Änderungen

Wechseln zu: Navigation, Suche

ART-DECOR Governance

2.903 Bytes hinzugefügt, 09:37, 3. Mär. 2021
Root OID für Templates
{{#customtitle:Governance für die CDA-Leitfadenerstellung mit Art-Decor und Mediawiki}}
 
{{#css:
.toc{
}
}}
 
<!--
{{Infobox Dokument
= Weiterentwicklung des Dokuments =
Dieses Dokument enthält die aktuellsten Fragen und Entscheidungen Festlegungen bezüglich der Arbeit mit Art-Decor und Mediawiki in Österreich und wird laufend angepasst.
{{BeginYellowBox}}
''Wichtiger Hinweis:'' Anfragen hinsichtlich der Änderung oder Erweiterung dieses Dokuments stellen Sie bitte an [[cda@elga.gv.at]].
=Governance für die CDA-Leitfadenerstellung mit Art-Decor=
== Sprache ==
'''ELGA Implementierungsleitfäden''' werden in '''deutscher Sprache''' verfasst. Dazu gehören textuelle Beschreibungen im Wiki, Art-Decor-Templates und Datasets.
'''Template-Namen''' sind sind grundsätzlich in '''englischer Sprache''' zu vergeben, sodass die Bezeichnungen entsprechend ihrer Definition in den anderen (internationalen) CDA-Leitfäden beibehalten werden können und die Wiederverwendbarkeit bestehender Templates in weiteren Leitfäden erleichtert wird.  
Eine Ausnahme bilden die Namen von '''Section-Level Templates'''. Diese werden auf '''deutsch''' vergeben, da sie den in den Arbeitsgruppen abgestimmten Titel der Sektion tragen sollen.
'''Empfehlung für Entries''': Sind im Entry Referenzen auf andere (internationale) Standards enthalten, soll der Name des Entries auch den entsprechenden Namen tragen (englisch).
Ist dies nicht der Fall (im Entry gibt es z.B. nur eine ELGA Template ID), soll der Name des Entries an den Namen der Sektion angelehnt sein (deutsch).
 
Beispiel:
Die Sektion '''''"Impfungen - kodiert"''''' (1.2.40.0.34.6.0.11.2.1) (mit AG abgestimmter Titel) referenziert durch Angabe der TemplateID (1.3.6.1.4.1.19376.1.5.3.1.3.23) auf den Standard IHE PCC (Immunizations Section) (und hält auch dessen Vorgaben ein). '''''"Impfungen - kodiert"''''' beinhaltet u.a. ein Entry: '''''"Immunization Entry"''''' (1.2.40.0.34.6.0.11.3.1), welches wiederum laut Standarddefintion folgende Template IDs enthalten muss: HL7 CCD Medication activity (1.2.40.0.34.6.0.11.3.1) und IHE Immunizations Entry (2.16.840.1.113883.10.20.1.24). Daher trägt das Entry den Namen, der auch im Standard angegeben wird (mit dem Zusatz "Entry").
== Verwendung von OID ==
====Root OID für Templates ====
Alle Art-Decor '''Templates''' müssen unterhalb des OID-Knotes 1.2.40.0.34.6.0'''.11''' liegen (eHealth-Austria/services/art-decor/templates).
Die OID der Art-Decor Templates sollen außerdem '''entsprechend ihres CDA-Template-Typs''' aus folgender folgenden '''Unterknoten ''' vergeben werden: : '''.0. Document-Level Template''' : '''.1. Header-Level Template'''
: '''.0 Document-Level Template''': '''2.1 HeaderSection-Level Template''': '''.2 Section-Level Template''': '''.3 . Entry-Level Template''' : '''.9 . other CDA Fragment Template'''
Beispiele:
*Header-Level-Template:
: 1.2.40.0.34.6.0.11'''.1.'''2 Author (eHealth-Austria/services/art-decor/templates/header/xxx)
*Entry-Level-Template:
: 1.2.40.0.34.6.0.11'''.3.'''15 Antikörper-Bestimmung Data Processing Entry (eHealth-Austria/services/art-decor/templates/entry/xxx)
{{BeginYellowBox}}
''Wichtiger Hinweis:'' Die Verwaltung der unter diesen Knoten liegenden Templates unterliegt Art-Decor und benötigt daher '''keine Registrierung''' über das '''OID-Portal'''. Die nächste '''freie OID''' für '''Templates''' muss über die [https://art-decor.org/art-decor/decor-governance-group?id=1.2.4016.0840.341.3113883.12.2 16 '''Art-Decor Governance Group'''], unter HL7 Austria - "List of Artefacts under this Governance Group" / Reiter '''"Templates" ''' ermittelt werden.
{{EndYellowBox}}
====Root OID für Value Sets====
Alle Art-Decor '''Value Sets''' müssen unterhalb des OID-Knotes 1.2.40.0.34.6.0'''.10''' liegen (eHealth-Austria/services/art-decor/value-sets).
Beispiele:
*Value Set:
: 1.2.40.0.34.6.0'''.10.'''8 ELGA_EntityNamePartQualifier_VS(eHealth-Austria/services/art-decor/value-sets/xxx)
{{BeginYellowBox}}
''Wichtiger Hinweis:'' Die Verwaltung der unter diesen Knoten liegenden Value Sets unterliegt Art-Decor und benötigt daher '''keine Registrierung''' über das '''OID-Portal'''. Die nächste '''freie OID''' für '''Value Sets''' muss über die [https://art-decor.org/art-decor/decor-governance-group?id=1.2.4016.0840.341.3113883.12.2 16 '''Art-Decor Governance Group'''], unter HL7 Austria - "List of Artefacts under this Governance Group" / Reiter '''"Value Sets" ''' ermittelt werden.
{{EndYellowBox}}
== Namenskonventionen Namens- und Versionierungs-Konventionen ===== VersionsEs wird zwischen den Namens-Label ===Im ''Versionund Versionierungs-LabelKonventionen von '' wird prinzipiell die 'Datasets''Jahrzahl''' der Publikation des , '''Templates''' (nach abgeschlossenem Ballot-Verfahren), des und '''Value Sets''' bzw. des '''Datasets''' eingetragen. Sollte die Angabe des Jahres nicht ausreichend sein, wird sie mit .Monat ergänzt. Gleiches gilt für tagesaktuelle Versionen.:Beispiele::* 2019:* 2019.01:* 2019.01unterschieden.16
=== Item-Label Datasets ===Zu jedem Dataset müssen Name und Versions-Label (VersionLabel) angegeben werden. Der im Item'''Name''' des Datasets ist passend dem Inhalt zu wählen. Das '''Versions-Label (VersionLabel)''' des DataSets muss wie folgt angegeben werden:'''[Hauptversions-Jahr]''.[optionale Nebenversions-Nummer]''''' Als Trenner fungiert ein Punkt ("."), wobei folgendes gilt:<br/>;'''Document[Hauptversions-Level TemplatesJahr]''': Das Jahr in welcher die Hauptversion publiziert wurde. Es wird zur Zeit als sehr unwahrscheinlich genommen das eine Hauptversion mehr als ein Mal im Jahr publiziert wird.<br/>;'''''[optionale Nebenversions-Nummer]''''' angegebene Name : Eine darauffolgende Nummer welche für jede neue Nebenversion um eins hochgezählt wird von Art.  Beispiele:<br/>* '''2019''' für die erste Hauptversion<br/>* '''2019.1''' für eine neue Nebenversion der Hauptversion 2019<br/>* '''2019.2''' für eine weitere Nebenversion der Hauptversion 2019<br/>* '''2021''' für eine neue Hauptversion im Jahr 2021<br/>* '''2021.1''' für eine neue Nebenversion der Hauptversion 2021<br/>* usw.  === Templates ===Zu jedem Template müssen Bezeichnung (DisplayName), Versions-Decor später automatisch als Label (VersionLabel) und Name für des Templates angegeben werden. Die '''Bezeichnung (DisplayName)''' des Templates ist passend zu wählen und bei einer möglichen Unterscheidung zwischen unkodiert und kodiert dies mit einem Bindestrich folgend anzugeben, z.B.: "Kompletter Immunisierungsstatus" oder "Frühere Erkrankungen - unkodiert".Ist das entsprechende Schematron verwendetTemplate unverändert aus einer anderen Spezifikation übernommen, empfielt es sich dieses mit dem originalen Namen des Templates zu bennen, wie z.B. „eimpf-UpdateImmunisierungsstatus“: "Author" oder "Immunization Entry".
Das '''Vorgaben für andere Versions-Label (VersionLabel)''' des Templates?: TODOmuss gleich dem des DataSets angegeben werden ('''[Hauptversions-Jahr]''.[Nebenversions-Nummer]''''', siehe oben).
=== Templatename ===Die Namen von Der '''Name''' des Templates werden wird wie folgt angegeben:
'''[Präfix]_[Template-Typ]_[ElementName]'''<br>
Als Trenner fungieren Unterstriche ("_"), wobei folgendes gilt:
:* '''"entry"''': für Entries
:* '''"other"''' : alle Templates, die nicht in obige Kategorien fallen ("Template type not specified")
;[ElementName]: Bezeichnung des Templates in Upper-CamelCase-Notation.
Beispiele:
*'''Other'''-Template im AT-CDA-BBR:
::Name: atcdabbr_other_AddressCompilation<br>
::DisplayName: "Address Compilation"{{BeginYellowBox}}Hinweise zur Änderung bestehender Templates siehe [[https://wiki.hl7.at/index.php?title=Hilfe:Art-Decor_Leitfadenerstellung#.C3.84nderung_bestehender_Templates|Art-Decor Leitfadenerstellung - Änderung bestehender Templates]] {{EndYellowBox}}=== Bezeichnungen für Value Sets ===Die '''Namen ''' von Value Sets werden wie folgt angegeben:'''[Präfix]_[ValueSetsNameValueSetName]_VS'''<br/>Als Trenner fungieren Unterstriche ("_"), wobei folgendes gilt:;[Präfix]: Als Präfix dient das Projektkürzel (Name des Repositories), z.B. "eimpf".;[ValueSetName]: Bezeichnung des Value Sets in Upper-CamelCase-Notation, wobei "Displayname" und "Name" des Value Sets sind identisch. <br> sein sollen;VS:steht immer am Ende jeder Value Set Bezeichnung Beispiel:
:*Name: eimpf_Abrechenbarkeit_VS
:*Wiedergabename: eimpf_Abrechenbarkeit_VS
==Versionierung==
 
===Versionierung von Templates ===
====Document-Level Templates====
Für jede neue Version eines Document-Level Templates ist eine neue OID zu verwenden. Der Bezug zur alten OID ist anzugeben. Dadurch wird die Anwendung der korrekten Schematron-Regeln gemäß dem getesteten CDA-Dokument sichergestellt.
 
====Alle anderen Templates====
TODO
 
===Versionierung von Value Sets===
Die '''OID''' der Value Sets bleiben '''für alle Versionen gleich''', werden aber durch das Gültigkeitsdatum '''"effectiveDate"''' unterschieden ("Gültig ab"). Darüber hinaus kann eine Value Set ein '''offizielles Freigabedatum''' tragen. <br><br>
Best Practices für die Erstellung und Pflege von Value Sets müssen angewendet werden, z.B. können Konzeptcodes hinzugefügt, aber nicht gelöscht werden, nur auf den Status "deprecated" gesetzt werden.
{{BeginYellowBox}}
''Wichtiger Hinweis:'' Wenn sich die Gesamtbedeutung der Codes in einem Value Set ändert, muss die neue Version des Value Sets eine '''neue OID''' erhalten.
{{EndYellowBox}}
Bei der Aktualisierung eines Value Sets muss im '''Version-Label''' prinzipiell das effectiveDate auf das aktuelle Datum (Gültig abder Gültigkeit eingetragen werden. Dies geschieht im Format '''[Jahreszahl]-[Monat]-[Tag]'''. <br/>Beispiele:<br/>* '''2019-Datum) geändert werden01-16''' für den 16.1.2019<br/>* '''2020-11-20''' für den 20.11.2020
:Beispiel:== Item-Label ==:*VersionsDer im Item-Label: des '''YYYYMM.Korrekturnummer(Document-beta)''' ''Hinweise:'' <br>Die "Korrekturnummer" ist Level Templates''optional'': bei Änderungen innerhalb eines Monats angegebene Name wird diese angehängt.<br>"Beta" wird nur bei Value Sets von Art-Decor später automatisch als Name für das entsprechende Schematron verwendet, die noch bearbeitet werdenz. Sobald die Version gültig ist, wird das "beta" entferntB. „eimpf-UpdateImmunisierungsstatus“.
== Repositories ==
=== Art-Decor Building Block Repository ===
In Österreich kann derzeit folgendes bereichsspezifische '''Building Block Repository''' (BBR) verwendet werden:
*[https://art-decor.org/art-decor/decor-project--at-cda-bbr- '''ATCDABBR''']: Dies soll in Zukunft alle für Österreich relevanten Basis-Templates enthalten, die für spezifische Anwendungen (e-Health und ELGA) in die einzelnen Projektverzeichnisse abgeleitet verwendet werden können. <br>:Derzeit sind Templates für den CDA-Header sowie Basis-Templates für den e-Impfpass vorhanden. Dieses Verzeichnis wird laufend erweitert. Nach Fertigstellung von CDA-Leitfäden sollen entsprechende Templates in dieses Verzeichnis übernommen werden.
:Dies soll in Zukunft alle für Österreich relevanten Basis-Templates enthalten, die für spezifische Anwendungen (e-Health und ELGA) in die einzelnen Projektverzeichnisse abgeleitet werden können. Das ATCDABBR wird laufend mit neuen Templates erweitert. Nach Fertigstellung eines neuen CDA-Leitfadens sollen entsprechende Templates in dieses Verzeichnis übernommen werden. Die im ATCDABBR befindlichen Templates dürfen nur von einem eingeschränkten Benutzerkreis bearbeitet werden.:Verantwortlichkeiten und Prozesse sind im Kapitel [[#Revision]] beschrieben.====Ableitung von Templates====Beim Ableiten von Templates soll einer der folgenden '''Beziehungstypen''' angegeben werden:*'''Spezialisierung''': bestehende Vorgaben werden weiter '''eingeschränkt''' (z.B. von [O] auf [M] oder von 0..* auf 0..1, ebenfalls [O] auf [NP])*'''Adaptierung''': bestehende Vorgaben werden '''erweitert''' (z.B. von [M] auf [O] oder von 0..1 auf 0..*) oder neue Elemente, Attribute, ValueSets, Fixe Werte werden hinzugefügt. Weitere Informationen sind im "Prozess der CDA-Leitfadenerstellung" unter [[Hilfe:Art-Decor_Leitfadenerstellung#Relationships|Relationship]] zu finden.
=== Projektverzeichnisse ===
* eEine Liste der Art-Impfpass (Pilot)* Basisleitfäden (alte Versionen)* TODODecor Projekte unter der HL7-Austria Governance Group ist hier verfügbar: [https://art-decor.org/art-decor/decor-governance-group?id=2.16.840.1.113883.2.16 HL7 Austria Projects].
== Governance Groups ==
Governance-Gruppen sind organisatorische Einheiten, die dazu dienen, die Verantwortung für Artefakte in Art-Decor darzustellen. Unter [https://art-decor.org/art-decor/decor-governance-group?id=1.2.4016.0840.341.3113883.12.2 16 '''Art-Decor Governance-GruppenGroup'''] sind alle Projekte der Gruppe HL7 Austria sichtbar, sowie alle angelegten Artefakte mit OID, Displayname, [[#Artefaktstatus]], BBR und Projekte, die das Template oder Value Set referenzieren.
=== Artefaktstatus ===
Elemente und Attribute, die im Template verwendet werden, sind zu dokumentieren. Die Beziehung zu anderen Templates ist anzugeben, um festzuhalten, wie sie sich zueinander verhalten (z.B. Spezialisierung, Anpassung usw.).
<br><br>
TODO: prüfen <br>Other elements that were in addition available according the HL7 CDA standard shall not be mentioned in the Art-Decor template.
* Open vs. Closed Templates
=== Standard-Referenzen ===
Daten- und Template-Elemente sollen in ihrem Label zu der entsprechenden Spezifikation verlinken, auf der sie basieren (z.B. IHE PHARM, Kap. 4.4). Dies liegt in der Verantwortung des Entwicklers.
 
Die erste Template-ID soll wie folgt bezeichnet werden: "HL7 Austria - [Name des Templates]".
== Datasets ==
Um eine konsistente Vorgehensweise bei der Erstellung und Darstellung eines Implementierungsleitfadens zu gewährleisten, wird folgende (minimale) Struktur vorgegeben: '''TODO REVIEW'''
# :1 Zusammenfassung# :2 Informationen über dieses Dokument## ::2.1 Impressum## ::2.2 Haftungsausschluss## ::2.3 Sprachliche Gleichbehandlung## ::2.4 Lizenzinformationen## ::2.5 Urheber- und Nutzungsrechte von anderen Quellen ("Third Party IP")## ::2.6 Verbindlichkeit## ::2.7 Verwendete Grundlagen und Bezug zu anderen Standards## ::2.8 Weitere unterstützende Materialien# :3 Einleitung## ::3.1 Ausgangslage und Motivation## ::3.2 Zweck des Dokuments## ::3.3 Zielgruppe# :4 Harmonisierung## ::4.1 Autoren und Mitwirkende# :5 Begriffsdefinitionen# :6 Technischer Hintergrund## ::6.1 Allgemeine Richtlinien ## ::6.2 Datentypen# :7 Funktionale Anforderungen## ::7.1 Darstellung## ::7.2 Verwendung in der ELGA Infrastruktur### :::7.2.1 Vorgaben zu Dokument-Metadaten (XDS-Metadaten)## ::7.3 Versionierung & Stornierung von Dokumenten## ::7.4 Mehrsprachigkeit und grenzüberschreitender Austausch# :8 User Storys ("Anwendungsfälle")# :9 Dataset# :10 Technische Spezifikation## ::10.1 Übersicht CDA Strukturen (Header & Body) ## ::10.2 CDA Templates### :::10.2.1 Document Level Templates### :::10.2.2 Header Level Templates### :::10.2.3 Section Level Templates### :::10.2.4 Entry Level Templates### Sonstige Templates (:::10.2.5 Weitere CDA Fragmente)## ::10.3 Terminologien# :11 Anhang## ::11.1 Abbildungsverzeichnis## ::11.2 Abkürzungsverzeichnis## Literaturverzeichnis == Schematische Template-Darstellung ==TODO: evtl:11. Grafikvorlage3 Literaturverzeichnis
== Revision ==
== Wiki ==
==Check before finalizing==
Thew folowing checks help to identify possible errors or missing includes from Art-Decor. Templates from other repositories than under the governance from eHealth Suisse need to be imported separatly. Please send the necessary OID and related project information to the [mailto://support@art-decor.org Art-Decor Support].  
*Perform search for:
** "/dynamic"
TODO
= Qualitätssicherung und Review ==
== Art-Decor Repository ==
TODO
 
== Implementation Guides ==
TODO
3.869
Bearbeitungen

Navigationsmenü