ddi:reusable:3_0

Imports: http://www.w3.org/XML/1998/namespace (xml.xsd)
Imports: http://www.w3.org/1999/xhtml (ddi-xhtml11.xsd)
Imports: ddi:dcelements:3_0 (dcelements.xsd)

Global Elements

CommandFile (CommandFileType): References a file which contains commands.

Command (CommandType): A complete structure to describe formal transformation procedures of variables. This could be an XML structure like MathML or a simple string.

StructuredCommand (StructuredCommandType): Contains a command expressed in XML, which is attached as an extension to this abstract stub (see the DDI 3.0 extension methodology documentation).

SchemeReference (SchemeReferenceType):

Exclude (ExcludeType):

Citation (CitationType): Provides bibliographic citation information for a DDI instance, a group of studies, a study unit, or a physical instance. Note that a native DDI citation is required - the citation information may be repeated using DCElements if desired, but a citation must not consist only of DCElements.

FundingInformation (FundingInformationType): Provides information about the agency and grant(s) which funded the described entity.

Embargo (EmbargoType): Provides information about data that are not currently available because of policies established by the principal investigators and/or data producers.

LifecycleInformation (LifecycleInformationType): Allows a listing of events in the life cycle of a data set or collection. Identification, date, agency, and descriptive information are provided for each event. Note that the agency that documents a lifecycle event is not necessarily the same agency as the one that performed the operation being documented as a lifecycle event.

Coverage (CoverageType): Describes the 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.

Label (LabelType): An unstructured label for the element. DDI does not impose any length limitations on Label. If length of Label is constrained due to use of the element in a specific application, the maximum length supported should be noted in the attribute maxLength. Label may be repeated to provide content for systems that have length constraints (e.g., some versions of the following statistical packages have character length limits: SAS 40-character, SPSS 120 characters, and Stata 80 characters). Mnemonics associated with a variable should include both of the following attributes: type="Nickname" and maxLength. Software packages will use this information to select the appropriate mnemonic for use.

Software (SoftwareType): Describes a specific software package.

MinimumValue (RangeValueType): Minimum bound value.

MaximumValue (RangeValueType): Maximum bound value.

TopCode (RangeValueType): Value implying top coding (all values at or above stated value are coded with this value).

NumberRange (NumberRangeType): A numeric range.

Low (NumberRangeValueType): The lower bound of the range.

High (NumberRangeValueType): The upper bound of the range.

CodeSchemeReference (ReferenceType): A reference to a code scheme.

CategorySchemeReference (ReferenceType): A reference to a category scheme describing the valid response values.

CoordinatePairs (CoordinatePairsType): Field to capture coordinate pairs as individual pairs or as an array of pairs.

AlternateOffset (TextDomainType): Allows entry of a non-standard offset figure.

AlternateObject (TextDomainType): Allows identification of an alternate object when the default object is not measureable.

AlternateCoordinateSystem (TextDomainType): Allows collection of data for a case in a different coordinate system than stated in the response structure.

ProprietaryInfo (ProprietaryInfoType):

ProprietaryProperty (ProprietaryPropertyType):

OtherMaterial (OtherMaterialType): Used to reference external resources that are related to the content of the relevant module. It includes a citation, an external reference using a URL (or other URI), and a reference to the item within the module to which the external resource is related.

Note (NoteType): Includes a footnote or annotation to a section of the documentation, and is designed to be an inherent part of the DDI. (Unlike XML comments or other types of system-level annotations, which may be removed during processing.)

RelationshipDescription (InternationalStringType): A description of the nature of the relationship between the external material in an OtherMaterial element reference and the DDI object to which it is related.

DefaultDecimalSeparator (OneCharStringType): The character used to separate the integer and the fraction part of a number (if an explicit separator is used in the data). Allowed values are: None (default), Dot, Comma, Other. On the basis of the data definition in DDI documents, data processing tools could compute the necessary precision width on the basis of the format width and the existence of separators. Appropriate data types could be used, i.e. float or double, short or long. The decimal separator definition only makes sense with some XML Schema primitives. This is a default which may be overridden in specific cases.

DefaultDigitGroupSeparator (OneCharStringType): The character used to separate groups of digits (if an explicit separator is used in the data). Allowed values are: None (default), Dot, Comma, Other. The decimal separator definition makes only sense with some XML Schema primitives. This is a default which may be overridden in specific cases.

