Versions Compared

Old Version 10

changes.mady.by.user Jan Riis

Saved on

compared with

New Version Current

changes.mady.by.user Jan Riis

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Indledning

Denne side skitserer de forventede snitflader (metoder) som udstilles på den kommende NSP ddtv-serviceservices. Den De endelige snitfladebeskrivelse snitfladebeskrivelser vil blive offentliggjort sammen med servicen at services bliver tilgængelige på NSP Test-miljøerne som en del af leverancebeskrivelsen hørende til servicen.

Siden indledes med at definere nogle datatyper, som bruges af flere metoder nedenfor.

Fælles datatyper

PersonID Element

Element

Beskrivelse

Type

Obligatorisk

id

Angiver borgerens ID (CPR-nummer uden bindestreg).

string

Ja

classification

Typen af ID. Gyldige værder er (CPR): 'CPROID:1.2.208.176.1.2'

string

Ja

Bemærk, person-id'et er type-klassificeret, så der i fremtiden kan understøttes flere person-id typer, f.eks. eCPR, EU person id, etc.

Læs mere om klassifikationer og OID'er her: FSK - Guide til anvendere.

DentistID Element

Element

Beskrivelse

Type

Obligatorisk

id

Angiver tandlægeklinikkens ID i den valgte klassifikationet ID hørende til tandlægeklinikken.

string

Ja, og må ikke være None/Null.

classification

Typen af ID. Gyldige værder er: 'SOR:

  • For SOR ID'er: 'OID:1.2.208.176.1.1'
  • For Lokationsnumre: 'urn:oasis:names:tc:ebcore:partyid-type:iso6523:0088'

string

Ja, og må ikke være None/Null.

Bemærk, id'et er type-klassificeret, så der i fremtiden kan understøttes flere id typer.

ddtvDentistContact Element

...

Element

...

Beskrivelse

...

Type

...

Obligatorisk

...

time

...

Tidspunkt for afsendelse af besked

...

DateTime

...

Ja

...

type

...

0: Anmodning om optagelse

1: Påmindelse

2: Ignorer tidligere henvendelser

...

int

...

Læs mere om klassifikationer og OID'er her: FSK - Guide til anvendere.

ddtvStatus Element

Ja, og

Element

Beskrivelse

Type

Obligatorisk

exists

Borgeren findes i databasen.

bool

Ja, og må ikke være None/Null.

dentistChosen

Borgeren har valgt tandlæge.

Sættes til 'None', hvis borgeren ikke har valgt tandlæge.

DentistID / None

createdTime

Tidspunktet elementet blev dannet i databasen.

DateTime

Betinget. Hvis exists=true, så er den obligatorisk og må ikke være None/Null.

chosenDentist

Den valgte tandlæge.

DentistID

Betinget. Hvis exists=true, så er elementet obligatorisk. Kan være None/Null hvis borgeren endnu ikke har valgt tandlæge.

dentistChoiceStatus

'noDentist': Borgeren har ikke (valgt) en tandlæge

'dentistChosen': Borgeren har valgt en tandlæge, men tandlægen er ikke blevet kontaktet.

'dentistContacted': Borgeren har valgt og tandlægen er kontaktet. Tandlægen har endnu ikke svaret.

'dentistAccepted': Tandlægen har accepteret og borgeren vil blive kontaktet mhp. kontrol.

'dentistRejected': Tandlægen kan eller ønsker ikke at optage borgeren i sin praksis.

'timedOut': Tandlægen svarede ikke på henvendelsen inden for svarfristen.

'communicationFailure': Der kunne ikke sendes besked til tandlægen.

String / None

Betinget. Hvis exists=true, så er den obligatorisk og 

må ikke være None/Null.

Invariant: Hvis dentistChoiceStatus != noDentist så er chosenDentist != null

dentistMayBeContacted

Den valgte tandlæge må kontaktes af DDTV.

bool

Ja, og må ikke

