Showing:

Annotations
Attributes
Diagrams
Facets
Instances
Model
Properties
Source
Used by
Element valueSet
Namespace No namespace
Annotations
 
Value Set. A DECOR valueSet can take different forms. It may be a simple value set reference (@ref) to a value set from a repository without any contents, id, effectiveDate or statusCode, but with a name and a displayName. The other option is a valueSet with contents, id, effectiveDate, statusCode, name and displayName.
Diagram
DiagramDECOR_xsd_Element_valueSet.tmp#valueSet_idDECOR_xsd_Attribute_canonicalUri.tmp#canonicalUriDECOR_xsd_Element_valueSet.tmp#valueSet_refDECOR_xsd_Element_valueSet.tmp#valueSet_nameDECOR_xsd_Attribute_displayName.tmp#displayNameDECOR_xsd_Attribute_Group_VersionHandlingEffectiveDateOptional.tmp#VersionHandlingEffectiveDateOptionalDECOR_xsd_Element_valueSet.tmp#valueSet_statusCodeDECOR_xsd_Attribute_experimental.tmp#experimentalDECOR_xsd_Element_valueSet.tmp#valueSet_flexibilityDECOR_xsd_Attribute_Group_ValueSetCompilationAttributes.tmp#ValueSetCompilationAttributesDECOR_xsd_Element_valueSet.tmp#valueSet_descDECOR_xsd_Element_Group_ValueSetCompilationSourceCodeSystem.tmp#ValueSetCompilationSourceCodeSystem_sourceCodeSystemDECOR_xsd_Element_Group_ValueSetCompilationSourceCodeSystem.tmp#ValueSetCompilationSourceCodeSystemDECOR_xsd_Element_valueSet.tmp#valueSet_publishingAuthorityDECOR_xsd_Element_valueSet.tmp#valueSet_endorsingAuthorityDECOR_xsd_Element_valueSet.tmp#valueSet_purposeDECOR_xsd_Element_valueSet.tmp#valueSet_copyrightDECOR_xsd_Element_valueSet.tmp#valueSet_revisionHistoryDECOR_xsd_Element_valueSet.tmp#valueSet_completeCodeSystemDECOR_xsd_Element_valueSet.tmp#valueSet_conceptList
Properties
content complex
Used by
Element terminology
Model
Children completeCodeSystem, conceptList, copyright, desc, endorsingAuthority, publishingAuthority, purpose, revisionHistory, sourceCodeSystem
Instance
 
<valueSet canonicalUri="" displayName="" effectiveDate="" experimental="" expirationDate="" flexibility="" id="" ident="" lastModifiedDate="" name="" officialReleaseDate="" ref="" referencedFrom="" statusCode="" url="" versionLabel="">
  <desc language="" lastTranslated="" mimeType="">{0,unbounded}</desc>
  <sourceCodeSystem>{0,unbounded}</sourceCodeSystem>
  <publishingAuthority id="" inherited="" name="">{0,1}</publishingAuthority>
  <endorsingAuthority id="" inherited="" name="">{0,0}</endorsingAuthority>
  <purpose language="" lastTranslated="" mimeType="">{0,unbounded}</purpose>
  <copyright inherited="" language="" lastTranslated="" mimeType="">{0,unbounded}</copyright>
  <revisionHistory by="" date="">{0,0}</revisionHistory>
  <completeCodeSystem codeSystem="" codeSystemName="" codeSystemVersion="" flexibility="" type="D">{0,unbounded}</completeCodeSystem>
  <conceptList>{0,1}</conceptList>
</valueSet>
Attributes
QName Type 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 required 
A short description string for the designation
effectiveDate TimeStampNoTimezone optional 
Identifies the effective date of the version of the object.
experimental xs:boolean optional 
DECOR project, codeSystem, valueSet or other artifact is for testing purposes, not real usage
expirationDate TimeStampNoTimezone optional 
Identifies the expiration date of the version of the object.
flexibility StaticOrDynamicFlexibility optional 
Reference to a valueSet/@effectiveDate. Default is unspecified which means 'latest available version'.
id Oid optional 
Defines the globally unique identifier for this value set and may be used to reference it. Value sets SHOULD carry either @id or @ref
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
lastModifiedDate TimeStampNoTimezone optional 
Identifies last point in time that the object was changed.
name BasicId required
officialReleaseDate TimeStampNoTimezone optional 
Identifies the official release date of the version of the object.
ref Oid optional 
Reference to a valueSet/@id. Value sets 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 ItemStatusCodeLifeCycle 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.
Source
 
