Innledning
Et API der eksterne (godkjente) klienter kan spørre Helsenorge om en innbygger er "Digital Aktiv" på Helsenorge eller ikke. Normalt benyttes dette i UseCases der det eksterne systemet vil undersøke om det kan "kommunisere" med innbygger via Helsenorge eller må benytte alternative kanaler. (Merk! At Helsenorge også har en videreformidlingstjeneste som støtter alternative kanaler for formidling av informasjon til innbygger).
API’et ble publisert og produksjonssatt i en tidlig versjon (versjon 1). Denne viste seg å ikke dekke de funksjonelle behovene tilfredsstillende. Det er derfor definert en litt endret kontrakt (versjon 2). Versjon 1 vil være operativ i en begrenset tid, og alle nye klienter oppfordres til å ta i bruk versjon 2. Versjon 2 er under implementering, og vi vil publisere her når den kan testes.
Versjon 2 (under implementering)
Input parametre
Navn | Type | Lovlige verdier | Kommentar |
|---|---|---|---|
fnr | string | Innbyggers fødselsnummer (11 siffer) | |
omrade | string | En av verdiene
| Dette representerer en logisk gruppering av tjenestene 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. |
Responsparametre
Begge parametre returneres alltid.
Navn | Type | Kommentar |
|---|---|---|
erDigitalAktivSelv | boolean | Denne vil være satt dersom innbygger er digitalt aktiv selv. Merk! At barn aldri er digitalt aktive selv. |
erDigitalAktivViaAndre | boolean | Denne vil være satt dersom innbygger er digitalt aktiv via andre. Dette kan være ved foreldrerepresentasjon (hvis barn) eller ved fullmakt. |
URL
Miljø | URL |
|---|---|
MAS-01 | https://eksternapi-hn-mas-01.int-hn.nhn.no/DigitaltAktiv/v2/ |
MAS-02 | https://eksternapi-hn-mas-02.int-hn.nhn.no/DigitaltAktiv/v2/ |
TEST1 | |
TEST2 | |
PROD |
Versjon 1 (vil fases ut)
Input parametre
Navn | Type | Lovlige verdier | Kommentar |
|---|---|---|---|
fnr | string | Innbyggers fødselsnummer (11 siffer) | |
samtykkeNivaa | string | En av verdiene
| Dette representerer en gruppering av tjenestene på Helsenorge som innbygger tar stilling til når man velger å bruke Helsenorge, eller lar andre få anledning til å representere seg på Helsenorge. Utgangspunktet er at den eksterne klient som benytter API'et vet hvilken gruppe den tjeneste man selv etterpå ønsker å benytte tilhører. Dersom man er usikker må man spørre sin kontaktperson på Helsenorge. (Hvis ingen verdi er satt for samtykkeNivaa i forespørselen, settes denne default til Registerinnsyn.) |
Responsparametre
Navn | Type | Kommentar |
|---|---|---|
erDigitalAktiv | boolean | Denne vil alltid være med i retur. Dette er hovedstatus. Settes til “true” dersom innbygger enten er digitalt aktiv selv eller ved representasjon. |
erDigitalAktivSelv | boolean | Denne vil være satt dersom innbygger er digitalt aktiv selv. |
erDigitalAktivViaAndre | boolean | Denne vil være satt dersom innbygger ikke er digitalt aktiv selv, men er digital aktiv via representasjon. |