1 Metodens formål
2 Detaljert dokumentasjon av metoden
- 2.1 Autentisering og autorisering
- 2.2 HTTP-verb
- 2.3 Request
- 2.4 Response
- 2.5 Swagger
- 2.6 Miljøer
- 2.7 Terms and Conditions
- 2.8 Quick Start
  - 2.8.1 Request (eks.)
  - 2.8.2 Response (eks.)
3 Feilmeldinger

API-navn	helsenorgeaktivsjekken
Metode/funksjon	HelsenorgeAktivSjekken
Endepunkt	https://{BaseUrl)/digitaltaktiv/helsenorgeaktivsjekken/v1
Funksjonelt område	Digitalt aktiv
API-versjon og dato publisert	v1 Sep 14, 2023
Status	i drift
API-dokumentasjon sist endret	Mar 14, 2024
Teknologi	REST

Metodens formål

Metoden kan brukes av eksterne aktører for å undersøke om én eller flere innbyggere er aktive på Helsenorge og har gitt tilstrekkelig samtykke slik at Helsenorge kan benyttes som kanal i forbindelse med ytelse av helsehjelp. Det henvises til generell informasjon om dette på følgende lenke.

Metoden kan benyttes både i sanntid, dvs. når et pasientkort åpnes i journalsystem, eller for å cache/lagre innbyggers status i lokalt system. Dersom det benyttes lokal lagring av denne status, må dette kombineres med metode DigitalAktivStatusEndringer.

Detaljert dokumentasjon av metoden

Autentisering og autorisering

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 “helsenorgeaktivsjekken”
3. Når tilgangen er godkjent av Helsenorge, kan aksesstoken hentes ut fra HelseId, dette kan så benyttes i tjenestekallet mot API’et
API-klienten kan autentisere seg mot Helsenorge Sikkerhetstjeneste.
1. Denne forhåndskonfigureres på Helsenorge
2. Deretter kan API-klienten får utsedt et AksessToken fra Helsenorge STS. DigitalAktiv API-et krever ikke at kallet utføres i context av en innlogget bruker dvs. UseCase 1 (system-til-system) beskrevet her kan benyttes: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/1886191617
3. Aksesstoken benyttes så i tjenestekallet mot API’et.

HTTP-verb

Det skal benyttes POST og alltid https. AksessToken skal være med i Authorization header. Se her: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/23789578/02+-+Kall+til+Helsenorge+og+PVK+API+er+og+bruk+av+AccessToken

For å unngå at innbyggers fødselsnummer er en del av parameterne i URL-en, og dermed vil vises i browser-historikk, benyttes alltid POST med parametere i requestens body.

Request

Plassering	Navn	Type	Beskrivelse

Plassering	Navn	Type	Beskrivelse
Header	Authorization: bearer {access-token}	-	Aksess token som klienten fikk fra Helsenorge sikkerhetstjeneste etter å ha autentisert/autorisert seg mot denne.
Header	Content-Type	application/json	Parametere i body er JSON
Body	fnrListe	string	En liste med ett eller flere fødselsnummer el. d-nummer (11 siffer), for de innbyggere man ønsker å foreta HelsenorgeAktivSjekken for. NB! Det er satt en begrensning på maksimalt 1.000 fødselsnummer i samme API-kall.
	omraade	int	Lovlige verdier (kun en av verdiene): 3 (Helsehjelp) 6 (Ungdom, nytt område for ungdom fra 13 år) (Disse verdiene er registrert i Volven kodeverk 7618) Beskrivelse: HelsenorgeAktivSjekken skal benyttes ved ytelse av Helsehjelp til innbygger. Det er definert noen tjenester for ungdom fra 13 år og oppover. Knyttet til Skolehelesetjenesten og Helsestasjon for unge. Et pilotprosjekt tillater ungdom til selv å samtykke til å ta i bruk Helsenorge for slikt formål. Dersom aktøren som benytter HelsenorgeAktivSjekken tilhører denne kategorien helseforetak, benyttes kode 6. Øvrige helseforetak benytter kode 3. Beskrivelse av områdene - hva skal brukes når: Helsehjelp – brukes for informasjon og tjenester knyttet til innbyggers direkte behandling, helsehjelp og forebygging og hvordan videre behandlingsløp, oppfølging og informasjon skal håndteres eks: sende oppgaver, timeavtaler eller annet til innbygger ifm. pasientforløp Ungdom – brukes for informasjon og tjenester som ungdommen selv kan velge å ta i bruk, uten at foreldre må samtykke til det, ut i fra GDPR og helselovgivningen. Eks: gi informasjon til ungdom om skolehelsetjenesten

Response

Plassering	Navn	Type	Beskrivelse

Plassering	Navn	Type	Beskrivelse
Body	erAktivListe	liste	Liste med innbyggeres fødselsnummer og tilhørende digital aktiv-status
	erAktivSelv	boolean	Denne vil være satt til “true” dersom innbygger selv kan nås på Helsenorge. NB! Et barn < 16 år vil aldri kunne være digital aktiv selv (foreløpig, men dette vil endres når ungdom selv gis tilgang til et begrenset antall tjenester på Helsenorge etter samtykke fra foreldre.)
	erAktivViaAndre	boolean	Denne vil være satt til “true” dersom innbygger kan nås på Helsenorge via andre, dvs det finnes minst én annen person som kan representere innbyggeren. Dette kan være ved foreldrerepresentasjon (hvis barn < 16 år) eller ved fullmakt.
	tildeltFullmakt	boolean	Denne vil være satt til “true” dersom innbygger kan nås via andre og representanten har såkalt tildelt fullmakt. Dvs. at innbygger selv ikke er samtykkekompetent.

Swagger

https://eksternapi.hn.test.nhn.no/digitaltaktiv/swagger/index.html

Miljøer

URL for å nå endepunktet (forskjellig pr miljø): https://<miljø>/digitaltaktiv/helsenorgeaktivsjekken/v1

Oversikt over tilgjengelige miljøer finnes her:

Terms and Conditions

Vilkår og betingelser for bruk av API-et. Generell oversikt over alle vilkår finnes her:

Beskriv eventuelle ytterligere detaljer her.

Quick Start

Request (eks.)

Header:

Body:

{
  "fnrListe": [
    "07118600295",
    "13116900216"
  ],
  "omraade": "3"
}

Response (eks.)

Body:

{
    "erAktivListe": {
        "07118600295": {
            "erAktivSelv": true,
            "erAktivViaAndre": true,
            "tildeltFullmakt": false
        },
        "13116900216": {
            "erAktivSelv": false,
            "erAktivViaAndre": true,
            "tildeltFullmakt": true
        }
    }
}

Feilmeldinger

Følgende responskoder kan forventes fra Helsenorge:

Kode	Beskrivelse

Kode	Beskrivelse
200	Alt OK
400	Validering av request feiler
401	Autorisasjon er feil eller mangler
403	Tilganger mangler
500	Midlertidig feil, prøv igjen senere (fra release august 2021)

Ved HTTP-statuskoder som tilsier at det har oppstått en feil returneres også en respons med feilkode og feilmelding.

Eksempler:

{  "Code": "SEC-110000",  "Message": "Token is expired or invalid"}
{  "Code": "EDAF-000109", "Message": "Requesten har for mange antall personnummer"}