1.104
Bearbeitungen
Änderungen
keine Bearbeitungszusammenfassung
|description= Hier finden Sie eine Erklärung zu der Erstellung von CDA-Leitfäden mit Art-Decor.
}}
<br>
Eine Übersicht '''verfügbarer Anleitungen''' sind unter [https://www.art-decor.org/mediawiki/index.php?title=ART_user_manual '''ART user manualmanuals'''] aufgelistet.{{EndYellowBox}}Folgende Vorgehensweisen werden bei der Erstellung von Leitfäden als '''Best Practices''' empfohlen.
==Projekt erstellen(überarbeitet aber komplett übernommen)==Ein neuer CDA-Leitfaden '''muss''' in einem eigenen Projektverzeichnis angelegt , alle Autoren müssen entsprechend berechtigt werden. Dies muss gegebenenfalls beim [https://www.art-decor.org/mediawiki/index.php?title=Contact Art-Decor-Support] beantragt werden.
Informationen zu den Funktionen des Projekt-Editors finden Sie unter [https://www.art-decor.org/mediawiki/index.php?title=ART_Project_Editor ART Project Editor].
==Datasets erstellen(überarbeitet aber komplett übernommen)==Die Modellierung der Datasets soll in enger Abstimmung mit Experten der Arbeitsgruppe erfolgen.Es ist gute Praxis, bestehende Standards bereits unter Einbeziehung potentiell bei der Modellierung der Datasets zu verwendender Standards berücksichtigen (z.B. IHE ProfilePCC). Wenn möglich sollen bestehende Dataset-Elemente verwendet werden oder von diesen geerbt werden ([https://www.art-decor.org/mediawiki/index.php?title=DECOR-dataset#Dataset_versioning Dataset versioning]).<br>
Die anzugebenden Inhalte eines Dataset-Elements sind in der [https://wiki.hl7.at/index.php?title=ART-DECOR_Governance&stable=0&redirect=no#Datasets Governance] festgelegt.
[https://www.art-decor.org/mediawiki/index.php?title=ART_Dataset_Editor ART Dataset Editor].
==Szenarios Szenario erstellen(überarbeitet aber komplett übernommen)==
Für '''jede''' Dokument-Ausprägung muss eine '''Transaktion''' erstellt werden. Diese ist für die Generierung von Schematronregeln erforderlich.<br>
Transaktionen stellen einen (Teil-)Satz von Konzepten enthalten Konzepte eines Datasets dar und ergänzen ihn diese um Kardinalität, Konformität und mögliche Bedingungen, damit die Anforderungen des Anwendungsfalles angemessen widergespiegelt werden. Die Angabe der Element-von Konformanz und Kardinalität der Dataset-Kardinalität Elemente kann nur in der Transaktion erfolgen, ist jedoch für die Erstellung eines Schematrons nicht zwingend erforderlich. <br>Eine Transaktion '''muss''' das entsprechedende [[Hilfe:Art-Decor_Leitfadenerstellung#Document_Level_Template_erstellen | #Document-Level-Template]] referenzieren (dies ist die technische Darstellung der Transaktion und der zugrunde liegenden Konzepte).<br><br>Die Bezeichnung Benennung der Transaktion soll der [[ART-DECOR_Governance#Governance_f.C3.BCr_die_CDA-Leitfadenerstellung_mit_Art-Decor | Governance für die CDA-Leitfadenerstellung mit Art-Decor]] folgen.<br>
Eine Beschreibung zur Erstellung von Transaktionen finden Sie unter [https://www.art-decor.org/mediawiki/index.php?title=ART_Scenario_Editor ART Scenario Editor].
==Referenzen auf andere Projektverzeichnisse setzen(überarbeitet aber komplett übernommen)==Um bestehende Templates anderer '''Building Block Repositories''' referenzieren zu können, müssen die entsprechenden Verzeichnisse dem Projekt hinzugefügt werden ({{BeginYellowBox}}''Empfehlung: ATCDABBR'' Dem Projekt Referenzen für ad1bbr-, ad2bbr-, at-cda-bbr-, IHE-PCC- hinzufügen).<br>{{EndYellowBox}}
Eine Anleitung hierfür finden Sie unter [https://www.art-decor.org/mediawiki/index.php?title=ART_Project_Editor#Reference_a_building_block_repository Reference a building block repository].
==Templates erstellenund referenzieren (überarbeitet aber komplett übernommen)==
Hinsichtlich OID, Namensgebung, Beschreibung und Inhalte neuer Templates sind die Richtlinien der [[ART-DECOR_Governance#Governance_f.C3.BCr_die_CDA-Leitfadenerstellung_mit_Art-Decor | Governance für die CDA-Leitfadenerstellung mit Art-Decor]] einzuhalten.<br>
Alle Funktionen des Template Editors finden Sie unter [https://www.art-decor.org/mediawiki/index.php?title=ART_Template_Editor#Creating_a_link_to_a_template_that_resides_in_a_BBR '''ART Temple Editor'''].
====Übernahme Referenzieren bestehender Templates=(überarbeitet aber komplett übernommen)===Alle bestehenden Templates werden unter Unter dem Link [https://art-decor.org/art-decor/decor-governance-group?id=1.2.4016.0840.341.3113883.12.2 16 '''Art-Decor Governance Group'''] sind die Templates der HL7 Austria aufgelistet.<br>
Um herauszufinden, welche Art-Decor Projekte (auch außerhalb der eigenen Governance-Group) bereits ein bestimmtes Template umgesetzt haben, kann man im Menüpunkt '''„Auge“''' (links oben in der ArtDecor-Projektseite), die Template-ID oder den Namen eines Templates angeben -> alle Templates mit zugehörigem Projekt werden aufgelistet.<br>
Je nachdem, ob das Projekt, in dem sich das zu übernehmende Template befindet, im eigenen Projekt verlinkt ist, muss wie folgt vorgegangen werden:
:* Keine Änderung des Templates möglich!
:* Nur verwenden, wenn es bereits ein passendes ELGA-/e-Health-Template gibt
* '''Ableitung''' des Templates (Kopieren und Anpassen''' ) (siehe [https://www.art-decor.org/mediawiki/index.php?title=ART_Template_Editor#Creating_a_new_version_of_an_existing_template Neue Version eines bestehenden Templateserzeugen])
:* Ein passendes Template wird via „+“-Symbol als Prototyp angegeben, welches im Anschluss spezifiziert werden muss (neue OID).
:<code><nowiki>https://art-decor.org/temple/modules/temple.xquery?id=[OID des Templates]</nowiki></code>
der '''XML-Code jedes Templates''' via [https://www.art-decor.org/mediawiki/index.php?title=Temple '''Temple'''] (im Lesemodus) anzeigen und anschließend kopieren. Der kopierte Inhalt kann dann in ein neu erstelltes, leeres Template (mittels "+" und "Create from scratch") erstelltes Template eingefügt werden. Dabei ist zu beachten, dass der '''Zeitpunkt (effectiveDate)''' und die '''OID des neu erstellten Templates nicht verändert''' werden! Alle weiteren Inhalte können entsprechend angepasst werden. <br>:Die OID muss in einem späteren Arbeitsschritt über die GUI korrigiert werden.
* Der '''Name''' eines Templates (nicht der Display-Name!) kann nach dem Erstellen des Templates nur mittels [https://www.art-decor.org/mediawiki/index.php?title=Temple '''Temple'''] geändert werden! Die Änderung des Namens hat keinen Einfluss auf die Referenzierung durch andere Templates -> hier gilt die '''OID'''. Der Display-Name kann jederzeit über GUI oder Temple geändert werden.
* Wird die OID geändert, wenn das Template bereits durch andere Templates refereziert wird, werden alle bestehenden Referenzen darauf '''ungültig'''! Daher vor der Änderung der OID die Liste aller referenzierenden Templates abspeichern und diese hinsichtlich der neuen OID anpassen!
* Wird ein Template (im Entwurf-Status!) nicht mehr benötigt, soll der Inhalt gelöscht und ein dummy-Name sowie eine dummy-OID (z.B. OID Ändern auf Zweig 1.2.40.0.34.6.0.11'''.777.'''xxx) vergeben werden. Dies steht somit zur späteren Verwendung frei. 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.
{{BeginYellowBox}}
''Wichtiger Hinweis:'' Sollte das Template bereits produktiv sein ("active"), finden Sie Informationen unter [[Hilfe:Art-Decor_Leitfadenerstellung#Versionierung|'''Versionierung''']].
{{EndYellowBox}}
==Inhalte von Templates==
===Template Metadaten===
Hinsichtlich folgender Elemente gelten die Vorgaben der Governance.
====Templatename (überarbeitet aber komplett übernommen)====
Es gelten die Definitionen der Governance hinsichtlich [https://wiki.hl7.at/index.php?title=ART-DECOR_Governance#Namens-_und_Versionierungs-Konventionen Namenskonventionen]
====Versions-Label (überarbeitet aber komplett übernommen)====
Es gelten die Definitionen der Governance hinsichtlich [https://wiki.hl7.at/index.php?title=ART-DECOR_Governance#Namens-_und_Versionierungs-Konventionen Versionierungskonventionen]
====Item-Label (entfällt)====
Es gelten die Definitionen der Governance hinsichtlich [https://wiki.hl7.at/index.php?title=ART-DECOR_Governance#Item-Label Item-Label]
====Relationships (überarbeitet aber komplett übernommen)====
Wenn Beziehungen zu anderen Templates bestehen (z.B. Spezialisierung), sollen diese in den Template-Metadaten des neu erstellten Templates ersichtlich sein.
Die Arten der anzugebenden '''Beziehungstypen''' sind der Governance unter [[ART-DECOR_Governance#Ableitung_von_Templates|Ableitung von Templates]] beschrieben.
Die Template-ID des Basistemplates wird nur zu Zwecken der Nachvollziehbarkeit in den Metadaten angegeben, in der Templatespezifikation selbst muss sie entfernt werden, da dies sonst bei der Generierung von "closed" Schematron-Regeln zu Inkonsistenzen und zu falsch-positiven Schematron-Fehlern bei der Validierung führen kann.
====Erstellung neuer TemplatesBeispiel-Snippets (überarbeitet aber komplett übernommen)====* Wenn neue Templates erstellt werden, vergibt ArtCode-Snippet-Decor per Default eine Gerüste können mit dem Projektverzeichnis untergeordnete '''OID''', welche nach den Vorgaben der [https://wiki.hl7.at/index.php?title="Zaubstab" im ART-DECOR_Governance#Art-Decor_Root_OID Governance] geändert Template Editor erzeugt werden muss (siehe [https://www.art-decor.org/mediawiki/index.php?title=ART_Template_Editor#Metadata MetadataInsert_example '''Insert example''']).:Hierfür die Governance Seite aufrufen und alle bestehenden * In '''allen Templates''' (außer DLTs) werden nur '''Code-Snippets''' des betreffenden Templates auflisten lassenselbst eingefügt. Beispiel-Snippets werden in der Regel nur zum Template selbst erstellt, sodass deren Wiederverwendbarkeit geprüft und Nachschau gehalten nicht aber zu den darin verlinkten Templates (z.B. included Entries).* Code-Snippets sollen immer '''zuletzt''' ergänzt werden kann, welche OID als nächstes vergeben werden darfum den Aufwand nach Änderungen im Template gering zu halten.
===Inhalte von Templates===Hinsichtlich folgender Elemente gelten die Vorgaben der Governance.====TemplatenameStandard-Referenzen (überarbeitet aber komplett übernommen)====Es gelten die Definitionen der Governance hinsichtlich [https://wiki.hl7.at/index.php?title=ARTDaten-DECOR_Governance#Templatename Templatename]====Versionsund Template-Elemente sollen in ihrem Label====Es gelten die Definitionen zu der entsprechenden Spezifikation verlinken, auf der Governance hinsichtlich [https://wikisie basieren (z.hl7B.at/indexIHE PHARM, Kap.php?title=ART-DECOR_Governance#Versions-Label Versions-Label]====Item-Label====Es gelten die Definitionen der Governance hinsichtlich [https://wiki4.hl74).at/indexDies liegt in der Verantwortung des Entwicklers.php?title=ART-DECOR_Governance#Item-Label Item-Label]
====BeispielXDS-Metadaten-SnippetsMapping (komplett übernommen)====In '''allen Templates''' (außer DLTs) Elemente die auf XDS-Metadaten gemappt werden nur '''Codemüssen, sollen mit "↔ Hinweis zum XDS-Snippets''' eingefügt. Snippets zu den Entries werden nur im Entry selbst und nicht im aufrufenden Template angeführtMapping" gekennzeichnet sein. <br>Code-Snippets sollen immer Beispiel:<br>'''zuletzt↔ Hinweis zum XDS-Mapping:''' ergänzt werden, um den Aufwand nach Änderungen im Template gering zu haltenDas templateId-Element mit einer Extension beginnend mit "XDSdocumentEntry.formatCode^" wird ins XDS-Attribut formatCode gemappt (ohne Präfix XDSdocumentEntry.formatCode^)
====MetadatenVerwendung von Template-Compilations (komplett übernommen)====TODO: Hinweis auf MetadataCompilations sind Template-MappingFragmente, wie z.B. Adressinformationen. Da sich diese mehrfach wiederholen können, sollen sie mit "contains" eingebunden werden (d.h. der Inhalt der Compilation wird nicht im verlinkenden Template angezeigt). Diese sollen aber im Leitfaden als eigene Kapitel vorhanden sein.
===Document Level Template erstellen(überarbeitet aber komplett übernommen)===
Für '''jede Dokumentart''' (jede Transaktion) muss ein neues Document-Level-Template (DLT) erstellt werden (nach Vorgaben der [[ART-DECOR_Governance#Governance_f.C3.BCr_die_CDA-Leitfadenerstellung_mit_Art-Decor | Governance]]).<br>
''Anmerkung: Solange das DLT noch nicht in der Transaktion des Szenarios verlinkt ist, wird dessen Label (im Template-Baum) als oranges Dreieck mit Pfeilen angezeigt, sonst als oranges Viereck/Buch.''<br>
====Workflow Document Level Template erstellen(überarbeitet und teilweise übernommen)====# Neues DTL DLT anlegen: Angabe Name, Version Label, Display Name laut Governance, dann Template mit der von Art-Decor per default vergebenen OID speichern
# Anschließend OID entsprechend Governance korrigieren (Template bearbeiten, "#")(nur über GUI möglich, nicht via Temple).
# Kopieren „Included Templates“ aus DLT-Header mit Kettensymbol zum Projekt hinzufügenTipps (entfällt):* Zur Vereinfachung kann der Inhalte Inhalt eines bestehenden DLT (XML via Temple) als XML kopiert und in das neue Template einfügen werden (effective DATE und OID bleiben erhalten).# * Inhaltliche Korrekturen und Anpassungen am Besten können auch in einem externen XML-Editor durchführen (z.B. Oxygen) durchgeführt und dann in Temple einfügeneingefügt werden.# „Included Templates“ aus DTL-Header mit Kettensymbol zum Projekt hinzufügen
====Referenzierte Header Level Templates (überarbeitet aber komplett übernommen)====Der Großteil der Header Level Templates werden aus dem at-cda-bbr (Allgemeiner Leitfaden - ALF) referenziert. Für die Referenzierung dieser gibt es folgende Vorgaben:* Alle verwendeten ALF Header Templates werden im speziellen Leitfaden, in welchem sie verwendet werden, als "new template reference" ins Projekt geladen.* Die verwendeten ALF Header Templates werden mit include im Document Level Template abgebildet.* Die verwendeten AILF Header Templates werden nicht nochmals eigens in die Leitfäden (z.B. unter 10.2.2 Header Level Templates) referenziert, da sie im DLT abgebildet sind. ==Dataset-Mapping erstellen (überarbeitet aber komplett übernommen)==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 (auch für die Experten-/Arbeitsgruppe), dass alle erforderlichen Dataset-Elemente in den Templates modelliert wurden. [https://www.art-decor.org/mediawiki/index.php?title=ART_Template_Associations ART Template Associations] ==Terminologien hinzufügen(überarbeitet aber komplett übernommen)==
Bestehende ValueSets können mit Kettensymbol unter Value-Sets hinzugefügt werden
* [https://wiki.hl7.at/index.php?title=ART-DECOR_Governance&stable=0&redirect=no#Bezeichnungen_f.C3.BCr_Value_Sets Namenskonventionen für die Erstellung neuer Value Sets]
==Dataset-Mapping erstellenTesten und Fehlerbehebung (überarbeitet aber komplett übernommen)==Die Zuordnung Um die Qualität eines Projekts zu überprüfen, können eine Reihe von Datensatz-Elementen und erstellten Templates Prüfungen durchgeführt werden, bevor eine Publikation erstellt wird empfohlen. Dadurch sind alle mit einem Template assoziierten Konzepte in der Template Informationen zu den entsprechenden Funktionalitäten des ART Project Editors finden Sie unter [https://www.art-Beschreibung zusammengefasst, sowie direkt beim assoziierten CDA-Element bzwdecor.org/mediawiki/index. Attribut des Templates ersichtlichphp?title=ART_Project_Editor#Preflighting%20publication%20and%20quality%20checks Preflighting publication and quality checks]. Dies dient der Kontrolle ===Workflow Decor Prüfung===Die Decor Prüfung testet, dass alle erforderlichen Datensatz-Elemente in den Templates modelliert wurdenob das Projektschema gültig ist und Schematronregeln erstellt werden können.
Menü Projekt – Entwicklung:* "Decor prüfen": Prüfung über gesamtes Modell:* "Optionale Prüfungen konfigurieren": alle Optionen auswählen:* Schema und Schematron-Prüfung durchführen, eventuelle Fehler werden aufgelistet. ==Schematron erstellen (überarbeitet aber komplett übernommen: https://confluence.elga.gv.at/display/SCC/Schematron-Erstellung+und+Bereitstellung)== Generell gilt:* Mithilfe von ISO Schematron kann geprüft werden, ob ein gültiges HL7 CDA Dokument (HL7 v3) vorliegt, während eine XSD-Schemaprüfung, nur prüft ob ein gültiges XML Dokument vorliegt.* Aus den modellierten Templates können über Art-Decor automatisch Schematronregeln generiert werden.* Wenn zusätzliche Geschäftsregeln geprüft werden sollen, die nicht in den Templates modelliert sind, müssen die dazu notwendigen Asserts von Hand eingetragen werden (z.B. Logik: Schwangerschaftsstatus, prüfen ob Impfempfehlung in diesem Jahr noch gültig).* Informationen zu den entsprechenden Art-Decor Tool finden Sie unter [https://www.art-decor.org/mediawiki/index.php?title=ART_Template_Associations ART Live_Runtime_Compile Live Runtime Compile (LRC)].* Es wird empfohlen, bereits während der Modellierung regelmäßig eine Kompilierung durchzuführen (z.B. nachdem ein DLT mit Header und noch leerem structuredBody erstellt wurde), um zu testen, ob das Projektschema noch gültig ist.* Art-Decor bietet die Möglichkeit nach korrekter Schematron-Generierung ein Beispieldokument zu prüfen. ===Workflow Schematron erzeugen ===Menü Projekt – Entwicklung:* "Compiliere Entwicklungsversion": :* "Optionale Prüfungen konfigurieren": Optionen "Force recompile", "Explicit includes", "Schematron geschlossen" (falls gewünscht):* Bei jeder Compilierung entsteht eine neuer Listeneintrag, das zip-File kann gespeichert werden um lokal Beispieldokumente zu validieren -> Achtung, nur die jeweils letzten beiden Versionen bleiben zum Download verfügbar! :* Nach Publikation soll nur die letzte, gültige Schematron-Version verfügbar sein (alle restliche können entfernt werden). ==Asserts erstellen (entfällt)== (TODO: OKU) ==Beispieldokumente (überarbeitet aber komplett übernommen=====Beispielbokumente erstellen===* Das Gerüst eines Beispieldokuments kann erstellt werden, indem man im entsprechenden DLT den Zauberstab des Template Associations]Editors anwendet und rekursiv alle Code-Snippets der darin verlinkten Templates einfügt.
==Testen und Fehlerbehebung=Beispieldokumente validieren===Nachdem erfolgreich ein [https[Hilfe://www.artArt-decor.org/mediawiki/index.php?title=ART_Project_EditorDecor_Leitfadenerstellung#Preflighting%20publication%20and%20quality%20checks Preflighting publication and quality checksSchematron_erstellen|Schematron]] erstellt wurde, kann unter im Projekt Editor unter "Menü Projekt"–"Entwicklung"-"Compiliere Entwicklungsversion" im aktuellen Listeneintrag die Funktion "XML-Instanz validieren" ausgewählt werden und ein Beispieldokument hochgeladen werden.
=Publikation (überarbeitet aber komplett übernommen: https://confluence.elga.gv.at/display/SCC/Schematron-Erstellung+und+Bereitstellung)=Asserts erstellenInformationen zur Publikation eines Leitfadens in Art-Decor finden Sie unter [https://www.art-decor.org/mediawiki/index.php?title== (TODO)ART_Project_Editor#Creating_a_new_version_.2F_release_.2F_publication_request Creating a new version / release / publication request].
=Versionierung=
[https://www.art-decor.org/mediawiki/index.php?title=ART_Value_Set_Editor#Creating_a_new_version_of_a_value_set.2C_based_on_a_previous_version Creating a new version of a value set, based on a previous]