Toelichting catalogus Template basisregistraties

Transcriptie

1 Toelichting catalogus Template basisregistraties Datum: 9 april 2010 Auteur: E. Raadsen Versie: 2.0 d8 Status: Concept Toelichting catalogus br template 2.0 d8.1.odt-1-

2 Versiehistorie Versie Datum omschrijving verandering d1 9 april 2010 initiële vulling d6 27 april 2010 Verwerking werkgroep Template 26 april 2010 d7 27 mei 2010 Verwerking resultaten werkgroep oefenen invullen op d8 17 juni 2010 Toevoegen generieke gegevensgroepen en elementtypen Contactinformatie Voor vragen, suggesties of opmerkingen kunt u contact opnemen met: < Naam contactpersoon> < Telefoonnummer contactpersoon > < Naam van de beherende organisatie > < adres contactpersoon > Toelichting titelblad Naam basisregistratie: Hier invullen de volledige, officiële naam van de basisregistratie. Bijv. Basis Registratie Adressen Afkorting basisregistratie: Drieletterige afkorting van de naam van de basisregistratie, in hoofdletters. De 3-letterige afkorting wordt gebruikt bij de namen van de gegevens. Voorbeeld BRA Datum publicatie versie: De datum waarop de catalogus is gepubliceerd. De datum wordt gespecificeerd in bijv. dd-mm-jjjj. Auteur: Naam van de steller van de catalogus Versie: De versie aanduiding. Bijv. versie 1.1 Status: Tekstuele opmerkingen over de versie, bijv. concept, definitief Toelichting schutblad Versie catalogus De versiegegevens van de catalogus, te weten: - De versie aanduiding. Bijv. versie Datum publicatie versie De datum waarop de catalogus is gepubliceerd. De datum wordt gespecificeerd in dd-mm-jjjj - Omschrijving verandering Korte tekstuele toelichting op de nieuwe versie met vermelding wat in hoofdlijnen gewijzigd is ten opzichte van de vorige versie. Contactinformatie Gegevens over bij wie de lezer van de catalogus terecht kan met vragen, suggesties en of opmerkingen. - Naam contactpersoon De persoon die (als eerste) aanspreekbaar is voor vragen over de catalogus - Telefoonnummer contactpersoon Het telefoonnummer waarop men terecht kan voor informatie over de catalogus - Naam beherende organisatie Naam van de organisatie welke verantwoordelijk is voor de catalogus - adres contactpersoon Het adres bestemd voor de communicatie over de catalogus Toelichting catalogus br template 2.0 d8.1.odt-2-

3 Inhoudsopgave Toelichting catalogus br template 2.0 d8.1.odt-3-

4 1 Inleiding Voor het uitwerken van de catalogus voor een basisregistratie zijn op dit moment drie producten beschikbaar: een template, een toelichting op de template, en een addendum op de handreiking catalogus basisregistratie. De laatste is ongewijzigd ten opzichte van versie 1.0 Template Het template is een leeg documentsjabloon waarmee een catalogus voor een basisregistratie kan worden opgesteld. Het template kent een vaste indeling met rubrieken, en legt daarmee opmaak, vormgeving en structuur vast. Omdat elke organisatie haar eigen huisstijl kent, is een zo neutraal mogelijk documentsjabloon gebruikt voor het template. Handreiking catalogus basisregistratie addendum De handreiking is de aanvulling op de handreiking #3 van Kees van der Steen, handreiking catalogus basisregistratie. Toelichting op de template Toelichting op de template (dit is het onderhavige document) bevat uitleg per rubriek over de vulling van het documentsjabloon. De indeling en volgorde van rubrieken in template en toelichting komen overeen. Elke rubriek is in de volgende hoofdstukken toegelicht en soms van voorbeelden voorzien Toelichting catalogus br template 2.0 d8.1.odt-4-

5 1.1 Toelichting Algemene toelichting over de uitwerking van de catalogus. Eventueel aanvullen met leesinstructies. 1.2 Plaats basisregistratie in het stelsel Positionering BR in het stelsel: Tekstuele toelichting met figuur over de plaats van de basisregistratie in het stelsel van basisregistraties en de samenhang met andere basisregistraties. Zie figuur met voorbeeld Figuur 1: voorbeeld figuur positionering basisregistratie in het stelsel P e r s o o n P e r s o n N a t u u r l i j k N a t u r l i j k P e r s o o n P e r s o n N i e t - N a t u u r l i j k N i e t - N a t u r l i j k P e r s o o n P e r s o n K l e i n s c h a l i g K l e i n s c h a l i g t o p o g r a f i s c h t o p o g r a f i s c h o b j e c t o b j e c t G K B G B A H R / B B R i s b a s i s v o o r V e s t i g i n g V e s t i g i n g G r o o t s c h a l i g G r o t s c h a l i g t o p o g r a f i s c h t o p o g r a f i s c h o b j e c t o b j e c t G B K N h e e f t h e e f t l i g t o p R e c h t R e c h t o p O n r o e r e n d e O n r o e r e n d e z a a k z a k Z e k e r h e i d s - Z e k e r h e i d s - r e c h t r e c h t o p K a d a s t e r NB: De uitleg van de schematechniek met de gebruikte symbolen en een leesinstructie wordt opgenomen in de stelselcatalogus. Dit hoeft de steller van de catalogus van een basisregistratie niet zelf uit te werken. De te gebruiken modelleertaal en symbolen worden nog nader uitgewerkt in issue 080 Standaard modelleertaal stelsel Toelichting catalogus br template 2.0 d8.1.odt-5-

