DDI 3.1 XML Schema Documentation (2009-10-18)
© DDI Alliance 2009 - licensed under the terms of the GNU Lesser General Public License
complexType "GroupType"
Namespace:
ddi:group:3_1
Content:
complex, 20 attributes, 22 elements
Defined:
globally in group.xsd, see XML source
Includes:
definitions of 9 attributes and 19 elements
Used:
at 1 location
XML Representation Summary
<...
    action
 = 
 ("Add" | "Update" | "Delete")
    agency
 = 
 xs:NCName
    dataSet
 = 
 ("D0" | "D1" | "D2" | "D3" | "D4") : "D0"
    externalReferenceDefaultURI
 = 
 xs:anyURI
    geography
 = 
 ("G0" | "G1" | "G2" | "G3" | "G4") : "G0"
    groupInherits
 = 
 xs:boolean : "true"
    id
 = 
 xs:string
    instrument
 = 
 ("I0" | "I1" | "I2" | "I3") : "I0"
    isMaintainable
 = 
 "true"
    isPublished
 = 
 xs:boolean : "false"
    language
 = 
 ("L0" | "L1" | "L2" | "L3" | "L4" | "L5" | "L6" | "L7") : "L0"
    objectSource
 = 
 xs:anyURI
    panel
 = 
 ("P0" | "P1" | "P2" | "P3" | "P4") : "P0"
    time
 = 
 ("T0" | "T1" | "T2" | "T3" | "T4" | "T5") : "T0"
    urn
 = 
 xs:anyURI
    userDefinedGroupProperty
 = 
 xs:string
    userDefinedGroupPropertyValue
 = 
 xs:string
    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*, Purpose+, r:SeriesStatement?, r:FundingInformation*, r:Coverage?, r:UniverseReference?, r:OtherMaterial*, a:Archive?, r:Note*, Concepts*, DataCollection*, LogicalProduct*, PhysicalDataProduct*, StudyUnit*, SubGroup*, cm:Comparison?, pr:DDIProfile*, DDIProfileReference*
</...>
Content Model Elements (22):
a:Archive,
Abstract,
cm:Comparison,
Concepts,
DataCollection,
DDIProfileReference,
LogicalProduct,
PhysicalDataProduct,
pr:DDIProfile,
Purpose,
r:Citation,
r:Coverage,
r:FundingInformation,
r:Note,
r:OtherMaterial,
r:SeriesStatement,
r:UniverseReference,
r:VersionResponsibility (type xs:string),
StudyUnit,
SubGroup,
UserID,
VersionRationale
All Direct / Indirect Based Elements (1):
Group
Known Usage Locations
Annotation
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.
Type Definition Detail
Type Derivation Tree
r:AbstractIdentifiableType
  r:AbstractVersionableType (extension)
      r:AbstractMaintainableType (extension)
          r:MaintainableType (extension)
              GroupType (extension)
XML Source (w/o annotations (29); see within schema source)
<xs:complexType name="GroupType">
<xs:complexContent>
<xs:extension base="r:MaintainableType">
<xs:sequence>
<xs:element minOccurs="0" ref="r:Citation"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Abstract"/>
<xs:element maxOccurs="unbounded" ref="Purpose"/>
<xs:element minOccurs="0" ref="r:SeriesStatement"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:FundingInformation"/>
<xs:element minOccurs="0" ref="r:Coverage"/>
<xs:element minOccurs="0" ref="r:UniverseReference"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:OtherMaterial"/>
<xs:element minOccurs="0" ref="a:Archive"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Note"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Concepts"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="DataCollection"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="LogicalProduct"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="PhysicalDataProduct"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="StudyUnit"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="SubGroup"/>
<xs:element minOccurs="0" ref="cm:Comparison"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="pr:DDIProfile"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="DDIProfileReference"/>
</xs:sequence>
<xs:attribute default="T0" name="time" type="TimeGroupCodeType"/>
<xs:attribute default="I0" name="instrument" type="InstrumentGroupCodeType"/>
<xs:attribute default="P0" name="panel" type="PanelGroupCodeType"/>
<xs:attribute default="G0" name="geography" type="GeographyGroupCodeType"/>
<xs:attribute default="D0" name="dataSet" type="DataSetGroupCodeType"/>
<xs:attribute default="L0" name="language" type="LanguageGroupCodeType"/>
<xs:attribute name="userDefinedGroupProperty" type="xs:string" use="optional"/>
<xs:attribute name="userDefinedGroupPropertyValue" type="xs:string" use="optional"/>
<xs:attribute default="true" name="groupInherits" type="xs:boolean"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Attribute Detail (defined in this component only; 9/20)
dataSet
Type:
DataSetGroupCodeType
Use:
optional
Indicates how all members of the group are related in terms of physical data products in relation to data collection efforts.
Attribute Value
enumeration of xs:NMTOKEN
Enumeration:
"D0"
 - 
 No specified relationship
"D1"
 - 
 Single data file from a data collection
"D2"
 - 
 Multiple data products from a single data collection
"D3"
 - 
 Integration of multiple data sets into a single integrated structure
"D4"
 - 
 Multiple data files each from a different data collection
Default:
"D0"
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="D0" name="dataSet" type="DataSetGroupCodeType"/>
geography
Type:
GeographyGroupCodeType
Use:
optional
Indicates how all members of the group are related along the dimension of geography.
Attribute Value
enumeration of xs:NMTOKEN
Enumeration:
"G0"
 - 
 No specified relationship
"G1"
 - 
 Single geography surveyed multiple times
"G2"
 - 
 Single geography surveyed once
"G3"
 - 
 Rolling geography
"G4"
 - 
 Different geography each survey
Default:
"G0"
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="G0" name="geography" type="GeographyGroupCodeType"/>
groupInherits
Type:
xs:boolean, predefined
Use:
optional
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.
Attribute Value
Default:
"true"
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="true" name="groupInherits" type="xs:boolean"/>
instrument
Type:
InstrumentGroupCodeType
Use:
optional
Indicates how all members of the group are related in terms of the instruments used to collect data (single, multiple, etc.).
Attribute Value
enumeration of xs:NMTOKEN
Enumeration:
"I0"
 - 
 No specified relationship
"I1"
 - 
 Single
"I2"
 - 
 Multiple: Integrated set of 2 or more instruments used for different subpopulations
"I3"
 - 
 Multiple: Base with Topical changes
Default:
"I0"
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="I0" name="instrument" type="InstrumentGroupCodeType"/>
language
Type:
LanguageGroupCodeType
Use:
optional
Indicates how all members of the group are related in terms of physical data products in relation to data collection efforts.
Attribute Value
enumeration of xs:NMTOKEN
Enumeration:
"L0"
 - 
 No formal relationship - not a factor of grouping
"L1"
 - 
 Single language
"L2"
 - 
 All original languages with full language equivalence
"L3"
 - 
 Original language(s) plus translation(s) with full language equivalence
"L4"
 - 
 Translations from external original; full language equivalence
"L5"
 - 
 Translations from a non-included original and have full language equivalence
"L6"
 - 
 Original languages(s) plus translation(s) with partial relationship
"L7"
 - 
 Translations from external original; partial relationships
Default:
"L0"
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="L0" name="language" type="LanguageGroupCodeType"/>
panel
Type:
PanelGroupCodeType
Use:
optional
Indicates how all members of the group are related in terms of type of panel (single, rolling, etc.).
Attribute Value
enumeration of xs:NMTOKEN
Enumeration:
"P0"
 - 
 No specified relationship
"P1"
 - 
 Single panel surveyed multiple times
"P2"
 - 
 Single panel surveyed once
"P3"
 - 
 Rolling panel
"P4"
 - 
 Different panel each survey
Default:
"P0"
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="P0" name="panel" type="PanelGroupCodeType"/>
time
Type:
TimeGroupCodeType
Use:
optional
Indicates how all members of the group are related along the dimension of time (for example single occurrence, multiple occurrence, etc.).
Attribute Value
enumeration of xs:NMTOKEN
Enumeration:
"T0"
 - 
 No specified relationship
"T1"
 - 
 Single Occurrence
"T2"
 - 
 Multiple Occurrence: Regular Occurrence: Continuing
"T3"
 - 
 Multiple Occurrence: Regular Occurrence: Limited time
"T4"
 - 
 Multiple Occurrence: Irregular Occurrence: Continuing
"T5"
 - 
 Multiple Occurrence: Irregular Occurrence: Limited time
Default:
"T0"
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="T0" name="time" type="TimeGroupCodeType"/>
userDefinedGroupProperty
Type:
xs:string, predefined
Use:
optional
Provides a user-defined grouping property, different from those supplied in other attributes.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="userDefinedGroupProperty" type="xs:string" use="optional"/>
userDefinedGroupPropertyValue
Type:
xs:string, predefined
Use:
optional
Provides a value for the user-defined group property supplied in userDefinedGroupProperty.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="userDefinedGroupPropertyValue" type="xs:string" use="optional"/>
Content Element Detail (defined in this component only; 19/22)
a:Archive
Type:
a:ArchiveType, complex content
Provides archive-specific information, including a listing of items.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="a:Archive"/>
Abstract
Type:
r:IdentifiedStructuredStringType, complex content
Human-readable summary of the grouped material.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Abstract"/>
cm:Comparison
Type:
cm:ComparisonType, complex content
Provides documentation regarding the comparability of study units or subgroups within the containing group.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="cm:Comparison"/>
Concepts
Type:
ConceptType, complex content
Lists, or references, the concepts describing the data that are being documented.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="Concepts"/>
DataCollection
Type:
DataCollectionType, complex content
Shared documentation regarding data collection for all members of the group, subject to overrides at a lower level.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="DataCollection"/>
DDIProfileReference
Type:
r:ReferenceType, complex content
References a DDI Profile used by the group or resource package.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="DDIProfileReference"/>
LogicalProduct
Type:
LogicalProductType, complex content
Shared documentation regarding the logical data products of all members of the group, subject to overrides at a lower level.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="LogicalProduct"/>
PhysicalDataProduct
Type:
PhysicalDataProductType, complex content
Shared documentation regarding physical data products of all members of the group, subject to overrides at a lower level.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="PhysicalDataProduct"/>
pr:DDIProfile
Type:
pr:DDIProfileType, complex content
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.
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
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.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" ref="Purpose"/>
r:Citation
Type:
r:CitationType, complex content
Includes bibliographic citation information for the group.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:Citation"/>
r:Coverage
Type:
r:CoverageType, complex content
Documents the topical, spatial, and temporal coverage of the group.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:Coverage"/>
r:FundingInformation
Type:
r:FundingInformationType, complex content
Provides information about the agency and grant(s) which funded the group.
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
Notes regarding the group as a whole, or pertaining to all members of the group.
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
References other materials related to the group.
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
References the universe or sub-universe of the group.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:UniverseReference"/>
StudyUnit
Type:
StudyUnitType, complex content
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.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="StudyUnit"/>
SubGroup
Type:
SubGroupType, complex content
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.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="SubGroup"/>
XML schema documentation generated with DocFlex/XML SDK 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set