Inkludering-/deltager billett (arkivert)
Tjenesteoversikt
TjenesteNavn | Http | Beskrivelse |
---|---|---|
SettInnbyggersInkludering | POST <system url>/personvern/v1/settinnbyggersinkludering | Registrere at en innbygger har opplysninger registrert i et register. Dette kan være i et behandlingsrettet register eller fordi innbygger er er inkludert- eller deltager i et kvalitetsregister, forskningsprosjekt eller screeningprogram. Samme tjeneste benyttes for å si at en innbygger ikke lenger er “inkludert”. |
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. Tjenesten krever ikke at kallet utføres i context av en innlogget bruker dvs. at det benyttes UseCase 1 (system-til-system) beskrevet her: 01 - System til System
SettInnbyggersInkludering
Input parametre
Navn | Type | Lovlige verdier | Kommentar |
---|---|---|---|
innbyggerFnr | string | fødselsnummer (11 siffer) | Dette er fødselsnummer til innbygger inkluderingen gjelder. |
partKode | string | Avtalt kode for register/screeningprogram/forskningsprosjekt. | Kortnavn som identifisere det aktuelle register/screeningprogram/forskningsprosjekt. Avtales bilateralt mellom Helsenorge og kallende system. (Dersom inkluderingsbilletten kun benyttes for en delmengde av data i registeret, som ikke alle registrerte har, etableres en egen part-kode for dette formål.) |
inkluderingType | string | Type inkludering | Kan ha en av følgende verdier:
|
aktiv | boolean |
| Sier om inkludering er aktiv eller skal fjernes. Kan ha en av følgende verdier:
|
Eks: Gi informasjon om at innbygger er inkludert i et screeningprogram
{
"innbyggerFnr":"12048645510",
"partKode":"Tarmscreening",
"inkluderingType":"inkludert",
"aktiv":true
}
Eks: Gi informasjon om at innbygger ikke lenger er inkludert i et screeningprogram
{
"innbyggerFnr":"12048645510",
"partKode":"Tarmscreening",
"inkluderingType":"inkludert",
"aktiv":false
}
Responsparameter (ved HTTP 200)
Navn | Type | Lovlige verdier | Kommentar |
---|---|---|---|
instansEndret | string | endret ikkeEndret | Dersom retur er "ikkeEndret" betyr dette at aktuell inkludering for denne innbygger allerede hadde angitt verdi eller at det tidligere ikke var registrert noen inkludering dersom man via API’et prøver å fjerner en tidligere satt inkludering. |
Eks (innbygger var allerede inkludert):
{
"instansEndret":"ikkeEndret",
}
Respons ved feil
Alle tjenester i API'ene har følgende logikk for HTTP-respons:
Statuskode når kallet er utført ok: 200
Statuskode ved feil internt på Helsenorge: 500
Statuskode ved feil i request: 400
Statuskode ved manglende tilganger: 403
Statuskode ved feil eller manglende autorisasjon: 401
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"
}