6 B a s i s r e g i s t r a t i e K a d a s t e r Beschrijving afbakening van de basisregistratie Beschrijving afbakening BR: Figuur 2: voorbeeld afbakening basisregistratie Tekst en schematische voorstelling waarin het object /de objecten van registratie worden geïntroduceerd, de relaties met andere objecten van registratie worden benoemd, en de relaties met objecten van registratie uit andere basisregistraties. Op hoofdlijnen wordt weergegeven welke gegevens uit welke basisregistraties worden overgenomen. Voorbeeld van de schematische voorstelling: P e r c e e l A p p a r t e m e n t s - r e c h t L e i d i n g n e t w e r k h e e f t a l s b r o n d o c u m e n t O n r o e r e n d e z a a k T e r i n s c h r i j v i n g a a n g e b o d e n s t u k K a d a s t e r s t u k H e e f t a l s b r o n d o c u m e n t o p R e c h t o p Z e k e r h e i d s - r e c h t S t u k h e e f t h e e f t H e e f t a l s b r o n d u c u m e n t H e e f t a l s b r o n d u c u m e n t N a t u u r l i j k p e r s o o n N i e t n a t u r l i j k P e r s o o n P e r s o o n B a s i s m o d e l K a d a s t e r 1.3 Levenscyclus Tekst waarin de levensfasen van het subject/object van registratie wordt getoond, aangevuld met een schema. De levenscyclus begint over het algemeen al in de planfase, waarin sprake is van voorgenomen realisatie. De levenscyclus omvat ook de administratieve processen van archivering tot aan de vernietiging. Een tabel met de gebeurtenissen en per gebeurtenis wat er verandert aan gegevens, geeft een potentiële afnemer gevoel bij wat er speelt in de levenscyclus van het object van registratie. De detaillering hiervan wordt uitgewerkt in het hoofdstuk gebeurtenissen. 1.4 Semantisch gegevensmodel ORM plaat Hier wordt het semantische gegevensmodel weergegeven. De plaat wordt beperkt tot de weergave van de relaties tussen de objecttypen. Attributen worden dus zoveel mogelijk weggelaten Toelichting catalogus br template 2.0 d8.1.odt-6-

