EmbargoType¶
Provides information about data that are not currently available because of policies established by the principal investigators and/or data producers. This item may be attached to specific levels of a study such as a specific variable by reference. Embargo provides a name, label and description of the embargo, the dates covered by the embargo, the rationale or reason for the embargo, a reference to the agency establishing the embargo, and a reference to the agency enforcing the embargo.
Properties¶
Name |
Type |
Description |
|
|---|---|---|---|
EmbargoName |
0..n |
The name or names by which the embargo is known. Repeat if different names are used for different purposes or different contexts. Language repetition is handled within the structure of the Embargo Name element. |
|
Label |
0..n |
A label or labels for the embargo element. Repeat for differences in content due to software or application constraints. Language repetition is handled within the structure of the label. |
|
Description |
0..1 |
Describe the content and coverage of the embargo. Structure supports multiple languages. |
|
Date |
0..1 |
Provides the end date of the embargo, which may take the form of a date range (complete or open ended). Note SimpleDate should not be used for an Embargo Date as an embargo is for a period of time. |
|
Rationale |
0..1 |
Indicates the reason for the embargo. |
|
AgencyOrganizationReference |
0..1 |
Reference to an organization or individual, defined in the organization scheme, responsible for the embargo. |
|
EnforcementAgencyOrganizationReference |
0..n |
Reference to an organization or individual, defined in the organization scheme, responsible for enforcing the embargo. |
Properties Inherited from IdentifiableType¶
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. |
Item Type Hierarchy¶
- IdentifiableType
EmbargoType
