Toepasbare regels aanleveren

Een SOAP API voor het toepasbaar maken van activiteiten en het aanleveren en beheren van toepasbare regels.

Label: Toepasbare regels

Endpoint Pre-productieomgeving

https://pkio.service.pre.omgevingswet.overheid.nl/overheid/toepasbare-regels/aanleverentoepasbareregels/v1

Endpoint Productieomgeving

https://pkio.service.omgevingswet.overheid.nl/overheid/toepasbare-regels/aanleverentoepasbareregels/v1

Beveiligde REST-service

Vraag toegang aan voor deze beveiligde REST-service (Pre-productieomgeving) via het aanvraagformulier.

Voor toegang tot de Productieomgeving overlegt u met het aansluitteam.

Omschrijving

Om de geldende wet- en regelgeving voor een bepaalde activiteit en werkingsgebied te ontsluiten in een voor initiatiefnemers begrijpelijke vorm, worden juridische regels vertaald naar zogeheten 'toepasbare regels'. Deze toepasbare regels moeten voldoen aan de Standaard Toepasbare Regels (STTR) en het onderliggende Informatiemodel Toepasbare Regels (IMTR).

Via annotaties in Omgevingsdocumenten worden geannoteerde activiteiten, de link naar de juridische bronnen en de bijbehorende locaties na aanlevering aan het DSO, doorgezet naar de Registratie Toepasbare Regels (RTR). Daarbij hebben activiteiten een begindatum en (verderop in de tijd) mogelijk ook een einddatum. Tussen deze twee datums in is de activiteit ‘in werking’ in het Omgevingsloket.

Aan activiteiten in de RTR kunnen de voor die activiteit relevante toepasbare regels gehangen worden.

Om dat te kunnen doen moeten aan de activiteit eerst een aantal kenmerken worden toegevoegd, het ‘toepasbaar maken’ van de activiteit.

Per activiteit worden de toepasbare regels opgenomen in een ‘verzameling regels die over hetzelfde juridische onderdeel gaan’, zoals een vergunningcheck, indieningsvereisten van een bepaald soort (melding, vergunning, etcetera) of maatregelen op maat. Deze verzameling van dezelfde regels wordt getypeerd als regelbeheerobject.

Met de Toepasbare regels aanleveren service kan één van de volgende drie enkelvoudige opdrachten worden uitgevoerd:

  1. Het 'toepasbaar maken van een activiteit'. Het vullen of muteren van de attributen van een activiteit in de Registratie Toepasbare Regels (RTR), die de activiteit toepasbaar maken. Dit is inclusief het toevoegen van regelbeheerobjecten en het eventueel koppelen aan een werkzaamheid. De toepasbare kenmerken hebben een begin en een einddatum. Door iets te wijzigen ontstaan er versies van de toepasbare activiteit in de tijd.
  2. Het aanleveren van een toepasbare regelbestand voor een activiteit per regelbeheerobject. Op het Omgevingsloket kan voor een datum in de toekomst (minimaal morgen) een toepasbare regelbestand worden aangeleverd. Op de oefenomgeving van het Omgevingsloket kan het toepasbare regelbestand per direct ingaan.
  3. Het verwijderen van een toepasbare regelbestand (met een ingangsdatum in de toekomst) van een activiteit per regelbeheerobject.

Met de Toepasbare regels aanleveren service kan één opdracht met één bijbehorend toepasbare regelbestand per keer worden aangeleverd en verwerkt:

  • óf het vullen of muteren van de toepasbare attributen van één activiteit inclusief de bijhorende regelbeheerobjecten
  • óf het aanleveren of muteren van één toepasbare regelbestand en deze koppelen aan het juiste regelbeheerobject van de activiteit
  • óf het verwijderen van één toepasbare regelbestand met een ingangsdatum in de toekomst.

Toepasbaar maken activiteiten en toevoegen regelbeheerobjecten

Om toepasbare regels aan te leveren en uit te voeren moeten activiteiten ‘toepasbaar’ gemaakt worden. Hiervoor moeten de toepasbare attributen van de activiteit worden gevuld en de regelbeheerobjecten worden aangeleverd. De attributen als geldigheidsdatum, de link naar juridische regels en locaties die vanuit het omgevingsdocument bij de activiteit horen, kunnen niet via deze opdracht gemuteerd worden. Dit zijn aanpassingen aan de annotaties van het omgevingsdocument.

Met de enkelvoudige opdracht 'updateActiviteit' en het bestand *.json kunnen deze attributen en regelbeheerobjecten worden aangeleverd. Ook het koppelen van activiteiten aan werkzaamheden kan via deze opdracht. Als een activiteit aan een werkzaamheid is gekoppeld zijn de toepasbare regels van de vergunning check of maatregelen op maat zichtbaar in het Omgevingsloket.  Zie ook toepasbare_activiteit.yaml en voorbeeldbestanden bij Aanvullende informatie onderaan deze pagina. De regelbeheerobjecten hebben een typering (Conclusie, Indieningsvereisten of Maatregelen) en een toestemming in het geval van Indieningsvereisten (zie voor de toestemmingen, bijlage 1 van de Standaard Toepasbare Regels).

