Showing:

Annotations
Attributes
Diagrams
Facets
Instances
Model
Properties
Source
Used by
Element TemplateDefinition / desc
Namespace No namespace
Diagram
DiagramDECOR-datatypes_xsd_Complex_Type_VariousMixedContent.tmp#VariousMixedContentDECOR-datatypes_xsd_Complex_Type_FreeFormMarkupWithLanguage.tmp#FreeFormMarkupWithLanguage_languageDECOR-datatypes_xsd_Complex_Type_FreeFormMarkupWithLanguage.tmp#FreeFormMarkupWithLanguage_lastTranslatedDECOR-datatypes_xsd_Complex_Type_FreeFormMarkupWithLanguage.tmp#FreeFormMarkupWithLanguage_mimeTypeDECOR-datatypes_xsd_Complex_Type_FreeFormMarkupWithLanguage.tmp#FreeFormMarkupWithLanguage
Type FreeFormMarkupWithLanguage
Type hierarchy
Properties
content complex
minOccurs 0
maxOccurs unbounded
mixed true
Model
ANY element from ANY namespace
Attributes
QName Type Use Annotation
language LanguageCode optional 
Indicates the language in which the marked up text is expressed
 
UML: part of a complex stereotype tag
lastTranslated TimeStampNoTimezone optional 
Indicates when this languages rendition was last translated from the original.
 
UML: part of a complex stereotype tag
mimeType MimeType optional 
Indicates the mime type in which the data is expressed. If not specified, applications SHALL interpret the content based on other context or
specific application rules. Applications that do not recognize content SHALL retain it unchanged.
 
UML: Part of a complex tag
Source
 
<xs:element name="desc" minOccurs="0" maxOccurs="unbounded" type="FreeFormMarkupWithLanguage"/>
Element TemplateDefinition / classification
Namespace No namespace
Diagram
DiagramDECOR_xsd_Complex_Type_TemplateProperties.tmp#TemplateProperties_typeDECOR_xsd_Complex_Type_TemplateProperties.tmp#TemplateProperties_formatDECOR_xsd_Complex_Type_TemplateProperties.tmp#TemplateProperties_tagDECOR_xsd_Complex_Type_TemplateProperties.tmp#TemplateProperties_propertyDECOR_xsd_Complex_Type_TemplateProperties.tmp#TemplateProperties
Type TemplateProperties
Properties
content complex
minOccurs 0
maxOccurs unbounded
Model
Children property, tag
Instance
 
<classification format="hl7v3xml1" type="">
  <tag>{0,unbounded}</tag>
  <property>{0,unbounded}</property>
</classification>
Attributes
QName Type Default Use
format TemplateFormats hl7v3xml1 optional
type TemplateTypes required
Source
 
<xs:element name="classification" type="TemplateProperties" minOccurs="0" maxOccurs="unbounded"/>
Element TemplateDefinition / relationship
Namespace No namespace
Diagram
DiagramDECOR_xsd_Complex_Type_TemplateRelationships.tmp#TemplateRelationships_typeDECOR_xsd_Complex_Type_TemplateRelationships.tmp#TemplateRelationships_templateDECOR_xsd_Complex_Type_TemplateRelationships.tmp#TemplateRelationships_modelDECOR_xsd_Complex_Type_TemplateRelationships.tmp#TemplateRelationships_flexibilityDECOR_xsd_Attribute_Group_TemplateRelationshipCompilationAttributes.tmp#TemplateRelationshipCompilationAttributesDECOR_xsd_Complex_Type_TemplateRelationships.tmp#TemplateRelationships
Type TemplateRelationships
Properties
content complex
minOccurs 0
maxOccurs unbounded
Attributes
QName Type Use Annotation
flexibility StaticOrDynamicFlexibility optional 
Reference to a template/@effectiveDate. Default is unspecified which means 'latest available version'.
ident xs:string optional 
Added in compilation process for relationship. DO NOT ADD/EDIT yourself. Contains the project prefix for template
linkedartefactmissing optional 
Added in compilation process for relationship. DO NOT ADD/EDIT yourself. Signals the template indicated in the relationship was not found
model NonEmptyString optional 
A reference to a model artifact identifier or description specifying from what this template is derived from or based on, e.g. an HL7 R-MIM, a DCM,
used for template-model relationships
template BasicIdOrOid optional 
A reference by name or id to a template identifier, used for template-template relationships
tmdisplayName xs:string optional 
Added in compilation process for relationship. DO NOT ADD/EDIT yourself. Contains the displayName of the template
tmeffectiveDate xs:string optional 
Added in compilation process for relationship. DO NOT ADD/EDIT yourself. Contains the effectiveDate of the template
tmexpirationDate xs:string optional 
Added in compilation process for relationship. DO NOT ADD/EDIT yourself. Contains the expirationDate of the template
tmid xs:string optional 
Added in compilation process for relationship. DO NOT ADD/EDIT yourself. Contains the id of the template
tmname xs:string optional 
Added in compilation process for relationship. DO NOT ADD/EDIT yourself. Contains the name of the template
tmstatusCode xs:string optional 
Added in compilation process for relationship. DO NOT ADD/EDIT yourself. Contains the statusCode of the template
tmversionLabel xs:string optional 
Added in compilation process for relationship. DO NOT ADD/EDIT yourself. Contains the versionLabel of the template
type RelationshipTypes required 
The @type of the relationship of the template, at this point in time something like "SPEC", "GEN", "EQUIV", "VERSION", etc.
url xs:string optional 
Added in compilation process for relationship. DO NOT ADD/EDIT yourself. Contains the server url for template
Source
 
