Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
{
   "innbyggerFnr":"12048645510",
   "definisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A",
   "definisjonNavn":"Reservasjon mot utlevering av helseopplysninger",
   "partKode":"PDMR",
   "typePi": "reservasjon",
   "aktiv": true,
   "ReMetadata":
   {
      "SaFasteMetadataReFasteMetadata":
      {
          "omfangElement": [
             {
              "omfang": "UO",
              "logiskOmfang": "Angitte",
              "presisering": "Direkte personidentifiserbare opplysninger"
             }          
          ]
       },
       "SaInnbyggerMetadataReInnbyggerMetadata":
       {
          "innbyggerTidsbegrensninger": 
          {
             "periode": [
                 {
                     "fraTidspunkt":"2022-01-01",
                     "tilTidspunkt":"2022-06-01"
                 },
                 {
                     "fraTidspunkt": "2022-09-01",
                     "tilTidspunkt": "2022-12-31"
                 }
             ]
          }
       }
    }
 }  

Tilgangsbegrensning

Tilgangsbegrensning av type sperre som gjelder alt helsepersonell

...

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.

Input

...

parametere

Navn

Type

Lovlige verdier

Kommentar

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.

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.

typePi

string

Type personverninnstilling

Kan ha en av følgende verdier:

  • samtykke

  • reservasjon

  • tilgangsbegrensning

pagingReference

int

Verdi fås i respons.

Skal være med i request i etterfølgende kall dersom det er behov for paging, og kan være med i første request, men må da ha verdien 0.

...

Code Block
{   
   "definisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A",    
   "partKode":"NFS",
   "pagingReference": 0
}

Responsparametre

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 (mandatory)

  • En av følgende (avhengig av “typePi)

    • SaInnbyggerMetadata

    • ReInnbyggerMetadata

    • TbInnbyggerMetadata

Element (liste)

  • string

  • JSON (se over)

  • JSON (se over)

  • Gyldig fødselsnummer

  • 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":"SamtykkeReservasjon tilmot oppbevaringutlevering av biomaterialehelseopplysninger",
      "partKode":"NFSPDMR",   
   "typePi": "samtykkereservasjon",  
   "pagingReference": 0,
   "ReFasteMetadata":
   {
      "personvernInnstillingeromfangElement": [
         {
            "innbyggerFnromfang": "12048645510UO",
      },       {"logiskOmfang": "Angitte",
            "innbyggerFnrpresisering": "11059643310"Direkte personidentifiserbare opplysninger"
         } ]
}

Eks (tilgangsbegrensning):

Code Block
{          
      ]
   "definisjonGuid":"91b682e1-6a6d-4f3d-ad25-233dfddbe490"},   
   "definisjonNavnpersonvernInnstillinger":"Sperring mot[
innsyn i prøvesvar",    {
  "partKode":"NFS",       "typePiinnbyggerFnr": "tilgangsbegrensning12048645510",
   "pagingReference": 0,  },
    "personvernInnstillinger": [ {
     {      "innbyggerFnr":"11059643310",
         "ReInnbyggerMetadata":
         {
            "innbyggerTidsbegrensninger": 
            {
               "periode": [
                 {
                     "fraTidspunkt":"2022-01-01",
                     "tilTidspunkt":"2022-06-01"
                 },
                 {
                     "fraTidspunkt": "2022-09-01",
                     "tilTidspunkt": "2022-12-31"
                 }
               ]
            }
         } 
      },
      {
         "innbyggerFnr": "81205649216"
      }
   ]
}   

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":
   {
      "omfang": "BL",
      "logiskOmfang": "Angitte",
      "typeAngivelse": "Helsepersonell"
   },
   "personvernInnstillinger": [
      {
         "innbyggerFnr": "12048645510",
         "TbInnbyggerMetadata":
         {
             "innbyggerDetaljertAngivelse": 
             {
                "navngittHelseperson": [
                   {
                      "nummer": "4128168",
                      "navn": "Linda Ingrid Telle"
                   },
                   {
                      "nummer":"1234567",
                      "navn":"Per Olsen"
                   }
                ]
             }
         }
      },
      {
         "innbyggerFnr":"11059643",
         "TbInnbyggerMetadata":
         {
            "innbyggerTidsbegrensninger": 
     "innbyggerFnr":"12048645510",       {
     "innbyggerTbMetadata":[          "periode": [
 {                {
  "type":"helsepersonell",                   "nummerfraTidspunkt":"12345672022-01-01",
                     "navntilTidspunkt":"Per Olsen2022-06-01"
            },     },
       {               {
   "type":"helsepersonell",                   "nummerfraTidspunkt": "98765432022-09-01",
                     "navntilTidspunkt":"Lisa Elin Kultvedt" "2022-12-31"
                 }]
        },       {]
            "innbyggerFnr":"11059643310"},
            "innbyggerTbMetadatainnbyggerDetaljertAngivelse":[ 
            {  
                "typenavngittHelseperson":"helsepersonell", [
                   {
   "nummer":"1234599",                   "navnnummer": "Kim Hansen786432",
            },          "navn": "Hans Helle"
{                   "type":"helsepersonell",}
                ]
 "nummer":"9876599",           }
       "navn":"Nina Petersen" }
    }]  }
    }]
}

Respons ved feil

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

...