Personal tools
User menu

ART Template Viewer

From art-decor.org

Jump to: navigation, search

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. Id, Status and the template name are shown (1). Furthermore the Version (effective date), a possible version label and the display name are shown (2).

The description area (plain or an accordion) contains descriptions (3), followed by classifications and whether the template is defined as open or closed (4). The usage part (5) may list templates that uses this template or what templates this templates uses. A relationship list (6) may show all relationships to other templates or models.

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

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.

Card / Conf (3)

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

Values of the conformance column
Conf Short Description
O optional Data is truly optional
R required If data is present and not masked (e.g. for privacy reasons), it must be provided, otherwise it may be omitted or explicitly null flavored
M mandatory The data must be populated with a valid value from the associated value domain, otherwise the instance is not valid and may not be communicated
C conditional There are conditions when data has to be provided (e.g. co-constraints like "information about pregnancy IF the patient is "female"
F fixed The data has a fixed value
NP not present Data shall not be present

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 "cda:" (1). 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.

Form parameters

The template form, as most other forms, supports parametrization.

/decor-templates--[prefix]?id=[template id]&effectiveDate=[template effective date]&language=[ll-CC]
Parameter Description Since
prefix Project prefix always
id Switches to the project template with this id/name. Format: OID/name. Note: while references by name remain supported on best effort basis for historic reasons they are notoriously ambiguous and hence strongly discouraged. art v1.5
effectiveDate Switches to the project template with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param id art v1.5
templateRef Switches to the project template with this id/name. Format: OID always (deprecated in art >= 1.5)
templateEffectiveDate Switches to the project template with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param templateRef always (deprecated in art >= 1.5)
language Displays contents in the requested language. When contents are not available in the requested language, there will be nothing to display. Example en-US, or nl-NL. art v1.8.51
  • This page was last modified on 4 October 2017, at 11:01.
  • This page has been accessed 71,174 times.