AMQP Hent planlagte avtaler

Owned by kjetill.vassmo.lund, created
Last updated: Aug 25, 2023 by kjetill.vassmo.lund
7 min read

«Hent planlagte avtaler» gir innbygger tilgang til å hente fremtidige planlagte avtaler. Denne funksjonaliteten benyttes for avtaler som er flyktige, repeterende og der det ikke er hensiktsmessig å sende en notifikasjon for hver timeavtale til helsenorge.no.

Her henter helsenorge.no planlagte avtaler hos tjenesten som er angitt som mottaker i Hodemeldingen.

Denne tjenesten brukes kun av hjemmebaserte tjenester (Digihelseløsningen). Bruk utover dette må avtales spesifikt.

Premisser for tjenesten:

  • Fremtidige avtaler må kunne eksponeres ved oppslag slik at innbygger kan se disse



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

Prosesser og flyt

Informasjon om prosesser og flyt

Merk at det ikke skal sendes applikasjonskvittering for denne prosessen.

Følgende prosess skal aktiveres i adresseregisteret for å støtte funksjonaliteten.

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.

Versjon

Rolle

Funksjon

Meldingsinnhold

1.2

Innbygger

HentLedigeTimer

HentPlanlagteTimer

ReserverAvtale

AvbestillAvtale

·         Dialogmelding 1.1

·         Pasientrelasjon

·         iCalendar 2.0

Helsepersonell

Avtale

SvarLedigeTimer

SvarPlanlagteTimer

SvarTimeReservasjon

·         Dialogmelding 1.1

·         Helsepersonell

·         iCalendar 2.0

Se ytterligere detaljer i innholdsstandarder for innhold i meldinger

Forespørsel om hent ledige timer, synkron tjeneste

Strukturen på forespørselen

Tjeneste

Forespørsel om hent ledige timer, synkron tjeneste

Bruksområde

Forespørsel fra helsenorge.no for å hente planlagte besøk 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="Nei" V="N"/>

Dialogmelding

Obligatoriske elementer (klasse/element):

  • Dialogmelding/Foresporsel/TypeForesp

 

Lovlige kodeverdier som kan brukes i TypeForesp:

  • HBT  Hent bestilte timer

 

XML eksempel:

<Foresporsel> <TypeForesp V="HBT" DN="Hent bestilte timer" S="2.16.578.1.12.4.1.1.7601"/> </Foresporsel>

RollerRelatertNotat

Ikke aktuelt å bruke for denne tjenesten.

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.

Eksempelsvis når person med fullmakt ser kalender på vegne av pasient

Se Pasientrelasjon for korrekt bruk.

Vedlegg

Ikke aktuelt å bruke for denne tjenesten

 

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

Struktur på respons

For svar på hent innbyggers planlagte besøk svarer kommunikasjonsparten med alle innbyggers fremtidige besøk. Icalendar benyttes for å oversende kalenderinformasjon og flere forretningsregler benyttes for å generere, sende og motta denne informasjonen:

  • Planlagte avtaler

    • Avtalene er typisk repeterende

    • Alle planlagte avtaler fra og med dagens dato returneres.

      • Startdato for repeterende avtaler settes lik dagens dato

      • Planlagte avtaler der det er generert en arbeidsliste og det er laget en bekreftet avtale returneres ikke. Dette for å unngå å vise duplikater mellom bekreftede avtaler og repeterende avtaler

    • Attendee er typisk ikke kjent

    • Unntak fra repetisjon angis ved å bruke exdate, for eksempel ved en midlertidig stopp angis hvilke datoer der avtale ikke finner sted. Hver dato angis med et eget exdate element  

    • Status= TENTATIVE

    • Organizer benyttes for å angi hvem som er ansvarlig for besøket. Standardelementet Organizer er en mailadresse, der navn kan legges inn som en parameter

      • Parameteren CN benyttes for å sende navn på organisasjon som er ansvarlig

    • X-expected-duration benyttes til å angi forventet varighet for besøk dersom avtalen er et tidsvindu

    • TjenesteId til tjenesten som avtalen er knyttet til angis i Categories

    • Summary angir navnet på tjenesten som leveres

    • Location angir hvor avtalen finner sted, per nå benyttes bare "Hjemmebesøk"

  • Bekreftede avtaler, der arbeidslister er laget, sendes som enkeltstående besøk der hvert besøk har en egen vevent

    • Attendee benyttes for å angi ansatt som utfører besøket. Standardelementet attendee er en mailadresse, der navn kan legges inn som en parameter

      • Parameteren CN benyttes for å sende navn på ansatt

      • Ved flere ansatte benyttes flere attendee element

    • Status=CONFIRMED

    • Bekreftede avtaler returneres fra dagens dato og fremover, men ikke for avtaler som er utført

      • Alle bekreftede avtaler som ikke er utført fra og med kl 00:00 i dag returneres

  • Avlyste avtaler

    • Alle avlyste avtaler fra og med dagens dato returneres.

    • Status= CANCELLED

    • Organizer benyttes for å angi hvem som er ansvarlig for besøket. Standardelementet Organizer er en mailadresse, der navn kan legges inn som en parameter

      • Parameteren CN benyttes for å sende navn på organisasjon som er ansvarlig

    • TjenesteId til tjenesten som avtalen er knyttet til angis i Categories

    • Summary angir navnet på tjenesten som leveres

    • Location angir hvor avtalen finner sted, for Digihelse benyttes per nå bare "Hjemmebesøk"

 

I timebok vil det kunne ligge inne overlappende avtaler, med samme

  • starttidspunkt (xcal:dtstart)

  • slutttidspunkt (xcal:dtend)

  • ansvarlig kommune (xcal:contact)

  • tjenestetype (xcal:summary)

Disse avtalene skal vises som en sammenstilt avtale i timebok i Helsenorge. Dersom det angis en forventet varighet på avtalene, vil den summeres.

Tjeneste

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

Bruksområde

Svar fra kommunikasjonspart med planlagte timer for tjenesten.

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/Notat/Temakodet

 

Elementet Dialogmelding/Notat/Foresporsel benyttes ikke i svarmelding.

 

Lovlige kodeverdier som kan brukes i Dialogmelding/Notat/Temakodet:

  • 01     Bestilte timer

  • 02     Ingen bestilte 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>:

  • 26     Forespørsel avvist

  • 30     Ikke tilgang

 

XML eksempel:

RollerRelatertNotat

Ikke aktuelt å bruke for denne tjenesten

iCalender

Obligatorisk når informasjon om tidspunkt sendes til helsenorge.no .

Dersom koden «Ingen bestilte timer» returneres skal iCalendar ikke benyttes.

 

XML eksempel med to avtaler, en bekreftet og en ukentlig repeterende som er planlagt. Den repeterende avtalen er et tidsvindu, der forventet varighet er 30 min.

TjenesteId i Categories angir hvilken tjeneste innbygger mottar fra kommunen som avtalen er knyttet til.

Helsepersonell

Ikke aktuelt å bruke for denne tjenesten

Pasientrelasjon

Ikke aktuelt å bruke for denne tjenesten

Vedlegg

Ikke aktuelt å bruke for denne tjenesten

Generell info om meldingsutveksling med Helsenorge

For overordnet informasjon om meldingsutveksling med Helsenorge se her: Meldingsutveksling med Helsenorge

Ytterligere informasjon