AMQP Timereservasjon

Prosessen timereservasjon inneholder flere ulike funksjoner knyttet til administrasjon av timer.

API-navn	DIALOG_INNBYGGER_TIMERESERVASJON
Funksjonelt område	Dialog
API-versjon og dato publisert	v1.2 Nov 23, 2015
Status	I Drift
API-dokumentasjon sist endret	Dec 8, 2021
Teknologi	AMQP

Kommunikasjonsprosess

Følgende prosess skal aktiveres i adresseregisteret for å støtte funksjonaliteten. Sekvensdiagram for de ulike funksjonene er vist i egne underavnitt.

Prosess	Funksjonalitet	Versjon
Dialog_Innbygger_Timereservasjon	Håndtering av pasientrelasjon. Helsenorge.no kan sende meldinger på vegne av annen person.	1.2

Tabellen under viser hvilke roller som inngår i prosessen, hvilke funksjoner de ulike rollene kan gjøre og hvilke meldinger som benyttes for de ulike versjonene.

Versjon

Rolle

Funksjon

Meldingsinnhold

1.2

Innbygger

HentLedigeTimer (synkron)

HentPlanlagteTimer (synkron)

ReserverAvtale (asynkron)

AvbestillAvtale (asynkron)

· Dialogmelding 1.1

· Pasientrelasjon

· iCalendar 2.0

Helsepersonell

Avtale (asynkron)

SvarLedigeTimer (synkron)

SvarPlanlagteTimer (synkron)

SvarTimeReservasjon (asynkron)

· Dialogmelding 1.1

· Helsepersonell

· iCalendar 2.0

Se ytterligere detaljer i innholdsstandarder for innhold i meldinger

Avtaleutsending

Med denne funksjonen kan fagsystemet sende avtaler til helsenorge.no . Dette benyttes når innbygger bestiller eller endrer time hos behandler via andre kanaler enn helsenorge.no . Både nye timer og alle endringer på bestilte timer skal kommuniseres. Det skal bare sende en av meldingene over for en gitt instans av en avtale. Dersom endring av time f.eks. gjøres som avbestilling + endring i EPJ, er det bare endringen som skal sendes til helsenorge.no . Dersom det sendes to meldinger for dette tilfellet er det ikke gitt hvilken som mottas først og vises i helsenorge.no

Denne tjenesten er en «enveis» informasjonstjeneste som ikke skal besvares av helsenorge.no utover applikasjonskvittering.

Dersom innbygger ikke møter opp til time skal dette meldes til helsenorge.no . Dette gjelder for alle timer, uavhengig hvilken kanal timen er bestilt via.

Endring av time skal sendes til innbygger ved endringer i timen slik som for eksempel:

Endret tidspunkt (dtstart og dtend)
Endret lokasjon (Location)
Endret timetype (Categories)
Endret beskrivelse
Endret behandler

