| Table of Contents |
|---|
Tjenesteoversikt
TjenesteNavn | Http | Beskrivelse |
|---|---|---|
SettInnbyggersPersonvernInnstilling | POST <system url>/personvern/v1/Personverninnstillinger/SettInnbyggersPersonvernInnstilling | Nyregistrerer en innbyggers instans av en bestemt personverninnstilling eller endre status på en allerede satt innstilling. |
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
SettInnbyggersPersonvernInnstilling
Input parametre
Navn | Type | Lovlige verdier | Kommentar |
|---|---|---|---|
innbyggerFnr | string | fødselsnummer (11 siffer) | Dette er fødselsnummer til innbygger hvis personverninnstilling skal registreres eller endres |
definisjonGuid | string | GUID | GUID for den personverninnstilling definisjon det gjelder |
definisjonNavn | string | Navn på innstillingen | Beskrivende kortnavn på personverninnstilling definisjonen. (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.) |
typePi | string | Type personverninnstilling | Kan ha en av følgende verdier:
|
status | string | Status | Kan ha en av følgende verdier:
|
innbyggerTbMetadata | JSON | Struktur med metadata for tilgangsbegrensning | (C=Conditional). Er kun med dersom definisjonen er av type tilgangsbegrensning |
...
{
"innbyggerFnr":"12048645510",
"definisjonGuid":"3F7457B8-821C-45A8-AE04-D3E4A0DAC0F0",
"definisjonNavn":"Begrensning av helsepersonells tilgang til legemiddelliste",
"partKode":"RF",
"typePi": “tilgangsbegrensning”,
"status":"piIkkeAktiv",
"innbyggerTbMetadata": [
{
"type":"helsepersonell",
"nummer":"1234567",
"navn":"Per Olsen"
},
{
"type":"helsepersonell",
"nummer":"9876543",
"navn":"Lisa Elin Kultvedt"
} ]
}
Responsparameter (ved HTTP 200)
Navn | Type | Lovlige verdier | Kommentar |
|---|---|---|---|
returKode | string | ok ikkeOk | |
instansEndret | string | endret ikkeEndret | Dersom retur er "ikkeEndret" betyr dette at aktuell personverninnstilling for denne innbygger allerede hadde angitt verdi eller at et samtykke som trekkes aldri har vært gitt (dvs. det fantes ingen instans). |
...
"instansEndret":"ikkeEndret",
}
Respons ved feil
Alle tjenester i API'ene har følgende logikk for HTTP-respons:
...