Publication Templates

Revision as of 13:22, 5 June 2014 by Mligtvoet (talk | contribs) (first setup of page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Templates

Templates support mapping of data set artifacts to HL7v3 artifacts. The template format is influenced by the Templates Registry Project (HL7 International) and is a simplified representation of the HL7 MIF (model interchange format). The primary purposes for the definition of templates in DECOR are:

  • the construction of validation methods to support the implementation of interfaces. These methods are: schematron, and (in the future) simplified W3C schema for vendors who want to generate code based on schematron or schema
  • the documentation of templates, referenced value sets and identifications, constraints, conditions and co-occurrences
  • the documentation of template examples

Example

This text documents an example template that contains:

  • template metadata
    • identifier
    • name
    • timestamp after which the template existed
    • status of the template
    • description of the intent and scope of the template
    • context
  • template
    • example XML fragment
    • elements with properties like:
      • data type
      • vocabulary bindings (value sets)
      • property (range specified with minInclude and maxInclude)
      • identifier that references the dataset concept
      • attributes with fixed values (OBS, EVN)

Example template fragment

An example template (identifiers are fictional):

<template id="2.999.999.999.77.9.10.90.100001" name="Gravidity" effectiveDate="2011-01-28" statusCode="active">
    <desc>Template example for gravidity</desc>
    <example>
        <observation classCode="OBS" moodCode="EVN">
            <code code="Gravidity" codeSystem="2.16.840.1.113883.2.4.4.13"/>
            <value xsi:type="INT" value="2"/>
        </observation>
    </example>
    <element name="hl7:observation">
        <attribute classCode="OBS" moodCode="EVN"/>
        <element name="hl7:code" minimumMultiplicity="1" maximumMultiplicity="1" isMandatory="true" datatype="CE">
            <vocabulary code="Gravidity" codeSystem="2.16.840.1.113883.2.4.4.13"/>
        </element>
        <element name="hl7:value" minimumMultiplicity="1" maximumMultiplicity="1" id="2.999.999.999.77.9.100001.1" datatype="INT">
            <property minInclude="0" maxInclude="75"/>
        </element>
    </element>
</template>