7 2 Objecttypen en gegevens Objecttypen Voor elk objecttype wordt een aparte paragraaf aangemaakt. Specialisaties van objecttypen (subtypen) blijven evenwel in dezelfde paragraaf als het supertype. Relatie-objecten worden ook hier opgevoerd. Naam objecttype objecttype Afkorting objecttype Definitie objecttype Herkomst definitie objecttype Toelichting objecttype Populatie Kwaliteitsbegrip Definitierelaties Generalisatie Aggregatie Equivalent Gegevensgroeptypen Kardinaliteit Associatie Attribuuttypen De naam van het objecttype in hoofdletters. Ook super- en subtypen. Facultatief, door de registratiehouder te bepalen Drieletterige afkorting van de naam van het objecttype, in hoofdletters. De 3-letterige afkorting wordt gebruikt bij de namen van de attributen. Formele definitie van het objecttype. De definitie moet zodanig zijn dat je aan de hand ervan kunt vaststellen of een object er een is van die soort of niet Kan zijn: - ontleend aan <bron>: heeft als inspiratie gediend voor de definitie - overgenomen uit <bron>: is 1 op 1 overgenomen uit de bron. Indien naam en definitie overeenstemmen met het begrippenkader in het nationaal woordenboek, dan wordt dat als bron genoemd. Eventueel kan een toelichtende tekst aan de definitie worden toegevoegd. Beschrijving van de verzameling objecten die in de registratie wordt opgenomen. Het is belangrijk tevens te beschrijven welke verzameling van objecten nu juist niet wordt opgenomen, zodat de populatie scherp is afgebakend. Beschrijf ook verschillen in populatie met gekoppelde objecten De beschrijving van de relatie tussen de waargenomen situatie en/of gebeurtenissen en de registratie. Hierin aandacht voor: - Hoe kun je constateren dat het object bestaat. - Hoe kun je vaststellen dat er sprake is van een object van registratie. Wanneer is het er één?, Is het er één, of zijn het er meer? - Wie beslist hierover. De referentie aan begrippen (in de semantische kern, andere catalogi of nationaal woordenboek) in termen van: generalisatie van, aggregatie van, classificatie van, equivalent met, of elementair.indien elementair, dan niets invullen. Geeft aan dat dit object een generalisatie van de daarbij opgesomde objecten betreft. Wordt onder andere gebruikt bij een supertype van onderliggende subtypen. Aggregatie van (gerelateerde) objecttypen, bijvoorbeeld huwelijk Definitie overeenkomstig verwijzing (bijv. in semantische kern). Lijst met namen van gegevensgroeptypen die leverbaar zijn van dit objecttype. Voor generieke gegevensgroeptypen zie 2.2 Geeft aan of een attribuut, gegevensgroep of relatie naar een ander objecttype wel of niet altijd beschikbaar is en of er meerdere exemplaren van zijn; 0-1: is soms niet beschikbaar; 1-1: is altijd beschikbaar 0-N: is niet altijd beschikbaar, kan lijst zijn; 1-N: is altijd beschikbaar, kan lijst zijn Verplicht indien wordt verwezen naar een gegevensgroeptype waarvan meerdere voorkomens apart onderscheiden moeten worden. Bijvoorbeeld bij verwijzing naar de (generieke) gegevensgroep 'Adresgegevens' kan aangegeven worden dat het hier om de leveranciersingang gaat. Deze associatie wordt ook toegevoegd aan de naam en de XML-tag van het gegevensgroeptype. Lijst met de namen van de attribuuttypen die leverbaar zijn van dit objecttype. Overgenomen attribuuttypen uit andere basisregistraties Toelichting catalogus br template 2.0 d8.1.odt-7-

8 Relatie-attribuuttypen Identificaties Indicatie formele historie Datum registratie vanaf Indicatie materiële historie Conditie worden niet hier gespecificeerd, maar bij de berichten waarin ze opgevraagd en geleverd worden. Eigen versies worden hier wel benoemd. Meerdere voorkomens van hetzelfde attribuuttype kunnen niet apart gespecificeerd worden. Indien dat wel moet dan het attribuuttype opnemen in een gegevensgroeptype met nader specificerende attribuuttypen. Lijst met de namen van de relatie-attribuuttypen die leverbaar zijn van dit object. Ze verwijzen naar de primaire identificatie van het gerelateerde objecttype. Minstens twee bij een relatie-objecttype. De kenmerken (attributen) aan de hand waarvan de exemplaren van de soort uniek onderscheiden kunnen worden. Dit kan het identificatie nummer van het object zijn dat als apart attribuuttype in de desbetreffende tabel moet worden opgevoerd, zoals het burgerservicenummer (BSN, primaire identificatie). Het kan ook bestaan uit een combinatie van kenmerken, zoals postcode + huisnummer + -letter + -toevoeging. Alternatieve identificaties zijn facultatief. Geeft aan of de basisregistratie kan leveren wanneer een verandering in de registratie is verwerkt. Op dit niveau geldt dat voor het object zelf en alle niveaus waarop niet anders wordt gespecificeerd De eerste dag dat dit objecttype werd geregistreerd in de registratie Geeft aan of de basisregistratie kan leveren wanneer een verandering is opgetreden (en nog geldt) in de werkelijkheid. Op dit niveau geldt dat voor het object zelf en alle niveaus waarop niet anders wordt gespecificeerd Voorwaarde waaronder de gegevens over populatiehistorie geldig zijn. Wordt alleen gebruikt in geval van subpopulaties met verschillende populatiehistorie. Anders leeg laten. Formaat: <naam attribuuttype><operator><waarde>(<en/of>< >) Operatoren: =,.,. Bij meer dan twee condities zo nodig haakjes weergeven Datum ingang geldigheid vanaf De eerst voorkomende datum geldigheid van dit gegeven in deze registratie (onder deze conditie) Datum authentiek vanaf De eerst voorkomende datum vanaf wanneer een gegeven van dit type in de registratie authentiek is (onder deze conditie) Versie nummer De versie aanduiding. Bijv. versie 1.1 De dag vanaf wanneer de versie mag worden gebruikt. De laatste dag waarop de versie mag worden gebruikt, indien bekend Toelichting catalogus br template 2.0 d8.1.odt-8-

