...
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. Det tar også 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 metoder. 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 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
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/digitaltaktiv/ |
Disse kan testes ved hjelp av Swagger:
...
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:
...