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
~~~~~~~~~~

.. csv-table::
   :header: "Name","Type","","Description"
   :widths: 15,10,5,100

   "EmbargoName",":doc:`/composite-types/NameType/index`","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",":doc:`/composite-types/LabelType/index`","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",":doc:`/composite-types/StructuredStringType/index`","0..1","Describe the content and coverage of the embargo. Supports multiple language versions of the same content as well as optional formatting of the content."
   "Date",":doc:`/composite-types/DateType/index`","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",":doc:`/composite-types/StructuredStringType/index`","0..1","Indicates the reason for the embargo. Supports multiple language versions of the same content as well as optional formatting of the content."
   "AgencyOrganizationReference",":doc:`/item-types/Agent/index`","0..1","Reference to an organization or individual, defined in the organization scheme, responsible for the embargo."
   "EnforcementAgencyOrganizationReference",":doc:`/item-types/Agent/index`","0..n","Reference to an organization or individual, defined in the organization scheme, responsible for enforcing the embargo."

Properties Inherited from IdentifiableType
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. csv-table::
   :header: "Name","Type","","Description"
   :widths: 15,10,5,100

   "URN","string","1..1",""
   "Agency","string","1..1",""
   "ID","string","1..1",""
   "Version","string","1..1",""
   "UserID",":doc:`/composite-types/UserIDType/index`","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."
   "UserAttributePair",":doc:`/composite-types/StandardKeyValuePairType/index`","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."


Item Type Hierarchy
~~~~~~~~~~~~~~~~~~~

* :doc:`/composite-types/IdentifiableType/index`
    * **EmbargoType**


Relationships
~~~~~~~~~~~~~
The following types reference this type.

* :doc:`/item-types/Group/index`
* :doc:`/item-types/ResourcePackage/index`
* :doc:`/item-types/StudyUnit/index`
* :doc:`/item-types/Variable/index`

.. container:: image

   |stub|

.. |stub| image:: ../../images/EmbargoType.svg