Versions Compared

Old Version 24

changes.mady.by.user Mads Haargaard

Saved on

compared with

New Version Current

changes.mady.by.user Mads Haargaard

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Navitabs
rootSamtykkeservicen - Leverancebeskrivelse
includeroottrue


Table of Contents

Introduktion

Formål

This document describes the usage of the web services that are made available by consent services, which consists of two independent services: consent administration and consent verification.

The document provides an introduction to the general Web service interface for both services, in addition to examples on how they can be used in a specific user system.

Where the services overlap, common functionality is only described once.

Læsevejledning

This document is directed towards developers and architects that will be using consent service on NSP. It is assumed that the reader is familiar with Web services and the additional components on the NSP such as STS, in addition to knowing about Den Gode Web service Dette dokument henvender sig til udviklere og arkitekter, der vil anvende samtykkeservice på NSP. Det antages, at læseren er fortrolig med webservices og de yderligere komponenter på NSP såsom STS, udover at have kendskab til Den Gode Webservice (DGWS).

Dokument historik

VersionDatoAnsvarligBeskrivelse

1.0

29.06.2012

Systematic

Initial version

1.1

28.11.2014

Systematic

References to National Patient Index (NPI) removed

1.2

07.09.2016

Systematic

Description of additional conditions for data specific consent check (paragraph 2.2)

1.3

07.12.2016

Systematic

Consent services now support DCC – (paragraph 3.1.1 and 3.1.2)

Changed sts.endpoint to new endpoint in example properties file

1.4

13.06.2018

Systematic

Migrated to NSPOP SVN


22.10.2018KITDocument moved from Word to Confluence. Original document name was: PHB0035 Consent Services Users Guide.docx

12.11.2020KITOversættelse fra engelsk til dansk

17.12.2021KITTilføjet request/response eksempler for Minspærring Samtykkeservicen Administration

Definitioner og referencer

DefinitionBeksrivelse

NSI

National Sundheds IT

NSP

National Service Platform

SHAK

SygeHusAfdelingsKode

SOR

Sundhedsvæsnets Organisationsregister

STS

Security Token Service

ReferenceBeskrivelse

DGWS 1.0

Den Gode Webservice 1.0

DGWS 1.0.1

Den Gode Webservice 1.0.1

HSUID-header

HSUID - Guide til anvendere

MinSpærring - Verifikation Service Interface Beskrivelse

MinSpærring Samtykkeservicen - Verifikation Service Interface Beskrivelse


MinSpærring - Administration Service Interface Beskrivelse

MinSpærring - Administration Service Interface Description

Data Model

MinSpærring - Data Model

Interface Beskrivelse

Snitfladerne for de to services er beskrevet i detaljer i dokumenterne MinSpærring Samtykkeservicen - Verifikation Service Interface Beskrivelse og MinSpærring - Administration Service Interface Description.

I dette afsnit er kun de enkelte komponenter, der er nødvendige for at beskrive brugen af de to tjenester beskrevet.

Fælles

Security headerTo call consent services, a user system must obtain a certificate and an ID card of level 3, issued by STS, and add these to the security header.

For at kalde de to MinSpærring Samtykkeservicen services  skal der anvendes et niveau 3 ID-kort udstedt af STS'en.

...

Der findes en admin-snitflade (til MinSpærring Samtykkeservicen administrationsservices), som er tilgængelig for sundhedspersoner, der er autentificeret med et niveau 4 ID-kort og som besidder den nationale rolle 'urn:dk:healthcare:national-federation-role:code:41001:value:SundAssistR1'.

...

Hvis brugeren er en sundhedsfaglig person skal HSUID-headeren udfyldes med identifikation af den bruger, der udfører en given operation. Nogle af disse oplysninger genbruges muligvis i selve meddelelsen, og disse skal naturligvis være konsistente (jf. MinSpærring Samtykkeservicen - Verifikation Service Interface Beskrivelse og MinSpærring - Administration Service Interface Description). HSUID header skal ikke angives i admin-snitfladen og autentifikation og autorisation baserer sig udelukkende på oplysningerne i ID kortet.

Er det borgeren selv der ændre sine spærringer må HSUID-headeren gerne være tom (null) da de oplysninger der skal bruges fra headeren allerede findes i IDWS billetten.

