DECOR-rules
Template metadata is mainly defined in the “Business Requirements for Template Registries” [ref follows]. In order to support template registries and to allow the appropriate use of templates, the following metadata is associated with each template.
Contents
@id
A mandatory globally unique, non-semantic, identifier for the template as the primary identifier.
@name
A required name for the template as a secondary identifier. Please note that there is no guarantee that the name is globally unique.
@effectiveDate
The mandatory date (and time) after which the template can be considered for use. Use of the template prior to this date would be considered an invalid use of the template.
@expirationDate
The optional date at which the concept represented by this template becomes stale, and should be reviewed for (clinical) relevance and accuracy. Use of the template after this date would be considered venturesome.
@statusCode
The mandatory status of the template. According to the Business Requirements for Template Registries ART-DECOR uses the following subset of status codes of a template (in black).
| statusCode | Description |
|---|---|
| draft | Template under development (nascent). Metadata and template may be incomplete. Entered primarily to encourage other users to be aware of ongoing process. |
| active | Template has been published by the custodian organization and deemed fit for use. May have associated adoption and annotation metadata |
| retired | Template retired: No longer fit for use. Information available for historical reference. |
| inactive | Template never recommended for use. For example, rejected, withdrawn or found another template fit for use of the one under development. Will not have associated adoption metadata. |
| rejected | Template is rejected |
| cancelled | Template is withdrawn |
| update | Template under Update (adoption metadata): adopter adds adoption metadata and/or grouping metadata: these are the only actions an adopter organization can perform. The template(s) in the "under update (adoption metadata)" status are unavailable for any other status or metadata changes until the “under update/adoption metadata” action has been completed. |
| pending | Template is in pre-publication review: the template is complete, pending appropriate review. Entered primarily to encourage other users to be aware of and/or participate in the review process. The custodian organization has not given it an “Active” status (i.e. it has not been published); and it may still be rejected (transitioned to an inactive status). E.g. the template may be under ballot by an SDO. |
| review | Template is in Review: a post-publication state; may result in a new version or a retirement or no change at all. A new version is one that adds clarity but not new intent; the version number is incremented by one, but the identifier is unchanged. A retirement is a template that is no longer fit for purpose, and which may be replaced by a different a template with a different identifier, which is linked to the retired template. |
 | A template registry may consider all status codes (also those in grey) that are defined in the Business Requirements for Template Registries. The template itself is considered to need only the codes mentioned above and the experience of several years using ART-DECOR showed that this is sufficient. |
@displayName
The optional human readable display name for the template for orientation purposes. This is not intended for machine processing and typically created in the project’s language or in English.
@versionLabel
The optional human readable version label for the template to be able to determine the correct version of a template. This is not intended for machine processing.
