AMQP Meldingsformidling til innbygger

 

 

Med meldingsformidling til innbygger kan aktører i helsesektoren sende meldinger til innbygger. Løsningen har støtte for videreformidling av meldingen til digital postkasse og/eller fysisk post, slik at det er mulig å kommunisere med innbyggeren uavhengig av om innbygger har tatt i bruk helsenorge.no eller ikke. Det er støtte for vedlegg, slik at man kan sende med dokumenter som for eksempel innkallingsbrev. Det er lagt inn støtte for å få vite status på forsendelsen via en egen meldingstype kalt leveringsrapport.

API-navn

DIALOG_INNBYGGER_MELDINGSFORMIDLING

Funksjonelt område

Dialog

API-versjon og dato publisert

v1.1 Feb 10, 2020

Status

I Drift

API-dokumentasjon sist endret

Jan 9, 2024 (Avsenders angivelse av Innholdstype er gjort obligatorisk. Videreformidling skjema 1.0 støttes ikke lenger)

Teknologi

AMQP

Prosesser og flyt

Her er info om prosesser og flyt

Sekvensdiagram for prosessen er vist i figuren under:

Nyeste versjon av prosessen skal utvikles og aktiveres i adresseregisteret for nye aktører.

Prosess

Funksjonalitet

Versjon

Dialog_Innbygger_Meldingsformidling

Basisversjon for kommunikasjonsprosess.

1.0

Dialog_Innbygger_Meldingsformidling

Oppdaterte skjema for videreformidling og leveringsrapport

1.1

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

Helsepersonell

Melding

Dialogmelding 1.0

MeldingInnbygger 1.0

Vedlegg

Videreformidling 1.0 (“conditional”- må være med dersom videreformidling ønskes til innbyggere som ikke er digital aktive på Helsenorge)

Innbygger

Leveringsrapport

Dialogmelding 1.0

Leveringsrapport 1.0

1.1

Helsepersonell

Melding

Dialogmelding 1.0

MeldingInnbygger 1.0

Vedlegg

Videreformidling 1.1 (“conditional”- må være med dersom videreformidling ønskes til innbyggere som ikke er digital aktive på Helsenorge)

Innbygger

Leveringsrapport

Dialogmelding 1.0

Leveringsrapport 1.1

Meldingsformidling til innbygger

Meldingformidlimng til innbygger kan inneholde to skjema; MeldingInnbygger og Videreformidling (valgfritt) i tillegg til vedlegg.

Tjeneste

Melding til innbygger, asynkron tjeneste

Bruksområde

Brukes når en ekstern aktør skal sende melding/post til innbygger

Hodemelding

Obligatorisk, og benyttes i henhold til beskrivelse i Hodemelding

Obligatorisk verdi i «MsgHead/MsgInfo/Type» er:

<Type V="DIALOG_INNBYGGER_MELDINGSFORMIDLING " DN="Melding eller varsel til innbygger"/>


Obligatorisk verdi «MsgHead/MsgInfo/Ack» er:

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

 

Dialogmelding

Obligatorisk, og benyttes i henhold til beskrivelse i Dialogmelding

Obligatoriske elementer (klasse/element):

  • Dialogmelding/Foresporsel/TypeForesp

Lovlige kodeverdier som kan brukes i TypeForesp:

  • MTI – Melding til innbygger

XML-eksempel:

<Foresporsel> <TypeForesp V="MTI" S="2.16.578.1.12.4.1.1.7601" DN="Melding til innbygger"/> </Foresporsel>

MeldingInnbygger

Obligatorisk, og benyttes i henhold til beskrivelsen nedenfor under Ytterligere Informasjon.

Obligatoriske elementer:

  • Innholdstype

  • Emne

  • Meldingsavsender

  • Meldingstekst

  • SvarTillatt

 

Valgfrie elementer:

  • UtsattVisningstidspunkt

  • DelInnholdMedHelsepersonell

  • Lenkereferanse

Se detaljert beskrivelse av denne innholdsstandearden her: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/1985839105

XML-eksempel:

Vedlegg

Valgfritt element, og benyttes i henhold til Vedlegg

Dersom brev skal til print skal ett av dokumentene settes som hoveddokument og er dokumentet som printes først. Dersom ingen dokument er markert som hoveddokument, så vil HElsenorge sette første dokument til hoveddokument.


XML-eksempel som inneholder Document-delen fra hodemeldingen:

Videreformidling

Valgfritt element, og benyttes i henhold til Videreformidling under Videreformidling.
Versjon 1.0 og 1.1 har nært identisk innhold, så eksemplet er for versjon 1.1.

Obligatoriske elementer:

  • Kanalvalg / Mottakeravgrensning

  • OmfattetAvReservasjonsrett

  • Leveringsrapport

  • Organisasjonsnummer (konto hos DigDir)

 

Betingede elementer:

  • InfoFysiskPost (må med dersom Kanalvalg.GodkjentForFysiskPost = true)

  • InfoDPI (må med dersom Kanalvalg.GodkjentForDPI = true)

 

Valgfrie elementer:

  • AvsenderIdentifikator

  • Fakturareferanse

Se detaljert beskrivelse av denne innholdsstandarden her: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/1348174527

XML-eksempel Videreformidling 1.1:

Skjema MeldingInnbygger

Se innholdsstandarden her: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/1985839105

Funksjonell beskrivelse av attributtene er dokumentert på siden:

 

 

Skjema Videreformidling

Videreformidling inneholder informasjonen som trengs for å kunne formidle meldingen videre til andre kanaler enn Helsenorge. Valgfritt skjema.

Funksjonell beskrivelse av attributtene er dokumentert på siden:

Leveringsrapport

Avsender kan be om å motta leveringsrapport som inneholder informasjon om kanal og status på levering av meldingen.

Ytterligere informasjon

 

Innholdsstandarder for Meldingsformidling

For meldingsformidling benyttes tre spesifikke meldingsformater (skjema), samt Vedlegg.

Se beskrivelse av innholdsstadard:

Se beskrivelse i Videreformidling under Videreformidling

Leveringsrapport

Se beskrivelse i Videreformidling under Leveringsrapport

Leveringsrapport på videreformidlet melding (LRP)

Tjeneste

Leveringsrapport, svar - asynkron tjeneste

Bruksområde

Melding med status på forsendelser som anvender videreformidling, sendt fra Helsenorge til Avsender.

Hodemelding

Obligatorisk, og benyttes i henhold til beskrivelse i

Obligatorisk verdi i «MsgHead/MsgInfo/Type» er:

Obligatorisk verdi «MsgHead/MsgInfo/Ack» er:

Dialogmelding

Obligatorisk, og benyttes i henhold til beskrivelse i

 

Obligatoriske elementer (klasse/element):

  • Dialogmelding/Foresporsel/TypeForesp

 

Lovlige kodeverdier som kan brukes i TypeForesp:
   LRP – Leveringsrapport på videreformidlet melding

XML-eksempel:

Leveringsrapport

Obligatorisk, og benyttes i henhold til under Leveringsrapport.

Obligatoriske elementer:

  • Formidlingskanal

 

Betingede elementer:

  • Leveringsstatus.Levert

  • Leveringsstatus.Feilmelding

  • Leveringsstatus.Varslingfeilet

  • Leveringsstatus.Mottattpost

  • Leveringsstatus.Returpost

 

XML-eksempel: