ddi:group:3_0
Imports: ddi:reusable:3_0 (reusable.xsd)
Imports: ddi:archive:3_0 (archive.xsd)
Imports: ddi:comparative:3_0 (comparative.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:studyunit:3_0 (studyunit.xsd)
Imports: ddi:ddiprofile:3_0 (ddiprofile.xsd)
Global Elements
Group (GroupType): Groups are used to document related data. They may contain subgroups or individual study items, and may also contain metadata which is applicable to all members of the group, and is subject to over-rides at the lower levels. Thus, metadata is inherited down the grouping structure. The purpose of groups is described using the attributes which summarize relationships along the dimensions of time, panel, geography, instrument and language. These attributes allow the purpose to be machine-actionable, while the group also includes an element for describing the purpose in human-readable format.
ResourcePackage (ResourcePackageType): The Resource is a specialized type of Group which is intended to hold re-usable metadata such as Category Schemes, Variables, etc. It is placed in the Resource construct for the purposes of being included by reference in other Groups and StudyUnits which describe studies, but does not directly describe existing studies itself.
Abstract (r:IdentifiedStructuredStringType): Human-readable summary of the grouped material.
Purpose (r:IdentifiedStructuredStringType): Human-readable explanation of why the creator published these objects.
Concepts (ConceptType): Lists, or references, the concepts describing the data that are being documented.
DataCollection (DataCollectionType): Shared documentation regarding data collection for all members of the group, subject to over-rides at a lower level.
LogicalProduct (LogicalProductType): Shared documentation regarding the logical data products of all members of the group, subject to over-rides at a lower level.
PhysicalDataProduct (PhysicalDataProductType): Shared documentation regarding the physical data products of all members of the group, subject to over-rides at a lower level.
StudyUnit (StudyUnitType): Description of an individual study being documented as a member of the group. The study unit description inherits all metadata found at higher levels - that is, all metadata and documentation describing the groups and subgroups of which the study unit is a member. This metadata and documentation may be over-ridden within the study unit.
SubGroup (SubGroupType): Subordinate group which inherits all the metadata provided in the higher-level groups and subgroups of which this subgroup is a member, subject to over-rides within the sub-group itself.
DDIProfileReference (r:ReferenceType): References a DDI Profile used by the group or resource package.
Reference (r:ReferenceType): References a module that is external to the group, sub-group, or resource package.
Complex Types
ResourcePackageType: The Resource Package is a specialized structure which is intended to hold reusable metadata such as Category Schemes, Variable Schemes, etc. These are placed in the Resource Package for the purpose of being included by reference in Groups and StudyUnits. The Resource Package has a similar structure to the Group.
- 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
- Extended Content
- Sequence of:
- [Reference] (r:Citation) - min. 0
- Includes bibliographic citation information for the resource package.
- [Reference] (Abstract) - min. 0 - max. unbounded
- Human-readable summary of the material in the resource package.
- [Reference] (Purpose) - max. unbounded
- Human-readable explanation of why the creator grouped these objects together for reuse. When creating documentation from incomplete legacy materials this field may contain a statement such as "Unavailable", "Not provided by creator", or other similar statements.
- [Reference] (r:FundingInformation) - min. 0 - max. unbounded
- Provides information about the agency and grant(s) which funded the resource package.
- [Reference] (r:Coverage) - min. 0
- Documents the topical, spatial, and temporal coverage of the resource package.
- [Reference] (r:UniverseReference) - min. 0
- References the universe or sub-universe of the resource package.
- [Reference] (r:OtherMaterial) - min. 0 - max. unbounded
- References other materials related to the resource package.
- [Reference] (a:Archive) - min. 0
- Provides archive-specific information, including a listing of items.
- [Reference] (r:Note) - min. 0 - max. unbounded
- Notes regarding the group as a whole, or pertaining to all members of the resource package.
- [Reference] (Concepts) - min. 0 - max. unbounded
- Documents, or references, concept schemes, universe schemes, geographic structure and geographic location schemes.
- [Reference] (DataCollection) - min. 0 - max. unbounded
- Reusable documentation regarding the data collection process.
- [Reference] (LogicalProduct) - min. 0 - max. unbounded
- Reusable documentation pertaining to the logical description of data.
- [Reference] (PhysicalDataProduct) - min. 0 - max. unbounded
- Reusable documentation regarding a physical data product.
- [Reference] (cm:Comparison) - min. 0
- Provides documentation regarding the comparability of various DDI resources.
- [Reference] (pr:DDIProfile) - min. 0 - max. unbounded
- Contains a reusable DDI Profile.
- [Reference] (DDIProfileReference) - min. 0 - max. unbounded
- References a DDI Profile used by the resource package.
- [Reference] (a:OrganizationScheme) - min. 0 - max. unbounded
- [Reference] (c:ConceptScheme) - min. 0 - max. unbounded
- [Reference] (c:UniverseScheme) - min. 0 - max. unbounded
- [Reference] (c:GeographicStructureScheme) - min. 0 - max. unbounded
- [Reference] (c:GeographicLocationScheme) - min. 0 - max. unbounded
- [Reference] (d:InterviewerInstructionScheme) - min. 0 - max. unbounded
- [Reference] (d:ControlConstructScheme) - min. 0 - max. unbounded
- [Reference] (d:QuestionScheme) - min. 0 - max. unbounded
- [Reference] (l:CategoryScheme) - min. 0 - max. unbounded
- [Reference] (l:CodeScheme) - min. 0 - max. unbounded
- [Reference] (l:NCubeScheme) - min. 0 - max. unbounded
- [Reference] (l:VariableScheme) - min. 0 - max. unbounded
- [Reference] (p:PhysicalStructureScheme) - min. 0 - max. unbounded
- [Reference] (p:RecordLayoutScheme) - min. 0 - max. unbounded
GroupType: Groups are used to document related data. They may contain subgroups or individual study items, and may also contain metadata which is applicable to all members of the group, and is subject to over-rides at the lower levels. Thus, metadata is inherited down the grouping structure. The purpose of groups is described using the attributes which summarize relationships along the dimensions of time, panel, geography, instrument and language. These attributes allow the purpose to be machine-actionable, while the group also includes an element for describing the purpose in human-readable format.
- 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
- Extended Content
- Sequence of:
- [Reference] (r:Citation) - min. 0
- Includes bibliographic citation information for the group.
- [Reference] (Abstract) - min. 0 - max. unbounded
- Human-readable summary of the grouped material.
- [Reference] (Purpose) - max. unbounded
- Human-readable explanation of why the creator grouped these objects together. Example: Grouping of Longitudinal Survey elements. Example: Collection of StudyUnits to be used by class SOC1257- Impact of Aging on Social Services. Use this element to describe the nature of a series and/or the reason for treating the included study units and/or subgroups as a group. Include information on the limitations of the grouping and intended usage if applicable. When creating documentation from incomplete legacy materials this field may contain a statement such as "Unavailable", "Not provided by creator", or other similar statements.
- [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
- Provides information about the agency and grant(s) which funded the group.
- [Reference] (r:Coverage) - min. 0
- Documents the topical, spatial, and temporal coverage of the group.
- [Reference] (r:UniverseReference) - min. 0
- References the universe or sub-universe of the group.
- [Reference] (r:OtherMaterial) - min. 0 - max. unbounded
- References other materials related to the group.
- [Reference] (a:Archive) - min. 0
- Provides archive-specific information, including a listing of items.
- [Reference] (r:Note) - min. 0 - max. unbounded
- Notes regarding the group as a whole, or pertaining to all members of the group.
- [Reference] (Concepts) - min. 0 - max. unbounded
- Lists, or references, the concepts describing the data that are being documented.
- [Reference] (DataCollection) - min. 0 - max. unbounded
- Shared documentation regarding data collection for all members of the group, subject to overrides at a lower level.
- [Reference] (LogicalProduct) - min. 0 - max. unbounded
- Shared documentation regarding the logical data products of all members of the group, subject to overrides at a lower level.
- [Reference] (PhysicalDataProduct) - min. 0 - max. unbounded
- Shared documentation regarding physical data products of all members of the group, subject to overrides at a lower level.
- [Reference] (StudyUnit) - min. 0 - max. unbounded
- Description of an individual study being documented as a member of the group. The study unit description inherits all metadata found at higher levels - that is, all metadata and documentation describing the groups and subgroups of which the study unit is a member. This metadata and documentation may be over-ridden within the study unit.
- [Reference] (SubGroup) - min. 0 - max. unbounded
- Subordinate group which inherits all the metadata provided in the higher-level groups and subgroups of which this subgroup is a member, subject to overrides within the subgroup itself.
- [Reference] (cm:Comparison) - min. 0
- Provides documentation regarding the comparability of study units or subgroups within the containing group.
- [Reference] (pr:DDIProfile) - min. 0 - max. unbounded
- Contains a DDI Profile which is used by the group, and which can be referenced externally. If contained in a ResourcePackage, it is intended only for reuse elsewhere.
- [Reference] (DDIProfileReference) - min. 0 - max. unbounded
- References a DDI Profile used by the group or resource package.
- Extended Attributes
- time (TimeGroupCodeType) - required
- Indicates how all members of the group are related along the dimension of time (for example single occurrence, multiple occurrence, etc.).
- instrument (InstrumentGroupCodeType) - required
- Indicates how all members of the group are related in terms of the instruments used to collect data (single, multiple, etc.).
- panel (PanelGroupCodeType) - required
- Indicates how all members of the group are related in terms of type of panel (single, rolling, etc.).
- geography (GeographyGroupCodeType) - required
- Indicates how all members of the group are related along the dimension of geography.
- dataSet (DataSetGroupCodeType) - required
- Indicates how all members of the group are related in terms of physical data products in relation to data collection efforts.
- language (LanguageGroupCodeType) - required
- Indicates how all members of the group are related in terms of physical data products in relation to data collection efforts.
- userDefinedGroupProperty (xs:string) - optional
- Provides a user-defined grouping property, different from those supplied in other attributes.
- userDefinedGroupPropertyValue (xs:string) - optional
- Provides a value for the user-defined group property supplied in userDefinedGroupProperty.
- groupInherits (xs:boolean) - default: true
- Default is true, and allows for inheritance of all properties and modules, and the use of lower-level over-rides. If set to false, inheritance is switched off for specific groups.
SubGroupType: The subgroup element is a container for a group that is a child of a higher-level group described in this module, but may also be a parent to other (subordinate) groups. A group can be fully described, or just referenced, within its subgroup container.
- Content:
- Extends: r:VersionableType
- 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
- Extended Content
- Sequence of:
- [Reference] (r:Citation) - min. 0
- Includes bibliographic citation information for the group.
- [Reference] (Abstract) - min. 0 - max. unbounded
- Human-readable summary of the grouped material.
- [Reference] (Purpose) - max. unbounded
- Human-readable explanation of why the creator grouped these objects together. Example: Grouping of Longitudinal Survey elements. Example: Collection of StudyUnits to be used by class SOC1257- Impact of Aging on Social Services. Use this element to describe the nature of a series and/or the reason for treating the studyunits as a group. Include information on the limitations of the grouping and intended usage if applicable.
- [Reference] (r:SeriesStatement) - min. 0
- Information regarding the official series of which a study unit or group of study units is a part. You 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
- Provides information about the agency and grant(s) which funded the group.
- [Reference] (r:Coverage) - min. 0
- Documents the topical, spatial, and temporal coverage of the group.
- [Reference] (r:UniverseReference) - min. 0
- References the universe or sub-universe of the group.
- [Reference] (r:OtherMaterial) - min. 0 - max. unbounded
- References other materials related to the group.
- [Reference] (a:Archive) - min. 0
- Provides archive-specific information, including a listing of items.
- [Reference] (r:Note) - min. 0 - max. unbounded
- Notes regarding the group as a whole, or pertaining to all members of the group.
- [Reference] (Concepts) - min. 0 - max. unbounded
- Lists, or references, the concepts describing the data that are being documented.
- [Reference] (DataCollection) - min. 0 - max. unbounded
- Shared documentation regarding data collection for all members of the group, subject to over-rides at a lower level.
- [Reference] (LogicalProduct) - min. 0 - max. unbounded
- Shared documentation regarding the logical data products of all members of the group, subject to over-rides at a lower level.
- [Reference] (PhysicalDataProduct) - min. 0 - max. unbounded
- Shared documentation regarding physical data products of all members of the group, subject to over-rides at a lower level.
- [Reference] (StudyUnit) - min. 0 - max. unbounded
- Description of an individual study being documented as a member of the group. The study unit description inherits all metadata found at higher levels - that is, all metadata and documentation describing the groups and subgroups of which the study unit is a member. This metadata and documentation may be over-ridden within the study unit.
- [Reference] (cm:Comparison) - min. 0
- Provides documentation regarding the comparability of study units or subgroups within the containing group.
- [Reference] (pr:DDIProfile) - min. 0 - max. unbounded
- Contains a DDI Profile which is used by the group, and which can be referenced externally. If contained in a ResourcePackage, it is intended only for re-use elsewhere.
- [Reference] (DDIProfileReference) - min. 0 - max. unbounded
- References a DDI Profile used by the group or resource package.
- [Reference] (SubGroup) - min. 0 - max. unbounded
- Includes fully detailed, in-line information about a group that is the child of a higher-level group described in this module.
- [Reference] (Reference) - min. 0 - max. unbounded
- References a sub-group that is the child of a higher-level group or sub-group described in this module.
- Extended Attributes
- time (TimeGroupCodeType) - required
- Indicates how all members of the group are related along the dimension of time (for example single occurrence, multiple occurrence, etc.).
- instrument (InstrumentGroupCodeType) - required
- Indicates how all members of the group are related in terms of the instruments used to collect data (single, multiple, etc.).
- panel (PanelGroupCodeType) - required
- Indicates how all members of the group are related in terms of type of panel (single, rolling, etc.).
- geography (GeographyGroupCodeType) - required
- Indicates how all members of the group are related along the dimension of geography.
- dataSet (DataSetGroupCodeType) - required
- Indicates how all members of the group are related in terms of physical data products in relation to data collection efforts.
- language (LanguageGroupCodeType) - required
- Indicates how all members of the group are related in terms of physical data products in relation to data collection efforts.
- userDefinedGroupProperty (xs:string) - optional
- Provides a user-defined group property, different from those supplied in other attributes.
- userDefinedGroupPropertyValue (xs:string) - optional
- Provides a value for the user-defined group property supplied in userDefinedGroupProperty.
- groupInherits (xs:boolean) - default: true
- Default is true, and allows for inheritance of all properties and modules, and the use of lower-level over-rides. If set to false, inheritance is switched off for specific groups.
ConceptType: Allows for inclusion of a fully marked up Conceptual Components module or referencing such a module that is external to the instance.
- Content:
- Choice Of:
- [Reference] (c:ConceptualComponent)
- Lists, or references, the concepts describing the data that are being documented.
- [Reference] (Reference)
- References a Conceptual Components module that is external to the group.
DataCollectionType: Allows for inclusion of data collection information that is common to all members of the group, or referencing external data collection information.
- Content:
- Choice Of:
- [Reference] (d:DataCollection)
- Includes data collection information that is common to all members of the group.
- [Reference] (Reference)
- References external data collection information.
LogicalProductType: Allows for inclusion of a logical product that is common to all members of the group, or referencing an external logical product.
- Content:
- Choice Of:
- [Reference] (l:BaseLogicalProduct)
- Contains a logical product that is common to all members of the group.
- [Reference] (Reference)
- References an external logical product module.
PhysicalDataProductType: Allows for inclusion of a physical data product for reuse by reference.
- Content:
- Choice Of:
- [Reference] (p:PhysicalDataProduct)
- Contains a physical data product module.
- [Reference] (Reference)
- References an external physical data product module.
StudyUnitType: Allows for inclusion of a study unit that belongs to the group as a direct child. Subgroups may also contain study units, and individual study units and subgroups may be members of a single group. Study units can be included in any group or subgroup either as in-line documentation/metadata or by reference.
- Content:
- Choice Of:
- [Reference] (s:StudyUnit)
- Contains the detailed documentation for a study unit which is a member of the group.
- [Reference] (Reference)
- References a study unit which is a member of the group, but is documented in a different DDI metadata set.
Simple Types
TimeGroupCodeType: Indicates how all members of the group are related along the dimension of time. These relationships are inferred by the markup author, and should be considered as her/his own interpretation of the data.
- Restricts: xs:NMTOKEN
- Code: T0 -
No specified relationship
- Code: T1 -
Single Occurrence
- Code: T2 -
Multiple Occurrence: Regular Occurrence: Continuing
- Code: T3 -
Multiple Occurrence: Regular Occurrence: Limited time
- Code: T4 -
Multiple Occurrence: Irregular Occurrence: Continuing
- Code: T5 -
Multiple Occurrence: Irregular Occurrence: Limited time
InstrumentGroupCodeType: Indicates how all members of the group are related in terms of the instruments used to collect data. These relationships are inferred by the markup author, and should be considered as her/his own interpretation of the data.
- Restricts: xs:NMTOKEN
- Code: I0 -
No specified relationship
- Code: I1 -
Single
- Code: I2 -
Multiple: Integrated set of 2 or more instruments used for different subpopulations
- Code: I3 -
Multiple: Base with Topical changes
PanelGroupCodeType: Indicates how all members of the group are related in terms of type of panel. These relationships are inferred by the markup author, and should be considered as her/his own interpretation of the data.
- Restricts: xs:NMTOKEN
- Code: P0 -
No specified relationship
- Code: P1 -
Single panel surveyed multiple times
- Code: P2 -
Single panel surveyed once
- Code: P3 -
Rolling panel
- Code: P4 -
Different panel each survey
GeographyGroupCodeType: Indicates how all members of the group are related along the dimension of geography. These relationships are inferred by the markup author, and should be considered as her/his own interpretation of the data.
- Restricts: xs:NMTOKEN
- Code: G0 -
No specified relationship
- Code: G1 -
Single geography surveyed multiple times
- Code: G2 -
Single geography surveyed once
- Code: G3 -
Rolling geography
- Code: G4 -
Different geography each survey
DataSetGroupCodeType: Indicates how all members of the group are related in terms of physical data products in relation to data collection efforts. These relationships are inferred by the markup author, and should be considered as her/his own interpretation of the data.
- Restricts: xs:NMTOKEN
- Code: D0 -
No specified relationship
- Code: D1 -
Single data file from a data collection
- Code: D2 -
Multiple data products from a single data collection
- Code: D3 -
Integration of multiple data sets into a single integrated structure
- Code: D4 -
Multiple data files each from a different data collection
LanguageGroupCodeType: Indicates the panel relationships among all Study Units within the group and its sub-groups. This is an assertion of the relationship, and it is incumbent on the creating user or application to make sure that the assertion is true.
- Restricts: xs:NMTOKEN
- Code: L0 -
No formal relationship - not a factor of grouping
- Code: L1 -
Single language
- Code: L2 -
All original languages with full language equivalence
- Code: L3 -
Original language(s) plus translation(s) with full language equivalence
- Code: L4 -
Translations from external original; full language equivalence
- Code: L5 -
Translations from a non-included original and have full language equivalence
- Code: L6 -
Original languages(s) plus translation(s) with partial relationship
- Code: L7 -
Translations from external original; partial relationships
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.