Allgemeine Erläuterungen

Aus Hl7wiki
(Teildokument von V3 Datentypen Release 1)
Wechseln zu: Navigation, Suche
K (hat „v3dtr1:AE“ nach „v3dtr1:Allgemeine Erläuterungen“ verschoben)
 
(21 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
−
= Allgemeine Erläuterungen zur Benutzung von XML =
+
{{DocumentPart}}
−
Das Austauschformat für HL7 Version 3 Nachrichten ist (zum heutigen Zeitpunkt) Extensible Markup Language (XML, siehe [XML]). Es ist nicht Zweck dieses Leitfadens, allgemeine Erläuterungen über XML zu geben, allerdings werden einige Kennzeichen und Anforderungen hier trotzdem erwähnt.
+
== Allgemeine Erläuterungen zur Benutzung von XML ==
 +
Das Austauschformat für HL7 Version 3 Nachrichten ist (zum heutigen Zeitpunkt) Extensible Markup Language ([[XML]]). Es ist nicht Zweck dieses Leitfadens, allgemeine Erläuterungen über XML zu geben, allerdings werden einige Kennzeichen und Anforderungen hier trotzdem erwähnt.
  
−
 
+
=== Zeichensatz (Character Set) ===
−
== Zeichensatz (Character Set) ==
 
 
Das Encoding im XML-Prolog einer HL7 Version 3 Nachricht muss UTF-8 sein.
 
Das Encoding im XML-Prolog einer HL7 Version 3 Nachricht muss UTF-8 sein.
−
{{HL7XML
+
<syntaxhighlight lang="xml">
−
| code =
 
 
<?xml version="1.0" encoding="utf-8"?>
 
<?xml version="1.0" encoding="utf-8"?>
 +
 
     oder (als default)
 
     oder (als default)
 +
 
<?xml version="1.0"?>
 
<?xml version="1.0"?>
−
}}
+
</syntaxhighlight>
  
−
 
+
=== Spezielle Zeichen ===
−
== Spezielle Zeichen ==
 
 
In XML sind bestimmte Zeichen in Informationen durch Zeichenkombinationen zu ersetzen (character entities), weil sie im XML Format eine andere und spezielle Bedeutung haben. Eine XML Character Entity ist ein “&” gefolgt von einer Zeichenkette und einem abschließenden “;”. Diese Sequenz wird vom XML Prozessor wieder ersetzt durch das spezielle Zeichen.
 
In XML sind bestimmte Zeichen in Informationen durch Zeichenkombinationen zu ersetzen (character entities), weil sie im XML Format eine andere und spezielle Bedeutung haben. Eine XML Character Entity ist ein “&” gefolgt von einer Zeichenkette und einem abschließenden “;”. Diese Sequenz wird vom XML Prozessor wieder ersetzt durch das spezielle Zeichen.
  
Zeile 20: Zeile 20:
 
! Spezielle Zeichen in Datei !! Zu ersetzen durch !! Anmerkungen
 
! Spezielle Zeichen in Datei !! Zu ersetzen durch !! Anmerkungen
 
|-
 
|-
−
| & || <nowiki>&amp;</nowiki> ||   
+
| & || &amp;amp; ||   
 
|-
 
|-
−
| < || <nowiki>&lt;</nowiki> ||   
+
| < || &amp;lt; ||   
 
|-
 
|-
−
| > || <nowiki>&gt;</nowiki> ||   
+
| > || &amp;gt; ||   
 
|-
 
|-
−
| ' || <nowiki>&apos;</nowiki> ||  
+
| ' || &amp;apos; ||  
 
|-
 
|-
−
| " || <nowiki>&quot;</nowiki> || Ein " ist bei innerhalb von Attributwerten nicht zugelassen und muss ersetzt werden.  
+
| " || &amp;quot; || Ein " ist bei innerhalb von Attributwerten nicht zugelassen und muss ersetzt werden.  
 
|}
 
|}
  
−
=== XML Beispiel ===
+
'''''XML Beispiele'''''
−
{{HL7XML
+
 
−
| code =
+
<syntaxhighlight lang="xml">
−
<text>Werte &amp;gt; 5 mg/l sind pathologisch</text>
+
<text>Werte &gt; 5 mg/l sind pathologisch</text>
−
<nowiki>XML Prozessor liefert: Werte > 5 mg/l sind pathologisch</nowiki>
+
</syntaxhighlight>
 +
 
 +
XML Prozessor liefert: Werte > 5 mg/l sind pathologisch
  
−
<name>Apotheke Leermans &amp;amp; Söhne</name>
+
<syntaxhighlight lang="xml">
−
<nowiki>XML Prozessor liefert: Apotheke Leermans & Söhne</nowiki>
+
<name>Apotheke Leermans &amp; Söhne</name>
−
}}
+
</syntaxhighlight>
 +
XML Prozessor liefert: Apotheke Leermans & Söhne
  
−
== Allgemeiner Aufbau einer HL7 Version 3 Nachricht ==
+
=== Allgemeiner Aufbau einer HL7 Version 3 Nachricht ===
 
HL7 Version 3 Nachrichten haben als Root-Element immer den Namen der dazugehörenden Interaktion. So beginnt eine HL7 Version 3 Nachricht auf der Basis der Interaktion “PORX_IN123456” mit einem XML Root-Element PORX_IN123456. Die HL7 V3 Interaktionsschemas (allgemeine Erläuterungen W3C Schema Sprache siehe [XMLSC]) haben im allgemeinen den gleichen Namen wie das Root-Element.
 
