Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

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

Responsparametre (oppdatert 2024-05-02)

Navn

Type

Lovlige verdier

Kommentar

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 (Ny Q2 2024)

int

Hvilket sekvensnummer dette er for innbygger instans av denne personverninnstillingdefinisjonen. Har verdien “0” dersom innbygger enda ikke har satt noen instilling for denne personverninnstillingdefinisjonen.

Løpenummer som begynner på 1 for hver gang innbygger har satt/endrte den aktuelle innstilling. Dersom 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 (Ny Q2 2024)

time

Tidspunkt for når første instans av innbyggers personverninnstilling ble opprettet. Har verdien NULL dersom innbygger enda ikke har satt noen instilling for denne personverninnstillingdefinisjonen.

Tidspunkt for når sekvensnummer 1 ble opprettet,

sistEndretTidspunkt (Ny Q2 2024)

time

Tidspunkt for nå innbygger sist satt/endret personnverninnstillingen. Har verdien NULL dersom innbygger enda ikke har satt noen instilling for denne personverninnstillingdefinisjonen.

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":"12048645510",
   "partKode":"NFS"
}

Responsparametre (oppdatert 2024-05-02)

Navn

Type

Kommentar


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 (Ny Q2 2024)

int

Hvilket sekvensnummer dette er for innbygger instans av denne personverninnstillingdefinisjonen. Har verdien “0” dersom innbygger enda ikke har satt noen instilling for denne personverninnstillingdefinisjonen.

Løpenummer som begynner på 1 for hver gang innbygger har satt/endrte den aktuelle innstilling. Dersom

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 (Ny Q2 2024)

time

Tidspunkt for når første instans av innbyggers personverninnstilling ble opprettet. Har verdien NULL dersom innbygger enda ikke har satt noen instilling for denne personverninnstillingdefinisjonen.

Tidspunkt for når sekvensnummer 1 ble opprettet,

sistEndretTidspunkt (Ny Q2 2024)

time

Tidspunkt for nå innbygger sist satt/endret personnverninnstillingen. Har verdien NULL dersom innbygger enda ikke har satt noen instilling for denne personverninnstillingdefinisjonen.

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

...

Code Block
definisjonGuid=3FE2A80A-4200-42E2-817B-DA8A6236708A&partKode=NFS&pagingReference=0

Responsparametre (endret 2025-05-02)

Navn

Type

Lovlige verdier

Kommentar

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 (Ny Q2 2024)

  • sistEndretTidspunkt (Ny Q2 2024)

  • 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 ghan 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)

...