Digikoppeling Overzicht Actuele Documentatie en Compliance 1.10

Logius Standaard
Vastgestelde versie

Deze versie:
https://gitdocumentatie.logius.nl/publicatie/dk/actueel/1.10
Laatst gepubliceerde versie:
https://gitdocumentatie.logius.nl/publicatie/dk/actueel/
Laatste werkversie:
https://logius-standaarden.github.io/Digikoppeling-Overzicht-Actuele-Documentatie-en-Compliance/
Vorige versie
https://gitdocumentatie.logius.nl/publicatie/dk/actueel/1.9.1/
Redacteurs:
Peter Haasnoot
(Logius)
Auteur:
Pieter Hering
Doe mee:
GitHub Logius-standaarden/Digikoppeling-Overzicht-Actuele-Documentatie-en-Compliance
Dien een melding in
Revisiehistorie
Pull requests

This document is also available in this non-normative format: pdf


Samenvatting

Dit document Digikoppeling Overzicht Actuele Documentatie & Compliance beschrijft de opzet en huidige versies van de Digikoppeling standaard. Ook geeft dit document aan hoe compliance aan de standaard kan worden bepaald en aangetoond.

Status van dit document

Dit is de definitieve versie van de standaard. Wijzigingen naar aanleiding van consultaties zijn doorgevoerd.

Documentbeheer

Datum Versie Auteur Opmerkingen
12/10/2017 1.0 Logius 1e versie
09/07/2018 1.1 Logius Versionering documentniveau
21/08/2018 1.2 Logius RFC WUS Oin in wsa:to/from
16/05/2019 1.3 Logius RFC WUS Interoperabiliteit Signing RFC ebMS SyncReply
17/12/2019 1.4 Logius NCSC TLS Voorschriften
02/09/2020 1.5 Logius Beveiligingsstandaarden PKIO
14/10/2020 1.6 Logius DK KVS Grote Berichten v3.3
11/01/2021 1.7 Logius RFC 2020-2, RFC 2020-3
12/03/2021 1.8 Logius Beveiligingsstandaarden PKIO private root
11/04/2022 1.9 Logius Toevoeging REST-API koppelvlakstandaard
14/11/2022 1.10 Logius Wijziging REST-API koppelvlakstandaard RFC API-58

Colofon

Logius Servicecentrum: Postbus 96810
2509 JE Den Haag
tel. 0900 555 4555 (10 ct p/m)
email servicecentrum@logius.nl

1. Inleiding

Digikoppeling is een standaard voor berichtuitwisseling waarmee overheden op een veilige manier gegevens met elkaar kunnen uitwisselen.

1.1 Doel

Dit document Digikoppeling Overzicht Actuele Documentatie & Compliance beschrijft de opzet en huidige versies van de Digikoppeling standaard. Ook geeft dit document aan hoe compliance aan de standaard kan worden bepaald en aangetoond.

1.2 Doelgroep

Dit document is bedoeld voor ICT-professionals in de publieke sector en voor ICT-leveranciers die Digikoppeling (willen gaan) gebruiken.

1.3 Verantwoording

Dit document is tot stand gekomen in samenwerking met leden van het Technisch Overleg Digikoppeling.

2. Wat is Digikoppeling?

De Digikoppeling standaard is een verzameling van afspraken en principes voor berichtuitwisseling. Digikoppeling richt zich niet op de inhoud van het bericht maar op de “envelop” en op de logistiek van berichtenverkeer, kortom: de communicatiepatronen, adressering, beveiliging en betrouwbaarheid van berichten. Digikoppeling definieert verschillende koppelvlakken. In de koppelvlak specificaties worden de afspraken, eisen en te gebruiken technische standaarden in detail vastgelegd. Twee systemen die beiden hetzelfde digikoppeling koppelvlak ondersteunen kunnen gekoppeld worden en berichten uitwisselen op basis van een vooraf bepaald profiel.

Er zijn 4 soorten koppelvlakken:

Daarnaast zijn er algemene afspraken die voor elk koppelvlak gelden:

De onderstaande figuur geeft de verschillende onderdelen van de digikoppeling standaard weer:

Onderdelen Digikoppeling specificatie
Figuur 1 Onderdelen Digikoppeling specificatie

Deze onderverdeling komt ook terug in de documentatie van de Digikoppeling standaard. Het volgende hoofdstuk behandelt de beschikbare documentatie en geeft per document aan wat de inhoud is.

3. Welke Digikoppeling documentatie is beschikbaar?

De Digikoppeling standaard is vastgelegd in een aantal documenten.

Dit hoofdstuk geeft aan welk onderdeel van de standaard in welk document wordt beschreven en geeft ook de samenhang weer tussen de verschillende soorten documenten.

3.1 Structuur & opbouw documentatie

De onderstaande figuur geeft de opbouw weer van de Digikoppeling documentatie.

