Hendelsevarsel til innbygger

Dette er en funksjon for å varsle innbyggere om viktige hendelser på Helsenorge. Den kan brukes for å informere innbyggere om hendelser i tjenester som vises på Helsenorge, men hvor data er lagret i eksterne løsninger. For eksempel så kan innbygger se prøvesvar på Helsenorge, men fordi prøvesvarene hentes når innbygger går inn på siden, vet ikke Helsenorge at det har kommet nye prøvesvar og kan derfor ikke varsle selv.

Disse varslene vil vises for innbygger under Varsler på Helsenorge. En hendelse refererer til en ressurs som er kjent på Helsenorge, slik at når innbygger klikker på hendelsen, tas innbygger til den aktuelle ressursen. Avhengig av type hendelse det varsles om, kan innbygger også motta varsel om hendelsen via SMS/e-post. Det er Helsenorge som styrer om innbygger skal varsles på sms/e-post. Hvis en aktør ønsker å skru av sms/epost varsel for et hendelsesvarsel, så vil det gjelde alle varsler knyttet til den typen hendelsesvarsel.

Hendelsevarsel kan sendes til Helsenorge via API-integrasjon (REST). APIet returnerer respons på om Hendelsevarselet kunne mottas, og dermed vil vises for innbygger på Helsenorge.

Forutsetninger for bruk av Hendelsesvarsel:

Hva slags meldinger kan sendes med denne tjenesten:
- Varsel om hendelser i tjenester som vises 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	Hendelsevarsel
Funksjonelt område	Hendelsemeny
API-versjon og dato publisert	v1.0 Nov 17, 2023
Status	I DRIFT
API-dokumentasjon sist endret	Jan 12, 2024
Teknologi	REST + FHIR

Funksjonell beskrivelse

Id	Brukerhistorie	Forretningsmessige akseptansekriterier
1	Som aktør vil jeg varsle innbygger om hendelse på Helsenorge slik at innbygger tydelig blir gjort oppmerksom på hendelsen
2	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
3	Som Helsenorge vil jeg vite hva hendelsen gjelder slik at vi kan vise relevant hendelse og evt varsle innbygger	Innbygger ser et varsel på Helsenorge som inneholder tittel, beskrivelse (valgfri), ikon som representerer hendelsesvarseltypen, tidspunkt for når hendelsesvarslet er mottatt samt lenke til elementet eller siden elementet ligger på. Innbygger mottar sms/epost i henhold til varselprofilen hvis det er satt opp for hendelsesvarseltypen.
4	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.
5	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.

Ulike typer hendelsesvarsler

Type hendelsesvarsel	Beskrivelse	Hvem får varselet på sms/e-post ?	Hvem varsler

Type hendelsesvarsel

Beskrivelse

Hvem får varselet på sms/e-post ?

Hvem varsler

Nytt eller endret prøvesvar

Brukes for å informere innbygger om at de har fått et nytt eller endret prøvesvar i prøvesvartjenesten

Innbyggere som har valgt:

så mange varsler som mulig, eller
standard varsling, eller

Helsenorge sender ut varsel i henhold til innbyggers oppsett på Helsenorge

Hendelse/påminnelse fra eksternt verktøy

Brukes for å informere innbygger om viktige hendelser i eksterne verktøy

Avhengig av innbyggers innstilling i det eksterne verktøyet

Aktøren/verktøyet må sende ut varselet selv på SMS eller e-post

Nytt journaldokument (kommer)

Brukes for å informere innbygger om at de har fått et nytt dokument i pasientjournalen

Innbyggere som har valgt:

så mange varsler som mulig, eller
standard varsling

Helsenorge sender ut varsel i henhold til

innbyggers oppsett på Helsenorge

Flere typer kan bli utviklet og tilrettelagt ved behov

For oversikt over de konkrete varslene som Helsenorge sender ut se: https://helsenorge.atlassian.net/wiki/x/BIDekQ

Prosesser og flyt

Teknisk implementasjon av Hendelsevarsel

Payload

En Hendelsesvarsel er alltid representert ved en FHIR CommunicationRequest: Detaljert beskrivelse: CommunicationRequest - Hendelsesvarsel

REST API

Autorisasjon

To metoder for tilgang er tilgjengelige:

HelseId sin autoriseringstjeneste for maskin-til-maskin kan benyttes:
1. Velg Helsenorge Ekstern API i HelseId sin selvbetjeningsløsning
2. Velg deretter scope “Hendelsevarsel”
3. Når tilgangen er godkjent av Helsenorge, kan aksesstoken hentes ut fra HelseId
API-klienten kan alternativt autentisere seg mot Helsenorge Sikkerhetstjeneste.
1. API-klienten må forhåndskonfigureres på Helsenorge med sin public key
2. API-et skal benyttes i system-til-system kontekst: 01 - System til System
3. Deretter kan API-klienten få utsedt et AksessToken fra Helsenorge STS.

AksessToken som mottas fra HelseId eller Helsenorge STS skal deretter være med i Authorization header i alle HTTP-requestene. Se: 02 - Kall til Helsenorge og PVK API'er og bruk av AccessToken

Bruk av API’et

(HTTP POST): Helsenorge bestemmer ressursens ID. FHIR - REST Operasjoner | Create HTTP POST
URL til REST API: POST [baseUrl for ekstern-API til HN-system]/videreformidling-fhir/v1/CommunicationRequest
- Se her for oversikt over baseURL’er til de forskjellige systemene: Testmiljøer og endepunkter

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: Prinsipper for bruk av FHIR-ressurser i Hodemelding (ved meldingsutveksling/AMQP)

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 Hodemelding 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: CommunicationRequest - Hendelsesvarsel

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: Meldingsutveksling med Helsenorge