Synkron integrasjon

• REST-kall til endepunkt hos aktør

  • 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:

    • Innsyn-v5.1.xsd (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:

    • 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: Status-rapport_v1.0.xsd (se skjemaer nederst på siden)

      • Inkludert skjema: Innsyn-felles-v1.0.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

Asynkron integrasjon

• 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 i AMQP Helseregister Innsyn Helseopplysninger

• Respons fra Helseregister (som et "Document" i hodemelding):

  • PDF-vedlegg (kith-base64.xsd)

  • XML innsynsrapport (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 AMQP Dialog Innsyn Bruk

• Respons fra Helseregister (som et "Document" i hodemelding):

  • 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 AMQP - Dialog Innsyn Utlevering

• Respons fra Helseregister (som et "Document" i hodemelding):

  • Logg-respons_v1.1.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 AMQP - Dialog Melde Feil

• Innhold for både forespørsel og svar ligger i Dialogmeldingen

Be om at opplysninger slettes eller sperres for helsepersonell

• Meldingens funksjon i Hodemelding (Volven kodeverk 8279): DIALOG_INNBYGGER_HREG_SLETTING_ELLER_SPERRING

• Se detaljer om bruk av Hodemelding og Dialogmelding i https://helsenorge.atlassian.net/wiki/pages/createpage.action?spaceKey=HELSENORGE&title=Dialog%20Sletting%20Eller%20Sperring&linkCreation=true&fromPageId=1478000675

• Innhold for både forespørsel og svar ligger i Dialogmeldingen

XML-skjemaer

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.