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, soll von bereits vorhanden sollen bestehende Dataset-Elementen Elemente verwendet werden oder von diesen geerbt werden und diese, falls erforderlich, enterbt und den speziellen Anforderungen angepasst 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 '''mussTransaktion''' 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. Dies 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''' aber 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'''].
====Erstellung neuer TemplatesNicht verlinktes Projektverzeichnis (komplett übernommen)====* Wenn neue Die Übernahme vorhandener Templates erstellt werdenaus Projektverzeichnissen, vergibt Art-Decor per Default eine dem Projektverzeichnis untergeordnete OID, welche nach den Vorgaben der [https://wiki.hl7.at/index.php?title=ART-DECOR_Governance#Art-Decor_Root_OID Governance] geändert werden muss (siehe [[ART_Template_Editor#Metadata | Metadata]]).* Der die '''NameNICHT verlinkt''' eines Templates (sind, ist nicht der Anzeigename!) kann später nur mittels [https://www.art-decor.org/mediawiki/index.php?title=Temple '''Temple'''] geändert werden! Die Änderung hat des Namens hat keinen Einfluss auf die Referenzierung durch andere Templates -> hier gilt über die '''OID'''). * Wird die OID geändert, wenn das Template bereits durch andere Templates refereziert wirdGUI möglich, werden alle bestehenden Referenzen '''ungültig'''! Daher vor der Änderung der OID die Liste aller referenzierenden Templates abspeichern und da diese hinsichtlich der neuen OID anpassen!* Templates anderer Projekte, welche im eigenen Projekt nicht referenziert werden, können nicht als Prototyp angegeben werden können (d.h. von ihnen kann nicht geerbt werden)! .<br>Soll der Inhalt eines Templates trotzdem verwendet werden, empfiehlt lässt sich folgende Vorgehensweise: Mittels Linkmittels Browser-Direktlink
:<code><nowiki>https://art-decor.org/temple/modules/temple.xquery?id=[OID des Templates]</nowiki></code>
===Document Level Template erstellenÄnderung bestehender Templates (überarbeitet aber komplett übernommen)===*Für jede Transaktion (jede Dokumentart) muss Solange sich ein neues Document-Level-Template (DLT) erstellt werden (nach Vorgaben der noch im Status [[ART-DECOR_Governance#Governance_f.C3.BCr_die_CDA-Leitfadenerstellung_mit_Art-Decor Artefaktstatus| Governance'''Entwurf''']])befindet, kann es bearbeitet werden. Dabei ist folgendes zu beachten:* Falls bereits andere Leitfäden darauf referenzieren, ist mit den Autoren Rücksprache zu halten.<br>* Der '''Name'''Anmerkung: Solange das DLT noch eines Templates (nicht in der Transaktion Display-Name!) kann nach dem Erstellen des Szenarios verlinkt istTemplates 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 dessen Label , 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 TemplateEntwurf-Status!) nicht mehr benötigt, soll der Inhalt gelöscht und ein dummy-Name sowie eine dummy-BaumOID (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) als oranges Dreieck mit Pfeilen angezeigtentfernt, sonst als oranges Viereck/Buchund es scheint auch nicht mehr in den Beziehungen der referenzierenden Templates auf.{{BeginYellowBox}}'' <br>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. ====Alle weiteren Templates erstellenBeispiel-Snippets (überarbeitet aber komplett übernommen)====Bevor ein neues * 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 werden in der Regel nur zum Template selbst erstellt wird, müssen alle nicht aber zu den darin verlinkten Templates über (z.B. included Entries).* Code-Snippets sollen immer '''zuletzt''' ergänzt werden, um den Aufwand nach Änderungen im Template gering zu halten. ===Template Body=======Template-ID (überarbeitet aber komplett übernommen)====In einer konkreten CDA XML Instanz darf nur 1 Template-ID aus dem ELGA OID Root 1.2.40.0.34.6.0.11.XXX stammen. D.h. jene Template-ID, die Governance Seite aufgelistetbeim Ableiten eines Prototyps von Art-Decor automatisch hinzugefügt wird, deren Wiederverwendbarkeit geprüft muss entfernt werden bzw. welche Weitere OID als nächstes vergeben können - sofern im zugrundeliegenden Standard gefordert - angegeben werden muss. Wenn möglich, aus vorhandenen Templates ableiten! Alle Richtlinien zur Vergabe einer OID für das neu erzeugte Template sind unter [https://wiki.hl7.at/index.php?title=ART-DECOR_Governance#Root_OID_f.C3.BCr_Templates Governance] zu finden. ==== Standard-Referenzen („+“überarbeitet aber komplett übernommen)====Daten-Symbol und Template-Elemente sollen in ihrem Label zu der Templateansicht im Projektverzeichnisentsprechenden Spezifikation verlinken, auf der sie basieren (z.B. IHE PHARM, Kap. 4.4). Dies liegt in der Verantwortung des Entwicklers.Ein neues Basistemplate muss im ATCDABBR angelegt ====XDS-Metadaten-Mapping (komplett übernommen)====Elemente die auf XDS-Metadaten gemappt werden und soll so allgemein definiert müssen, sollen mit "↔ Hinweis zum XDS-Mapping" gekennzeichnet sein, dass es für andere Leitfäden verwendbar ist .<br>Beispiel:<br>'''↔ Hinweis zum XDS-Mapping:''' Das templateId-Element mit einer Extension beginnend mit "XDSdocumentEntry.formatCode^" wird ins XDS-Attribut formatCode gemappt (ohne Value Sets, ohne projektspezifischen Angaben!Präfix XDSdocumentEntry.formatCode^)*. Alle Projekte sollen ====Verwendung von dort ableiten Template-Compilations (genauer spezifizierenkomplett übernommen)====Compilations sind Template-Fragmente, Value Sets angeben uswwie z.)B. Adressinformationen. zDa sich diese mehrfach wiederholen können, sollen sie mit "contains" eingebunden werden (d.Bh. Section-der Inhalt der Compilation wird nicht im verlinkenden Template angezeigt). Diese sollen aber im ATCDABBR: „Durchgemachte Krankheiten“ abgeleitet in SectionLeitfaden 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 „Impfrelevante Erkrankungen (DLT) erstellt werden (nach Vorgaben der [[ART- kodiert“ im eDECOR_Governance#Governance_f.C3.BCr_die_CDA-Leitfadenerstellung_mit_Art-ImpfpassDecor | Governance]]).<br>TemplateIDs müssen mit IHE-Vorgaben übereinstimmenOptionalitäten und Reihenfolge ''Anmerkung: Solange das DLT noch nicht in der Elemente einhalten*bei fehlender Berechtigung können Basistemplates Transaktion des Szenarios verlinkt ist, wird dessen Label (im Projektverzeichnis erstellt werden und später durch berechtigte Personen in das ATCDABBR verschoben werdenTemplate-Baum) als oranges Dreieck mit Pfeilen angezeigt, sonst als oranges Viereck/Buch.''<br>Wenn ein ====Workflow Document Level Template erstellen (überarbeitet und teilweise übernommen)====# Neues DLT anlegen: Angabe Name, Version Label, Display Name laut IHE required ist, aber nicht benötigt wirdGovernance, dann Template mit nullFlavor erstellender von Art-Decor per default vergebenen OID speichern# Anschließend OID entsprechend Governance korrigieren (Template bearbeiten, "#")(nur über GUI möglich, nicht via Temple).# „Included Templates“ aus DLT-Header mit Kettensymbol zum Projekt hinzufügenTipps (entfällt): * Zur Vereinfachung kann der Inhalt eines bestehenden DLT via Temple als XML kopiert und in das neue Template einfügen werden (effective DATE und OID bleiben erhalten).* Inhaltliche Korrekturen und Anpassungen können auch in einem externen XML-Editor (z.B. Freitext-Inhalt „keine Information“ oder Code „entry emty“ Oxygen) durchgeführt und dann in Temple eingefügt werden. ====Referenzierte Header Level Templates (überarbeitet aber komplett übernommen)====> Workarround damit Der Großteil der Standard nicht verletzt wird und das IHE Template trotzdem verwenden Header Level Templates werden kann aus dem at-cda-bbr (sonst nicht interoperabel!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.Vorgabe von 6* Die verwendeten ALF Header Templates werden mit include im Document Level Template abgebildet.3* Die verwendeten AILF Header Templates werden nicht nochmals eigens in die Leitfäden (z.1B.unter 10.4 Specification: Sektionen eigentlich verpflichtend2.2 Header Level Templates) referenziert, da sie im DLT abgebildet sind. ==Dataset-Mapping erstellen (überarbeitet aber R kann 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 0 seinfür die Experten-/Arbeitsgruppe), dass alle erforderlichen Dataset-Elemente in den Templates modelliert wurden.
[https://www.art-decor.org/mediawiki/index.php?title===Sektionen entsprechend dem IHE Profil modellieren===(siehe TODO)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]
==DatasetTesten und Fehlerbehebung (überarbeitet aber komplett übernommen)==Um die Qualität eines Projekts zu überprüfen, können eine Reihe von Prüfungen durchgeführt werden, bevor eine Publikation erstellt wird. Informationen zu den entsprechenden Funktionalitäten des ART Project Editors finden Sie unter [https://www.art-Mapping erstellendecor.org/mediawiki/index.php?title=ART_Project_Editor#Preflighting%20publication%20and%20quality%20checks Preflighting publication and quality checks]. ===Workflow Decor Prüfung===Die Zuordnung von Datensatz-Elementen Decor Prüfung testet, ob das Projektschema gültig ist und erstellten Templates wird empfohlenSchematronregeln erstellt werden können. Dadurch sind Menü Projekt – Entwicklung:* "Decor prüfen": Prüfung über gesamtes Modell:* "Optionale Prüfungen konfigurieren": alle mit einem Template assoziierten Konzepte in der TemplateOptionen 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-Beschreibung zusammengefasstErstellung+und+Bereitstellung)== Generell gilt:* Mithilfe von ISO Schematron kann geprüft werden, sowie direkt beim assoziierten ob ein gültiges HL7 CDADokument (HL7 v3) vorliegt, während eine XSD-Element bzwSchemaprüfung, nur prüft ob ein gültiges XML Dokument vorliegt. Attribut des * Aus den modellierten Templates ersichtlichkönnen über Art-Decor automatisch Schematronregeln generiert werden. Dies dient der Kontrolle* Wenn zusätzliche Geschäftsregeln geprüft werden sollen, dass alle erforderlichen Datensatz-Elemente die nicht in den Templates modelliert wurdensind, 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=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).
==Schematron Beispieldokumente (überarbeitet aber komplett übernommen=====Beispielbokumente erstellen=== (TODO)* 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.
==Asserts erstellen=Beispieldokumente validieren=== (TODO)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.
==Beispielbefunde erstellen Publikation (überarbeitet aber komplett übernommen: https://confluence.elga.gv.at/display/SCC/Schematron-Erstellung+und testen+Bereitstellung)=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]. TODO
=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]