Betinget. Hvis exists=true, så er den obligatorisk og må ikke være None/Null.

reminderList

Borgeren

Liste med tidspunkter, hvor borgeren er blevet påmindet om at vælge tandlæge.

Liste af

ddtvReminder

DateTime elementer

([DateTime])

Betinget. Hvis exists=true, så er den obligatorisk

Ja

. Skal være tom liste ([ ]), hvis der endnu ikke er sendt påmindelse. Må ikke være None/Null.

dentistContactedList

Tidspunkter og typer af beskeder til den valgte tandlæge

Liste af ddtvDentistContact elementer

Ja, men skal være liste ([ ]), hvis tandlægen endnu ikke er blevet kontaktet. Må ikke være None/Null.

noMoreReminders

Borgeren ønsker ikke flere påmindelser

,eller maksimalt antal reminders afsendt

.

bool

Ja, og må ikke

Betinget. Hvis exists=true, så er den obligatorisk og må ikke være None/Null.

OptOut

Borgeren ønsker ikke at bruge ddtv

bool

Ja, og må ikke være None/Null.

...

dpStatus

Status på afsendelse af digital post til borgeren

String

Betinget. Hvis exists=true, så er den obligatorisk og må ikke være None/Null.

Værdier:

  • 'NoMessageToCitizen': Der sendes ikke besked på denne status
  • 'Ready': Der vil blive sendt en besked ved næste jobkørsel
  • 'Sent:YYYYMMDD': Besked blev sendt på den angivne dato.

citizenPhoneNr

Telefonnummer til kontakt til borgeren.

String

Nej

Operationer / Funktioner

ddtvCheckStatus(...)

Returnerer statusinformation for en borgers tandlægevalg.

...

Element/ParameterTypeBeskrivelseevt. note
personIDPersonIDCPR nummer på den der ønskes status for

I normaltilfældet vil personID være lig ID'et i IDWS Identititokenet, hvor der efterspørges status for personen selv.

Hvis den kaldende person gør brug af fuldmagt eller forældremyndighed, vil personID være på hhv. fuldmagtsgiver eller barnet.
I disse tilfælde skal hhv. OIO-BPP eller OIO-SRP elementet i headeren inspiceres for at kontrollere om der reelt er fuldmagt / forældremyndighed. Hvis ikke, skal der returneres en fejl.

Elementet er type-klassificeret, så der på sigt kan understøttes andre person-id typer (se datatypebeskrivelsen ovenfor)

Alle CPR numre skal alle checkes gennem CPR enkeltopslagsservice på NSP. Hvis CPR-nummeret ikke findes eller peger på en død person, skal der returneres en fejl.

Output:

ElementTypeBeskrivelseevt. note
status[ddtvStatusStatus for Borgerens ddtv forløb]Liste med ddtvStatus elementer der overordnet viser forløbet i valg af tandlæge over tid.

Der returneres en liste af ddtvStatus-elementer i omvendt kronologisk rækkefølge (nyeste først).

Elementerne svarer 1-1  til kæden af 'DentistChoices' i databasen. Se 5. Udkast til ER-model.

ddtvApplyForNewDentist(...)

Registrerer et tandlægevalg. Hvis borgeren allerede har valgt en registreret tandlæge overskrives denne. Der gemmes historik i databasentandlæge (status ikke lig med 'noDetist'}, oprettes en ny entry i databasen, og status sættes til 'dentistChosen'. Bemærk: requestID og dpStatus skal sættes til 'Null' i det nye element.

Input:

Element/ParameterTypeBeskrivelseevt. note
personIDPersonIDID på borgeren (CPR)

I normaltilfældet vil personID være lig ID'et i IDWS Identititokenet, hvor der efterspørges status for personen selv.

Hvis den kaldende person gør brug af fuldmagt eller forældremyndighed, vil personID være på hhv. fuldmagtsgiver eller barnet.
I disse tilfælde skal hhv. OIO-BPP eller OIO-SRP elementet i headeren inspiceres for om der reelt er fuldmagt / forældremyndighed.

