Opprett definisjon

POST <system url>/personvern/innstillingdefinisjon/v1

Oppretter en definisjon basert på en mal.

Oppdater definisjon

PATCH <system url>/personvern/innstillingdefinisjon/v1

Oppdaterer en eksisterende definisjon, det er begrenset hva som kan oppdateres for å forhindre at eksisterende personverninnstillinger satt for denne definisjonen blir ugyldige.

definisjonMalGuid

Guid

Påkrevd

Guid for eksisterende mal i PVK

Personverninnstilling definisjonen malens unike ID

definisjonGuid

Guid

Påkrevd

Unik id for personverninnstilling definisjonen

Brukes til å unikt identifisere en personverninnstilling definisjon. Det anbefales å bruke samme guid i testmiljø og produksjon for å forenkle oppsett, testing og kommunikasjon mellom systemer og mennesker.

partKode

string

Påkrevd

Eksisterende partKode i PVK

PartKode identifiserer hvem som eier en personverninnstilling definisjon.

navn

string

Påkrevd

Navn på register/ forskningsprosjekt/ studie/ biobank

Navnet brukes for å kjenne igjen definisjonen i oversikter og vil brukes i tekster fra malen som har støtte for placeholder verdier basert på navn.

beskrivelse

string

Frivillig

Beskrivelse av hva personverninnstillingen gjelder. Dette skal være en velformulert tekst som enkelt forklarer for innbyggere hva de samtykker til / reserverer seg mot.

Behov for fullstendige vilkår og utdypende tekst støttes ved at det lastes opp en pdf fil.

Dette feltet har varierende grad av frivillighet, det bestemmes av malen.

• Hvis malen har en fast beskrivelse som kun tar navn som variabel verdi har dette feltet ingen betydning

• Hvis malen har en fast beskrivelse som også har en grad av tilpasning vil dette feltet være påkrevd

• Hvis malen ikke har en fast beskrivelse vil dette feltet være påkrevd

visning

string

Påkrevd

• “alltid”

• “aldri”

• “instans”

• “inkludering-part”

• “inkludering-definisjon”

Bestemmer hvordan personverninnstillingen tilgjengeliggjøres for innbyggere via Helsenorge.

• alltid: Alle innbygger vil se denne innstillingen så fort den er laget

• aldri: Innbyggere vil aldri se denne innstillingen

• instans: Innbyggere vil kun se denne innstillingen dersom det finnes en aktiv instans av den. Dette fordrer at eksterne aktører benytter SettInnbyggersPersonvernInnstilling.

• inkludering-part: Innbyggere vil kun se denne innstillingen om de har inkluderingsbilett for parten. Dette fordrer at eksterne aktører benytter SettInnbyggersInkludering.

• inkludering-definisjon: Innbyggere vil kun se denne innstillingen om de er inkluderingsbilett for definisjonen. Dette fordrer at eksterne aktører benytter SettInnbyggersInkludering.

fullstendigTekstInnhold

string

Frivillig

En base 64 enkodet PDF fil

Fullstendig juridisk tekst som forklarer personverninnstillingen.

Maks 4 MB før base64 enkoding.

kravTilLesingAvFullstendigTekst

boolean

Frivillig

true, false

Om det er krav om at innbygger må lese den fullstendige teksten før personverninnstillingen kan settes. Kan bare brukes om det er lastet opp en fullstendig tekst fil.

Vil innføres i APIet på ett senere tidspunkt.

sortering

int

Frivillig

Alle positive int 32 verdier

Brukes til å angi sorteringsrekkefølge for personverninnstillinger når det er flere definisjoner som eies av samme part.

replikering

boolean

Frivillig

true, false

Skal det opprettes ett abonnement slik at innbyggers endringer av personverninnstillingen replikeres til databehandler. Abonnementet settes da opp basert på eksisterende konfigurasjon av databehandler i PVK.

Databehandlere med:

• HerId definert vil det settes opp AMQP abonnement, korrekt CPP må da ligge i adresseregisteret.

