1.119
Bearbeitungen
Änderungen
→Publikation der Value Sets am Terminologieserver
==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 '''''[RM]''''' 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 '''''[R2R]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"| '''''[R2]''''' || 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"| '''''[C]''''' || || || KONDITIONALES Konformitätskriterium. Die Konformität Optionalitä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-Kriterium|| style="text-Setalign: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 ''("fixed")''Für das '''Attribut''' ist in den ELGA Implementierungsleitfäden nicht erfolgtein fixer Wert vorgeschrieben.''("fixed")''|-|}<ref group="Tabelle">Legende der Optionalitäten von Attributen</ref>:''Legende der Optionalitäten von Attributen''
'''AchtungnullFlavor Beispiele''':{| class="wikitable" |-! nullFlavor! displayName! Deutsche Übersetzung! Anwendung|-| '''NI'''| NoInformation| keine Information vorhanden| wenn es keine Informationen gibt|-| '''UNK''' Für bereits | Unknown| unbekannt| wenn es Informationen gibt, diese aber unbekannt sind|-| '''MSK'''| Masked| maskiert | wenn es Informationen gibt, diese aber nicht bekannt gegeben werden (vertraulich, nicht freigegeben)|-| '''NA'''| Not applicable| nicht anwendbar| wenn keine Codierung verfügbar ist|-| '''OTH'''| Other| Andere| wenn eine Codierung nur in Implementierungsleitfäden definierte Entries gilt jedoch die Regelung des „Maximum-Sets“! Ihre Erweiterung oder Veränderung einem alternativen Codesystem verfügbar ist NICHT ERLAUBT.{{EndYellowBox}|}Diese Ausnahmeregelung soll eine erweiterte Nutzung der CDA<ref group="Tabelle">nullFlavor-Beispiele aus Value Set ELGA_NullFlavor</ref>: nullFlavor-Dokumente ermöglichen und Innovationen bei der Weiterentwicklung der Spezifikationen zu fördernBeispiele aus Value Set [https://termgit.elga.gv.at/ValueSet/elga-nullflavor ELGA_NullFlavor]
{{BeginYellowBox}}
{{EndYellowBox}}
=====Ausnahme: „templateId“"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.
=====Ausnahme: Verfasser von CDA-SektionenFixierte Attribute=====Der Verfasser von Sektionen KANN mittels des Elements „''author''“ innerhalb einer Sektion („''section''“Attribute, die gem. CDA-Element) abgebildet Schema mit "fixed" angegeben sind, haben einen festen Wert, daher können diese Attribute auch weggelassen werden. Diese „''author''“-Elemente sind bei Bedarf OPTIONAL bei allen CDA-Sektionen zusätzlich zu verwenden, sofern die Spezifikation der Sektion dies Attribute werden daher üblicherweise nicht explizit ausschließt. Siehe auch ''„[[#Sektionen|Sektionen]]“''beschrieben und angegeben. ====Ausnahme: Zusätzliche weitere Beteiligte====Die möglichen Arten für die Dokumentation Angabe von wichtigen beteiligten Personen fixierten Attributen oder Organisationen (zAttributen mit ihrem gem.B. Angehörige, Verwandte, Versicherungsträger, etc.) sind in diesem Leitfaden in [[#Weitere_Beteiligte_.28.E2.80.9Eparticipant.E2.80.9C.29|Weitere Beteiligte („participant“)]] definiert. Es CDA-Schema definierten Default-Wert ist daher NICHT ERLAUBTerlaubt, darüberhinausgehende Arten von Beteiligten anzugeben, ausgenommen die entsprechende Art von Beteiligten ist in einem speziellen Implementierungsleitfaden auch wenn diese nicht explizit definiertim Leitfaden beschrieben sind.
====Ausnahme: Fixierte Attribute=Explizit angegebene Ausnahmen=====Attribute, die gem. CDA-Schema mit „fixed“ angegeben sind, haben einen festen Wert, daher können diese Attribute auch weggelassen Im speziellen Implementierungsleitfaden KÖNNEN bestimmte Sektionen als "offene Templates" definiert 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 ist erlaubt, auch wenn diese nicht explizit im Leitfaden beschrieben sindAusnahmen für Subsektionen und Entries zulassen.
====Hinweis zur Implementierung weiterverarbeitender Software====
CDA-Dokumente können unter Umständen „fremde“ "fremde" Elemente oder Attribute enthalten, die der „Maximum"Maximum-Set“ Set" Vorschrift dieses Dokumentleitfadens Leitfadens widersprechen (z.B. aufgrund von Software-Fehlern). Darüber hinaus können 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 ebenfalls selbst-definierte maschinenlesbare Elemente beinhaltenführt.
====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).
====Ä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 Alle ValueSets, die für ein CDA des Implementierungsleitfadens verwendet werden, sollen periodisch gemeinsam aktualisiert werden Versionsnummer. Das Datum, an dem die lokal zur Implementierung verwendeten Value Sets mit dem österreichischen Terminologieserver abgeglichen wurden, Änderungsdatum und „Gültig ab“wird im Terminologiedatum-Header-Datum (effectiveDate) 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).
====Terminologiedatum====Das Datum, an dem sämtliche lokal zur Implementierung verwendeten Value Sets können auch STATISCH an ein Code-mit dem österreichischen Terminologieserver abgeglichen wurden, wird über das "Terminologiedatum" angegeben: Dieses Datum wird in der Notation "YYYYMMDD" im eigenen Element gebunden werden"terminologyDate" angegeben. Das wird gekennzeichnet durch die Angabe des Beim Abgleich der Terminologien müssen immer alle Value Sets mit Name, OIDdie 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 "Gültig ab"-Datum (effectiveDate) sowie dem Schlüsselwort STATICMÜSSEN vermieden werden.
===PDF Format-Vorschrift===
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-1a 1b bzw. PDF/A-3b entsprechen MUSS<sup>5<sup>. Im Sinne der Barrierefreiheit ist die Umsetzung von PDF/A-1a bzw. PDF/A-3a EMPFOHLEN.
{{BeginYellowBox}}
Alle in ELGA-CDA-Dokumente eingebetteten PDF-Dateien MÜSSEN dem Standard PDF/A-1a 1b bzw. PDF/A3-b (gemäß „ISO "ISO 19005-1:2005 Level A conformance“conformance") entsprechen. Die Umsetzung von PDF/A-1a bzw. PDF/A-3a ist EMPFOHLEN.
{{EndYellowBox}}
===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 Dokumente 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 des CDA-Dokuments 20 MB nicht überschreiten.<sup>6</sup> <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:{{BeginOrangeBoxEndYellowBox}}<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'''.