DDI 3.1 XML Schema Documentation (2009-10-18)
© DDI Alliance 2009 - licensed under the terms of the GNU Lesser General Public License
complexType "ReferenceType"
Namespace:
ddi:reusable:3_1
Content:
complex, 6 attributes, 6 elements
Defined:
globally in reusable.xsd, see XML source
Includes:
definitions of 6 attributes and 6 elements
Used:
at 117 locations
XML Representation Summary
<...
    URI
 = 
 xs:anyURI
    isExternal
 = 
 xs:boolean : "false"
    isReference
 = 
 "true"
    lateBound
 = 
 xs:boolean : "false"
    objectLanguage
 = 
 xs:language
    sourceContext
 = 
 xs:anyURI
    >
   
Content: 
 Module?, Scheme?, (URN | (ID, IdentifyingAgency?, Version?))[1..2]
</...>
Content Model Elements (6):
ID,
IdentifyingAgency (type xs:NCName),
Module,
Scheme,
URN,
Version
Known Direct Subtypes (12):
CodeSchemeReferenceType, ConceptReferenceType, InterviewerInstructionReferenceType, KeyVariableReferenceType, MeasureReferenceType, MeasureReferenceType, MeasureReferenceType, ParentGeographyType, PhysicalStructureReferenceType, SchemeReferenceType, SourceReferenceType, VariableUsedReferenceType
All Direct / Indirect Based Elements (132):
AgencyOrganizationReference,
AgencyOrganizationReference,
ArchiveOrganizationReference,
ArchiveReference,
AssignedVariableReference,
AttachmentGroupReference,
AttributeReference,
AttributeReference,
AttributeReference,
AuthorityOrganizationReference,
CategoryReference,
CategoryReference (in Code),
CategorySchemeReference,
CategorySchemeReference,
CharacteristicReference,
CodeSchemeReference,
CodeSchemeReference,
CodingInstructionsReference,
ComponentReference,
ConceptGroupReference,
ConceptReference,
ConceptReference,
ConceptReference,
ConceptSchemeReference,
ConceptualComponentReference,
ContactOrganizationReference,
ControlConstructReference,
ControlConstructSchemeReference,
DataCollectionReference,
DataCollectorOrganizationReference,
DataFileReference,
DDIProfileReference,
DDIProfileReference,
DefaultVariableSchemeReference,
DefaultVariableSchemeReference,
DefaultVariableSchemeReference,
DefiningConceptReference,
Delete,
DependentVariableReference,
DepositoryGroupReference,
DepositoryStudyUnitReference,
ElseConstructReference,
EmbargoReference,
EnforcementAgencyOrganizationReference,
EntityReference,
ExcludedMissingCategoryReference,
FilterVariableReference,
GeographicLayerBase,
GeographicLevelReference,
GeographicLocationReference,
GeographicLocationSchemeReference,
GeographicStructureReference,
GeographicStructureSchemeReference,
GeographyReference,
GeographyStructureVariable,
IdentifyingVariableReference,
ImputationReference,
IndependentVariableReference,
IndividualReference,
InterviewerInstructionReference,
InterviewerInstructionSchemeReference,
IsOverride,
KeyVariableReference,
LevelReference,
LocationReference,
LogicalProductReference,
LogicalProductReference,
LogicalRecordReference,
LoopVariableReference,
MeasureReference,
MeasureReference,
MeasureReference,
Module,
NCubeGroupReference,
NCubeReference,
NCubeReference,
NCubeReference,
NCubeReference,
NCubeSchemeReference,
OrganizationReference,
OrganizationSchemeReference,
OriginalArchiveOrganizationReference,
ParentGeography,
PhysicalDataProductReference,
PhysicalInstanceReference,
PhysicalStructureReference,
PhysicalStructureSchemeReference,
QuestionReference,
QuestionReference,
QuestionSchemeReference,
RecordLayoutReference,
RecordLayoutSchemeReference,
RecordReferenceTarget,
Reference,
RelatedToReference,
Replace,
Scheme,
SchemeReference,
SimilarConceptReference,
SourceQuestion,
SourceQuestionReference,
SourceSchemeReference,
SourceVariable,
SourceVariableReference,
SpatialCoverageReference,
StandardWeightReference,
SummaryDataReference,
TargetSchemeReference,
TemporalCoverageReference,
ThenConstructReference,
TopicalCoverageReference,
UniverseReference,
UniverseSchemeReference,
UntilConstructReference,
VariableGroupReference,
VariableReference,
VariableReference,
VariableReference,
VariableReference,
VariableReference,
VariableReference,
VariableReference,
VariableReference,
VariableReference,
VariableReference (in VariableItem),
VariableSchemeReference,
VariableSetReference,
VariableUsedReference,
WeightUsedReference,
WeightVariableReference,
WeightVariableReference,
WhileConstructReference
Known Usage Locations
Annotation
Used for referencing an identified entity expressed in DDI XML, either by a URN and/or an ID. If both are supplied, the URN takes precedence. At a minimum, one or the other is required. The lateBound attribute has a boolean value, which - if set to true - indicates that the latest version should be used.
XML Source (w/o annotations (12); see within schema source)
<xs:complexType name="ReferenceType">
<xs:sequence>
<xs:element minOccurs="0" ref="Module"/>
<xs:element minOccurs="0" ref="Scheme"/>
<xs:choice maxOccurs="2">
<xs:element ref="URN"/>
<xs:sequence>
<xs:element ref="ID"/>
<xs:element minOccurs="0" name="IdentifyingAgency" type="xs:NCName"/>
<xs:element minOccurs="0" ref="Version"/>
</xs:sequence>
</xs:choice>
</xs:sequence>
<xs:attribute default="false" name="isExternal" type="xs:boolean"/>
<xs:attribute name="URI" type="xs:anyURI" use="optional"/>
<xs:attribute fixed="true" name="isReference" type="xs:boolean"/>
<xs:attribute default="false" name="lateBound" type="xs:boolean"/>
<xs:attribute name="objectLanguage" type="xs:language" use="optional"/>
<xs:attribute name="sourceContext" type="xs:anyURI" use="optional"/>
</xs:complexType>
Attribute Detail (defined in this component only; 6/6)
isExternal
Type:
xs:boolean, predefined
Use:
optional
Indicates that the reference is made to an external source. If the value is true, then a URI must be provided.
Attribute Value
Default:
"false"
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="false" name="isExternal" type="xs:boolean"/>
isReference
Type:
xs:boolean, predefined
Use:
optional
A fixed attribute value identifying which elements are references.
Attribute Value
Fixed:
"true"
XML Source (w/o annotations (1); see within schema source)
<xs:attribute fixed="true" name="isReference" type="xs:boolean"/>
lateBound
Type:
xs:boolean, predefined
Use:
optional
Attribute Value
Default:
"false"
XML Source (see within schema source)
<xs:attribute default="false" name="lateBound" type="xs:boolean"/>
objectLanguage
Type:
xs:language, predefined
Use:
optional
Specifies the language (or language-locale pair) to use for display in references to objects which have multiple languages available.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="objectLanguage" type="xs:language" use="optional"/>
sourceContext
Type:
xs:anyURI, predefined
Use:
optional
Provide a DDI URN for the version of the parent maintainable that shows the full context for the referenced object. This is used only when the context of the object within the current version of a maintainable is important to the user and this version is later than the one containing the object itself. For example a occupation classification may be unchanged since version 1.0 of its maintainable but at the point of reference the current version of the maintainable containing the original structure is at version 2.0 etc..
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="sourceContext" type="xs:anyURI" use="optional"/>
URI
Type:
xs:anyURI, predefined
Use:
optional
URI identifying the location of an external reference.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="URI" type="xs:anyURI" use="optional"/>
Content Element Detail (defined in this component only; 6/6)
ID
Type:
IDType, simple content
ID of the entity that is being referenced.
Simple Content
xs:string
Pattern:
 ([A-Z]|[a-z]|\*|@|[0-9]|_|$|\-)*
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="ID"/>
IdentifyingAgency
Type:
xs:NCName, predefined, simple content
Maintaining agency as described in Part 1 of the Technical Specification.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="IdentifyingAgency" type="xs:NCName"/>
Module
Type:
ReferenceType, complex content
References the module of the entity that is being referenced, in cases where there have been local modifications.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="Module"/>
Scheme
Type:
ReferenceType, complex content
Containing scheme of the entity that is being referenced.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="Scheme"/>
URN
Type:
URNType, simple content
URN of the entity that is being referenced.
Simple Content
xs:anyURI
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="URN"/>
Version
Type:
VersionType, simple content
If referencing a versioned or maintained element you must include Version. The version can be identified as lateBound, meaning that the latest version should be used.
Simple Content
xs:string
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="Version"/>
XML schema documentation generated with DocFlex/XML SDK 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set