Document toolboxDocument toolbox

(v3.0.0) XML-bestanden voor lijsten

Owned by Martin Wilmink
Sept 28, 2023
1 min read


De XML-bestanden waarmee MedMij Beheer de Zorgaanbiederslijst, de Whitelist, de OAuth Client List, de Gegevensdienstnamenlijst en de Catalogus ontsluit voldoen aan enkele eisen, zodat PGO Server, Authorization Server, MedMijNode en anderen weten waarop zij kunnen rekenen voor de goede verwerking van deze lijsten.

1.Het XML-bestand van de Zorgaanbiederslijst heet MedMij_Zorgaanbiederslijst.xml. Het XML-bestand van de Whitelist heet MedMij_Whitelist.xml. Het XML-bestand van de OAuth Client List heet MedMij_OAuthclientlist.xml. Het XML-bestand van de Gegevensdienstnamen heet MedMij_Gegevensdienstnamenlijst.xml. Het XML-bestand van de Catalogus heet MedMij_Catalogus.xml.
2.

Bij een wijziging in een lijst die tot hernieuwde publicatie leidt, wordt het volgnummer van de lijst met één opgehoogd.

 Toelichting

De bestandsnamen van de lijsten zijn zo gekozen dat zij niet wijzigen wanneer de inhoud van het XML-schema wijzigt. Dit vergemakkelijkt de implementatie van changes. Het is gebruikelijk om meta-informatie niet uit de bestandsnaam te halen, maar uit de XML-bestanden zelf (met name uit de header). Daarom is het niet nodig om naast de informatie in het bestand, ook nog eens de bestandsnaam in te zetten voor versie-aanduiding.

3.

De in verantwoordelijkheid 1 bedoelde XML-bestanden maken gebruik van een default namespace, zijnde de namespace waarin het bijpassende XML-schema is gedefinieerd, zonder prefix.

 Toelichting

De afwezigheid van (onnodige) prefixes komt de leesbaarheid ten goede en voorkomt dat bij de implementatie gebruik wordt gemaakt van namespace-aanduidingen en prefixes die in de toekomst mogelijk wijzigen.

4.
De in verantwoordelijkheid 1 bedoelde XML-bestanden:
  • voldoen aan XML 1.0 en XML Schema 1.0.
  • zijn pretty-printed (verplicht gebruik van regeleinden en inspringing).
  • bevatten de XML Declaration <?xml version="1.0" encoding="UTF-8"?>.
  • bevatten geen Byte Order Mark.
 Toelichting

Deze vier eisen gelden ook voor de op de XML-bestanden van toepassing zijnde XML-schema's. Voor de toelichting ervan zij daarom verwezen naar die op de pagina over die (v3.0.0) XML-schema's.