complexType "StudyUnitType"
Namespace:
Content:
complex, 9 attributes, 46 elements
Defined:
globally in studyunit.xsd; see XML source
Includes:
definitions of 33 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)
 = 
xs:anyURI
 = 
xs:boolean : "false"
 = 
xs:language
 = 
"true"
   
>
   
Content: 
(r:URN | (r:Agency, r:ID, r:Version))[1..2], r:UserID*, r:UserAttributePair*, (r:VersionResponsibility | r:VersionResponsibilityReference)?, r:VersionRationale?, r:BasedOnObject?, r:Note*, r:Software*, r:MetadataQuality*, r:Citation?, r:Abstract?, r:AuthorizationSource*, r:UniverseReference?, r:SeriesStatement*, r:QualityStatementReference*, (r:QualityStatementScheme* | r:QualityStatementSchemeReference*)*, r:ExPostEvaluation*, r:FundingInformation*, StudyBudget*, r:Purpose?, r:Coverage?, r:AnalysisUnit*, r:AnalysisUnitsCovered?, r:KindOfData*, r:OtherMaterial*, r:RequiredResourcePackages?, r:Embargo*, (c:ConceptualComponent | r:ConceptualComponentReference)*, (d:DataCollection | r:DataCollectionReference)*, (l:BaseLogicalProduct | r:LogicalProductReference)*, (p:PhysicalDataProduct | r:PhysicalDataProductReference)*, (pi:PhysicalInstance | r:PhysicalInstanceReference)*, (a:Archive | r:ArchiveReference)*, (pr:DDIProfile | r:DDIProfileReference)*
</...>
Content Model Elements (46):
StudyBudget, a:Archive, c:ConceptualComponent, d:DataCollection, l:BaseLogicalProduct, p:PhysicalDataProduct, pi:PhysicalInstance, pr:DDIProfile, r:Abstract, r:Agency, r:AnalysisUnit, r:AnalysisUnitsCovered, r:ArchiveReference, r:AuthorizationSource, r:BasedOnObject, r:Citation, r:ConceptualComponentReference, r:Coverage, r:DDIProfileReference, r:DataCollectionReference, r:Embargo, r:ExPostEvaluation, r:FundingInformation, r:ID, r:KindOfData, r:LogicalProductReference, r:MetadataQuality, r:Note, r:OtherMaterial, r:PhysicalDataProductReference, r:PhysicalInstanceReference, r:Purpose, r:QualityStatementReference, r:QualityStatementScheme, r:QualityStatementSchemeReference, r:RequiredResourcePackages, r:SeriesStatement, r:Software, r:URN, r:UniverseReference, r:UserAttributePair, r:UserID, r:Version, r:VersionRationale, r:VersionResponsibility, r:VersionResponsibilityReference
All Direct / Indirect Based Elements (2):
LocalStudyUnitContent, StudyUnit
Known Usage Locations
Annotation
A primary packaging and publication module within DDI representing the purpose, background, development, data capture, and data products related to a study. In DDI a study is defined as a single coordinated set of data collection/capture activities, such as a one-time survey or a single iteration of a multi-year repeated study (such as one year of a longitudinal survey). The StudyUnit brings together all of the components of the study including the description of its purpose, funding, quality statements, data collection and capture methods and activities, processing activities, and a description of the resulting data (description of its intellectual or logical content plus a description of its physical store). A study unit may have only a single data collection or capture process resulting in one or more data products (i.e., Census). A complex study unit may contain multiple means of data capture that are integrated into one or more data products (i.e., a medical study collecting bio-markers, patient background, health care service information, etc.). A longitudinal study with multiple waves or iterations of data collection is considered to be a group of studies, each wave or iteration captured as a single study unit. As a primary packaging module, the Study Unit contains a full citation, abstract, authorization information, a universe reference, series statement, quality statement, information on post study evaluation, funding information, budget, purpose, coverage, type of analysis units covered, kind of data, other materials, a list of required resource packages, embargoes, the conceptual components (universe, concept, data element, geographic structure and locations), data collection, logical products, physical data products, physical instance, archive, and DDI profile. The maintainable elements within a Study Unit may be included in-line or by reference.
Type Definition Detail
Type Derivation Tree
r:AbstractIdentifiableType (extension)
      r:AbstractMaintainableType (extension)
          r:MaintainableType (extension)
              StudyUnitType
