API'ets formål

API’et må benyttes av brukersteder i Helse-og Omsorgsektoren der digitale fullmakter skal kunne benyttes. Fullmaktene registreres alltid av innbygger i Pertsonvernkomponenten (PVK) i Helsenorge. Brukersteder der man ønsker å benytte fullmaktene må ha integrasjon med API for dette i PTS (Personvern og Tilgangstyring).

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

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 innenfor et gitt virkeområde. Vanlig UseCase er at man kjenner pasientens FNR/DNR og vil vite hvem som har fått fullmakt av denne.
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. Vanlig UseCase er at man kjenner representants FNR/DNR og vil vite hvem denne kan representere.
FullmaktToken	POST <system url>/personvern/FullmaktToken/v1	Henter ut detaljer om et fullmaktsforhold. (Digitalt fullmaktsbevis). Benyttes etter at enten “Fullmaktshavere” eller “Fullmaktsgivere” er kalt, og man har valgt hvilket av de mulige representasjons forhold som eksisterer som skal benyttes.
FinnFullmaktToken	POST <system url>/personvern/FinnFullmaktToken/v1	Kan benyttes for å hente ut Digitalt fullmaktsbevis, dersom det eksisterer en fullmakt mellom angitt Fullmaktsgiver og Fullmaktshaver og der begges FNR/DNR er kjent. Alternativ metode til å benytte Fullmaktshaver/Fullmaktsgiver først og deretter FullmaktToken.

Metode Fullmaktshavere

Returnerer en liste over hvem som har fått fullmakt (fullmaktshaver) fra en bestemt person (fullmaktsgiver).

Input parametre

Navn	Type	Påkrevd/ Frivillig	Lovlige verdier	Kommentar

Navn	Type	Påkrevd/ Frivillig	Lovlige verdier	Kommentar
fullmaktsgiverIdNrType	string	Påkrevd	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	Påkrevd	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	Påkrevd	Tokenverdier (kan utvides)	Angir fullmaktens virkeområde, dvs. hvor den kan benyttes “apotekogbandasjist” - Fullmakten kan benyttes på apotek og bandasjister “helseogomsorg” - Fullmakten kan benyttes i hele Helse og Omsorgsektoren (for framtidig utvidelse)
fullmaktDefinisjonGuid	string	Frivillig	Eksisterende fullmaktsdefinisjon i PVK	Denne er opsjonell. Kan benyttes dersom man ønsker å begrense søket til en bestemt fullmakt innenfor et virkeområde (der det eksistere flere fullmaktdefinisjoner), og kun en av disse er interessant for det aktuelle brukersted.

Request eks 1:

{
  "fullmaktsgiverIdNrType": "FNR",
  "fullmaktsgiverIdNr": "27924199925",
  "fullmaktVirkeomrade": "apotekogbandasjist"
}

Request eks 2:

{
  "fullmaktsgiverIdNrType": "FNR",
  "fullmaktsgiverIdNr": "27924199925",
  "fullmaktVirkeomrade": "apotekogbandasjist",
  "fullmaktDefinisjonGuid": "826c0aa6-9e08-46de-a031-9b37dd91f4b9"
}

Responsparametre

Dersom det ikke finnes noen fullmaktshavere returneres “fullmaktshaverFunnet”: false (og lista er tom)