...

Samtykkeservicen Verifikation

MinSpærring Samtykkeservicen Verifikation har to operationer til at verificere samtykke fra en sundhedsfaglig: ConsentForUserCheck og ConsentForDataCheck.

...

På et positivt svar antager brugersystemet, at brugeren har samtykke til at se sundhedsdata vedrørende den borger, som MinSpærring Samtykkeservicen databasen er ansvarlig for. Omvendt antages det på et negativt svar, at borgeren har oprettet en spærring vedrørende adgang til data.

...

Dette illustreres i de følgende eksempler. Figur 1 viser borger, der har et generelt samtykke, men som har givet en dataspecifikt spærring til organisationen "Org". Hvis organisations id'er fra alle fire organisationer sendes til MinSpærring Samtykkeservicen Verifikation viser diagrammet svaret hvor rød er spærring og grøn er samtykke.

...

Det er anvendersystemets ansvar at sikre, at de anvendte ID'er er unikke, så de kan skelnes på den returnerede liste. Tjenesten bruger ikke ID'erne til andet end returlisten.

...

Samtykkeservicen Administration

Opret- rediger- og sletoperationer accepterer alle samtykke/spærring-objekter som parametre. Indholdet af et objektet vises i MinSpærring - Datamodel afsnit 2.

...

Admin-snitfladen er til brug for sundhedsfaglige til hjælp for ikke digitale borgere. Sundhedsfaglige har i denne snitflade adgang til alle administrative services: Opret, rediger, slet og hent.

Notificeringer i NAS 
Anchor
NAS_Frabedelse
NAS_Frabedelse

For alle ændringer af en borgers spærringer (oprettelse, opdateringer og sletninger), sker der en notificering via NAS få sekunder efter ændringen er gemt. Se evt. NAS 2.0 Anvenderguide.

...

Topic der anvendes: http://sundhedsdatastyrelsen.dk/ConsentAdministration/2021/03/01:ConsentUpdated

Eksempler

I dette afsnit gives eksempler på, hvordan man kan bruge et Java-baseret systemet til at kalde de to services.

...

Koden kan muligvis ikke være i stand til at kompilere eller køre i sin nuværende form, da den kun er beregnet som en guide til, hvordan man opretter et kald til tjenesten.

Eksempler på IDWS kald request og response

ConsentModifications

Code Block
languagexml
titleConsentModifyConstraint Request
linenumberstrue
collapsetrue
<?xml version='1.0' encoding='UTF-8'?> <soap:Envelope
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
    xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"
    xmlns:sbf="urn:liberty:sb"
    xmlns:sbfprofile="urn:liberty:sb:profile"
    xmlns:wsa="http://www.w3.org/2005/08/addressing"
    xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
    xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    <soap:Header
	  .. soap headers fjernet for overskueligehed...
	</soap:Header>
    <soap:Body
        xmlns:ns2="urn:dk:nsi:consentservices:types"
        xmlns:ns3="http://www.nsi.dk/hsuid/2016/08/hsuid-1.1.xsd"
        xmlns:ns4="http://sundhedsdatastyrelsen.dk/minspaerring/2020/11/04"
        wsu:Id="body">
        <ns4:ConsentModifyConstraint
            xmlns:ns4="http://sundhedsdatastyrelsen.dk/minspaerring/2020/11/04">
            <ConsentModifications
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ns2:consentId>
                    123498765532454
                    </ns2:consentId>
                <ns2:citizenCPR>
                    1110734334
                    </ns2:citizenCPR>
                <ns2:who>
                    <ns2:healthProfessionalCPR>
                        0307702555
                        </ns2:healthProfessionalCPR>
                    <ns2:includeSubOrganizations>
                        false
                        </ns2:includeSubOrganizations>
                    <ns2:foreignHealthProfessionals>
                        false
                        </ns2:foreignHealthProfessionals>
                    </ns2:who>
                <ns2:what
                    xsi:nil="true"/>
                <ns2:validFromDate>
                    2021-12-18T00:00:00.000+01:00
                    </ns2:validFromDate>
                <ns2:validToDate>
                    2021-12-07T00:00:00.000+01:00
                    </ns2:validToDate>
                </ConsentModifications>
            </ns4:ConsentModifyConstraint>
        </soap:Body>
    </soap:Envelope>
