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

API-navn	DigitaltAktiv
Metode/funksjon	DigitaltAktivOmraade
Endepunkt	https://{BaseUrl)/digitaltaktiv/v1/DigitaltAktivOmraade
Funksjonelt område	Link til det aktuelle funksjonelle området
API-versjon og dato publisert	v1 Mar 10, 2021
Status	I Drift
API-dokumentasjon sist endret	Mar 18, 2021
Teknologi	REST

Metodens formål

Metoden kan brukes av eksterne aktører for å undersøke om en bestemt innbygger er aktiv på Helsenorge eller ikke. Basert på svaret, kan det eksterne systemet vurdere om det kan og bør kommunisere med innbyggeren via Helsenorge og/eller om det må benytte alternative kanaler. Dersom formålet er å lagre innbyggers digitale status i eget system bør metoden bare benyttes etter at metoden DigitaltAktivStatusEndringer først er benyttet.

benytte API'et

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 tjenesten 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/24051725

Type API

REST

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

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	fnr	string	Innbyggers fødselsnummer el. d-nummer (11 siffer)
	omraade	int	Lovlige verdier (kun en av verdiene): 1 (Helseregister 2 (Pasientjournal) 3 (Helsehjelp 4 (Forvaltning) 5 (Sekundærbruk) 6 (Ungdom, nytt område for ungdom mellom 12-16 år)) (Disse verdiene er registrert i Volven kodeverk, 7618) Beskrivelse: Dette representerer en logisk gruppering av tjenestene og informasjon på Helsenorge. Utgangspunktet er at den eksterne klient som benytter API'et vet hvilket tjeneste område den tjeneste man selv etterpå ønsker å benytte tilhører. Dersom man er usikker må man spørre sin kontaktperson på Helsenorge. Beskrivelse av områdene - hva skal brukes når: Helseregister – brukes for informasjon og tjenester knyttet til innbyggers innsyn og rettigheter i ulike registre Pasientjournal – brukes for informasjon og tjenester knyttet til innbyggers innsyn og rettigheter i pasientjournal 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 Forvaltning – brukes for informasjon og tjenester knyttet til helseforvaltning og helseøkonomiforvaltning Sekundærbruk – brukes for informasjon og tjenester knyttet til forskning, helseundersøkelser og annen sekundærbruk

Response

Plassering	Navn	Type	Beskrivelse

Plassering

Navn

Type

Beskrivelse

Body

erDigitalAktivSelv

boolean

Denne vil være satt dersom innbygger er digitalt aktiv selv.

NB! Et barn < 16 år vil aldri kunne være digital aktiv selv (foreløpig, men dette vil nok komme etter hvert)

erDigitalAktivViaAndre

boolean

Denne vil være satt dersom innbygger er digitalt aktiv 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.

Swagger

https://eksternapi-hn-mas-02.int-hn.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/api/<versjon>/DigitaltAktivOmraade

Oversikt over tilgjengelige miljøer finnes her: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/1552384092

Terms and Conditions

Vilkår og betingelser for bruk av API'et. Generell oversikt over alle vilkår finnes her: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/1346634744

Beskriv eventuelle ytterligere detaljer her.

Quick Start

Request (eks.)

Header:

Body:

{
  "fnr": "07118600295",
  "omraade": 1
}

Response (eks.)