Timebokoversikt lar helesaktører gjøre alle timebøker tilgjengelig for en innbygger, og støtter både personlige timebøker og ressurstimebøker.
API-navn
DIALOG_INNBYGGER_TIMEBOKOVERSIKT
Funksjonelt område
Timeavtaler
API-versjon og dato publisert
v1.0 Jun 20, 2024
Status
Prod
API-dokumentasjon sist endret
Mar 18, 2025
Teknologi
AMQP
Krever representasjon
Nei
Flyt og sekvensdiagram Under er informasjon om flyten i bruk av denne funksjonaliteten. Prosessflyt for timebestilling generelt er vist her Bestille time i timebok | Prosessflyt for timebestilling
Overordnet flyt og sekvensdiagram
Sekvensdiagram for timebokoversikt er vist under.
Forespørsel om Timebokoversikt Synkron henting av tilgjengelige timebøker for innbygger
Tjeneste
Forespørsel om Timebokoversikt
Bruksområde
Forespørsel fra helsenorge.no for å hente alle timebøker som er tilgjengelig for en innbygger.
Hodemelding
Obligatorisk Hodemelding
Obligatorisk verdi i MsgHead/MsgInfo/Type er:
<Type V="DIALOG_INNBYGGER_TIMEBOKOVERSIKT" DN="Dialog med innbygger – Timebokoversikt" /> Obligatorisk verdi i MsgHead/MsgInfo/Ack er:
Dialogmelding
Det er påkrevd med minst ett document under en hodenelding.
Dialogmeldingen inneholder ingen meningsbærende informasjjon, men er inkludert.
Lovlige kodeverdier
XML eksempel:
<Foresporsel>
<TypeForesp V="HTB" DN="Hent Timebok" ="2.16.578.1.12.4.1.1.7601"/>
</Foresporsel>
RollerRelatertNotat
Ikke aktuelt å bruke for forespørselen i denne tjenesten.
Pasientrelasjon
Ikke aktuelt å bruke for forespørselen i denne tjenesten, ikke relevant å skille på hvem som ber om tilgjengelige timebøker.
Vedlegg
Ikke aktuelt å bruke for denne tjenesten
FHIR profil Responsen med timebøker benytter denne FHIR profilen: https://norskhelsenett.github.io/FHIRCodeAndMore/ExampleIG/output/StructureDefinition-hn-basis-schedule.html
For å støtte ulike typer timebøker og gi en god oversikt over disse til innbygger er det noen viktige klassifiseringer som må gjøres
Hovedtyper av timebøker Timebokoversikt støtter to hovedtyper timebøker
Personlige timebøker, typisk for en behandler. Disse skal angis med Actor=Practitioner
Ressurstimebøker. Timebøker der det ikke er en behandler men en ressurs som tilbyr timer. Et eksempel kan være en labtimebok. Disse skal angis med Actor=HealthcareService
Timeboktyper For å angi type timebok er det innført et egendefinert kodeverk. De ulike timeboktypene brukes for å gi god forklaring i brukerflaten til innbygger om hva slags timer timeboken inneholder og det kan knyttes egne veiledere/kartlegginger til de før bestilling.
Lab
For timebestilling til labtimer.
Kun relevant for ressurstimebøker
Kan gi spesifikk veileder og vises med egen visning
Vaksine
For timebestilling til vaksinasjon.
Kun relevant for ressurstimebøker
Kan gi spesifikk veileder og vises med egen visning
Koronavaksine
For timebestilling til koronavaksine.
Kun relevant for ressurstimebøker, innført for pandemien og beholdt for bakoverkompatibilitet
Kan gi spesifikk veileder og vises med egen visning
Koronatest
For timebestilling til koronatest.
Kun relevant for ressurstimebøker, innført for pandemien og beholdt for bakoverkompatibilitet
Kan gi spesifikk veileder og vises med egen visning
Behandlertimebok
Annen
Benyttes der andre timeboktyper ikke er dekkende. Ved behov for denne vil Helsenorge gjerne ha innspill for å vurdere om kodeverk bør utvides
Helsenorge viser navn på timebok, men kan ikke gi ytterligere veileder
Svar på Timebokoversikt Svar med tilgjengelige timebøker
Tjeneste
Svar på forespørsel om Timebokoversikt, synkron tjeneste
Bruksområde
Svar fra kommunikasjonspart med Timebøker som er tilgjengelige for en innbygger.
Hodemelding
Obligatorisk Hodemelding
Obligatorisk verdi i MsgHead/MsgInfo/Type er:
<Type V="DIALOG_INNBYGGER_TIMEBOKOVERSIKT" DN="Dialog med innbygger – Timebokoversikt" />
Dialogmelding
Ikke aktuelt å bruke, ingen informasjon i dialogmeldingen
FHIR Schedule
Obligatorisk informasjon
Schedule benyttes for informasjon om timebok. Detaljer for bruk av denne ressursen er angitt i FHIR Schedule
Dersom det ikke er noen tilgjengelige timebøker for innbygger benyttes ikke elementet.
Generell info om meldingsutveksling med Helsenorge For overordnet informasjon om meldingsutveksling med Helsenorge se her: Meldingsutveksling med Helsenorge
Eksempelmeldinger Eksempelmelding for forespørsel om timebokoversikt er vist under.
Eksempelmelding for forespørsel for henting av timebokoversikt
<MsgHead xmlns="http://www.kith.no/xmlstds/msghead/2006-05-24" p1:schemaLocation="http://www.kith.no/xmlstds/msghead/2006-05-24 MsgHead-v1_2.xsd" xmlns:p1="http://www.w3.org/2001/XMLSchema-instance">
<MsgInfo>
<Type V="DIALOG_INNBYGGER_TIMEBOKOVERSIKT" DN="Dialog med innbygger – Timebokoversikt"/>
<MIGversion>v1.2 2006-05-24</MIGversion>
<GenDate>2022-11-23T10:46:20.5934330+01:00</GenDate>
<MsgId>ad06b67f-6d49-4c9d-91df-87f5e3468560</MsgId>
<Ack V="N" DN="Nei"/>
<Sender>
<Organisation>
<OrganisationName>Norsk Helsenett SF</OrganisationName>
<Ident>
<Id>112374</Id>
<TypeId V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret (HER-id)" S="2.16.578.1.12.4.1.1.9051" />
</Ident>
<Organisation>
<OrganisationName>Digitale innbyggertjenester- Helsenorge</OrganisationName>
<Ident>
<Id>8093247</Id>
<TypeId V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret (HER-id)" S="2.16.578.1.12.4.1.1.9051" />
</Ident>
</Organisation>
</Organisation>
</Sender>
<Receiver>
<Organisation>
<OrganisationName>Test virksomhet</OrganisationName>
<Ident>
<Id>8091453</Id>
<TypeId V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret (HER-id)" S="2.16.578.1.12.4.1.1.9051" />
</Ident>
<HealthcareProfessional>
<RoleToPatient V="6" DN="Fastlege" S="2.16.578.1.12.4.1.1.9034" />
<FamilyName/>
<MiddleName/>
<GivenName/>
<Ident>
<Id>8091492</Id>
<TypeId V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret (HER-id)" S="2.16.578.1.12.4.1.1.8116" />
</Ident>
</HealthcareProfessional>
</Organisation>
</Receiver>
<Patient>
<FamilyName>Aas</FamilyName>
<GivenName>Kim</GivenName>
<Ident>
<Id>18129800174</Id>
<TypeId V="FNR" DN="Fødselsnummer" S="2.16.578.1.12.4.1.1.8116" />
</Ident>
</Patient>
</MsgInfo>
<Document>
<ContentDescription>Henvendelse</ContentDescription>
<RefDoc>
<IssueDate V="2022-11-23T10:46:20.5465523+01:00" />
<MsgType V="XML" DN="XML-instans" />
<Content>
<Dialogmelding xmlns="http://www.kith.no/xmlstds/dialog/2013-01-23" p1:schemaLocation="http://www.kith.no/xmlstds/dialog/2013-01-23 dialogmelding-v1.1.xsd">
<Foresporsel>
<TypeForesp V="HTO" DN="Hent timebokoversikt" S="2.16.578.1.12.4.1.1.7601" />
<EmneSporsmal></EmneSporsmal>
<Sporsmal></Sporsmal>
</Foresporsel>
</Dialogmelding>
</Content>
</RefDoc>
</Document>
</MsgHead>
Eksempelmelding for svar på timebokoversikt er vist under.
Eksempel XML for fire timebøker, to personlige og to ressurstimebøker for hhv. Koronavaksine og lab
<Bundle xmlns="http://hl7.org/fhir" p1:schemaLocation="http://hl7.org/fhir fhir\bundle.xsd">
<type value="searchset"/>
<entry>
<resource>
<Schedule>
<meta>
<profile value="http://helsenorge.no/fhir/StructureDefinition/hn-basis-schedule"/>
</meta>
<extension url="http://helsenorge.no/fhir/StructureDefinition/hn-extension-free-slot-planningHorizon">
<extension url="freePlanningHorizon">
<valuePeriod>
<start value="2024-06-08T09:00:00Z"/>
<end value="2024-11-20T15:30:00Z"/>
</valuePeriod>
</extension>
</extension>
<identifier>
<system value="urn:ietf:rfc:3986"/>
<value value="urn:uuid:d082e865-7a93-46fc-a0a3-681571aed13c"/>
</identifier>
<serviceType>
<coding>
<system value=" http://helsenorge.no/fhir/CodeSystem/hn-schedule-type-cs"/>
<code value="Behandlertimebok"/>
</coding>
</serviceType>
<actor>
<type value="Practitioner"/>
<identifier>
<system value="urn:oid:2.16.578.1.12.4.1.4.4"/>
<value value="123456789"/>
</identifier>
<display value="Fastlege Hans Hansen"/>
</actor>
<comment value="Jobber mandag, onsdag og fredag"/>
</Schedule>
</resource>
</entry>
<entry>
<resource>
<Schedule>
<meta>
<profile value="http://helsenorge.no/fhir/StructureDefinition/hn-basis-schedule"/>
</meta>
<extension url="http://helsenorge.no/fhir/StructureDefinition/hn-extension-free-slot-planningHorizon">
<extension url="freePlanningHorizon">
<valuePeriod>
<start value="2024-06-07T09:00:00Z"/>
<end value="2024-09-20T15:30:00Z"/>
</valuePeriod>
</extension>
</extension>
<identifier>
<system value="urn:ietf:rfc:3986"/>
<value value="0cd7fe84-94c3-41b8-83f6-3c64451447bc"/>
</identifier>
<serviceType>
<coding>
<system value=" http://helsenorge.no/fhir/CodeSystem/hn-schedule-type-cs"/>
<code value="Behandlertimebok"/>
</coding>
</serviceType>
<actor>
<type value="Practitioner"/>
<identifier>
<system value="urn:oid:2.16.578.1.12.4.1.4.4"/>
<value value="431001875"/>
</identifier>
<display value="Vikar September August"/>
</actor>
<comment value="Jobber tirsdag og torsdag"/>
</Schedule>
</resource>
</entry>
<entry>
<resource>
<Schedule>
<meta>
<profile value="http://helsenorge.no/fhir/StructureDefinition/hn-basis-schedule"/>
</meta>
<extension url="http://helsenorge.no/fhir/StructureDefinition/hn-extension-free-slot-planningHorizon">
<extension url="freePlanningHorizon">
<valuePeriod>
<start value="2024-06-05T09:00:00Z"/>
<end value="2024-06-09T15:30:00Z"/>
</valuePeriod>
</extension>
</extension>
<identifier>
<system value="urn:ietf:rfc:3986"/>
<value value="03b4a6cf-7c8b-4171-a171-8b7abbec2eaf"/>
</identifier>
<serviceType>
<coding>
<system value=" http://helsenorge.no/fhir/CodeSystem/hn-schedule-type-cs"/>
<code value="Koronavaksine"/>
</coding>
</serviceType>
<actor>
<type value="HealthcareService"/>
<identifier>
<system value="urn:oid:2.16.578.1.12.4.1.1.9051"/>
<value value="ABCDEF123456"/>
</identifier>
<display value="Koronavaksine"/>
</actor>
<comment value="Koronavaksine tilbys til risikopasienter i henhold til retningslinjer fra FHI"/>
</Schedule>
</resource>
</entry>
<entry>
<resource>
<Schedule>
<meta>
<profile value="http://helsenorge.no/fhir/StructureDefinition/hn-basis-schedule"/>
</meta>
<identifier>
<system value="urn:ietf:rfc:3986"/>
<value value="50aa673f-3456-4855-9eec-5f1aea3966a7"/>
</identifier>
<serviceType>
<coding>
<system value=" http://helsenorge.no/fhir/CodeSystem/hn-schedule-type-cs"/>
<code value="Lab"/>
</coding>
</serviceType>
<actor>
<type value="HealthcareService"/>
<identifier>
<system value="urn:oid:2.16.578.1.12.4.1.1.9051"/>
<value value="3546c8f7-3cd3-4693-929e-66501642504c"/>
</identifier>
<display value="Lab på legekontoret"/>
</actor>
<comment value="Lab tilbyr blodprøver og andre tester hver dag fra 10-15"/>
</Schedule>
</resource>
</entry>
</Bundle> Eksempel XML ingen timebøker
<MsgHead xmlns="http://www.kith.no/xmlstds/msghead/2006-05-24" p1:schemaLocation="http://www.kith.no/xmlstds/msghead/2006-05-24 MsgHead-v1_2.xsd" xmlns:p1="http://www.w3.org/2001/XMLSchema-instance">
<MsgInfo>
<Type V="DIALOG_INNBYGGER_TIMEBOKOVERSIKT" DN="Dialog med innbygger – Timebokoversikt"/>
<MIGversion>v1.2 2006-05-24</MIGversion>
<GenDate>2021-01-12T11:59:52.6881844+01:00</GenDate>
<MsgId>4e8b328d-1a45-4b2b-9155-dd111197f484</MsgId>
<Ack V="N" DN="Nei"/>
<ConversationRef>
<RefToParent>a8f5b448-e488-44a6-b11d-bc6cae2e0fa3</RefToParent>
<RefToConversation>a8f5b448-e488-44a6-b11d-bc6cae2e0fa3</RefToConversation>
</ConversationRef>
<Sender>
<Organisation>
<OrganisationName>Test virksomhet</OrganisationName>
<Ident>
<Id>1</Id>
<TypeId V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret (HER-id)" S="2.16.578.1.12.4.1.1.9051"/>
</Ident>
<Organisation>
<OrganisationName>Test Kommunikasjonspart</OrganisationName>
<Ident>
<Id>1234</Id>
<TypeId V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret (HER-id)" S="2.16.578.1.12.4.1.1.9051"/>
</Ident>
</Organisation>
</Organisation>
</Sender>
<Receiver>
<Organisation>
<OrganisationName>Norsk Helsenett</OrganisationName>
<Ident>
<Id>115851</Id>
<TypeId V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret (HER-id)" S="2.16.578.1.12.4.1.1.9051"/>
</Ident>
<Organisation>
<OrganisationName>Digitale innbyggertjenester</OrganisationName>
<Ident>
<Id>109989</Id>
<TypeId V="HER" DN="Identifikator fra Helsetjenesteenhetsregisteret (HER-id)" S="2.16.578.1.12.4.1.1.9051"/>
</Ident>
</Organisation>
</Organisation>
</Receiver>
<Patient>
<Ident>
<Id>13116900216</Id>
<TypeId V="FNR" DN="Fødselsnummer" S="2.16.578.1.12.4.1.1.8116"/>
</Ident>
</Patient>
</MsgInfo>
<Document>
<ContentDescription>Fhir element</ContentDescription>
<RefDoc>
<MsgType V="XML" DN="XML-instans"/>
<Description>Fhir element</Description>
<Content>
<Bundle xmlns="http://hl7.org/fhir" p1:schemaLocation="http://hl7.org/fhir fhir\bundle.xsd">
<type value="searchset"/>
</Bundle>
</Content>
</RefDoc>
</Document>
</MsgHead>
Eksempelmelding inkludert hodemelding med respons for timebokoversikt:
