Fælles Medicinkort - Dokumentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== DDV Extension E2 =======

**OBS: Extension E2 er stadig i planlægningsfasen så tag nedenstående som et foreløbigt udkast. Det er ikke muligt at benytte Extension E2 endnu.**

Denne extension bygger på snitfladen 1.4.0 og viderefører ændringerne fra Extension E1. Extension E2 indeholder primært en ændring af håndteringen af frameldinger af notifikationer fra DDV.

I Extension E1 blev framelding til påmindelser introduceret med services til oprettelse, hentning og sletning af en samlet framelding. Extension E2 udvider denne model, så frameldinger kan angives pr. notifikationstype for en konkret kombination af borger og brevmodtager. Det betyder, at en brevmodtager kan være frameldt én type påmindelse, men fortsat modtage andre typer påmindelser. Forældre kan eksempelvis vælge at modtage påmindelsesbreve vedr. børnevaccinationer, men ikke invitationsbreve vedr. sæsonvaccination og andre vaccinationstilbud.

E2 introducerer derfor nye services til at sætte og hente den fulde liste af frameldte påmindelsestyper. De tidligere E1-services til enkeltvis oprettelse, opslag og sletning af notification-unsubscriptions udgår og erstattes af disse mere enkle services i E2.

Eksisterende ændringer fra Extension E1 for øvrige services videreføres uændret i E2-snitfladen.

I det følgende beskrives de enkelte ændringer og tilføjelser i E2 snitfladen.

==== Videreførte services fra E1 ====

Følgende services er uændrede i E2 i forhold til Extension E1 og videreføres med E1-kontrakten:

^ Service ^ Bemærkning ^
|[[fmk:ddv:1.4.0:deletesubscriptione1|DeleteSubscription]] | Videreføres uændret fra Extension E1. |
|[[fmk:ddv:1.4.0:getsubscriptionse1|GetUnsubscriptions]] | Videreføres uændret fra Extension E1. |
|[[fmk:ddv:1.4.0:CreateUnsubscriptionE1|CreateUnsubscription]] | Videreføres uændret fra Extension E1.|
|[[fmk:ddv:1.4.0:DeletePlannedVaccinationE1|DeletePlannedVaccination]] | Videreføres uændret fra Extension E1. |
|[[fmk:ddv:1.4.0:MultiUpdateVaccinationE1|MultiUpdateVaccination]] | Videreføres uændret fra Extension E1. |

==== Nye services ====

  * [[SetNotificationUnsubscriptions]]
  * [[GetNotificationUnsubscriptions]]

==== SetNotificationUnsubscriptions ====

Servicen anvendes til at sætte den komplette liste af frameldte påmindelsestyper for en given kombination af borger og brevmodtager.

Request angiver:

  * ''PersonCivilRegistrationIdentifier''
  * ''RecipientPersonIdentifier''
  * ''Created''
  * ''Reported'' (valgfri)
  * 0..n ''NotificationType''

Listen af ''NotificationType'' skal være unik i requestet. En tom liste betyder, at alle aktuelle frameldinger for den konkrete borger/brevmodtager-kombination ophæves.

Response returnerer den resulterende liste af frameldte påmindelsestyper for kombinationen af borger og brevmodtager. Listen er tom, hvis kaldet fjernede alle frameldinger.

==== GetNotificationUnsubscriptions ====

Servicen anvendes til opslag af aktuelle frameldinger til påmindelser.

Request kan angive:

  * kun PersonCivilRegistrationIdentifier
  * kun RecipientPersonIdentifier
  * både PersonCivilRegistrationIdentifier og RecipientPersonIdentifier

Response indeholder kun aktuelle frameldinger. Historik returneres ikke.

Hver NotificationUnsubscription i response indeholder:

  * PersonCivilRegistrationIdentifier
  * Created
  * Reported, valgfri
  * RecipientPersonIdentifier
  * en eller flere NotificationType

==== NotificationType ====

NotificationType angives som den SOAP-synlige danske tekstværdi.

De kendte værdier er:

  * ''Påmindelse om kommende børnevaccination''
  * ''Påmindelse om manglende børnevaccination''
  * ''Invitationsbrev om vaccinationstilbud''
  * ''Påmindelse om vaccinationstilbud''

Schemaet tillader også andre ikke-tomme tekstværdier til retur af værdier der introduceres senere for nye påmindelsestyper.

==== XSD-schemas og WSDL ====

{{ :fmk:ddv:extensions:schemas-e2.zip|XSD-schemaer for DDV 1.4.0.E2 }}

{{ fmk:ddv:extensions:vaccinationsservice_2013-12-01-e2.zip | WSDL for DDV 1.4.0.E2 DGWS snitflade}}

{{ fmk:ddv:extensions:vaccinationsserviceidws_2013-12-01-e2.zip | WSDL for DDV 1.4.0.E2 IDWS snitflade}}

Samt evt. de samlede snitflade-filer: [[fmk:ddv:ddv_wsdlfiler_og_schemaer|WSDL og XML skemaer]]