complexType "CodeListType"
Namespace:
Content:
complex, 10 attributes, 22 elements
Defined:
Includes:
definitions of 1 attribute, 9 elements
Used:
XML Representation Summary
<...
   
 = 
("Add" | "Update" | "Delete")
 = 
(xs:string | xs:string)
 = 
("Agency" | "Maintainable") : "Agency"
 = 
xs:boolean
 = 
(xs:dateTime | xs:date | xs:gYearMonth | xs:gYear | xs:duration)
 = 
xs:anyURI
 = 
xs:boolean : "false"
 = 
xs:language
 = 
"true"
 = 
xs:boolean : "false"
   
>
   
Content: 
</...>
Content Model Elements (22):
Code, CodeListName, HierarchyType, Level, r:Agency, r:BasedOnObject, r:CategorySchemeReference, r:CodeListReference, r:Description, r:ID, r:Label, r:MetadataQuality, r:Note, r:RecommendedDataType, r:Software, r:URN, r:UserAttributePair, r:UserID, r:Version, r:VersionRationale, r:VersionResponsibility, r:VersionResponsibilityReference
All Direct / Indirect Based Elements (1):
CodeList
Known Usage Locations
Annotation
A structure used to associate a list of code values to specified categories. May be flat or hierarchical. This is a maintainable object. In addition to the standard name, label, and description the CodeList specifies a recommended data type, the hierarchical nature of the CodeList, level descriptions, individual code values and associated category, and whether the CodeList contents are used to represent system specific missing values. May include another CodeList by reference. If including other CodeLists make sure there are no code conflicts in the overall content. A code value must be unique within the CodeList. May also include a reference to a default CategoryScheme.
Type Definition Detail
Type Derivation Tree
r:AbstractIdentifiableType (extension)
      r:AbstractMaintainableType (extension)
          r:MaintainableType (extension)
              CodeListType
XML Source (w/o annotations (11); see within schema source)
<xs:complexType name="CodeListType">
<xs:complexContent>
<xs:extension base="r:MaintainableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CodeListName"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label"/>
<xs:element minOccurs="0" ref="r:Description"/>
<xs:element minOccurs="0" ref="r:RecommendedDataType"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:CodeListReference"/>
<xs:element minOccurs="0" ref="r:CategorySchemeReference"/>
<xs:element minOccurs="0" ref="HierarchyType"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Level"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Code"/>
</xs:sequence>
<xs:attribute default="false" name="isSystemMissingValue" type="xs:boolean"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Attribute Detail (all declarations; defined within this component only; 1/10)
isSystemMissingValue
Type:
xs:boolean, predefined
Use:
optional
If "true" contents are used to represent system specific missing values. The default value is "false".
Attribute Value
Default:
"false"
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="false" name="isSystemMissingValue" type="xs:boolean"/>
Content Element Detail (all declarations; defined within this component only; 9/22)
Code
Type:
CodeType, complex content
Includes a code value, references the category label, and describes the code's position in a hierarchy.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Code"/>

CodeListName
Type:
r:NameType, complex content
A name for the CodeList. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CodeListName"/>

HierarchyType
Type:
HierarchyCodeType, simple content
Identifies the type of hierarchy used in the nesting of categories. Possible values are Regular and Irregular. A regular nesting indicates that the category hierarchy is consistent at all lower levels of the hierarchy, i.e., the lowest levels of the hierarchy are at the same level for every branch on the hierarchy.
Simple Content
enumeration of xs:NMTOKEN
Enumeration:
"Regular"
 - 
A hierarchy where each section has the same number of nested levels, i.e., the lowest level represents the most discrete values.
"Irregular"
 - 
A hierarchy where each section can vary in the number of nested levels it contains. The most discrete objects in an irregular hierarchy must be individually identified.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="HierarchyType"/>

Level
Type:
LevelType, complex content
Describes the levels of the code hierarchy. The level describes the nesting structure of a hierarchical coding structure. Note that the attribute levelNumber is used for referencing specific codes to their level identifier.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Level"/>

r:CategorySchemeReference
Type:
r:SchemeReferenceType, complex content
Reference to a default category scheme, with the assumption that all categories referenced by the subsequent codes are part of it, unless overwritten by the scheme reference in the CategoryReference field of the code.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:CategorySchemeReference"/>

r:CodeListReference
Type:
r:ReferenceType, complex content
Allows for inclusion by reference of another CodeList. Care must be taken to ensure that all code values of the resulting CodeList are unique.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:CodeListReference"/>

r:Description
Type:
r:StructuredStringType, complex content
A description of the content and purpose of the CodeList. May be expressed in multiple languages and supports the use of structured content.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:Description"/>

r:Label
Type:
r:LabelType, complex content
A display label for the CodeList. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label"/>

r:RecommendedDataType
Type:
r:CodeValueType, simple content
This field provides the recommended treatment of the data within an application. This field is important as some codes represented as numeric should be treated as strings, i.e., many standardized codes for industry, occupation, education, etc. The value should come from a controlled vocabulary - recommended values include the set found in W3C XML Schema Part 2, but excluding string sub-types, QNAME, and NOTATION.
Simple Content
xs:string
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:RecommendedDataType"/>

XML schema documentation generated with DocFlex/XML RE 1.9.0 using DocFlex/XML XSDDoc 2.8.0 template set