Metodens formål
Metoden kan brukes av eksterne aktører for å undersøke om en en eller flere innbyggere er aktive på Helsenorge, og har gitt tilstrekkelig samtykke, slik at Helsenoreg kan benyttes som kanal i forbindelse med yteklse av helsehjelp. Det henvises til generll informasjon om dette på følgende lenke.
Metoden kan benyttes både i realtid, 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 AktivStatusEndringer.
Detaljert dokumentasjon av metoden
Autentisering og autorisasjon
Alle API’er krever at klienten på forhånd har autentisert seg mot vår Sikkerhetstjeneste og fått utstedt et aksesstoken som skal være med i tjenestekallene til det enkelte API. 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: 01 - System til System - V2
HTTP verb
Det skal benyttes POST og alltid https.
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 |
---|---|---|---|
Header | Authorization: bearer {access-token} | - | Aksess token som klienten fikk fra Helsenorge sikkerhetstjeneste etter å ha autentisert/autorisert seg mot denne. |
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 (Samfunnsinformasjonstjenester, nytt område for ungdom fra 13 år) (Disse verdiene er registrert i Volven kodeverk, 7618) Beskrivelse: Beskrivelse av områdene - hva skal brukes når:
|
Response
Plassering | Navn | Type | Beskrivelse |
---|---|---|---|
Body | erAktivListe | liste | Liste med innbyggeres fødselsnummere og tilhørende digital aktiv status |
erAktivSelv | boolean | Denne vil være satt 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 dersom innbygger kan nås på helsenortge via andre, dvs det finnes minst en annen person som kan representere innbyggeren. Dette kan være ved foreldrerepresentasjon (hvis barn < 16 år) eller ved fullmakt. | |
tildeltFullmakt | boolean | Betinget element. Flagget vil være med, og satt til “true”, dersom innbygger kan nås via andre og representanten har såkalt tildelt fuillmaklt. Dvs. at innbygger selv ikke er samtykkekompetent. |
Swagger
https://eksternapi.hn.test.nhn.no/digitaltaktiv/swagger/index.html
Miljøer
Standard for hvordan URL’en til API’et vil se ut i alle miljøene: https://<miljø>/digitaltaktiv/v2/HelsenorgeAktiv
Oversikt over tilgjengelige miljøer finnes her: Testmiljøer og endepunkter
Terms and Conditions
Vilkår og betingelser for bruk av API'et. Generell oversikt over alle vilkår finnes her: Vilkår og betingelser for bruk av APIer og kommunikasjonsprosesser
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 }, "13116900216": { "erAktivSelv": false, "erAktivViaAndre": true, "tildeltFullmakt": true } } } |
Feilmeldinger
Følgende responskoder kan forventes fra Helsenorge:
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"}