vzvz XML-distributie Onderhoud_Open_HIS

Gegenereerd: 01 februari 2022

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

Release: HIS t.b.v. Open versie 1.0

Initiële publicatie van HIS t.b.v. Open versie 1.0

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.

vzvz is voor nieuwere projecten/standaarden overgeschakeld naar een nieuwe methodiek DECOR. vzvz 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)
Webservices GBK Indexbestand voor webservices ten behoeve van het Klantenloket (GBK)
Webservices GBO Indexbestand voor webservices ten behoeve van een Goed Beheerde Organisatie (GBO) op basis van PKIO-authenticatie
Hieronder een overzicht van alle 30 XML schema's, waarvan 6 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

BQZG

BRZG

COCT - Common Message Elements

XML Schema Omschrijving Includes Interactie
COCT_MT030203.xsd
COCT_MT040203.xsd
COCT_MT070000.xsd
COCT_MT090000.xsd
COCT_MT090100.xsd
COCT_MT090300.xsd
COCT_MT150000.xsd
COCT_MT150003.xsd
COCT_MT230100UV_ext_pharmacy.xsd
COCT_MT440001UV_ext_pharmacy.xsd
COCT_MT710000.xsd

CORR

XML Schema Omschrijving Includes Interactie
CORR_MT990003NL01.xsd

GPCD

GQZG

XML Schema Omschrijving Includes Interactie
GQZG_IN000001NL.xsd Interactieschema: Generieke Query Zorggegevens
GQZG_MT000001NL.xsd

MCAI - Message Act Infrastructure

MCCI - Message Control Infrastructure

CDA

XML Schema Omschrijving Includes Interactie
POCD_MT000040NL_extended.xsd
CDA include level schema met Nederlandse extensies
sdtc_extension.xsd
XML Schema met HL7 Structured Documents Technical Committee (SDTC) extensies voor CDA.

QUAF

QUCO

XML Schema Omschrijving Includes Interactie
QUCO_IN990001NL01.xsd Interactieschema: Opvragen Correspondentie
QUCO_IN990003NL01.xsd Interactieschema: Opleveren Correspondentie

QUQI - Query Infrastructure

ZTZM

XML Schema Omschrijving Includes Interactie
ZTZM_IN000004NL.xsd Interactieschema:
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
ho-vzvz-BevestigingDelenZelfmetingen.sch Schematron file for transaction Bevestiging (2.16.840.1.113883.2.4.3.111.3.28.4.3 2021-10-13T16:52:03)
ho-vzvz-DelenZelfmetingen.sch Schematron file for transaction Delen Zelfmetingen (2.16.840.1.113883.2.4.3.111.3.28.4.2 2021-10-13T16:52:03)
ho-vzvz-instance2schematron.xml Bestand dat verbinding maakt tussen een instance en een schematronbestand en tussen een template en een transactie
ho-vzvz-OpleverenContactafspraken.sch Schematron file for transaction Opleveren Contactafspraken (2.16.840.1.113883.2.4.3.111.3.28.4.9 2021-10-13T16:56:36)
ho-vzvz-OpleverenCorrespondentie.sch Schematron file for transaction Opleveren Correspondentie (2.16.840.1.113883.2.4.3.111.3.28.4.12 2021-10-13T16:57:39)
ho-vzvz-OpvragenContactafspraken.sch Schematron file for transaction Opvragen Contactafspraken (2.16.840.1.113883.2.4.3.111.3.28.4.8 2021-10-13T16:56:36)
ho-vzvz-OpvragenCorrespondentie.sch Schematron file for transaction Opvragen Correspondentie (2.16.840.1.113883.2.4.3.111.3.28.4.11 2021-10-13T16:57:39)
include Map met basis-schematron- en vocabulairebestanden voor alle via de DECOR-methodiek gegenereerde schematron
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 overzicht van door vzvz gedefinieerde vocabulaire in ART-DECOR vindt u hier: http://decor.nictiz.nl/decor/services/ValueSetIndex?prefix=ho-vzvz-&version=2021-12-31T15:40:35

N.B. Vocabulaires die niet door vzvz 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
Systeemrollen 2.16.840.1.113883.2.4.3.11.3
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
compiled
coreschemas
XML-basisschema's voor de definitie van datatypen en vocabulaires.
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_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_flat
XML schema's welke door transformatie volledig op zichzelf staan en geen verwijzingen meer naar andere schema's hebben (afgezien van eventuele xs:import). 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.
schematron_closed_warnings_svrl
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.
schematron_xslt
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 door derden 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-COVABE
wsdl-DVZA
wsdl-GBK
WSDL-bestanden met definities van de webservices specifiek voor het Klantenloket (GBK) bestemd voor implementatie op de ZIM.
wsdl-GBO
WSDL-bestanden met definities van de webservices specifiek voor een Goed Beheerde Organisatie (GBO) op basis van PKIo-certificaten, bestemd voor implementatie op de ZIM.
wsdl-GBP
WSDL-bestanden met definities van de webservices specifiek voor een Patiëntenportaal (GBP) bestemd voor implementatie op de ZIM.
xml
XML-voorbeeldberichten.