Registrering av eksternt avgitte personverninnstillinger

Owned by sven.christiansen (Unlicensed)
Last updated: Jun 29, 2021 by sven.christiansen
2 min read

Tjenesteoversikt

TjenesteNavn

Http

Beskrivelse

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: https://helsenorge.atlassian.net/wiki/spaces/HELSENORGE/pages/24051725

SettInnbyggersPersonvernInnstilling

Input parametre

Navn

Type

Lovlige verdier

Kommentar

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:

  • samtykke

  • reservasjon

  • tilgangsbegrensning

status

string

Status

Kan ha en av følgende verdier:

  • piIkkeAktiv

    • Samtykke: Ikke samtykket

    • Reservasjon: Ingen Reservasjon satt

    • Tilgangsbegrensning: Ingen tilgangsbegrensning satt

  • piAktiv

    • Samtykke: Har samtykket

    • Reservasjon: Reservasjon satt

    • Tilgangsbegrensning: Tilgangsbegrensning satt.

innbyggerTbMetadata

JSON

Struktur med metadata for tilgangsbegrensning

(C=Conditional). Er kun med dersom definisjonen er av type tilgangsbegrensning


Eks: Sette et nytt samtykke:

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

Eks: Slette et tidligere gitt samtykke:

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

Eks: Sette en ny reservasjon:

{
   "innbyggerFnr":"12048645510",
   "definisjonGuid":"ecc56090-124b-4405-8137-2a616c683ffc",
   "definisjonNavn":"Reservasjon mot registrering av helseopplysninger",
   "partKode":"PDMR",
   "typePi": “reservasjon”,
   "status":"piAktiv
}

Eks: Slette en tidligere satt reservasjon:

{
   "innbyggerFnr":"12048645510",
   "definisjonGuid":"ecc56090-124b-4405-8137-2a616c683ffc",
   "definisjonNavn":"Reservasjon mot registrering av helseopplysninger",
   "partKode":"PDMR",
   "typePi": “reservasjon”,
   "status":"piIkkeAktiv
}

Eks: Sette ny tilgangsbegrensning. Enten registrerer ny instans eller oppdatere eksisterende instans med flere helsepersonell:

{
   "innbyggerFnr":"12048645510",
   "definisjonGuid":"3F7457B8-821C-45A8-AE04-D3E4A0DAC0F0",
   "definisjonNavn":"Begrensning av helsepersonells tilgang til legemiddelliste",
   "partKode":"RF",
   "typePi": “tilgangsbegrensning”,
   "status":"piAktiv",
   "innbyggerTbMetadata": [
   {
      "type":"helsepersonell",
      "nummer":"1234567",
      "navn":"Per Olsen"
   },
   {
      "type":"helsepersonell",
      "nummer":"9876543",
      "navn":"Lisa Elin Kultvedt"
   } ]
}

Eks: Slette tidligere satt tilgangsbegrensning. Enten slette instans (hvis alle fjernes) eller oppdatere eksisterende instans ved å slette noen av de tidligere registrerte helsepersonell:

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

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


Eks (samtykket var allerede registrert):

{
“returkode”: “ok”,

"instansEndret":"ikkeEndret",
 }

Respons ved feil

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

  • Statuskode når kallet er utført ok: 200 

  • Statuskode ved feil internt på Helsenorge: 500

  • Statuskode ved feil i request: 400

  • Statuskode ved manglende tilganger: 403

  • Statuskode ved feil eller manglende autorisasjon: 401

Ved HTTP-statuskoder som tilsier at det har oppstått en feil returneres også en respons med feilkode og feilmelding.

Eks:
{
  "Code": "SEC-110000",
  "Message": "Token is expired or invalid"
}