DDI 3.1 XML Schema Documentation (2009-10-18)
© DDI Alliance 2009 - licensed under the terms of the GNU Lesser General Public License
complexType "StudyUnitType"
Namespace:
ddi:studyunit:3_1
Content:
complex, 11 attributes, 30 elements
Defined:
globally in studyunit.xsd, see XML source
Includes:
definitions of 27 elements
Used:
at 2 locations
XML Representation Summary
<...
    action
 = 
 ("Add" | "Update" | "Delete")
    agency
 = 
 xs:NCName
    externalReferenceDefaultURI
 = 
 xs:anyURI
    id
 = 
 xs:string
    isMaintainable
 = 
 "true"
    isPublished
 = 
 xs:boolean : "false"
    objectSource
 = 
 xs:anyURI
    urn
 = 
 xs:anyURI
    version
 = 
 xs:string
    versionDate
 = 
 (xs:dateTime | xs:date | xs:gYearMonth | xs:gYear | xs:duration)
    xml:lang
 = 
 xs:language
    >
   
Content: 
 UserID*, VersionResponsibility?, VersionRationale*, r:Citation, Abstract+, r:UniverseReference+, r:SeriesStatement?, r:FundingInformation*, Purpose+, r:Coverage?, r:AnalysisUnit*, AnalysisUnitsCovered*, KindOfData*, r:OtherMaterial*, r:Note*, r:Embargo*, c:ConceptualComponent*, ConceptualComponentReference*, d:DataCollection*, DataCollectionReference*, l:BaseLogicalProduct*, LogicalProductReference*, p:PhysicalDataProduct*, PhysicalDataProductReference*, pi:PhysicalInstance*, PhysicalInstanceReference*, a:Archive?, ArchiveReference*, pr:DDIProfile*, DDIProfileReference*
</...>
Content Model Elements (30):
a:Archive,
Abstract,
AnalysisUnitsCovered,
ArchiveReference,
c:ConceptualComponent,
ConceptualComponentReference,
d:DataCollection,
DataCollectionReference,
DDIProfileReference,
KindOfData,
l:BaseLogicalProduct,
LogicalProductReference,
p:PhysicalDataProduct,
PhysicalDataProductReference,
PhysicalInstanceReference,
pi:PhysicalInstance,
pr:DDIProfile,
Purpose,
r:AnalysisUnit,
r:Citation,
r:Coverage,
r:Embargo,
r:FundingInformation,
r:Note,
r:OtherMaterial,
r:SeriesStatement,
r:UniverseReference,
r:VersionResponsibility (type xs:string),
UserID,
VersionRationale
All Direct / Indirect Based Elements (2):
LocalAddedContent, StudyUnit
Known Usage Locations
Annotation
Describes the study unit which encompasses specified data collection processes as well as their resultant data products. This includes all of it's associated documentation and metadata. A Study Unit corresponds to the "study" as described in a traditional codebook, although a codebook may relate to only a single data product from the study. Typically, a 2.* or earlier version can have its content marked up in DDI version 3.0 with a single study unit containing the bulk of the documentation and metadata. Multiple data products from the same "study" (typically separate DDI instances in 2.* and earlier) can be combined in a single 3.0 instance. (See "DDI 3.0 Documentation, Part 1: Basic Structures" for more detail regarding the mappings between 2.* and 3.0.)
Type Definition Detail
Type Derivation Tree
r:AbstractIdentifiableType
  r:AbstractVersionableType (extension)
      r:AbstractMaintainableType (extension)
          r:MaintainableType (extension)
              StudyUnitType (extension)
