elga-cdaalf-2.06.2:Dokumentenstruktur: Unterschied zwischen den Versionen
| [unmarkierte Version] | [unmarkierte Version] |
(→Wurzelelement) |
(→Strukturbeispiel) |
||
| Zeile 42: | Zeile 42: | ||
====Strukturbeispiel==== | ====Strukturbeispiel==== | ||
<div style="border:solid 1px black; background-color:#F4C789"> | <div style="border:solid 1px black; background-color:#F4C789"> | ||
| − | <realmCode code="AT"/> | + | <realmCode code="'''AT''''"/> |
</div> | </div> | ||
| + | |||
====Spezifikation==== | ====Spezifikation==== | ||
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
Version vom 24. Juli 2017, 09:13 Uhr
Inhaltsverzeichnis
- 1 Dokumentenstruktur
- 1.1 Zeichencodierung
- 1.2 Hinterlegung eines Stylesheets
- 1.3 Wurzelelement
- 1.4 Hoheitsbereich des Dokuments („realmCode“)
- 1.5 Dokumentformat („typeId“)
- 1.6 ELGA Implementierungsleitfaden-Kennzeichnung („templateId“)
- 1.7 Dokumenten-Id („id”)
- 1.8 Dokumentenklasse („code“)
- 1.9 Titel des Dokuments („title“)
- 1.10 Erstellungsdatum des Dokuments („effectiveTime“)
- 1.11 Vertraulichkeitscode („confidentialityCode“)
- 1.12 Sprachcode des Dokuments („languageCode“)
- 1.13 Versionierung des Dokuments („setId“ und „versionNumber“)
1 Dokumentenstruktur
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.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.3 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 diesem Leitfaden werden namespace-Präfixe nicht genutzt.
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.4 Hoheitsbereich des Dokuments („realmCode“)
Dieses Element kennzeichnet, dass das Dokument aus dem Hoheitsbereich Österreich (bzw. Bereich der HL7 Affiliate Austria, Code „AT“) stammt.
1.4.1 Strukturbeispiel
<realmCode code="AT'"/>
1.4.2 Spezifikation
| Element/Attribut | DT | Kard | Konf | Beschreibung |
|---|---|---|---|---|
| realmCode | CS CNE |
1..1 | M | Hoheitsbereich des Dokuments Fester Wert: @code = AT |
1.5 Dokumentformat („typeId“)
Dieses Element kennzeichnet, dass das Dokument im Format CDA R2 vorliegt.
1.5.1 Strukturbeispiel
<typeId root="2.16.840.1.113883.1.3" extension="POCD_HD000040"/>
1.5.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 |
1.6 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.6.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.6.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.
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.7 Dokumenten-Id („id”)
1.7.1 Strukturbeispiel
<id
root="1.2.40.0.34.99.111.1.1"
extension="134F989"
assigningAuthorityName="Amadeus Spital"/>
1.7.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äß Kapitel „Identifikations-Elemente“ zu befolgen. |
1.8 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.8.1 Strukturbeispiel
<code code="11490-0"
displayName="Physician Discharge summary"
codeSystem="2.16.840.1.113883.6.1"
codeSystemName="LOINC" />
1.8.2 Spezifikation
Es MUSS eine gültige und innerhalb des ID-Pools eindeutige Dokumenten-ID angegeben werden.
| 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.9 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.9.1 Strukturbeispiel
<title>Entlassungsbrief</title>
1.9.2 Spezifikation
| Element/Attribut | DT | Kard | Konf | Beschreibung |
|---|---|---|---|---|
| title | ST | 1..1 | M | Dokumententitel Der Sinn der Benennung MUSS mit der Dokumentklasse übereinstimmen. |
1.10 Erstellungsdatum des Dokuments („effectiveTime“)
Mit Erstellungsdatum ist jenes Datum gemeint, welches normalerweise im Briefkopf eines Schriftstückes angegeben wird. (z.B.: Wien, am …). Das Erstellungsdatum dokumentiert den Zeitpunkt, an dem das Dokument inhaltlich fertiggestellt wurde.
Bemerkung: Das Erstellungsdatum des Dokuments muss nicht mit dem Datum der rechtlichen Unterzeichnung (oder „Vidierung“) übereinstimmen
1.10.1 Strukturbeispiel
<effectiveTime value="20081224082015+0100"/>
1.10.2 Spezifikation
| Id | 1.2.40.0.34.11.90008 ref elgabbr- | Gültigkeit | 2016‑07‑21 Andere Versionen mit dieser Id:
| |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Status |  Aktiv | Versions-Label | ||||||||||||||||||||||||
| Name | CDeffectiveTime | Bezeichnung | CD effectiveTime | |||||||||||||||||||||||
| ||||||||||||||||||||||||||
| 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.90008 CD effectiveTime (2016‑07‑21) ref elgabbr- | |||||||||||||||||||||||||
| Beispiel |
| |||||||||||||||||||||||||
| Beispiel |
| |||||||||||||||||||||||||
| ||||||||||||||||||||||||||
Grundsätzlich sind die Vorgaben gemäß Kapitel„Zeit-Elemente“ zu befolgen.
1.11 Vertraulichkeitscode („confidentialityCode“)
“Vertraulichkeitscode” (im CDA das Element ClinicalDocument/confidentialityCode) bezeichnet die Vertraulichkeitsstufe dieses Dokuments. Der tatsächliche Zugriff auf das Dokument muss von der übergeordneten Infrastrukturschicht geregelt werden. Die Information des Vertraulichkeitscodes im Dokument selbst, dient nur der reinen Information und hat keine technischen Konsequenzen. Da Dokumente nach der Vidierung weder technisch noch legistisch geändert werden dürfen, kann der Vertraulichkeitscode keine konkreten Zugriffsrechte auf das Dokument regeln, sondern nur auf „Metaebenen“, wie beispielsweise „geltendes Recht XY“ oder weiterführende Verwendungen über das IHE BPPC Profil, verweisen.
1.11.1 Strukturbeispiel
<confidentialityCode
code="N"
displayName="normal"
codeSystem="2.16.840.1.113883.5.25"
codeSystemName="HL7:Confidentiality" />
1.11.2 Spezifikation
| Id | 1.2.40.0.34.11.90009 ref elgabbr- | Gültigkeit | 2013‑11‑07 | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Status | Aktiv | 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 |
| |||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||
| Element/Attribut | DT | Kard | Konf | Beschreibung | |
|---|---|---|---|---|---|
| code | CE CWE |
1..1 | M | Code des Dokuments | |
| @code | cs | 1..1 | M | Fester Wert: N (aus ValueSet „ELGA_Confidentiality“) | |
| @displayName | st | 1..1 | M | Fester Wert: normal | |
| @codeSystem | uid | 1..1 | M | Fester Wert: 2.16.840.1.113883.5.25 | |
| @codeSystemName | ADXP | 1..1 | M | Fester Wert: HL7:Confidentiality | |
1.12 Sprachcode des Dokuments („languageCode“)
Die Sprache des Dokuments wird in diesem Attribut gemäß IETF (Internet Engineering Task Force), RFC 1766: Tags for the Identification of Languages nach ISO-639-1 (zweibuchstabige Codes für Sprachen, Kleinbuchstaben) und ISO 3166 (hier: zweibuchstabige Ländercodes, Großbuchstaben) festgelegt.
Das Format ist entsprechend ss-CC, mit ss, zwei Kleinbuchstaben für den Sprachencode gemäß ISO-639-1, und CC, zwei Großbuchstaben für den Ländercode gemäß ISO 3166 (Tabelle mit zwei Buchstaben).
1.12.1 Strukturbeispiel
<languageCode code="de-AT"/>
1.12.2 Spezifikation
| Id | 1.2.40.0.34.11.90010 ref elgabbr- | Gültigkeit | 2013‑11‑07 | |||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Status | Aktiv | 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.13 Versionierung des Dokuments („setId“ und „versionNumber“)
Der CDA-Header repräsentiert ebenfalls die Beziehungen zu anderen Dokumenten mit Referenz auf die oben genannte Dokumenten-Identifikation.
Mittels der Attribute setId und versionNumber kann eine Versionskennung des Dokuments erreicht werden. Für ELGA-CDA-Dokumente MÜSSEN immer beide Elemente angegeben werden.
Die setId bezeichnet das Set von Dokumenten, die zu einer Reihe von Versionen gehören. Sie bleibt über alle Versionen der Dokumente gleich (initialer Wert bleibt erhalten). Die versionNumber ist eine natürliche Zahl für die fortlaufende Versionszählung. Mit einer neuen Version wird diese Zahl hochgezählt, die setId bleibt gleich.
1.13.1 Strukturbeispiel
1.13.1.1 Beispiel für die 1.Version eines Dokuments
<ClinicalDocument xmlns="urn:hl7-org:v3">
<id root="1.2.40.0.34.99.111.1.1" extension="AAAAAAAAAAAAAAA"/>
<setId root="1.2.40.0.34.99.111.1.1" extension="ZZZZZZZZZZZZZZZ"/>
<versionNumber value="1"/>
</ClinicalDocument>
Die bei setId angegebene ID SOLLTE nicht gleich sein wie die id des Dokuments.
1.13.1.2 Beispiel für die 2.Version eines Dokuments
<ClinicalDocument xmlns=„urn:hl7-org:v3“>
<id root="1.2.40.0.34.99.111.1.1" extension="BBBBBBBBBBBBBBB"/>
<setId root="1.2.40.0.34.99.111.1.1" extension="ZZZZZZZZZZZZZZZ"/>
<versionNumber value="2"/>
</ClinicalDocument>
Die bei setId angegebene ID MUSS mit der setId der Vorversion übereinstimmen.
1.13.2 Spezifikation
| Id | 1.2.40.0.34.11.90007 ref elgabbr- | Gültigkeit | 2015‑09‑18 Andere Versionen mit dieser Id:
| ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Status | Aktiv | 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 |
| ||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
Es MÜSSEN immer beide Elemente (setID und versionNumber) angegeben werden.
| Element/Attribut | DT | Kard | Konf | Beschreibung | |
|---|---|---|---|---|---|
| setId | II | 1..1 | M | Eindeutige Id des Dokumentensets Grundsätzlich sind die Vorgaben gemäß Kapitel 5.1 „Identifikations-Elemente“ zu befolgen. | |
| versionNumber | INT | 1..1 | M | Versionsnummer des Dokuments | |
| @value | int | 1..1 | M | Versionsnummer als positive ganze Zahl | |
8 Manche Validatoren erkennen es als Fehler, wenn die SetID und ID gleich sind. 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 Kapitel „Bezug zu vorgehenden Dokumenten“.
