OIOXML dokumentationsguide Person

Transkript

1 OIOXML dokumentationsguide Person OIOXML dokumentationsguide Person

2 . Ejerskab Indenrigs og Sundhedsministeriets CPR-kontor i medfør af Bekendtgørelse af lov om Det Centrale Personregister, jf. lov nr. 426 af 3. maj 2000, med de ændringer, der følger af 6 i lov nr. 409 af 6. juni 2002, lov nr. 379 af 28. maj 2003 og lov nr. 68 af 4. februar Interessenter og høringsparter Kernekomponenterne har relevans for samtlige offentlige myndigheder og deres itleverandører, idet CPR's persondata anvendes i stort set hele den offentlige forvaltning. Den offentlige forvaltning må endvidere i de kommende år antages at tage webservices i OIOXML i anvendelse i større elle mindre omfang. 2. Relevans Kernekomponenten CPRStamPerson tager udgangspunkt i CPR s Person begrænsede stamoplysninger. 3. Konceptuel model Figuren nedenfor illustrerer den konceptuelle model for person-klasserne. Klasserne er opdelt i en række komplekse typer markeret med hvidt og en række simple typer markeret med gråt. Den komplekse type PersonNavn skal anvendes af virksomheder som refererer til en person uden brug af personnummer. Den komplekse type CPRSimpelPerson skal anvendes af myndigheder som refererer til en person med personnummer. Den komplekse type CPRStamPerson repræsenterer et udtræk fra CPR-registeret, som ofte anvendes af myndigheder. Ud over navn og personnummer indeholder CPRStamPerson information om køn, fødselsdato, fødselsdatousikkerhed (om fødselsdatoen kan verificeres), CPRStatus (er personen død, udrejst, forsvundet etc.), navneadressebeskyttelse (om personens navn og adresse må videregives) og adresseringsnavn (en navneforkortelse anvendt ved adressering). PersonNavn -fornavn -mellemnavn -efternavn CPRSimpelPerson -personnummer Statsborgerskab CivilStatus NavneAdresseBeskyttet Titulering CPRStamPerson {documentation = fra cpr's begrænsede stamoplysninger} -køn -fødselsdag -fødselsdagsusikkerhed -CPRStatus -CPRStatusDato -NavneOgAdresseBeskyttelse -AdresseringsNavn KaldeNavn AdresseringsNavn MarkedsføringsBeskyttet Køn Fødselsdag OIOXML dokumentationsguide Person 2

3 De simple typer markeret med gråt er medtaget for at muliggøre udvikling af specialudviklede persontyper. Behovet for udveksling af personrelateret data er mangfoldigt. At standardisere denne mangfoldighed eller begrænse organisationer ved at kræve anvendelse af bestemte OIOXML typer vil ikke være formålstjenligt. Der lægges i stedet op til at standardisere en række generiske typer (basale byggeklodser), som organisationer kan anvende direkte eller bygge videre på. De simple typer markeret med gråt repræsenterer typer som de komplekse typer kan udbygges med efter behov. Det skal dog i den forbindelse fremhæves at man altid bør anvende de standardiserede typer og kun ty til egenudvikling, hvis det udtømmende kan godtgøres at de standardiserede typer er utilstrækkelige. Nedenfor ses to eksempler på konstruktioner af specialudviklede typer på baggrund af de komplekse og simple typer. Det skal fremhæves at nedenstående kun er eksempler, der ikke har hold i virkelige behov og anvendelser. CPRSimpelPerson CPRSimpelPerson Køn CivilStatus MinSpeciellePersonAnvendelse CivilStatus Barn Voksen -ForældreMyndighed : Boolean Værge Statsborgerskab 0..2 Køn 0.. ForældreMyndighedsOplysninger Første eksempel viser den specialudviklede type kaldet MinSpeciellePersonAnvendelse, som bygger på CPRSimpelPerson med tilføjelse af Køn, CivilStatus og Statsborgerskab. Andet eksempel viser de specialudviklede typer Barn, Voksen, Værge og ForældreMyndighedsOplysninger samt deres interne relation. 4. Logisk model Figuren nedenfor viser den logiske model for person-klasserne. De primære komplekse typer er PersonNameStructure, SimpleCPRPerson og RegularCPRPerson. OIOXML dokumentationsguide Person 3

