7phcy:V2.0 Toelichting samenhang Wiki en ART-DECOR: verschil tussen versies

Uit informatiestandaarden
Ga naar: navigatie, zoeken
 
(48 tussenliggende versies door 3 gebruikers niet weergegeven)
Regel 1: Regel 1:
{{#customtitle:Toelichting bij HL7v3 implementatiehandleiding Medicatieproces|Toelichting bij HL7v3 implementatiehandleiding Medicatieproces}}
+
{{DISPLAYTITLE:Toelichting samenhang Wiki en ART-DECOR|noreplace}}
  
 
=Inleiding=
 
=Inleiding=
 
==Doel en scope==
 
==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 ([HL7v3 IH MP]) 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.
+
Deze toelichting beschrijft de samenhang tussen: de HL7v3-implementatiehandleiding Medicatieproces ([[7phcy:V6.12_HL7v3-domeinspecificatie_Pharmacy|wiki]]) en de bijbehorende html-publicatie van ART-DECOR ([[http://decor.nictiz.nl/medicatieproces/ DECOR MP]]).
  
 
==Doelgroep voor dit document==
 
==Doelgroep voor dit document==
Regel 10: Regel 10:
 
De doelgroep bestaat uit productmanagers en softwareontwikkelaars van informatiesystemen die de gegevensuitwisseling voor medicatieproces willen implementeren.
 
De doelgroep bestaat uit productmanagers en softwareontwikkelaars van informatiesystemen die de gegevensuitwisseling voor medicatieproces willen implementeren.
  
==Documenthistorie==
+
=Samenhang Wiki en ART-DECOR=
  
TODO
+
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.
  
=Samenhang IH en DECOR=
 
  
TODO
+
{|
 +
|-
 +
|[[Image: samenhangwikiartdecor.png]]
 +
|-
 +
|Figuur 1 Verwijzingen in ART-DECOR naar wiki
 +
|}
  
=Toelichting DECOR=
+
=Toelichting ART-DECOR=
  
De toelichting van DECOR is te vinden op de
+
De toelichting van ART-DECOR is te vinden op de
 
[http://decor.nictiz.nl/wiki/index.php/Documentatie_DECOR ART-DECOR Wiki].
 
[http://decor.nictiz.nl/wiki/index.php/Documentatie_DECOR ART-DECOR Wiki].
  
Enkele extra toelichtingen met betrekking tot DECOR zijn hieronder in dit document te vinden.
+
Enkele extra toelichtingen zijn hieronder in dit document te vinden.
  
 
==DECOR met "twee gezichten"==
 
==DECOR met "twee gezichten"==
  
De informatie die in DECOR is gedocumenteerd kan op twee manieren ingezien worden.
+
De informatie die DECOR documenteert kan op twee manieren ingezien worden: met een statische HTML versie en met een interactieve versie.
Ten eerste is er een HTML versie. Deze geeft de “bevroren” versie van de DECOR bestanden op een bepaalde tijdstip weer en stelt de DECOR publicatie voor (publicatie datum).
 
  
Voor medicatieproces is de link naar de meest recente versie altijd te vinden op  
+
De HTML versie bevat een statische, “bevroren” versie van de DECOR bestanden op een bepaald tijdstip: een DECOR publicatie (publicatie datum).
http://decor.nictiz.nl/medicatieproces/
+
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.
De versie-informatie is te zien op het voorblad (tevens ook het aanmaak datum van het HTML uittreksel)
 
  
De HTML versie is niet interactief, d.w.z. dat er geen wijzigingen kunnen worden gemaakt. Wel kan men door de verschillende aspecten (zichten) van DECOR brouwsen.
+
Voor medicatieproces is de link naar de meest recente HTML 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).
  
''Voor sommige items zijn vlaggetjes beschikbaar (zie het voorbeeld “Graviditeit”). Deze kunnen worden gebruikt om wijzigingsvoorstellen, vragen of problemen met het desbetreffende item te melden. Door daar op te klikken wordt een email voorbereid die kan worden aangevuld. Daarna kan deze verstuurd worden naar de al ingevulde emailadress naar Nictiz.''
+
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.
  
[[Image: graviditeit.png|Figuur 3 Decor data element met een flag als mogelijkheid om issues in te kunnen dienen als email.]]
+
Voor extra uitleg zie: [http://vimeo.com/54511848 deze film].
 
 
Daarnaast is een interactive versie beschikbaar met een gebruikers-interface, ART (Advanced Requirements Tooling) genoemd, om naast het brouwsen door de DECOR gegevens ook wijzigingen voor te nemen en DECOR te beheren.
 
  
 
==DECOR tabbladen==
 
==DECOR tabbladen==
Regel 46: Regel 47:
 
===Tabblad Voorblad===
 
===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.
+
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===
 
===Tabblad Projectinformatie===
  
Op dit tabblad is algemene projectinformatie te vinden over het project en versiehistorie.
+
Bevat algemene projectinformatie over het project en versiehistorie.
  
 
===Tabblad Datasets===
 
===Tabblad Datasets===
  
[http://decor.nictiz.nl/wiki/index.php/Datasets_(DECOR) Datasets]
+
Bevat [http://decor.nictiz.nl/wiki/index.php/Datasets_(DECOR) Datasets].
  
 
===Tabblad Scenarios===
 
===Tabblad Scenarios===
 +
Bevat scenario's en transacties.
  
TODO SCENARIOS
+
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===
 
===Tabblad Identificaties===
Regel 66: Regel 72:
 
===Tabblad Terminologie===
 
===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.
+
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 een aantal value sets zijn meerdere versies beschikbaar.
+
Van sommige value sets zijn meerdere versies beschikbaar.
  
 
{|
 
{|
Regel 74: Regel 80:
 
|[[Image: screenshot_terminologie.png]]
 
|[[Image: screenshot_terminologie.png]]
 
|-
 
|-
|Figuur x Decor template met meta informatie, elementen en attributen plus de weergave van de inperkingen.
+
|Figuur 2 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 (dit is de default voor deze zorgtoepassing). 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.
+
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.  
  
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.
+
Value sets downloaden kan met behulp van [http://decor.nictiz.nl/wiki/index.php/URIs REST-gebaseerde services van ART-DECOR], zie de [http://decor.nictiz.nl/decor/services/ValueSetIndex Valueset index].
  
 
===Tabblad Regels===
 
===Tabblad Regels===
Regel 115: Regel 121:
 
|[[Image: Decor_template.png]]
 
|[[Image: Decor_template.png]]
 
|-
 
|-
|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".
+
|Figuur 3 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".
 
|}
 
|}
  
Regel 124: Regel 130:
 
|[[Image: Decor_template2.png]]
 
|[[Image: Decor_template2.png]]
 
|-
 
|-
|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;  
+
|Figuur 4 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;  
 
|}
 
|}
  
Regel 132: Regel 138:
 
[http://decor.nictiz.nl/wiki/index.php/Issues_(DECOR) Issues]
 
[http://decor.nictiz.nl/wiki/index.php/Issues_(DECOR) Issues]
  
===Tabblad Compliatie===
+
===Tabblad Compilatie===
  
Op dit tabblad kunnen in de runtime-versie problemen en waarschuwingen worden getoond.
+
Kan - in de runtime-versie - problemen en waarschuwingen bevatten.
  
 
===Tabblad Colofon===
 
===Tabblad Colofon===
Regel 143: Regel 149:
 
===Artefacten versionering===
 
===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  
+
Data elementen, value sets, scenario's en regels die in DECOR zijn gedefinieerd hebben een aantal attributen voor versiebeheer. Belangrijkste eigenschappen zijn  
 
* een identificatie (OID) en  
 
* een identificatie (OID) en  
* een naam een begin- en einddatum van geldigheid  
+
* een naam een begin- en einddatum van geldigheid en
 
* een status (nieuw, geldig, niet meer te gebruiken).
 
* een status (nieuw, geldig, niet meer te gebruiken).
  
Regel 153: Regel 159:
  
 
Er zijn strikte regels voor het toekennen van OID's aan "nieuwe" versies van objecten.
 
Er zijn strikte regels voor het toekennen van OID's aan "nieuwe" versies van objecten.
 
=Bijlage A Referenties=
 
 
{| style="color: black; background-color: #CCC0D9;"
 
|+ Tabel 1 Referenties
 
| '''Referentie'''
 
|'''Document'''
 
|'''Versie'''
 
|-
 
| style="background-color: white;"|
 
TODO
 
| style="background-color: white;"|
 
TODO
 
| style="background-color: white;"|
 
TODO
 
|-
 
| style="background-color: white;"|
 
TODO
 
| style="background-color: white;"|
 
TODO
 
| style="background-color: white;"|
 
TODO
 
|-
 
| style="background-color: white;"|
 
TODO
 
| style="background-color: white;"|
 
TODO
 
| style="background-color: white;"|
 
TODO
 
|}
 

Huidige versie van 26 aug 2020 om 15:21


Inleiding

Doel en scope

Deze toelichting beschrijft de samenhang tussen: de HL7v3-implementatiehandleiding Medicatieproces (wiki) en de bijbehorende html-publicatie van ART-DECOR ([DECOR MP]).

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 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.


Samenhangwikiartdecor.png
Figuur 1 Verwijzingen in ART-DECOR naar 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 medicatieproces is de link naar de meest recente HTML 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).

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

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.

Screenshot terminologie.png
Figuur 2 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)
  • 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.

Decor template.png
Figuur 3 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.

Decor template2.png
Figuur 4 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

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 die in DECOR zijn gedefinieerd hebben een aantal attributen voor versiebeheer. Belangrijkste eigenschappen zijn

  • een identificatie (OID) en
  • een naam een begin- en einddatum 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.

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.