Metode DigitaltAktivStatusEndringer
API-navn | DigitaltAktivStatusEndringer |
|---|---|
Funksjonelt område | |
API-versjon og dato publisert | v1 Mar 9, 2021 |
Status | I Drift |
API-dokumentasjon sist endret | Oct 29, 2021 |
Teknologi | REST |
API-ets formål
Gir informasjon om nye/eksisterende Helsenorge brukere som potensielt har blitt- eller har fått endret sin aktiv-status. Løsningen baserer seg på endringer som gjøres på Helsenorge-samtykke dvs. nytt/endret/trukket, samt endringer som skjer knyttet til gyldige representasjonsforhold..
Fordeler med API-et
En del eksterne aktører har valgt å spørre regelmessig HelsenorgeAktivSjekken om deres pasienter er 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 Aktiv-status på Helsenorge mer effektivt, kan aktørene benytte dette API-et. Det gir en totaloversikt over de innbyggere på Helsenorge som potensielt har fått endret HelsenorgeAktivSjekken sin status siden et gitt tidspunkt. Ved å sammenlikne dette svaret med lokal “pasient-liste”, vil det kun være behov for å kalle HelsenorgeAktivSjekken API-et for de pasienter som er på “endringslisten” og samtidig finnes lokalt. Øvrige pasienter i lokalt system vil ha uendret HelsenorgeAktiv status.
Hvordan benytte API-et
Metoder og parametre til endepunktet
GET
Request
Plassering | Navn | Type | Beskrivelse |
|---|---|---|---|
Header | Authorization: bearer {access-token} | - | - |
URL | offset | query parameter (string) | iso8601 string yyyy-mm-ddThh:mm:ss.0000000Z 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 senere kall for å motta kun nye hendelser fra sist man gjorde kontrollen. |
| fnr | string[] | Liste med 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/1886191617
Miljøer
Standard for hvordan URL-en til API-et vil se ut i alle miljøene: https://<miljø>/DigitaltAktiv/api/v1/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"}