ResourcePackage¶
The Resource Package is a specialized structure which is intended to hold reusable metadata outside of the structures of a single StudyUnit or Group. For example this may be common methodological approaches bound in a DataCollection module, DataRelationship information bound in a LogicalProduct, or any maintainable scheme. The ResourcePackage is often used to manage and publish metadata that is used by StudyUnits or Groups by reference. Any maintainable object with the exception of a Group, StudyUnit or LocalHoldingPackage may be published in a Resource Package. Each maintainable object may be entered as either an in-line representation or by reference. Within each maintainable type the ordering of in-line or referenced content may be mixed. In addition the ResourcePackage contains self identifying information including: a citation, abstract, authorization source, a universe reference, series statement, references to applicable quality statements, funding and budget information, purpose, coverage, other material, embargo, and the resource package archive (as opposed to an Archive module intended as the part of the published reusable content).
Properties¶
Name |
Type |
Description |
|
|---|---|---|---|
Citation |
0..1 |
The citation for the ResourcePackage. DDI strongly recommends that at minimum a Title be provided. |
|
TypeOfResourcePackage |
0..1 |
A brief description of the resource package type. Supports the use of a controlled vocabulary. |
|
Abstract |
0..1 |
An abstract of the ResourcePackage unit describing the nature and scope of the data collection, special characteristics of its content. Note that detailed information on the purpose of the ResourcePackage 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 ResourcePackage 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 ResourcePackage 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 ResourcePackage. A universe may be described as “inclusive” or “exclusive”. This ResourcePackage level reference is normally to the top level of the UniverseScheme. |
|
SeriesStatement |
0..n |
A ResourcePackage, particularly one in a series, may be the result of two series merging into a single ResourcePackage. The new ResourcePackage 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 QualityStatementScheme containing statements of quality related to the quality of the ResourcePackage methodology, metadata, or data. Quality statements may be related to external quality standards. |
|
FundingInformation |
0..n |
Contains details of the ResourcePackage unit’s funding, including information about grants, agencies, etc. |
|
ProjectBudget |
0..n |
This describes the overall budget of the ResourcePackage. It can be repeated for distinct budget activities. It contains a structured description and one or more budget documents described by an OtherMaterial type. |
|
Purpose |
0..1 |
The purpose of the ResourcePackage, why the ResourcePackage took place. This should include detailed information on the investigator’s primary ResourcePackage 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 ResourcePackage 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. |
|
OtherMaterial |
0..n |
Contains references to other materials relevant to the ResourcePackage 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 ResourcePackage unit. References to embargo information in this section can be made from individual variables. |
|
ResourcePackageArchive |
0..n |
This is archive information specific to the creation, maintenance, and archiving of the ResourcePackage provided either in-line or by reference. This packaging element differentiates this “Archive” from one being published as a product within a ResourcePackage. |
|
ConceptualComponentReference |
0..n |
Allows for in-line entry of an ConceptualComponent. |
|
DataCollectionReference |
0..n |
Allows for in-line entry of an DataCollection. |
|
LogicalProductReference |
0..n |
Allows for in-line entry of any LogicalProduct. l:BaseLogicalProduct is a substitution group base. |
|
PhysicalDataProductReference |
0..n |
Allows for in-line entry of an PhysicalDataProduct. |
|
PhysicalInstanceReference |
0..n |
Allows for in-line entry of an PhysicalInstance. |
|
ArchiveReference |
0..n |
Allows for in-line entry of an Archive. |
|
DDIProfileReference |
0..n |
Allows for in-line entry of an DDIProfile. |
|
ComparisonReference |
0..n |
Allows for in-line entry of an Comparison. |
|
OrganizationSchemeReference |
0..n |
In-line inclusion of a OrganizationScheme. |
|
ConceptSchemeReference |
0..n |
In-line inclusion of a ConceptScheme. |
|
UniverseSchemeReference |
0..n |
In-line inclusion of a UniverseScheme. |
|
ConceptualVariableSchemeReference |
0..n |
In-line inclusion of a ConceptualVariableScheme. |
|
RepresentedVariableSchemeReference |
0..n |
In-line inclusion of a RepresentedVariableScheme. |
|
GeographicStructureSchemeReference |
0..n |
In-line inclusion of a GeographicStructureScheme. |
|
GeographicLocationSchemeReference |
0..n |
In-line inclusion of a GeographicLocationScheme. |
|
InterviewerInstructionSchemeReference |
0..n |
In-line inclusion of a InterviewerInstructionScheme. |
|
ControlConstructSchemeReference |
0..n |
In-line inclusion of a ControlConstructScheme. |
|
QuestionSchemeReference |
0..n |
In-line inclusion of a QuestionScheme. |
|
CategorySchemeReference |
0..n |
In-line inclusion of a CategoryScheme. |
|
CodeListSchemeReference |
0..n |
In-line inclusion of a CodeListScheme. |
|
NCubeSchemeReference |
0..n |
In-line inclusion of a NCubeScheme. |
|
VariableSchemeReference |
0..n |
In-line inclusion of a VariableScheme. |
|
PhysicalStructureSchemeReference |
0..n |
In-line inclusion of a PhysicalStructureScheme. |
|
RecordLayoutSchemeReference |
0..n |
In-line inclusion of a RecordLayoutScheme. |
|
QualityStatementSchemeReference |
0..n |
In-line inclusion of a QualityStatementScheme. |
|
InstrumentSchemeReference |
0..n |
In-line inclusion of a InstrumentScheme. |
|
ProcessingEventSchemeReference |
0..n |
In-line inclusion of a ProcessingEventScheme. |
|
ProcessingInstructionSchemeReference |
0..n |
In-line inclusion of a ProcessingInstructionScheme. |
|
ManagedRepresentationSchemeReference |
0..n |
In-line inclusion of a ManagedRepresentationScheme. |
Properties Inherited from Maintainable¶
Name |
Type |
Description |
|
|---|---|---|---|
Note |
0..n |
Note allows for the attachment of a piece of additional information to any object with an ID. Note facilitates capturing temporary processing notes such as “Review and approval required”. A single note can be attached to multiple objects by reference to the objects. Note may also contain content for a needed object that has been reported for addition in a later version of the schema. Ideally this should be handled by a local extension, but Note can accommodate run-time extensions when required. The Note should be housed within the Maintainable object that contains the referenced objects. In this way the user is ensured of receiving all known Note attachments when the maintainable content is delivered. This means that if a Note references objects within multiple Maintainable objects, the Note should be repeated in each Maintainable and reference only those objects with that Maintainable. |
|
Software |
0..n |
Indicate the software used to create and/or manage the metadata. This is repeatable to allow for multiple softwares or multiple functions. If this information is important it is advisable to provide it in each maintainable so that it does not become separated from the internal content if the metadata is re-factored. |
|
MetadataQuality |
0..n |
An assessment of the quality of the metadata within the Maintainable object, e.g. the quality of the transcription, completeness, editing status, etc. |
|
ExternalReferenceDefaultURI |
anyURI |
0..1 |
Use to provide a default value for the URI of external references. Use of a URI in a reference within this maintainable overrides the value entered here. Nested maintainables should redeclare the contents of this attribute for clarity. |
IsPublished |
boolean |
0..1 |
Indicates that the maintainable will not be changed without versioning, and is a stable target for referencing. |
Lang |
language |
0..1 |
This is used to designate the language of the metadata content of the maintainable. If a lower level xml:lang attribute conflicts with the content at the maintainable level, the object level value takes precedence. |
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
- Maintainable
ResourcePackage