TimeZone (TimeZoneCodeType): Coded values specifying time zones as an offset from Greenwich Meridian Time. For example, United States Eastern Standard Time is -5.00.

Date (DateType): A single point in time, or a time range with start and end dates.

SimpleDate (BaseDateType): A single point in time.

StartDate (BaseDateType): Start of a date range.

HistoricalStartDate (HistoricalDateType): Start of a date range, expressed in a historical date format, according to a system specified in the historicalDateFormat attribute.

EndDate (BaseDateType): End of a date range.

HistoricalEndDate (HistoricalDateType): End of a date range, expressed in a historical date format, according to a system specified in the historicalDateFormat attribute.

HistoricalDate (HistoricalDateType): A date expressed in a historical date format, according to a system specified in the historicalDateFormat attribute.

Content (StructuredStringType): Contains a structured string that may be marked up in XHTML.

URN (URNType): URN providing identification.

ID (IDType): An identification.

Module (ReferenceType): References the module containing an entity which is being referenced, in case there have been local modifications made to inherited properties.

Scheme (ReferenceType): References the scheme containing an item which is being referenced.

VersionDate (DateType): Date the version took effect.

VersionRationale (InternationalStringType): Textual description of the rationale/purpose for a version change.

Name (InternationalStringType): Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.

Version (VersionType): Version of the entity that is being referenced. The version can be identified as lateBound, meaning that the latest version should be used.

Title (InternationalStringType): Full authoritative title.

SubTitle (InternationalStringType): Secondary or explanatory title.

AlternateTitle (InternationalStringType): An alternative title by which a data collection is commonly referred, or an abbreviation for the title.

Creator (CreatorType): Person, corporate body, or agency responsible for the substantive and intellectual content of the described object.

Publisher (InternationalStringType): Person or organization responsible for making the resource available in its present form.

Contributor (ContributorType): The name of a contributing author or creator, who worked in support of the primary creator given above.

PublicationDate (DateType): The date of publication.

InternationalIdentifier (TypedStringType): ISBN, ISSN or similar designator.

Copyright (InternationalStringType): The copyright statement.

Rationale (StructuredStringType): Indicates the reason for the embargo.

LifecycleEvent (LifecycleEventType): A life cycle event can be any event which is judged to be significant enough to document by the agency maintaining the documentation for a particular set of data. The type attribute may be used to create indicate which type of event in a typology meaningful to the documentor.

EventType (CodeValueType): May be used to qualify the event according to a typology meaningful to the documentor.

Description (StructuredStringType): A human-readable description of the event. This may be provided in several languages by repeating the field.

SourceQuestionReference (ReferenceType): A reference to a source question used in the associated Code element.

TopicalCoverageReference (ReferenceType): Reference to a previously defined topical coverage.

TopicalCoverage (TopicalCoverageType): Description of the topical coverage of the data described in a particular DDI module.

SpatialCoverageReference (ReferenceType): Reference to a previously defined spatial coverage.

SpatialCoverage (GeographicCoverageType): Description of the geographic coverage of the data described in a particular DDI module.

TemporalCoverageReference (ReferenceType): Reference to a previously defined temporal coverage.

TemporalCoverage (TemporalCoverageType): Description of the temporal coverage of the data described in a particular DDI module.

Subject (InternationalCodeValueType): A subject or list of subjects that indicate the topical coverage of the data described in a particular module/section.

Keyword (InternationalCodeValueType): A keyword (which can be supplied in multiple language-equivalent forms) to support searches on topical coverage.

BoundingBox (BoundingBoxType): The Bounding Box is a 'rectangle, oriented to the x and y axes, which bounds a geographic feature or a geographic dataset. It is specified by two coordiantes: xmin, ymin and xmax,ymax.' [FGDC]. In the DDI, it describes the full extent of the geographic coverage, and is designed to be used by systems that search for geography by coordinates. It is compatible with the description and structure found in FGDC and other geographic metadata structures.

GeographyStructureVariable (ReferenceType): References a variable describing the geographic levels available in the data such as the variable "Summary Level" in U.S. Census data. This reference is needed for assistance in programming.

SpatialObject (GeographicDescriptionCodeType): Contains information on the most discrete type of spatial representation to which data in this file can be attached (point, line, polygon, linear ring). For example, a raw data file with an address attached to each case is 'point'. When the microdata file is anonymized and the geographic information is for a state or other defined area, it is 'polygon'. Some data, such as traffic or criminal incidence data may have a street range identification or 'line', and some such as communications data have a point with a radius or 'linear ring'.

