KET-024: Het doorgeven van statussen van documenten

KET-024: Het doorgeven van statussen van documenten

Samenvatting

Deze ketenafspraak stelt regels vast over het meesturen van de juiste status van een document in het veld //DocumentKenmerk/DocumentStatus bij het opvragen van documenten met een DOC.AANVRAAGBERICHT (DA).

Ingangsdatum huidige versie

May 30, 2026

Laatst gewijzigd per HDN-versie

HDN 26.0

Impact op

DOC.AANVRAAGBERICHT (DA)/ DOCUMENTBERICHT (DX)/ STATUSMELDING (SX)

Relevant voor rollen

  • Rol 1: Softwarepakketten (voorkant)

  • Rol 2: Tussenstations zonder aanpassingen

  • Rol 3: Tussenstations met aanpassingen

  • Rol 4: Aanbieder

Type ketenafspraak

  • Proces

  • Berichtvulling

Van toepassing op de velden

DOC.AANVRAAGBERICHT (DA)

  • //DocumentKenmerk/DocumentMijNr

  • //DocumentKenmerk/SoortDocument

  • //DocumentKenmerk/SoortDocumentOmschr

DOCUMENTBERICHT (DX)

  • //DocumentKenmerk/DocumentMijNr

  • //DocumentKenmerk/SoortDocument

  • //DocumentKenmerk/SoortDocumentOmschr

  • //DocumentKenmerk/DocumentStatus

STATUSMELDING (SX)

  • //Status/DXBerichtStatusSpecificatie//StatusDXBericht

Van toepassing op de entiteiten

DOC.AANVRAAGBERICHT (DA)

  • //DocumentKenmerk/

DOCUMENTBERICHT (DX)

  • //DocumentKenmerk/

STATUSMELDING (SX)

  • //Status/DXBerichtStatusSpecificatie/

Ketenafspraak

Vereisten voor Rol 1: Softwarepakketten (voorkant)

  1. Het is verplicht per //DocumentKenmerk/DocumentMijNr die ontvangen wordt in een DOC.AANVRAAGBERICHT (DA) de mogelijkheid te bieden een DOCUMENTBERICHT (DX) te versturen, wanneer //DocumentKenmerk/DocumentStatus de waarde bevat:

    1. 01 Aan te leveren

    2. 02 In behandeling

    3. 03 Ontvangen

    4. 07 Afgekeurd en opnieuw aan te leveren (zie toelichting)

  2. Het is niet toegestaan een DOCUMENTBERICHT (DX) te versturen voor een DocumentMijNr die volgens de laatst ontvangen DOC.AANVRAAGBERICHT (DA) de volgende waarde in DocumentStatus heeft:

    1. 04 Akkoord

    2. 06 Voorlopig Akkoord

    3. 08 Vervallen (zie toelichting)

  3. Het is verplicht bij het ontvangen van een DOC.AANVRAAGBERICHT (DA) de waarden van //DocumentKenmerk/DocumentStatus en //DocumentKenmerk/DocumentStatusOmschr te tonen in de software.

  4. Aanbeveling: Het is niet de bedoeling om de waarde in het veld DOC.AANVRAAGBERICHT (DA) de waarden van //DocumentKenmerk/SoortDocumentOmschrPortal te tonen in de software. Dit veld is bedoeld om te tonen in het consumentenportaal van de aanbieder. Het kan ook een code bevatten en is daarom niet geschikt om te tonen aan het intermediair.

  5. Wanneer een STATUSMELDING (SX)wordt ontvangen waarin de entiteit //Status/DXBerichtStatusSpecificatie/ is gevuld is het aanbevolen om deze aan de gebruiker te tonen bij het betreffende document die genoemd wordt in het DocumentMijNr in deze entiteit.

    1. Opmerking 1: Het is daarmee een aanvulling op de //DocumentKenmerk/DocumentStatus die via een DOC.AANVRAAGBERICHT (DA) binnen kunnen komen.

    2. Opmerking 2: Houdt er rekening mee dat het document opnieuw moet kunnen worden aangeleverd wanneer een STATUSMELDING (SX) voor een document is ontvangen waarin //Status/DXBerichtStatusSpecificatie/StatusDXBericht gevuld is met 05 Bestandstype niet ondersteund.

    3. Opmerking 3: Wanneer er voor het betreffende document een nieuwe DOCUMENTBERICHT (DX) wordt verstuurd is na ontvangst van een nieuwe DOC.AANVRAAGBERICHT (DA), de status in //DocumentKenmerk/DocumentStatus uit dit bericht leidend voor het betreffende DocumentMijNr.

