Fullmaktinformasjon (arkivert)
Introduksjon
API’et må benyttes av brukersteder i Helse-og Omsorgsektoren der digitale fullmakter skal kunne benyttes. Fullmaktene registreres alltid i Pertsonvernkomponenten (PVK) i Helsenorge. Brukersteder må altså ha slik API integrasjon for at de elektroniske fullmaktene skal kunne benyttes.
API'et skal dekke følgende USeCases:
Et brukersted vil sjekke om det finnes en gyldig fullmakt for aktuelt formål.
Dersom fullmakte eksisterer, skal brukerstedet kunne laste ned et “fullmaktsbevis” som må arkiveres som dokumentasjon for handlingen som ble utført basert på den aktuelle fullmakten.
Tjenesteoversikt
TjenesteNavn | Http | Beskrivelse |
---|---|---|
Fullmaktshavere | POST <system url>/personvern/Fullmaktshavere/v1 | Hente ut liste over fullmaktshavere (de som har fått fullmakt) av en gitt innbygger innefor et gitt virkeområde. |
Fullmaktsgivere | POST <system url>/personvern/Fullmaktsgivere/v1 | Hente ut liste over fullmaktsgivere (de som har gitt en innbygger fullmakt til å representere seg) innenfor et gitt område. |
FullmaktToken | POST <system url>/personvern/FullmaktToken/v1 | Henter ut detaljer om et fullmaktsforhold. (Digitalt fullmaktsbevis) |
Se her for oversikt over <system url> for de forskjellige systemene Test-, Qa og Prod: Testmiljøer og endepunkter
Autorisasjon og aksesstoken
To metoder for tilgang er tilgjengelige:
HelseId sin autoriseringstjeneste for maskin-til-maskin kan benyttes:
Velg Helsenorge Ekstern API i HelseId sin selvbetjeningsløsning
Velg deretter scope “Fullmaktinformasjon_les”
Når tilgangen er godkjent av Helsenorge, kan aksesstoken hentes ut fra HelseId
API-klienten kan alternativt autentisere seg mot Helsenorge Sikkerhetstjeneste.
API-klienten må forhåndskonfigureres på Helsenorge med sin public key
Fullmaktinformasjon API-et skal benyttes i system-til-system kontekst: 01 - System til System
Deretter kan API-klienten få utsedt et AksessToken fra Helsenorge STS.
AksessToken som mottas fra HelseId eller Helsenorge STS skal deretter være med i Authorization header i alle HTTP-requestene. Se: 02 - Kall til Helsenorge og PVK API'er og bruk av AccessToken
Fullmaktshavere
Returnerer en liste over hvem som har fått fullmakt (fullmaktshaver) fra en bestemt person (fullmaktsgiver).
Input parametre
Navn | Type | Lovlige verdier | Kommentar |
---|---|---|---|
fullmaktsgiverIdNrType | string | Volven kodeverk 8116. Lovlige verdier: “FNR” (Fødselsnummer) “DNR” (D-nummer) | Innført for å skille på D-nummer og FNR som nasjonal NIN |
fullmaktsgiverIdNr | string | fødselsnummer eller D-nummer (11 siffer) | Dette er fødselsnummer eller D-nummer til den innbygger som har avgitt fullmakter, og som det skal returneres en liste over fullmaktshavere for. |
fullmaktVirkeomrade | string | Tokenverdier (kan utvides) | Angir fullmaktens virkeområde, dvs. hvor den kan benyttes “helsenorge” - Fullmakten kan kun benyttes for digitale helsetjenester på Helsenorge “helseogomsorg” - Fullmakten kan benyttes i hele Helse og Omsorgsektoren “apotekogbandagist” - Fullmakten kan benyttes på apotek og bandagister |
fullmaktDefinisjonGuid | string | Eksisterende fullmaktsdefinisjon i PVK | Denne er opsjonell. Kan benyttes dersom man øsnker å begrense søket til en bestemt fullmakt innenfor et virkeområde (der det eksistere flere fullmaktdefinisjoner). |
Request eks:
{
"fullmaktsgiverIdNrType": "FNR",
"fullmaktsgiverIdNr":"12048645510",
"fullmaktVirkeomrade": "apotekogbandagist"
}
Responsparametre
Navn | Type | Lovlige verddier | Kommentar |
---|---|---|---|
fullmaktsgiverIdNrType | string | Volven kodeverk 8116. Lovlige verdier: “FNR” (Fødselsnummer) “DNR” (D-nummer) | Innført for å skille på D-nummer og FNR som nasjonal NIN |
fullmaktsgiverIdNr | string | fødselsnummer (11 siffer) | Dette er fødselsnummer eller D-nummer til den innbygger som har avgitt fullmakter (og som det ble spurt på). |
fullmaktVirkeomrade | string | Tokenverdier (kan utvides) | Angir fullmaktens virkeområde, dvs. hvor den kan benyttes “helsenorge” - Fullmakten kan kun benyttes for digitale helsetjenester på Helsenorge “helseogomsorg” - Fullmakten kan benyttes i hele Helse og Omsorgsektoren “apotekogbandagist” - Fullmakten kan benyttes på apotek og bandagister |
fullmaktshaverFunnet | boolean | Denne vil alltid være med i retur. | |
fullmaktDefinisjoner | array |
| Det vil være en liste med fullmathavere pr fullmaktdefinisjon innenfor det aktuelle virksomhetsområde. |
| string | Eksisterende fullmaktsdefinisjon i PVK | Fullmaktdefinisjonens unike ID |
| string | Eksisterende fullmaktsdefinisjon i PVK | Fullmaktdefinisjonenes beskrivende navn |
| array | JSON-struktur | En liste med fulmakthaver (som er gitt av fullmaktgiver). |
|
| "fullmaktReferanseId" benyttes i etterfølgende kall for å få detaljer om en fullmakt/fullmaktsbeviset. |
Respons eks:
{
"fullmaktsgiverIdNrType": "FNR",
"fullmaktsgiverIdNr":"12048645510",
"fullmaktVirkeomrade": "apotekogbandagist",
"fullmaktshaverFunnet":"TRUE",
"fullmaktDefinisjoner": [
{
"fullmaktDefinisjonGuid": "fd9faa5d-acf9-461f-a493-8f6f6c29a8d3",
"fullmaktDefinisjonNavn": "Fullmakt for å hente ut reseptbelagte apotekvarer",
"fullmakthavere": [
{
"fornavn":"Per",
"mellomnavn":"Ole",
"etternavn":"Hansen",
"fodselsdato":"1955-11-19",
"fullmaktReferanseId":"3FE2A80A-4200-42E2-817B-DA8A6236708A"
},
{
"fornavn":"Hans",
"mellomnavn":"Per",
"etternavn":"Olesen",
"fodselsdato":"1962-06-12",
"fullmaktReferanseId":"3F7457B8-821C-45A8-AE04-D3E4A0DAC0F0"
}
]
},
{
"fullmaktDefinisjonGuid": "904af8ec-0d8a-43dc-bb2e-dfccfc69f2cc",
"fullmaktDefinisjonNavn": "Fullmakt til å få utlevert reseptliste og journalinformasjon",
"fullmakthavere": [
{
"fornavn":"Ina",
"mellomnavn":"",
"etternavn":"Hansen",
"fodselsdato":"1954-10-17",
"fullmaktReferanseId":"4b702b23-27fa-467c-aa54-759483307579"
}
]
}
]
}
Fullmaktsgivere
Returnerer en liste over hvem som har gitt fullmakt (fullmaktsgivere) til en bestemt person (fullmaktshaver).
Input parametre
Navn | Type | Lovlige verdier | Kommentar |
---|---|---|---|
fullmaktshaverIdNrType | string | Volven kodeverk 8116. Lovlige verdier: “FNR” (Fødselsnummer) “DNR” (D-nummer) | Innført for å skille på D-nummer og FNR som nasjonal NIN |
fullmaktshaverIdNr | string | fødselsnummer (11 siffer) | Dette er fødselsnummer eller D-nummer til den innbygger som har fått fullmakter av andre, og som det skal returneres en liste over fullmaktsgivere for. |
fullmaktVirkeomrade | string | Tokenverdier (kan utvides) | Angir fullmaktens virkeområde, dvs. hvor den kan benyttes “helsenorge” - Fullmakten kan kun benyttes for digitale helsetjenester på Helsenorge “helseogomsorg” - Fullmakten kan benyttes i hele Helse og Omsorgsektoren “apotekogbandagist” - Fullmakten kan benyttes på apotek og bandagister |
fullmaktDefinisjonGuid | string | Eksisterende fullmaktsdefinisjon i PVK | Denne er opsjonell. Kan benyttes dersom man øsnker å begrense søket til en bestemt fullmakt innenfor et virkeområde (der det eksistere flere fullmaktdefinisjoner). |
Request eks:
{
"fullmaktshaverIdNrType": "FNR",
"fullmaktshaverIdNr":"12048645510",
"fullmaktVirkeomrade": "apotekogbandagist"
}
Responsparametre
Navn | Type | Lovlige verddier | Kommentar |
---|---|---|---|
fullmaktshaverIdNrType | string | Volven kodeverk 8116. Lovlige verdier: “FNR” (Fødselsnummer) “DNR” (D-nummer) | Innført for å skille på D-nummer og FNR som nasjonal NIN |
fullmaktshaverIdNr | string | fødselsnummer (11 siffer) | Dette er fødselsnummer eller D-nummer til den innbygger som har avgitt fullmakter (og som det ble spurt på). |
fullmaktVirkeomrade | string | Tokenverdier (kan utvides) | Angir fullmaktens virkeområde, dvs. hvor den kan benyttes “helsenorge” - Fullmakten kan kun benyttes for digitale helsetjenester på Helsenorge “helseogomsorg” - Fullmakten kan benyttes i hele Helse og Omsorgsektoren “apotekogbandagist” - Fullmakten kan benyttes på apotek og bandagister |
fullmaktsgiverFunnet | boolean | Denne vil alltid være med i retur. |
|
fullmaktDefinisjoner | array |
| Det vil være en liste med fullmathavere pr fullmaktdefinisjon innenfor det aktuelle virksomhetsområde. |
| string | Eksisterende fullmaktsdefinisjon i PVK | Fullmaktdefinisjonens unike ID |
| string | Eksisterende fullmaktsdefinisjon i PVK | Fullmaktdefinisjonenes beskrivende navn |
| array | JSON-struktur | En liste med fulmaktsgivere (som er avgitt fullmakter til fullmaktshaver. |
|
|
| "fullmaktReferanseId" benyttes i etterfølgende kall for å få detaljer om en fullmakt/fullmaktsbeviset. |
Respons eks:
FullmaktToken
Returnerer et digitalt verifiserbart fullmaktbevis.