<xs:element name="relationship" type="TemplateRelationships" minOccurs="0" maxOccurs="unbounded"/>
Element TemplateDefinition / publishingAuthority
Namespace No namespace
Annotations
 
The authoritative body who has reviewed the Template for (clinical) accuracy and relevance, 
and authorized it for publication. Registries may require this element to be valued
Diagram
DiagramDECOR_xsd_Complex_Type_AuthorityType.tmp#AuthorityType_idDECOR_xsd_Complex_Type_AuthorityType.tmp#AuthorityType_nameDECOR_xsd_Attribute_Group_PublicationAuthorityCompilationAttributes.tmp#PublicationAuthorityCompilationAttributesDECOR_xsd_Element_addrLine.tmp#addrLineDECOR_xsd_Complex_Type_AuthorityType.tmp#AuthorityType
Type AuthorityType
Properties
content complex
minOccurs 0
maxOccurs 1
mixed true
Model
Children addrLine
Instance
 
<publishingAuthority id="" inherited="" name="">
  <addrLine type="">{0,unbounded}</addrLine>
</publishingAuthority>
Attributes
QName Type Use Annotation
id Oid optional 
Id of the authority/organisation/person
inherited optional
name NonEmptyString required 
Name of the authority/organisation/person
Wildcard: ANY attribute from ANY namespace OTHER than 'No Namespace'
Source
 
<xs:element name="publishingAuthority" type="AuthorityType" minOccurs="0" maxOccurs="1">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">The authoritative body who has reviewed the Template for (clinical) accuracy and relevance, and authorized it for publication. Registries may require this element to be valued</xs:documentation>
  </xs:annotation>
</xs:element>
Element TemplateDefinition / endorsingAuthority
Namespace No namespace
Annotations
 
A list of bodies who have reviewed the Template for (clinical) accuracy and relevance, 
and endorsed it for use
Diagram
DiagramDECOR_xsd_Complex_Type_AuthorityType.tmp#AuthorityType_idDECOR_xsd_Complex_Type_AuthorityType.tmp#AuthorityType_nameDECOR_xsd_Attribute_Group_PublicationAuthorityCompilationAttributes.tmp#PublicationAuthorityCompilationAttributesDECOR_xsd_Element_addrLine.tmp#addrLineDECOR_xsd_Complex_Type_AuthorityType.tmp#AuthorityType
Type AuthorityType
Properties
content complex
minOccurs 0
maxOccurs 0
mixed true
Model
Children addrLine
Instance
 
<endorsingAuthority id="" inherited="" name="">
  <addrLine type="">{0,unbounded}</addrLine>
</endorsingAuthority>
Attributes
QName Type Use Annotation
id Oid optional 
Id of the authority/organisation/person
inherited optional
name NonEmptyString required 
Name of the authority/organisation/person
Wildcard: ANY attribute from ANY namespace OTHER than 'No Namespace'
Source
 
<xs:element name="endorsingAuthority" type="AuthorityType" minOccurs="0" maxOccurs="0">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">A list of bodies who have reviewed the Template for (clinical) accuracy and relevance, and endorsed it for use</xs:documentation>
  </xs:annotation>
</xs:element>
Element TemplateDefinition / purpose
Namespace No namespace
Annotations
 
A statement about the purpose of the template
Diagram
DiagramDECOR-datatypes_xsd_Complex_Type_VariousMixedContent.tmp#VariousMixedContentDECOR-datatypes_xsd_Complex_Type_FreeFormMarkupWithLanguage.tmp#FreeFormMarkupWithLanguage_languageDECOR-datatypes_xsd_Complex_Type_FreeFormMarkupWithLanguage.tmp#FreeFormMarkupWithLanguage_lastTranslatedDECOR-datatypes_xsd_Complex_Type_FreeFormMarkupWithLanguage.tmp#FreeFormMarkupWithLanguage_mimeTypeDECOR-datatypes_xsd_Complex_Type_FreeFormMarkupWithLanguage.tmp#FreeFormMarkupWithLanguage
Type FreeFormMarkupWithLanguage
Type hierarchy
Properties
content complex
minOccurs 0
maxOccurs unbounded
mixed true
Model
ANY element from ANY namespace
Attributes
QName Type Use Annotation
language LanguageCode optional 
Indicates the language in which the marked up text is expressed
 
