5 Conventions (Current)
Prev		Next

5 Conventions

5.1 Template Metadata

Each template has a set of metadata, as specified in the HL7 Templates Specification. The metadata is presented as a table, as shown in Table 5.1-1.

Table 5.1-1. Template metadata table format

Template ID	OID (see Section 5.1.1)
Name
Effective Date
Version Label	(see Section 5.1.1)
Status	"draft", "active", "review" or "retired"
Description
Classification	type of the template, e.g., CDA Section Level
Relationships	relationships to other templates or model artifacts
Context	"parent node", "sibling node" (see Section 5.1.2)
Open/Closed	"open", "closed"(see Section 5.1.3)
Revision History

5.1.1 Template IDs and Version

Template identifiers (templateId) are assigned for each document, section, and entry level template. When valued in an instance, the template identifier signals the imposition of a set of template-defined constraints. The value of this attribute (e.g., @root="2.16.840.1.113883.10.20.22.4.8") provides a unique identifier for the template in question.

A template may be further qualified by a version label. This label may be used as the extension attribute of the templateID (e.g., @extension="20150309"). All versions of a template, regardless of the version label, must be compatible; i.e., they may vary only by optional content conformance requirements. Thus the version label is typically not used as a conformance constraint.

Within this Standard, template versions are identified by the string "DICOM" and the date of adoption (represented as YYYYMMDD), separated by a hyphen (e.g., DICOM-20150523).

5.1.2 Context

As described in the HL7 Template specification section 2.9.9.4, the context identifies whether the template applies to the parent node in which the templateID is an element, or applies to its sibling nodes in the template table. These typically are applied respectively to templates with a single parent element with child element structure, and to templates with flat list of sibling elements (see Section 5.2.8).

5.1.3 Open and Closed Templates

Each template is defined as being either "open" or "closed". In "open" templates, all of the features of the CDA Specification are allowed except as constrained by the templates. By contrast, a "closed" template specifies everything that is allowed and nothing further may be included.

Prev		Next
4 Symbols and Abbreviations	Home	5.2 Template Table Structure