GeographicStructure (GeographicStructureType): Contains information on the hierarchy of the geographic structure. The structure can be defined within the DDI or an external structure can be referenced.

GeographicLocation (GeographicLocationType): Contains information on the specific geographic areas defined in the data set such as cities, countries, or states. The areas can be defined within the DDI instance or an external structure can be referenced.

SummaryDataReference (ReferenceType): May be repeated to reference each geography (geographic level) for which there is summary data.

TopLevelReference (LevelReferenceType): Reference to the top-level geography.

LowestLevelReference (LevelReferenceType): Reference to the lowest-level geography.

LevelReference (ReferenceType): Reference to the Geographic Level as described in the GeographicStructure.

Geography (GeographyType): Used to describe any level of geography, including overall coverage and each of the lower levels.

GeographyReference (ReferenceType): Reference to a previously defined geographic hierarchy.

Level (GeographicLevelType): Describes a single level in a geographical breakdown (eg, country, province, etc.)

ParentGeography (ParentGeographyType): Reference to a containing (parent) geography.

GeographicLayerBase (ReferenceType): Use for geographic polygons that are the result of layering 2 or more geographic hierarchies where the polygon being described is the intersect of the layers. For example: State - County - County Subdivision - Place/Remainder - Tract [The portion of a tract that is within a single place (or non-place area) and a single county subdivision] This polygon is made by overlaying the following three geographic hierarchies: 1) State - Place, 2) State - County - Tract, and 3) State - County - Subdivision. The three GeographicLayerBase elements would point to Tract, Place, and County Subdivision.

Values (GeographyValuesType): Allows inclusion of specific values (eg. for the geographic level of "country" allows specification of Germany, Norway, Sweden etc.).

GeographicLocationReference (ReferenceType): Reference to a previously defined set of geographic values.

WestLongitude (LongitudeType): West longitude of the bounding box. (xmin)

EastLongitude (LongitudeType): East longitude of the bounding box. (xmax)

SouthLatitude (LatitudeType): South latitude of the bounding box. (ymin)

NorthLatitude (LatitudeType): North latitude of the bounding box. (ymax)

CoverageLimitation (InternationalStringType): Describes limitations of coverage within the parent geography (for example only places with a population of over 10,000).

