7kezo:V1.0 Toelichting samenhang Wiki en ART-DECOR
{{#customtitle:Toelichting samenhang Wiki en ART-DECOR|Toelichting samenhang Wiki en ART-DECOR}}
Inleiding
Doel en scope
Deze toelichting beschrijft de samenhang tussen: de HL7v3 implementatiehandleiding bouwstenen Ketenzorg en uitwisseling Ketenzorg en de bijbehorende html-publicatie van ART-DECOR (DECOR KEZO).
Doelgroep voor dit document
De doelgroep bestaat uit productmanagers en softwareontwikkelaars van informatiesystemen die de gegevensuitwisseling voor ketenzorg willen implementeren.
Samenhang Wiki en ART-DECOR
ART-DECOR bevat links naar de wiki wanneer een begrip in ART-DECOR uitleg behoeft. Het gaat hierbij voornamelijk om het tabblad Templates in ART-DECOR. Dit tabblad bevat de specificaties van de XML-berichten. Ieder XML-element waarvoor de wiki extra toelichting heeft, bevat een link 'Verdere informatie' die de gebruiker direct naar de juiste toelichting in wiki brengt.
|
| Figuur: Verwijzingen in ART-DECOR naar verder uitleg in de wiki |
Toelichting ART-DECOR
De toelichting van ART-DECOR is te vinden op de ART-DECOR Wiki.
Enkele extra toelichtingen zijn hieronder in dit document te vinden.
DECOR met "twee gezichten"
De informatie die DECOR documenteert kan op twee manieren ingezien worden: met een statische HTML versie en met een interactieve versie.
De HTML versie bevat een statische, “bevroren” versie van de DECOR bestanden op een bepaald tijdstip: een DECOR publicatie (publicatie datum). De HTML versie is niet interactief, dat wil zeggen dat er geen wijzigingen kunnen worden gemaakt. Wel kan men de verschillende aspecten (zichten) van DECOR inzien met de verschillende tabbladen.
Voor ketenzorg is de link naar de meest recente HTML versie altijd te vinden op http://decor.nictiz.nl/ketenzorg/. De versie-informatie is te zien op het voorblad (tevens ook de aanmaakdatum van het HTML uittreksel).
Ten tweede is een interactieve versie beschikbaar met een gebruikers-interface, ART (Advanced Requirements Tooling) genoemd, om naast het inzien van DECOR gegevens ook wijzigingen door te voeren en DECOR te beheren.
Voor extra uitleg zie: deze film.
DECOR tabbladen
|
| Figuur: Ketenzorg html-publicatie van ART-DECOR |
Tabblad Voorblad
Bevat algemene projectinformatie: onder andere op welk moment (datum en tijd) de set is aangemaakt en welke organisaties betrokken zijn geweest bij het samenstellen.
Tabblad Projectinformatie
Bevat algemene projectinformatie over het project en versiehistorie.
Tabblad Datasets
Bevat Datasets.
Tabblad Scenarios
Bevat scenario's en transacties.
Scenario's vertegenwoordigen gebruiksscenario's, ook wel bekend als use cases waarin één of meerdere actoren met elkaar in een (deel)proces zitten en processtappen doorlopen op basis van één of meer transacties.
Transacties zijn vrijwel altijd een vorm van (berichtgebaseerde) communicatie, zoals een HL7v3-interactie. Transacties hebben meestal een gedefinieerde (keuze van) reactie. Iedere transactie gebruikt een deelverzameling van de concepten uit de dataset. Transacties en, indien van toepassing, hun reacties worden gebundeld in een transactiegroep.
Dit tabblad toont voor iedere transactie de bijbehorende datasetconcepten.
Tabblad Identificaties
Op dit tabblad is een overzicht gegeven van de gebruikte OID's.
Tabblad Terminologie
Bevat value sets (waardenlijsten), deze hebben een naam en een versie datum. De templates specificeren welke waarden een bepaald xml element of attribuut mag hebben door links op te nemen naar valuesets.
Van sommige value sets zijn meerdere versies beschikbaar.
|
| Figuur: Decor template met meta informatie, elementen en attributen plus de weergave van de inperkingen. |
Een dynamische binding van een value set gebruikt altijd de meest recente versie. Een statische binding van een value set vermeldt welke versie van toepassing is.
Value sets downloaden kan met behulp van REST-gebaseerde services van ART-DECOR, zie de Valueset index.
Tabblad Regels
De HL7v3-inhoud van de templates is op dit tabblad vastgelegd. De elementen in de template worden beschreven in de volgorde waarin zij voorkomen in een bericht (XML). Elke template kan de volgende onderdelen bevatten:
- Naam
- Identificatie (OID)
- Classificatie
- Relaties met andere templates
- Versie
- Omschrijving
- Koppelingen van de template elementen met dataset elementen
- Informatie in welke template dit template gebruikt wordt en welke templates dit template gebruikt
- XML-voorbeeld
- één of meerdere HL7v3-elementen.
|
| Figuur: Decor templatemetainformatie. |
Elk HL7v3-element kan de volgende onderdelen bevatten:
- Elementnaam
- Omschrijving
- Kardinaliteit
- Conformanceregel(s)
- XML-voorbeeld
- Nul of meerdere HL7v3-elementen
Vervolgens wordt een toelichting op de belangrijkste begrippen gegeven.
Element - een XML-element van een interactie, een „context node‟ zoals die in de XML-structuur van de interactie voorkomt. Element komt in het model (D-MIM / R-MIM) overeen met een klasse (Role, Role Link, Entity, Act, Act Relationship, Participation).
XML-attribuut - onderdeel van het element dat beschreven wordt. Een onderdeel kan in XML een attribuut of een element zijn. Onderdelen die beginnen met een @ zijn een XML-attribuut; de overige onderdelen zijn een XML-element.
Data type - Indien van toepassing wordt hier de data type van een element weergegeven (voorbeelden zijn “TS” timestamp, “CE” coded element enz.) Zie [HL7v3 IH Basis] voor meer informatie over datatypen.
Kardinaliteit - De kardinaliteit bepaalt het aantal keer dat het onderdeel mag/moet voorkomen. Zie [HL7v3 IH Basis] voor meer informatie over kardinaliteit. Hierbij wordt ook aangegeven of het onderdeel mandatory (vereist), required (verplicht ondersteunen eventueel met nullFlavor)of optioneel (niet verplicht; is de standaard waarde) is. Conditioneel verplichting is in de conformanceregels opgenomen.
|
| Figuur: Decor template: een XML element "observation" (in de HL7 namespace), een attribuut @classCode met de vaste waarde "OBS" en een @moodCode met de vaste waarde "EVN". |
Conformanceregel - beschrijft de regels waaraan het onderdeel moet voldoen. Hierin worden verplichte of standaard waarden voorgeschreven.
|
| Figuur: Decor template: een XML element “code” (in de HL7 namespace), met data type “CE” (code), mandatory aan te geven (1..1 M) met de beschreven de @code en @codeSystem; |
Tabblad Issues
Tabblad Compilatie
Kan - in de runtime-versie - problemen en waarschuwingen bevatten.
Tabblad Colofon
Bevat het Colofon.
Uitgangspunten
Artefacten versionering
Data elementen, value sets, scenario's en regels/templates die in DECOR zijn gedefinieerd hebben een aantal attributen voor versiebeheer. Belangrijkste eigenschappen zijn
- een identificatie (OID) en
- een naam een begin- (en eind-)datum van geldigheid en
- een status (nieuw, geldig, niet meer te gebruiken).
In het kopje van de desbetreffende artefacten is de naam en de id samen met de versiedatum te zien. Bovendien is de status van het element met een kleuren balletje aangegeven.
In ART-DECOR zijn lijsten van
met namen, identificaties en versie datum te vinden. De status is weergeven met een kleur, groen voor “actief”, rood hier als voorbeeld voor “niet meer gebruiken” en geel/oranje voor “in ontwikkeling” (draft).
Er zijn strikte regels voor het toekennen van OID's aan "nieuwe" versies van objecten.
Wiki Langingspagina
De Landingspagina voor de wiki-informatie ketenzorg is te vinden onder Landingspagina_Ketenzorg.
Schematron's en andere XML materialen
De schematron's en andere XML materialen (voorbeelden, schema's enz.) worden voor download ter beschikking gesteld waar ook de html-publicatie van ART-DECOR (DECOR KEZO) te vinden is.
|
| Figuur: Ketenzorg Download van de Schematron's en XML materialen. |
Beide links zijn ZIP bestanden. In de map XML zijn de bekende mappen te vinden:
- coreschemas
- schemas
- vocab
- xml-kz
met in xml-kz de voorbeeld berichten ketenzorg die d.m.v. de schemas (map schemas) en de schematron's (apart down te loaden) gevalideerd kunnen worden.