ART-DECOR Governance
<--
Document Information
| Status | Draft |
|---|---|
| Document version | 1.1 |
| Authors |
|
| Stakeholder Contributor(s) | HL7 Schweiz, IHE Suisse, Heitmann Consulting and Services |
-->
Inhaltsverzeichnis
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 Guidelines
3.1 Languages
3.1.1 Art-Decor
TODO
3.1.2 Art-Decor export to Wiki
TODO
3.1.3 Wiki
TODO
3.1.4 Implementation guides / exchange formats
TODO
3.2 OIDs
3.2.1 Implementation Guide
For each Implementation Guide an OID with the following child nodes shall be created:
[Abbildung 1] OID Struktur für ELGA Implementierungsleitfäden basierend auf HL7 CDA
 |
Legend:
x:Is a placeholder for the next free child node within the OID tree. This ordinal number will be assigned by the OID Registration Authority (Refdata). yyyy:Is a placeholder for a 4-letter abbreviation of the English title of the implementation Guide. Symbolic names must be unique within the parent OID node. Duplicate values for yyyy are forbidden. |
3.2.2 Art-Decor root OIDs
All Art-Decor templates shall be placed below the OID 2.16.756.5.30.1.1.10 (hl7-ch-domains/decor-templates). All Art-Decor value-sets shall be placed below the OID 2.16.756.5.30.1.1.11 (hl7-ch-domains/decor-valuesets).
[Abbildung 2] OID tree for Art-Decor templates and value sets
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:
- .1 Document Level Template
- .2 Header Level Template
- .3 Section Level Template
- .4 Entry Level Template
- .9 other CDA Fragment Template
|
|
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 Documentation
3.3.3.1 Templates
TODO
3.3.3.2 Standard references
TODO
3.3.4 Datasets
3.3.4.1 Language
See chapter #Languages for language guidelines.
3.3.4.2 Optionality
TODO
3.3.4.3 Official ELGA implementation guides
3.3.4.4 Minimum Description
TODO
3.3.5 Naming conventions for templates
TODO
3.3.6 Naming conventions for value sets
TODO
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:
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:
[Abbildung 3] 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 |
|---|---|---|---|---|
 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
5.2 List of Figures
5.3 List of Tables
- ↑ Art-Decor state machine
5.4 List of future definitions
TODO
