Nictiz XML-distributie Ketenzorg v3.0.2

Gegenereerd: 10 januari 2019

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

Release: v3.0.2

Deze publicatie heeft als voornaamste doelen om een ongedocumenteerde en onbedoelde wijziging in de KEZO Verwijzing te corrigeren en tevens Medicatieafspraak 9.0.7 in te voegen als vervanging van Medicatieafspraak 9.0.5a. Zie voor details de releasenotes vanaf versie v3.0.1

Er zijn wijzigingen geweest in de volgende 3 issues sinds de laatste tussentijdse versie of release.
  • Issue 104 "Waardelijst ObservationInterpretation beter toelichten" met status "Gesloten". Laatste gebeurtenis (2019-01-09T14:36:53):
    De hele templateset voor laboratoriumresultaten is vervangen. De nieuwe set heeft relatie met de zib Laboeratoriumuitslag 4.2 en daarin is de lijst al sterk ingeperkt en de mapping is vervolgens expliciet gemaakt in de template.
  • Issue 127 "HL7 RoleCode vervangen door RoleCodeNL" met status "Gesloten". Laatste gebeurtenis (2019-01-09T14:27:36):
    Template 9007 omgezet naar domain="RoleCode" omdat niet gezegd is of dit een zorgverlener is. Templates 9030 en 9039 omgezet naar waardelijst RoleCodeNL - Zorgverlener
  • Issue 128 "BITS#KZ-39 Artsnaam/praktijknaam verplichten" met status "Gesloten". Laatste gebeurtenis (2019-01-09T15:42:28):
    Uitgevoerd zoals voorgesteld. Zie voor verdere discussie het oorspronkelijke issue BITS#KZ-39
  • Start met het opnieuw opbouwen van een relevante dataset gemaakt. Beschikbaar zijn nu: Patient, Zorgverlener, Zorgaanbieder, AllergieIntolerantie, Episode en Medicatieafspraak. Hiervoor zijn de transacties voor de laatste drie uitgebreid en tevens zoveel mogelijk de templatekoppelingen aangelegd
  • Medicatieafspraak 9.0.7 (MP9) is nu aan Ketenzorg toegevoegd. Hiervoor zijn de volgende dingen gedaan:
    • Ketenzorg transactie Beschikbaarstellen medicatieafspraken is aangepast zodat deze een-op-een gelijk is aan de MP9 transactie Beschikbaarstellen medicatiegegevens, uiteraard alleen voor zover het medicatieafspraken betreft. Merk op dat deze transactie in Medicatieproces 9.0.7 geen ondersteuning biedt voor de Kopie indicator. Ook Ketenzorg kent deze niet en opleveren van medicatieafspraken van derden wordt daarmee dus niet ondersteund.
    • Ketenzorg transactie Beschikbaarstellen medicatieafspraken is aangepast zodat deze koppelt met het template MP HL7 Medicatieafspraken Organizer (2.16.840.1.113883.2.4.3.11.60.20.77.10.9265). Deze is ook nieuw gemaakt in Medicatieproces 9.0.7

    Voor de volledigheid volgen hierbij ook de MP9 releasenotes voor zover deze betrekking hadden op Medicatieafspraak sinds versie 9.0.5:

    • Issue 329 : Bouwsteen medicatieafspraak. Dataset, transacties en templates zijn uitgebreid met relaties naar Episode / Contact.
    • Issue 337 : Template 9216 voor medicatieafspraak (versie 9.0.6) had in het voorbeeldfragment een verkeerd template-id. Dit is hersteld.
    • Issue 341 : Bouwstenen medicatieafspraak en verstrekkingsverzoek. Het werkadres van de voorschrijver respectievelijk auteur is nu verplicht in de bouwsteen.
    • Issue 348 : Geneesmiddel - product code. Meerdere product codes zijn gewenst, bij een specifieke G-standaard codering nu ook de meer generieke codering(en) meegeven. Aangepast in de scenario's/transacties.
    • Issue 349 : Geneesmiddel - template. De attributen bij ManufacturedMaterial waren verplicht volgens schematron, maar hebben default waarde in het xsd. Niet alle xml parsers genereren in zo'n geval deze attributen. Ze zijn daarom optioneel gezet in het template (en dus de schematrons). Semantisch maakt dat geen verschil.
    • Issue 354 : Bouwsteen medicatieafspraak. Lengte en gewicht meetdatum/tijd waren niet verplicht in MP maar wel in zib. Met issue 360 (gebruik maken van zib template) is dit ook hersteld: dus het meegeven van datum/tijd is nu verplicht
    • Issue 355 : Bouwsteen medicatieafspraak en medicatiegebruik. MA: de waardelijst voor 'Reden afspraak' is aangepast, tevens is het concept hernoemd. MGB: de waardelijst voor 'Reden stoppen of wijzigen gebruik' is aangepast naar aanleiding van deze aanpassingen in de lijst voor de MA.
    • Issue 358 : Informatiestandaard-overstijgende organizers voor bouwsteenquery-responses. Voor infrastructuren die losse bouwstenen opvragen bij bronsystemen zijn er organizers gemaakt die voor de MP-bouwstenen (MA, VV, TA, MVE, MGB) informatie-standaard overstijgend kunnen worden toegepast.
    • Issue 359 : Organizer/statusCode. Het was verplicht een nullFlavor door te geven, maar dat is te streng. De templatespecificaties zijn daarom versoepeld.
    • Issue 360 : Bouwsteen medicatieafspraak. Lengte en gewicht waren nog gebaseerd op oude zibs (2015) en een specifiek mp-template. Dit is herstel naar 2017 zib met bijbehorend template.
    • Issue 362 : Geneesmiddel - product code. De scenario's/transacties noemden onterecht een ATC-codering als optie. Dit is hersteld.
    • Issue 363 : Geneesmiddel - product code. Templates geschikt maken om het uitwisselen van 90 miljoen nummers mogelijk te maken.
    • Issue 364 : Functioneel ontwerp: diverse aanpassingen in het functioneel ontwerp.
    • Issue 350 : Datatype van verstrekte hoeveelheid/aantal. Dit was onterecht 'hoeveelheid', en is nu hersteld naar 'decimaal getal'. Heeft alleen effect op functioneel niveau in dataset (dus niet voor bericht templates / xml instances).
    • Issue 320 : Template 9184. Het sturen van een nullFlavor bij routeCode (toedieningsweg) werd onterecht afgekeurd door het template. Dit is hersteld.
    • Issue 327 : Waardelijst voor Aanvullende gebruiksinstructie. Template 9022. In de waardelijst ontbrak de optie 'Overig' voor de niet gecodeerde gebruiksinstructies. Dit is hersteld.
    • Issue 328 : Template voor reden van voorschrijven (9160) had een verkeerd attribuut bij het value element en er ontbrak een voorbeeld voor een gecodeerde reden van voorschrijven. Dit is hersteld.
    • Issue 330 : Templates voor kopie bouwstenen (MA, TA, GB in medicatieoverzicht) hebben nu een eigen templateId. De bestaande templateIds zijn ook gewijzigd vanwege backward compatibiliteit (andermans bouwstenen mogen niet meer in het template voor 'eigen' bouwstenen).
  • Documentatie over de mapping van NHG Tabel 45 eenheden naar HL7v3 datatypen en UCUM eenheden toegevoegd in de templates KEZO Algemene bepaling (2.16.840.1.113883.2.4.3.11.60.66.10.202) en Laboratory Observation NL (2.16.840.1.113883.2.4.3.11.60.7.10.31) - Deze documentatie is gekopieerd uit de Huisartswaarneemgegevens documentatie.
  • In templates waar een Organization/standardIndustryClass nog koppelde met het standaard CDA-domein OrganizationIndustryClass is nu de waardelijst OrganisatieTypeCodelijst uit de zib Zorgaanbieder met daarin onder andere "Huisasrtsenpraktijk" (Z3)
  • De template KEZO PART CDA Dossierhouder (2.16.840.1.113883.2.4.3.11.60.66.10.9032) is aangepast zodat een dossierhoudende organisatie nu ook wordt ondersteund. Voorheen was alleen een dossierhoudende zorgverlener mogelijk.
  • In diverse templates zijn kleine typfouten in omschrijvingen aangepast
  • In diverse templatevoorbeelden voor interpretationCode klopte de code niet met de displayName. Deze zijn gecorrigeerd.
