1      Formål

Nærværende dokument indgår i den samlede dokumentationspakke for stamdataregistret på NSP. Dokumentationspakken giver tilsammen det fulde overblik over dokumentationen. ”Guide til anvendere” er målrettet udviklere og arkitekter hos leverandører, som ønsker at anvende funktionaliteten udstillet af stamdataservicen. Guiden kan indeholde kodeeksempler, interaktionsbeskrivelser, servicebeskrivelser, snitfladebeskrivelser mv.

1       Formål

Nærværende dokument indgår i den samlede dokumentationspakke for stamdataregistret på NSP. Dokumentationspakken giver tilsammen det fulde overblik over dokumentationen.

”Guide til anvendere” er målrettet udviklere og arkitekter hos leverandører, som ønsker at anvende funktionaliteten udstillet af stamdataservicen. Guiden indeholder snitfladebeskrivelser,

Guiden kan indeholde kodeeksempler, interaktionsbeskrivelser, servicebeskrivelser, snitfladebeskrivelser mv.

2       Introduktion til Stamdataservicen

Stamdataservicen er en national service udstillet på NSP, som giver adgang til relevante nationale stamdataregistre, opsamlet af NSP fra forskellige myndigheder og dataansvarlige enheder.

Stamdataservicen udstiller flere snitflader, der tilsammen giver mulighed for både at holde komplette lokale kopier af stamdataregistrene ajour og for at lave enkeltopslag i udvalgte registre. For en overordnet beskrivelse af den udstillede funktionalitet henvises der til Arkitektur og Design, der på lige fod med nærværende dokument indgår i den samlede dokumentationspakke for stamdataservicen.

2.1     Adgang til Stamdataservicens funktionalitet

