Klassenattribute

Aus Hl7wiki
(Teildokument von V3 Datentypen Release 1)
Wechseln zu: Navigation, Suche
(→‎Zusammengesetzte Datentypen)
(→‎Zusammengesetzte Datentypen)
 
(14 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
 +
{{DocumentPart}}
 
== XML Repräsentation von Klassen-Attributen ==
 
== XML Repräsentation von Klassen-Attributen ==
 
=== Klassen-Attribute und Datentypen ===
 
=== Klassen-Attribute und Datentypen ===
Zeile 5: Zeile 6:
 
Beispiel:
 
Beispiel:
  
−
[[Bild:KL-ATT_IMG1.jpg]]
+
[[Bild:Classattr.jpg|250px]]
  
 
In der vorstehenden Klasse “Patient” ist eine Reihe von Attributen aufgenommen, darunter der classCode (mit dem festen Wert “PAT”), id, addr und telecom.
 
In der vorstehenden Klasse “Patient” ist eine Reihe von Attributen aufgenommen, darunter der classCode (mit dem festen Wert “PAT”), id, addr und telecom.
Zeile 15: Zeile 16:
  
 
Mit Ausnahme der strukturellen Attribute (siehe nachstehend) werden die Modell-Attribute als XML Elemente wiedergegeben. Die Elemente tragen den im Modell angegebenen Namen. Wenn z.B. ein Attribut den Namen ''id'' hat, ist der Name des XML Elements <id/>.
 
Mit Ausnahme der strukturellen Attribute (siehe nachstehend) werden die Modell-Attribute als XML Elemente wiedergegeben. Die Elemente tragen den im Modell angegebenen Namen. Wenn z.B. ein Attribut den Namen ''id'' hat, ist der Name des XML Elements <id/>.
−
{{HL7XML
+
<syntaxhighlight lang="xml">
−
| code =
 
 
<id ... />
 
<id ... />
 
<addr ... />
 
<addr ... />
 
<telecom ... />
 
<telecom ... />
 +
</syntaxhighlight>
 +
In dem XML Schema ist die Kardinalität des Modellattributs aufgenommen. In dem vorstehenden Beispiel ist <id> Pflicht [1..1], <addr> [0..1] und <telecom> [0..*] sind optional.
 +
{{EMBox|Achtung: Im heutigen XML Schema Sprache kann die Kardinalität eines XML Elements festgelegt werden, aber ob der “Inhalt”, also die Informationen gemäβ der Datentyp-Spezifikation vorhanden sind oder nicht, oder ob sie die korrekte Zusammensetzung haben, ist mit den jetzt vorhandenen Schemas nicht validierbar. Hier ist aber ein zweiter Validierungsschritt erforderlich, wenn garantiert werden muss, dass beispielsweise ein II Datentyp immer mit einem ''root/extension'' Attributpaar ausgefüllt ist oder ein ''nullFlavor'' Attribut enthält. Um dieses Validierungsniveau möglich zu machen, sind weitere Validierungsschritte mit so genannten ''constraint'' Sprachen erforderlich (beispielsweise OCL, Schematron).
 
}}
 
}}
−
In dem XML Schema ist die Kardinalität des Modellattributs aufgenommen. In dem vorstehenden Beispiel ist <id> Pflicht [1..1], <addr> [0..1] und <telecom> [0..*] sind optional.
 
−
{{BeginEMBox}}
 
−
Achtung: Im heutigen XML Schema Sprache kann die Kardinalität eines XML Elements festgelegt werden, aber ob der “Inhalt”, also die Informationen gemäβ der Datentyp-Spezifikation vorhanden sind oder nicht, oder ob sie die korrekte Zusammensetzung haben, ist mit den jetzt vorhandenen Schemas nicht validierbar. Hier ist aber ein zweiter Validierungsschritt erforderlich, wenn garantiert werden muss, dass beispielsweise ein II Datentyp immer mit einem ''root/extension'' Attributpaar ausgefüllt ist oder ein ''nullFlavor'' Attribut enthält. Um dieses Validierungsniveau möglich zu machen, sind weitere Validierungsschritte mit so genannten ''constraint'' Sprachen erforderlich (beispielsweise OCL, Schematron).
 
−
{{EndEMBox}}
 
  
−
Die XML Elemente haben XML Attribute, die durch den Datentype selbst bestimmt werden. Die hier verwendete Notationsform für die Datentyp-Attribute lautet:
+
Die XML Elemente haben XML Attribute, die durch den Datentyp selbst bestimmt werden. Die hier verwendete Notationsform für die Datentyp-Attribute lautet:
 +
 
 +
{{AttDesc
 +
| ae = att
 +
| rim = oth
 +
| name = Bezeichnung
 +
| desc = Beschreibung / Erklärung
 +
| dt = Datentyp
 +
| card = Kardinalität
 +
| conf = Konformität
 +
}}
  
−
{{AttDesc | elm-act | Name Attribut | Beschreibung / Erklärung / Bedeutung | Datentyp /Pattern }}
 
 
Für die Datentypen wurden Attribute definiert, welche die Daten tragen. So hat in dem Beispiel das ''id'' Modellattribut den Datentype II (Instance Identifier). Die zu diesem Datentyp gehörenden Attribute sind beispielsweise ''root'' und ''extension'', die als XML Attribute beim Element wiedergegeben werden.  
 
Für die Datentypen wurden Attribute definiert, welche die Daten tragen. So hat in dem Beispiel das ''id'' Modellattribut den Datentype II (Instance Identifier). Die zu diesem Datentyp gehörenden Attribute sind beispielsweise ''root'' und ''extension'', die als XML Attribute beim Element wiedergegeben werden.  
  
−
{{HL7XML
+
<syntaxhighlight lang="xml">
−
| code =
 
 
<id  root="..."  extension="..." />
 
<id  root="..."  extension="..." />
−
}}
+
</syntaxhighlight>
  
 
Nähere Erläuterungen zu den Datentypen und den dazugehörenden Attributen sind in den folgenden Kapiteln pro Datentyp aufgenommen.
 
Nähere Erläuterungen zu den Datentypen und den dazugehörenden Attributen sind in den folgenden Kapiteln pro Datentyp aufgenommen.
Zeile 42: Zeile 49:
  
 
Beispiel: Die Komponenten einer Adresse werden durch Kindelemente des ''addr'' Elements mit den Informationen als Element Content (im Beispiel rot markiert) aufgenommen.
 
Beispiel: Die Komponenten einer Adresse werden durch Kindelemente des ''addr'' Elements mit den Informationen als Element Content (im Beispiel rot markiert) aufgenommen.
−
{{HL7XML
+
<syntaxhighlight lang="xml">
−
| code =
 
 
<addr>
 
<addr>
 
   <streetName>Große Bleichen</streetName>
 
   <streetName>Große Bleichen</streetName>
Zeile 50: Zeile 56:
 
   <city>Hamburg</city>
 
   <city>Hamburg</city>
 
</addr>
 
</addr>
−
}}
+
</syntaxhighlight>
  
 
=== Zusammengesetzte Datentypen ===
 
=== Zusammengesetzte Datentypen ===
Zeile 56: Zeile 62:
  
 
Bei zusammengesetzten Datentypen wird die Substruktur (beispielsweise <low> und <high> bei einem Intervall) immer als Kindelement des betreffenden Datentyp-Elements wiedergegeben.  
 
Bei zusammengesetzten Datentypen wird die Substruktur (beispielsweise <low> und <high> bei einem Intervall) immer als Kindelement des betreffenden Datentyp-Elements wiedergegeben.  
−
{{HL7XML
+
<syntaxhighlight lang="xml">
−
| code =
 
 
<effectiveTime>
 
<effectiveTime>
 
   <low value="20040507"/>
 
   <low value="20040507"/>
 
   <high value="20040909"/>
 
   <high value="20040909"/>
 
</effectiveTime>
 
</effectiveTime>
−
}}
+
</syntaxhighlight>
  
 
In den Beschreibungen der zusammengesetzten Datentypen werden die Kindelemente folgendermaßen notiert:
 
In den Beschreibungen der zusammengesetzten Datentypen werden die Kindelemente folgendermaßen notiert:
−
{{AttDesc | elm | | Name Kindelement | Beschreibung / Erklärung / Bedeutung | Datentyp | | }}
+
{{AttDesc | ae=elm | rim=act | name=Name Kindelement | desc=Beschreibung / Erklärung / Bedeutung | dt=Datentyp | conf=Konformanz| card=Kardinalität }}
  
 
=== Strukturelle Attribute ===
 
=== Strukturelle Attribute ===
Zeile 150: Zeile 155:
  
 
Beispiel: In der Klasse ''Observation'' gibt es zwei Attribute, ''classCode'' und ''moodCode'', die als strukturelle Attribute nicht als separate XML Elemente auftreten, sondern als XML Attribute des Klassenelements.
 
Beispiel: In der Klasse ''Observation'' gibt es zwei Attribute, ''classCode'' und ''moodCode'', die als strukturelle Attribute nicht als separate XML Elemente auftreten, sondern als XML Attribute des Klassenelements.
−
{{HL7XML
+
<syntaxhighlight lang="xml">
−
| code =
+
<observation classCode="OBS" moodCode="EVN"/>
−
<Observation classCode="OBS" moodCode="EVN"/>
+
</syntaxhighlight>
−
}}
 

Aktuelle Version vom 18. März 2013, 08:58 Uhr

Dieses Material ist Teil des Leitfadens V3 Datentypen Release 1.
  • Direkt im Wiki geändert werden sollten Schreibfehler, ergänzende Hinweise.
  • Offene Fragen, die der Diskussionen bedürfen, sollten auf der Diskussionsseite aufgenommen werden.
  • Liste der Seiten dieses Leitfadens: hier, Liste der Seiten, in denen dieses Material verwendet (transkludiert) siehe hier .

XML Repräsentation von Klassen-Attributen

Klassen-Attribute und Datentypen

Die Attribute von Klassen in den HL7 Modellen werden auf eine bestimmte, fest vordefinierte Weise in die XML Repräsentation umgesetzt.

Beispiel:

Classattr.jpg

In der vorstehenden Klasse “Patient” ist eine Reihe von Attributen aufgenommen, darunter der classCode (mit dem festen Wert “PAT”), id, addr und telecom.

Jedes dieser Klassen-Attribute hat unter anderem

  • einen Namen, beispielsweise id,
  • einen Datentyp, beispielsweise AD,
  • sowie eine Kardinalität, beispielsweise [0..*].

Mit Ausnahme der strukturellen Attribute (siehe nachstehend) werden die Modell-Attribute als XML Elemente wiedergegeben. Die Elemente tragen den im Modell angegebenen Namen. Wenn z.B. ein Attribut den Namen id hat, ist der Name des XML Elements <id/>. 

<id ... />
<addr ... />
<telecom ... />

In dem XML Schema ist die Kardinalität des Modellattributs aufgenommen. In dem vorstehenden Beispiel ist <id> Pflicht [1..1], <addr> [0..1] und <telecom> [0..*] sind optional.

Talk.svg Achtung: Im heutigen XML Schema Sprache kann die Kardinalität eines XML Elements festgelegt werden, aber ob der “Inhalt”, also die Informationen gemäβ der Datentyp-Spezifikation vorhanden sind oder nicht, oder ob sie die korrekte Zusammensetzung haben, ist mit den jetzt vorhandenen Schemas nicht validierbar. Hier ist aber ein zweiter Validierungsschritt erforderlich, wenn garantiert werden muss, dass beispielsweise ein II Datentyp immer mit einem root/extension Attributpaar ausgefüllt ist oder ein nullFlavor Attribut enthält. Um dieses Validierungsniveau möglich zu machen, sind weitere Validierungsschritte mit so genannten constraint Sprachen erforderlich (beispielsweise OCL, Schematron).

Die XML Elemente haben XML Attribute, die durch den Datentyp selbst bestimmt werden. Die hier verwendete Notationsform für die Datentyp-Attribute lautet:

@ Attribut DT Card Conf Beschreibung
Bezeichnung Datentyp Kardinalität Konformität Beschreibung / Erklärung


Für die Datentypen wurden Attribute definiert, welche die Daten tragen. So hat in dem Beispiel das id Modellattribut den Datentype II (Instance Identifier). Die zu diesem Datentyp gehörenden Attribute sind beispielsweise root und extension, die als XML Attribute beim Element wiedergegeben werden. 

<id   root="..."  extension="..." />

Nähere Erläuterungen zu den Datentypen und den dazugehörenden Attributen sind in den folgenden Kapiteln pro Datentyp aufgenommen.

Ausnahmen mit Informationen als Element Content

Bei den meisten Datentypen werden die faktischen Informationen in den XML Attributen wiedergegeben. Es gibt allerdings ein paar Ausnahmen. Bei den Datentypen Binary, Encapsulated Data, Entity Name, Person Name, Organization Name, Trivial Name, Address und Character String werden die Informationen als Element Content wieder-gegeben.

Beispiel: Die Komponenten einer Adresse werden durch Kindelemente des addr Elements mit den Informationen als Element Content (im Beispiel rot markiert) aufgenommen. 

<addr>
  <streetName>Große Bleichen</streetName>
  <houseNumber>23-25</houseNumber>
  <postalCode>20354</postalCode>
  <city>Hamburg</city>
</addr>

Zusammengesetzte Datentypen

Es gibt eine Reihe zusammengesetzter Datentypen, die eine Sammlung von Datenelementen darstellen. So wird beispielsweise in einem Intervall die Unter- und Obergrenze angegeben und eine Ratio stellt ein Verhältnis zweier Werte dar.

Bei zusammengesetzten Datentypen wird die Substruktur (beispielsweise <low> und <high> bei einem Intervall) immer als Kindelement des betreffenden Datentyp-Elements wiedergegeben. 

<effectiveTime>
  <low value="20040507"/>
  <high value="20040909"/>
</effectiveTime>

In den Beschreibungen der zusammengesetzten Datentypen werden die Kindelemente folgendermaßen notiert:

< Element DT Card Conf Beschreibung
Name Kindelement Datentyp Kardinalität Konformanz Beschreibung / Erklärung / Bedeutung


Strukturelle Attribute

Es gibt eine Liste von Klassen-Attributen, die nicht als separate Elemente präsentiert werden, sondern als XML Attribute der Klassenelemente.

RIM Klasse

Attribut

 

Act

moodCode

classCode

negationInd

levelCode

 

ActRelationship

typeCode

inversionInd

contextControlCode

contextConductionInd

negationInd

 

Entity

classCode

determinerCode

 

Participation

typeCode

contextControlCode

 

Role

classCode

negationInd

 

RoleLink

typeCode

Beispiel: In der Klasse Observation gibt es zwei Attribute, classCode und moodCode, die als strukturelle Attribute nicht als separate XML Elemente auftreten, sondern als XML Attribute des Klassenelements. 

<observation classCode="OBS" moodCode="EVN"/>
Abgerufen von „https://wiki.hl7.de/index.php?title=v3dtr1:Klassenattribute&oldid=12117“