Page History

Versions Compared

Old Version 14

changes.mady.by.user Unknown User (nha@kmd.dk)

Saved on 17-12-2021

compared with

New Version Current

changes.mady.by.user Mads Haargaard

Saved on 21-02-2024

Key

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

Navitabs

root	MinSpærring Samtykkeservicen - Leverancebeskrivelse
includeroot	true

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

Version	Dato	Ansvarlig	Beskrivelse
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.2018	KIT	Document moved from Word to Confluence. Original document name was: PHB0035 Consent Services Users Guide.docx
	12.11.2020	KIT	Oversættelse fra engelsk til dansk
	17.12.2021	KIT	Tilføjet request/response eksempler for Samtykkeservicen Administration

Definitioner og referencer

Definition	Beksrivelse
NSI	National Sundheds IT
NSP	National Service Platform
SHAK	SygeHusAfdelingsKode
SOR	Sundhedsvæsnets Organisationsregister
STS	Security Token Service

Reference	Beskrivelse
DGWS 1.0	Den Gode Webservice 1.0
DGWS 1.0.1	Den Gode Webservice 1.0.1
HSUID-headerMinSpærring - Healthcare Service User Identification Header Interface Description	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 header

To 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 For at kalde de to Samtykkeservicen services skal der anvendes et niveau 3 ID-kort udstedt af STS'en.

It should furthermore be ensured that one has a stated company registration number and that it is on the whitelist of authorized system. The two services use different whitelists, so the company registration number must be added to one or both, depending on which service one wants to call.

Det skal desuden sikres, at man har et angivet CVR-nummer og at dette er whitelisted i servicen. De to services bruger forskellige whitelisting tabeller, så CVR-nummer skal føjes til den ene eller begge, afhængigt af hvilken tjeneste man vil tilgå.

Medcom header

