Metode DigitaltAktivStatusEndringer
API-navn | DigitaltAktivStatusEndringer |
|---|---|
Funksjonelt område | Link til det aktuelle funksjonelle området |
API-versjon og dato publisert | v1 Mar 9, 2021 |
Status | I Drift |
API-dokumentasjon sist endret | Mar 18, 2021 |
Teknologi | REST |
API'ets formål
Gir informasjon om nye/eksisterende helsenorge brukere som potensielt har blitt- eller har fått endret sin digitalt aktiv status. Løsningen baserer seg på endringer som gjøres på helsenorge-samtykke dvs. nytt/endret/trukket, men vil fremover også kunne inneholde flere kriterier som kan påvirke innbyggers digital aktiv status.
Fordeler med API'et
En del eksterne aktører har valgt å spørre regelmessig DigitaltAktivOmråde om deres pasienter er digitalt aktiv eller ikke. Dette kallet gjøres pr pasient og svaret på api kallet (status) lagres så i det lokale systemet. For å gjøre slikt lokalt ajourhold av pasientenes Digitale Aktiv status mere effektivt, kan aktørene benytte dette API’et. Det 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 Digital Aktiv API’et for de pasienter som er på “endringslisten” og samtidig finnes lokalt. Øvrige pasienter i lokalt system vil ha uendret Digital Aktiv status.
Hvordan benytte API'et
Type API
REST
Metoder og parametre til endepunktet
En liste over hvilke metoder som kan brukes til endepunktet, samt tabeller som sier hvilke parametre med tilhørende gyldige verdier som kan brukes pr metode. Beskriv også hva den enkelte metode generelt vil gi i respons når den brukes på endepunktet og når den brukes med ulike parametre.
GET
Request
Plassering | Navn | Type | Beskrivelse |
|---|---|---|---|
Header | Authorization: bearer {access-token} | - | - |
URL | offset | string | iso8601 string yyyy-mm-ddThh:mm:ss.00000Z Tidspunkt for når endringer ønskes fra. Hvis tom så returneres alle endringer uavhengig av tid. Klienter som kaller API’et bør “huske” sist gang de kalte endepunktet, og benytte dette som ny tid neste gang. NB! Det returneres uansett ikke endringer eldre enn 3 måneder. |
Response
Plassering | Navn | Type | Beskrivelse |
|---|---|---|---|
Body | offset | string | Offset generert fra server, send inn denne som input ved neste kall for å motta kun nye hendelser. |
| fnr | string[] | Alle fødselsnummer som har hatt endringer etter det oppgitte tidspunktet |
Swagger
https://eksternapi-hn-mas-02.int-hn.nhn.no/digitaltaktiv/swagger/index.html
Autentisering og Autorisering
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
Miljøer
Standard for hvordan URL’en til API’et vil se ut i alle miljøene: https://<miljø>/DigitaltAktiv/api/<versjon>/DigitaltAktivStatusEndringer
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.
Feilmeldinger
Beskriv her hvilke feilmeldinger brukeren kan få og hva de betyr
Kode | Beskrivelse |
|---|---|
200 | Alt OK |
400 | Validering av request feiler |
401 | Autorisasjon er feil eller mangler |
403 | Tilganger mangler |
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"}