Nictiz XML-distributie versie

Gegenereerd: 22 januari 2020

Welkom bij de HTML-documentatie van de XML-distributie.

Tips bij het gebruik:

  • Bij tabellen kan de inhoud naar wens gesorteerd worden door op één van de kolombeschrijvingen te klikken, het kleine rode pijltje geeft aan hoe gesorteerd wordt.
  • De Webservices tab is meer dan alleen een opsomming van alle webservices, het is ook een handige ingang naar achterliggende XML schema's en XML-voorbeeldberichten.

Nictiz is voor nieuwere projecten/standaarden overgeschakeld naar een nieuwe methodiek DECOR. Nictiz onderhoudt op basis hiervan alle huidige en toekomstige materialen op een openbaar toegankelijke server decor.nictiz.nl/art-decor. De doelen en de achtergrond van deze open source methodiek, vindt u hier:

Deze omschakeling betekent voor de XML schema's en webservices nog niets, maar HL7v3-interacties zullen vaker gebruik maken van templateId's en schematronbestanden en vocabulaire zullen anders van opbouw zijn. Standaarden gebaseerd op DECOR hebben volledig gegenereerde schematrons en vocabulairebestanden.

Hieronder een overzicht van alle Webservices (met link naar de documentatie) met hun WSDL. In alle gevallen is de WSDL de normatieve beschrijving van de Webservice en is de documentatie aanvullend. De derde kolom toont de interactieschema's van de berichten die in de webservice gebruikt worden.
Naam Omschrijving
Webservices GBZ Indexbestand voor webservices ten behoeve van een Goed Beheerd Zorgsysteem (GBZ)
Webservices GBP Indexbestand voor webservices ten behoeve van een Patiëntenportaal (GBP)
Hieronder een overzicht van alle 73 XML schema's, waarvan 18 interacties. De schema's zijn per HL7-domein, zichtbaar in de eerste vier letters, gegroepeerd en worden voorafgegaan door het overzicht van interacties. De interacties komen ook terug in de HL7-domeingroepen.

Interacties

XML Schema Omschrijving Includes Interactie
MCCI_IN200101.xsd Interactieschema: Batchantwoord
PORX_IN932000NL.xsd Interactieschema: Versturen medicatievoorschrift
QURX_IN990011NL.xsd Interactieschema: Opvragen medicatieverstrekkingen
QURX_IN990101NL.xsd Interactieschema: Opvragen medicatievoorschriftenlijst
QURX_IN990103NL.xsd Interactieschema: Opleveren medicatievoorschriftenlijst
QURX_IN990111NL.xsd Interactieschema: Opvragen medicatieverstrekkingenlijst
QURX_IN990113NL.xsd Interactieschema: Opleveren medicatieverstrekkingenlijst
QURX_IN990013NL.xsd Interactieschema: Opleveren medicatieverstrekkingen
PORX_IN924000NL.xsd Interactieschema: Versturen medicatieverstrekking
MCCI_IN000002.xsd Interactieschema: Ontvangstbevestiging
PORX_IN040050NL.xsd Interactieschema: Opvragen medicatiegebruik
PORX_IN040010NL.xsd Interactieschema: Versturen medicatiegebruik
PORX_IN040052NL.xsd Interactieschema: Opleveren medicatiegebruik
QUQI_IN000003.xsd Interactieschema: Algemeen antwoord continueren of afbreken oplevering
QUQI_IN000003UV.xsd Interactieschema: Algemene vraag continueren of afbreken oplevering
PORX_IN932100NL.xsd Interactieschema: Versturen medicatievoorschrift met handtekening
REPC_IN000023NL.xsd Interactieschema: Opvragen condities
REPC_IN000024NL.xsd Interactieschema: Opleveren condities

CDANL

XML Schema Omschrijving Includes Interactie
CDANL_extended.xsd

COCT - Common Message Elements

