3.869
Bearbeitungen
Änderungen
keine Bearbeitungszusammenfassung
'''eHealth Implementierungsleitfäden''' können auch in englischer Sprache verfasst werden.
Wichtige Informationen hinsichtlich der '''technischen''' Erstellung eines CDA-Leitfadens mit Mediawiki sind unter [https://wiki.hl7.at/index.php?title=Hilfe:Wiki HL7 Austria MediaWiki - Hilfe] nachzulesen.
Die Einbindung eines neuen Leitfadens folgt einem vorgegebenen Prozess, dieser ist ersichtlich unter Benutzung von [https://wiki.hl7.at/index.php?title=Hilfe:Flagged_Revisions#Benutzung_von_Flagged_Revisions Flagged Revisions].
===Name===
Der Name eines Leitfadens wird wie folgt angegeben:
HL7 Austria & ELGA
HL7 CDA® R2 Implementierungsleitfaden
'''[Titel]'''
OID: '''[OID]'''
''Beispiel:''
HL7 Austria & ELGA
HL7 CDA® R2 Implementierungsleitfaden
Labor- und Mikrobiologiebefund
OID: 1.2.40.0.34.7.4.9.3
Für jeden Implementierungsleitfaden muss über das '''TemplateOID-NamenPortal''' sind grundsätzlich in eine Dokumentenklassen-OID unterhalb des Knotens '''englischer Sprache1.2.40.0.34.7''' zu vergeben, sodass die Bezeichnungen entsprechend ihrer Definition in anderen (internationaleneHealth-Austria/documents) CDA-Leitfäden beibehalten '''registriert''' werden können und die Wiederverwendbarkeit bestehender Templates in weiteren Leitfäden erleichtert wird.
''Beispiel:Die Sektion '''''"Impfungen - kodiert"''''' (*1.2.40.0.34.67.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 18: Dokumentenklassen- kodiertOID des Implementierungsleitfadens "''''' beinhaltet u.a. ein Entry: '''''Meldung von antimikrobieller Resistenzen"Immunization Entry"''''' **OID wird im OID-Portal beantragt (Root-Knoten aller Versionen des entsprechenden Leitfadens)*1.2.40.0.34.67.0.11.318.1): Implementierungsleitfaden Meldung von antimikrobieller Resistenzen, welches wiederum laut Standarddefintion folgende Template IDs enthalten muss: HL7 CCD Medication activity Version 1**OID des PDF-Leitfaden (1.Titelblatt)**wird im DLT als templateId[2] als informative Referenz angegeben**Hauptversionen verlangen eine neue Verordnung durch das BM*G**OID wird ebenfalls im OID-Portal beantragtDie Leitfaden-OID von Nebenversionen ändert sich nicht.40Die Version des Leitfadens ist im Leitfadentitel (Wiki) bzw.0.34.6.0.11.3.1auf dem Titelblatt (PDF) und IHE Immunizations Entry (2dem Versionlabel des DLT ersichtlich.16.840.1.113883.10Siehe [https://confluence.20elga.1gv.24). Daher trägt das Entry den Namen, der auch im Standard angegeben wird (mit dem Zusatz "Entry")at/display/SCCTERM/Versionierung Versionierung].
== Verwendung von OID ==Im Zusammenhang mit der Verwendung von OID sind die österreichischen Richtlinen einzuhalten([https://www.gesundheit.gv.at/OID_Frontend/OID_Konzept_1-1-0.pdf Object Identifier (OID) Konzept für das österreichische Gesundheitswesen]).Das österreichische OID Portal ist zu finden unter [https://www.gesundheit.gv.at/OID_Frontend/ OID Portal Österreich]. ===OID für Implementierungsleitfäden==={{BeginYellowBox}}''Wichtiger Hinweis:'' Für '''jeden Implementierungsleitfaden''' muss (über das OID-Portal) eine OID '''unterhalb des Knotens 1.2.40.0.34.7''' (eHealth-Austria/documents) '''registriert''' werden.{{EndYellowBox}}Falls Dokumente in aufeinander aufbauenden Versionen vorliegen, muss dafür darunter eine '''zusätzliche Ebene''' angelegt werden. Beispiel: * 1.2.40.0.34.7.18: Implementierungsleitfaden Meldung von antimikrobieller Resistenzen * 1.2.40.0.34.7.18.1: Implementierungsleitfaden Meldung von antimikrobieller Resistenzen - Version 1.00 ===Art-Decor Root OID===Als neuer '''Root-Knoten für Art-Decor''' wird 1.2.40.0.34'''.6.0''' (eHealth-Austria/services) verwendet. Er enthält OID für Value Sets und Templates.<br>====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 folgenden '''Unterknoten''' vergeben werden: : '''.0. Document-Level Template''' : '''.1. Header-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=2.16.840.1.113883.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=2.16.840.1.113883.2.16 '''Art-Decor Governance Group'''], unter HL7 Austria - "List of Artefacts under this Governance Group" / Reiter '''"Value Sets"''' ermittelt werden.{{EndYellowBox}} == Namens- und Versionierungs-Konventionen ==Es wird zwischen den Namens- und Versionierungs-Konventionen von '''Datasets''', '''Templates''' und '''Value Sets''' unterschieden. === Datasets ===Zu jedem Dataset müssen Name und Versions-Label (VersionLabel) angegeben werden. Der '''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/>;'''[Hauptversions-Jahr]''': 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]''''': Eine darauffolgende Nummer welche für jede neue Nebenversion um eins hochgezählt wird. 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-Label (VersionLabel) und Name 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 Template unverändert aus einer anderen Spezifikation übernommen, empfielt es sich dieses mit dem originalen Namen des Templates zu bennen, wie z.B.: "Author" oder "Immunization Entry". Das '''Versions-Label (VersionLabel)''' des Templates muss gleich dem des DataSets angegeben werden ('''[Hauptversions-Jahr]''.[Nebenversions-Nummer]''''', siehe oben). Der '''Name''' des Templates wird wie folgt angegeben:'''[Präfix]_[Template-Typ]_[ElementName]'''<br>Als Trenner fungieren Unterstriche ("_"), wobei folgendes gilt:;[Präfix]: Als Präfix dient das Projektkürzel (Name des Repositories), z.B. "atcdabrr".;[Template-Typ]: Der Template-Typ muss einen der folgenden Template-Typen enthalten::* '''"document"''': für Document-Level-Templates:* '''"header"''': für Header-Level-Templates:* '''"section"''': für Sektionen:* '''"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:*'''Document-Level-Template''' im ELGA e-Impfpass Repository:::Name: "eimpf_document_KompletterImmunisierungsstatus"<br>::DisplayName: "Kompletter Immunisierungsstatus"*'''Header-Level-Template''' im AT-CDA-BBR:::Name: atcdabbr_header_Author<br>::DisplayName: Author*'''Unkodierten Sektion''' im Repository AT-CDA-BBR:::Name: "atcdabrr_section_FruehereErkrankungUnkodiert"<br>::DisplayName: "Frühere Erkrankungen - unkodiert"*'''Kodierten Sektion''' im ELGA e-Impfpass Repository:::Name: "eimpf_section_ImpfrelevanteErkrankungenKodiert"<br>::DisplayName: "Impfrelevante Erkrankungen - kodiert"*'''Entry''' im AT-CDA-BBR: ::Name: "atcdabbr_entry_Immunization"<br>::DisplayName: "Immunization Entry"*'''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}}=== Value Sets ===Die '''Namen''' von Value Sets werden wie folgt angegeben:'''[Präfix]_[ValueSetName]_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 identisch sein sollen;VS: steht immer am Ende jeder Value Set Bezeichnung Beispiel: :*Name: eimpf_Abrechenbarkeit_VS :*Wiedergabename: eimpf_Abrechenbarkeit_VS 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 Datum der Gültigkeit eingetragen werden. Dies geschieht im Format '''[Jahreszahl]-[Monat]-[Tag]'''. <br/>Beispiele:<br/>* '''2019-01-16''' für den 16.1.2019<br/>* '''2020-11-20''' für den 20.11.2020 == Item-Label ==Der im Item-Label des '''Document-Level Templates''' angegebene Name wird von Art-Decor später automatisch als Name für das entsprechende Schematron verwendet, z.B. „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 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 ===Eine Liste der Art-Decor 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=2.16.840.1.113883.2.16 '''Art-Decor Governance Group'''] sind alle Projekte der HL7 Austria sichtbar, sowie alle angelegten Artefakte mit OID, Displayname, [[#Artefaktstatus]], BBR und Projekte, die das Template oder Value Set referenzieren. === Artefaktstatus ===In einem Repository werden Artefakte zunächst im Status "Entwurf" erstellt. Nach Abschluss, Überprüfung und Bestätigung kann der Status eines Artefakts im Repository gemäß den Regeln der zuständigen Governance-Gruppe geändert werden (siehe [https://art-decor.org/mediawiki/index.php?title=ART_Template_Editor#Changing_the_status_of_a_template "Changing the status of a template"]). Das Kapitel [[#Repositories]] enthält die Beschreibung des detaillierten Prozesses und der Verantwortlichkeiten. Das folgende Zustandsdiagramm zeigt die Standardzustände und möglichen Übergänge für ein Artefakt in Art-Decor: {{ HL7img | Governance state machine.png |center| Zustandsautomat }} <ref group="Abbildung">Default state diagram for Art-Decor artefacts</ref> ''Default state diagram for Art-Decor artefacts'' '''TODO: Beschreibung, wann von draft in active wechseln. <br>'''TODO: Example for CH anpassen, nicht verwendete Zustände aus Tabelle entfernen''' <br><ref group="Tabelle">Art-Decor state machine</ref> ''Art-Decor state machine''{| class="hl7table"! width="80px" | Status !! Action !! Trigger / Description !! Example for CDA-CH !! Responsibility|-| [[File:Kyellow.png|16px]] draft| activate| Artefact is finished and it is considered as final (no review needed).| ''n/a for CDA-CH as review necessary.''| Developer|-| | consider| If an artefact is considered to be moved into a repository, this action is applied and the artefact has to be reviewed by the owner/team of the repository.| ''final draft for a CDA-CH V2 template ready to review.''| Developer (info to the Reviewer) |-| | cancel| If an artefact is not further developed, it is cancelled.| ''any developed draft template not to be used anymore.''| Developer|-| [[File:Korange.png|16px]] pending| activate| Upon decision of the review team.| ''CDA-CH V2 template has been reviewed within HL7 Switzerland and was considered to be ready for release.''| Review team of the repository. |-| | reject| If the artefact is considered as not appropriate for the repository, it's rejected.| ''HL7 Switzerland does not consider the template.''| Review team of the repository.|-| [[File:Kpurple.png|16px]] rejected| | Decision necessary for what next status applies, it is recommended to set the status to draft and re-evaluate it for a repository or set is as active only within the project.| ''As appropriate, propose to set it to draft again or move it to another BBR.''| Developer|-| [[File:Kgreen.png|16px]] active| review| Maintenance or update of a project/repository.| ''Review CDA-CH template to consider it for CDA-CH v2.''| Repository / Project owner|-| | retire| In case of a new version, the old version is retired in order to have only one valid version of an artefact.| ''A CDA-CH template is not used anymore or replaced by another one.''| Repository / Project owner|-| [[File:Korange.png|16px]] pre-publication review | reactivate| If updated and considered as final by the responsible person, the artefact is re-activated.| ''template is reviewed within HL7 Switzerland and considered to be ready for release.''| Repository / Project owner|-| | retire| | ''A CDA-CH template is not used anymore or replaced by another one.''| |} == Dokumentation ===== Templates ===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: <br>* 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 ==Die Verwendung von Art-Decor-Datensätzen wird für neue Projekte empfohlen. Diese bilden die funktionalen Anforderungen an das Projekt ab und sind Diskussionsgrundlage bei Fachexpertengesprächen (erfordern kein technisches Hintergrundwissen). <br>Folgende Inhalte eines Dataset-Elements sind mindestens anzugeben:* Name* Beschreibung* Datentyp<br>wenn vorhanden:* Auswahllisten* Link zu kodierten Konzepten / Value Sets (Terminologien) == Szenarios ==Das Erstellen von '''Transaktionen''' im Rahmen von Szenarios ist für die Generierung von Schematron-Regeln '''zwingend erforderlich'''.<br>Die Transaktion soll dem Schema '''[Projektkürzel]_[Name des Szenarios]''' folgen.<br>Die Angabe von Kardinalität (optional, wiederholbar) und Konformität (erforderlich, obligatorisch) für die einzelnen Elemente des Datasets '''wird empfohlen'''. == Dataset-Mapping ==Die Zuordnung von Datensatz-Elementen und erstellten Templates wird '''empfohlen''' (Informationen zum [https://wiki.hl7.at/index.php?title=Hilfe:Art-Decor_Leitfadenerstellung#Dataset-Mapping_erstellen Dataset-Mapping]) = Governance für die CDA-Leitfadenerstellung mit Mediawiki ===Leitfaden erstellen==Wichtige Informationen hinsichtlich der technischen Erstellung eines CDA-Leitfadens mit Mediawiki sind unter [https://wiki.hl7.at/index.php?title=Hilfe:Leitfaden_erstellen "Leitfaden erstellen"] nachzulesen. ===Namespace& Metadaten===Der Verwendung von Namespaces ist wesentlich für Versionierung der Wiki-Seiten mit Flagged Revisions.
{{BeginYellowBox}}
''Wichtiger Hinweis:'''''Alle Seiten''' von CDA-Leitfäden müssen im Namespace '''[[https://wiki.hl7.at/index.php?title=Hilfe:Leitfaden_erstellen#Verwendung_von_Namespaces "ILF"]]''' erstellt werden.
{{EndYellowBox}}
Das Wiki-Leitfadenprojekt DARF NICHT unabhängig vom ART-DECOR-DLT versioniert werden, siehe [https://confluence.elga.gv.at/display/SCCTERM/Versionierung Versionierung].
Alle veröffentlichten Leitfadenversionen sind zusätzlich zum Wiki als PDF verfügbar (Anleitung siehe [https://wiki.hl7.at/index.php?title=Hilfe:Leitfaden_erstellen#PDF_Generierung PDF-Generierung]). Eine Übersicht der Versionen eines Leitfadens findet sich im jeweiligen Guide (alle vorhandenen Guides sind zu finden unter [https://wiki.hl7.at/index.php?title= ELGA Implementierungsleitf%C3%A4den Übersicht der CDA Implementierungsleitfäden ==TODO: Prozess # muss eingehalten werden].
= Anhang==Inhalt=Links==* [http://art-decor.org/art-decor/home Art-Decor Workspace]* [https://www.art-decor.org/mediawiki/index.php?title=Documentation Art-Decor Dokumentation]* [https://wiki.hl7.at/index.php?title=Willkommen_auf_dem_Wiki-Portal_von_HL7_Austria eHealth Wiki]* [https://wiki.hl7.at/index.php?title=HilfeDer Inhalt besteht üblicherweise aus den Kapiteln:Wiki Wiki Hilfe]
