Bearbeiten von „ART-DECOR Governance“

<!--
{{Infobox Dokument
|Title     = Best Practices and Governance for Art-Decor
|Short     = Art-Decor Governance 
|Type      = Governance
|Namespace = Ehscda
|Version   = 1.1
|Date      = 21.03.2017
|Copyright = 2017-2018
|Status    = Draft
|Period    = 21.03.2017
|OID       = TODO
|Realm     = Schweiz
|Submitted = 21.03.2017}}

{{Versionbox Begin}}
{{VersionboxEntry | Version = 0.1 | Date = 02.02.2017 | Status = Draft | History=Initial Draft for review on 03.02.2017 (JGN)}}
{{VersionboxEntry | Version = 0.2 | Date = 03.02.2017 | Status = Draft | History=Inputs from Telco on 03.02.2017: State Diagram for artefacts (JGN)}}
{{VersionboxEntry | Version = 0.3 | Date = 15.02.2017 | Status = Draft | History=Include comments from review (JBL, OEG, JGN, KHE, TSC)}}
{{VersionboxEntry | Version = 0.4 | Date = 20.02.2017 | Status = Draft | History=finalize document for audit within HL7 & IHE Switzerland (JGN)}}
{{VersionboxEntry | Version = 0.5 | Date = 28.02.2017 | Status = Draft | History=Include comments from review (Tony Schaller, IHE, HL7) (JGN, TSC)}}
{{VersionboxEntry | Version = 1.0 | Date = 21.03.2017 | Status = Final | DocumentLink=| History=First release}}
{{VersionboxEntry | Version = 1.1 | Date = 07.05.2018 | Status = Draft | History=Changes according lessons learned from CDA-CH V2, LREP, VACD, EMED.<ul><li>[[#Structure of an Implementation Guide | Specification: chapter structure]]</li><li>[[#Support for Art-Decor  | Involvement of Art-Decor Support]]</li><li>[[#Revisions | PDF Generation with Prince and Github Link]]</li><li>[[#Art-Decor artifact states | Status Pre-publication Review for art-decor artefacts]]</li><li>[[#Revisions | Art-Decor release notes]]</li></ul>}}
{{Versionbox End}}
-->

<--
'''Document Information'''
{| class="doc governance-doc-info"
|-
! Status  
| Draft
|-
! Document version
| 1.1
|-
! Authors
| 
* Johannes Gnägi (eHealth Suisse)
* Sang-Il Kim (eHealth Suisse)
* Kai Heitmann (Heitmann Consulting and Services , ART-DECOR Open Tools)
* Jürg Bleuer (eHealth Suisse)
* Tony Schaller (IHE Suisse)
* Oliver Egger (HL7 Benutzergruppe Schweiz)
|-
! Stakeholder Contributor(s)
| HL7 Schweiz, IHE Suisse, Heitmann Consulting and Services
|}
-->

= Summary =
TODO

== Guidelines ==
TODO

== Governance ==
TODO

= Introduction =
== Purpose ==
TODO

== Scope ==
TODO

== Process of developing ==
TODO

== Evolving document ==
TODO

= Guidelines =
== Languages ==
===Art-Decor===
TODO

===Art-Decor export to Wiki===
TODO

===Wiki===
TODO

===Implementation guides / exchange formats===
TODO

== OIDs ==
===Implementation Guide===
For each Implementation Guide an OID with the following child nodes ''shall'' be created:

{{HL7img | Governance oid impl-guide.png | 400px |80%}}
<ref group="Abbildung">OID Struktur für ELGA Implementierungsleitfäden basierend auf HL7 CDA</ref> ''OID Struktur für ELGA Implementierungsleitfäden basierend auf HL7 CDA''

{{NoteBox|
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.
}}

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

{{HL7img | Governance oid temp-val.png | 400px |80%}}
<ref group="Abbildung">OID tree for Art-Decor templates and value sets</ref> ''OID tree for Art-Decor templates and value sets''

===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

{{NoteBox |
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''
}}

===Versioning of document-level templates===
TODO

===Versioning of value sets===
TODO

===OIDs to be registered===
TODO

== Art-Decor ==
=== Repositories ===
==== Art-Decor BBR====
TODO

=== Governance Groups ===
TODO

==== 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 [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.

=== Documentation ===
==== Templates ====
TODO

==== Standard references ====
TODO

=== Datasets ===
==== Language ====
See chapter [[#Languages]] for language guidelines. 

==== Optionality ====
TODO

==== Official ELGA implementation guides ==== 

==== Minimum Description====
TODO

=== Naming conventions for templates ===
TODO

=== Naming conventions for value sets ===
TODO

== Mediawiki ==
=== Structure of an Implementation Guide ===
To ensure a consistent approach and display of the implementation guide, the following (minimum, German) structure is ''recommended'':

{{DokumentStruktur}}

TODO

=== Schematic View of Templates ===
TODO

=== Revisions ===
TODO

== Releases ==
=== Art-Decor ===
TODO

=== 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" 
** "/static"
** "Cannot find"
** ...

'''Afterwards:''' 
Create a revision according to [[#Revisions | Wiki revisions]]. 

= Governance =
== Responsibilities ==
=== Support for Art-Decor ===
TODO

=== Governance Groups ===
TODO

=== Repositories ===
TODO

=== Wiki ===
TODO

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

{{HL7img | Governance state machine.png | 400px |80%}}
<ref group="Abbildung">Default state diagram for Art-Decor artefacts</ref> ''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.


<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.''
| 
|}

== Quality Assurance & Review ==
=== Art-Decor Repository ===
TODO

=== Implementation Guides ===
TODO

=== Official ELGA implementation guides ===
TODO

= Annex =
==Links==
* [http://art-decor.org/art-decor/home Workspace]
* [http://art-decor-open-tools.net Art-Decor Open Tools]
* [http://e-health-wiki.ch/index.php/Hauptseite eHealth Wiki]
* [http://www.e-health-suisse.ch eHealth Suisse]
* [https://groups.google.com/d/forum/swiss-art-decor-implementors Art-Decor Google Group]

==List of Figures==
<references group="Abbildung"/>
==List of Tables==
<references group="Tabelle"/>

==List of future definitions==
TODO

[[Kategorie:Hilfe]]
[[Kategorie:Best Practices]]
[[Kategorie:Governance]]
[[Kategorie:Anleitung]]