Navn	Type	Lovlige verddier	Kommentar

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 eller D-nummer (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 “apotekogbandasjist” - Fullmakten kan benyttes på apotek og bandasjister “helseogomsorg” - Fullmakten kan benyttes i hele Helse og Omsorgsektoren (for framtidig utvidelse)
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. (Bare en i lista dersom man inkluderte kun en definisjonsGuid i requesten)
fullmaktDefinisjonGuid	string	Eksisterende fullmaktsdefinisjon i PVK	Fullmaktdefinisjonens unike ID
fullmaktDefinisjonNavn	string	Eksisterende fullmaktsdefinisjon i PVK	Fullmaktdefinisjonenes beskrivende navn
fullmaktshavere	array	JSON-struktur	En liste med fulmakthaver (som er gitt av fullmaktgiver).
fornavn mellomnavn etternavn fodselsdato fullmaktReferanseId	string string string string string (GUID)		"fullmaktReferanseId" kan benyttes i etterfølgende kall (FullmaktToken) for å få detaljer om en fullmakt/fullmaktsbeviset dersom dette fullmaktsforholdet skal benyttes.

Respons eks:

{
  "fullmaktsgiverIdNrType": "fnr",
  "fullmaktsgiverIdNr": "27924199925",
  "fullmaktVirkeomrade": "apotekogbandasjist",
  "fullmaktshaverFunnet": true,
  "fullmaktDefinisjoner": [
    {
      "fullmaktDefinisjonGuid": "826c0aa6-9e08-46de-a031-9b37dd91f4b9",
      "fullmaktDefinisjonNavn": "Fullmakt til å hente reseptvarer",
      "fullmakthavere": [
        {
          "fornavn": "PRAGMATISK",
          "mellomnavn": null,
          "etternavn": "SEKK",
          "fodselsdato": "1976-12-12",
          "fullmaktReferanseId": "1c1f126e-b9af-4a5d-aa11-996ededf29c6"
        }
      ]
    }
  ]
}

Metode Fullmaktsgivere

Returnerer en liste over hvem som har gitt fullmakt (fullmaktsgivere) til en bestemt person (fullmaktshaver).

Input parametre

Navn	Type	Påkrevd/ Frivillig	Lovlige verdier	Kommentar

Navn	Type	Påkrevd/ Frivillig	Lovlige verdier	Kommentar
fullmaktshaverIdNrType	string	Påkrevd	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	Påkrevd	fødselsnummer eller D-nummer (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	Påkrevd	Tokenverdier (kan utvides)	Angir fullmaktens virkeområde, dvs. hvor den kan benyttes “apotekogbandasjist” - Fullmakten kan benyttes på apotek og bandasjister “helseogomsorg” - Fullmakten kan benyttes i hele Helse og Omsorgsektoren (for framtidig utvidelse)
fullmaktDefinisjonGuid	string	Frivillig	Eksisterende fullmaktsdefinisjon i PVK	Denne er opsjonell. Kan benyttes dersom man ønsker å begrense søket til en bestemt fullmakt innenfor et virkeområde (der det eksistere flere fullmaktdefinisjoner), og kun en av disse er interessant for brukerstedet.

Request eks 1:

{
  "fullmaktshaverIdNrType": "FNR",
  "fullmaktshaverIdNr": "12927698801",
  "fullmaktVirkeomrade": "apotekogbandasjist"
}

Request eks 2:

{
  "fullmaktshaverIdNrType": "FNR",
  "fullmaktshaverIdNr": "12927698801",
  "fullmaktVirkeomrade": "apotekogbandasjist",
  "fullmaktDefinisjonGuid": "826c0aa6-9e08-46de-a031-9b37dd91f4b9"
}

Responsparametre

Dersom det ikke finnes noen fullmaktsgivere returneres “fullmaktsgiverFunnet”: false (og lista er tom)

Navn	Type	Lovlige verddier	Kommentar

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 eller D-nummer (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 “apotekogbandasjist” - Fullmakten kan benyttes på apotek og bandasjister “helseogomsorg” - Fullmakten kan benyttes i hele Helse og Omsorgsektoren (for framtidig utvidelse)
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.
fullmaktDefinisjonGuid	string	Eksisterende fullmaktsdefinisjon i PVK	Fullmaktdefinisjonens unike ID
fullmaktDefinisjonNavn	string	Eksisterende fullmaktsdefinisjon i PVK	Fullmaktdefinisjonenes beskrivende navn
fullmaktsgivere	array	JSON-struktur	En liste med fulmaktsgivere (som er avgitt fullmakter til fullmaktshaver.
fornavn mellomnavn etternavn fodselsdato fullmaktReferanseId	string string string string string (GUID)		"fullmaktReferanseId" kan benyttes i etterfølgende kall (FullmaktToken) for å få detaljer om en fullmakt/fullmaktsbeviset dersom dette fullmaktsforholdet skal benyttes.

Respons eks:

{
  "fullmaktshaverIdNrType": "fnr",
  "fullmaktshaverIdNr": "12927698801",
  "fullmaktVirkeomrade": "apotekogbandasjist",
  "fullmaktsgiverFunnet": true,
  "fullmaktDefinisjoner": [
    {
      "fullmaktDefinisjonGuid": "826c0aa6-9e08-46de-a031-9b37dd91f4b9",
      "fullmaktDefinisjonNavn": "Fullmakt til å hente reseptvarer",
      "fullmaktgivere": [
        {
          "fornavn": "KVART",
          "mellomnavn": null,
          "etternavn": "REGLE",
          "fodselsdato": "1941-12-27",
          "fullmaktReferanseId": "1c1f126e-b9af-4a5d-aa11-996ededf29c6"
        }
      ]
    }
  ]
}

Metode FinnFullmaktToken

Kan benyttes for å sjekke om en bestemt fullmakt (angitt av dennes fullmaktDefinijsonGuid) finnes mellom en Fullmaktsgiver og en Fullmaktshaver, der begge disses identifikasjonsnummer er kjent. Returnerer det digitale fullmakt beviset direkte dersom en slik fullmakt eksistere, returnere HTTP 404 - Not found, dersom ingen slik fullmakt eksisterer.

Input parametere

Navn	Type	Lovlige verdier	Kommentar

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 (11 siffer)	Dette er fødselsnummer eller D-nummer til den innbygger som det skal kontrolleres om har gitt den aktuelle fullmakt.
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 det skal kontrolleres om har aktuell fullmakt.
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 “apotekogbandasjist” - Fullmakten kan benyttes på apotek og bandagister
fullmaktDefinisjonGuid	string	Eksisterende fullmaktsdefinisjon i PVK	Denne må angis, og være kjent, i det systemet som spør om den aktuelle fullmakt type eksisterer.

Request eks:

{
  "fullmaktsgiverIdNrType": "fnr",
  "fullmaktsgiverIdNr": "27924199925",
  "fullmaktshaverIdNrType": "fnr",
  "fullmaktshaverIdNr": "12927698801",
  "fullmaktVirkeomrade": "apotekogbandasjist",
  "fullmaktDefinisjonGuid": "826c0aa6-9e08-46de-a031-9b37dd91f4b9"
}

Respons

Hvis fullmakt eksisterer

{
   "jwt": "<token>"
}

Se under om FullmaktToken for beskrivelse av det digitale fullmaktbeviset.

Hvis fullmakten ikke eksisterer: HTTP 404 - Not found
Hvis input er feil format, f.eks. at fullmaktsgiverIdNrType eller fullmaktVirkeomrade har ikke kjent/lovlig verdi: HTTP 400 - Bad request

Metode FullmaktToken

Benyttes for å hente ut fullmaktsbevis etter at man har funnet ønsket representasjons forhold gjennom kall til enten Fullmaktshavere eller Fullmktsgivere. Returnerer et digitalt verifiserbart fullmaktsbevis.

Input parametre

Navn	Type	Lovlige verdier	Kommentar

Navn	Type	Lovlige verdier	Kommentar
fullmaktReferanseId	Guid	Referanse mottatt i tidligere respons fra enten FullmaktHavere eller FullmaktGivere.	Denne er en unik referanse til et bestemt fullmaktsforhold

Request eks:

{
  "fullmaktReferanseId":"1c1f126e-b9af-4a5d-aa11-996ededf29c6"
}

Responsparametre

Dersom fullmaktsreferanseId ikke finnes, returneres HTTP 404 (Not found)

Responsen er et JWT signert av Helsenorge personverntjenester.

Respons eks:

{
   "jwt": "<token>"
}

Format på FullmaktToken

encodeBase64(json-header) + '.' + encodeBase64(json-payload) + '.' + encodeBase64(signature)

encodeBase64(json-header) + '.' + encodeBase64(json-payload) + '.' + encodeBase64(signature)

Header

Kort claimnavn	Fullt claimnavn	Beskrivelse

Kort claimnavn	Fullt claimnavn	Beskrivelse
alg	Algorithm	Hvilken algoritme som benyttes. Vil være "RS256" dvs. RSA-SHA256
kid	Key ID	Thumbprint av public sertifikat tilhørende privat nøkkel som ble benyttet til å generere token
typ	Type	Type token det er, vil alltid være "JWT"
x5c	X.509 certificate chain	Public X.509 sertifikat tilhørende den private nøkkelen som ble benyttet for å signerer tokenet (se https://tools.ietf.org/html/rfc7515 )

Eks:

{
  "alg": "RS256",
  "kid": "63DD934E30BDB20FEAF729540FD14CB53A7F4FC1",
  "typ": "JWT",
  "x5c": [
    "MIIGVjCCBD6gAwIBAgILAZx1kFcVLeaZUOkwDQYJKoZIhvcNAQELBQAwbjELMAkGA1UEBhMCTk8xGDAWBgNVBGEMD05UUk5PLTk4MzE2MzMyNzETMBEGA1UECgwKQnV5cGFzcyBBUzEwMC4GA1UEAwwnQnV5cGFzcyBDbGFzcyAzIFRlc3Q0IENBIEcyIFNUIEJ1c2luZXNzMB4XDTIzMTExMDEwNTQ0MVoXDTI2MTExMDIyNTkwMFowejELMAkGA1UEBhMCTk8xGzAZBgNVBAoMEk5PUlNLIEhFTFNFTkVUVCBTRjEWMBQGA1UECwwNSEVMU0VOT1JHRS5OTzEcMBoGA1UEAwwTUEVSU09OVkVSTlRKRU5FU1RFUjEYMBYGA1UEYQwPTlRSTk8tOTk0NTk4NzU5MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAlFlqENggn8k1rgbYKuIQPXYfJTgdnoDFWsnFIE8H+DNUjjm0pc1/tCNbLY+8y6ecKi/XYp/03c1HvD9YsvKzdO/H7wH6aFvaKtqnTNzEW6RhmoHrmnEAoyDxgzYgXF30/mJOYTIu6LU1mB6AdnHQdLLY2Soc6yQSK5B7nNMZbYHvkbknZcE6hoYTfvRx36vaoPTShfFShkujt55ZwUpLFLSjZ7zrYzsUDq/BBZDC7YXbqcdwwV2HEgwxaosOMi32RWFURUAwI6U447+MexUwP8GDIKKn+2dI8rA4REYMy4+UhrZ2+nI82iuxzx733QOr8Ifsr6xrnYI+c1jTFLy8KhucdIfE9m3DGld+LPf9mETdCeqMevluNL1iVLLV/yiSGHPvH6uqKRzNrL1Pck2WxGqq188DTC+ME5T+ZZwqJd25XduVoNZr74nGrpP5pz5tVfzLUw2rns2e6lDO0ofro2fYxoiObb49gDSGyqG8/cDTMOzwaZSZ7tH1VFWf1IcTAgMBAAGjggFnMIIBYzAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFKf+u2xZiK10LkZeemj50bu/z7aLMB0GA1UdDgQWBBRnqv8EDKS7zssUF7H0AzW92OtJGzAOBgNVHQ8BAf8EBAMCBkAwHwYDVR0gBBgwFjAKBghghEIBGgEDAjAIBgYEAI96AQEwQQYDVR0fBDowODA2oDSgMoYwaHR0cDovL2NybC50ZXN0NC5idXlwYXNzY2EuY29tL0JQQ2wzQ2FHMlNUQlMuY3JsMHsGCCsGAQUFBwEBBG8wbTAtBggrBgEFBQcwAYYhaHR0cDovL29jc3Bicy50ZXN0NC5idXlwYXNzY2EuY29tMDwGCCsGAQUFBzAChjBodHRwOi8vY3J0LnRlc3Q0LmJ1eXBhc3NjYS5jb20vQlBDbDNDYUcyU1RCUy5jZXIwJQYIKwYBBQUHAQMEGTAXMBUGCCsGAQUFBwsCMAkGBwQAi+xJAQIwDQYJKoZIhvcNAQELBQADggIBAGqcB2Ag0L394Z/ysQtmcuAnBA4ekGA9bG4B+ntcAWY00qz0ufDEdcFshVtjrs5+NZrkZWJQRt1GIgLVtLBWGW2ZqPqVzL2FKFM+v6j252Dd1Wx+ht03JfjM4GwAuUCdk83UQQKYTn6YU0TXPSDAtzTSiaMPIe7l/WsoN6GXUOZIBDI6PoV5JsoWY+Cvi0lQcJ+ZYoLngdxnq69wRCgrrwjGU3R9A5NCp+fAtsXWT6Vfi9e3rc5kiWqnCsFWl3lvE1TPugRfOUTHPbynpZn+FFPvefppcObMN0qmo/RqL9lCgg94PsCPLEfvyXNu1q08PIZ+iwDpv2Hbqj/LwqvEONdiTN4AF/C0g25fjMTVYzp3vHO1Zjn24f4OLfN4XG3HNskGcx9kwQsiR75ktLm1FshRGYqMat2FyXvNWscLHLLl21TfOP6qTtX3xUDRl5jQAc0tcPSctjU2JZfWMNCeNFwD9j4n/ACrZyT7gVYd5PzHZEeWzjz+YbRi9e+Uldro8LCSyygmpvKvy4ge3bfL9r3o2ZfgC/aojrOwBul1GLlXIvsf3qXxwzfAZNvBHMXwkso4BSeFxV8HRrW7c3lKu7bpkJoZpvVBW+LPsjWP4nUG/nHOpHOPutdpoxPGwsXXL/CTKwm7SEIj/eA1xIu4e4c3rxlZPfxEYQ6foMNf4xzK"
  ]
}

Payload

Kort claimnavn	Fullt navn for claim	Beskrivelse

Kort claimnavn	Fullt navn for claim	Beskrivelse
jti	JWT-ID	En unik iditifier (GUID) for dette fullmaktsbeviset. (Det kan utstedes mange fullmaktsbevis basert på samme fullmakt (som også har sin unike identifikator)
aud	Audience	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 “apotekogbandasjist” - Fullmakten kan benyttes på apotek og bandagister
fullmakt_definisjon_guid	Fullmakt definisjon ID	En unik ID for den aktuell fullmakt definisjon i PVK, f.eks. for Apotek-fullmakten.
fullmakt_definisjon_navn	Fullmakt definisjonens navn	Et beskrivende navn for den aktuelle fullmakt slik den er definert i PVK
pvk_ref	PVK reference	GUID i PVK som entydig identifiserer dette fullmaktsforholdet. (Samme GUID som i request, dersom man benytter metoden FullmaktToken).
type	Fullmakt type	“ordinar”- Ordinær fullmakt “tildelt” - Tildelt fullmakt (fullmaktsgiver er ikke samtykkekompetent)
sub	Subject	Fødselsnummer eller D-nummer til fullmaktgiver
sub_id_type	Type identifikator

Fullmaktinformasjon

API'ets formål

Tjenesteoversikt

Metode Fullmaktshavere

Input parametre

Responsparametre

Metode Fullmaktsgivere

Input parametre

Responsparametre

Metode FinnFullmaktToken

Input parametere

Respons

Metode FullmaktToken

Input parametre

Responsparametre

Format på FullmaktToken

Header

Payload