Vereisten voor Rol 2: Tussenstations zonder aanpassingen, Rol 3: Tussenstations met aanpassingen

  1. Het is verplicht de mogelijkheid te bieden een DOCUMENTBERICHT (DX) te versturen wanneer een DOC.AANVRAAGBERICHT (DA) is verwerkt waarbij bij een of meerdere //DocumentKenmerk de DocumentStatus de waarde bevat:

    1. 01 Aan te leveren

    2. 02 In behandeling

    3. 03 Ontvangen

    4. 07 Afgekeurd en opnieuw aan te leveren (zie toelichting)

  2. Het is niet toegestaan een DOCUMENTBERICHT (DX) te versturen voor een DocumentMijNrgevuld die in de laatst ontvangen DOC.AANVRAAGBERICHT (DA) de volgende waarde in DocumentKenmerk/DocumentStatus heeft:

    1. 04 Akkoord

    2. 06 Voorlopig Akkoord

    3. 08 Vervallen (zie toelichting)

  3. Het is verplicht bij het ontvangen van een DOC.AANVRAAGBERICHT (DA) de waarden van //DocumentKenmerk/DocumentStatus en //DocumentKenmerk/DocumentStatusOmschr te tonen in de software.

  4. Aanbeveling: Het is niet de bedoeling om de waarde in het veld DOC.AANVRAAGBERICHT (DA) de waarden van //DocumentKenmerk/SoortDocumentOmschrPortal te tonen in de software. Dit veld is bedoeld om binnen het consumentenportaal binnen het landschap van de aanbieder te tonen. Het kan ook een code bevatten en is derhalve niet geschikt om te tonen aan het intermediair.

  5. Wanneer een DOCUMENTBERICHT (DX) is ontvangen moet de ontvanger een STATUSMELDING (SX)versturen waarin//Status/DXBerichtStatusSpecificatie/StatusDXBericht gevuld is met 02 Document reeds ontvangen wanneer het document in de DOC.AANVRAAGBERICHT (DA) de //DocumentKenmerk/DocumentStatus ofDocumentKenmerk/DocumentStatus/StatusKetenPartij had:

    1. 04 Akkoord

    2. 06 Voorlopig Akkoord

    3. 08 Vervallen (zie toelichting)

  6. Wanneer een DOCUMENTBERICHT (DX) is ontvangen moet de ontvanger een STATUSMELDING (SX)versturen waarin//Status/DXBerichtStatusSpecificatie/StatusDXBericht gevuld is met 03 DocumentMijNr onbekend wanneer het DocumentMijNr in het DOCUMENTBERICHT (DX) niet gevonden kan worden in de verzonden DOC.AANVRAAGBERICHT (DA).

  7. Wanneer een nieuw te verwerken DOCUMENTBERICHT (DX) is ontvangen is het verplicht binnen 15 minuten een nieuwe DOC.AANVRAAGBERICHT (DA) te versturen met de actuele status van alle documenten.
    Let op! Een uitzondering: wanneer er in de afgelopen 15 minuten al een DOC.AANVRAAGBERICHT (DA) verzonden is, dan is het pas toegestaan om een nieuwe DOC.AANVRAAGBERICHT (DA) te versturen als de 15 minuten verstreken zijn.
    Aanbeveling: Stuur niet direct na elk ontvangen DOCUMENTBERICHT (DX) een DOC.AANVRAAGBERICHT (DA). Wacht eerst af of er nog meer documenten binnen komen. Dit zorgt voor minder DOC.AANVRAAGBERICHT (DA) berichten.

  8. Wanneer er een beoordeling plaatsvindt door het tussenstation dient de status hiervan gecommuniceerd te worden in een DOC.AANVRAAGBERICHT (DA) via het veld //DocumentKenmerk/StatusKetenPartij/DocumentStatus. De waarde hiervan is:

    1. 06 Voorlopig akkoord als:

      1. het betreffende document opzichzelfstaand akkoord is en nog niet beoordeeld is in combinatie met andere documenten.
        Voorbeeld: De werkgever die vermeld is op de salarisstrook moet gecontroleerd worden in combinatie met de werkgever op de werkgeversverklaring. Zolang deze controle nog niet heeft plaatsgevonden blijft de status van beide documenten op 06 Voorlopig akkoord

      2. nog niet te bepalen is of het document nog geldig is.
        Voorbeeld: Of een document (bijvoorbeeld een taxatierapport) nog geldig is wordt bepaald bij het uitbrengen van de bindende offerte. Dit betekend dat de documenten kunnen pas de status 04 Akkoord kunnen krijgen wanneer de bindende offerte wordt uitgebracht.

    2. 04 Akkoord als alle onderstaande punten waar zijn:

      1. het betreffende document opzichzelfstaand akkoord is.

      2. in combinatie met andere documenten akkoord is.

      3. bepaald is dat het document geldig is.

  9. Het is niet toegestaan de waarde van het veld //DocumentKenmerk/DocumentStatus aan te passen in de uitgaande DOC.AANVRAAGBERICHT (DA) ten op zichten van het binnenkomende DOC.AANVRAAGBERICHT (DA).

  10. Wanneer een tussenstation een DOCUMENTBERICHT (DX) heeft ontvangen is het verplicht deze door te sturen naar de partij waar een DOC.AANVRAAGBERICHT (DA) van is ontvangen. Tenzij:

    1. Er sprake is van een fout in het DOCUMENTBERICHT (DX), zie punt 6 en 7.

    2. Er nog geen DOC.AANVRAAGBERICHT (DA) is ontvangen.

    3. Het document inhoudelijk wordt afgekeurd. In dat geval kan via //DocumentKenmerk/StatusKetenPartij/DocumentStatus de waarde 07 Afgekeurd en opnieuw aan te leveren (zie toelichting) worden doorgegeven.

  11. Wanneer in een dossier een DOC.AANVRAAGBERICHT (DA) verzonden is waarin het veld //DocumentKenmerk/StatusKetenPartijDocumentStatus de waarde 04 Akkoord heeft, is het niet toegestaan dit te wijzigen in een nieuwe DOC.AANVRAAGBERICHT (DA) voor dit //DocumentKenmerk/DocumentMijNr, tenzij:

    1. Het document is vervallen. In dat geval moet het veld //DocumentKenmerk/StatusKetenPartij/DocumentStatus wijzigen in 08 Vervallen (zie toelichting).

  12. Wanneer een tussenstation een STATUSMELDING (SX) ontvangt waarin //Status/DXBerichtStatusSpecificatie/StatusDXBericht gevuld is met 05 Bestandstype niet ondersteund moet deze dezelfde STATUSMELDING (SX) naar de organisatie waarvan de laatste DOCUMENTBERICHT (DX) ontvangen is versturen.

    1. Een uitzondering hierop geldt als het document niet afkomstig is van het intermediair en/of de tussenstation kan het probleem zelf oplossen.

  13. Wanneer een STATUSMELDING (SX)wordt ontvangen waarin de entiteit //Status/DXBerichtStatusSpecificatie/ is gevuld is het aanbevolen om deze aan de gebruiker te tonen bij het betreffende document die genoemd wordt in het DocumentMijNr in deze entiteit.

    1. Opmerking 1: Het is daarmee een aanvulling op de //DocumentKenmerk/DocumentStatus die via een DOC.AANVRAAGBERICHT (DA) binnen kunnen komen.

    2. Opmerking 2: Houdt er rekening mee dat het document opnieuw moet kunnen worden aangeleverd wanneer een STATUSMELDING (SX) voor een document is ontvangen waarin //Status/DXBerichtStatusSpecificatie/StatusDXBericht gevuld is met 05 Bestandstype niet ondersteund.

    3. Opmerking 3: Wanneer er voor het betreffende document een nieuwe DOCUMENTBERICHT (DX) wordt verstuurd is na ontvangst van een nieuwe DOC.AANVRAAGBERICHT (DA), de status in //DocumentKenmerk/DocumentStatus uit het DOC.AANVRAAGBERICHT (DA) leidend voor het betreffende DocumentMijNr.