XML Source (w/o annotations (34); see within schema source)
<xs:complexType name="StudyUnitType">
<xs:complexContent>
<xs:extension base="r:MaintainableType">
<xs:sequence>
<xs:element minOccurs="0" ref="r:Citation"/>
<xs:element minOccurs="0" ref="r:Abstract"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:AuthorizationSource"/>
<xs:element minOccurs="0" ref="r:UniverseReference"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:SeriesStatement"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:QualityStatementReference"/>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:QualityStatementScheme"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:QualityStatementSchemeReference"/>
</xs:choice>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:ExPostEvaluation"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:FundingInformation"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="StudyBudget"/>
<xs:element minOccurs="0" ref="r:Purpose"/>
<xs:element minOccurs="0" ref="r:Coverage"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:AnalysisUnit"/>
<xs:element minOccurs="0" ref="r:AnalysisUnitsCovered"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:KindOfData"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:OtherMaterial"/>
<xs:element minOccurs="0" ref="r:RequiredResourcePackages"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Embargo"/>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="c:ConceptualComponent"/>
<xs:element ref="r:ConceptualComponentReference"/>
</xs:choice>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="d:DataCollection"/>
<xs:element ref="r:DataCollectionReference"/>
</xs:choice>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="l:BaseLogicalProduct"/>
<xs:element ref="r:LogicalProductReference"/>
</xs:choice>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="p:PhysicalDataProduct"/>
<xs:element ref="r:PhysicalDataProductReference"/>
</xs:choice>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="pi:PhysicalInstance"/>
<xs:element ref="r:PhysicalInstanceReference"/>
</xs:choice>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="a:Archive"/>
<xs:element ref="r:ArchiveReference"/>
</xs:choice>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="pr:DDIProfile"/>
<xs:element ref="r:DDIProfileReference"/>
</xs:choice>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Content Element Detail (all declarations; defined within this component only; 33/46)
a:Archive
Type:
a:ArchiveType, complex content
Archive serves as a packet containing both persistent and transient information. Describes archive-specific material including item record information as well as lifecycle information. The metadata in the package is divided into elements that are persistent (should remain with the Study Unit through its life-cycle), and transient (pertinent only to the Study Unit as held by that archive).
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="a:Archive"/>

c:ConceptualComponent
Type:
c:ConceptualComponentType, complex content
Documents the content and relational structure of the concepts, universes, data elements, geographic structures and geographic locations used by the study unit.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="c:ConceptualComponent"/>

d:DataCollection
Type:
d:DataCollectionType, complex content
Documents the content of the Data Collection activities used in this study; development of data collection processes, questions, question flows (control constructs), data collection instrument, instructions, processing events and instructions, methodology, etc.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="d:DataCollection"/>

l:BaseLogicalProduct
Type:
l:BaseLogicalProductType, complex content
Abstract:
(may not be used directly in instance XML documents)
Subst.Gr:
may be substituted with 1 element
Documents the logical (intellectual) content of the data produced by the study unit. Note that l:BaseLogicalProduct is the head of a substitution group and is replaced by the appropriate member of that substitution group.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="l:BaseLogicalProduct"/>

p:PhysicalDataProduct
Type:
p:PhysicalDataProductType, complex content
Documents the physical structure of the data produced by the study unit.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="p:PhysicalDataProduct"/>

pi:PhysicalInstance
Type:
pi:PhysicalInstanceType, complex content
Documents the link to a specific external data file produced by the study unit. May contain summary and category level statistics on the variables contained in the data file.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="pi:PhysicalInstance"/>

pr:DDIProfile
Type:
pr:DDIProfileType, complex content
Contains a DDI Profile which is used by the study unit.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="pr:DDIProfile"/>

r:Abstract
Type:
r:StructuredStringType, complex content
An abstract of the study unit describing the nature and scope of the data collection, special characteristics of its content. Note that detailed information on the purpose of the study and structured coverage information are to be entered in Purpose and Coverage. Abstract supports multiple language versions of the same content as well as optional formatting of the content.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:Abstract"/>

r:AnalysisUnit
Type:
r:CodeValueType, simple content
Allows the use of a controlled vocabulary to list all of the units of analysis used in the study. Should be repeated to describe multiple units of analysis.
Simple Content
xs:string
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:AnalysisUnit"/>

r:AnalysisUnitsCovered
Type:
r:InternationalStringType, complex content
A narrative of the units of analysis in the study unit. Uses an InternationalString to support multiple languages.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:AnalysisUnitsCovered"/>

r:ArchiveReference
Type:
r:ReferenceType, complex content
Inclusion of an existing Archive module by reference.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="r:ArchiveReference"/>

r:AuthorizationSource
Type:
r:AuthorizationSourceType, complex content
Identifies the authorizing agency for the study and allows for the full text of the authorization (law, regulation, or other form of authorization). May be used to list authorizations from oversight committees and other regulatory agencies.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:AuthorizationSource"/>

r:Citation
Type:
r:CitationType, complex content
The citation for the study. DDI strongly recommends that at minimum a Title be provided.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:Citation"/>

r:ConceptualComponentReference
Type:
r:ReferenceType, complex content
Inclusion of an existing Conceptual Component module by reference.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="r:ConceptualComponentReference"/>

r:Coverage
Type:
r:CoverageType, complex content
Describes the coverage of the study unit. Detailed information on Topical, Temporal, and Spatial Coverage is contained here. Note that Coverage at this level should be inclusive all lower level modules or section. Lower level descriptions serve to constrain coverage within the scope described here.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:Coverage"/>

