Hente informasjon fra PVK om innbyggers personverninnstillinger

Hente informasjon fra PVK om innbyggers personverninnstillinger

API-navn

PVK - Informasjon om innbyggers personverninnstillinger

Funksjonelt område

Personvernkomponenten

API-versjon og dato publisert

V2 May 2, 2024

Status

I Drift

API-dokumentasjon sist endret

Jun 18, 2025

Teknologi

REST HelseId.jpg

API'ets formål

API’et gir eksterne aktører mulighet til å sjekke hvilke innbyggere som har satt hvilke personverninnstillinger. Hver personverninnstilling er beskrevet gjennom en “personverninnstillingdefinisjon” som identifiseres av en Guid. Hver Personverninnstillingdefinisjon eies av en datansvarlig (Part) som identifiseres gjennom en partKode. For å benytte API’et må man kjenne Personverninnstillingdefinisjonens Guid samt eiers partkode.

Det er streng tilgangstyring for denne informasjonen. Normalt har datanasvarlig sin databehandler (dennes API-klient) tilgang til API’et. I tillegg kan andre API-klienter eksplisitt gis tilgang til å hente ut informasjonen.

Tjenesteoversikt

TjenesteNavn

HttpVerb

Beskrivelse

TjenesteNavn

HttpVerb

Beskrivelse

SjekkInnbyggersPiStatus

POST <system url>/personvern/Personverninnstillinger/SjekkInnbyggersPiStatus/v2

Returnerer status på en bestemt Personverninnstilling for en gitt innbygger. 

HentInnbyggersPiForPart

POST <system url>/personvern/Personverninnstillinger/HentInnbyggersPiForPart/v2

Returnerer en liste over personverninnstillinger for en bestemt innbygger som tilhører en bestemt aktør inklusiv innstillingenes status.  Merk! Denne returnerer kun status på de Personverninnstillinger der det finnes en instans hos aktuell innbygger og der denne har status "Aktiv", dvs. at den er virksom. Historikk vises derfor ikke.

HentInnbyggereAktivePiForDefinisjon

GET <system url>/personvern/Personverninnstillinger/HentInnbyggereAktivePiForDefinisjon/v2

Returnerer en liste med fødselsnummer for alle innbyggere som har en aktiv personverninnstilling for en bestemt Personverninnstillingdefinisjon.

Kan benyttes for å:

  • Synkronisere initielt når man skal ha lokal kopi av alle innstillinger og holdes ajour ved replikering.

  • Kan benyttes som alternativ til replikering og lokal kopi dersom man f.eks. skal “vaske” et stort datasett mot en bestemt personverninnstilling (f.eks. reservasjon) og det er uhensiktsmessig å spørre om status for hver enkelt innbygger.

HentInnbyggersOpplastedeBevis (kommer Q3 2025)

POST <system url>/personvern/Personverninnstillinger/HentinnbyggersOpplastedeBevis/v2

Dersom et register/forskningsprosjekt har innhentet en personverninnstilling utenfor Helsenorge, f.eks. et samtykke på papirskjema, kan dette lastes opp til PVK for å arkiveres der sammen med innbyggers personverninnstilling (via metode kallet: “SettInnbyggersPersonvernInnstilling”).

Dette metode kallet kan benyttes av registeret/forskningsprosjektet selv ved behov, f.eks. ved revisjon.

<system url> : Dette er bas.eurl for ekstern api’ene i de forskjellige testsystemer og i produksjon. Oversikt over disse finnes her: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/1552384092

Autorisasjon og aksesstoken

HelseId sin autoriseringstjeneste for maskin-til-maskin skal benyttes:

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

    1. Velg deretter scope “Personverninnstillinger_les

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

Se ytterligere detaljer her: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/1886191617

AksessToken som mottas fra HelseId eller Helsenorge STS skal deretter være med i Authorization header i alle HTTP-requestene. Se: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/23789578