Vereisten voor Rol 4: Aanbieder

  1. In een DOC.AANVRAAGBERICHT (DA) moet het veld //DocumentKenmerk/DocumentStatus met 06 Voorlopig akkoord zijn gevuld als:

    1. het betreffende document opzichzelfstaand akkoord is en nog niet beoordeeld is in combinatie met andere documenten.
      Voorbeeld: De werkgever die vermeld is op de salarisstrook moet worden gecontroleerd in combinatie met de werkgever op de werkgeversverklaring. Zolang deze controle nog niet heeft plaatsgevonden blijft de status van beide documenten op 06 Voorlopig akkoord .

    2. nog niet te bepalen is of het document nog geldig is.
      Voorbeeld: Of een document (bijvoorbeeld een taxatierapport) nog geldig is wordt bepaald bij het uitbrengen van de bindende offerte. Dit betekend dat de documenten kunnen pas de status 04 Akkoord kunnen krijgen wanneer de bindende offerte wordt uitgebracht.

  2. In een DOC.AANVRAAGBERICHT (DA) moet het veld //DocumentKenmerk/DocumentStatus met 04 Akkoord zijn gevuld als alle onderstaande punten waar zijn:

    1. het betreffende document opzichzelfstaand akkoord is.

    2. in combinatie met andere documenten akkoord is.

    3. bepaald is dat het document geldig is.

  3. Wanneer in een dossier een DOC.AANVRAAGBERICHT (DA) verzonden is waarin het veld //DocumentKenmerk/DocumentStatus de waarde 04 Akkoord heeft, is het niet toegestaan dit te wijzigen in een nieuwe DOC.AANVRAAGBERICHT (DA) voor dit //DocumentKenmerk/DocumentMijNr, tenzij:

    1. Het document is vervallen. In dat geval moet het veld //DocumentKenmerk/DocumentStatus wijzigen in 08 Vervallen (zie toelichting).

  4. Wanneer een DOCUMENTBERICHT (DX) is ontvangen moet de ontvanger een STATUSMELDING (SX)versturen waarin//Status/DXBerichtStatusSpecificatie/StatusDXBericht gevuld is met 02 Document reeds ontvangen wanneer het document in de DOC.AANVRAAGBERICHT (DA) de //DocumentKenmerk/DocumentStatus had:

    1. 04 Akkoord

    2. 06 Voorlopig Akkoord

    3. 08 Vervallen (zie toelichting)

  5. Wanneer een DOCUMENTBERICHT (DX) is ontvangen en in de laatst verstuurde DOC.AANVRAAGBERICHT (DA) het veld OpgevraagdViaBronJN op J Ja staat, moet de STATUSMELDING (SX) waarin //Status/DXBerichtStatusSpecificatie/StatusDXBericht gevuld is met 07 Document reeds opgevraagd via bron verstuurd zijn.

    1. Zie ook KET-002: Sturen en verwerken van statusmeldingen als reactie op DocumentenArchived.

  6. Wanneer een nieuw te verwerken DOCUMENTBERICHT (DX) is ontvangen is het verplicht binnen 15 minuten een nieuwe DOC.AANVRAAGBERICHT (DA) te versturen met de actuele status van alle documenten.
    Let op! Een uitzondering: wanneer er in de afgelopen 15 minuten al een DOC.AANVRAAGBERICHT (DA) verzonden is, dan is het pas toegestaan om een nieuwe DOC.AANVRAAGBERICHT (DA) te versturen als de 15 minuten verstreken zijn.
    Aanbeveling: Stuur niet direct na elk ontvangen DOCUMENTBERICHT (DX) een DOC.AANVRAAGBERICHT (DA). Wacht eerst af of er nog meer documenten binnen komen. Dit zorgt voor minder DOC.AANVRAAGBERICHT (DA) berichten.

  7. Wanneer de status van een document in het systeem wijzigt moet deze een DOC.AANVRAAGBERICHT (DA)versturen gevuld met:

    1. de nieuwe status in //DocumentKenmerk/DocumentStatus.

    2. de nieuwe datum en tijd wanneer de status veranderd is in //DocumentKenmerk/DocumentStatusDtt.

  8. Wanneer in een dossier een DOC.AANVRAAGBERICHT (DA) verzonden is waarin het veld //DocumentKenmerk/StatusKetenPartijDocumentStatus de waarde 06 Voorlopig Akkoord heeft, en het voorlopig akkoord is verlopen, moet een nieuwe DOC.AANVRAAGBERICHT (DA) worden verstuurd waarin //DocumentKenmerk/StatusKetenPartijDocumentStatus de waarde 07 Afgekeurd en opnieuw aan te leveren is.

  9. Het is verplicht elk nieuw toegevoegde documentkenmerk in het DOC.AANVRAAGBERICHT (DA) de status 01 Aan te leveren te geven,

    1. Een uitzondering hierop zijn de documenten die via een bron worden opgevraagd, zie KET-026: Bronnen in documentberichten

  10. Wanneer een DOCUMENTBERICHT (DX) is ontvangen met daarin een //DocumentKenmerk/DocumentMijNr die niet eerder is voorgekomen in een DOC.AANVRAAGBERICHT (DA) is het verplicht een STATUSMELDING (SX) te versturen waarin//Status/DXBerichtStatusSpecificatie//StatusDXBericht gevuld is met03 DocumentMijNr onbekend.

  11. Wanneer een DOCUMENTBERICHT (DX) is ontvangen met daarin een //Printdoc/BestandType die niet wordt ondersteund door het ontvangende systeem is het verplicht een STATUSMELDING (SX) te versturen waarin//Status/DXBerichtStatusSpecificatie//StatusDXBericht gevuld is met05 Bestandstype niet ondersteund.

  12. Het is niet toegestaan de entiteit /StatusKetenPartij/ toe te voegen binnen /DocumentKenmerk/.

Aanleiding en achtergrond

Bij het opvragen van documenten met een DOC.AANVRAAGBERICHT (DA) is het belangrijk dat de juiste status van een document wordt meegestuurd in het veld //DocumentKenmerk/DocumentStatus. Hierdoor ontstaat er duidelijkheid wat te doen wanneer een document voor de tweede keer ontvangen wordt. Deze ketenafspraak stelt hierover regels vast.

Versiegeschiedenis

Versie

Wijzigingen

Datum

HDN Versie

Versie

Wijzigingen

Datum

HDN Versie

2.0

Verplichte STATUSMELDING (SX) toegevoegd, verduidelijking voor tussenstations om documentenlijst op te stellen

May 30, 2026

HDN-26

1.0

 Initiële ketenafspraak

May 29, 2021

HDN-21