UML: part of a complex stereotype tag
lastTranslated TimeStampNoTimezone optional 
Indicates when this languages rendition was last translated from the original.
 
UML: part of a complex stereotype tag
mimeType MimeType optional 
Indicates the mime type in which the data is expressed. If not specified, applications SHALL interpret the content based on other context or
specific application rules. Applications that do not recognize content SHALL retain it unchanged.
 
UML: Part of a complex tag
Source
 
<xs:element name="purpose" minOccurs="0" maxOccurs="unbounded" type="FreeFormMarkupWithLanguage">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">A statement about the purpose of the template</xs:documentation>
  </xs:annotation>
</xs:element>
Element TemplateDefinition / copyright
Namespace No namespace
Annotations
Diagram
Type CopyrightText
Type hierarchy
Properties
Model
Attributes
Source
Element TemplateDefinition / revisionHistory
Namespace No namespace
Annotations
 
The free text description describing the changes in this version of the Template as compared to the previous version. 
Since Template versions are built off of previous versions, the net effect of this field is to function as a
comprehensive historical reference of the Template.
Diagram
DiagramDECOR_xsd_Complex_Type_ObjectHistory.tmp#ObjectHistory_dateDECOR_xsd_Complex_Type_ObjectHistory.tmp#ObjectHistory_byDECOR_xsd_Complex_Type_ObjectHistory.tmp#ObjectHistory_descDECOR_xsd_Complex_Type_ObjectHistory.tmp#ObjectHistory
Type ObjectHistory
Properties
content complex
minOccurs 0
maxOccurs 0
Model
Children desc
Instance
 
<revisionHistory by="" date="">
  <desc language="" lastTranslated="" mimeType="">{0,unbounded}</desc>
</revisionHistory>
Attributes
QName Type Use
by NonEmptyString optional
date TimeStampNoTimezone optional
Source
 
<xs:element name="revisionHistory" type="ObjectHistory" minOccurs="0" maxOccurs="0">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">The free text description describing the changes in this version of the Template as compared to the previous version. Since Template versions are built off of previous versions, the net effect of this field is to function as a comprehensive historical reference of the Template.</xs:documentation>
  </xs:annotation>
</xs:element>
Element TemplateDefinition / inherit
Namespace No namespace
Diagram
DiagramDECOR_xsd_Complex_Type_InheritDefinition.tmp#InheritDefinition_refDECOR_xsd_Complex_Type_InheritDefinition.tmp#InheritDefinition_effectiveDateDECOR_xsd_Attribute_Group_InheritCompilationAttributes.tmp#InheritCompilationAttributesDECOR_xsd_Complex_Type_InheritDefinition.tmp#InheritDefinition
Type InheritDefinition
Properties
content complex
minOccurs 0
maxOccurs 0
Attributes
QName Type Use Annotation
datasetEffectiveDate optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the dataset effectiveDate for the inherited concept
datasetExpirationDate optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the dataset expirationDate for the original concept
datasetId optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the dataset id for the original concept
datasetStatusCode optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the dataset statusCode for the inherited concept
datasetVersionLabel optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the dataset versionLabel for the original concept
effectiveDate TimeStampNoTimezone required
iEffectiveDate optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the effectiveDate for the inherited concept
iExpirationDate optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the expirationDate for the inherited concept
iStatusCode optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the statusCode for the inherited concept
iType optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the type for the original concept
iVersionLabel optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the versionLabel for the inherited concept
localInherit optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains a boolean for whether or not the relationship 'lives' in the same project or not
originalEffectiveDate optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the concept effectiveDate for the original concept, if the inherited concept was itself an inheriting/containing concept
originalExpirationDate optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the concept expirationDate for the original concept, if the inherited concept was itself an inheriting/containing concept
originalId optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the concept id for the original concept, if the inherited concept was itself an inheriting/containing concept
originalPrefix optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the concept project prefix for the original concept, if the inherited concept was itself an inheriting/containing concept
originalStatusCode optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the concept statusCode for the original concept, if the inherited concept was itself an inheriting/containing concept
originalVersionLabel optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the concept versionLabel for the original concept, if the inherited concept was itself an inheriting/containing concept
prefix optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the project prefix for the original concept
ref Oid required
refdisplay xs:string optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the calculated display name for the value in @ref
Source
 