Code Block
languagexml
titleConsentModifyConstraint Response
linenumberstrue
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
    xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"
    xmlns:sbf="urn:liberty:sb"
    xmlns:sbfprofile="urn:liberty:sb:profile"
    xmlns:wsa="http://www.w3.org/2005/08/addressing"
    xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
    xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
    <soapenv:Header
       .. soap headers fjernet for overskueligehed...
	</soapenv:Header>
    <soap:Body
        wsu:Id="body">
        <ns4:ConsentModifyConstraintResponse
            xmlns:ns2="urn:dk:nsi:consentservices:types"
            xmlns:ns3="http://www.nsi.dk/hsuid/2016/08/hsuid-1.1.xsd"
            xmlns:ns4="http://sundhedsdatastyrelsen.dk/minspaerring/2020/11/04"/>
        </soap:Body>
    </soap:Envelope>

ConsentAddConstraint

Code Block
languagexml
titleConsentAddConstraint Request
linenumberstrue
collapsetrue
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
    xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"
    xmlns:sbf="urn:liberty:sb"
    xmlns:sbfprofile="urn:liberty:sb:profile"
    xmlns:wsa="http://www.w3.org/2005/08/addressing"
    xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
    xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
  <soap:Header
     .. soap headers fjernet for overskueligehed...
</soap:Header>
  <soap:Body
      xmlns:ns2="urn:dk:nsi:consentservices:types"
      xmlns:ns3="http://www.nsi.dk/hsuid/2016/08/hsuid-1.1.xsd"
      xmlns:ns4="http://sundhedsdatastyrelsen.dk/minspaerring/2020/11/04"
      wsu:Id="body">
    <ns4:ConsentAddConstraint
        xmlns:ns4="http://sundhedsdatastyrelsen.dk/minspaerring/2020/11/04">
      <ConsentAdds
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <ns2:citizenCPR>
          0804610417
        </ns2:citizenCPR>
        <ns2:who>
          <ns2:healthProfessionalCPR>
            0307702555
          </ns2:healthProfessionalCPR>
          <ns2:includeSubOrganizations>
            false
          </ns2:includeSubOrganizations>
          <ns2:foreignHealthProfessionals>
            false
          </ns2:foreignHealthProfessionals>
        </ns2:who>
        <ns2:what
            xsi:nil="true"/>
        <ns2:validFromDate>
          2021-12-17T07:35:51.906+01:00
        </ns2:validFromDate>
        <ns2:validToDate
            xsi:nil="true"/>
      </ConsentAdds>
    </ns4:ConsentAddConstraint>
  </soap:Body>
</soap:Envelope>
Code Block
languagexml
titleConsentAddConstraint Response
linenumberstrue
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
    xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"
    xmlns:sbf="urn:liberty:sb"
    xmlns:sbfprofile="urn:liberty:sb:profile"
    xmlns:wsa="http://www.w3.org/2005/08/addressing"
    xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
    xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
  <soapenv:Header
     .. soap headers fjernet for overskueligehed...
 </soapenv:Header>
  <soap:Body
      wsu:Id="body">
    <ns4:ConsentAddConstraintResponse
        xmlns:ns2="urn:dk:nsi:consentservices:types"
        xmlns:ns3="http://www.nsi.dk/hsuid/2016/08/hsuid-1.1.xsd"
        xmlns:ns4="http://sundhedsdatastyrelsen.dk/minspaerring/2020/11/04"/>
  </soap:Body>
</soap:Envelope>

ConsentAddPositive

Code Block
languagexml
titleConsentAddPositive Request
linenumberstrue
collapsetrue
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
    xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"
    xmlns:sbf="urn:liberty:sb"
    xmlns:sbfprofile="urn:liberty:sb:profile"
    xmlns:wsa="http://www.w3.org/2005/08/addressing"
    xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
    xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
  <soap:Header
     .. soap headers fjernet for overskueligehed...