Felles objekter benyttet i respons fra tjenestene

Personverninnstilling definisjoner kan være utformet slik at de har metadata. Slike metadata har tre formål:

  • De angir i kodeverk personverninnstillingens generelle virkeområde, slik at dette kan tolkes maskinelt (uten å på forhånd vite hva en bestemt innstilling betyr).

  • Dersom en personverninnstillingdefinisjon tillater at innbygger selv kan sette en eller flere tidsperioder det innstillingen skal være gjeldende, er innbyggers valg med som metadata

  • For tilgangsbegrensninger er det alltid med metadata. Noen av disse er valg innbygger selv kan gjøre. (F.eks. blokkere tilgang til navngitt helsepersonell).

Litt mer om “faste-metadata”

I alle responser fra API’ene våre så har vi valgt å inkludere også de metadata som er faste for en personverninnstilling. Man kan si at dette kan virke unødvendig, da det register som har fått definert opp en personverninnstilling på Helsenorge, selv “vet” denne informasjonen. (Dvs. hva det betyr for registeret selv dersom innbygger har satt den aktuelle innstilling).

Hovedargumentet for å inkludere denne informasjonen, er at vi har stadig flere UseCase der også andre enn registeret selv benytter personverninnstillingen i sin egen tilgangsstyring. Det er derfor fornuftig å inkludere slik informasjon. Dette betyr at registeret som selv “eier” en innstilling selv kan velge om de vil ta hensyn til de faste metadataene eller ikke.

I API’et for å registrere innbyggers innstillinger som er mottatt utenfor Helsenorge, er de faste metadata for innstillingen ikke med (da jo Helsnorge uansett kjenner disse).

Metadata for samtykker og reservasjoner

Hovedstruktur

SaMetadata eller ReMetadata

(Replikering: samtykkeMetadata eller reservasjonMetadata)

Type

Kommentar

SaMetadata eller ReMetadata

(Replikering: samtykkeMetadata eller reservasjonMetadata)

Type

Kommentar

SaFasteMetadata eller ReFasteMetadata (conditional)

Se under.

Er med kun dersom det er definerte faste metadata på definisjonen. Normalt med i alle nyere definisjoner.

SaInnbyggerMetadata eller ReInnbyggerMetdata (conditinal)

Se under

Er kun med dersom definisjonen tillater at innbygger setter tidsbegrensninger og innbygger har satt slike.

Faste metadata for en definisjon

Dette er metadata som beskriver innstillingens virkeområde/omfang og som gjelder alle innbyggere.

fasteMetadata

Type

Lovlige verdier

Kommentar

fasteMetadata

Type

Lovlige verdier

Kommentar

tidsbegrensning

element (conditional)

 

Kun med hvis det er en fast tidsbegrensning for innstillingens virkeområde. Merk! Eventuelle tidsbegrensning gjelder felles for alle “Omfang” elementer (dersom det er flere av disse).

tidsbegrensetFra

string

Dato

Fra og med

tidsbegrensetTil

string

Dato

Til og med

omfangElementer

Liste

 

Det kan være flere enn et slikt element (eventuelt ingen)

omfangKode (mandatory)

string (kodeverdi)

Omfanget av samtykke/reservasjon: kodeverk fra Volven 7608. Følgende verdier er aktuelle for Samtykke eller Reservasjon:

DT: Digital tilgang

OF: Oppføring

UO: Utlevering av helseopplysninger

IO: Innhenting av helseopplysninger

DO: Deltagelse i ordning eller tjeneste

 

 

logiskOmfang (optional)

string

Kan ha en av følgende tre verdier:

  • Angitte = Gjelder for det som er angitt på definisjonen eller det som er angitt av innbygger selv

  • Ovrige = Gjelder for alt unntatt det som er angitt på definisjonen eller det som er angitt av innbygger selv

  • Alle = Gjelder for alle elementer av angitt type.

 

presisering (optional)

string