<xs:element name="inherit" type="InheritDefinition" minOccurs="0" maxOccurs="0"/>
Element TemplateDefinition / choice
Namespace No namespace
Diagram
DiagramDECOR-datatypes_xsd_Attribute_Group_MultiplicityRangeOptional.tmp#MultiplicityRangeOptionalDECOR_xsd_Complex_Type_ChoiceDefinition.tmp#ChoiceDefinition_descDECOR_xsd_Element_item.tmp#itemDECOR_xsd_Complex_Type_ChoiceDefinition.tmp#ChoiceDefinition_includeDECOR_xsd_Complex_Type_ChoiceDefinition.tmp#ChoiceDefinition_elementDECOR_xsd_Complex_Type_ChoiceDefinition.tmp#ChoiceDefinition_constraintDECOR_xsd_Complex_Type_ChoiceDefinition.tmp#ChoiceDefinition
Type ChoiceDefinition
Properties
content complex
minOccurs 1
maxOccurs unbounded
Model
Children constraint, desc, element, include, item
Instance
 
<choice maximumMultiplicity="" minimumMultiplicity="">
  <desc language="" lastTranslated="" mimeType="">{0,unbounded}</desc>
  <item label="">{0,1}</item>
  <include conformance="" flexibility="" isMandatory="" maximumMultiplicity="" minimumMultiplicity="" ref="">{0,unbounded}</include>
  <element conformance="" contains="" datatype="" displayName="" effectiveDate="" expirationDate="" flexibility="" id="" isClosed="false" isMandatory="" lastModifiedDate="" maximumMultiplicity="" minimumMultiplicity="" name="" officialReleaseDate="" statusCode="" strength="required" useWhere="false" versionLabel="">{0,unbounded}</element>
  <constraint language="" lastTranslated="" mimeType="">{0,unbounded}</constraint>
</choice>
Attributes
QName Type Use Annotation
maximumMultiplicity UnlimitedInteger optional 
Identifies the maximum number of repetitions of this element that may occur within the containing element.
 
UML: multiplicity (upper-bound)
minimumMultiplicity SmallNonNegativeInteger optional 
Identifies the minimum number of repetitions of this element that may occur within the containing element.
 
UML: multiplicity (lower-bound)
Source
 
<xs:element name="choice" type="ChoiceDefinition" minOccurs="1" maxOccurs="unbounded"/>
Element TemplateDefinition / element
Namespace No namespace
Diagram
DiagramDECOR_xsd_Attribute_displayName.tmp#displayNameDECOR_xsd_Attribute_Group_VersionHandlingEffectiveDateOptional.tmp#VersionHandlingEffectiveDateOptionalDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_statusCodeDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_nameDECOR_xsd_Complex_Type_RuleDefinition.tmp#NO_NAMESPACE_RuleDefinition_includeDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_useWhereDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_containsDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_flexibilityDECOR-datatypes_xsd_Attribute_Group_MultiplicityRangeOptional.tmp#MultiplicityRangeOptionalDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_conformanceDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_isMandatoryDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_idDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_datatypeDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_isClosedDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_strengthDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_descDECOR_xsd_Element_item.tmp#itemDECOR_xsd_Element_example.tmp#exampleDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_inheritDECOR_xsd_Element_vocabulary.tmp#vocabularyDECOR_xsd_Element_property.tmp#propertyDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_textDECOR_xsd_Element_attribute.tmp#attributeDECOR_xsd_Element_let.tmp#letDECOR_xsd_Element_assert.tmp#assertDECOR_xsd_Element_report.tmp#reportDECOR_xsd_Element_defineVariable.tmp#defineVariableDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_elementDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_includeDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_choiceDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition_constraintDECOR_xsd_Complex_Type_RuleDefinition.tmp#RuleDefinition
Type RuleDefinition
Properties
content complex
minOccurs 1
maxOccurs unbounded
Model
Children assert, attribute, choice, constraint, defineVariable, desc, element, example, include, inherit, item, let, property, report, text, vocabulary
Instance
 
