CPR service
Indhold
- Beskrivelse
- Sikkerhed
- Erstatningscpr-numre
- WSDL
- Scenarier
- Tilgængelige metoder
- getPersonDetailsLocal
- getPersonDetailsLocals
- getPersonDetailsCentral
- getPersonDetailsCentrals
- getPersonDetailsAnywhere
- subscribePersonDetails
- unsubscribePersonDetails
- getCivilRegistrationNumbersChanged
- createSubstitutePersonDetails
- updateSubstitutePersonDetails
- getCivilRegistrationNumberSubstitutions
- civilRegistrationException
- Push CPR
Beskrivelse
Generelt indeholder regionens CPR-komponent alle CPR-numre på borgere i region Syddanmark, hvilket inkluderer de tilstødende kommuner (eks: Horsens) til region Midtjylland.
Derudover kan der forespørges på de CPR-numre som regionen har tegnet abonnement på, hvilket eksempelvis vil sige CPR-numre på de patienter udenfor regionen som har været i behandling på et af regionens sygehuse. Nedenstående scenarier beskriver, hvordan og med hvilke metoder klientsystemerne skal tilgå regionens CPR-services.
Overordnet består CPR-servicen af metoder der giver mulighed for at lave opslag, abonnement og hente ændringer på CPR information. Servicen skal også bruges når der i Region Syddanmark skal tildeles erstatnings CPR-numre.
Det er som minimum nødvendigt, at man i forespørgslen benytter et brugernavn, password som kan rekvireres ved, at forespørge regionens strategi- og udviklingsafdeling. Det er systemejer der er ansvarlig for rekvirering af username, password da systemejer har ansvaret for, at det pågældende system må forespørge på CPR-numre.
Der er en række integrationsscenarier der skal overvejes ved integration til regionens CPR-service, se integrationsscenarier.
Følgende metoder er tilgængelige:
- getPersonDetailsLocal
- getPersonDetailsLocals
- getPersonDetailsCentral
- getPersonDetailsCentrals
- getPersonDetailsAnywhere
- subscribePersonDetails
- unsubscribePersonDetails
- getCivilRegistrationNumbersChanged
- createSubstitutePersonDetails
- updateSubstitutePersonDetails
- getCivilRegistrationNumberSubstitutions
- civilRegistrationException
Sikkerhed
Brugernavn og password
Erstatningscpr-numre
Der er udarbejdet en "teknisk" model for en koordineret tildeling af erstatningscprnumre, se vedhæftet fil.
Teknisk model for tildeling af erstatningscprnumre i RSD_ver 1.0.9.doc
WSDL
Servicen benytter følgende WSDL. (Version 1.2).
En SOSI-enabled version kan hentes her. (Denne version bliver ikke længere udviklet).
 | Internet Explorer Internet Explorer gemmer filen som .xml?  FireFox gør det korrekt!   |