</soap:Header>
  <soap:Body
      xmlns:ns2="urn:dk:nsi:consentservices:types"
      xmlns:ns3="http://www.nsi.dk/hsuid/2016/08/hsuid-1.1.xsd"
      xmlns:ns4="http://sundhedsdatastyrelsen.dk/minspaerring/2020/11/04"
      wsu:Id="body">
    <ns4:ConsentAddPositive
        xmlns:ns4="http://sundhedsdatastyrelsen.dk/minspaerring/2020/11/04">
      <ConsentAdds
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <ns2:citizenCPR>
          0804610417
        </ns2:citizenCPR>
        <ns2:who>
          <ns2:healthProfessionalCPR>
            0307702555
          </ns2:healthProfessionalCPR>
          <ns2:includeSubOrganizations>
            false
          </ns2:includeSubOrganizations>
          <ns2:foreignHealthProfessionals>
            false
          </ns2:foreignHealthProfessionals>
        </ns2:who>
        <ns2:what
            xsi:nil="true"/>
        <ns2:validFromDate>
          2021-12-17T07:35:52.133+01:00
        </ns2:validFromDate>
        <ns2:validToDate>
          2022-02-05T00:00:00.000+01:00
        </ns2:validToDate>
      </ConsentAdds>
    </ns4:ConsentAddPositive>
  </soap:Body>
</soap:Envelope>
Code Block
languagexml
titleConsentAddPositive Response
linenumberstrue
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
    xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"
    xmlns:sbf="urn:liberty:sb"
    xmlns:sbfprofile="urn:liberty:sb:profile"
    xmlns:wsa="http://www.w3.org/2005/08/addressing"
    xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
    xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
  <soapenv:Header
</soapenv:Header>
   .. soap headers fjernet for overskueligehed...
  <soap:Body
      wsu:Id="body">
    <ns4:ConsentAddPositiveResponse
        xmlns:ns2="urn:dk:nsi:consentservices:types"
        xmlns:ns3="http://www.nsi.dk/hsuid/2016/08/hsuid-1.1.xsd"
        xmlns:ns4="http://sundhedsdatastyrelsen.dk/minspaerring/2020/11/04"/>
  </soap:Body>
</soap:Envelope>

ConsentRevoke

Code Block
languagexml
titleConsentRevoke Request
linenumberstrue
collapsetrue
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
    xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"
    xmlns:sbf="urn:liberty:sb"
    xmlns:sbfprofile="urn:liberty:sb:profile"
    xmlns:wsa="http://www.w3.org/2005/08/addressing"
    xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
    xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
  <soap:Header
    .. soap headers fjernet for overskueligehed...
</soap:Header>
  <soap:Body
      xmlns:ns2="urn:dk:nsi:consentservices:types"
      xmlns:ns3="http://www.nsi.dk/hsuid/2016/08/hsuid-1.1.xsd"
      xmlns:ns4="http://sundhedsdatastyrelsen.dk/minspaerring/2020/11/04"
      wsu:Id="body">
    <ns4:ConsentRevoke
        xmlns:ns4="http://sundhedsdatastyrelsen.dk/minspaerring/2020/11/04">
      <ConsentRevocations>
        <ns2:consentId>
          123498765532463
        </ns2:consentId>
        <ns2:citizenCPR>
          1110734334
        </ns2:citizenCPR>
        <ns2:positiveConsent>
          false
        </ns2:positiveConsent>
        <ns2:who>
          <ns2:healthProfessionalCPR>
            0307702555
          </ns2:healthProfessionalCPR>
          <ns2:includeSubOrganizations>
            false
          </ns2:includeSubOrganizations>
          <ns2:foreignHealthProfessionals>
            false
          </ns2:foreignHealthProfessionals>
        </ns2:who>
        <ns2:validFromDate>
          2021-12-17T07:35:53.000+01:00
        </ns2:validFromDate>
      </ConsentRevocations>
    </ns4:ConsentRevoke>
  </soap:Body>
</soap:Envelope>
Code Block
languagexml
titleConsentRevoke Response
linenumberstrue
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
    xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"
    xmlns:sbf="urn:liberty:sb"
    xmlns:sbfprofile="urn:liberty:sb:profile"
    xmlns:wsa="http://www.w3.org/2005/08/addressing"
    xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
    xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
  <soapenv:Header
    .. soap headers fj ernet for overskueligehed...