9 te registreren gegevens naam objecttype uit het overzichtsschema klantnummer i unieke aanduiding van het object achternaam KLANT doorgetrokken lijn: gegeven of gegevensgroep komt altijd voor bij het object voorvoegsels voorletters woonadres adresaanduiding ingangsdatum gegevensgroep die meermalen bij het geregistreerde object voorkomt, echter op één moment is er slechts één geldig i gegevens binnen de gegevensgroep gestreepte lijn: gegeven of gegevensgroep komt niet altijd voor bij het object bezorgadres adresaanduiding ingangsdatum i gegevensgroep die meermalen bij het geregistreerde object voorkomt, en op één moment kunnen er meer geldig zijn einddatum telefoonnummer gegeven dat meermalen voorkomt Toelichting catalogus br template 2.0 d8.1.odt-9-

10 2.1 <Naam objecttype> Naam objecttype: <NAAM OBJECTTYPE> Afkorting Definitie Herkomst definitie Toelichting Populatie Kwaliteitsbegrip Definitierelaties met Equivalent Generalisatie Aggregatie <code objecttype> <afkorting objecttype> <definitie objecttype> <herkomst definitie objecttype> <toelichting objecttype> <populatiebeschrijving objecttype> <kwaliteitsbegrip objecttype> <afkorting BR><naam objecttype> <afkorting BR><naam (sub)objecttype> <afkorting BR><naam objecttype> Gegevensgroepen Kardinaliteit Associatie <naam gegevensgroeptype> 0-1/1-1/0-N/1-N <associatie> Attributen <naam attribuuttype> Relatie-attributen <naam relatie-attribuuttype> Identificaties Kardinaliteit 0-1/1-1/0-N/1-N Kardinaliteit 0-1/1-1/0-N/1-N Attributen Primaire identificatie <code attribuuttype><naam attribuuttype>(+ ) Alternatieve identificaties <code attribuuttype><naam attribuuttype>(+ ) Historie Indicatie formele historie Datum registratie vanaf Indicatie materiële historie <datum registratie eerste object> Populatiehistorie Datum ingang geldigheid vanaf Datum authentiek vanaf (<conditie>)(<conditie>) Versie <eerste datum ingang geldigheid> <versienummer objecttype> <begindatum versie objecttype> <einddatum versie objecttype> <eerste datum authentiek> Toelichting catalogus br template 2.0 d8.1.odt-10-

11 2.1.1 Gegevensgroeptypen van <Naam objecttype> Zie voor de gelijknamige specificaties bij objecttype Naam gegevensgroep De naam van de gegevensgroep van dit objecttype. Deze wordt voorafgegaan door de afkorting van het object en een punt: Formaat: <afkorting object><.><naam gegevensgroep> Afkorting Drieletterige afkorting van de naam van de gegevensgroep. De 3- letterige afkorting wordt gebruikt bij de namen van de attributen en onderliggende gegevensgroepen. Facultatief, door de registratiehouder te bepalen Naam specifiek gegevensgroeptype: <Naam gegevensgroeptype> Afkorting XML-tag Definitie Herkomst definitie Toelichting <code gegevensgroeptype> <afkorting gegevensgroeptype> <XML-tag> Definitierelaties met Equivalent <definitie attribuuttype> <herkomst definitie attribuuttype> <toelichting> <afkorting BR><naam gegevensgroeptype> Gegevensgroepen Kardinaliteit Associatie <naam gegevensgroeptype> 0-1/1-1/0-N/1-N <associatie> Attributen <naam attribuuttype> Relatie-attributen <naam relatie-attribuuttype> Identificaties Kardinaliteit 0-1/1-1/0-N/1-N Kardinaliteit 0-1/1-1/0-N/1-N Attributen Primaire identificatie <code attribuuttype><naam attribuuttype>(+ ) Alternatieve identificaties <code attribuuttype><naam attribuuttype>(+ ) Regels <naam/aanduiding> Historie Indicatie formele historie Datum registratie vanaf Indicatie materiële historie <gegevensregel> <datum registratie eerste attribuut> Populatiehistorie Datum ingang geldigheid vanaf Datum authentiek vanaf (<conditie>)(<conditie>) Versie <eerste datum ingang geldigheid> <versienummer gegevensgroeptype> <begindatum versie gegevensgroeptype> <einddatum versie gegevensgroeptype> <eerste datum authentiek> Toelichting catalogus br template 2.0 d8.1.odt-11-

