597
Bearbeitungen
Änderungen
→Art-Decor Projekt
{{#customtitle:Governance für die CDA-Leitfadenerstellung (Version 1)}}
{{#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;
}
}}
<pre class="ilfbox_code">
Governance für die CDA-Leitfadenerstellung mit Art-Decor und Mediawiki
Version: 1.1.1+20230503
Status: Final
</pre>
<!--
{{Infobox Dokument
|Title = Best Practices and Governance for für die CDA-Leitfadenerstellung mit Art-Decorund Mediawiki
|Short = Art-Decor Governance
|Type = Governance
{{Versionbox Begin}}
{{VersionboxEntry | Version = 0.1 | Date = 0215.021.2017 2019 | Status = Draft | History=Initial Draft for review on 03.02.2017 Inititalversion beim Workshop mit Tony Schaller (JGNCH)}}{{VersionboxEntry | Version = 0.2 | Date = 0307.0211.2017 2019| Status = Draft | History=Inputs from Telco on 03.02.2017: State Diagram for artefacts (JGN)Überarbeitung und Einarbeitung der Erkenntnisse nach Erstellung des CDA-Leitfadens e-Impfpass}}{{VersionboxEntry | Version = 0.3 1 | Date = 1514.0212.2017 2021| Status = Draft | History=Include comments from review (JBL, OEG, JGN, KHE, TSC)}}{{VersionboxEntry | Version = 0.4 | Date = 20.02.2017 | Status = Draft Final| History=finalize document for audit within HL7 & IHE Switzerland (JGN)}}{{VersionboxEntry | Version = 0.5 | Date = 28.02.2017 | Status = Draft | History=Include comments from review (Tony Schaller, IHE, HL7) (JGN, TSC)Überarbeitung}}{{VersionboxEntry | Version = 1.0 | Date = 21.03.2017 | Status = Final | DocumentLink=| History=First release}}{{VersionboxEntry | Version = 1.1 | Date = 073.055.2018 2023| Status = Draft Final| History=Changes according lessons learned from 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 | Art-Decor release notes]]</li></ul>Überarbeitung Kapitel Value Sets}}
{{Versionbox End}}
-->
|-
! Status
| DraftFinal
|-
! Document version
| 1.1
|-
! Authors
|
* Johannes Gnägi Andrea Klostermann (ELGA GmbH)* Gabriel Kleinoscheg (ELGA GmbH)* Stefan Sabutsch (ELGA GmbH)* Nikola Tanjga (ELGA GmbH)|}--> = 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. = 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. = 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.{{BeginYellowBox}}''Wichtiger Hinweis:'' Anfragen hinsichtlich der Änderung oder Erweiterung dieses Dokuments stellen Sie bitte an [mailto:office@hl7.at office@hl7.at].{{EndYellowBox}} =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.==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 [https://art-decor.org/art-decor/decor-governance-group?id=1.2.40.0.34.3.1.2 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 [https://art-decor.org/art-decor/decor-governance-group?id=2.16.840.1.113883.2.16 HL7 Austria Art Decor Governance Group], welche alle eHealth SuisseAustria Vorgaben umfasst. Dabei wird die hier beschriebene ELGA Governance auch für die HL7 Austria relevant und soll von dieser übernommen werden. ==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 [https://wiki.hl7.at/index.php?title=Hilfe:Wiki Leitfaden erstellen mit Mediawiki] nachzulesen. Die Einbindung eines neuen Leitfadens folgt einem vorgegebenen Prozess, dieser ist ersichtlich unter Benutzung von [https://wiki.hl7.at/index.php?title=Hilfe:Flagged_Revisions#Benutzung_von_Flagged_Revisions Flagged Revisions]. === Name ===Der '''Name''' eines Leitfadens wird wie folgt angegeben: * HL7 Austria & ELGA* HL7 CDA® R2 Implementierungsleitfaden* Sang'''[Titel]'''* OID: '''[OID]''' ''Beispiel:'' HL7 Austria & ELGA HL7 CDA® R2 Implementierungsleitfaden Labor-Il Kim und Mikrobiologiebefund OID: 1.2.40.0.34.7.4.9.3 ===OID===Im Zusammenhang mit der Verwendung von OID sind die österreichischen Richtlinien einzuhalten (siehe [https://www.gesundheit.gv.at/OID_Frontend/OID_Konzept_1-1-0.pdf Object Identifier (OID) Konzept für das österreichische Gesundheitswesen]). Das österreichische OID Portal ist zu finden unter [https://www.gesundheit.gv.at/OID_Frontend/ 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 Suisse-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"* Kai Heitmann *OID wird im OID-Portal beantragt (Heitmann Consulting and Services 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 beantragtDie 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 [https://confluence.elga.gv.at/display/SCCTERM/Versionierung Versionierung]. ===Version & Metadaten===Der Verwendung von Namespaces ist wesentlich für Versionierung der Wiki-Seiten mit Flagged Revisions.{{BeginYellowBox}}''Wichtiger Hinweis:'' Alle Seiten von CDA-Leitfäden müssen im Namespace ["ILF"] erstellt werden.{{EndYellowBox}}Das Wiki-Leitfadenprojekt DARF NICHT unabhängig vom ART-DECOR Open Tools-DLT versioniert werden, siehe [https://confluence.elga.gv.at/display/SCCTERM/Versionierung 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 [https://wiki.hl7.at/index.php?title=Hilfe:Wiki#Versionierung_von_Wiki-Seiten 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 [https://wiki.hl7.at/index.php?title=Hilfe:Leitfaden_erstellen#PDF_Generierung PDF-Generierung]). Eine Übersicht der Versionen eines Leitfadens findet sich im jeweiligen Guide (alle vorhandenen Guides sind zu finden unter [https://wiki.hl7.at/index.php?title=Implementierungsleitf%C3%A4den Übersicht der CDA Implementierungsleitfäden]. ===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 [https://de.wikipedia.org/wiki/Transklusion 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:LizenzinformationenFü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. =Art-Decor Projekt=Ein neuer CDA-Leitfaden '''muss''' in einem eigenen Projektverzeichnis angelegt, alle Autoren müssen entsprechend berechtigt werden. Dies muss beim [https://www.art-decor.org/mediawiki/index.php?title=Contact Art-Decor-Support] beantragt werden. Das neue Projekt kann am besten mit folgendem E-Mail-Template beantragt werden:{{BeginValueSetBox}}Dear Art-Decor-Support,we would like to ask you to create a new project in Art-Decor:* Jürg Bleuer Name: <'''displayName des Projekts'''>*Prefix: <'''Projektkürzel''' - soll immer mit at- beginnen, z.B. "at-emed-" oder "at-lab-" (eHealth SuisseVorweg: 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>* Tony Schaller Governance-Groups: ELGA, HL7 Austria*Wiki-Bot activated à wiki.hl7.at Thank you in advance.{{EndValueSetBox}} Eine Liste der Art-Decor Projekte ist unter der HL7-Austria Governance Group verfügbar [https://art-decor.org/art-decor/decor-governance-group?id=1.2.40.0.34.3.1.2 ELGA Art-Decor Governance Group]. Weitere offizielle Informationen sind unter [https://www.art-decor.org/mediawiki/index.php?title=ART_Project_Editor ART Project Editor] zu finden. ==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''". ==OID==Alle Art-Decor Projekte bekommen die unter ([https://art-decor.org/art-decor/decor-governance-group?id=1.2.40.0.34.3.1.2 Governance Group (art-decor.org)] -> Projects) einsehbaren OID mit der nächste ID im 1.2.40.0.34.777 Knoten. ==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 [[Datei:Image2021-6-24 13-41-12.png|200px]] darf nicht angehackt sein! Es wird empfohlen dem Projekt standardmäßig Referenzen zu den Building Block Repositories ''ad1bbr-, ad2bbr-, at-cda-bbr-, IHE Suisse-PCC-'' hinzuzufügen (siehe auch [https://www.art-decor.org/mediawiki/index.php?title=ART_Project_Editor#Reference_a_building_block_repository Reference a building block repository]). ==Inhalt==In Österreich kann derzeit folgendes bereichsspezifische '''Building Block Repository''' (BBR)für die Ableitung oder Referenzierung von Templates verwendet werden:* Oliver Egger [https://art-decor.org/art-decor/decor-project--at-cda-bbr- at-cda-bbr]Dies soll in Zukunft alle für Österreich relevanten Basis-Templates enthalten, die für spezifische Anwendungen (HL7 Benutzergruppe SchweizeHealth 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. ===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 [https://art-decor.org/mediawiki/index.php?title=ART_Template_Editor#Changing_the_status_of_a_template "Changing the status of a template"]). {|
|-
|}
{| class= Zusammenfassung ="wikitable"|-Dieses Dokument enthält Richtlinien zur Erstellung von CDA|[[Datei:TemplateStatuswechsel2021-9-Implementierungsleitfäden mit Art22.png|top]]|| '''Beschreibung Statuswechsel eines Templates (Diagramm)''' '''1.''' Bevor ein Template neu angelegt wird, soll überprüft werden, ob ein verwendbares Dummy-Decor® Template(*) vorhanden ist. Ein neues Template erhält immer Version 1.0.0 und der Dokumentation mit Mediawiki in Österreichhat den Status "'''Entwurf'''".
Weitere offizielle Informationen sind unter [https: '''//www.0 Documentart-Level Template''': '''.1 Header-Level Template''': '''decor.2 Section-Level Template''': '''org/mediawiki/index.3 Entry-Level Template''': '''php?title=ART_Dataset_Editor ART Dataset Editor] zu finden.9 other CDA Fragment Template'''
==VersionierungInhalt =====Versionierung von Templates =======Document-Level Templates====Für jede neue Version eines Document-Level Templates Es ist eine neue OID zu verwenden. Der Bezug zur alten OID ist '''Beschreibung''' und der '''Werttyp/Valuetype''' anzugeben. Dadurch wird die Anwendung der korrekten Schematron-Regeln gemäß dem getesteten CDA-Dokument sichergestellt.
''HinweiseInfo:'' <br>Die "Korrekturnummer" ist ''optional'': bei Änderungen innerhalb eines Monats wird diese angehängt.<br>"Beta" wird nur bei Value Sets verwendet, die Solange das DLT noch bearbeitet werden. Sobald die Version gültig nicht in der Transaktion des Szenarios verlinkt ist, wird das "beta" entferntdessen Label (im Template-Baum) als oranges Dreieck mit Pfeilen angezeigt, sonst als oranges Viereck/Buch.''
== Art-Decor Vorbedingungen für die Erstellung neuer Templates===== Repositories ======= Art-Decor Building Block Repository ====In Österreich kann derzeit folgendes bereichsspezifische '''Building Block Repository''' Bevor neue Templates erstellt werden, sollte geprüft werden, ob bestehende Templates (BBR) verwendet werden:*[https://art-decor.org/art-decor/decor-project--bestenfalls im at-cda-bbr- ), die Anforderungen bereits erfüllen. Gibt es passende Templates können diese durch '''ATCDABBRReferenzierung''']: Dies soll in Zukunft alle für Österreich relevanten Basis-Templates enthalten, die für spezifische Anwendungen (e-Health und ELGAunveränderte Übernahme) mittels Kettensymbol in die einzelnen Projektverzeichnisse abgeleitet verwendet das bestehende Projekt übernommen werden können. <br>:Derzeit In diesem Fall sind Templates für den CDAkeine Änderungen an dem Template möglich! Diese Funktion sollte nur verwendet werden, wenn es bereits ein passendes ELGA-Header sowie Basis-Templates für den /e-Impfpass vorhanden. Dieses Verzeichnis wird laufend erweitert. Nach Fertigstellung von CDAHealth-Leitfäden sollen entsprechende Templates in dieses Verzeichnis übernommen werdenTemplate gibt.
==Vorbedingungen für Änderungen bestehender Templates== Projektverzeichnisse ====* e-Impfpass (Pilot)* Basisleitfäden Bevor ein bestehendes Template geändert wird (alte VersionenErstellung einer neuen Version, welche automatisch von allen dynamisch referenzierenden Templates verwendet wird)* TODO, 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.
==== Artefaktstatus ==Name ==In einem Repository Template-Namen sind grundsätzlich in '''englischer Sprache''' zu vergeben, sodass sie entsprechend ihrer Definition in internationalen Standards beibehalten werden Artefakte zunächst im Status "Entwurf" erstellt. Nach Abschluss, Überprüfung können 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 VerantwortlichkeitenWiederverwendbarkeit bestehender Templates erleichtert wird.
=== Szenarios =OID ==Das Erstellen von 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::'''Transaktionen.0.''' im Rahmen von Szenarios ist für die Generierung von SchematronDocument-Regeln Level Template:'''.1.'''zwingend erforderlichHeader-Level Template:'''.<br>2.''' Section-Level TemplateDie Angabe von Kardinalität (optional, wiederholbar) und Konformität (erforderlich, obligatorisch) für die einzelnen Elemente des Datasets :'''.3.'''wird empfohlenEntry-Level Template:'''.9.''' other CDA Fragment Template
== Mediawiki Version & Metadaten ===== Structure of an Implementation Guide ===To ensure a consistent approach and display of the implementation guide, the following (minimum, German) structure is ''recommended'':
''Beispiel''Afterwards:''' Create a revision according to [[#Revisions | Wiki revisions]].
<code><nowiki>https://art-decor.org/temple/views/temple.html?id= Governance </nowiki>2.16.756.5.30.1.1.10.2.63&effectiveDate=2020-06-26T00:00:00&prefix=cdachvacd-&language= Responsibilities ===== Support for Artde-Decor ==DE&mode=TODOreadonly</code>
==Inhalt = Governance Groups ===TODO
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 [https://art-decor.org/mediawiki/index.php?title=DECOR-rules#Mandatory_.2F_Conformance Mandatory/Conformance]).{| class="wikitable"! colspan= "3" |Für Elemente|-!Vorgaben Allgemeiner Leitfaden! colspan="1" |Verwendung von nullFlavor!Umsetzung Art-Decor artifact states am Beispiel eines <code>id-</code>Elements mit dem Datentypen <code>II</code> (in Temple)|-|1..1 M| colspan="1" |nicht erlaubt|<code><element name="hl7:id" datatype="II" minimumMultiplicity="1" maximumMultiplicity="1" conformance="R" isMandatory="true"></code>|-| colspan="1" |1..* M| colspan="1" |nicht erlaubtThe following state| colspan="1" |<code><element name="hl7:id" datatype="II" minimumMultiplicity="1" maximumMultiplicity="*" conformance="R" isMandatory="true"></event diagram shows the default states and possbile transitions for an artifact within Artcode>|-Decor| colspan="1" |0..0 NP| colspan="1" |nicht erlaubt| colspan="1" |<code><element name="hl7:id" datatype="II" conformance="NP"></code>
<code> <attribute name="root" value="1.3.6.1.4.1.19376.1.3.3.2.1" datatype="uid" /></code>
<ref groupcode></element></code>|-| colspan="Tabelle1"|1..1 R| colspan="1" |erlaubt| colspan="1" |<code>Art<element name="hl7:id" datatype="II" minimumMultiplicity="1" maximumMultiplicity="1" conformance="R"></code>|-Decor state machine|1..* R|erlaubt|<code><element name="hl7:id" datatype="II" minimumMultiplicity="1" maximumMultiplicity="*" conformance="R"></refcode> ''Art|-Decor state machine''{| classcolspan="1" |0..1 R| colspan="hl7table1"|nicht erlaubt! width| colspan="80px1" | Status !! Action !! Trigger <code><element name="hl7:id[not(@nullFlavor)]" datatype="II" minimumMultiplicity="0" maximumMultiplicity="1" conformance="R"></ Description !! Example for CDAcode>|-CH !! Responsibility| colspan="1" |0..* R| colspan="1" |nicht erlaubt| colspan="1" |<code><element name="hl7:id[not(@nullFlavor)]" datatype="II" minimumMultiplicity="0" maximumMultiplicity="*" conformance="R"></code>
|-
| [[File:Kyellowcolspan="1" |0..png1 O|16px]] draftcolspan="1" | activateerlaubt| Artefact is finished and it is considered as final (no review needed).colspan="1" | ''n<code><element name="hl7:id" datatype="II" minimumMultiplicity="0" maximumMultiplicity="1"></a for CDA-CH as review necessary.''| Developercode>
|-
| colspan="1" |0..* O| considercolspan="1" | 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.erlaubt| ''final draft for a CDA-CH V2 template ready to review.''colspan="1" | Developer (info to the Reviewer) <code><element name="hl7:id" datatype="II" minimumMultiplicity="0" maximumMultiplicity="*"></code>
|-
| colspan="1" |0..1 C| cancelcolspan="1" | If an artefact is not further developed, it is cancelled.Abhängig vom Kontext| ''any developed draft template not to be used anymore.''colspan="1" | Developer<code><element name="hl7:id" datatype="II" minimumMultiplicity="0" maximumMultiplicity="1" conformace="C"></code>
|-
| [[File:Korangecolspan="1" |0..png* C| colspan="1" |16px]] pendingAbhängig vom Kontext| activatecolspan="1" |<code><element name="hl7:id" datatype="II" minimumMultiplicity="0" maximumMultiplicity="*" conformace="C"></code>| Upon decision of the review team.}{| ''CDA-CH V2 template has been reviewed within HL7 Switzerland and was considered to be ready for release.''class="wikitable"! colspan="2" | Review team of the repository. Für Attribute
|-
|-
| [[File:Kpurple0.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.''0 NP| Developer<attribute name="root" datatype="uid" prohibited="true"/>
|-
| [[File:Kgreencolspan="1" |1.png|16px]] active| review| Maintenance or update of a project/repository.1 R| ''Review CDA-CH template to consider it for CDA-CH v2.''colspan="1" | Repository <attribute name="root" datatype="uid"/ Project owner>
|-
| colspan="1" | retire| In case of a new version, the old version is retired in order to have only one valid version of an artefact0..1 O| ''A CDA-CH template is not used anymore or replaced by another one.''colspan="1" | Repository <attribute name="root" datatype="uid" isOptional="true"/ Project owner>
|-
| [[File:Korangecolspan="1" |1..png|16px]] pre-publication review 1 F| reactivatecolspan="1" | If updated and considered as final by the responsible person, the artefact is re-activated<attribute name="root" datatype="uid" value="1.3.6.1.4.1.19376.1.3.| ''template is reviewed within HL7 Switzerland and considered to be ready for release2.''| Repository 1"/ Project owner>
|-
| colspan="1" | retire0..1 F| colspan="1" | ''A CDA-CH template is not used anymore or replaced by another one<attribute name="root" datatype="uid" value="1.3.6.1.''| 4.1.19376.1.3.2.1" isOptional="true"/>
|}
=Value Sets = Quality Assurance Eine Anleitung zur Verwendung des Value Set Editors ist unter [https://www.art-decor.org/mediawiki/index.php?title=ART_Value_Set_Editor ART Value Set Editor] zu finden. {{BeginYellowBox}}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{{EndYellowBox}} == 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 == 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){{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/decor/services/GovernanceGroupList?gg=1.2.40.0.34.3.1.2&language=en-US&format=html#tabs1-valuesets1 '''ELGA Art-Decor Governance Group Value Sets'''] (Vorsicht!: lange Ladezeit) ermittelt werden.{{EndYellowBox}} == Version & Review Metadaten ==Versionierung: Siehe [https://confluence.elga.gv.at/display/SCCTERM/Versionierung Versionierung]. == 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.{{BeginYellowBox}}''Wichtiger Hinweis:'' Wenn sich die Gesamtbedeutung der Codes in einem Value Set ändert, muss die neue Version des Value Sets eine '''neue OID''' erhalten.{{EndYellowBox}} = 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. = Szenarios / Schematron =Das Erstellen von '''einer Transaktion pro DLT''' in den Szenarien ist für die Generierung von Schematron-Regeln '''zwingend erforderlich''', siehe [https://confluence.elga.gv.at/display/SCC/Schematron-Erstellung+und+Bereitstellung 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 [https://www.art-decor.org/mediawiki/index.php?title=ART_Scenario_Editor ART Scenario Editor] zu finden. == 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. == 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. = Qualitätssicherung = == Art-Decor ==Offizielle Informationen zur Qualitätssicherung eines Projekts in Art-Decor Repository finden sich auf der Seite [https://www.art-decor.org/mediawiki/index.php?title=ART_Project_Editor#Preflighting_publication_and_quality_checks 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 <code>hl7at:formatCode</code> 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 [https://confluence.elga.gv.at/display/SCC/Schematron-Erstellung+und+Bereitstellung 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) ==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 <code>hl7at:formatCode</code> auf der Wiki-Seite aktualisieren* Diskussionsseite aktualisieren** Diskussionsseiten sollen wie folgendes Beispiel aufgebaut sein ([[ILF_Diskussion:Telemonitoring-Episodenbericht_(Version_1)|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"
=== Implementation Guides =GitLab ==TODOEine 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.
= Annex Anhang ===Links==* [http://art-decor.org/art-decor/home Workspace]* [http://art-decor-open-tools.net Art-Decor Open Tools]* [http://e-health-wiki.ch/index.php/Hauptseite eHealth Wiki]* [http://www.e-health-suisse.ch eHealth Suisse]* [https://groups.google.com/d/forum/swiss-art-decor-implementors Art-Decor Google Group]
==List of FiguresLinks ==<references group="Abbildung"/>==List of Tables==<references group="Tabelle"/>
* [http://art-decor.org/art-decor/home Art-Decor Workspace]* [https://www.art-decor.org/mediawiki/index.php?title=Documentation Art-Decor Dokumentation]* Wiki-Portal von HL7 Austria: [https://wiki.hl7.at/index.php?title=List of future definitions=Willkommen_auf_dem_Wiki-Portal_von_HL7_Austria eHealth Wiki] & [https://wiki.hl7.at/index.php?title=TODOHilfe:Wiki Wiki Hilfe]