3.869
Bearbeitungen
Änderungen
→Struktur eines CDA-Implementierungsleitfadens
{{#customtitle:Governance für die CDA-Leitfadenerstellung mit Art-Decor und Mediawiki}}
<!--
{{Infobox Dokument
|Title = Best Practices and Governance for für die CDA-Leitfadenerstellung mit Art-Decorund Mediawiki
|Short = Art-Decor Governance
|Type = Governance
|Status = Draft
|Period = 2107.0311.20172019
|OID = TODO
|Realm = SchweizÖsterreich|Submitted = 2107.0311.20172019}}
{{Versionbox Begin}}
{{VersionboxEntry | Version = 0.1 | Date = 02.02.2017 | Status = Draft | History=Initial Draft for review on 03.02.2017 (JGN)}}{{VersionboxEntry | Version = 0.2 | Date = 03.02.2017 | Status = Draft | History=Inputs from Telco on 03.02.2017: State Diagram for artefacts (JGN)}}{{VersionboxEntry | Version = 0.3 | Date = 15.02.2017 | Status = Draft | History=Include comments from review (JBL, OEG, JGN, KHE, TSC)}}{{VersionboxEntry | Version = 0.4 | Date = 20.02.2017 | Status = Draft | History=finalize document for audit within HL7 & IHE Switzerland (JGN)}}{{VersionboxEntry | Version = 01.5 | Date = 28.02.2017 2019 | Status = Draft | History=Include comments from review (Inititalversion beim Workshop mit Tony Schaller, IHE, HL7) (JGN, TSCCH)}}{{VersionboxEntry | Version = 1.0 | Date = 21.03.2017 | Status = Final | DocumentLink=| History=First release}}{{VersionboxEntry | Version = 1.1 2 | Date = 07.0511.2018 2019| Status = Draft | History=Changes according lessons learned from Überarbeitung und Einarbeitung der Erkenntnisse nach Erstellung des CDA-CH V2, LREP, VACD, EMED.<ul><li>[[#Structure of an Implementation Guide | Specification: chapter structure]]</li><li>[[#Support for Art-Decor | Involvement of Art-Decor Support]]</li><li>[[#Revisions | PDF Generation with Prince and Github Link]]</li><li>[[#Art-Decor artifact states | Status Pre-publication Review for art-decor artefacts]]</li><li>[[#Revisions | ArtLeitfadens e-Decor release notes]]</li></ul>Impfpass}}
{{Versionbox End}}
-->
|-
! Document version
| 10.12
|-
! Authors
|
* Johannes Gnägi Andrea Klostermann (eHealth SuisseELGA GmbH)* Sang-Il Kim Stefan Sabutsch (eHealth Suisse)* Kai Heitmann (Heitmann Consulting and Services , ART-DECOR Open Tools)* Jürg Bleuer (eHealth Suisse)* Tony Schaller (IHE Suisse)* Oliver Egger (HL7 Benutzergruppe SchweizELGA GmbH)
|-
! Stakeholder Contributor(s)unter Mitwirkung von| HL7 Schweiz, Tony Schaller (IHE Suisse, Heitmann Consulting and Services)
|}
-->
= 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).
{{EndYellowBox}}
= Richtlinien Art-Decor =
== Sprache ==
'''ELGA Implementierungsleitfäden''' werden in '''deutscher Sprache''' verfasst. Dazu gehören textuelle Beschreibungen im Wiki, Art-Decor-Templates und Datasets.
Das österreichische OID Portal ist zu finden unter [https://www.gesundheit.gv.at/OID_Frontend/ OID Portal Österreich].
{{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)
{{EndYellowBox}}
Falls Dokumente in aufeinander aufbauenden Versionen vorliegen, kann dafür darunter eine zusätzliche Ebene angelegt werden.
Beispiel:
* 1.2.40.0.34.7.18.1: Implementierungsleitfaden Meldung von antimikrobieller Resistenzen - Version 1.00
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.
{{BeginYellowBox}}
{{EndYellowBox}}
<br>
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:
: 1.2.40.0.34.6.0.11.3.15 Antikörper-Bestimmung Data Processing Entry (eHealth-Austria/services/art-decor/templates/entry/xxx)
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).
==Versionierung==
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.
TODO
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.
"Beta" wird nur bei Value Sets verwendet, die noch bearbeitet werden. Sobald die Version gültig ist, wird das "beta" entfernt.
In Österreich kann derzeit folgendes bereichsspezifische '''Building Block Repository''' (BBR) verwendet werden:
*[https://art-decor.org/art-decor/decor-project--at-cda-bbr- '''ATCDABBR''']: Dies soll in Zukunft alle für Österreich relevanten Basis-Templates enthalten, die für spezifische Anwendungen (e-Health und ELGA) in die einzelnen Projektverzeichnisse abgeleitet verwendet werden können. <br>
:Verantwortlichkeiten und Prozesse sind im Kapitel [[#Revision]] beschrieben.
* e-Impfpass (Pilot)
* Basisleitfäden (alte Versionen)
* TODO
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.
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: {{ HL7img | Governance state machine.png |center| Zustandsautomat }} <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><ref group="Tabelle">Art-Decor state machine</ref> ''Art-Decor state machine''{| class="hl7table"! width="80px" | Status !! Action !! Trigger / Description !! Example for CDA-CH !! Responsibility|-| [[File:Kyellow.png|16px]] draft| activate| Artefact is finished and it is considered as final (no review needed).| ''n/a for CDA-CH as review necessary.''| Developer|-| | consider| If an artefact is considered to be moved into a repository, this action is applied and the artefact has to be reviewed by the owner/team of the repository.| ''final draft for a CDA-CH V2 template ready to review.''| Developer (info to the Reviewer) |-| | cancel| If an artefact is not further developed, it is cancelled.| ''any developed draft template not to be used anymore.''| Developer|-| [[File:Korange.png|16px]] pending| activate| Upon decision of the review team.| ''CDA-CH V2 template has been reviewed within HL7 Switzerland and was considered to be ready for release.''| Review team of the repository. |-| | reject| If the artefact is considered as not appropriate for the repository, it's rejected.| ''HL7 Switzerland does not consider the template.''| Review team of the repository.|-| [[File:Kpurple.png|16px]] rejected| | Decision necessary for what next status applies, it is recommended to set the status to draft and re-evaluate it for a repository or set is as active only within the project.| ''As appropriate, propose to set it to draft again or move it to another BBR.''| Developer|-| [[File:Kgreen.png|16px]] active| review| Maintenance or update of a project/repository.| ''Review CDA-CH template to consider it for CDA-CH v2.''| Repository / Project owner|-| | retire| In case of a new version, the old version is retired in order to have only one valid version of an artefact.| ''A CDA-CH template is not used anymore or replaced by another one.''| Repository / Project owner|-| [[File:Korange.png|16px]] pre-publication review | reactivate| If updated and considered as final by the responsible person, the artefact is re-activated.| ''template is reviewed within HL7 Switzerland and considered to be ready for release.''| Repository / Project owner|-| | retire| | ''A CDA-CH template is not used anymore or replaced by another one.''| |} == 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>
* Open vs. Closed Templates
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.
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>
* Link zu kodierten Konzepten / Value-Sets (Terminologien)
Das Erstellen von '''Transaktionen''' im Rahmen von Szenarios ist für die Generierung von Schematron-Regeln '''zwingend erforderlich'''.<br>
Die Angabe von Kardinalität (optional, wiederholbar) und Konformität (erforderlich, obligatorisch) für die einzelnen Elemente des Datasets '''wird empfohlen'''.
Die Zuordnung von Datensatz-Elementen und erstellten Templates wird '''empfohlen'''.
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, dass alle erforderlichen Datensatz-Elemente in den Templates modelliert wurden.
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.01.16
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“.
Die Namen von Templates werden wie folgt angegeben:
'''[Präfix]_[Template-Typ]_[ElementName]'''<br/>
::DisplayName: Narrative Text Reference
Die Namen von Value-Sets werden wie folgt angegeben:
'''[Präfix]_[ValueSetsName]_VS'''<br/>
:*Wiedergabename: eimpf_Abrechenbarkeit_VS
=== Struktur eines CDA-Implementierungsleitfadens Namespace===Um eine konsistente Vorgehensweise und Darstellung eines Implementierungsleitfadens zu gewährleisten, wird die folgende (minimale) Struktur empfohlenDer 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}}
Aufgrund bisherige Erfahrungen wird empfohlen, nur jene Textabschnitte in Teildokumente auszulagern, die aufgrund deren allgemeinen Inhalten auch zur Transklusion in andere Leitfäden verwendet werden können. Dies hat den Vorteil, das mit den Onboard-Mitteln des Wikis verschiedene Seiten-Versionen (über den Reiter "Versionsgeschichte") leichter verglichen werden können. ===Typische Gliederung eines Dokuments===Um eine konsistente Vorgehensweise bei der Erstellung und Darstellung eines Implementierungsleitfadens zu gewährleisten, wird folgende (minimale) Struktur vorgegeben: '''TODO REVIEW'''* Informationen über dieses Dokument** Allgemeines** Sprachliche Gleichbehandlung** Verbindlichkeit** Zielgruppe** Hinweis auf verwendete Grundlagen** Danksagung** Hinweise zur Nutzung des Leitfadens** Revisionsliste** Weitere unterstützende Materialien** Bedienungshinweise** Impressum* Harmonisierung* Einleitung** Ausgangssituation** Zweck** Hierarchie der Implementierungsleitfäden* Anwendungsfälle* Administrative Daten (CDA Header)* Fachlicher Inhalt (CDA Body)* Technische Konformitätsprüfung** Schema-Prüfung** Schematron-Prüfung** Online-Validation von CDA-Dokumenten* Anhang** Referenzen** Revisionsliste == Schematische Template-Darstellung ===
TODO: evtl. Grafikvorlage
=== Revisions =Revision ==
TODO:
* Versionierung: https://wiki.hl7.at/index.php?title=Hilfe:Leitfaden_erstellen#Versionierung
* PDF-Generierung: https://wiki.hl7.at/index.php?title=Hilfe:Leitfaden_erstellen#PDF_Generierung
TODO
Thew folowing checks help to identify possible errors or missing includes from Art-Decor. Templates from other repositories than under the governance from eHealth Suisse need to be imported separatly. Please send the necessary OID and related project information to the [mailto://support@art-decor.org Art-Decor Support].
Create a revision according to [[#Revisions | Wiki revisions]].
= Governance Verantwortliche Personen === Responsibilities ===== Support for Art-Decor ===
TODO
TODO
TODO
TODO
TODO
TODO
TODO: Prozess # muss eingehalten werden