Overzicht van de onderdelen van de Digikoppeling Standaard, de standaard is onderverdeeld in normatieve en ondersteunende onderdelen
Figuur 2 Opbouw documentatie Digikoppeling

Tekstalternatief

* Normatief document

† Ondersteunend document

Legenda

Kleur Soort Document
Standaard documentatie
Ondersteunende documentatie

Beheer

3.2 Overzicht documentatie

3.2.1 Algemene documentatie

  • Wat is Digikoppeling?
    Inleidend document over Digikoppeling

  • DK Overzicht Actuele Documentatie en Compliance
    Totaal overzicht van de documentatie en toelichting op compliance aan de standaard;

  • DK Beheermodel en Releasebeleid Governance van de Digikoppeling standaard;

3.2.2 Technische documentatie

Technische documentatie algemeen

  • DK Architectuur

    Overzicht van de standaard, samenhang en architectuur. Dit document beschrijft op hoofdlijnen welke manier de standaard moet worden toegepast;

  • DK Identificatie en Authenticatie Uitgangspunten en principes voor identificatie- en authenticatieafspraken die gehanteerd worden tussen overheidsorganisaties bij gebruik van de Digikoppeling standaard;

  • DK Beveiliging standaarden en voorschriften Centraal document van beveiligingsvoorschriften en -standaarden die door de Digikoppeling Standaard verplicht worden gesteld;

Technische documentatie koppelvlakken

  • DK Koppelvlakstandaard WUS
    Koppelvlakspecificatie voor het gebruik van WUS conform Digikoppeling;

  • DK Koppelvlakstandaard EBMS2
    Koppelvlakspecificatie voor het gebruik van ebMS 2.0 conform Digikoppeling;

  • DK Koppelvlakstandaard REST API
    Koppelvlakspecificatie voor het gebruik van REST-API (gebaseerd op ADR) conform Digikoppeling;

  • DK Koppelvlakstandaard Grote Berichten
    Koppelvlakspecificatie voor het uitwisselen van grote berichten conform Digikoppeling. Grote berichten zijn XML berichten of bijlagen die een bepaalde bestandsgrootte overschrijden;

Ondersteunende Documentatie

  • DK Best Practices WUS
    Best Practices voor WUS implementatie;

  • DK Best Practices EBMS2
    Best Practices voor EBMS2 implementatie;

  • DK Best Practices REST API
    Best Practices voor REST API implementatie; (toekomstige uitbreiding)

  • DK Best Practices Grote Berichten
    Best Practices voor Grote Berichten implementatie;

  • DK Gebruik en achtergrond certificaten
    Toelichting gebruik en achtergrond DK certificaten;

4. Wat zijn de huidige versies van documenten?

De onderstaande tabel geeft de huidige versies van de Digikoppeling documenten weer. Patchversies (hieronder weergegeven met een asterisk) raken de technische specificatie niet en hebben derhalve geen invloed op de geldigheid van het document.

Document Versie Normatief Geldig vanaf Geldig tot
Wat is Digikoppeling 1.1.* 19-10-2017
DK Beheermodel en releasebeleid 1.5.* 19-10-2017
DK Architectuur 2.0.* X 11-04-2022
DK Koppelvlakstandaard REST API 1.1.* X 14-11-2022
DK Koppelvlakstandaard WUS 3.8.* X 11-01-2021
DK Koppelvlakstandaard ebMS2 3.3.* X 16-05-2019
DK Koppelvlakstandaard Grote Berichten 3.8.* X 11-04-2022
DK Identificatie en Authenticatie 1.4.* X 19-10-2017
DK Beveiligingsstandaarden en voorschriften 1.4.* X 12-03-2021
DK Overzicht Actuele Documentatie en Compliance 1.10.* X 14-11-2022
DK Best Practices WUS 1.10.* 19-10-2017
DK Best Practices ebMS2 3.2.* 16-05-2019
DK Best Practices Grote Berichten 3.1.* 11-04-2022
DK Gebruik en achtergrond certificaten 1.6.* 02-09-2020

Tabel 1: Digikoppeling document versies

Toelichting Normatief:

In de kolom ‘Normatief’ wordt met ‘X’ aangegeven dat het document specifieke regels bevat waar men zich aan moet houden om te voldoen aan de Digikoppeling standaard (Zie ook H5 Wanneer ben ik Digikoppeling compliant).

De onderstaande tabel geeft de voorgaande versies van de Digikoppeling documenten weer.

