elga-cdaalf-2.06.2:Dokumentenstruktur: Unterschied zwischen den Versionen
[unmarkierte Version] | [unmarkierte Version] |
(→Erstellungsdatum des Dokuments („effectiveTime“)) |
|||
Zeile 115: | Zeile 115: | ||
|- | |- | ||
|} | |} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
===Vertraulichkeitscode („confidentialityCode“)=== | ===Vertraulichkeitscode („confidentialityCode“)=== |
Version vom 5. September 2017, 09:51 Uhr
Inhaltsverzeichnis
- 1 Dokumentenstruktur
- 1.1 XML Metainformationen
- 1.2 Wurzelelement
- 1.3 Hoheitsbereich des Dokuments („realmCode“)
- 1.4 Dokumentformat („typeId“)
- 1.5 Erstellungsdatum des Dokuments („effectiveTime“)
- 1.6 Vertraulichkeitscode („confidentialityCode“)
- 1.7 Sprachcode des Dokuments („languageCode“)
- 1.8 ELGA Implementierungsleitfaden-Kennzeichnung („templateId“)
- 1.9 Dokumenten-Id („id”)
- 1.10 Dokumentenklasse („code“)
- 1.11 Titel des Dokuments („title“)
- 1.12 Vertraulichkeitscode („confidentialityCode“)
- 1.13 Sprachcode des Dokuments („languageCode“)
- 1.14 Versionierung des Dokuments („setId“ und „versionNumber“)
1 Dokumentenstruktur
1.1 XML Metainformationen
1.1.1 Zeichencodierung
CDA-Dokumente MÜSSEN mit UTF-8 (8-Bit Universal Character Set Transformation Format, nach RFC 3629 / STD 63 (2003)) codiert werden.
<?xml version="1.0" encoding="UTF-8" standalone=”yes”?>
<ClinicalDocument xmlns="urn:hl7-org:v3">
:
1.1.2 Hinterlegung eines Stylesheets
Um ein CDA-Dokument in einem Webbrowser anzeigen zu können, muss es nach HTML tranformiert werden. Das kann durch eine XSLT-Transformation (ein so genanntes „Stylesheet“) geschehen. Ist das Stylesheet im angegebenen Pfad erreichbar, wird dieses beim Öffnen des CDA-Dokuments mit einem Browser üblicherweise automatisch auf das CDA-Dokument angewandt und die Darstellung gerendert.
ELGA stellt zur einheitlichen Darstellung von CDA-Dokumenten ein „Referenz-Stylesheet“ zur Verfügung (Download ist von der ELGA Website http://www.elga.gv.at/cda möglich). Da der Zugriff auf XSLT-Programme von den meisten Browsern eingeschränkt ist, wird kein absoluter Pfad auf eine Webressource angegeben.
<?xml version="1.0" encoding="UTF-8" standalone=”yes”?>
<?xml-stylesheet type="text/xsl" href="ELGA_Stylesheet_v1.0.xsl"?>
<ClinicalDocument xmlns="urn:hl7-org:v3">
:
Das Stylesheet „ELGA_Stylesheet_v1.0.xsl“ MUSS angegeben werden [M]. Die Angabe eines Pfades ist NICHT ERLAUBT. Ausnahmen können für automatisiert erstellte Dokumente notwendig sein, diese müssen im allgemeinen und speziellen Leitfäden beschrieben werden.
1.2 Wurzelelement
Der XML-Namespace für CDA Release 2.0 Dokumente ist urn:hl7-org:v3 (Default-Namespace). Dieser MUSS in geeigneter Weise in jeder CDA XML Instanz genannt werden. In speziellen Leitfäden können weitere namespace-Präfixe angegeben werden.
Für ELGA CDA-Dokumente MUSS der Zeichensatz UTF-8 verwendet werden.
CDA-Dokumente beginnen mit dem Wurzelelement ClinicalDocument, der grobe Aufbau ist im folgenden Übersichtsbeispiel gegeben.
<ClinicalDocument xmlns="urn:hl7-org:v3"> <!-- CDA Header --> … siehe Beschreibung CDA R2 Header … <!-- CDA Body --> <component> <structuredBody> … siehe Beschreibung CDA R2 Body … </structuredBody> </component> </ClinicalDocument>
1.3 Hoheitsbereich des Dokuments („realmCode“)
Dieses Element kennzeichnet, dass das Dokument aus dem Hoheitsbereich Österreich (bzw. Bereich der HL7 Affiliate Austria, Code „AT“) stammt.
1.3.1 Strukturbeispiel
<realmCode code="AT'"/>
1.3.2 Spezifikation
Element/Attribut | DT | Kard | Konf | Beschreibung |
---|---|---|---|---|
realmCode | CS CNE |
1..1 | M | Hoheitsbereich des Dokuments Fester Wert: @code = AT |
1.4 Dokumentformat („typeId“)
Dieses Element kennzeichnet, dass das Dokument im Format CDA R2 vorliegt.
1.4.1 Strukturbeispiel
<typeId root="2.16.840.1.113883.1.3" extension="POCD_HD000040"/>
1.4.2 Spezifikation
Element/Attribut | DT | Kard | Konf | Beschreibung |
---|---|---|---|---|
typeId | II | 1..1 | M | Dokumentformat CDA R2 Feste Werte: @root = 2.16.840.1.113883.1.3' @extension = POCD_HD000040 |
1.5 Erstellungsdatum des Dokuments („effectiveTime“)
1.5.1 Spezifikation
1.6 Vertraulichkeitscode („confidentialityCode“)
1.6.1 Spezifikation
Id | 1.2.40.0.34.11.90009 ref elgabbr- | Gültigkeit | 2013‑11‑07 | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status | ![]() | Versions-Label | ||||||||||||||||||||||||||||||||||||||||||||||
Name | CDconfidentialityCode | Bezeichnung | CD confidentialityCode | |||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||
Klassifikation | CDA Header Level Template | |||||||||||||||||||||||||||||||||||||||||||||||
Offen/Geschlossen | Offen (auch andere als die definierten Elemente sind erlaubt) | |||||||||||||||||||||||||||||||||||||||||||||||
Assoziiert mit |
| |||||||||||||||||||||||||||||||||||||||||||||||
Beziehung | Version: Template 1.2.40.0.34.11.90009 CD confidentialityCode (2013‑11‑07) ref elgabbr- | |||||||||||||||||||||||||||||||||||||||||||||||
Beispiel |
| |||||||||||||||||||||||||||||||||||||||||||||||
|
1.7 Sprachcode des Dokuments („languageCode“)
1.7.1 Spezifikation
Id | 1.2.40.0.34.11.90010 ref elgabbr- | Gültigkeit | 2013‑11‑07 | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status | ![]() | Versions-Label | ||||||||||||||||||||||||||||||||
Name | CDlanguageCode | Bezeichnung | CD languageCode | |||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||
Klassifikation | CDA Header Level Template | |||||||||||||||||||||||||||||||||
Offen/Geschlossen | Offen (auch andere als die definierten Elemente sind erlaubt) | |||||||||||||||||||||||||||||||||
Assoziiert mit |
| |||||||||||||||||||||||||||||||||
Beziehung | Version: Template 1.2.40.0.34.11.90010 CD languageCode (2013‑11‑07) ref elgabbr- | |||||||||||||||||||||||||||||||||
Beispiel |
| |||||||||||||||||||||||||||||||||
|
1.8 ELGA Implementierungsleitfaden-Kennzeichnung („templateId“)
Templates sind definierte Vorlagen, die Strukturen von Dokumenten, Dokumentteilen oder Datenelementen vorgeben. In CDA bezeichnen solche Templates bestimmte Teilstrukturen. Mittels templateId-Elementen können Teile von CDA-Dokumenten hinsichtlich ihrer Konformität zu Templates oder Implementierungsleitfäden gekennzeichnet werden.
Der Einsatz von so genannten „templateId”-Elementen sichert zu, dass eine CDA-Instanz nicht nur CDA konform ist, sondern auch dem referenzierten Template oder Implementierungsleitfaden entspricht. Mit Zusicherung ist dabei nur eine informelle Behauptung des Verfassers gemeint und nicht notwendigerweise auch eine erfolgreich durchgeführte Validierung bzw. Zertifizierung.
Ein CDA Dokument, welches den Vorgaben dieses Implementierungsleitfadens entspricht, ist berechtigt und verpflichtet, die entsprechende templateId-Kennung einzutragen.
1.8.1 Strukturbeispiel
<ClinicalDocument xmlns="urn:hl7-org:v3"> <realmCode code="AT"/> <typeId root="2.16.840.1.113883.1.3" extension="POCD_HD000040"/> <!— Folgt dem vorliegenden Implementierungsleitfaden-Template --> <templateId root="1.2.40.0.34.11.1"/> <!— Beliebig viele weitere templateIds, falls das Dokumente noch weiteren Implementierungsleitfäden oder Spezifikationen folgt --> <templateId root="…"/> : </ClinicalDocument>
1.8.2 Spezifikation
Die OID des vorliegenden Implementierungsleitfadens MUSS im @root Attribut des Elements angegeben werden.
Mit Angabe dieses Elements wird ausgesagt, dass das vorliegende CDA-Dokument zu diesem Implementierungsleitfaden konform ist.
Element/Attribut | DT | Kard | Konf | Beschreibung |
---|---|---|---|---|
templateId[1] | II | 1..1 | M | ELGA TemplateId für den Allgemeinen Implementierungsleitfaden Fester Wert: @root = 1.2.40.0.34.11.1 |
templateId[n] | II | 0..* | O | Weitere TemplateIds |
Verweis auf speziellen Implementierungsleitfaden:
Des Weiteren können zusätzlich die geforderten templateIds eines weiteren speziellen Implementierungsleitfadens angegeben werden (z.B. Entlassungsbrief, Laborbefund, etc.).
Die jeweils im @root Attribut einzutragende OID entnehmen Sie bitte den entsprechenden Implementierungsleitfaden gemäß der Dokumentklasse.
Folgt das CDA-Dokument noch anderen Implementierungsleitfäden oder Spezifikationen können beliebig viele weitere templateId-Elemente angegeben werden.
1.9 Dokumenten-Id („id”)
Die Dokumenten-Id eines CDA-Dokuments ist ein eindeutiger Instanzidentifikator, der das Dokument weltweit eindeutig und für alle Zeit identifiziert. Ein CDA-Dokument hat genau eine Id.
1.9.1 Strukturbeispiel
<id root="1.2.40.0.34.99.111.1.1" extension="134F989" assigningAuthorityName="Amadeus Spital"/>
1.9.2 Spezifikation
Es MUSS eine gültige und innerhalb des ID-Pools eindeutige Dokumenten-ID angegeben werden.
Element/Attribut | DT | Kard | Konf | Beschreibung |
---|---|---|---|---|
id | II | 1..1 | M | Dokumenten-Id Grundsätzlich sind die Vorgaben gemäß „Identifikations-Elemente“ zu befolgen. |
1.10 Dokumentenklasse („code“)
Der “Code des Dokuments” (im CDA das Element ClinicalDocument/code) bezeichnet die „Dokumentklasse'“ bzw den präziseren „'Dokumenentyp'“.
Beispiele für die Klasseneinteilung der Dokumente:
- Dokumentenklasse: Entlassungsbrief
- Dokumententyp: „Entlassungsbrief aus stationärer Behandlung (Ärztlich)“
- Dokumententyp: „Entlassungsbrief aus stationärer Behandlung (Pflege)“
- Dokumentenklasse: Laborbefund
- Dokumentenklasse: Befundbericht Befund bildgebende Diagnostik
- …
Für das Mapping in XDS siehe den entsprechenden Leitfaden „ELGA XDS Metadaten“.
1.10.1 Strukturbeispiel
displayName="Physician Discharge summary" codeSystem="2.16.840.1.113883.6.1" codeSystemName="LOINC" />
1.10.2 Spezifikation
Element/Attribut | DT | Kard | Konf | Beschreibung |
---|---|---|---|---|
code | CE CWE |
1..1 | M | Dokumententyp oder Dokumentenklasse Zulässige Werte gemäß Value-Set „ELGA_Dokumentklassen“ |
Verweis auf speziellen Implementierungsleitfaden:
Die gültigen Wertebereiche dieses Elements entnehmen Sie bitte den entsprechenden speziellen Implementierungsleitfaden gemäß der Dokumentklasse bzw dem Dokumententyp.
1.11 Titel des Dokuments („title“)
“Titel” (im CDA das Element ClinicalDocument/title) bezeichnet die verpflichtende „Dokumentenüberschrift“ (zusätzlich zur Dokumentenklasse).
Beispiele für Titel der Dokumente:
- „Arztbrief“
- „Entlassungsbrief der gynäkologischen Abteilung des SMZ Ost“
- „Vorläufiger Entlassungsbrief“
- „Befundbericht“
- …
1.11.1 Strukturbeispiel
<title>Entlassungsbrief</title>
1.11.2 Spezifikation
Element/Attribut | DT | Kard | Konf | Beschreibung |
---|---|---|---|---|
title | ST | 1..1 | M | Dokumententitel Der Sinn der Benennung MUSS mit der Dokumentklasse übereinstimmen. |
1.12 Vertraulichkeitscode („confidentialityCode“)
1.12.1 Spezifikation
Id | 1.2.40.0.34.11.90009 ref elgabbr- | Gültigkeit | 2013‑11‑07 | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status | ![]() | Versions-Label | ||||||||||||||||||||||||||||||||||||||||||||||
Name | CDconfidentialityCode | Bezeichnung | CD confidentialityCode | |||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||
Klassifikation | CDA Header Level Template | |||||||||||||||||||||||||||||||||||||||||||||||
Offen/Geschlossen | Offen (auch andere als die definierten Elemente sind erlaubt) | |||||||||||||||||||||||||||||||||||||||||||||||
Assoziiert mit |
| |||||||||||||||||||||||||||||||||||||||||||||||
Beziehung | Version: Template 1.2.40.0.34.11.90009 CD confidentialityCode (2013‑11‑07) ref elgabbr- | |||||||||||||||||||||||||||||||||||||||||||||||
Beispiel |
| |||||||||||||||||||||||||||||||||||||||||||||||
|
1.13 Sprachcode des Dokuments („languageCode“)
1.13.1 Spezifikation
Id | 1.2.40.0.34.11.90010 ref elgabbr- | Gültigkeit | 2013‑11‑07 | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status | ![]() | Versions-Label | ||||||||||||||||||||||||||||||||
Name | CDlanguageCode | Bezeichnung | CD languageCode | |||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||
Klassifikation | CDA Header Level Template | |||||||||||||||||||||||||||||||||
Offen/Geschlossen | Offen (auch andere als die definierten Elemente sind erlaubt) | |||||||||||||||||||||||||||||||||
Assoziiert mit |
| |||||||||||||||||||||||||||||||||
Beziehung | Version: Template 1.2.40.0.34.11.90010 CD languageCode (2013‑11‑07) ref elgabbr- | |||||||||||||||||||||||||||||||||
Beispiel |
| |||||||||||||||||||||||||||||||||
|
1.14 Versionierung des Dokuments („setId“ und „versionNumber“)
1.14.1 Spezifikation
Es MÜSSEN immer beide Elemente (setID und versionNumber) angegeben werden.
Id | 1.2.40.0.34.11.90007 ref elgabbr- | Gültigkeit | 2015‑09‑18 | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status | ![]() | Versions-Label | |||||||||||||||||||||||||||||||||
Name | CDsetIdversionNumber | Bezeichnung | SetId VersionNumber | ||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
Klassifikation | CDA Header Level Template | ||||||||||||||||||||||||||||||||||
Offen/Geschlossen | Offen (auch andere als die definierten Elemente sind erlaubt) | ||||||||||||||||||||||||||||||||||
Beziehung | Version: Template 1.2.40.0.34.11.90007 SetId VersionNumber (2015‑09‑18) ref elgabbr- | ||||||||||||||||||||||||||||||||||
Beispiel |
| ||||||||||||||||||||||||||||||||||
Beispiel |
| ||||||||||||||||||||||||||||||||||
|
Für die setId sind grundsätzlich die Vorgaben gemäß Kapitel „id-Element II“ zu befolgen. Die versionNumber von neuen Dokumenten wird mit 1 festgelegt.
Anhänge oder Ersetzungen von Vordokumenten MÜSSEN ebenfalls diese zusätzlichen Angaben enthalten.
Der genaue Zusammenhang zwischen diesen Attributen finden Sie im „Bezug zu vorgehenden Dokumenten“.
Achtung: Manche Validatoren erkennen es als Fehler, wenn die SetID und ID gleich sind.