12 2.1.2 Attribuuttypen van <Naam objecttype> of <Naam specifieke gegevensgroep> In onderstaande tabellen worden de attributen gespecificeerd per subparagraaf, behorend tot het desbetreffende object. Overgenomen attributen uit andere basisregistraties worden niet hier gespecificeerd, maar bij het desbetreffende object in de andere basisregistratie.. Eigen versies van een overgenomen attribuut worden hier wel gespecificeerd. Attribuuttype: < Naam attribuuttype> XML-tag Definitie Herkomst definitie Toelichting Domein <code attribuuttype> <XML-tag> Definitierelatie met Equivalent Regels <naam/aanduiding> Historie Indicatie formele historie Datum registratie vanaf Indicatie materiële historie <definitie attribuuttype> <herkomst definitie attribuuttype> <toelichting> <naam domein><versienummer domein> <afkorting BR><naam objecttype><naam attribuuttype> <gegevensregel> <datum registratie eerste attribuut> Populatiehistorie Datum ingang geldigheid vanaf Datum authentiek vanaf (<conditie>)(<conditie>) Versie <eerste datum ingang geldigheid> <versienummer attribuuttype> <begindatum versie attribuuttype> <einddatum versie attribuuttype> <eerste datum authentiek> Naam attribuuttype attribuuttype XML-tag Definitie attribuut Herkomst definitie : De volledige en unieke naam van het attribuuttype. De naam van het attribuuttype wordt uniek gemaakt door de afkorting van het objecttype, waarop het gegeven betrekking heeft daaraan vooraf te laten gaan. De unieke naam wordt weergegeven in het formaat: <afkorting objecttype><.><naam> Bij attribuuttypen van een gegevensgroep wordt de naam voorafgegaan door de afkorting van de gegevensgroep. Facultatief, door de registratiehouder te bepalen Sleutel in XML-bericht De omschrijving van de betekenis van het attribuut Aan welke bron de definitie is ontleend. Kan zijn: - ontleend aan <bron>: de bron heeft als inspiratie gediend voor de definitie - overgenomen uit <bron>: de definitie is 1 op 1 overgenomen uit de bron. Indien de naam en definitie overeenstemmen met het begrippenkader/ nationaal woordenboek, dan wordt als bron genoemd: nationaal woordenboek Toelichting catalogus br template 2.0 d8.1.odt-12-

13 Toelichting: Waar nodig kan een toelichtende tekst worden opgenomen. Domein: Aangegeven wordt uit welk domein het attribuuttype zijn waarden put. Equivalent Definitie overeenkomstig verwijzing (bijv. in semantische kern). Regels: Indien op de gegevensgroep of het attribuut optionaliteitsregels of waardebeperkende regels van toepassing zijn, worden deze hier aangegeven. Indicatie formele historie Geeft aan of de basisregistratie kan leveren wanneer een verandering in de registratie is verwerkt. Dit hier niet specificeren als het geleverd wordt op groeps- of objectniveau Datum registratie vanaf De eerste dag dat dit gegeven werd geregistreerd in deze registratie Indicatie materiële historie Geeft aan of de basisregistratie kan leveren wanneer een verandering is opgetreden in de werkelijkheid. Dit hier niet specificeren als het alleen geleverd wordt op groep- of objectniveau Conditie Voorwaarde waaronder de gegevens over populatiehistorie geldig zijn. Wordt alleen gebruikt in geval van subpopulaties met verschillende populatiehistorie. Anders leeg laten. Formaat: <naam attribuuttype><operator><waarde>(<en/of>< >) Operatoren: =,.,. Bij meer dan twee condities zo nodig haakjes weergeven Datum ingang geldigheid vanaf De eerst voorkomende datum geldigheid van dit gegeven in deze registratie (onder deze conditie), Dit hier niet specificeren als het alleen geleverd wordt op groep- of objectniveau Datum authentiek vanaf De eerst voorkomende datum vanaf wanneer een gegeven van dit type in de registratie authentiek is (onder deze conditie). Dit hier niet specificeren als het geleverd wordt op groep- of objectniveau Het volgnummer van de (historische versie) van het attribuuttype. De dag vanaf wanneer de versie mag worden gebruikt De laatste dag waarop de versie mag worden gebruikt, indien bekend Toelichting catalogus br template 2.0 d8.1.odt-13-

14 2.1.3 Relaties van <Naam objecttype> Relatie: <Naam relatie-attribuuttype> XML-tag Definitie Herkomst definitie Toelichting Gerelateerd attribuuttype <code attribuuttype> <XML-tag> <definitie> Definitierelatie met Equivalent Regels <naam/aanduiding> Historie Indicatie formele historie Datum registratie vanaf Indicatie materiële historie <herkomst relatie> <toelichting relatie> <afkorting BR><naam objecttype>primaire identificatie (XOR) ( ) <afkorting BR><naam objecttype><naam attribuuttype> <gegevensregel> <datum registratie eerste relatie-attribuut> Populatiehistorie Datum ingang geldigheid vanaf Datum authentiek vanaf (<conditie>)(<conditie>) Versie <eerste datum ingang geldigheid> <versienummer relatie-attribuuttype> <begindatum versie relatie-attribuuttype> <einddatum versie relatie-attribuuttype> Zie hiervoor bij attribuuttype voor overeenkomstige metagegevens <eerste datum authentiek> Gerelateerd attribuuttype De afkorting van de basisregistratie en de naam van het objecttype waarmee een relatie is gelegd. De relatie wordt standaard gelegd naar de primaire identificatie daarvan. Zo niet, de secundaire identificatie specificeren Toelichting catalogus br template 2.0 d8.1.odt-14-