XML Schema Omschrijving Includes Interactie
COCT_MT000003NL.xsd
COCT_MT030200.xsd
COCT_MT030200NL.xsd
COCT_MT030202.xsd
COCT_MT030203.xsd
COCT_MT040200.xsd
COCT_MT040203.xsd
COCT_MT050000NL.xsd
COCT_MT070000.xsd
COCT_MT090000.xsd
COCT_MT090000NL1.xsd
COCT_MT090100.xsd
COCT_MT090100NL.xsd
COCT_MT090101.xsd
COCT_MT090102.xsd
COCT_MT090300.xsd
COCT_MT150000.xsd
COCT_MT150001.xsd
COCT_MT150002.xsd
COCT_MT150003.xsd
COCT_MT230100UV_ext_pharmacy.xsd
COCT_MT440001UV_ext_pharmacy.xsd
COCT_MT500000.xsd
COCT_MT710000.xsd
COCT_MT720000NL.xsd
COCT_MT924000NL02.xsd
COCT_MT932000NL02.xsd
COCT_MT940000NL.xsd
COCT_MT990002NL.xsd

hl7nl

XML Schema Omschrijving Includes Interactie
hl7nl_extension.xsd

MCAI - Message Act Infrastructure

MCCI - Message Control Infrastructure

POCD

PORX - Pharmacy

XML Schema Omschrijving Includes Interactie
PORX_IN040010NL.xsd Interactieschema: Versturen medicatiegebruik
PORX_IN040050NL.xsd Interactieschema: Opvragen medicatiegebruik
PORX_IN040052NL.xsd Interactieschema: Opleveren medicatiegebruik
PORX_IN924000NL.xsd Interactieschema: Versturen medicatieverstrekking
PORX_IN932000NL.xsd Interactieschema: Versturen medicatievoorschrift
PORX_IN932100NL.xsd Interactieschema: Versturen medicatievoorschrift met handtekening
PORX_MT040010NL.xsd
PORX_MT924000NL.xsd
PORX_MT924000NL02.xsd
PORX_MT924100NL.xsd
PORX_MT932000NL02.xsd
PORX_MT932100NL.xsd
PORX_MT932200NL01.xsd
PORX_MT932200NL02.xsd

QUMT - Query Master File Types

QUQI - Query Infrastructure

QURX - Query Pharmacy

XML Schema Omschrijving Includes Interactie
QURX_IN990011NL.xsd Interactieschema: Opvragen medicatieverstrekkingen
QURX_IN990013NL.xsd Interactieschema: Opleveren medicatieverstrekkingen
QURX_IN990101NL.xsd Interactieschema: Opvragen medicatievoorschriftenlijst
QURX_IN990103NL.xsd Interactieschema: Opleveren medicatievoorschriftenlijst
QURX_IN990111NL.xsd Interactieschema: Opvragen medicatieverstrekkingenlijst
QURX_IN990113NL.xsd Interactieschema: Opleveren medicatieverstrekkingenlijst
QURX_MT990001NL.xsd
QURX_MT990011NL.xsd

REPC - Care Provision

sdtc