<element conformance="" contains="" datatype="" displayName="" effectiveDate="" expirationDate="" flexibility="" id="" isClosed="false" isMandatory="" lastModifiedDate="" maximumMultiplicity="" minimumMultiplicity="" name="" officialReleaseDate="" statusCode="" strength="required" useWhere="false" versionLabel="">
  <desc language="" lastTranslated="" mimeType="">{0,unbounded}</desc>
  <item label="">{0,1}</item>
  <example caption="" type="neutral">{0,unbounded}</example>
  <inherit datasetEffectiveDate="" datasetExpirationDate="" datasetId="" datasetStatusCode="" datasetVersionLabel="" effectiveDate="" iEffectiveDate="" iExpirationDate="" iStatusCode="" iType="" iVersionLabel="" localInherit="" originalEffectiveDate="" originalExpirationDate="" originalId="" originalPrefix="" originalStatusCode="" originalVersionLabel="" prefix="" ref="" refdisplay="">{0,0}</inherit>
  <vocabulary code="" codeSystem="" codeSystemName="" displayName="" domain="" flexibility="" valueSet="">{0,unbounded}</vocabulary>
  <property currency="" fractionDigits="" maxInclude="" maxLength="" minInclude="" minLength="" unit="" value="">{0,unbounded}</property>
  <text>{0,unbounded}</text>
  <attribute classCode="" contextConductionInd="" contextControlCode="" datatype="" determinerCode="" extension="" id="" independentInd="" institutionSpecified="" inversionInd="" isOptional="" mediaType="" moodCode="" name="" negationInd="" nullFlavor="" operator="" prohibited="" qualifier="" representation="" root="" typeCode="" unit="" use="" value="">{0,unbounded}</attribute>
  <let name="" value="">{0,unbounded}</let>
  <assert flag="" role="" see="" test="">{0,unbounded}</assert>
  <report flag="" role="" see="" test="">{0,unbounded}</report>
  <defineVariable name="" path="">{0,unbounded}</defineVariable>
  <element conformance="" contains="" datatype="" displayName="" effectiveDate="" expirationDate="" flexibility="" id="" isClosed="false" isMandatory="" lastModifiedDate="" maximumMultiplicity="" minimumMultiplicity="" name="" officialReleaseDate="" statusCode="" strength="required" useWhere="false" versionLabel="">{0,unbounded}</element>
  <include conformance="" flexibility="" isMandatory="" maximumMultiplicity="" minimumMultiplicity="" ref="">{0,unbounded}</include>
  <choice maximumMultiplicity="" minimumMultiplicity="">{0,unbounded}</choice>
  <constraint language="" lastTranslated="" mimeType="">{0,unbounded}</constraint>
</element>
Attributes
QName Type Default Use Annotation
conformance ConformanceType optional
contains BasicIdOrOid optional 
Reference to a template/@id or @name. References to @name are discouraged because they become ambiguous quickly.
datatype xs:QName optional
displayName NonEmptyString optional 
A short description string for the designation
effectiveDate TimeStampNoTimezone optional 
Identifies the effective date of the version of the object.
expirationDate TimeStampNoTimezone optional 
Identifies the expiration date of the version of the object.
flexibility StaticOrDynamicFlexibility optional 
Reference to a template/@effectiveDate. Default is unspecified which means 'latest available version'.
id Oid optional
isClosed xs:boolean false optional 
Whether the template is open (other elements than specified allowed) or closed (no other elements than specified allowed)
isMandatory xs:boolean optional 
Default is unspecified which in practice means 'false'.
lastModifiedDate TimeStampNoTimezone optional 
Identifies last point in time that the object was changed.
maximumMultiplicity UnlimitedInteger optional 
Identifies the maximum number of repetitions of this element that may occur within the containing element.
 
UML: multiplicity (upper-bound)
minimumMultiplicity SmallNonNegativeInteger optional 
Identifies the minimum number of repetitions of this element that may occur within the containing element.
 
UML: multiplicity (lower-bound)
name xs:anyURI optional
officialReleaseDate TimeStampNoTimezone optional 
Identifies the official release date of the version of the object.
statusCode ItemStatusCodeLifeCycle optional
strength CodingStrengthType required optional
useWhere xs:boolean false optional
versionLabel ShortDescriptiveName optional 
A human readable version number or version label for convenient human rendition; not used by an application.
Source
 
<xs:element name="element" type="RuleDefinition" minOccurs="1" maxOccurs="unbounded"/>
Element TemplateDefinition / include
Namespace No namespace
Diagram
DiagramDECOR_xsd_Complex_Type_IncludeDefinition.tmp#IncludeDefinition_refDECOR_xsd_Complex_Type_IncludeDefinition.tmp#IncludeDefinition_flexibilityDECOR_xsd_Complex_Type_IncludeDefinition.tmp#IncludeDefinition_scenarioDECOR_xsd_Complex_Type_IncludeDefinition.tmp#IncludeDefinition_effectiveDateDECOR-datatypes_xsd_Attribute_Group_MultiplicityRangeOptional.tmp#MultiplicityRangeOptionalDECOR_xsd_Complex_Type_IncludeDefinition.tmp#IncludeDefinition_conformanceDECOR_xsd_Complex_Type_IncludeDefinition.tmp#IncludeDefinition_isMandatoryDECOR_xsd_Complex_Type_IncludeDefinition.tmp#IncludeDefinition_descDECOR_xsd_Element_item.tmp#itemDECOR_xsd_Element_example.tmp#exampleDECOR_xsd_Complex_Type_IncludeDefinition.tmp#IncludeDefinition_constraintDECOR_xsd_Complex_Type_IncludeDefinition.tmp#IncludeDefinition
Type IncludeDefinition
Properties
content complex
minOccurs 1
maxOccurs unbounded
Model
Children constraint, desc, example, item
Instance
 
