Table of Contents |
---|
Page Properties | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Metodens formål
Metoden kan HelsenorgeAktivSjekken 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 lenkefå 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å dette kombineres med metode DigitalAktivStatusEndringer.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
autorisasjonAlle 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 - V2autorisering
To metoder for tilgang er tilgjengelige, der alternativ 1 foretrekkes for alle nye klienter:
HelseId sin autoriseringstjeneste for maskin-til-maskin kan benyttes:
Velg Helsenorge Ekstern API i HelseId sin selvbetjeningsløsning
Velg deretter scope “HelsenorgeAktivSjekken”
Når tilgangen er godkjent av Helsenorge, kan aksesstoken hentes ut fra HelseId
API-klienten kan alternativt autentisere seg mot Helsenorge Sikkerhetstjeneste.
API-klienten må forhåndskonfigureres på Helsenorge med sin public key
Helsenorgeaktivsjekken skal benyttes i system-til-system kontekst: 01 - System til System
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 |
---|---|---|---|
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 (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: Beskrivelse av områdene - hva skal brukes når:
|
Response
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
Standard for hvordan URL’en til API’et vil se ut i alle miljøeneURL for å nå endepunktet (forskjellig pr miljø): https://<miljø>/digitaltaktiv/helsenorgeaktivsjekken/v1
Oversikt over tilgjengelige miljøer finnes her: Testmiljøer og endepunkter
Terms and Conditions
Vilkår og betingelserVilkår for bruk
Generelle vilkår for bruk av API-et. Generell oversikt over alle vilkår APIer finnes her: Vilkår og betingelser for bruk av APIer og kommunikasjonsprosesser
Beskriv eventuelle ytterligere detaljer her.
Quick StartEksempel på bruk
Request (eks.)
Header:
Body:
|
Response (eks.)
Body:
|
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 Block | ||
---|---|---|
| ||
{ "Code": "SEC-110000", "Message": "Token is expired or invalid"} { "Code": "EDAF-000109", "Message": "Requesten har for mange antall personnummer"} |