Der findes en admin-snitflade (til 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'.

Medcom header

I Medcom-I Medcom-headeren skal det sikres, at Flow-ID er sat korrekt. Hvis servicene kaldes fra et andet system der også anvender DGWS skal Flow-ID bevares fra dette opkald.

...

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.

Alle metoder i administrationen af samtykke og spærringer tillader den borger, der opretter en registrering (eller sletter / ændrer), at være forskellig fra den borger, som registreringen vedrører.

...

Det er brugersystemets ansvar, at brugeren er godkendt og autoriseret til at udføre en handling på vegne af en anden.

Eksempler

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

Kodeeksemplet er taget fra integrationstestene for servicen, og begge metodekald, variabler og parametre kommer fra integrationstesten.

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

...

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.

De enkelte notificeringer indholder ikke detaljer vedr. opdateringen eller spærring, men udelukkende oplysninger om det cprnummer, for hvilket opdateringen har fundet sted. Det er efterfølgende op til anvenderen at hente ændringerne ud via snitfladerne.

Følgende er et eksempel på en opdateringsnotificering:

Code Block

language	xml
title	ConsentModifyConstraint Request
linenumbers	true
Eksempel på notifikation ved ændring i MinSpærring
collapse	true

<?xml version='1.0' encoding='UTF-8'?> <soap:Envelope
    xmlns:soap<ns2:Body>
     <ns8:Notify>
          <ns8:NotificationMessage>
               <ns8:TopicDialect="http://schemasdocs.xmlsoapoasis-open.org/wsn/soapt-1/envelopeTopicExpression/Simple">MinSpærringTopic</ns8:Topic>
              xmlns:SOAP-ENV <ns8:Message>
                    <ns13:NotifyContentid="1208643298"idType="http://schemasnsi.xmlsoap.orgdk/soapadvis/envelopev10/CPR">
                  xmlns:ds        <ns14:ConsentUpdatedxmlns:ns14="http://nsp.dk/consent/2021/04/12">
                              <datevalue="2021-04-21"/>
                              <versionvalue="1"/>
                         </ns14:ConsentUpdated>
                    </ns13:NotifyContent>
               </ns8:Message>
          </ns8:NotificationMessage>
     </ns8:Notify>     
</ns2:Body>

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.

Kodeeksemplet er taget fra integrationstestene for servicen, og begge metodekald, variabler og parametre kommer fra integrationstesten.

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

language	xml
title	ConsentModifyConstraint Request
linenumbers	true
collapse	true

<?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.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

language	xml
title	ConsentModifyConstraint Response
linenumbers	true
collapse	true

<?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

language	xml
title	ConsentAddConstraint Request
linenumbers	true
collapse	true

<?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

language	xml
title	ConsentAddConstraint Response
linenumbers	true
collapse	true

<?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

language	xml
title	ConsentAddPositive Request
linenumbers	true
collapse	true

<?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

language	xml
title	ConsentAddPositive Response
linenumbers	true
collapse	true

<?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

language	xml
title	ConsentRevoke Request
linenumbers	true
collapse	true

<?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
       wsu:Id="body">
 </ns2:consentId>
        <ns4<ns2:ConsentRevokecitizenCPR>
          xmlns:ns4="http://sundhedsdatastyrelsen.dk/minspaerring/2020/11/04">1110734334
      <ConsentRevocations>  </ns2:citizenCPR>
        <ns2:consentId>positiveConsent>
          123498765532463false
        </ns2:consentId>positiveConsent>
        <ns2:citizenCPR>
who>
          <ns2:healthProfessionalCPR>
           1110734334 0307702555
          </ns2:citizenCPR>healthProfessionalCPR>
          <ns2:positiveConsent>includeSubOrganizations>
            false
          </ns2:positiveConsent>
includeSubOrganizations>
          <ns2:who>foreignHealthProfessionals>
          <ns2:healthProfessionalCPR>
  false
          0307702555
  </ns2:foreignHealthProfessionals>
        </ns2:healthProfessionalCPR>who>
          <ns2:includeSubOrganizations>validFromDate>
            false
 2021-12-17T07:35:53.000+01:00
         </ns2:includeSubOrganizations>validFromDate>
      </ConsentRevocations>
    <ns2</ns4: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>

ConsentRevoke>
  </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	ConsentRevoke Response
linenumbers	true
collapse	true

<?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

Code Block

language	xml
title	ConsentRevoke Response
linenumbers	true
collapse	true

<?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.w3nsi.orgdk/hsuid/20052016/08/addressinghsuid-1.1.xsd"
        xmlns:wssens4="http://docs.oasis-open.org/wss/2004/01/oasis-sundhedsdatastyrelsen.dk/minspaerring/2020/11/04"/>
  </soap:Body>
</soap:Envelope>

ConsentRegistrationsGet

Code Block

language	xml
title	ConsentRegistrationsGet Request
linenumbers	true
collapse	true

<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope200401-wss-wssecurity-secext-1.0.xsd"
    xmlns:wsusoap="http://docsschemas.oasis-openxmlsoap.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
  <soapenv:Header
    .. soap headers fj ernet for overskueligehed...
</soapenv:Header>
  <soap:Bodysoap/envelope/"
      wsu:Id="body">xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
    <ns4:ConsentRevokeResponsexmlns:ds="http://www.w3.org/2000/09/xmldsig#"
        xmlns:ns2saml="urn:dk:nsi:consentservices:typesoasis:names:tc:SAML:2.0:assertion"
        xmlns:ns3="http://www.nsi.dk/hsuid/2016/08/hsuid-1.1.xsdsbf="urn:liberty:sb"
    xmlns:sbfprofile="urn:liberty:sb:profile"
    xmlns:ns4wsa="http://sundhedsdatastyrelsenwww.w3.dkorg/minspaerring/2020/11/04"/>
  </soap:Body>
</soap:Envelope>

ConsentRegistrationsGet

Code Block

language	xml
title	ConsentRegistrationsGet Request
linenumbers	true
collapse	true

<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope
2005/08/addressing"
    xmlns:soapwsse="http://schemasdocs.xmlsoapoasis-open.org/wss/soap2004/envelope/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
    xmlns:SOAP-ENVwsu="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
//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:samlns2="urn:oasisdk:namesnsi:tc:SAML:2.0:assertionconsentservices:types"
    xmlns:sbf="urn:liberty:sb"
    xmlns:sbfprofilens3="urn:liberty:sb:profile"
http://www.nsi.dk/hsuid/2016/08/hsuid-1.1.xsd"
      xmlns:wsans4="http://www.w3.org/2005/08/addressing"
sundhedsdatastyrelsen.dk/minspaerring/2020/11/04"
      xmlnswsu:wsseId="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
"body">
    <ns4:ConsentRegistrationsGet
        xmlns:wsuns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsdsundhedsdatastyrelsen.dk/minspaerring/2020/11/04">
  <soap:Header
    <PatientPersonCivilRegistrationIdentifier>
        ..0701979346
 soap headers fj ernet for overskueligehed...
</soap:Header> </PatientPersonCivilRegistrationIdentifier>
    </ns4:ConsentRegistrationsGet>
  <soap</soap:Body>
</soap:Envelope>

Code Block

language	xml
title	ConsentRegistrationsGet Response
linenumbers	true
collapse	true

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope
Body
      xmlns:ns2="urn:dk:nsi:consentservices:types"
      xmlns:ns3soap="http://wwwschemas.nsixmlsoap.dkorg/hsuidsoap/2016/08/hsuid-1.1.xsdenvelope/"
      xmlns:ns4ds="http://sundhedsdatastyrelsenwww.w3.dkorg/minspaerring2000/202009/11/04xmldsig#"
      wsu:Id="body">xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"
    xmlns:sbf="urn:liberty:sb"
    <ns4:ConsentRegistrationsGet
   xmlns:sbfprofile="urn:liberty:sb:profile"
     xmlns:ns4wsa="http://sundhedsdatastyrelsenwww.w3.dkorg/minspaerring2005/202008/11/04addressing">
      <PatientPersonCivilRegistrationIdentifier>
        0701979346
      </PatientPersonCivilRegistrationIdentifier>
    </ns4:ConsentRegistrationsGet>
  </soap:Body>
</soap:Envelope>

Code Block

language	xml
title	ConsentRegistrationsGet Response
linenumbers	true
collapse	true

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelopexmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
    xmlns:soapwsu="http://schemasdocs.xmlsoapoasis-open.org/wss/2004/soap/envelope/"01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
  <soapenv:Header
     .. soap headers fj ernet for overskueligehed...
</soapenv:Header>
  <soap:Body
    xmlns  wsu:dsId="http://www.w3.org/2000/09/xmldsig#"body">
    xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"<ns4:ConsentRegistrationsGetResponse
    xmlns:sbf="urn:liberty:sb"
    xmlns:sbfprofilens2="urn:libertydk:sb:profile"
    xmlns:wsa="http://www.w3.org/2005/08/addressingnsi:consentservices:types"
        xmlns:wssens3="http://docswww.oasis-opennsi.orgdk/wsshsuid/20042016/01/oasis-200401-wss-wssecurity-secext-1.008/hsuid-1.1.xsd"
        xmlns:wsuns4="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
sundhedsdatastyrelsen.dk/minspaerring/2020/11/04">
      <ConsentRegistrations>
        <ns2:consentId>
          123498765532463
        </ns2:consentId>
        <ns2:citizenCPR>
          0701979346
        </ns2:citizenCPR>
        <ns2:positiveConsent>
          false
       wsu:Id="body">
 </ns2:positiveConsent>
        <ns4<ns2:ConsentRegistrationsGetResponsewho>
        xmlns:ns2="urn:dk:nsi:consentservices:types"  <ns2:healthProfessionalCPR>
        xmlns:ns3="http://www.nsi.dk/hsuid/2016/08/hsuid-1.1.xsd"
    0307702555
    xmlns:ns4="http://sundhedsdatastyrelsen.dk/minspaerring/2020/11/04">
      <ConsentRegistrations></ns2:healthProfessionalCPR>
          <ns2:consentId>includeSubOrganizations>
            123498765532463false
          </ns2:consentId>
includeSubOrganizations>
          <ns2:citizenCPR>foreignHealthProfessionals>
          0701979346  false
          </ns2:citizenCPR>foreignHealthProfessionals>
        <ns2</ns2:positiveConsent>who>
        <ns2:validFromDate>
  false
        </ns2:positiveConsent>2021-12-17T07:35:53.000+01:00
        <ns2</ns2:who>validFromDate>
      </ConsentRegistrations>
    <ns2</ns4:healthProfessionalCPR>ConsentRegistrationsGetResponse>
            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

language	xml

<dependency> 
	<groupId>dk.nsi.consentservices.verification</groupId> 
	<artifactId>consent-verification-client</artifactId> 
	<version><desired client version></version>
</dependency>

og:

Code Block

language	xml

<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.

Konfiguration af klienten sker via ClientConfig. ClientConfig's argument er navnet på den property fil der skal anvendes. Filen skal findes på classpath.

Koden nedenfor opretter en web service port til MinSpærring 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);

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);

