AMQP Avtaleavbestilling

Prosessen avtaleavbestilling er identisk med funksjonen for innbygger å sende avbestilling i prosessen https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/1462108169 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. En forutsetning for å kunne benytte denne prosessen er at helseaktør tilbyr timevisning og at innbygger har en helsekontakt.

API-navn

DIALOG_INNBYGGER_AVTALEAVBESTILLING

Funksjonelt område

Dialog

API-versjon og dato publisert

v1.0 Oct 25, 2018

Status

I Drift

API-dokumentasjon sist endret

Feb 11, 2021

Teknologi

AMQP

Kommunikasjonsprosess

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

Se ytterligere detaljer i innholdsstandarder for innhold i meldinger

Forespørsel fra innbygger om avbestilling

 

Med forespørsel om avbestilling kan innbygger sende en forespørsel om å avbestille en time.

Denne funksjonen dekker avbestilling som beskrevet i https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/1462108169 under Reservasjon av valgt time.

Tjeneste

Forespørsel om avbestilling, asynkron tjeneste

Bruksområde

Brukes når innbygger ønsker å avbestille en reservert time.

Hodemelding

Obligatorisk, og benyttes i henhold til beskrivelse i https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/1348174397

 

Obligatorisk verdi i MsgHead/MsgInfo/Type er:

<Type V="DIALOG_INNBYGGER_AVTALEAVBESTILLING" DN="Dialog med innbygger - avtaleavbestilling "/>

 

Obligatorisk verdi i MsgHead/MsgInfo/Ack er:

<Ack DN="Ja" V="J"/>

 

Referanse til samtaletråd settes til meldingen som ble sendt for timenotifikasjon, beskrevet i

<ConversationRef> <RefToParent>f5896674-1147-46f0-bc9b-6b6bde5bb844</RefToParent> <RefToConversation>f5896674-1147-46f0-bc9b-6b6bde5bb844</RefToConversation> </ConversationRef>

Dialogmelding

Obligatoriske elementer (klasse/element):

  • Dialogmelding/Foresporsel/TypeForesp

 

Lovlige kodeverdier som kan brukes i TypeForesp:

  • ART  Avbestill reservert time

 

iCalender

Obligatorisk når informasjon om tidspunkt sendes til legekontor.

Elementene under iCal/vevent skal ha følgende innhold

  • dtstart: tidspunkt for gjeldende time, start

  • dtend: tidspunkt for gjeldende time, slutt

  • uid: id for timeavtalen som ønskes avbestilt

  • contact: HER-id for kommunikasjonspart som timeavtale tilhører

 

Følgende valgfrie informasjon kan benyttes:

  • Summary: Hva timen gjelder

  • Description: Fritekst informasjon om hvorfor avbestilling sendes

 

XML eksempel:

 

Svar på forespørsel om avbestilling

Innholdet i Dialogmeldingen for svar på forespørsel er identisk med svar som beskrevet i 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

 

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

 

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

  • Cancellation-reason: årsak til avlysning

XML eksempel:

Generell info om meldingsutveksling med Helsenorge

For overordnet informasjon om meldingsutveksling med Helsenorge se her: 

Eksempelmeldinger

Logikk for å avgjøre om innbygger kan avbestille timen

For å finne ut om "Avbestille time" knappen skal vises gjør Helsenorge følgende sjekker:

  1. Dersom timen venter på svar for avbestilling eller endring, eller om avbestilling er avvist, så vil bruker ikke kunne avbestille timen på nytt. 

  2. Dersom avsender av timevtalen støtter DIALOG_INNBYGGER_TIMERESERVASJON eller DIALOG_INNBYGGER_AVTALEAVBESTILLING så vil bruker kunne avbestille timen.

    1. Dersom begge støttes vil avbestillingen sendes med meldingstypen DIALOG_INNBYGGER_TIMERESERVASJON.