Met regelbeheerobjecten en werkzaamheden kunnen activiteiten worden aan- en uitgezet (zichtbaar en vindbaar worden gemaakt) in het Omgevingsloket. Een activiteit toepasbaar maken start of beëindigt / verwijdert echter niet het toepasbare regelbestand. Zie daarvoor de paragraaf Verwijderen toepasbare regels.

Met de enkelvoudige opdracht 'updateActiviteit' kan een activiteit in de RTR toepasbaar worden gemaakt.

Aanleveren toepasbare regels

Toepasbare regels kunnen worden aangeleverd en gekoppeld aan een regelbeheerobject van een activiteit.

Met de enkelvoudige opdracht

'toevoegenToepasbareRegels',

'toevoegenToepasbareRegelsAansluiting',

'toevoegenToepasbareRegelsAansluitpunt',

'toevoegenToepasbareRegelsStandaardAansluiting' of

'toevoegenToepasbareRegelsLokaleAansluiting'

in combinatie met een geldigheid (begin- en einddatum) en het toepasbare regelbestand (bijvoorbeeld: sttr.xml)  kunnen de toepasbare regels worden aangeleverd.

Bij een lokale aansluiting moet daar ook een locatie aan worden toegevoegd (meestal de bestuurlijke grens van het aanleverende bevoegd gezag).

Het toepasbare regelbestand wordt na het aanleveren op een aantal manieren geverifieerd. Er wordt gecontroleerd of het bestand voldoet aan de eisen van STTR/IMTR. De verificatie kent de volgende methoden:

  • Syntactisch – Tegen de XSD van DMN en de XSD’s van de + laag (Bedrijfsregels, Uitvoeringsregels, Interactieregels, Content). Hier wordt gecontroleerd of de structuur van het bestand correct is volgens de XSD’s.
  • Semantisch – Met behulp van Schematron (ISO Standaard). Hier wordt gecontroleerd of de onderlinge relaties in het bestand logisch en correct zijn en of het bestand consistent en volledig is.
  • Functionele verificatie – Door de achterliggende componenten. Bijvoorbeeld of de GEO-gegevens vindbaar zijn in OZON; dat wil zeggen dat het locatieobject bestaat.

Voor de details van de verificatie zie hoofdstuk Verificaties van het IMTR document.

Als de verificatie niet slaagt, dan beantwoordt de service dit met één of meerdere verificatiemeldingen met als mogelijk:

  • de verificatiemethode
  • de reden van de melding en bijbehorende oplossing/eis
  • het element binnen het toepasbare regelbestand

Verwijderen toepasbare regels

Wanneer een toepasbare regelbestand nog niet in werking is getreden kan op basis van het bestand-ID worden verwijderd. Het bestand-ID is te raadplegen via de RTR (Registratie Toepasbare Regels) en de API Raadplegen RTR gegevens.

Met de enkelvoudige opdracht 'verwijderToepasbareRegels' kunnen deze toekomstige toepasbare regels worden verwijderd.

Het verwijderen (of eigenlijk beëindigen, er wordt een einddatum gezet) van een toepasbare regelbestand wat al in werking is, kan door op een datum in de toekomst een nieuw toepasbare regelbestand aan te leveren, waarbij de begindatum hetzelfde is als de einddatum. Hiermee krijgt het huidige in werking zijnde toepasbare regelbestand in de RTR automatisch de einddatum een dag vóór de begindatum van het toekomstige toepasbare regelbestand.

Er komen meer mogelijkheden om versies van toepasbare regelbestanden te beheren, die worden in 2024 nader uitgewerkt.

Aanvullende informatie

De Toepasbare regels aanleveren service wordt aangeboden via een Digikoppeling ebMS waarbij er een zip-bestand wordt aangeleverd met daarin een aantal bestanden, afhankelijk van de opdracht:

  1. xml: bevat een overzicht van alle bestanden in het zip-bestand (zie manifest.xsd (m7z, 644 bytes))1
  2. xml: bevat de opdracht die moet worden uitgevoerd (1 van de 6 mogelijke opdrachten, zie opdracht.xsd (m7z, 1 kB))1
  3. json: bevat toepasbare attributen van de activiteit inclusief de gewenste regelbeheerobjecten (zie toepasbare_activiteit.yaml (m7z, 1.2 kB))1
  4. .*: bevat het toepasbare regelbestand (extensie niet voorgeschreven). Het toepasbare regelbestand moet voldoen aan de Standaard Toepasbare Regels (STTR)

Zie voor meer informatie Koppelvlak aanleveren toepasbare regels v1.7. pdf (pdf, 1.1 MB). Bovenvermelde bestanden (xsd’s en yaml) zijn bijlagen bij dit document.

Als voorbeeldbestanden voor toepasbaar maken zijn beschikbaar:

Documentatie

Standaarden

Informatiemodellen

1  Bestanden met extensie  xsd en yaml mogen op deze website niet gebruikt worden. Ze zijn daarom ingepakt.


Meer informatie

Deze service is van belang in het proces toepasbare regels voor vragenbomen.

PKIoverheid-certificaat

Deze service kan alleen worden gebruikt met een PKIoverheid-certificaat.

Feedback

Geef feedback op deze service. Ga naar het forum om je bevindingen te delen.