Showing:

Annotations
Attributes
Diagrams
Facets
Identity Constraints
Instances
Model
Properties
Source
Used by
Element codeSystem
Namespace No namespace
Annotations
 
Code System
Diagram
DiagramDECOR_xsd_Element_codeSystem.tmp#codeSystem_idDECOR_xsd_Attribute_canonicalUri.tmp#canonicalUriDECOR_xsd_Element_codeSystem.tmp#codeSystem_refDECOR_xsd_Element_codeSystem.tmp#codeSystem_nameDECOR_xsd_Attribute_displayName.tmp#displayNameDECOR_xsd_Attribute_Group_VersionHandlingEffectiveDateOptional.tmp#VersionHandlingEffectiveDateOptionalDECOR_xsd_Element_codeSystem.tmp#codeSystem_statusCodeDECOR_xsd_Attribute_experimental.tmp#experimentalDECOR_xsd_Element_codeSystem.tmp#codeSystem_caseSensitiveDECOR_xsd_Element_codeSystem.tmp#codeSystem_flexibilityDECOR_xsd_Attribute_Group_CodeSystemCompilationAttributes.tmp#CodeSystemCompilationAttributesDECOR_xsd_Element_codeSystem.tmp#codeSystem_descDECOR_xsd_Element_codeSystem.tmp#codeSystem_publishingAuthorityDECOR_xsd_Element_codeSystem.tmp#codeSystem_endorsingAuthorityDECOR_xsd_Element_codeSystem.tmp#codeSystem_purposeDECOR_xsd_Element_codeSystem.tmp#codeSystem_copyrightDECOR_xsd_Element_codeSystem.tmp#codeSystem_revisionHistoryDECOR_xsd_Element_codeSystem.tmp#codeSystem_propertyDECOR_xsd_Element_codeSystem.tmp#codeSystem_conceptList
Properties
content complex
Used by
Element terminology
Model
desc* , publishingAuthority{0,1} , endorsingAuthority{0,0} , purpose* , copyright* , revisionHistory{0,0} , property* , (conceptList{0,1} | ANY element from namespace(s) 'http://hl7.org/fhir')
Children conceptList, copyright, desc, endorsingAuthority, property, publishingAuthority, purpose, revisionHistory
Instance
 
<codeSystem canonicalUri="" caseSensitive="true" displayName="" effectiveDate="" experimental="" expirationDate="" flexibility="" id="" ident="" lastModifiedDate="" name="" officialReleaseDate="" ref="" referencedFrom="" statusCode="" url="" versionLabel="">
  <desc language="" lastTranslated="" mimeType="">{0,unbounded}</desc>
  <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>
  <property code="" description="" type="" uri="">{0,unbounded}</property>
  <conceptList>{0,1}</conceptList>
</codeSystem>
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)
caseSensitive xs:boolean true optional 
If code comparison is case sensitive when codes within this system are compared to each other. If this value is missing, then it is not specified whether a code system is case sensitive or not.
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 codeSystem/@codeSystem. Default is unspecified which means 'latest available version'.
id Oid optional 
A version identifier that uniquely identifies each version of a Code System
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 
A reference to a version identifier of a Code System
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.
Identity constraints
QName Type Refer Selector Field(s)
desc-language-unique unique desc @language
purpose-language-unique unique purpose @language
copyright-language-unique unique copyright @language
property-code-unique unique property @code
codedConcept-code-unique unique conceptList/codedConcept @code
Source
 
