Husk å legg til etiketten “api-dokumentasjon” når denne malen benyttes, samt å slette denne notisen
Ved bruk av prosessen timeønske kan innbygger rette et ønske om time med valgt behandler, men innbygger får ikke anledning til å velge og reservere en spesifikk time.
Page Properties
API-navn
DIALOG_INNBYGGER_TIMEONSKE
Funksjonelt område
Dialog
API-versjon og dato publisert
v1.2
Status
Status
colour
Green
title
I Drift
API-dokumentasjon sist endret
Teknologi
Status
colour
Purple
title
AMQP
Prosesser og flyt
Her er info om prosesser og flyt
Expand
title
Prosesser og sekvensdiagram
En av følgende prosesser skal aktiveres i adresseregisteret for å støtte funksjonaliteten.
Prosess
Funksjonalitet
Versjon
Dialog_Innbygger_Timeonske
Første versjon av kommunikasjonsprosess. Skal ikke tas i bruk av nye aktører.
1.1
Dialog_Innbygger_Timeonske
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.1
Innbygger
ØnskeReserver
ØnskeEndring
ØnskeAvbestill
Dialogmelding 1.1
iCal
Helsepersonell
SvarØnske
Dialogmelding 1.1
iCal
1.2
Innbygger
ØnskeReserver
ØnskeEndring
ØnskeAvbestill
Dialogmelding 1.1
Pasientrelasjon
iCal
Helsepersonell
SvarØnske
Dialogmelding 1.1
iCal
Sekvensdiagram for ønske om time er vist i figuren under.
Image Removed
Sekvensdiagram for ønske om endring av time er vist i figuren under.
Image Removed
Sekvensdiagram for ønske om avbestilling av time er vist i figuren under.
Image Removed
Forespørsel om Timeønske
Med forespørsel om timeønske kan innbygger komme med et ønske om time, men timen kan ikke reserveres (eller endres) i sanntid.
Expand
title
Struktur på query
Tjeneste
Forespørsel om timeønske, asynkron tjeneste
Bruksområde
Brukes når innbygger har ønske om ny time, endre en bestilt time eller avbestille en bestilt time.
Hodemelding
Obligatorisk, og benyttes i henhold til beskrivelse i kapittel 2.3
Obligatorisk verdi i MsgHead/MsgInfo/Type er:
Code Block
<Type V="DIALOG_INNBYGGER_TIMEONSKE" DN="Dialog med innbygger - timeønske"/>
Obligatorisk verdi i MsgHead/MsgInfo/Ack er:
Code Block
<Ack DN="Ja" V="J"/>
Dialogmelding
Obligatoriske elementer (klasse/element):
Dialogmelding/Foresporsel/TypeForesp
Lovlige kodeverdier som kan brukes i TypeForesp:
OT Ønske om time
OET Ønske om endring av time. Under utvikling, ikke prodsatt
OAT Ønske om avbestilling av time
UT Ønske om ungdomstime
Valgfrie elementer (klasse/element):
Dialogmelding/Foresporsel/EmneSporsmal
Dialogmelding/Foresporsel/Sporsmal
XML eksempel:
Code Block
<Foresporsel>
<TypeForesp V="OT" DN=" Ønske om time"
Ved bruk av prosessen timeønske kan innbygger be om en time hos en helsekontakt.
Page Properties
API-navn
DIALOG_INNBYGGER_TIMEONSKE
Funksjonelt område
Dialog
API-versjon og dato publisert
v1.2
Status
Status
colour
Green
title
I Drift
API-dokumentasjon sist endret
Teknologi
Status
colour
Purple
title
AMQP
Kommunikasjonsprosess
Expand
title
Prosess og sekvensdiagram
Følgende prosess skal aktiveres i adresseregisteret for å støtte funksjonaliteten.
Prosess
Funksjonalitet
Versjon
Dialog_Innbygger_Timeonske
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
ØnskeReserver
Dialogmelding 1.1
Pasientrelasjon
iCal
Helsepersonell
SvarØnske
Dialogmelding 1.1
iCal
Sekvensdiagram for ønske om time er vist i figuren under.
Dette skal benyttes i tilfeller der det sendes et svar på et timeønske.
Dialogmelding
Obligatoriske elementer (klasse/element):
Dialogmelding/Notat/Temakodet
Elementet Dialogmelding/Notat/Foresporsel benyttes ikke i svarmelding.
Lovlige kodeverdier som kan brukes i Dialogmelding/Notat/Temakodet:
05 Timereservasjon bekreftet
06 Time ikke tilgjengelig
07 Endring av time bekreftet
34 Time kunne ikke endres
08 Avbestilling av time bekreftet
09 Time kunne ikke avbestilles
10 Timereservasjon hos annen behandler bekreftet
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>:
26 Forespørsel avvist
30 Ikke tilgang
Valgfrie elementer (klasse/element):
Dialogmelding/Notat/TekstNotatInnhold
XML eksempel:
Code Block
<Notat>
<TemaKodet DN="Timereservasjon bekreftet" V="05" S="2.16.578.1.12.4.1.1. 7602" />
<TekstNotatInnhold>Din time er reservert. SMS varsel blir sendt 24 timer før.</TekstNotatInnhold>
</Notat>
RollerRelatertNotat
Valgfritt, benyttes i henhold til Dialogmelding under RollerRelatertNotat.
RollerRelatertNotat angir helsepersonellet som besvarte meldingen og gir mulighet til å skille hvem meldingen er adressert fra (hodemelding) og hvem som besvarer
Angir helsepersonellet det ønskes at dialogen rutes til. Bruk av denne forutsetter at prosessen 3.12 Behandler er støttet og helsenorge.no kan hente behandlere fra EPJ.
Obligatorisk ved endring eller avbestilling av time når informasjon om tidspunkt sendes strukturert til legekontor. Ved ønske om ny time skal ikke iCal benyttes (dette vil kun ligge som fritekst i Dialogmeldingen).
Elementer under iCal/vevent skal ha følgende innhold for de ulike bruksområdene:
Ønske om avbestilling eller endring av time
dtstart: tidsslot for gjeldende time, start
dtend: tidsslot for gjeldende time, slutt
uid: id for tidsslot
contact: HER-id for behandler som tidsslot tilhører
related-to: id for timeavtalen en ønsker å avbestille/endre
Obligatorisk informasjonnåren annen person enn utfører timereservasjon på vegne av pasient.
Se kapittel 2.4.6 for korrekt bruk.
Vedlegg
Valgfri informasjon som kanvære med dersom f.eks. innbygger legger ved et bilde.
Se kapittel 2.10 for korrekt bruk.
Svar på forespørsel om Timeønske
Her er strukturen på en respons
Expand
title
Struktur på response
Tjeneste
Svar på forespørsel om timeønske, asynkron tjeneste
Bruksområde
Svar på reservasjon en ny time, endring av en reservert time eller avbestilling av en reservert time.
Hodemelding
Obligatorisk, og benyttes i henhold til beskrivelse i kapittel 2.3
Obligatorisk verdi i MsgHead/MsgInfo/Type er:
Code Block
<Type V="DIALOG_INNBYGGER_TIMEONSKE" DN="Dialog med innbygger - timeønske"/>
Obligatorisk verdi i MsgHead/MsgInfo/Ack er:
Code Block
<Ack DN="Ja" V="J"/>
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:
05 Timereservasjon bekreftet
06 Time ikke tilgjengelig
07 Endring av time bekreftet
34 Time kunne ikke endres
08 Avbestilling av time bekreftet
09 Time kunne ikke avbestilles
10 Timereservasjon hos annen behandler bekreftet
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>:
26 Forespørsel avvist
30 Ikke tilgang
Valgfrie elementer (klasse/element):
Dialogmelding/Notat/TekstNotatInnhold
XML eksempel:
Code Block
<Notat>
<TemaKodet DN="Timereservasjon bekreftet" V="05" S="2.16.578.1.12.4.1.1. 7602" />
<TekstNotatInnhold>Din time er reservert. SMS varsel blir sendt 24 timer før.</TekstNotatInnhold>
</Notat>
RollerRelatertNotat
Valgfritt, benyttes i henhold til kapittel 2.3.5.
RollerRelatertNotat angir helsepersonellet som besvarte meldingen og gir mulighet til å skille hvem meldingen er adressert fra (hodemelding) og hvem som besvarer
Under er forskjellige typer supplerende informasjon
Expand
title
Benytter av følgende komponenter
Navn
Type
Beskrivelse
Endringslogg
Expand
Dato
Endring
November 2015
Opprinnelig versjon av spesifikasjon. Publisert som del av DDFL prosjektet
Desember 2021
Versjon 1.1 av prosessen faset ut og ryddet bort fra dokumentasjon
23.10.23
Oppdatert beskrivelse av timeønske:
Endring av timeavtale har aldri vært implementert. Var beskrevet i dokumentasjon
Avbestilling av timeavtale gjøres ikke ved timeønske
Rettet XML eksempel for “Timereservasjon hos annen behandler bekreftet” . Eksempel validerte ikke og inneholdt XML dokument som ikke støttes i kommunikasjonsprosess.