XML Schema Omschrijving Includes Interactie
sdtc_extension.xsd
Hieronder een overzicht van alle Schematrons. Schematronbestanden van het type "interactie-id.sch" horen bij de oorspronkelijke methodiek. Schematronbestanden van het type "prefix-omschrijving.sch" zijn gegenereerd uit een DECOR-definitie.
Map/bestand Omschrijving
include Map met basis-schematron- en vocabulairebestanden voor alle via de DECOR-methodiek gegenereerde schematron
mp-cilstresp.sch Schematron file for REPC_IN000024NL - Opleveren potentiële contraindicaties
mp-ciqry.sch Schematron file for REPC_IN000023NL - Opvragen potentiële contraindicaties
mp-instance2schematron.xml XML bestand met link tussen instances en het bijbehorende schematron.
mp-medoverzicht.sch Schematron file for POCD_MT000040NL - Medicatieoverzicht
mp-medstm.sch Schematron file for PORX_IN040010NL - Meld medicatiegebruik
mp-medstmack.sch Schematron file for MCCI_IN000002 - Meld medicatiegebruik Acknowledgement
mp-medstmqry.sch Schematron file for PORX_IN040050NL - Opvragen medicatiegebruik
mp-medstmresp.sch Schematron file for PORX_IN040052NL - Opleveren medicatiegebruik
mp-medverslstqry.sch Schematron file for QURX_IN990111NL - Opvragen verstrekkingenlijst
mp-medverslstresp.sch Schematron file for QURX_IN990113NL - Opleveren verstrekkingenlijst
mp-medverst.sch Schematron file for PORX_IN924000NL - Meld medicatieverstrekking
mp-medverstack.sch Schematron file for MCCI_IN000002 - Meld Medicatieverstrekking Acknowledgement
mp-medverstqry.sch Schematron file for QURX_IN990011NL - Opvragen verstrekkingen
mp-medverstresp.sch Schematron file for QURX_IN990013NL - Opleveren verstrekkingen
mp-medvoorlstqry.sch Schematron file for QURX_IN990101NL - Opvragen voorschriftenlijst
mp-medvoorlstresp.sch Schematron file for QURX_IN990103NL - Opleveren voorschriftenlijst
mp-medvoors.sch Schematron file for PORX_IN932000NL - Verzoek uitvoeren voorschrift
mp-medvoorsack.sch Schematron file for MCCI_IN000002 - Verzoek uitvoeren voorschrift Acknowledgement
mp-MP9_av.sch Schematron file for - Sturen afhandeling voorschrift
mp-MP90_avvv.sch Schematron file for - Antwoord voorstel verstrekkingsverzoek
mp-MP90_ge.sch Schematron file for - Sturen gebruik
mp-MP90_mg.sch Schematron file for - Beschikbaarstellen medicatiegegevens
mp-MP90_mgs.sch Schematron file for - Sturen medicatiegegevens
mp-MP90_mo.sch Schematron file for - Medicatieoverzicht
mp-MP90_vma.sch Schematron file for - Sturen Voorstel medicatieafspraak
mp-MP90_vo.sch Schematron file for - Sturen voorschrift
mp-MP90_vvv.sch Schematron file for - Sturen Voorstel verstrekkingsverzoek
xslUtils Map met conversietools van www.schematron.com voor de conversie van Schematron naar XSLT
Overzicht van de binnen de map vocab gebruikte vocabulaires. De via de DECOR-methodiek (zie tabblad Inleiding) gegenereerde vocabulairebestanden staan in schematron/include en zijn niet hier gedocumenteerd, maar in de betreffende projectdocumentatie. Naarmate meer projecten worden ge/herschreven in DECOR zal het aantal hier genoemde vocabulaires afnemen. Het complete overzicht van door Nictiz gedefinieerde vocabulaire vindt u hier: http://decor.nictiz.nl/decor/services/ValueSetIndex

N.B. Vocabulaires die niet door Nictiz worden beheerd zijn zuiver informatief. Zij zijn opgenomen voor gebruik door de schematron en html presentatie stylesheets, meldingen moeten gezien worden waarschuwingen.

