Replikering av fullmaktinformasjon gjennom abonnement (oppdatert 2024-08-22)

Denne funksjonaliteten er under spsifisering. Dvs. dokumentasjonen kan ikke benyttes som grunnlag for implementering enda.

Innledning

PVK inneholder fullmakter en innbygger gir til en annen. Dersom en aktør ønsker å få hendelser fra PVK om fullmakter som opprettes og slettes, er det mulig å abonnere på slike hendelser. Abonnementet vil være knyttet til de type fullmakter aktøren har rett til å abonnere på. Slev om en aktør abonnerer på slike hendelser, vil PVK alltid være master for fullmalktsinformasjon.

Grunnleggende om grensesnittet

Endepunkt hos aktør og Payload i request

Ekstern part må ha et API som implementerer dette endepunktet.

 

TjenesteNavn

HttpVerb

Beskrivelse

TjenesteNavn

HttpVerb

Beskrivelse

LagreFullmaktInformasjon

POST

Ekstern part må lagre/slette informasjon om en fullmakt.

LagreInnbyggersPersonvernInnstilling

Parametere i request

Navn

Type

Lovlige verdier

Kommentar

Navn

Type

Lovlige verdier

Kommentar

fullmaktDefinisjonGuid

string

GUID

GUID for den fullmaktdefinisjon det gjelder

fullmaktVirkeomrade

string

String (tokenverdier)

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

fullmaktType

string

String (tokenverdier)

“ordinar”- Ordinær fullmakt

“tildelt” - Tildelt fullmakt (fullmaktsgiver er ikke samtykkekompetent)

handling

int

Enum

1 - Fullmakt opprettet

2 - Fullmakt slettet

fullmaktReferanseId

String

GUID

En global unik referanse til fullmakten som nå er slettet eller opprettet.

opprettetTidspunkt (UTC)

string (ISO 8601 Date string)

Tidspunkt for når fullmakten ble opprettet

Vil alltid være satt, og verdien reflekterer tidspunkt når fullmakten ble opprettet

opprettetAvType

int

enum (kan utvides)

1- Innbygger selv (via Helsenorge)

2 - Representant for innbygger (via Helsenorge)

3 - Saksbehandler

sistEndretTidspunkt (UTC)

string (ISO 8601 Date string)

Tidspunkt for når fullmakten sist ble endret.

Vil være samme tidspunkt som opprettetTidspunkt dersom en fullmakt opprettes.

Vil være når fullmakten ble slettet, dersom en fullmakt slettes.

endretAvType

int

enum (kan utvides)

1- Innbygger selv (via Helsenorge)

2 - Representant for innbygger (via Helsenorge)

3 - Saksbehandler

fullmaktsgiverIdNr

string

fødselsnummer (11 siffer)

Dette er fødselsnummer eller D-nummer til den innbygger som det er gitt fillmakt for til en annen

fullmaktgiverIdType

string

Angir om nummeret er D-nummer eller Fødselsnummer

Volven kodeverk 8116. Lovlige verdier:

“FNR” (Fødselsnummer)

“DNR” (D-nummer)

fullmaktshaverIdNr

string

fødselsnummer (11 siffer)

Dette er fødselsnummer eller D-nummer til den innbygger som har fått fullmakt for en annen

fullmakthaverIdType

string

Angir om nummeret er D-nummer eller Fødselsnummer

Volven kodeverk 8116. Lovlige verdier:

“FNR” (Fødselsnummer)

“DNR” (D-nummer)

gyldigFraTidspunkt (UTC)

string (ISO 8601 Date string)

Kan ikke være en dato tidligere enn den dato fullmakten ble opprettet.

Er alltid satt. Fullmakten er gyldig fra og med starten av denne dato. (Verdien har “00” i angivelsen av timer, minutter og sekunder.)

gyldigTilTidspunkt (UTC)

string (ISO 8601 Date string)

Må være senere enn da fullmakten gjelder fra

Vil være “null” dersom det ikke er satt noen tidsbegrensning for fullmaktens varighet. Hvis satt er fullmakten gyldig til og med denne dato. (Hvis satt, har verdien tidsangivelsen “23:59:59” i angivelsen av timer, minutter og sekunder.)

fullmaktOmfang

  • omfangKode

liste

string

 

Verdier som er definert på definisjonen

Liste med “omfangkoder” som er definert for den aktuelle Fullmaktdefinisjon. Må være kjent der fullmakten skal anvendes., dvs. på brukerstedene. Dersom en fullmakt har et fast omfang, og dermed en fast omfangkode, kan brukerstedet forholde seg kun til fullmaktens definisjonsGuid.

fullmaktFritekstInstruksjoner

string

Uformattert tekst. Max 2048 tegn

ER kun med dersom fullmakten tillater slike fritekstfelt og fullmaktsgiver har fylt inn noe i dette feltet.

Eksempel - ny fullmakt opprettet

{ "fullmaktDefinisjonGuid":"3FE2A80A-4200-42E2-817B-DA8A6236708A", "fullmaktVirkeomrade": "apotekogbandagist", "fullmaktType":"ordinar", "handling":1, "opprettetTidspunkt":"2024-01-16T11:09:38.4871148Z", "opprettetAvTypeId": 1, "sistEndretTidspunkt":"2024-01-16T11:09:38.4871148Z", "endretAvTypeId": 1, "fullmaktsgiverIdNr":"12045645510", "fullmaktgiverIdType": "FNR", "fullmaktshaverIdNr": "27018745510", "fullmakthaverIdType": "FNR", "gyldigFraTidpunkt": "2024-01-16:T00:00:00Z", "gyldigTilTidspunkt": "2027-01-15:T23:59:59Z", "fullmaktOmfang": [ { "omfangKode": "journalinfo" }, { "omfangKode": "utleveringresepter" } ], "fullmaktFritekstInstruksjoner": "Får kun hente ut for 3 måneders forbruk av gangen" }

Responsparametre (som ekstern part skal sette):

OK, replikering mottatt:

  • HTTP responskode: 200

og

  • Body: “returkode”: “ok”

Replikering ikke ok

Enten:

  • HTTP responskode 200

og

  • Body:

    • “returkode”: “ikkeOk”

    • “feilkode”: “Forklaring på hvorfor feil”

Eller:

  • HTTP responskode: Annet enn 200