Tjeneste	Del innbyggers bestilte timer, asynkron tjeneste
Bruksområde	«Pushutsending» fra EPJ-systemet til helsenorge.no for å dele bestilte timer for innbyggeren.
Hodemelding	Obligatorisk, og benyttes i henhold til beskrivelse i Hodemelding Obligatorisk verdi i MsgHead/MsgInfo/Type er: `<Type V="DIALOG_INNBYGGER_TIMERESERVASJON" DN="Dialog med innbygger - timereservasjon"/>` Obligatorisk verdi i MsgHead/MsgInfo/Ack er: `<Ack DN="Ja" V="J"/>` Meldinger som inngår i en samtaletråd skal refereres til hverandre ved hjelp av MsgHead/MsgInfo/ConversationRef på følgende måte: Elementet «RefToParent» skal referere til forrige melding i dialog Elementet «RefToConversation» skal referere til første melding i dialogen `<ConversationRef> <RefToParent>ae53cf18-c834-4342-994c-387e5b80078c</RefToParent> <RefToConversation>ae53cf18-c834-4342-994c-387e5b80078c</RefToConversation> </ConversationRef>` Dette skal benyttes i tilfeller der det sendes en endring på en tidligere avtale
Dialogmelding	Obligatoriske elementer (klasse/element): Dialogmelding/Foresporsel/TypeForesp Lovlige kodeverdier som kan brukes i TypeForesp: 05 Timereservasjon bekreftet 06 Time ikke tilgjengelig 07 Endring av time bekreftet 08 Avbestilling av time bekreftet 11 Pasient ikke møtt MOA Melding om avtale Valgfrie elementer (klasse/element): Dialogmelding/Sakstype i henhold til beskrivelse i Dialogmelding under Referanse til helsekontakt - Sakstype Følgende elementer skal ikke benyttes for avtaleutsending: Dialogmelding/Foresporsel/EmneSporsmal Dialogmelding/Foresporsel/Sporsmal Innhold for emne og beskrivelse skal sendes i iCal elementet. Av historiske grunner er det enkelte leverandører som benytter EmneSporsmal, støtten for dette vil fases ut på sikt. XML eksempel: RollerRelatertNotat Valgfritt, benyttes i henhold til Dialogmelding under avsnitt RollerRelatertNotat. Obligatorisk for AMQP Behandleroversikt & AMQP Ressursoversikt RollerRelatertNotat angir helsepersonellet/ressurs som utfører avtalen og vises på avtalen i helsenorge.no . Hodemeldingen angir hvem som er teknisk avsender av meldingen (en kommunikasjonspart fra adresseregisteret), RollerRelatertNotat angir behandler eller enhet som innbygger har time hos. XML-eksempel: For ressurstimebøker må ID og navn på timeboken sendes med, XML-eksempel for en ressurstimebok vist under
iCalender	Obligatorisk når avtale sendes til helsenorge.no Følgende informasjon benyttes i visning av avtale dtstart og dtend location: Oppmøtested Summary: Hva timen gjelder Description: Beskrivelse av timen Følgende informasjon benyttes for å identifisere avtalen og til vurdering om eksisterende avtale skal oppdateres eller ny avtale opprettes Related-to,. Valgfritt element som kan peke på en Id til en avtale som allerede er sendt til Helsenorge eller en slot dersom innbygger har sendt en timebestilling Uid. Id for timeavtalen. Status hentes fra Dialogmeldingen, bortsett fra for koden MOA som benytter status fra iCal. XML eksempel:
Helsepersonell	Ikke aktuelt å bruke for denne tjenesten
Pasientrelasjon	Ikke aktuelt å bruke for denne tjenesten
Vedlegg	Ikke aktuelt å bruke for denne tjenesten

Hent ledige timer

Med «Hent ledige timer» menes det at innbygger får tilgang til ledige timer som kan reserves.

Helsenorge.no henter ledige timer hos tjenesten som er angitt i hodemeldingen og eventuelt for en timebok som er hentet på forhånd og er angitt i dialogmeldingen. Timene vil presenteres for innbygger som kan velge og reservere en timeavtale

Forespørsel om hent ledige timer, synkron tjeneste

