complexType "CodeListType"
Namespace: |
|
Content: |
|
Defined: |
|
Includes: |
|
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:boolean : "false" |
|
|
= |
xs:anyURI |
|
|
= |
xs:language |
|
|
= |
"true" |
|
|
= |
xs:boolean : "false" |
|
|
> |
|
Content: |
( r:URN | ( r:Agency, r:ID, r:Version))[1..2], r:UserID*, r:UserAttributePair*, ( r:VersionResponsibility | r:VersionResponsibilityReference)?, r:VersionRationale?, r:BasedOnObject?, r:RelatedOtherMaterialReference*, r:Note*, r:Software*, r:MetadataQuality*, CodeListName*, r:Label*, r:Description?, r:RecommendedDataType?, r:CodeListReference*, r:CategorySchemeReference?, HierarchyType?, Level*, Code* |
|
</...> |
All Direct / Indirect Based Elements (1):
-
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 Derivation Tree
 CodeListType
|
XML Source (w/o annotations (11); see within schema source)
<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 maxOccurs="unbounded" minOccurs="0" ref="Level"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Code"/>
</xs:sequence>
</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
XML Source (w/o annotations (1); see within schema source)
Content Element Detail (all declarations; defined within this component only; 9/23)
-
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"/>
|
-
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"/>
|
-
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)
-
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"/>
|
-
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)
-
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)
-
A description of the content and purpose of the CodeList. Supports multiple language versions of the same content as well as optional formatting of the content.
XML Source (w/o annotations (1); see within schema source)
-
A display label for the CodeList. Supports multiple language versions of the same content as well as optional formatting of the content. 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"/>
|
-
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
XML Source (w/o annotations (1); see within schema source)
