VZVZ XML-distributie Ketenzorg op het LSP versie 1.0.2

Gegenereerd: 23 januari 2019

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.

VZVZ is voor nieuwere projecten 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. Projecten 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)
Hieronder een overzicht van alle 95 XML schema's, waarvan 28 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
MCCI_IN000002.xsd Interactieschema: Ontvangstbevestiging
GQZG_IN000001NL.xsd Interactieschema: Generieke Query Zorggegevens
POLB_IN354001NL02.xsd Interactieschema: Opvragen Labuitslagen
POLB_IN354001NL03.xsd Interactieschema: Opvragen Labbepalingen
POOB_IN990001NL.xsd Interactieschema: Opvragen Algemene Uitslagen
PRPA_IN900300NL.xsd Interactieschema: Opvragen Contactmomenten
QUMA_IN991201NL02.xsd Interactieschema: Opvragen Medicatieafspraken
QURX_IN990201NL01.xsd Interactieschema: Opvragen Voorschriften
REPC_IN990100NL.xsd Interactieschema: Opvragen contactverslagen
REPC_IN990110NL.xsd Interactieschema: Opvragen overdrachtconcerns
REPC_IN990120NL.xsd Interactieschema: Opvragen alerts
REPC_IN990130NL.xsd Interactieschema: Opvragen allergieintoleranties
ZTKZ_IN000001NL.xsd Interactieschema: verwijzingHuisartsZorggroep
ZTKZ_IN000001NL02.xsd Interactieschema: verwijzingHuisartsZorggroep
ZTKZ_IN000004NL.xsd Interactieschema: Overdracht ketenzorgdossier
ZTKZ_IN000004NL02.xsd Interactieschema: Overdracht ketenzorgdossier
QUMA_IN991203NL02.xsd Interactieschema: Opleveren Medicatieafspraken
POLB_IN364001NL02.xsd Interactieschema: Opleveren Labuitslagen
POLB_IN364001NL03.xsd Interactieschema: Opleveren Labbepalingen
REPC_IN990101NL.xsd Interactieschema: Opleveren contactverslagen
REPC_IN990111NL.xsd Interactieschema: Opleveren overdrachtconcerns
REPC_IN990121NL.xsd Interactieschema: Opleveren alerts
REPC_IN990131NL.xsd Interactieschema: Opleveren allergieintoleranties
POOB_IN990003NL.xsd Interactieschema: Opleveren Algemene Uitslagen
PRPA_IN900350NL.xsd Interactieschema: Opleveren Contactmomenten
QURX_IN990203NL01.xsd Interactieschema: Opleveren Voorschriften
ZTKZ_IN000005NL.xsd Interactieschema: verwijzingAfbrekenHuisartsZorggroep

CDANL

XML Schema Omschrijving Includes Interactie
CDANL_extended.xsd Omschrijving ontbreekt

CDAr2ClinicalStatement.xsd

COCT - Common Message Elements