Dette forudsætter, at en VerificationClient.properties-fil kan findes på classpath

Lignende kode skaber en klient til MinSpærring 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.

Code Block
administration.wsdl.location = http://localhost:8080/consent-administration/service?wsdl administration.service.url = http://localhost:8080/consent-administration/service verification.wsdl.location = http://localhost:8080/consent-verification/service?wsdl verification.service.url = http://localhost:9090/consent-verification/service idcard.level = 3 idcard.system.name = TESTSTS idcard.subject.id.type = medcom:cvrnumber idcard.subject.id = 19343634 idcard.subject.name = JERNALDERBYENS VENNER sts.test.mode = false sts.endpoint = http://test1.ekstern-test.nspop.dk:8080/sts/services/NewSecurityTokenService sts.token.expiry.threshold = 60 sts.keystore = jks/validVocesVault.jks sts.keystore.password = !234Qwer cert.expires.in.warning = 30

Code Block

administration.wsdl.location = http://localhost:8080/consent-administration/service?wsdl
administration.service.url = http://localhost:8080/consent-administration/service
verification.wsdl.location = http://localhost:8080/consent-verification/service?wsdl
verification.service.url = http://localhost:9090/consent-verification/service
idcard.level = 3
idcard.system.name = TESTSTS
idcard.subject.id.type = medcom:cvrnumber
idcard.subject.id = 19343634
idcard.subject.name = JERNALDERBYENS VENNER
sts.test.mode = false
sts.endpoint = http://test1.ekstern-test.nspop.dk:8080/sts/services/NewSecurityTokenService
sts.token.expiry.threshold = 60
sts.keystore = jks/validVocesVault.jks
sts.keystore.password = !234Qwer
cert.expires.in.warning = 30

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.

