complexType "DDIInstanceType" | DDI-Lifecycle 3.3 XML Schema Documentation (2020-01-15)

complexType "DDIInstanceType"

Namespace:	ddi:instance:3_3
Content:	complex, 9 attributes, 27 elements
Defined:	globally in instance.xsd; see XML source
Includes:	definitions of 13 elements
Used:	at 1 location

XML Representation Summary

<...

inheritanceAction	=	("Add" \| "Update" \| "Delete")
objectSource	=	(xs:string \| xs:string)
scopeOfUniqueness	=	("Agency" \| "Maintainable") : "Agency"
isUniversallyUnique	=	xs:boolean
versionDate	=	(xs:dateTime \| xs:date \| xs:gYearMonth \| xs:gYear \| xs:duration)
isPublished	=	xs:boolean : "false"
externalReferenceDefaultURI	=	xs:anyURI
xml:lang	=	xs:language
isMaintainable	=	"true"

>

Content:

</...>

All Direct / Indirect Based Elements (1):

Known Usage Locations

As direct type of elements (1):

DDIInstance

Annotation

DDIInstance is the top-level publication wrapper for any DDI document. All DDI content published as XML (with the exception of a Fragment intended for transmission) has DDIInstance as its top level structure. In addition to a citation and coverage statement for the instance, the DDIInstance can contain a Group, ResourcePackage, LocalHoldingPackage or StudyUnit. Additional OtherMaterial content may be added but in general OtherMaterial should be listed in the maintainable object containing the objects the OtherMaterial is related to. The instance can provide an applicable DDIProfile either in-line or by reference and can contain overall translation information.

Type Definition Detail

Type Derivation Tree

r:AbstractIdentifiableType (extension)

r:AbstractVersionableType (extension)

r:AbstractMaintainableType (extension)

r:MaintainableType (extension)

DDIInstanceType

XML Source (w/o annotations (14); 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:choice maxOccurs="unbounded" minOccurs="0">

<xs:element ref="g:Group"/>

<xs:element ref="r:GroupReference"/>

</xs:choice>

<xs:choice maxOccurs="unbounded" minOccurs="0">

<xs:element ref="g:ResourcePackage"/>

<xs:element ref="r:ResourcePackageReference"/>

</xs:choice>

<xs:choice maxOccurs="unbounded" minOccurs="0">

<xs:element ref="g:LocalHoldingPackage"/>

<xs:element ref="r:LocalHoldingPackageReference"/>

</xs:choice>

<xs:choice maxOccurs="unbounded" minOccurs="0">

<xs:element ref="s:StudyUnit"/>

<xs:element ref="r:StudyUnitReference"/>

</xs:choice>

<xs:choice maxOccurs="unbounded" minOccurs="0">

<xs:element ref="pr:DDIProfile"/>

<xs:element ref="r:DDIProfileReference"/>

</xs:choice>

<xs:element minOccurs="0" ref="TranslationInformation"/>

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

Content Element Detail (all declarations; defined within this component only; 13/27)

Type:

g:GroupType, complex content

A publication of a Group of StudyUnits in-line.

XML Source (w/o annotations (1); see within schema source)

<xs:element ref="g:Group"/>

g:LocalHoldingPackage

Type:

g:LocalHoldingPackageType, complex content

A publication package containing a deposited publication as well as local value added or processing information in-line.

XML Source (w/o annotations (1); see within schema source)

<xs:element ref="g:LocalHoldingPackage"/>

g:ResourcePackage

Type:

g:ResourcePackageType, complex content

A publication of a set of maintainables (modules or schemes) intended for reuse between studies in-line.

XML Source (w/o annotations (1); see within schema source)

<xs:element ref="g:ResourcePackage"/>

Type:

pr:DDIProfileType, complex content

A DDIProfile applicable to the instance.

XML Source (w/o annotations (1); see within schema source)

<xs:element ref="pr:DDIProfile"/>

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"/>

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:DDIProfileReference

Type:

r:ReferenceType, complex content

Inclusion of an existing DDIProfile by reference.

XML Source (w/o annotations (1); see within schema source)

<xs:element ref="r:DDIProfileReference"/>

r:GroupReference

Type:

r:ReferenceType, complex content

A publication of a Group of StudyUnits by reference. TypeOfObject should be set to Group.

XML Source (w/o annotations (1); see within schema source)

<xs:element ref="r:GroupReference"/>

r:LocalHoldingPackageReference

Type:

r:ReferenceType, complex content

A publication package containing a deposited publication as well as local value added or processing information by reference. TypeOfObject should be set to LocalHoldingPackage.

XML Source (w/o annotations (1); see within schema source)

<xs:element ref="r:LocalHoldingPackageReference"/>

r:ResourcePackageReference

Type:

r:ReferenceType, complex content

A publication of a set of maintainables (modules or schemes) intended for reuse between studies by reference. TypeOfObject should be set to ResourcePackage.

XML Source (w/o annotations (1); see within schema source)

<xs:element ref="r:ResourcePackageReference"/>

r:StudyUnitReference

Type:

r:ReferenceType, complex content

A publication of a study unit representing the purpose, background, development, data capture, and data products related to a study by reference. TypeOfObject should be set to StudyUnit.

XML Source (w/o annotations (1); see within schema source)

<xs:element ref="r:StudyUnitReference"/>

Type:

s:StudyUnitType, complex content

A publication of a study unit representing the purpose, background, development, data capture, and data products related to a study in-line.

XML Source (w/o annotations (1); see within schema source)

<xs:element 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 1.12 using DocFlex/XML XSDDoc 2.9.0 template set