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
"Registerinnsyn"
"InnsynPasientjournal"
"DigitaleHelsetjenester"
...
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. |
...
| Table of Contents |
|---|
Hva er Digital Aktiv?
Digital Aktiv er en funksjon på Helsenorge som gir et nøyaktig svar på om en aktuell innbygger benytter Helsenorge (enten selv eller gjennom andre) eller ikke. Svaret er nyansert avhengig av hvilket tjenesteområde det spørres om for den spesifikke innbyggeren. Ved å kunne spørre om innbygger er digital aktiv innenfor forskjellige tjenesteområder, tas det høyde for at innbygger på Helsenorge kan nyansere hvilke digitale helsetjenester de ønsker å benytte/få og hvilke de evt. ønsker å reservere seg mot.
Om API’et for Digital Aktiv
API’et inneholder to alternative “mønstre”:
UseCase 1: Metoden DigitaltAktivOmraade brukes av eksterne aktører for å undersøke om en 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. Dette er den foretrukne metoden, og bør benyttes i det behov for dialog med innbygger oppstår.
UseCase 2: Enkelte systemer har utfordringer med å undersøke om innbygger er digital aktiv i “real-tid” når det oppstår behov for dialog med innbygger. Dette kan være “historisk” betinget, dvs. fra før Helsenorge tilbød API’et DigitalAktivOmråde. Dersom det eksterne systemet likevel “trenger” å ha en lokal kopi av innbyggers digitale status på Helsenorge, har vi implementert en ny API metode som kan underlette slikt ajourhold. Dette er metoden DigitaltAktivStatusEndringer. Denne gir en totaloversikt over de innbyggere på Helsenorge som potensielt har fått endret DigitalAktiv status siden et gitt tidspunkt. Ved å sammenlikne dette svaret med lokal “pasient-liste”, vil det kun være behov for å kalle metoden DigitaltAktivOmraade for de pasienter som er på “endringslisten” og samtidig finnes lokalt. Øvrige pasienter i lokalt system vil ha uendret Digital Aktiv status.
| Gliffy | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Hva betyr det å være Digital aktiv?
Spørsmålet om en person er Digital Aktiv er ikke et binært ja/nei-spørsmål. Svarene funksjonen gir vil avhenge av:
Hvilke opplysninger som er registrert om personen i folkeregisteret
Om personens kontaktinformasjon i Difis kontakt- og reservasjonsregister er oppdatert eller bekreftet siste 18 mnd
Om personen har tatt i bruk Helsenorge, og i så fall hvilke samtykker og personverninnstillinger personen har gjort
Om det er et barn som har en voksen (forelder) som kan representere det
Om personen har gitt andre fullmakt til å operere på vegne av seg (og til hva)
Hvilke type tjeneste/område det er snakk om
Merk: DigitalAktiv-sjekken for Helsenorge er helt uavhengig av om en innbygger har reservert seg mot digital kommunikasjon i Difis kontakt- og reservasjonsregister.
Det betyr at personer kan være aktive på Helsenorge, også i de tilfeller hvor de har reservert seg mot digital kommunikasjon sentralt.
Aktiv selv
Betyr at innbygger har en aktiv profil på Helsenorge og kan motta digital informasjon innenfor det området det er snakk om i det aktuelle tilfellet.
Aktiv via andre
Betyr at det finnes minst en annen person som har tilgang til å representere den aktuelle innbyggeren innenfor det aktuelle området på Helsenorge. Dvs. at det finnes andre som kan få tilgang til informasjon på vegne av innbyggeren og evt. utføre aktuelle handlinger på vegne av denne. Dette kan også fungere som et supplement i tillegg til informasjon som også må gis i andre kanaler for å nå innbygger direkte. Personen(-e) som kan representere andre på denne måten har fått denne tilgangen gjennom fullmakt eller fordi de har foreldreansvar for barnet det er snakk om.
Helsenorge tilbyr pårørendeinvolvering og ønsker å gjøre det lettest mulig å være pårørende. Det betyr at vi ønsker å tilrettelegge slik at det er mulig å tilgjengeliggjøre mest mulig informasjon for pårørende samtidig som vi ivaretar at innbyggeren/pasienten selv får informasjon på den måten de har krav på.
Tolkning av svaret på DigitaltAktivOmråde
Det er den eksterne aktøren og det eksterne systemet som er ansvarlig for å avgjøre hva som er riktig å gjøre i hvert enkelt tilfelle basert på svarene. Den eksterne aktøren må derfor selv definere hva som er riktige forretningsregler for sin bruk når det gjelder de ulike svarkombinasjonene i svaret fra DigitalAktivOmraade
En innbygger kan være:
både digitalt aktiv selv og samtidig aktiv via andre
kun aktiv selv
kun aktiv via andre
ingen av delene
Teknisk Dokumentasjon
API-metoder
Operasjon | Beskrivelse |
|---|---|
Gir informasjon om en innbygger sin digitalt aktiv status | |
Gir informasjon om hvilke innbyggere som potensielt har fått endret sin digitalt aktiv status siden angitt tidspunkt |
URL per miljø
Miljø | URL |
|---|---|
MAS-01 | https://eksternapi-hn-mas-01.int-hn.nhn.no/ |
digitaltaktiv/ | |
MAS-02 | https://eksternapi-hn-mas-02.int-hn.nhn.no/ |
digitaltaktiv/ | |
TEST1 | https://eksternapi.hn.test.nhn.no/digitaltaktiv/ |
TEST2 | https://eksternapi.hn2.test.nhn.no/ |
digitaltaktiv/ | |
PROD | https://eksternapi. |
helsenorge.no/ |
Link til swagger dokumentasjon
digitaltaktiv/ |
Disse kan testes ved hjelp av Swagger:
https://eksternapi-hn-mas-0102.int-hn.nhn.no//digitaltaktiv/swagger/index.html html
Autorisasjon og aksesstoken
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: 01 - System til System
Feilhåndtering
Følgende responskoder kan forventes fra Helsenorge:
Alle tjenester i API'ene har følgende logikk for HTTP-respons:
Statuskode når kallet er utført ok: 200
Statuskode ved feilende validering av request: 400
Statuskodde ved feil eller manglende autorisasjon: 401
Statuskode ved manglende tilganger: 403
Ved HTTP-statuskoder som tilsier at det har oppstått en feil returneres også en respons med feilkode og feilmelding.
Eks:
{
"Code": "SEC-110000",
"Message": "Token is expired or invalid"
}