<xs:element name="codeSystem">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">Code System</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element name="desc" minOccurs="0" maxOccurs="unbounded" type="FreeFormMarkupWithLanguage">
        <xs:annotation>
          <xs:documentation xml:lang="en-US">A description that describes the Code System</xs:documentation>
        </xs:annotation>
      </xs:element>
      <!-- 
                    there may be one publishing and one or more endorsing authorities
                    not used by DECOR yet, but is populated by the Code System 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 Code System 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 Code System 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 Code System</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 Code System 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 Code System as compared to the previous version. Since Code System versions are built off of previous versions, the net effect of this field is to function as a comprehensive historical reference of the Code System.</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="property" type="CodeSystemPropertyDefinition" minOccurs="0" maxOccurs="unbounded">
        <xs:annotation>
          <xs:documentation xml:lang="en-US">Additional information supplied about each concept</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:choice maxOccurs="1">
        <xs:element name="conceptList" type="CodeSystemConceptList" minOccurs="0" maxOccurs="1"/>
        <!-- a FHIR code system was temporarily positioned here, deprecated -->
        <xs:any namespace="http://hl7.org/fhir" minOccurs="0" maxOccurs="1" processContents="skip"/>
      </xs:choice>
    </xs:sequence>
    <xs:attribute name="id" use="optional" type="Oid">
      <xs:annotation>
        <xs:documentation xml:lang="en-US">A version identifier that uniquely identifies each version of a Code System</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">A reference to a version identifier of a Code System</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"/>
    <xs:attribute name="caseSensitive" type="xs:boolean" use="optional" default="true">
      <xs:annotation>
        <xs:documentation xml:lang="en-US">If code comparison is case sensitive when codes within this system are compared to each other. If this value is missing, then it is not specified whether a code system is case sensitive or not.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <!-- if @ref, flexibility -->
    <xs:attribute name="flexibility" type="StaticOrDynamicFlexibility" use="optional">
      <xs:annotation>
        <xs:documentation xml:lang="en-US">Reference to a codeSystem/@codeSystem. Default is unspecified which means 'latest available version'.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <!-- Only relevant after compilation -->
    <xs:attributeGroup ref="CodeSystemCompilationAttributes"/>
  </xs:complexType>
  <xs:unique name="desc-language-unique">
    <xs:selector xpath="desc"/>
    <xs:field xpath="@language"/>
  </xs:unique>
  <xs:unique name="purpose-language-unique">
    <xs:selector xpath="purpose"/>
    <xs:field xpath="@language"/>
  </xs:unique>
  <xs:unique name="copyright-language-unique">
    <xs:selector xpath="copyright"/>
    <xs:field xpath="@language"/>
  </xs:unique>
  <xs:unique name="property-code-unique">
    <xs:selector xpath="property"/>
    <xs:field xpath="@code"/>
  </xs:unique>
  <xs:unique name="codedConcept-code-unique">
    <xs:selector xpath="conceptList/codedConcept"/>
    <xs:field xpath="@code"/>
  </xs:unique>
</xs:element>
Element codeSystem / desc
Namespace No namespace
Annotations
 
A description that describes the Code System
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">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">A description that describes the Code System</xs:documentation>
  </xs:annotation>
</xs:element>
Element codeSystem / publishingAuthority
Namespace No namespace
Annotations
 
The authoritative body who has reviewed the Code System 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 Code System 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 codeSystem / endorsingAuthority
Namespace No namespace
Annotations
 
A list of bodies who have reviewed the Code System 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 Code System for (clinical) accuracy and relevance, and endorsed it for use</xs:documentation>
  </xs:annotation>
</xs:element>
Element codeSystem / purpose
Namespace No namespace
Annotations
 
A statement about the purpose of the Code System
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 Code System</xs:documentation>
  </xs:annotation>
</xs:element>
Element codeSystem / copyright
Namespace No namespace
Annotations
Diagram
Type CopyrightText
Type hierarchy
Properties
Model
Attributes
Source
Element codeSystem / revisionHistory
Namespace No namespace
Annotations
 
The free text description describing the changes in this version of the Code System
as compared to the previous version. Since Code System versions are built off of previous versions, the net effect 
of this field is to function as a comprehensive historical reference of the Code System.
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 Code System as compared to the previous version. Since Code System versions are built off of previous versions, the net effect of this field is to function as a comprehensive historical reference of the Code System.</xs:documentation>
  </xs:annotation>
</xs:element>
Element codeSystem / property
Namespace No namespace
Annotations
 