15 2.2 Generieke gegevensgroeptypen Generieke gegevensgroepen kunnen bij verschillende objecten voorkomen. Ze worden specifiek gemaakt door de koppeling aan het bovenliggend object- of gegevensgroeptype en toevoeging van de afkorting van daarvan voorafgaand aan de naam en de tag. In geval van meerdere voorkomens bij één object- of gegevensgroeptype worden ze (bovendien) uniek gemaakt door de toevoeging van de associatie achteraan de naam of de tag. Invullen van een generieke gegevensgroep is alleen zinvol voorzover de waarden identiek zijn voor alle voorkomende concretiseringen. Afwijkende waarden moeten ingevuld worden bij een gegevensgroep bij het desbetreffende object. Zie voor toelichting bij de specifieke gegevensgroeptypen Naam generiek gegevensgroeptype: <Naam generiek gegevensgroeptype> Afkorting XML-tag Definitie Herkomst definitie Toelichting <code gegevensgroeptype> <afkorting gegevensgroeptype> <XML-tag> Definitierelaties met Equivalent <definitie gegevensgroepype> <herkomst definitie gegevensgroeptype> <toelichting> <afkorting BR><naam gegevensgroeptype> Gegevensgroepen Kardinaliteit Associatie <naam gegevensgroeptype> 0-1/1-1/0-N/1-N <associatie> Gegevenselementtypen <naam elementtype> Relatie-attributen <naam relatie-attribuuttype> Identificaties Kardinaliteit 0-1/1-1/0-N/1-N Kardinaliteit 0-1/1-1/0-N/1-N Attributen Primaire identificatie <code attribuuttype><naam attribuuttype>(+ ) Alternatieve identificaties <code attribuuttype><naam attribuuttype>(+ ) Regels <naam/aanduiding> Historie Indicatie formele historie Datum registratie vanaf Indicatie materiële historie <gegevensregel> <datum registratie eerste attribuut> Populatiehistorie Datum ingang geldigheid vanaf Datum authentiek vanaf (<conditie>)(<conditie>) Versie <eerste datum ingang geldigheid> <versienummer gegevensgroeptype> <begindatum versie gegevensgroeptype> <einddatum versie gegevensgroeptype> <eerste datum authentiek> Toelichting catalogus br template 2.0 d8.1.odt-15-

16 2.2.1 Elementtypen van <Naam generiek gegevensgroeptype> Elementtypen vormen het generieke deel van de specificatie van attribuuttypen in een generieke gegevensgroep. Door de koppeling van de generieke gegevensgroep aan een object ontstaan de desbetreffende attributen, die op identieke wijze specifiek gemaakt worden als beschreven bij het generieke gegevensgroeptype. Aan deze specifieke attributen kan gerefereerd worden in bericht(component)en en gebeurtenissen. Invullen van elementtypen is alleen zinvol voorzover de waarden identiek zijn voor alle voorkomende concretiseringen. Afwijkende waarden moeten ingevuld worden bij overeenkomstige attributen bij het desbetreffende object. Elementtype: <Naam elementtype> XML-tag Definitie Herkomst definitie Toelichting Domein <code elementtype> <XML-tag> Definitierelatie met Equivalent Regels <naam/aanduiding> Historie Indicatie formele historie Datum registratie vanaf Indicatie materiële historie <definitie elementtype> <herkomst definitie elementtype> <toelichting> <naam domein><versienummer domein> <afkorting BR><naam objecttype><naam attribuuttype> <gegevensregel> <datum registratie eerste attribuut> Populatiehistorie Datum ingang geldigheid vanaf Datum authentiek vanaf (<conditie>)(<conditie>) Versie <eerste datum ingang geldigheid> <versienummer elementtype> <begindatum versie elementtype> <einddatum versie elementtype> <eerste datum authentiek> Toelichting catalogus br template 2.0 d8.1.odt-16-