Naam OID
Trigger event 2.16.840.1.113883.1.18
Interactie Id 2.16.840.1.113883.1.6
Het onderstaande overzicht bevat beschrijvingen van de mappen in de XML-distributie. Klikken op een map gaat rechtstreeks naar de desbetreffende map.
Map/bestand Omschrijving
coreschemas
XML-basisschema's voor de definitie van datatypen en vocabulaires.
css
Bestanden voor de opmaak van html pagina's. Deze worden gebruikt voor de opmaak van de html documentatie en ook voor de opmaak van de html weergave van xml berichten. Naast cascading style sheets (css) bestanden voor de opmaak bevat deze folder ook javascript bestanden.
schemas
XML schema's voor de definitie van XML berichten. De XML schema's definiëren de structuur van de berichtinhoud en veelal ook de cardinaliteit van de elementen in een bericht.
schemas-SOAP
Schemas met focus op de SOAP envelope, zoals authenticatietokens.
schemas_codeGen
XML schema's welke door transformatie geschikt zijn gemaakt voor generatie van code door de transmission wrapper en de control act wrapper in het interactieschema te trekken. Hierdoor zijn er geen dubbele declaraties van Message, ControlAct, QueryByParameterPayload en Payload meer bij het genereren van code uit bijvoorbeeld de WSDL. Deze schema's zijn functioneel gelijk aan de schema's in de schemas folder.
schemas_codeGen_LSP
XML schemas welke door transformatie geschikt zijn gemaakt voor gebruik door de ZIM. Deze schema's zijn functioneel gelijk aan de schema's in de schemas folder, met als uitzondering dat medische inhoud is vervangen door xs:any.
schematron
Schematron-bestanden voor de validatie van 'business rules'. Het gaat hierbij om eisen die in implementatiehandleidingen zijn opgenomen, maar slechts moeizaam of helemaal niet met XML schema zijn af te dwingen. Dit is relevant voor ontwikkeling / test fase en niet bedoeld voor een productieomgeving.
De bestanden met extensie '.sch' zijn de schematrons.
De bestanden met bestandsnamen die eindigen op '_svrl.xsl' zijn XSLT (stylesheets) bestanden welke gegenereerd zijn uit de schematronbestanden. Indien de mogelijkheid ontbreekt om Schematron-bestanden te gebruiken voor de validatie van XML berichten dan kunnen deze XSLT's gebruikt worden. SVRL staat voor Schematron Validation Reporting Language (zie: http://schematron.com) en geeft de meldingen terug in een XML-structuur zodat deze verder kunnen worden verwerkt in andere logica.
De bestanden met bestandsnamen die eindigen op '_text.xsl' zijn XSLT (stylesheets) bestanden welke gegenereerd zijn uit de schematronbestanden. Indien de mogelijkheid ontbreekt om Schematron-bestanden te gebruiken voor de validatie van XML berichten dan kunnen deze XSLT's gebruikt worden. Deze XSLT's geven de meldingen terug via xsl:message. Deze meldingen zijn geschikt voor afslag in bijvoorbeeld logging. Zie SVRL om meldingen in een verwerkbare vorm geleverd te krijgen. (http://schematron.com)
schematron_closed_warnings
De map 'schematron_closed_warnings' bevat schematrons met daarin naast de gebruikelijke meldingen ook waarschuwingen worden gegeven voor zaken die niet zijn gespecificeerd. Dit is relevant voor ontwikkeling / test fase en niet bedoeld voor een productieomgeving.
De bestanden met extensie '.sch' zijn de schematrons.
De bestanden met bestandsnamen die eindigen op '_svrl.xsl' zijn XSLT (stylesheets) bestanden welke gegenereerd zijn uit de schematronbestanden in schematron_closed_warnings. Indien de mogelijkheid ontbreekt om Schematron-bestanden te gebruiken voor de validatie van XML berichten dan kunnen deze XSLT's gebruikt worden. SVRL staat voor Schematron Validation Reporting Language (zie: http://schematron.com) en geeft de meldingen terug in een XML-structuur zodat deze verder kunnen worden verwerkt in andere logica.
De bestanden met bestandsnamen die eindigen op '_text.xsl' zijn XSLT (stylesheets) bestanden welke gegenereerd zijn uit de schematronbestanden. Indien de mogelijkheid ontbreekt om Schematron-bestanden te gebruiken voor de validatie van XML berichten dan kunnen deze XSLT's gebruikt worden. Deze XSLT's geven de meldingen terug via xsl:message. Deze meldingen zijn geschikt voor afslag in bijvoorbeeld logging. Zie SVRL om meldingen in een verwerkbare vorm geleverd te krijgen. (http://schematron.com)
vocab
Vocabulaire bestanden met, binnen AORTA gebruikte, vocabulaires. Deze bestanden hebben als naam de OID van het desbetreffende vocabulaire met als extensie .xml.

N.B. Vocabulaires die niet door Nictiz worden beheerd zijn zuiver informatief. Zij zijn opgenomen voor gebruik door de schematron en html presentatie stylesheets, meldingen moeten gezien worden waarschuwingen.

wsdl
WSDL-bestanden met definities van de webservices.
wsdl-GBP
WSDL-bestanden met definities van de webservices specifiek voor een Patiëntenportaal (GBP) bestemd voor implementatie op de ZIM.
xml-ICA
XML-voorbeeldberichten uit het domein Medicatiebewaking.
xml-Mp
XML-voorbeeldberichten uit het domein Medicatie. (ontstaan uit Elektronisch Medicatie Dossier of EMD)
xsl
Bevat informatieve hulpmiddelen voor tonen en converteren van bepaalde XML-materialen.