Codelist (Codelijst)

In de BRO wordt een onderscheid gemaakt tussen beheerde waardenlijsten en niet-beheerde waardenlijsten.

In de gegevenscatalogus en de XSD-bestanden noemen we een beheerde waardenlijst een codelijst. Het domein van een codelijst is een uitbreidbare opsomming van toegestane waarden.

De BRO volgt voor een codelijst de GML XML encoding rules het patroon voor een CodeType. Dit patroon voegt een XML-attribuut codeSpace toe aan een XML-element. De waarde van de codeSpace verwijst naar een catalogus, thesaurus, classificatie schema of autoriteit waar de toegestane waarden in de codelijst worden gedefinieerd. Als conventie binnen de BRO bestaat de waarde van het XML-attribuut uit een URN, b.v.: urn:bro:bhrgt:DescriptionLocation. 

In een XSD leidt een codelijst tot een restrictie van het complexType CodeWithAuthority, bijvoorbeeld:

Onderstaand een voorbeeld van het gebruik van een codelijst uit het algemene XSD-bestand brocommon.xsd en een uit BHR-GT (Geotechnisch booronderzoek). Het XML-element heeft een attribuut codeSpace, met als waarde de URN van de codelijst.

<brocom:registrationStatus codeSpace="urn:bro:RegistrationStatus">voltooid</brocom:registrationStatus>
...
<bhrgtcom:descriptionLocation codeSpace="urn:bro:bhrgt:DescriptionLocation">veld</bhrgtcom:descriptionLocation>

Merk op dat in de gegevenscatalogus het domein (de toegestane waarden) expliciet wordt gedefinieerd. De lijst van toegestane waarden van een codelijst wordt niet opgenomen in het XSD-bestand. Als dat wel zou gebeurren, dan zou een wijziging in het domein leiden tot een wijziging van het XSD-bestand. Het gebruik van een toegestane waarde wordt niet afgedwongen door het XSD-bestand. In plaats daarvan valideert het BRO-systeem de gebruikte waarde softwarematig. Het gebruik van een niet-toegestane waarde leidt tot een gepaste foutmelding.

De berichtencatalogus bevat een overzicht van de codelijsten en hun URN.

Via de refcode service kunnen op basis van de URN van een codelijst de toegestane waarden worden opgevraagd, bijvoorbeeld https://publiek.broservices.nl/refcodes/api/get_codes?domain=urn:bro:bhrgt:DescriptionLocation.

Merk op dat bij een codelijst de toegestane waarden anders kunnen zijn voor het kwaliteitsregime IMBRO dan voor IMBRO/A. Zie de catalogus en/of de refcode service voor nadere details.