In release 3.0.0 van Ketenzorg was een ongedocumenteerde wijziging geslopen. Deze wijziging was inhoudelijk correct, maar had moeten leiden tot een nieuw template-id voor de betreffende template.
  • De wijziging in template KEZO Verwijzing (id="2.16.840.1.113883.2.4.3.11.60.66.10.206" versie van "2014-06-27") is teruggedraaid. Deze template heeft nu status "deprecated";
  • Er is een nieuwe template KEZO Verwijzing (id="2.16.840.1.113883.2.4.3.11.60.66.10.222" versie van "2018-12-07") gemaakt als kopie van de oorspronkelijke template en hierin is de wijziging toegepast;
  • De nieuwe template KEZO Verwijzing is gekoppeld aan de documenten voor Verwijzing en Afbreken verwijzing.
De wijziging waar het om ging was dat vanwege de behoefte om op volledige episode informatie te kunnen verwijzen de wat meer basale "KEZO Indicatie Diagnose" (id=2.16.840.1.113883.2.4.3.11.60.66.10.205) is vervangen door de volledige "KEZO Overdracht Concern" (id=2.16.840.1.113883.2.4.3.11.60.66.10.212)
  • Dataset en transacties opgezet voor (organizer van) AllergieIntolerantie en Episode zoveel mogelijk op basis van zibs AllergieIntolerantie en Probleem. Episode is afgeleid uit de bestaande dataset in repository Huisartsgegevens. Controle gedaan tegen bestaande templates en afgeronde kwalificaties zodat de vrij uitgebreide templates niet tot een overmatig gevulde dataset leiden. Uitgangspunt is dat de transacties uiteindelijk alleen dingen bevat die werkelijk geïmplementeerd moeten worden.
  • Fix: Template "KEZO PART CDA Inhoudsverantwoordelijke (Body)" bevatte een element met predicate "hl7:participant[@typeCode='RESP']" terwijl het attribuut @typeCode in kwestie optioneel was. Dit attribuut is nu verplicht.
  • Fix: Template "KEZO PART CDA Dossierhouder" bevatte een element met predicate "hl7:participant[@typeCode='CST']" terwijl het attribuut @typeCode in kwestie optioneel was. Dit attribuut is nu verplicht.
  • Fix: Template "KEZO PART CDA Dossierhouder" moest een zorgverlener bevatten terwijl de ClinicalDocument/custodian, waarop deze gebaseerd moest zijn, alleen een zorgaanbieder vraagt. In de praktijk zijn dossierhouders ook altijd organisaties. Er is een nieuwe template "KEZO PART CDA Custodian Party (Body)" gemaakt op basis van template "KEZO PART CDA Responsible Party (Body)" waarin zorgaanbieder ondersteund wordt. Dit is niet backwards compatible met de situatie in Ketenzorg 3.0.1 doordat de oude template een zorgverlener 'eiste'. Doordat er in Ketenzorg 3.0.1 nog geen implementatie van dit element was, zal dit in de praktijk niet tot problemen leiden.
  • Fix: Template "KEZO Allergie Intolerantie Observatie" bevatte een element met predicate "hl7:participant[@typeCode='VRF']" terwijl het attribuut @typeCode in kwestie optioneel was. Dit attribuut is nu verplicht.

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 8 XML schema's, waarvan 0 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