<xs:element name="valueSet">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">Value Set. A DECOR valueSet can take different forms. It may be a simple value set reference (@ref) to a value set from a repository without any contents, id, effectiveDate or statusCode, but with a name and a displayName. The other option is a valueSet with contents, id, effectiveDate, statusCode, name and displayName.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element name="desc" minOccurs="0" maxOccurs="unbounded" type="FreeFormMarkupWithLanguage"/>
      <!-- Only relevant after compilation -->
      <xs:group ref="ValueSetCompilationSourceCodeSystem"/>
      <!-- there may be one publishing and one or more endorsing authorities. not used by DECOR yet, but is populated by the ValueSet API upon retrieval based on the first project/copyright -->
      <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 Value set 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 Value set for (clinical) accuracy and relevance, and endorsed it for use</xs:documentation>
        </xs:annotation>
      </xs:element>
      <!-- FHIR Value Set DSTUr1 0.8 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 value set</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..* value set 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 Value set as compared to the previous version. Since Value set versions are built off of previous versions, the net effect of this field is to function as a comprehensive historical reference of the Value set.</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="completeCodeSystem" type="CodeSystemReference" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="conceptList" type="ValueSetConceptList" minOccurs="0" maxOccurs="1"/>
    </xs:sequence>
    <xs:attribute name="id" type="Oid" use="optional">
      <xs:annotation>
        <xs:documentation xml:lang="en-US">Defines the globally unique identifier for this value set and may be used to reference it. Value sets SHOULD carry either @id or @ref</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute ref="canonicalUri" use="optional">
      <xs:annotation>
        <xs:documentation xml:lang="en-US">Defines the canonical uir for this value set and may be used to reference it.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="ref" type="Oid" use="optional">
      <xs:annotation>
        <xs:documentation xml:lang="en-US">Reference to a valueSet/@id. Value sets SHALL carry either @id or @ref</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="name" use="required" type="BasicId"/>
    <xs:attribute ref="displayName" use="required"/>
    <xs:attributeGroup ref="VersionHandlingEffectiveDateOptional"/>
    <xs:attribute name="statusCode" type="ItemStatusCodeLifeCycle" use="optional"/>
    <xs:attribute ref="experimental" use="optional"/>
    <!-- if @ref, flexibility -->
    <xs:attribute name="flexibility" type="StaticOrDynamicFlexibility" use="optional">
      <xs:annotation>
        <xs:documentation xml:lang="en-US">Reference to a valueSet/@effectiveDate. Default is unspecified which means 'latest available version'.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <!-- Only relevant after compilation -->
    <xs:attributeGroup ref="ValueSetCompilationAttributes"/>
  </xs:complexType>
</xs:element>
Element valueSet / 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 valueSet / publishingAuthority
Namespace No namespace
Annotations
 
The authoritative body who has reviewed the Value set 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 Value set 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 valueSet / endorsingAuthority
Namespace No namespace
Annotations
 
A list of bodies who have reviewed the Value set 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 Value set for (clinical) accuracy and relevance, and endorsed it for use</xs:documentation>
  </xs:annotation>
</xs:element>
Element valueSet / purpose
Namespace No namespace
Annotations
 
A statement about the purpose of the value set
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 value set</xs:documentation>
  </xs:annotation>
</xs:element>
Element valueSet / copyright
Namespace No namespace
Annotations
Diagram
Type CopyrightText
Type hierarchy
Properties
Model
Attributes
Source
Element valueSet / revisionHistory
Namespace No namespace
Annotations
 
The free text description describing the changes in this version of the Value set
as compared to the previous version. Since Value set versions are built off of previous versions, the net effect 
of this field is to function as a comprehensive historical reference of the Value set.
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 Value set as compared to the previous version. Since Value set versions are built off of previous versions, the net effect of this field is to function as a comprehensive historical reference of the Value set.</xs:documentation>
  </xs:annotation>
</xs:element>
Element valueSet / completeCodeSystem
Namespace No namespace
Diagram
DiagramDECOR_xsd_Complex_Type_CodeSystemReference.tmp#CodeSystemReference_codeSystemDECOR_xsd_Complex_Type_CodeSystemReference.tmp#CodeSystemReference_codeSystemNameDECOR_xsd_Complex_Type_CodeSystemReference.tmp#CodeSystemReference_codeSystemVersionDECOR_xsd_Complex_Type_CodeSystemReference.tmp#CodeSystemReference_flexibilityDECOR_xsd_Complex_Type_CodeSystemReference.tmp#CodeSystemReference_typeDECOR_xsd_Complex_Type_CodeSystemReference.tmp#CodeSystemReference_filterDECOR_xsd_Complex_Type_CodeSystemReference.tmp#CodeSystemReference
Type CodeSystemReference
Properties
content complex
minOccurs 0
maxOccurs unbounded
Model
Children filter
Instance
 
<completeCodeSystem codeSystem="" codeSystemName="" codeSystemVersion="" flexibility="" type="D">
  <filter op="" property="" value="">{0,unbounded}</filter>