4 SimpleCPRPerson -PersonCivilRegistrationIdentifier : PersonCivilRegistrationIdentifierType PersonNameStructure -PersonGivenName[] : PersonGivenNameType -PersonMiddleName[0..] : PersonMiddleNameType -PersonSurnameName[] : PersonSurnameNameType RegularCPRPerson -PersonNameForAddressingName : PersonNameForAddressingNameType -PersonGenderCode : PersonGenderCodeType -PersonInformationProtectionIndicator : boolean -PersonBirthDateStructure : PersonBirthDateStructureType -PersonCivilRegistrationStatusStructure : PersonCivilRegistrationStatusStructureType PersonBirthDateStructure -BirthDate : date -BirthDateUncertaintyIndicator : boolean PersonCivilRegistrationStatusStructure -PersonCivilRegistrationStatusCode : PersonCivilRegistrationStatusCodeType -PersonCivilRegistrationStatusStartDate : date I tabellen nedenfor beskrives de tre klasser og sammenholdes med klasserne i den konceptuelle model. De komplekse person typer Navn på klasse Formål Anvendelse PersonNameStructure PersonNavn SimpleCPRPerson CPRSimpelPerson RegularCPRPerson StamPerson Angivelse af en persons fulde navn, dvs. fornavn(e), mellemnavn(e) og efternavn(e). Entydig identifikation af en person ved navn og personnummer. Basisinformationer på en person foruden entydig identifikation ved navn og personnummer. Anvendes til at identificere en person ved navn. Anvendes primært af virksomheder som ikke kender til og må anvende en persons personnummer. Anvendes til at identificere en person ved navn og personnummer. Anvendes primært af offentlige organisationer som ofter kender og gerne må anvende personnummer. Anvendes primært som det basale informationsgrundlag ved sagsbehandling eller udveksling af personoplysninger mellem parter med en berettiget interesse heri. OIOXML dokumentationsguide Person 4