Elementet er type-klassificeret, så der på sigt kan understøttes andre person-id typer (se datatypebeskrivelsen ovenfor).

Alle CPR numre skal alle checkes gennem CPR enkeltopslagsservice på NSP. Hvis CPR-nummeret ikke findes eller peger på en død person, skal der returneres en fejl.

dentistIDDentistIDID på tandlægeklinikken (SOR)

SOR-id'et skal kontrolleres for eksistens og gyldighed gennem SOR enkeltopslagsservice på NSP. Findes ID'et ikke, eller peger ID'et på en ikke-aktiv enhed, skal der returneres en fejl.

dentistLocationnumberDentistIDLokationsnummer til klinikken (Lokationsnummer til EDI forsendelse)

Lokationsnummeret hørende til SOR-enheden (dentistID). Mandatory i DDTV version 1.0 (2025) men vil senere udgå eller blive valgfri.

citizenPhoneNrStringBorgerens telefonnummer.

Kan angives i brugergrænsefladen på "Din Digitale Tandlægevælger" på Sundhed.dk. Feltet er ikke obligatorisk.

Output:

ElementTypeBeskrivelseevt. note
statusddtvStatusStatus for Borgerens ddtv forløb

status: {exists = true,

dentistChosen = dentistID

dentistMayBeContacted = true (med mindre andet er valgt)

reminderList = None eller []

dentistContactedList = None eller [] (lagt på kø)

noMoreReminders = false

optOut = false}

boolOK / Fail

Hvis 'Fail' returneres en beskrivelse af årsagen til at operationen fejlede.

ddtvDisregardApplicationForNewDentist(...)

Registrerer at borgeren fortryder tandlægevalg. Der gemmes historik i databasen.

...

Element/ParameterTypeBeskrivelseevt. note
personIDPersonIDID på borgeren (CPR)

I normaltilfældet vil personID være lig ID'et i IDWS Identititokenet, hvor der efterspørges status for personen selv.

Hvis den kaldende person gør brug af fuldmagt eller forældremyndighed, vil personID være på hhv. fuldmagtsgiver eller barnet.
I disse tilfælde skal hhv. OIO-BPP eller OIO-SRP elementet i headeren inspiceres for om der reelt er fuldmagt / forældremyndighed.

Elementet er type-klassificeret, så der på sigt kan understøttes andre person-id typer (se datatypebeskrivelsen ovenfor).

Alle CPR numre skal alle checkes gennem CPR enkeltopslagsservice på NSP. Hvis CPR-nummeret ikke findes eller peger på en død person, skal der returneres en fejl.

Output:

ElementTypeBeskrivelseevt. note
statusddtvStatusStatus for Borgerens ddtv forløb

status: {exists = true,

dentistChosen = None

dentistMayBeContacted = false

reminderList = None eller []

dentistContactedList = None eller []

noMoreReminders = false

optOut = false}

boolOK / Fail

Hvis 'Fail' returneres en beskrivelse af årsagen til at operationen fejlede.

ddtvOptOut(...)

Registrerer at borgeren ikke ønsker at indgå i tandlægevalg løsningen. Der gemmes historik i Alle data om borgeren slettes fra databasen.

Input:

Element/ParameterTypeBeskrivelseevt. note
personIDPersonIDID på borgeren (CPR)

I normaltilfældet vil personID være lig ID'et i IDWS Identititokenet, hvor der efterspørges status for personen selv.

Hvis den kaldende person gør brug af fuldmagt eller forældremyndighed, vil personID være på hhv. fuldmagtsgiver eller barnet.
I disse tilfælde skal hhv. OIO-BPP eller OIO-SRP elementet i headeren inspiceres for om der reelt er foreligger en fuldmagt / forældremyndighed.

Elementet er type-klassificeret, så der på sigt kan understøttes andre person-id typer (se datatypebeskrivelsen ovenfor).

