Inkludering-/deltager billett

Owned by sven.christiansen, created
Last updated: Oct 08, 2024
3 min read

API-navn

PVK - Sett inkludering

Funksjonelt område

Personvernkomponenten

API-versjon og dato publisert

V1 Aug 2, 2022

Status

I Drift

API-dokumentasjon sist endret

Oct 8, 2024

Teknologi

REST image-20241008-051259.png

API'ets formål

Dette API’et gir eksterne mulighet til å registrere i PVK at en bestemt innbygger er deltager eller oppført i et register eller program. På Helenorge vil man kunne styre at bestemt funksjonalitet kun er tilgjengelig for de som har en slik inkluderingsbillett i PVK.

Funksjonalitet som kan være avhengig av en inkluderingsbillett:

  • Tilgang til å sette bestemte personverninnstillinger i brukerflaten på Helsenorge

  • Innsyn i Helseregistre

  • Tilgang til status i screeningprogrammer og forskningsprosjekter

Merk! Innbygger kan ha aktive personverninstillinger selv om det ikke finnes en inkluderingsbillett for innbyggeren i det aktuelle register. Inkludering kan f.eks. styre tilgang til å opprette et samtykke. Samtykket kan likevel opprettes gjennom en samtykkeforespørsel eller at samtykket ligger åpent slik at alle innbygger kan gi det, selv om innbygger ikek er inkludert.

Tjenesteoversikt

TjenesteNavn

Http

Beskrivelse

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

To metoder for tilgang er tilgjengelige:

  1. HelseId sin autoriseringstjeneste for maskin-til-maskin kan benyttes:

    1. Velg Helsenorge Ekstern API i HelseId sin selvbetjeningsløsning

    2. Velg deretter scope “Inkluderingsbillett_skriv”

    3. Når tilgangen er godkjent av Helsenorge, kan aksesstoken hentes ut fra HelseId

  2. API-klienten kan alternativt autentisere seg mot Helsenorge Sikkerhetstjeneste.

    1. API-klienten må forhåndskonfigureres på Helsenorge med sin public key

    2. API-et skal benyttes i system-til-system kontekst: 01 - System til System

    3. Deretter kan API-klienten få utsedt et AksessToken fra Helsenorge STS.

AksessToken som mottas fra HelseId eller Helsenorge STS skal deretter være med i Authorization header i alle HTTP-requestene. Se: 02 - Kall til Helsenorge og PVK API'er og bruk av AccessToken

SettInnbyggersInkludering

Input parametre

Navn

Type

Lovlige verdier

Kommentar

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:

  • inkludert - Innbygger er inkludert i et forskningprosjekt eller screeningprogram. Dette kan være gjennom lov eller forskrift.

  • deltager - Innbygger er deltager i et forskningsprosjekt eller screeningprogram. Dette krever normal aksept til deltagelse.

  • oppfort - Innbygger er oppført i et register. Grunnlag for oppføring er normalt hjemlet i lov eller forskrift, eventuelt gjennom innbyggers samtykke.

aktiv

boolean

 

Sier om inkludering er aktiv eller skal fjernes. Kan ha en av følgende verdier:

  • “true” - er inkludert, deltager eller oppført

  • “false” - Er ikke (lenger) inkludert, deltager eller oppført

 

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

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"
}