</soapenv:Header>
  <soap:Body
      wsu:Id="body">
    <ns4:ConsentRevokeResponse
        xmlns:ns2="urn:dk:nsi:consentservices:types"
        xmlns:ns3="http://www.nsi.dk/hsuid/2016/08/hsuid-1.1.xsd"
        xmlns:ns4="http://sundhedsdatastyrelsen.dk/minspaerring/2020/11/04"/>
  </soap:Body>
</soap:Envelope>

ConsentRegistrationsGet

Code Block
languagexml
titleConsentRegistrationsGet Request
linenumberstrue
collapsetrue
<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
    xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"
    xmlns:sbf="urn:liberty:sb"
    xmlns:sbfprofile="urn:liberty:sb:profile"
    xmlns:wsa="http://www.w3.org/2005/08/addressing"
    xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
    xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
  <soap:Header
     .. soap headers fj ernet for overskueligehed...
</soap:Header>
  <soap:Body
      xmlns:ns2="urn:dk:nsi:consentservices:types"
      xmlns:ns3="http://www.nsi.dk/hsuid/2016/08/hsuid-1.1.xsd"
      xmlns:ns4="http://sundhedsdatastyrelsen.dk/minspaerring/2020/11/04"
      wsu:Id="body">
    <ns4:ConsentRegistrationsGet
        xmlns:ns4="http://sundhedsdatastyrelsen.dk/minspaerring/2020/11/04">
      <PatientPersonCivilRegistrationIdentifier>
        0701979346
      </PatientPersonCivilRegistrationIdentifier>
    </ns4:ConsentRegistrationsGet>
  </soap:Body>
</soap:Envelope>
Code Block
languagexml
titleConsentRegistrationsGet Response
linenumberstrue
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
    xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"
    xmlns:sbf="urn:liberty:sb"
    xmlns:sbfprofile="urn:liberty:sb:profile"
    xmlns:wsa="http://www.w3.org/2005/08/addressing"
    xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
    xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
  <soapenv:Header
     .. soap headers fj ernet for overskueligehed...
</soapenv:Header>
  <soap:Body
      wsu:Id="body">
    <ns4:ConsentRegistrationsGetResponse
        xmlns:ns2="urn:dk:nsi:consentservices:types"
        xmlns:ns3="http://www.nsi.dk/hsuid/2016/08/hsuid-1.1.xsd"
        xmlns:ns4="http://sundhedsdatastyrelsen.dk/minspaerring/2020/11/04">
      <ConsentRegistrations>
        <ns2:consentId>
          123498765532463
        </ns2:consentId>
        <ns2:citizenCPR>
          0701979346
        </ns2:citizenCPR>
        <ns2:positiveConsent>
          false
        </ns2:positiveConsent>
        <ns2:who>
          <ns2:healthProfessionalCPR>
            0307702555
          </ns2:healthProfessionalCPR>
          <ns2:includeSubOrganizations>
            false
          </ns2:includeSubOrganizations>
          <ns2:foreignHealthProfessionals>
            false
          </ns2:foreignHealthProfessionals>
        </ns2:who>
        <ns2:validFromDate>
          2021-12-17T07:35:53.000+01:00
        </ns2:validFromDate>
      </ConsentRegistrations>
    </ns4:ConsentRegistrationsGetResponse>
  </soap:Body>
</soap:Envelope>

Service Klienter

Der er udviklet en service klient til hver service. Klienterne kan findes som maven moduler.

...

Code Block
languagexml
<dependency> 
	<groupId>dk.nsi.consentservices.administration</groupId> 
	<artifactId>consent-administration-client</artifactId> 
	<version><desired client version></version>
</dependency>

Oprettelse af service client

Disse serviceklienter konfigureres ved hjælp af en property fil, og klienten sørger for at få et gyldigt STS-token, indsætte korrekte headers osv.

...

Koden nedenfor opretter en web service port til MinSpærring Samtykkeservicen Verifikation:

Code Block
Config config = new ClientConfig("VerificationClient").
     addRequiredKeys(ConsentVerificationService.CONFIG_KEY, ConsentVerificationService.CONFIG_ENDPOINT);
URL wsdl =
   new URL(config.getProperty(ConsentVerificationService.CONFIG_KEY));
