Schema "logicalproduct.xsd"
Target Namespace:
ddi:logicalproduct:3_2_dev
Defined Components:
elements (86 global + 6 local), complexTypes (40), simpleTypes (6)
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
/Users/j/Documents/workspace/proposed3.2/schema/logicalproduct.xsd; see XML source
Imports Schemas (1):
reusable.xsd [src]
Imported by Schemas (4):
datacollection.xsd [src], group.xsd [src], instance.xsd [src], studyunit.xsd [src]
All Element Summary
AggregationDefinition Identifies the independent (denominator) and dependent (numerator) dimensions for calculating aggregate measures such as percent.
Type:
Content:
complex, 1 attribute, 2 elements
Defined:
globally; see XML source
Used:
Anchor Identifies the start value for this interval.
Type:
xs:string
Content:
simple
Defined:
locally witnin IntervalType complexType; see XML source
AttachmentGroupReference Reference to an existing CoordinateGroup using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
AttachmentValue The value of the attachment expressed as a string, if not a variable.
Type:
xs:string
Content:
simple
Defined:
locally witnin AttributeType complexType; see XML source
Attribute An attribute may be any object which should be attached to all or part of the NCube.
Type:
Content:
complex, 6 attributes, 11 elements
Defined:
globally; see XML source
Used:
BaseLogicalProduct This is an abstract structure which serves as a substitution base for current and future LogicalProduct definitions relating to specific data types.
Type:
Content:
complex, 9 attributes, 19 elements
Abstract:
(may not be used directly in instance XML documents)
Subst.Gr:
may be substituted with 1 element
Defined:
globally; see XML source
Used:
CaseIdentification Describes the information needed to identify an individual case within a record type
Type:
Content:
complex, 1 attribute, 2 elements
Defined:
globally; see XML source
Used:
CaseSpecification Case specification allows different unique identifiers to be used based on the value of an identified variable.
Type:
Content:
complex, 2 elements
Defined:
globally; see XML source
Used:
Category A description of a particular category or response.
Type:
Content:
complex, 7 attributes, 16 elements
Defined:
globally; see XML source
Used:
CategoryGroup Contains a group of Category descriptions, which may be ordered or hierarchical.
Type:
Content:
complex, 7 attributes, 17 elements
Defined:
globally; see XML source
Used:
CategoryGroupName Name of the Category Group using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
CategoryName Name of the Category using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
CategoryRelationship Describes the relationship between the categories in terms of the significance of order and the distance between categories.
Type:
Content:
simple
Defined:
globally; see XML source
Used:
CategoryScheme A scheme containing a set of Categories managed by an agency.
Type:
Content:
complex, 9 attributes, 19 elements
Defined:
globally; see XML source
Used:
CategorySchemeName Name of the Category Scheme using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
Code A structure that links a unique value of a code to a specified category .
Type:
Content:
complex, 9 attributes, 9 elements
Defined:
globally; see XML source
Used:
CodeList A structure used to associate a list of code values to specified categories.
Type:
Content:
complex, 10 attributes, 22 elements
Defined:
globally; see XML source
Used:
CodeListGroup A grouping of CodeLists for conceptual or administrative purposed.
Type:
Content:
complex, 7 attributes, 19 elements
Defined:
globally; see XML source
Used:
CodeListGroupName Name of the Code List Group using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
CodeListGroupReference Reference to an existing CodeListGroup using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
CodeListName Name of the Code List using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
CodeListReference ORPHAN
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
never
CodeListScheme A scheme containing sets of CodeLists that are used by reference to define code delineations used by value representations and response domains.
Type:
Content:
complex, 9 attributes, 21 elements
Defined:
globally; see XML source
Used:
CodeListSchemeName Name of the Code List Scheme using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
CodeListSchemeReference ORPHAN
Type:
Content:
complex, 8 attributes, 7 elements
Defined:
globally; see XML source
Used:
never
ComponentReference Reference to an existing Category using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
ConcatenatedValue Lists the variables whose values when concatenated result in the value for this variable.
Type:
Content:
complex, 1 element
Defined:
globally; see XML source
Used:
ConditionalIdentifier Reference to the variable containing the unique identifier given the conditional value.
Type:
Content:
complex, 1 element
Defined:
globally; see XML source
Used:
ConditionalVariableReference Value of variable indicating this record type.
Type:
Content:
complex, 8 attributes, 7 elements
Defined:
globally; see XML source
Used:
CoordinateGroup Defines the area of attachment for an NCube attribute.
Type:
Content:
complex, 5 attributes, 10 elements
Defined:
globally; see XML source
Used:
DataElementReference Reference to an existing DataElement using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
DataRelationship Describes the relationships among logical records in the dataset.
Type:
Content:
complex, 6 attributes, 16 elements
Defined:
globally; see XML source
Used:
DataRelationshipName Name of the Data Relationship using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
DefaultMissingValues Identifies the default missing value parameter for the this logical record by referencing a MissingValuesDelineation or by stating that there is a default missing values parameter used but it is undocumented.
Type:
Content:
complex, 2 elements
Defined:
globally; see XML source
Used:
DefaultUsedNoDocumentation Use when it is known that a default missing values definition was use but there is NO documentation describing its content.
Type:
xs:boolean
Content:
simple
Defined:
DefiningCategoryReference Reference to an existing Category using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
DependentDimension The rank of a dimension that acts as the numerator (dependent variable).
Type:
xs:integer
Content:
simple
Defined:
Dimension A dimension is provided a rank and a reference to a variable that describes it.
Type:
Content:
complex, 1 attribute, 1 element
Defined:
globally; see XML source
Used:
DimensionValue Defines the included values of a dimension.
Type:
Content:
complex, 1 attribute, 3 elements
Defined:
globally; see XML source
Used:
EmbargoReference Reference to an existing Embargo using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
FixedIdentifier Reference to the variable containing the unique identifier.
Type:
Content:
complex, 1 element
Defined:
globally; see XML source
Used:
Generation Description of the process used to generate the category content.
Type:
Content:
complex, 2 attributes, 4 elements
Defined:
globally; see XML source
Used:
HierarchyType Defines the type of hierarchical structure as Regular or Irregular.
Type:
Content:
simple
Defined:
globally; see XML source
Used:
ImputationReference Reference to an existing GenerationInstruction or GeneralInstruction using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
Increment Value specifying the increment between categories.
Type:
xs:string
Content:
simple
Defined:
locally witnin IntervalType complexType; see XML source
IndependentDimension The rank of a dimension that acts as the denominator (independent variable).
Type:
xs:integer
Content:
simple
Defined:
Interval Describes the structure, starting point and increment step of an interval.
Type:
Content:
complex, 2 elements
Defined:
globally; see XML source
Used:
Level Used to describe the levels of the code list hierarchy.
Type:
Content:
complex, 1 attribute, 4 elements
Defined:
globally; see XML source
Used:
LevelName Name of the Level using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
LinkVariableReference Reference to an existing Variable using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
never
LogicalProduct A module describing the logical (intellectual) contents of the quantitative data.
Type:
Content:
complex, 9 attributes, 27 elements
Subst.Gr:
may substitute for element BaseLogicalProduct
Defined:
globally; see XML source
Used:
LogicalProductName Name of the Logical Product using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
LogicalRecord A logical record is a description of all of the elements (variables or NCubes) related to a single case or analysis unit.
Type:
Content:
complex, 7 attributes, 15 elements
Defined:
globally; see XML source
Used:
LogicalRecordName Name of the Logical Record using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
LogicalRecordReference Reference to an existing LogicalRecord using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
never
MeasureDefinition Defines the structure and type of measure captured within the cells.
Type:
Content:
complex, 5 attributes, 8 elements
Defined:
globally; see XML source
Used:
MeasurementUnit Records the measurement unit, for example, 'km', 'miles', etc.
Type:
Content:
simple, 7 attributes
Defined:
globally; see XML source
Used:
MissingValuesReference Reference to an existing MissingValuesDelineation using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
NCube An NCube is a 1..n dimension structure which relates a set of individual values to each other by defining them within a matrix.
Type:
Content:
complex, 9 attributes, 23 elements
Defined:
globally; see XML source
Used:
NCubeGroup Contains a group of NCubes, which may be ordered or hierarchical.
Type:
Content:
complex, 7 attributes, 19 elements
Defined:
globally; see XML source
Used:
NCubeGroupName Name of the NCube Scheme using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
NCubeGroupReference Reference to an existing NCubeGroup using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
NCubeName Name of the NCube using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
NCubeScheme A set of NCubes maintained by an agency and used to structure data items into relational structures.
Type:
Content:
complex, 9 attributes, 19 elements
Defined:
globally; see XML source
Used:
NCubeSchemeName Name of the NCube Scheme using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
NCubesInRecord Identifies the NCubes and any variables in the record external to NCube structures.
Type:
Content:
complex, 1 attribute, 3 elements
Defined:
globally; see XML source
Used:
RecordRelationship Describes the relationship between records of different types or of the same type within a longitudinal study.
Type:
Content:
complex, 6 attributes, 12 elements
Defined:
globally; see XML source
Used:
RecordRelationshipName Name of the Record Relationship using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
RelatedValue The characteristic value expressed as a string with an indicator of the specific relationship of the variable value to the characteristic value.
Type:
Content:
simple, 3 attributes
Defined:
globally; see XML source
Used:
SelectorVariableReference Reference to an existing Variable using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
never
SourceLinkVariableReference Reference to an existing Variable using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
SourceLogicalRecordReference Reference to an existing LogicalRecord using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
SourceTargetLink Contains a set of variables, one from the source record and one from the target record used as all or part of a link between the source and target records.
Type:
Content:
complex, 2 elements
Defined:
globally; see XML source
Used:
SourceUnit The normal source of the information contained in the variable.
Type:
Content:
simple, 7 attributes
Defined:
globally; see XML source
Used:
StandardWeightReference Reference to an existing StandardWeight using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
SupportForMultipleSegments A reference the variable containing the segment locator and the value being used.
Type:
Content:
complex, 2 elements
Defined:
globally; see XML source
Used:
TargetLinkVariableReference Reference to an existing Variable using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
TargetLogicalRecordReference Reference to an existing LogicalRecord using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
TypeOfCodeListGroup A brief textual description of the type of group created to associate a number of code lists.
Type:
Content:
simple, 7 attributes
Defined:
globally; see XML source
Used:
TypeOfGroup A brief textual description or classification of the created to associate a number of variables or NCubes.
Type:
Content:
simple, 7 attributes
Defined:
globally; see XML source
Used:
Variable Describes the structure of a Variable.
Type:
Content:
complex, 9 attributes, 23 elements
Defined:
globally; see XML source
Used:
VariableGroup Contains a group of Variables, which may be ordered or hierarchical.
Type:
Content:
complex, 7 attributes, 20 elements
Defined:
globally; see XML source
Used:
VariableGroupName Name of the Variable Group using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
VariableGroupReference Reference to an existing VariableGroup using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
VariableName Name of the Variable using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
VariableRepresentation Describes the representation of the variable in the data set.
Type:
Content:
complex, 1 attribute, 10 elements
Defined:
globally; see XML source
Used:
VariableRole Describes a specific function of the variable, such as identity, weight, geographic variable, time, date, currency, etc.
Type:
Content:
simple, 7 attributes
Defined:
globally; see XML source
Used:
VariableScheme Contains a set of Variables and VariableGroups.
Type:
Content:
complex, 9 attributes, 21 elements
Defined:
globally; see XML source
Used:
VariableSchemeName Name of the Variable Scheme using the DDI Name structure.
Type:
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
VariablesInRecord Identifies the variables contained in the logical record.
Type:
Content:
complex, 1 attribute, 2 elements
Defined:
globally; see XML source
Used:
VariableUsedReference Reference to an existing Variable using the Reference structure.
Type:
Content:
complex, 8 attributes, 6 elements
Defined:
globally; see XML source
Used:
VariableValueReference A reference the variable containing the record type locator and the value being used.
Type:
Content:
complex, 2 elements
Defined:
globally; see XML source
Used:
Complex Type Summary
Identifies the independent (denominator) and dependent (numerator) dimensions for calculating aggregate measures such as percent.
Content:
complex, 1 attribute, 2 elements
Defined:
globally; see XML source
Includes:
definitions of 1 attribute, 2 elements
Used:
An attribute may be any object which should be attached to all or part of the NCube.
Content:
complex, 6 attributes, 11 elements
Defined:
globally; see XML source
Includes:
definitions of 1 attribute, 5 elements
Used:
This is an abstract structure which serves as a substitution base for current and future LogicalProduct definitions relating to specific data types.
Content:
complex, 9 attributes, 19 elements
Abstract:
(cannot be assigned directly to elements used in instance XML documents)
Defined:
globally; see XML source
Includes:
definitions of 6 elements
Used:
Describes the information needed to identify an individual case within a record type.
Content:
complex, 1 attribute, 2 elements
Defined:
globally; see XML source
Includes:
definitions of 1 attribute, 2 elements
Used:
Case specification allows different unique identifiers to be used based on the value of an identified variable.
Content:
complex, 2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
Contains a group of Category descriptions, which may be ordered or hierarchical.
Content:
complex, 7 attributes, 17 elements
Defined:
globally; see XML source
Includes:
definitions of 1 attribute, 6 elements
Used:
A scheme containing a set of Categories managed by an agency.
Content:
complex, 9 attributes, 19 elements
Defined:
globally; see XML source
Includes:
definitions of 6 elements
Used:
A description of a particular category or response.
Content:
complex, 7 attributes, 16 elements
Defined:
globally; see XML source
Includes:
definitions of 1 attribute, 5 elements
Used:
A grouping of CodeLists for conceptual or administrative purposed.
Content:
complex, 7 attributes, 19 elements
Defined:
globally; see XML source
Includes:
definitions of 1 attribute, 8 elements
Used:
A scheme containing sets of CodeLists that are used by reference to define code delineations used by value representations and response domains.
Content:
complex, 9 attributes, 21 elements
Defined:
globally; see XML source
Includes:
definitions of 8 elements
Used:
A structure used to associate a list of code values to specified categories.
Content:
complex, 10 attributes, 22 elements
Defined:
globally; see XML source
Includes:
definitions of 1 attribute, 9 elements
Used:
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.
Content:
complex, 9 attributes, 9 elements
Defined:
globally; see XML source
Includes:
definitions of 4 attributes, 3 elements
Used:
Defines the included values of a dimension by means of individual value references or by defining a range of values to include.
Content:
complex, 1 attribute, 3 elements
Defined:
globally; see XML source
Includes:
definitions of 1 attribute, 3 elements
Used:
Lists the variables whose values when concatenated result in the value for this variable.
Content:
complex, 1 element
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
Describes the information needed to identify a specific record or case within a record type.
Content:
complex, 1 element
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
Value of variable indicating this record type, multiple entries allow for multiple valid values or ranges.
Content:
complex, 8 attributes, 7 elements
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
Defines the area of attachment for an NCube attribute.
Content:
complex, 5 attributes, 10 elements
Defined:
globally; see XML source
Includes:
definitions of 4 elements
Used:
Describes the relationships among logical records in the dataset.
Content:
complex, 6 attributes, 16 elements
Defined:
globally; see XML source
Includes:
definitions of 5 elements
Used:
Identifies the default missing value parameter for the this logical record by referencing a MissingValuesDelineation or by stating that there is a default missing values parameter used but it is undocumented.
Content:
complex, 2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
A dimension is provided a rank and a reference to a variable that describes it.
Content:
complex, 1 attribute, 1 element
Defined:
globally; see XML source
Includes:
definitions of 1 attribute, 1 element
Used:
Reference to the variable containing the unique identifier.
Content:
complex, 1 element
Defined:
globally; see XML source
Includes:
definition of 1 element
Used:
Description of the process used to generate the category content.
Content:
complex, 2 attributes, 4 elements
Defined:
globally; see XML source
Includes:
definitions of 2 attributes, 4 elements
Used:
Describes the structure, starting point and increment step of an interval.
Content:
complex, 2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
Used to describe the levels of the code list hierarchy.
Content:
complex, 1 attribute, 4 elements
Defined:
globally; see XML source
Includes:
definitions of 1 attribute, 4 elements
Used:
A module describing the logical (intellectual) contents of the quantitative data.
Content:
complex, 9 attributes, 27 elements
Defined:
globally; see XML source
Includes:
definitions of 8 elements
Used:
A logical record is a description of all of the elements (variables or NCubes) related to a single case or analysis unit.
Content:
complex, 7 attributes, 15 elements
Defined:
globally; see XML source
Includes:
definitions of 2 attributes, 9 elements
Used:
Defines the structure and type of measure captured within the cells.
Content:
complex, 5 attributes, 8 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
Contains a group of NCubes, which may be ordered or hierarchical.
Content:
complex, 7 attributes, 19 elements
Defined:
globally; see XML source
Includes:
definitions of 1 attribute, 8 elements
Used:
A set of NCubes maintained by an agency and used to structure data items into relational structures.
Content:
complex, 9 attributes, 19 elements
Defined:
globally; see XML source
Includes:
definitions of 6 elements
Used:
Identifies the NCubes and any variables in the record external to NCube structures such as case identification variables that are contained in the logical record by indicating that all NCubes contained in the logical product are included, inclusion of a NCubeScheme to include, or listing individual NCubes to include.
Content:
complex, 1 attribute, 3 elements
Defined:
globally; see XML source
Includes:
definitions of 1 attribute, 3 elements
Used:
An NCube is a 1..n dimension structure which relates a set of individual values to each other by defining them within a matrix.
Content:
complex, 9 attributes, 23 elements
Defined:
globally; see XML source
Includes:
definitions of 3 attributes, 12 elements
Used:
Describes the relationship between records of different types or of the same type within a longitudinal study.
Content:
complex, 6 attributes, 12 elements
Defined:
globally; see XML source
Includes:
definitions of 1 attribute, 6 elements
Used:
The characteristic value expressed as a string with an indicator of the specific relationship of the variable value to the characteristic value.
Content:
simple, 3 attributes
Defined:
globally; see XML source
Includes:
definitions of 2 attributes
Used:
Contains a set of variables, one from the source record and one from the target record used as all or part of a link between the source and target records.
Content:
complex, 2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
Contains a group of Variables, which may be ordered or hierarchical.
Content:
complex, 7 attributes, 20 elements
Defined:
globally; see XML source
Includes:
definitions of 1 attribute, 9 elements
Used:
Describes the representation of the variable in the data set.
Content:
complex, 1 attribute, 10 elements
Defined:
globally; see XML source
Includes:
definitions of 1 attribute, 10 elements
Used:
Contains a set of Variables and VariableGroups.
Content:
complex, 9 attributes, 21 elements
Defined:
globally; see XML source
Includes:
definitions of 8 elements
Used:
Identifies the variables contained in the logical record by indicating that all variable contained in the logical product are included, inclusion of a scheme of variable to include, or listing individual variables to include.
Content:
complex, 1 attribute, 2 elements
Defined:
globally; see XML source
Includes:
definitions of 1 attribute, 2 elements
Used:
Describes the structure of a Variable.
Content:
complex, 9 attributes, 23 elements
Defined:
globally; see XML source
Includes:
definitions of 3 attributes, 12 elements
Used:
A reference to the variable containing the record type locator and the value being used.
Content:
complex, 2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
Simple Type Summary
Describes the nature of additivity for the content.
Defined:
globally; see XML source
Used:
Identifies the contextual level of an NCube to which the attribute is attached; the full cube, a specific set of coordinates, a full dimension, a specific measurement, or a specific measurement value.
Defined:
globally; see XML source
Used:
Defines the type of hierarchical structure as Regular or Irregular.
Defined:
globally; see XML source
Used:
Indicates the values are comprehensive, they cover all possible values.
Defined:
globally; see XML source
Used:
Indicates the relationship of the value of a source object to a target object.
Defined:
globally; see XML source
Used:
Indicates the relationship of a source object to a target object.
Defined:
globally; see XML source
Used:
XML Source
<?xml version="1.0" encoding="UTF-8"?>
<!--