</completeCodeSystem>
Attributes
QName Type Fixed Use Annotation
codeSystem Oid required
codeSystemName NonEmptyString optional 
Display name for the code system as it is known in your context. This may or may not be the official name for the code system.
codeSystemVersion NonEmptyString optional 
Version string for the code system. This is only relevant for code systems with incompatible versions. If specified, than your instances will need to carry this information exactly as-is.
flexibility StaticOrDynamicFlexibility optional 
Reference to a codeSystem/@codeSystemVersion. Default is unspecified which means 'latest available version'.
type D optional 
Signals deprecation of the codeSystem in the context of this value set definition. This does not imply any status change in the code system itself.
Source
 
<xs:element name="completeCodeSystem" type="CodeSystemReference" minOccurs="0" maxOccurs="unbounded"/>
Element valueSet / conceptList
Namespace No namespace
Diagram
DiagramDECOR_xsd_Complex_Type_ValueSetConceptList.tmp#ValueSetConceptList_conceptDECOR_xsd_Complex_Type_ValueSetConceptList.tmp#ValueSetConceptList_includeDECOR_xsd_Complex_Type_ValueSetConceptList.tmp#ValueSetConceptList_excludeDECOR_xsd_Complex_Type_ValueSetConceptList.tmp#ValueSetConceptList_exceptionDECOR_xsd_Complex_Type_ValueSetConceptList.tmp#ValueSetConceptList
Type ValueSetConceptList
Properties
content complex
minOccurs 0
maxOccurs 1
Model
Children concept, exception, exclude, include
Instance
 
<conceptList>
  <concept code="" codeSystem="" codeSystemName="" codeSystemVersion="" displayName="" level="" ordinal="" type="">{1,1}</concept>
  <include code="" codeSystem="" codeSystemName="" codeSystemVersion="" displayName="" exception="false" flexibility="" ident="" op="" ref="" referencedFrom="" url="">{1,1}</include>
  <exclude code="" codeSystem="" codeSystemName="" codeSystemVersion="" displayName="" exception="false" flexibility="" ident="" op="" ref="" referencedFrom="" url="">{1,1}</exclude>
  <exception code="" codeSystem="" codeSystemName="" codeSystemVersion="" displayName="" level="" ordinal="" type="">{0,unbounded}</exception>
</conceptList>
Source
 
<xs:element name="conceptList" type="ValueSetConceptList" minOccurs="0" maxOccurs="1"/>
Attribute valueSet / @id
Namespace No namespace
Annotations
 
Defines the globally unique identifier for this value set and may be used to reference it. Value sets SHOULD carry either @id or @ref
Type Oid
Properties
use optional
Facets
maxLength 255
pattern [0-2](\.(0|[1-9][0-9]*))*
Used by
Element valueSet
Source
 
<xs:attribute name="id" type="Oid" use="optional">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">Defines the globally unique identifier for this value set and may be used to reference it. Value sets SHOULD carry either @id or @ref</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute valueSet / @ref
Namespace No namespace
Annotations
 
Reference to a valueSet/@id. Value sets SHALL carry either @id or @ref
Type Oid
Properties
use optional
Facets
maxLength 255
pattern [0-2](\.(0|[1-9][0-9]*))*
Used by
Element valueSet
Source
 
<xs:attribute name="ref" type="Oid" use="optional">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">Reference to a valueSet/@id. Value sets SHALL carry either @id or @ref</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute valueSet / @name
Namespace No namespace
Type BasicId
Properties
use required
Facets
minLength 1
maxLength 80
Used by
Element valueSet
Source
 
<xs:attribute name="name" use="required" type="BasicId"/>
Attribute valueSet / @statusCode
Namespace No namespace
Type ItemStatusCodeLifeCycle
Type hierarchy
Properties
use optional
Facets
maxLength 50
enumeration new 
Item just created and is new and work in progress to become a draft/finalized item/issue. Beyond the author, nobody should look at this
item/issue unless it's status code is draft or finalized.
enumeration draft 
Item is draft
enumeration pending 
Item is in pre-publication review: the item is complete, pending appropriate review.
enumeration final 
Item finalized, ready for approval
enumeration rejected 
Item is rejected
enumeration cancelled 
Item is cancelled
enumeration deprecated 
Item is deprecated, i.e. item should be avoided to be used, typically because it will be or has been superseded
Used by
Element valueSet
Source
 
<xs:attribute name="statusCode" type="ItemStatusCodeLifeCycle" use="optional"/>
Attribute valueSet / @flexibility
Namespace No namespace
Annotations
 
Reference to a valueSet/@effectiveDate. Default is unspecified which means 'latest available version'.
Type StaticOrDynamicFlexibility
Properties
use optional
Used by
Element valueSet
Source
 
<xs:attribute name="flexibility" type="StaticOrDynamicFlexibility" use="optional">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">Reference to a valueSet/@effectiveDate. Default is unspecified which means 'latest available version'.</xs:documentation>
  </xs:annotation>
</xs:attribute>
XML Schema documentation generated by ® XML Editor.