Additional information supplied about each concept
Diagram
DiagramDECOR_xsd_Complex_Type_CodeSystemPropertyDefinition.tmp#CodeSystemPropertyDefinition_codeDECOR_xsd_Complex_Type_CodeSystemPropertyDefinition.tmp#CodeSystemPropertyDefinition_uriDECOR_xsd_Complex_Type_CodeSystemPropertyDefinition.tmp#CodeSystemPropertyDefinition_descriptionDECOR_xsd_Complex_Type_CodeSystemPropertyDefinition.tmp#CodeSystemPropertyDefinition_typeDECOR_xsd_Complex_Type_CodeSystemPropertyDefinition.tmp#CodeSystemPropertyDefinition
Type CodeSystemPropertyDefinition
Properties
content complex
minOccurs 0
maxOccurs unbounded
Attributes
QName Type Use
code EnumerationString required
description NonEmptyString optional
type CodeSystemPropertyDefinitionType optional
uri xs:anyURI optional
Source
 
<xs:element name="property" type="CodeSystemPropertyDefinition" minOccurs="0" maxOccurs="unbounded">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">Additional information supplied about each concept</xs:documentation>
  </xs:annotation>
</xs:element>
Element codeSystem / conceptList
Namespace No namespace
Diagram
DiagramDECOR_xsd_Element_codedConcept.tmp#codedConceptDECOR_xsd_Complex_Type_CodeSystemConceptList.tmp#CodeSystemConceptList
Type CodeSystemConceptList
Properties
content complex
minOccurs 0
maxOccurs 1
Model
Children codedConcept
Instance
 
<conceptList>
  <codedConcept code="" effectiveDate="" expirationDate="" lastModifiedDate="" level="" officialReleaseDate="" ordinal="" statusCode="" type="" versionLabel="">{1,unbounded}</codedConcept>
</conceptList>
Source
 
<xs:element name="conceptList" type="CodeSystemConceptList" minOccurs="0" maxOccurs="1"/>
Attribute codeSystem / @id
Namespace No namespace
Annotations
 
A version identifier that uniquely identifies each version of a Code System
Type Oid
Properties
use optional
Facets
maxLength 255
pattern [0-2](\.(0|[1-9][0-9]*))*
Used by
Element codeSystem
Source
 
<xs:attribute name="id" use="optional" type="Oid">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">A version identifier that uniquely identifies each version of a Code System</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute codeSystem / @ref
Namespace No namespace
Annotations
 
A reference to a version identifier of a Code System
Type Oid
Properties
use optional
Facets
maxLength 255
pattern [0-2](\.(0|[1-9][0-9]*))*
Used by
Element codeSystem
Source
 
<xs:attribute name="ref" type="Oid" use="optional">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">A reference to a version identifier of a Code System</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute codeSystem / @name
Namespace No namespace
Type BasicId
Properties
use required
Facets
minLength 1
maxLength 80
Used by
Element codeSystem
Source
 
<xs:attribute name="name" use="required" type="BasicId"/>
Attribute codeSystem / @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 codeSystem
Source
 
<xs:attribute name="statusCode" type="ItemStatusCodeLifeCycle" use="optional"/>
Attribute codeSystem / @caseSensitive
Namespace No namespace
Annotations
 
If code comparison is case sensitive when codes within this system are compared to each other. If this value is missing, then it is not specified whether a code system is case sensitive or not.
Type xs:boolean
Properties
use optional
default true
Used by
Element codeSystem
Source
 
<xs:attribute name="caseSensitive" type="xs:boolean" use="optional" default="true">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">If code comparison is case sensitive when codes within this system are compared to each other. If this value is missing, then it is not specified whether a code system is case sensitive or not.</xs:documentation>
  </xs:annotation>
</xs:attribute>
Attribute codeSystem / @flexibility
Namespace No namespace
Annotations
 
Reference to a codeSystem/@codeSystem. Default is unspecified which means 'latest available version'.
Type StaticOrDynamicFlexibility
Properties
use optional
Used by
Element codeSystem
Source
 
<xs:attribute name="flexibility" type="StaticOrDynamicFlexibility" use="optional">
  <xs:annotation>
    <xs:documentation xml:lang="en-US">Reference to a codeSystem/@codeSystem. Default is unspecified which means 'latest available version'.</xs:documentation>
  </xs:annotation>
</xs:attribute>
XML Schema documentation generated by ® XML Editor.