[geprüfte Version] | [Markierung ausstehend] |
|
|
| | rowspan="2" |'''''[R]'''''||1..1<br />1..*||''erlaubt''||Das '''Element''' MUSS in der Instanz vorhanden sein ''("required")''. Wenn ein Element nicht bekannt ist, ist die Verwendung eines nullFlavors vorgeschrieben, "Dummy"-Werte sind NICHT ERLAUBT. | | | rowspan="2" |'''''[R]'''''||1..1<br />1..*||''erlaubt''||Das '''Element''' MUSS in der Instanz vorhanden sein ''("required")''. Wenn ein Element nicht bekannt ist, ist die Verwendung eines nullFlavors vorgeschrieben, "Dummy"-Werte sind NICHT ERLAUBT. |
| |- | | |- |
− | |0..1<br />0..*||''nicht erlaubt''||Das '''Element''' SOLL in der Instanz vorhanden sein, sofern bekannt ''("required")''. Wenn nicht bekannt, darf es nicht in der Instanz codiert sein und muss weggelassen werden. Ein nullFlavor ist daher NICHT ERLAUBT. Entspricht der in älteren Leitfäden gebräuchlichen Notation [R2] ''("required if known")''. | + | |0..1<br />0..*||''nicht erlaubt''||Das '''Element''' SOLL in der Instanz vorhanden sein, sofern bekannt ''("required")''. Wenn nicht bekannt, darf es nicht in der Instanz codiert sein und MUSS weggelassen werden. Ein nullFlavor ist daher NICHT ERLAUBT. Entspricht der in älteren Leitfäden gebräuchlichen Notation [R2] ''("required if known")''. |
| |- | | |- |
| |'''''[O]'''''||0..1<br />0..*||''erlaubt''||Das '''Element''' ist OPTIONAL ''("optional")''. Sender können das Element angeben. Leere optionale Elemente sind nicht zugelassen, sofern kein nullFlavor angewandt wird. | | |'''''[O]'''''||0..1<br />0..*||''erlaubt''||Das '''Element''' ist OPTIONAL ''("optional")''. Sender können das Element angeben. Leere optionale Elemente sind nicht zugelassen, sofern kein nullFlavor angewandt wird. |
|
|
| | wenn eine Codierung nur in einem alternativen Codesystem verfügbar ist | | | wenn eine Codierung nur in einem alternativen Codesystem verfügbar ist |
| |} | | |} |
− | <ref group="Tabelle">nullFlavor-Beispiele aus Value-Set ELGA_nullFlavor</ref>: nullFlavor-Beispiele aus Value-Set ELGA_nullFlavor | + | <ref group="Tabelle">nullFlavor-Beispiele aus Value Set ELGA_NullFlavor</ref>: nullFlavor-Beispiele aus Value Set [https://termgit.elga.gv.at/ValueSet/elga-nullflavor ELGA_NullFlavor] |
| | | |
| ===Maximum-Set=== | | ===Maximum-Set=== |
− | Das CDA Modell beschreibt ein höchst umfangreiches Schema von Informationselementen und bietet in manchen Bereichen über rekursive, beliebig tief verschachtelbare Elemente eine theoretisch unendlich hohe Anzahl von Möglichkeiten, Informationen abzulegen. Die vollständige Beschreibung und Definition aller Elemente in einem Implementierungsleitfaden wäre daher äußerst aufwändig und ist in den ELGA Implementierungsleitfäden nicht erfolgt. | + | Das CDA-Modell beschreibt ein höchst umfangreiches Schema von Informationselementen und bietet in manchen Bereichen über rekursive, beliebig tief verschachtelbare Elemente eine theoretisch unendlich hohe Anzahl von Möglichkeiten, Informationen abzulegen. Die vollständige Beschreibung und Definition aller Elemente in einem Implementierungsleitfaden wäre daher äußerst aufwändig und ist in den ELGA Implementierungsleitfäden nicht erfolgt. |
| | | |
| Vielmehr beschreiben die ELGA Implementierungsleitfäden lediglich jene Elemente, die erlaubt sind. Die Verwendung aller nicht angegebenen Elemente und Attribute ist NICHT ERLAUBT. Für alle Templates gelten die im [[#Datentypen|Kapitel Datentypen]] angegebenen Einschränkungen. Die ELGA Implementierungsleitfäden beschreiben daher ein sogenanntes '''''"Maximum-Set"''''', Die ELGA Templates sind demnach als "closed templates" entsprechend dem HL7 Templates Standard zu betrachten. | | Vielmehr beschreiben die ELGA Implementierungsleitfäden lediglich jene Elemente, die erlaubt sind. Die Verwendung aller nicht angegebenen Elemente und Attribute ist NICHT ERLAUBT. Für alle Templates gelten die im [[#Datentypen|Kapitel Datentypen]] angegebenen Einschränkungen. Die ELGA Implementierungsleitfäden beschreiben daher ein sogenanntes '''''"Maximum-Set"''''', Die ELGA Templates sind demnach als "closed templates" entsprechend dem HL7 Templates Standard zu betrachten. |
|
|
| | | |
| ====Hinweis zur Implementierung weiterverarbeitender Software==== | | ====Hinweis zur Implementierung weiterverarbeitender Software==== |
− | CDA-Dokumente können unter Umständen "fremde" Elemente oder Attribute enthalten, die der "Maximum-Set" Vorschrift dieses Leitfadens widersprechen (z.B. aufgrund von Software-Fehlern). Sollten derartige Elemente oder Attribute im CDA-Dokument vorhanden sein, soll weiterverarbeitende Software so implementiert sein, dass dies nicht zu Fehlern in der Weiterverarbeitung der Dokumente führt. | + | CDA-Dokumente können unter Umständen "fremde" Elemente oder Attribute enthalten, die der "Maximum-Set" Vorschrift dieses Leitfadens widersprechen (z.B. aufgrund von Software-Fehlern). Sollten derartige Elemente oder Attribute im CDA-Dokument vorhanden sein, soll weiterverarbeitende Software so implementiert sein, dass dies nicht zu Fehlern in der Weiterverarbeitung der CDA-Dokumente führt. |
| | | |
| ===Value Sets=== | | ===Value Sets=== |
− | Ein Value Set ist eine eindeutig identifizierbare und versionierte Sicht auf ein oder mehrere Codesysteme. Es kann als Zusammenstellung von einem oder mehreren Codes aus einem oder mehreren Codesysteme gesehen werden. Ein Value Set enthält die Codes selbst und die Information über die Herkunft des Codes (das Source-Codesystem). | + | Ein Value Set ist eine eindeutig durch Name oder OID identifizierbare und versionierte Sicht auf ein oder mehrere Codesysteme. Es kann als Zusammenstellung von einem oder mehreren Codes aus einem oder mehreren Codesystemen gesehen werden. Ein Value Set enthält die Codes selbst und die Information über die Herkunft des Codes (das Source-Codesystem), z.B. "ELGA_NullFlavor" oder "ELGA_Dokumentenklassen". |
| | | |
− | Beispiele für Value-Sets: "ELGA_NullFlavor", "ELGA_Dokumentenklassen".
| + | Wo immer in den CDA-Implementierungsleitfäden eine Werteauswahl getroffen werden kann, wird ein passendes Value Set mit einem eindeutigen Namen angegeben. Sämtliche in den Implementierungsleitfäden verwendeten Value Sets werden am österreichischen Terminologieserver publiziert: https://termgit.elga.gv.at/. |
| | | |
− | Wo immer in den CDA Implementierungsleitfäden eine Werteauswahl getroffen werden kann, wird ein passendes Value Set mit einem eindeutigen Namen angegeben. Sämtliche in den Implementierungsleitfäden verwendeten Value Sets werden am österreichischen Terminologieserver publiziert: https://termpub.gesundheit.gv.at/.
| + | ====Value Set Binding==== |
| + | Für ELGA gilt grundsätzlich eine DYNAMISCHE Bindung an Value Sets. Das bedeutet, dass immer die aktuell am Terminologieserver publizierte Version eines Value Sets anzuwenden ist. (Das Setzen des entsprechenden Schlüsselworts DYNAMIC ist daher in den Leitfäden optional, aktuell gibt es auch keine ValueSets die statisch gebunden sind). |
| | | |
− | Value Sets sind nicht nur durch einen eindeutigen Namen, sondern auch durch eine OID, und eine Versionsnummer gekennzeichnet. Weiters werden Gültigkeitsstatus und ein "Gültig ab"-Datum angegeben. | + | Für jedes Value Set ist am Terminologieserver auch ein Zeitpunkt angegeben, an dem es Gültigkeit erlangt ("Status: Active as of"), das ist speziell für Value Sets wichtig, die schon vor ihrem Inkrafttreten veröffentlicht werden. Value Sets sind so lange gültig, bis das Gültigkeitsdatum einer neueren Version dieses Value Sets erreicht wird – dann gilt die neuere Version. |
| | | |
− | Hinweise zum korrekten Umgang mit Terminologien finden sich im "Leitfaden für den Umgang mit Terminologien in ELGA" [TERMLEIT].
| + | Im CDA-Dokument KANN über die Attribute @ValueSet und @ValueSetVersion angegeben werden, welches Value Set in welcher Version als Basis für die Befüllung des jeweiligen Datenelements verwendet wurde. |
| | | |
| ====Änderbarkeit von Value Sets==== | | ====Änderbarkeit von Value Sets==== |
− | Inhalte von Value Sets können sich ändern, der Name und die OID eines Value Sets bleiben aber gleich. Bei neuen Versionen werden Versionsnummer, Änderungsdatum und "Gültig ab"-Datum (effectiveDate) angegeben. Damit kann die Gültigkeit zu einer bestimmten Zeit rekonstruiert werden. | + | Inhalte von Value Sets können sich ändern, der Name und die OID eines Value Sets bleiben aber gleich. Alle ValueSets, die für ein CDA des Implementierungsleitfadens verwendet werden, sollen periodisch gemeinsam aktualisiert werden. Das Datum, an dem die lokal zur Implementierung verwendeten Value Sets mit dem österreichischen Terminologieserver abgeglichen wurden, wird im Terminologiedatum-Header-Element "terminologyDate" angegeben. Damit kann die Gültigkeit zu einer bestimmten Zeit rekonstruiert werden. |
− | | |
− | In Ausnahmen kann bei der Definition eines Value Sets angegeben werden, dass es nicht geändert oder versioniert werden darf (Property "Immutability").
| |
− | | |
− | ====Value Set Binding====
| |
− | Für ELGA gilt grundsätzlich eine DYNAMISCHE Bindung an Value Sets. Das bedeutet, dass immer die aktuell am Terminologieserver publizierte Version eines Value Sets anzuwenden ist. (Das Setzen des entsprechenden Schlüsselworts DYNAMIC ist daher in den Leitfäden optional).
| |
− | | |
− | Für jedes Value Set ist auch ein Zeitpunkt angegeben, an dem es Gültigkeit erlangt ("Gültig ab"), das ist für Value Sets wichtig, die schon vor ihrem Inkrafttreten veröffentlicht werden.
| |
− | | |
− | Value Sets können auch STATISCH an ein Code-Element gebunden werden. Das wird gekennzeichnet durch die Angabe des Value Sets mit Name, OID, Version und "Gültig ab"-Datum (effectiveDate) sowie dem Schlüsselwort STATIC.
| |
| | | |
| + | ====Publikation der Value Sets am Terminologieserver==== |
| + | Sämtliche in den Implementierungsleitfäden verwendeten Value Sets werden am österreichischen Terminologieserver publiziert.<ref name="Terminologieserver">Österreichischer e-Health-Terminologie-Browser https://termgit.elga.gv.at</ref> |
| + | Damit die jeweils aktuelle Version der Value Sets angewendet werden kann, soll der Terminologieserver regelmäßig auf Update abgeprüft werden. Es wird EMPFOHLEN, diese Überprüfung täglich durchzuführen. |
| | | |
| + | ====Terminologiedatum==== |
| + | Das Datum, an dem sämtliche lokal zur Implementierung verwendeten Value Sets mit dem österreichischen Terminologieserver abgeglichen wurden, wird über das "Terminologiedatum" angegeben: Dieses Datum wird in der Notation "YYYYMMDD" im eigenen Element "terminologyDate" angegeben. |
| + | Beim Abgleich der Terminologien müssen immer alle Value Sets, die für ein CDA-Dokument notwendig sind, auf die am Terminologieserver aktuelle Version aktualisiert werden. Dokumente, die nur teilweise auf dem aktuellen Stand beruhen, könnten inkonsistent sein und MÜSSEN vermieden werden. |
| | | |
| ===PDF Format-Vorschrift=== | | ===PDF Format-Vorschrift=== |
− | PDF-Attachments kommen im e-Impfpass nicht zur Anwendung.
| + | In CDA Dokumenten können Dokumente im PDF Format an verschiedensten Stellen eingebettet werden, entweder als gesamter CDA-Body oder als eingebetteter Inhalt in gewissen CDA-Sektionen. Im Hinblick auf eine dauerhafte Verfügbarkeit der Daten muss mindestens gewährleistet werden, dass diese PDF-Dokumente zuverlässig und eindeutig visuell reproduzierbar sind. Dies kann über die Einhaltung der Mindestkriterien der Norm ISO 19005-1:2005 sichergestellt werden (PDF/A-1b Basic bzw. PDF/A-3b Basic). Die Norm beschreibt zusätzlich die Barrierefreiheit der Dokumente, sodass sie von einem Screenreader vorgelesen werden können (PDF/A-1a Accessible bzw. PDF/A-3a Accessible). Dieser Implementierungsleitfaden schreibt daher als Minimalanforderung vor, dass jedes eingebettete PDF-Dokument dem Standard PDF/A-1b bzw. PDF/A-3b entsprechen MUSS. Im Sinne der Barrierefreiheit ist die Umsetzung von PDF/A-1a bzw. PDF/A-3a EMPFOHLEN. |
− | <!-- Standardtext:
| |
− | In CDA Dokumenten können Dokumente im PDF Format an verschiedensten Stellen eingebettet werden, entweder als gesamter CDA-Body oder als eingebetteter Inhalt in gewissen CDA-Sektionen. Im Hinblick auf eine dauerhafte Verfügbarkeit der Daten muss mindestens gewährleistet werden, dass diese PDF-Dokumente zuverlässig und eindeutig visuell reproduzierbar sind. Dies kann über die Einhaltung der Mindestkriterien der Norm ISO 19005-1:2005 sichergestellt werden (PDF/A-1b Basic). Die Norm beschreibt zusätzlich Barrierefreiheit der Dokumente, sodass sie von einem Screenreader vorgelesen werden können (PDF/A-1a Accessible). Dieser Implementierungsleitfaden schreibt daher vor, dass jedes eingebettete PDF-Dokument dem Standard PDF/A-1a entsprechen MUSS<sup>5<sup>. | |
| {{BeginYellowBox}} | | {{BeginYellowBox}} |
− | Alle in ELGA-CDA-Dokumente eingebetteten PDF-Dateien MÜSSEN dem Standard PDF/A-1a (gemäß "ISO 19005-1:2005 Level A conformance") entsprechen. | + | Alle in ELGA-CDA-Dokumente eingebetteten PDF-Dateien MÜSSEN dem Standard PDF/A-1b bzw. PDF/A3-b (gemäß "ISO 19005-1:2005 Level A conformance") entsprechen. Die Umsetzung von PDF/A-1a bzw. PDF/A-3a ist EMPFOHLEN. |
| {{EndYellowBox}} | | {{EndYellowBox}} |
− | {{Informationsbox|Änderung|Für die nächste Version des Leitfadens ist geplant, die Vorschrift auf PDF/A-1b zu senken. PDF/A-1a bleibt erlaubt.}}
| |
− | <sup>5</sup> Bis zum Vorliegen von Dokumenten in EIS Full Support wird mindestens PDF/A-1b vorgeschrieben.
| |
− | -->
| |
| | | |
| ===Größenbeschränkung von eingebetteten Objekten=== | | ===Größenbeschränkung von eingebetteten Objekten=== |
− | In CDA Dokumenten können verschiedene Objekte (z.B. PDF-Dokumente, Bilder) eingebettet werden (siehe "[[#Eingebettetes_Objekt_Entry|Eingebettetes Objekt Entry]]"). | + | In CDA-Dokumenten können verschiedene Objekte (z.B. PDF-Dokumente, Bilder) eingebettet werden (siehe "[[#Eingebettetes_Objekt_Entry|Eingebettetes Objekt Entry]]"). |
| | | |
− | Dieser Implementierungsleitfaden schreibt keine Größenbeschränkung für diese Objekte vor, es wird allerdings EMPFOHLEN, diese in Bezug auf Anzahl und Speicherbedarf so klein wie möglich zu halten. Es liegt in der Verantwortung des Erstellers, die Größe der über ELGA bereitgestellten CDA-Dateien etwa durch Verringerung der Auflösung oder der Anzahl der Einzelbilder auf eine sinnvolle und angemessene Größe zu beschränken. | + | Dieser Implementierungsleitfaden schreibt keine Größenbeschränkung für diese Objekte vor, es wird allerdings EMPFOHLEN, diese in Bezug auf Anzahl und Speicherbedarf so klein wie möglich zu halten. Es liegt in der Verantwortung des Erstellers, die Größe der über ELGA bereitgestellten CDA-Dokumente etwa durch Verringerung der Auflösung oder der Anzahl der Einzelbilder auf eine sinnvolle und angemessene Größe zu beschränken. |
| {{BeginYellowBox}} | | {{BeginYellowBox}} |
− | Damit beim Download keine unnötigen Verzögerungen verursacht werden, SOLL die Gesamtgröße der Datei 20 MB nicht überschreiten.<sup>6</sup> | + | Damit beim Download keine unnötigen Verzögerungen verursacht werden, SOLL die Gesamtgröße des CDA-Dokuments 20 MB nicht überschreiten. |
| {{EndYellowBox}} | | {{EndYellowBox}} |
− | <sup>6</sup> Aktuell wird von ELGA die Größe von Doumenten auf 20MB beschränkt.
| |
| | | |
| ===Verbot von CDATA=== | | ===Verbot von CDATA=== |
− | Die Verwendung von CDATA-Abschnitten (<![CDATA[…]]>), also von Zeichenketten, die vom Parser nicht als XML-Quellcode interpretiert werden können, ist für ELGA CDA Dokumente generell '''NICHT ERLAUBT'''. | + | Die Verwendung von CDATA-Abschnitten (<![CDATA[…]]>), also von Zeichenketten, die vom Parser nicht als XML-Quellcode interpretiert werden können, ist für ELGA CDA-Dokumente generell '''NICHT ERLAUBT'''. |