complexType "VariableType"
Namespace:
Content:
complex, 9 attributes, 26 elements
Defined:
Includes:
definitions of 3 attributes, 15 elements
Used:
XML Representation Summary
<...
   
 = 
("Add" | "Update" | "Delete")
 = 
(xs:string | xs:string)
 = 
("Agency" | "Maintainable") : "Agency"
 = 
xs:boolean
 = 
(xs:dateTime | xs:date | xs:gYearMonth | xs:gYear | xs:duration)
 = 
"true"
 = 
xs:boolean : "false"
 = 
xs:boolean : "false"
 = 
xs:boolean : "false"
   
>
   
Content: 
</...>
Content Model Elements (26):
EmbargoReference, RepresentedVariableReference, SourceUnit, VariableName, VariableRepresentation, r:Agency, r:AnalysisUnit, r:BasedOnObject, r:ConceptReference, r:ConceptualVariableReference, r:Description, r:ID, r:Label, r:MaintainableObject, r:OutParameter, r:QuestionReference, r:SourceParameterReference, r:SourceVariableReference, 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 and maps to the GSIM ImplementedVariable. In addition to the standard name, label, and description, includes a reference to a source parameter, represented variable, conceptual variable, universe, concept, question, source variable, 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 (19); 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:OutParameter"/>
<xs:element minOccurs="0" ref="r:SourceParameterReference"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:SourceVariableReference"/>
<xs:element maxOccurs="1" minOccurs="0" ref="RepresentedVariableReference"/>
<xs:element maxOccurs="1" minOccurs="0" ref="r:ConceptualVariableReference"/>
<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; 15/26)
EmbargoReference
Type:
r:ReferenceType, complex content
Reference to any embargoes placed on the contents of this variable. Embargoes 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:ConceptualVariableReference
Type:
r:ReferenceType, complex content
Reference to the ConceptualVariable that describes the core of this variable. The ConceptualVariable provides linked Concept and Universe specifications. These may be constrained by specifications within the Variable description. TypeOfObject should be set to ConceptualVariable.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="1" minOccurs="0" ref="r:ConceptualVariableReference"/>

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:OutParameter
Type:
r:ParameterType, complex content
Assigns a parameter that contains output from the Variable so that it can be bound to an InParameter of an instruction or act as the SourceParameter of another Variable.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:OutParameter"/>

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:SourceVariableReference
Type:
r:ReferenceType, complex content
Reference to variable(s) used as a basis for recoding, derivation, or other means of calculating the data for this variable. This reference is intended to provide basic information on the source variable structure including value representation, measurement unit, etc. Note that if a variable is used by reference within multiple VariableSchemes you can identify its role within a specific VariableScheme by including that VariableScheme in the sourceContext attribute of the reference. Use ProcessingInstructionReference to provide additional information on the transformation of the source variable(s) into the data for this variable. If additional processing detail is required use the InParameter, OutParameter, and ParameterLinkage options in the GenerationInstruction and ProcessingInstructionReference.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:SourceVariableReference"/>

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

RepresentedVariableReference
Type:
r:ReferenceType, complex content
Reference to the RepresentedVariable that describes the core of this variable (the RepresentedVariable that the variable is the implementation of). The RepresentedVariable contains the broad reusable specification of the Variable, i.e., concept, universe, and value representation. These may be constrained by specifications within the Variable description. TypeOfObject should be set to RepresentedVariable.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="1" minOccurs="0" ref="RepresentedVariableReference"/>

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 RE 1.9.0 using DocFlex/XML XSDDoc 2.8.0 template set