Et flowID er angivet i headeren.

Code Block
DGWSHeaderWrapper signedHeaders = service.getSignedHeaders(flowID); Holder<Header> medcomHeader = new Holder<Header>(signedHeaders.getMedcomHeader()); HsuidHeader hsuidHeader = createHsuidHeader();

Værdierne i HSUID-headeren skal sættes manuelt ved at kalde en metode, der opretter objektet (se MinSpærring Healthcare Service User Identification Header Interface Description for en beskrivelse af headerindholdet).

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

Eksempel på kald af MinSpærring Verifikation

Et eksempel på kald af ConsentForDataCheck er vist her.

Code Block

language	java

List<ConsentDataRegistration> consentData; // the list must be populated elsewhere

ConsentForDataCheck consentForDataCheck =
new ConsentForDataCheck(citizen, healthcareProfessional, onBehalfOf,
organization, consentData);

ConsentForDataResponse consentForDataCheckResponse =
PORT.ConsentForDataCheck(consentForDataCheck, medcomHeader,
signedHeaders.getSecurityHeader(), hsuidHeader);

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.

Eksempal på kald af MinSpærring Administration

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

Code Block

language	java

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

...

</soap:Body>
</soap:Envelope>

Service Klienter

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

Code Block

language	xml

<dependency> 
	<groupId>dk.nsi.consentservices.verification</groupId> 
	<artifactId>consent-verification-client</artifactId> 
	<version><desired client version></version>