Integrationscenarier
Scenarie 1 og 5 beskriver en option som klientsystemet kan vælge at benytte, hvorimod det er et krav, at scenarie 2-5 implementeres. Har klientsystemet ikke mulighed for dette bedes systemejer eller leverandør kontakte regionens strategi og udviklingsafdeling.
Scenarier
Scenarie 1:
Er det første gang klientsystemet skal integrere til regionens CPR-service skal der tegnes abonnement på klientsystemet eksisterende CPR-numre. Dette gøres som et engangsudtræk fra klientsystemets CPR-database. Udtrækket afhænger lidt af antallet af CPR-numre som forefindes i klientsystemets database. Drejer det sig om et mindre antal CPR-numre (50 - 100.000) er det mere fordelagtig, at klientsystemet selv varetager denne opdatering og efterfølgende skriver abonnement, se scenarie 2. Nedenstående sekvensdiagram beskriver, hvad klientsystemet skal foretage sig i en opstarts fasen inden idriftssættelse af CPR-servicen.
Scenarie 2:
Med hensyn til den fremtidige driftssituation er det nødvendigt, at klientsystemet opdaterer systemets eget interne CPR-register. Det gøres ved, at kalde nedenstående metoder som henter de CPR-numre som klientsystemet abonnere på og hvor der er sket ændringer siden sidst (eks. personen har skiftet adresse). Opdateringssekvensen (daglig, ugentlig) kan defineres i servicens og bestemmes af klient systemet.
Ved tilføjelse af (s) i metoden er det muligt at kalde med et array (liste) på maks. 1000 CPR-numre og få en tilsvarende liste af CPR-ændringer retur. Se en detajleret beskrivelser under metoderne.
Scenarie 3:
Dette scenarie beskriver, hvordan CPR-servicen tænkes anvendt i daglig drift af klientsystemet.
Vigtigt: Klientsystemet skal først forespørge i egen CPR-database og findes CPR-nummeret ikke i klientsystemets egen database foretager klientsystemet et forespørgsel (request) til CPR-servicen og tegner abonnement på dette CPR-nummer. Har klientsystemet ikke mulighed for, at forespørge i egen database først skal udviklingssektionen i RSD kontaktes.
Når metoden getPersonDetailLocal(s) kaldes og returnere en nulværdi betyder det, at borgere bor udenfor regionen og det er derfor nødvendigt for klientsystemet at forespørge metoden getPersonDetailCentral som forespørger det centrale CPR-register og videreformidler dette CPR-nummer til klientsystemet.
Scenarie 4:
Det er klientsystemet eget ansvar, at "rydde" op og holde styr på CPR-numre i systemets egen database.
Klientsystemet har via metoderne subscribe og unsubscribe mulighed for, at markere om man ønsker at modtage ændringer eller IKKE modtage ændringer på et bestemt CPR-nummer.
Der må kun tegnes abonnemet på borgere, hvor man har en legal adkomst til at have borgeren i systemet - fx hvis personen er i behandling på en af regionens sundhedsinstitutioner, er ansat i regionen eller lignende. Hvis adkomsten til at have personen i klientsystemet ophører, skal abbonementet slettes. Det er derfor nødvendigt, at der sker en løbende oprydning og vedligeholdelse i klientsystemet, hvilket pålægges systemejer, leverandør, etc. at opretholde.
Det bemærkes, at abonnement på ajourføring af CPR-oplysninger for patienter, som har været i behandling på en af regionens sundhedsinstitutioner, må opretholdes så længe registreringer om behandlingen bevares i systemet.
Scenarie 5:
Når kliniske systemer skal integrere til regionens CPR services skal klientsystemet implementere en service så cpr ændringer kan pushe over til klientsystemet. Denne løsning foretrækkes kun ifm. kliniske systemer, hvor det er væsentligt, at klient-systemet løbende adviseres om ændringer i CPR-data (hvor periodisk opdatering initieret fra klient-systemet ikke er tilstrækkeligt - scenarie 2).
Tilgængelige metoder
GetPersonDetailsLocal
Denne metode giver mulighed for at lave CPR-forespørgsler på borgere i RSDs lokale database, som indeholder CPR-information om borgerne i RSD og de tilgrænsende kommuner samt personer der har været i kontakt med et af sygehusene i RSD.
Tekniske detaljer
Søgekriterier
| XML navn |
Beskrivelse |
|---|---|
| authentification | Brugernavn og password for adgang til servicen |
| civilRegistrationNumber |
CPR-nummeret på borgeren. Skal angives i formatet DDMMÅÅXXXX. |
| subscribe |
Angiver om man ønsker at systemet skal modtage ændringer når CPR-informationen opdateres. |
Udtræksfelter
| XML navn |
Implementeret fra version |
Beskrivelse |
Eksempel |
|---|---|---|---|
| addressInformation- ProtectionIndicator |
1.0 |
Angiver om der er adressebeskyttelse | "0" |
| cityName | 1.0 | Navnet på byen. | "Odense" |
| floor | 1.0 | Etage personen bor på | "3" |
| houseLetter | 1.0 | Husbogstav | "B" |
| houseNumber | 1.0 | Husnummer | "12" |
| municipalityCode | 1.0 | Kommunkode | "460" |
| roomNumber | Kun 1.0 (udgår) | Værelsesnummer | "2" |
| sideOrDoor | 1.1 | Side af opgangen eller nummeret på døren som personen bor på | "tv" eller "4" |
| streetName | 1.0 | Vejnavn | "Christiansgade" |
| civilRegistrationNumber | 1.0 | CPR-nummer på personen der forespørges på | "1112130PM1" |
| civilSubstitute- NumberNational |
Ikke implementeret (returnerer ikke noget) |
Det nationale erstatnings-CPR-nummer, bruges i forbindelse med erstatnings CPR-numre | "2123130349" |
| civilStatusCode | 1.1 | Civilstandskode: F - Fraskilt G - Gift U - Ugift E - Enke/enkemand P - Registreret parnterskab O - Ophævelse af registreret partnerskab L - Længstlevende D - Død 9 - Ukendt |
"F" |
| countryIdentifi- cationCode |
1.0 | Landekode (Cpr-registrets) | "5172" (Tyrkiet) |
| countryIdentifi- cationText |
1.1 | Landetekst | "Danmark" |
| parishDistrictCode | 1.1 | Sognekode | "7774" |
| parishDistrictText | 1.1 | Sognetekst | "Skt. Knuds Odense" |
| socialDistrictCode | 1.1 | Socialkode | "2" |
| socialDistrictText | 1.1 | Socialtekst | "Dalum" |
| populationDistrictCode | 1.1 | Befolkningskode | "0001" |
| populationDistrictText | 1.1 | Befolkningstekst | "Skibhus" |
| vacantDate | 1.0 udgår fra 1.2 |
Dato for personens ændring i bopæl, udrejse, død eller forsvinden NB! Fra v. 1.2 anvendes statusDate istedet |
"2007-08-13" |
| vacantCode |
1.0 udgår fra 1.2 |
Type af ændring: F - Fraflyttet U - Udrejst D - Død V - Væk (forsvundet) Fra version 1.2 anvendes statuskode istedet |
"F" |
| personGenderCode |
1.0 | Personens køn. Gyldige typer: M (mand) K (kvinde) |
"K" |
| firstName | 1.0 | Personens officielle fornavn | "Marie" |
| lastName | 1.0 | Personens officielle efternavn | "Prøveklud" |
| middleName | 1.0 | Personens officielle mellemnavn | "Else" |
| adrName | 1.1 | Adresseringsnavn (kunstnernavn) | |
| practitionerIdenti- ficationCode |
1.0 | Ydernummer på personens læge | "123456" |
| postCodeIdentifier | 1.0 | Postnummer | "5000" |
| streetNumber | 1.1 | Vejnummer i vejregistret | |
| nextOfKinCivilRegistrationNumber | 1.1 | CPRnr på den tættest knyttede slægtning | |
| regionalCode | 1.1 | Koden til regionen | "1083" |
| regionalName | 1.1 | Navnet på regionen | "Region Syddanmark" |
| birthDate | 1.1 | Dato for fødsel. Bemærk at datoen leveres i DateTime i UTC format, kompenseret for dansk tidszone. Det anbefales at "lægge to timer til" og smide tidsdelen væk, for at være sikker på få den korrekte dato. |
|
| statusCode | 1.2 | Statuskode iflg. Cprkontoret 01 = Aktiv, bopæl i dansk folkeregister 03 = Aktiv, speciel vejkode (9900 - 9999) i dansk folkeregister 05 = Aktiv, bopæl i grønlandsk folkeregister 07 = Aktiv, speciel vejkode (9900 - 9999) i grønlandsk folkeregister 20 = Inaktiv, uden bopæl i dansk/grønlandsk folkeregister men tildelt personnummer af skattehensyn (kommunekoderne 0010, 0011, 0012 og 0019) 30 = Inaktiv, annulleret personnummer 50 = Inaktiv, slettet personnummer ved dobbeltnummer 60 = Inaktiv, ændret personnummer ved ændring af fødselsdato og køn 70 = Inaktiv, forsvundet 80 = Inaktiv, udrejst 90 = Inaktiv, død |
|
| statusDate | 1.2 | Dato for sidste ændring til inaktiv status |
|
| uAddressStartDate | 1.2 | Startdato for seneste opdatering af udlandsadresse | |
| uAddressContryCode | 1.2 | Landekode for udlandsadressen [www.cpr.dk/cpr] |
"5100" Danmark |
| uAddressR1 | 1.2 | Udlandsadresse linie1 | |
| uAddressR2 | 1.2 | Udlandsadresse linie2 | |
| uAddressR3 | 1.2 | Udlandsadresse linie3 | |
| uAddressR4 | 1.2 | Udlandsadresse linie4 | |
| uAddressR5 | 1.2 | Udlandsadresse linie5 | |
| contactAddressStartDate | 1.2 | Startdato for seneste opdatering af kontaktadresse | |
| contactAddressR1 | 1.2 | Kontaktadresse linie1 | |
| contactAddressR2 | 1.2 | Kontaktadresse linie2 | |
| contactAddressR3 | 1.2 | Kontaktadresse linie3 | |
| contactAddressR4 | 1.2 | Kontaktadresse linie4 | |
| contactAddressR5 | 1.2 | Kontaktadresse linie5 | |
| addrCOname | 1.2 | C/O adresse | |
| adrTilflytDato | 1.2 | Tilflytningsdato for seneste adresseændring | |
| adrTilflytKommuneDato | 1.2 | Tilflytningsdato for seneste flytning til gældende kommune | |
| personIdentifierSpouse | 1.2 | Henvisningscprnummer til ægtefælle | |
| personIdentifierMother | 1.2 | Henvisningscprnummer til moder | |
| personIdentifierFather | 1.2 | Henvisningscprnummer til fader | |
| addressProtectionSurveys | 1.2 | Forskerbeskyttelse. Borgeren har frabedt sig deltagelse i videnskabelige undersøgelser. |
|
| lastUpdated | 1.2 | Dato for seneste opdatering af cpr-data | "2007-08-13" |
GetPersonDetailsLocals
Samme metode som getPersonDetailsLocal med den forskel at der returneres en liste af personoplysninger og at der ikke kan tegnes abonnement.
Tekniske detaljer
Søgekriterier
| XML navn |
Beskrivelse |
|---|---|
| authentification | Brugernavn og password for adgang til servicen |
| civilRegistrationNumbers |
Liste af CPR-nummere på borgerene. Skal angives i formatet DDMMÅÅXXXX. |
Udtræksfelter
Returnerer en liste af PersonDetails som beskrevet i getPersonDetailsLocal.
GetPersonDetailsCentral
Denne metode giver mulighed for at lave CPR-forespørgsler på borgere i det landsdækkende CPR-register. Metoden bruges typisk, hvis personen ikke kunne findes med getPersonDetailsLocal.
Tekniske detaljer
Søgekriterier
| XML navn | Beskrivelse |
|---|---|
| authentification | Brugernavn og password for adgang til servicen |
| civilRegistrationNumber | CPR-nummeret på borgeren. Skal angives i formatet DDMMÅÅXXXX. |
| subscribe | Hvis værdien sættes true kopieres oplysningerne fra det centrale CPR-register til den lokale database og fremtidige ændringer vil blive videregivet til det forespørgende system |
Udtræksfelter
| XML navn |
Implementeret fra version |
Beskrivelse |
Eksempel |
|---|---|---|---|
| addressInformation- ProtectionIndicator |
1.0 |
Angiver om der er adressebeskyttelse | "0" |
| cityName | 1.0 | Navnet på byen. | "Odense" |
| floor | 1.0 | Etage personen bor på | "3" |
| houseLetter | 1.0 | Husbogstav | "B" |
| houseNumber | 1.0 | Husnummer | "12" |
| municipalityCode | 1.0 | Kommunkode | "460" |
| roomNumber | Kun 1.0 (udgår) | Værelsesnummer | "2" |
| sideOrDoor | 1.1 | Side af opgangen eller nummeret på døren som personen bor på | "tv" eller "4" |
| streetName | 1.0 | Vejnavn | "Christiansgade" |
| civilRegistrationNumber | 1.0 | CPR-nummer på personen der forespørges på | "1112130PM1" |
| civilSubstitute- NumberNational |
Ikke implementeret (returnerer ikke noget) |
Det nationale erstatnings-CPR-nummer, bruges i forbindelse med erstatnings CPR-numre | "2123130349" |
| civilStatusCode | 1.1 | Civilstandskode: F - Fraskilt G - Gift U - Ugift E - Enke/enkemand P - Registreret parnterskab O - Ophævelse af registreret partnerskab L - Længstlevende D - Død 9 - Ukendt |
"F" |
| countryIdentifi- cationCode |
1.0 | Landekode (Cpr-registrets) | "5172" (Tyrkiet) |
| countryIdentifi- cationText |
1.1 | Landetekst | "Danmark" |
| parishDistrictCode | 1.1 | Sognekode | "7774" |
| parishDistrictText | 1.1 | Sognetekst | "Skt. Knuds Odense" |
| socialDistrictCode | 1.1 | Socialkode | "2" |
| socialDistrictText | 1.1 | Socialtekst | "Dalum" |
| populationDistrictCode | 1.1 | Befolkningskode | "0001" |
| populationDistrictText | 1.1 | Befolkningstekst | "Skibhus" |
| vacantDate | 1.0 udgår fra 1.2 |
Dato for personens ændring i bopæl, udrejse, død eller forsvinden NB! Fra v. 1.2 anvendes statusDate istedet |
"2007-08-13" |
| vacantCode |
1.0 udgår fra 1.2 |
Type af ændring: F - Fraflyttet U - Udrejst D - Død V - Væk (forsvundet) Fra version 1.2 anvendes statuskode istedet |
"F" |
| personGenderCode |
1.0 | Personens køn. Gyldige typer: M (mand) K (kvinde) |
"K" |
| firstName | 1.0 | Personens officielle fornavn | "Marie" |
| lastName | 1.0 | Personens officielle efternavn | "Prøveklud" |
| middleName | 1.0 | Personens officielle mellemnavn | "Else" |
| adrName | 1.1 | Adresseringsnavn (kunstnernavn) | |
| practitionerIdenti- ficationCode |
1.0 | Ydernummer på personens læge | "123456" |
| postCodeIdentifier | 1.0 | Postnummer | "5000" |
| streetNumber | 1.1 | Vejnummer i vejregistret | |
| nextOfKinCivilRegistrationNumber | 1.1 | CPRnr på den tættest knyttede slægtning | |
| regionalCode | 1.1 | Koden til regionen | "1083" |
| regionalName | 1.1 | Navnet på regionen | "Region Syddanmark" |
| birthDate | 1.1 | Dato for fødsel. Bemærk at datoen leveres i DateTime i UTC format, kompenseret for dansk tidszone. Det anbefales at "lægge to timer til" og smide tidsdelen væk, for at være sikker på få den korrekte dato. |
|
| statusCode | 1.2 | Statuskode iflg. Cprkontoret 01 = Aktiv, bopæl i dansk folkeregister 03 = Aktiv, speciel vejkode (9900 - 9999) i dansk folkeregister 05 = Aktiv, bopæl i grønlandsk folkeregister 07 = Aktiv, speciel vejkode (9900 - 9999) i grønlandsk folkeregister 20 = Inaktiv, uden bopæl i dansk/grønlandsk folkeregister men tildelt personnummer af skattehensyn (kommunekoderne 0010, 0011, 0012 og 0019) 30 = Inaktiv, annulleret personnummer 50 = Inaktiv, slettet personnummer ved dobbeltnummer 60 = Inaktiv, ændret personnummer ved ændring af fødselsdato og køn 70 = Inaktiv, forsvundet 80 = Inaktiv, udrejst 90 = Inaktiv, død |
|
| statusDate | 1.2 | Dato for sidste ændring til inaktiv status |
|
| uAddressStartDate | 1.2 | Startdato for seneste opdatering af udlandsadresse | |
| uAddressContryCode | 1.2 | Landekode for udlandsadressen [www.cpr.dk/cpr] |
"5100" Danmark |
| uAddressR1 | 1.2 | Udlandsadresse linie1 | |
| uAddressR2 | 1.2 | Udlandsadresse linie2 | |
| uAddressR3 | 1.2 | Udlandsadresse linie3 | |
| uAddressR4 | 1.2 | Udlandsadresse linie4 | |
| uAddressR5 | 1.2 | Udlandsadresse linie5 | |
| contactAddressStartDate | 1.2 | Startdato for seneste opdatering af kontaktadresse | |
| contactAddressR1 | 1.2 | Kontaktadresse linie1 | |
| contactAddressR2 | 1.2 | Kontaktadresse linie2 | |
| contactAddressR3 | 1.2 | Kontaktadresse linie3 | |
| contactAddressR4 | 1.2 | Kontaktadresse linie4 | |
| contactAddressR5 | 1.2 | Kontaktadresse linie5 | |
| addrCOname | 1.2 | C/O adresse | |
| adrTilflytDato | 1.2 | Tilflytningsdato for seneste adresseændring | |
| adrTilflytKommuneDato | 1.2 | Tilflytningsdato for seneste flytning til gældende kommune | |
| personIdentifierSpouse | 1.2 | Henvisningscprnummer til ægtefælle | |
| personIdentifierMother | 1.2 | Henvisningscprnummer til moder | |
| personIdentifierFather | 1.2 | Henvisningscprnummer til fader | |
| addressProtectionSurveys | 1.2 | Forskerbeskyttelse. Borgeren har frabedt sig deltagelse i videnskabelige undersøgelser. |
|
| lastUpdated | 1.2 | Dato for seneste opdatering af cpr-data | "2007-08-13" |
GetPersonDetailCentrals
Samme metode som getPersonDetailsCentral med den forskel at der returneres en liste af personoplysninger og at der ikke kan tegnes abonnement.
Tekniske detaljer
Søgekriterier
| XML navn |
Beskrivelse |
|---|---|
| authentification | Brugernavn og password for adgang til servicen |
| civilRegistrationNumbers |
Liste af CPR-nummere på borgerene. Skal angives i formatet DDMMÅÅXXXX. |
Udtræksfelter
Returnerer en liste af PersonDetails som beskrevet i getPersonDetailsCentral.
GetPersonDetailsAnywhere
Metoden kan bruges af systemer som ikke kan spørge på enten local eller central oplysninger. Her er funktionerne samlet i et kald, hvor der først spørges med local funktionen, og herefter central funktionen hvis local forespørgslen ikke returnerede nogen oplysninger. Se getPersonDetailsLocal og getPersonDetailsCentralfor flere oplysninger.
Tekniske detaljer
Søgekriterier
| XML navn |
Beskrivelse |
|---|---|
| authentification | Brugernavn og password for adgang til servicen |
| civilRegistrationNumber |
CPR-nummeret på borgeren. Skal angives i formatet DDMMÅÅXXXX. |
| subscribe |
Angiver om man ønsker at systemet skal modtage ændringer når CPR-informationen opdateres. |
Udtræksfelter
Returnerer PersonDetails som beskrevet i getPersonDetailsLocal eller getPersonDetailsCentral.
SubscribePersonDetails
Denne metode giver mulighed for at markere at man ønsker at modtage ændringer på en person i den lokale CPR-database.
Tekniske detaljer
Søgekriterier
| XML navn | Beskrivelse |
|---|---|
| authentification | Brugernavn og password for adgang til servicen |
| civilRegistrationNumber | CPR-nummeret på borgeren. Skal angives i formatet DDMMÅÅXXXX. |
Udtræksfelter
Ingen.
I tilfælde af fejl kastes der en civilRegistrationException
UnsubscribePersonDetails
Denne metode giver mulighed for at markere at man IKKE længere ønsker at modtage ændringer på en person i den lokale CPR-database.
Tekniske detaljer
Søgekriterier
| XML navn | Beskrivelse |
|---|---|
| authentification | Brugernavn og password for adgang til servicen |
| civilRegistrationNumber | CPR-nummeret på borgeren. Skal angives i formatet DDMMÅÅXXXX. |
Udtræksfelter
Ingen.
I tilfælde af fejl kastes der en civilRegistrationException
GetCivilRegistrationNumbersChanged
Metoden giver mulighed for at spørge på ændringer i CPR-information indenfor en given tidsperiode for et bestemt system.
Tekniske detaljer
Søgekriterier
| XML navn |
Beskrivelse |
|---|---|
| authentification | Brugernavn og password for adgang til servicen |
| from | Fra og med den dato, hvor der skal tjekkes for ændringer |
| to | Til den dato, hvor der skal tjekkes for ændringer |
Udtræksfelter
Returnerer en liste af CPR-numre på de personer, hvor der optræder ændringer.
BEMÆRK: Datoen for seneste ændring, der skal ligge mellem 'from' og 'to'. Metoden returnerer ikke cpr-numre, der er ændret efter 'to' datoen, selv om også er ændret på et tidspunkt mellem 'from' og 'to'.
I tilfælde af fejl kastes der en civilRegistrationException
CreateSubstitutePersonDetails
Metoden giver mulighed for at oprette en person med et erstatningscprnr.
Tekniske detaljer
Søgekriterier
Erstatningscprnummeret genereres automatisk ud fra følgende kriterier:
1) fødselsdato
2) køn
3) forbogstaver (fornavn og efternavn) anvendes på 8. og 9. position.
4) Erstatningsnummer efter 1-3 skal være ledigt (dvs. ikke tidligere tildelt)
5) hvis 4 ikke kan opfyldes skiftes bostav på 9. position til næste ledige.
| XML-navn | Beskrivelse | Obligatorisk |
|---|---|---|
| authentification | Brugernavn og password for adgang til servicen | ja |
| substitutePersonDetails | Indeholder informationer til brug ved oprettelse af person med erstatningscprnr. Se nedenunder: | ja |
| birthDate | Fødselsdato for person | ja |
| personGenderCode | Personens køn. Gyldige typer: M (mand) K (kvinde) |
ja |
| firstName | Fornavn | nej |
| middleName | Mellemnavn | nej |
| lastName | Efternavn | nej |
| adrName | Adresseringsnavn | ja |
| practitionerIdenti- ficationCode |
Ydernummer på egen læge | nej |
| streetNumber | Vejnummer i vejregistret | nej |
| houseNumber | Husnummer | nej |
| houseLetter | Husbogstav | nej |
| floor | Etage | nej |
| sideOrDoor | Side af opgangen eller nummeret på døren som personen bor på. Fx. "th" eller "4". |
nej |
| municipalityCode | Kommunekode | nej |
| civilStatusCode | Civilstandskode: F - Fraskilt G - Gift U - Ugift E - Enke 9 - Ukendt |
nej |
| civilSubstitute- NumberNational |
Hvis nationalt erstatningscprnummer kendes ved oprettelsen angives dette; eller tildeles dette efterfølgende | nej |
| uAddressStartDate | Startdato for seneste opdatering af udlandsadresse (format yyyy-mm-dd) | nej |
| uAddressCountryCode | Landekode for udlandsadressen | nej |
| uAddressR1 | Udlandsadresse linje 1 | nej |
| uAddressR2 | Udlandsadresse linje 2 | nej |
| uAddressR3 | Udlandsadresse linje 3 | nej |
| uAddressR4 | Udlandsadresse linje 4 | nej |
| uAddressR5 | Udlandsadresse linje 5 | nej |
| contactAddressStartDate | Startdato for seneste opdatering af kontaktadresse (format yyyy-mm-dd) | nej |
| contactAddressR1 | Kontaktadresse linje 1 | nej |
| contactAddressR2 | Kontaktadresse linje 2 | nej |
| contactAddressR3 | Kontaktadresse linje 3 | nej |
| contactAddressR4 | Kontaktadresse linje 4 | nej |
| contactAddressR5 | Kontaktadresse linje 5 | nej |
Udtræksfelter
Returnerer det tildelte erstatningscprnummer.
I tilfælde af fejl smides der en civilRegistrationException
UpdateSubstitutePersonDetails
Metoden giver mulighed for at opdatere en person med et erstatningscprnr.
Tekniske detaljer
Søgekriterier
| XML-navn | Beskrivelse | Obligatorisk |
|---|---|---|
| authentification | Brugernavn og password for adgang til servicen | ja |
| substitutePersonDetails | Indeholder informationer til brug ved opdatering af person med erstatningscprnr. Se nedenunder: | ja |
| civilSubstituteNumber | Det tidligere tildelte erstatningscprnummer | ja |
| personGenderCode | Personens køn. Gyldige typer: M (mand) K (kvinde) |
ja |
| firstName | Fornavn | nej |
| middleName | Mellemnavn | nej |
| lastName | Efternavn | nej |
| adrName | Adresseringsnavn | ja |
| practitionerIdenti- ficationCode |
Ydernummer på egen læge | nej |
| streetNumber | Vejnummer i vejregistret | nej |
| houseNumber | Husnummer | nej |
| houseLetter | Husbogstav | nej |
| floor | Etage | nej |
| sideOrDoor | Side af opgangen eller nummeret på døren, som personen bor på. Fx. "th" eller "4". |
nej |
| municipalityCode | Kommunekode | nej |
| civilStatusCode | Civilstandskode: F - Fraskilt G - Gift U - Ugift E - Enke 9 - Ukendt |
nej |
| civilSubstitute- NumberNational |
Nationalt erstatningscprnummer hvis dette er tildelt | nej |
| uAddressStartDate | Startdato for seneste opdatering af udlandsadresse (format yyyy-mm-dd) | nej |
| uAddressCountryCode | Landekode for udlandsadressen | nej |
| uAddressR1 | Udlandsadresse linje 1 | nej |
| uAddressR2 | Udlandsadresse linje 2 | nej |
| uAddressR3 | Udlandsadresse linje 3 | nej |
| uAddressR4 | Udlandsadresse linje 4 | nej |
| uAddressR5 | Udlandsadresse linje 5 | nej |
| contactAddressStartDate | Startdato for seneste opdatering af kontaktadresse (format yyyy-mm-dd) | nej |
| contactAddressR1 | Kontaktadresse linje 1 | nej |
| contactAddressR2 | Kontaktadresse linje 2 | nej |
| contactAddressR3 | Kontaktadresse linje 3 | nej |
| contactAddressR4 | Kontaktadresse linje 4 | nej |
| contactAddressR5 | Kontaktadresse linje 5 | nej |
Udtræksfelter
Ingen
I tilfælde af fejl smides der en civilRegistrationException
GetCivilRegistrationNumberSubstitutions
Ikke implementeret
Metoden giver mulighed for at spørge på skift af cprnr indenfor en given tidsperiode for et bestemt system.
Tekniske detaljer
Søgekriterier
| XML navn |
Beskrivelse |
|---|---|
| authentification | Brugernavn og password for adgang til servicen |
| system |
Systemnavnet på det system der abonnerer på ændringer. |
| from | Fra og med den dato, hvor der skal tjekkes for ændringer |
| to | Til den dato, hvor der skal tjekkes for ændringer |
Udtræksfelter
Returnerer en liste af CPR-numre (oprindeligt cprnr og nyt cprnummer) som er skiftet i den angivne tidsperiode, som det pågældende system har abonnement på.
CivilRegistrationException
Kastes af de beskrevne metoder i tilfælde af fejl.
Tekniske detaljer
Udtræksfelter
| XML navn | Beskrivelse |
|---|---|
| errorCode | Angiver fejlkoden |
| errorDescription | Angiver en kort beskrivelse af fejlen |
Fejlkoder
| Kode | Besked | Beskrivelse |
|---|---|---|
| 1 | An internal error occurred. | Ved fejl internt i cpr-servicen. |
| 2 | CPR-nr not found. | Hvis cpr-nummer ikke findes. |
| 3 | Credentials for the system not found. | Hvis der sendes et ukendt bruger-id. |
| 4 | Authentification failed. | Hvis der ikke kunne logges ind. |
| 5 | Authorisation failed. | Hvis der er kaldt en service, der ikke er adgang til. |
| 6 | Unknown error. | Bruges ikke pt. |
| 7 | An error occurred accessing the central CPR-register. | Hvis der opstår fejl under opslag i det centrale cpr-register. |
| 8 | CPR-nr is invalid. | Hvis cpr-nummer er null eller har en længde forskellig fra 10. |
| 9 | Unkown method call. | Bruges ikke pt. |
| 10 | Method not implemented yet. | Ved kald af servicen getCivilRegistrationNumberSubstitutions. |
| 11 | The ID-Card could not be reckognized as a 'user ID-Card'. | Bruges ikke pt. |
| 12 | Too much data, please request less or narrow search. | Hvis der ud fra en søgning er fundet flere end 1000 personer. |
| 13 | Use local lookup when data is available locally. | Ved forsøg på opslag i det centrale cpr-register, når data haves lokalt. |
| 14 | Subscription exists. | Ved forsøg på tegning af abonnement, som allerede findes. |
| 15 | Authentification not found. | Anvendes kun ved SOSI authentication. |
| 16 | Wrong value. | Bruges ikke pt. |
Push CPR
Andre systemer, som ønsker at modtage CPR-opdateringer, kan selv udstille en service til dette.
Her er et udkast til en WSDL, som kan anvendes. Den anvendte opbygning er ikke et krav, når blot XSD-elementerne overholdes.
WSDL'en udstiller en service til opdatering af cpr-oplysninger, som benytter brugernavn/password til autentificering. Denne indeholder en række inputfelter, som svarer til felterne i GetPersonDetailsLocal. Desuden udstiller den en anden service til skift af cpr-nummer. Denne har som input det oprindelige cpr-nummer samt det nye.
Begge services har ingen returværdier, men kaster en exception i tilfælde af fejl.