String wsendpoint = config.getProperty(ConsentVerificationService.CONFIG_ENDPOINT);
ConsentVerificationServiceservice =
   new ConsentVerificationService (config, wsdl);
service.initialise();
ConsentVerification port = service.getConsentVerificationPort(wsendpoint);

...

Lignende kode skaber en klient til MinSpærring Samtykkeservicen Administration, klienten er bare klassen ConsentAdministrationService i stedet, og kaldet returnerer en web service port der er defineret i klassen ConsentAdministration.

Konfiguration

Den konfigurationsfil der gives til service klient skal definere en række properties som klienten anvender til at kommunikere med servicen.

...

Værdierne er taget fra integrationstesten og skal tilpasses til det anvende systemet Det vil sige sti til certifikat, systemnavn osv.

Headers

Derefter kan service og port bruges til at oprette de nødvendige headers så det er muligt at kalde servicen.

...

Medcom-headeren er pakket ind i et holderobjekt, da det er en request/response-parameter.

Eksempel på kald af

...

Samtykkeservicen Verifikation

Et eksempel på kald af  ConsentForDataCheck er vist her.

...

Elementet consentData skal være en liste over ConsentDataRegistration-objekter, se MinSpærring - Administration Service Interface Beskrivelse.

Servicen returnerer en liste af ID'er som den sundhedsfaglige har samtukke til at få vist.

Eksempel på kald af

...

Samtykkeservicen Administration

Her vises et eksempel på et kald til ConsentAdd i administrationsservicen. Indholdet af det faktiske samtykkeobjekt vises ikke her:

Code Block
languagejava
Consent consentItem = new Consent();
consentItem.setCitizenCPR(citizen);
consentItem.setPositiveConsent(positive);
consentItem.setValidFromDate(validFrom);
consentItem.setValidToDate(validTo);
consentItem.setWho(who);
consentItem.setWhat(what);

PORT.ConsentAdd(Arrays.<Consent>asList(consentItem), medcomHeader,
signedHeaders.getSecurityHeader(), hsuidHeader);

Klient generering fra WSDL

Det er også muligt selv at generere en klient baseret på en WSDL.

...

Samtykkeservicen services versioner

Både den administrative og verifikationssnitfladen findes i flere versioner. Nedenstående liste er en fortegnelse over disse og deres endpoints og WSDL. Urlen skal tilpasses til det miljø, som anvenderen ønsker at ramme (se FAQ NSP miljøer).miljø, som anvenderen ønsker at ramme (se FAQ NSP miljøer).

VerifikationsserviceURLWSL
DGWS service til verfification af bruger og datahttp://localhost:8080/consent-verification/service

http://localhost:8080/consent-verification/service?wsdl

http://localhost:8080/consent-verification/service-contract/wsdl/consent-verification.wsdl

Administrationsservice

DGWS service til administration af spærringerhttp://localhost:8081/consent-administration/service

http://localhost:8081/consent-administration/service?wsdl

http://localhost:8081/consent-administration/service-contract/wsdl/consent-administration-dgws.wsdl

IDWS service til administration af spærringerhttp://localhost:8081/consent-administration/serviceidws

http://localhost:8081/consent-administration/serviceidws?wsdl

http://localhost:8081/consent-administration/service-contract/wsdl/consent-administration-idws.wsdl

DGWS service til administration af spærringer v2http://localhost:8081/consent-administration/service-2.0

http://localhost:8081/consent-administration/service-2.0?wsdl

http://localhost:8081/consent-administration/service-contract/wsdl/consent-administration-dgws-20201104.wsdl

IDWS
VerifikationsserviceURLWSL
AdministrationsserviceDGWS service til administration af spærringer v2http://localhost:80808081/consent-administration/serviceserviceidws-2.0

http://localhost:

8080

8081/consent-administration/

service

serviceidws-2.0?wsdl

...

http://localhost:

...

8081/consent-administration/service

...

-contract/wsdl/consent-administration-idws-20201104.wsdl

DGWS service til administration af spærringer for ikke digititale borgere
http://localhost:

...

8081/consent-administration/service

...

-adm-2.0

http://localhost:

...

8081/consent-

...

administration/service-adm-2.0?wsdl

...

http://localhost:

...

8081/consent-

...

administration/service-contract/wsdl/consent-administration-adm-20220207.wsdl