complexType "CodeType"
Namespace: |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
XML Representation Summary |
<... |
|
|
= |
("Add" | "Update" | "Delete") |
|
= |
(xs:string | xs:string) |
|
= |
("Agency" | "Maintainable") : "Agency" |
|
= |
xs:boolean |
|
= |
"true" |
|
= |
xs:boolean : "true" |
|
= |
xs:integer |
|
= |
("True" | "False" | "Unknown") : "Unknown" |
|
= |
xs:boolean : "false" |
|
|
> |
|
|
</...> |
Content Model Elements (9):
-
All Direct / Indirect Based Elements (1):
-
Annotation
A structure that links a unique value of a code to a specified category and provides information as to the location of the code within a hierarchy, whether it is discrete, represents a total for the CodeList contents, and if its sub-elements represent a comprehensive coverage of the code. The Code is identifiable, but the value within the code must also be unique within the CodeList.
Type Derivation Tree
CodeType
|
XML Source (w/o annotations (8); see within schema source)
<xs:complexContent>
<xs:extension base="r:IdentifiableType">
<xs:sequence>
</xs:sequence>
<xs:attribute default="true" name="isDiscrete" type="xs:boolean"/>
<xs:attribute name="levelNumber" type="xs:integer" use="optional"/>
<xs:attribute default="false" name="isTotal" type="xs:boolean"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
|
Attribute Detail (all declarations; defined within this component only; 4/9)
isComprehensive
-
Used in hierarchical structures at upper level values to indicate whether or not the subelements of the code are comprehensive in coverage. Not applicable if attribute isDiscrete is set to "true".
Attribute Value
enumeration of xs:NMTOKEN
|
Enumeration: |
"True" |
- |
True, the values are comprehensive.
|
"False" |
- |
False, the values are not comprehensive, some possible values have not been included. These should be treated as a specified sub-set of the parent.
|
"Unknown" |
- |
Unknown, the documentation is lacking to make an assertion as to whether the values listed are comprehensive.
|
|
Default: |
"Unknown" |
XML Source (w/o annotations (1); see within schema source)
isDiscrete
-
Type: |
xs:boolean, predefined |
Use: |
optional |
Indicates whether the code is discrete (that is, placed at the lowest level in a hierarchy and has no children).
Attribute Value
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="true" name="isDiscrete" type="xs:boolean"/>
|
isTotal
-
Type: |
xs:boolean, predefined |
Use: |
optional |
This expresses a total whether or not isComprehensive is true. If isComprehensive = "true" then if addition is supported by the measure type, the contained categories can be aggregated to calculate the total. If isComprehensive = "false" or "unknown" the content of this field cannot be calculated if the value is not provided in the data.
Attribute Value
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="false" name="isTotal" type="xs:boolean"/>
|
levelNumber
-
Type: |
xs:integer, predefined |
Use: |
optional |
Level number of the code.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="levelNumber" type="xs:integer" use="optional"/>
|
Content Element Detail (all declarations; defined within this component only; 3/9)
-
Allows for nesting of codes.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Code"/>
|
-
Reference to the category that the code value represents.
XML Source (w/o annotations (1); see within schema source)
-
The value of the code. In a microdata file this would be the value found in the data file. If used as the description of an NCube dimension the value provides the coordinate value for that dimension. Note that r:Value has an attribute xml:space with the default value of "default". If white space is critical to the understanding of this code value (such as critical leading or tailing spaces, or multiple spaces within the code) change the value of xml:space to "preserve".
Simple Content
XML Source (w/o annotations (1); see within schema source)