Brondocumenten
Een brondocument bevat de gegevens die geregistreerd worden in de LV BRO. Voor elk registratieobject staat in de bijbehorende gegevenscatalogus waaraan die gegevens moeten voldoen.
Een brondocument is de eenheid waarin een verzameling gegevens worden geregistreerd, aangevuld of gecorrigeerd. De gegevens in het brondocument zijn gedefinieerd in de gegevenscatalogus . De gegevenscatalogus definieert ook gegevens die door het BRO-systeem worden gegenereerd of afgeleid; deze gegevens hoeven niet worden opgenomen in een brondocument.
Een brondocument wordt verpakt in een 'request'. Vervolgens wordt het geheel als een bestand in IMBRO/XML-formaat in de vorm van een BRO-verzoek aangeboden in het Bronhouderportaal.
GMN is een registratieobject met materiële geschiedenis. De gegevens waarover geschiedenis wordt opgebouwd zijn:
-
De lijst met meetpunten: er kunnen in de loop van de tijd meetpunten bijkomen en meetpunten af gaan;
-
De buisverwijzing (de relatie naar een grondwatermonitoringbuis) van een meetpunt: in de loop van de tijd kan een meetpunt verwijzen naar een andere grondwatermonitoringbuis en/of put. Bijvoorbeeld als de eerst put kapot is gegaan of als een filter verstopt is geraakt.
Het registreren van de gegevens van een object is een doorlopend proces, waarvoor de volgende vijf brondocumenten beschikbaar zijn:
|
Naam in XML-bestand |
Nederlandse naam |
Leidt tot registratiestatus |
Omschrijving |
|---|---|---|---|
|
GMN_StartRegistration |
GMN-StartRegistratie |
Geregistreerd |
Dit brondocument wordt aangeboden wanneer een (nieuw) grondwatermonitoringnet wordt gestart. |
|
GMN_MeasuringPoint |
GMN-Meetpunt |
Aangevuld |
Dit brondocument wordt aangeboden wanneer een meetpunt wordt toegevoegd aan het grondwatermonitoringnet. |
|
GMN_TubeReference |
GMN-Buisverwijzing |
Aangevuld |
Dit brondocument wordt aangeboden wanneer de actuele buisverwijzing van een meetpunt wordt vervangen door een andere buisverwijzing. |
|
GMN_MeasuringPointEndDate |
GMN-EinddatumMeetpunt |
Aangevuld |
Dit brondocument wordt aangeboden wanneer een meetpunt niet meer wordt gebruikt in het grondwatermonitoringnet, |
|
GMN_Closure |
GMN-EindeRegistratie |
Voltooid |
Dit brondocument wordt aangeboden wanneer de registratie van het grondwatermonitoringnet wordt beëindigd. Aanvullen is hierna niet meer mogelijk. |
Onderstaande tabel geeft per type brondocument weer in welke types BRO-verzoeken het brondocument aangeboden mag worden.
De grijs gemarkeerde combinaties van een type brondocument en een type BRO-verzoek zijn momenteel out-of-scope. Zie ook de grijs gemarkeerde teksten verderop in deze pagina.
|
Brondocument |
Registreren |
Corrigeren |
|||
|---|---|---|---|---|---|
|
|
|
Vervangen |
Invoegen |
Verplaatsen |
Verwijderen |
|
GMN_StartRegistration |
√ |
√ |
|
√ |
|
|
GMN_MeasuringPoint |
√ |
|
√ |
√ |
√ |
|
GMN_TubeReference |
√ |
√ |
√ |
√ |
√ |
|
GMN_MeasuringPointEndDate |
√ |
|
|
√ |
√ |
|
GMN_Closure |
√ |
|
|
√ |
√ |
GMN_StartRegistration
Onderstaande figuur geeft een overzicht van de inhoud van het brondocument.
De startDateMonitoring (begindatum monitoring) in het brondocument is tevens de startDate (startdatum meetpunt) voor elk measuringPoint (meetpunt) in het brondocument. Als meerdere meetpunten op dezelfde datum in gebruik zijn genomen, dan kunnen al deze meetpunten in 1 GMN_StartRegistration brondocument worden angeboden.
Dit is echter niet aan te raden voor historische monitoringnetten, met name als de startDateMonitoring niet volledig bekend is, bijvoorbeeld alleen de maand van een jaar, of alleen een jaartal. Biedt in dat geval een GMN_StartRegistration brondocument aan met één meetpunt, namelijk het meetpunt met de oudste startDate (startdatum meetpunt). Lever de andere meetpunten één voor één aan met GMN_MeasuringPoint brondocumenten, gesorteerd op startDate (startdatum meetpunt), de oudste datum eerst. Dan is het achteraf corrigeren van de startDateMonitoring bij individuele meetpunten gemakkelijker. Want het corrigeren van de startDateMonitoring in een GMN_StartRegistration brondocument heeft gevolgen voor alle meetpunten die zijn aangeboden met dat brondocument.
Als van meerdere meetpunten de startDate (startdatum meetpunt) onbekend is, lever die wel in één keer aan met een GMN_StartRegistration brondocument, want bij een GMN_MeasuringPoint brondocument mag de eventDate (datum gebeurtenis) niet de waarde 'onbekend' hebben.
De gegevens zijn volledig gedefinieerd in de gegevenscatalogus. Het brondocument bevat alle gegevens uit de gegevenscatalogus met uitzondering van de volgende gegevens:
-
Attribuut broId (BRO-ID). Deze wordt niet opgenomen in het brondocument maar in het BRO-verzoek, behalve bij het registrationRequest (registratieverzoek) want dan genereert de BRO een waarde voor dit gegeven.
-
Attribuut deliveryAccountableParty (bronhouder). Deze wordt niet opgenomen in het brondocument maar in het BRO-verzoek.
-
Attribuut deliveryResponsibleParty (dataleverancier). Deze wordt niet opgenomen in het brondocument maar in de SOAP header van het bericht.
-
Attribuut qualityRegime (kwaliteitsregime). Deze wordt niet opgenomen in het brondocument maar in het BRO-verzoek.
-
Entiteit RegistrationHistory (Registratiegeschiedenis), wordt afgeleid door de BRO.
-
Attribuut endDateMonitoring (einddatum monitoring) in entiteit MonitoringNetHistory (Monitoringnetgeschiedenis), krijgt pas een waarde als het grondwatermonitoringnet wordt afgesloten/beëindigd.
-
Entiteit IntermediateEvent (Tussentijdse gebeurtenis), wordt afgeleid door de BRO als er een aanvulling wordt geregistreerd.
Het brondocument kan met de onderstaande BRO-verzoeken worden aangeboden voor de onderstaande gebruiksdoelen:
|
request |
Gebruiksdoel |
|---|---|
|
registrationRequest |
Starten van de registratie van een grondwatermonitoringnet, door de initiële inrichting van het monitoringnet aan te bieden, inclusief een of meerdere meetpunten en per meetpunt de initiële verwijzing naar een monitoringbuis in een grondwatermonitoringput. |
|
replaceRequest |
Een fout herstellen in de geregistreerde inhoud van de initiële inrichting. Bijvoorbeeld wanneer bij het starten van de registratie een foute waarde voor het monitoringPurpose (monitoringdoel) is opgegeven. |
|
insertRequest |
Niet van toepassing.
|
|
moveRequest |
Een verplaatsing op de tijdlijn: Wanneer een onjuiste waarde voor de startDateMonitoring (begindatum monitoring) is geregistreerd. |
|
deleteRequest |
Niet van toepassing.
|
GMN_StartRegistration in een registrationRequest
Met een GMN_StartRegistration brondocument in een registrationRequest (registratieverzoek) worden de gegevens in het aangeboden brondocument toegevoegd aan de BRO en wordt de registratie van een nieuw registratieobject gestart.
Voor nadere informatie over de inhoud van een GMN_StartRegistration brondocument zie GMN BCI Brondocumenten#GMN_StartRegistration.
Voor nadere informatie over de inhoud van een registrationRequest (registratieverzoek) zie GMN BCI BRO-Verzoeken#RegistrationRequest.
Voor een algemene inleiding tot de aanvullende regels, die tijdens het verwerken van een BRO-verzoek met een GMN brondocument worden gevalideerd, zie GMN BCI Levensloop.
De aanvullende regels voor deze combinatie van brondocument en BRO-verzoek staan in onderstaande tabel:
|
Aanvullende regels: GMN_StartRegistration in registrationRequest |
|---|
|
GMN_StartRegistration in een replaceRequest
Met een GMN_StartRegistration brondocument in een replaceRequest (vervangverzoek) wordt het geregistreerde brondocument vervangen door het aangeboden brondocument.
Voor nadere informatie over de inhoud van een GMN_StartRegistration brondocument zie .
Voor nadere informatie over de inhoud van een replaceRequest (vervangverzoek) zie GMN BCI BRO-Verzoeken#ReplaceRequest.
Een van de attributen in het replaceRequest (vervangverzoek) is correctionReason (correctie reden). Dit attribuut geeft aan waarom het registratieobject wordt vervangen. Afhankelijk van de waarde van het atribuut correctionReason (correctie reden) gelden er bepaalde aanvullende regels voor deze combinatie van brondocument en BRO-verzoek naast de regels in de gegevenscatalogus en de regels voor het replaceRequest (vervangverzoek):
|
Aanvullende regels: GMN_StartRegistration in replaceRequest |
|---|
|
Als de waarde van het attribuut correctionReason (correctie reden) gelijk is aan eigenCorrectie of inOnderzoek, mag het aangeboden brondocument meer, minder of andere MeasuringPoints (meetpunten) bevatten dan het geregistreerde brondocument. Daarbij gelden echter wel de algemene aanvullende regels zoals beschreven in GMN BCI Levensloop#Aanvullende regels. Dit heeft bijvoorbeeld tot gevolg:
-
Het GMN_StartRegistration brondocument mag niet een measuringPointCode (meetpuntcode) bevatten als die voorkomt in een geregistreerd GMN_MeasuringPoint brondocument (een meetpunt met een bestaande meetpuntcode kan niet worden toegevoegd).
-
Het GMN_StartRegistration brondocument moet een measuringPointCode (meetpuntcode) bevatten als die voorkomt in een geregistreerd GMN_MeasuringPointEndDate brondocument (alleen een bestaand meetpunt kan worden beëindigen).
-
Het GMN_StartRegistration brondocument moet een measuringPointCode (meetpuntcode) bevatten als die voorkomt in een geregistreerd GMN_TubeReference brondocument (een monitoringbuis kan alleen worden vervangen in een bestaand meetpunt).
-
Het GMN_StartRegistration brondocument mag niet een monitoringTube (monitoringbuis) bevatten als dat voorkomt in een geregistreerd GMN_MeasuringPoint brondocument (een monitoringbuis mag niet tegelijkertijd gebruikt worden in meerdere meetpunten binnen hetzelfde grondwatermonitoringnet).
-
Het GMN_StartRegistration brondocument mag niet een monitoringTube (monitoringbuis) bevatten als die voorkomt in het eerst volgende, geregistreerde GMN_TubeReference brondocument met dezelfde measuringPointCode (meetpuntcode) (een vervangende monitoringbuis moet afwijken van zijn voorgaande buisverwijzing).
De aanvullende regels en het opnieuw afleiden van gegevens wordt voor enkele praktische scnario's toegelicht in Scenario's voor GMN_StartRegistration correctieverzoeken.
GMN_StartRegistration in een moveRequest
Met een GMN_StartRegistration brondocument in een moveRequest (verplaatsverzoek) wordt het geregistreerde brondocument verplaatst op de tijdlijn.
Voor nadere informatie over de inhoud van een GMN_StartRegistration brondocument zie .
Voor nadere informatie over de inhoud van een moveRequest (verplaatsverzoek) zie GMN BCI BRO-Verzoeken.
Voor een algemene inleiding tot de aanvullende regels, die tijdens het verwerken van een BRO-verzoek met een GMN brondocument worden gevalideerd, zie GMN BCI Levensloop.
De aanvullende regels voor deze combinatie van brondocument en BRO-verzoek staan in onderstaande tabel:
|
Aanvullende regels: GMN_StartRegistration in moveRequest |
|---|
|
GMN_MeasuringPoint
Onderstaande figuur geeft een overzicht van de inhoud van het brondocument.
De eventDate (datum gebeurtenis) is de begindatum vanaf wanneer het meetpunt in gebruik is genomen. De overige gegevens zijn volledig gedefinieerd in de gegevenscatalogus.
Het brondocument kan met de onderstaande BRO-verzoeken aangeboden worden voor de onderstaande gebruiksdoelen:
|
request |
Gebruiksdoel |
|---|---|
|
registrationRequest |
Een meetpunt toevoegen aan een grondwatermonitoringnet. |
|
replaceRequest |
Niet van toepassing. De measuringPointCode (meetpuntcode) is een identificerend gegeven. Dat mag niet vervangen worden. In plaats daarvan moet bij een foutief aangeleverde waarde de geregistreerde buisverwijzing verwijderd worden en een nieuwe buisverwijzing met de juiste meetpuntcode worden toegevoegd (registrationRequest) of ingevoegd (insertRequest). |
|
insertRequest |
Invoegen van een meetpunt op de tijdlijn vóór de meest recente gebeurtenis. Bijvoorbeeld wanneer de laatste geregistreerde gebeurtenis heeft plaatsgevonden in september, en dat daarvoor, in bijvoorbeeld augustus een nieuw meetpunt in gebruik was genomen. |
|
moveRequest |
Verplaatsen van een meetpunt op de tijdlijn. Bijvoorbeeld als een onjuiste datum is geregistreerd waarop het meetpunt is toegevoegd aan het grondwatermonitoringnet. |
|
deleteRequest |
Verwijderen van een meetpunt. Bijvoorbeeld als een meetpunt is toegevoegd wat niet toegevoegd had moeten worden. |
Onderstaande tabel geeft de aanvullende regels (zie ook de GMN gegevenscatalogus en de GMN berichtencatalogus uitgiftewebservice):
|
BRO-verzoek |
Aanvullende regels |
|---|---|
|
registrationRequest |
|
|
insertRequest |
|
|
moveRequest |
|
|
deleteRequest |
|
GMN_TubeReference
Onderstaande figuur geeft een overzicht van de inhoud van het brondocument.
Toelichting bij de gegevens in het brondocument:
-
De eventDate (datum gebeurtenis) is de datum waarop de huidige (actuele) buisverwijzing van het meetpunt in het brondocument wordt vervangen door de buisverwijzingen in het brondocument. Onder het kwaliteitsregime IMBRO/A mag het attribuut eventDate (datum gebeurtenis) een onvolledige datum zijn. De waarde 'onbekend' is niet toegestaan.
-
De measuringPointCode (meetpuntcode) is de unieke identificatie van het meetpunt waarvan de buisverwijzing wordt vervangen.
-
De vervangende monitoringTube (monitoringbuis) bestaat uit:De broId (BRO-ID) van de grondwatermonitoringput.Het tubeNumber (buisnummer) van een buis in die put.
Het brondocument kan met de onderstaande BRO-verzoeken aangeboden worden voor de onderstaande gebruiksdoelen:
|
request |
Gebruiksdoel |
|---|---|
|
registrationRequest |
Vervangen van de huidige buisverwijzing door een andere buisverwijzing (eventueel een monitoringbuis in een andere grondwatermonitoringput). |
|
replaceRequest |
Herstellen van een fout in een geregistreerde buisverwijzing. Bijvoorbeeld wanneer het verkeerde buisnummer is geregistreerd. |
|
insertRequest |
Invoegen van een buisverwijzing op de tijdlijn. Bijvoorbeeld wanneer is geregistreerd dat in oktober het meetpunt wordt gevormd door buis 2 van put X maar dat vergeten is dat daarvoor sinds augustus het meetpunt werd gevormd door buis 3 van put Y. |
|
moveRequest |
Verplaatsen van een buisverwijzing op de tijdlijn. Bijvoorbeeld wanneer een onjuiste startdatum is geregistreerd bij een buisverwijzing. |
|
deleteRequest |
Verwijderen van een buisverwijzing van de tijdlijn. Bijvoorbeeld wanneer een meetpunt niet gedurende een bepaalde periode werd gevormd door een bepaalde buis van een grondwatermonitoringput. De buisverwijzing wordt hiermee ongedaan gemaakt. |
Onderstaande tabel geeft de aanvullende regels (zie ook de GMN gegevenscatalogus en de GMN berichtencatalogus uitgiftewebservice):
|
BRO-verzoek |
Aanvullende regels |
|---|---|
|
registrationRequest |
Na verwerking van het verzoek krijgt:
De volgende attributen worden afgeleid:
|
|
replaceRequest |
|
|
insertRequest |
|
|
moveRequest |
|
|
deleteRequest |
|
Als een huidige buisverwijzing wordt vervangen door een andere buisverwijzing, dan wordt bij de betreffende monitoringbuizen in de GMW grondwatermonitoringput(ten) de waarde van het gegeven 'buis in gebruik' aangepast zoals beschreven in de bovenstaande aanvullende regels, ook als een betreffende GMW grondwatermonitoringput al is opgeruimd.
GMN_MeasuringPointEndDate
Onderstaande figuur geeft een overzicht van de inhoud van het brondocument.
Toelichting bij de gegevens in het brondocument:
-
De eventDate (datum gebeurtenis) is de datum waarop het aangeleverde meetpunt wordt beëindigd (niet meer wordt gebruikt binnen het kader van dit grondwatermonitoringnet).
-
De measuringPointCode (meetpuntcode) is de unieke identificatie van het meetpunt dat wordt beëindigd.
Het brondocument kan met de onderstaande BRO-verzoeken aangeboden worden voor de onderstaande gebruiksdoelen:
|
request |
Gebruiksdoel |
|---|---|
|
registrationRequest |
Een meetpunt in een grondwatermonitoringnet buiten gebruik stellen. |
|
replaceRequest |
Niet van toepassing. Bij het buiten gebruik stellen van een meetpunt wordt alleen de gebeurtenis datum geregistreerd. Het corrigeren daarvan valt onder verplaatsen. |
|
insertRequest |
Niet van toepassing. Een meetpunt kan maar één keer buiten gebruik gesteld worden. Het ongedaan maken daarvan valt onder verwijderen. |
|
moveRequest |
Verplaatsen van de einddatum geldigheid van een of meerdere meetpunten op de tijdlijn. |
|
deleteRequest |
Verwijderen van de einddatum geldigheid bij een of meerdere meetpunten. Bijvoorbeeld wanneer een meetpunt ten onrechte buiten gebruik is gesteld. De buiten gebruik stelling wordt hiermee ongedaan gemaakt en het meetpunt is daarna weer actief. |
Onderstaande tabel geeft de aanvullende regels (zie ook de GMN gegevenscatalogus en de GMN berichtencatalogus uitgiftewebservice):
|
BRO-verzoek |
Aanvullende regels |
|---|---|
|
registrationRequest |
|
|
moveRequest |
|
|
deleteRequest |
|
Als een meetpunt in een grondwatermonitoringnet buiten gebruik wordt gesteld (het krijgt een waarde voor het gegeven einddatum meetpunt), dan wordt de op dat moment actuele buisverwijzing NIET beëindigd; er wordt op dat moment geen einddatum afgeleid voor de buisverwijzing. We hebben hier bewust voor gekozen zodat de bronhouder op een later moment makkelijk de laatste stand van zaken van het grondwatermonitoringnet kan achterhalen voordat het meetpunt buiten gebruik werd gesteld.
Wel moet bij het buiten gebruik stellen van een meetpunt voor de actuele buisverwijzing bij de betreffende monitoringbuis van de GMW grondwatermonitoringput de waarde van het gegeven 'buis in gebruik' op 'nee' worden gezet, tenzij de monitoringbuis nog in gebruik is bij een ander grondwatermonitoringnet. Dit wordt ook gedaan als de betreffende GMW grondwatermonitoringput al is opgeruimd.
GMN_Closure
Onderstaande figuur geeft een overzicht van de inhoud van het brondocument.
Toelichting bij de gegevens in het brondocument:
-
De endDateMonitoring (einddatum monitoring) is de datum waarop de registratie van het grondwatermonitoringnet wordt beëindigd.
Het brondocument kan met de onderstaande BRO-verzoeken aangeboden worden voor de onderstaande gebruiksdoelen:
|
request |
Gebruiksdoel |
|---|---|
|
registrationRequest |
Het beëindigen van de registratie van een grondwatermonitoringnet (niet meer gebruiken in een grondwaterstandsonderzoek noch een grondwatersamenstellingsonderzoek). |
|
replaceRequest |
Niet van toepassing. Bij het beëindigen van een registratie wordt alleen de einddatum monitoring geregistreerd. Het corrigeren daarvan valt onder verplaatsen. |
|
insertRequest |
Niet van toepassing. Een registratie kan maar één keer beëindigd worden. Het ongedaan maken van een beëindiging valt onder verwijderen. |
|
moveRequest |
Verplaatsen van de afsluiting op de tijdlijn. Bijvoorbeeld wanneer een onjuiste einddatum monitoring is geregistreerd. |
|
deleteRequest |
Verwijderen van de einddatum monitoring. Bijvoorbeeld wanneer de registratie van een grondwatermonitoringnet niet beëindigd had moeten worden. De beëindiging wordt ongedaan gemaakt en het grondwatermonitoringnet is daarna weer actief. |
Onderstaande tabel geeft de aanvullende regels (zie ook de GMN gegevenscatalogus en de GMN berichtencatalogus uitgiftewebservice):
|
BRO-verzoek |
Aanvullende regels |
|---|---|
|
registrationRequest |
|
|
moveRequest |
|
|
deleteRequest |
|
Als een grondwatermonitoringnet wordt beëindigd, dan worden de op dat moment actieve meetpunten en buisverwijzingen NIET beëindigd; er wordt op dat moment geen einddatum afgeleid voor het meetpunt en de buisverwijzing. We hebben hier bewust voor gekozen zodat de bronhouder op een later moment makkelijk de laatste stand van zaken van het grondwatermonitoringnet kan achterhalen voordat het grondwatermonitoringnet werd beëindigd.
Wel moet bij het beëindigen van een grondwatermonitoringnet voor de actuele buisverwijzing van de actieve meetpunten bij de betreffende monitoringbuis van de GMW grondwatermonitoringput de waarde van het gegeven 'buis in gebruik' op 'nee' worden gezet, tenzij de monitoringbuis nog in gebruik is bij een ander grondwatermonitoringnet. Dit wordt ook gedaan als de betreffende GMW grondwatermonitoringput al is opgeruimd.