ART Template Viewer

Revision as of 14:25, 5 August 2014 by Kheitmann (talk | contribs) (Template viewer overview)

Template viewer overview

Templateviewer1.png

The typical template viewer window has a navigation list on the left (1) with a search field (2), a template meta data area (3) and the template design body area (4).

The templates are listed in the navigation area as document level templates (1) or as re-usable templates with a recycling icon (2). The icons can be orange for a template status "draft" or "in review", or green for a template status "active" or blue for a template status "retired" or "inactive".

Template Meta data

Templateviewer2.png

The upper right part of the template viewer contains the template meta data. Version (effective date), a possible version label and the template name are shown (1). The status code is also indicated with a colored dot (2), furthermore the template id and display name are shown.

The accordion area contains descriptions, classifications and whether the template is defined as open or closed. The usage part (4) may list templates that uses this template or what templates this templates uses. A relationship list (not shown in this picture) may show all relationships to other templates or models.

Examples may show the correct use of the template by an XML fragment (5).

Table view of template design

Templateviewer3.png

The captions of the table view of a template design are:

Item (1)

contains the XML document tree view of all elements and attributes specified in the template design. Elements are denoted by a preceding "<>" and attributes by "@".

DT (2)

datatypes, contains the datatype of the item, please refer to valid datatypes for elements and attributes respectively

Values of the conformance column
Conf Description
O optional
R required
M mandatory
C conditional
NP not present

Card / Conf (3)

cardinality and conformance of the item; conformance may display values as shown in the following table.

Description (4)

contains a textual description of the item, may also contain constraints and values for fixed attributes.

Label (5)

is a human readable label that is displayed upon errors, warnings or notes during validation.

Detail table view of template design

Templateviewer4.png

The actual template design shows the XML structure in a hierarchical list of elements (items) that are typically prefixed by the namespace "hl7:" or "cad:" (1). Elements are denoted with a <>, attributes with an @ sign (2). Data types are specified according to the list of supported data types (3) They may be simple data types or flavors thereof. The cardinality and conformance column is explained above (4).

Fixed values for e.g. attributes are also shown in the "description" column (5). An optional label is displayed at the rightmost column (6). Some items have a reference / relationship with data set elements that are denoted as a concept target (7). Inclusion of other templates are shown accordingly (8) and "transcluded" in the template viewer.