...
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).
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. Dette gir samme funksjonalitet som dagens AMQP-baserte forespørsel om innbygger er DigitaltAktiv, og hvor "samtykkeNivaa" ikke er en input parameter.) |
Responsparametre
Navn | Type | Kommentar |
|---|---|---|
erDigitalAktiv | boolean | Denne vil alltid være med i retur. Dette er hovedstatus. Forteller om innbygger er digitalt aktiv selv eller ved representasjon (for angitt samtykkenivå). |
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. |
URL
Miljø | URL |
|---|---|
MAS-01 | |
MAS-02 | |
TEST1 | |
TEST2 | |
PROD |
Link til swagger dokumentasjon
https://eksternapi-hn-mas-01.int-hn.nhn.no//digitaltaktiv/swagger/index.html