DDI 3.1 XML Schema Documentation (2009-10-18)
© DDI Alliance 2009 - licensed under the terms of the GNU Lesser General Public License
complexType "DDIInstanceType"
Namespace:
ddi:instance:3_1
Content:
complex, 11 attributes, 12 elements
Defined:
globally in instance.xsd, see XML source
Includes:
definitions of 9 elements
Used:
at 1 location
XML Representation Summary
<...
    action
 = 
 ("Add" | "Update" | "Delete")
    agency
 = 
 xs:NCName
    externalReferenceDefaultURI
 = 
 xs:anyURI
    id
 = 
 xs:string
    isMaintainable
 = 
 "true"
    isPublished
 = 
 xs:boolean : "false"
    objectSource
 = 
 xs:anyURI
    urn
 = 
 xs:anyURI
    version
 = 
 xs:string
    versionDate
 = 
 (xs:dateTime | xs:date | xs:gYearMonth | xs:gYear | xs:duration)
    xml:lang
 = 
 xs:language
    >
   
Content: 
 UserID*, VersionResponsibility?, VersionRationale*, r:Citation?, r:Coverage?, g:Group*, g:ResourcePackage*, g:LocalHoldingPackage*, s:StudyUnit*, r:OtherMaterial*, r:Note*, TranslationInformation?
</...>
Content Model Elements (12):
g:Group,
g:LocalHoldingPackage,
g:ResourcePackage,
r:Citation,
r:Coverage,
r:Note,
r:OtherMaterial,
r:VersionResponsibility (type xs:string),
s:StudyUnit,
TranslationInformation,
UserID,
VersionRationale
All Direct / Indirect Based Elements (1):
DDIInstance
Known Usage Locations
Annotation
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.
Type Definition Detail
Type Derivation Tree
r:AbstractIdentifiableType
  r:AbstractVersionableType (extension)
      r:AbstractMaintainableType (extension)
          r:MaintainableType (extension)
              DDIInstanceType (extension)
XML Source (w/o annotations (10); see within schema source)
<xs:complexType name="DDIInstanceType">
<xs:complexContent>
<xs:extension base="r:MaintainableType">
<xs:sequence>
<xs:element minOccurs="0" ref="r:Citation"/>
<xs:element minOccurs="0" ref="r:Coverage"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="g:Group"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="g:ResourcePackage"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="g:LocalHoldingPackage"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="s:StudyUnit"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:OtherMaterial"/>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Note"/>
<xs:element minOccurs="0" ref="TranslationInformation"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Content Element Detail (defined in this component only; 9/12)
g:Group
Type:
g:GroupType, complex content
Group is a framework for documenting related studies or groups of studies.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="g:Group"/>
g:LocalHoldingPackage
Type:
g:LocalHoldingPackageType, complex content
LocalHoldingPackages are used to contain metadata added at a local level, without causing a versioning of the original metadata. This facilitates the addition of lifecycle events and similar non-intrusive additions on the part of an archive.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="g:LocalHoldingPackage"/>
g:ResourcePackage
Type:
g:ResourcePackageType, complex content
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.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="g:ResourcePackage"/>
r:Citation
Type:
r:CitationType, complex content
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.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:Citation"/>
r:Coverage
Type:
r:CoverageType, complex content
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.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="r:Coverage"/>
r:Note
Type:
r:NoteType, complex content
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.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Note"/>
r:OtherMaterial
Type:
r:OtherMaterialType, complex content
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.
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:OtherMaterial"/>
s:StudyUnit
Type:
s:StudyUnitType, complex content
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.)
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" ref="s:StudyUnit"/>
TranslationInformation
Type:
TranslationType, complex content
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.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" ref="TranslationInformation"/>
XML schema documentation generated with DocFlex/XML SDK 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set