...
REST-kall til endepunkt hos aktør, må være
Benyttes alltid HTTPS (ikke krav om toveis-SSL)
Det benyttes alltid HTTP POST.
Alltid bruk av JWT token i REST-kall. Dette skal
“forstås- og valideres av aktør: Innlogget innbygger
Be om innsyn i registrerte opplysninger (i Helseregistre)
Kall:
URL som er konfigurert på Helsenorge peker til metode i endepunkt hos aktør som gir denne funksjonaliteten. Ingen parametere, kun JWT-token i HTTP-header (der representert innbyggers fødselsnummer finnes).
Respons:
HTTP-respons kode
Payload:
I produksjon: Innsyn-v5.1.xsd
Payload ønsket (for alle nye): Innsyn-v6.0.xsd (denne har kopiert inn Innsyn-v5.1.xsd)
Støtte for andre innsynsrapporter enn STANDARD (default) vil utvikles på Helsenorge etter egen prioritering
Vedlegg støttes på Helsenorge
(se skjemaer nederst på siden)
Be om innsyn i Logg over bruk (i Helseregistre)
Kall:
URL som er konfigurert på Helsenorge peker til metode i endepunkt hos aktør som gir denne funksjonaliteten. Ingen parametere, kun JWT-token i HTTP-header.
Respons:
HTTP-respons kode
Payload:
I produksjon:
Innsyn-v5.1.xsdPayload ønsket (for alle nye): Logg-respons_v1.1.xsd (se skjemaer nederst på siden)
Be om status på deltagelse i forskningsprosjekter og screeningprogrammer
Kall:
URL som er konfigurert på Helsenorge peker til metode i endepunkt hos aktør som gir denne funksjonaliteten. Ingen parametere, kun JWT-token i HTTP-header.
Respons:
HTTP-respons kode
Payload:
Under implementering (for Tarmscreening): Status: Status-rapport_v0v1.960.xsd (se skjemaer nederst på siden)
Inkludert skjema: Innsyn-felles-v0v1.940.xsd
Kan inneholde selvbetjeningsfunksjoner:
Kall når selvbetjeningsfunksjon utføres på Helsenorge:
URL som er konfigurert på Helsenorge knyttet til referert selvbetjeningsfunksjon. Peker til metode i endepunkt hos aktør som gir denne funksjonaliteten. JWT-token i HTTP-header.
Når innbygger utfører en selvbetjeningsfunksjon skal det våre følgende i Payload:
For EnkleFunksjoner skal det alltid være med følgende i Body fra Helsenorge:
{
"funksjonKortnavn":"<kortnavnet på funksjonen>""funksjonsType":1
"nyTilstand": true eller false
}For RadioFunksjoner skal alltid følgende med i Body
{
"funksjonKortnavn":"<kortnavnet på funksjonen>""funksjonsType":2
"valgtOpsjon":"<Opsjonkortnavn>"
}
Respons: Kun HTTP-respons kode
...
Alle dialog-meldinger sendes og mottas fra løsningsområde Helseregistre
Det benyttes AMQP som transportprotokoll (se: Meldingsutveksling med Helsenorge)
NHN service BUS benyttes som AMQP service provider.
Alle meldinger er beskrevet på Helsenorgetjenester
Det benyttes alltid KITH hodemelding: MsgHead-v1_2.xsd
Inkluderte skjema:
Dialogmelding (benyttes alltid): dialogmelding-v1.1.xsd
Diverse andre KITH felles elementer:
kith.xsd
felleskomponent1.xsd
Container for ikke XML-innhold (benyttes hvis respons er f.eks. PDF-dokument): kith-base64.xsd
Be om innsyn i registrerte opplysninger (i Helseregistre)
Meldingens funksjon i Hodemelding (Volven kodeverk 8279): DIALOG_INNBYGGER_HREG_INNSYN_HELSEOPPLYSNINGER
Se detaljer om bruk av Hodemelding og Dialogmelding i Implementasjonsguide (lagt inn over) i kapittel 3.17i AMQP Helseregister Innsyn Helseopplysninger
Respons fra Helseregister (som et "Document" i hodemelding):
I produksjon:
PDF-vedlegg (kith-base64.xsd)
- Støtte for
XML innsynsrapport (
bare for responser via Innsynsorkestrator?): Innsyn-v6.0.xsdØnsket støtte for alle nye registre:
PDF-vedlegg (kith-base64.xsd)
Støtte for XML innsynsrapport også for innsyn som ikke går gjennom innsynsorkestratorStøtte for andre innsynsrapporter enn STANDARD (default) vil utvikles på Helsenorge etter egen prioritering
Vedlegg støttes på Helsenorge
foretrukket): Innsyn-v6.0.xsd
Be om innsyn i Logg over bruk (i Helseregistre)
Meldingens funksjon i Hodemelding (Volven kodeverk 8279): DIALOG_INNBYGGER_HREG_INNSYN_BRUK
Se detaljer om bruk av Hodemelding og Dialogmelding i Implementasjonsguide (lagt inn over) i kapittel 3.19 AMQP Dialog Innsyn Bruk
Respons fra Helseregister (som et "Document" i hodemelding):
I produksjon:
PDF-vedlegg (kith-base64.xsd)
Ønsket støtte for alle nye registre:
PDF-vedlegg (kith-base64.xsd)
For alle registre (samme som ønsket payload for synkron respons):
Logg-respons_v1.1.xsd
Be om innsyn i Logg over utlevering (i Helseregistre)
Meldingens funksjon i Hodemelding (Volven kodeverk 8279): DIALOG_INNBYGGER_HREG_INNSYN_UTLEVERING
Se detaljer om bruk av Hodemelding og Dialogmelding i Implementasjonsguide (lagt inn over) i kapittel 3.18 Dialog Innsyn Utlevering
Respons fra Helseregister (som et "Document" i hodemelding):
I produksjon:
PDF-vedlegg (kith-base64.xsd)
Ønsket støtte for alle nye registre- For alle registre (samme som ønsket payload for synkron respons):
Logg-respons_v1.1.xsd
:
PDF-vedlegg (kith-base64.xsd)Melde feil eller stille spørsmål om registrerte opplysninger
Meldingens funksjon i Hodemelding (Volven kodeverk 8279): DIALOG_INNBYGGER_HREG_MELDE_FEIL
Se detaljer om bruk av Hodemelding og Dialogmelding i Implementasjonsguide (lagt inn over) i kapittel 3.20 Dialog Melde Feil
Innhold for både forespørsel og svar ligger i Dialogmeldingen
...
Meldingens funksjon i Hodemelding (Volven kodeverk 8279): DIALOG_INNBYGGER_HREG_SLETTING_ELLER_SPERRING
Se detaljer om bruk av Hodemelding og Dialogmelding i Implementasjonsguide (lagt inn over) i kapittel 3.21 Dialog Sletting Eller Sperring
Innhold for både forespørsel og svar ligger i Dialogmeldingen
Forespørsel til Innsynsorkestrator om Oppføringer
...
Meldingens funksjon i Hodemelding (Volven kodeverk 8279): DIALOG_INNBYGGER_HREG_OPPFORINGER
...
Se detaljer om bruk av Hodemelding og Dialogmelding i Implementasjonsguide (lagt inn over) i kapittel 3.16
Innhold i svar:
...
Det som er i Produksjon: Registeroppforing_V1.0.xsd
...
XML-skjemaer
Attachments | ||||||||
---|---|---|---|---|---|---|---|---|
|
Testside for generisk innsynformat
Skjemaene som benyttes for responsen fra et register inneholder det vi kaller et “generisk innsynformat”. Dette er et “meta-språk” der responsen kan struktureres og delvis formateres. På Helsenorge vil responsen vises for innbygger og formateres tilpasset innbyggers device. Det er laget en egen test-tjeneste i testsystemene for Helsenorge der man kan få verifisert hvordan responsen blir seende ut for innbygger. Man laster her opp en XML-fil ( i formatet Innsyn-v5.1.xsd).
https://tjenester.hn.test.nhn.no/testregisterinnsyn
Merk! Den krever, på samme måte som alle integrasjoner, at aktørens system (IP-adresse) er whitelistet mot våre testsystemer.