Hendelsesvarsel til innbygger

Denne tjenesten er under etablering. API er ikke tilgjengelig i test eller produksjonsmiljøer ennå, men forventes tilgjengelig i Produksjon i løpet av Q1-2024.

APIet tilbyr eksterne aktører å sende varsel til innbygger om nye hendelser via Helsenorge. Innbygger vil varsles om ny hendelse på Helsenorge. Når innbygger logger inn på Helsenorge vil hendelsene vises i “Hendelsesmenyen”. En hendelse kan referere til en ressurs som er kjent på Helsenorge, slik at når innbygger klikker på hendelsen tas innbygger til den aktuelle ressursen. Hendelsesvarsel kan sendes til Helsenorge via API-integrasjon eller meldingsbasert integrasjon. (Meldingsbasert integrasjon implementeres først når første aktør trenger dette)

APIet returnerer respons på om Hendelsesvarselet kunne mottas, og dermed vil vises for innbygger på Helsenorge. På sikt kan det også etableres mekanismer for å sjekke leveransestatus på at varsling av innbygger om mottatt Hendelsevarsel på Helsenorge var vellykket eller ikke.

Forutsetninger for bruk av Hendelsesvarsel (under utarbeidelse):

Hva slags meldinger kan sendes med denne tjenesten:
- Varsel om hendelser på Helsenorge, eksempelvis nytt prøvesvar eller påminnelse fra verktøy
Hvilke aktører kan bruke tjenesten:
- Offentlig helseaktør, eller aktør med offentlig avtale
- Aktører med tjenester på Helsenorge

API-navn	Hendelsesvarsel
Funksjonelt område	Hendelsesmeny
API-versjon og dato publisert	v1.0 Nov 17, 2023
Status	I DRIFT
API-dokumentasjon sist endret	Jan 12, 2024
Teknologi	REST + FHIR (AMQP + FHIR, avventes)

Forretningsbehov

Id	Brukerhistorie	Forretningsmessige akseptansekriterier
	Som aktør vil jeg varsle innbygger om hendelse på Helsenorge slik at innbygger tydelig blir gjort oppmerksom på hendelsen
	Som aktør vil jeg kunne sende med referanse til en tjeneste eller element som vises på Helsenorge, slik at innbygger kan ledes direkte til relevant tjeneste eller spesifikt element fra hendelsen
	Som Helsenorge vil jeg vite hva hendelsen gjelder slik at vi kan vise relevant hendelse og evt varsle innbygger
	Som aktør vil jeg kunne oppgi at foreldre til barn ikke kan se hendelse, slik at jeg kan ta hensyn til barnets rettigheter.	Støttes ikke i V1, vil implementeres som del av prosjektet der ungdom 13-15 år skal kunne benytte Helsenorge med foreldrenes samtykke.
	Som aktør vil jeg kunne oppgi at bare foreldrene kan se hendelse jeg sender til et barn, slik at barn ikke får informasjon de ikke bør eksponeres for.	Støttes ikke i V1, vil implementeres som del av prosjektet der ungdom 13-15 år skal kunne benytte Helsenorge med foreldrenes samtykke.
	Som aktør vil jeg få tilbakemelding hvis Helsenorge ikke kan formidle hendelse til innbygger på Helsenorge, slik at jeg kan varsle innbygger i annen kanal.

Prosesser og flyt

Innsending av Hendelsesvarsel

Payload

En Hendelsesvarsel er alltid representert ved en FHIR CommunicationRequest: Detaljert beskrivelse: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/2066120717 MERK! Endring med nytt obligatorisk element 2024-01-12.

REST API

Det benyttes sikkerhetsmodell system-til-system: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/1886191617
- AksessToken inkluderes i header i etterfølgende HTTP-kall til API’et: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/23789578/02+-+Kall+til+Helsenorge+og+PVK+API+er+og+bruk+av+AccessToken
(HTTP POST): Helsenorge bestemmer ressursens ID.
URL til REST API: POST [baseUrl for ekstern-API til HN-system]/videreformidling-fhir/v1/CommunicationRequest (endret 2023-01-12)
- Se her for oversikt over baseURL’er til de forskjellige systemene:

Meldingsbasert integrasjon (AMQP)

Sending av Hendelsesvarsel kan også skje ved meldingsbasert integrasjon. (Vil først implementeres når første aktør har slik behov). Hodemeldingen inneholder da eksakt samme “payload” som det som postes i REST-API’et.

Se prinsippene for meldingsbasert integrasjon med FHIR API’er på helsenorge:

