Änderungen

Wechseln zu: Navigation, Suche

ILF:EImpfpass Allgemeine Richtlinien

1.319 Bytes hinzugefügt, 09:37, 4. Feb. 2021
K
Typographische Anführungszeichen entfernt
==Allgemeine Richtlinien für die Implementierung des e-Impfpasses==
===Verwendung von Schlüsselwörtern===
Wenn im Text die Verbindlichkeit von Vorgaben angegeben wird, wird das durch Schlüsselwörter gekennzeichnet [gemäß RFC 2119], die in Majuskeln (Großbuchstaben) geschrieben werden. Die Angabe der Verbindlichkeit ersetzt nicht die Angabe von Kardinalität oder Nullwerten (die in HL7 Version 3 als NullFlavors nullFlavors ausgedrückt werden).
* MUSS bedeutet eine verpflichtend einzuhaltende Vorschrift (Gebot). Entspricht den Konformitätskriterien '''''[R 1..*M]''''' und '''''[MR]1..'''''.* NICHT ERLAUBT formuliert ein verpflichtend einzuhaltendes Verbot. Entspricht dem Konformitätskriterium '''''[NP]'''''.* SOLL oder EMPFOHLEN steht für eine pragmatische Empfehlung. Es ist gewünscht und empfohlen, dass die Anforderung umgesetzt wird, es kann aber Gründe geben, warum dies unterbleibt. Entspricht dem Konformitätskriterium '''''[R ] 0..*]'''''.* KANN oder OPTIONAL (engl. MAY, OPTIONAL) Die Umsetzung der Anforderung ist optional, sie kann auch ohne zwingenden Grund unterbleiben. Entspricht dem Konformtätskriterium Konformitätskriterium '''''[O]'''''.
===Kardinalität===
Die Kardinalität beschreibt, wie oft ein Element innerhalb einer Struktur auftreten kann. Die Kardinalität wird durch ein Intervall zwischen der minimalen und maximalen Anzahl angegeben, getrennt durch "..". Eine unbegrenzte Anzahl wird durch ein "*" angegeben. Daraus ergeben sich mindestens folgende Möglichkeiten: 0..1; 0..*; 1..1; 1..* ==Legende der Optionalitäten=Umgang mit optionalen Elementen===Siehe auch Sind Elemente bzw. Attribute als "optional" gekennzeichnet ('''''[O]''''') so ist ihre Verwendung OPTIONAL, aber es ist NICHT ERLAUBT, dass sie, wenn sie verwendet werden, leer sind. Möchte man ein optionales Element explizit mit einem leeren Wert angeben, so hat dies durch Kennzeichnung mit '''''[[#Umgang_mit_optionalen_ElementenDer_nullFlavor|“Umgang mit optionalen Elementen“nullFlavor]]''''' zu erfolgen===Legende der Konformitätskriterien=======Optionalitäten von CDA-Elementen====
{| class="wikitable" width="100%"
|-
! style="text-align:left" width="15%" | Konformitäts-Kriterium ||style="text-align:left" width="15%" | Mögliche Kardinalität ||style="text-align:left" width="15%" | Verwendung von NullFlavor nullFlavor||style="text-align:left" width="55%" | Beschreibung|- style="background:#FFFFFF"| '''''[M]''''' || 1..1<br/> 1..* || ''nicht erlaubt'' || Das '''Element ''' MUSS mit einem korrekten "echten" Wert angegeben werden''("mandatory")''. NullFlavor <br />nullFlavor oder "Dummy"-Werte sind NICHT ERLAUBT.|- style="background:#FFFFFF"| '''''[NP]''''' || 0..0 || ''nicht erlaubt'' || Das '''Element ist i'''st NICHT ERLAUBT''("not permitted")''.|- style| rowspan="background:#FFFFFF2"| '''''[R]''''' || 1..1<br /> 1..* || ''erlaubt'' || Das '''Element ''' MUSS in der Instanz vorhanden sein''("required")''. Wenn ein Element nicht bekanntist, ist die Verwendung eines NullFlavors nullFlavors vorgeschrieben, "Dummy"-Werte sind NICHT ERLAUBT.|- style="background:#FFFFFF"| '''''[R]''''' || 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 seinund muss weggelassen werden. NullFlavor Ein nullFlavor ist daher NICHT ERLAUBT. Entspricht der in älteren Leitfäden gebräuchlichen Notation [R2] ''("required if known")''.|- style="background:#FFFFFF"| '''''[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. |- style="background:#FFFFFF"| '''''[FC]''''' || 1..1|| || Für das Element ist ein fixer Wert vorgeschrieben. |- style="background:#FFFFFF"| Die Optionalität des '''''[C]'Elements'''' || || || KONDITIONALES Konformitätskriterium. Die Konformität des Elements variiert in Abhängigkeit von anderen Elementen, Situationen oder Zuständen(''"conditional"''). Die konkreten Abhängigkeiten sind in Folge angegeben.
|-
|}
<ref group="Tabelle">Legende der Optionalitäten von Elementen</ref>:''Tabelle 2: Legende der Optionalitätenvon Elementen''
===Maximum=Optionalitäten von CDA-Attributen===={| class="wikitable" width="100%"|- ! style="text-align:left" width="15%" |Konformitäts-SetKriterium|| style="text-align:left" width="15%" |Mögliche Kardinalität|| style="text-align:left" width="55%" |Beschreibung|- |'''''[NP]'''''||0..0||Das '''Attribut''' ist NICHT ERLAUBT. ''("not permitted")''|-|'''''[R]'''''|1..1|Das CDA Modell beschreibt ein höchst umfangreiches Schema von Informationselementen und bietet '''Attribut''' MUSS in manchen Bereichen über rekursiveder Instanz vorhanden sein. ''("required")''|- |'''''[O]'''''||0..1||Das '''Attribut''' ist OPTIONAL. ''("optional")''|- |'''''[F]'''''||0..11..1|Wenn das '''Attribut''' angegeben wird, beliebig tief verschachtelbare Elemente eine theoretisch unendlich hohe Anzahl von Möglichkeiten, Informationen abzulegenist ein fixer Wert vorgeschrieben. Die vollständige Beschreibung und Definition aller Elemente in einem Implementierungsleitfaden wäre daher äußerst aufwändig und kann im vorliegenden Implementierungsleitfäden nicht erfolgen''("fixed")''Für das '''Attribut''' ist ein fixer Wert vorgeschrieben.''("fixed")''|-|}<ref group="Tabelle">Legende der Optionalitäten von Attributen</ref>:''Legende der Optionalitäten von Attributen''
Vielmehr werden lediglich jene Elemente, für die es Vorgaben gibt beschrieben. Die Verwendung aller nicht angegebenen Elemente und Attribute ist NICHT ERLAUBT. Die e-Impfpass Templates sind daher „closed templates“.===Der nullFlavor==={{BeginYellowBox}}Elemente oder AttributeDas Attribut @''nullFlavor'' dient zur Kennzeichnung, die dass ein Element nicht im e-Impfpass Implementierungsleitfaden definiert wurden, sind NICHT ERLAUBTseiner Entsprechung gemäß befüllt werden kann. {{EndYellowBox}}Diese beschreiben daher ein sogenanntes '''''„Maximum-Set“'Die konkrete Anwendung des @''nullFlavor''Attributs ist im Rahmen dieser Implementierungsleitfäden nur erlaubt, wenn er explizit in der Spezifikation eines Elementes angegeben ist. Für diese Regel existieren nur [[ILF:Allgemeiner_Implementierungsleitfaden_2020#Codierungs-Elemente|codierte Elemente]] ist ein nullFlavor für unbekannte und fehlende Information nach Möglichkeit zu vermeiden, bevorzugt ist die im Folgenden genannten Ausnahmen:Verwendung eines Codes mit demselben Informationsgehalt (etwa für "keine Allergie bekannt" das SNOMED Konzept 716186003 "No known allergy").
====AusnahmeBeispiel für ein Element, welches mit dem @''nullFlavor'' versehen wurde: Fixierte Attribute==<pre class="ILFgreen"><id nullFlavor="UNK" /></pre>Attribute, die gem. CDA-Schema mit default („fixed“) Wenn in einem Element ein nullFlavor angegeben sindwurde, haben einen festen Wert, daher können diese Attribute auch weggelassen werden. Diese Attribute kann nicht gleichzeitig ein anderes Attribut eingetragen werden daher üblicherweise nicht beschrieben und angegeben. Die Angabe von fixierten Attributen oder Attributen mit ihrem gem. CDA-Schema definierten Default-Wert ist erlaubt, auch wenn diese nicht explizit im Leitfaden beschrieben sind.
'''nullFlavor Beispiele''':{| class====Hinweis zur Implementierung weiterverarbeitender Software===="wikitable" |-! nullFlavor! displayName! Deutsche Übersetzung! Anwendung|-| '''NI'''| NoInformation| keine Information vorhanden| wenn es keine Informationen gibtCDA|-Dokumente können unter Umständen „fremde“ Elemente oder Attribute enthalten| '''UNK'''| Unknown| unbekannt| wenn es Informationen gibt, die der „Maximumdiese aber unbekannt sind|-Set“ Vorschrift dieses Dokumentleitfadens widersprechen | '''MSK'''| Masked| maskiert | wenn es Informationen gibt, diese aber nicht bekannt gegeben werden (z.B. aufgrund von Softwarevertraulich, nicht freigegeben)|-| '''NA'''| Not applicable| nicht anwendbar| wenn keine Codierung verfügbar ist|-| '''OTH'''| Other| Andere| wenn eine Codierung nur in einem alternativen Codesystem verfügbar ist|}<ref group="Tabelle">nullFlavor-Fehlern). Darüber hinaus können CDABeispiele aus Value-Set ELGA_nullFlavor</ref>: nullFlavor-Dokumente ebenfalls selbstBeispiele aus Value-definierte maschinenlesbare Elemente beinhalten.Set ELGA_nullFlavor
Sollten derartige Elemente oder Attribute im ===Maximum-Set===Das CDA-Dokument vorhanden seinModell beschreibt ein höchst umfangreiches Schema von Informationselementen und bietet in manchen Bereichen über rekursive, soll weiterverarbeitende Software so implementiert seinbeliebig tief verschachtelbare Elemente eine theoretisch unendlich hohe Anzahl von Möglichkeiten, dass dies 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 zu Fehlern in der Weiterverarbeitung der Dokumente führterfolgt.
====Umgang mit Ausnahmen bei der Konformitätsprüfung ====Nur 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 „Maximum[[#Datentypen|Kapitel Datentypen]] angegebenen Einschränkungen. Die ELGA Implementierungsleitfäden beschreiben daher ein sogenanntes '''''"Maximum-Set“ beschrieben Set"''''', Die ELGA Templates sind, können zuverlässig geprüft werdendemnach als "closed templates" entsprechend dem HL7 Templates Standard zu betrachten. „Fremde“ {{BeginYellowBox}}Elemente oder Attribute<sup>4</sup> werden daher von den Konformitätsprüfmechanismen im Sinne der „closed templates“ grundsätzlich als falsch erkannt. Selbst , die genannten Ausnahmen, v.a. zusätzliche Entries nicht vom Allgemeinen oder TemplateIdseinem speziellen ELGA-Implementierungsleitfaden definiert wurden, können daher falsche Fehlermeldungen auslösensind NICHT ERLAUBT. Diese {{EndYellowBox}}====Ausnahmen sollten entsprechend ====Für diese Regel existieren nur, wenn unbedingt notwendig und mit Vorsicht eingesetzt werden.die im Folgenden genannten Ausnahmen:
=====Ausnahme: "templateId"=====
''templateId''-Elemente KÖNNEN bei Bedarf an allen laut CDA-Schema möglichen Stellen verwendet werden. Wenn bereits templateId-Elemente laut Spezifikation vorgeschrieben sind, KÖNNEN beliebig viele weitere ''templateId''-Elemente angegeben werden.
<sup>4</sup>=====Ausnahme: Fixierte Attribute=====Attribute, die im gem. CDA-Schema als „fixed“ definiert mit "fixed" angegeben sind , haben einen festen Wert, daher können diese Attribute auch weggelassen werden. Diese Attribute werden daher üblicherweise nicht beschrieben und angegeben. Die Angabe von fixierten Attributen oder Attributen mit ihrem gem. CDA-Schema definierten Default-Wert angegeben sindist erlaubt, dürfen angegeben werden und werden auch wenn diese nicht als Fehler bewertetexplizit im Leitfaden beschrieben sind.
===Umgang mit optionalen Elementen==Explizit angegebene Ausnahmen=====Sind Elemente bzw. Attribute Im speziellen Implementierungsleitfaden KÖNNEN bestimmte Sektionen als „optional“ gekennzeichnet ('''''[O]''''') so ist ihre Verwendung OPTIONAL, aber es ist NICHT ERLAUBT, dass sie, wenn sie verwendet "offene Templates" definiert werden, leer sindund Ausnahmen für Subsektionen und Entries zulassen. Möchte man ein optionales Element explizit mit einem leeren Wert angeben, so hat dies durch Kennzeichnung mit '''''[[#Der_nullFlavor|nullFlavor]]''''' zu erfolgen, zum Beispiel:* '''NI''': wenn es keine Informationen gibt* '''UNK''': wenn es Informationen gibt, diese aber unbekannt sind
Zur genauen Definition und Verwendung siehe [[#Der_nullFlavor|Der nullFlavor]]====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.
===ELGA 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).
Beispiele für ELGA Value-Sets: „ELGA_NullFlavor“"ELGA_NullFlavor", „ELGA_Dokumentenklassen“"ELGA_Dokumentenklassen".
Wo immer in den ELGA 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 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.
Hinweise zum korrekten Umgang mit Terminologien finden sich im „Leitfaden "Leitfaden für den Umgang mit Terminologien in ELGA“ ELGA" [TERMLEIT].
====Ä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“"Gültig ab"-Datum (effectiveDate) 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“"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“"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.
 
 
===PDF Format-Vorschrift===
PDF-Attachments kommen im e-Impfpass nicht zur Anwendung.
<!-- 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}}
Alle in ELGA-CDA-Dokumente eingebetteten PDF-Dateien MÜSSEN dem Standard PDF/A-1a (gemäß „ISO "ISO 19005-1:2005 Level A conformance“conformance") entsprechen.
{{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===
In CDA Dokumenten können verschiedene Objekte (z.B. PDF-Dokumente, Bilder) eingebettet werden (siehe "[[ILF:Allgemeiner Implementierungsleitfaden#ELGA_EingebettetesObjekt-EntryEingebettetes_Objekt_Entry|ELGA EingebettetesObjekt-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.
{{BeginYellowBox}}
Damit beim Download keine unnötigen Verzögerungen verursacht werden, SOLL die Gesamtgröße der Datei 20 MB nicht überschreiten.<sup>6</sup>
 {{EndYellowBox}}
<sup>6</sup> Aktuell wird von ELGA die Größe von Doumenten auf 20MB beschränkt.
 
===Der nullFlavor===
Das Attribut @''nullFlavor'' dient zur Kennzeichnung, wenn das Element nicht seiner Entsprechung gemäß befüllt werden kann.
 
Obwohl dieses Attribut vom CDA-Schema bei prinzipiell jedem CDA-Element erlaubt wäre, ist die konkrete Anwendung des @''nullFlavor'' Attributs im Rahmen dieser Implementierungsleitfäden nur eingeschränkt erlaubt. Ein entsprechender Vermerk ist im jeweiligen Abschnitt angeführt.
 
Beispiel für ein Element, welches mit dem @''nullFlavor'' versehen wurde:
{{BeginOrangeBox}}
<id nullFlavor="'''UNK'''" />
{{EndOrangeBox}}
Zulässig sind Werte gemäß Value-Set „'''ELGA_NullFlavor'''“, solange nicht eine weitere Einschränkung beim jeweiligen Element angegeben wird.
 
Wenn in einem Element ein NullFlavor angegeben wurde, kann nicht gleichzeitig ein anderes Attribut eingetragen werden.
===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'''.
1.104
Bearbeitungen

Navigationsmenü