Main content
Inleiding
Berichtenstandaard Nederlandse Overheid (OHNL)
De berichtenstandaard geeft een functionele en technische beschrijving van de EBF berichten. De berichtenstandaard is een profiel van (inter)nationale standaarden om de berichten te vereenvoudigen en beter te laten aansluiten op de werkprocessen van de Rijksoverheid. De functionele eisen die worden gesteld vanuit de SMeF (Semantisch Model e-Factureren) zijn hierin verwerkt.
Afhankelijk van het soort inkoop (goederen/diensten of inhuur) worden er twee berichtstandaarden gebruikt:
- UBL Overheid NL voor goederen/diensten. Dit is gebaseerd op de internationale UBL standaard.
- SETU (HRXML) Overheid NL voor Inhuur. Dit is gebaseerd op de nationale SETU standaard, welke weer een nadere specificatie is van HRXML.
Dit is de leeswijzer voor de Goederen/diensten-berichten (UBL).
DigiPoort
De distributie van alle EBF berichten gaat via de DigiPoort.
Gerelateerde documenten
Deze pagina maakt onderdeel uit van een bredere set aan documentatie die u kunnen helpen bij het implementeren van EBF berichten. Hieronder zijn de documenten in samenhang weergegeven.
- De Handleiding aansluiten op DigiPoort geeft een overzicht van alle activiteiten die uitgevoerd moeten worden om succesvol berichten uit te wisselen.
- Het procesmodel bevat 2 documenten
- Berichtenstandaard. Dit bestaat uit een set aan documenten
- DigiPoort documentatie. Dit betreft documentatie voor het aansluiten op de DigiPoort
UBL OH NL 1.9
Profiel
De berichtenstandaard is gebaseerd op UBL 2.0.
Berichttypen
UBL-OHNL 1.9 bevat de volgende berichttypen:
- Commitment (intern overheid bericht)
- Application Response (intern overheid bericht)
- Order
- OrderResponse
- Invoice
Documentatie
De documentatie van de berichtenstandaard bestaat uit de volgende onderdelen
Implementatiewijzer
De implementatiewijzer bevat toelichtingen op een aantal onderdelen:
- Opbouw UBL-NLOH
- Generieke toelichting
- XML schema’s en Schematron
- Berichttypen en Berichtsoorten
- Configuratiebestanden
- Voorbeeldscenario’s met voorbeeldberichten
Configuratiebestanden
Van ieder berichttype is een Excel document opgesteld waarin van alle velden uit het bericht de volgende informatie is opgenomen:
- Technische gegevens, zoals XML-XPath en datatype
- Cardinaliteit. Elk element in de hiërarchie van HR-XML kent een cardinaliteit: het aantal malen dat het minimaal en maximaal mag/moet voorkomen in het bericht.
- Definities
- Gebruikersaanwijzing; een nadere toelichting op het gebruik van een specifiek veld
- Business Rules; controles waaraan het bericht moet voldoen.
In de Implementatiewijzer worden de configuratiebestanden nader toegelicht.
Functionele documentatie
De functionele documentatie bestaat uit:
- De configuratiebestanden
- Semantisch Model eFactureren (SMeF). Op de site van Logius vindt u documentatie over de SMeF
Technische bestanden
Voor geautomatiseerd gebruik, zoals het valideren van berichten wordt de gekozen syntax in bestanden gegoten. Voor UBL zijn dit XML schema’s, Schematron bestanden, GeneriCode bestanden en een Context/Value Association (CVA) bestand. Deze bestanden zijn een technische weergave van wat in de functionele specificaties is beschreven.
Een XML-schema is een syntax of grammatica specificatie. Het bepaalt onder andere de hiërarchische structuur van het bericht en de toegestane waarden van ieder XML element. Maar er zijn nog andere “regels” waaraan het gespecificeerde bericht moet voldoen. Voorbeelden daarvan zijn de regels die afhankelijkheden tussen meerdere elementen leggen of de beperkingen van berichtonderdelen die volgen uit beschrijvingen zoals die van de 11-proef voor een Burgerservicenummer. Dergelijke regels kunnen niet in een XML-schema worden uitgedrukt. Hiervoor wordt ISO Schematron gebruikt. Alle beperkingen die de Nederlandse Overheid wil uitoefenen op de HR-XML schema’s worden gerealiseerd middels de ISO Schematron validatie techniek.
Voor het vastleggen van codelijsten (lijst met geldige waarden) wordt de OASIS standaard GeneriCode gebruikt in combinatie met CVA.
De technische documentatie van de UBL-OHNL 1.9 bestaat uit de volgende onderdelen:
- XSD Schema’s van HR-XML
- XSD Schema’s van OHNL (dit betreft een extensie op het UBL schema). OHNL heeft extensie XSD’s opgesteld voor de Invoice en XSD’s voor het OHNL eigen Commitment bericht.
- OHNL Schematron
- OHNL GeneriCode
- OHNL CVA
Voorbeeldbestanden
In de oplevering worden ook XML voorbeeldberichten geleverd. Deze zijn alleen ter illustratie en vormen geen volledig overzicht van de berichtenstandaard. Dat wordt alleen gegeven in de configuratiebestanden. In de Implementatiewijzer worden de technische bestanden en voorbeeldbestanden nader toegelicht.
Vindplaats documentatie
De documentatie is te vinden op de website van Logius. De documentatie is opgenomen in twee zip-bestanden: één voor de OHNL die per release verschillend zal zijn, en één met de UBL bestanden die voor meerdere releases van toepassing zijn.
OHNL-zip
Dit .zip bestand geeft na uitpakken de volgende folderstructuur:
Versie
├─ cl
│ └─ gc
├─ cva
├─ doc
├─ sch
├─ xml
├─ xsd
│ ├─ common
│ └─ maindoc
└─ xsdrt
│ ├─ common
│ └─ maindoc
- Versie: Dit is de versie van de uitlevering. De versienummering kent het formaat X.Y[.Z], waarbij X de ‘major’ versie is ,Y de ‘minor’ versie en Z optioneel de ‘bugfix’ versie. Deze folder bevat de releasenotes voor deze versie en een kopie van de leeswijzer (dit document).
- cl: Dit is de ‘codelist’ folder. Hier worden de codewaarden opgenomen die voor specifieke gegevens elementen zijn toegestaan. De belangrijkste standaard is de OASIS GeneriCode. Maar andere standaarden inclusief de W3C XML Schema notatie voor enumeraties zijn ook mogelijk.
- gc: Dit is de folder voor de GeneriCode bestanden. Deze folder bevat alleen de OHNL GeneriCode bestanden die als aanvulling op UBL 2.0 gebruikt worden.
- cva: Dit is de folder voor het Context/Value Assocication bestand.
- doc: Dit is de folder voor de door de mens leesbare documentatie bestanden. Deze folder bevat de configuratiebestanden en de implementatiewijzer.
- sch: Dit is de folder voor de ISO Schematron (c040833_ISO_IEC_19757-3_2006(E)) validatie bestanden. Er is één schematron bestand per berichttype.
- xml: Dit is de folder voor de XML voorbeeldberichten.
- xsd: Dit is de folder voor de OHNL XML Schema’s gebaseerd op en als uitbreiding van UBL 2.0 (common) en het OHNL Commitment bericht (maindoc) waarin opgenomen de referenties naar de UN-Cefact Core Components.
- xsdrt: Dit is de folder voor de OHNL XML Schema’s gebaseerd op en als uitbreiding van UBL 2.0 (common) en het OHNL Commitment bericht ( (maindoc) zonder referenties naar UN-Cefact Core Components. Deze schema’s zijn bedoeld voor de run-time omgeving.
UBL-2.0.zip.
Dit .zip bestand geeft na uitpakken de volgende folderstructuur:
UBL-2.0
├─ cl
│ └─ gc
├─ mod
│ ├─ common
│ └─ maindoc
├─ xsd
│ ├─ common
│ └─ maindoc
└─ xsdrt
│ ├─ common
│ └─ maindoc
- cl: Dit is de ‘codelist’ folder. Hier worden de codewaarden opgenomen die voor specifieke gegevens elementen zijn toegestaan. De belangrijkste standaard is de OASIS GeneriCode. Maar andere standaarden inclusief de W3C XML Schema notatie voor enumeraties zijn ook mogelijk.
- gc: Dit is de folder voor de GeneriCode bestanden van UBL 2.0.
- mod: Dit is de folder waarvan UBL 2.0 voorschrijft dat zij Excel bestanden bevatten van de UBL 2.0 gespecificeerde elementen die daadwerkelijk voor de opgenomen berichten gebruikt worden.
- xsd: Dit is de folder voor de XML Schema’s van UBL 2.0 (common) en het daadwerkelijke bericht (maindoc) waarin opgenomen de referenties naar de UN-Cefact Core Components.
- xsdrt: Dit is de folder voor de XML Schema’s van UBL 2.0 (common) en het daadwerkelijke bericht (maindoc) zonder referenties naar UN-Cefact Core Components. Deze schema’s zijn bedoeld voor de run-time omgeving.
Om een volledig werkende set te verkrijgen moeten de folders uit de UBL-2.0.zip worden samengevoegd met de corresponderende folders van OHNL.zip.