3.869
Bearbeitungen
Änderungen
→XDS-Metadaten-Mapping
|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==
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==
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==
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].
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'''].
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
* '''Kopieren und Anpassen''' eines Templates(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 Templates erzeugen])
:* Ein passendes Template wird via „+“-Symbol als Prototyp angegeben, welches im Anschluss spezifiziert werden muss (neue OID).
Die Übernahme vorhandener Templates aus Projektverzeichnissen, die '''NICHT verlinkt''' sind, ist nicht über die GUI möglich, da diese Templates nicht als Prototyp angegeben werden können (d.h. von ihnen kann nicht geerbt werden).<br>
Soll der Inhalt eines Templates trotzdem verwendet werden, lässt sich mittels Browser-Direktlink
:<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") 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>
Solange sich ein Template noch im Status [[ART-DECOR_Governance#Artefaktstatus|'''Entwurf''']] befindet, kann es jederzeit bearbeitet werden. Dabei ist folgendes zu beachten:
* 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.
''Wichtiger Hinweis:'' Sollte das Template bereits produktiv sein ("active"), finden Sie Informationen unter [[Hilfe:Art-Decor_Leitfadenerstellung#Versionierung|'''Versionierung''']].
{{EndYellowBox}}
===Inhalte von Templates===
====Beispiel-Snippets====
* Code-Snippet-Gerüste können mit dem "Zaubstab" im ART Template Editor erzeugt werden (siehe [https://www.art-decor.org/mediawiki/index.php?title=ART_Template_Editor#Insert_example '''Insert example''']). * In '''allen Templates''' (außer DLTs) werden nur '''Code-Snippets''' des betreffenden Templates selbst eingefügt. Beispiel-Snippets zu den Entries werden in der Regel nur im Entry zum Template selbst und erstellt, nicht im aufrufenden Template angeführtaber zu den darin verlinkten Templates (z.B. included Entries). <br>* Code-Snippets sollen immer '''zuletzt''' ergänzt werden, um den Aufwand nach Änderungen im Template gering zu halten.
====XDS-Metadaten-Mapping====TODOElemente die auf XDS-Metadaten gemappt werden müssen, sollen mit "↔ Hinweis zum XDS-Mapping" gekennzeichnet sein.<br>Beispiel: <br>'''↔ Hinweis auf Metadatazum XDS-Mapping:''' Das templateId-Element mit einer Extension beginnend mit "XDSdocumentEntry.formatCode^" wird ins XDS-Attribut formatCode gemappt (ohne Präfix XDSdocumentEntry.formatCode^)
===Document Level Template erstellen===
''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====
# Neues DTL DLT anlegen: Angabe Name, Version Label, Display Name laut Governance, dann Template 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:* 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==Dataset-Mapping erstellen==Die Zuordnung von Datensatz-Header Elementen und erstellten Templates wird empfohlen. Dadurch sind alle mit Kettensymbol zum Projekt hinzufügeneinem 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==
* [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==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.
==Schematron erstellen==
==Testen und Fehlerbehebung=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! [https://www.art* Nach Publikation soll nur die letzte, gültige Schematron-decor.org/mediawiki/indexVersion verfügbar sein (alle restliche können entfernt werden).php?title=ART_Project_Editor#Preflighting%20publication%20and%20quality%20checks Preflighting publication and quality checks]
==Asserts erstellen==
(TODO: OKU) ==Beispieldokumente =====Beispielbokumente erstellen===* Das Gerüst eines Beispieldokuments kann erstellt werden, indem man im entsprechenden DLT den Zauberstab des Template Editors anwendet und rekursiv alle Code-Snippets der darin verlinkten Templates einfügt. * In jedem '''Document-Level-Template''' soll nur ein '''Verweis''' auf ein vollständiges Beispieldokument angeführt werden (z.B. auf HL7.at), damit dies bei Bedarf angepasst werden kann. Änderungen im DLT erfordern sonst eine neue Template-ID!* Beispieldokument sollen immer '''zuletzt''' ergänzt werden, um den Aufwand nach Änderungen in Templates gering zu halten. ===Beispieldokumente validieren===Nachdem erfolgreich ein [[Hilfe:Art-Decor_Leitfadenerstellung#Schematron_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=Informationen zur Publikation eines Leitfadens in Art-Decor finden Sie unter [https://www.art-decor.org/mediawiki/index.php?title=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]