</dependency>

og:

Code Block

language	xml

<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.

Konfiguration af klienten sker via ClientConfig. ClientConfig's argument er navnet på den property fil der skal anvendes. Filen skal findes på classpath.

Koden nedenfor opretter en web service port til 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);

Dette forudsætter, at en VerificationClient.properties-fil kan findes på classpath

Lignende kode skaber en klient til 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.

Code Block

administration.wsdl.location = http://localhost:8080/consent-administration/service?wsdl
administration.service.url = http://localhost:8080/consent-administration/service
verification.wsdl.location = http://localhost:8080/consent-verification/service?wsdl
verification.service.url = http://localhost:9090/consent-verification/service
idcard.level = 3
idcard.system.name = TESTSTS
idcard.subject.id.type = medcom:cvrnumber
idcard.subject.id = 19343634
idcard.subject.name = JERNALDERBYENS VENNER
sts.test.mode = false
sts.endpoint = http://test1.ekstern-test.nspop.dk:8080/sts/services/NewSecurityTokenService
sts.token.expiry.threshold = 60
sts.keystore = jks/validVocesVault.jks
sts.keystore.password = !234Qwer
cert.expires.in.warning = 30

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.

Et flowID er angivet i headeren.

Code Block
DGWSHeaderWrapper signedHeaders = service.getSignedHeaders(flowID); Holder<Header> medcomHeader = new Holder<Header>(signedHeaders.getMedcomHeader()); HsuidHeader hsuidHeader = createHsuidHeader();

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.

Code Block

language	java

List<ConsentDataRegistration> consentData; // the list must be populated elsewhere

ConsentForDataCheck consentForDataCheck =
new ConsentForDataCheck(citizen, healthcareProfessional, onBehalfOf,
organization, consentData);

ConsentForDataResponse consentForDataCheckResponse =
PORT.ConsentForDataCheck(consentForDataCheck, medcomHeader,
signedHeaders.getSecurityHeader(), hsuidHeader);

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

language	java

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).

Verifikationsservice	URL	WSL
DGWS service til verfification af bruger og data	http://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ærringer	`http://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ærringer	http://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 v2	http://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 service til administration af spærringer v2	http://localhost:8081/consent-administration/serviceidws-2.0	http://localhost:8081/consent-administration/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

Content

Space Tools

Page History

Versions Compared

Old Version 14

New Version Current

Key

Introduktion

Formål

Læsevejledning

Dokument historik

Definitioner og referencer

Interface Beskrivelse

Fælles

Samtykkeservicen Verifikation

Samtykkeservicen Administration

Eksempler

Eksempler på IDWS kald request og response

Notificeringer i NAS AnchorNAS_FrabedelseNAS_Frabedelse

Eksempler

Eksempler på IDWS kald request og response

ConsentModifications

ConsentAddConstraint

ConsentAddPositive

ConsentRevoke

ConsentRegistrationsGet

ConsentRegistrationsGet

Service Klienter

Oprettelse af service client

Konfiguration

Headers

Eksempel på kald af MinSpærring Verifikation

Eksempal på kald af MinSpærring Administration

Klient generering fra WSDL

Service Klienter

Oprettelse af service client

Konfiguration

Headers

Eksempel på kald af Samtykkeservicen Verifikation

Eksempel på kald af Samtykkeservicen Administration

Klient generering fra WSDL

Samtykkeservicen services versioner

Notificeringer i NAS
Anchor
NAS_Frabedelse
NAS_Frabedelse

`ConsentModifications`