Alle CPR numre skal alle checkes gennem CPR enkeltopslagsservice på NSP. Hvis CPR-nummeret ikke findes eller peger på en død person, skal der returneres en fejl.

Output:

ElementTypeBeskrivelseevt. note
statusddtvStatusStatus for Borgerens ddtv forløb

status: {exists = true,

dentistChosen = None

dentistMayBeContacted = false

reminderList = None eller []

dentistContactedList = None eller []

noMoreReminders = false

optOut = true}

boolOK / Fail

Hvis 'Fail' returneres en beskrivelse af årsagen til at operationen fejlede.

ddtvNoMoreReminders(...)

Registrerer at borgeren stadig ønsker at benytte løsningen, men ikke ønsker (flere) reminders.

...

Element/ParameterTypeBeskrivelseevt. note
personIDPersonIDID på borgeren (CPR)

I normaltilfældet vil personID være lig ID'et i IDWS Identititokenet, hvor der efterspørges status for personen selv.

Hvis den kaldende person gør brug af fuldmagt eller forældremyndighed, vil personID være på hhv. fuldmagtsgiver eller barnet.
I disse tilfælde skal hhv. OIO-BPP eller OIO-SRP elementet i headeren inspiceres for om der reelt er fuldmagt / forældremyndighed.

Elementet er type-klassificeret, så der på sigt kan understøttes andre person-id typer (se datatypebeskrivelsen ovenfor).

Alle CPR numre skal alle checkes gennem CPR enkeltopslagsservice på NSP. Hvis CPR-nummeret ikke findes eller peger på en død person, skal der returneres en fejl.

Output:

ElementTypeBeskrivelseevt. note
statusddtvStatusStatus for Borgerens ddtv forløb

status: {exists = true,

dentistChosen = (som i databasen nu)

dentistMayBeContacted = (som i databasen nu)

reminderList = (som i databasen nu)

dentistContactedList = (som i databasen nu)

noMoreReminders = true

optOut = true}

boolOK / Fail

Hvis 'Fail' returneres en beskrivelse af årsagen til at operationen fejlede.

ddtvNewDentistFullStop(...)

Registrerer at borgeren stadig ønsker at benytte løsningen, men ikke ønsker (flere) remindersikke at tandlægen skal kontaktes. 'status' sættes til 3 ('dentistAccepted').

Input:

Element/ParameterTypeBeskrivelseevt. note
personIDPersonIDID på borgeren (CPR)

I normaltilfældet vil personID være lig ID'et i IDWS Identititokenet, hvor der efterspørges status for personen selv.

Hvis den kaldende person gør brug af fuldmagt eller forældremyndighed, vil personID være på hhv. fuldmagtsgiver eller barnet.
I disse tilfælde skal hhv. OIO-BPP eller OIO-SRP elementet i headeren inspiceres for om der reelt er fuldmagt / forældremyndighed.

Elementet er type-klassificeret, så der på sigt kan understøttes andre person-id typer (se datatypebeskrivelsen ovenfor).

Alle CPR numre skal alle checkes gennem CPR enkeltopslagsservice på NSP. Hvis CPR-nummeret ikke findes eller peger på en død person, skal der returneres en fejl.

dentistIDDentistIDID på tandlægeklinikken (SOR)

SOR-id'et skal kontrolleres for eksistens og gyldighed gennem SOR enkeltopslagsservice på NSP. Findes ID'et ikke, eller peger ID'et på en ikke-aktiv enhed, skal der returneres en fejl.

Output:

ElementTypeBeskrivelseevt. note
statusddtvStatusStatus for Borgerens ddtv forløbboolOK / Fail

Hvis 'Fail' returneres en beskrivelse af årsagen til at operationen fejlede.

status: {exists = true,

dentistChosen = dentistID

dentistMayBeContacted = false

reminderList = None eller []

dentistContactedList = None eller []

noMoreReminders = true

optOut = false}