XML Source (w/o annotations (22); see within schema source)
<xs:complexType name="StudyUnitType">
<xs:complexContent>
<xs:extension base="r:MaintainableType">
<xs:sequence>
<xs:element ref="r:Citation"/>
<xs:element maxOccurs="unbounded" ref="Abstract"/>
<xs:element maxOccurs="unbounded" ref="r:UniverseReference"/>
<xs:element minOccurs="0" ref="r:SeriesStatement"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:FundingInformation"/>
<xs:element maxOccurs="unbounded" ref="Purpose"/>
<xs:element minOccurs="0" ref="r:Coverage"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:AnalysisUnit"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="AnalysisUnitsCovered"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="KindOfData"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:OtherMaterial"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Note"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Embargo"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="c:ConceptualComponent"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="ConceptualComponentReference"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="d:DataCollection"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="DataCollectionReference"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="l:BaseLogicalProduct"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="LogicalProductReference"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="p:PhysicalDataProduct"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="PhysicalDataProductReference"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="pi:PhysicalInstance"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="PhysicalInstanceReference"/>
<xs:element minOccurs="0" ref="a:Archive"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="ArchiveReference"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="pr:DDIProfile"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="DDIProfileReference"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Content Element Detail (defined in this component only; 27/30)
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 minOccurs="0" ref="a:Archive"/>
Abstract
Type:
r:IdentifiedStructuredStringType, complex content
A human-readable 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. During study development, or when creating documentation from incomplete legacy materials, this field should contain an appropriate statement such as "Under development", "Unavailable", "Not provided by creator", or some other similar statement.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" ref="Abstract"/>
AnalysisUnitsCovered
Type:
r:InternationalStringType, simple content
A narrative of the units of analysis in the study unit. May be repeated to provide for multiple-language support.
Simple Content
xs:string
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="AnalysisUnitsCovered"/>
ArchiveReference
Type:
r:ReferenceType, complex content
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="ArchiveReference"/>
c:ConceptualComponent
Type:
c:ConceptualComponentType, complex content
Contains documentation and metadata regarding the concepts and universes used by the study unit. This includes over-rides for documentation and metadata inherited from parent groups, if any.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="c:ConceptualComponent"/>
ConceptualComponentReference
Type:
r:ReferenceType, complex content
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="ConceptualComponentReference"/>
d:DataCollection
Type:
d:DataCollectionType, complex content
Contains documentation and metadata regarding the data collection methods and processes of the study unit. This includes over-rides for documentation and metadata inherited from parent groups, if any.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="d:DataCollection"/>
DataCollectionReference
Type:
r:ReferenceType, complex content
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="DataCollectionReference"/>
DDIProfileReference
Type:
r:ReferenceType, complex content
References a DDI Profile used by the study unit
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="DDIProfileReference"/>
KindOfData
Type:
KindOfDataType, simple content
Describes, with a string or a term from a controlled vocabulary, 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.
Simple Content
xs:string
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="KindOfData"/>
l:BaseLogicalProduct
Type:
l:BaseLogicalProductType, complex content
Abstract:
(may not be used directly in instance XML documents)
Subst.Gr:
may be substituted with 2 elements
Contains documentation and metadata regarding the logical data products of the study unit. This includes over-rides for documentation and metadata inherited from parent groups, if any.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="l:BaseLogicalProduct"/>
LogicalProductReference
Type:
r:ReferenceType, complex content
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="LogicalProductReference"/>
p:PhysicalDataProduct
Type:
p:PhysicalDataProductType, complex content
Contains documentation and metadata regarding a physical structure of data products of the study unit.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="p:PhysicalDataProduct"/>
PhysicalDataProductReference
Type:
r:ReferenceType, complex content
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="PhysicalDataProductReference"/>
PhysicalInstanceReference
Type:
r:ReferenceType, complex content
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="PhysicalInstanceReference"/>
pi:PhysicalInstance
Type:
pi:PhysicalInstanceType, complex content
Contains documentation and metadata regarding a physical instance of one of the data products of the study unit.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="pi:PhysicalInstance"/>
pr:DDIProfile
Type:
pr:DDIProfileType, complex content
Contains a DDI Profile which is used by the study unit, and which can be referenced externally.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="pr:DDIProfile"/>
Purpose
Type:
r:IdentifiedStructuredStringType, complex content
The purpose of the study, in human-readable form. 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. During study development, or when creating documentation from incomplete legacy materials, this field should contain an appropriate statement such as "Under development", "Unavailable", "Not provided by creator", or some other similar statement.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" ref="Purpose"/>
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:Citation
Type:
r:CitationType, complex content
Encodes the bibliographic information describing the original study.
XML Source (w/o annotations (1); see within schema source)
<xs:element ref="r:Citation"/>
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 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: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: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:Note
Type:
r:NoteType, complex content
Contains notes pertinent to the study unit and its contents. References can be made from items in this section to any identifiable element in the instance.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Note"/>
r:OtherMaterial
Type:
r:OtherMaterialType, complex content
Contains references to other materials relevent to the study unit, whether in DDI form or external. References can be made from items in this section to any identifiable element in the instance.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:OtherMaterial"/>
r:SeriesStatement
Type:
r:SeriesStatementType, complex content
Information regarding the official series of which a study unit or group of study units is a part. One may point to the URL of a series repository and then use the Name field to indicate the series itself as identified in that repository. Fields also exist for describing the series and providing abbreviations.
XML Source (w/o annotations (1); see within schema source)
<xs:element 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. During development or when creating documentation from incomplete legacy materials this field should contain an appropriate statement such as "Under development", "Unavailable", "Not provided by creator", or other similar statement.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" ref="r:UniverseReference"/>
XML schema documentation generated with DocFlex/XML SDK 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set