5 I tabellen nedenfor beskrives de simple person typer, som anvendes fra de komplekse personklasser. Element navn PersonNameFor- AdressingName PersonGivenName PersonMiddleName PersonSurnameName PersonInformation- ProctectionIndicator BirthDate NavneAdresseBeskyttelse Markering der viser om personen har navne- /adressebeskyttelse Fødselsdato Personens fødselsdato Fødselsdatousikkerhed Angiver at fødselsdatoen er usikker, hvilket vil sige, at det ikke har været muligt af verificere datoens korrekthed. Køn Angiver personens køn. BirthDateUncertainty- Indicator PersonGenderCode Dansk label og definition AdresseringsNavn Adresseringsnavn anvendes af offentlige myndigheder og andre til forsendelse. Fornavn En persons fornavn(e) Mellemnavn En persons mellemnavn(e) Efternavn En persons efternavn(e) Eksempel Bemærkning H.C. Andersen Adresseringsnavn kan være udfyldt med andre navnedele end de, der findes for personen i felterne FORNAVN, MELLEMNAVN og EFTERNAVN. Efternavn og mindst et fornavn, eventuelt i forkortet form, skal dog indgå i feltet. Udvidet tegnsæt.. position i feltet eller. tegn efter komma skal være alfabetisk. Resten alfanumerisk samt bindestreg(-), apostrof('), skråstreg(/), parentes ( () ), ampersand (&), punktum (.) samt komma (,). Feltet kan er blankt for unavngivne personer. Komma forekommer som adskillelse mellem efternavn(e) og fornavne(e), og må kun forekomme en gang. Der anvendes ikke punktum efter forkortede navndedele. Hans Christian PersonGivenName indeholder alle personens fornavne. Måløv PersonMiddleName indeholder alle personens mellemnavne Andersen PersonSurnameName indeholder alle personens efternavne 0 Boolsk værdi som markerer sand eller falsk Boolsk værdi som markerer sand eller falsk male male, female eller unspecified OIOXML dokumentationsguide Person 5

6 Element navn PersonCivilRegistration- Identifier PersonCivilRegistration- StatusCode Dansk label og definition Personnummer En persons personnummer i henhold til bekendtgørelse af lov om Det Centrale Personregister, jf. lov nr. 426 af 3. maj 2000, med de ændringer, der følger af 6 i lov nr. 409 af 6. juni 2002, lov nr. 379 af 28. maj 2003 og lov nr. 68 af 4. februar Statuskode Statuskoden angiver om et personnummer (person) er aktiv eller inaktiv, samt andre oplysninger - se værdimængde. Eksempel Bemærkning Vær opmærksom på, at personnummerets 0. ciffer i dag fungerer som et kontrolciffer. Det må imidlertid forventes, at der inden for en kortere tidshorisont vil blive tildelt 0-cifrede personnumre uden det sædvanlige kontrolciffer. Derfor er det mest hensigtsmæssigt at udelade modulus kontrollen i IT-systemer. 90 0: Registreret med bopæl i dansk folkeregister 03: Registreret med høj vejkode ( ) i dansk folkeregister 05: Registreret med bopæl i grønlandsk folkeregister 07: Registreret med høj vejkode ( ) i grønlandsk folkeregister 20: Registreret uden bopæl i dansk/grønlandsk folkeregister - samt administrative personnumre 30: Annulleret personnummer 50: Slettet personnummer 60: Ændret personnummer 70: Forsvundet 80: Udrejst PersonCivilRegistration- StatusStartDate Statusdato Startdato for status : Død (død eller død som udrejst eller forsvundet) OIOXML dokumentationsguide Person 6

7 Som beskrevet i forbindelse med den konceptuelle model er der medtaget en række simple typer for at muliggøre udvikling af specialudviklede persontyper. Den logiske model for de mest relevante udvidelsestyper ses nedenfor. PersonInformationProtectionIndicator -PersonInformationProtectionIndicator : boolean PersonNationalityCode -PersonNationalityCode : CountryIdentificationCodeType MarketingProtectionIndicator -MarketingProtectionIndicator : boolean PersonShortName -PersonShortName : string BirthDate -BirthDate : date MaritalStatusCode -MaritalStatusCode : MaritalStatusCodeType PersonGenderCode -PersonGenderCode : PersonGenderCodeType PersonNameForAddressingName -PersonNameForAddressingName : PersonNameForAddressingNameType PersonNamePrefixIdentifier -PersonNamePrefixIdentifier : PersonNamePrefixIdentifierType En del af ovenstående typer er allerede beskrevet og de resterende beskrives i tabellen nedenfor. Element navn Dansk label og definition Eksempel Bemærkning MaritalStatusCode CivilStatus married Den fulde liste af tilladte værdier er: married, divorced, widow, registered partnership, abolition of registered partnership, longest living partner, deceased, unmarried. MarketingBeskyttelse 0 Boolsk værdi som markerer sand eller falsk Titel Hr Hr, Fru, doktor, civilingeniør. Statsborgerskab Det land en person har statsborgerskab. MarketingProtection- Indicator PersonNamePrefix- Identifier PersonNationalityCode Landeidentifikations kode - 2 eller 3 karakterer eller 3 cifre - som beskrevet i ISO 366 standarden eller 4 cifre som beskrevet i MyndighedsKode fra Det Centrale Personregister. Ex. 'DK', 'DNK', '208' er koderne for Danmark i ISO 366 standarden og '500' er koden for Danmark i MyndighedsKode fra Det Centrale Personregister I tilfælde af dobbelt statborgerret bliver der registreret den foretrukne statsborgerret. I CPR er der altid kun én statsborgerret registreret, men med historik, hvis en sådan eksisterer. Såfremt dansk statsborgerret er den ene mulighed, vil det altid være dansk statsborgerret, der er registreret pga. udsendelse af valgkort etc. OIOXML dokumentationsguide Person 7

8 Element navn Dansk label og definition Eksempel Bemærkning PersonShortName Kaldenavn Til angivelse af et andet navn end personens officielt registrerede navn. John Faxe Jensen PersonNameStructure (PersonNavn) Formål Angivelse af en persons fulde navn. Baggrund Anvendelse Indhold Registreringen af en persons fulde navn sker i henhold til bekendtgørelse af lov om Det Centrale Personregister, jf. lov nr. 426 af 3. maj 2000, med de ændringer, der følger af 6 i lov nr. 409 af 6. juni 2002, lov nr. 379 af 28. maj 2003 og lov nr. 68 af 4. februar Ved sikker identifikation og udveksling af en persons fulde navn, hvor der ikke er behov eller hjemmel til anvendelse af personnummer. En persons fornavn(e), eventuelle mellemnavn(e) og efternavn(e) Nødvendige elementer er angivet med fed skrift. Bemærk, at mellemnavn(e) skal angives, og kun må udelades hvis personen ikke har mellemnavn(e). PersonNameStructure Min Max Dansk Label Eksempel PersonGivenName Fornavn Anne Marie PersonMiddleName 0 Mellemnavn Munch PersenSurnameName Efternavn Hansen Eksempel på XML-struktur med de nødvendige hhv. med alle delelementer (uden angivelse af namespace tilhørsforhold) <PersonGivenName>Michael</PersonGivenName> <PersonGivenName>Anne Marie</PersonGivenName> <PersonMiddleName>Munch</PersonMiddleName> SimpleCPRPerson (CPRSimpelPerson) Formål Angivele af en persons fulde navn samt personnummer. Hermed sker der en entydig identifikation af personen OIOXML dokumentationsguide Person 8

9 Baggrund Anvendelse Indhold Registreringen af en persons fulde navn samt personnummer sker i henhold til bekendtgørelse af lov om Det Centrale Personregister, jf. lov nr. 426 af 3. maj 2000, med de ændringer, der følger af 6 i lov nr. 409 af 6. juni 2002, lov nr. 379 af 28. maj 2003 og lov nr. 68 af 4. februar Ved sikker identifikation og udveksling af en persons fulde navn samt personnummer, hvor der er behov og/eller hjemmel til anvendelse af personnummer. En persons fornavn(e), eventuelle mellemnavn(e), efternavn(e) og personnummer. Nødvendige elementer er angivet med fed skrift. Bemærk, at mellemnavn(e) skal angives, og kun må udelades hvis personen ikke har mellemnavn(e). SimpleCPRPerson Min Max Dansk Label Eksempel PersonNameStructure - PersonGivenName Fornavn Anne Marie - PersonMiddleName 0 Mellemnavn Munch - PersenSurnameName Efternavn Hansen PersonCivilRegistrationIdentifier Personnummer Eksempel på XML-struktur med de nødvendige hhv. med alle delelementer (uden angivelse af namespace tilhørsforhold) <SimpleCPRPerson> <PersonGivenName>Michael</PersonGivenName> <PersonCivilRegistrationIdentifier> </PersonCivilRegistrationIdentifier> </SimpleCPRPerson> <SimpleCPRPerson> <PersonGivenName>Anne Marie</PersonGivenName> <PersonMiddleName>Munch</PersonMiddleName> <PersonCivilRegistrationIdentifier> </PersonCivilRegistrationIdentifier> </SimpleCPRPerson> RegularCPRPerson(CPRStamPerson) Formål Baggrund Anvendelse Angivele af basisinformationer om en person foruden entydig identifikation ved navn og personnummer. Registreringen af en persons stamoplysninger sker i henhold til bekendtgørelse af lov om Det Centrale Personregister, jf. lov nr. 426 af 3. maj 2000, med de ændringer, der følger af 6 i lov nr. 409 af 6. juni 2002, lov nr. 379 af 28. maj 2003 og lov nr. 68 af 4. februar Anvendes primært som det basale informationsgrundlag ved sagsbehandling eller udveksling af personoplysninger mellem parter med en berettiget interesse heri. OIOXML dokumentationsguide Person 9

10 Indhold Fornavn(e), Mellemnavn(e), Efternavn(e), Personnummer, Adresseringsnavn, Køn, Navne- og adressebeskyttelse, Fødselsdag, Fødselsdagsusikkerhed, Statuskode, Statusdato. Nødvendige elementer er angivet med fed skrift. Bemærk, at mellemnavnet skal angives, og kun må udelades hvis personen ikke har et mellemnavn RegularCPRPerson Min Max Dansk Label Eksempel PersonNameStructure - PersonGivenName Fornavn Anne Marie - PersonMiddleName 0 Mellemnavn Munch (Mellemnavn(e) skal angives, hvis de(t) eksisterer) - PersenSurnameName Efternavn Hansen PersonCivilRegistrationIdentifier Personnummer PersonNameForAddressingName Adresseringsnavn Anne Marie M. Hansen PersonGenderCode Køn Female PersonInformationProtection- Navne- og adressebeskyttelse Indicator 0 PersonBirthDateStructure - BirthDate Fødselsdag BirthDateUncertaintyIndicator Fødselsdagsusikkerhed 0 PersonCivilRegistrationStatus- Structure - PersonCivilRegistrationStatusCode Statuskode 0 - PersonCivilRegistrationStatusStart~ Date Statusdato Eksempel på XML-struktur med de nødvendige hhv. med alle delelementer (uden angivelse af namespace tilhørsforhold) <RegularCPRPerson> <PersonGivenName>Michael</PersonGivenName> <PersonCivilRegistrationIdentifier> </PersonCivilRegistrationIdentifier> <PersonNameForAddressingName>Michael Hansen</PersonNameForAddressingName> <PersonGenderCode>male</PersonGenderCode> <PersonInformationProtectionIndicator>0</PersonInformationProtectionIndicator> <PersonBirthDateStructure> <BirthDate> </BirthDate> <BirthDateUncertaintyIndicator>0</BirthDateUncertaintyIndicator> </PersonBirthDateStructure> <PersonCivilRegistrationStatusStructure> <PersonCivilRegistrationStatusCode>0</PersonCivilRegistrationStatusCode> <PersonCivilRegistrationStatusStartDate> </PersonCivilRegistrationStatusStartDate> </PersonCivilRegistrationStatusStructure> </RegularCPRPerson> OIOXML dokumentationsguide Person 0

11 <RegularCPRPerson> <PersonGivenName>Anne Marie</PersonGivenName> <PersonMiddleName>Munch</PersonMiddleName> <PersonCivilRegistrationIdentifier> </PersonCivilRegistrationIdentifier> <PersonNameForAddressingName>Anne Marie M. Hansen</PersonNameForAddressingName> <PersonGenderCode>female</PersonGenderCode> <PersonInformationProtectionIndicator>0</PersonInformationProtectionIndicator> <PersonBirthDateStructure> <BirthDate> </BirthDate> <BirthDateUncertaintyIndicator>0</BirthDateUncertaintyIndicator> </PersonBirthDateStructure> <PersonCivilRegistrationStatusStructure> <PersonCivilRegistrationStatusCode>0</PersonCivilRegistrationStatusCode> <PersonCivilRegistrationStatusStartDate> </PersonCivilRegistrationStatusStartDate> </PersonCivilRegistrationStatusStructure> </RegularCPRPerson> 5. Specialudviklede typer Nedenfor ses den logiske model for de specialudviklede typer fra afsnittet Konceptuel model. Desuden ses eksempler på XML-struktur og XML Schema for de specialudviklede typer. MyPersonUsage CustodyStructure SimpleCPRPerson PersonGenderCode Child Parent -CustodyIndicator : boolean Guardian MaritalStatusCode MaritalStatusCode PersonNationalityCode PersonGenderCode SimpleCPRPerson OIOXML dokumentationsguide Person

12 Eksempel på XML-struktur for MyPersonUsage <MyPersonUsage> <SimpleCPRPerson> <PersonGivenName>Anne Marie</PersonGivenName> <PersonMiddleName>Munch</PersonMiddleName> <PersonCivilRegistrationIdentifier> </PersonCivilRegistrationIdentifier> </SimpleCPRPerson> <PersonGenderCode>female</PersonGenderCode> <MaritalStatusCode>married</MaritalStatusCode> <PersonNationalityCode>DK</PersonNationalityCode> </MyPersonUsage> Eksempel på XML Schema for MyPersonUsage <element name= MyPersonUsage type= MyPersonUsageType > <complextype name= MyPersonUsageType > <sequence> <element ref= SimpleCPRPerson /> <element ref= PersonGenderCode /> <element ref= MaritalStatusCode /> <element ref= PersonNationalityCode /> </sequence> </complextype> OIOXML dokumentationsguide Person 2

13 Eksempel på XML-struktur for CustodyStructure <CustodyStructure> <Child> <SimpleCPRPerson> <PersonGivenName>Bjørn</PersonGivenName> <PersonCivilRegistrationIdentifier>0503</PersonCivilRegistrationIdentifier> </SimpleCPRPerson> </Child> <Parent> <SimpleCPRPerson> <PersonGivenName>Jens</PersonGivenName> <PersonCivilRegistrationIdentifier> </PersonCivilRegistrationIdentifier> </SimpleCPRPerson> <MaritalStatusCode>unmarried</MaritalStatusCode> <PersonGenderCode>male</PersonGenderCode> <CustodyIndicator>0</CustodyIndicator> </Parent> <Guardian> <SimpleCPRPerson> <PersonGivenName>Anne Marie</PersonGivenName> <PersonMiddleName>Munch</PersonMiddleName> <PersonCivilRegistrationIdentifier> </PersonCivilRegistrationIdentifier> </SimpleCPRPerson> <MaritalStatusCode>married</MaritalStatusCode> <PersonGenderCode>female</PersonGenderCode> </Guardian> </CustodyStructure> OIOXML dokumentationsguide Person 3

14 Eksempel på XML Schema for CustodyStructure <element name= CustodyStructure type= CustodyStructureType > <complextype name= CustodyStructureType > <sequence> <element ref= Child /> <element ref= Parent /> <element ref= Guardian /> </sequence> </complextype> <element name= Child type= ChildType > <complextype name= ChildType > <sequence> <element ref= SimpleCPRPersonType /> </sequence> </complextype> <element name= Parent type= ParentType > <complextype name= ParentType > <sequence> <element ref= SimpleCPRPersonType /> <element ref= MaritalStatusCode /> <element ref= PersonGenderCode /> <element name= CustodyIndicator type= boolean /> </sequence> </complextype> <element name= Guardian type= GuardianType > <complextype name= GuardianType > <sequence> <element ref= SimpleCPRPersonType /> <element ref= MaritalStatusCode /> <element ref= PersonGenderCode /> </sequence> </complextype> OIOXML dokumentationsguide Person 4