SubGroup¶
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.
Properties¶
Name |
Type |
Description |
|
|---|---|---|---|
Citation |
0..1 |
The citation for the sub-group. DDI strongly recommends that at minimum a Title be provided. |
|
Abstract |
0..1 |
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. |
|
AuthorizationSource |
0..n |
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. |
|
UniverseReference |
0..1 |
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. |
|
SeriesStatement |
0..n |
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. |
|
QualityStatementReference |
0..n |
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. |
|
QualityStatementSchemeReference |
0..n |
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. |
|
FundingInformation |
0..n |
Contains details of the sub-group unit’s funding, including information about grants, agencies, etc. |
|
Purpose |
0..1 |
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. |
|
Coverage |
0..1 |
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. |
|
AnalysisUnit |
0..n |
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. |
|
AnalysisUnitsCovered |
0..1 |
A narrative of the units of analysis in the sub-group unit. Uses an InternationalString to support multiple languages. |
|
KindOfData |
0..n |
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. |
|
OtherMaterial |
0..n |
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. |
|
Embargo |
0..n |
Embargo information about the sub-group unit. References to embargo information in this section can be made from individual variables. |
|
ConceptualComponentReference |
0..n |
ConceptualComponent applying to the sub-group as a whole. |
|
DataCollectionReference |
0..n |
DataCollection applying to the sub-group as a whole. |
|
LogicalProductReference |
0..n |
LogicalProduct applying to the sub-group as a whole. |
|
PhysicalDataProductReference |
0..n |
PhysicalDataProduct applying to the sub-group as a whole. |
|
PhysicalInstanceReference |
0..n |
PhysicalInstance applying to the sub-group as a whole. |
|
ArchiveReference |
0..n |
Archive applying to the sub-group as a whole. |
|
DDIProfileReference |
0..n |
DDIProfile applying to the sub-group as a whole. |
|
ComparisonReference |
0..n |
In-line Comparison of differences between related objects in different study units or due to versioning. |
|
StudyUnitReference |
0..n |
A StudyUnit within the SubGroup provided in-line. |
|
SubGroupReference |
0..n |
A description of study units comprising a sub-sub-group within the main SubGroup. |
|
Time |
string |
0..1 |
Indicates how all members of the sub-group are related along the dimension of time (for example single occurrence, multiple occurrence, etc.). |
CaptureInstrument |
string |
0..1 |
Indicates how all members of the sub-group are related in terms of the instruments used to collect data (single, multiple, etc.). |
Panel |
string |
0..1 |
Indicates how all members of the sub-group are related in terms of type of panel (single, rolling, etc.). |
Geography |
string |
0..1 |
Indicates how all members of the sub-group are related along the dimension of geography. |
DataProduct |
string |
0..1 |
Indicates how all members of the sub-group are related in terms of physical data products in relation to data collection efforts. |
LanguageRelationship |
string |
0..1 |
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. |
UserDefinedGroupProperty |
string |
0..1 |
Provides a user-defined sub-grouping property, different from those supplied in other attributes. |
UserDefinedGroupPropertyValue |
string |
0..1 |
Provides a value for the user-defined sub-group property supplied in userDefinedSubGroupProperty. |
IsInheritable |
boolean |
0..1 |
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. |
Properties Inherited from Versionable¶
Name |
Type |
Description |
|
|---|---|---|---|
URN |
string |
1..1 |
|
Agency |
string |
1..1 |
|
ID |
string |
1..1 |
|
Version |
string |
1..1 |
|
UserID |
0..n |
Allows for the specification of identifiers other than the specified DDI identification of the object. This may be a legacy ID from DDI-C, a system specific ID such as for a database or registry, or a non-DDI unique identifier. As the identifier is specific to a system the system must be identified with the UserID structure. |
|
InheritanceAction |
string |
0..1 |
The attribute “action” is used for inheritance situations where there is an override at the local level (within a grouped StudyUnit) which is not available for further inheritance. There are three possible values for “action”: Add - A new identifiable object (an Identifiable, Versionable, or Maintainable element) is provided locally with a new identifier (one that is not inherited). All properties (elements and attributes contained in the object) of the object are as specified. If an object with an existing id is created, this is an error.; Update - An object is provided locally with the SAME id as the inherited object. For each type of property that is specified locally, a full set of those properties is specified for local use. These properties replace any properties of this type which were inherited. Unspecified properties are used as inherited.; Delete - An object is provided locally with the SAME id as the inherited object. All properties specified locally in this object will be deleted if their types and values match those inherited. Note that to completely delete an object at the local level, all properties of the inherited object must be listed. |
UserAttributePair |
0..n |
A system specific user defined property of the object expressed as a key/value pair. As this is specific to an individual system the use of controlled vocabularies for the key is strongly recommended. |
|
VersionResponsibility |
string |
0..1 |
Person or organization within the MaintenanceAgency responsible for the version change. If it is important to retain the affiliation between and individual responsible for the version and his/her agency, it may be included in this notation. This is primarily intended for internal use. |
VersionResponsibilityReference_Organization |
0..1 |
Reference person or organization within the MaintenanceAgency responsible for the version change, as described in an OrganizationScheme. If it is important to retain the affiliation between and individual responsible for the version and his/her agency, a Relation should be created between the individual referenced here and his/her organization. This is primarily intended for internal use. |
|
VersionResponsibilityReference_Individual |
0..1 |
Reference person or organization within the MaintenanceAgency responsible for the version change, as described in an OrganizationScheme. If it is important to retain the affiliation between and individual responsible for the version and his/her agency, a Relation should be created between the individual referenced here and his/her organization. This is primarily intended for internal use. |
|
VersionRationale |
0..1 |
Textual description of the rationale/purpose for the version change and a coded value to provide an internal processing flag within and organization or system. Note that versioning can only take place on objects owned by the specified DDI Agency. If you are creating a local instance of an object from another agency for current or future modification use BasedOnObject. If the changes being made result in what you determine to be new object rather than a version of a previous object, i.e. the change is too extensive to consider it a version of the existing object, create a new object and use BasedOnObject to provide a link to the object or objects that were a basis for the new object. |
|
BasedOnObject |
0..1 |
Use when creating an object that is based on an existing object or objects that are managed by a different agency or when the new object is NOT simply a version change but you wish to maintain a reference to the object that served as a basis for the new object. BasedOnObject may contain references to any number of objects which serve as a basis for this object, a BasedOnRationalDescription of how the content of the referenced object was incorporated or altered, and a BasedOnRationalCode to allow for specific typing of the BasedOnReference according to an external controlled vocabulary. |
|
VersionDate |
cogsDate |
0..1 |
Date of version using the union set BaseDateType. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser. |
Item Type Hierarchy¶
- Versionable
SubGroup
