CE

Aus Hl7wiki
(Teildokument von V3 Datentypen Release 1)
Wechseln zu: Navigation, Suche
(→‎Attribute)
(→‎Elemente)
 
(10 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
−
= CE (Kodierte Daten mit Äquivalenten – Coded with Equivalents) =
+
{{DocumentPart}}
 +
== CE (Kodierte Daten mit Äquivalenten – Coded with Equivalents) ==
 
Dieser Datentyp spezifiziert ein Konzept über einen Code und das Codesystem (die Tabelle) aus dem der Code stammt und enthält optional eines oder mehrere Äquivalente dieses Codes mit Hilfe anderer Codiersysteme.
 
Dieser Datentyp spezifiziert ein Konzept über einen Code und das Codesystem (die Tabelle) aus dem der Code stammt und enthält optional eines oder mehrere Äquivalente dieses Codes mit Hilfe anderer Codiersysteme.
  
 
Beispiel: Das Konzept “Männlich” wird abhängig von dem verwendeten Codiersystem identifiziert, beispielsweise durch ein “M” oder den Code “1”. Der Empfänger ist nur dann in der Lage, einen Code eindeutig zu interpretieren, wenn neben dem Code auch das verwendete Codiersystem identifiziert wird. Die Kombinationen (“M”, HL7 v3 Tabelle ''AdministrativeGender'') oder deren Übersetzung (“1”, ABC-KIS System Geschlechtscodetabelle) sind eindeutig zu interpretieren.
 
Beispiel: Das Konzept “Männlich” wird abhängig von dem verwendeten Codiersystem identifiziert, beispielsweise durch ein “M” oder den Code “1”. Der Empfänger ist nur dann in der Lage, einen Code eindeutig zu interpretieren, wenn neben dem Code auch das verwendete Codiersystem identifiziert wird. Die Kombinationen (“M”, HL7 v3 Tabelle ''AdministrativeGender'') oder deren Übersetzung (“1”, ABC-KIS System Geschlechtscodetabelle) sind eindeutig zu interpretieren.
  
−
== Attribute ==
+
=== Attribute ===
  
 
Attribute eines Elements mit diesem Datentyp sind:
 
Attribute eines Elements mit diesem Datentyp sind:
−
{{AttDesc | att | code | Code | string }}
+
{{AttDesc | ae=att | rim=act| name=code | desc=Code | dt=string |card= |conf= }}
  
 
Verpflichtend. Enthält den Code (mnemonic), eine Identifikation des Konzepts, das in dem unter ''codeSystem'' angegebenen Codiersystem beschrieben ist.
 
Verpflichtend. Enthält den Code (mnemonic), eine Identifikation des Konzepts, das in dem unter ''codeSystem'' angegebenen Codiersystem beschrieben ist.
−
{{AttDesc | att | codeSystem | Codiersystem | OID }}
+
{{AttDesc | ae=att | rim=act| name=codeSystem | desc=Codiersystem | dt=OID |card= |conf= }}
  
 
Verpflichtend. Enthält die Identifikation des Codiersystems (Tabelle, Terminologie). Zur Identifikation wird ein OID verwendet.
 
Verpflichtend. Enthält die Identifikation des Codiersystems (Tabelle, Terminologie). Zur Identifikation wird ein OID verwendet.
Zeile 19: Zeile 20:
  
 
Grundsätzlich sollte erwähnt werden, dass die Verwendung von Codesystems in einem bestimmten Kontext z. B. durch Implementierungsleitfäden eingeschränkt wird.
 
Grundsätzlich sollte erwähnt werden, dass die Verwendung von Codesystems in einem bestimmten Kontext z. B. durch Implementierungsleitfäden eingeschränkt wird.
−
{{AttDesc | att | displayName | Konzeptbeschreibung | string }}
+
{{AttDesc | ae=att | rim=act| name=displayName | desc=Konzeptbeschreibung | dt=string |card= |conf= }}
  
 
Optional. Eine textliche Beschreibung des Konzepts. Diese Beschreibung legt das sendende System seinen Benutzern vor und auf Basis dieser Beschreibung selektiert ein Pflegeanbieter den Code. Dem Wert dieses Attributs darf keine Bedeutung zugemessen werden, außer dass es dem Benutzer vorgelegt wird, um den Hintergrund des Codes zu verdeutlichen. Ein ''displayName'' darf niemals ohne zugehörigen ''code'' vorkommen und muss dieselbe Bedeutung haben.
 
Optional. Eine textliche Beschreibung des Konzepts. Diese Beschreibung legt das sendende System seinen Benutzern vor und auf Basis dieser Beschreibung selektiert ein Pflegeanbieter den Code. Dem Wert dieses Attributs darf keine Bedeutung zugemessen werden, außer dass es dem Benutzer vorgelegt wird, um den Hintergrund des Codes zu verdeutlichen. Ein ''displayName'' darf niemals ohne zugehörigen ''code'' vorkommen und muss dieselbe Bedeutung haben.
  
−
{{BeginEMBox}}
+
{{EMBox|
  
 
Es darf nicht erwartet werden, dass der Empfänger den ''displayName'' auf Konsistenz mit dem angegebenen Code prüft. Der Empfänger kann selbst bestimmen, ob er eine eventuell vorhandene eigene Beschreibung oder den ''displayName'' des Senders für eine Wiedergabe benutzt. Bei der Benutzung eines nullFlavors darf kein ''displayName'', wohl aber das Kindelement ''originalText'' genutzt werden, um nicht-kodierte Beschreibungen anzugeben.
 
Es darf nicht erwartet werden, dass der Empfänger den ''displayName'' auf Konsistenz mit dem angegebenen Code prüft. Der Empfänger kann selbst bestimmen, ob er eine eventuell vorhandene eigene Beschreibung oder den ''displayName'' des Senders für eine Wiedergabe benutzt. Bei der Benutzung eines nullFlavors darf kein ''displayName'', wohl aber das Kindelement ''originalText'' genutzt werden, um nicht-kodierte Beschreibungen anzugeben.
  
−
{{EndEMBox}}
+
EMBox}}
  
−
{{AttDesc | att | codeSystemName | Name des Codiersystems | string }}
+
{{AttDesc | ae=att | rim=act| name=codeSystemName | desc=Name des Codiersystems | dt=string |card= |conf= }}
 
Optional. Eine Textform des Namens des Codiersystems, das den Code enthält. Dem Wert dieses Attributs darf keine Bedeutung zugemessen werden, außer dass es dem Benutzer vorgelegt wird, um den Hintergrund des Codes zu verdeutlichen. Für die Lesbarkeit von Nachrichten wird empfohlen, das ''codeSystemName'' mitzusenden.
 
Optional. Eine Textform des Namens des Codiersystems, das den Code enthält. Dem Wert dieses Attributs darf keine Bedeutung zugemessen werden, außer dass es dem Benutzer vorgelegt wird, um den Hintergrund des Codes zu verdeutlichen. Für die Lesbarkeit von Nachrichten wird empfohlen, das ''codeSystemName'' mitzusenden.
  
−
{{AttDesc | att | codeSystemVersion | Version des Codiersystems | string }}
+
{{AttDesc | ae=att | rim=act| name=codeSystemVersion | desc=Version des Codiersystems | dt=string |card= |conf= }}
 
Optional. Eine Textform der Version des Codiersystems, das den Code enthält. Dem Wert dieses Attributs darf keine Bedeutung zugemessen werden, außer dass es dem Benutzer vorgelegt wird, um den Hintergrund des Codes zu verdeutlichen.
 
Optional. Eine Textform der Version des Codiersystems, das den Code enthält. Dem Wert dieses Attributs darf keine Bedeutung zugemessen werden, außer dass es dem Benutzer vorgelegt wird, um den Hintergrund des Codes zu verdeutlichen.
  
 
Verschiedene Versionen eines Codiersystems können über einzelne OIDs im ''codeSystem'' Attribut identifiziert werden. Das empfangende System darf deshalb niemals den Wert des ''codeSystemVersion'' benutzen, um den Code zu interpretieren. Ob eine neue Version eines Codesystems ein neue OID bekommt, hängt von verschiedenen Faktoren ab, die hier nicht näher erläutert werden sollen. So sehen die verschiedenen ICD-Schlüssel in Deutschland für jede Version eine eigene OID vor, verschiedene Versionen des LOINC-Codes beispielsweise hingegen haben konstant eine OID.
 
Verschiedene Versionen eines Codiersystems können über einzelne OIDs im ''codeSystem'' Attribut identifiziert werden. Das empfangende System darf deshalb niemals den Wert des ''codeSystemVersion'' benutzen, um den Code zu interpretieren. Ob eine neue Version eines Codesystems ein neue OID bekommt, hängt von verschiedenen Faktoren ab, die hier nicht näher erläutert werden sollen. So sehen die verschiedenen ICD-Schlüssel in Deutschland für jede Version eine eigene OID vor, verschiedene Versionen des LOINC-Codes beispielsweise hingegen haben konstant eine OID.
  
−
== Elemente ==
+
=== Elemente ===
  
−
{{AttDesc | elm | originalText | ursprünglicher Text | string }}
+
{{AttDesc | ae=elm | rim=act| name=originalText | desc=ursprünglicher Text | dt=string |card= |conf=}}
 
Optional. Eine textliche Beschreibung des Konzepts. Dies stellt den Text dar, worauf das sendende System den Code zugewiesen hat. Dies ist also gerade umgekehrt zu ''displayName'' zu sehen, wo eine Beschreibung auf Basis des Codes bestimmt wird. Das bedeutet auch, dass ''originalText'' gerade auch ausdrücklich in den Fällen vorkommen kann, wo kein Code zugewiesen ist oder gefunden werden kann. In diesem Falle biete originalText die Möglichkeit, Text anzugeben, der anscheinend (noch) nicht in einen Code umzusetzen war.
 
Optional. Eine textliche Beschreibung des Konzepts. Dies stellt den Text dar, worauf das sendende System den Code zugewiesen hat. Dies ist also gerade umgekehrt zu ''displayName'' zu sehen, wo eine Beschreibung auf Basis des Codes bestimmt wird. Das bedeutet auch, dass ''originalText'' gerade auch ausdrücklich in den Fällen vorkommen kann, wo kein Code zugewiesen ist oder gefunden werden kann. In diesem Falle biete originalText die Möglichkeit, Text anzugeben, der anscheinend (noch) nicht in einen Code umzusetzen war.
  
−
{{BeginEMBox}}
+
{{EMBox|
−
 
 
 
Es darf nicht erwartet werden, dass der Empfänger den ''originalText'' auf Konsistenz mit dem eventuell abgeleiteten Code prüft. Bei der Nutzung von ''nullFlavor'' in diesem Datentyp kann der ''originalText'' als Alternative zum codierten Wert verwendet werden (siehe auch Beispiele unten).
 
Es darf nicht erwartet werden, dass der Empfänger den ''originalText'' auf Konsistenz mit dem eventuell abgeleiteten Code prüft. Bei der Nutzung von ''nullFlavor'' in diesem Datentyp kann der ''originalText'' als Alternative zum codierten Wert verwendet werden (siehe auch Beispiele unten).
 +
EMBox}}
  
−
{{EndEMBox}}
+
{{AttDesc | ae=elm | rim=act| name=translation | desc=Übersetzung des Codes | dt=CD |card= |conf= }}
−
 
 
−
{{AttDesc | elm | translation | Übersetzung des Codes | CD }}
 
 
Optional. Null oder mehr Übersetzungen des Konzepts mit Hilfe alternativer Codier-systeme.
 
Optional. Null oder mehr Übersetzungen des Konzepts mit Hilfe alternativer Codier-systeme.
  
Zeile 55: Zeile 54:
 
Beispiel: Das Konzept “Granny Smith” kann, wenn ein Codiersystem nicht das entsprechende Niveau an Details enthält, übersetzt werden in das Konzept “Apfel”. Das Konzept “Apfel” darf allerdings niemals übersetzt werden in das detaillierte Konzept  “Granny Smith”. Das Konzept “Apfel” darf ebenfalls nicht übersetzt werden in das Konzept “Grün”: Es handelt sich dabei vielleicht um verwandte Konzepte, aber inhaltlich ist es keine Übersetzung des originalen Konzepts.
 
Beispiel: Das Konzept “Granny Smith” kann, wenn ein Codiersystem nicht das entsprechende Niveau an Details enthält, übersetzt werden in das Konzept “Apfel”. Das Konzept “Apfel” darf allerdings niemals übersetzt werden in das detaillierte Konzept  “Granny Smith”. Das Konzept “Apfel” darf ebenfalls nicht übersetzt werden in das Konzept “Grün”: Es handelt sich dabei vielleicht um verwandte Konzepte, aber inhaltlich ist es keine Übersetzung des originalen Konzepts.
  
−
== XML Beispiele ==
+
'''''XML Beispiele'''''
  
−
{{HL7XML
+
<syntaxhighlight lang="xml">
−
| code =
 
 
<administrativeGenderCode code="M" codeSystem="2.16.840.1.113883.5.1"/>
 
<administrativeGenderCode code="M" codeSystem="2.16.840.1.113883.5.1"/>
−
}}
+
</syntaxhighlight>
−
{{HL7XML
+
 
−
| code =
+
<syntaxhighlight lang="xml">
−
<value xsi:type="CE" code="Z94.0" codeSystem="2.16.840.1.113883.6.3"
+
<value xsi:type="CE" code="Z94.0" codeSystem="2.16.840.1.113883.6.3" displayName="Lungenentzündung" codeSystemName="ICD10"/>
−
  displayName="Lungenentzündung" codeSystemName="ICD10"/>
+
</syntaxhighlight>
−
}}
+
 
−
{{HL7XML
+
<syntaxhighlight lang="xml">
−
| code =
 
 
<code code="ERY" codeSystem="2.16.840.1.113883.2.4.4.13"/>
 
<code code="ERY" codeSystem="2.16.840.1.113883.2.4.4.13"/>
−
}}
+
</syntaxhighlight>
−
{{HL7XML
+
 
−
| code =
+
<syntaxhighlight lang="xml">
 
<code code="GSMITH" codeSystem="2.16.840.1.22.3"
 
<code code="GSMITH" codeSystem="2.16.840.1.22.3"
 
       codeSystemName="US Fruit Category" displayName="Granny Smith">
 
       codeSystemName="US Fruit Category" displayName="Granny Smith">
Zeile 80: Zeile 77:
  
 
</code>
 
</code>
−
}}
+
</syntaxhighlight>
−
{{HL7XML
+
 
−
| code =
+
<syntaxhighlight lang="xml">
 
<code code="13715119" codeSystem="2.16.840.1.113883.2.4.4.8"
 
<code code="13715119" codeSystem="2.16.840.1.113883.2.4.4.8"
 
       codeSystemName="G-Standard Artikel"
 
       codeSystemName="G-Standard Artikel"
Zeile 90: Zeile 87:
  
 
</code>
 
</code>
−
}}
+
</syntaxhighlight>
−
{{HL7XML
+
 
−
| code =
+
<syntaxhighlight lang="xml">
−
<code nullFlavor="OTH" originalText="Een zelfgemaakt medicijn"/>
+
<code nullFlavor="OTH" originalText="eine selbstgemachte Medizin"/>
−
}}
+
</syntaxhighlight>

Aktuelle Version vom 10. März 2013, 12:26 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 .

CE (Kodierte Daten mit Äquivalenten – Coded with Equivalents)

Dieser Datentyp spezifiziert ein Konzept über einen Code und das Codesystem (die Tabelle) aus dem der Code stammt und enthält optional eines oder mehrere Äquivalente dieses Codes mit Hilfe anderer Codiersysteme.

Beispiel: Das Konzept “Männlich” wird abhängig von dem verwendeten Codiersystem identifiziert, beispielsweise durch ein “M” oder den Code “1”. Der Empfänger ist nur dann in der Lage, einen Code eindeutig zu interpretieren, wenn neben dem Code auch das verwendete Codiersystem identifiziert wird. Die Kombinationen (“M”, HL7 v3 Tabelle AdministrativeGender) oder deren Übersetzung (“1”, ABC-KIS System Geschlechtscodetabelle) sind eindeutig zu interpretieren.

Attribute

Attribute eines Elements mit diesem Datentyp sind:

@ Attribut DT Card Conf Beschreibung
code string Code


Verpflichtend. Enthält den Code (mnemonic), eine Identifikation des Konzepts, das in dem unter codeSystem angegebenen Codiersystem beschrieben ist.

@ Attribut DT Card Conf Beschreibung
codeSystem OID Codiersystem


Verpflichtend. Enthält die Identifikation des Codiersystems (Tabelle, Terminologie). Zur Identifikation wird ein OID verwendet.

Ein ISO Object Identifier (OID) ist ein weltweit eindeutiger String (Zeichenkette), der aus Zahlen und Punkten besteht (beispielsweise "2.16.840.1.113883.3.1"). Laut ISO Definition bestehen OIDs aus Pfaden mit einer Baumstruktur, wobei die äußerst links situierte Zahl die root ist und die am meisten rechts situierte Zahl ein leaf (ein Blatt als Endpunkt) markiert. Die Nummer ist garantiert weltweit eindeutig, weil sie auf dem System der delegierten Verantwortlichkeit basiert. Jeder Zweig unter einer Wurzel in der Baumstruktur korrespondiert mit einer Domäne, in der eine Organisation die Abgabe von OIDs verwaltet. Die zentralen Vergabestelle für OIDs im Gesundheitswesen in Deutsch-land publiziert eine Tabelle mit OIDs. Informieren Sie sich bei Zweifel bei der zentralen Vergabestelle, welche (eventuell neu zu registrierende) OID benutzt werden muss.

Im OID Konzept für das Deutsche Gesundheitswesen oidk finden Sie nähere Informationen über Codiersysteme und OIDs.

Grundsätzlich sollte erwähnt werden, dass die Verwendung von Codesystems in einem bestimmten Kontext z. B. durch Implementierungsleitfäden eingeschränkt wird.

@ Attribut DT Card Conf Beschreibung
displayName string Konzeptbeschreibung


Optional. Eine textliche Beschreibung des Konzepts. Diese Beschreibung legt das sendende System seinen Benutzern vor und auf Basis dieser Beschreibung selektiert ein Pflegeanbieter den Code. Dem Wert dieses Attributs darf keine Bedeutung zugemessen werden, außer dass es dem Benutzer vorgelegt wird, um den Hintergrund des Codes zu verdeutlichen. Ein displayName darf niemals ohne zugehörigen code vorkommen und muss dieselbe Bedeutung haben.

Talk.svg Es darf nicht erwartet werden, dass der Empfänger den displayName auf Konsistenz mit dem angegebenen Code prüft. Der Empfänger kann selbst bestimmen, ob er eine eventuell vorhandene eigene Beschreibung oder den displayName des Senders für eine Wiedergabe benutzt. Bei der Benutzung eines nullFlavors darf kein displayName, wohl aber das Kindelement originalText genutzt werden, um nicht-kodierte Beschreibungen anzugeben. EMBox
@ Attribut DT Card Conf Beschreibung
codeSystemName string Name des Codiersystems

Optional. Eine Textform des Namens des Codiersystems, das den Code enthält. Dem Wert dieses Attributs darf keine Bedeutung zugemessen werden, außer dass es dem Benutzer vorgelegt wird, um den Hintergrund des Codes zu verdeutlichen. Für die Lesbarkeit von Nachrichten wird empfohlen, das codeSystemName mitzusenden.

@ Attribut DT Card Conf Beschreibung
codeSystemVersion string Version des Codiersystems

Optional. Eine Textform der Version des Codiersystems, das den Code enthält. Dem Wert dieses Attributs darf keine Bedeutung zugemessen werden, außer dass es dem Benutzer vorgelegt wird, um den Hintergrund des Codes zu verdeutlichen.

Verschiedene Versionen eines Codiersystems können über einzelne OIDs im codeSystem Attribut identifiziert werden. Das empfangende System darf deshalb niemals den Wert des codeSystemVersion benutzen, um den Code zu interpretieren. Ob eine neue Version eines Codesystems ein neue OID bekommt, hängt von verschiedenen Faktoren ab, die hier nicht näher erläutert werden sollen. So sehen die verschiedenen ICD-Schlüssel in Deutschland für jede Version eine eigene OID vor, verschiedene Versionen des LOINC-Codes beispielsweise hingegen haben konstant eine OID.

Elemente

< Element DT Card Conf Beschreibung
originalText string ursprünglicher Text

Optional. Eine textliche Beschreibung des Konzepts. Dies stellt den Text dar, worauf das sendende System den Code zugewiesen hat. Dies ist also gerade umgekehrt zu displayName zu sehen, wo eine Beschreibung auf Basis des Codes bestimmt wird. Das bedeutet auch, dass originalText gerade auch ausdrücklich in den Fällen vorkommen kann, wo kein Code zugewiesen ist oder gefunden werden kann. In diesem Falle biete originalText die Möglichkeit, Text anzugeben, der anscheinend (noch) nicht in einen Code umzusetzen war.

Talk.svg Es darf nicht erwartet werden, dass der Empfänger den originalText auf Konsistenz mit dem eventuell abgeleiteten Code prüft. Bei der Nutzung von nullFlavor in diesem Datentyp kann der originalText als Alternative zum codierten Wert verwendet werden (siehe auch Beispiele unten). EMBox
< Element DT Card Conf Beschreibung
translation CD Übersetzung des Codes

Optional. Null oder mehr Übersetzungen des Konzepts mit Hilfe alternativer Codier-systeme.

Alle Übersetzungen müssen auf ein und dasselbe Konzept hinweisen. Dabei ist es zugelassen, dass die Übersetzungen “weniger nuanciert/detailliert” sind als das originale Konzept.

Beispiel: Das Konzept “Granny Smith” kann, wenn ein Codiersystem nicht das entsprechende Niveau an Details enthält, übersetzt werden in das Konzept “Apfel”. Das Konzept “Apfel” darf allerdings niemals übersetzt werden in das detaillierte Konzept “Granny Smith”. Das Konzept “Apfel” darf ebenfalls nicht übersetzt werden in das Konzept “Grün”: Es handelt sich dabei vielleicht um verwandte Konzepte, aber inhaltlich ist es keine Übersetzung des originalen Konzepts.

XML Beispiele 

<administrativeGenderCode code="M" codeSystem="2.16.840.1.113883.5.1"/>

<value xsi:type="CE" code="Z94.0" codeSystem="2.16.840.1.113883.6.3" displayName="Lungenentzündung" codeSystemName="ICD10"/>

<code code="ERY" codeSystem="2.16.840.1.113883.2.4.4.13"/>

<code code="GSMITH" codeSystem="2.16.840.1.22.3"
      codeSystemName="US Fruit Category" displayName="Granny Smith">

   <translation code="100" codeSystem="2.16.840.1.113883.2.4.4.99"
     displayName="Appel"
     codeSystemName="Deutscher Verband für Nahrungsmittel" />

</code>

<code code="13715119" codeSystem="2.16.840.1.113883.2.4.4.8"
      codeSystemName="G-Standard Artikel"
      displayName=" ABSORIN UNTERLAGE 60X90CM 120G FLUFF 60920">

   <translation code="753696" codeSystem="2.16.840.1.113883.2.4.4.7"/>

</code>

<code nullFlavor="OTH" originalText="eine selbstgemachte Medizin"/>
Abgerufen von „https://wiki.hl7.de/index.php?title=v3dtr1:CE&oldid=11743“