<include conformance="" flexibility="" isMandatory="" maximumMultiplicity="" minimumMultiplicity="" ref="">
  <desc language="" lastTranslated="" mimeType="">{0,unbounded}</desc>
  <item label="">{0,1}</item>
  <example caption="" type="neutral">{0,unbounded}</example>
  <constraint language="" lastTranslated="" mimeType="">{0,unbounded}</constraint>
</include>
Attributes
QName Type Use Annotation
conformance ConformanceType optional
flexibility StaticOrDynamicFlexibility optional 
Reference to a template/@effectiveDate. Default is unspecified which means 'latest available version'.
isMandatory xs:boolean optional 
Default is unspecified which in practice means 'false'.
maximumMultiplicity UnlimitedInteger optional 
Identifies the maximum number of repetitions of this element that may occur within the containing element.
 
UML: multiplicity (upper-bound)
minimumMultiplicity SmallNonNegativeInteger optional 
Identifies the minimum number of repetitions of this element that may occur within the containing element.
 
UML: multiplicity (lower-bound)
ref BasicIdOrOid required 
Reference to a template/@id or @name. References to @name are discouraged because they become ambiguous quickly.
Source
 
<xs:element name="include" type="IncludeDefinition" minOccurs="1" maxOccurs="unbounded"/>
Element TemplateDefinition / constraint
Namespace No namespace
Diagram
DiagramDECOR-datatypes_xsd_Complex_Type_VariousMixedContent.tmp#VariousMixedContentDECOR-datatypes_xsd_Complex_Type_FreeFormMarkupWithLanguage.tmp#FreeFormMarkupWithLanguage_languageDECOR-datatypes_xsd_Complex_Type_FreeFormMarkupWithLanguage.tmp#FreeFormMarkupWithLanguage_lastTranslatedDECOR-datatypes_xsd_Complex_Type_FreeFormMarkupWithLanguage.tmp#FreeFormMarkupWithLanguage_mimeTypeDECOR-datatypes_xsd_Complex_Type_FreeFormMarkupWithLanguage.tmp#FreeFormMarkupWithLanguage
Type FreeFormMarkupWithLanguage
Type hierarchy
Properties
content complex
minOccurs 0
maxOccurs unbounded
mixed true
Model
ANY element from ANY namespace
Attributes
QName Type Use Annotation
language LanguageCode optional 
Indicates the language in which the marked up text is expressed
 
UML: part of a complex stereotype tag
lastTranslated TimeStampNoTimezone optional 
Indicates when this languages rendition was last translated from the original.
 
UML: part of a complex stereotype tag
mimeType MimeType optional 
Indicates the mime type in which the data is expressed. If not specified, applications SHALL interpret the content based on other context or
specific application rules. Applications that do not recognize content SHALL retain it unchanged.
 
UML: Part of a complex tag
Source
 
<xs:element name="constraint" minOccurs="0" maxOccurs="unbounded" type="FreeFormMarkupWithLanguage"/>
Complex Type TemplateDefinition
Namespace No namespace
Diagram
DiagramDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_idDECOR_xsd_Attribute_canonicalUri.tmp#canonicalUriDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_refDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_nameDECOR_xsd_Attribute_Group_VersionHandlingEffectiveDateOptional.tmp#VersionHandlingEffectiveDateOptionalDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_statusCodeDECOR_xsd_Attribute_displayName.tmp#displayNameDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_isClosedDECOR_xsd_Attribute_Group_TemplateCompilationAttributes.tmp#TemplateCompilationAttributesDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_descDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_classificationDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_relationshipDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_publishingAuthorityDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_endorsingAuthorityDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_purposeDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_copyrightDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_revisionHistoryDECOR_xsd_Element_context.tmp#contextDECOR_xsd_Element_item.tmp#itemDECOR_xsd_Element_example.tmp#exampleDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_inheritDECOR_xsd_Element_attribute.tmp#attributeDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_choiceDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_elementDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_includeDECOR_xsd_Element_let.tmp#letDECOR_xsd_Element_assert.tmp#assertDECOR_xsd_Element_report.tmp#reportDECOR_xsd_Element_defineVariable.tmp#defineVariableDECOR_xsd_Complex_Type_TemplateDefinition.tmp#TemplateDefinition_constraint
Used by
Element rules/template
Model
Children assert, attribute, choice, classification, constraint, context, copyright, defineVariable, desc, element, endorsingAuthority, example, include, inherit, item, let, publishingAuthority, purpose, relationship, report, revisionHistory
Attributes
QName Type Default Use Annotation
canonicalUri xs:anyURI optional 
HL7® FHIR® canonical URI. Logical URI to reference this StructureDefinition, logical model, value set, etc. (globally unique)
 
