ddi:instance:3_0

Global Elements

DDIInstance (DDIInstanceType):

TranslationInformation (TranslationType): TranslationInformation contains information about the translation of the content of the DDI Instance. This includes human-readable information about which language(s) are involved in translation.

Complex Types

DDIInstanceType: DDIInstance is the top-level wrapper for any DDI document. It may contain a set of top-level elements, which generally correspond to the modular breakdown within DDI. (Note that some modules are sub-components of other, higher-level modules). Every DDI Instance will use this wrapper, regardless of its contents.

• Content:
  • Extends: r:MaintainableType
  • Base Content
    • Extends: AbstractMaintainableType
    • Base Content
      • Extends: AbstractVersionableType
      • Base Content
        • Extends: AbstractIdentifiableType
        • Base Content
          • Sequence of:
            • [Reference] (Name) - min. 0 - max. unbounded
              • Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
        • Extended Content
          • Sequence of:
            • VersionResponsibility (xs:string) - min. 0
              • Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
            • [Reference] (VersionRationale) - min. 0 - max. unbounded
              • Textual description of the rationale/purpose for a version change.
        • Base Attributes
          • id (BaseIDType) - required
            • Assigned ID, unique within its maintainable object.
          • urn (xs:anyURI) - optional
            • DDI-structured URN of the element as described in Part I of the Technical Documentation.
          • action (ActionCodeType) - optional
            • Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
        • Extended Attributes
          • version (NewVersionType) - optional
            • Restricted string - numeric with optional decimal points.
          • versionDate (BaseDateType) - optional
            • Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
      • Extended Attributes
        • agency (xs:NCName) - optional
          • Maintaining agency as described in Part 1 of the Technical Specification.
    • Extended Attributes
      • isMaintainable (xs:boolean) - fixed: true
  • Extended Content
    • Sequence of:
      • [Reference] (r:Citation) - min. 0
        • Citation for the Instance. Note that the citation is optional, because the DDI Instance may contain only reusable component pieces of metadata sets, which are not directly concerned with a single study or studies.
      • [Reference] (r:Coverage) - min. 0
        • This element contains descriptions of temporal, geographic and topical coverage. At the instance level these descriptions should be inclusive of the coverage of all modules in the instance. The element is available within individual modules and can be used to refine the coverage to that of the individual module.
      • [Reference] (g:Group) - min. 0 - max. unbounded
        • Group is a framework for documenting related studies or groups of studies.
      • [Reference] (g:ResourcePackage) - min. 0 - max. unbounded
        • Resource is a type of Group which contains metadata intended for inclusion by reference in other Groups, SubGroups, and StudyUnits, but does not itself directly describe studies. Resource contains information intended for reuse.
      • [Reference] (s:StudyUnit) - min. 0 - max. unbounded
        • A StudyUnit corresponds to the documentation for a single, "simple" study. (In the 2.* version of DDI, this was the scope of a single DDI instance.)
      • [Reference] (r:OtherMaterial) - min. 0 - max. unbounded
        • OtherMaterials element includes citations to materials related to the content of the DDI Instance. This includes citations to such material, an external reference to a URL (or other URI), and a statement about the relationship between the cited OtherMaterial the contents of the DDI instance.
      • [Reference] (r:Note) - min. 0 - max. unbounded
        • The Note element is used to include notes which are relevant to the contents of the entire DDI Instance. A note type may be specified using a controlled vocabulary.
      • [Reference] (TranslationInformation) - min. 0
        • TranslationInformation contains information about the translation of the content of the DDI Instance. This includes human-readable information about which language(s) are involved in the translation.

TranslationType: Describes the translation process of data and metadata.

• Content:
  • Sequence of:
    • Language (xs:string) - max. unbounded
      • Name of the language of translation.
    • I18n-text (xs:string)
      • Value of language identifier being used.
    • I18n-catalog (xs:string) - min. 0
      • Identifies the I18n catalog of language being used.
    • [Reference] (r:Description) - min. 0
      • Describes the translation process of data and metadata.
• Attributes:
  • [Reference] (xml:lang)
    • Indicates language of tag content