585
Bearbeitungen
Änderungen
→Art-Decor Projekt
{{#customtitle:Governance für die CDA-Leitfadenerstellung mit Art-Decor und Mediawiki(Version 1)}}
{{#css:
.toc{
}
}}
<pre class="ilfbox_code">
Governance für die CDA-Leitfadenerstellung mit Art-Decor und Mediawiki
Version: 1.1.1+20230503
Status: Final
</pre>
<!--
|Short = Art-Decor Governance
|Type = Governance
|Version = 0.1|Date = 073.115.20192023|Copyright = 2019 2021 - 20222025|Status = Draft|Period = 07.11.2019|OID = TODOFinal
|Realm = Österreich
|Submitted = 073.115.20192023}}
{{Versionbox Begin}}
{{VersionboxEntry | Version = 0.1 | Date = 15.1.2019 | Status = Draft | Inititalversion beim Workshop mit Tony Schaller (CH)}}
{{VersionboxEntry | Version = 0.2 | Date = 07.11.2019| Status = Draft| History=Überarbeitung und Einarbeitung der Erkenntnisse nach Erstellung des CDA-Leitfadens e-Impfpass}}
{{VersionboxEntry | Version = 1 | Date = 14.12.2021| Status = Final| History=Überarbeitung}}
{{VersionboxEntry | Version = 1.1.1 | Date = 3.5.2023| Status = Final| History=Überarbeitung Kapitel Value Sets}}
{{Versionbox End}}
-->
|-
! Status
| DraftFinal
|-
! Document version
| 0.21
|-
! Authors
|
* Andrea Klostermann (ELGA GmbH)
* Gabriel Kleinoscheg (ELGA GmbH)
* Stefan Sabutsch (ELGA GmbH)
|}
-->
= Zusammenfassung Einleitung =Dieses Dokument enthält Richtlinien zur Erstellung von CDA-Implementierungsleitfäden mit Art-Decor® und Mediawiki und anderen Werkzeugen 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). Dieses Dokument wird laufend aktualisiert, sobald die Nutzer und beruhen auf den bisher gemachten Erfahrungen in der Tools einen neuen Konsens erzielenLeitfadenerstellung.
Weiters werden die notwendigen Verantwortlichkeiten und Prozesse definertdefiniert, um klare Strukturen für die Zusammenarbeit zwischen Art-Decor Decor®, Wiki und dem Wiki 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 hauptsächlich den Einsatz der Tools Art-Decor und Mediawiki, begleitet von Do's und Don'ts für Österreich. Es definiert Regeln und Strukturen, die von allen Anwendern dieser Werkzeuge eingehalten werden müssen.{{BeginYellowBox}}''Wichtiger Hinweis:'' Informationen zum Erstellungsprozess von Art-Decor CDA-Implementierungsleitfäden finden Sie unter[[HILFE:Art-Decor Leitfadenerstellung |'''Prozess der CDA-Leitfadenerstellung in Art-Decor''']].{{EndYellowBox}}
= Weiterentwicklung des Dokuments =
Dieses Dokument enthält die aktuellsten Fragen und Entscheidungen aktuellen Festlegungen bezüglich der Arbeit mit Art-Decor Decor®, Mediawiki und Mediawiki 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 Austria 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* '''[Titel]'''* OID: '''[OID]''' ''Beispiel:'' HL7 Austria & ELGA HL7 CDA® R2 Implementierungsleitfaden Labor- 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-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 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-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:{{EndYellowBoxBeginValueSetBox}}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.{{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-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:*[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 (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. ===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"]). {||-| [[Datei:Kyellow.png|15px|rahmenlos|left]]||Entwurf: Das Template verbleibt bis zur Veröffentlichung im Status „Entwurf“ und ist bearbeitbar.|-|[[Datei:Kgreen.png|15px|rahmenlos|left]]||Aktiv: Gültiges Template, dessen Inhalt nicht mehr verändert werden kann. Zum Bearbeiten (Entwurf) muss das Template eine neue Version bekommen.|-|[[Datei:Kdeprecblue.png|15px|rahmenlos|left]]||Veraltet: Aktive Templates, die nicht mehr verwendet werden sollen, können in den Status „veraltet“ versetzt werden. Dieser Status ist endgültig.|} {| class="wikitable"|-|[[Datei:TemplateStatuswechsel2021-9-22.png|top]]|| '''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 [[https://confluence.elga.gv.at/display/SCCTERM/Versionierung 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 [https://confluence.elga.gv.at/display/SCCTERM/Versionierung 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 [https://confluence.elga.gv.at/display/SCCTERM/Versionierung 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.''|} = 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 [https://www.art-decor.org/mediawiki/index.php?title=DECOR-dataset#Dataset_versioning 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 [https://www.art-decor.org/mediawiki/index.php?title=ART_Dataset_Editor ART Dataset Editor] zu finden. == Name ==Es gibt keine speziellen Namenskonoventionen, der '''Name''' ist jedoch '''anzugeben'''! == Inhalt ==Es ist eine '''Beschreibung''' und der '''Werttyp/Valuetype''' anzugeben. '''Wenn vorhanden''' muss zusätzlich angegeben werden:
===OID Vorbedingungen für Implementierungsleitfäden=die Erstellung neuer Templates=={{BeginYellowBox}}''Wichtiger Hinweis:'' Für '''jeden Implementierungsleitfaden''' muss Bevor neue Templates erstellt werden, sollte geprüft werden, ob bestehende Templates (über das OIDbestenfalls im at-cda-Portalbbr) eine OID , die Anforderungen bereits erfüllen. Gibt es passende Templates können diese durch '''unterhalb des Knotens 1.2.40.0.34.7Referenzierung''' (eHealth-Austria/documentsunveränderte Übernahme) '''registriert''' mittels Kettensymbol in das bestehende Projekt übernommen werden.{{EndYellowBox}}Falls Dokumente in aufeinander aufbauenden Versionen vorliegenIn diesem Fall sind keine Änderungen an dem Template möglich! Diese Funktion sollte nur verwendet werden, kann dafür darunter eine zusätzliche Ebene angelegt werdenwenn es bereits ein passendes ELGA-/e-Health-Template gibt.
===Art-Decor Root OID=Vorbedingungen für Änderungen bestehender Templates==Als neuer '''Root-Knoten für Art-Decor''' Bevor ein bestehendes Template geändert wird 1.2.40.0.34'''.6.0''' (eHealth-Austria/servicesErstellung einer neuen Version, welche automatisch von allen dynamisch referenzierenden Templates verwendet wird) verwendet. Er enthält OID für Value Sets und Templates.<br>====Root OID für Templates ====Alle Art-Decor '''Templates''' müssen unterhalb des OID-Knotes 1, ist zu überprüfen, wie sich diese Änderung auf andere Leitfäden auswirkt bzw.2ob diese gewünscht ist.40.0.34.6.0'''.11''' liegen (eHealth-Austria/services/art-decor/templates).Die OID In allen betroffenen Leitfäden muss die Änderung auf der Art-Decor Templates sollen außerdem '''entsprechend ihres CDA-Template-Typs''' aus folgender Unterknoten vergeben Diskussionsseite im Abschnitt "Ausblick" festgehalten werden:.
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::*'Vorgaben ''[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 andere Entries::*"other" : alle Templates?/Fragmente, die nicht in obige Kategorien fallen ("Template type not specified")::*'''[ElementName]: TODO'''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.
<code><nowiki>https:Beispiel::*Versions//art-Label: '''YYYYMMdecor.org/temple/views/temple.Korrekturnummer(-beta)'''html?id=</nowiki>[OID des Templates]&[effectiveDate]&[prefix]&[language]&mode=readonly</code>
der ''Hinweise'XML-Code jedes Templates''' via [https://www.art-decor.org/mediawiki/index.php?title=Temple '' <br>Die "Korrekturnummer" ist 'Temple'optional'': bei Änderungen innerhalb eines Monats wird diese angehängt] (im Lesemodus) anzeigen und anschließend kopieren. Der Inhalt kann dann in ein neu erstelltes Template eingefügt werden.<br>"Beta" wird nur bei Value Sets verwendetDabei ist zu beachten, dass der '''Zeitpunkt (effectiveDate)''' und die noch bearbeitet '''OID des neu erstellten Templates nicht verändert''' werden. Alle weiteren Inhalte können entsprechend angepasst werden. Sobald Die OID muss in einem späteren Arbeitsschritt über die Version gültig ist, wird das "beta" entferntGUI korrigiert werden.
<code><nowiki>https:Die im ATCDABBR befindlichen Templates dürfen nur von einem eingeschränkten Benutzerkreis bearbeitet werden//art-decor.org/temple/views/temple.html?id=</nowiki>2.16.756.5.30.1.1.10.2.63&effectiveDate=2020-06-26T00:Verantwortlichkeiten und Prozesse sind im Kapitel [[#Revision]] beschrieben.00:00&prefix=cdachvacd-&language=de-DE&mode=readonly</code>
==Inhalt = Projektverzeichnisse ===* e-Impfpass (Pilot)* Basisleitfäden (alte Versionen)* TODO
<ref groupcode><element name="hl7:templateId[@root='1.3.6.1.4.1.19376.1.3.3.2.1']" datatype="AbbildungII" conformance="NP">Default state diagram for Art-Decor artefacts</refcode> ''Default state diagram for Art-Decor artefacts''
<brcode><ref group="Tabelle"/element>Art-Decor state machine</refcode> ''Art-Decor state machine''{| class="hl7table"! width="80px" | Status !! Action !! Trigger / Description !! Example for CDA-CH !! Responsibility
|-
| [[File:Kyellowcolspan="1" |1..png1 R|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="1" maximumMultiplicity="1" conformance="R"></a for CDA-CH as review necessary.''| Developercode>
|-
| 1..* R| considererlaubt| 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<code><element name="hl7:id" datatype="II" minimumMultiplicity="1" maximumMultiplicity="*" conformance="R"></team of the repositorycode>|-| colspan="1" |0..1 R| colspan="1" |nicht erlaubt| colspan="1" |<code><element name="hl7:id[not(@nullFlavor)]" datatype="II" minimumMultiplicity="0" maximumMultiplicity="1" conformance="R"></code>| ''final draft for a CDA-CH V2 template ready to review| colspan="1" |0..''* R| colspan="1" |nicht erlaubt| Developer colspan="1" |<code><element name="hl7:id[not(info to the Reviewer@nullFlavor) ]" datatype="II" minimumMultiplicity="0" maximumMultiplicity="*" conformance="R"></code>|-| colspan="1" |0..1 O| colspan="1" |erlaubt| colspan="1" |<code><element name="hl7:id" datatype="II" minimumMultiplicity="0" maximumMultiplicity="1"></code>|-| colspan="1" |0..* O| colspan="1" |erlaubt| colspan="1" |<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 = 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}} === Templates =Name ==Elemente '''Name''' und Attribute, die im Template verwendet '''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 zu dokumentierennicht erlaubt. Die Beziehung zu anderen Templates ist anzugeben, um festzuhaltenAls Präfix dient das Projektkürzel (Name des Repositories), wie sie sich zueinander verhalten (z.B. Spezialisierung, Anpassung usw"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).<br><br>TODO''Beispiele'': prüfen <br>Other elements that were in addition available according the HL7 CDA standard shall not be mentioned in the * 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 templateGovernance Group Value Sets'''] (Vorsicht!: lange Ladezeit) ermittelt werden.{{EndYellowBox}} * Open vs== Version & 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. Closed 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 Templateseinfügt. Name
=Szenarios / Schematron = Schematische TemplateDas Erstellen von '''einer Transaktion pro DLT''' in den Szenarien ist für die Generierung von Schematron-Darstellung ==TODORegeln '''zwingend erforderlich''', siehe [https: evtl//confluence.elga.gv.at/display/SCC/Schematron-Erstellung+und+Bereitstellung Schematron-Erstellung und Bereitstellung]. Grafikvorlage
== Wiki Name ====Check before finalizing==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 Der Name/Label der Transaktionen soll dem Schema '''[mailto://support@art-decorNameDesSzenarios]''' folgen.org Art-Decor Support]Alles zusammengeschrieben, kein Prefix.
= Verantwortliche Personen Qualitätssicherung === Support for Art-Decor ==TODO
== Governance Groups Art-Decor ==TODOOffizielle Informationen zur Qualitätssicherung eines Projekts in Art-Decor 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].
== 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"
= Qualitätssicherung und Review = GitLab ==== ArtEine 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-Decor Repository ==TODOValidierung) gestartet.
=Anhang = ELGA Implementierungsleitfäden == Links ==TODO: Prozess # muss eingehalten werden
* [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=Willkommen_auf_dem_Wiki-Portal_von_HL7_Austria eHealth Wiki]* & [https://wiki.hl7.at/index.php?title=Hilfe:Wiki Wiki Hilfe] ==Abbildungsverzeichnis==<references group="Abbildung"/> ==Tabellenverzeichnis==<references group="Tabelle"/> ==Zur Diskussion stehende Änderungsvorschläge==TODO