Nictiz XML-distributie Verwijzingen v1.5.0-patch1

Gegenereerd: 22 January 2021, patch 1 dd 1 Juni 2021

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

Release: V1.5.0-patch1

Technische aanpassing in schematronbestanden DTr1_hl7nl-IVL_TS.sch en DTr1_IVL_TS.sch waardoor variabele-namen niet worden hergebruikt in dezelfde scope. Dit vergroot compatibiliteit met sommige frameworks zoals .Net. De SVRL en TXT versies van de schematrons zijn opnieuw gegenereerd met deze aanpassingen.
Deze publicatie vervangt V1.4, en bevat geen wijzigingen in de inhoud van de bestaande berichten. Er zijn wel 2 scenario’s en berichten toegevoegd: ‘MKA bevestigt naar HA of HAP‘ en ‘MKA stuurt voorwaarschuwing naar SEH’.
Daarnaast is de naamgeving consistent gemaakt (zie hieronder), en zijn er verschillende inconsistenties in koppelingen van templates en terminologie opgelost in de specificatie in ART-DECOR.
 
Er zijn wijzigingen geweest in de volgende issues sinds de laatste tussentijdse versie of release.
  • Issue 287 "consistente naamgeving doorvoeren" met status "Gesloten". Laatste gebeurtenis (2021-01-21T14:16:15):

Alle scenario's, transacties, templates, voorbeeldberichten en schematrons hebben nu een consistente naam volgens de volgende opzet:
Voor scenarios: <Zender> <Berichttype als werkwoord> naar/aan <Ontvanger>
Voor de transacties, templates en andere materialen: <Berichttype als zelfstandig naamwoord> <Zender> naar/aan <Ontvanger>

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)
Hieronder een overzicht van alle 23 XML schema's, waarvan 2 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_IN000002.xsd Interactieschema: Ontvangstbevestiging
POCD_IN000040NL.xsd Interactieschema: Versturen ClinicalDocument

CDA

XML Schema Omschrijving Includes Interactie
CDANL_extended.xsd
CDA top level schema met Nederlandse extensies
CDAr2ClinicalStatement.xsd
XML Schema met complexTypes voor het officiële CDA ClinicalStatement, met enkele uitzonderingen. Zie interne schema-documentatie voor details.
hl7nl_extension.xsd
XML Schema met Nederlandse extensies voor CDA.
organizer.xsd
XML Schema met organizer die bouwstenen groepeert op basis van CDAr2ClinicalStatement.xsd
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.

COCT - Common Message Elements

lab

XML Schema Omschrijving Includes Interactie
lab_extension.xsd
XML Schema met Nederlandse extensies voor Laboratoria.

MCAI - Message Act Infrastructure

MCCI - Message Control Infrastructure

pharm

XML Schema Omschrijving Includes Interactie
pharm_extension.xsd
XML Schema met Nederlandse extensies voor Pharmacy/medicatie.

POCD

XML Schema Omschrijving Includes Interactie
POCD_IN000040NL.xsd Interactieschema: Versturen ClinicalDocument
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
acutezorg-Bevestiging_MKA_HA.sch Schematron file for transaction Sturen bevestiging MKA naar HA of HAP (2.16.840.1.113883.2.4.3.11.60.55.4.85 2020-08-18T10:32:21)
acutezorg-instance2schematron.xml Bestand dat verbinding maakt tussen een instance en een schematronbestand en tussen een template en een transactie
acutezorg-Spoedmelding_HA_MKA.sch Schematron file for transaction Sturen spoedmelding HA of HAP naar MKA (2.16.840.1.113883.2.4.3.11.60.55.4.20 2015-10-13T22:42:39)
acutezorg-Verwijzing_HAPT_SEH.sch Schematron file for transaction Sturen verwijzing HAP-triagist naar SEH (2.16.840.1.113883.2.4.3.11.60.55.4.14 2015-10-13T22:23:26)
acutezorg-Verwijzing_HAPW_SEH.sch Schematron file for transaction Sturen verwijzing HA of HAP-huisarts naar SEH (2.16.840.1.113883.2.4.3.11.60.55.4.17 2015-10-13T22:36:16)
acutezorg-Verwijzing_MKA_SEH_naar_HA.sch Schematron file for transaction Sturen Verwijzing MKA of SEH naar HA of HAP (2.16.840.1.113883.2.4.3.11.60.55.4.8 2015-09-04T13:16:32)
acutezorg-Voorwaarschuwing_MKA_SEH.sch Schematron file for transaction Sturen voorwaarschuwing MKA naar SEH (2.16.840.1.113883.2.4.3.11.60.55.4.88 2020-08-18T11:21:59)
include Map met basis-schematron- en vocabulairebestanden voor alle via de DECOR-methodiek gegenereerde schematron
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 Nictiz gedefinieerde vocabulaire in ART-DECOR vindt u hier: http://decor.nictiz.nl/decor/services/ValueSetIndex?prefix=acutezorg-&version=2021-01-22T12:34:27

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_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.
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
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.
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_closed_warnings_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)
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.
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.
xml-acutezorg-verw
XML-voorbeeldberichten uit het domein Acute Zorg voor use case Verwijzingen.