Tjeneste	Forespørsel om hent ledige timer, synkron tjeneste
Bruksområde	Forespørsel fra helsenorge.no for å hente ledige timer for den behandleren som er angitt som mottaker i meldingen.
Hodemelding	Obligatorisk, og benyttes i henhold til beskrivelse i Hodemelding Obligatorisk verdi i MsgHead/MsgInfo/Type er: Obligatorisk verdi i MsgHead/MsgInfo/Ack er:
Dialogmelding	Obligatoriske elementer (klasse/element): Dialogmelding/Foresporsel/TypeForesp Dialogmelding/Foresporsel/FraDato Dialogmelding/Foresporsel/TilDato Lovlige kodeverdier som kan brukes i TypeForesp: HLT Hent ledige timer Maksimalt tidsrom mellom feltene FraDato og TilDato er 4 uker. TilDato skal håndteres som til og med dato, det vil si siste dag det ønskes timer fra. XML eksempel: RollerRelatertNotat Valgfritt, benyttes i henhold til Dialogmelding under RollerRelatertNotat. Angir timeboken som timeforespørsel gjelder. Bruk av denne forutsetter at helsenorge.no kan hente behandlere fra EPJ eller at det er støtte for ressurstimebøker. XML-eksempel for en personlig timebok, hentet ved Behandleroversikt: XML-eksempel for en ressurstimebok hentet ved Ressursoversikt:
iCalender	Ikke aktuelt å bruke for denne tjenesten.
Helsepersonell	Ikke aktuelt å bruke for denne tjenesten.
Pasientrelasjon	Obligatorisk informasjon når en annen person utfører timereservasjon på vegne av pasient. Se Pasientrelasjon for korrekt bruk.
Vedlegg	Ikke aktuelt å bruke for denne tjenesten

Svar på forespørsel om hent ledige timer, synkron tjeneste

Tjeneste	Svar på forespørsel om hent ledige timer, synkron tjeneste
Bruksområde	Svar fra kommunikasjonspart med ledige timer som angitt behandler har tilgjengelig for online timereservasjon. Dersom tjenesten ikke har ledige timer skal dette returneres.
Hodemelding	Obligatorisk, og benyttes i henhold til beskrivelse i Hodemelding Obligatorisk verdi i MsgHead/MsgInfo/Type er: Obligatorisk verdi i MsgHead/MsgInfo/Ack er: Meldinger som inngår i en samtaletråd skal refereres til hverandre ved hjelp av MsgHead/MsgInfo/ConversationRef på følgende måte: Elementet «RefToParent» skal referere til forrige melding i dialog Elementet «RefToConversation» skal referere til første melding i dialogen
Dialogmelding	Obligatoriske elementer (klasse/element): Dialogmelding/Notat/Temakodet Dialogmelding/Notat/Foresporsel Elementet Dialogmelding/Notat/Foresporsel benyttes ikke i svarmelding. Lovlige kodeverdier som kan brukes i Dialogmelding/Notat/Temakodet: 03 Ledige timer 04 Ingen ledige timer Avvisning av henvendelse/forespørsel: dersom system/behandler ikke kan svare på mottatt henvendelse/forespørsel kan følgende kodeverdier fra kodeverk 7602 benyttes i elementet <Dialogmelding/Notat/Temakodet>: 30 Ikke tilgang XML eksempel: RollerRelatertNotat Ikke aktuelt å bruke for denne tjenesten
iCalender	Obligatorisk når informasjon om timer sendes til Helsenorge.no. Dersom koden «ingen ledige timer» returneres skal iCalendar ikke benyttes. Verdien i uid er her en Id til en tidsslot i timeboken. Ven en forespørsel om reservasjon er det denne Id’en som vil sendes til timebok. XML eksempel med to ledige timer, der den ene er en videotime og den andre er en time som ikke blir tilgjengelig før et gitt tidspunkt:
Helsepersonell	Ikke aktuelt å bruke for denne tjenesten.
Pasientrelasjon	Ikke aktuelt å bruke for denne tjenesten
Vedlegg	Ikke aktuelt å bruke for denne tjenesten

Reservasjon av valgt time

Med reservasjon av valgt time kan innbygger reservere et tidspunkt med valgt behandler. Bruk av denne funksjonen forutsetter at hent ledige timer er benyttet først, for å finne ledige tidspunkt og referanser til tidsslot som skal reserveres.

Med forespørsel om timereservasjon kan innbygger sende en forespørsel om å bestille eller avbestille en time. Dersom innbygger vil endre en time må dette gjøres som avbestilling av eksisterende og en bestilling av ny time.

Eksempelmeldinger

Generell info om meldingsutveksling med Helsenorge

For overordnet informasjon om meldingsutveksling med Helsenorge se her: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/690913297