7phcy:V2.0 Toelichting samenhang Wiki en ART-DECOR
{{#customtitle:Toelichting bij HL7v3 implementatiehandleiding Medicatieproces|Toelichting bij HL7v3 implementatiehandleiding Medicatieproces}}
Inhoud
Inleiding
Doel en scope
Dit document bevat een toelichting bij de oplevering van de HL7v3-producten voor de zorgtoepassing Medicatieproces. De opgeleverde HL7v3-producten zijn de HL7v3-implementatiehandleiding Medicatieproces (wiki) en de bijbehorende html-uitgave van ART-DECOR ([DECOR MP]). Deze toelichting bevat de samenhang tussen beide opgeleverde producten. Daarnaast licht het ART-DECOR kort toe.
Doelgroep voor dit document
De doelgroep bestaat uit productmanagers en softwareontwikkelaars van informatiesystemen die de gegevensuitwisseling voor medicatieproces willen implementeren.
Samenhang Wiki en ART-DECOR
ART-DECOR en wiki zijn op zo'n manier aan elkaar gekoppeld dat er binnen ART-DECOR links zijn geplaatst naar de wiki wanneer een begrip in ART-DECOR uitleg behoeft. Wiki is dan ook voornamelijk bedoeld voor uitleg en achtergrondinformatie van de onderdelen binnen ART-DECOR. Het gaat hierbij voornamelijk om het tabblad Templates. Dit tabblad bevat de specificaties van de XML-berichten. Ieder XML-element waarvooor de wiki extra toelichting heeft, bevat een link 'Verdere informatie'.
Toelichting DECOR
De toelichting van DECOR is te vinden op de ART-DECOR Wiki.
Enkele extra toelichtingen met betrekking tot DECOR zijn hieronder in dit document te vinden.
DECOR met "twee gezichten"
De informatie die in DECOR is gedocumenteerd kan op twee manieren ingezien worden. Ten eerste is er een HTML versie. Deze geeft de “bevroren” versie van de DECOR bestanden op een bepaald tijdstip weer en bevat een DECOR publicatie (publicatie datum).
Voor medicatieproces is de link naar de meest recente versie altijd te vinden op http://decor.nictiz.nl/medicatieproces/
De versie-informatie is te zien op het voorblad (tevens ook de aanmaakdatum van het HTML uittreksel).
De HTML versie is niet interactief, dat wil zeggen dat er geen wijzigingen kunnen worden gemaakt. Wel kan men door de verschillende aspecten (zichten) van DECOR browsen.
Daarnaast is een interactieve versie beschikbaar met een gebruikers-interface, ART (Advanced Requirements Tooling) genoemd, om naast het browsen door de DECOR gegevens ook wijzigingen door te voeren en DECOR te beheren.
Voor extra uitleg zie: dit filmpje.
DECOR tabbladen
Tabblad Voorblad
Op dit tabblad wordt algemene projectinformatie getoond. Hierop is onder andere te zien op welk moment (datum en tijd) deze set is aangemaakt en welke organisaties betrokken zijn geweest bij het samenstellen.
Tabblad Projectinformatie
Op dit tabblad is algemene projectinformatie te vinden over het project en versiehistorie.
Tabblad Datasets
Tabblad Scenarios
TODO SCENARIOS
Tabblad Identificaties
Op dit tabblad is een overzicht gegeven van de gebruikte OID's.
Tabblad Terminologie
Op dit tabblad zijn de gebruikte value sets (waardenlijsten) te zien. Ze hebben een naam en een versie datum. In de templates wordt gebruikt gemaakt van links naar value sets, m.a.w. er wordt aangeduid welke waarden een code bij het betreffende element mag hebben.
Van een aantal value sets zijn meerdere versies beschikbaar.
Figuur x Decor template met meta informatie, elementen en attributen plus de weergave van de inperkingen. |
Bij dynamische binding van een value set wordt altijd de meest recente versie gebruikt. Bij statische binding van de value set wordt vermeld welke versie van toepassing is. Wanneer een statische binding van toepassing is wordt dat expliciet vermeld in de template.
Er is een mogelijkheid om de value sets down te loaden. Door op de CSV (comma separated file) of XML links naast het download icoontje te klikken worden de waardenlijsten per download ter beschikking gesteld.
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)
- Omschrijving
- Versie
- XML-voorbeeld
- Eén of meerdere HL7v3-elementen
Elk HL7v3-element kan de volgende onderdelen bevatten:
- Elementnaam
- Omschrijving
- Kardinaliteit
- Conformanceregel(s)
- XML-voorbeeld
- Nul of meerdere HL7v3-elementen
TO DO Decor template met meta informatie, elementen en attributen plus de weergave van de inperkingen.
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, RoleLink, Entity, Act, ActRelationship, Participation</blue>).
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 x Decor template: een XML element "medicationDispenseEvent" (in de HL7 namespace), een attribuut @classCode met de vaste waarde "SPLY" 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 x Decor template: een XML element “code” (in de HL7 namespace), met data type “CE” (code), required aan te geven (1..1 R) met de beschreven de @code en @codeSystem; |
Tabblad Issues
Tabblad Compliatie
Op dit tabblad kunnen in de runtime-versie problemen en waarschuwingen worden getoond.
Tabblad Colofon
Bevat het Colofon.
Uitgangspunten
Artefacten versionering
Data elementen, value sets, scenario's en regels die in DECOR zijn gedefinieerd hebben een aantal attributen t.b.v. versiebeheer. Belangrijkste eigenschappen zijn
- een identificatie (OID) en
- een naam een begin- en einddatum van geldigheid
- 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.
TODO Decor template lijst met namen, identificaties en versie datum. 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.
Bijlage A Referenties
Referentie | Document | Versie |
TODO |
TODO |
TODO |
TODO |
TODO |
TODO |
TODO |
TODO |
TODO |