r:DataCollectionReference
Type:
r:ReferenceType, complex content
Inclusion of an existing Data Collection module by reference.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="r:DataCollectionReference"/>

r:DDIProfileReference
Type:
r:ReferenceType, complex content
Inclusion of an existing DDIProfile by reference.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="r:DDIProfileReference"/>

r:Embargo
Type:
r:EmbargoType, complex content
Embargo information about the study unit. References to embargo information in this section can be made from individual variables.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Embargo"/>

r:ExPostEvaluation
Type:
r:ExPostEvaluationType, complex content
An evaluation of the study process, often taking place after the completion of the study. These may include issues such as timing of the study, sequencing issues, cost/budget issues, relevance, institutional or legal arrangements etc. of the study. If the study is part of a series or group (i.e., a single wave in a longitudinal study) this may include evaluation of earlier waves which resulted in changes to the current wave.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:ExPostEvaluation"/>

r:FundingInformation
Type:
r:FundingInformationType, complex content
Contains details of the study unit's funding, including information about grants, agencies, etc.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:FundingInformation"/>

r:KindOfData
Type:
r:KindOfDataType, simple content
Briefly describes the kind of data documented in the logical product(s) of a study unit. Examples include survey data, census/enumeration data, administrative data, measurement data, assessment data, demographic data, voting data, 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 maxOccurs="unbounded" minOccurs="0" ref="r:KindOfData"/>

r:LogicalProductReference
Type:
r:ReferenceType, complex content
Inclusion of an existing Logical Product module by reference.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="r:LogicalProductReference"/>

r:OtherMaterial
Type:
r:OtherMaterialType, complex content
Contains references to other materials relevant to the study unit, whether in DDI form or external. Links can be made from items in this section to any identifiable element in the instance. Best practice is to include OtherMaterial inside the maintainable containing the objects that are related to the OtherMaterial.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:OtherMaterial"/>

r:PhysicalDataProductReference
Type:
r:ReferenceType, complex content
Inclusion of an existing Physical Data Product module by reference.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="r:PhysicalDataProductReference"/>

r:PhysicalInstanceReference
Type:
r:ReferenceType, complex content
Inclusion of an existing Physical Instance module by reference.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="r:PhysicalInstanceReference"/>

r:Purpose
Type:
r:StructuredStringType, complex content
The purpose of the study, why the study took place. This should include detailed information on the investigator's primary study questions or hypotheses as well as information on any legal basis for the data collection, such as laws requiring the collection of census data for apportionment purposes. Legal or other authorization should be provided in detail within AuthorizationSource. Purpose supports multiple language versions of the same content as well as optional formatting of the content.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:Purpose"/>

r:QualityStatementReference
Type:
r:ReferenceType, complex content
A reference to a Quality Statement pertaining to the quality of the study overall, metadata, or data to which it is associated. Quality statements may be related to external quality standards.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:QualityStatementReference"/>

r:QualityStatementScheme
Type:
A scheme containing statements of quality related to the quality of methodologies, metadata, or data. Quality statements may be related to external quality standards.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:QualityStatementScheme"/>

r:QualityStatementSchemeReference
Type:
r:SchemeReferenceType, complex content
A reference to a QualityStatementScheme containing statements of quality related to the quality of the study methodology, metadata, or data. Quality statements may be related to external quality standards.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:QualityStatementSchemeReference"/>

r:RequiredResourcePackages
Type:
Specifies by reference the ResourcePackages required to resolve the Study. This list is informational and assists in creating full transmissions of metadata or creating archival packages. Primarily used after the instance is relatively stable and published.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:RequiredResourcePackages"/>

r:SeriesStatement
Type:
r:SeriesStatementType, complex content
A study, particularly one in a series, may be the result of two series merging into a single study. The new study belongs to both series. For example, Niger now fields the UNICEF Multiple Indicators Cluster Survey (MICS) and the Demographic and Health Survey as a single merged instrument.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:SeriesStatement"/>

r:UniverseReference
Type:
r:ReferenceType, complex content
Reference to the universe statement from the universe scheme, describing the group of persons or other elements that are the object of research and to which any analytic results refer. Age, nationality, and residence commonly help to delineate a given universe, but any of a number of factors may be involved, such as sex, race, income, veteran status, criminal convictions, etc. The universe may consist of elements other than persons, such as housing units, court cases, deaths, countries, etc. In general, it should be possible to tell from the description of the universe whether a given individual or element (hypothetical or real) is a member of the population under study. A universe may be described as "inclusive" or "exclusive". This StudyUnit level reference is normally to the top level of the UniverseScheme.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:UniverseReference"/>

StudyBudget
Type:
r:BudgetType, complex content
This describes the overall budget of the study. It can be repeated for distinct budget activities. It contains a structured description and one or more budget documents described by an OtherMaterial type.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="StudyBudget"/>

XML schema documentation generated with DocFlex/XML RE 1.9.0 using DocFlex/XML XSDDoc 2.8.0 template set