17 3 Domeinen Naam domein: <Naam domein> Definitie Herkomst definitie Toelichting: Gehanteerde standaard Definitierelatie met Equivalent Specificatie Formaat domein: (Maximale) lengte domein Uitwisselingsmasker domein: waardenverzameling domein: Regels <naam/aanduiding> Versie <code domein> <definitie domein> <herkomst definitie domein> <toelichting> <standaard> <verwijzing> tekst/getal/datum/datum (onvolledig)/datum-tijd/punt/lijn/vlak/ <lengte> (bij getal of tekst) <uitwisselingsmasker domein> <bereik>( <waarde>) en/of <waarde> of <tabel> <gegevensregel> <versienummer domein> <begindatum versie domein> <einddatum versie domein> Naam domein: Definitie domein: Herkomst definitie domein: Toelichting: Gehanteerde standaard Definitierelatie Formaat (sub)domein: Lengte (sub)domein Uitwisselingsmasker domein: De naam van het domein, in hoofdletters Facultatief, door de registratiehouder te bepalen De definitie waaruit blijkt welke soorten van dingen met de naam worden aangeduid Kan zijn: - ontleend aan <bron>: de bron heeft als inspiratie gediend voor de definitie - overgenomen uit <bron>: de definitie is 1 op 1 overgenomen uit de bron. Indien de naam en definitie overeenstemmen met het begrippenkader/ nationaal woordenboek, dan wordt als bron genoemd: nationaal woordenboek. Een andere toelichting op de domeinbeschrijving De standaard die is gevolgd voor de definitie van het domein (bijv. ISO 8601) De referentie aan begrippen in termen van: equivalent aan, Het formaat (soort en betekenis tekens) wordt aangegeven De lengte van de tekst of het getal, de laatste met eventueel het aantal cijfers achter de komma evt. wordt aangegeven door middel van welk masker de gegevens ter beschikking worden gesteld Toelichting catalogus br template 2.0 d8.1.odt-17-

18 waardenverzameling domein: Regels: De waardenverzameling wordt opgesomd, gedefinieerd of er wordt verwezen naar een standaardtabel of standaardocument. Daarnaast kan een domein bepaald worden door wat is uitgegeven aan waarden. (bijv. bij Kadaster mag alleen een bestaand BSN worden geregistreerd, bij GBA mag alleen een nog vrij BSN worden toegekend aan een nieuwe ingezetene) aangegeven wordt welke regels op het domein van toepassing zijn. Het volgnummer van de versie van het domein De dag vanaf wanneer de versie mag worden gebruikt De laatste dag waarop de versie mag worden gebruikt, indien bekend Toelichting catalogus br template 2.0 d8.1.odt-18-

19 4 Gebeurtenistypen In dit hoofdstuk wordt een opsomming opgenomen van alle gebeurtenissen, waarover de basisregistratie gegevens kunnen leveren in afzonderlijke berichten. Een gebeurtenis is een elementaire situatie die zich op een bepaald moment voordoet in de levenscyclus van een object, waardoor de status van het object verandert, en de registratie moet worden geactualiseerd. Naam gebeurtenistype: De naam van het gebeurtenistype, in hoofdletters Facultatief, door de registratiehouder te bepalen Afkorting gebeurtenis: Drieletterige afkorting van de naam van de gebeurtenis, in hoofdletters. Definitie gebeurtenis: De definitie van de gebeurtenis Toelichting gebeurtenis: Eventueel een toelichting op de gebeurtenis Gegevensdiensten De naam van de gegevensdiensten die in verband met de gebeurtenis worden geleverd. Betrokken objecttypen: De objecttypen, waarop de gebeurtenis betrekking heeft Wijzigende gegevensgroeptypen De lijst met gegevensgroeptypen die wijzigen naar aanleiding van de gebeurtenis, inclusief de aard van de wijziging en of die verplicht is. Wijzigende attributen: De lijst met attribuuttypen die wijzigen, idem Wijzigende relatie-atribuuttypende lijst met relatie-attribuutypen die wijzigen, idem Het volgnummer van de versie van het gebeurtenistype De dag vanaf wanneer de versie mag worden gebruikt De laatste dag waarop de versie mag worden gebruikt, indien bekend. 4.1 <NAAM GEBEURTENISTYPE> Naam gebeurtenistype: NAAM GEBEURTENISTYPE> Afkorting Definitie Toelichting Gegevensdiensten Betrokken objecttypen <code gebeurtenistype> <afkorting gebeurtenistype> <definitie gebeurtenistype> <toelichting gebeurtenistype> <afkorting BR><naam gegevensdienst> <afkorting BR><naam object> Wijzigende gegevensgroeptypen Aard wijziging Verplicht? <afkorting BR><naam object><naam gegevensgroep> opvoeren/bijwerken/verwijderen Wijzigende attribuuttypen Aard wijziging Verplicht? <afkorting BR><naam attribuut> opvoeren/bijwerken/verwijderen Wijzigende relatie-attribuuttypen Aard wijziging Verplicht? Versie opvoeren/bijwerken/verwijderen <versienummer gebeurtenistype> <begindatum versie gebeurtenistype> <einddatum versie gebeurtenistype> Toelichting catalogus br template 2.0 d8.1.odt-19-