HL7® FHIR® canonical URI. Logical URI to reference this StructureDefinition, logical model, value set, etc. (globally unique)
 
HL7® FHIR® kanonieke URI. Logische URI om te verwijzen naar deze StructureDefinition, dit logisch model, waardelijst, etc. (wereldwijd uniek)
displayName NonEmptyString optional 
A short description string for the designation
effectiveDate TimeStampNoTimezone optional 
Identifies the effective date of the version of the object.
expirationDate TimeStampNoTimezone optional 
Identifies the expiration date of the version of the object.
id Oid optional 
The identifying OID of the template
ident ShortDescriptiveName optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the project @prefix of the project that defines the dataset, template, or value set
isClosed xs:boolean false optional 
Whether the template is open (other elements than specified allowed) or closed (no other elements than specified allowed)
lastModifiedDate TimeStampNoTimezone optional 
Identifies last point in time that the object was changed.
name ShortFormalName required 
The mnemonic name of the template
officialReleaseDate TimeStampNoTimezone optional 
Identifies the official release date of the version of the object.
ref Oid optional 
Reference to a template/@id. Templates SHALL carry either @id or @ref
referencedFrom ShortDescriptiveName optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the project @prefix of the project that referenced the dataset, template, or value set (normally current project)
statusCode TemplateStatusCodeLifeCycle optional
url xs:anyURI optional 
Added in compilation process for releases. DO NOT ADD/EDIT yourself. Contains the services URL useful in retrieving the dataset, template, or value set
versionLabel ShortDescriptiveName optional 
A human readable version number or version label for convenient human rendition; not used by an application.
Wildcard: ANY attribute from ANY namespace OTHER than 'No Namespace'
Source
 
<xs:complexType name="TemplateDefinition">
  <xs:sequence>
    <!-- description(s) of template -->
    <xs:element name="desc" minOccurs="0" maxOccurs="unbounded" type="FreeFormMarkupWithLanguage"/>
    <!-- the type(s) etc of the template, for later use -->
    <xs:element name="classification" type="TemplateProperties" minOccurs="0" maxOccurs="unbounded"/>
    <!-- relationships of this template -->
    <xs:element name="relationship" type="TemplateRelationships" minOccurs="0" maxOccurs="unbounded"/>
    <!-- context of template
                either
                <context id="*"/> for an element templateId context
                or <context path="//"/> for a specific context path
            -->
    <!-- 
                there may be one publishing and one or more endorsing authorities
                not used by DECOR yet
            -->
    <xs:element name="publishingAuthority" type="AuthorityType" minOccurs="0" maxOccurs="1">
      <xs:annotation>
        <xs:documentation xml:lang="en-US">The authoritative body who has reviewed the Template for (clinical) accuracy and relevance, and authorized it for publication. Registries may require this element to be valued</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="endorsingAuthority" type="AuthorityType" minOccurs="0" maxOccurs="0">
      <xs:annotation>
        <xs:documentation xml:lang="en-US">A list of bodies who have reviewed the Template for (clinical) accuracy and relevance, and endorsed it for use</xs:documentation>
      </xs:annotation>
    </xs:element>
    <!-- FHIR compatibility -->
    <xs:element name="purpose" minOccurs="0" maxOccurs="unbounded" type="FreeFormMarkupWithLanguage">
      <xs:annotation>
        <xs:documentation xml:lang="en-US">A statement about the purpose of the template</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="copyright" minOccurs="0" maxOccurs="unbounded" type="CopyrightText">
      <xs:annotation>
        <xs:documentation xml:lang="en-US">A copyright statement relating to the template and/or its contents.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <!-- 
                there may be 0..* template revision history discriptions
                not used by DECOR yet
            -->
    <xs:element name="revisionHistory" type="ObjectHistory" minOccurs="0" maxOccurs="0">
      <xs:annotation>
        <xs:documentation xml:lang="en-US">The free text description describing the changes in this version of the Template as compared to the previous version. Since Template versions are built off of previous versions, the net effect of this field is to function as a comprehensive historical reference of the Template.</xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element ref="context" minOccurs="0" maxOccurs="1"/>
    <!-- item reference and description(s), inherited by all subsequent elements unless overridden -->
    <xs:element ref="item" minOccurs="0" maxOccurs="1"/>
    <!-- examples may be given -->
    <xs:element ref="example" minOccurs="0" maxOccurs="unbounded"/>
    <!-- 
                there maybe 0..n inherit definitions before others in a template (indicating parent / sibling templates)
                not used by DECOR yet
            -->
    <xs:element name="inherit" type="InheritDefinition" minOccurs="0" maxOccurs="0"/>
    <!-- 
                the design body: elements, attributes, choices or includes
            -->
    <xs:choice maxOccurs="unbounded">
      <xs:element ref="attribute" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="choice" type="ChoiceDefinition" minOccurs="1" maxOccurs="unbounded"/>
      <xs:element name="element" type="RuleDefinition" minOccurs="1" maxOccurs="unbounded"/>
      <xs:element name="include" type="IncludeDefinition" minOccurs="1" maxOccurs="unbounded"/>
      <xs:element ref="let" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="assert" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="report" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element ref="defineVariable" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="constraint" minOccurs="0" maxOccurs="unbounded" type="FreeFormMarkupWithLanguage"/>
    </xs:choice>
  </xs:sequence>
  <!-- attributes of element (validation done by embedded schematron) -->
  <xs:attribute name="id" type="Oid" use="optional">
    <xs:annotation>
      <xs:documentation xml:lang="en-US">The identifying OID of the template</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute ref="canonicalUri" use="optional"/>
  <xs:attribute name="ref" type="Oid" use="optional">
    <xs:annotation>
      <xs:documentation xml:lang="en-US">Reference to a template/@id. Templates SHALL carry either @id or @ref</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <xs:attribute name="name" type="ShortFormalName" use="required">
    <xs:annotation>
      <xs:documentation xml:lang="en-US">The mnemonic name of the template</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <!-- attributes of template (validation done by embedded schematron) -->
  <xs:attributeGroup ref="VersionHandlingEffectiveDateOptional"/>
  <xs:attribute name="statusCode" type="TemplateStatusCodeLifeCycle" use="optional"/>
  <xs:attribute ref="displayName" use="optional"/>
  <xs:attribute name="isClosed" type="xs:boolean" use="optional" default="false">
    <xs:annotation>
      <xs:documentation xml:lang="en-US">Whether the template is open (other elements than specified allowed) or closed (no other elements than specified allowed)</xs:documentation>
    </xs:annotation>
  </xs:attribute>
  <!-- Only relevant after compilation -->
  <xs:attributeGroup ref="TemplateCompilationAttributes"/>