Anvendelse af stamdataservicen forudsætter en aftale med NSP-operatøren. Yderligere oplysninger om betingelserne for anvendelse af stamdataservicen, herunder håndtering af dataansvar og tekniske forudsætninger, kan fås ved henvendelse til NSP-operatørens servicedesk (http://nsp.nsi.dk).

Adgangen til funktionaliteten er styret i flere ”lag”, idet de enkelte stamdataregistre indeholder forskelligartet information, og kan være styret af forskellige politikker. I praksis styres adgangen gennem whitelists på CVR nummer niveau[1] for de enkelte services.

Alle snitflader udstillet af stamdataservicen er baseret på Den Gode Web-Service 1.0.1 (DGWS 1.0.1) som er en national standard for identitetsbaserede webservices i sundhedssektoren. I forhold til stamdataservicen forudsættes der autentifikation på DGWS niveau 3, dvs. brug af STS-signerede system-IDkort.

NSI leverer gratis biblioteksunderstøttelse af store dele af webservice kommunikationen, herunder generering og parsning af IDkort og headere. Der henvises til DGWS dokumentationen (http://www.medcom.dk/wm110731) for generel information om DGWS og SEAL dokumentationen (http://www.sosi.dk/twiki/bin/view/ProjectManagement/SOSIProducts) for generel information om biblioteksunderstøttelsen.

3       Kopiregisterservicen (SKRS)

Kopiregisterservicen (SKRS) giver systemer mulighed for at etablere og ajourføre en lokal kopi af et register, som f.eks. CPR-registret eller autorisationsregistret.

Som beskrevet i afsnit 2.1 er det nødvendigt at etablere en aftale hos NSP-operatøren for at få adgang til de respektive registre. Præcist hvilke registre og data-typer man får adgang til er afhængigt af aftalen. Der henvises til dokumentet Design og Arkitektur for en oversigt over hvilke registre, KRS pt. kan levere data fra.

3.1     Struktur af kald til KRS

Kopiregisterservicen tager følgende input:

Kaldet til Kopiregisterservicen er formelt specificeret i WSDL’en stamdata_krs.wsdl, der kan rekvireres ved henvendelse til NSP-operatøren.

En komplet gennemgang af tilgængelige registre, datatyper samt versioner er at finde i dokumentet ”Registerspecifikation for Anvendere”.

3.2     Fejlsituationer

Hvis der er en fejl i forespørgslen eller der opstår en fejl på serveren vil servicen returnere en fejlmelding af typen ReplicationFault med en beskrivelse af fejlen (jævnfør WSDL som specificeret i ovenstående afsnit). Hvis forespørgslen går godt returnerer servicen en besked af typen ReplicationResponse der indeholder et ”any”-element. Dette any-element er af typen atom baseret på ATOM 1.0 [RFC4287]. ATOM er en syndikeringsprotokol og designet til at holde styr på ændringer i en ressource. I dette tilfælde er ressourcerne datatyperne i et register. Hvordan dette atom-element skal tolkes er forklaret nærmere i afsnit 3.3.

3.3     Endpoint URL

Kopi register servicen er som udgangspunk konfigureret på

<hostnavn>:8080/stamdata-batch-copy-ws/service/StamdataReplication

og wsdl kan hentes ved at sætte ?wsdl efter altså:

<hostnavn>:8080/stamdata-batch-copy-ws/service/StamdataReplication?wsdl

3.4     Eksempel på kald til KRS

Som klient sender man et ReplicationRequest til servicen.

Forespørgsel:

<?xml version="1.0" encoding="UTF-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

  <S:Header>

                    …

  </S:Header>

  <S:Body>

    <ns1:ReplicationRequest xmlns:ns1="http://nsi.dk/2011/10/21/StamdataKrs/">

      <register>cpr</register>

      <datatype>person</datatype>

      <version>1</version>

      <offset>0</offset>

    </ns1:ReplicationRequest>

  </S:Body>

</S:Envelope>

Headeren skal indeholde en DGWS 1.0.1 header.

Hvis alt går som forventet og forespørgslen bliver godkendt modtages et svar:

Svar:

<?xml version="1.0" encoding="UTF-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

  <S:Header>

                    …

  </S:Header>

  <S:Body>

    <ns1:ReplicationResponse xmlns:ns1="http://nsi.dk/2011/10/21/StamdataKrs/">

      <atom:feed xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://nsi.dk/-/stamdata/3.0/cpr">

        <atom:id>tag:nsi.dkersonLookupWithSubscriptionIntegrationTest.java,2011:cpr/person/v1</atom:id>

        <atom:updated>2011-10-25T07:02:08.045Z</atom:updated>

        <atom:title>Stamdata Registry Feed</atom:title>

        <atom:author>

          <atom:name>National Sundheds IT</atom:name>

        </atom:author>

                    …

      </atom:feed>

    </ns1:ReplicationResponse>

  </S:Body>

</S:Envelope>

Opstår der derimod en fejl, bliver en DGWS 1.0.1 Fault sendt tilbage, f.eks.:

Fejl:

<soapenv:Envelope ...>

  <soapenv:Header>...</soapenv:Header>

  <soapenv:Body>

  <soapenv:Fault>

     <faultcode>Server</faultcode>

     <detail>

       <medcom:FaultCode>expired_idcard</medcom:FaultCode>

     </detail>

     <faultstring>The ID card has expired.</faultstring>

   </soapenv:Fault>

   </soapenv:Body>

</soapenv:Envelope>

3.5     Detaljeret svar fra KRS

Her følger et mere detaljeret output fra KRS. Tolkning af dette er beskrevet i afsnittet efter.

  <atom:feed xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://nsi.dk/-/stamdata/3.0/cpr">

    <atom:id>tag:nsi.dk,2011:cpr/person/v1</atom:id>

    <atom:updated>2011-11-07T09:56:12.278Z</atom:updated>

    <atom:title>Stamdata Registry Feed</atom:title>

    <atom:author>

      <atom:name>National Sundheds IT</atom:name>

    </atom:author>

    <atom:entry>

      <atom:id>tag:nsi.dk,2011:cpr/person/v1/13206597710000000085</atom:id>

      <atom:title/>

      <atom:updated>2011-11-07T09:56:11.000Z</atom:updated>

      <atom:content type="application/xml">

        <person>

          <cpr>0102451234</cpr>

          <koen>M</koen>

          <fornavn>Hans</fornavn>

          <mellemnavn/>

          <efternavn>Hansen</efternavn>

          <coNavn></coNavn>

          <lokalitet/>

          <vejnavn>Ligusterv&#xE6;nget</vejnavn>

          <bygningsnummer>42</bygningsnummer>

          <husnummer>123</husnummer>

          <etage>12</etage>

          <sideDoerNummer>th.</sideDoerNummer>

          <bynavn>Enby</bynavn>

          <postnummer>1448</postnummer>

          <postdistrikt>N&#xF8;ddebo</postdistrikt>

          <status>01</status>

          <gaeldendeCPR>3105459876</gaeldendeCPR>

          <foedselsdato>1947-12-24T00:00:00+01:00</foedselsdato>

          <stilling/>

          <vejKode>740</vejKode>

          <kommuneKode>314</kommuneKode>

          <validFrom>2011-11-07T10:56:21+01:00</validFrom>

          <validTo>2012-11-07T10:56:11+01:00</validTo>

        </person>

      </atom:content>

    </atom:entry>

  </atom:feed>

3.6     Parsing af output

Det mest interessante ved et response er ’entry’-elementerne. Hvert ’entry’-element indeholder et snapshot af en record fra registret. Med snapshot menes, at det var sådan data så ud på et bestemt tidspunkt. Stamdata bruger fuld historik når man laver et udtag. Det vil sige at man f.eks. kan få information om hvordan en person record så ud for 1 år siden – med adresse, navn etc. Der er ingen garanti for hvor langt tilbage i tiden stamdata har information. Historiske ændringer styres af ValidFrom og ValidTo elementer.

Hvert entry element har et ’content’-element som indeholder alt domæne-data. I eksemplet ovenfor er det datatypen ’person’ som er indeholdt.

Det er to slags nøgler som identificerer en record: Unikke nøgler (indeks) og versionsnumre.

3.6.1     Unikke Nøgler

Hver datatype har et nøgleelement som unikt bestemmer en record. Eksempelvis identificeres en person unikt ved sit CPR-nummer i CPR-registret. Derfor vil man, når man persisterer records fra cpr/person/v1 bruge cpr-elementet som unik nøgle. Unikke nøgler for de enkelte datatyper er beskrevet i listen over registre i dokumentet "Registerspecifikation for Anvendere”.

3.6.2     Revisionsnummer

Revisionsnumre bestemmer en record unikt indenfor en given datatype. Man kan se det som en primær nøgle i en database. Et revisionsnummer er også en slags historisk ID. Det vil sige at det bestemmer en record unikt i historien, i modsætning til unikke nøgler.

Revisionsnummeret kan findes ved at kigge på entry-elementernes id-element. F.eks. i

tag:nsi.dk,2011:sor/apotek/v1/168763721800723

er 1687637218007236 revisionsnummeret.

Med andre ord, bestemmer en unik nøgle en bestemt entitet, revisionsnummeret bestemmer et snapshot af den entitet. Begge disse numre er vigtige på flere måder. Den unikke nøgle kan optræde i flere forskellige entry-elementer. Det er på grund af at en entitet ændre sig med tiden, men revisionsnumre vil altid være forskellige.

3.6.3     ValidFrom og ValidTo elementer

Historiske ændringer styres af ValidFrom og ValidTo. Hvert entry-element har et ValidFrom og ValidTo element. Dettte gælder for alle register og datatyper. ValidFrom og ValidTo representer en tidslinie af ændringer for den samme primær nøgle for en datatype. Der er ikke overlap mellem de tidsintervaller representeret ved ValidFrom og ValidTo for en specifik primær nøgle.

For Person datatypen er den primær nøgle CPR nummer og en ændring af f.eks. efternavn vil resulter i disse 2 records.

<person>
          <cpr>0102451234</cpr>
          ...
          <efternavn>Hansen</efternavn>
          ...
          <validFrom>2000-01-01T01:01:01+01:00</validFrom>
          <validTo>2010-10-10T10:10:10+01:00</validTo>
</person>

<person>
          <cpr>0102451234</cpr>
          ...
          <efternavn>Jensen</efternavn>
          ...
          <validFrom>2000-10-10T10:10:10+01:00</validFrom>
          <validTo>2999-01-01T00:00:00+01:00</validTo>
</person>

Bemærk at ValidTo for den første record er det samme som ValidFrom i den anden og på den måde representer en uafbrudt tidslinie.

3.6.4     DateTime

DateTime’s i data vil som udgangspunkt være repræsenteret som lokal tidszone, altså fx ”2018-07-11T08:16:47+02:00”, bemærk dog at for datoer ældre end 1894 anvendes UTC, da de moderne tidszoner ikke var indført den gang.

Klienter bør derfor altid være i stand til at forstå datoer tider uanset tidszone angivelse.

3.7     Paginering

Antallet af records i et register kan være meget stort, i visse tilfælde flere millioner records. Derfor bliver man nødt til at opdele et udtræk i flere kald. Response fra det tidligere eksempel, er et eksempel på en page. Når man er klar til at hente næste page sender man et request med nyt offset i ReplicationResponse beskeden. Offset-parameteren i næste request sættes til det sidste versionsnummeret man har modtaget.

Det er muligt at angive hvor mange records man højest ønsker i et svar fra servicen ved at sætte parameteren maxRecords i ReplicationRequest forespørgelsen. Der er på serveren en øvre grænse på denne parameter der overskriver for høje værdier i en forespørgelse. Hvis parameteren ikke specificeres i kaldet indsættes denne grænse som antal records.

4       Registre

Da der løbende kommer nye registre er beskrivelserne af de enkelte registre flyttet til:

https://www.nspop.dk/display/web/SKRS+-+Stamdata+Kopi+Register+Service#SKRS-StamdataKopiRegisterService-Registeroversigt

5       Enkeltopslag i registre

Stamdataservicen tilbyder en service til såkaldte enkeltopslag i følgende registre:

• Autorisationsregistret
• CPR registret
• Yderregistret

Enkeltopslag i et af de ovennævnte registre foregår som et webservice kald til stamdataservicen på NSP med angivelse af søgekriterier. De konkrete parametre og eventuelle særlige forhold der gør sig gældende for kald til enkeltopslags-snitfladen på stamdataservicen er beskrevet i de følgende afsnit.

5.1     Forespørgsler og dataformat

Enkeltopslags-snitfladen er udstillet som en DGWS 1.0.1 identitetsbaseret webservice. Adgang til enkeltopslagsservices forudsætter en aftale med NSP operatøren (adgang styres på CVR-nummer). Metoderne for de udstillede registre er beskrevet i separate WSDL filer, der kan rekvireres ved henvendelse til NSP operatøren.

Fælles for de udstillede enkeltopslagsservices er at der kræves STS-signerede system IDkort (dvs. DGWS niveau 3).

5.2     Enkeltopslag i autorisationsregistret

Det er muligt at lave onlineopslag i stamdataservicens kopi af Sundhedsstyrelsens autorisationsregister til fremsøgning af eventuelle autorisationer for en given sundhedsfaglig person. Der er to services AuthorizationService og AuthorizationCodeService, som tager henholdsvis personens CPR nummer og Autorisationsnummer som input, og returnerer personens navn og samtlige autorisationer der er i kraft for vedkommende.[2]

En person kan have flere gyldige autorisationer. Hver autorisation som bliver returneret fra webservicen er forbundet med en uddannelseskode. Tabellen nedenfor  viser en liste over kendte uddannelseskoder og deres tilknyttede uddannelse. Der henvises til Sundhedsstyrelsens løbende vedligeholdte liste af uddannelser, hvortil der udstedes sundhedsfaglige autorisationer for yderligere information (http://autregwebservice.sst.dk/autregservice.asmx). Faggruppenavnet bliver også returneret såfremt uddannelseskoden er kendt af enkeltopslagsservicen.

Hvis CPR-nummeret fra forespørgselen er tilknyttet en eller flere autorisationer vil også for- og efternavn for personen blive returneret. Forespørges der på et ugyldigt CPR-nummer eller en person uden gyldige autorisationer returneres der af sikkerhedshensyn tomme navnefelter i svaret – også selv om CPR-nummeret er et korrekt CPR-nummer for en eksisterende person.

5.2.1     Eksempel: Én eller flere autorisationer

Nedenfor ses et ”solskinsscenarie”, hvor der forespørges på en sundhedsfaglig, der har en enkelt gyldig autorisation.

Forespørgsel:

<?xml version="1.0" encoding="UTF-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

  <S:Header>

    …

  </S:Header>

  <S:Body>

    <AuthorizationRequestStructure xmlns="http://nsi.dk/-/stamdata/3.0" xmlns:ns2="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:ns3="http://www.w3.org/2000/09/xmldsig#" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns6="http://www.medcom.dk/dgws/2006/04/dgws-1.0.xsd">

      <cpr>1111122222</cpr>

    </AuthorizationRequestStructure>

  </S:Body>

</S:Envelope>

Svar:

<?xml version="1.0" encoding="UTF-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

  <S:Header>

                    …

  </S:Header>

  <S:Body>

    <AuthorizationResponseStructure xmlns="http://nsi.dk/-/stamdata/3.0" >

      <cpr>1111122222</cpr>

      <firstName>Peter</firstName>

      <lastName>Andersen</lastName>

      <authorization>

        <authorizationCode>B1114</authorizationCode>

        <educationCode>2131</educationCode>

      </authorization>

    </AuthorizationResponseStructure>

  </S:Body>

</S:Envelope>

I eksemplet er Peter Andersen tilknyttet CPR 1111122222, og han har en autorisation.

5.2.2     Eksempel: Ingen gyldige autorisationer

Forespørges der på en ikke-eksisterende person eller en person, der ikke har en gyldig autorisation, svares der blot med en tom AutorizationResponseStructure.

I eksemplet nedenfor er headere udeladt, og der henvises til eksemplet i afsnit 5.2.1 for en tilsvarende forespørgsel hvor headere er vist.

Forespørgsel:

<?xml version="1.0" encoding="UTF-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

  <S:Header>

    …

  </S:Header>

  <S:Body>

    <AuthorizationRequestStructure xmlns="http://nsi.dk/-/stamdata/3.0" xmlns:ns2="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:ns3="http://www.w3.org/2000/09/xmldsig#" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns6="http://www.medcom.dk/dgws/2006/04/dgws-1.0.xsd">

      <cpr>1111122244</cpr>

    </AuthorizationRequestStructure>

  </S:Body>

</S:Envelope>

Svar:

<soapenv:Envelope …>

  <soapenv:Header>…</soapenv:Header>

  <soapenv:Body>

    <AuthorizationResponseStructure xmlns="http://nsi.dk/-/stamdata/3.0">

  <cpr>1111122222</cpr>

</AuthorizationResponseStructure> 

</soapenv:Body>

</soapenv:Envelope>

Da der ikke er nogen tilknyttede autorisationer, returneres en tom AuthorizationResponseStructure uden angivelse af for- og efternavn.

5.3     CPR registret: Det Gode CPR Opslag

Stamdataservicen udstiller mulighed for enkeltopslag i CPR registret gennem en implementering af ’Det Gode CPR Opslag’ som specificeret af MedCom (http://www.medcom.dk/wm110491).

5.3.1     WSDL

Wsdl filer for servicen kan findes på medcoms svn her :

http://svn.medcom.dk/svn/drafts/CPR-opslag/trunk/CPR-opslag/wsdl/

Hver opmærksom på at der tilføjes Den Gode WebService felter på, så vil nok være nemmere at hente wsdl direkte fra servicen, det gøres ved at kalde endpoint med ?wsdl tilføjes som sådan http://endpointurl?wsdl da denne indeholder de tilføjede felter.

Sidst men ikke mindst kan de også hentes med dgws felter direkte fra leverandørens svn her:

https://fisheye.nspop.dk/browse/public/components/sdm/latest/code/nsp/cpr-ws/src/main/webapp/WEB-INF/wsdl

5.3.2     Endpoints

Det gode CPR opslag er udstillet i følgende versioner som er tilgængelig på hver deres endpoints.

For 1.0.2

http://stamdatahost:8080/stamdata-cpr-ws/service/DetGodeCPROpslag-1.0.2

Det anbefales at køre på mindst version 1.0.2 da ikke alle personer kan hentes i 1.0.0 uden validerings fejl.

For 1.0.3

http://stamdatahost:8080/stamdata-cpr-ws/service/DetGodeCPROpslag-1.0.3

For 1.0.4

http://stamdatahost:8080/stamdata-cpr-ws/service/DetGodeCPROpslag-1.0.4

For 1.0.4a

http://stamdatahost:8080/stamdata-cpr-ws/service/DetGodeCPROpslag-1.0.4a

5.3.3     Mangelfuld datagrundlag

Datagrundlaget kan i nogle tilfælde mangle værdier som er påkrævet af wsdl skemaet, hvis dette er tilfældet vil felterne udfyldes med en erstatningsværdi.

For PersonInformationStructureType drejer sig om følgende felter:

For AssociatedGeneralPractitionerStructure er det følgende felter:

Yderligere indeholder datagrundlaget i nogle tilfælde email adresser som ikke overholder reglerne i wsdl skemaet, hvis dette er tilfældet vil email adressen fjernes fra svaret.

Hvis der ikke kan findes en tilknyttet læge i datagrundlaget vil AssociatedGeneralPractitionerStructure være udfyld med følgende værdier

5.3.4     Fejlfyldt CPR data

Udover ovenstående erstatningsværdier kan der også være tale om data som ikke har kunnet indlæses pga. fejlfyldt kildedata, det kan fx være en dato der ikke har kunne parses. 

Hvis der laves opslag på en person som har fejlfyldt data vil der blive indsat erstatningsværdier for de felter der er markeret som fejlfyldte eller der vil blive sendt en soap fejl med beskeden ”Data for personen er markeret som upålideligt”

Hvorvidt der kommer en fejl eller der anvendes erstatningsværdier og hvad disse vil være sat til afhænger af konfigurationen, se mere på http://www.nspop.dk

5.3.5     Navne- og adressebeskyttelse

For CPR opslag gælder det generelt at hvis en record i CPR registret er markeret med navne- og adressebeskyttelse, da vil output være beskyttet ud fra følgende regler

Beskyttelse af data sker ved indsættelse erstatningsværdier, værdierne som der bliver erstattet med er afhængig af hvilken XSD type elementet har (dvs. der tages hensyn til de navnebeskyttede felters skema-definition).

Hvorvidt en person er adressebeskyttet kan i svaret bestemmes ud fra ”PersonInformationProtectionIndicator” uanset om output er beskyttet eller læsbart.

5.4     CPR registret: getPersonDetails og getPersonDetailsWithConsent

Stamdataservicen udstiller endvidere en variant af ’Det Gode CPR Opslag’, der kan anvendes til søgninger i CPR registret med følgende input.

• CPR-nummer
• liste af CPR-numre
• fødselsdato
• navn

Servicen i version 1.0.1 og 1.1.0 har en enkelt snitflade: getPersonDetails, der er implementeret i forskellige udgaver der muliggør forskellige typer af søgninger. Version 1.1.0 har desuden en snitflade getPersonDetailsWithConsent, der muliggør at hente addressebeskyttet data. Request og response er de samme for begge snifflader. I de følgende afsnit er kaldmulighederne beskrevet med tilhørende eksempler.

Servicen er formelt beskrevet i WSDL og XSD skemaer der kan findes her:

<src-root>/Dokumentation/bilag/StamdataPersonLookupService/

Eller direkte på driftsoperatørens SVN:

https://fisheye.nspop.dk/browse/public/components/sdm/latest/code/nsp/cpr-ws/src/main/webapp/WEB-INF/wsdl/

Servicen tager hensyn til navnebeskyttelse, og det anbefales at undersøge elementet PersonInformationProtectionIndicator for om værdien er true da personen i så fald er navnebeskyttet.

5.4.1     Endpoints

På samme måde som DetGodeCprOplag findes der 2 endpoints:

http://stamdatahost:8080/stamdata-cpr-ws/service/StamdataPersonLookup-1.0.1
http://stamdatahost:8080/stamdata-cpr-ws/service/StamdataPersonLookup-1.1.0

Det første endpoint findes kun af hensyn til bagud kompatibilitet og anvender wsdl filer som ligger i mappen PERSONLOOKUP_1.0.1.

Det anbefales man anvender StamdataPersonLookup-1.1.0 i nye projekter, wsdl filerne til denne kan findes i PERSONLOOKUP_1.1.0 mappen.

5.4.2     Whitelistning

Snitflader er beskyttet af en whitelistning. Et cvr nummer skal være whitelistet til ”SDM” og at kalde getPersonDetails og ”SDMwithConsent” for at kalde getPersonDetailsWithContents.

5.4.3     Mangelfuld data og Fejlfyldt CPR data

Se 5.3.3 Mangelfuld data og 5.3.4 Fejlfyldt CPR data

5.4.4     Eksempel 1: getPersonDetails(<Personnummer>)

I denne variant af getPersonDetails søges på et specifikt CPR nummer. Findes personen i CPR registret returneres de tilhørende CPR informationer. Findes personen ikke i CPR registret returneres et tomt svar.

I dette eksempel vises et kald, og en række mulige svar, afhængigt af søgeresultatet.

Kald 1: (Opslag vha. CPR-nummer)

<stam:PersonLookupRequest>

  <CivilRegistrationNumberPersonQuery>

    1234567890

  </CivilRegistrationNumberPersonQuery>

</stam:PersonLookupRequest>

Svar 1: (Personen blev fundet)

Giver anledning til følgende svar:

<stam:PersonLookupResponse>

  <ns:PersonInformationStructure>

    <ns1:RegularCPRPerson>

      <ns1:SimpleCPRPerson>

        <ns2:PersonNameStructure>

          <ns3:PersonGivenName>Peter</ns3:PersonGivenName>

          <ns3:PersonSurnameName>Andersen</ns3:PersonSurnameName>

        </ns2:PersonNameStructure>

        <ns1:PersonCivilRegistrationIdentifier>

          1234567890

        </ns1:PersonCivilRegistrationIdentifier>

        …

      </ns1:SimpleCPRPerson>

      …

      <ns6:PersonInformationProtectionIndicator>

        false

      </ns6:PersonInformationProtectionIndicator>

      </ns1:RegularCPRPerson>

    <ns:PersonAddressStructure>…</ns:PersonAddressStructure>

  </ns:PersonInformationStructure>

</stam:PersonLookupResponse>

Svar 2: (Personen blev ikke fundet)

Hvis søgningen ikke giver et positivt resultat, returneres der et tomt svar:

<stam:PersonLookupResponse />

5.4.5     Kald 2: (Opslag vha. navn)

getPersonDetails understøtter også søgninger på personnavn. Svar ved kald til denne variant er strukturelt identiske med svar ved søgninger på CPR nummer eller liste af CPR numre, og der henvises til disse eksempler for svarmuligheder.

<stam:PersonLookupRequest>

  <NamePersonQuery>

    <ns:PersonGivenName>Anne</ns:PersonGivenName>

    <!-- Det er ikke nødvendigt at angive mellemnavn -->

    <ns:PersonMiddleName>Søgaard</ns:PersonMiddleName>

    <ns:PersonSurnameName>Petersen</ns:PersonSurnameName>

  </NamePersonQuery>

</stam:PersonLookupRequest>

Angives mellemnavnet ikke, ignoreres det og records med matchende for- og efternavn returneret. Se kaldet med en liste af CPR-numre for at se scenariet hvor flere person-elementer returneres.

5.4.6     Kald 3: (Opslag vha. fødselsdato)

getPersonDetails understøtter også søgninger på fødselsdato. Svar ved kald til denne variant er strukturelt identiske med svar ved søgninger på CPR nummer eller liste af CPR numre, og der henvises til disse eksempler for svarmuligheder.

<stam:PersonLookupRequest>

    <BirthDatePersonQuery>1991-09-22</BirthDatePersonQuery>

</stam:PersonLookupRequest>

5.4.7     Kald 4: (Opslag vha. en liste af CPR numre)

getPersonDetails understøtter også søgninger med en liste af CPR numre som input. For hvert CPR nummer på listen returneres CPR informationerne eller et tomt svar, hvis CPR nummeret ikke findes.

<stam:PersonLookupRequest>

  <CivilRegistrationNumberListPersonQuery>

    <CivilRegistrationNumber>1111111111</CivilRegistrationNumber>

    <CivilRegistrationNumber>2222222222</CivilRegistrationNumber>

    <CivilRegistrationNumber>3333333333</CivilRegistrationNumber>

  </CivilRegistrationNumberListPersonQuery>

</stam:PersonLookupRequest>

Svar 4: (Resultat med flere records)

<stam:PersonLookupResponse>

  <ns:PersonInformationStructure>

    …

    <ns:PersonCivilRegistrationIdentifier>

      1111111111

    </ns:PersonCivilRegistrationIdentifier>

    …

  </ns:PersonInformationStructure>

  <ns:PersonInformationStructure>

    …

    <ns:PersonCivilRegistrationIdentifier>

      3333333333

    </ns:PersonCivilRegistrationIdentifier>

    …

  </ns:PersonInformationStructure>

</stam:PersonLookupResponse>

5.5 Enkeltopslag i yderregistret

Det er muligt at lave onlineopslag i stamdataservicens kopi af Sundhedsstyrelsens yderregister til fremsøgning af eventuelle yder oplysninger for en given sundhedsfaglig person. Der er en service YderService, som tager personens Ydernummer som input, og returnerer personens oplysninger i yderregister.

Servicen returner alt gyldig information i yderregistret baseret på opslag med ydernummeret. Se beskrivelsen af Yderregisteret lisen af data felter.

5.5.1     Endpoints

http://stamdatahost:8080/stamdata-yder-lookup-ws/service/YderService

5.5.1     Eksempel: Én eller flere autorisationer

Nedenfor ses et ”solskinsscenarie”, hvor der forespørges på en sundhedsfaglig, der har en enkelt gyldig autorisation.

Forespørgsel:

<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Header>
    …
  </S:Header>
  <S:Body>
    <YderRequestStructure xmlns="http://nsi.dk/-/stamdata/3.0" xmlns:ns2="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:ns3="http://www.w3.org/2000/09/xmldsig#" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns6="http://www.medcom.dk/dgws/2006/04/dgws-1.0.xsd">
      <yder>1111122222</yder>
    </YderRequestStructure>
  </S:Body>
</S:Envelope>

Svar:

<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Header>
                    …
  </S:Header>
  <S:Body>
    <YderResponseStructure xmlns="http://nsi.dk/-/stamdata/3.0" >
      <Yder>
        <AmtKode>81</AmtKode>
        <AmtTekst>Nordjylland</AmtTekst>
        <Praksisbetegnelse>Kraniosekral</Praksisbetegnelse>
        <Adresse>Vejen 1</Adresse>
        <Postnummer>5000</Postnummer>
        <Postdistrikt>Vejen</Postdistrikt>
        <Tilgangsdato>20000101</Tilgangsdato>
        <Afgangsdato>20200101</Afgangsdato>
        <HovedspecialeKode>8</HovedspecialeKode>
        <HovedspecialeTekst>Intern Medicin</HovedspecialeTekst>
        <Telefonnummer>12345678</Telefonnummer>
        <Email>test@dk.dk</Email>
        <Web>www.test.dk</Web>
        <CVR>12345678</CVR>
      </yder>
      <person>
        <CPR>1234567890</CPR>
        <Tilgangsdato>20000202</Tilgangsdato>
        <Afgangsdato>20200202</Afgangsdato>
        <PersonrolleKode>11</PersonrolleKode>
        <PersonrolleTekst>Ejer</PersonrolleTekst>
      </person>
      <person>
        <CPR>1234567891</CPR>
        <Tilgangsdato>20000202</Tilgangsdato>
        <Afgangsdato>20200202</Afgangsdato>
        <PersonrolleKode>23</PersonrolleKode>
        <PersonrolleTekst>Vikar</PersonrolleTekst>
      </person>
    </YderResponseStructure>
  </S:Body>
</S:Envelope>

I eksemplet er ydernummeret tilknyttet en praksis med to ansatte.

[1]                                          Det er forventningen, at det er i nær fremtid bliver muligt at adgangsstyre på system-niveau.

[2]                                          Servicen giver et øjebliksbillede af personens autorisationer, dvs. udløbne og fremtidige autorisationer returneres ikke.