20 5 Gegevensdiensten Naam dienst: De naam van de dienst dienst: Facultatief, door de registratiehouder te bepalen. Definitie dienst: Hoe de dienst is gedefinieerd Toelichting dienst: Toelichting op de definitie van de dienst Soort dienst: Wat voor soort dienst het betreft: bestandsafslag, verschil (was/wordt bestand), volgtijdelijke mutaties Gegevensstandaard De gehanteerde gegevensstandaard, het sectormodel en het versienummer Condities dienst: Voorwaarden waaronder van de dienst gebruik gemaakt kan worden Gebruikte berichttypen: De naam van de berichten die worden gebruikt bij het leveren van de dienst. Abonnementsvormen: De abonnementsvormen welke beschikbaar zijn voor deze dienst. Specificeert o.a. hoe vaak de dienst geleverd kan worden: incidenteel, periodiek met vermelding van het aantal malen per tijdseenheid. gegevensdienst Het volgnummer van de versie van de gegevensdienst De dag vanaf wanneer de versie mag worden gebruikt De laatste dag waarop de versie mag worden gebruikt, indien bekend 5.1 <Naam gegevensdienst> Naam gegevensdienst: <NAAM GEGEVENSDIENST> gegevensdienst Definitie gegevensdienst Toelichting gegevensdienst Soort dienst Gegevensstandaard Condities Gebruikte berichttypen Abonnementsvormen <abonnementsvorm> Versie <code gegevensdienst> <definitie gegevensdienst> <toelichting gegevensdienst> registratie/levering mutaties/levering op aanvraag/bestandsafslag <gegevenstandaard><sectormodel><versienummer> <conditie> <naam berichttype> specificatie <specificatie abonnementsvorm> <versienummer gegevensdienst> <begindatum versie gegevensdienst> <einddatum versie gegevensdienst> Toelichting catalogus br template 2.0 d8.1.odt-20-

21 6 Berichten Naam berichttype: De naam van het berichttype, in hoofdletters Facultatief, door de registratiehouder te bepalen. Berichtsoort De rol van het bericht in de communicatie bij de dienstverlening Berichtstandaard De gebruikte berichtstandaard met versienummer Beveiligingsniveau De gehanteerde klasse van het beveiligingsniveau Opgenomen gegevensgroeptypende naam van de gegevensgroeptypen die zijn opgenomen in het bericht. Opgenomen attribuuttypen De naam van de attribuuttypen die zijn opgenomen in het bericht Opgenomen relatie-attribuuttypen De naam van de relatie-attribuuttypen die zijn opgenomen in het bericht Tijdversie De tijdversie van de groep, het attribuut of de relatie: actueel, historisch, toekomst, oud of nieuw Berichtcomponent Elementaire bouwsteen van berichten Kardinaliteit Geeft aan of een berichtcomponent wel of niet altijd is opgenomen en al dan niet meermaals. Het volgnummer van de versie van het berichttype De dag vanaf wanneer de versie wordt gebruikt De laatste dag waarop de versie mag worden gebruikt, indien bekend. 6.1 <NAAM BERICHTTYPE> Naam berichttype: <NAAM BERICHTTYPE> berichttype Berichtsoort Berichtstandaard Beveiligingsniveau Opgenomen gegevensgroepen <afk. BR><afk. object><naam gegevensgroep> Opgenomen attributen <afkorting BR><naam object><naam attribuut> Opgenomen relatie-attributen Berichtcomponenten <code berichtcomponent> Versie <code berichttype> melding/vraagbericht/antwoordbericht/bulkbericht StUF/NEN3610/SUWIml <versienummer> <beveiligingsniveau> Tijdversie <tijdversie> Tijdversie <tijdversie> Tijdversie <tijdversie> Kardinaliteit 0-1/1-1-1/0-N/1-N <versienummer berichttype> <begindatum versie berichttype> <einddatum versie berichttype> Toelichting catalogus br template 2.0 d8.1.odt-21-

22 7 Berichtcomponenten 7.1 <NAAM BERICHTCOMPONENT> Naam berichtcomponent: <NAAM BERICHTCOMPONENT> XML-tag Opgenomen gegevensgroepen <afkorting BR><afkorting object><naam gegevensgroep> Opgenomen attributen <afkorting BR><afkorting object><naam attribuut> Opgenomen relatie-attributen <afkorting BR><afkorting object><naam relatie-attribuut> Versie <XML-tag> Tijdversie <tijdversie> Tijdversie <tijdversie> Tijdversie <tijdversie> <versienummer berichtcomponent> <begindatum versie berichtcomponent> <einddatum versie berichtcomponent> Toelichting catalogus br template 2.0 d8.1.odt-22-