Prosessen avtaleavbestilling er identisk med funksjonen for innbygger å sende avbestilling i prosessen 3.4 Timereservasjon versjon 1.2
Denne prosessen gjør det mulig for en aktør å åpne opp for avbestillinger av avtaler fra innbygger, uten å åpne opp for hele prosessen timeadministrasjon som også innebærer at innbygger får hente ledige timer og bestille nye timer. Et premiss for å kunne benytte denne prosessen er at innbygger ser avtaler og prosessen Avtaleutsending er aktivert.
Page Properties
API-navn
DIALOG_INNBYGGER_AVTALEAVBESTILLING
Funksjonelt område
Dialog
API-versjon og dato publisert
v1.0
Status
Status
colour
Green
title
I Drift
API-dokumentasjon sist endret
Teknologi
Status
colour
Purple
title
AMQP
Prosesser og roller
Her er info om prosesser og roller
Expand
title
Prosesser og roller
Dette er en frittstående prosess og har en egen verdi i meldingens funksjon i hodemeldingen. Følgende prosess skal aktiveres i adresseregisteret for å støtte funksjonaliteten.
Prosess
Funksjonalitet
Versjon
Dialog_Innbygger_Avtaleavbestilling
Første versjon av kommunikasjonsprosess.
1.0
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.0
Innbygger
AvbestillAvtale
Dialogmelding 1.1
Pasientrelasjon
iCal
Helsepersonell
SvarAvbestilling
Dialogmelding 1.1
iCal
Forespørsel fra innbygger om avbestilling
Her er strukturen på query
Expand
title
Struktur på query
Med forespørsel om avbestilling kan innbygger sende en forespørsel om å avbestille en time.
Denne funksjon dekker avbestilling som beskrevet i avsnitt 3.4.3.1 Forespørsel fra innbygger om timereservasjon.
Tjeneste
Forespørsel om timereservasjon, asynkron tjeneste
Bruksområde
Brukes når innbygger ønsker å avbestille 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_AVTALEAVBESTILLING" DN="Dialog med innbygger - avtaleavbestilling "/>
Obligatorisk verdi i MsgHead/MsgInfo/Ack er:
Code Block
<Ack DN="Ja" V="J"/>
Referanse til samtaletråd settes til meldingen som ble sendt for timenotifikasjon, beskrevet i 3.6
Prosessen avtaleavbestilling er identisk med funksjonen for innbygger å sende avbestilling i prosessen AMQP Timereservasjonversjon 1.2
Denne prosessen gjør det mulig for en aktør å åpne opp for avbestillinger av avtaler fra innbygger, uten å åpne opp for hele prosessen timeadministrasjon som også innebærer at innbygger får hente ledige timer og bestille nye timer. En forutsetning for å kunne benytte denne prosessen er at helseaktør tilbyr timevisning og at innbygger har en helsekontakt.
Page Properties
API-navn
DIALOG_INNBYGGER_AVTALEAVBESTILLING
Funksjonelt område
Dialog
API-versjon og dato publisert
v1.0
Status
Status
colour
Green
title
I Drift
API-dokumentasjon sist endret
Teknologi
Status
colour
Purple
title
AMQP
Kommunikasjonsprosess
Expand
title
Prosesser og roller
Dette er en frittstående prosess og har en egen verdi i meldingens funksjon i hodemeldingen. Følgende prosess skal aktiveres i adresseregisteret for å støtte funksjonaliteten.
Prosess
Funksjonalitet
Versjon
Dialog_Innbygger_Avtaleavbestilling
Første versjon av kommunikasjonsprosess.
1.0
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.
uid>
<related-to>
<uri>651b1341-26ca-11e4-8c21-0800200c9a66</uri>
</related-to>
<contact>
<text>91095</text>
</contact>
<summary>
<text>Reisevaksine</text>
</summary>
<description>
<text>Jeg har allerede tatt dose 2</text>
</description>
</properties>
<components/>
</vevent>
</components>
</vcalendar>
Svar på forespørsel om avbestilling
Her er strukturen på en respons
Expand
title
Struktur på response
Innholdet i Dialogemeldingen for svar på forespørsel er identisk med svar beskrevet i 3.4.3.2 Svar på forespørsel om timereservasjon. Dersom avbestilling kommer via prosessen Avtaleavbestilling skal det også svares med avbestilling slik som i eksempelet under.
Tjeneste
Svar på forespørsel om avbestilling, asynkron tjeneste
Bruksområde
Svar på 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_AVTALEAVBESTILLING" DN="Dialog med innbygger - avtaleavbestilling "/>
Obligatorisk verdi i MsgHead/MsgInfo/Ack er:
Code Block
<Ack DN="Ja" V="J"/>
Dialogmelding
Obligatoriske elementer (klasse/element):
Dialogmelding/Notat/Temakodet
Lovlige kodeverdier som kan brukes i Dialogmelding/Notat/Temakodet:
08 Avbestilling av time bekreftet
09 Time kunne ikke avbestilles
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
iCalender
Obligatorisk når informasjon om tidspunkt sendes til Helsenorge.no.
Elementene under iCal/vevent skal ha følgende innhold
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 som tidssloten tilhører
Ved avbestilling av time skal feltet related-to ha samme verdi som i opprinnelig time.
Følgende valgfrie informasjon kan benyttes:
Summary: Hva timen gjelder
Description: Fritekst informasjon knyttet til svaret
Status: Status for timen. Settes til CANCELLED dersom timen er avlyst
Innholdet i Dialogmeldingen for svar på forespørsel er identisk med svar som beskrevet i AMQP Timereservasjon under Reservasjon av valgt time. Dersom avbestilling kommer via prosessen Avtaleavbestilling skal det også svares med avbestilling slik som i eksempelet under.
Tjeneste
Svar på forespørsel om avbestilling, asynkron tjeneste
Bruksområde
Svar på avbestilling av en reservert time.
Hodemelding
Obligatorisk, og benyttes i henhold til beskrivelse i Hodemelding
Obligatorisk verdi i MsgHead/MsgInfo/Type er
Code Block
<Type V="DIALOG_INNBYGGER_AVTALEAVBESTILLING" DN="Dialog med innbygger - avtaleavbestilling "/>
Obligatorisk verdi i MsgHead/MsgInfo/Ack er:
Code Block
<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
Lovlige kodeverdier som kan brukes i Dialogmelding/Notat/Temakodet:
08 Avbestilling av time bekreftet
09 Time kunne ikke avbestilles
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
iCalender
Obligatorisk når informasjon om tidspunkt sendes til Helsenorge.no.
Elementene under iCal/vevent skal ha følgende innhold
dtstart: tidspunkt for gjeldende time, start
dtend: tidspunkt for gjeldende time, slutt
uid: id for avtale
contact: HER-id til kommunikasjonspart som timeavtale tilhører
related-to: id for relatert avtale.
Ved avbestilling av time skal feltet related-to ha samme verdi som den opprinnelige avtalen, i tilfeller der det opprettes en ny avtale (uid) i timebok
Følgende valgfrie informasjon kan benyttes:
Summary: Hva timen gjelder
Description: Fritekst informasjon knyttet til svaret
Status: Status for timen. Settes til CANCELLED dersom timen er avlyst
<text>Siden du allerede har tatt dose 2, trenger du ikke denne timen</text>
</
contact>
description>
<status>
</properties><components/>
<text>CANCELLED<
</
text>
vevent>
</
status>
<x-cancellation-reason>
<text>Avlyst av innbygger</text>
</x-cancellation-reason>
<summary>
<text>Reisevaksine</text>
</summary>
<description>
<text>Siden du allerede har tatt dose 2, trenger du ikke denne timen</text>
</description>
</properties>
<components/>
</vevent>
</components>
</vcalendar>
Ytterligere informasjon
Under er forskjellige typer supplerende informasjon
Om brukeren kan avbestille timen
For å finne ut om "Avbestille time" knappen skal vise så gjøres det et kall mot backend; Timeadministrasjonsstotte.
Timeadministrasjon sjekker:
Om timen venter på svar for avbestilling eller endring, eller om avbestilling er avvist, da vil ikke bruker kunne avbestille timen på nytt.
Om kommunikasjonsprosessen til motpart her DIALOG_INNBYGGER_TIMERESERVASJON eller DIALOG_INNBYGGER_AVTALEAVBESTILLING. Om den har en av disse så vil bruker kunne avbestille timen.
Vi returnerer MessageFunction i kallet som inneholder den kommunikasjonsprossessen motpart har, der timereservasjon blir valgt over avtaleavbestilling. Denne blir sendt til avbestilling av time når man gjør dette kallet når man trykker på knappen og bestemmer hvilket kommunikasjon
Om timen ikke har motpart så sjekker man i databasen om timen har KanAvbestilles og eventuelt om den er innenfor dato når man kan avbestilles (gjerne en gitt tid før timen). Om man kan avbestille timen og datoen er innenfor så vil brukeren kunne avbestille timen.
Expand
title
Sikkerhetsmodell
Mekanisme
Benyttes
Beskrivelse
1-veis SSL
X
2-veis SSL
-
Brukernavn/passord
-
API-nøkkel
-
Token
-
Meldingskryptering
X
Meldingskryptering med virksomhetssertifikat
Meldingsignering
X
Signering med virksomhestsertifikat
Expand
title
Benytter av følgende komponenter
Navn
Type
Beskrivelse
components>
</vcalendar>
Generell info om meldingsutveksling med Helsenorge