Governance für die CDA-Leitfadenerstellung (Version 1)

Aus HL7 Austria MediaWiki
Wechseln zu: Navigation, Suche 


Governance für die CDA-Leitfadenerstellung mit Art-Decor und Mediawiki
Version: 1.1.1+20230503
Status: Final



1 Einleitung

Dieses Dokument enthält Richtlinien zur Erstellung von CDA-Implementierungsleitfäden mit Art-Decor® und Mediawiki und anderen Werkzeugen in Österreich.

Diese Richtlinien entstanden in Zusammenarbeit mit der ELGA GmbH und beruhen auf den bisher gemachten Erfahrungen in der Leitfadenerstellung.

Weiters werden die notwendigen Verantwortlichkeiten und Prozesse definiert, um klare Strukturen für die Zusammenarbeit zwischen Art-Decor®, Wiki und anderen Werkzeugen zu gewährleisten. Dies umfasst die Verantwortung für Art-Decor Repositories, Qualitätssicherung und den Support der Tools.

2 Anwendungsbereich

Das Dokument geht nicht auf die Modellierung von HL7 CDA-Dokumenten ein, sondern beschreibt den Einsatz der Tools für Österreich. Es definiert Regeln und Strukturen, die von allen Anwendern dieser Werkzeuge eingehalten werden müssen.

3 Weiterentwicklung des Dokuments

Dieses Dokument enthält die aktuellen Festlegungen bezüglich der Arbeit mit Art-Decor®, Mediawiki und weitere Werkzeuge in Österreich und wird laufend angepasst.

Wichtiger Hinweis: Anfragen hinsichtlich der Änderung oder Erweiterung dieses Dokuments stellen Sie bitte an office@hl7.at.

4 Governance für die CDA-Leitfadenerstellung

Die folgenden Vorgaben sind verpflichtend einzuhalten. Empfehlungen werden entsprechend markiert. Die Reihenfolge der Kapitel soll eine übliche Vorgehensweise darstellen, jedoch ist die Reihenfolge selbst nicht verpflichtend einzuhalten.

4.1 Governance Groups

Governance-Gruppen sind organisatorische Einheiten, die dazu dienen, die Verantwortung für Artefakte (Templates und Value Sets) in Art-Decor darzustellen. Unter der ELGA Art-Decor Governance Group sind alle Projekte der ELGA sichtbar, sowie alle angelegten Artefakte mit OID, Displayname, Artefaktstatus, BBR und Repositories), z.B. "at-cda-brr"-Projekte, die das Template oder Value Set referenzieren. Weiters existiert die HL7 Austria Art Decor Governance Group, welche alle eHealth Austria Vorgaben umfasst. Dabei wird die hier beschriebene ELGA Governance auch für die HL7 Austria relevant und soll von dieser übernommen werden. 

4.2 Implementierungsleitfaden (inkl. Wiki)

