Indledning
Denne side skitserer de forventede snitflader (metoder) som udstilles på den kommende NSP ddtv-services. De endelige snitfladebeskrivelser vil blive offentliggjort sammen med 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' | 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.
DentistID Element
Element | Beskrivelse | Type | Obligatorisk |
|---|---|---|---|
id | Angiver tandlægeklinikkens ID i den valgte klassifikation. | string | Ja, og må ikke være None/Null. |
classification | Typen af ID. Gyldige værder er: 'SOR' | 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, og må ikke være None/Null. |
type | 0: Anmodning om optagelse 1: Påmindelse 2: Ignorer tidligere henvendelser | int | Ja, og må ikke være None/Null. |
ddtvStatus Element
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 | Betinget. Hvis exists=true, så er den obligatorisk og må ikke være None/Null. |
dentistMayBeContacted | Den valgte tandlæge må kontaktes af DDTV | bool | Betinget. Hvis exists=true, så er den obligatorisk og må ikke være None/Null. |
reminderList | Borgeren er blevet påmindet om at vælge tandlæge | Liste af ddtvReminder elementer | Betinget. Hvis exists=true, så er den obligatorisk. 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 | Betinget. Hvis exists=true, så er den obligatorisk. 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 | Betinget. Hvis exists=true, så er den obligatorisk og må ikke være None/Null. |
OptOut | Borgeren ønsker ikke at bruge ddtv | bool | Betinget. Hvis exists=true, så er den obligatorisk og må ikke være None/Null. |
Operationer / Funktioner
ddtvCheckStatus(...)
Returnerer statusinformation for en borgers tandlægevalg.
Input:
| Element/Parameter | Type | Beskrivelse | evt. note |
|---|---|---|---|
| personID | PersonID | CPR 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. 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:
| Element | Type | Beskrivelse | evt. note |
|---|---|---|---|
| status | ddtvStatus | Status for Borgerens ddtv forløb |
ddtvApplyForNewDentist(...)
Registrerer et tandlægevalg. Hvis borgeren allerede har en registreret tandlæge overskrives denne. Der gemmes historik i databasen.
Input:
| Element/Parameter | Type | Beskrivelse | evt. note |
|---|---|---|---|
| personID | PersonID | ID 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. 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. |
| dentistID | DentistID | ID 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:
| Element | Type | Beskrivelse | evt. note |
|---|---|---|---|
| status | ddtvStatus | Status 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} |
ddtvDisregardApplicationForNewDentist(...)
Registrerer at borgeren fortryder tandlægevalg. Der gemmes historik i databasen.
Input:
| Element/Parameter | Type | Beskrivelse | evt. note |
|---|---|---|---|
| personID | PersonID | ID 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. 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:
| Element | Type | Beskrivelse | evt. note |
|---|---|---|---|
| status | ddtvStatus | Status for Borgerens ddtv forløb | status: {exists = true, dentistChosen = None dentistMayBeContacted = false reminderList = None eller [] dentistContactedList = None eller [] noMoreReminders = false optOut = false} |
ddtvOptOut(...)
Registrerer at borgeren ikke ønsker at indgå i tandlægevalg løsningen. Der gemmes historik i databasen.
Input:
| Element/Parameter | Type | Beskrivelse | evt. note |
|---|---|---|---|
| personID | PersonID | ID 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. 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:
| Element | Type | Beskrivelse | evt. note |
|---|---|---|---|
| status | ddtvStatus | Status for Borgerens ddtv forløb | status: {exists = true, dentistChosen = None dentistMayBeContacted = false reminderList = None eller [] dentistContactedList = None eller [] noMoreReminders = false optOut = true} |
ddtvNoMoreReminders(...)
Registrerer at borgeren stadig ønsker at benytte løsningen, men ikke ønsker (flere) reminders.
Input:
| Element/Parameter | Type | Beskrivelse | evt. note |
|---|---|---|---|
| personID | PersonID | ID 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. 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:
| Element | Type | Beskrivelse | evt. note |
|---|---|---|---|
| status | ddtvStatus | Status 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} |
ddtvNewDentistFullStop(...)
Registrerer at borgeren stadig ønsker at benytte løsningen, men ikke ønsker (flere) reminders.
Input:
| Element/Parameter | Type | Beskrivelse | evt. note |
|---|---|---|---|
| personID | PersonID | ID 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. 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. |
| dentistID | DentistID | ID 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:
| Element | Type | Beskrivelse | evt. note |
|---|---|---|---|
| status | ddtvStatus | Status for Borgerens ddtv forløb | status: {exists = true, dentistChosen = dentistID dentistMayBeContacted = false reminderList = None eller [] dentistContactedList = None eller [] noMoreReminders = true optOut = false} |