</xs:complexType>
Attribute TemplateDefinition / @id
Namespace No namespace
Annotations
 
The identifying OID of the template
Type Oid
Properties
use optional
Facets
maxLength 255
pattern [0-2](\.(0|[1-9][0-9]*))*
Used by
Complex Type TemplateDefinition
Source
 
<xs:attribute name="id" type="Oid" use="optional">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">The identifying OID of the template</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute TemplateDefinition / @ref
Namespace No namespace
Annotations
 
Reference to a template/@id. Templates SHALL carry either @id or @ref
Type Oid
Properties
use optional
Facets
maxLength 255
pattern [0-2](\.(0|[1-9][0-9]*))*
Used by
Complex Type TemplateDefinition
Source
 
<xs:attribute name="ref" type="Oid" use="optional">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">Reference to a template/@id. Templates SHALL carry either @id or @ref</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute TemplateDefinition / @name
Namespace No namespace
Annotations
 
The mnemonic name of the template
Type ShortFormalName
Properties
use required
Facets
maxLength 80
pattern (\c+) & ([A-Za-z]+([A-Za-z0-9,.,\-,_])*)
Used by
Complex Type TemplateDefinition
Source
 
<xs:attribute name="name" type="ShortFormalName" use="required">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">The mnemonic name of the template</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute TemplateDefinition / @statusCode
Namespace No namespace
Type TemplateStatusCodeLifeCycle
Type hierarchy
Properties
use optional
Facets
maxLength 50
enumeration draft 
Template under development (nascent). Metadata and template may be incomplete. Entered primarily to encourage other users to be aware of ongoing
process.
enumeration active 
Template has been published by the governance group (custodian organization) and deemed fit for use. May have associated adoption and annotation metadata.
enumeration retired 
Template retired: No longer fit for use. Information available for historical reference.
enumeration rejected 
Template is rejected. During the development proces of a template design (new, draft) it was decided that
further development on this template will not happen.
enumeration cancelled 
Template was never published and is withdrawn.
enumeration 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 governance group (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.
enumeration 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 (new version date but 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 (version), which is linked to the retired template.
Used by
Complex Type TemplateDefinition
Source
 
<xs:attribute name="statusCode" type="TemplateStatusCodeLifeCycle" use="optional"/>
Attribute TemplateDefinition / @isClosed
Namespace No namespace
Annotations
 
Whether the template is open (other elements than specified allowed) or closed (no other elements than specified allowed)
Type xs:boolean
Properties
use optional
default false
Used by
Complex Type TemplateDefinition
Source
 
<xs:attribute name="isClosed" type="xs:boolean" use="optional" default="false">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">Whether the template is open (other elements than specified allowed) or closed (no other elements than specified allowed)</xs:documentation>
  </xs:annotation>
</xs:attribute>
XML Schema documentation generated by ® XML Editor.