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 Vilkår for bruk
- 2.8 Eksempel på bruk
  - 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 HelsenorgeAktivSjekken brukes for å få svar på om en innbygger er digitalt aktiv på Helsenorge eller ikke. Innbygger kan være digitalt aktiv via andre, enten ved at foreldre representerer et barn, at en voksen representerer en annen voksen basert på fullmakt, eller at en voksen representerer en annen voksen eller et barn via såkalt tildelt fullmakt. Tildelt fullmakt innebærer at den som representeres ikke er samtykkekompetent. Metoden kan ta inntil 1000 fødselsnummer i samme forespørsel.

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å status jevnlig oppdateres.

Det er en forutsetning at resultatet av HelsenorgeAktivSjekken vises til behandler på en hensiktsmessig måte, slik at behandler kan avgjøre om pasieneten kan følge et digitalt behandlingsløp via Helsenorge eller ikke. Til inspirasjon for slik visning av status til behandler er det laget eksempelikoner og forslag til tekster her HelsenorgeAktiv

Detaljert dokumentasjon av metoden

Autentisering og autorisering

To metoder for tilgang er tilgjengelige, der alternativ 1 foretrekkes for alle nye klienter:

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
API-klienten kan alternativt autentisere seg mot Helsenorge Sikkerhetstjeneste.
1. API-klienten må forhåndskonfigureres på Helsenorge med sin public key
2. Helsenorgeaktivsjekken skal benyttes i system-til-system kontekst: 01 - System til System
3. Deretter kan API-klienten få utsedt et AksessToken fra Helsenorge STS.

AksessToken som mottas fra HelseId eller Helsenorge STS skal deretter være med i Authorization header i alle HTTP-requestene. Se: 02 - Kall til Helsenorge og PVK API'er og bruk av AccessToken

HTTP-verb

Det skal benyttes POST og alltid https. AksessToken skal være med i Authorization header. Se her: 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, der ungdommen selv kan samtykke. Dette området er relevant for skolehelsetjenester.) (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: Testmiljøer og endepunkter

Vilkår for bruk

Generelle vilkår for bruk av APIer finnes her: Vilkår og betingelser for bruk av APIer og kommunikasjonsprosesser

Eksempel på bruk

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

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"}