Fritekstfelt: Bilateralt avtalt mellom Register og NHN

Presisering ift. Omfang, benyttes hvis nødvendig

Metadata som innbygger kan sette selv

Dette er metadata som innbygger kan settes selv, dersom definisjonen tillater det, og som er individuelle pr. innbygger.

SaInnbyggerMetadata eller ReInnbyggerMetadata

Type

Lovlige verdier

Kommentar

SaInnbyggerMetadata eller ReInnbyggerMetadata

Type

Lovlige verdier

Kommentar

tidsbergensning

element (conditional)

 

Kun med dersom definisjonen har gitt innbygger slik mulighet og innbygger har angitt en eller flere tidsperioder. Merk! Eventuell tidsbegrensning satt av innbygger gjelder for hele definisjonen (dvs. for alle eventuelle “omfang” elementer i den faste delen av definisjonen).

perioder

liste

 

 

fraDato

string

Dato

Fra og med

tilDato

string

Dato

til og med

Metadata for tilgangsbegrensninger

Hovedstruktur

TbMetadata

Replikering: tilgangsbegresningMetadata

Type

Kommentar

TbMetadata

Replikering: tilgangsbegresningMetadata

Type

Kommentar

TbFasteMetadata (mandatory)

Se under.

Er med for alle definisjoner.

TbInnbyggerMetadata (conditional)

Se under

Er med dersom definisjonen tillater at innbygger setter tidsbegrensninger eller definisjonen tilsier at innbygger selv må angi sperringen eller blokkeringens virkeområde.

Faste metadata for en definisjon

Dette er metadata som beskriver innstillingens virkeområde/omfang og som gjelder alle innbyggere.

TbFasteMetadata

Type

Lovlige verdier

 

TbFasteMetadata

Type

Lovlige verdier

 

tidsbegrensning (conditional)

element (conditional)

Kun med hvis det er en fast tidsbegrensning for innstillingens virkeområde.

 

tidsbegrensetFra

string

Dato

 

tidsbegrensetTil

string

Dato

 

omfangElementer

Liste

 

Det er alltid med et slikt listelemenet for Tilgangsbegrensninger. (Data modellen tillater flere, men vi har ingen usecase pr. nå der dette benyttes.)

omfangKode (mandatory)

string

Omfanget av tilgangsbegrensningen: kodeverk fra Volven 7608. Følgende verdier er lovlige for tilgangsbegrensning:

SP: Sperre tilgang til helseopplysninger

BL: Blokkere tilgang til helseopplysninger

 

logiskOmfang (mandatory)

string

Kan ha en av følgende tre verdier:

  • Angitte = Gjelder for det som er angitt på definisjonen eller det som er angitt av innbygger selv

  • Ovrige = Gjelder for alt unntatt det som er angitt på definisjonen eller det som er angitt av innbygger selv

  • Alle = Gjelder for alle elementer av angitt type.

 

typeAngivelse (mandatory)

string

Angir hvilken type angivelse som benyttes for å beskrive hva/hvem tilgangsbegrensningen gjelder for. Kan ha en av følgende 2 verdier:

  • Helsepersonell

  • Rolle til pasient

Følgende to verdier er for fremtidig bruk, og ikke implementert full støtte for enda (kan implementeres når slik behov kommer fra sektoren):

  • Ansatte i organisasjon

  • Kategori opplysninger

 

detaljertAngivelse (conditional)

element

 

 

(liste av) kategoriOpplysninger (conditional)

string

Foreløpig ikke etablert kodeverk. Må avtales bilateralt mellom register og NHN.

 

(liste av) rolleTilPasient (conditional)

string

Volven kodeverk 9034. Feltet inneholder rollens verdi i kodeverket. Eksempel: “Fastlege”.

 

Metadata som innbygger kan sette selv

Dette er metadata som beskriver innstillingens virkeområde/omfang og som gjelder alle innbyggere.

