VOORSTEL – TER BESPREKING Dit voorstel beschrijft de geplande uitbreidingen van de API voor de dienst burgerlijke stand (gemeente van overlijden). Het vertrekt van de huidige API (versie 1.20.3). Feedback van API-gebruikers is welkom, vooral op de open vragen onderaan.
Context
Artsen kunnen een vaststelling van overlijden na indiening vandaag niet meer aanpassen in eLys. Bij een fout bezorgen ze een attest van wijziging aan de gemeente, buiten eLys om. Met deze uitbreiding kan de arts in eLys zelf:
-
het tijdstip van vaststelling en/of het tijdstip van overlijden wijzigen;
-
de plaats van overlijden wijzigen (eventueel naar een andere gemeente);
-
melden dat de verkeerde persoon werd doodverklaard.
Zo'n wijziging past het dossier van de gemeente niet rechtstreeks aan. Ze komt binnen als een wijzigingsaanvraag die de gemeente van overlijden moet aanvaarden. De wijzigingsaanvraag geldt als bewijsstuk en vervangt het attest dat vandaag per mail bezorgd wordt.
Kernprincipes
-
Een wijzigingsaanvraag wordt altijd gericht aan het lokaal bestuur dat het dossier op dat moment behandelt. Bij een wijziging van plaats naar een andere gemeente is dat de oude gemeente.
-
De gegevens van het dossier wijzigen pas bij aanvaarding. Pas dan worden de nieuwe waarden ook doorgegeven aan crematorium, begraafplaats en Departement Zorg.
-
Een gemeente kan een wijzigingsaanvraag niet weigeren. Ze kan het dossier wel niet afsluiten (status
BEHANDELD) zolang er openstaande wijzigingsaanvragen zijn. -
Per type is er maximaal één openstaande wijzigingsaanvraag. Er kunnen wel meerdere aanvaarde aanvragen van hetzelfde type zijn.
-
De arts kan wijzigingen indienen zolang het dossier niet in status
BEHANDELDstaat. Wordt een dossier heropend, dan kan de arts opnieuw wijzigen. -
Elke wijzigingsaanvraag wordt afzonderlijk aanvaard (zie open vragen).
Overzicht van de wijzigingen
|
# |
Endpoint |
Soort |
Impact voor API-gebruikers |
|---|---|---|---|
|
1 |
|
UITBREIDING |
Nieuw veld |
|
2 |
|
UITBREIDING |
Nieuwe filter |
|
3 |
|
NIEUW |
Aanvaarden van een wijzigingsaanvraag. |
|
4 |
|
NIEUW |
Opvragen van één aanvraag en het bijhorende attest (PDF) als bewijsstuk. |
|
5 |
|
GEDRAGSWIJZIGING |
Afsluiten wordt geweigerd zolang er openstaande wijzigingsaanvragen zijn. Foutafhandeling aanpassen. |
|
6 |
|
UITBREIDING |
Nieuwe waarden voor |
|
7 |
|
AANDACHTSPUNT |
De verplichte boodschap wordt voortaan getoond aan de arts. |
Alle paden hieronder starten met /burgerlijke-stand/v1/dossiers/{dossiernummer}, tenzij anders vermeld.
1. Wijzigingsaanvragen in het dossier
Aan DossierBurgerlijkeStandJSON wordt een lijst wijzigingsaanvragen toegevoegd. Die bevat zowel openstaande als eerder aanvaarde, vervangen of vervallen aanvragen. De lijst is leeg als er geen aanvragen zijn.
Omdat het volledige dossier ook in /v2/dossiers en /v1/dossiers/gewijzigd zit, zijn de wijzigingsaanvragen daar automatisch beschikbaar.
Voorbeeld
"wijzigingsaanvragen": [
{
"id": "6f1c2a90-3b1e-4c55-9a0e-1d2b7c8e4f10",
"type": "TIJDSTIP_OVERLIJDEN",
"status": "OPENSTAAND",
"ingediendOp": "2026-11-06T18:12:00+01:00",
"ingediendDoor": {
"registratie": "10212714001",
"naam": "Faict",
"voornaam": "Jonas"
},
"toelichting": "Uur van overlijden foutief ingegeven. Volgens de thuisverpleging was het overlijden om 09u45.",
"oudeWaarde": { "datum": "2026-11-06T10:08:00+01:00" },
"nieuweWaarde": { "datum": "2026-11-06T09:45:00+01:00" },
"aanvaardOp": null,
"aanvaardBoodschap": null,
"attestURI": "https://…/burgerlijke-stand/v1/dossiers/20261106-005-C7VF/wijzigingsaanvragen/6f1c2a90-…/attest"
}
]
Velden
|
Veld |
Type |
Beschrijving |
|---|---|---|
|
|
string (UUID) |
Unieke identificatie van de aanvraag. |
|
|
enum |
Zie Types. |
|
|
enum |
Zie Statussen. |
|
|
date-time |
Tijdstip waarop de arts de aanvraag indiende. |
|
|
|
De arts die de aanvraag indiende (bestaand schema). |
|
|
string |
Verplichte toelichting van de arts. |
|
|
object |
Waarde vóór en na de wijziging. De structuur hangt af van het type. Niet ingevuld voor |
|
|
date-time |
Ingevuld zodra de aanvraag aanvaard is. |
|
|
string |
Optionele boodschap die de gemeente meegaf bij het aanvaarden. |
|
|
uri |
Link naar het attest (PDF) van deze aanvraag. |
Types
|
Type |
Structuur oudeWaarde / nieuweWaarde |
Opmerking |
|---|---|---|
|
|
|
Komt overeen met de datum van het medisch verslag van de vaststelling. |
|
|
|
Komt overeen met |
|
|
|
|
|
|
geen |
Melding dat de vaststelling voor de verkeerde persoon werd ingediend. Een eventueel correct rijksregisternummer kan de arts in de toelichting vermelden. |
Statussen
|
Status |
Wanneer |
|---|---|
|
|
De arts heeft de aanvraag ingediend en de gemeente heeft ze nog niet aanvaard. |
|
|
De gemeente heeft de aanvraag aanvaard. Het dossier is aangepast. |
|
|
De arts heeft een nieuwe aanvraag van hetzelfde type ingediend terwijl deze nog openstond. De nieuwe aanvraag krijgt status |
|
|
De aanvraag is niet meer relevant door een actie van de gemeente of een andere aanvraag (zie punt 7). |
Waarom VERVANGEN in plaats van de aanvraag te overschrijven? Zo kan een systeem dat een aanvraag al getoond of opgeslagen heeft, zien dat die niet meer geldig is. Het aanvaarden gebeurt altijd op een specifiek id, zodat de gemeente zeker de versie aanvaardt die ze gezien heeft.
Laatste wijziging
Het indienen van een nieuwe aanvraag (ook een vervangende) past laatsteWijziging van het dossier aan. Daardoor verschijnt het dossier in GET /burgerlijke-stand/v1/dossiers/gewijzigd. Er is geen nieuw gebeurtenistype nodig.
2. Filter op openstaande wijzigingsaanvragen
GET /burgerlijke-stand/v2/dossiers krijgt een nieuwe optionele queryparameter, naar analogie met de bestaande heeft…-filters:
|
Parameter |
Type |
Beschrijving |
|---|---|---|
|
|
boolean |
Enkel dossiers met ( |
3. Wijzigingsaanvraag aanvaarden
POST /burgerlijke-stand/v1/dossiers/{dossiernummer}/wijzigingsaanvragen/{id}/aanvaarden
Request body (optioneel): het bestaande schema Optionele Boodschap.
{ "boodschap": "Overlijdensakte aangepast." }
Gevolg bij aanvaarden
|
Type |
Gevolg |
|---|---|
|
|
Het tijdstip in het dossier wordt aangepast. |
|
|
De plaats in het dossier wordt aangepast. |
|
|
De plaats wordt aangepast en het dossier wordt overgedragen aan het nieuwe lokaal bestuur, op dezelfde manier als het bestaande endpoint |
|
|
Het dossier gaat naar status |
In alle gevallen worden laatsteWijziging en de historiek bijgewerkt, en worden de nieuwe waarden doorgegeven aan crematorium, begraafplaats en Departement Zorg.
Responses
|
Code |
Wanneer |
|---|---|
|
|
Aanvraag aanvaard. |
|
|
Dossier of aanvraag niet gevonden, of de aanvraag hoort niet bij dit dossier. |
|
|
De aanvraag heeft status |
4. Bewijsstuk opvragen
GET /burgerlijke-stand/v1/dossiers/{dossiernummer}/wijzigingsaanvragen/{id}
GET /burgerlijke-stand/v1/dossiers/{dossiernummer}/wijzigingsaanvragen/{id}/attest
-
Het eerste endpoint geeft één wijzigingsaanvraag terug (zelfde structuur als in het dossier), ongeacht de status.
-
Het tweede endpoint geeft een PDF met de verklaring van de arts, de oude en nieuwe waarde en de toelichting. Dit document vervangt het attest van wijziging dat vandaag buiten eLys bezorgd wordt.
voorbeeld PDF wordt later toegevoegd
5. Afsluiten bij openstaande wijzigingsaanvragen
Gedragswijziging. Bestaande integraties moeten deze nieuwe foutmelding opvangen en aan de gebruiker tonen.
Aan POST …/afsluiten wordt een voorwaarde toegevoegd: er mogen geen wijzigingsaanvragen met status OPENSTAAND zijn. Is dat wel het geval, dan wordt het afsluiten geweigerd met een ErrorDTO:
{
"status": 409,
"type": "openstaande-wijzigingsaanvragen",
"title": "Het dossier heeft openstaande wijzigingsaanvragen",
"detail": "Aanvaard eerst alle openstaande wijzigingsaanvragen voordat u het dossier afsluit.",
"structuredDetails": ["6f1c2a90-3b1e-4c55-9a0e-1d2b7c8e4f10"]
}
structuredDetails bevat de id's van de openstaande aanvragen.
6. Historiek
HistoriekGebeurtenis krijgt nieuwe enumwaarden. Het veld message bevat de toelichting van de arts (bij ontvangst) of de boodschap van de gemeente (bij aanvaarding).
|
Veld |
Nieuwe waarden |
|---|---|
|
|
|
|
|
|
Bij aanvaarding van een melding VERKEERDE_PERSOON volgt een gebeurtenis DOSSIER_VERWIJDERD met reden VERWIJDERD_NA_MELDING_ARTS, naast het bestaande MANUEEL_VERWIJDERD. De oude en nieuwe waarden zitten in de wijzigingsaanvraag zelf en worden niet in de historiek herhaald.
7. Verwijderen en andere bestaande acties
Verwijderen
-
De verplichte
boodschapbijPOST …/verwijderenwordt voortaan getoond aan de arts die de vaststelling indiende. Vermeld daarin dus geen interne notities. -
Openstaande wijzigingsaanvragen krijgen bij het verwijderen status
VERVALLEN.
Wijzig plaats van overlijden door de gemeente
Het bestaande endpoint POST …/wijzig-plaats-overlijden blijft ongewijzigd beschikbaar. Gebruikt de gemeente dit endpoint terwijl er een openstaande aanvraag van type PLAATS_OVERLIJDEN is, dan krijgt die aanvraag status VERVALLEN. Andere openstaande aanvragen verhuizen mee met het dossier.
Heropenen
Na POST …/heropen staat het dossier opnieuw in IN_BEHANDELING, waardoor de arts weer wijzigingsaanvragen kan indienen. Er verandert niets aan het endpoint zelf.
Voorbeeldscenario
-
De arts dient een wijziging van het tijdstip van overlijden in. Het dossier verschijnt in
/v1/dossiers/gewijzigdmet een aanvraagOPENSTAAND. -
De software van de gemeente toont de aanvraag aan de ambtenaar, met oude en nieuwe waarde, toelichting en attest.
-
De ambtenaar verwerkt de wijziging in de eigen toepassing (bijvoorbeeld de akte) en roept
…/aanvaardenaan. -
Het dossier bevat nu het nieuwe tijdstip, de aanvraag staat op
AANVAARDen de historiek bevatWIJZIGINGSAANVRAAG_AANVAARD. -
De gemeente kan het dossier afsluiten.
Open vragen voor API-gebruikers
- Aanvaarden per aanvraag of per dossier? Het voorstel gaat uit van aanvaarden per aanvraag. Is het in jullie toepassing handiger om alle openstaande aanvragen van een dossier in één keer te aanvaarden?
- Afsluiten: welke overgangsperiode hebben jullie nodig om de nieuwe foutmelding bij afsluiten te ondersteunen?
- Ophalen van wijzigingen: volstaat het om nieuwe aanvragen te detecteren via
laatsteWijzigingin/v1/dossiers/gewijzigd, of is een aparte gebeurtenis gewenst?