VariableReference (ReferenceType): References the single code (as in the case of a single level hierarchy like a Metroplitan Area within a single country where there is one unique code, or a Variable describing the concatenation order being used in the codes provided in the GeographicValues. This may require creating a concatenated Varible to meet this specificiation.

GeographyValue (GeographyValueType): Used to spoecify a geographical value.

GeographyCode (GeographyCodeType): Container for a standard geography code

GeographyName (InternationalStringType): Textual description of the particular geographic entity/code.

GeographicTime (DateType): The date (and, optionally, time) of a specific geographic value (code). This is necessary because geographic boundaries change over time.

BoundingPolygon (PolygonType): A closed plane figure bounded by three or more line segments representing the described geographic area.

ExcludingPolygon (PolygonType): A closed plane figure bounded by three or more line segments representing an area excluded from the described geographical area.

Point (PointType): A geographic point defined by a latitude and longitude.

XCoordinate (SpatialCoordinateType): An X coordiante (longitudinal equivilent) value.

YCoordinate (SpatialCoordinateType): A Y coordinate (latitudinal equivilent) value.

Relationship (RelationshipType): Relationship between the item within the DDI Instance to which the external resource is related and that item.

RelatedToReference (ReferenceType): Reference to the item within the DDI Instance to which the external resource is related.

RelationshipDescripton (InternationalStringType): A description of the nature of the relationship between the external material in an OtherMaterial element reference and the DDI object to which i is related.

ReferenceDate (DateType): The time period to which the data refer. This item reflects the time period covered by the data, not dates in the life cycle of a study or collection.

Reason (StructuredStringType): Textual description of the reason for the access restriction.

User (StructuredStringType): User group to whom this restriction applies.

UniverseReference (ReferenceType): Reference to the description of the persons or other elements that are the object of the research and to which any analytic results refer.

Add (EmptyType): Notes that the entity being identified is being added.

Replace (ReferenceType): Notes that the entity being identified is replacing another entity value.

Delete (ReferenceType): Notes that the entity being identified is being deleted.

AgencyOrganizationReference (ReferenceType): Reference to an Agency in the organization scheme.

EnforcementAgencyOrganizationReference (ReferenceType): Reference to an Enforcement Agency in the organization scheme.

SeriesStatement (SeriesStatementType): Series statement contains information about the series to which a study unit or group of study units belongs.

SeriesDescription (StructuredStringType):

AnalysisUnit (CodeValueType): The analysis unit, which is a term which may come from a controlled vocabulary.

GeographicStructureReference (ReferenceType): A reference to an internal or external geographic structure in DDI 3.0 XML.

AuthorityOrganizationReference (ReferenceType): Reference to an authorizing agent in the organization scheme.

GeographicLevelReference (ReferenceType): Reference to a Geographic Level.

GeographicLevelDescription (StructuredStringType): Human-readable description of a geographic level, when there is no formal DDI description of it.

Image (ImageType): A reference to an image, with fields describing its properties and type.


Complex Types

HistoricalDateType: Used to preserve an historical date, formatted in a non-ISO fashion.

DateType: Provides the structure of a Date element, which allows a choice between single, simple dates (of BaseDateType) or date ranges. If the Date element contains a range, Cycle may be used to indicate occurrence of this range within a series of ranges as an integer identifying the cycle. ISO-formatted dates are required for all fields; a historically-formatted date may be provided in addition to the ISO-formatted date.

InternationalStringType: Allows for marking-up strings that may be translations from other languages, or that may be translatable into other languages.

StructuredStringType: Provides for string content that may be marked up using XHTML formatting tags.

IdentifiedStructuredStringType: Combines the features of IdentifedStringType and StructuredStringType, providing both identification and XHTML structured content.

EmptyType: Element with no content. It is an abstract type, used to extend into subclasses.

CodeValueType: Provides a code value, as well as a reference to the code list from which the value is taken. Note that the CodeValue can be restricted to reference an enumeration.

CommandFileType: References a file which contains commands.

CommandType: A complete structure to describe formal transformation procedures of variables. This could be an XML structure like MathML or a simple string.

StructuredCommandType: [abstract] This type structures an empty stub which is used as the basis for extensions added using external namespaces such as MathML. The DDI 3.0 extension methodology is used here - a new module is declared, and the StructuredCommand element is used as the head of a substitution group to insert whatever XML is needed to express the command.

AbstractIdentifiableType: [abstract] Used to identify described identifiable objects for purposes of internal and/or external referencing. Elements of this type cannot be versioned or maintained except as part of a complex parent element. Provides containers for Uniform Resource Name (URN) as well as ID information. An entity can either be identified by a URN, or an ID. The Agency and Version information in the URN is inherited from the containing elements. If both URN and combination of elements is used, the URN takes precedence. The element can be designated as an addition, replacement, or deletion to facilitate tracking changes.

IdentifiableType: [abstract]

AbstractVersionableType: [abstract]

VersionableType: [abstract]

AbstractMaintainableType: [abstract]

MaintainableType: [abstract]

SeriesStatementType: Series statement contains information about the series to which a study unit or group of study units belongs. You may point to the URL of a series repository and then use the Name field to indicate the series itself as identified in that repository. Fields also exist for describing the series and providing abbreviations.

ReferenceType: Used for referencing an identified entity expressed in DDI XML, either by a URN and/or an ID. If both are supplied, the URN takes precedence. At a minimum, one or the other is required. The lateBound attribute has a boolean value, which - if set to true - indicates that the latest version should be used.

SchemeReferenceType: This is a type of reference used only by schemes to include or exclude specific items from imported schemes of the same type.

ExcludeType: An item from the referenced scheme which should be excluded from use for the purposes of the reference. If the version field is not used, then the referenced scheme must include only one item with that ID.

VersionType: Version number of the referenced object, expressed as a two-part numeric string composed of two positive integers separated by a period. The first number indicates a major version, the second a minor one: 1.0. Optionally, a third integer may indicate sub-version: 1.0.2. In DDI 3.0, any child object is assumed to inherit its version and maintenance agency from its parent. Thus, the information does not have to be unnecessarily repeated. However, an object can over-ride this inheritance by describing its own maintenance agency and version.

URNType: Container for a URN which complies with DDI conventions. The format of this URN includes the protocol ('urn'), the standard (DDI), the version of the standard, and the object's class (which may be compound, with maintainable, and child versionable/identifiable separated by '.'), followed by an equals sign ('='). After the equals sign comes the maintenance agency and the object's ID, separated by colons. If the ID of the object is compound, the maintainable and the child versionable/maintainable each have an ID with version in square brackets following, using the dot ('.') to separate parent and child objects. Example: urn:ddi:3_0:VariableScheme.Variable=MPC:Vscheme6[1.1].V1[1.1]

IDType: ID type. A fixed attribute is added to the string to ensure that only one ID can be provided.

CitationType: Provides bibliographic citation information for a DDI instance, a group of studies, a study unit, or a physical instance. Note that a native DDI citation is required - the citation information may be repeated using DCElements if desired, but a citation must not consist only of DCElements.

CreatorType: Holds the nam,e of the creator. The affiliation attribute holds a human-readable string indicating the creator's affiliation.

ContributorType: The contributor's name.

FundingInformationType: Provides information about the agency and grant(s) which funded the described entity.

EmbargoType: Provides information about data that are not currently available because of policies established by the principal investigators and/or data producers.

LifecycleInformationType: Allows a listing of events in the life cycle of a data set or collection. Identification, date, agency, and descriptive information are provided for each event. Note that the agency that documents a lifecycle event is not necessarily the same agency as the one that performed the operation being documented as a lifecycle event.

LifecycleEventType: Documents an event in the life cycle of a study or group of studies. A life cycle event can be any event which is judged to be significant enough to document by the agency maintaining the documentation for a particular set of data. The element EventType indicates the type of event, using a typology meaningful to the documentor.

CodeType: Structures the expression of a coding in the data collection process.

CoverageType: Describes the 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.

LabelType: An unstructured label for the element. DDI does not impose any length limitations on Label. If length of Label is constrained due to use of the element in a specific application, the maximum length supported should be noted in the attribute maxLength. Label may be repeated to provide content for systems that have length constraints (e.g., some versions of the following statistical packages have character length limits: SAS 40-character, SPSS 120 characters, and Stata 80 characters). Mnemonics associated with a variable should include both of the following attributes: type="Nickname" and maxLength. Software packages will use this information to select the appropriate mnemonic for use.

TopicalCoverageType: Describes the topical coverage of the data documented in a particular DDI module.

InternationalCodeValueType: Provides a code value, as well as a reference to the code list from which the value is taken. Note that the CodeValue can be restricted to reference an enumeration. Provides a language-locale identifier.

TypedStringType: Provides for string content with a type identifier.

SoftwareType: Describes a specific software package, which may be commercially available or bespoke.

GeographicCoverageType: Describes the geographic coverage of the data documented in a particular DDI module.

LevelReferenceType: Provides a reference to a described geographic level and a human-readable name for the level.

GeographicStructureType: Contains information on the hierarchy of the geographic structure. The structure can be defined within the DDI, or an external structure can be referenced.

GeographyType: Describes the levels of a geographic hierarchy.

ParentGeographyType: References a parent geography and describes whether the geographic level completely fills its parent level.

GeographicLocationType: References or describes specific geographic codes/values.

BoundingBoxType: Set of north, south, east, west coordinates defining a rectangle that encompasses the full extent of geographic coverage.

GeographicLevelType: Describes a geographic level. The level can be identified by a code, or a descriptive name, or both.

GeographyValuesType: Provides the values of a geographic area.

GeographyValueType: Used to specify a geographic value.

GeographyCodeType: Used to specify a geographic code, along with the authority responsible for introducing and maintaining it.

PolygonType: A closed plane figure bounded by three or more line segments, representing a geographic area.

PointType: A geographic point consisting of an X and Y coordinate.

SpatialCoordinateType: Describes a coordinate (such as an X or Y coordinate)

RepresentationType: [abstract] Abstract type for the head of a substitution group for a variable representation or a question response domain. If specific values are used to denote missing values, these can be indicated as a space-delimited list in the missingValue attribute. If the missing value is indicated by a blank, this should be indicated by setting the value of blankIsMissingValue to true.

TextRepresentationType: Structures a textual representation. MinLength and maxlength attributes are inclusive integers describing the number of permitted characters. The regExp attribute holds a regular expression describing the valid contents of the string.

DateTimeRepresentationType: Structures the representation for any type of time format (including dates, etc.).

NumericRepresentationType: Defines the representation for a numeric response. May be a range or specific value, or a list of ranges.

NumberRangeType: Structures a numeric range. the regExp attribute holds a regular expression (same as for W3C XML Schema simple types) which can provide a filter for the contents.