• ReplikeringsUri definert vil få et REST abonnement basert på nyeste tilgjengelige versjon

relasjoner

liste av relasjoner

Frivillig

eksisterende personverninnstilling definisjoner og relasjonstyper

Brukes til å sette opp relasjoner mellom definisjoner, definisjonen må eksistere i PVK og eies av samme partKode for at relasjonen skal kunne opprettes.

definisjonGuid

Guid

Påkrevd

En eksisterende personverninnstilling definisjon i PVK. Det kan ikke opprettes relasjoner til “seg selv”.

relasjonType

string

Påkrevd

• “erstattet-av”

• “avhengig-av”

• “ny-versjon-av”

Bestemmer type avhengighet mellom denne og en annen personverninnstilling definisjon

• avhengig-av: Hvordan denne fungerer kommer an på hva slags type personverninnstilling det er (reservasjon, samtykke)

  • reservasjon: Denne innstillingen kan ikke gis dersom innbygger har en aktiv reservasjon

  • samtykke: Denne innstillingen kan ikke gis dersom innbygger ikke har ett aktivt samtykke

• erstatter-av: Denne innstillingen erstatter en annen innstilling, innstillinger satt av innbygger for den gamle definisjonen vil ikke lenger være gydlige

• ny-versjon-av: Det er kommet en ny versjon av innstillingen, innstillinger innbygger har gitt for gammel versjon er fortsatt gyldig.

beskrivelse

string

Påkrevd

Kort beskrivelse av relasjonen (vises til innbygger)

definisjonGuid

Guid

Påkrevd

Guid for eksisterende definisjon

Personverninnstilling definisjonen malens unike ID

visning

string

Frivillig

• “alltid”

• “aldri”

• “instans”

• “inkludering-part”

• “inkludering-definisjon”

Bestemmer hvordan personverninnstillingen tilgjengeliggjøres for innbyggere via Helsenorge.

• alltid: Alle innbygger vil se denne innstillingen så fort den er laget

• aldri: Innbyggere vil aldri se denne innstillingen

• instans: Innbyggere vil kun se denne innstillingen dersom det finnes en aktiv instans av den. Dette fordrer at eksterne aktører benytter SettInnbyggersPersonvernInnstilling.

• inkludering-part: Innbyggere vil kun se denne innstillingen om de har inkluderingsbilett for parten. Dette fordrer at eksterne aktører benytter SettInnbyggersInkludering

• inkludering-definisjon: Innbyggere vil kun se denne innstillingen om de er inkluderingsbilett for definisjonen. Dette fordrer at eksterne aktører benytter SettInnbyggersInkludering

kravTilLesingAvFullstendigTekst:

bool

Frivillig

null, true, false

Om det er krav om at innbygger må lese den fullstendige teksten før personverninnstillingen kan settes. Kan bare brukes om det er lastet opp en fullstendig tekst fil.

Vil innføres i APIet på ett senere tidspunkt.

sortering

int

Frivillig

null, alle positive int 32 verdier

Gjelder kun for sortering innenfor parten som eier personverninnstilling definsjonen

replikering

bool

Frivillig

null, true, false

Opprette eller slette replikering

status

string

Frivillig

deaktivert

Brukes for å dekativere en personverninnstilling definisjon. En deaktivert definsjon kan ikke reaktiveres.

relasjoner

liste av relasjoner

Frivillig

null, tom liste, liste over eksisterende personverninnstilling definisjoner og relasjonstyper

Brukes til å sette opp relasjoner mellom definisjoner, definisjonen må eksistere i PVK for at relasjonen skal kunne opprettes.

Fullstendig liste over relasjoner må sendes inn ved endring da inkommende liste vil være fasit for nytt sett med relasjoner.

• hvis listen er null vil ingen endringer på relasjoner utføres

• hvis listen er tom ([]) vil eksisterende relasjoner slettes

• hvis listen inneholder verdier vil eksisterende relasjoner oppdateres basert på innkommende liste