XML Schema Omschrijving Includes Interactie
COCT_MT030000NL.xsd Omschrijving ontbreekt
COCT_MT030007NL.xsd Omschrijving ontbreekt
COCT_MT030200NL02.xsd Omschrijving ontbreekt
COCT_MT030203.xsd Omschrijving ontbreekt
COCT_MT030207NL.xsd Omschrijving ontbreekt
COCT_MT040200NL.xsd Omschrijving ontbreekt
COCT_MT040203.xsd Omschrijving ontbreekt
COCT_MT050000NL02.xsd Omschrijving ontbreekt
COCT_MT050004NL.xsd Omschrijving ontbreekt
COCT_MT070000.xsd Omschrijving ontbreekt
COCT_MT070000NL.xsd Omschrijving ontbreekt
COCT_MT090000.xsd Omschrijving ontbreekt
COCT_MT090000NL.xsd Omschrijving ontbreekt
COCT_MT090100.xsd Omschrijving ontbreekt
COCT_MT090108NL.xsd Omschrijving ontbreekt
COCT_MT090300.xsd Omschrijving ontbreekt
COCT_MT090303NL.xsd Omschrijving ontbreekt
COCT_MT120100NL02.xsd Omschrijving ontbreekt
COCT_MT120300NL.xsd Omschrijving ontbreekt
COCT_MT120500NL.xsd Omschrijving ontbreekt
COCT_MT150000.xsd Omschrijving ontbreekt
COCT_MT150000NL.xsd Omschrijving ontbreekt
COCT_MT150002NL.xsd Omschrijving ontbreekt
COCT_MT150003.xsd Omschrijving ontbreekt
COCT_MT150003NL.xsd Omschrijving ontbreekt
COCT_MT150007NL.xsd Omschrijving ontbreekt
COCT_MT200000NL.xsd Omschrijving ontbreekt
COCT_MT230100UV_ext_pharmacy.xsd Omschrijving ontbreekt
COCT_MT440001UV_ext_pharmacy.xsd Omschrijving ontbreekt
COCT_MT510004NL.xsd Omschrijving ontbreekt
COCT_MT550000NL.xsd Omschrijving ontbreekt
COCT_MT670000NL.xsd Omschrijving ontbreekt
COCT_MT710000.xsd Omschrijving ontbreekt
COCT_MT710000NL.xsd Omschrijving ontbreekt
COCT_MT820000NL.xsd Omschrijving ontbreekt
COCT_MT840000NL.xsd Omschrijving ontbreekt
COCT_MT840100NL.xsd Omschrijving ontbreekt
COCT_MT840200NL.xsd Omschrijving ontbreekt
COCT_MT841100NL.xsd Omschrijving ontbreekt
COCT_MT841200NL.xsd Omschrijving ontbreekt
COCT_MT841300NL.xsd Omschrijving ontbreekt
COCT_MT841400NL.xsd Omschrijving ontbreekt
COCT_MT841500NL.xsd Omschrijving ontbreekt
COCT_MT960000NL.xsd Omschrijving ontbreekt

GQZG

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

hl7nl

MCAI - Message Act Infrastructure

MCCI - Message Control Infrastructure

organizer.xsd

XML Schema Omschrijving Includes Interactie
organizer.xsd Omschrijving ontbreekt

POCD

POLB - Laboratory

POOB

XML Schema Omschrijving Includes Interactie
POOB_IN990001NL.xsd Interactieschema: Opvragen Algemene Uitslagen
POOB_IN990003NL.xsd Interactieschema: Opleveren Algemene Uitslagen

PORX - Pharmacy

XML Schema Omschrijving Includes Interactie
PORX_MT932200NL01.xsd Omschrijving ontbreekt

PRPA - Patient Administration

XML Schema Omschrijving Includes Interactie
PRPA_IN900300NL.xsd Interactieschema: Opvragen Contactmomenten
PRPA_IN900350NL.xsd Interactieschema: Opleveren Contactmomenten
PRPA_MT900300NL.xsd Omschrijving ontbreekt
PRPA_MT900300NL02.xsd Omschrijving ontbreekt

QUMA

XML Schema Omschrijving Includes Interactie
QUMA_IN991201NL02.xsd Interactieschema: Opvragen Medicatieafspraken
QUMA_IN991203NL02.xsd Interactieschema: Opleveren Medicatieafspraken

QUMT - Query Master File Types

QUQI - Query Infrastructure

QURX - Query Pharmacy

REPC - Care Provision

XML Schema Omschrijving Includes Interactie
REPC_IN990100NL.xsd Interactieschema: Opvragen contactverslagen
REPC_IN990101NL.xsd Interactieschema: Opleveren contactverslagen
REPC_IN990110NL.xsd Interactieschema: Opvragen overdrachtconcerns
REPC_IN990111NL.xsd Interactieschema: Opleveren overdrachtconcerns
REPC_IN990120NL.xsd Interactieschema: Opvragen alerts
REPC_IN990121NL.xsd Interactieschema: Opleveren alerts
REPC_IN990130NL.xsd Interactieschema: Opvragen allergieintoleranties
REPC_IN990131NL.xsd Interactieschema: Opleveren allergieintoleranties

