ddi:studyunit:3

ddi:studyunit:3_0

Imports: ddi:reusable:3_0 (reusable.xsd)
Imports: ddi:archive:3_0 (archive.xsd)
Imports: ddi:conceptualcomponent:3_0 (conceptualcomponent.xsd)
Imports: ddi:datacollection:3_0 (datacollection.xsd)
Imports: ddi:logicalproduct:3_0 (logicalproduct.xsd)
Imports: ddi:physicaldataproduct:3_0 (physicaldataproduct.xsd)
Imports: ddi:physicalinstance:3_0 (physicalinstance.xsd)
Imports: ddi:ddiprofile:3_0 (ddiprofile.xsd)

Global Elements

StudyUnit (StudyUnitType):

Abstract (r:IdentifiedStructuredStringType): 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

Purpose (r:IdentifiedStructuredStringType): 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.

DDIProfileReference (r:ReferenceType): References a DDI Profile used by the study unit

KindOfData (KindOfDataType): 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.

Complex Types

StudyUnitType: 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.)

Content:
- Extends: r:MaintainableType
- Base Content
  - Extends: AbstractMaintainableType
  - Base Content
    - Extends: AbstractVersionableType
    - Base Content
      - Extends: AbstractIdentifiableType
      - Base Content
        Sequence of:
        [Reference] (Name) - min. 0 - max. unbounded
        Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
      - Extended Content
        Sequence of:
        VersionResponsibility (xs:string) - min. 0
        Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
        [Reference] (VersionRationale) - min. 0 - max. unbounded
        Textual description of the rationale/purpose for a version change.
      - Base Attributes
        id (BaseIDType) - required
        Assigned ID, unique within its maintainable object.
        urn (xs:anyURI) - optional
        DDI-structured URN of the element as described in Part I of the Technical Documentation.
        action (ActionCodeType) - optional
        Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
      - Extended Attributes
        version (NewVersionType) - optional
        Restricted string - numeric with optional decimal points.
        versionDate (BaseDateType) - optional
        Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
    - Extended Attributes
      - agency (xs:NCName) - optional
        Maintaining agency as described in Part 1 of the Technical Specification.
  - Extended Attributes
    - isMaintainable (xs:boolean) - fixed: true
- Extended Content
  - Sequence of:
    - [Reference] (r:Citation)
      - Encodes the bibliographic information describing the original study.
    - [Reference] (Abstract) - max. unbounded
      - 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.
    - [Reference] (r:UniverseReference) - max. unbounded
      - 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.
    - [Reference] (r:SeriesStatement) - min. 0
      - 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.
    - [Reference] (r:FundingInformation) - min. 0 - max. unbounded
      - Contains details of the study unit's funding, including information about grants, agencies, etc.
    - [Reference] (Purpose) - max. unbounded
      - 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.
    - [Reference] (r:Coverage) - min. 0
      - 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.
    - [Reference] (r:AnalysisUnit) - min. 0 - max. unbounded
      - 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.
    - AnalysisUnitsCovered (r:InternationalStringType) - min. 0 - max. unbounded
      - A narrative of the units of analysis in the study unit. May be repeated to provide for multiple-language support.
    - [Reference] (KindOfData) - min. 0 - max. unbounded
      - 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.
    - [Reference] (r:OtherMaterial) - min. 0 - max. unbounded
      - 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.
    - [Reference] (r:Note) - min. 0 - max. unbounded
      - 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.
    - [Reference] (r:Embargo) - min. 0 - max. unbounded
      - Embargo information about the study unit. References to embargo information in this section can be made from individual variables.
    - [Reference] (c:ConceptualComponent) - min. 0 - max. unbounded
      - 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.
    - [Reference] (d:DataCollection) - min. 0 - max. unbounded
      - 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.
    - [Reference] (l:BaseLogicalProduct) - min. 0 - max. unbounded
      - 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.
    - [Reference] (p:PhysicalDataProduct) - min. 0 - max. unbounded
      - Contains documentation and metadata regarding a physical structure of data products of the study unit.
    - [Reference] (pi:PhysicalInstance) - min. 0 - max. unbounded
      - Contains documentation and metadata regarding a physical instance of one of the data products of the study unit.
    - [Reference] (a:Archive) - min. 0
      - 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).
    - [Reference] (pr:DDIProfile) - min. 0 - max. unbounded
      - Contains a DDI Profile which is used by the study unit, and which can be referenced externally.
    - [Reference] (DDIProfileReference) - min. 0 - max. unbounded
      - References a DDI Profile used by the study unit

KindOfDataType: 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.

Content:
- Extends: r:CodeValueType
- Base Content
  - Extends: xs:string
  - Extended Attributes
    - codeListID (xs:string) - optional
      - Identifies the code list that the value is taken from.
    - codeListAgency (xs:string) - optional
      - Agency maintaining the code list.
    - codeListVersion (xs:string) - default: 1.0
      - Version of the code list. (Default value is 1.0)
    - otherValue (xs:string) - optional
      - Other Value.
- Extended Attributes
  - type (KindOfDataTypeType) - optional
    - Provides a description of the types of data described by the KindOfData element.

Simple Types

KindOfDataTypeType: Provides a description of the types of data described by the KindOfData element.

Restricts: xs:string

Code: Qualitative - Narrative or descriptive accounts that may be subjected to interpretive analysis
Code: Quantitative - Numerical or coded data that may be subjected to statistical analysis
Code: Mixed - Both qualitative and quantitative data within the same collection.

This documentation is extracted from the inline documentation of DDI 3.0 XML Schema and is licensed under the terms of the GNU General Public License as the schema itself.