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.

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.

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

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

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.

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”.

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

innbyggerFnr

string

fødselsnummer (11 siffer)

Dette er fødselsnummer 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.)

innbyggerFnr

string

fødselsnummer (11 siffer)

Dette er fødselsnummer 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

• reservasjon

• tilgangsbegrensning

aktiv

bool

Kan ha en av følgende verdier:

• false (Betyr: Dersom Samtykke: Ikke samtykket; dersom reservasjon: Ingen Reservasjon satt, dersom Tilgangsbegrensning: Ingen tilgangsbegrensning satt.)

• true (Betyr: Dersom Samtykke: Har samtykket; dersom reservasjon: Reservasjon satt, dersom Tilgangsbegrensning: Tilgangsbegrensning satt.

MERK! En innstilling er markert som aktiv selv om den eventuelt ikke er virksom ut fra metadata som kan tillate tidsbegrensninger (se under)

sekvensnummer

int

Hvilket sekvensnummer dette er for innbygger instans av denne personverninnstillingdefinisjonen.

Elementet er ikke med dersom innbygger aldri har satt verdi for aktuell personverninnstilling.

Løpenummer som begynner på 1 og økes med 1 for hver gang innbygger har satt/endret den aktuelle innstilling.

opprettetTidspunkt

time

Tidspunkt for når første instans av innbyggers personverninnstilling ble opprettet.

Elementet er ikke med dersom innbygger aldri har satt verdi for aktuell personverninnstilling.

Tidspunkt for når sekvensnummer 1 ble opprettet,

sistEndretTidspunkt

time

Tidspunkt for nå innbygger sist satt/endret personnverninnstillingen.

Elementet er ikke med dersom innbygger aldri har satt verdi for aktuell personverninnstilling.

Tidspunkt for siste endring.

SaMetadata (element)

• SaFasteMetadata

• SaInnbyggerMetadata

ReMetadata (element)

• ReFasteMetadata

• ReInnbyggerMetadata

TbMetadata (element)

• TbFasteMetadata

• TbInnbyggerMetadata

JSON

Struktur med metadata knyttet til aktuell personverninnstilling. Kan både være faste metadata for definisjonen, og metadata som innbygger selv kan sette, dersom dette er tillatt/nødvendig for den aktuelle definisjon

(C=Conditional). Er med dersom definisjonen har faste metadata eller har metadata som innbygger setter.

• Er alltid med dersom definisjonen er av type tilgangsbegrensning

innbyggerFnr

string

fødselsnummer (11 siffer)

Dette er fødselsnummer til innbygger det spørres på.

partKode

string

Forhåndskjent verdi

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

funnet

boolean

Denne vil alltid være med i retur. 

"true" dersom minst en aktiv personverninnstilling ble funnet for innbygger tilhørende den parten det forespørres på.

personvernInnstillinger

liste

JSON-struktur

En liste med de aktive personverninnstillinger som finnes for aktuell innbygger knyttet til den aktuelle part. Disse har eksakt samme struktur som i respons for andre tjenestekall som gjelder kun en enkelt innstilling. Derav dublering av innbyggers fødselsnummer og PartKode i hver returnert aktiv innstilling.

• innbyggerFnr

• definisjonGuid

• definisjonNavn

• partKode

• typePi

• aktiv

• string

• string

• string

• string

• string

• bool

• (gjentagelse av) innbyggers FNR som det ble spurt på

• Forhåndskjent verdi

• Innstillingens navn

• Partkode til register

• Type innstilling

• Alltid true

• Innbyggers FNR

• GUID til personverninnstilling definisjonen.

• Lesbart navn

• Bilateralt avtalt mellom register og NHN

• Kan ha en av følgende verdier:

  • samtykke

  • reservasjon

  • tilgangsbegrensning

sekvensnummer

int

Hvilket sekvensnummer dette er for innbygger instans av denne personverninnstillingdefinisjonen.

Løpenummer som begynner på 1 og økes med 1 for hver gang innbygger har satt/endret den aktuelle innstilling.

MERK! Mottagende system bør lagre siste mottatte sekvensnummer. Dersom det mottas en replikering med et sekvensnummer som er mindre (eller lik) et tidligere mottatt sekvensnummer, skal replikeringen overses. Dette kan skje dersom det er temporær nedetid i mottagende system, og Helsnorge/PVK retry-mekanisme gjør at replikeringensmeldingen blir “forsinket”, og innbygger i mellomtiden har satt ny innstilling.

opprettetTidspunkt

time

Tidspunkt for når første instans av innbyggers personverninnstilling ble opprettet.

Tidspunkt for når sekvensnummer 1 ble opprettet,

sistEndretTidspunkt

time

Tidspunkt for nå innbygger sist satt/endret personnverninnstillingen.

Tidspunkt for siste endring.

• SaMetadata

• ReMetadata

• TbMetadata

JSON

Struktur med metadata knyttet til aktuell personverninnstilling. Kan både være faste metadata for definisjonen, og metadata som innbygger selv kan sette, dersom dette er tillatt/nødvendig for den aktuelle definisjon

(C=Conditional). Er med dersom definisjonen har faste metadata eller har metadata som innbygger setter.

• Er alltid med dersom definisjonen er av type tilgangsbegrensning

definisjonGuid

query string parameter

Forhåndskjent verdi

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

partKode

query string parameter

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.

pagingReference

query string parameter

Verdi fås i respons.

Skal være med i request. Nye kall må gjøres med mottatt pagingReference så lenge denne er større enn verdien “0”.

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

• reservasjon

• tilgangsbegrensning

pagingReference

int

Dersom den har verdien 0, trenger det ikke å gjøres flere kall. Dersom annen verdi, må det gjøres etterfølgende kall med angitt pagingReference.

Nytt kall må gjøres med pagingReference så lenge denne er større enn verdien “0”.

En av følgende (avhengig av “typePi”:

• SaFasteMetadata

• ReFasteMetadata

• TbFasteMetadata

personvernInnstillinger

• innbyggerFnr

• sekvensnummer

• opprettetTidspunkt

• sistEndretTidspunkt

• En av følgende (avhengig av “typePi)

  • SaInnbyggerMetadata

  • ReInnbyggerMetadata

  • TbInnbyggerMetadata

Element (liste)

• string

• int

• time

• time

• JSON (se over)

• Gyldig fødselsnummer

• Sekvensnummer på innbyggerens innstilling for denne definisjonen (starter på 1, og økes for hver gang innbygger endrer den aktuelle inn stilling)

• Når personverninnstillingen første gang ble satt

• Når personverninnstullingen sist ble satt

• Eventuelle tidsbegrensninger innbygger har satt selv

• Struktur med metadata for tilgangsbegrensning som innbygger kan sette selv (hvis relevant for aktuell definisjon). Er bare med dersom aktuell innbygger har satt slik begrensning.

En liste med alle de innbygger som har en aktiv instans (aktiv reservasjon, samtykke eller tilgangsbegrensning)