...
TjenesteNavn | HttpVerb | Beskrivelse |
---|---|---|
SjekkInnbyggersPiStatus | POST <system url>/personvern/v2/Personverninnstillinger/SjekkInnbyggersPiStatus/v2 | Returnerer status på en bestemt Personverninnstilling for en gitt innbygger. |
HentInnbyggersPiForPart | POST <system url>/personvern/v2/Personverninnstillinger/HentInnbyggersPiForPart/v2 | Returnerer en liste over personverninnstillinger for en bestemt innbygger som tilhører en bestemt aktør inklusiv innstillingenes status. Merk! Denne returnerer kun status på de Personverninnstillinger der det finnes en instans hos aktuell innbygger og der denne har status "Aktiv", dvs. at den er virksom. Historikk vises derfor ikke. |
HentInnbyggereAktivePiForDefinisjon | POST GET <system url>/personvern/v2/Personverninnstillinger/HentInnbyggereAktivePiForDefinisjon/v2 | Returnerer en liste med fødselsnummer for alle innbyggere som har en aktiv personverninnstilling for en bestemt Personverninnstillingdefinisjon. Kan benyttes for å:
|
...
SaMetadata eller ReMetadata | Type | Kommentar |
---|---|---|
SaFasteMetadata eller ReFasteMetadata fasteMetadata (conditional) | Se under. | Er med kun dersom det er definerte faste metadata på definisjonen. Normalt med i alle nyere definisjoner. |
SaInnbyggerMetadata eller ReInnbyggerMetadata innbyggerMetadata (conditinal) | Se under | Er kun med dersom definisjonen tillater at innbygger setter tidsbegrensninger og innbygger har satt slike. |
...
Dette er metadata som beskriver innstillingens virkeområde/omfang og som gjelder alle innbyggere.
SaFasteMetadata eller ReFasteMetadatafasteMetadata | Type | Lovlige verdier | Kommentar |
---|---|---|---|
fastTidsbegrensningtidsbegrensning | element (conditional) | Kun med hvis det er en fast tidsbegrensning for innstillingens virkeområde. Merk! Eventuelle tidsbegrensning gjelder felles for alle “Omfang” elementer (dersom det er flere av disse). | |
tidsbegrensetFra | string | Dato | Fra og med |
tidsbegrensetTil | string | Dato | Til og med |
omfangElementomfangElementer | Liste | Det kan være flere enn et slikt element (eventuelt ingen) | |
omfang (mandatory) | string (kodeverdi) | Omfanget av samtykke/reservasjon: kodeverk fra Volven 7608. Følgende verdier er aktuelle for Samtykke eller Reservasjon: DT: Digital tilgang OF: Oppføring UO: Utlevering av helseopplysninger IO: Innhenting av helseopplysninger DO: Deltagelse i ordning eller tjeneste | |
logiskOmfang (optional) | string | Kan ha en av følgende tre verdier:
| |
presisering (optional) | string | Fritekstfelt: Bilateralt avtalt mellom Register og NHN | Presisering ift. Omfang, benyttes hvis nødvendig |
...
Dette er metadata som innbygger kan settes selv, dersom definisjonen tillater det, og som er individuelle pr. innbygger.
SaInnbyggerMetadata eller ReInnbyggerMetadatainnbyggerMetadata | Type | Lovlige verdier | Kommentar |
---|---|---|---|
innbyggerTidsbergensningertidsbergensning | 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). | |
periode perioder | liste | ||
fraTidspunkt | string | Dato | Fra og med |
tilTidspukt | string | Dato | til og med |
Metadata for tilgangsbegrensninger
Hovedstruktur
SaMetadata eller ReMetadataTbMetadata | Type | Kommentar |
---|---|---|
TbFasteMetadata fasteMetadata (mandatory) | Se under. | Er med kun dersom det er definerte faste metadata på definisjonen. Normalt med i alle nyere definisjoner. |
TbInnbyggerMetadata innbyggerMetadata (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.
TbFasteMetadatafasteMetadata | Type | Lovlige verdier | |
---|---|---|---|
fastTidsbegrensning tidsbegrensning (conditional) | element (conditional) | Kun med hvis det er en fast tidsbegrensning for innstillingens virkeområde. | |
tidsbegrensetFra | string | Dato | |
tidsbegrensetTil | string | Dato | |
omfangElementomfangElementer | 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:
| |
fastDetaljertAngivelse 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.
TbInnbyggerMetadatainnbyggerMetadata | Type | Lovlige verdier | Kommentar |
---|---|---|---|
innbyggerTidsbergensninger tidsbergensning (conditional) | element | Kun med dersom definisjonen har gitt innbygger slik mulighet og innbygger har angitt en eller flere tidsperioder. | |
periode perioder | liste | ||
fraTidspunkt | string | Dato | Fra og med |
tilTidspukt | string | Dato | til og med |
innbyggerDetaljertAngivelse 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)
fasteMetadata ReMetadata (element)
TbMetadata (element)
fasteMetadata | 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": { "SaFasteMetadatafasteMetadata": { "fastTidsbegrensningtidsbegrensning": { "tidsbegrensetFra": "2022-01-01", "tidsbegrensetTil": "2023-12-31" }, "omfangElementomfangElementer": [ { "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": { "ReFasteMetadatafasteMetadata": { "omfangElementomfangElementer": [ { "omfang": "UO", "logiskOmfang": "Angitte", "presisering": "Direkte personidentifiserbare opplysninger" } ] }, "ReInnbyggerMetadatainnbyggerMetadata": { "innbyggerTidsbegrensningertidsbegrensning": { "periodeperioder": [ { "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": { "TbFasteMetadatafasteMetadata": { "omfangElementomfangElementer": [ { "omfang": "SP", "logiskOmfang": "Alle", "typeAngivelse": "Helsepersonell" } ] }, "TbInnbyggerMetadatainnbyggerMetadata": { "innbyggerTidsbegrensningertidsbegrensning": { "periodeperioder": [ { "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": { "TbFasteMetadatafasteMetadata": { "omfangElementomfangElementer": [ { "omfang": "BL", "logiskOmfang": "Angitte", "typeAngivelse": "Rolle til Pasient" } ], "fastDetaljertAngivelsedetaljertAngivelse": { "rolleTilPasient": [ { "rolle": "Fastlege" } ] } }, "TbInnbyggerMetadatainnbyggerMetadata": { "innbyggerTidsbegrensningertidsbegrensning": { "periodeperioder": [ { "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": { "TbFasteMetadatafasteMetadata": { "omfangElementomfangElementer": [ { "omfang": "BL", "logiskOmfang": "Angitte", "typeAngivelse": "Helsepersonell" } ] }, "TbInnbyggerMetadatainnbyggerMetadata": { "innbyggerTidsbegrensningertidsbegrensning": { "periodeperioder": [ { "fraTidspunkt":"2022-01-01", "tilTidspunkt":"2022-06-01" } ] }, "innbyggerDetaljertAngivelsedetaljertAngivelse": { "navngittHelseperson": [ { "nummer": "4128168", "navn": "Linda Ingrid Telle" }, { "nummer":"1234567", "navn":"Per Olsen" } ] } } } } |
...
Navn | Type | Kommentar | |
---|---|---|---|
funnet | boolean | Denne vil alltid være med i retur. | "true" dersom minst en aktiv personverninnstilling ble funnet for innbygger tilhørende den parten det forespørres på. |
personvernInnstillinger | liste | JSON-struktur | En liste med de aktive personverninnstillinger som finnes for aktuell innbygger knyttet til den aktuelle part. Disse har eksakt samme struktur som i respons for andre tjenestekall som gjelder kun en enkelt innstilling. Derav dublering av innbyggers fødselsnummer og PartKode i hver returnert aktiv innstilling. |
|
|
|
|
| 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 |
---|
{ "funnet": true, "personverninnstillinger": [ { "innbyggerFnr": "12048645510", "definisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A", "definisjonNavn":"Samtykke til oppbevaring av biomateriale", "partKode":"NFS", "typePi":"samtykke", "aktiv": true, "SaMetadata": { "SaFasteMetadatafasteMetadata": { "fastTidsbegrensningtidsbegrensning": { "tidsbegrensetFra": "2022-01-01", "tidsbegrensetTil": "2023-12-31" }, "omfangElementomfangElementer": [ { "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": { "TbFasteMetadatafasteMetadata": { "omfangElementomfangElementer": [ { "omfang": "BL", "logiskOmfang": "Angitte", "typeAngivelse": "Helsepersonell" }, ] }, "TbInnbyggerMetadatainnbyggerMetadata": { "innbyggerTidsbegrensningertidsbegrensning": { "periodeperioder": [ { "fraTidspunkt":"2022-01-01", "tilTidspunkt":"2022-06-01" } ] }, "innbyggerDetaljertAngivelsedetaljertAngivelse": { "navngittHelseperson": [ { "nummer": "4128168", "navn": "Linda Ingrid Telle" }, { "nummer":"1234567", "navn":"Per Olsen" } ] } } } } ] } |
...
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. NB! Her benyttes HTTP verbet GET.
Input parametere
Navn | Type | Lovlige verdier | Kommentar |
---|---|---|---|
definisjonGuid | query string parameter | Forhåndskjent verdi | GUID som referer til en bestemt personverninnstilling. Må være kjent på forhånd av kallende system. |
definisjonNavn | query string parameter | Navn på innstillingen | Beskrivende kortnavn på den forespurte personverndefinisjon. |
partKode | query string parameter | 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 | query string parameter | Type personverninnstilling | Kan ha en av følgende verdier:
|
pagingReferenceint | query string parameter | 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. |
Eks (første kall):
Code Block |
---|
{ definisjonGuid=3FE2A80A-4200-42E2-817B-DA8A6236708A&partKode=NFS&typePi=reservasjon "definisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A", "partKode":"NFS" } |
eller
Code Block |
---|
{ "definisjonGuid":"definisjonGuid=3FE2A80A-4200-42E2-817B-DA8A6236708A", "partKode":"NFS", "pagingReference": 0 }&partKode=NFS&typePi=reservasjon&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:
|
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”:
| |||
personvernInnstillinger
| Element (liste)
|
| En liste med alle de innbygger som har en aktiv instans (aktiv reservasjon, samtykke eller tilgangsbegrensning) |
...
Code Block |
---|
{ "definisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A", "definisjonNavn":"Reservasjon mot utlevering av helseopplysninger", "partKode":"PDMR", "typePi": "reservasjon", "pagingReference": 0, "ReFasteMetadataFasteMetadata": { "omfangElementomfangElementer": [ { "omfang": "UO", "logiskOmfang": "Angitte", "presisering": "Direkte personidentifiserbare opplysninger" } ] }, "personvernInnstillinger": [ { "innbyggerFnr": "12048645510" }, { "innbyggerFnr":"11059643310", "ReInnbyggerMetadatainnbyggerMetadata": { "innbyggerTidsbegrensningertidsbegrensning": { "periodeperioder": [ { "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, "TbFasteMetadatafasteMetadata": { "omfangElementomfangElementer": [ { "omfang": "BL", "logiskOmfang": "Angitte", "typeAngivelse": "Helsepersonell" } ] }, "personvernInnstillinger": [ { "innbyggerFnr": "12048645510", "TbInnbyggerMetadatainnbyggerMetadata": { "innbyggerDetaljertAngivelsedetaljertAngivelse": { "navngittHelseperson": [ { "nummer": "4128168", "navn": "Linda Ingrid Telle" }, { "nummer":"1234567", "navn":"Per Olsen" } ] } } }, { "innbyggerFnr":"11059643", "TbInnbyggerMetadatainnbyggerMetadata": { "innbyggerTidsbegrensningertidsbegrensning": { "periodeperioder": [ { "fraTidspunkt":"2022-01-01", "tilTidspunkt":"2022-06-01" }, { "fraTidspunkt": "2022-09-01", "tilTidspunkt": "2022-12-31" } ] }, "innbyggerDetaljertAngivelsedetaljertAngivelse": { "navngittHelseperson": [ { "nummer": "786432", "navn": "Hans Helle" } ] } } } ] } |
...