complexType "SubGroupType"
Namespace: |
|
Content: |
|
Defined: |
|
Includes: |
|
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) |
|
= |
"true" |
|
= |
("T0" | "T1" | "T2" | "T3" | "T4" | "T5") : "T0" |
|
= |
("I0" | "I1" | "I2" | "I3") : "I0" |
|
= |
("P0" | "P1" | "P2" | "P3" | "P4") : "P0" |
|
= |
("G0" | "G1" | "G2" | "G3" | "G4") : "G0" |
|
= |
("D0" | "D1" | "D2" | "D3" | "D4") : "D0" |
|
= |
("L0" | "L1" | "L2" | "L3" | "L4" | "L5" | "L6" | "L7") : "L0" |
|
= |
xs:string |
|
= |
xs:string |
|
= |
xs:boolean : "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:MaintainableObject?, r:Citation?, r:Abstract?, r:AuthorizationSource*, r:UniverseReference?, r:SeriesStatement*, r:QualityStatementReference*, r:QualityStatementSchemeReference*, r:FundingInformation*, r:Purpose?, r:Coverage?, r:AnalysisUnit*, r:AnalysisUnitsCovered?, r:KindOfData*, r:OtherMaterial*, 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)*, (cm:Comparison | r:ComparisonReference)*, (s:StudyUnit | r:StudyUnitReference)*, (SubGroup | SubGroupReference)* |
|
</...> |
Content Model Elements (46):
-
a:Archive,
c:ConceptualComponent,
cm:Comparison,
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:ComparisonReference,
r:ConceptualComponentReference,
r:Coverage,
r:DataCollectionReference,
r:DDIProfileReference,
r:Embargo,
r:FundingInformation,
r:ID,
r:KindOfData,
r:LogicalProductReference,
r:MaintainableObject,
r:OtherMaterial,
r:PhysicalDataProductReference,
r:PhysicalInstanceReference,
r:Purpose,
r:QualityStatementReference,
r:QualityStatementSchemeReference,
r:SeriesStatement,
r:StudyUnitReference,
r:UniverseReference,
r:URN,
r:UserAttributePair,
r:UserID,
r:Version,
r:VersionRationale,
r:VersionResponsibility,
r:VersionResponsibilityReference,
s:StudyUnit,
SubGroup,
SubGroupReference
All Direct / Indirect Based Elements (1):
-
Known Usage Locations
Annotation
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 studyunit can be fully described, or just referenced, within its subgroup container. The purpose of sub-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 sub-group also includes an element for describing the purpose in human-readable format. A SubGroup contains a Citation, Abstract, information on authorization, the universe of the sub-group, series statement, quality statements, funding information, purpose, coverage, analysis units covered, kind of data, other materials, and embargo information. It then allows all maintainable structures within the StudyUnit to be expressed at the SubGroup level.
Type Definition Detail
Type Derivation Tree SubGroupType |
XML Source (w/o annotations (45); see within schema source)
<xs:complexType name="SubGroupType"> <xs:complexContent> <xs:sequence> <xs:element maxOccurs="unbounded" minOccurs="0" ref="r:AnalysisUnit"/> <xs:element maxOccurs="unbounded" minOccurs="0" ref="r:KindOfData"/> <xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Embargo"/> <xs:choice maxOccurs="unbounded" minOccurs="0"> </xs:choice> <xs:choice maxOccurs="unbounded" minOccurs="0"> </xs:choice> <xs:choice maxOccurs="unbounded" minOccurs="0"> </xs:choice> <xs:choice maxOccurs="unbounded" minOccurs="0"> </xs:choice> <xs:choice maxOccurs="unbounded" minOccurs="0"> </xs:choice> <xs:choice maxOccurs="unbounded" minOccurs="0"> </xs:choice> <xs:choice maxOccurs="unbounded" minOccurs="0"> </xs:choice> <xs:choice maxOccurs="unbounded" minOccurs="0"> </xs:choice> <xs:choice maxOccurs="unbounded" minOccurs="0"> </xs:choice> <xs:choice maxOccurs="unbounded" minOccurs="0"> </xs:choice> </xs:sequence> <xs:attribute default="true" name="isInheritable" type="xs:boolean"/> </xs:extension> </xs:complexContent> </xs:complexType> |
Attribute Detail (all declarations; defined within this component only; 9/15)
captureInstrument-
Indicates how all members of the sub-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)
dataProduct-
Indicates how all members of the sub-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)
geography-
Indicates how all members of the sub-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)
isInheritable-
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 sub-groups.
Attribute Value
XML Source (w/o annotations (1); see within schema source)
<xs:attribute default="true" name="isInheritable" type="xs:boolean"/> |
languageRelationship-
Indicates how all members of the sub-group are related in terms of language relationships such as parallel content in multiple languages, translations (full or partial), etc.
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)
panel-
Indicates how all members of the sub-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)
time-
Indicates how all members of the sub-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)
userDefinedGroupProperty-
Type: |
xs:string, predefined |
Use: |
optional |
Provides a user-defined sub-grouping property, different from those supplied in other attributes.
XML Source (w/o annotations (1); see within schema source)
userDefinedGroupPropertyValue-
Type: |
xs:string, predefined |
Use: |
optional |
Provides a value for the user-defined sub-group property supplied in userDefinedSubGroupProperty.
XML Source (w/o annotations (1); see within schema source)
Content Element Detail (all declarations; defined within this component only; 35/46) -
Archive applying to the sub-group as a whole.
XML Source (w/o annotations (1); see within schema source)
-
ConceptualComponent applying to the sub-group as a whole.
XML Source (w/o annotations (1); see within schema source)
-
In-line Comparison of differences between related objects in different study units or due to versioning.
XML Source (w/o annotations (1); see within schema source)
-
DataCollection applying to the sub-group as a whole.
XML Source (w/o annotations (1); see within schema source)
-
Type: |
|
Abstract: |
(may not be used directly in instance XML documents) |
Subst.Gr: |
|
LogicalProduct applying to the sub-group as a whole.
XML Source (w/o annotations (1); see within schema source)
-
PhysicalDataProduct applying to the sub-group as a whole.
XML Source (w/o annotations (1); see within schema source)
-
PhysicalInstance applying to the sub-group as a whole.
XML Source (w/o annotations (1); see within schema source)
-
DDIProfile applying to the sub-group as a whole.
XML Source (w/o annotations (1); see within schema source)
-
An abstract of the sub-group unit describing the nature and scope of the data collection, special characteristics of its content. Note that detailed information on the purpose of the sub-group 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)
-
Allows the use of a controlled vocabulary to list all of the units of analysis used in the sub-group. Should be repeated to describe multiple units of analysis.
Simple Content
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:AnalysisUnit"/> |
-
A narrative of the units of analysis in the sub-group unit. Uses an InternationalString to support multiple languages.
XML Source (w/o annotations (1); see within schema source)
-
Inclusion of Archive applying to the sub-group as a whole by reference.
XML Source (w/o annotations (1); see within schema source)
-
Identifies the authorizing agency for the sub-group 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)
-
The citation for the sub-group. DDI strongly recommends that at minimum a Title be provided.
XML Source (w/o annotations (1); see within schema source)
-
Inclusion of Comparison by reference.
XML Source (w/o annotations (1); see within schema source)
-
Inclusion of ConceptualComponent applying to the sub-group as a whole by reference.
XML Source (w/o annotations (1); see within schema source)
-
Describes the coverage of the sub-group 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)
-
Inclusion of DataCollection applying to the sub-group as a whole by reference.
XML Source (w/o annotations (1); see within schema source)
-
Inclusion of DDIProfile applying to the sub-group as a whole by reference.
XML Source (w/o annotations (1); see within schema source)
-
Embargo information about the sub-group 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"/> |
-
Contains details of the sub-group unit's funding, including information about grants, agencies, etc.
XML Source (w/o annotations (1); see within schema source)
-
Briefly describes the kind of data documented in the logical product(s) of a sub-group 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
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:KindOfData"/> |
-
Inclusion of LogicalProduct applying to the sub-group as a whole by reference.
XML Source (w/o annotations (1); see within schema source)
-
Contains references to other materials relevant to the sub-group 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)
-
Inclusion of PhysicalDataProduct applying to the sub-group as a whole by reference.
XML Source (w/o annotations (1); see within schema source)
-
Inclusion of PhysicalInstance applying to the sub-group as a whole by reference.
XML Source (w/o annotations (1); see within schema source)
-
The purpose of the sub-group, why the sub-group took place. This should include detailed information on the investigator's primary sub-group 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)
-
A reference to a Quality Statement pertaining to the quality of the subgroup 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)
-
A reference to a QualityStatementScheme containing statements of quality related to the quality of the sub-group methodology, metadata, or data. Quality statements may be related to external quality standards.
XML Source (w/o annotations (1); see within schema source)
-
A sub-group, particularly one in a series, may be the result of two series merging into a single sub-group. The new sub-group 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)
-
Inclusion of a StudyUnit within the SubGroup by reference.
XML Source (w/o annotations (1); see within schema source)
-
Reference to the universe statement from the universe scheme, describing the sub-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 sub-group. A universe may be described as "inclusive" or "exclusive". This sub-group level reference is normally to the top level of the UniverseScheme.
XML Source (w/o annotations (1); see within schema source)
-
A StudyUnit within the SubGroup provided in-line.
XML Source (w/o annotations (1); see within schema source)
-
A description of study units comprising a sub-sub-group within the main SubGroup.
XML Source (w/o annotations (1); see within schema source)
-
Inclusion of a SubSubGroup by reference.
XML Source (w/o annotations (1); see within schema source)