Struktur på AMQP-melding ved meldingsbasert integrasjon

Tjeneste	Hendelsesvarsel
Bruksområde	Ekstern aktør ønsker å sende et hendelsesvarsel til innbygger
Hodemelding	Obligatorisk, og benyttes i henhold til beskrivelse i Obligatorisk verdi i MsgHead/MsgInfo/Type er: `<Type V="DIALOG_INNBYGGER_HENDELSESVARSEL" DN="Dialog med innbygger – hendelsesvarsel" />` Obligatorisk verdi i MsgHead/MsgInfo/Ack er: `<Ack DN="Ja" V="J"/>`
Dialogmelding	Ikke aktuelt å bruke for denne tjenesten.
iCalender	Ikke aktuelt å bruke for denne tjenesten
Helsepersonell	Ikke aktuelt å bruke for denne tjenesten.
Pasientrelasjon	Ikke aktuelt å bruke for denne tjenesten.
Vedlegg	Ikke aktuelt å bruke for denne tjenesten
FHIR ressurs (i Document)	CommunicationRequest:

Støtte for kommunikasjonsprosessen i Adresseregisteret

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

Prosessen er ikke etablert i Adresseregisteret ennå og er ikke valgbar.

Prosess	Funksjonalitet	Versjon
Dialog_Innbygger_Hendelsesvarsel	Basisversjon for 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.

Versjon

Rolle

Funksjon

Meldingsinnhold

1.0

Innbygger

Applikasjonskvittering

Helsepersonell

Hendelsesvarsel

Hodemelding

FHIR CommunicationRequest

Eksempel på bruk av FHIR CommunicationRequest i Hodemelding

<?xml version="1.0" encoding="iso-8859-1"?>
<MsgHead 
  xmlns="http://www.kith.no/xmlstds/msghead/2006-05-24">
  <MsgInfo>
    <!-- Meldingens funksjon Volven-kodeverk 8279 -->
    <Type V="DIALOG_INNBYGGER_HENDELSESVARSEL" DN="Dialog med innbygger - hendelsesvarsel" />
    <MIGversion>v1.2 2006-05-24</MIGversion>
    <GenDate>2023-12-29T11:34:00.0513824+01:00</GenDate>
    <MsgId>d43723fe-a526-4c00-86b2-da3f4ae52cb8</MsgId>	
	<Ack DN="Ja" V="J" />
    <Sender>
      <Organisation>
        <OrganisationName>HELSEDIREKTORATET</OrganisationName>
        <Ident>
          <Id>2397</Id>
          <TypeId V="HER" S="2.16.578.1.12.4.1.1.9051" DN="Her-id" />
        </Ident>
        <Organisation>
          <OrganisationName>DD.TEST</OrganisationName>
          <Ident>
            <Id>8091467</Id>
            <TypeId V="HER" S="2.16.578.1.12.4.1.1.9051" DN="Her-id" />
          </Ident>
        </Organisation>
      </Organisation>
    </Sender>
    <Receiver>
      <Organisation>
        <OrganisationName>Direktoratet for e-helse</OrganisationName>
        <Ident>
          <!-- HERID i TEST: 115851, HERID i Prod: ? -->
          <Id>115851</Id>
          <TypeId V="HER" S="2.16.578.1.12.4.1.1.9051" DN="Her-id" />
        </Ident>
        <Organisation>
          <OrganisationName>Digitale innbyggertjenester</OrganisationName>
          <!-- HERID'er i DEV/TEST: TEST01: 8093248, TEST02: 8093247, QA: 8093249, MAS-01: 8093244, MAS-02: 8093239 -->
          <Ident>
            <Id>8093248</Id>
            <TypeId V="HER" S="2.16.578.1.12.4.1.1.9051" DN="Her-id" />
          </Ident>
        </Organisation>
      </Organisation>  
    </Receiver>
  </MsgInfo>
  <Document>
    <!-- Dette er et selvstendig objekt som inneholder all informasjon knyttet til Hendelsesvarselet. 
      Resten av (hode) meldingen er i utgangspunktet KUN transport. -->
    <ContentDescription>FHIR CommunicationRequest</ContentDescription>
    <RefDoc>
      <MsgType V="XML" DN="XML-instans" />
      <Content>
        <CommunicationRequest>
          …………..

        </CommunicationRequest>    
       </Content>
    </RefDoc>
  </Document>
</MsgHead>

Generell info om meldingsutveksling med Helsenorge

For overordnet informasjon om meldingsutveksling med Helsenorge se her: