complexType "VariableType"
Namespace:
Content:
complex, 9 attributes, 23 elements
Defined:
Includes:
definitions of 3 attributes, 12 elements
Used:
XML Representation Summary
<...
   
 = 
("Canonical" | "Deprecated")
 = 
("Add" | "Update" | "Delete")
 = 
xs:anyURI
 = 
("Agency" | "Maintainable") : "Agency"
 = 
(xs:dateTime | xs:date | xs:gYearMonth | xs:gYear | xs:duration)
 = 
"true"
 = 
xs:boolean : "false"
 = 
xs:boolean : "false"
 = 
xs:boolean : "false"
    >
   
Content: 
(r:URN | (r:Agency, r:ID, r:Version))[1..2], r:UserID*, r:UserAttributePair*, (r:VersionResponsibility | r:VersionResponsibilityReference)?, r:VersionRationale?, r:BasedOnReference?, r:MaintainableObject?, VariableName*, r:Label*, r:Description?, r:SourceParameterReference?, DataElementReference?, r:UniverseReference*, r:ConceptReference?, r:QuestionReference*, EmbargoReference?, SourceUnit?, r:AnalysisUnit?, VariableRepresentation?
</...>
Content Model Elements (23):
DataElementReference, EmbargoReference, SourceUnit, VariableName, VariableRepresentation, r:Agency, r:AnalysisUnit, r:BasedOnReference, r:ConceptReference, r:Description, r:ID, r:Label, r:MaintainableObject, r:QuestionReference, r:SourceParameterReference, r:URN, r:UniverseReference, r:UserAttributePair, r:UserID, r:Version, r:VersionRationale, r:VersionResponsibility, r:VersionResponsibilityReference
All Direct / Indirect Based Elements (1):
Variable
Known Usage Locations
Annotation
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.
Type Definition Detail
Type Derivation Tree
r:AbstractIdentifiableType (extension)
      r:VersionableType (extension)
          VariableType
XML Source (w/o annotations (16); see within schema source)
<xs:complexType name="VariableType">
<xs:complexContent>
<xs:extension base="r:VersionableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="VariableName"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label"/>
<xs:element minOccurs="0" ref="r:Description"/>
<xs:element minOccurs="0" ref="r:SourceParameterReference"/>
<xs:element maxOccurs="1" minOccurs="0" ref="DataElementReference"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:UniverseReference"/>
<xs:element minOccurs="0" ref="r:ConceptReference"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:QuestionReference"/>
<xs:element minOccurs="0" ref="EmbargoReference"/>
<xs:element minOccurs="0" ref="SourceUnit"/>
<xs:element minOccurs="0" ref="r:AnalysisUnit"/>
<xs:element minOccurs="0" ref="VariableRepresentation"/>
</xs:sequence>
<xs:attribute default="false" name="isTemporal" type="xs:boolean"/>
<xs:attribute default="false" name="isGeographic" type="xs:boolean"/>
<xs:attribute default="false" name="isWeight" type="xs:boolean"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Attribute Detail (all declarations; defined within this component only; 3/9)
isGeographic
Type:
xs:boolean, predefined
Use:
optional
Set to "true" if the variable relays geographic information, i.e., geographic code, area name, relative location, etc.
Attribute Value
Default:
"false"
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="false" name="isGeographic" type="xs:boolean"/>

isTemporal
Type:
xs:boolean, predefined
Use:
optional
Set to "true" if the variable relays time-related information (date, time, season, relative time, etc.).
Attribute Value
Default:
"false"
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="false" name="isTemporal" type="xs:boolean"/>

isWeight
Type:
xs:boolean, predefined
Use:
optional
Set to "true" if the variable is used a weight when analyzing data within the data set.
Attribute Value
Default:
"false"
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="false" name="isWeight" type="xs:boolean"/>
Content Element Detail (all declarations; defined within this component only; 12/23)
DataElementReference
Type:
r:ReferenceType, complex content
Reference to the DataElement that describes the core of this variable (the data element that the variable is the applied expression of).
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="1" minOccurs="0" ref="DataElementReference"/>

EmbargoReference
Type:
r:ReferenceType, complex content
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.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="EmbargoReference"/>

r:AnalysisUnit
Type:
r:CodeValueType, simple content
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.
Simple Content
xs:string
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:AnalysisUnit"/>

r:ConceptReference
Type:
r:ReferenceType, complex content
Reference to the concept measured by this variable.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:ConceptReference"/>

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

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

r:QuestionReference
Type:
r:ReferenceType, complex content
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.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:QuestionReference"/>

r:SourceParameterReference
Type:
r:ReferenceType, complex content
Reference to an OutParameter that serves as the source for the content of this variable.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:SourceParameterReference"/>

r:UniverseReference
Type:
r:ReferenceType, complex content
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.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:UniverseReference"/>

SourceUnit
Type:
r:CodeValueType, simple content
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.
Simple Content
xs:string
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="SourceUnit"/>

VariableName
Type:
r:NameType, complex content
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.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="VariableName"/>

VariableRepresentation
Type:
Describes the representation of the variable in the data set, including allowed content, data typing, and computation information.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="VariableRepresentation"/>

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