ART-DECOR Governance

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

ELGA Implementierungsleitfäden werden in deutscher Sprache verfasst. Dazu gehören textuelle Beschreibungen im Wiki, Art-Decor-Templates und Datasets.

Eine Ausnahme bilden Template-Namen. Diese 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. Nur Template-Namen im CDA-Body werden auf deutsch vergeben, da diese den in den Arbeitsgruppen abgestimmten Titel der Sektion tragen sollen.

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 OIDs für Implementierungsleitfäden

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

Wichtiger Hinweis: Die Verwaltung der unter diesen Knoten liegenden Templates und Value-Sets unterliegt Art-Decor und benötigt daher keine Registrierung über das OID-Portal.

3.2.3 Root OIDs für Templates

Die OIDs der Art-Decor Templates sollen außerdem entsprechend ihres CDA-Template-Typs aus folgender 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)

Wichtiger Hinweis: Die nächste freie OID für Templates und Value-Sets kann über die Art-Decor Governance Group, unter "List of Artefacts under this Governance Group" ermittelt werden.

3.3 Namenskonventionen

3.3.1 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.2 Namenskonventionen für Templates

Die Namen von Templates werden wie folgt angegeben: [Präfix]_[Template-Typ]_[ElementName]
Wobei folgendes gilt:

[Präfix]

Als Präfix dient das Projektkürzel (Name des Repositories) in CamelCase-Notation, z.B. "atcdabrr"

[Template-Typ]

Der Template-Typ kann enthalten:

• "document"
• "header"
• "section"
• "entry"
• "other"

[ElementName]

Bezeichnung des Templates in CamelCase-Notation. Als Trenner fungieren Unterstriche "_".

Beispiele:

• Template einer unkodierten Sektion im Repository AT-CDA-BBR:

Name: "atcdabrr_section_FruehereErkrankungUnkodiert"
DisplayName: "Frühere Erkrankungen - unkodiert"

• Template einer kodierten Sektion im ELGA e-Impfpass Repository:

Name: "eimpf_section_ImpfrelevanteErkrankungenKodiert"
DisplayName: "Impfrelevante Erkrankungen - kodiert"

• Document Level Template im ELGA e-Impfpass Repository:

Name: "eimpf_document_KompletterImmunisierungsstatus"
DisplayName: "Kompletter Immunisierungsstatus"

• Entry im AT-CDA-BBR:

Name: "atcdabbr_entry_Immunizations"
DisplayName: "Immunization Entry"

• Template aus der Kategorie "Other" im AT-CDA-BBR:

Name: atcdabbr_other_TextElementWithReferenceToNarrativeText
DisplayName: Narrative Text Reference

3.4 Versionierung

3.4.1 Versionierung von Document-Level Templates

TODO

3.4.2 Versionierung von Value-Sets

Bei der Aktualisierung eines Value Sets muss das effectiveDate auf das aktuelle Datum (Gültig ab-Datum) geändert werden.

Name: Name des Value Sets In Art-Decor ist der "Wiedergabename" gleichzeitig der "Name".

Versionlabel: YYYYMM.Korrekturnummer(-beta)

Korrekturnummer ist optional. Bei Änderungen innerhalb eines Monats wird eine Korrekturnummer angehängt.

"Beta" wird nur bei Value Sets verwendet, die noch in Arbeit sind. Sobald die Version gültig ist, wird das beta entfernt.

3.5 Art-Decor

3.5.1 Repositories

3.5.1.1 Art-Decor BBR

Das ELGA Building Block Repository (BBR) enthält alle Basis-Templates:

• ELGA Repository

Die im ELGA BBR befindlichen Templates dürfen nur von einem eingeschränkten Benutzerkreis bearbeitet werden.

3.5.2 Governance Groups

TODO

3.5.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.5.3 Documentation

3.5.3.1 Templates

TODO

3.5.3.2 Standard references

TODO

3.5.4 Datasets

3.5.4.1 Language

See chapter #Languages for language guidelines.

3.5.4.2 Optionality

TODO

3.5.4.4 Minimum Description

TODO

3.5.5 Namenskonventionen für Value-Sets

Analog zu Templates, mit dem Zusatz "VS". Displayname und Name sind hier gleich. Beispiel: Name: eimpf_Abrechenbarkeit_VS Wiedergabename: eimpf_Abrechenbarkeit_VS

3.6 Mediawiki

3.6.1 Structure of an Implementation Guide

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

TODO

3.6.2 Schematic View of Templates

TODO

3.6.3 Revisions

TODO

3.7 Releases

3.7.1 Art-Decor

TODO

3.7.2 Wiki

3.7.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:

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.

Art-Decor state machine

Status	Action	Trigger / Description	Example for CDA-CH	Responsibility
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
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.
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
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
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

• Workspace
• Art-Decor Open Tools
• eHealth Wiki
• eHealth Suisse
• Art-Decor Google Group

5.4 List of future definitions

TODO

5.5 Weiterführende Links

HL7 Schweiz