Copyright (c) 2010 DDI Alliance, DDI 3.2 development release, 2010-09-21

This file is part of DDI 3.2 dev XML Schema.

DDI 3.2 dev XML Schema is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.

DDI 3.2 dev XML Schema is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
for more details.

You should have received a copy of the GNU Lesser General Public License along
with DDI 3 dev XML Schema. If not, see <http://www.gnu.org/licenses/>.

-->
<xs:schema elementFormDefault="qualified" targetNamespace="ddi:logicalproduct:3_2_dev" xmlns="ddi:logicalproduct:3_2_dev" xmlns:r="ddi:reusable:3_2_dev" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="ddi:reusable:3_2_dev" schemaLocation="reusable.xsd"/>
<!-- BASE LOGICAL PRODUCT -->
<xs:element abstract="true" name="BaseLogicalProduct" type="BaseLogicalProductType">
<xs:annotation>
<xs:documentation>
This is an abstract structure which serves as a substitution base for current and future LogicalProduct definitions relating to specific data types.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType abstract="true" name="BaseLogicalProductType">
<xs:annotation>
<xs:documentation>
This is an abstract structure which serves as a substitution base for current and future LogicalProduct definitions relating to specific data types. It provides an extension base including the standard name, label, and description, coverage information, a structure to define data relationships (between records of information and between the intellectual content and physical storage of data), as well as OtherMaterial related to its contents.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:MaintainableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="LogicalProductName">
<xs:annotation>
<xs:documentation>
A name for the LogicalProduct. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
A display label for the LogicalProduct. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and purpose of the LogicalProduct. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Coverage">
<xs:annotation>
<xs:documentation>
The Coverage statement at this level may be used to restrict the coverage described in the StudyUnit module. For example if this specific logical product from a population and housing census only covers housing questions or only provides State and County level data these should be noted here. If there are no changes in the coverage from the coverage of the StudyUnit module, no entry is needed here.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="DataRelationship">
<xs:annotation>
<xs:documentation>
Contains a written description of how the logical contents of the file relate to each other for programming purposes. For example, noting that there are household, family and person items where the household is identified by variable, the unique family by the concatenation of variable_H and variable_F, and the unique person within a household by the concatenation of variable_H and variable_P.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:OtherMaterial">
<xs:annotation>
<xs:documentation>
Describes Other Materials that have a specific relation to the logical product. For example the printed data dictionary or printed output for the logical product.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="LogicalProductName" type="r:NameType">
<xs:annotation>
<xs:documentation>
Name of the Logical Product using the DDI Name structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<!-- LOGICAL PRODUCT -->
<xs:element name="LogicalProduct" substitutionGroup="BaseLogicalProduct" type="LogicalProductType">
<xs:annotation>
<xs:documentation>
A module describing the logical (intellectual) contents of the quantitative data.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="LogicalProductType">
<xs:annotation>
<xs:documentation>
A module describing the logical (intellectual) contents of the quantitative data. This is a member of the BaseLogicalProduct substitution group and in addition to the content inherited from the BaseLogicalProduct, contains CategorySchemes, CodeListSchemes, VariableSchemes an NCubeSchemes both in-line an by reference.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="BaseLogicalProductType">
<xs:sequence>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="CategoryScheme">
<xs:annotation>
<xs:documentation>
Contains descriptions of particular categories used as question responses and in the logical product. Their relationships and code values are described in the code scheme.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="r:CategorySchemeReference">
<xs:annotation>
<xs:documentation>
Reference to a previously defined category scheme either internal to or external to the xml instance.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="CodeListScheme">
<xs:annotation>
<xs:documentation>
Lists the code values used to represent categories for a variable or question. Also describes hierarchical relationships between categories used in the code scheme.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="r:CodeListSchemeReference">
<xs:annotation>
<xs:documentation>
Reference to a previously defined code scheme either internal to or external to the DDI instance.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="VariableScheme">
<xs:annotation>
<xs:documentation>
Contains a collection of variables and variable groups.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="r:VariableSchemeReference">
<xs:annotation>
<xs:documentation>
A reference to a previously defined variable scheme either internal to or external to the DDI instance.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="NCubeScheme">
<xs:annotation>
<xs:documentation>Contains a collection of NCubes and NCube groups.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="r:NCubeSchemeReference">
<xs:annotation>
<xs:documentation>
A reference to a previously defined NCube scheme either internal to or external to the DDI instance.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- CATEGORIES -->
<xs:complexType name="CategorySchemeType">
<xs:annotation>
<xs:documentation>
A scheme containing a set of Categories managed by an agency. These are used to manage category definitions used as a domain for data element and basic content for a category delineation. In addition to the name, label, and description of the scheme, the structure supports the inclusion of another CategoryScheme by reference, a set of Category descriptions either in-line or by reference, and the description of a CategoryGroup either in-line or by reference.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:MaintainableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CategorySchemeName">
<xs:annotation>
<xs:documentation>
A name for the scheme. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
A display label for the scheme. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and purpose of the scheme. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:CategorySchemeReference">
<xs:annotation>
<xs:documentation>
Allows for inclusion by reference of other category schemes.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CategoryGroup">
<xs:annotation>
<xs:documentation>
Allows categories to be grouped with or without hierarchical structure,
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Category">
<xs:annotation>
<xs:documentation>
A description of a particular category or response. OECD Glossary of Statistical Terms: Generic term for items at any level within a classification, typically tabulation categories, sections, subsections, divisions, subdivisions, groups, subgroups, classes and subclasses.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="CategorySchemeName" type="r:NameType">
<xs:annotation>
<xs:documentation>
Name of the Category Scheme using the DDI Name structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="CategoryGroupType">
<xs:annotation>
<xs:documentation>
Contains a group of Category descriptions, which may be ordered or hierarchical. In addition to the name, label, and description of the group, the structure allows for defining the group as a valid category value using a DefiningCategoryReference, and a listing of Categories and CategoryGroups in any order.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:VersionableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CategoryGroupName">
<xs:annotation>
<xs:documentation>
A name for the group. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
A display label for the delineation group. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and purpose of the CategoryDelineationGroup. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="DefiningCategoryReference">
<xs:annotation>
<xs:documentation>
A reference to a category that defines the group, thereby allowing the group to define the contents of that category by explicitly identifying its members.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Category">
<xs:annotation>
<xs:documentation>A category defined as a member of this group.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CategoryGroup">
<xs:annotation>
<xs:documentation>
A category group that is a member of this group (nesting structure).
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:sequence>
<xs:attribute default="false" name="isOrdered" type="xs:boolean">
<xs:annotation>
<xs:documentation>
If set to "true" indicates that the content of the group is ordered as it appears within the XML structure.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="DefiningCategoryReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>
Reference to an existing Category using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="CategoryGroupName" type="r:NameType">
<xs:annotation>
<xs:documentation>
Name of the Category Group using the DDI Name structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="CategoryType">
<xs:annotation>
<xs:documentation>
A description of a particular category or response. OECD Glossary of Statistical Terms: Generic term for items at any level within a classification, typically tabulation categories, sections, subsections, divisions, subdivisions, groups, subgroups, classes and subclasses. In addition to the standard name, label, and description, a category may contain a reference to a defining concept, provide information on how the category was generated (membership defined), and indicate if it is the description of a type of missing value.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:VersionableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CategoryName">
<xs:annotation>
<xs:documentation>
A name for the category. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
A display label for the category. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations or of different types or applications.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and purpose of the category. May be expressed in multiple languages and supports the use of structured content. Note that comparison of categories is done using the content of description.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:ConceptReference">
<xs:annotation>
<xs:documentation>Reference to the defining concept.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="Generation">
<xs:annotation>
<xs:documentation>
Describes how the category is derived or generated. A process for describing the determination of category membership.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="isMissing" type="xs:boolean" use="optional">
<xs:annotation>
<xs:documentation>
If the category is describing a classification of "missing data" set the value of isMissing to "true".
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="CategoryName" type="r:NameType">
<xs:annotation>
<xs:documentation>
Name of the Category using the DDI Name structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<!-- CodeLists -->
<xs:element name="CodeListScheme" type="CodeListSchemeType">
<xs:annotation>
<xs:documentation>
A scheme containing sets of CodeLists that are used by reference to define code delineations used by value representations and response domains.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="CodeListSchemeType">
<xs:annotation>
<xs:documentation>
A scheme containing sets of CodeLists that are used by reference to define code delineations used by value representations and response domains. In addition to the standard name, label, description, the CodeListScheme may contain another CodeListScheme by reference, CodeLists either in-line or by reference, and CodeListGroups either in-line or by reference.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:MaintainableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CodeListSchemeName">
<xs:annotation>
<xs:documentation>
A name for the CodeListScheme. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
A display label for the CodeListScheme. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and purpose of the CodeListScheme. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:CodeListSchemeReference">
<xs:annotation>
<xs:documentation>
Allows for the inclusion of another CodeListScheme by reference.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="CodeList">
<xs:annotation>
<xs:documentation>
A structure used to associate a list of code values to specified categories. May be flat or hierarchical. A maintainable CodeList listed in the CodeListScheme in-line.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="r:CodeListReference">
<xs:annotation>
<xs:documentation>
A reference to an existing CodeList to be added to this CodeListScheme by reference.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="CodeListGroup">
<xs:annotation>
<xs:documentation>
In-line description of a group of CodeLists for conceptual, administrative or other purposes.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="CodeListGroupReference">
<xs:annotation>
<xs:documentation>
The inclusion of an existing CodeListGroup by reference.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="CodeListSchemeName" type="r:NameType">
<xs:annotation>
<xs:documentation>
Name of the Code List Scheme using the DDI Name structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:annotation>
<xs:documentation>ORPHAN</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="CodeListReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>ORPHAN</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="CodeListGroupReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>
Reference to an existing CodeListGroup using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="CodeListType">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:MaintainableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CodeListName">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and purpose of the CodeList. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:RecommendedDataType">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:CodeListReference">
<xs:annotation>
<xs:documentation>
Allows for inclusion by reference of another CodeList. Care must be taken to ensure that all code values of the resulting CodeList are unique.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:CategorySchemeReference">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="HierarchyType">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Level">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Code">
<xs:annotation>
<xs:documentation>
Includes a code value, references the category label, and describes the code's position in a hierarchy.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute default="false" name="isSystemMissingValue" type="xs:boolean">
<xs:annotation>
<xs:documentation>
If "true" contents are used to represent system specific missing values. The default value is "false".
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="CodeListName" type="r:NameType">
<xs:annotation>
<xs:documentation>
Name of the Code List using the DDI Name structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="LevelType">
<xs:annotation>
<xs:documentation>
Used to describe the levels of the code list hierarchy. The level describes the nesting structure of a hierarchical coding structure. A level could have data attached to it (summary of its children) or no data attached to it (the equivalent of creating a category group in 2.0 and earlier versions Note that the attribute levelNumber is used for referencing specific codes to their level identifier. Although Code Lists can be physically nested, the use of a Level description and the level number on a specific code is needed to specify subsets of the CodeList for use in CodeDelineations by level specification. Provides a name, description and level number. Specifies the relationship between the categories at that level and interval value if the relationship has the value of Interval.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="LevelName">
<xs:annotation>
<xs:documentation>
Name of a level in a code scheme. This should be short and explicit, such as Major Industrial Groups (2 digit SIC Codes) or NUTS 1. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the code Level. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="CategoryRelationship">
<xs:annotation>
<xs:documentation>
Describes the relationships among categories at that respective level. Possible values are either Nominal, Ordinal, or Interval. Note that different levels may have different types of relationships within the same hierarchy. For example, Level 1 items may be ordinal and Level 2 (the children of Level 1 items) may be nominal.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="Interval">
<xs:annotation>
<xs:documentation>
Identifies the interval between each value of the codes at this level. Used only for codes with interval relationship.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="levelNumber" type="xs:integer" use="required">
<xs:annotation>
<xs:documentation>
Designated identifier for the level; generally increases as the level of indention for nesting increases.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="CodeType">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:IdentifiableType">
<xs:sequence>
<xs:element ref="r:CategoryReference">
<xs:annotation>
<xs:documentation>
Reference to the category that the code value represents.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="r:Value">
<xs:annotation>
<xs:documentation>
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 understnading 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".
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Code">
<xs:annotation>
<xs:documentation>Allows for nesting of codes.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute default="true" name="isDiscrete" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Indicates whether the code is discrete (that is, placed at the lowest level in a hierarchy and has no children).
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="levelNumber" type="xs:integer" use="optional">
<xs:annotation>
<xs:documentation>Level number of the code.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute default="Unknown" name="isComprehensive" type="IsComprehensiveType">
<xs:annotation>
<xs:documentation>
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".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute default="false" name="isTotal" type="xs:boolean">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="IntervalType">
<xs:annotation>
<xs:documentation>
Describes the structure, starting point and increment step of an interval.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="Anchor" type="xs:string">
<xs:annotation>
<xs:documentation>Identifies the start value for this interval.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Increment" type="xs:string">
<xs:annotation>
<xs:documentation>
Value specifying the increment between categories.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="CodeListGroup" type="CodeListGroupType">
<xs:annotation>
<xs:documentation>
A grouping of CodeLists for conceptual or administrative purposed.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="CodeListGroupType">
<xs:annotation>
<xs:documentation>
A grouping of CodeLists for conceptual or administrative purposed. May be hierarchical.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:VersionableType">
<xs:sequence>
<xs:element minOccurs="0" ref="TypeOfCodeListGroup">
<xs:annotation>
<xs:documentation>
A brief textual identification of the group type. Supports the use of an external controlled vocabulary.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CodeListGroupName">
<xs:annotation>
<xs:documentation>
A name for the CodeListGroup. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
A display label for the delineation group. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and purpose of the CodeDelineationGroup. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:UniverseReference">
<xs:annotation>
<xs:documentation>
Reference to the universe statement describing the persons or other objects to which the contents of this CodeList group pertain.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:ConceptReference">
<xs:annotation>
<xs:documentation>
Reference to the concept expressed by the CodeLists in this group.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="r:CodeListReference">
<xs:annotation>
<xs:documentation>Reference to constituent CodeList.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="CodeListGroupReference">
<xs:annotation>
<xs:documentation>
Reference to constituent CodeListGroup. This allows for nesting of CodeListGroups.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:sequence>
<xs:attribute default="false" name="isOrdered" type="xs:boolean">
<xs:annotation>
<xs:documentation>
If set to "true" indicates that the content of the group is ordered as it appears within the XML structure.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="CodeListGroupName" type="r:NameType">
<xs:annotation>
<xs:documentation>
Name of the Code List Group using the DDI Name structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TypeOfCodeListGroup" type="r:CodeValueType">
<xs:annotation>
<xs:documentation>
A brief textual description of the type of group created to associate a number of code lists. Supports the use of an external controlled vocabulary.
</xs:documentation>
</xs:annotation>
</xs:element>
<!-- VARIABLES -->
<xs:complexType name="VariableSchemeType">
<xs:annotation>
<xs:documentation>
Contains a set of Variables and VariableGroups. In addition to the standard name, label, and description of the Variable Scheme, may contain another VariableScheme by reference, a listing of Variables (in-line or by reference), and a listing of VariableGroups (in-line or by reference).
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:MaintainableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="VariableSchemeName">
<xs:annotation>
<xs:documentation>
A name for the VariableScheme. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
A display label for the scheme. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and purpose of the VariableScheme. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:VariableSchemeReference">
<xs:annotation>
<xs:documentation>
Allows for the inclusion of another VariableScheme by reference.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="Variable">
<xs:annotation>
<xs:documentation>
Describes a Variable in-line. This is the applied expression of a data item within a data set.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="r:VariableReference">
<xs:annotation>
<xs:documentation>
Allows for the inclusion of an existing variable by reference.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="VariableGroup">
<xs:annotation>
<xs:documentation>
Contains a group of Variables, which may be ordered or hierarchical.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="VariableGroupReference">
<xs:annotation>
<xs:documentation>
Allows the inclusion of an existing VariableGroup by reference.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="VariableSchemeName" type="r:NameType">
<xs:annotation>
<xs:documentation>
Name of the Variable Scheme using the DDI Name structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="VariableType">
<xs:annotation>
<xs:documentation>
Describes the structure of a Variable. This is the applied expression of a data item within a data set. In addition to the standard name, label, and description, includes a reference to a source parameter, DataElement, universe, concept, question, and embargo information. It identifies the normal source of the data in the variable, the unit of analysis, whether the variable provides temporal or geographic information, or serves as a weight for other variables in the data, and provides a full description of its representation.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:VersionableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="VariableName">
<xs:annotation>
<xs:documentation>
A name for the Variable. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
A display label for the Variable. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and purpose of the Variable. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:SourceParameterReference">
<xs:annotation>
<xs:documentation>
Reference to an OutParameter that serves as the source for the content of this variable.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" ref="DataElementReference">
<xs:annotation>
<xs:documentation>
Reference to the DataElement that describes the core of this variable (the data element that the variable is the applied expression of).
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:UniverseReference">
<xs:annotation>
<xs:documentation>
Reference to the universe statement containing a description of the persons or other elements that this variable refers to, and to which any analytic results refer. If more than one universe is referenced the universe of the variable is the intersect of the referenced universes.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:ConceptReference">
<xs:annotation>
<xs:documentation>
Reference to the concept measured by this variable.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:QuestionReference">
<xs:annotation>
<xs:documentation>
Reference to question(s) used to collect data for this variable. This references the wording and response domain of the question, not the question flow (if the same question was asked in reference to multiple objects (i.e., Age of each child). Use SourceParameterReference and/or VariableRepresentation/ProcessingInstructionReference to differentiate sources associated with flow patterns or data processing instructions.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="EmbargoReference">
<xs:annotation>
<xs:documentation>
Reference to any embargos placed on the contents of this variable. Embargos may limit access to the data and/or metadata to specific groups and/or for specified periods of time.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="SourceUnit">
<xs:annotation>
<xs:documentation>
The normal source of the information contained in the variable. In the case of a survey this may be a respondent, proxy, interviewer, or other source. In the case of administrative data the position of a field on a form e.g., "top of page", "item 3", "generated by data processor", etc. Supports the use of an external controlled vocabulary.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:AnalysisUnit">
<xs:annotation>
<xs:documentation>
The entity to which the data refer, for example, individuals, families or households, groups, institutions/organizations, administrative units, etc. Supports the use of an external controlled vocabulary.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="VariableRepresentation">
<xs:annotation>
<xs:documentation>
Describes the representation of the variable in the data set, including allowed content, data typing, and computation information.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute default="false" name="isTemporal" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Set to "true" if the variable relays time-related information (date, time, season, relative time, etc.).
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute default="false" name="isGeographic" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Set to "true" if the variable relays geographic information, i.e., geographic code, area name, relative location, etc.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute default="false" name="isWeight" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Set to "true" if the variable is used a weight when analyzing data within the data set.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="VariableName" type="r:NameType">
<xs:annotation>
<xs:documentation>
Name of the Variable using the DDI Name structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="SourceUnit" type="r:CodeValueType">
<xs:annotation>
<xs:documentation>
The normal source of the information contained in the variable. In the case of a survey this may be a respondent, proxy, interviewer, or other source. In the case of administrative data the position of a field on a form e.g., "top of page", "item 3", "generated by data processor", etc. Supports the use of an external controlled vocabulary.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="VariableRepresentationType">
<xs:annotation>
<xs:documentation>
Describes the representation of the variable in the data set. Describes the function of the variable, variables or standard weights that may be used to weight this variable during analysis, imputation and processing information, other variables used to create the value of this variable through concatenation, valid value representations (valid for analysis of respondents), missing value representations, aggregation methods used to generate the content of the variable, and additivity information.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" ref="VariableRole">
<xs:annotation>
<xs:documentation>
Describes a specific function of the variable, such as identity, weight, geographic variable, time, date, currency, etc. This is a more extensive means of identifying the function of the variable than the Boolean indicators on the variable. Allows for agency specific designations. Supports the use of a controlled vocabulary.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:WeightVariableReference">
<xs:annotation>
<xs:documentation>
Reference to one or more weight variables that may be used in analyzing this variable.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="StandardWeightReference">
<xs:annotation>
<xs:documentation>
Reference to the StandardWeight found in the Weighting description, which is relevant for analyzing this variable. A standard weight is a single weight used for all variables of a specific type or for a specified sub-universe.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="ImputationReference">
<xs:annotation>
<xs:documentation>
Reference to the imputation process described as a General Instruction in a ProcessingInstructionScheme.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="ConcatenatedValue">
<xs:annotation>
<xs:documentation>
Provides a reference to other variables and describes the method for deriving the value of this variable by concatenating a collection of other variables. This is useful in creating concatenated keys.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:ProcessingInstructionReference">
<xs:annotation>
<xs:documentation>
A reference to either a general or generation instruction that was provided to those who converted information from one form to another to create a particular variable. This might include the reordering of numeric information into another form or the conversion of textual information into numeric information.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:ValueRepresentation">
<xs:annotation>
<xs:documentation>
Describes the actual representation of the variables' values. Delineate the values defined as missing in a separate MissingValuesDelineation and reference from MissingValuesReference.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="MissingValuesReference">
<xs:annotation>
<xs:documentation>
Reference to a delineation of the values defined as "missing" for this variable.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="MeasurementUnit">
<xs:annotation>
<xs:documentation>
Records the measurement unit, for example, 'km', 'miles', etc. Supports the use of a controlled vocabulary.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:AggregationMethod">
<xs:annotation>
<xs:documentation>
Indicates the type of aggregation method used. Supports the use of a controlled vocabulary.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="additivity" type="AdditivityCodeType" use="optional">
<xs:annotation>
<xs:documentation>
Records type of additivity, such as 'stock', 'flow', 'non-additive'.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:element name="MeasurementUnit" type="r:CodeValueType">
<xs:annotation>
<xs:documentation>
Records the measurement unit, for example, 'km', 'miles', etc. Supports the use of a controlled vocabulary.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="MissingValuesReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>
Reference to an existing MissingValuesDelineation using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="ConcatenatedValueType">
<xs:annotation>
<xs:documentation>
Lists the variables whose values when concatenated result in the value for this variable.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="2" ref="r:VariableReference">
<xs:annotation>
<xs:documentation>
Identifies the variables whose values are concatenated to form the concatenated variable. Note that the order of these variables determines the order of concatenation.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="GenerationType">
<xs:annotation>
<xs:documentation>
Description of the process used to generate the category content. Includes a reference to component parts, a description of the generation process, a structured command, and other materials that are needed in the generation process. The item may be designated as a derivation process (default value) and be qualified in some way by a qualification attribute.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="ComponentReference">
<xs:annotation>
<xs:documentation>
Reference to a category used in the generation process.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the generation process. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:CommandCode">
<xs:annotation>
<xs:documentation>
Structured information used by a system to generate the category.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:OtherMaterial">
<xs:annotation>
<xs:documentation>
External documentation required for creating the generation - for example, a chart or table for defining poverty.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute default="true" name="isDerived" type="xs:boolean">
<xs:annotation>
<xs:documentation>
If not a derivation process set this attribute to "false".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute default="optional" name="qualification" type="xs:string">
<xs:annotation>
<xs:documentation>
A qualification for the generation process expressed as a simple string.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="VariableGroupType">
<xs:annotation>
<xs:documentation>
Contains a group of Variables, which may be ordered or hierarchical. In addition to the name, label, and description of the group, the structure allows for defining the type of group using an optional controlled vocabulary, a reference to a defining universe or concept for the group, a subject classification for the group, and a listing of Variables and VariableGroups in any order.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:VersionableType">
<xs:sequence>
<xs:element minOccurs="0" ref="TypeOfGroup">
<xs:annotation>
<xs:documentation>
A brief textual identification of the group type. Supports the use of an external controlled vocabulary.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="VariableGroupName">
<xs:annotation>
<xs:documentation>
A name for the group. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
A display label for the variable group. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and purpose of the VariableGroup. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:UniverseReference">
<xs:annotation>
<xs:documentation>
Reference to the universe statement describing the persons or other objects to which the contents of this variable group pertain.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:ConceptReference">
<xs:annotation>
<xs:documentation>
Reference to the concept expressed by the Variables in this group.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Subject">
<xs:annotation>
<xs:documentation>
If subjects are listed for this group, it is strongly recommended that the subjects listed also be found in the TopicalCoverage element for the parent packaging element when this group is included directly or by reference in a module containing a coverage element. Use of subject at the group level allows for associating objects as a type of subject based group or to identify subject characteristics of a reusable group of objects.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="r:VariableReference">
<xs:annotation>
<xs:documentation>Reference to constituent Variable.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="VariableGroupReference">
<xs:annotation>
<xs:documentation>
Reference to constituent VariableGroup. This allows for nesting of VariableGroups.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:sequence>
<xs:attribute default="false" name="isOrdered" type="xs:boolean">
<xs:annotation>
<xs:documentation>
If set to "true" indicates that the content of the group is ordered as it appears within the XML structure.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="VariableGroupName" type="r:NameType">
<xs:annotation>
<xs:documentation>
Name of the Variable Group using the DDI Name structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<!-- nCUBES -->
<xs:complexType name="NCubeSchemeType">
<xs:annotation>
<xs:documentation>
A set of NCubes maintained by an agency and used to structure data items into relational structures. In addition to the standard name, label, and description of the scheme, contains descriptions of individual NCubes and NCubeGroups as well as allowing the inclusion of another NCubeScheme by reference.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:MaintainableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="NCubeSchemeName">
<xs:annotation>
<xs:documentation>
A name for the NCubeScheme. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
A display label for the NCubeScheme. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and purpose of the NCubeScheme. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="NCube">
<xs:annotation>
<xs:documentation>
Describes the logical structure of an NCube which is a 1..n dimension structure which relates a set of individual value to each other by defining them within a matrix.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="NCubeGroup">
<xs:annotation>
<xs:documentation>
Describes a group of NCubes for conceptual or administrative purposes, which may be ordered or hierarchical.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:NCubeSchemeReference">
<xs:annotation>
<xs:documentation>
Allows for inclusion of other NCube schemes by reference.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="NCubeSchemeName" type="r:NameType">
<xs:annotation>
<xs:documentation>
Name of the NCube Scheme using the DDI Name structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="AttributeType">
<xs:annotation>
<xs:documentation>
An attribute may be any object which should be attached to all or part of the NCube. It may be defined as a Variable or contain textual content (such as a footnote).
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:IdentifiableType">
<xs:sequence>
<xs:choice>
<xs:element ref="r:VariableReference">
<xs:annotation>
<xs:documentation>
A reference to a variable that describes the attribute.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AttachmentValue" type="xs:string">
<xs:annotation>
<xs:documentation>
The value of the attachment expressed as a string, if not a variable.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:element minOccurs="0" ref="AttachmentGroupReference">
<xs:annotation>
<xs:documentation>
Reference to the CoordinateGroup that defines the attachment point for the attribute.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:MeasureDefinitionReference">
<xs:annotation>
<xs:documentation>
Reference to the MeasureDefinition that the attribute is attached to.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Value">
<xs:annotation>
<xs:documentation>
Reference to the specified Value of the MeasureDefinition that the attribute is attached to.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute default="Cube" name="attachmentLevel" type="AttachmentLevelCodeType">
<xs:annotation>
<xs:documentation>
Describes the attachment level of the attribute as Cube, CoordinateGroup, Dimension, Measurement, or MeasurementValue.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="NCubeType">
<xs:annotation>
<xs:documentation>
An NCube is a 1..n dimension structure which relates a set of individual values to each other by defining them within a matrix. The NCube may be the result of aggregations, cross-tabulation, time-series, etc. The NCube is described by its dimensions which are represented by categorical variables (variables with a set number of values of specific definition that can be used to identify a specific cell as part of a matrix address). The resulting cells can contain one or more measures, also defined by variables. In addition to the standard name, label, and description of the NCube, it contains a reference to a universe, defines both the normal source of the data in the cells and unit of analysis, the purpose of creating the structured data, the dimensions and measures, as well as the ability to attached any other attribute (i.e., footnote, cell or region specific note) to a specified area of the NCube. Three attribute serve as informational check values; dimensionCount, cellCount, and isClean.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:VersionableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="NCubeName">
<xs:annotation>
<xs:documentation>
A name for the NCube. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
A display label for the NCube. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and structure of the NCube. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:UniverseReference">
<xs:annotation>
<xs:documentation>
Reference to an imputation process described as a GeneralInstruction or GenerationInstruction held in a ProcessingInstructionScheme.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="ImputationReference">
<xs:annotation>
<xs:documentation>
The normal source of the information contained in the NCube. In the case of a survey this may be a respondent, proxy, interviewer, or other source. In the case of administrative data the position of a field on a form e.g., "top of page", "item 3", "generated by data processor", etc.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="SourceUnit">
<xs:annotation>
<xs:documentation>
The normal source of the information contained in the NCube. In the case of a survey this may be a respondent, proxy, interviewer, or other source. In the case of administrative data the position of a field on a form e.g., "top of page", "item 3", "generated by data processor", etc. Supports the use of an external controlled vocabulary.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:AnalysisUnit">
<xs:annotation>
<xs:documentation>
The entity to which the data refer, for example, individuals, families or households, groups, institutions/organizations, administrative units, etc. Supports the use of an external controlled vocabulary.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Purpose">
<xs:annotation>
<xs:documentation>
Purpose for which the NCube was created. For example, designed to support a set of age pyramids generated yearly.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Dimension">
<xs:annotation>
<xs:documentation>
NCubes are defined by their dimensions. A dimension is provided a rank and a reference to a variable that describes it. Cell locations are "addressed" by the value of their intersect on each dimension provided in rank order.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CoordinateGroup">
<xs:annotation>
<xs:documentation>
Defines the area of attachment for an attribute. It may be defined as the NCube as a whole or as certain dimensions or values of dimensions.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="MeasureDefinition">
<xs:annotation>
<xs:documentation>
Defines the structure and type of measure captured within the cells. This may be repeated to describe multiple measure for the cells (i.e., count, percent of universe, dimensional percent, index, text, suppression flag, etc.).
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Attribute">
<xs:annotation>
<xs:documentation>
An attribute may be any object which should be attached to all or part of the NCube. It may be defined as a Variable or contain textual content (such as a footnote).
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="dimensionCount" type="xs:integer" use="optional">
<xs:annotation>
<xs:documentation>
The number of dimensions found in the NCube. Caution in using optional checksums is recommended. Conflict between checksums and the items being counted can cause problems with warning flags during processing. If using checksum to capture information for internal processing purposes, the use of automatically generated check sums is strongly urged.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cellCount" type="xs:integer" use="optional">
<xs:annotation>
<xs:documentation>
The number of cells (measures) found in the NCube. Note that this is the number of cells produced by dimension structure not the number of cells containing data in a sparse NCube. Caution in using optional checksums is recommended. Conflict between checksums and the items being counted can cause problems with warning flags during processing. If using checksum to capture information for internal processing purposes, the use of automatically generated check sums is strongly urged.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute default="true" name="isClean" type="xs:boolean">
<xs:annotation>
<xs:documentation>
A value of "true" indicates that all cells have the potential for content values. If set to "false" Attribute and CoordinateGroup should be used to define the sparse areas of the NCube, those that have no content by definition. For example a cross-tabulation between Household Type (Family, Non-Family) and Number of persons in Household (1,2,3,4,5,6,7+) would need an attribute for Family/1 Person as this will always be empty due to the definition of Family as two or more related persons.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="NCubeName" type="r:NameType">
<xs:annotation>
<xs:documentation>Name of the NCube using the DDI Name structure.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="DataRelationshipType">
<xs:annotation>
<xs:documentation>
Describes the relationships among logical records in the dataset. Date Relationship is needed to create the appropriate link between the logical record and the physical storage description. Data Relationship is optional because a logical product can contain only a category scheme and/or code scheme. In addition to the standard name, label, and description, it contains structures to describe the LogicalRecord and RecordRelationship.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:VersionableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="DataRelationshipName">
<xs:annotation>
<xs:documentation>
A name for the DataRelationship. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
A display label for the DataRelationship. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and purpose of the DataRelationship. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="LogicalRecord">
<xs:annotation>
<xs:documentation>
A logical record is a description of all of the elements (variables or NCubes) related to a single case or analysis unit. Required to link a description of a physical record structure to its logical record.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="RecordRelationship">
<xs:annotation>
<xs:documentation>
Describes the relationship between records of different types or of the same type within a longitudinal study. Identifies the key and linking value relationships. All relationships are pairwise. Multiple pairwise relationships maybe needed to clarify all record relationships within a logical product or data set.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="DataRelationshipName" type="r:NameType">
<xs:annotation>
<xs:documentation>
Name of the Data Relationship using the DDI Name structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="LogicalRecordType">
<xs:annotation>
<xs:documentation>
A logical record is a description of all of the elements (variables or NCubes) related to a single case or analysis unit. Required to link a description of a physical record structure to its logical record. In addition to the standard name, label, and description, the structure identifies the variable designating its record type, describes case identification within the record type, indicates support for multiple storage segments, and defines a default set of missing values used by the record. In a data set with multiple records repeat to describe each logical record, such as a household, family, person, or event, record. A LogicalRecord is required to link a description of a physical record structure to its logical record.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:IdentifiableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="LogicalRecordName">
<xs:annotation>
<xs:documentation>
A name for the LogicalRecord. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
A display label for the LogicalRecord. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and purpose of the LogicalRecord. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="VariableValueReference">
<xs:annotation>
<xs:documentation>
A reference the variable containing the record type locator and the value being used. Files with single record types or which store records in different files may not have a record type locator. If this element is used set the attribute hasLocator to "true".
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="SupportForMultipleSegments">
<xs:annotation>
<xs:documentation>
Information concerning support for breaking the logical record into segments for storage purposes. Some files may be broken into record segments for storage but lack variables to support identification of specific segments. In this case segments are identified by their physical order within the storage file.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CaseIdentification">
<xs:annotation>
<xs:documentation>
Describes the information needed to identify an individual case within a record type. This may be the variable or concatenated variable used to identify a unique case of a particular record type. Often referred to as a unique key. There may be more than one means of identifying a record. For example a US Census Summary File has a LogicalRecordIdentifer that is unique to the original file within which it was published. A specific geography has a set of fields that uniquely identify it.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice minOccurs="0">
<xs:element ref="VariablesInRecord">
<xs:annotation>
<xs:documentation>
List of all variables used in the record, either directly or as found in a defined VariableGroup; note that a variable can be used in multiple records. The variables in the logical record can be noted by inclusion or exclusion to facilitate listing. The attribute allVariablesInLogicalProduct, when set to 'true', includes all variables in the LogicalProduct. VariableSchemeReference can then be used to exclude individual Variables schemes or include schemes from other logical products. In the same way VariableReference can be used to exclude specific variables from the previously defined variable set or include variables not already included. The simplest LogicalProduct descriptions with a single LogicalRecord can be described using only the attribute allVariablesInLogicalProduct with a value of true.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="NCubesInRecord">
<xs:annotation>
<xs:documentation>
List of all NCubes used in the record, either directly or as found in a defined NCubeGroup; note that an NCube can be used in multiple records. The NCubes in the logical record can be noted by inclusion or exclusion to facilitate listing. The attribute allNCubesInLogicalProduct, when set to 'true', includes all NCubes in the LogicalProduct. NCubeSchemeReference can then be used to exclude individual NCubes schemes or include schemes from other logical products. In the same way NCubeReference can be used to exclude specific variables from the previously defined variable set or include variables not already included. The simplest LogicalProduct descriptions with a single LogicalRecord can be described using only the attribute allNCubesInLogicalProduct with a value of true.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:element minOccurs="0" ref="DefaultMissingValues">
<xs:annotation>
<xs:documentation>
Identifies the default missing value parameter for the this logical record by referencing a MissingValuesDelineation or by stating that there is a default missing values parameter used but it is undocumented. Note that a conflicting DefaultMissingValues definition in a PhysicalInstance will override that found in the LogicalRecord.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="hasLocator" type="xs:boolean" use="optional">
<xs:annotation>
<xs:documentation>
If "true" indicates that the record type has a field which identifies its record type. In logical structures with a single record type there is generally no identifier. Most multi-record files will have a variable that identifies the record type.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="variableQuantity" type="xs:integer" use="optional">
<xs:annotation>
<xs:documentation>
Number of variables in the logical record. Caution in using optional checksums is recommended. Conflict between checksums and the items being counted can cause problems with warning flags during processing. If using checksum to capture information for internal processing purposes, the use of automatically generated check sums is strongly urged.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="LogicalRecordName" type="r:NameType">
<xs:annotation>
<xs:documentation>
Name of the Logical Record using the DDI Name structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="NCubesInRecordType">
<xs:annotation>
<xs:documentation>
Identifies the NCubes and any variables in the record external to NCube structures such as case identification variables that are contained in the logical record by indicating that all NCubes contained in the logical product are included, inclusion of a NCubeScheme to include, or listing individual NCubes to include. When the attribute allNCubesInLogicalProduct is set to "false" use the NCubeSchemeReference (which allows for exclusions) and NCubeReference to specify the included variables. A nested VariablesInRecord structure is used to include non-NCube variables in the record.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" ref="VariablesInRecord">
<xs:annotation>
<xs:documentation>
Use VariablesInRecord to describe any variables in the record that are external to the NCube such as case identifiers.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:NCubeSchemeReference">
<xs:annotation>
<xs:documentation>
Reference to an NCubeScheme whose members are included in the logical record. Note that individual items may be excluded from the scheme if not used by the logical record.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:NCubeReference">
<xs:annotation>
<xs:documentation>
Reference to an NCube to include in the logical record. This may be used to supplement the contents of an included NCubeScheme or to list all the variables individually.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="allNCubesInLogicalProduct" type="xs:boolean" use="optional">
<xs:annotation>
<xs:documentation>
When the value is true, then the logical record contains all listed NCubes in the logical product module.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="VariableValueReferenceType">
<xs:annotation>
<xs:documentation>
A reference to the variable containing the record type locator and the value being used.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element ref="r:VariableReference">
<xs:annotation>
<xs:documentation>
Reference to the variable containing the record type locator.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="RelatedValue">
<xs:annotation>
<xs:documentation>
Value of variable indicating this record type, multiple entries allow for multiple valid values or ranges. Indicates if the variable should be equal to, greater than, less than, greater than or equal to, less than or equal to, or not equal to the stated value.(default value is "Equal"). Also allows the conditional value to be defined as blank (or no content).
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="VariablesInRecordType">
<xs:annotation>
<xs:documentation>
Identifies the variables contained in the logical record by indicating that all variable contained in the logical product are included, inclusion of a scheme of variable to include, or listing individual variables to include. When the attribute allVariablesInLogicalProduct is set to "false" use the VariableSchemeReference (which allows for exclusions) and VariableUsedReference to specify the included variables.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:VariableSchemeReference">
<xs:annotation>
<xs:documentation>
Reference to a VariableScheme whose members are included in the logical record. Note that individual items may be excluded from the scheme if not used by the logical record.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="VariableUsedReference">
<xs:annotation>
<xs:documentation>
Reference to a variable to include in the logical record. This may be used to supplement the contents of an included VariableScheme or to list all the variables individually.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="allVariablesInLogicalProduct" type="xs:boolean" use="optional">
<xs:annotation>
<xs:documentation>
Set to "true" when the logical record contains all the variables identified within the logical product module.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="CaseIdentificationType">
<xs:annotation>
<xs:documentation>
Describes the information needed to identify an individual case within a record type. This may be the variable or concatenated variable used to identify a unique case of a particular record type. Often referred to as a unique key. There may be more than one means of identifying a record. For example a US Census Summary File has a LogicalRecordIdentifer that is unique to the original file within which it was published. A specific geography has a set of fields that uniquely identify it.
</xs:documentation>
</xs:annotation>
<xs:choice minOccurs="0">
<xs:element ref="FixedIdentifier">
<xs:annotation>
<xs:documentation>
Reference to the variable containing the unique identifier. This may be a concatenated variable which indicates the combination of variable required to create a unique identification. If more than one variable reference is included the combination of the variable field contents must be unique and all variables are required for case identification.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="ConditionalIdentifier">
<xs:annotation>
<xs:documentation>
Describes the information needed to identify a specific record or case within a record type. Repeating the field allows multiple means of identifying a case referencing multiple variables.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:attribute default="true" name="isPrimary" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Indicates whether the case identifier is the primary key.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:element name="FixedIdentifier" type="FixedIdentifierType">
<xs:annotation>
<xs:documentation>
Reference to the variable containing the unique identifier.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="FixedIdentifierType">
<xs:annotation>
<xs:documentation>
Reference to the variable containing the unique identifier. This may be a concatenated variable which indicates the combination of variable required to create a unique identification. If more than one variable reference is included the combination of the variable field contents must be unique and all variables are required for case identification.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:VariableReference">
<xs:annotation>
<xs:documentation>
Reference to a variable used as a fixed identifier either singly or in combination with additional reference variables.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:annotation>
<xs:documentation>
Reference to the variable containing the unique identifier given the conditional value.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="ConditionalIdentifierType">
<xs:annotation>
<xs:documentation>
Describes the information needed to identify a specific record or case within a record type. Repeating the field allows multiple means of identifying a case referencing multiple variables.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="CaseSpecification">
<xs:annotation>
<xs:documentation>
Case specification allows different unique identifiers to be used based on the value of an identified variable. In some cases the value of a variable (such as a geographic level) results in a different set of variables required to identify a unique case. Case specification is used to capture these combinations. For example: a file containing State, County, and Place records. The unique identifier for a State requires a combination of GeoLevel=State and the variable STATE. Place would require a combination of GeoLevel=Place and the variables STATE and PLACE.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="CaseSpecificationType">
<xs:annotation>
<xs:documentation>
Case specification allows different unique identifiers to be used based on the value of an identified variable. In some cases the value of a variable (such as a geographic level) results in a different set of variables required to identify a unique case. Case specification is used to capture these combinations. For example: a file containing State, County, and Place records. The unique identifier for a State requires a combination of GeoLevel=State and the variable STATE. Place would require a combination of GeoLevel=Place and the variables STATE and PLACE.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element ref="ConditionalVariableReference">
<xs:annotation>
<xs:documentation>
References the variable containing the conditional content, provides the value of the condition.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="1" ref="r:VariableReference">
<xs:annotation>
<xs:documentation>
The variables required to provide a unique identification when the conditional variable contains the stated value.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:annotation>
<xs:documentation>Value of variable indicating this record type.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="ConditionalVariableReferenceType">
<xs:annotation>
<xs:documentation>
Value of variable indicating this record type, multiple entries allow for multiple valid values or ranges. Includes a reference to the variable an the specified related value.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:ReferenceType">
<xs:sequence>
<xs:element ref="RelatedValue">
<xs:annotation>
<xs:documentation>
Use to specify the value of variable for which this is a case specification (i.e., GeoLevel in the example for Case Specification).
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="RecordRelationshipType">
<xs:annotation>
<xs:documentation>
Describes the relationship between records of different types or of the same type within a longitudinal study. Identifies the key and linking value relationships. All relationships are pairwise. Multiple pairwise relationships maybe needed to clarify all record relationships within a logical product or data set. In addition to the standard name, label, and description, the structure identifies the pair of logical records for which the relationship is defined as SourceLogicalRecord and TargetLogicalRecord, describes the link between these two records and indicates the relationship of the of the source record to the target record.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:IdentifiableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="RecordRelationshipName">
<xs:annotation>
<xs:documentation>
A name for the RecordRelationship. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
A display label for the RecordRelationship. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and purpose of the RecordRelationship. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="SourceLogicalRecordReference">
<xs:annotation>
<xs:documentation>
A reference to the Logical Record acting as the Source Record. All relationship information is from the source to the target. If the relationship is not unidirectional (i.e., sibling) simply assign one record as the source and the other as the target.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="TargetLogicalRecordReference">
<xs:annotation>
<xs:documentation>
A reference to the Logical Record acting as the Target Record.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="SourceTargetLink">
<xs:annotation>
<xs:documentation>
Each SourceTargetLink provides a pair of variables which act as all or part of a link between the source and the target records. Repeat if more than one set of variables is required to make the link.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute default="Unknown" name="relationToTarget" type="RelationCodeType">
<xs:annotation>
<xs:documentation>
Indicates the relationship of the source to the target. The value describes the role of the source in the relationship. This is a restricted list of Parent, Child, Sibling, Unknown.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="RecordRelationshipName" type="r:NameType">
<xs:annotation>
<xs:documentation>
Name of the Record Relationship using the DDI Name structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="SourceTargetLink" type="SourceTargetLinkType">
<xs:annotation>
<xs:documentation>
Contains a set of variables, one from the source record and one from the target record used as all or part of a link between the source and target records.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="SourceTargetLinkType">
<xs:annotation>
<xs:documentation>
Contains a set of variables, one from the source record and one from the target record used as all or part of a link between the source and target records.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element ref="SourceLinkVariableReference">
<xs:annotation>
<xs:documentation>
A reference to the variable in the Source Record containing the value that is equal to the value in the identified variable in the Target Record.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="TargetLinkVariableReference">
<xs:annotation>
<xs:documentation>
A reference to the variable in the Target Record containing the value that is equal to the value in the identified variable in the Source Record.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:annotation>
<xs:documentation>
Reference to an existing LogicalRecord using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:annotation>
<xs:documentation>
Reference to an existing LogicalRecord using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TargetLinkVariableReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>
Reference to an existing Variable using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="SourceLinkVariableReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>
Reference to an existing Variable using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="RelatedValueType">
<xs:annotation>
<xs:documentation>
The characteristic value expressed as a string with an indicator of the specific relationship of the variable value to the characteristic value. The default is "Equal". The value may be defined as containing no content (blank) by setting the attribute valueIsBlank to "true".
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="r:ValueType">
<xs:attribute default="Equal" name="type" type="RelatedValueTypeCodeType">
<xs:annotation>
<xs:documentation>
Indicates value type as "GreaterThan", LessThan", "Equal", "GreaterThanOrEqual", "LessThanOrEqual", or "NotEqual".
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute default="false" name="valueIsBlank" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Set to "true" if the value of the conditional variable is blank.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:simpleType name="IsComprehensiveType">
<xs:annotation>
<xs:documentation>
Indicates the values are comprehensive, they cover all possible values. If the data collected for these values is additive the sum of the values should equal the value of the parent.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="True">
<xs:annotation>
<xs:documentation>True, the values are comprehensive.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="False">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Unknown">
<xs:annotation>
<xs:documentation>
Unknown, the documentation is lacking to make an assertion as to whether the values listed are comprehensive.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="RelatedValueTypeCodeType">
<xs:annotation>
<xs:documentation>
Indicates the relationship of the value of a source object to a target object. Except in the case of equality or non-equality of the relationship is unidirectional (source to target).
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="GreaterThan">
<xs:annotation>
<xs:documentation>
The value of the source object is greater than the value of the target object.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="LessThan">
<xs:annotation>
<xs:documentation>
The value of the source object is less than the value of the target object.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Equal">
<xs:annotation>
<xs:documentation>
The value of the source object is equal to the value of the target object.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="GreaterThanOrEqual">
<xs:annotation>
<xs:documentation>
The value of the source object is greater than or equal to the value of the target object.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="LessThanOrEqual">
<xs:annotation>
<xs:documentation>
The value of the source object is less than or equal to the value of the target object.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="NotEqual">
<xs:annotation>
<xs:documentation>
The value of the source object is not equal the value of the target object.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="RelationCodeType">
<xs:annotation>
<xs:documentation>
Indicates the relationship of a source object to a target object. Except in the case of sibling the relationship is unidirectional (source to target).
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="Parent">
<xs:annotation>
<xs:documentation>
The source object is the parent of the target object. The target object is a sub-part or member of the parent source.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Child">
<xs:annotation>
<xs:documentation>
The source object is the child of the source object. The target object is the parent or contains the source object as a sub-part or member.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Sibling">
<xs:annotation>
<xs:documentation>
The source object is the sibling of the target object. One object is not a member of or subsidiary to the other. They may be equal members of the same group.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Unknown">
<xs:annotation>
<xs:documentation>
The relationship between the source and target objects is unknown.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="NCubeGroupType">
<xs:annotation>
<xs:documentation>
Contains a group of NCubes, which may be ordered or hierarchical. In addition to the name, label, and description of the group, the structure allows for defining the type of group using an optional controlled vocabulary, a reference to a defining universe or concept for the group, and a listing of NCubes and NCubeGroups in any order.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:VersionableType">
<xs:sequence>
<xs:element minOccurs="0" ref="TypeOfGroup">
<xs:annotation>
<xs:documentation>
A brief textual identification of the group type. Supports the use of an external controlled vocabulary.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="NCubeGroupName">
<xs:annotation>
<xs:documentation>
A name for the group. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
A display label for the NCube group. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and purpose of the NCubeGroup. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:UniverseReference">
<xs:annotation>
<xs:documentation>
Reference to the universe statement describing the persons or other objects to which the contents of this NCube group pertain.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:ConceptReference">
<xs:annotation>
<xs:documentation>
Reference to the concept expressed by the NCubes in this group.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="r:NCubeReference">
<xs:annotation>
<xs:documentation>Reference to constituent NCube.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="NCubeGroupReference">
<xs:annotation>
<xs:documentation>
Reference to constituent NCubeGroup. This allows for nesting of NCubeGroups.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:sequence>
<xs:attribute default="false" name="isOrdered" type="xs:boolean">
<xs:annotation>
<xs:documentation>
If set to "true" indicates that the content of the group is ordered as it appears within the XML structure.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="NCubeGroupName" type="r:NameType">
<xs:annotation>
<xs:documentation>
Name of the NCube Scheme using the DDI Name structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="CoordinateGroupType">
<xs:annotation>
<xs:documentation>
Defines the area of attachment for an NCube attribute. It may be defined as the NCube as a whole or as certain dimensions or values of dimensions.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:IdentifiableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
A display label for the CoordinateGroup. May be expressed in multiple languages. Repeat for labels with different content, for example, labels with differing length limitations.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:UniverseReference">
<xs:annotation>
<xs:documentation>
Reference to the universe statement containing a description of the persons or other elements that this CoordinateGroup refers to, and to which any analytic results refer. If more than one universe is referenced the universe of the CoordinateGroup is the intersect of the referenced universes. Use when the CoordinateGroup describes a subset of the NCube universe.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content of the CoordinateGroup. May be expressed in multiple languages and supports the use of structured content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="DimensionValue">
<xs:annotation>
<xs:documentation>
Defines the included set of values needed to describe the coordinate region of the NCube on a Dimension by Dimension basis.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="CohortType">
<xs:annotation>
<xs:documentation>
Defines the included values of a dimension by means of individual value references or by defining a range of values to include. Allows the included values to be identified by reference to the Code, the Category used by the Code, or the Value of the Code (which by definition should be unique). The dimension is identified by its rank value.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:choice>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:CategoryReference">
<xs:annotation>
<xs:documentation>
Reference to the Category represented by the Value of the Code assigned in a CodeList. Repeat for including multiple values.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:CodeReference">
<xs:annotation>
<xs:documentation>
Reference to the Code within the CodeList used by the variable describing the dimension. Repeat for including multiple values.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Range">
<xs:annotation>
<xs:documentation>
Use when multiple values are included. This uses the unique Value provided for the Code as a means of identification. Provides the range of Values for this dimension that are within the area being defined. Repeat for non-contiguous values.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:choice>
</xs:sequence>
<xs:attribute name="rank" type="xs:integer" use="required">
<xs:annotation>
<xs:documentation>
Identify the dimension being described by its rank value within the NCube description.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="DimensionType">
<xs:annotation>
<xs:documentation>
A dimension is provided a rank and a reference to a variable that describes it. Cell locations are "addressed" by the value of their intersect on each dimension provided in rank order.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element ref="r:VariableReference">
<xs:annotation>
<xs:documentation>
Identifies the variable describing this dimension. The dimension uses the CodeList and related categories, or a fixed range of numeric values to define the labels and intersect points for the dimension. The data set will contain a value for each cell in the NCube rather than the code from the CodeList.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="rank" type="xs:integer" use="required">
<xs:annotation>
<xs:documentation>
Provides coordinate order (1,2,n) for the intersect point of this dimension within the cell address. For example, if the rank of this dimension is 2, the intersect point on this dimension will be the second value listed in the cell address.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="MeasureDefinitionType">
<xs:annotation>
<xs:documentation>
Defines the structure and type of measure captured within the cells. This may be repeated to describe multiple measure for the cells (i.e., count, percent of universe, dimensional percent, index, text, suppression flag, etc.). Includes a reference to the defining variable and an optional aggregation definition for use in defining content relying on the use of independent and dependent variables (such as the percentage of a specific dimension (like a row or column percent on a table).
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:IdentifiableType">
<xs:sequence>
<xs:element ref="r:VariableReference">
<xs:annotation>
<xs:documentation>
A reference to the variable that defines the measure of the NCube.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="AggregationDefinition">
<xs:annotation>
<xs:documentation>
Identifies the independent (denominator) and dependent (numerator) dimensions for calculating aggregate measures such as percent. When two or more independent or dependent dimensions are listed here, the value is defined as the intersection of the listed dimensions.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:annotation>
<xs:documentation>
Identifies the independent (denominator) and dependent (numerator) dimensions for calculating aggregate measures such as percent.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="AggregationDefinitionType">
<xs:annotation>
<xs:documentation>
Identifies the independent (denominator) and dependent (numerator) dimensions for calculating aggregate measures such as percent. When two or more independent or dependent dimensions are listed here, the value is defined as the intersection of the listed dimensions.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="IndependentDimension" type="xs:integer">
<xs:annotation>
<xs:documentation>
The rank of a dimension that acts as the denominator (independent variable).
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" name="DependentDimension" type="xs:integer">
<xs:annotation>
<xs:documentation>
The rank of a dimension that acts as the numerator (dependent variable).
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute default="true" name="isNCubeUniverse" type="xs:boolean">
<xs:annotation>
<xs:documentation>
When true indicates that total count of the NCube as described by the universe acts as the independent variable (denominator) and that all dimensions are used to define the dependent variable (numerator). When false, use the IndependentDimension and DependentDimension elements to assign each rank to its appropriate role.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<!-- code schemes -->
<xs:simpleType name="AdditivityCodeType">
<xs:annotation>
<xs:documentation>
Describes the nature of additivity for the content. By designating the type of content, a user will understand whether the contents can be summed or must be treated differently in terms of processing an aggregation.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="Stock">
<xs:annotation>
<xs:documentation>
A count of objects at one specific time. In general items in a non-hierarchical table of Stock figures can be added together to determine the total.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Flow">
<xs:annotation>
<xs:documentation>
A measure that is taken over time and should be treated as the number of items per a unit of time. Analogous to a rate or a speed.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="NonAdditive">
<xs:annotation>
<xs:documentation>
Due to the nature of the content or the measure, these data cannot be aggregated to determine a sum or accounting of activity.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="HierarchyCodeType">
<xs:annotation>
<xs:documentation>
Defines the type of hierarchical structure as Regular or Irregular.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="Regular">
<xs:annotation>
<xs:documentation>
A hierarchy where each section has the same number of nested levels, i.e., the lowest level represents the most discrete values.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Irregular">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="AttachmentLevelCodeType">
<xs:annotation>
<xs:documentation>
Identifies the contextual level of an NCube to which the attribute is attached; the full cube, a specific set of coordinates, a full dimension, a specific measurement, or a specific measurement value.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="Cube">
<xs:annotation>
<xs:documentation>Attaches to the whole NCube.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="CoordinateGroup">
<xs:annotation>
<xs:documentation>
Attaches to a group of cells described by a coordinate group which specifies the range of coordinate values contained within the group.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Dimension">
<xs:annotation>
<xs:documentation>Attaches to a full dimension.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Measurement">
<xs:annotation>
<xs:documentation>Attaches to a specific measurement type.</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="MeasurementValue">
<xs:annotation>
<xs:documentation>
Attaches to a specific value of a specified measurement.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:element name="TypeOfGroup" type="r:CodeValueType">
<xs:annotation>
<xs:documentation>
A brief textual description or classification of the created to associate a number of variables or NCubes. Supports the use of an external controlled vocabulary. DDI strongly recommends the use of a controlled vocabulary.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="CategoryScheme" type="CategorySchemeType">
<xs:annotation>
<xs:documentation>
A scheme containing a set of Categories managed by an agency.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="CodeList" type="CodeListType">
<xs:annotation>
<xs:documentation>
A structure used to associate a list of code values to specified categories. May be flat or hierarchical.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="NCubeScheme" type="NCubeSchemeType">
<xs:annotation>
<xs:documentation>
A set of NCubes maintained by an agency and used to structure data items into relational structures.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="VariableScheme" type="VariableSchemeType">
<xs:annotation>
<xs:documentation>Contains a set of Variables and VariableGroups.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DataRelationship" type="DataRelationshipType">
<xs:annotation>
<xs:documentation>
Describes the relationships among logical records in the dataset. Date Relationship is needed to create the appropriate link between the logical record and the physical storage description.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Category" type="CategoryType">
<xs:annotation>
<xs:documentation>
A description of a particular category or response.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="CategoryGroup" type="CategoryGroupType">
<xs:annotation>
<xs:documentation>
Contains a group of Category descriptions, which may be ordered or hierarchical.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Generation" type="GenerationType">
<xs:annotation>
<xs:documentation>
Description of the process used to generate the category content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="HierarchyType" type="HierarchyCodeType">
<xs:annotation>
<xs:documentation>
Defines the type of hierarchical structure as Regular or Irregular.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Level" type="LevelType">
<xs:annotation>
<xs:documentation>
Used to describe the levels of the code list hierarchy.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Code" type="CodeType">
<xs:annotation>
<xs:documentation>
A structure that links a unique value of a code to a specified category .
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:annotation>
<xs:documentation>
Describes the relationship between the categories in terms of the significance of order and the distance between categories.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Interval" type="IntervalType">
<xs:annotation>
<xs:documentation>
Describes the structure, starting point and increment step of an interval.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Variable" type="VariableType">
<xs:annotation>
<xs:documentation>
Describes the structure of a Variable. This is the applied expression of a data item within a data set.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="SelectorVariableReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>
Reference to an existing Variable using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="VariableGroup" type="VariableGroupType">
<xs:annotation>
<xs:documentation>
Contains a group of Variables, which may be ordered or hierarchical.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="VariableGroupReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>
Reference to an existing VariableGroup using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DataElementReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>
Reference to an existing DataElement using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EmbargoReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>
Reference to an existing Embargo using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:annotation>
<xs:documentation>
Describes the representation of the variable in the data set.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="StandardWeightReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>
Reference to an existing StandardWeight using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ImputationReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>
Reference to an existing GenerationInstruction or GeneralInstruction using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ConcatenatedValue" type="ConcatenatedValueType">
<xs:annotation>
<xs:documentation>
Lists the variables whose values when concatenated result in the value for this variable.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ComponentReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>
Reference to an existing Category using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="NCube" type="NCubeType">
<xs:annotation>
<xs:documentation>
An NCube is a 1..n dimension structure which relates a set of individual values to each other by defining them within a matrix.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="NCubeGroup" type="NCubeGroupType">
<xs:annotation>
<xs:documentation>
Contains a group of NCubes, which may be ordered or hierarchical.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AttachmentGroupReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>
Reference to an existing CoordinateGroup using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="CoordinateGroup" type="CoordinateGroupType">
<xs:annotation>
<xs:documentation>
Defines the area of attachment for an NCube attribute.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Dimension" type="DimensionType">
<xs:annotation>
<xs:documentation>
A dimension is provided a rank and a reference to a variable that describes it.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="MeasureDefinition" type="MeasureDefinitionType">
<xs:annotation>
<xs:documentation>
Defines the structure and type of measure captured within the cells.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Attribute" type="AttributeType">
<xs:annotation>
<xs:documentation>
An attribute may be any object which should be attached to all or part of the NCube.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="NCubeGroupReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>
Reference to an existing NCubeGroup using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DimensionValue" type="CohortType">
<xs:annotation>
<xs:documentation>Defines the included values of a dimension.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="LogicalRecord" type="LogicalRecordType">
<xs:annotation>
<xs:documentation>
A logical record is a description of all of the elements (variables or NCubes) related to a single case or analysis unit.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="RecordRelationship" type="RecordRelationshipType">
<xs:annotation>
<xs:documentation>
Describes the relationship between records of different types or of the same type within a longitudinal study. Identifies the key and linking value relationships.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="LogicalRecordReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>
Reference to an existing LogicalRecord using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="LinkVariableReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>
Reference to an existing Variable using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="RelatedValue" type="RelatedValueType">
<xs:annotation>
<xs:documentation>
The characteristic value expressed as a string with an indicator of the specific relationship of the variable value to the characteristic value. The default is "Equal".
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:annotation>
<xs:documentation>
A reference the variable containing the record type locator and the value being used.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="VariableUsedReference" type="r:ReferenceType">
<xs:annotation>
<xs:documentation>
Reference to an existing Variable using the Reference structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:annotation>
<xs:documentation>
A reference the variable containing the segment locator and the value being used.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="CaseIdentification" type="CaseIdentificationType">
<xs:annotation>
<xs:documentation>
Describes the information needed to identify an individual case within a record type
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="VariablesInRecord" type="VariablesInRecordType">
<xs:annotation>
<xs:documentation>
Identifies the variables contained in the logical record.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="CaseSpecification" type="CaseSpecificationType">
<xs:annotation>
<xs:documentation>
Case specification allows different unique identifiers to be used based on the value of an identified variable.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="NCubesInRecord" type="NCubesInRecordType">
<xs:annotation>
<xs:documentation>
Identifies the NCubes and any variables in the record external to NCube structures.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="LevelName" type="r:NameType">
<xs:annotation>
<xs:documentation>Name of the Level using the DDI Name structure.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="VariableRole" type="r:CodeValueType">
<xs:annotation>
<xs:documentation>
Describes a specific function of the variable, such as identity, weight, geographic variable, time, date, currency, etc. Supports the use of an external controlled vocabulary.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:annotation>
<xs:documentation>
Identifies the default missing value parameter for the this logical record by referencing a MissingValuesDelineation or by stating that there is a default missing values parameter used but it is undocumented.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="DefaultMissingValuesType">
<xs:annotation>
<xs:documentation>
Identifies the default missing value parameter for the this logical record by referencing a MissingValuesDelineation or by stating that there is a default missing values parameter used but it is undocumented. Note that a conflicting DefaultMissingValues definition in a PhysicalInstance will override that found in the LogicalRecord.
</xs:documentation>
</xs:annotation>
<xs:choice minOccurs="0">
<xs:element ref="MissingValuesReference">
<xs:annotation>
<xs:documentation>
Reference to the appropriate MissingValuesDelineation describing the default values.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element fixed="true" name="DefaultUsedNoDocumentation" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Use when it is known that a default missing values definition was use but there is NO documentation describing its content.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:schema>

XML schema documentation generated with DocFlex/XML 1.8.7 using DocFlex/XML XSDDoc 2.7.0 template set