Implementatie

Het uitwisselpakket is een gecomprimeerd (zip) bestand met als extensie .stop in plaats van .zip. De inhoud van het pakket bestaat uit:

• Een bestand met de vaste naam pakbon.xml waarin de inhoud van het pakket beschreven wordt. Het specifieke XML-formaat is gedefinieerd en beschreven in imop-uitwisseling.xsd.

• Een of meer XML-bestanden. Elk uit te wisselen STOP-module is opgenomen in een apart XML-bestand.

• Bestanden die door de STOP-modules gebruikt worden, zoals plaatjes of informatieobject-bestanden.

• Bestanden met gerelateerde informatie als beschreven in andere standaarden (zoals IMOW).

Bij de bestandsnamen in het zip-bestand is het gebruik van hoofd- en kleine letters van belang: PAKBON.xml is een ander bestand dan pakbon.xml. Uit oogpunt van interoperabiliteit wordt geëist dat er geen bestandsnamen gebruikt mogen worden die slechts in hoofd- of kleine letters van elkaar afwijken. Het gebruik van een mapstructuur in het zip-bestand is wel toegestaan. De bestandsnamen moeten per map uniek zijn.

Een voorbeeld van de inhoud van een zip-bestand is:

De inhoud van een uitwisselpakket wordt beschreven in pakbon.xml. Dit bestand vervult verschillende functies. In de pakbon is opgenomen:

• Welke bestanden met STOP-modules en aanvullende bestanden in het uitwisselpakket zitten.

• Welke informatie bij elkaar hoort

• Hoe een STOP-module (of een bestand volgens een andere standaard) gelezen en gevalideerd moet worden

Voor een informatieobject moet tenminste de InformatieObjectVersieMetadata module (en meestal ook InformatieObjectMetadata) onderdeel zijn van de component. In die module staan de bestanden genoemd waaruit het informatieobject bestaat. Bijvoorbeeld:

<?xml version="1.0" encoding="UTF-8"?>
<InformatieObjectVersieMetadata schemaversie="1.3.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns="https://standaarden.overheid.nl/stop/imop/data/" xsi:schemaLocation="https://standaarden.overheid.nl/stop/imop/data/ https://standaarden.overheid.nl/stop/1.3.0/imop-data.xsd">
  <heeftGeboorteregeling>/akn/nl/act/gm9999/2020/REG0001</heeftGeboorteregeling>
  <heeftBestanden>
    <heeftBestand>
      <Bestand>
        <bestandsnaam>Vuurwerkverbodsgebied.gml</bestandsnaam>
        <hash>ca2d23c1776b15cbc83bd9031c70e3acf745d2f1f0c12c78c3b5325c7b81b69d4a95dacdd30238721fdba73a02151110f005d144d27c0fc82e3f7cb8d415e09f</hash>
      </Bestand>
    </heeftBestand>
  </heeftBestanden>
</InformatieObjectVersieMetadata>

Hoe die bestanden in de pakbon vermeld worden hangt af van het formaat van het informatieobject. Voor informatieobjecten waarvan de bestanden (volgens IMOP) als XML bestand worden gecodeerd staat het bestand als Module vermeld:

<Module>
  <localName>GeoInformatieObjectVersie</localName>
  <namespace>https://standaarden.overheid.nl/stop/imop/geo/</namespace>
  <bestandsnaam>GIO993859238/Vuurwerkverbodsgebied.gml</bestandsnaam>
  <mediatype>application/xml+gml</mediatype>
  <schemaversie>1.0.4</schemaversie>
</Module>

Als dat niet het geval is, zoals bij PDF-informatieobjecten, dan staat het als Bestand vermeld:

<Bestand>
  <bestandsnaam>MER.pdf</bestandsnaam>
  <mediatype>application/pdf</mediatype>
</Bestand>

Het uitwisselpakket is zo generiek mogelijk ingestoken, voor een zo breed mogelijk scala aan scenario's waarin STOP-informatie wordt uitgewisseld. Er is een klein aantal bedrijfsregels voor de Pakbon geformuleerd met als doel:

• Consistentie van de pakbon, de informatie per component en de bestanden in het uitwisselpakket;

• Aanwezigheid van de minimaal noodzakelijke informatie voor een component;

• Reductie van de implementatie-eisen bij import van een uitwisselpakket.

STOP stelt geen striktere eisen, hoewel dat voor sommige toepassingen denkbaar en werkbaar zou zijn. Zo kent STOP geen expliciete bedrijfsregels over welke Moduletypes in welke Componenten kunnen voorkomen. Deze toekenning is versieafhanklijk en kan beter uit een relatietabel als versiecompleet.xml worden afgeleid.

Ook stelt STOP geen regels over welke informatie wanneer kan en moet worden uitgewisseld. Een voorbeeld hiervan zou kunnen zijn: "Een module mag niet worden uitgewisseld middels een uitwisselpakket als dezelfde module van hetzelfde instrument ongewijzigd is ten opzichte van het meest recente uitwisselpakket tussen dezelfde verzender en ontvanger." De verwachting is dat er dergelijke afspraken tussen zender en ontvanger zullen worden opgesteld, afhankelijk van het scenario.