Implementation¶
The StUF-BG specification does not map exactly to the Haal Centraal BRP API. There are several implementation details that are documented below, starting with a mapping of all API to StUF-BG attributes.
If an attribute mapping has no design decision remarks, the attribute value is not changed.
StUF-BG attribute notation¶
attribute
- API value is derived directly fromattribute
.FUNCTION(
attribute
) - API value is derived fromattribute
via a specific FUNCTION. These FUNCTIONs should be self explanatory.“value” - API value is staticly set to this “value”.
(
attribute
== “value”) - API value is derived from simple calculation.(calculated) - API value is derived from complex calculation. The remarks should indicate how exactly.
Ingeschreven persoon¶
API attribute |
StUF-BG attribute |
Design decision remarks |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
( |
One of the multiple inOnderzoek occurrances matches |
|
( |
One of the multiple inOnderzoek occurrances matches |
|
( |
One of the multiple inOnderzoek occurrances matches |
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
(calculated) |
See features |
|
(calculated) |
See features |
|
(calculated) |
See features |
|
|
|
|
DAY( |
|
|
|
|
|
YEAR( |
|
|
MONTH( |
|
|
COUNTRY_CODE( |
|
|
|
|
|
CITY_CODE( |
|
|
|
|
|
( |
One of the multiple inOnderzoek occurrances matches |
|
( |
One of the multiple inOnderzoek occurrances matches |
|
( |
One of the multiple inOnderzoek occurrances matches |
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
|
|
|
(calculated) |
See features |
|
DAY( |
|
|
|
|
|
YEAR( |
|
|
MONTH( |
|
|
( |
StUF-BG value “2” evaluates to “true”. |
|
( |
StUF-BG value “A” evaluates to “true”. |
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
( |
One of the multiple inOnderzoek occurrances matches |
|
( |
One of the multiple inOnderzoek occurrances matches |
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
|
|
|
DAY( |
|
|
|
|
|
YEAR( |
|
|
MONTH( |
|
|
|
|
|
|
|
|
REDEN_CODE( |
|
|
|
|
|
( |
One of the multiple inOnderzoek occurrances matches |
|
( |
One of the multiple inOnderzoek occurrances matches |
|
|
TODO |
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
|
|
|
DAY( |
|
|
|
|
|
YEAR( |
|
|
MONTH( |
|
|
( |
|
|
DAY( |
|
|
|
|
|
YEAR( |
|
|
MONTH( |
|
|
COUNTRY_CODE( |
|
|
|
|
|
CITY_CODE( |
|
|
|
|
|
( |
One of the multiple inOnderzoek occurrances matches |
|
( |
One of the multiple inOnderzoek occurrances matches |
|
( |
One of the multiple inOnderzoek occurrances matches |
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
|
TODO |
|
|
|
|
|
|
|
|
|
|
null |
TODO |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TODO |
|
|
|
|
|
|
|
|
TODO |
|
DAY( |
|
|
|
|
|
YEAR( |
|
|
MONTH( |
|
|
DAY( |
|
|
|
|
|
YEAR( |
|
|
MONTH( |
|
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
|
|
|
|
|
|
“” |
TODO |
|
“” |
TODO |
|
|
|
|
|
|
|
|
|
|
|
TODO |
|
COUNTRY_CODE(sub.verblijfBuitenland.lnd.landcode) |
|
|
|
|
|
|
TODO |
|
|
TODO |
|
|
TODO |
|
|
TODO |
|
|
TODO |
|
( |
|
|
( |
|
|
( |
|
|
( |
|
|
( |
|
|
( |
|
|
( |
|
|
( |
|
|
( |
|
|
( |
|
|
( |
|
|
( |
|
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
|
|
|
|
|
|
( |
|
|
( |
|
|
( |
|
|
( |
|
|
( |
|
|
( |
|
|
|
|
|
(calculated) |
Obtained from mapping https://publicaties.rvig.nl/dsresource?objectid=4801&type=org |
|
DAY( |
|
|
|
|
|
YEAR( |
|
|
MONTH( |
|
|
DAY( |
|
|
|
|
|
YEAR( |
|
|
MONTH( |
|
|
( |
One of the multiple inOnderzoek occurrances matches |
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
null |
|
|
null |
Kind¶
API attribute |
StUF-BG attribute |
Design decision remarks |
---|---|---|
burgerservicenummer |
|
|
geheimhoudingPersoonsgegevens |
|
|
naam.geslachtsnaam |
|
|
naam.voorletters |
|
|
naam.voornamen |
|
|
naam.voorvoegsel |
|
|
naam.inOnderzoek.geslachtsnaam |
( |
One of the multiple inOnderzoek occurrances matches |
naam.inOnderzoek.voornamen |
( |
One of the multiple inOnderzoek occurrances matches |
naam.inOnderzoek.voorvoegsel |
( |
One of the multiple inOnderzoek occurrances matches |
naam.inOnderzoek.datumIngangOnderzoek.dag |
null |
|
naam.inOnderzoek.datumIngangOnderzoek.datum |
null |
|
naam.inOnderzoek.datumIngangOnderzoek.jaar |
null |
|
naam.inOnderzoek.datumIngangOnderzoek.maand |
null |
|
geboorte.datum.dag |
DAY( |
|
geboorte.datum.datum |
|
|
geboorte.datum.jaar |
YEAR( |
|
geboorte.datum.maand |
MONTH( |
|
geboorte.land.code |
COUNTRY_CODE( |
|
geboorte.land.omschrijving |
|
|
geboorte.plaats.code |
CITY_CODE( |
|
geboorte.plaats.omschrijving |
|
|
geboorte.inOnderzoek.datum |
( |
One of the multiple inOnderzoek occurrances matches |
geboorte.inOnderzoek.land |
( |
One of the multiple inOnderzoek occurrances matches |
geboorte.inOnderzoek.plaats |
( |
One of the multiple inOnderzoek occurrances matches |
geboorte.inOnderzoek.datumIngangOnderzoek.dag |
null |
|
geboorte.inOnderzoek.datumIngangOnderzoek.datum |
null |
|
geboorte.inOnderzoek.datumIngangOnderzoek.jaar |
null |
|
geboorte.inOnderzoek.datumIngangOnderzoek.maand |
null |
|
leeftijd |
(calculated) |
See features |
inOnderzoek.burgerservicenummer |
( |
One of the multiple inOnderzoek occurrances matches |
inOnderzoek.datumIngangOnderzoek.dag |
null |
|
inOnderzoek.datumIngangOnderzoek.datum |
null |
|
inOnderzoek.datumIngangOnderzoek.jaar |
null |
|
inOnderzoek.datumIngangOnderzoek.maand |
null |
Ouder¶
API attribute |
StUF-BG attribute |
Design decision remarks |
---|---|---|
burgerservicenummer |
|
|
geslachtsaanduiding |
|
|
ouderAanduiding |
|
|
datumIngangFamilierechtelijkeBetrekking.dag |
DAY( |
|
datumIngangFamilierechtelijkeBetrekking.datum |
inp.heeftAlsOuders.datumIngangFamilierechtelijkeBetrekking |
|
datumIngangFamilierechtelijkeBetrekking.jaar |
YEAR( |
|
datumIngangFamilierechtelijkeBetrekking.maand |
MONTH( |
|
naam.geslachtsnaam |
|
|
naam.voorletters |
|
|
naam.voornamen |
|
|
naam.voorvoegsel |
|
|
naam.inOnderzoek.geslachtsnaam |
( |
One of the multiple inOnderzoek occurrances matches |
naam.inOnderzoek.voornamen |
( |
One of the multiple inOnderzoek occurrances matches |
naam.inOnderzoek.voorvoegsel |
( |
One of the multiple inOnderzoek occurrances matches |
naam.inOnderzoek.datumIngangOnderzoek.dag |
null |
|
naam.inOnderzoek.datumIngangOnderzoek.datum |
null |
|
naam.inOnderzoek.datumIngangOnderzoek.jaar |
null |
|
naam.inOnderzoek.datumIngangOnderzoek.maand |
null |
|
inOnderzoek.burgerservicenummer |
( |
One of the multiple inOnderzoek occurrances matches |
inOnderzoek.datumIngangFamilierechtelijkeBetrekking |
null |
|
inOnderzoek.geslachtsaanduiding |
( |
One of the multiple inOnderzoek occurrances matches |
inOnderzoek.datumIngangOnderzoek.dag |
null |
|
inOnderzoek.datumIngangOnderzoek.datum |
null |
|
inOnderzoek.datumIngangOnderzoek.jaar |
null |
|
inOnderzoek.datumIngangOnderzoek.maand |
null |
|
geboorte.datum.dag |
DAY( |
|
geboorte.datum.datum |
|
|
geboorte.datum.jaar |
YEAR( |
|
geboorte.datum.maand |
MONTH( |
|
geboorte.land.code |
COUNTRY_CODE( |
|
geboorte.land.omschrijving |
|
|
geboorte.plaats.code |
CITY_CODE( |
|
geboorte.plaats.omschrijving |
|
|
geboorte.inOnderzoek.datum |
( |
One of the multiple inOnderzoek occurrances matches |
geboorte.inOnderzoek.land |
( |
One of the multiple inOnderzoek occurrances matches |
geboorte.inOnderzoek.plaats |
( |
One of the multiple inOnderzoek occurrances matches |
geboorte.inOnderzoek.datumIngangOnderzoek.dag |
null |
|
geboorte.inOnderzoek.datumIngangOnderzoek.datum |
null |
|
geboorte.inOnderzoek.datumIngangOnderzoek.jaar |
null |
|
geboorte.inOnderzoek.datumIngangOnderzoek.maand |
null |
|
geheimhoudingPersoonsgegevens |
|
Partner¶
API attribute |
StUF-BG attribute |
Design decision remarks |
---|---|---|
burgerservicenummer |
|
|
geslachtsaanduiding |
|
|
soortVerbintenis |
|
|
naam.geslachtsnaam |
|
|
naam.voorletters |
|
|
naam.voornamen |
|
|
naam.voorvoegsel |
|
|
naam.inOnderzoek.geslachtsnaam |
( |
One of the multiple inOnderzoek occurrances matches |
naam.inOnderzoek.voornamen |
( |
One of the multiple inOnderzoek occurrances matches |
naam.inOnderzoek.voorvoegsel |
( |
One of the multiple inOnderzoek occurrances matches |
naam.inOnderzoek.datumIngangOnderzoek.dag |
1 |
Fixed value since not in StUF-BG and cannot be |
naam.inOnderzoek.datumIngangOnderzoek.datum |
null |
|
naam.inOnderzoek.datumIngangOnderzoek.jaar |
1900 |
Fixed value since not in StUF-BG and cannot be |
naam.inOnderzoek.datumIngangOnderzoek.maand |
1 |
Fixed value since not in StUF-BG and cannot be |
geboorte.datum.dag |
DAY( |
|
geboorte.datum.datum |
|
|
geboorte.datum.jaar |
YEAR( |
|
geboorte.datum.maand |
MONTH( |
|
geboorte.land.code |
COUNTRY_CODE( |
|
geboorte.land.omschrijving |
|
|
geboorte.plaats.code |
CITY_CODE( |
|
geboorte.plaats.omschrijving |
|
|
geboorte.inOnderzoek.datum |
( |
One of the multiple inOnderzoek occurrances matches |
geboorte.inOnderzoek.land |
( |
One of the multiple inOnderzoek occurrances matches |
geboorte.inOnderzoek.plaats |
( |
One of the multiple inOnderzoek occurrances matches |
geboorte.inOnderzoek.datumIngangOnderzoek.dag |
1 |
Fixed value since not in StUF-BG and cannot be |
geboorte.inOnderzoek.datumIngangOnderzoek.datum |
null |
|
geboorte.inOnderzoek.datumIngangOnderzoek.jaar |
1900 |
Fixed value since not in StUF-BG and cannot be |
geboorte.inOnderzoek.datumIngangOnderzoek.maand |
1 |
Fixed value since not in StUF-BG and cannot be |
inOnderzoek.burgerservicenummer |
( |
One of the multiple inOnderzoek occurrances matches |
inOnderzoek.geslachtsaanduiding |
( |
One of the multiple inOnderzoek occurrances matches |
inOnderzoek.datumIngangOnderzoek.dag |
1 |
Fixed value since not in StUF-BG and cannot be |
inOnderzoek.datumIngangOnderzoek.datum |
null |
|
inOnderzoek.datumIngangOnderzoek.jaar |
1900 |
Fixed value since not in StUF-BG and cannot be |
inOnderzoek.datumIngangOnderzoek.maand |
1 |
Fixed value since not in StUF-BG and cannot be |
aangaanHuwelijkPartnerschap.datum.dag |
DAY( |
|
aangaanHuwelijkPartnerschap.datum.datum |
|
|
aangaanHuwelijkPartnerschap.datum.jaar |
YEAR( |
|
aangaanHuwelijkPartnerschap.datum.maand |
MONTH( |
|
aangaanHuwelijkPartnerschap.land.code |
COUNTRY_CODE( |
|
aangaanHuwelijkPartnerschap.land.omschrijving |
|
|
aangaanHuwelijkPartnerschap.plaats.code |
CITY_CODE( |
|
aangaanHuwelijkPartnerschap.plaats.omschrijving |
|
|
aangaanHuwelijkPartnerschap.inOnderzoek.datum |
( |
One of the multiple inOnderzoek occurrances matches |
aangaanHuwelijkPartnerschap.inOnderzoek.land |
( |
One of the multiple inOnderzoek occurrances matches |
aangaanHuwelijkPartnerschap.inOnderzoek.plaats |
( |
One of the multiple inOnderzoek occurrances matches |
aangaanHuwelijkPartnerschap.inOnderzoek.datumIngangOnderzoek.dag |
1 |
Fixed value since not in StUF-BG and cannot be |
aangaanHuwelijkPartnerschap.inOnderzoek.datumIngangOnderzoek.datum |
null |
|
aangaanHuwelijkPartnerschap.inOnderzoek.datumIngangOnderzoek.jaar |
1900 |
Fixed value since not in StUF-BG and cannot be |
aangaanHuwelijkPartnerschap.inOnderzoek.datumIngangOnderzoek.maand |
1 |
Fixed value since not in StUF-BG and cannot be |
geheimhoudingPersoonsgegevens |
|