Hilfe:Art-Decor-Tabellen verstehen: Unterschied zwischen den Versionen

Aus HL7 Austria MediaWiki
Wechseln zu: Navigation, Suche
[unmarkierte Version][geprüfte Version]
(Seite erstellt)
 
(Erklärung der Hintergrundfarbe von Strukturbeispielen hinzugefügt)
 
(79 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
==How to read the table view for templates==
+
=Art-Decor-Tabellen verstehen=
 +
<div style="border: thin #C9302C solid;width:100%; margin-left: 10px">
 +
  <div style="line-height: 1.25; font-size:16px; border-bottom: 1px solid #C9302C; box-shadow: 0 4px 0 0 #C9302C;margin-
 +
  bottom:4px; color:#C9302C; width:100%">
 +
    <p style="padding: 10px 15px;font-size:18px;">Anleitung: Lesen der Tabellenansicht von Templates</p>
 +
  </div>
 +
  <div style="width:100%;">
 +
<p style="padding-left:10px; padding-top: 10 px>
 +
Die Template Definitionen werden in einer Tabellenansicht angezeigt. <br/>Diese besteht aus Template Meta Daten und dem Template Design. <br/> Weitere Informationen finden Sie im HL7 Template-Austauschformat-Standard "Specification and Use of Reusable Information Constraint Templates, Release 1"<ref> HL7 Templates Standard: Specification and Use of Reusable Information Constraint Templates, Release 1  [http://www.hl7.org/implement/standards/product_brief.cfm?product_id=377] </ref> und auf der "How-To-Read"-Seite von Art-Decor<ref>How to read ART-DECOR Definitions https://art-decor.org/mediawiki/index.php?title=How_to_read_ART-DECOR_Definitions</ref>.
 +
==Template Meta Daten==
 +
<imagemap>
 +
Datei:art-decor-1.png|800px|Art-Decor
 +
#Anklickbare Zahlen
 +
rect  350 50  450 150  [[#Template Meta Daten|1 Template-ID, Status und Template-Name]]
 +
rect  550 50  650 150  [[#Template Meta Daten|2 Versionsnummer ("effectiveDate"), Versionslabel und Anzeigename]]
 +
rect  700 150  800 250  [[#Template Meta Daten|3 Beschreibung des Templates]]
 +
rect  400 250  500 350  [[#Template Meta Daten|4 Offen oder geschlossenes Template]]
 +
rect  580 320  680 420  [[#Template Meta Daten|5 Andere Templates, die dieses Template verwenden oder von diesem Template verwendet werden]]
 +
rect  700 400  800 475  [[#Template Meta Daten|6 Beziehungen zu anderen Templates]]
 +
rect  700 480  800 550  [[#Template Meta Daten|7 XML-Fragment als Beispiel]]
 +
</imagemap>
 +
Der obere rechte Teil der Template-Tabelle enthält die Template-Metadaten. Hier werden Template-ID, Status und der Template-Name angezeigt(1).
 +
Weiters werden die Version (effective date), ein mögliches Versionslabel und der Anzeigename dargestellt(2).
 +
<br/>
 +
Die Beschreibung (einfach oder ein Akkordeon) enthält die Template-Beschreibungen/Zweck(3), gefolgt von der Klassifikationen und ob das Template als offen oder geschlossen definiert ist(4).
 +
<br/>
 +
Der Verwendungsteil (5) listet Templates auf, die dieses Template verwenden oder welche Templates in diesem Template inkludiert sind. <br/>
 +
Die Beziehungsliste (6) enthält alle Beziehungen zu anderen Templates oder Modellen.
 +
<br/>
 +
Beispiele zeigen die korrekte Verwendung der Templates durch ein XML-Fragment (7).
 +
<br/><br/>
 +
Die Strukturbeispiele (XML-Fragmente) werden je nach Typ mit einer eigenen Farbe hinterlegt:
 +
* '''grün:''' korrektes Beispiel, das die präferierte Struktur darstellt
 +
* '''blau:''' korrektes Beispiel
 +
* '''rot:''' ungültiges Beispiel
 +
[[Datei:Art-decor_strukturbeispiel.PNG|1024px]]
 +
<br/><br/>
 +
<imagemap>
 +
Datei:Ref_template_artdecor.png|800px|Art-Decor
 +
#Anklickbare Zahlen
 +
rect  500 10  650 75    [[#Template Meta Daten|8 referenziertes Template]]
 +
</imagemap>
 +
Ein referenziertes Template ist erkennbar durch ein grau hinterlegtes "ref", gefolgt mit einen bunt hinterlegten Namen der verwendeten Quelle (8).
 +
<br/><br/>
 +
[[Datei:art-decor-2.png]]
 +
<br/><br/>
 +
Die Beziehungsliste zeigt alle Beziehungen zu anderen Templates oder Modellen für dieses Template auf. Diese Liste ist aufgeteilt in einen "Used By" Abschnitt, welcher eine Auflistung der Templates wiedergibt, die von diesem Template Gebrauch machen, und in einen "Used" Abschnitt, der alle Templates beinhaltet, die in diesem Template eingebunden sind (entweder einbezogen oder eingegrenzt). Indirekte Beziehungen, wie das übergeordnete Document Level Template für eine Section Level Template, sind mit einem Kettensymbol gekennzeichnet.
 +
<br/>
 +
PDF-Versionen werden auf die gleiche Weise eingebunden, beinhalten aber eventuell andere Schriftarten etc., um konforme Publikationsanforderungen zu erfüllen.
 +
<br/><br/>
 +
[[Datei:art-decor-3.png]]
 +
==Tabellenansicht vom Template Design==
 +
[[Datei:art-decor-4.png]]
 +
<br/><br/>
 +
Die Überschriften der Tabellenansicht eines Template Designs sind:
 +
<br/>
 +
* '''Item (1)''' enthält die XML-Dokumentbaumansicht aller im Template-Design angegebenen Elemente und Attribute. Elemente werden durch ein vorangestelltes Dreieck gekennzeichnet und Attribute durch ein vorangestelltes "@".
  
The template definitions are shown in a table view. It is comprised of ''Template Meta data'' and the ''Template Design''. For further information please refer to the HL7 Templates Standard: Specification and Use of Reusable Information Constraint Templates, Release 1<ref name="teits"/>.
+
* '''DT (2)''' enthält den Datentyp des Elements.
 
+
* '''Card / Conf (3)''' Kardinalität (Card) und Konformität (Conf) des Artikels.
Templates may also be included in the hierarchical graph view (often used for CDA), see below.
+
Kardinalität gibt die min und max Anzahl der Vorkommen des Elements an. Attribute der Kardinalität 0..1 werden als optional bezeichnet, die Kardinalität 1..1 sagt aus, dass das Attribut erforderlich ist und NP sind verbotene Attribute. Die Konformität kann Werte, wie in der folgenden Tabelle gezeigt, enthalten.
 
+
<br/>
===Template Meta data===
 
{{IncludeImage|TemplatePublication1.png|750px|100%}}
 
 
 
The upper right part of the template table contains the template meta data. Template id, status and the template name are shown (1). Furthermore the Version (effective date), a possible version label and the display name are shown (2).
 
 
 
The description area (plain or an accordion) contains the template descriptions/purpose (3), followed by classifications and whether the template is defined as open or closed (4).
 
 
 
The usage part (5) may list templates that uses this template or what templates this templates uses. A relationship list (6) may show all relationships to other templates or models.
 
 
 
Examples may show the correct use of the template by an XML fragment (7).
 
 
 
{{IncludeImage|TemplatePublication5a.png|750px|100%}}
 
 
 
The relationship list shows all relationships to other templates or models for this template. It is divided in the "Used by" part listing templates that make use of this template, and a "Uses" listing all templates that are used by this templates, either as inclusion or containment. Indirect relationships like the parent Document Level Template for a Section Level Template are marked with a chain symbol.
 
 
 
The PDF version is rendered in the same way, but maybe with different fonts etc. to fit customized publication requirements.
 
 
 
{{IncludeImage|TemplatePublication2.png|750px|100%}}
 
 
 
===Table view of Template Design===
 
{{IncludeImage|TemplatePublication3.png|750px|100%}}
 
 
 
The headings of the table view of a template design are:
 
 
 
'''Item (1)''' contains the XML document tree view of all elements and attributes specified in the template design. Elements are denoted by a preceding triangle and attributes by a preceding "@".
 
 
 
'''DT (2)''' data types, contains the data type of the item, for more information on valid data types for element and attributes (see <ref name="teits"/>).
 
 
 
'''Card / Conf (3)''' cardinality (Card) and conformance (Conf) of the item.
 
Cardinality is the usual notion of min and max occurrences of the element. For attributes 0..1 denotes optionality, 1..1 say that the attribute is required and NP denotes prohibited attributes.
 
Conformance may display values as shown in the following table.
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|+Values of the conformance column
 
|+Values of the conformance column
 
! '''Conf''' !! Short !! Description
 
! '''Conf''' !! Short !! Description
 
|-
 
|-
|O || optional || Data is truly optional
+
|O || optional || Daten sind optional
 
|-
 
|-
|R || required || If data is present and not masked (e.g. for privacy reasons), it must be provided, otherwise it may be omitted or explicitly null flavored.<br/>Sender and receiver must support this element.
+
|R || required || Wenn Daten vorhanden sind und nicht geschützt sind (z. B. aus Datenschutzgründen), müssen sie bereitgestellt werden, andernfalls können sie weggelassen oder explizit der null flavor angegeben werden.<br/>
 +
Sender und Empfänger müssen dieses Element unterstützen.
 
|-
 
|-
|M || mandatory || The data must be populated with a valid value from the associated value domain, otherwise the instance is not valid and may not be communicated.<br/>Sender and receiver must support this element.
+
|M || mandatory || Die Daten müssen mit einem gültigen Wert aus der zugehörigen Wertdomäne befüllt werden, andernfalls ist die Instanz nicht gültig und darf nicht kommuniziert werden. <br/> Der Sender und der Empfänger müssen dieses Element unterstützen.
 +
 
 
|-
 
|-
|C || conditional || There are conditions when data has to be provided (e.g. co-constraints like "information about pregnancy IF the patient is "female".<br/>Sender and receiver must support this element.
+
|C || conditional || Es gibt Bedingungen, in denen Daten bereitgestellt werden müssen (z. B. Co-Constraints wie "Informationen über die Schwangerschaft, wenn der Patient" weiblich "ist. <br/> Der Sender und der Empfänger müssen dieses Element unterstützen.
 +
 
 
|-
 
|-
|F || fixed || The data has a fixed value.
+
|F || fixed || Die Daten haben einen festen Wert.
 +
 
 
|-
 
|-
|NP || not&nbsp;present || Data shall not be present
+
|NP || not&nbsp;present || Daten sollen nicht aufscheinen
 
|}
 
|}
 +
<br/>
 +
* '''Description (4)''' enthält eine Textbeschreibung des Elements und kann auch Einschränkungen und Werte für feste Attribute enthalten.
 +
* '''Label (5)''' ist ein menschlich lesbares Label, das bei Fehlern, Warnungen oder Notizen während der Validierung angezeigt wird.
 +
==Details von der Tabellenansicht==
 +
[[Datei:art-decor-5.png]]
  
'''Description (4)''' contains a textual description of the item, may also contain constraints and values for fixed attributes.
+
Das eigentliche Template-Design zeigt die XML-Struktur in einer hierarchischen Liste von Elementen (Items), die typischerweise einen Namespace "hl7:" oder "cda:" (1) vorangestellt haben. Diese im Art-Decor angegebenen Namespaces werden nicht in den letztendlichen eHealth-Austria Dokumenten genutzt! Das HL7-International-Namespace, welches im Art-Decor unter "hl7:" oder "cda:" geführt wird, ist in den eHealth-Austria Dokumenten als Standard-Namespace für alle eHealth-Austria-Dokumente geführt: "<ClinicalDocument '''xmlns="urn:hl7-org:v3"''' ... >"
 
 
'''Label (5)''' is a human readable label that is displayed upon errors, warnings or notes during validation.
 
 
 
===Details of the table view===
 
{{IncludeImage|TemplatePublication4.png|750px|100%}}
 
 
 
The actual template design shows the XML structure in a hierarchical list of elements (items) that are typically prefixed by the namespace "hl7:" or "cda:" (1).
 
 
 
Elements are denoted with a triangle, attributes with an @ sign (2).
 
 
 
Data types are specified according to the list of supported data types (3). They may be simple data types (lowercase), regular data types (uppercase) or flavors thereof.
 
 
 
The cardinality and conformance column is explained above (4).
 
 
 
Fixed values for e.g. attributes are also shown in the "description" column (5), preceded by a "F" in the Conf column.
 
  
Conformance statements are shown together with a CONF box, e.g. a @code and a @codeSystem with fixed and required values (6).  
+
Elemente werden mit einem Dreieck bezeichnet, Attribute mit einem @ -Zeichen (2).
  
An optional label is displayed at the rightmost column (7).
+
Datentypen werden nach der Liste der unterstützten Datentypen (3) angegeben. Es können einfache Datentypen (Kleinbuchstaben), reguläre Datentypen (Großbuchstaben) oder flavors sein.
  
<!--Some items have a reference / relationship with data set elements that are denoted as a concept target (7).-->
+
Die Kardinalitäts- und Konformitätsspalte ist oben (4) erläutert.
Inclusion or containments of other templates, e.g. an entry within a section, are shown accordingly (8) along with their template id, display name and flexibility/stability indication, i.e. "DYNAMIC" (the most recent version) or a STATIC binding together with a version date.
 
  
{{IncludeImage|TemplatePublication5b.png|750px|100%}}
+
Feste Werte für z.B. Attribute werden auch in der Spalte "Beschreibung" (5) angezeigt, denen ein "F" in der Spalte Conf folgt.
  
Choices of elements are shown as a choice list with the elements in questions summarised in a bullet point list.
+
Konformitätserklärungen werden zusammen mit einer CONF-Box gezeigt, z.B. ein @code und ein @codeSystem mit festen und erforderlichen Werten (6).
  
{{IncludeImage|TemplatePublication6b.png|750px|100%}}
+
Ein optionales Label wird in der rechten Spalte (7) angezeigt.
  
A typical Conformance Statement is the binding of a coded element to a value set. This is expressed in the way shown. The value set is represented with the id, display name and the flexibility/stability of the binding.
+
Einbeziehung oder Eingrenzung von anderen Templates, z.B. ein Eintrag innerhalb eines Abschnitts, werden entsprechend (8) zusammen mit ihrer Template-ID, dem Anzeigenamen und der Flexibilität/Stabilitätsanzeige angezeigt, d.h. "DYNAMIC" (die neueste Version) oder STATIC zusammen mit dem Versionsdatum.
 +
<br/><br/>
 +
[[Datei:art-decor-6.png]]
  
{{IncludeImage|TemplatePublication6c.png|750px|100%}}
+
Die Auswahl von Elementen wird als Auswahlliste mit den Elementen in Fragen dargestellt, die in einer Aufzählungsliste zusammengefasst sind.
 +
<br/><br/>
 +
[[Datei:art-decor-7.png]]
  
In case a constraint is expressed in words, a box "Constraint" accompanies the textual expression of the constraint.
+
Eine typische Konformitätserklärung ist die Bindung eines codierten Elements an einen Wert. Dies wird in der dargestellten Weise ausgedrückt. Der Wert wird mit der ID, dem Anzeigenamen und der Flexibilität/Stabilität der Bindung dargestellt.
 +
<br/><br/>
 +
[[Datei:art-decor-8.png]]
  
{{IncludeImage|TemplatePublication6a.png|750px|100%}}
+
Wenn eine Einschränkung in Worten ausgedrückt wird, begleitet eine Box "Constraint" den Textausdruck der Einschränkung.
 +
<br/><br/>
 +
[[Datei:art-decor-9.png]]
  
In cases where constraints are expressed by formalised rules in ISO Schematron, the rule along with the role (error, warning), the test and the assertion message is shown.
+
In Fällen, in denen Einschränkungen durch formalisierte Regeln in ISO Schematron ausgedrückt werden, wird die Regel zusammen mit der Rolle (Fehler, Warnung), der Test und die Assertionsmeldung angezeigt.
 +
</p>
 +
</div>
 +
</div>

Aktuelle Version vom 3. Dezember 2020, 10:17 Uhr

1 Art-Decor-Tabellen verstehen

Anleitung: Lesen der Tabellenansicht von Templates

Die Template Definitionen werden in einer Tabellenansicht angezeigt.
Diese besteht aus Template Meta Daten und dem Template Design.
Weitere Informationen finden Sie im HL7 Template-Austauschformat-Standard "Specification and Use of Reusable Information Constraint Templates, Release 1"[1] und auf der "How-To-Read"-Seite von Art-Decor[2].

1.1 Template Meta Daten

1 Template-ID, Status und Template-Name2 Versionsnummer ("effectiveDate"), Versionslabel und Anzeigename3 Beschreibung des Templates4 Offen oder geschlossenes Template5 Andere Templates, die dieses Template verwenden oder von diesem Template verwendet werden6 Beziehungen zu anderen Templates7 XML-Fragment als BeispielArt-Decor
Über dieses Bild

Der obere rechte Teil der Template-Tabelle enthält die Template-Metadaten. Hier werden Template-ID, Status und der Template-Name angezeigt(1). Weiters werden die Version (effective date), ein mögliches Versionslabel und der Anzeigename dargestellt(2).
Die Beschreibung (einfach oder ein Akkordeon) enthält die Template-Beschreibungen/Zweck(3), gefolgt von der Klassifikationen und ob das Template als offen oder geschlossen definiert ist(4).
Der Verwendungsteil (5) listet Templates auf, die dieses Template verwenden oder welche Templates in diesem Template inkludiert sind.
Die Beziehungsliste (6) enthält alle Beziehungen zu anderen Templates oder Modellen.
Beispiele zeigen die korrekte Verwendung der Templates durch ein XML-Fragment (7).

Die Strukturbeispiele (XML-Fragmente) werden je nach Typ mit einer eigenen Farbe hinterlegt:

  • grün: korrektes Beispiel, das die präferierte Struktur darstellt
  • blau: korrektes Beispiel
  • rot: ungültiges Beispiel

Art-decor strukturbeispiel.PNG

8 referenziertes TemplateArt-Decor
Über dieses Bild

Ein referenziertes Template ist erkennbar durch ein grau hinterlegtes "ref", gefolgt mit einen bunt hinterlegten Namen der verwendeten Quelle (8).

Art-decor-2.png

Die Beziehungsliste zeigt alle Beziehungen zu anderen Templates oder Modellen für dieses Template auf. Diese Liste ist aufgeteilt in einen "Used By" Abschnitt, welcher eine Auflistung der Templates wiedergibt, die von diesem Template Gebrauch machen, und in einen "Used" Abschnitt, der alle Templates beinhaltet, die in diesem Template eingebunden sind (entweder einbezogen oder eingegrenzt). Indirekte Beziehungen, wie das übergeordnete Document Level Template für eine Section Level Template, sind mit einem Kettensymbol gekennzeichnet.
PDF-Versionen werden auf die gleiche Weise eingebunden, beinhalten aber eventuell andere Schriftarten etc., um konforme Publikationsanforderungen zu erfüllen.

Art-decor-3.png

1.2 Tabellenansicht vom Template Design

Art-decor-4.png

Die Überschriften der Tabellenansicht eines Template Designs sind:

  • Item (1) enthält die XML-Dokumentbaumansicht aller im Template-Design angegebenen Elemente und Attribute. Elemente werden durch ein vorangestelltes Dreieck gekennzeichnet und Attribute durch ein vorangestelltes "@".
  • DT (2) enthält den Datentyp des Elements.
  • Card / Conf (3) Kardinalität (Card) und Konformität (Conf) des Artikels.

Kardinalität gibt die min und max Anzahl der Vorkommen des Elements an. Attribute der Kardinalität 0..1 werden als optional bezeichnet, die Kardinalität 1..1 sagt aus, dass das Attribut erforderlich ist und NP sind verbotene Attribute. Die Konformität kann Werte, wie in der folgenden Tabelle gezeigt, enthalten.

Values of the conformance column
Conf Short Description
O optional Daten sind optional
R required Wenn Daten vorhanden sind und nicht geschützt sind (z. B. aus Datenschutzgründen), müssen sie bereitgestellt werden, andernfalls können sie weggelassen oder explizit der null flavor angegeben werden.

Sender und Empfänger müssen dieses Element unterstützen.

M mandatory Die Daten müssen mit einem gültigen Wert aus der zugehörigen Wertdomäne befüllt werden, andernfalls ist die Instanz nicht gültig und darf nicht kommuniziert werden.
Der Sender und der Empfänger müssen dieses Element unterstützen.
C conditional Es gibt Bedingungen, in denen Daten bereitgestellt werden müssen (z. B. Co-Constraints wie "Informationen über die Schwangerschaft, wenn der Patient" weiblich "ist.
Der Sender und der Empfänger müssen dieses Element unterstützen.
F fixed Die Daten haben einen festen Wert.
NP not present Daten sollen nicht aufscheinen


  • Description (4) enthält eine Textbeschreibung des Elements und kann auch Einschränkungen und Werte für feste Attribute enthalten.
  • Label (5) ist ein menschlich lesbares Label, das bei Fehlern, Warnungen oder Notizen während der Validierung angezeigt wird.

1.3 Details von der Tabellenansicht

Art-decor-5.png

Das eigentliche Template-Design zeigt die XML-Struktur in einer hierarchischen Liste von Elementen (Items), die typischerweise einen Namespace "hl7:" oder "cda:" (1) vorangestellt haben. Diese im Art-Decor angegebenen Namespaces werden nicht in den letztendlichen eHealth-Austria Dokumenten genutzt! Das HL7-International-Namespace, welches im Art-Decor unter "hl7:" oder "cda:" geführt wird, ist in den eHealth-Austria Dokumenten als Standard-Namespace für alle eHealth-Austria-Dokumente geführt: "<ClinicalDocument xmlns="urn:hl7-org:v3" ... >"

Elemente werden mit einem Dreieck bezeichnet, Attribute mit einem @ -Zeichen (2).

Datentypen werden nach der Liste der unterstützten Datentypen (3) angegeben. Es können einfache Datentypen (Kleinbuchstaben), reguläre Datentypen (Großbuchstaben) oder flavors sein.

Die Kardinalitäts- und Konformitätsspalte ist oben (4) erläutert.

Feste Werte für z.B. Attribute werden auch in der Spalte "Beschreibung" (5) angezeigt, denen ein "F" in der Spalte Conf folgt.

Konformitätserklärungen werden zusammen mit einer CONF-Box gezeigt, z.B. ein @code und ein @codeSystem mit festen und erforderlichen Werten (6).

Ein optionales Label wird in der rechten Spalte (7) angezeigt.

Einbeziehung oder Eingrenzung von anderen Templates, z.B. ein Eintrag innerhalb eines Abschnitts, werden entsprechend (8) zusammen mit ihrer Template-ID, dem Anzeigenamen und der Flexibilität/Stabilitätsanzeige angezeigt, d.h. "DYNAMIC" (die neueste Version) oder STATIC zusammen mit dem Versionsdatum.

Art-decor-6.png

Die Auswahl von Elementen wird als Auswahlliste mit den Elementen in Fragen dargestellt, die in einer Aufzählungsliste zusammengefasst sind.

Art-decor-7.png

Eine typische Konformitätserklärung ist die Bindung eines codierten Elements an einen Wert. Dies wird in der dargestellten Weise ausgedrückt. Der Wert wird mit der ID, dem Anzeigenamen und der Flexibilität/Stabilität der Bindung dargestellt.

Art-decor-8.png

Wenn eine Einschränkung in Worten ausgedrückt wird, begleitet eine Box "Constraint" den Textausdruck der Einschränkung.

Art-decor-9.png

In Fällen, in denen Einschränkungen durch formalisierte Regeln in ISO Schematron ausgedrückt werden, wird die Regel zusammen mit der Rolle (Fehler, Warnung), der Test und die Assertionsmeldung angezeigt.

  1. HL7 Templates Standard: Specification and Use of Reusable Information Constraint Templates, Release 1 [1]
  2. How to read ART-DECOR Definitions https://art-decor.org/mediawiki/index.php?title=How_to_read_ART-DECOR_Definitions