Versions Compared

Key

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

Tjenesteoversikt

...

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.

<system url> : Dette er bas.eurl for ekstern api’ene i de forskjellige testsystemer og i produksjon. Oversikt over disse finnes her: Testmiljøer og endepunkter

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. DigitalAktiv 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 - V2

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

...

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

...

Table of Contents

Tjenesteoversikt

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.

<system url> : Dette er bas.eurl for ekstern api’ene i de forskjellige testsystemer og i produksjon. Oversikt over disse finnes her: Testmiljøer og endepunkter

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

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

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

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

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

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.

fasteMetadata

TbFasteMetadata

Type

Lovlige verdier

Kommentar

tidsbegrensning (conditional)

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

er alltid med et slikt

element (eventuelt ingen

listelemenet for Tilgangsbegrensninger. (Data modellen tillater flere, men vi har ingen usecase pr. nå der dette benyttes.)

omfangKode (mandatory)

string

(kodeverdi)

Omfanget av

samtykke/reservasjon

tilgangsbegrensningen: 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

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.

  • 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

    ...

    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

    ...

    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

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

    TbFasteMetadata

    TbInnbyggerMetadata

    Type

    Lovlige verdier

    tidsbegrensning

    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

    (conditional)

    Kun

    Er 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 ikek implementert full støtte for enda:

    • 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

    ...

    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.

    ...

    (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

    ...

    (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

    ...

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

    Eks:

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

    Responsparametre

    ...

    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)

    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

    Eksempler

    Samtykker

    Samtykke uten metadata

    Code Block
    {
       "innbyggerFnr":"12048645510",
       "definisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A",
       "definisjonNavn":"Samtykke til oppbevaring av biomateriale",
       "partKode":"NFS",
       "typePi": “samtykke”,
       "aktiv": true
    }

    Samtykke med fast tidsbegrensning og metadata

    Her er det en fast tidsbegrensning for hvilken periode samtykket gjelder for. Videre er det i eksemplet to stk. omfangElement:

    • OF (oppføring)

    • IO (innhenting av helseopplysninger, med tilhørende presisering)

    ...

    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

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

    Eks:

    {
      "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.

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

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

    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

    Eksempler

    Samtykker

    Samtykke uten metadata

    Code Block
    {
       "innbyggerFnr":"12048645510",
       "definisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A",
       "definisjonNavn":"Samtykke til oppbevaring av biomateriale",
       "partKode":"NFS",
       "typePi": “samtykke”,
       "aktiv": true,
      "sekvensnummer":3,
      "opprettetTidspunkt":"2020-01-16T11:09:38.4871148+01:00",
      "sistEndretTidspunkt":"2020-03-12T11:09:38.4870056+01:00"
    }

    Samtykke med fast tidsbegrensning og metadata

    Her er det en fast tidsbegrensning for hvilken periode samtykket gjelder for. Videre er det i eksemplet to stk. omfangElement:

    • OF (oppføring)

    • IO (innhenting av helseopplysninger, med tilhørende presisering)

    Code Block
    {
       "innbyggerFnr": "12048645510",
       "definisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A",
       "definisjonNavn":"Samtykke til oppbevaring av biomateriale",
       "partKode":"NFS",
       "typePi":"samtykke",
       "aktiv": true,
       "sekvensnummer":3,
       "opprettetTidspunkt":"2020-01-16T11:09:38.4871148+01:00",
       "sistEndretTidspunkt":"2020-03-12T11:09:38.4870056+01:00",
       "SaMetadata":
       {
          "SaFasteMetadata":
          {
              "tidsbegrensning":
              {
                  "tidsbegrensetFra": "2022-01-01",
                  "tidsbegrensetTil": "2023-12-31"
              },
              "omfangElementer": [
                 {
                   "omfangKode": "OF"
                 },
                 {
                   "tidsbegrensetFraomfangKode": "2022-01-01IO",
                   "tidsbegrensetTillogiskOmfang": "2023-12-31"
         Angitte",
        },           "omfangElementerpresisering": ["Blodprøver"
                 {}          
         "omfangKode": "OF"   ]
          }
       },
    
    }

    Reservasjon

    Reservasjon uten metadata

    Code Block
    {
       "innbyggerFnr":"12048645510",
       "definisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A",
        {
      "definisjonNavn":"Reservasjon mot lagring av helseopplysninger",
       "partKode":"PDMR",
       "typePi": "reservasjon",
       "omfangKodeaktiv": "IO"false,
       "sekvensnummer":2,
       "opprettetTidspunkt":"2020-01-16T11:09:38.4871148+01:00",
       "sistEndretTidspunkt":"2020-03-12T11:09:38.4870056+01:00"
    }

    Reservasjon med innbygger satt tidsbegrensning og metadata

    Her har reservasjonen metadata som forklarer i kodeverk hva den gjelder (utlevering av direkte personidentifiserbare opplysninger). Videre har innbygger satt 2 tidsperioder der reservasjonen gjelder.

    Code Block
    {
       "logiskOmfanginnbyggerFnr": "Angitte12048645510",
            
          "presiseringdefinisjonGuid": "Blodprøver"
          "3FE2A80A-4200-42E2-817B-DA8A6236708A",
       "definisjonNavn":"Reservasjon mot }utlevering av helseopplysninger",
       "partKode":"PDMR",
       "typePi": "reservasjon",
       "aktiv": true,
       ]"sekvensnummer":2,
       "opprettetTidspunkt":"2020-01-16T11:09:38.4871148+01:00",
      }
       }
    }

    Reservasjon

    Reservasjon uten metadata

    Code Block
    { "sistEndretTidspunkt":"2020-03-12T11:09:38.4870056+01:00",
       "innbyggerFnrReMetadata":"12048645510",
       {
          "definisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A",
       "definisjonNavn":"Reservasjon mot lagring av helseopplysninger",ReFasteMetadata":
          {
              "partKodeomfangElementer":"PDMR", [
      "typePi": "reservasjon",    "aktiv": false
    }

    Reservasjon med innbygger satt tidsbegrensning og metadata

    Her har reservasjonen metadata som forklarer i kodeverk hva den gjelder (utlevering av direkte personidentifiserbare opplysninger). Videre har innbygger satt 2 tidsperioder der reservasjonen gjelder.

    Code Block
    {     {
        "innbyggerFnr          "omfangKode": "12048645510UO",
       "definisjonGuid           "logiskOmfang":"3FE2A80A-4200-42E2-817B-DA8A6236708A "Angitte",
         "definisjonNavn":"Reservasjon mot utlevering av helseopplysninger",         "partKodepresisering": "PDMR",Direkte personidentifiserbare opplysninger"
                 }          
         "typePi": "reservasjon",    "aktiv": true,]
        "ReMetadata":   },
    {       "ReFasteMetadataReInnbyggerMetadata":
           {
              "omfangElementertidsbegrensning": 
     [         {
          {       "perioder": [
          "omfangKode": "UO",           {
         "logiskOmfang": "Angitte",               "presiseringfraDato": "Direkte personidentifiserbare opplysninger""2022-01-01",
                         "tilDato":"2022-06-01"
      }               },
         ]        },    {
       "ReInnbyggerMetadata":        {          "fraDato": "tidsbegrensning": 
      2022-09-01",
           {              "periodertilDato": ["2022-12-31"
                     {}
                 ]
           "fraDato":"2022-01-01",   }
           }
        }
     } 

    Tilgangsbegrensning

    Tilgangsbegrensning av type sperre som gjelder alt helsepersonell

    I dette eksemplet har vi også lagt på en tidsperiode som innbygger har satt der denne sperren gjelder.

    Code Block
    {
       "tilDatoinnbyggerFnr":"2022-06-0112048645510",
            "definisjonGuid":"9c869253-ed40-4447-abdb-9e2024a88af0",
       "definisjonNavn":"Sperre tilgang for alt  }helsepersonell",
       "partKode":"nilar",
       "typePi": "tilgangsbegrensning",
       "aktiv": true,
       {"sekvensnummer":3,
       "opprettetTidspunkt":"2020-01-16T11:09:38.4871148+01:00",
       "sistEndretTidspunkt":"2020-03-12T11:09:38.4870056+01:00",
       "TbMetadata":
          {
      "fraDato": "2022-09-01",     "TbFasteMetadata":
           {
              "tilDatoomfangElementer": "2022-12-31"[
                 {
       }              ]"omfangKode": "SP",
                  }  "logiskOmfang": "Alle",
        }     }  } 

    Tilgangsbegrensning

    Tilgangsbegrensning av type sperre som gjelder alt helsepersonell

    I dette eksemplet har vi også lagt på en tidsperiode som innbygger har satt der denne sperren gjelder.

    Code Block
    {    "innbyggerFnrtypeAngivelse": "12048645510Helsepersonell",
        "definisjonGuid":"9c869253-ed40-4447-abdb-9e2024a88af0",    "definisjonNavn":"Sperre tilgang for alt helsepersonell",  }
     "partKode":"nilar",    "typePi": "tilgangsbegrensning",    "aktiv": true, ]
       "TbMetadata":    {},
           "TbFasteMetadataTbInnbyggerMetadata":
           {
              "omfangElementertidsbegrensning": [
      
              {
                    "omfangKodeperioder": "SP",[
                    {
     "logiskOmfang": "Alle",                 "typeAngivelsefraDato": "Helsepersonell2022-01-01",
                  }     "tilDato":"2022-06-01"
            ]        },
                "TbInnbyggerMetadata": ]
          {    }
          "tidsbegrensning":}
       }
    }

    Tilgangsbegrensning av type blokkering som gjelder alt helsepersonell unntatt fastlegen

    Dette er fast for definisjonen g kan ikke velges av innbygger). Vi har lagt på en innbygger satt tidsbegrensning i dette eksemplet.

    Code Block
    {
       "innbyggerFnr":"12048645510",
      { "definisjonGuid":"a3c17c59-d197-47fd-aa51-64cdfdf847db",
       "definisjonNavn":"Blokkere tilgang for alt helsepersonell unntatt fastlege",
       "perioderpartKode":"RF",
    [      "typePi": "tilgangsbegrensning",
       "aktiv": true,
       "sekvensnummer":2,
     {  "opprettetTidspunkt":"2020-01-16T11:09:38.4871148+01:00",
       "sistEndretTidspunkt":"2020-03-12T11:09:38.4870056+01:00"
       "sekvensnummer":3,
        "opprettetTidspunkt":"2020-01-16T11:09:38.4871148+01:00",
        "fraDatosistEndretTidspunkt":"20222020-01-0103-12T11:09:38.4870056+01:00",
       "TbMetadata":
          {
            "tilDatoTbFasteMetadata":"2022-06-01"
          {
             "omfangElementer": }[
                {
    ]           }    "omfangKode": "BL",
      }    } }

    Tilgangsbegrensning av type blokkering som gjelder alt helsepersonell unntatt fastlegen

    Dette er fast for definisjonen g kan ikke velges av innbygger). Vi har lagt på en innbygger satt tidsbegrensning i dette eksemplet.

    Code Block
    {    "innbyggerFnr":"12048645510",    "definisjonGuidlogiskOmfang":"a3c17c59-d197-47fd-aa51-64cdfdf847db "Angitte",
         "definisjonNavn":"Blokkere tilgang for alt helsepersonell unntatt fastlege",    "partKodetypeAngivelse": "RF",Rolle til Pasient"
               "typePi": "tilgangsbegrensning", }
       "aktiv": true,    "TbMetadata": ],
      {       "TbFasteMetadatadetaljertAngivelse": 
             {
                "omfangElementerrolleTilPasient": [
                   {
                      "omfangKoderolle": "BLFastlege",
                   }
      "logiskOmfang": "Angitte",         ]
          "typeAngivelse": "Rolle til Pasient"}
          },
         } "TbInnbyggerMetadata":
           {
    ],          "detaljertAngivelsetidsbegrensning": 
              {
                 "rolleTilPasientperioder": [
                    {
                       "rollefraDato": "Fastlege2022-01-01",
                   }     "tilDato":"2022-06-01"
           ]          }
          },       "TbInnbyggerMetadata":]
           {   }
           "tidsbegrensning":}
               {
           }
    }

    Tilgangsbegrensning av type blokkering som gjelder angitt helsepersonell

    Innbygger angir hvilket helsepersonell som det ska blokkeres tilgang for (vi har også her lagt på en innbygger bestemt tidsperiode).

    Code Block
    {
         "perioderinnbyggerFnr":"12048645510",
    [   "definisjonGuid":"61d0da0d-1e08-425f-b0c6-2a01019cc181",
       "definisjonNavn":"Blokkere tilgang for angitt helsepersonell",
       "partKode":"nilar",
     {  "typePi": "tilgangsbegrensning",
       "aktiv": true,
       "sekvensnummer":3,
       "opprettetTidspunkt":"2020-01-16T11:09:38.4871148+01:00",
       "fraDatosistEndretTidspunkt":"20222020-01-0103-12T11:09:38.4870056+01:00",    
       "TbMetadata":
       {
           "tilDatoTbFasteMetadata":"2022-06-01"
           {
              "omfangElementer": [
     }            {
     ]           }    "omfangKode": "BL",
      }     } }

    Tilgangsbegrensning av type blokkering som gjelder angitt helsepersonell

    Innbygger angir hvilket helsepersonell som det ska blokkeres tilgang for (vi har også her lagt på en innbygger bestemt tidsperiode).

    Code Block
    {    "innbyggerFnr":"12048645510",    "definisjonGuidlogiskOmfang":"61d0da0d-1e08-425f-b0c6-2a01019cc181 "Angitte",
       "definisjonNavn":"Blokkere tilgang for angitt helsepersonell",         "partKode":"nilar",    "typePitypeAngivelse": "tilgangsbegrensningHelsepersonell",
        "aktiv": true,    "TbMetadata":    {}
           "TbFasteMetadata":   ]
        {   },
           "omfangElementerTbInnbyggerMetadata":
    [       {
          {    "tidsbegrensning": 
              {
     "omfangKode": "BL",           "perioder": [
        "logiskOmfang": "Angitte",           {
         "typeAngivelse": "Helsepersonell"              }"fraDato":"2022-01-01",
               ]        },"tilDato":"2022-06-01"
           "TbInnbyggerMetadata":        { }
             "tidsbegrensning":    ]
           {   },
              "perioderdetaljertAngivelse": [
              {
         {          "navngittHelseperson": [
            "fraDato":"2022-01-01",          {
             "tilDato":"2022-06-01"            "nummer": "4128168",
       }              ]    "navn": "Linda Ingrid Telle"
       },           "detaljertAngivelse":    },
           {           {
        "navngittHelseperson": [                 "nummer":"1234567",
     {                      "nummernavn":"Per "4128168Olsen",
                      }
        "navn": "Linda Ingrid Telle"        ]
              },
           }
                  {
                         "nummer":"1234567",
                         "navn":"Per Olsen"
                      }
                   ]
              }
           }
        }
    }

    HentInnbyggersPiForPart

    Dette tjenestekallet returnerer kun innstillinger aktuell innbygger har aktiv hos aktøren. Merk! EN innstilling anses aktiv selv om tidsperiode angitt for innstillingens virkeområde ikke er “aktiv”.

    Input parametere

    ...

    Navn

    ...

    Type

    ...

    Lovlige verdier

    ...

    Kommentar

    ...

    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.

    Eks:

    {
       "innbyggerFnr":"12048645510",
       "partKode":"NFS"
    }

    Responsparametre

    ...

    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

    ...

    }
    }

    HentInnbyggersPiForPart

    Dette tjenestekallet returnerer kun innstillinger aktuell innbygger har aktiv hos aktøren. Merk! EN innstilling anses aktiv selv om tidsperiode angitt for innstillingens virkeområde ikke er “aktiv”.

    Input parametere

    Navn

    Type

    Lovlige verdier

    Kommentar

    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.

    Eks:

    {
       "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.

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

    time

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

    Tidspunkt for når sekvensnummer 1 ble opprettet,

    sistEndretTidspunkt (Ny Q2 2024)

    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

    Eksempel

    Eksemplet viser innbygger som har et aktivt samtykke med innbygger bestemt tidsperiode, samt en tilgangsbegrensning for angitt helsepersonell.

    Code Block
    {
       "funnet": true,
       "personverninnstillinger": [
          {
             "innbyggerFnr": "12048645510",
             "definisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A",
             "definisjonNavn":"Samtykke til oppbevaring av biomateriale",
             "partKode":"NFS"",
             "typePi":"samtykke",
             "aktiv": true, 
             "sekvensnummer":3,
             "typePiopprettetTidspunkt":"samtykke2020-01-16T11:09:38.4871148+01:00",
             "aktivsistEndretTidspunkt": true, "2020-03-12T11:09:38.4870056+01:00",   
              "SaMetadata":
              {
                 "SaFasteMetadata":
                 {
                     "tidsbegrensning":
                     {
                         "tidsbegrensetFra": "2022-01-01",
                         "tidsbegrensetTil": "2023-12-31"
                     },
                     "omfangElementer": [
                        {
                          "omfangKode": "OF"
                        },
                        {
                          "omfangKode": "IO",
                          "logiskOmfang": "Angitte",
                          "presisering": "Blodprøver"
                       }          
                    ]
                 }
              }
          },
          {
             "innbyggerFnr": "12048645510",
             "definisjonGuid":"61d0da0d-1e08-425f-b0c6-2a01019cc181-b0c6-2a01019cc181",
             "definisjonNavn":"Blokkere tilgang for angitt helsepersonell",
             "partKode":"NFS",
             "typePi": "tilgangsbegrensning",
             "definisjonNavnaktiv":"Blokkere tilgang for angitt helsepersonell" true,
             "partKodesekvensnummer":"NFS"3,
             "typePiopprettetTidspunkt": "tilgangsbegrensning"2020-01-16T11:09:38.4871148+01:00",
             "aktivsistEndretTidspunkt": true"2020-03-12T11:09:38.4870056+01:00",
             "TbMetadata":
              {
                  "TbFasteMetadata":
                  {
                     "omfangElementer": [
                        {
                           "omfangKode": "BL",
                           "logiskOmfang": "Angitte",
                           "typeAngivelse": "Helsepersonell"
                        },
                     ]
                  },
                  "TbInnbyggerMetadata":
                  {
                     "tidsbegrensning": 
                     {
                        "perioder": [
                           {
                              "fraDato":"2022-01-01",
                              "tilDato":"2022-06-01"
                           }
                        ]
                     },
                     "detaljertAngivelse": 
                     {
                          "navngittHelseperson": [
                             {
                                "nummer": "4128168",
                                "navn": "Linda Ingrid Telle"
                             },
                             {
                                "nummer":"1234567",
                                "navn":"Per Olsen"
                             }
                          ]
                     }
                  }
              }
          }        
       ]
    }

    HentInnbyggereAktivePiForDefinisjon

    Fordi denne tjenesten kan returnere et meget stort antall objekter i responsen, er det en litt annen hovedstruktur der faste metadata for definisjonen beskrives kun en gang (og ikke for hver innbyggerinstans). Imildertid benyttes de samme responsobjekter som i de øvrige tjenestene. NB! Her benyttes HTTP verbet GET.

    Input parametere

    Navn

    Type

    Lovlige verdier

    Kommentar

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

    ...

    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 gang innbygger endrer den aktuelle inn stilling)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)

    Eksempler

    Eks (reservasjon, en innbygger har individuell innstilling)

    Code Block
    {
       "definisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A",
       "definisjonNavn":"Reservasjon mot utlevering av helseopplysninger",
       "partKode":"PDMR",
       "typePi": "reservasjon",",
       "pagingReference": 0,
       "ReFasteMetadata":
       {
          "omfangElementer": [
             {
                "omfangKode": "UO",
                "logiskOmfang": "Angitte",
                "pagingReferencepresisering": "Direkte 0,personidentifiserbare opplysninger"
      "ReFasteMetadata":    {   }    "omfangElementer": [     
        {  ]
       },   
       "omfangKodepersonvernInnstillinger": "UO", [
          {
             "logiskOmfanginnbyggerFnr": "Angitte12048645510",
                "presiseringsekvensnummer": "Direkte1,
    personidentifiserbare opplysninger"        "opprettetTidspunkt":"2020-01-16T11:09:38.4871148+01:00",
     }          
       "sistEndretTidspunkt":"2020-03-12T11:09:38.4870056+01:00"
      ]    },   
      
    "personvernInnstillinger": [       {
             "innbyggerFnr": "1204864551011059643310",
             "sekvensnummer": 1
          }3,
          {
             "innbyggerFnropprettetTidspunkt":"110596433102020-01-16T11:09:38.4871148+01:00",
             "sekvensnummer": 3sistEndretTidspunkt":"2020-03-12T11:09:38.4870056+01:00",
             "ReInnbyggerMetadata":
             {
                "tidsbegrensning": 
                {
                   "perioder": [
                     {
                         "fraDato":"2022-01-01",
                         "tilDato":"2022-06-01"
                     },
                     {
                         "fraDato": "2022-09-01",
                         "tilDato": "2022-12-31""
                     }
                   ]
                }
             } 
        ]  },
          {
       }      "innbyggerFnr": "81205649216",
      }       "sekvensnummer": }3,
            { "opprettetTidspunkt":"2021-01-16T11:09:38.4871148+01:00",
             "innbyggerFnrsistEndretTidspunkt": "81205649216"2023-03-12T11:09:38.4870056+01:00"
          }
       ]
    }   

    Eks (tilgangsbegrensning, to innbyggere har aktiv innstilling)

    Code Block
    {
      "definisjonGuid":"61d0da0d-1e08-425f-b0c6-2a01019cc181",
       "definisjonNavn":"Blokkere tilgang for angitt helsepersonell",
       "partKode":"nilar",
       "typePi": "tilgangsbegrensning",
       "pagingReference": 0,
       "TbFasteMetadata":
       {
          "omfangElementer": [
             {
                "omfangKode": "BL",
                "logiskOmfang": "Angitte",
                "typeAngivelse": "Helsepersonell"
             }
          ]
       },
       "personvernInnstillinger": [
          {
             "innbyggerFnr": "12048645510",
          {   "sekvensnummer": 2,
             "innbyggerFnropprettetTidspunkt": "12048645510"2021-01-16T11:09:38.4871148+01:00",
             "sekvensnummersistEndretTidspunkt": 2"2023-03-12T11:09:38.4870056+01:00",
             "TbInnbyggerMetadata":
             {
                 "detaljertAngivelse": 
                 {
                    "navngittHelseperson": [
                       {
                          "nummer": "4128168",
                          "navn": "Linda Ingrid Telle"
                       },
                       {
                          "nummer":"1234567",
                          "navn":"Per Olsen"
                       }
                    ]
                 }
             }
          },
          {
             "innbyggerFnr":"11059643",
             "sekvensnummer": 6,
             "opprettetTidspunkt":"2021-01-16T11:09:38.4871148+01:00",
             "sistEndretTidspunkt":"2023-03-12T11:09:38.4870056+01:00",
             "TbInnbyggerMetadata":
             {
                "tidsbegrensning": 
                {
                   "perioder": [
                     {
                         "fraDato":"2022-01-01",
                         "tilDato":"2022-06-01"
                     },
                     {
                         "fraDato": "2022-09-01",
                         "tilDato": "2022-12-31"
                     }
                   ]
                },
                "detaljertAngivelse": 
                {
                    "navngittHelseperson": [
                       {
                          "nummer": "786432",
                          "navn": "Hans Helle"
                       }
                    ]
                }
             }
          }
       ]
    }

    Respons ved feil

    Alle tjenester i API'ene har følgende logikk for HTTP-respons:

    ...