COCT - Common Message Elements

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.
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
ClinicalDocument.sch Schematron file for ClinicalDocument - Klinisch document
include Map met basis-schematron- en vocabulairebestanden voor alle via de DECOR-methodiek gegenereerde schematron
kz-beschikbaarstellenAlerts.sch Schematron file for - Beschikbaarstellen alerts
kz-beschikbaarstellenAlgemeneUitslagen.sch Schematron file for - Beschikbaarstellen algemene uitslagen
kz-beschikbaarstellenAllergieintoleranties.sch Schematron file for - Beschikbaarstellen allergie/intoleranties
kz-beschikbaarstellenContactmomenten.sch Schematron file for - Beschikbaarstellen contactmomenten
kz-beschikbaarstellenContactverslagen.sch Schematron file for - Beschikbaarstellen contactverslagen
kz-beschikbaarstellenLabbepalingen.sch Schematron file for - Beschikbaarstellen labbepaling
kz-beschikbaarstellenMedicatieafspraken.sch Schematron file for - Beschikbaarstellen medicatieafspraken
kz-beschikbaarstellenOverdrachtconcerns.sch Schematron file for - Beschikbaarstellen overdracht concerns
kz-instance2schematron.xml Bestand dat verbinding maakt tussen een instance en een schematronbestand en tussen template en een transactie
kz-sturenAfbrekenVerwijzing.sch Schematron file for - Afbreken verwijzing
kz-sturenRapportageConsult.sch Schematron file for - Sturen Rapportage Consult
kz-sturenVerwijzing.sch Schematron file for - Sturen Verwijzing
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_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.
xml-KZ
XML-voorbeeldberichten uit het domein Ketenzorg.