3.869
Bearbeitungen
Änderungen
→Quality Assurance & Review =
{{#customtitle:Governance für die CDA-Leitfadenerstellung mit Art-Decor und Mediawiki}}
{{#css:
.toc{
width: 20%;
float: right !important;
margin: 10px 0px 10px 30px !important;
border: 1px solid #AAA;
background-color: #F9F9F9;
display: table;
padding: 7px !important;
}
}}
<!--
= Zusammenfassung =
Dieses Dokument enthält Richtlinien zur Erstellung von CDA-Implementierungsleitfäden mit Art-Decor® und der Dokumentation mit Mediawiki in Österreich.
Diese Richtlinien sollen als Empfehlungen und Best Practices dienen, um eine nationale und auch internationale Konformität und eine harmonisierte Verwendung der Tools zu gewährleisten. Sie entstanden in Zusammenarbeit mit Tony Schaller (CH) und der ELGA GmbH (AT).
Weiters werden die notwendigen Verantwortlichkeiten und Prozesse definert, um klare Strukturen für die Zusammenarbeit zwischen Art-Decor und dem Wiki zu gewährleisten. Dies umfasst die Verantwortung für Art-Decor Repositories, Qualitätssicherung und den Support der Tools.
Das Dokument geht nicht auf die Modellierung von HL7 CDA-Dokumenten ein, sondern beschreibt hauptsächlich den Einsatz der Tools Art-Decor und Mediawiki, begleitet von Do's und Don'ts für Österreich. Sie definiert Regeln und Strukturen, die von allen Anwendern dieser Werkzeuge eingehalten werden müssen.
Dieses Dokument enthält die aktuellsten Fragen und Entscheidungen bezüglich der Arbeit mit Art-Decor und Mediawiki in Österreich und wird laufend angepasst.
{{BeginYellowBox}}
{{EndYellowBox}}
= Governance für die CDA-Leitfadenerstellung mit Art-Decor =
== Sprache ==
Das österreichische OID Portal ist zu finden unter [https://www.gesundheit.gv.at/OID_Frontend/ OID Portal Österreich].
===OIDs für Implementierungsleitfäden===
{{BeginYellowBox}}
''Wichtiger Hinweis:'' Für '''jeden Implementierungsleitfaden''' muss (über das OID-Portal) eine OID '''unterhalb des Knotens 1.2.40.0.34.7''' (eHealth-Austria/documents)
* 1.2.40.0.34.7.18.1: Implementierungsleitfaden Meldung von antimikrobieller Resistenzen - Version 1.00
===Art-Decor Root OIDs===
Als neuer '''Root-Knoten für Art-Decor''' wird 1.2.40.0.34'''.6.0''' (eHealth-Austria/services) verwendet. Er enthält OID für Value Sets und Templates.
<br>
====Root OIDs für Templates ====
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 OIDs der Art-Decor Templates sollen außerdem '''entsprechend ihres CDA-Template-Typs''' aus folgender Unterknoten vergeben werden:
*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)
{{BeginYellowBox}}
''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 [https://art-decor.org/art-decor/decor-governance-group?id=1.2.40.0.34.3.1.2 '''Art-Decor Governance Group'''], unter "List of Artefacts under this Governance Group" / Reiter "Templates" ermittelt werden.
{{EndYellowBox}}
====Root OIDs für Value Sets====
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).
{{BeginYellowBox}}
''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 [https://art-decor.org/art-decor/decor-governance-group?id=1.2.40.0.34.3.1.2 '''Art-Decor Governance Group'''], unter "List of Artefacts under this Governance Group" / Reiter "Value Sets" ermittelt werden.
{{EndYellowBox}}
== Namenskonventionen ==
=== Versions-Label ===
Im ''Version-Label'' wird prinzipiell die '''Jahrzahl''' der Verabschiedung des '''Templates''', des '''Value Sets''' bzw. des '''Datasets''' eingetragen. Sollte die Angabe des Jahres nicht ausreichend sein, wird sie mit .Monat ergänzt. Gleiches gilt für tagesaktuelle Versionen.
:Beispiele:
:* 2019
:* 2019.01
:* 2019.01.16
=== Item-Label ===
Der im Item-Label des '''Document-Level Templates''' angegebene Name wird von Art-Decor später automatisch als Name für das entsprechende Schematron verwendet, z.B. „elgaimpf‑UpdateImmunisierungsstatus“.
'''Vorgaben für andere Templates?: TODO'''
=== Bezeichnungen für Templates ===
Die Namen von Templates werden wie folgt angegeben:
'''[Präfix]_[Template-Typ]_[ElementName]'''<br/>
Wobei folgendes gilt:
;[Präfix]: Als Präfix dient das Projektkürzel (Name des Repositories) in CamelCase-Notation, z.B. "atcdabrr"
;[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, die nicht in obige Kategorien fallen ("Template type not specified")
;[ElementName]: Bezeichnung des Templates in CamelCase-Notation. Als Trenner fungieren Unterstriche "_".
Beispiele:
*'''Document-Level-Template''' im ELGA e-Impfpass Repository:
::Name: "eimpf_document_KompletterImmunisierungsstatus"<br>
::DisplayName: "Kompletter Immunisierungsstatus"
*'''Header-Level-Template''' im AT-CDA-BBR:
::Name: atcdabbr_header_Author<br>
::DisplayName: Author
*'''Unkodierten Sektion''' im Repository AT-CDA-BBR:
::Name: "atcdabrr_section_FruehereErkrankungUnkodiert"<br>
::DisplayName: "Frühere Erkrankungen - unkodiert"
*'''Kodierten Sektion''' im ELGA e-Impfpass Repository:
::Name: "eimpf_section_ImpfrelevanteErkrankungenKodiert"<br>
::DisplayName: "Impfrelevante Erkrankungen - kodiert"
*'''Entry''' im AT-CDA-BBR:
::Name: "atcdabbr_entry_Immunization"<br>
::DisplayName: "Immunization Entry"
*'''Other'''-Template im AT-CDA-BBR:
::Name: atcdabbr_other_AddressCompilation<br>
::DisplayName: Address Compilation
=== Bezeichnungen für Value Sets ===
Die Namen von Value Sets werden wie folgt angegeben:
'''[Präfix]_[ValueSetsName]_VS'''<br/>
==Versionierung==
===Versionierung von Templates =======Document-Level Templates====
Für jede neue Version eines Document-Level Templates ist eine neue OID zu verwenden. Der Bezug zur alten OID ist anzugeben. Dadurch wird die Anwendung der korrekten Schematron-Regeln gemäß dem getesteten CDA-Dokument sichergestellt.
====Alle anderen Templates====
TODO
===Versionierung von Value-Sets===Die '''OIDs''' der Value-Sets bleiben '''für alle Versionen gleich''', werden aber durch das Gültigkeitsdatum '''"effectiveDate"''' unterschieden ("Gültig ab"). Darüber hinaus kann eine Value-Set ein '''offizielles Freigabedatum''' tragen. <br><br>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. Wenn sich die Gesamtbedeutung der Codes in einem Value-Set ändert, muss die neue Version des Value-Sets eine neue OID erhalten.
Bei der Aktualisierung eines Value Sets muss das effectiveDate auf das aktuelle Datum (Gültig ab-Datum) geändert werden.
== Governance Groups ==
Governance-Gruppen sind organisatorische Einheiten, die dazu dienen, die Verantwortung für Artefakte in Art-Decor darzustellen. Unter [https://art-decor.org/art-decor/decor-governance-group?id=1.2.40.0.34.3.1.2 Governance-Gruppen] sind alle Projekte der Gruppe sichtbar, sowie alle angelegten Artefakte mit OID, Displayname, [[#Artefaktstatus]], BBR und Projekte, die das Template oder Value-Set referenzieren.
=== Artefaktstatus ===
In einem Repository werden Artefakte zunächst im Status "Entwurf" erstellt. Nach Abschluss, Überprüfung und Bestätigung kann der Status eines Artefakts im Repository gemäß den Regeln der zuständigen Governance-Gruppe geändert werden (siehe [https://art-decor.org/mediawiki/index.php?title=ART_Template_Editor#Changing_the_status_of_a_template "Changing the status of a template"]). Das Kapitel [[#Repositories]] enthält die Beschreibung des detaillierten Prozesses und der Verantwortlichkeiten.
Das folgende Zustandsdiagramm zeigt die Standardzustände und möglichen Übergänge für ein Artefakt in Art-Decor:
<ref group="Abbildung">Default state diagram for Art-Decor artefacts</ref> ''Default state diagram for Art-Decor artefacts''
'''TODO: Beschreibung, wann von draft in active wechseln.<br>'''TODO: Example for CH anpassen, nicht verwendete Zustände aus Tabelle entfernen'''
<br>
|}
= = Dokumentation ===== Templates ===Elemente und Attribute, die im Template verwendet werden, sind zu dokumentieren. Die Beziehung zu anderen Templates ist anzugeben, um festzuhalten, wie sie sich zueinander verhalten (z.B. Spezialisierung, Anpassung usw.).<br><br>TODO: prüfen <br>Other elements that were in addition available according the HL7 CDA standard shall not be mentioned in the Art-Decor template.* Open vs. Closed Templates === Standard-Referenzen ===Daten- und Template-Elemente sollen in ihrem Label zu der entsprechenden Spezifikation verlinken, auf der sie basieren (z.B. IHE PHARM, Kap. 4.4). Dies liegt in der Verantwortung des Entwicklers. == Datasets ==Die Verwendung von Art-Decor-Datensätzen 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). <br>Folgende Inhalte eines Dataset-Elements sind mindestens anzugeben:* Name* Beschreibung* Datentyp<br>wenn vorhanden:* Auswahllisten* Link zu kodierten Konzepten / Value Sets (Terminologien) == Szenarios ==Das Erstellen von '''Transaktionen''' im Rahmen von Szenarios ist für die Generierung von Schematron-Regeln '''zwingend erforderlich'''.<br>Die Transaktion soll dem Schema '''[Projektkürzel]_[Name des Szenarios]''' folgen.<br>Die Angabe von Kardinalität (optional, wiederholbar) und Konformität (erforderlich, obligatorisch) für die einzelnen Elemente des Datasets '''wird empfohlen'''. == Dataset-Mapping ==Die Zuordnung von Datensatz-Elementen und erstellten Templates wird '''empfohlen''' (Informationen zum [https://wiki.hl7.at/index.php?title=Hilfe:Art-Decor_Leitfadenerstellung#Dataset-Mapping_erstellen Dataset-Mapping]) = Governance für die CDA-Leitfadenerstellung mit Mediawiki =
==Leitfaden erstellen==
Wichtige Informationen hinsichtlich der technischen Erstellung eines CDA-Leitfadens mit Mediawiki sind unter [https://wiki.hl7.at/index.php?title=Hilfe:Leitfaden_erstellen "Leitfaden erstellen"] nachzulesen. ===Namespace===Der Verwendung von Namespaces ist wesentlich für Versionierung der Wiki-Seiten mit Flagged Revisions. {{BeginYellowBox}}''Wichtiger Hinweis:'''''Alle Seiten''' von CDA-Leitfäden im Namespace '''[[https://wiki.hl7.at/index.php?title=Hilfe:Leitfaden_erstellen#Verwendung_von_Namespaces "ILF"]]''' erstellt werden.{{EndYellowBox}}
== Struktur eines CDA-Implementierungsleitfadens ==
== Schematische Template-Darstellung ==
TODO
= Quality Assurance & Qualitätssicherung und Review ==
== Art-Decor Repository ==
TODO