sdtc

ZTKZ
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
kz-vzvz-afbrekenVerwijzing-ack.sch Schematron file for - Accept Acknowledgement
kz-vzvz-afbrekenVerwijzing.sch Schematron file for - Afbreken Verwijzing
kz-vzvz-batchAntwoord.sch Schematron file for - Beschikbaarstellen Actuele gegevens van patiënt
kz-vzvz-generiekeQueryKetenzorg.sch Schematron file for - Raadplegen Actuele gegevens van Patiënt
kz-vzvz-instance2schematron.xml  
kz-vzvz-opleverenAlerts.sch Schematron file for - Opleveren Alerts
kz-vzvz-opleverenAlgemeneBepalingen.sch Schematron file for - Opleveren Algemene Bepalingen
kz-vzvz-opleverenAllergieIntoleranties.sch Schematron file for - Opleveren AllergieIntoleranties
kz-vzvz-opleverenContactMomenten.sch Schematron file for - Opleveren ContactMomenten
kz-vzvz-opleverenContactVerslagen.sch Schematron file for - Opleveren ContactVerslagen
kz-vzvz-opleverenLabBepalingen.sch Schematron file for - Opleveren Labbepalingen
kz-vzvz-opleverenMedicatieafspraken.sch Schematron file for - Opleveren Medicatieafspraken
kz-vzvz-opleverenMedicatieVoorschriften.sch Schematron file for - Opleveren MedicatieVoorschriften
kz-vzvz-opleverenOverdrachtsConcerns.sch Schematron file for - Opleveren OverdrachtsConcerns
kz-vzvz-opvragenAlerts.sch Schematron file for - Opvragen Alerts
kz-vzvz-opvragenAlgemeneBepalingen.sch Schematron file for - Opvragen Algemene Bepalingen
kz-vzvz-opvragenAllergieIntoleranties.sch Schematron file for - Opvragen AllergieIntoleranties
kz-vzvz-opvragenContactMomenten.sch Schematron file for - Opvragen ContactMomenten
kz-vzvz-opvragenContactVerslagen.sch Schematron file for - Opvragen ContactVerslagen
kz-vzvz-opvragenLabBepalingen.sch Schematron file for - Opvragen Labbepalingen
kz-vzvz-opvragenMedicatieafspraken.sch Schematron file for - Opvragen Medicatieafspraken
kz-vzvz-opvragenMedicatieVoorschriften.sch Schematron file for - Opvragen MedicatieVoorschriften
kz-vzvz-opvragenOverdrachtConcerns.sch Schematron file for - Opvragen OverdrachtConcerns
kz-vzvz-sturenRapportageConsult-ack.sch Schematron file for - Accept Acknowledgement
kz-vzvz-sturenRapportageConsult.sch Schematron file for - Sturen Rapportage Consult
kz-vzvz-sturenVerwijzing-ack.sch Schematron file for - Accept Acknowledgement
kz-vzvz-sturenVerwijzing.sch Schematron file for - Sturen Verwijzing
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.

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
build.xml
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.
message-templates
Map met geparametriseerde antwoordsjablonen voor gebruik met ART-DECOR. Het bestand messageFilter_manifest.xml bevat configuratie voor contentgebaseerde antwoorden.
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 implementatie handleidingen zijn opgenomen, maar slechts moeizaam of helemaal niet met XML schema zijn af te dwingen.
schematron_closed_warnings
schematron_closed_warnings_svrl
schematron_svrl
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.
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 VZVZ 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.
xml
XML-voorbeeldberichten.