Prozess der CDA-Leitfadenerstellung in Art-Decor
[unmarkierte Version] | [unmarkierte Version] |
(→Datasets erstellen) |
(→Erstellung neuer Templates) |
||
Zeile 82: | Zeile 82: | ||
* Templates anderer Projekte, welche im eigenen Projekt nicht referenziert werden, können nicht als Prototyp angegeben werden (d.h. von ihnen kann nicht geerbt werden). Soll der Inhalt eines Templates trotzdem verwendet werden, empfiehlt sich folgende Vorgehensweise: Mittels Link | * Templates anderer Projekte, welche im eigenen Projekt nicht referenziert werden, können nicht als Prototyp angegeben werden (d.h. von ihnen kann nicht geerbt werden). Soll der Inhalt eines Templates trotzdem verwendet werden, empfiehlt sich folgende Vorgehensweise: Mittels Link | ||
:<code><nowiki>https://art-decor.org/temple/modules/temple.xquery?id=[OID des Templates]</nowiki></code> | :<code><nowiki>https://art-decor.org/temple/modules/temple.xquery?id=[OID des Templates]</nowiki></code> | ||
− | :lässt sich der '''XML-Code jedes Templates''' via [https://www.art-decor.org/mediawiki/index.php?title=Temple '''Temple'''] anzeigen und kopieren. Der kopierte Inhalt kann dann in ein neu ("from | + | :lässt sich der '''XML-Code jedes Templates''' via [https://www.art-decor.org/mediawiki/index.php?title=Temple '''Temple'''] anzeigen und kopieren. Der kopierte Inhalt kann dann in ein neu ("from scratch") erstelltes Template kopiert werden. Dabei ist zu beachten, dass die obere Zeilen des neu erstellten Templates erhalten bleiben -> '''Zeitpunkt (effectiveDate)''' und '''OID''' dürfen '''nicht verändert''' werden, alle weiteren Inhalte können entsprechend angepasst werden! |
* Neue, '''allgemeine''' e-Health-/ELGA-Basistemplates sollen generell im ATCDABBR angelegt werden und sollen 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.). | * Neue, '''allgemeine''' e-Health-/ELGA-Basistemplates sollen generell im ATCDABBR angelegt werden und sollen 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.). | ||
:Beispiel: Section-Template „Durchgemachte Krankheiten“ im ATCDABBR wird abgeleitet in Section-Template „Impfrelevante Erkrankungen - kodiert“ im e-Impfpass. | :Beispiel: Section-Template „Durchgemachte Krankheiten“ im ATCDABBR wird abgeleitet in Section-Template „Impfrelevante Erkrankungen - kodiert“ im e-Impfpass. |
Version vom 18. November 2019, 11:48 Uhr
Folgende Vorgehensweise wird bei der Erstellung von Leitfäden als Best Practice empfohlen.
Eine Einleitung in Art-Decor finden Sie unter ART Introduction.
Eine Übersicht verfügbarer Anleitungen sind unter ART user manual aufgelistet.
Inhaltsverzeichnis
- 1 Projekt erstellen
- 2 Datasets erstellen
- 3 Szenarios erstellen
- 4 Referenzen auf andere Projektverzeichnisse setzen
- 5 Templates erstellen
- 6 Terminologien hinzufügen
- 7 Dataset-Mapping erstellen
- 8 Schematron erstellen
- 9 Testen und Fehlerbehebung
- 10 Asserts erstellen
- 11 Beispielbefunde erstellen und testen
- 12 Versionierung
- 13 Publikation
1 Projekt erstellen
Ein neuer CDA-Leitfaden muss in einem eigenen Projektverzeichnis angelegt alle Autoren müssen entsprechend berechtigt werden. Dies muss gegebenenfalls beim Art-Decor-Support beantragt werden.
Informationen zu den Funktionen des Projekt-Editors finden Sie unter ART Project Editor.
2 Datasets erstellen
Die Modellierung der Datasets soll in enger Abstimmung mit Experten der Arbeitsgruppe erfolgen, bereits unter Einbeziehung potentiell zu verwendender Standards (IHE Profile).
Wenn möglich sollen bestehende Dataset-Elemente verwendet werden oder von diesen geerbt werden (Dataset versioning).
Die anzugebenden Inhalte eines Dataset-Elements sind in der Governance festgelegt.
Eine Anleitung zur Modellierung von Datasets finden Sie unter ART Dataset Editor.
3 Szenarios erstellen
Für jede Dokument-Ausprägung muss eine Transaktion erstellt werden. Diese ist für die Generierung von Schematronregeln erforderlich.
Transaktionen stellen einen (Teil-)Satz von Konzepten eines Datasets dar und ergänzen ihn um Kardinalität, Konformität und mögliche Bedingungen, damit die Anforderungen des Anwendungsfalles angemessen widergespiegelt werden. Dies Angabe der Element-Konformanz und -Kardinalität ist jedoch für die Erstellung eines Schematrons nicht zwingend erforderlich.
Eine Transaktion muss aber das entsprechedende Document-Level-Template referenzieren (dies ist die technische Darstellung der Transaktion und der zugrunde liegenden Konzepte).
Die Bezeichnung der Transaktion soll der Governance für die CDA-Leitfadenerstellung mit Art-Decor folgen.
Eine Beschreibung zur Erstellung von Transaktionen finden Sie unter ART Scenario Editor.
4 Referenzen auf andere Projektverzeichnisse setzen
Um bestehende Templates anderer Building Block Repositories referenzieren zu können, müssen die entsprechenden Verzeichnisse dem Projekt hinzugefügt werden (Empfehlung: ATCDABBR, IHE-PCC- hinzufügen).
Eine Anleitung hierfür finden Sie unter Reference a building block repository.
5 Templates erstellen
Hinsichtlich OID, Namensgebung, Beschreibung und Inhalte neuer Templates sind die Richtlinien der Governance für die CDA-Leitfadenerstellung mit Art-Decor einzuhalten.
Alle Funktionen des Template Editors finden Sie unter ART Temple Editor.
Direkt-Links:
- Neues Template erzeugen
- Neue Version eines bestehenden Templates erzeugen
- Bestehendes Templates aus einem anderen BBR referenzieren
5.1 Generelle Hinweise für die Erstellung von Templates
5.1.1 Verwendung von Standards
Im zugrundeliegenden Basis IHE Leitfaden müssen vorgeschriebene Sektionen, Kardinalitäten, Optionalitäten, Terminologien, ServiceEvents usw. ermittelt werden.
- Bevor ein neues Template erstellt wird, müssen alle Templates über die Governance Seite aufgelistet, deren Wiederverwendbarkeit geprüft werden und Nachschau gehalten werden, welche OID als nächstes vergeben werden darf. Wenn möglich, aus vorhandenen Templates ableiten!
- Verwendete TemplateIDs müssen mit IHE-Vorgaben übereinstimmen
- Optionalitäten und Reihenfolge der Elemente müssen eigenhalten werden
- Hinweis: Wenn ein Template laut IHE "required" ist, aber für die Anwendung in Österreich 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 IHE-Template kann trotzdem verwenden zu können (Interoperabilität!).
5.1.2 Erstellung neuer Templates
- Wenn neue Templates erstellt werden, vergibt Art-Decor per Default eine dem Projektverzeichnis untergeordnete OID, welche nach den Vorgaben der Governance geändert werden muss (siehe Metadata).
- Templates anderer Projekte, welche im eigenen Projekt nicht referenziert werden, können nicht als Prototyp angegeben werden (d.h. von ihnen kann nicht geerbt werden). Soll der Inhalt eines Templates trotzdem verwendet werden, empfiehlt sich folgende Vorgehensweise: Mittels Link
https://art-decor.org/temple/modules/temple.xquery?id=[OID des Templates]
- lässt sich der XML-Code jedes Templates via Temple anzeigen und kopieren. Der kopierte Inhalt kann dann in ein neu ("from scratch") erstelltes Template kopiert werden. Dabei ist zu beachten, dass die obere Zeilen des neu erstellten Templates erhalten bleiben -> Zeitpunkt (effectiveDate) und OID dürfen nicht verändert werden, alle weiteren Inhalte können entsprechend angepasst werden!
- Neue, allgemeine e-Health-/ELGA-Basistemplates sollen generell im ATCDABBR angelegt werden und sollen 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.).
- Beispiel: Section-Template „Durchgemachte Krankheiten“ im ATCDABBR wird abgeleitet in Section-Template „Impfrelevante Erkrankungen - kodiert“ im e-Impfpass.
(*) Bei fehlender Berechtigung können Basistemplates im Projektverzeichnis erstellt werden und später durch berechtigte Personen in das ATCDABBR verschoben werden.
5.1.3 Änderung bestehender Templates
- Nur Templates die sich noch im Status Entwurf befinden können bearbeitet werden. Für alle anderen Status finden Sie Informationen unter Versionierung.
- Der Name eines Templates (nicht der Anzeigename!) kann später nur mittels Temple geändert werden! Die Änderung hat des Namens hat keinen Einfluss auf die Referenzierung durch andere Templates -> hier gilt die OID).
- Wird die OID geändert, wenn das Template bereits durch andere Templates refereziert wird, werden alle bestehenden Referenzen ungültig! Daher vor der Änderung der OID die Liste aller referenzierenden Templates abspeichern und diese hinsichtlich der neuen OID anpassen!
5.2 Inhalte von Templates
Hinsichtlich folgender Elemente gelten die Vorgaben der Governance.
5.2.1 Templatename
Es gelten die Definitionen der Governance hinsichtlich Templatename
5.2.2 Versions-Label
Es gelten die Definitionen der Governance hinsichtlich Versions-Label
5.2.3 Item-Label
Es gelten die Definitionen der Governance hinsichtlich Item-Label
5.2.4 Beispiel-Snippets
In allen Templates (außer DLTs) werden nur Code-Snippets eingefügt. Snippets zu den Entries werden nur im Entry selbst und nicht im aufrufenden Template angeführt.
Code-Snippets sollen immer zuletzt ergänzt werden, um den Aufwand nach Änderungen im Template gering zu halten.
5.2.5 Metadaten
TODO: Hinweis auf Metadata-Mapping
5.3 Document Level Template erstellen
- Für jede Transaktion (jede Dokumentart) muss ein neues Document-Level-Template (DLT) erstellt werden (nach Vorgaben der Governance).
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.
6 Terminologien hinzufügen
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#Root_OIDs_f.C3.BCr_Value_Sets Root OIDs für Value Sets]
- Namenskonventionen für die Erstellung neuer Value Sets
7 Dataset-Mapping erstellen
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, dass alle erforderlichen Datensatz-Elemente in den Templates modelliert wurden.
8 Schematron erstellen
TODO
9 Testen und Fehlerbehebung
Preflighting publication and quality checks
10 Asserts erstellen
(TODO)
11 Beispielbefunde erstellen und testen
- Im jedem Document-Level-Template soll nur ein Verweis auf ein vollständiges CDA-Beispiel angeführt werden (z.B. auf HL7.at), damit dies bei Bedarf angepasst werden kann. Änderungen im Template erfordern sonst eine neue Template-ID!
- Beispielbefunde und sollen immer zuletzt ergänzt werden, um den Aufwand nach Änderungen im Template gering zu halten.
12 Versionierung
12.1 Versionierung von Templates
12.1.1 Major
12.1.2 Minor
12.2 Versionierung von Value Sets
Creating a new version of a value set, based on a previous