...
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
...
SaMetadata eller ReMetadata | Type | Kommentar |
|---|---|---|
fasteMetadata SaFasteMetadata eller ReFasteMetadata (conditional) | Se under. | Er med kun dersom det er definerte faste metadata på definisjonen. Normalt med i alle nyere definisjoner. |
innbyggerMetadata SaInnbyggerMetadata eller ReInnbyggerMetdata (conditinal) | Se under | Er kun med dersom definisjonen tillater at innbygger setter tidsbegrensninger og innbygger har satt slike. |
...
Dette er metadata som innbygger kan settes selv, dersom definisjonen tillater det, og som er individuelle pr. innbygger.
innbyggerMetadataSaInnbyggerMetadata 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 | ||
fraTidspunkt | string | Dato | Fra og med |
tilTidspukt | string | Dato | til og med |
...
Hovedstruktur
TbMetadata | Type | Kommentar |
|---|---|---|
fasteMetadata TbFasteMetadata (mandatory) | Se under. | Er med kun dersom det er definerte faste metadata på definisjonen. Normalt med i alle nyere definisjoner. |
innbyggerMetadata 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. |
...
Dette er metadata som beskriver innstillingens virkeområde/omfang og som gjelder alle innbyggere.
fasteMetadataTbFasteMetadata | Type | Lovlige verdier | |
|---|---|---|---|
tidsbegrensning (conditional) | element (conditional) | Kun 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.) | |
omfang (mandatory) | string | Omfanget av tilgangsbegrensningen: kodeverk fra Volven 7608. Følgende verdier er aktuelle for tilgangsbegrensning: SP: Sperre tilgang til helseopplysninger BL: Blokkere tilgang til helseopplysninger Merk! For tilgangsbegrensninger tillater vi ikke | |
logiskOmfang (mandatory) | string | Kan ha en av følgende tre verdier:
| |
typeAngivelse (mandatory) | string | Angir hvilken type angivelse som benyttes for å beskrive hva/hvem tilgangsbegrensningen gjelder for. Kan ha en av følgende 4 verdier:
| |
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 kodeverkets verdi. Eksempel: “Fastlege”. |
...
Dette er metadata som beskriver innstillingens virkeområde/omfang og som gjelder alle innbyggere.
innbyggerMetadataTbInnbyggerMetadata | 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 | ||
fraTidspunkt | string | Dato | Fra og med |
tilTidspukt | 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 |
...
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:
|
aktiv | bool | Kan ha en av følgende verdier:
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)
ReMetadata (element)
TbMetadata (element)
| 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.
|
...
| Code Block |
|---|
{
"innbyggerFnr": "12048645510",
"definisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A",
"definisjonNavn":"Samtykke til oppbevaring av biomateriale",
"partKode":"NFS",
"typePi":"samtykke",
"aktiv": true,
"SaMetadata":
{
"fasteMetadataSaFasteMetadata":
{
"tidsbegrensning":
{
"tidsbegrensetFra": "2022-01-01",
"tidsbegrensetTil": "2023-12-31"
},
"omfangElementer": [
{
"omfang": "OF"
},
{
"omfang": "IO",
"logiskOmfang": "Angitte",
"presisering": "Blodprøver"
}
]
}
}
} |
...
| Code Block |
|---|
{
"innbyggerFnr":"12048645510",
"definisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A",
"definisjonNavn":"Reservasjon mot utlevering av helseopplysninger",
"partKode":"PDMR",
"typePi": "reservasjon",
"aktiv": true,
"ReMetadata":
{
"fasteMetadataReFasteMetadata":
{
"omfangElementer": [
{
"omfang": "UO",
"logiskOmfang": "Angitte",
"presisering": "Direkte personidentifiserbare opplysninger"
}
]
},
"innbyggerMetadataReInnbyggerMetadata":
{
"tidsbegrensning":
{
"perioder": [
{
"fraTidspunkt":"2022-01-01",
"tilTidspunkt":"2022-06-01"
},
{
"fraTidspunkt": "2022-09-01",
"tilTidspunkt": "2022-12-31"
}
]
}
}
}
} |
...
| Code Block |
|---|
{
"innbyggerFnr":"12048645510",
"definisjonGuid":"9c869253-ed40-4447-abdb-9e2024a88af0",
"definisjonNavn":"Sperre tilgang for alt helsepersonell",
"partKode":"nilar",
"typePi": "tilgangsbegrensning",
"aktiv": true,
"TbMetadata":
{
"fasteMetadataTbFasteMetadata":
{
"omfangElementer": [
{
"omfang": "SP",
"logiskOmfang": "Alle",
"typeAngivelse": "Helsepersonell"
}
]
},
"innbyggerMetadataTbInnbyggerMetadata":
{
"tidsbegrensning":
{
"perioder": [
{
"fraTidspunkt":"2022-01-01",
"tilTidspunkt":"2022-06-01"
}
]
}
}
}
} |
...
| Code Block |
|---|
{
"innbyggerFnr":"12048645510",
"definisjonGuid":"a3c17c59-d197-47fd-aa51-64cdfdf847db",
"definisjonNavn":"Blokkere tilgang for alt helsepersonell unntatt fastlege",
"partKode":"RF",
"typePi": "tilgangsbegrensning",
"aktiv": true,
"TbMetadata":
{
"fasteMetadataTbFasteMetadata":
{
"omfangElementer": [
{
"omfang": "BL",
"logiskOmfang": "Angitte",
"typeAngivelse": "Rolle til Pasient"
}
],
"detaljertAngivelse":
{
"rolleTilPasient": [
{
"rolle": "Fastlege"
}
]
}
},
"innbyggerMetadataTbInnbyggerMetadata":
{
"tidsbegrensning":
{
"perioder": [
{
"fraTidspunkt":"2022-01-01",
"tilTidspunkt":"2022-06-01"
}
]
}
}
}
} |
...
| Code Block |
|---|
{
"innbyggerFnr":"12048645510",
"definisjonGuid":"61d0da0d-1e08-425f-b0c6-2a01019cc181",
"definisjonNavn":"Blokkere tilgang for angitt helsepersonell",
"partKode":"nilar",
"typePi": "tilgangsbegrensning",
"aktiv": true,
"TbMetadata":
{
"fasteMetadataTbFasteMetadata":
{
"omfangElementer": [
{
"omfang": "BL",
"logiskOmfang": "Angitte",
"typeAngivelse": "Helsepersonell"
}
]
},
"innbyggerMetadataTbInnbyggerMetadata":
{
"tidsbegrensning":
{
"perioder": [
{
"fraTidspunkt":"2022-01-01",
"tilTidspunkt":"2022-06-01"
}
]
},
"detaljertAngivelse":
{
"navngittHelseperson": [
{
"nummer": "4128168",
"navn": "Linda Ingrid Telle"
},
{
"nummer":"1234567",
"navn":"Per Olsen"
}
]
}
}
}
} |
...
| 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,
"SaMetadata":
{
"fasteMetadataSaFasteMetadata":
{
"tidsbegrensning":
{
"tidsbegrensetFra": "2022-01-01",
"tidsbegrensetTil": "2023-12-31"
},
"omfangElementer": [
{
"omfang": "OF"
},
{
"omfang": "IO",
"logiskOmfang": "Angitte",
"presisering": "Blodprøver"
}
]
}
}
},
{
"innbyggerFnr": "12048645510",
"definisjonGuid":"61d0da0d-1e08-425f-b0c6-2a01019cc181",
"definisjonNavn":"Blokkere tilgang for angitt helsepersonell",
"partKode":"NFS",
"typePi": "tilgangsbegrensning",
"aktiv": true,
"TbMetadata":
{
"fasteMetadataTbFasteMetadata":
{
"omfangElementer": [
{
"omfang": "BL",
"logiskOmfang": "Angitte",
"typeAngivelse": "Helsepersonell"
},
]
},
"innbyggerMetadataTbInnbyggerMetadata":
{
"tidsbegrensning":
{
"perioder": [
{
"fraTidspunkt":"2022-01-01",
"tilTidspunkt":"2022-06-01"
}
]
},
"detaljertAngivelse":
{
"navngittHelseperson": [
{
"nummer": "4128168",
"navn": "Linda Ingrid Telle"
},
{
"nummer":"1234567",
"navn":"Per Olsen"
}
]
}
}
}
}
]
} |
...
| Code Block |
|---|
{
"definisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A",
"definisjonNavn":"Reservasjon mot utlevering av helseopplysninger",
"partKode":"PDMR",
"typePi": "reservasjon",
"pagingReference": 0,
"FasteMetadataReFasteMetadata":
{
"omfangElementer": [
{
"omfang": "UO",
"logiskOmfang": "Angitte",
"presisering": "Direkte personidentifiserbare opplysninger"
}
]
},
"personvernInnstillinger": [
{
"innbyggerFnr": "12048645510"
},
{
"innbyggerFnr":"11059643310",
"innbyggerMetadataReInnbyggerMetadata":
{
"tidsbegrensning":
{
"perioder": [
{
"fraTidspunkt":"2022-01-01",
"tilTidspunkt":"2022-06-01"
},
{
"fraTidspunkt": "2022-09-01",
"tilTidspunkt": "2022-12-31"
}
]
}
}
},
{
"innbyggerFnr": "81205649216"
}
]
} |
...
| Code Block |
|---|
{
"definisjonGuid":"61d0da0d-1e08-425f-b0c6-2a01019cc181",
"definisjonNavn":"Blokkere tilgang for angitt helsepersonell",
"partKode":"nilar",
"typePi": "tilgangsbegrensning",
"pagingReference": 0,
"fasteMetadataTbFasteMetadata":
{
"omfangElementer": [
{
"omfang": "BL",
"logiskOmfang": "Angitte",
"typeAngivelse": "Helsepersonell"
}
]
},
"personvernInnstillinger": [
{
"innbyggerFnr": "12048645510",
"innbyggerMetadataTbInnbyggerMetadata":
{
"detaljertAngivelse":
{
"navngittHelseperson": [
{
"nummer": "4128168",
"navn": "Linda Ingrid Telle"
},
{
"nummer":"1234567",
"navn":"Per Olsen"
}
]
}
}
},
{
"innbyggerFnr":"11059643",
"innbyggerMetadataTbInnbyggerMetadata":
{
"tidsbegrensning":
{
"perioder": [
{
"fraTidspunkt":"2022-01-01",
"tilTidspunkt":"2022-06-01"
},
{
"fraTidspunkt": "2022-09-01",
"tilTidspunkt": "2022-12-31"
}
]
},
"detaljertAngivelse":
{
"navngittHelseperson": [
{
"nummer": "786432",
"navn": "Hans Helle"
}
]
}
}
}
]
} |
...