Husk å legg til etiketten “api-dokumentasjon” når denne malen benyttes, samt å slette denne notisen
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.
Page Properties
API-navn
DIALOG_INNBYGGER_MELDINGSFORMIDLING
Funksjonelt område
Dialog
API-versjon og dato publisert
v1.1
Status
Status
colour
Green
title
I Drift
API-dokumentasjon sist endret
Teknologi
Status
colour
Purple
title
AMQP
Prosesser og flyt
Her er info om prosesser og flyt
Expand
title
Overordnet flyt og sekvensdiagram
Sekvensdiagram for prosessen er vist i figuren under:
Image Removed
Versjon 1.0 av prosessen skal aktiveres i adresseregisteret for å støtte funksjonaliteten.
Prosess
Funksjonalitet
Versjon
Dialog_Innbygger_Meldingsformidling
Gammel versjon med begrenset utbredelse. Videreføres ikke og dokument videreformidles ikke til andre, dvs sendes kun til innbyggere på Helsenorge.
0.8
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
0.8
Helsepersonell
Melding
Dialogmelding 1.1
MeldingTilIInnbygger 0.8
Vedlegg
1.0
Helsepersonell
Melding
Dialogmelding 1.0
MeldingInnbygger 1.0
Vedlegg
Videreformidling 1.0
Innbygger
Leveringsrapport
Dialogmelding 1.0
Leveringsrapport 1.0
1.1
Helsepersonell
Melding
Dialogmelding 1.0
MeldingInnbygger 1.0
Vedlegg
Videreformidling 1.1
Innbygger
Leveringsrapport
Dialogmelding 1.0
Leveringsrapport 1.1
Melding til innbygger (MTI)
Expand
title
Struktur på melding
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 kapittel 2.3
Obligatorisk verdi i tillegg til adressering i «MsgHead/Sender» er organisasjonsnummeret:
Code Block
<Ident>
<Id>915933149</Id>
<TypeId V="ENH" S="2.16.578.1.12.4.1.1.9051" DN="Organisasjonsnummeret i Enhetsregister"/>
</Ident>
Organisasjonsnummeret anvendes til å finne rett avsenderpostkasse hos Digdir. Denne vil endres til kun å gjelde hvis man har med videreformidlings-skjemaet, men per nå er feltet påkrevd for begge scenarioene.
Obligatorisk verdi i «MsgHead/MsgInfo/Type» er:
Code Block
<Type V="DIALOG_INNBYGGER_MELDINGSFORMIDLING " DN="Melding eller varsel til innbygger"/>
Obligatorisk verdi «MsgHead/MsgInfo/Ack» er:
Code Block
<Ack V="J" DN="Ja"/>
Dialogmelding
Obligatorisk, og benyttes i henhold til beskrivelse i kapittel 2.4
Obligatoriske elementer (klasse/element):
Dialogmelding/Foresporsel/TypeForesp
Lovlige kodeverdier som kan brukes i TypeForesp:
MTI – Melding til innbygger
XML-eksempel:
Code Block
<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:
Emne
Meldingsavsender
Meldingstekst
SvarTillatt
Valgfrie elementer:
Innholdstype
UtsattVisningstidspunkt
DelInnholdMedHelsepersonell
XML-eksempel:
Code Block
<MeldingInnbygger xmlns="http://ehelse.no/xmlstds/MeldingInnbygger/2018-09-25">
<Innholdstype V="IB" S="2.16.578.1.12.4.1.1.7613" DN="Innkallingsbrev"/>
<Emne>Innkallingsbrev fra STHF</Emne>
<Meldingsavsender>Sykehuset Telemark - Radiologiavdelingen</Meldingsavsender>
<Meldingstekst>Innkalling til innbygger hos foretak ABC</Meldingstekst>
<SvarTillatt>false</SvarTillatt>
<UtsattVisningstidspunkt>2018-10-28T09:30:00Z</UtsattVisningstidspunkt>
<DelInnholdMedHelsepersonell V="6" S="2.16.578.1.12.4.1.1.9246" DN="Fastlege"/>
<SensitivAvsender>false</SensitivAvsender>
</MeldingInnbygger>
Vedlegg
Valgfritt element, og benyttes i henhold til kapittel 2.10
XML-eksempel som inneholder Document-delen fra hodemeldingen:
Valgfritt element, og benyttes i henhold til kapittel 2.12.1: Videreformidling. Versjon 1.0 og 1.1 har nært identisk innhold, så eksemplet er for versjon 1.1.
Melding med status på forsendelser som anvender videreformidling, sendt fra Helsenorge til Avsender.
Hodemelding
Obligatorisk, og benyttes i henhold til beskrivelse i kapittel 2.3.
Obligatorisk verdi i «MsgHead/MsgInfo/Type» er:
Code Block
<Type V="DIALOG_INNBYGGER_ MELDINGSFORMIDLING " DN=" Melding eller varsel til innbygger "/>
Obligatorisk verdi «MsgHead/MsgInfo/Ack» er:
Code Block
<Ack DN="Ja" V="J"/>
Dialogmelding
Obligatorisk, og benyttes i henhold til beskrivelse i kapittel 2.4
Obligatoriske elementer (klasse/element):
Dialogmelding/Foresporsel/TypeForesp
Lovlige kodeverdier som kan brukes i TypeForesp: LRP – Leveringsrapport på videreformidlet melding
XML-eksempel:
Code Block
<Foresporsel>
<TypeForesp V="LRP
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.
Page Properties
API-navn
DIALOG_INNBYGGER_MELDINGSFORMIDLING
Funksjonelt område
Dialog
API-versjon og dato publisert
v1.1
Status
Status
colour
Green
title
I Drift
API-dokumentasjon sist endret
Teknologi
Status
colour
Purple
title
AMQP
Info
Endringer januar 2024:
Avsenders angivelse av Innholdstype er gjort obligatorisk i MTI-skjema.
Videreformidling skjema 1.0 støttes ikke lenger, og organisasjonsnummer til den virksomhet som har inngått avtale med DigDir om utskrift skal angis i videreformidlingsskjema 1.1.
Prosesser og flyt
Her er info om prosesser og flyt
Expand
title
Overordnet flyt og sekvensdiagram
Sekvensdiagram for prosessen er vist i figuren under:
Image Added
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.
Expand
title
Struktur på melding
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:
Code Block
<Type V="DIALOG_INNBYGGER_MELDINGSFORMIDLING " DN="Melding eller varsel til innbygger"/>
Obligatorisk verdi «MsgHead/MsgInfo/Ack» er:
Code Block
<Ack V="J" DN="Ja"/>
Dialogmelding
Obligatorisk, og benyttes i henhold til beskrivelse iDialogmelding
Obligatoriske elementer (klasse/element):
Dialogmelding/Foresporsel/TypeForesp
Lovlige kodeverdier som kan brukes i TypeForesp:
MTI – Melding til innbygger
XML-eksempel:
Code Block
<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: MeldingInnbygger
XML-eksempel:
Code Block
<MeldingInnbygger xmlns="http://ehelse.no/xmlstds/MeldingInnbygger/2018-09-25">
<Innholdstype V="IB" S="2.16.578.1.12.4.1.1.7613" DN="Innkallingsbrev"/>
<Emne>Innkallingsbrev fra STHF</Emne>
<Meldingsavsender>Sykehuset Telemark - Radiologiavdelingen</Meldingsavsender>
<Meldingstekst>Innkalling til innbygger hos foretak ABC</Meldingstekst>
<SvarTillatt>false</SvarTillatt>
<UtsattVisningstidspunkt>2018-10-28T09:30:00Z</UtsattVisningstidspunkt>
<DelInnholdMedHelsepersonell V="6" S="2.16.578.1.12.4.1.1.9246" DN="Fastlege"/>
<SensitivAvsender>false</SensitivAvsender>
</MeldingInnbygger>
Vedlegg
Valgfritt element, og benyttes i henhold tilVedlegg
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:
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: Videreformidling
7616" DN="Fysisk post"/>
<!-- Avsender valgte HelsenorgeProsessering og er selv ansvarlig for forsendelsen hvis Formidlingskanal er fysisk post eller digital postkasse (eBoks/digipost) -->
<HelsenorgeProsessering Tidspunkt="2020-01-10T09:30:47Z"/>
</Primarkanal>
<Sekundarkanal>
7602" DN="Leveringsrapport på videreformidlet melding"/>
</Foresporsel>
Leveringsrapport
Obligatorisk, og benyttes i henhold til Videreformidling under Leveringsrapport.
Under er forskjellige typer supplerende informasjon
Innholdsstandarder for Meldingsformidling
For meldingsformidling benyttes tre spesifikke meldingsformater (skjema), samt Vedlegg.
Expand
title
MeldingInnbygger
Innholdstype – Valgfri. Definere verdi fra Volven-kodeverket 7613 som kan gi eget varsel og/eller definerer tilgangsstyring på innholdet.
Emne - Emnetekst/overskrift på meldingen i Helsenorge og digital postkasse.
Meldingsavsender - Angir navn på meldingsavsender som vises på Helsenorge.
Meldingstekst - Meldingstekst som i Helsenorge vil vises på som egen tekst på meldingen i tillegg til vedlegg.
SvarTillatt - Angir om innbygger kan svare på meldingen eller ikke. Gjelder Helsenorge, svarmeldingen vil komme som meldingstypen Dialog_helsepersonell og i samme meldingstråd som tilsendt melding.
UtsattVisningstidspunkt – Valgri. Dato og tidspunkt for når en melding tidligst kan gjøres tilgjengelig for innbygger. Gjelder Helsenorge og digital postkasse.
DelInnholdMedHelsepersonell – Valgfri. Angir oppfordring til innbygger om å dele meldingens innhold med helsepersonell. Deling skjer aldri automatisk, men skal være et eksplisitt valg innbygger gjør. Helsenorge legger til rette for at dette kan gjøres på en effektiv måte for innbygger. Kun fastlege støttes i dag.
SensitivAvsender - Valgfri. Angir om Meldingsavsender kan legges til i sms og epost varslene. Det kan bare legges til hvis verdien er false. Default verdien er true.
Skjemaet definerer ikke makslengder eller innhold i felter. For Digital dialog med innbygger er det innført begrensninger i brukergrensesnitt for feltlengder. Begrensninger er vist i tabellen er vist under.
Felt
Feltlengde
Kommentar
Emne
50
Emne begrenses til 50 tegn i brukergrensesnitt
Meldingsavsender
255
Makslengde på felt er 255 tegn, innhold utover dette vil ikke vises på Helsenorge.
Videreformidling
Se beskrivelse i kapittel 2.12.1: Videreformidling
Leveringsrapport
Se beskrivelse i kapittel 2.12.2: Leveringsrapport
Expand
title
Benytter av følgende komponenter
Navn
Type
Beskrivelse
:47Z>"/>
</Sekundarkanal>
</Leveringsrapport>
XML-eksempel HelsenorgeProsessering:
Code Block
<Leveringsrapport xmlns="http://ehelse.no/xmlstds/videreformidling/2020-01-10">
<Primarkanal>
<Formidlingskanal V="FP" S="2.16.578.1.12.4.1.1.7616" DN="Fysisk post"/>
<!-- Avsender valgte HelsenorgeProsessering og er selv ansvarlig for forsendelsen hvis Formidlingskanal er fysisk post eller digital postkasse (eBoks/digipost) -->
<HelsenorgeProsessering Tidspunkt="2020-01-10T09:30:47Z"/>
</Primarkanal>
<Sekundarkanal>
<Formidlingskanal V="HN" S="2.16.578.1.12.4.1.1.7616" DN="Helsenorge"/>
<Levert Tidspunkt="2020-01-10T09:30:47Z"/>
</Sekundarkanal>
</Leveringsrapport>