DDI 3.1 XML Schema Documentation (2009-10-18)
© DDI Alliance 2009 - licensed under the terms of the GNU Lesser General Public License
complexType "CodeSchemeType"
Namespace:
Content:
complex, 11 attributes, 11 elements
Defined:
Includes:
definitions of 8 elements
Used:
XML Representation Summary
<...
    action
 = 
("Add" | "Update" | "Delete")
    agency
 = 
xs:NCName
    externalReferenceDefaultURI
 = 
xs:anyURI
    id
 = 
xs:string
    isMaintainable
 = 
"true"
    isPublished
 = 
xs:boolean : "false"
    objectSource
 = 
xs:anyURI
    urn
 = 
xs:anyURI
    version
 = 
xs:string
    versionDate
 = 
(xs:dateTime | xs:date | xs:gYearMonth | xs:gYear | xs:duration)
    xml:lang
 = 
xs:language
    >
   
Content: 
UserID*, VersionResponsibility?, VersionRationale*, CodeSchemeName*, r:Label*, r:Description*, CodeSchemeReference*, CategorySchemeReference?, HierarchyType?, Level*, Code*
</...>
Content Model Elements (11):
All Direct / Indirect Based Elements (1):
Known Usage Locations
Annotation
Describes the structure of a Code Scheme.
Type Definition Detail
Type Derivation Tree
      r:AbstractMaintainableType (extension)
          r:MaintainableType (extension)
              CodeSchemeType (extension)
XML Source (w/o annotations (8); see within schema source)
<xs:complexType name="CodeSchemeType">
<xs:complexContent>
<xs:extension base="r:MaintainableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CodeSchemeName"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Description"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CodeSchemeReference"/>
<xs:element minOccurs="0" ref="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:extension>
</xs:complexContent>
</xs:complexType>
Content Element Detail (defined in this component only; 8/11)
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="CategorySchemeReference"/>

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"/>

CodeSchemeName
Type:
r:NameType, simple content
Simple Content
xs:string
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CodeSchemeName"/>

CodeSchemeReference
Type:
CodeSchemeReferenceType, complex content
Allows for inclusion by reference of another code scheme
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CodeSchemeReference"/>

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"
"Irregular"
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="HierarchyType"/>

Level
Type:
LevelType, complex content
to describe 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:Description
Type:
r:StructuredStringType, mixed content
A further human-readable description of the code scheme.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Description"/>

r:Label
Type:
r:LabelType, mixed content
A display label for the code scheme.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label"/>

XML schema documentation generated with DocFlex/XML SDK 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set