ELGA Implementierungsleitfäden werden in deutscher Sprache verfasst. Dazu gehören textuelle Beschreibungen im Wiki, Art-Decor-Templates und Art-Decor-Datasets. Ausnahmen gelten bei der Benennung von Templates (siehe #Name).

eHealth Implementierungsleitfäden können auch in englischer Sprache verfasst werden.

Wichtige Informationen hinsichtlich der technischen Erstellung eines CDA-Leitfadens mit Mediawiki sind unter Leitfaden erstellen mit Mediawiki nachzulesen.

Die Einbindung eines neuen Leitfadens folgt einem vorgegebenen Prozess, dieser ist ersichtlich unter Benutzung von Flagged Revisions.

4.2.1 Name

Der Name eines Leitfadens wird wie folgt angegeben:

  • HL7 Austria & ELGA
  • HL7 CDA® R2 Implementierungsleitfaden
  • [Titel]
  • OID: [OID]


Beispiel:

HL7 Austria & ELGA

HL7 CDA® R2 Implementierungsleitfaden

Labor- und Mikrobiologiebefund

OID: 1.2.40.0.34.7.4.9.3

4.2.2 OID

Im Zusammenhang mit der Verwendung von OID sind die österreichischen Richtlinien einzuhalten (siehe Object Identifier (OID) Konzept für das österreichische Gesundheitswesen). Das österreichische OID Portal ist zu finden unter OID Portal Österreich.

Für jeden Implementierungsleitfaden muss über das OID-Portal eine Dokumentenklassen-OID unterhalb des Knotens 1.2.40.0.34.7 (eHealth-Austria/documents) registriert werden.

Für die Verwaltung der Hauptversionen muss darunter eine zusätzliche Ebene angelegt werden.

Beispiel:

  • 1.2.40.0.34.7.18: Dokumentenklassen-OID des Implementierungsleitfadens "Meldung von antimikrobieller Resistenzen"
    • OID wird im OID-Portal beantragt (Root-Knoten aller Versionen des entsprechenden Leitfadens)
  • 1.2.40.0.34.7.18.1: Implementierungsleitfaden Meldung von antimikrobieller Resistenzen, Version 1
    • OID des PDF-Leitfadens (Titelblatt)
    • wird im DLT als templateId[2] als informative Referenz angegeben
    • Hauptversionen verlangen eine neue Verordnung durch das BM*G
    • OID wird ebenfalls im OID-Portal beantragt

Die Leitfaden-OID von Nebenversionen ändert sich nicht. Die Version des Leitfadens ist im Leitfadentitel (Wiki) bzw. auf dem Titelblatt (PDF) und dem Versionlabel des DLT ersichtlich. Siehe Versionierung.

4.2.3 Version & Metadaten

Der Verwendung von Namespaces ist wesentlich für Versionierung der Wiki-Seiten mit Flagged Revisions.

Wichtiger Hinweis: Alle Seiten von CDA-Leitfäden müssen im Namespace ["ILF"] erstellt werden.

Das Wiki-Leitfadenprojekt DARF NICHT unabhängig vom ART-DECOR-DLT versioniert werden, siehe Versionierung.

Alle Hauptversionen und Nebenversionen eines Leitfadens sind als Wiki verfügbar. In der "Lese-Ansicht ist die publizierte Version ersichtlich, aktuelle (noch nicht freigegebene) Überarbeitungen/Änderungen sind der "Revisions-Ansicht" zu entnehmen. Zum Zeitpunkt der Publikation (z.B. Ballotversion / Publikation neue Haupt- oder Nebenversion) wird die Hauptseite des Leitfadens von einer berechtigten Person als "abgenommen" markiert (siehe dazu Versionierung von Wiki-Seiten), sodass die "Revisions"-Ansicht in die stabile "Leseansicht" übernommen wird. Die "Leseansicht" bleibt unverändert, bis eine neue Version des Leitfadens abgenommen wird.

Alle veröffentlichten Leitfadenversionen sind zusätzlich zum Wiki als PDF verfügbar (Anleitung siehe PDF-Generierung). Eine Übersicht der Versionen eines Leitfadens findet sich im jeweiligen Guide (alle vorhandenen Guides sind zu finden unter Übersicht der CDA Implementierungsleitfäden.

4.2.4 Inhalt

Der Inhalt eines Implementierungsleitfadens besteht üblicherweise aus den Kapiteln:

1 Zusammenfassung
2 Informationen über dieses Dokument
2.1 Impressum
2.2 Haftungsausschluss
2.3 Sprachliche Gleichbehandlung
2.4 Lizenzinformationen
2.4.1 Urheber- und Nutzungsrechte von anderen Quellen ("Third Party IP")
2.4.2 SNOMED CT
2.4.3 Weitere Terminologien
2.5 Verwendete Grundlagen und Bezug zu anderen Standards
2.6 Verbindlichkeit
2.7 Wichtige unterstützende Materialien
2.8 Bedienungshinweise
2.8.1 Farbliche Hervorhebungen und Hinweise
2.8.2 PDF-Navigation
3 Begriffsdefinitionen
4 Einleitung
4.1 Ausgangslage und Motivation
4.2 Zweck des Dokuments
4.3 Zielgruppe
5 Leitfadenerstellungs- und Harmonisierungsprozess
5.1 Revision der Leitfäden
5.2 Autoren und Mitwirkende
5.2.1 Autoren
5.2.2 Mitwirkende
6 Technischer Hintergrund
7 Allgemeine Richtlinien für ELGA CDA-Implementierungsleitfäden
8 Funktionale Anforderungen
8.1 Voraussetzungen für den Zugriff auf e-Befunde in ELGA
8.2 Anwendungsfälle des Dokumentenmanagements
8.2.1 Dokument-Metadaten (XDS-Metadaten)
9 Konformitätsprüfung
10 Datentypen
11 Vorgaben zum medizinischen Inhalt
12 Anwendungsfälle / User Stories
13 Dataset
14 Technische Spezifikation
14.1 Übersicht CDA Strukturen (Header & Body)
(evtl. Übersichtstabelle der Header-Elemente für dokumenten-relevante Zeitpunkte/Zeitspannen)
14.2 CDA Templates
14.2.1 Document Level Templates
14.2.2 Header Level Templates (Hinweis: hier sollten nur jene Header Level Templates aufgeführt werden, die für spezielle Leitfäden erstellt / adaptiert wurden. Alle anderen werden als Teil der DLTs angezeigt)
14.2.3 Section Level Templates
14.2.4 Entry Level Templates
14.2.5 Weitere CDA Fragmente
14.3 Terminologien
15 Anhang
(15.1 evtl. Abkürzungsverzeichnis)
15.2 Abbildungsverzeichnis
15.2 Tabellenverzeichnis
15.3 Einzelnachweise
15.4 Literatur und Weblinks
15.5 Revisionsliste
15.6 Erratum


Bei Kapiteln ohne Inhalt soll kurz darauf eingegangen werden, warum dieser Leitfaden dieses Kapitel nicht füllt.

Aufgrund bisheriger Erfahrungen wird nicht empfohlen, Textabschnitte in Teildokumente (eigene Wiki-Seiten) auszulagern und zu transkludieren, da Änderungen an dem Teildokument automatisch in alle transkludierenden Wiki-Leitfäden übernommen werden und einer Abstimmung mit den Leitfadenverantwortlichen bedürfen. Weiters ist beim Bearbeiten eines Seitenabschnittes nur im Seitenlink bzw. unter Menüpunkt "Links auf diese Seite" ersichtlich, ob man sich auf der Hauptseite des eigenen Leitfadens oder auf einer bereits transkludierten Seite befindet, was die Gefahr eines unbeabsichtigten Änderns anderer bestehender Leitfäden erhöht.

Ausnahmen bilden folgende Seiten, welche transkludiert werden können, aber nicht bearbeitet werden dürfen (liegen in der Obhut des Allgemeinen Leitfadens):

  • ILF:Lizenzinformationen

Für die Kapitel Section Level Templates, Entry Level Templates und Weitere CDA Fragmente in speziellen Leitfäden gilt, dass für Templates, die im Allgemeinen Implementierungsleitfaden spezifiziert sind, eine einfache Referenz auf den Allgemeinen Implementierungsleitfaden ausreicht. Dabei MUSS aber angegeben werden, um welche Hauptversion des Allgemeinen Leitfaden es sich handelt.

5 Art-Decor Projekt

Ein neuer CDA-Leitfaden muss in einem eigenen Projektverzeichnis angelegt, alle Autoren müssen entsprechend berechtigt werden. Dies muss beim Art-Decor-Support beantragt werden.

Das neue Projekt kann am besten mit folgendem E-Mail-Template beantragt werden:

Dear Art-Decor-Support,

we would like to ask you to create a new project in Art-Decor:

  • Name: <displayName des Projekts>
  • Prefix: <Projektkürzel - soll immer mit at- beginnen, z.B. "at-emed-" oder "at-lab-" (Vorweg: an bestimmten Stellen werden Bindestriche durch das System ausgeblendet)>
  • ContainsReusableContent=false
  • Experimental/Test=false
  • defautLanguage=de
  • id=1.2.40.0.34.777.<nächste freie ID, siehe Kapitel OID>
  • Governance-Groups: ELGA, HL7 Austria
  • Wiki-Bot activated à wiki.hl7.at
Thank you in advance.


Eine Liste der Art-Decor Projekte ist unter der HL7-Austria Governance Group verfügbar ELGA Art-Decor Governance Group.

Weitere offizielle Informationen sind unter ART Project Editor zu finden.

5.1 Name

Der Name des Projekts, auch displayName des Projekts genannt, soll sprechend gewählt werden und ist mit dem ELGA SCC Team abzusprechen.

Dies gilt auch für das Prefix, auch Projektkürzel genannt. Dabei soll dieses keine Bindestriche enthalten, z.B. "elgatest".

5.2 OID

Alle Art-Decor Projekte bekommen die unter (Governance Group (art-decor.org) -> Projects) einsehbaren OID mit der nächste ID im 1.2.40.0.34.777 Knoten.

5.3 Version & Metadaten

Projekte selbst werden nicht versioniert. Nur die beinhaltenden DLT werden versioniert.

Projektkürzel unter "prefix" werden im lowercase geschrieben, ohne jegliche Trennzeichen. Bsp.: "elgatgd".

Neue Projekte dürfen keine bbr sein! Die Checkbox Image2021-6-24 13-41-12.png darf nicht angehackt sein!

Es wird empfohlen dem Projekt standardmäßig Referenzen zu den Building Block Repositories ad1bbr-, ad2bbr-, at-cda-bbr-, IHE-PCC- hinzuzufügen (siehe auch Reference a building block repository).

5.4 Inhalt

In Österreich kann derzeit folgendes bereichsspezifische Building Block Repository (BBR) für die Ableitung oder Referenzierung von Templates verwendet werden:

Dies soll in Zukunft alle für Österreich relevanten Basis-Templates enthalten, die für spezifische Anwendungen (eHealth und ELGA) in die einzelnen Projektverzeichnisse abgeleitet werden können.

Das at-cda-bbr wird laufend mit neuen Templates erweitert. Nach Fertigstellung eines neuen CDA-Leitfadens sollen weiter zu verwendete Templates in dieses Verzeichnis übernommen werden. Die im at-cda-bbr befindlichen Templates dürfen nur von einem eingeschränkten Benutzerkreis bearbeitet werden.

5.4.1 Statuswechsel eines Templates

In einem Repository werden Artefakte (Templates/Value Sets) zunächst im Status "Entwurf" erstellt. Der Status eines Artefakts im Repository kann gemäß den Regeln der hier beschriebenen Governance geändert werden (siehe "Changing the status of a template").

Kyellow.png
 Entwurf: Das Template verbleibt bis zur Veröffentlichung im Status „Entwurf“ und ist bearbeitbar.
Kgreen.png
 Aktiv: Gültiges Template, dessen Inhalt nicht mehr verändert werden kann. Zum Bearbeiten (Entwurf) muss das Template eine neue Version bekommen.
Kdeprecblue.png
 Veraltet: Aktive Templates, die nicht mehr verwendet werden sollen, können in den Status „veraltet“ versetzt werden. Dieser Status ist endgültig.
TemplateStatuswechsel2021-9-22.png Beschreibung Statuswechsel eines Templates (Diagramm)

1. Bevor ein Template neu angelegt wird, soll überprüft werden, ob ein verwendbares Dummy-Template(*) vorhanden ist. Ein neues Template erhält immer Version 1.0.0 und hat den Status "Entwurf".

2. Nach erstmaliger Erstellung eines Templates oder nach Durchführung von Major- oder Minor-Änderungen, muss vor der Publikation ("Aktiv-Setzung" des Templates) ein Ballotverfahren durchgeführt werden. (Der Status "Revision vor Publikation" kann verwendet werden, um anzuzeigen, dass eine Publikation bevorsteht. Vom Status "Revision vor Publikation" kann in den Stauts "Aktiv" gewechselt werden.)

3. Wurde ein Ballotverfahren durchgeführt, erfolgt der Template-Statuswechsel zu "Aktiv" zum Publikationszeitpunkt des Leitfadens. Wird ein Template "Aktiv" gesetzt, wird die bestehende Versionsnummer im Version-Label mit dem Publikationsdatum ergänzt (z.B. 1.0.0+20210504, siehe [Versionierung). (Der Status "Revision nach Publikation" kann verwendet werden, um anzuzeigen, dass eine neue Version vorbereitet wird. Vom Status "Revision nach Publikation" kann man wieder in den "Aktiv" Status wechseln.)

4. Solange keine Änderungen an dem Template durchgeführt werden müssen, werden verbleibt es im Status "Aktiv".

5. Ist das Template veraltet oder wird es durch ein neues ersetzt, muss der Status auf "veraltet" gesetzt werden (6.). Dieser Status ist unveränderbar (Status endgültig). Veraltete Templates, scheinen weiterhin in referenzierenden Templates auf.

7. Sind Änderungen eines aktiven Templates erforderlich, muss unterschieden werden, ob es sich um Minor/Major-Änderungen oder um einen Patch handelt.

8. Handelt es sich um einen Patch oder wurden die Änderungen von den referenzierenden Leitfäden akzeptiert, kann mit "neue Version erzeugen" eine neue Templateversion von Art-Decor erstellt werden. Diese hat den Status "Entwurf", die gleiche Template-OID, aber ein neues Erstellungsdatum. Die Versionsnummer im Version-Label des Templates muss an der entsprechenden Stelle um 1 erhöht werden (siehe Versionierung).

9. Sind die Änderungen nicht von allen referenzierenden Leitfäden gewünscht oder noch nicht bekannt ob dies des Fall ist, muss eine "neue Bearbeitung" dieses Templates erstellt werden. Es erhält eine neue Template-OID, Version 1.0.0, siehe Versionierung). Die neue Bearbeitung kann ein Zwischenschritt sein, um kurzzeitig eine Major-Änderung für eine neue Version eines Templates zu erstellen, welche kurz vor Ballot dann als neue Version des originalen Templates erstellt wird. 10.Major und Minor-Änderungen an Templates erfordern (unabhängig davon, ob eine neue Version oder eine neue Bearbeitung erstellt wurde), immer ein Ballotverfahren vor Aktiv-Setzung des Templates. Patch-Änderungen können sofort "Aktiv" gesetzt werden, sollten jedoch idealerweise ebenfalls im Rahmen eines Ballotverfahrens "Aktiv" gesetzt werden.

(*) Anmerkung: Wird ein Template im Status „Entwurf“ nicht mehr benötigt (und wird auch von keinem anderen Leitfaden referenziert), soll es nicht auf "annulliert" oder "zurückgewiesen" gesetzt werden, sondern stattdessen soll der Inhalt gelöscht, der Titel auf „dummy“ (o.ä) umbenannt und die Template-Id auf .999 geändert werden. Dieses Dummy-Template kann später für neue Templates verwendet werden. Durch das Löschen des Inhalts werden auch evtl. bestehende Referenzen (Beziehungen zu anderen Templates) entfernt, und es scheint auch nicht mehr in den Beziehungen der referenzierenden Templates auf.

6 Datasets

Die Verwendung von Art-Decor-Datasets wird für neue Projekte empfohlen. Diese bilden die funktionalen Anforderungen an das Projekt ab und sind Diskussionsgrundlage bei Fachexpertengesprächen (erfordern kein technisches Hintergrundwissen).

Für Datasets gibt es keine speziellen Vorgaben hinsichtlich OID und Version & Metadaten.

Bereits bei der Modellierung der Datasets sollen bestehende Standards berücksichtigt werden (z.B. IHE PCC) und bestehende Dataset-Elemente so gut es geht aus anderen Projekten wiederverwendet werden (siehe auch Dataset versioning). Dies funktioniert durch die Eingabe eines Names und dem mit etwas Ladezeit folgendem Vorschlag von ähnlichen Konzepten. Dabei sollte der Sinn des Datasets, der aus der Beschreibung hervorkommt, derselbe sein.

Weitere offizielle Informationen sind unter ART Dataset Editor zu finden.

6.1 Name

Es gibt keine speziellen Namenskonoventionen, der Name ist jedoch anzugeben!

6.2 Inhalt

Es ist eine Beschreibung und der Werttyp/Valuetype anzugeben.

Wenn vorhanden muss zusätzlich angegeben werden:

  • Auswahllisten
  • Link zu codierten Konzepten / Value Sets (Terminologien)

Die Zuordnung von Dataset-Elementen und erstellten Templates unter "Template" → "Template-Mapping" wird empfohlen, ist aber nicht verpflichtend (siehe auch ART Template Associations). Dadurch sind alle mit einem Template assoziierten Konzepte in der Template-Beschreibung zusammengefasst, sowie direkt beim assoziierten CDA-Element bzw. Attribut des Templates ersichtlich. Dies dient der Kontrolle (auch für die Experten-/Arbeitsgruppe), dass alle erforderlichen Dataset-Elemente in den Templates modelliert wurden.

7 Templates

Ein Leitfadenprojekt besteht aus einem oder mehreren Document Level Templates (DLT) (jedes DLT entspricht dabei einem Dokumententyp), welche die Struktur für ein gültiges CDA-Dokument vorgeben. Darüber hinaus werden in einem Leitfadenprojekt zahlreiche nicht-DLT-Templates referenziert, die im at-cda-brr spezifiziert wurden. Ein Leitfadenprojekt kann außerdem nicht-DLT-Templates beinhalten, die ausschließlich für das Projekt spezifiziert wurden. Für die Verwendung ist folgende Seite ART Template Editor zu lesen.

Info: Solange das DLT noch nicht in der Transaktion des Szenarios verlinkt ist, wird dessen Label (im Template-Baum) als oranges Dreieck mit Pfeilen angezeigt, sonst als oranges Viereck/Buch.

7.1 Vorbedingungen für die Erstellung neuer Templates

Bevor neue Templates erstellt werden, sollte geprüft werden, ob bestehende Templates (bestenfalls im at-cda-bbr), die Anforderungen bereits erfüllen. Gibt es passende Templates können diese durch Referenzierung (unveränderte Übernahme) mittels Kettensymbol in das bestehende Projekt übernommen werden. In diesem Fall sind keine Änderungen an dem Template möglich! Diese Funktion sollte nur verwendet werden, wenn es bereits ein passendes ELGA-/e-Health-Template gibt.

Um herauszufinden, welche Art-Decor Projekte (auch außerhalb der eigenen Governance-Group) bereits ein bestimmtes Template umgesetzt haben, kann man im Menüpunkt „Auge“ (links oben in der ArtDecor-Projektseite), die Template-ID oder den Namen eines Templates angeben -> alle Templates mit zugehörigem Projekt werden aufgelistet.

7.2 Vorbedingungen für Änderungen bestehender Templates

Bevor ein bestehendes Template geändert wird (Erstellung einer neuen Version, welche automatisch von allen dynamisch referenzierenden Templates verwendet wird), ist zu überprüfen, wie sich diese Änderung auf andere Leitfäden auswirkt bzw. ob diese gewünscht ist. In allen betroffenen Leitfäden muss die Änderung auf der Diskussionsseite im Abschnitt "Ausblick" festgehalten werden.

Zu Beachten:

  • Wenn eine neue Version eines aus dem ATCDABBR referenzierten Templates (graues Icon im Template-Baum) benötigt wird, MUSS diese im ATCDABBR erstellt werden.
  • Soll ein Template, das im ATCDABBR erstellt wurde, in ein Projekt-Repository verschoben werden, muss dort zuerst eine evtl. bereits existierende Referenz darauf entfernt werden.
  • Fehlen die Berechtigungen für schreibenden Zugriff auf das ATCDABBR, sollen die erforderlichen Anpassungen zuerst im Projekt-Repository durchgeführt werden und können nach abgeschlossenem Ballot von Berechtigten ins ATCDABBR übernommen werden.

7.3 Name

Template-Namen sind grundsätzlich in englischer Sprache zu vergeben, sodass sie entsprechend ihrer Definition in internationalen Standards beibehalten werden können und die Wiederverwendbarkeit bestehender Templates erleichtert wird.

Eine Ausnahme bilden die Namen von Section-Level Templates. Diese werden auf deutsch vergeben, da sie den in den Arbeitsgruppen abgestimmten Titel der Sektion tragen sollen. Bei einer möglichen Unterscheidung zwischen uncodiert und codiert, ist dies mit einem Bindestrich anzugeben. (Alte Schreibweise mit unkodiert und kodiert ist nicht mehr zu verwenden!)

Empfehlung für Entries: Sind im Entry Referenzen auf andere Standards enthalten, soll der Name des Entries auch den entsprechenden Namen tragen (englisch). Ist dies nicht der Fall (im Entry gibt es z.B. nur eine ELGA Template ID), soll der Name des Entries an den Namen der Sektion angelehnt sein (deutsch). Beispiel: Die Sektion "Impfungen - codiert" (1.2.40.0.34.6.0.11.2.1) (mit AG abgestimmter Titel) referenziert durch Angabe der TemplateID (1.3.6.1.4.1.19376.1.5.3.1.3.23) auf den Standard IHE PCC (Immunizations Section) (und hält auch dessen Vorgaben ein). "Impfungen - codiert" beinhaltet u.a. ein Entry: "Immunization Entry" (1.2.40.0.34.6.0.11.3.1), welches wiederum laut Standarddefintion folgende Template IDs enthalten muss: HL7 CCD Medication activity (1.2.40.0.34.6.0.11.3.1) und IHE Immunizations Entry (2.16.840.1.113883.10.20.1.24). Daher trägt das Entry den Namen, der auch im Standard angegeben wird (mit dem Zusatz "Entry").


Weitere Vorgaben für Name und Display-Name (Bezeichnung) eines Templates:

  • Der Name eines Templates wird wie folgt angegeben:
[Präfix]_[Template-Typ]_[ElementName]
Als Trenner fungieren Unterstriche ("_"), wobei folgendes gilt:
  • [Präfix]: Als Präfix dient das Projektkürzel (Name des Repositories) ohne Bindestriche, z.B. "atcdabrr" oder "atlab". Diese Präfixe bleiben auch beim Verschieben ins at-cda-bbr bestehen!
  • [Template-Typ]: Der Template-Typ muss einen der folgenden Template-Typen enthalten:
  • "document": für Document-Level-Templates
  • "header": für Header-Level-Templates
  • "section": für Sektionen
  • "entry": für Entries
  • "other" : alle Templates/Fragmente, die nicht in obige Kategorien fallen ("Template type not specified")
  • [ElementName]: Entspricht dem Display-Name ohne Leerzeichen, Bindestriche und Klammern "( )". Der ElementName wird in Upper-CamelCase-Notation angegeben.
  • Der Display-Name enthält nur den ElementName (kein Präfix oder Template-Typ), wobei aber Leerzeichen, Bindestriche und Klammern "( )" verwendet werden dürfen. Dieser wird in der Template-Baum-Struktur angezeigt.

Beispiele:

  • Document-Level-Template im ELGA e-Impfpass Repository:
Name: "eimpf_document_KompletterImmunisierungsstatus"
Display-Name: "Kompletter Immunisierungsstatus"
  • Header-Level-Template im at-cda-bbr:
Name: "atcdabbr_header_Author"
Display-Name: "Author"
  • Uncodierten Sektion im Repository at-cda-bbr:
Name: "atcdabrr_section_FruehereErkrankungUncodiert"
Display-Name: "Frühere Erkrankungen - uncodiert"
  • Codierten Sektion im ELGA e-Impfpass Repository:
Name: "eimpf_section_ImpfrelevanteErkrankungenCodiert"
Display-Name: "Impfrelevante Erkrankungen - codiert"
  • Entry im at-cda-bbr:
Name: "atcdabbr_entry_ImmunizationEntry"
Display-Name: "Immunization Entry"
  • Compilation/Other-Template im at-cda-bbr: Compilations/Other sind Template-Fragmente, wie z.B. Adressinformationen. Da sich diese in einem Leitfaden oft wiederholen können, sollen sie mit "contains" in Templates eingebunden werden (d.h. der Inhalt der Compilation wird nicht im verlinkenden Template angezeigt). Diese sollen aber im Leitfaden als eigene Kapitel vorhanden sein.
Name: "atcdabbr_other_AddressCompilation"
Display-Name: "Address Compilation"

7.4 OID

OIDs werden einmalig gesetzt und nicht mehr geändert. Alle Art-Decor Templates müssen unterhalb des OID-Knotes 1.2.40.0.34.6.0.11 liegen (eHealth-Austria/services/art-decor/templates). Die OID der Art-Decor Templates sollen außerdem entsprechend ihres CDA-Template-Typs aus folgenden Unterknoten vergeben werden:

.0. Document-Level Template
.1. Header-Level Template
.2. Section-Level Template
.3. Entry-Level Template
.9. other CDA Fragment Template

Beispiele:

  • Header-Level-Template: 1.2.40.0.34.6.0.11.1.2 Author (eHealth-Austria/services/art-decor/templates/header/xxx)
  • Entry-Level-Template: 1.2.40.0.34.6.0.11.3.15 Antikörper-Bestimmung Data Processing Entry (eHealth-Austria/services/art-decor/templates/entry/xxx)
Wichtiger Hinweis:Die Verwaltung der unter diesen Knoten liegenden Templates unterliegt Art-Decor und benötigt daher keine Registrierung über das OID-Portal. Die nächste freie OID für Templates muss über die ELGA Art-Decor Governance Group Template (Vorsicht!: lange Ladezeit) ermittelt werden.

7.5 Version & Metadaten

  • Für neu angelegte Templates (Entwurf-Status) soll im Version Label die Version 1.0.0 angegeben werden. Wenn das Template aktiv gesetzt wird, wird das aktuelle Datum ergänzt. Nur das DLT erhält immer das Datum, an dem der Leitfaden veröffentlicht wird. Die genauen Vorgaben zur Versionierung sind hier zu nachzulesen Versionierung.
  • Der Zweck des Templates muss aus der Beschreibung hervorgehen. Im Fall von generischen Templates, die im at-cda-bbr angelegt werden und abgeleitet werden müssen (z.B. weil noch kein Value Set referenziert wurde), soll die Beschreibung möglichst allgemein gehalten werden.
  • Modellierung der Templates  "offen/geschlossen":
    • ELGA Implementierungsleitfäden werden seit 2020 "geschlossen" modelliert. Somit können nur die Elemente verwendet werden, die explizit modelliert werden oder durch den Datentypen implizit erlaubt sind. Sobald bei einem Element mit gesetzten Datentypen ein Unterelement einfügt wird, sind die vom Datentypen möglichen Elemente nicht mehr implizit erlaubt, sondern müssen nun auch explizit modelliert werden. Attribute sind davon ausgenommen.
    • Templates von eHealth Implementierungsleitfäden können auch "offen" modelliert werden.
  • Es ist zumindest ein korrektes Beispiel anzugeben.

Beim Ableiten von Templates ist durch einen der folgenden Beziehungstypen anzugeben, wie sie sich zueinander verhalten (siehe auch Creating a new version of an existing template). Die Template-ID des Basistemplates wird nur zu Zwecken der Nachvollziehbarkeit in den Metadaten angegeben, in der Template-Spezifikation selbst muss sie entfernt werden, weil dies sonst bei der Generierung von "closed" Schematron-Regeln zu Inkonsistenzen und zu falsch-positiven Schematron-Fehlern bei der Validierung führen kann.

  • Spezialisierung: bestehende Vorgaben werden weiter eingeschränkt (z.B. von [O] auf [M] oder von 0..* auf 0..1, ebenfalls [O] auf [NP])
  • Adaptierung: bestehende Vorgaben werden erweitert oder geändert (z.B. von [M] auf [O] oder von 0..1 auf 0..*) oder neue Elemente, Attribute, ValueSets, Fixe Werte werden hinzugefügt.

Die Übernahme vorhandener Templates aus Projektverzeichnissen, die NICHT referenziert sind, ist nicht über die GUI möglich, weil diese Templates nicht als Prototyp angegeben werden können (d.h. von ihnen kann nicht geerbt werden).

Soll der Inhalt eines Templates trotzdem verwendet werden, lässt sich mittels Browser-Direktlink

https://art-decor.org/temple/views/temple.html?id=[OID des Templates]&[effectiveDate]&[prefix]&[language]&mode=readonly

der XML-Code jedes Templates via Temple (im Lesemodus) anzeigen und anschließend kopieren. Der Inhalt kann dann in ein neu erstelltes Template eingefügt werden. Dabei ist zu beachten, dass der Zeitpunkt (effectiveDate) und die OID des neu erstellten Templates nicht verändert werden. Alle weiteren Inhalte können entsprechend angepasst werden. Die OID muss in einem späteren Arbeitsschritt über die GUI korrigiert werden.

Beispiel:

https://art-decor.org/temple/views/temple.html?id=2.16.756.5.30.1.1.10.2.63&effectiveDate=2020-06-26T00:00:00&prefix=cdachvacd-&language=de-DE&mode=readonly

7.6 Inhalt

  • Warning.png Wenn möglich, sollen bereits vorhandene Templates verwenden werden.
  • Zugrundeliegende Standards dürfen nur eingeschränkt, aber nicht erweitert werden.
    • Hinweis: Wenn ein Template laut Standard "required" ist, aber für den konkreten Leitfaden nicht benötigt wird, kann das Template mit einem nullFlavor erstellt werden (z.B. Freitext-Inhalt „keine Information“ oder Code „entry empty“). Dadurch wird der Standard nicht verletzt und das Template kann trotzdem verwenden werden.
  • Optionalitäten und Reihenfolge der Elemente müssen eingehalten werden.
  • Die erste Template-ID soll wie folgt bezeichnet werden: "HL7 Austria - [Name des Templates]". Diese Template-ID muss aus dem OID-Knoten 1.2.40.0.34.6.0.11 stammen.
    • Warning.png Jene Template-ID, die beim Erstellen eines neuen Templates oder Ableiten eines Prototyps von Art-Decor automatisch hinzugefügt wird, muss entfernt bzw. ersetzt werden (nur über GUI mögich, nicht via Temple: "Template bearbeiten" → "#")
  • Weitere Template-IDs können angegeben werden, sofern das im zugrundeliegenden Standard gefordert ist (z.B. IHE).
  • include vs. contains
    • Im CDA-Header sollen alle Elemente mit include eingebunden werden.
      • Ausgenommen davon sind so genannte Compilation-Elemente, die in die Kategorie "Template type not specified" fallen (z.B. Address Compilation, Performer Body - Laboratory, etc.)
    • Ab dem component/structuredBody soll nur mehr mit contains gearbeitet werden.
  • Elemente und Attribute, die im Template verwendet werden, sind zu dokumentieren. Dabei kann in der Dokumentation auch auf den zugrundeliegenden Standard verwiesen werden.
  • Elemente die auf XDS-Metadaten gemappt werden müssen, sollen mit "↔ Hinweis zum XDS-Mapping" gekennzeichnet sein.
    • Beispiel: ↔ Hinweis zum XDS-Mapping: Das "templateId"-Element mit einer Extension beginnend mit "XDSdocumentEntry.formatCode^" wird ins XDS-Attribut "formatCode" gemappt (ohne Präfix XDSdocumentEntry.formatCode^)
  • Es ist beim Neu-Erstellen wie auch beim Bearbeiten eines Templates zu überprüfen, ob die Datentypen nach R-MIM richtig eingehalten werden.
  • Wen man bei Elementen mit Datentypen Unterelemente vorgibt, muss man dabei alle anderen Unterelemente auch vorgeben. Es werden die möglichen Unterelemente des Datentyps sonst nicht erlaubt.
  • Bei einigen Datentypen muss man neben der Art-Decor Dokumentation, zusätzlich das ELGA-Schema beachten, damit die ELGA-Anpassungen mitbeachtet werden.
  • Es sollen in Art-Decor immer nur CD, CE und CV verwendet werden, nicht die IPS oder SDTC Varianten. Das ELGA-Schema bietet diese Erweiterungen bereits innerhalb CD, CE und CV an.
  • Jedes Template sollte ein Beispielsnippet enthalten, in dem die korrekte Anwendung des Templates angegeben wird. In der Regel werden Beispielsnippets nur zum Template selbst erstellt, nicht zu den darin verlinkten Templates (z.B. included Entries).
    • Idealerweise werden Beispielsnippets als letztes ergänzt, um den Aufwand an Änderungen im Template gering zu halten.
  • Der Name eines Templates (nicht der Display-Name!) kann nach dem Erstellen des Templates nur mittels Temple geändert werden! Die Änderung des Namens hat keinen Einfluss auf die Referenzierung durch andere Templates -> hier gilt die OID. Der Display-Name kann jederzeit über GUI oder Temple geändert werden.
  • Wird die OID geändert, wenn das Template bereits durch andere Templates refereziert wird, werden alle bestehenden Referenzen darauf ungültig! Daher vor der Änderung der OID die Liste aller referenzierenden Templates abspeichern und diese hinsichtlich der neuen OID anpassen!

Kardinalität / Konformität

Im Allgemeinen Implementierungsleitfaden wird unter der Legende der Konformitätskriterien beschrieben, welche Kardinalitäten und Konformitäten in den ELGA Leitfäden vorkommen können. Die folgende Tabelle stellt dar, wie diese Kriterien in Art-Decor umzusetzen sind (siehe auch Mandatory/Conformance).

Für Elemente
Vorgaben Allgemeiner Leitfaden Verwendung von nullFlavor Umsetzung Art-Decor am Beispiel eines id-Elements mit dem Datentypen II (in Temple)
1..1 M nicht erlaubt <element name="hl7:id" datatype="II" minimumMultiplicity="1" maximumMultiplicity="1" conformance="R" isMandatory="true">
1..* M nicht erlaubt <element name="hl7:id" datatype="II" minimumMultiplicity="1" maximumMultiplicity="*" conformance="R" isMandatory="true">
0..0 NP nicht erlaubt <element name="hl7:id" datatype="II" conformance="NP">

Achtung, bei templateIds sollte zusätzlich ein Prädikat angegeben werden, damit auch das Schematron richtig erstellt wird:

<element name="hl7:templateId[@root='1.3.6.1.4.1.19376.1.3.3.2.1']" datatype="II" conformance="NP">

  <attribute name="root" value="1.3.6.1.4.1.19376.1.3.3.2.1" datatype="uid" />

</element>

1..1 R erlaubt <element name="hl7:id" datatype="II" minimumMultiplicity="1" maximumMultiplicity="1" conformance="R">
1..* R erlaubt <element name="hl7:id" datatype="II" minimumMultiplicity="1" maximumMultiplicity="*" conformance="R">
0..1 R nicht erlaubt <element name="hl7:id[not(@nullFlavor)]" datatype="II" minimumMultiplicity="0" maximumMultiplicity="1" conformance="R">
0..* R nicht erlaubt <element name="hl7:id[not(@nullFlavor)]" datatype="II" minimumMultiplicity="0" maximumMultiplicity="*" conformance="R">
0..1 O erlaubt <element name="hl7:id" datatype="II" minimumMultiplicity="0" maximumMultiplicity="1">
0..* O erlaubt <element name="hl7:id" datatype="II" minimumMultiplicity="0" maximumMultiplicity="*">
0..1 C Abhängig vom Kontext <element name="hl7:id" datatype="II" minimumMultiplicity="0" maximumMultiplicity="1" conformace="C">
0..* C Abhängig vom Kontext <element name="hl7:id" datatype="II" minimumMultiplicity="0" maximumMultiplicity="*" conformace="C">
Für Attribute
Vorgaben Allgemeiner Leitfaden Umsetzung Art-Decor
0..0 NP <attribute name="root" datatype="uid" prohibited="true"/>
1..1 R <attribute name="root" datatype="uid"/>
0..1 O <attribute name="root" datatype="uid" isOptional="true"/>
1..1 F <attribute name="root" datatype="uid" value="1.3.6.1.4.1.19376.1.3.2.1"/>
0..1 F <attribute name="root" datatype="uid" value="1.3.6.1.4.1.19376.1.3.2.1" isOptional="true"/>

8 Value Sets

Eine Anleitung zur Verwendung des Value Set Editors ist unter ART Value Set Editor zu finden.


Seit 2022 steht unter https://termgit.elga.gv.at/ ein neuer Terminologieserver zur Verfügung. Die Dokumentation findet sich auf https://termgit.elga.gv.at/documentation_and_support_de.html und https://termgit.elga.gv.at/faq_de.html

8.1 Name

Name und Display-Name (bzw. Title auf Termgit) eines Value Sets müssen wie folgt angegeben werden:

  • Name: [Präfix]-[ValueSetName] (lowercase-Schreibweise)
  • Display-Name/Title: [Präfix]_[ValueSetName] (UpperCamelCase-Schreibweise)

Sonderzeichen sind nicht erlaubt. Als Präfix dient das Projektkürzel (Name des Repositories), z.B. "eimpf".

Beispiele:

  • Name: eimpf-antikoerperbestimmung
  • Title: eImpf_Antikoerperbestimmung
  • Name: elga-administrativegender
  • Title: ELGA_AdministrativeGender

8.2 OID

Alle Art-Decor Value Sets müssen unterhalb des OID-Knotes 1.2.40.0.34.6.0.10 liegen (eHealth-Austria/services/art-decor/value-sets).

Beispiele:

  • Value Set: 1.2.40.0.34.6.0.10.8 ELGA_EntityNamePartQualifier_VS (eHealth-Austria/services/art-decor/value-sets/xxx)
Wichtiger Hinweis: Die Verwaltung der unter diesen Knoten liegenden Value Sets unterliegt Art-Decor und benötigt daher keine Registrierung über das OID-Portal. Die nächste freie OID für Value Sets muss über die ELGA Art-Decor Governance Group Value Sets (Vorsicht!: lange Ladezeit) ermittelt werden.

8.3 Version & Metadaten

Versionierung: Siehe Versionierung.

8.4 Inhalt

Best Practices für die Erstellung und Pflege von Value Sets müssen angewendet werden, z.B. können Konzeptcodes hinzugefügt, aber nicht gelöscht werden, nur auf den Status "deprecated" gesetzt werden.

Wichtiger Hinweis: Wenn sich die Gesamtbedeutung der Codes in einem Value Set ändert, muss die neue Version des Value Sets eine neue OID erhalten.

9 Beispielbefunde

Neben den Beispielsnippets in den Templates sind Beispielbefunde und Falsch-Beispielbefunde zu erstellen. Ein Grundgerüst für ein Beispieldokumentekann erstellt werden, indem man im entsprechenden DLT den Zauberstab des Template Editors anwendet und rekursiv alle Code-Snippets der darin verlinkten Templates einfügt.

Name

Der Name von (Falsch-)Beispielbefunden sollte folgendermaßen aufgebaut sein. Die einzelnen Elemente werden mit "_" verbunden.

"falsch_": Angabe, dass es sich um einen Falsch-Beispielbefund handelt.

[Präfix]: Als Präfix dient das Projektkürzel (Name des Repositories), z.B. "eimpf"

[optional DLT-Name]: Name des DLTs, wenn es in dem Projekt mehrere DLTs gibt.

[Kurztitel des Beispiels]: Erklärt ganz kurz, worum es in dem Beispielbefund geht.

Beispiele:

  • at-lab_Laborbefund_Kompletter_Befund.xml
  • falsch_at-lab_Laborbefund_Constraint_gebrochen.xml

Inhalt

  • Beispielbefunde
    • sind vollständig valide und bilden verschiedene reale Szenarien ab.
  • Für Falsch-Beispielbefunde sollte mindestens jeweils ein Befund vorhanden sein für
    • das Brechen eines Contraints,
    • das Verwenden eines falschen Wertes wo ein Value Set Wert erwartet wird,
    • das Verwenden eines nicht CDA-Elementes (nicht im Schema vorhanden),
    • das Verwenden eines verbotenen Elementes
    • das Weglassen eines Pflichtfeldes.

10 Szenarios / Schematron

Das Erstellen von einer Transaktion pro DLT in den Szenarien ist für die Generierung von Schematron-Regeln zwingend erforderlich, siehe Schematron-Erstellung und Bereitstellung.

Für Szenarios gibt es keine speziellen Vorgaben hinsichtlich OID oder Version & Metdaten.

Eine Anleitung zur Verwendung des Szenario Editors ist unter ART Scenario Editor zu finden.

10.1 Name

Der Name/Label der Transaktionen soll dem Schema [NameDesSzenarios] folgen. Alles zusammengeschrieben, kein Prefix.

Der im Label der Transaktion angegebene Name wird von Art-Decor später automatisch als Name für das entsprechende Schematron verwendet, z.B. „eimpf-UpdateImmunisierungsstatus“, wobei das Präfix des Projektes mit dem folgenden Bindestrich automatisch ergänzt wird.

10.2 Inhalt

Optional ist es für jede Transaktion möglich das Dataset ("Konzepte") anzugeben und für jedes Element Kardinalität (optional, wiederholbar) und Konformität (erforderlich, obligatorisch) festzulegen. Die Angabe von Kardinalität und Konformität ist für die Erstellung eines Schematrons nicht zwingend erforderlich.

11 Qualitätssicherung

11.1 Art-Decor

Offizielle Informationen zur Qualitätssicherung eines Projekts in Art-Decor finden sich auf der Seite Preflighting publication and quality checks.

  • Template-Checks:
    • korrektes Präfix, Name, Displayname
    • open/closed
    • korrektes Value Set
    • Beispielsnippets
    • Templatebeschreibung
    • Standardreferenzen
    • Dataset Mapping (optional)
    • im Beispieldokument enthalten
    • Schematron Asserts ergänzen
  • DLT bei jeder Version MUSS in hl7at:formatCode die Versionierungsinfo + Publikationsdatum im Label angepasst werden.
    • Entsprechende Adaptierung von CodeSystem ELGA_FormatCode und ValueSet ELGA_FormatCode
  • Temlatestatus:
    • für Ballot: Templates bleiben im Entwurf-Status
    • nach Ballotabschluss: Versionlabel mit Publikationsdatum ergänzen und Templates aktiv setzen
  • Zur Prüfung des Projektschemas unter dem Menü "Project" → "Development" → "Check DECOR" ein Dataset auswählen und die Prüfung durchführen. Eventuelle Fehler, Warnungen oder Hinweise werden anschließend in einer Liste dargestellt.
  • Nach der Erstellung eines Schematrons unter "Project" → "Development" → "Compile a development version" (für Details siehe Schematron-Erstellung und Bereitstellung) ist es möglich, über "Validate XML instance" Beispielbefunde für die verschiedenen Szenarios zu validieren.
  • AD-Bot starten (lassen) (am Vortag der Publikation)

11.2 Wiki

Im Wiki werden die Metadaten vor dem setzen des Seiten-Status auf Abnahme nochmals überprüft.

  • Anpassung Titelblatt
    • Publikationsdatum
    • Versionsinformationen mit DLT abgleichen
  • Infobox: „In Arbeit“ entfernen
  • Prüfen, ob alle Templates eingefügt und Value Sets verlinkt wurden
  • Linkverzeichnisse, Referenzen prüfen
  • ggf. Informationen bezüglich hl7at:formatCode auf der Wiki-Seite aktualisieren
  • Diskussionsseite aktualisieren
    • Diskussionsseiten sollen wie folgendes Beispiel aufgebaut sein (Diskussionseite Telemonitoring-Episodenbericht)
    • prüfen, ob Elemente aus dem "Ausblick" in der aktuellen Version umgesetzt wurden. Falls ja, sind diese in die Tabelle des "Release-Log" zu verschieben.
  • Revisionsliste des Leitfadens auf Basis der Diskussionsseite aktualisieren
  • Links prüfen und optimieren: Nur externe Links sollen in neuem Tab geöffnet werden, Sprungmarken sollten immer mit # gekennzeichnet sein.
  • PDF: Druck checken (leere Seiten, Suche nach: „Error“, „Fehler“, "TODO")
  • Wiki-Seite Status ändern auf "abgenommen"
  • falls neue Hauptversion dann OID im OID Portal eintragen lassen
  • Wiki-Guide aktualisieren (neue Zeile für neue Version, PDF upload)
  • Seiten-Status ändern auf "abgenommen"

11.3 GitLab

Eine erweiterte Qualitätssicherung wird auch in GitLab erstellt. Hier werden beim Einstellen von (Falsch-)Beispielbefunden oder Schematron-Regeln in die jeweiligen Projekte automatisch Prüfroutinen (Schematron-Validierung) gestartet.

  • Beispielbefunde aktualisieren
  • Falsch-Beispielbefunde aktualisieren
  • Schematron aktualisieren

12 Anhang

12.1 Links

Abgerufen von „http://wiki.hl7.at/index.php?title=ART-DECOR_Governance&oldid=160624“