Table of Contents |
---|
Tjenesteoversikt
TjenesteNavn | HttpVerb | Beskrivelse |
---|---|---|
SjekkInnbyggersPiStatus | POST <system url>/personvern/Personverninnstillinger/SjekkInnbyggersPiStatus/v2 | Returnerer status på en bestemt Personverninnstilling for en gitt innbygger. |
HentInnbyggersPiForPart | POST <system url>/personvern/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 | GET <system url>/personvern/Personverninnstillinger/HentInnbyggereAktivePiForDefinisjon/v2 | Returnerer en liste med fødselsnummer for alle innbyggere som har en aktiv personverninnstilling for en bestemt Personverninnstillingdefinisjon. Kan benyttes for å:
|
<system url> : Dette er bas.eurl for ekstern api’ene i de forskjellige testsystemer og i produksjon. Oversikt over disse finnes her: Testmiljøer og endepunkter
...
Metadata for samtykker og reservasjoner
Hovedstruktur
SaMetadata eller ReMetadata | Type | Kommentar |
---|---|---|
SaFasteMetadata eller ReFasteMetadata (conditional) | Se under. | Er med kun dersom det er definerte faste metadata på definisjonen. Normalt med i alle nyere definisjoner. |
SaInnbyggerMetadata eller ReInnbyggerMetdata (conditinal) | Se under | Er kun med dersom definisjonen tillater at innbygger setter tidsbegrensninger og innbygger har satt slike. |
Faste metadata for en definisjon
Dette er metadata som beskriver innstillingens virkeområde/omfang og som gjelder alle innbyggere.
fasteMetadata | Type | Lovlige verdier | Kommentar |
---|---|---|---|
tidsbegrensning | 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 |
omfangElementer | Liste | Det kan være flere enn et slikt element (eventuelt ingen) | |
omfangKode (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 |
Metadata som innbygger kan sette selv
Dette er metadata som innbygger kan settes selv, dersom definisjonen tillater det, og som er individuelle pr. innbygger.
SaInnbyggerMetadata 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 | ||
fraDato | string | Dato | Fra og med |
tilDato | string | Dato | til og med |
Metadata for tilgangsbegrensninger
Hovedstruktur
TbMetadata | Type | Kommentar |
---|---|---|
TbFasteMetadata (mandatory) | Se under. | Er med for alle definisjoner. |
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. |
Faste metadata for en definisjon
Dette er metadata som beskriver innstillingens virkeområde/omfang og som gjelder alle innbyggere.
TbFasteMetadata | 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.) | |
omfangKode (mandatory) | string | Omfanget av tilgangsbegrensningen: kodeverk fra Volven 7608. Følgende verdier er lovlige for tilgangsbegrensning: SP: Sperre tilgang til helseopplysninger BL: Blokkere tilgang til helseopplysninger | |
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 |
2 verdier: |
|
Følgende to verdier er for fremtidig bruk, og ikek implementert full støtte for enda:
| |||
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 |
rollens verdi i kodeverket. Eksempel: “Fastlege”. |
Metadata som innbygger kan sette selv
Dette er metadata som beskriver innstillingens virkeområde/omfang og som gjelder alle innbyggere.
TbInnbyggerMetadata | 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 | ||
fraDato | string | Dato | Fra og med |
tilDato | 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 |
SjekkInnbyggersPiStatus
Input parametere
Navn | Type | Lovlige verdier | Kommentar |
---|---|---|---|
innbyggerFnr | string | fødselsnummer (11 siffer) | Dette er fødselsnummer til innbygger det spørres på. |
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. 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.) |
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.) |
Eks:
{
"innbyggerFnr":"12048645510",
"definisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A",
"definisjonNavn":"Samtykke til oppbevaring av biomateriale",
"partKode":"NFS"
}
Responsparametre
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.
|
Eksempler
Samtykker
Samtykke uten metadata
...
Dette tjenestekallet returnerer kun innstillinger aktuell innbygger har aktiv hos aktøren. Merk! EN innstilling anses aktiv selv om tidsperiode angitt for innstillingens virkeområde ikke er “aktiv”.
Input parametere
Navn | Type | Lovlige verdier | Kommentar |
---|---|---|---|
innbyggerFnr | string | fødselsnummer (11 siffer) | Dette er fødselsnummer til innbygger det spørres på. |
partKode | string | Forhåndskjent verdi | Kortnavn som identifisere det aktuelle register/screeningprogram/forskningsprosjekt som eier den aktuelle personverninnstilling. |
Eks:
{
"innbyggerFnr":"12048645510",
"partKode":"NFS"
}
Responsparametre
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.
|
Eksempel
Eksemplet viser innbygger som har et aktivt samtykke med innbygger bestemt tidsperiode, samt en tilgangsbegrensning for angitt 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. 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. |
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. |
pagingReference | query string parameter | Verdi fås i respons. | Skal være med i request. Nye kall må gjøres med mottatt pagingReference så lenge denne er større enn verdien “0”. |
Eks (første kall):
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:
|
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) |
Eksempler
Eks (reservasjon, en innbygger har individuell innstilling)
...