TbInnbyggerMetadata

Type

Lovlige verdier

Kommentar

TbInnbyggerMetadata

Type

Lovlige verdier

Kommentar

tidsbergensning (conditional)

element

 

Kun med dersom definisjonen har gitt innbygger slik mulighet og innbygger har angitt en eller flere tidsperioder.

perioder

liste

 

 

fraDato

string

Dato

Fra og med

tilDato

string

Dato

til og med

detaljertAngivelse (conditional)

element

 

Er med dersom definisjonen er utformet slik at innbygger selv kan velge hva/hvem tilgangsbegrensningen gjelder for.

Ikke støtte for enda

(liste av) kategoriOpplysninger (conditional)

element

Foreløpig ikke etablert kodeverk. Må avtales bilateralt mellom register og NHN.

Er med dersom et “omfangElement” har “typeAngivelse = Kategori opplysninger” i den faste delen av definisjonen.

(liste av) rolleTilPasient (conditional)

string

Volven kodeverk 9034. Feltet inneholder kodeverkets verdi. Eksempel: “rolle”: “Fastlege”.

Er med dersom et “omfangElement” har “typeAngivelse = Rolle til pasient” i den faste delen av definisjonen.

(liste av) navngittHelseperson (conditional)

element

 

Er med dersom et “omfangElement” har “typeAngivelse = Helsepersonell” i den faste delen av definisjonen.

nummer (manadatory)

string

Helsepersonens HPR-nummer

 

navn (mandatory)

string

Helsepersonenes Navn

 

Ikke støtte for enda

(liste av) helseforetak (conditional)

element

 

Er med dersom et “omfangElement” har “typeAngivelse = Ansatte i organisasjon” i den faste delen av definisjonen.

nummer (manadatory)

string

Helseforetakets organisasjonsnummer

 

navn (mandatory)

string

Helseforetakets Navn

 

SjekkInnbyggersPiStatus

Input parametere

Navn

Type

Lovlige verdier

Kommentar

Navn

Type

Lovlige verdier

Kommentar

innbyggerFnr

string

fødselsnummer (11 siffer)

Dette er fødselsnummer (eller D-nummer) til innbygger det spørres på.

definisjonGuid

string

Forhåndskjent verdi

GUID som referer til en bestemt personverninnstilling. Må være kjent på forhånd av kallende system.

definisjonNavn

string

Navn på innstillingen

Beskrivende kortnavn på den forespurte personverndefinisjon. Må være kjent på forhånd av kallende system. (Denne er egentlig overflødig da GUID uansett er unik, vi har likevel valgt å ta denne med.)

partKode

string

Forhåndsavtalt verdi

Kortnavn som identifisere det aktuelle register/screeningprogram/forskningsprosjekt som eier den aktuelle personverninnstilling. Må være kjent på forhånd av kallende system. (Denne er egentlig overflødig da GUID uansett er unik, vi har likevel valgt å ta denne med.)

Eks:

{
  "innbyggerFnr":"12048645510",
   "definisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A",
   "definisjonNavn":"Samtykke til oppbevaring av biomateriale",
   "partKode":"NFS"
}

Responsparametre

Navn

Type

Lovlige verdier

Kommentar

Navn

Type

Lovlige verdier

Kommentar

innbyggerFnr

string

fødselsnummer (11 siffer)

Dette er fødselsnummer (eller D-nummer) til innbygger det ble spurt på (og som svaret gjelder).

definisjonGuid

string

GUID

GUID for den personverninnstilling definisjon det ble spurt på.

definisjonNavn

string

Navn på innstillingen

Beskrivende kortnavn på den forespurte personverndefinisjon.

partKode

string

Forhåndsavtalt verdi

Kortnavn som identifisere det aktuelle register/screeningprogram/forskningsprosjekt som eier den aktuelle personverninnstilling.

typePi

string

Type personverninnstilling

Kan ha en av følgende verdier:

  • samtykke