HL7 Version 3 Nachrichten haben als Root-Element immer den Namen der dazugehörenden Interaktion. So beginnt eine HL7 Version 3 Nachricht auf der Basis der Interaktion “PORX_IN123456” mit einem XML Root-Element PORX_IN123456. Die HL7 V3 Interaktionsschemas (allgemeine Erläuterungen W3C Schema Sprache siehe [XMLSC]) haben im allgemeinen den gleichen Namen wie das Root-Element.
−
{{HL7XML
+
<syntaxhighlight lang="xml">
−
| code =
 
 
<?xml version="1.0"? encoding="utf-8">
 
<?xml version="1.0"? encoding="utf-8">
 
<PORX_IN123456 ...
 
<PORX_IN123456 ...
Zeile 50: Zeile 52:
 
     xmlns:voc="urn:hl7-org:v3/voc"
 
     xmlns:voc="urn:hl7-org:v3/voc"
 
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 +
 
         … HL7 Version 3 Nachricht  inklusive Wrapper und Payload
 
         … HL7 Version 3 Nachricht  inklusive Wrapper und Payload
 +
 +
<!-- dies ist ein Test -->
 +
 
</PORX_IN123456>
 
</PORX_IN123456>
−
}}
+
</syntaxhighlight>
 
Der Sender kann ein ''schemaLocation'' zwar hinzufügen, aber der Empfänger darf die Information in ''schemaLocation'' nicht benutzen.
 
Der Sender kann ein ''schemaLocation'' zwar hinzufügen, aber der Empfänger darf die Information in ''schemaLocation'' nicht benutzen.
  
−
Bei einem HL7 Message Batch hat das Root-Element den Namen der Batch-Interaktion und die verschiedenen Interaktionen (Teilberichte) sind darin aufgenommen. Für weitere Informationen siehe [Wrapper-Leitfaden].
+
Bei einem HL7 Message Batch hat das Root-Element den Namen der Batch-Interaktion und die verschiedenen Interaktionen (Teilberichte) sind darin aufgenommen. Für weitere Informationen siehe Wrapper-Leitfaden.
−
 
 
  
−
== Transport der XML Nachrichten ==
+
=== Transport der XML Nachrichten ===
 
In diesem Leitfaden finden Sie keine Informationen über den eigentlichen Transport der Nachrichten. Hierzu erscheinen separate Leitfäden.
 
In diesem Leitfaden finden Sie keine Informationen über den eigentlichen Transport der Nachrichten. Hierzu erscheinen separate Leitfäden.

Aktuelle Version vom 16. Dezember 2012, 18:09 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 .

Allgemeine Erläuterungen zur Benutzung von XML

Das Austauschformat für HL7 Version 3 Nachrichten ist (zum heutigen Zeitpunkt) Extensible Markup Language (XML). Es ist nicht Zweck dieses Leitfadens, allgemeine Erläuterungen über XML zu geben, allerdings werden einige Kennzeichen und Anforderungen hier trotzdem erwähnt.

Zeichensatz (Character Set)

Das Encoding im XML-Prolog einer HL7 Version 3 Nachricht muss UTF-8 sein. 

<?xml version="1.0" encoding="utf-8"?>

     oder (als default)

<?xml version="1.0"?>

Spezielle Zeichen

In XML sind bestimmte Zeichen in Informationen durch Zeichenkombinationen zu ersetzen (character entities), weil sie im XML Format eine andere und spezielle Bedeutung haben. Eine XML Character Entity ist ein “&” gefolgt von einer Zeichenkette und einem abschließenden “;”. Diese Sequenz wird vom XML Prozessor wieder ersetzt durch das spezielle Zeichen.

Die nachstehende Tabelle zeigt eine (unvollständige) Übersicht dieser Zeichen. Für mehr Informationen siehe die XML Spezifikation ([XML]):

Spezielle Zeichen in Datei Zu ersetzen durch Anmerkungen
& &amp;
< &lt;
> &gt;
' &apos;
" &quot; Ein " ist bei innerhalb von Attributwerten nicht zugelassen und muss ersetzt werden.

XML Beispiele 

<text>Werte &gt; 5 mg/l sind pathologisch</text>

XML Prozessor liefert: Werte > 5 mg/l sind pathologisch 

<name>Apotheke Leermans &amp; Söhne</name>

XML Prozessor liefert: Apotheke Leermans & Söhne

Allgemeiner Aufbau einer HL7 Version 3 Nachricht

HL7 Version 3 Nachrichten haben als Root-Element immer den Namen der dazugehörenden Interaktion. So beginnt eine HL7 Version 3 Nachricht auf der Basis der Interaktion “PORX_IN123456” mit einem XML Root-Element PORX_IN123456. Die HL7 V3 Interaktionsschemas (allgemeine Erläuterungen W3C Schema Sprache siehe [XMLSC]) haben im allgemeinen den gleichen Namen wie das Root-Element. 

<?xml version="1.0"? encoding="utf-8">
<PORX_IN123456 ...
    xmlns="urn:hl7-org:v3"
    xmlns:voc="urn:hl7-org:v3/voc"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

         … HL7 Version 3 Nachricht  inklusive Wrapper und Payload

<!-- dies ist ein Test -->

</PORX_IN123456>

Der Sender kann ein schemaLocation zwar hinzufügen, aber der Empfänger darf die Information in schemaLocation nicht benutzen.

Bei einem HL7 Message Batch hat das Root-Element den Namen der Batch-Interaktion und die verschiedenen Interaktionen (Teilberichte) sind darin aufgenommen. Für weitere Informationen siehe Wrapper-Leitfaden.

Transport der XML Nachrichten

In diesem Leitfaden finden Sie keine Informationen über den eigentlichen Transport der Nachrichten. Hierzu erscheinen separate Leitfäden.

Abgerufen von „https://wiki.hl7.de/index.php?title=v3dtr1:Allgemeine_Erläuterungen&oldid=9994“