Änderungen

Wechseln zu: Navigation, Suche

ILF:EImpfpass Allgemeine Richtlinien

2.028 Bytes hinzugefügt, 08:15, 15. Sep. 2020
K
Allgemeine Richtlinien für die Implementierung des e-Impfpasses
==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..*]''''' und '''''[M]'''''.* 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 Konformitätskriterium '''''[O]'''''.
===Legende Kardinalität===Die Kardinalität beschreibt, wie oft ein Element innerhalb einer Struktur auftreten kann. Die Kardinalität wird durch ein Intervall zwischen der Konformitätskriterien (Optionalität)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..* ===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 oder Attribut ist i'''st NICHT ERLAUBT''("not permitted")''.|- style="background:#FFFFFF"| rowspan="2" | '''''[R]''''' || 1..1<br /> 1..* || ''erlaubt'' || Das '''Element oder Attribut ''' MUSS in der Instanz vorhanden sein''("required")''. Wenn ein Element nicht bekannt ist, ist die Verwendung eines NullFlavors nullFlavors vorgeschrieben, "Dummy"-Werte sind NICHT ERLAUBT.|- style="background:#FFFFFF"| 0..1<br /> 0..* || ''nicht erlaubt'' || Das '''Element oder Attribut ''' 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 oder Attribut ''' ist OPTIONAL ''("optional")''. Sender können das Element angeben. Leere optionale Elemente sind nicht zugelassen, sofern kein nullFlavor angewandt wird. Nur die jeweils im Template explizit angegebenen nullFlavors sind erlaubt. Ist kein nullFlavor angegeben, darf kein nullFlavor angewendet werden.|- style="background:#FFFFFF"| '''''[FC]''''' || 0..1<br /> 1..1|| || Für das Attribut 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>:''Legende der Optionalitäten von Elementen'' ====Optionalitäten von CDA-Attributen===={| 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="55%" |Beschreibung|- |'''''[NP]'''''||0..0||Das '''Attribut''' ist NICHT ERLAUBT. ''("not permitted")''|-|'''''[R]'''''|1..1|Das '''Attribut''' MUSS in der Instanz vorhanden sein. ''("required")''|- |'''''[O]'''''||0..1||Das '''Attribut''' ist OPTIONAL. ''("optional")''|- |'''''[F]'''''||0..11..1|Wenn das '''Attribut''' angegeben wird, ist ein fixer Wert vorgeschrieben. ''("fixed")''Für das '''Attribut''' ist ein fixer Wert vorgeschrieben. ''("fixed")''|-|}<ref group="Tabelle 2">Legende der Optionalitäten von Attributen</ref>: ''Legende der Optionalitätenvon Attributen'' ===Der nullFlavor===Das Attribut @''nullFlavor'' dient zur Kennzeichnung, dass ein Element nicht seiner Entsprechung gemäß befüllt werden kann. 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 [[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 Verwendung eines Codes mit demselben Informationsgehalt (etwa für "keine Allergie bekannt" das SNOMED Konzept 716186003 "No known allergy"). Attribute dürfen höchstens  Beispiel für ein mal pro Element vorkommen, welches mit dem @''nullFlavor'' versehen wurde:<pre class="ILFgreen"><id nullFlavor="UNK" /></pre>Wenn in einem Element ein nullFlavor angegeben wurde, kann nicht gleichzeitig ein anderes Attribut eingetragen werden.
'''nullFlavor Beispiele''':{| class===Kardinalität==="wikitable" |-! nullFlavor! displayName! Deutsche Übersetzung! Anwendung|-| '''NI'''| NoInformation| keine Information vorhanden| wenn es keine Informationen gibt|-| '''UNK'''| Unknown| unbekannt| wenn es Informationen gibt, diese aber unbekannt sind|-| '''MSK'''| Masked| maskiert Die Kardinalität beschreibt| wenn es Informationen gibt, wie oft ein Element innerhalb einer Struktur auftreten kann. Die Kardinalität wird durch ein Intervall zwischen der minimalen und maximalen Anzahl angegebendiese aber nicht bekannt gegeben werden (vertraulich, getrennt durch „..“. Eine unbegrenzte Anzahl wird durch ein „*“ angegeben. Daraus ergeben sich mindestens folgende Möglichkeitennicht 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-Beispiele aus Value-Set ELGA_nullFlavor</ref>: 0..1; 0..*; 1..1; 1..*nullFlavor-Beispiele aus Value-Set ELGA_nullFlavor
===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 kann im vorliegenden Implementierungsleitfaden ist in den ELGA Implementierungsleitfäden nicht erfolgenerfolgt.
Vielmehr werden beschreiben die ELGA Implementierungsleitfäden lediglich jene Elemente, für die es Vorgaben gibt beschriebenerlaubt 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 eELGA Implementierungsleitfäden beschreiben daher ein sogenanntes '''''„Maximum-Impfpass Set“''''', Die ELGA Templates sind daher demnach als „closed templates“entsprechend dem HL7 Templates Standard zu betrachten.
{{BeginYellowBox}}
'''Elemente oder Attribute, die nicht im evom Allgemeinen oder einem speziellen ELGA-Impfpass Implementierungsleitfaden definiert wurden, sind NICHT ERLAUBT.'''
{{EndYellowBox}}
Diese beschreiben daher ein sogenanntes '''''„Maximum-Set“'''''. Für diese Regel existieren nur die im Folgenden genannten Ausnahmen:
====Ausnahme: Fixierte AttributeAusnahmen====Attribute, Für diese Regel existieren nur die gem. CDA-Schema mit default („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 ist erlaubt, auch wenn diese nicht explizit im Leitfaden beschrieben sind.Folgenden genannten Ausnahmen:
====Hinweis zur Implementierung weiterverarbeitender Software=Ausnahme: „templateId“=====CDA''templateId''-Dokumente können unter Umständen „fremde“ Elemente oder Attribute enthalten, die der „MaximumKÖNNEN bei Bedarf an allen laut CDA-Set“ Vorschrift dieses Dokumentleitfadens widersprechen (zSchema möglichen Stellen verwendet werden.B. aufgrund von SoftwareWenn bereits templateId-Fehlern). Sollten derartige Elemente oder Attribute im CDAlaut Spezifikation vorgeschrieben sind, KÖNNEN beliebig viele weitere ''templateId''-Dokument vorhanden sein, soll weiterverarbeitende Software so implementiert sein, dass dies nicht zu Fehlern in der Weiterverarbeitung der Dokumente führtElemente angegeben werden.
====Umgang mit Ausnahmen bei der Konformitätsprüfung =Ausnahme: Fixierte Attribute=====Nur ElementeAttribute, die im „Maximumgem. CDA-Set“ beschrieben Schema mit „fixed“ angegeben sind, haben einen festen Wert, daher können zuverlässig geprüft diese Attribute auch weggelassen werden. „Fremde“ Elemente oder Diese Attribute werden daher üblicherweise nicht beschrieben und angegeben. Die Angabe von den Konformitätsprüfmechanismen im Sinne der „closed templates“ grundsätzlich als falsch erkannt. Zusätzliche Entries fixierten Attributen oder TemplateIds können daher Fehlermeldungen auslösenAttributen mit ihrem gem. Attribute, die im CDA-Schema als „fixed“ definiert sind oder mit ihrem 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 bzwIm speziellen Implementierungsleitfaden KÖNNEN bestimmte Sektionen als "offene Templates" definiert werden und Ausnahmen für Subsektionen und Entries zulassen. Attribute als „optional“ gekennzeichnet ( '''''[O]''↔ Hinweis zum XDS-Mapping:'''Beim XDS-Attribut XDSDocumentEntry.formatCode muss ein zusätzliches Plus-Zeichen („+“) so ist ihre Verwendung OPTIONAL, aber es ist NICHT ERLAUBT, dass sieam Ende des Strings hinzugefügt werden, wenn sie verwendet werden, leer in einem Dokument selbst-definierte maschinenlesbare Elemente vorhanden sind. Möchte man ein optionales Element explizit mit einem leeren Wert angeben, so hat dies durch Kennzeichnung mit '''''<br/>Beispiel: urn:elga:lab:2011:EIS_FullSupport+<br/>Siehe dazu die entsprechende Regelung im Leitfaden „[[ILF:XDS Metadaten#Der_nullFlavorZusatz_bei_selbst-definierten_maschinenlesbaren_Elementen_.28Dokumente_in_EIS_.E2.80.9EEnhanced.E2.80.9C_oder_.E2.80.9EFull_Support.E2.80.9C.29|nullFlavorELGA XDS Metadaten (XDSDocumentEntry)“, [OID Root 1.2.40.0.34.7.6], Kapitel Zusatz bei selbst-definierten maschinenlesbaren Elementen (Dokumente in EIS „Enhanced“ oder „Full Support“]]''''' zu erfolgen, zum Beispiel:). * '''NI''': wenn es keine Informationen gibt=====Hinweis zur Implementierung weiterverarbeitender Software=====* '''UNK''': wenn es Informationen gibtCDA-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, diese aber unbekannt sinddass dies nicht zu Fehlern in der Weiterverarbeitung der Dokumente führt.
Zur genauen Definition und Verwendung siehe [[#Der_nullFlavor|Der nullFlavor]].
===Value Sets===
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.
 
===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.
2.168
Bearbeitungen

Navigationsmenü