1.104
Bearbeitungen
Änderungen
keine Bearbeitungszusammenfassung
|description= Hier finden Sie eine Erklärung zu der Erstellung von CDA-Leitfäden mit Art-Decor.
}}
{{BeginYellowBox}}
'''DIESE SEITE IST NICHT MEHR ZU BEARBEITEN, WURDE VOLLSTÄNDIG in [https://confluence.elga.gv.at/pages/viewpage.action?pageId=23791972 ELGA Governance für die CDA-Leitfadenerstellung mit Art-Decor - Semantic Competence Center - ELGA Confluence] ÜBERNOMMEN. Sobald die [https://wiki.hl7.at/index.php?title=Spezial:Linkliste/Hilfe:Art-Decor_Leitfadenerstellung Links, die auf diese Seite zeigen,] korrigiert wurden, kann die Seite gelöscht werden.'''
{{EndYellowBox}}
{{BeginYellowBox}}
Eine Einleitung in Art-Decor finden Sie unter [https://www.art-decor.org/mediawiki/index.php?title=ART_Introduction '''ART Introduction'''].
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 bei der Modellierung der Datasets zu berücksichtigen (z.B. IHE PCC). 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>
[https://www.art-decor.org/mediawiki/index.php?title=ART_Dataset_Editor ART Dataset Editor].
==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 enthalten Konzepte eines Datasets und ergänzen diese um Kardinalität, Konformität und mögliche Bedingungen, damit die Anforderungen des Anwendungsfalles angemessen widergespiegelt werden. Die Angabe von Konformanz und Kardinalität der Dataset-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.<br>Die 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}}
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'''].
===Verwendung von Standards(überarbeitet aber komplett übernommen)===
Grundsätzlich sollen existierende Standards angewendet werden.
Generell gilt daher:
* Wenn möglich, sollen bereits vorhandene Templates verwenden werden (siehe [[Hilfe:Art-Decor_Leitfadenerstellung#.C3.9Cbernahme_bestehender_Templates| Übernahme bestehender Templates]]).
* Der Standard darf dabei nur eingeschränkt, aber nicht erweitert werden.
* Optionalitäten und Reihenfolge der Elemente müssen eingehalten werden.
:Hinweis: Wenn ein Template laut Standard "required" ist, aber für den konkreten Leitfaden nicht benötigt wird, kann das Template mit einem '''nullFlavor''' erstellt werden (z.B. Freitext-Inhalt „keine Information“ oder Code „entry empty“). Dadurch wird der Standard nicht verletzt und das Template kann trotzdem verwenden werden.
===Neues Templates erzeugen(überarbeitet aber komplett übernommen)===Informationen zur Erstellung von Templates in Art-Decor finden Sie unter [https://www.art-decor.org/mediawiki/index.php?title=ART_Template_Editor#Creating_a_new_template Neues Template erzeugenCreating a new template]. <br>
Hinweise:
* Wenn ein neues Templates erstellt wird, 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 [https://www.art-decor.org/mediawiki/index.php?title=ART_Template_Editor#Metadata Metadata]).
:Hierfür die [https://art-decor.org/art-decor/decor-governance-group?id=1.2.40.0.34.3.1.2 '''Art-Decor Governance Group'''] aufrufen und alle unter HL7 Austria bestehenden Templates auflisten lassen, sodass deren Wiederverwendbarkeit geprüft und ermittelt werden kann, welche OID als nächstes vergeben werden darf.
* Neue, '''allgemeine''' e-Health-/ELGA-Basistemplates sollen generell im [https://art-decor.org/art-decor/decor-project--at-cda-bbr- ATCDABBR] angelegt und so allgemein definiert werden, dass sie für andere Leitfäden verwendbar sind (ohne Value Sets, ohne projektspezifischen Angaben!)(*). Dies stellt sicher, dass alle Projekte Templates aus dem ATCDABBR ableiten und spezifizieren können (Value Sets ergänzen usw.).
(*) Bei fehlender Berechtigung können Basistemplates im Projektverzeichnis erstellt werden und später durch berechtigte Personen in das ATCDABBR verschoben werden.
===Übernahme Referenzieren bestehender Templates(überarbeitet aber komplett übernommen)===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 über Art-Decor verfügbaren 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:
==== Verlinktes Projektverzeichnis (überarbeitet aber komplett übernommen)====
Übernahme eines vorhandenen Templates aus einem '''verlinktem Projektverzeichnis''' (siehe [https://www.art-decor.org/mediawiki/index.php?title=ART_Template_Editor#Creating_a_link_to_a_template_that_resides_in_a_BBR Bestehendes Templates aus einem anderen BBR referenzieren])
* '''Referenzierung''' (unveränderte Übernahme) des Templates mit Kettensymbol
:* Keine Änderung des Templates möglich!
:* Nur verwenden, wenn es bereits ein passendes ELGA-/e-Health-Template gibt
* '''Kopieren und AnpassenAbleitung''' eines 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 Templates erzeugen])
:* Ein passendes Template wird via „+“-Symbol als Prototyp angegeben, welches im Anschluss spezifiziert werden muss (neue OID).
==== Nicht verlinktes Projektverzeichnis (komplett übernommen)====
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
Die OID muss in einem späteren Arbeitsschritt über die GUI korrigiert werden.
===Änderung bestehender Templates(überarbeitet aber komplett übernommen)===Solange sich ein Template noch im Status [[ART-DECOR_Governance#Artefaktstatus|'''Entwurf''']] befindet, kann es jederzeit bearbeitet werden. Dabei ist folgendes zu beachten:* Falls bereits andere Leitfäden darauf referenzieren, ist mit den Autoren Rücksprache zu halten.
* 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}}
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#Templatename TemplatenameNamens-_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#VersionsNamens-Label Versions_und_Versionierungs-LabelKonventionen 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. ====Beispiel-Snippets(überarbeitet aber komplett übernommen)====
* 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, nicht aber zu den darin verlinkten Templates (z.B. included Entries).
* Code-Snippets sollen immer '''zuletzt''' ergänzt werden, um den Aufwand nach Änderungen im Template gering zu halten.
===Template Body=XDS-Metadaten======Template-MappingID (überarbeitet aber komplett übernommen)====HinweisIn 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, welche Elemente auf welche XDSdie beim Ableiten eines Prototyps von Art-Metadaten gemappt Decor automatisch hinzugefügt wird, muss entfernt werden müssen.Weitere OID können - sofern im zugrundeliegenden Standard gefordert - angegeben werden.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.
====XDS-Metadaten-Mapping (komplett übernommen)====Elemente die auf XDS-Metadaten gemappt werden müssen, sollen mit "↔ Hinweis zum XDS-Mapping" gekennzeichnet sein.<br>Beispiel:<br>'''↔ Hinweis zum XDS-Mapping:''' Das templateId-Element mit einer Extension beginnend mit "XDSdocumentEntry.formatCode^" wird ins XDS-Attribut formatCode gemappt (ohne Präfix XDSdocumentEntry.formatCode^) ====Verwendung von Template-Compilations (komplett übernommen)====Compilations sind Template-Fragmente, 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 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).
# „Included Templates“ aus DLT-Header mit Kettensymbol zum Projekt hinzufügen
Tipps(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. Oxygen) durchgeführt und dann in Temple eingefügt werden.
====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]
==Testen 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.
:* 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.
* Art-Decor bietet die Möglichkeit nach korrekter Schematron-Generierung ein Beispieldokument zu prüfen.
===Workflow Schematron erzeugen===
Menü Projekt – Entwicklung:
* "Compiliere Entwicklungsversion":
:* 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 Editors anwendet und rekursiv alle Code-Snippets der darin verlinkten Templates einfügt.
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(überarbeitet aber komplett übernommen: https://confluence.elga.gv.at/display/SCC/Schematron-Erstellung+und+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].
