ART-DECOR Governance: Unterschied zwischen den Versionen

Aus HL7 Austria MediaWiki
Wechseln zu: Navigation, Suche
[unmarkierte Version][unmarkierte Version]
(→‎OIDs)
(→‎Art-Decor)
Zeile 130: Zeile 130:
 
In a repository, artefacts shall be initially created in the status 'draft'. When finished, reviewed and endorsed, an artefact’s status can be changed in the repository according the rules of the responsible governance group (see [https://art-decor.org/mediawiki/index.php?title=ART_Template_Editor Art-Decor.org/Template Editor] for the Art-Decor default state/event diagram). Chapter [[#Repositories]] contains the description of the detailed process and responsibilities.
 
In a repository, artefacts shall be initially created in the status 'draft'. When finished, reviewed and endorsed, an artefact’s status can be changed in the repository according the rules of the responsible governance group (see [https://art-decor.org/mediawiki/index.php?title=ART_Template_Editor Art-Decor.org/Template Editor] for the Art-Decor default state/event diagram). Chapter [[#Repositories]] contains the description of the detailed process and responsibilities.
  
−
=== Namenskonvetionen ===
+
=== Namenskonventionen ===
  
−
=== Version label ===
+
=== Versions-Label ===
 
Im Version-Label wird prinzipiell die Jahrzahl der Verabschiedung des Templates resp. Value-Sets resp. Datasets etc. eingetragen. Sollte die Angabe des Jahres nicht ausreichend sein, wird sie mit .Monat ergänzt. Dito für Tagesaktuelle Versionen.
 
Im Version-Label wird prinzipiell die Jahrzahl der Verabschiedung des Templates resp. Value-Sets resp. Datasets etc. eingetragen. Sollte die Angabe des Jahres nicht ausreichend sein, wird sie mit .Monat ergänzt. Dito für Tagesaktuelle Versionen.
 
Beispiele:
 
Beispiele:
Zeile 140: Zeile 140:
  
 
==== Templates ====
 
==== Templates ====
−
Business names of Templates are created using CamelCase notation according to the element which wraps further content (e.g. LegalAuthenticator). The prefix of the project shall be added. The prefix of the template type shall also be added as follows:
 
  
 +
Die Namen von Templates werden wie folgt angegeben:
 +
 +
[Präfix]_[Template-Typ]_[ElementName]
 +
 +
[Präfix]: Als Präfix dient das Projektkürzel (Name des Repositories)
 +
[Template-Typ]: Der Template-Typ kann
 
* document
 
* document
 
* header
 
* header
Zeile 147: Zeile 152:
 
* entry
 
* entry
 
* other
 
* other
 +
enthalten.
 +
[ElementName]: wird in CamelCase-Notation angegeben. 
 +
Als Trenner fungieren Unterstriche "_".
  
−
Prefixes shall be separated by underscore '_'
+
Beispiele:
 +
- Template im BBR:
 +
Name: elga_section_ImpfempfehlungenKodiert
 +
DisplayName: Impfempfehlungen - kodiert
  
−
Example:
+
- Template aus dem Projekt eImpfpass:  
 
Name: eimpf_document_KompletterImpfstatus
 
Name: eimpf_document_KompletterImpfstatus
 
DisplayName: Kompletter Impfstatus
 
DisplayName: Kompletter Impfstatus

Version vom 29. Januar 2019, 16:33 Uhr


1 Summary

TODO

1.1 Guidelines

TODO

1.2 Governance

TODO

2 Introduction

2.1 Purpose

TODO

2.2 Scope

TODO

2.3 Process of developing

TODO

2.4 Evolving document

TODO

3 Richtlinien

3.1 Sprache

Die gesamte Dokumentation eines ELGA Implementierungsleitfadens wird grundsätzlich in deutscher Sprache verfasst. Dazu gehören textuelle Beschreibungen im Wiki, Art-Decor-Templates und Datasets.

3.2 OIDs

Im Zusammenhang mit der Verwendung von OIDs sind die österreichischen Richtlinen einzuhalten (Object Identifier (OID) Konzept für das österreichische Gesundheitswesen). Das österreichische OID Portal ist zu finden unter (OID Portal Österreich).

3.2.1 Implementierungsleitfäden

Für jeden Implementierungsleitfaden muss eine OID unterhalb des Knotens 1.2.40.0.34.7 registriert werden. Falls Dokumente in aufeinander aufbauenden Versionen vorliegen, kann 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

3.2.2 Art-Decor Root OIDs

Als neuer Root-Knoten für Art-Decor wird 1.2.40.0.34.6.0 (eHealth-Austria/services) verwendet.

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).

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).

3.2.3 Root OIDs for templates

OIDs for Art-Decor templates shall be drawn according to their CDA template types from the corresponding following child nodes:

.0 Document Level Template
.1 Header Level Template
.2 Section Level Template
.3 Entry Level Template
.9 other CDA Fragment Template
Information icon.svg Example: A Document Level Template gets an OID as follows: 2.16.756.5.30.1.1.10.1.xxx (where xxx is the number of the specific template). The next free OID can be found via templates or value sets from a Governance Group

3.2.4 Versioning of document-level templates

TODO

3.2.5 Versioning of value sets

TODO

3.2.6 OIDs to be registered

TODO

3.3 Art-Decor

3.3.1 Repositories

3.3.1.1 Art-Decor BBR

TODO

3.3.2 Governance Groups

TODO

3.3.2.1 Artefact status in repositories

In a repository, artefacts shall be initially created in the status 'draft'. When finished, reviewed and endorsed, an artefact’s status can be changed in the repository according the rules of the responsible governance group (see Art-Decor.org/Template Editor for the Art-Decor default state/event diagram). Chapter #Repositories contains the description of the detailed process and responsibilities.

3.3.3 Namenskonventionen

3.3.4 Versions-Label

Im Version-Label wird prinzipiell die Jahrzahl der Verabschiedung des Templates resp. Value-Sets resp. Datasets etc. eingetragen. Sollte die Angabe des Jahres nicht ausreichend sein, wird sie mit .Monat ergänzt. Dito für Tagesaktuelle Versionen. Beispiele: 2019 2019.01 2019.01.16

3.3.4.1 Templates

Die Namen von Templates werden wie folgt angegeben:

[Präfix]_[Template-Typ]_[ElementName]

[Präfix]: Als Präfix dient das Projektkürzel (Name des Repositories) [Template-Typ]: Der Template-Typ kann

  • document
  • header
  • section
  • entry
  • other

enthalten. [ElementName]: wird in CamelCase-Notation angegeben. Als Trenner fungieren Unterstriche "_".

Beispiele: - Template im BBR: Name: elga_section_ImpfempfehlungenKodiert DisplayName: Impfempfehlungen - kodiert

- Template aus dem Projekt eImpfpass: Name: eimpf_document_KompletterImpfstatus DisplayName: Kompletter Impfstatus

3.3.4.2 Value Sets

3.3.4.3 Data Sets

3.3.5 Documentation

3.3.5.1 Templates

TODO

3.3.5.2 Standard references

TODO

3.3.6 Datasets

3.3.6.1 Language

See chapter #Languages for language guidelines.

3.3.6.2 Optionality

TODO

3.3.6.3 Official ELGA implementation guides

3.3.6.4 Minimum Description

TODO

3.3.7 Naming conventions for templates

Bsp:

Name: elga_entry_Impfung

Wiedergabename: Impfung Entry

Versionslabel:2019

3.3.8 Naming conventions for value sets

Bsp:

Name: eimpf_Abrechenbarkeit_VS

Wiedergabename: Abrechenbarkeit VS

Versionslabel:2019

3.4 Mediawiki

3.4.1 Structure of an Implementation Guide

To ensure a consistent approach and display of the implementation guide, the following (minimum, German) structure is recommended:

Vorlage:DokumentStruktur

TODO

3.4.2 Schematic View of Templates

TODO

3.4.3 Revisions

TODO

3.5 Releases

3.5.1 Art-Decor

TODO

3.5.2 Wiki

3.5.2.1 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 Art-Decor Support.

  • Perform search for:
    • "/dynamic"
    • "/static"
    • "Cannot find"
    • ...

Afterwards: Create a revision according to Wiki revisions.

4 Governance

4.1 Responsibilities

4.1.1 Support for Art-Decor

TODO

4.1.2 Governance Groups

TODO

4.1.3 Repositories

TODO

4.1.4 Wiki

TODO

4.2 Art-Decor artifact states

The following state/event diagram shows the default states and possbile transitions for an artifact within Art-Decor:

Governance state machine.png

[Abbildung 1] Default state diagram for Art-Decor artefacts

Each Governance Group may decide to avoid some of these states. It is not recommended to add new states by a Governance Group.


[Tabelle 1] Art-Decor state machine

Status Action Trigger / Description Example for CDA-CH Responsibility
Kyellow.png 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
Korange.png 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.
Kpurple.png 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
Kgreen.png 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
Korange.png 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.

4.3 Quality Assurance & Review

4.3.1 Art-Decor Repository

TODO

4.3.2 Implementation Guides

TODO

4.3.3 Official ELGA implementation guides

TODO

5 Annex

5.1 Links

5.2 List of Figures

  1. ↑ Default state diagram for Art-Decor artefacts

5.3 List of Tables

  1. ↑ Art-Decor state machine

5.4 List of future definitions

TODO

5.5 Weiterführende Links

HL7 Schweiz

Abgerufen von „http://wiki.hl7.at/index.php?title=ART-DECOR_Governance&oldid=104075“