Document Versie Normatief Geldig vanaf Geldig tot
DK Koppelvlakstandaard ebMS2 3.2.* x 19-10-2017 16-05-2019
DK Best Practices ebMS2 3.1.* 19-10-2017 16-05-2019
DK Koppelvlakstandaard WUS 3.7.* X 16-05-2019 10-01-2021
DK Koppelvlakstandaard WUS 3.6.* X 21-08-2018 16-05-2019
DK Koppelvlakstandaard WUS 3.5.* X 19-07-2018 21-08-2018
DK Koppelvlakstandaard REST API 1.0.* X 11-04-2022 14-11-2022
DK Architectuur 1.5.* X 19-10-2017 11-04-2022
DK Koppelvlakstandaard Grote Berichten 3.3.* X 14-10-2020 11-04-2022
DK Koppelvlakstandaard Grote Berichten 3.2.* X 19-10-2017 11-10-2020
DK Beveiligingsstandaarden en voorschriften 1.3.* X 02-09-2020 12-03-2021
DK Beveiligingsstandaarden en voorschriften 1.2.* X 17-12-2019 02-09-2020
DK Beveiligingsstandaarden en voorschriften 1.1.* X 19-10-2017 17-12-2019
DK Gebruik en achtergrond certificaten 1.5.* 19-10-2017 02-09-2020
DK Overzicht Actuele Documentatie en Compliance 1.9.* X 11-04-2022 14-11-2022
DK Overzicht Actuele Documentatie en Compliance 1.8.* X 12-03-2021 11-04-2022
DK Overzicht Actuele Documentatie en Compliance 1.7.* X 10-01-2021 12-03-2021
DK Overzicht Actuele Documentatie en Compliance 1.6.* X 14-10-2020 10-01-2021
DK Overzicht Actuele Documentatie en Compliance 1.5.* X 02-09-2020 14-10-2020
DK Overzicht Actuele Documentatie en Compliance 1.4.* X 17-12-2019 02-09-2020
DK Overzicht Actuele Documentatie en Compliance 1.3.* X 16-05-2019 17-12-2019
DK Overzicht Actuele Documentatie en Compliance 1.2.* X 30-07-2018 16-05-2019
DK Overzicht Actuele Documentatie en Compliance 1.1.* X 23-07-2018 30-07-2018
DK Overzicht Actuele Documentatie en Compliance 1.0.* X 19-07-2018 23-07-2018

Tabel 2: Vorige versies Digikoppeling documenten per koppelvlak

5. Wanneer ben ik Digikoppeling compliant?

Voor de implementatie van een bepaald koppelvlak volgens de Digikoppeling standaard gebruikt u de algemene documenten van de standaard samen met de technische specificatie van het specifieke koppelvlak (bv WUS, EBMS2, API of Grote Berichten).

5.1 Documenten per koppelvlak

De onderstaande tabel laat zien welke documenten van toepassing zijn voor de implementatie van een bepaald koppelvlak. De kolom Koppelvlak toont per koppelvlak WUS, EBMS2, API, Grote Berichten de bijbehorende documentatie.

Digikoppeling Compliance Koppelvlak
Document WUS EBMS2 API GB Type Normatief
DK Beheermodel en Releasebeleid X X X X Standaard
DK Overzicht Actuele Documentatie en Compliance X X X X Standaard
DK Architectuur X X X X Standaard X
DK Koppelvlakstandaard REST API X O1 Standaard X
DK Koppelvlakstandaard WUS X O1 Standaard X
DK Koppelvlakstandaard EBMS2 X O1 Standaard X
DK Koppelvlakstandaard Grote Berichten O1 O1 O1 X Standaard X
DK Identificatie en Authenticatie X X X X Standaard X
DK Beveiliging standaarden en voorschriften X X X X Standaard X
DK Best Practices WUS X Ondersteuning Standaard
DK Best Practices EBMS X Ondersteuning Standaard
DK Best Practices Grote Berichten X Ondersteuning Standaard
DK Gebruik en achtergrond certificaten X X X X Ondersteuning Standaard

1 O=gebruik van WUS óf ebMS2 óf API . Binnen de Grote Berichten standaard wordt eerst een metadatabericht gestuurd om een aan te kondigen dat een bestand klaar staat om te downloaden. Voor dit metadatabericht dient WUS, ebMS2 of API gebruikt te worden.

Tabel 3: Digikoppeling documentatie per koppelvlak

5.2 Toelichting compliance

De tabel in de voorgaande paragraaf geeft aan welke combinatie van documenten tezamen een complete specificatie vormt voor Digikoppeling op basis van WUS, EBMS2 of Grote berichten. Een koppelvlak implementatie voldoet aan de digikoppeling standaard als deze conform de principes, afspraken en gestelde eisen uit de normatieve documenten is uitgewerkt. Om de compliance van software in de een praktijksituatie te testen is de Digikoppeling Compliancy Voorziening ontwikkeld. Deze voorziening is onderdeel van het Digikoppeling Portaal en beschikbaar op https://portaal.digikoppeling.nl.

De Digikoppeling Compliancy Voorziening moet gezien worden als een hulpmiddel. Bij afwijking tussen de documentatie en de Compliance Voorziening zijn de eisen in de documentatie leidend bij het beoordelen of software de Digikoppeling standaard correct implementeert.

6. Conformiteit

Naast onderdelen die als niet normatief gemarkeerd zijn, zijn ook alle diagrammen, voorbeelden, en noten in dit document niet normatief. Verder is alles in dit document normatief.

7. Lijst met figuren