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.
- Content:
- Extends: xs:string
- Extended Attributes
- historicalDateFormat (xs:string) - optional
- Used to specify the non-ISO date format.
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.
- Content:
- Sequence of:
- Choice Of:
- [Reference] (SimpleDate)
- Sequence of:
- [Reference] (StartDate)
- [Reference] (HistoricalStartDate) - min. 0
- Start of a date range, expressed in a historical date format, according to a system specified in the historicalDateFormat attribute.
- [Reference] (EndDate) - min. 0
- End of a date range. If range is continuing on, end date can be blank.
- [Reference] (HistoricalEndDate) - min. 0
- End of a date range, expressed in a historical date format, according to a system specified in the historicalDateFormat attribute.
- Cycle (xs:integer) - min. 0
- Indicates the sequence of a date range within several ranges.
- [Reference] (HistoricalDate) - min. 0
- A date expressed in a historical date format, according to a system specified in the historicalDateFormat attribute.
- Attributes:
- calendar (xs:string) - optional
- Specifies the type of calendar used (e.g., Gregorian, Julian, Jewish).
InternationalStringType: Allows for marking-up strings that may be translations from other languages, or that may be translatable into other languages.
- Content:
- Extends: xs:string
- Extended Attributes
- [Reference] (xml:lang)
- Indicates the language of content.
- translated (xs:boolean) - default: false
- Indicates whether content is a translation (value of true) or not (value of false).
- translatable (xs:boolean) - default: true
- Indicates whether content is translatable (value of true) or not (value of false).
StructuredStringType: Provides for string content that may be marked up using XHTML formatting tags.
- Content:
- Choice Of: - min. 0 - max. unbounded
- Attributes:
- [Reference] (xml:lang)
- Indicates the language of content.
- translated (xs:boolean) - default: false
- Indicates whether content is a translation (value of true) or not (value of false).
- translatable (xs:boolean) - default: true
- Indicates whether content is translatable (value of true) or not (value of false).
IdentifiedStructuredStringType: Combines the features of IdentifedStringType and StructuredStringType, providing both identification and XHTML structured content.
- Content:
- Extends: IdentifiableType
- 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.
- 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
- Extended Content
- Sequence of:
- [Reference] (Content)
- Contains a structured string that may be marked up in XHTML.
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.
- Content:
- Extends: xs:string
- Extended Attributes
- codeListID (xs:string) - optional
- Identifies the code list that the value is taken from.
- codeListAgency (xs:string) - optional
- Agency maintaining the code list.
- codeListVersion (xs:string) - default: 1.0
- Version of the code list. (Default value is 1.0)
- otherValue (xs:string) - optional
CommandFileType: References a file which contains commands.
- Content:
- Sequence of:
- Location (xs:string) - min. 0 - max. unbounded
- Documents the location of the command file as human-readable text.
- Path (xs:string) - min. 0 - max. unbounded
- Provides a machine-readable path expression for the command file's location (e.g. Java).
- URI (xs:anyURI) - min. 0 - max. unbounded
- URI for the command file.
- Attributes:
- formalLanguage (xs:string) - optional
- Indicates the formal language of the command file.
CommandType: A complete structure to describe formal transformation procedures of variables. This could be an XML structure like MathML or a simple string.
- Content:
- Sequence of:
- CommandText (xs:string) - min. 0
- Human-readable text of a command.
- [Reference] (CommandFile) - min. 0 - max. unbounded
- An etxernal file containing the commands for creating the generation.
- [Reference] (StructuredCommand) - min. 0
- Used to insert extensions to provide structured language for external namespaces such as MathML.
- Attributes:
- formalLanguage (xs:string) - optional
- Name of formal language used (for example, MathML, SPSS).
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.
- 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.
- 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.
IdentifiableType: [abstract]
- 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.
- 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
AbstractVersionableType: [abstract]
- 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.
VersionableType: [abstract]
- 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
AbstractMaintainableType: [abstract]
- 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.
MaintainableType: [abstract]
- 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
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.
- Content:
- Sequence of:
- SeriesRepositoryLocation (xs:anyURI) - min. 0
- Location of the repository containing the series.
- [Reference] (Name)
- Abbreviation (xs:string) - min. 0 - max. unbounded
- Abbreviation of the series name
- [Reference] (SeriesDescription) - min. 0 - max. unbounded
- Human-readable description of the series.
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.
- Content:
- Sequence of:
- [Reference] (Module) - min. 0
- References the module of the entity that is being referenced, in cases where there have been local modifications.
- [Reference] (Scheme) - min. 0
- Containing scheme of the entity that is being referenced.
- Choice Of: - max. 2
- [Reference] (URN)
- URN of the entity that is being referenced.
- Sequence of:
- [Reference] (ID)
- ID of the entity that is being referenced.
- IdentifyingAgency (xs:NCName) - min. 0
- Maintaining agency as described in Part 1 of the Technical Specification.
- [Reference] (Version) - min. 0
- If referencing a versioned or maintained element you must include Version. The version can be identified as lateBound, meaning that the latest version should be used.
- Attributes:
- isExternal (xs:boolean) - default: false
- Indicates that the reference is made to an external source. If the value is true, then a URI must be provided.
- URI (xs:anyURI) - optional
- URI identifying the location of an external reference.
- isReference (xs:boolean) - fixed: true
- A fixed attribute value identifying which elements are references.
- lateBound (xs:boolean) - default: false
SchemeReferenceType: This is a type of reference used only by schemes to include or exclude specific items from imported schemes of the same type.
- Content:
- Extends: ReferenceType
- Base Content
- Sequence of:
- [Reference] (Module) - min. 0
- References the module of the entity that is being referenced, in cases where there have been local modifications.
- [Reference] (Scheme) - min. 0
- Containing scheme of the entity that is being referenced.
- Choice Of: - max. 2
- [Reference] (URN)
- URN of the entity that is being referenced.
- Sequence of:
- [Reference] (ID)
- ID of the entity that is being referenced.
- IdentifyingAgency (xs:NCName) - min. 0
- Maintaining agency as described in Part 1 of the Technical Specification.
- [Reference] (Version) - min. 0
- If referencing a versioned or maintained element you must include Version. The version can be identified as lateBound, meaning that the latest version should be used.
- Extended Content
- Sequence of:
- [Reference] (Exclude) - min. 0 - max. unbounded
- An item from the referenced scheme which should be excluded from use for the purposes of the reference.
- Base Attributes
- isExternal (xs:boolean) - default: false
- Indicates that the reference is made to an external source. If the value is true, then a URI must be provided.
- URI (xs:anyURI) - optional
- URI identifying the location of an external reference.
- isReference (xs:boolean) - fixed: true
- A fixed attribute value identifying which elements are references.
- lateBound (xs:boolean) - default: false
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.
- Content:
- Sequence of:
- ID (xs:NCName)
- Version (VersionType) - min. 0
- Version number of excluded item, provided only for versionable items. If not supplied for a reference to a versionable item, all items with the corresponding ID value are excluded.
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]
- Content:
- Extends: xs:anyURI
- Extended Attributes
- type (xs:string) - fixed: URN
- Specifies that this URI is a URN. In future, other types of URI may be allowed here.
IDType: ID type. A fixed attribute is added to the string to ensure that only one ID can be provided.
- Content:
- Extends: xs:NCName
- Extended Attributes
- type (xs:string) - fixed: ID
- Fixed attribute for use in uniqueness constraint.
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.
- Content:
- Sequence of:
- [Reference] (Title) - max. unbounded
- Full authoritative title. Field may be repeated to document multiple languages.
- [Reference] (SubTitle) - min. 0 - max. unbounded
- Secondary or explanatory title.
- [Reference] (AlternateTitle) - min. 0 - max. unbounded
- An alternative title by which a data collection is commonly referred, or an abbreviation for the title.
- [Reference] (Creator) - min. 0 - max. unbounded
- Person, corporate body, or agency responsible for the substantive and intellectual content of the described object.
- [Reference] (Publisher) - min. 0 - max. unbounded
- Person or organization responsible for making the resource available in its present form.
- [Reference] (Contributor) - min. 0 - max. unbounded
- The name of a contributing author or creator, who worked in support of the primary creator given above.
- [Reference] (PublicationDate) - min. 0
- Language (xs:string) - min. 0
- Language of the intellectual content of the described object, expressed either as a two-character ISO language code or as a pair of two-character codes indicating language and locale, as per ISO 3166.
- [Reference] (InternationalIdentifier) - min. 0 - max. unbounded
- ISBN, ISSN or similar designator.
- [Reference] (Copyright) - min. 0
- [Reference] (dc:DCElements) - min. 0
- Element including a sequence of Dublin Core fields that may be used to supplement - but not replace - the DDI citation.
CreatorType: Holds the nam,e of the creator. The affiliation attribute holds a human-readable string indicating the creator's affiliation.
- Content:
- Extends: InternationalStringType
- Base Content
- Extends: xs:string
- Extended Attributes
- [Reference] (xml:lang)
- Indicates the language of content.
- translated (xs:boolean) - default: false
- Indicates whether content is a translation (value of true) or not (value of false).
- translatable (xs:boolean) - default: true
- Indicates whether content is translatable (value of true) or not (value of false).
- Extended Attributes
ContributorType: The contributor's name.
- Content:
- Extends: InternationalStringType
- Base Content
- Extends: xs:string
- Extended Attributes
- [Reference] (xml:lang)
- Indicates the language of content.
- translated (xs:boolean) - default: false
- Indicates whether content is a translation (value of true) or not (value of false).
- translatable (xs:boolean) - default: true
- Indicates whether content is translatable (value of true) or not (value of false).
- Extended Attributes
- role (xs:string) - optional
- Role played by the cited contributor.
- affiliation (xs:string) - optional
- Human-readable string indicating the contributor's affiliation.
FundingInformationType: Provides information about the agency and grant(s) which funded the described entity.
- Content:
- Sequence of:
- [Reference] (AgencyOrganizationReference) - max. unbounded
- Reference to an organization or individual, defined in the organization scheme, that served as a funding source.
- GrantNumber (xs:string) - min. 0 - max. unbounded
- The identification code of the grant which provided funding for the described object.
- Attributes:
- role (xs:string) - optional
- Role of the funding agency.
EmbargoType: Provides information about data that are not currently available because of policies established by the principal investigators and/or data producers.
- Content:
- Extends: IdentifiableType
- 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.
- 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
- Extended Content
- Sequence of:
- [Reference] (Date)
- Provides the date of the embargo, which may take the form of a relevant date range.
- [Reference] (Rationale) - max. unbounded
- Indicates the reason for the embargo.
- [Reference] (AgencyOrganizationReference)
- Reference to an organization or individual, defined in the organization scheme, responsible for the embargo.
- [Reference] (EnforcementAgencyOrganizationReference) - min. 0 - max. unbounded
- Reference to an organization or individual, defined in the organization scheme, responsible for enforcing the embargo.
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.
- Content:
- Sequence of:
- [Reference] (LifecycleEvent) - max. unbounded
- 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.
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.
- Content:
- Extends: IdentifiableType
- 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.
- 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
- Extended Content
- Sequence of:
- [Reference] (EventType) - min. 0
- Indicates the type of event, using a typology meaningful to the documentor.
- [Reference] (Date)
- The date or date range of the lifecycle event.
- [Reference] (AgencyOrganizationReference)
- Reference to an organization or individual, defined in the organization scheme, responsible for the life cycle event.
- [Reference] (Description) - max. unbounded
- A human-readable description of the event. This may be provided in several languages by repeating the field.
CodeType: Structures the expression of a coding in the data collection process.
- Content:
- Sequence of:
- Code (xs:string)
- The processible code of the expression.
- [Reference] (SourceQuestionReference) - min. 0 - max. unbounded
- A reference to a source question used in the associated Code element.
- [Reference] (Description) - min. 0 - max. unbounded
- A description of the code.
- Attributes:
- programmingLanguage (xs:string) - optional
- The programming language in which the Code is expressed.
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.
- Content:
- Sequence of:
- Choice Of: - min. 0
- [Reference] (TopicalCoverageReference)
- Reference to a previously defined topical coverage.
- [Reference] (TopicalCoverage)
- Description of the topical coverage of the data described in a particular DDI module.
- Choice Of: - min. 0
- [Reference] (SpatialCoverageReference)
- Reference to a previously defined spatial coverage.
- [Reference] (SpatialCoverage)
- Description of the geographic coverage of the data described in a particular DDI module.
- Choice Of: - min. 0
- [Reference] (TemporalCoverageReference)
- Reference to a previously defined temporal coverage.
- [Reference] (TemporalCoverage)
- Description of the temporal coverage of the data described in a particular DDI 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.
- Content:
- Extends: InternationalStringType
- Base Content
- Extends: xs:string
- Extended Attributes
- [Reference] (xml:lang)
- Indicates the language of content.
- translated (xs:boolean) - default: false
- Indicates whether content is a translation (value of true) or not (value of false).
- translatable (xs:boolean) - default: true
- Indicates whether content is translatable (value of true) or not (value of false).
- Extended Attributes
- locationVariant (xs:string) - optional
- Describes a specific geographic location that is also included in the spatial coverage section. The value is the geographic code found in the GeographyCode element.
- validForDate (BaseDateType) - optional
- Allows the specification of valid date for the label. The date must be formatted according to ISO 8601.
- type (xs:string) - optional
- A value taken from a controlled vocabulary, describing the type of the label.
- maxLength (xs:integer) - optional
- A positive integer indicating the maximum number of characters in the label.
TopicalCoverageType: Describes the topical coverage of the data documented in a particular DDI module.
- Content:
- Extends: IdentifiableType
- 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.
- 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
- Extended Content
- Sequence of:
- [Reference] (Subject) - min. 0 - max. unbounded
- A subject or list of subjects that indicate the topical coverage of the data described in a particular module/section.
- [Reference] (Keyword) - min. 0 - max. unbounded
- A keyword (which can be supplied in multiple language-equivalent forms) to support searches on topical coverage.
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.
- Content:
- Extends: InternationalStringType
- Base Content
- Extends: xs:string
- Extended Attributes
- [Reference] (xml:lang)
- Indicates the language of content.
- translated (xs:boolean) - default: false
- Indicates whether content is a translation (value of true) or not (value of false).
- translatable (xs:boolean) - default: true
- Indicates whether content is translatable (value of true) or not (value of false).
- Extended Attributes
- codeListID (xs:string) - optional
- Identifies the code list that the value is taken from.
- codeListAgency (xs:string) - optional
- Agency maintaining the code list.
- codeListVersion (xs:string) - default: 1.0
- Version of the code list. (Default value is 1.0)
TypedStringType: Provides for string content with a type identifier.
- Content:
- Extends: InternationalStringType
- Base Content
- Extends: xs:string
- Extended Attributes
- [Reference] (xml:lang)
- Indicates the language of content.
- translated (xs:boolean) - default: false
- Indicates whether content is a translation (value of true) or not (value of false).
- translatable (xs:boolean) - default: true
- Indicates whether content is translatable (value of true) or not (value of false).
- Extended Attributes
- type (xs:string) - required
- Identifies the type of this string. This attribute can be restricted to use a controlled vocabulary.
SoftwareType: Describes a specific software package, which may be commercially available or bespoke.
- Content:
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- The name of the software package, including its producer.
- Version (xs:string) - min. 0
- The version of the software package. Defaults to '1.0'.
- [Reference] (Description) - min. 0 - max. unbounded
- Description of the software package, intended to be human-readable.
- [Reference] (Date) - min. 0
- Release date of the software package.
- Attributes:
GeographicCoverageType: Describes the geographic coverage of the data documented in a particular DDI module.
- Content:
- Extends: IdentifiableType
- 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.
- 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
- Extended Content
- Sequence of:
- [Reference] (BoundingBox) - min. 0
- 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 coordinates: 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.
- [Reference] (Description) - min. 0 - max. unbounded
- Provides a human-readable summary of the information included in Geography and Geography Reference. It may include information on all levels of spatial coverage, in addition to the overall coverage. This field can map to Dublin Core Coverage, which does not support structured strings. Therefore, if there is intent to map to Dublin Core, the text should not be marked up with XHTML.
- [Reference] (GeographyStructureVariable) - min. 0
- 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.
- [Reference] (SpatialObject) - min. 0
- 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'.
- [Reference] (GeographicStructureReference) - min. 0 - max. unbounded
- Contains information on the hierarchy of the geographic structure. The structure can be defined within the DDI or an external structure can be referenced.
- [Reference] (GeographicLocationReference) - min. 0 - max. unbounded
- Contains information on the specific geographic areas defined in the dataset such as cities, countries, or states. The areas can be defined within the DDI or an external structure can be referenced.
- [Reference] (SummaryDataReference) - min. 0 - max. unbounded
- May be repeated to reference each geography (geographic level) for which there is summary data.
- [Reference] (TopLevelReference)
- Reference to the top-level geography.
- [Reference] (LowestLevelReference)
- Reference to the lowest-level geography.
LevelReferenceType: Provides a reference to a described geographic level and a human-readable name for the level.
- Content:
- Sequence of: - min. 0 - max. unbounded
- [Reference] (LevelReference) - min. 0
- Reference to the Geographic Level as described in the GeographicStructure.
- LevelName (xs:string)
- Human-readable name of the Geographic Level. This field may be used by outside systems to identify the highest or lowest geographic level in a consistent manner regardless of whether the DDI instance contains a detailed Geographic Structure section.
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.
- Content:
- Extends: VersionableType
- 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
- Extended Content
- Choice Of: - min. 0 - max. unbounded
- [Reference] (Geography)
- Used to describe any level of geography, including overall coverage and each of the lower levels.
- [Reference] (GeographyReference)
- Reference to a previously defined geographic hierarchy.
GeographyType: Describes the levels of a geographic hierarchy.
- Content:
- Extends: IdentifiableType
- 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.
- 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
- Extended Content
- Sequence of:
- [Reference] (Level)
- Describes a single level in a geographical breakdown (eg, country, province, etc.)
- Choice Of: - min. 0
- [Reference] (ParentGeography)
- Reference to a single containing (parent) geography.
- [Reference] (GeographicLayerBase) - min. 2 - max. unbounded
- Use for geographic polygons that are the result of layering two 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.
ParentGeographyType: References a parent geography and describes whether the geographic level completely fills its parent level.
- Content:
- Extends: ReferenceType
- Base Content
- Sequence of:
- [Reference] (Module) - min. 0
- References the module of the entity that is being referenced, in cases where there have been local modifications.
- [Reference] (Scheme) - min. 0
- Containing scheme of the entity that is being referenced.
- Choice Of: - max. 2
- [Reference] (URN)
- URN of the entity that is being referenced.
- Sequence of:
- [Reference] (ID)
- ID of the entity that is being referenced.
- IdentifyingAgency (xs:NCName) - min. 0
- Maintaining agency as described in Part 1 of the Technical Specification.
- [Reference] (Version) - min. 0
- If referencing a versioned or maintained element you must include Version. The version can be identified as lateBound, meaning that the latest version should be used.
- Base Attributes
- isExternal (xs:boolean) - default: false
- Indicates that the reference is made to an external source. If the value is true, then a URI must be provided.
- URI (xs:anyURI) - optional
- URI identifying the location of an external reference.
- isReference (xs:boolean) - fixed: true
- A fixed attribute value identifying which elements are references.
- lateBound (xs:boolean) - default: false
- Extended Attributes
- isExhaustiveCoverage (xs:boolean) - required
- Indicates whether the geographic level completely fills its parent level. Counties are exhaustive within States. Places are NOT exhaustive within States.
GeographicLocationType: References or describes specific geographic codes/values.
- Content:
- Extends: VersionableType
- 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
- Extended Content
- Sequence of:
- Choice Of: - min. 0 - max. unbounded
- [Reference] (Values)
- Allows inclusion of specific values (eg. for the geographic level of "country" allows specification of Germany, Norway, Sweden etc.).
- [Reference] (GeographicLocationReference)
- Reference to a previously defined set of geographic values.
- [Reference] (AuthorityOrganizationReference)
- Reference to an organization or individual, defined in the organization scheme, responsible for the code.
- Choice Of:
BoundingBoxType: Set of north, south, east, west coordinates defining a rectangle that encompasses the full extent of geographic coverage.
- Content:
- Sequence of:
- [Reference] (WestLongitude)
- West longitude of the bounding box. (xmin)
- [Reference] (EastLongitude)
- East longitude of the bounding box. (xmax)
- [Reference] (SouthLatitude)
- South latitude of the bounding box. (ymin)
- [Reference] (NorthLatitude)
- North latitude of the bounding box. (ymax)
GeographicLevelType: Describes a geographic level. The level can be identified by a code, or a descriptive name, or both.
- Content:
- Sequence of:
- Choice Of: - max. 2
- Sequence of:
- Code (CodeValueType)
- A numeric code identifying the geographic level (a code for a group of nations, a nation, region, city, etc.).
- [Reference] (AuthorityOrganizationReference)
- Reference to an organization, defined in the organization scheme, responsible for defining the code. This is used as a mandatory field and replaces/overrides any value provided as part of the Code element which precedes it.
- [Reference] (Name) - max. unbounded
- Textual description of the level (e.g. "Nation", "Region"). It can be repeated to provide alternatives in different languages.
- [Reference] (CoverageLimitation) - min. 0 - max. unbounded
- Describes limitations of coverage within the parent geography (for example only places with a population of over 10,000).
- [Reference] (Description) - min. 0 - max. unbounded
- A human-readable description of the geographic level.
GeographyValuesType: Provides the values of a geographic area.
- Content:
- Sequence of:
- [Reference] (VariableReference) - min. 0
- 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.
- ExternalAuthorityReference (xs:anyURI) - min. 0
- Link to an external resource that includes a list of codes for the described geography.
- [Reference] (GeographyValue) - min. 0 - max. unbounded
- Used to specify a geographical value.
GeographyValueType: Used to specify a geographic value.
- Content:
- Sequence of:
- [Reference] (GeographyCode)
- Container for a standard geography code
- [Reference] (GeographyName) - min. 0 - max. unbounded
- Textual description of the particular geographic entity/code.
- [Reference] (GeographicTime)
- The date (and, optionally, time) of a specific geographic value (code). This is necessary because geographic boundaries change over time.
- [Reference] (BoundingPolygon) - min. 0 - max. unbounded
- A closed plane figure bounded by three or more line segments representing the described geographic area.
- [Reference] (ExcludingPolygon) - min. 0 - max. unbounded
- A closed plane figure bounded by three or more line segments representing an area excluded from the described geographical area.
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.
- Content:
- Sequence of:
- Choice Of:
- Sequence of:
- ExternalURI (xs:anyURI)
- Note that ExternalURI points to the boundary file location.
- PolygonLinkCode (xs:string) - min. 0
- The PolygonLinkCode is the identifier of the specific polygon within the file. For example in an NHGIS file the LinkCodeForPolygon for Tract 101.01 in Hennepin County in Minnesota is 2700530010101.
- ShapeFileFormat (xs:string) - min. 0
- The format of the shape file existing at the location indicated by the sibling ExternalURI element.
- Sequence of:
- [Reference] (Point) - min. 4 - max. unbounded
- A geographic point defined by a latitude and longitude.
- [Reference] (GeographicTime)
- A time which corresponds to the identification of a geographic region described by a polygon. This may be a range if historical.
PointType: A geographic point consisting of an X and Y coordinate.
- Content:
- Sequence of:
- [Reference] (XCoordinate)
- An X coordinate (latitudinal equivalent) value.
- [Reference] (YCoordinate)
- A Y coordinate (longitudinal equivalent) value.
SpatialCoordinateType: Describes a coordinate (such as an X or Y coordinate)
- Content:
- Sequence of:
- CoordinateValue (xs:string)
- The value of the coordinate
- Attributes:
- coordinateType (PointFormatType) - required
- Identifies the type of point coordinate system using a controlled vocabulary. Point formats include decimal degree, degrees minutes seconds, decimal minutes, meters, and fee.
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.
- Content:
- Sequence of:
- RecommendedDataType (CodeValueType) - min. 0
- This field provides the recommended treatment of the data within an application. The value should come from a controlled vocabulary - recommended values include the set found in W3C XML Schema Part 2, but excluding string sub-types, QNAME, and NOTATION.
- GenericOutputFormat (CodeValueType) - min. 0
- This field provides a recommended generic treatment of the data for display by an application. The value should come from a controlled vocabulary.
- Attributes:
- missingValue (xs:NMTOKENS) - optional
- List the values used to represent missing data in a space delimited array.
- blankIsMissingValue (xs:boolean) - optional
- When value is true a blank or empty variable content should be treated as a missing value.
- classificationLevel (CategoryRelationCodeType) - optional
- Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous.
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.
- Content:
- Extends: RepresentationType
- Base Content
- Sequence of:
- RecommendedDataType (CodeValueType) - min. 0
- This field provides the recommended treatment of the data within an application. The value should come from a controlled vocabulary - recommended values include the set found in W3C XML Schema Part 2, but excluding string sub-types, QNAME, and NOTATION.
- GenericOutputFormat (CodeValueType) - min. 0
- This field provides a recommended generic treatment of the data for display by an application. The value should come from a controlled vocabulary.
- Base Attributes
- missingValue (xs:NMTOKENS) - optional
- List the values used to represent missing data in a space delimited array.
- blankIsMissingValue (xs:boolean) - optional
- When value is true a blank or empty variable content should be treated as a missing value.
- classificationLevel (CategoryRelationCodeType) - optional
- Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous.
- Extended Attributes
- maxLength (xs:integer) - optional
- Maximum length of the text.
- minLength (xs:integer) - optional
- Minimum length of the text.
- regExp (xs:string) - optional
- Regular expression defining the allowed syntax of the text.
DateTimeRepresentationType: Structures the representation for any type of time format (including dates, etc.).
- Content:
- Extends: RepresentationType
- Base Content
- Sequence of:
- RecommendedDataType (CodeValueType) - min. 0
- This field provides the recommended treatment of the data within an application. The value should come from a controlled vocabulary - recommended values include the set found in W3C XML Schema Part 2, but excluding string sub-types, QNAME, and NOTATION.
- GenericOutputFormat (CodeValueType) - min. 0
- This field provides a recommended generic treatment of the data for display by an application. The value should come from a controlled vocabulary.
- Base Attributes
- missingValue (xs:NMTOKENS) - optional
- List the values used to represent missing data in a space delimited array.
- blankIsMissingValue (xs:boolean) - optional
- When value is true a blank or empty variable content should be treated as a missing value.
- classificationLevel (CategoryRelationCodeType) - optional
- Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous.
- Extended Attributes
- type (DateTypeCodeType) - required
- Value of the date type selected from a controlled vocabulary.
- format (xs:string) - optional
- Describes the format of the date field, in formats such as YYYY/MM or MM-DD-YY, etc. If this attribute is omitted, then the format is assumed to be the XML Schema format corresponding to the type attribute value.
NumericRepresentationType: Defines the representation for a numeric response. May be a range or specific value, or a list of ranges.
- Content:
- Extends: RepresentationType
- Base Content
- Sequence of:
- RecommendedDataType (CodeValueType) - min. 0
- This field provides the recommended treatment of the data within an application. The value should come from a controlled vocabulary - recommended values include the set found in W3C XML Schema Part 2, but excluding string sub-types, QNAME, and NOTATION.
- GenericOutputFormat (CodeValueType) - min. 0
- This field provides a recommended generic treatment of the data for display by an application. The value should come from a controlled vocabulary.
- Extended Content
- Base Attributes
- missingValue (xs:NMTOKENS) - optional
- List the values used to represent missing data in a space delimited array.
- blankIsMissingValue (xs:boolean) - optional
- When value is true a blank or empty variable content should be treated as a missing value.
- classificationLevel (CategoryRelationCodeType) - optional
- Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous.
- Extended Attributes
- type (NumericTypeCodeType) - required
- The type attribute is used by the documentor to describe the numeric response domain.
- scale (xs:integer) - optional
- Records unit of scale, for example 'x1', 'x1000'.
- decimalPositions (xs:integer) - optional
- Refers to the number of decimal places in the variable.
- startValue (xs:double) - optional
- Start, or seed, value for an incremental numeric representation.
- endValue (xs:double) - optional
- End value for a incremental numeric representation.
- interval (xs:double) - optional
- Value to increase, or step value for a incremental numeric representation.
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.
- Content:
- Sequence of:
- [Reference] (Low) - min. 0
- The lower bound of the range. If not present, then there is no lower bound.
- [Reference] (High) - min. 0
- The upper bound of the range. If not present, then there is no upper bound.
- TopCode (xs:integer) - min. 0
- Indicates that any response equal to or greater than this value has been coded as the topcode value.
- BottomCode (xs:integer) - min. 0
- Indicates that any response equal to or less than this value has been coded as the bottomcode value.
- Attributes:
- regExp (xs:string) - optional
- Regular expression defining the allowed syntax of the number.
NumberRangeValueType: Describes a bounding value for a number range.
- Content:
- Extends: xs:decimal
- Extended Attributes
- included (xs:boolean) - default: true
- Indicates that the value is included in the range.
RangeValueType: Described bounding value.
- Content:
- Extends: xs:string
- Extended Attributes
- included (xs:boolean) - required
- Indicates that the value is included in the range.
CodeRepresentationType: Describes a coded representation.
- Content:
- Extends: RepresentationType
- Base Content
- Sequence of:
- RecommendedDataType (CodeValueType) - min. 0
- This field provides the recommended treatment of the data within an application. The value should come from a controlled vocabulary - recommended values include the set found in W3C XML Schema Part 2, but excluding string sub-types, QNAME, and NOTATION.
- GenericOutputFormat (CodeValueType) - min. 0
- This field provides a recommended generic treatment of the data for display by an application. The value should come from a controlled vocabulary.
- Extended Content
- Sequence of:
- [Reference] (CodeSchemeReference) - min. 0 - max. unbounded
- A reference to a code scheme containing the valid response values..
- Base Attributes
- missingValue (xs:NMTOKENS) - optional
- List the values used to represent missing data in a space delimited array.
- blankIsMissingValue (xs:boolean) - optional
- When value is true a blank or empty variable content should be treated as a missing value.
- classificationLevel (CategoryRelationCodeType) - optional
- Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous.
CategoryRepresentationType: Describes a representation based on categorization.
- Content:
- Extends: RepresentationType
- Base Content
- Sequence of:
- RecommendedDataType (CodeValueType) - min. 0
- This field provides the recommended treatment of the data within an application. The value should come from a controlled vocabulary - recommended values include the set found in W3C XML Schema Part 2, but excluding string sub-types, QNAME, and NOTATION.
- GenericOutputFormat (CodeValueType) - min. 0
- This field provides a recommended generic treatment of the data for display by an application. The value should come from a controlled vocabulary.
- Extended Content
- Sequence of:
- [Reference] (CategorySchemeReference) - min. 0 - max. unbounded
- A reference to a category scheme describing the representation.
- Base Attributes
- missingValue (xs:NMTOKENS) - optional
- List the values used to represent missing data in a space delimited array.
- blankIsMissingValue (xs:boolean) - optional
- When value is true a blank or empty variable content should be treated as a missing value.
- classificationLevel (CategoryRelationCodeType) - optional
- Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous.
ExternalCategoryRepresentationType: Structures a response domain based on categorization.
- Content:
- Extends: RepresentationType
- Base Content
- Sequence of:
- RecommendedDataType (CodeValueType) - min. 0
- This field provides the recommended treatment of the data within an application. The value should come from a controlled vocabulary - recommended values include the set found in W3C XML Schema Part 2, but excluding string sub-types, QNAME, and NOTATION.
- GenericOutputFormat (CodeValueType) - min. 0
- This field provides a recommended generic treatment of the data for display by an application. The value should come from a controlled vocabulary.
- Extended Content
- Sequence of:
- ExternalCategoryReference (xs:anyURI)
- References an external, non DDI category. This is the element to use if the Code Scheme being used is not in DDI and cannot be used directly. It provides for both the reference and an explanation of how to use the information accurately within a DDI context.
- [Reference] (Description) - min. 0 - max. unbounded
- A description of the use of the external category file.
- Base Attributes
- missingValue (xs:NMTOKENS) - optional
- List the values used to represent missing data in a space delimited array.
- blankIsMissingValue (xs:boolean) - optional
- When value is true a blank or empty variable content should be treated as a missing value.
- classificationLevel (CategoryRelationCodeType) - optional
- Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous.
GeographicRepresentationType: Structures the representation for a geographic point to ensure collection of relevant information. The point may be associated with a polygon (such as the centroid of the polygon) or a line (end or shape points of a line).
- Content:
- Extends: RepresentationType
- Base Content
- Sequence of:
- RecommendedDataType (CodeValueType) - min. 0
- This field provides the recommended treatment of the data within an application. The value should come from a controlled vocabulary - recommended values include the set found in W3C XML Schema Part 2, but excluding string sub-types, QNAME, and NOTATION.
- GenericOutputFormat (CodeValueType) - min. 0
- This field provides a recommended generic treatment of the data for display by an application. The value should come from a controlled vocabulary.
- Extended Content
- Sequence of:
- Datum (xs:NCName)
- The type of datum being recorded.
- CoordinateSystem (xs:string)
- The precision of the numeric response to be applied by default to the responses, expressed as an integer indicating the number of decimal places to the right of the decimal separator.
- CoordinateZone (xs:string) - min. 0
- CoordinateSource (xs:string)
- Source of the coordinate such as GPS, address mapping, or map interpretation.
- ErrorCorrection (xs:string)
- Type of error correction employed. For example point averaging, WAAS, etc. If none, state none.
- Offset (xs:string)
- GeoreferencedObject (xs:string)
- This could be a household, village centroid, etc.
- AddressMatchType (xs:string) - min. 0
- Use for address match coordinates only. Example: street segment match, ZIPcode centroid, etc.
- [Reference] (CoordinatePairs) - max. unbounded
- Field to capture coordinate pairs as individual pairs or as an array of pairs.
- [Reference] (AlternateOffset) - min. 0
- Allows entry of a non-standard offset figure.
- [Reference] (AlternateObject) - min. 0
- Allows identification of an alternate object when the default object is not measureable.
- [Reference] (AlternateCoordinateSystem) - min. 0
- Allows collection of data for a case in a different coordinate system than stated in the response structure.
- Base Attributes
- missingValue (xs:NMTOKENS) - optional
- List the values used to represent missing data in a space delimited array.
- blankIsMissingValue (xs:boolean) - optional
- When value is true a blank or empty variable content should be treated as a missing value.
- classificationLevel (CategoryRelationCodeType) - optional
- Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous.
- Extended Attributes
- format (PointFormatType) - required
- The type attribute is used by the documentor to describe the numeric response domain.
- spatialPrimitive (GeographicDescriptionCodeType) - required
- Indicates the spatial primitive object which the point references.
CoordinatePairsType: Field to capture coordinate pairs as individual pairs or as an array of pairs.
- Content:
- Extends: TextDomainType
- Base Content
- Extends: TextRepresentationType
- Base Content
- Extends: RepresentationType
- Base Content
- Sequence of:
- RecommendedDataType (CodeValueType) - min. 0
- This field provides the recommended treatment of the data within an application. The value should come from a controlled vocabulary - recommended values include the set found in W3C XML Schema Part 2, but excluding string sub-types, QNAME, and NOTATION.
- GenericOutputFormat (CodeValueType) - min. 0
- This field provides a recommended generic treatment of the data for display by an application. The value should come from a controlled vocabulary.
- Base Attributes
- missingValue (xs:NMTOKENS) - optional
- List the values used to represent missing data in a space delimited array.
- blankIsMissingValue (xs:boolean) - optional
- When value is true a blank or empty variable content should be treated as a missing value.
- classificationLevel (CategoryRelationCodeType) - optional
- Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous.
- Extended Attributes
- maxLength (xs:integer) - optional
- Maximum length of the text.
- minLength (xs:integer) - optional
- Minimum length of the text.
- regExp (xs:string) - optional
- Regular expression defining the allowed syntax of the text.
- Extended Content
- Sequence of:
- [Reference] (Label) - min. 0 - max. unbounded
- Label for the response domain as a human-readable string.
- [Reference] (Description) - min. 0 - max. unbounded
- A human-readable description of the response domain.
- Extended Attributes
- maxArray (xs:integer) - default: 1
- The maximum number of coordinate pairs listed in the array. The two values in a coordinate pair are separated by a comma. Pairs in an array are separated by the character indicated in the arraySeparator attribute. Default value is "1".
- arraySeparator (xs:string) - optional
- The character used to separate arrays, if present. If not given a value, and if the maxArray attribute has a value greater than one, the separator is assumed to be whitespace.
TextDomainType: Structures the response domain for a textual response.
- Content:
- Extends: TextRepresentationType
- Base Content
- Extends: RepresentationType
- Base Content
- Sequence of:
- RecommendedDataType (CodeValueType) - min. 0
- This field provides the recommended treatment of the data within an application. The value should come from a controlled vocabulary - recommended values include the set found in W3C XML Schema Part 2, but excluding string sub-types, QNAME, and NOTATION.
- GenericOutputFormat (CodeValueType) - min. 0
- This field provides a recommended generic treatment of the data for display by an application. The value should come from a controlled vocabulary.
- Base Attributes
- missingValue (xs:NMTOKENS) - optional
- List the values used to represent missing data in a space delimited array.
- blankIsMissingValue (xs:boolean) - optional
- When value is true a blank or empty variable content should be treated as a missing value.
- classificationLevel (CategoryRelationCodeType) - optional
- Indicates the type of relationship, nominal, ordinal, interval, ratio, or continuous.
- Extended Attributes
- maxLength (xs:integer) - optional
- Maximum length of the text.
- minLength (xs:integer) - optional
- Minimum length of the text.
- regExp (xs:string) - optional
- Regular expression defining the allowed syntax of the text.
- Extended Content
- Sequence of:
- [Reference] (Label) - min. 0 - max. unbounded
- Label for the response domain as a human-readable string.
- [Reference] (Description) - min. 0 - max. unbounded
- A human-readable description of the response domain.
ProprietaryInfoType: Contains information proprietary to the software package which produced the data file. This is expressed as a set of name-value pairs.
ProprietaryPropertyType: A name-value pair providing information proprietary to the software package used to produce the data. The name of a property is supplied, along with a value, which may come from a controlled vocabulary.
- Content:
- Extends: CodeValueType
- Base Content
- Extends: xs:string
- Extended Attributes
- codeListID (xs:string) - optional
- Identifies the code list that the value is taken from.
- codeListAgency (xs:string) - optional
- Agency maintaining the code list.
- codeListVersion (xs:string) - default: 1.0
- Version of the code list. (Default value is 1.0)
- otherValue (xs:string) - optional
- Extended Attributes
OtherMaterialType: OtherMaterialType describes the structure of the OtherMaterial element, used to reference external resources. It 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.
- Content:
- Sequence of:
- [Reference] (Citation)
- Bibliographic citation for the external resource.
- ExternalURLReference (xs:anyURI) - min. 0
- Contains a URL which indicates the location of the cited external resource.
- ExternalURNReference (xs:anyURI) - min. 0
- Contains a URN which identifies the cited external resource.
- [Reference] (Relationship) - min. 0 - max. unbounded
- Reference to the item within the DDI Instance to which the external resource is related.
- MIMEType (xs:string) - min. 0
- Provides a standard Internet MIME type for use by processing applications.
- Attributes:
- type (xs:string) - required
- Specifies the type of material.
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.)
- Content:
- Sequence of:
- Subject (xs:string) - min. 0
- [Reference] (Relationship) - max. unbounded
- Reference to the section of the DDI to which this note is related.
- Responsibility (xs:string) - min. 0
- The person or agency responsible for adding the note.
- Header (xs:string) - min. 0
- A brief label or heading for the note contents.
- [Reference] (Content)
- Attributes:
RelationshipType: Relationship between the item within the DDI Instance to which the external resource is related and that item.
- Content:
- Sequence of:
- [Reference] (RelatedToReference)
- Reference to the item within the DDI Instance to which the external resource is related.
- [Reference] (RelationshipDescription) - min. 0 - max. unbounded
- 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.
ImageType: A reference to an image, with a description of ts properties and type.
- Content:
- Extends: xs:anyURI
- Extended Attributes
- dpi (xs:integer) - optional
- Provides the resolution of the image in dots per inch to assist in selecting the appropriate image for various uses.
- [Reference] (xml:lang) - optional
- Allows differention of image content by language, such as the language of a logo.
- type (xs:string) - optional
- Use to identify type or specific intended use of the image (e.g., logo, web-logo, print-logo, photo, etc.).
TemporalCoverageType: Describes the temporal coverage of the data described in a particular DDI module.
- Content:
- Extends: IdentifiableType
- 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.
- 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
- Extended Content
- Sequence of:
- [Reference] (ReferenceDate) - min. 0 - max. unbounded
- 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.
AccessRestrictionDateType: Describes the date or range of dates for access restrictions to all or portions of the data.
- Content:
- Extends: DateType
- Base Content
- Sequence of:
- Choice Of:
- [Reference] (SimpleDate)
- Sequence of:
- [Reference] (StartDate)
- [Reference] (HistoricalStartDate) - min. 0
- Start of a date range, expressed in a historical date format, according to a system specified in the historicalDateFormat attribute.
- [Reference] (EndDate) - min. 0
- End of a date range. If range is continuing on, end date can be blank.
- [Reference] (HistoricalEndDate) - min. 0
- End of a date range, expressed in a historical date format, according to a system specified in the historicalDateFormat attribute.
- Cycle (xs:integer) - min. 0
- Indicates the sequence of a date range within several ranges.
- [Reference] (HistoricalDate) - min. 0
- A date expressed in a historical date format, according to a system specified in the historicalDateFormat attribute.
- Extended Content
- Sequence of:
- [Reference] (Reason) - min. 0 - max. unbounded
- Textual description of the reason for the access restriction.
- [Reference] (User) - min. 0 - max. unbounded
- User group to whom this restriction applies.
- Base Attributes
- calendar (xs:string) - optional
- Specifies the type of calendar used (e.g., Gregorian, Julian, Jewish).
EmailType: Email address type (Currently restricted to Internet format user@server.ext.)
CountryType: Specifies a country.
Simple Types
BaseDateType: Union type which allows date-times, dates, year-months, and years as valid values. These are formatted according to ISO 8601.
BaseIDType: Provides a type which is used for restricting the characters in codes and IDs. Valid characters include A-Z, a-z, @, 0-9, _, -, $.
- Restricts: xs:string
- pattern: ([A-Z]|[a-z]|\*|@|[0-9]|_|$|\-)*
NewVersionType:
- Restricts: xs:string
- pattern: ([0-9])+(\.([0-9])+)*
ActionCodeType:
- Restricts: xs:string
- Code: Add -
The element is in addition to the included Scheme
- Code: Update -
The element updates the element with the same ID in the included Scheme. This new element replaces or updates the included element for local use.
- Code: Delete -
The element with the same ID in the included Scheme should be treated as deleted for local use.
GeographicDescriptionCodeType: Indicates the most discrete level identifed for a single case. Note that data can be collected at a geographic point (address) and reported as such in a protected file, and then aggregated to a polygon for a public file.
- Restricts: xs:NMTOKEN
- Code: Point -
Single geographical point (e.g., an address).
- Code: Polygon -
Geographic area described with a set of three or more points.
- Code: Line -
Set of points describing a line.
- Code: LinearRing -
An area with a defined radius (e.g., area within x miles of a specific point.)
LongitudeType: Longitudinal value.
- Restricts: xs:decimal
- minInclusive: -180
- maxInclusive: 180
LatitudeType: Latitudinal value.
- Restricts: xs:decimal
- minInclusive: -90
- maxInclusive: 90
PointFormatType: Provides an enumerated list of data types.
- Restricts: xs:NMTOKEN
- Code: DecimalDegree -
Value is expressed as a decimal degree
- Code: DegreesMinutesSeconds -
Value is expressed as Degrees-minutes-seconds.
- Code: DecimalMinutes -
Value is expressed as Decimal Minutes.
- Code: Meters -
Value is expressed in meters.
- Code: Feet -
Value is expressed in feet.
CategoryRelationCodeType:
- Restricts: xs:NMTOKEN
- Code: Nominal -
A relationship of less than, or greater than, cannot be established among the included categories. This type of relationship is also called categorical or discrete.
- Code: Ordinal -
The categories in the domain have a rank order.
- Code: Interval -
The categories in the domain are in rank order and have a consistent interval between each category so that differences between arbitrary pairs of measurements can be meaningfully compared.
- Code: Ratio -
The categories have all the features of interval measurement and also have meaningful ratios between arbitrary pairs of numbers.
- Code: Continuous -
May be used to identify both interval and ratio classification levels, when more precise information is not available.
NoteTypeCodeType: A standard typology of notes.
- Restricts: xs:NMTOKEN
- Code: Processing -
A note related to the processing.
- Code: Footnote -
A footnote related to the data or metadata being documented.
- Code: Addendum -
An addendum to the information contained in a DDI section or module. Information of a factual nature as opposed to commentary.
- Code: System -
A note generated by the processing system that produced the data or metadata.
- Code: Problem -
A problem, as reported by a human user or system generated. Generally a temporary note providing information for review and correction.
- Code: Comment -
A human-readable comment, typically of a more subjective nature than a footnote.
- Code: Other -
Any other type of note.
EmailTypeCodeType: Type of address.
VCardEmailTypeCodeType: Enumeration of vCard email types.
- Restricts: xs:NMTOKENS
- Code: INTERNET -
- Code: X400 -
InternetEmailType: Pattern for Internet email address.
- Restricts: xs:string
- pattern: ([\.a-zA-Z0-9_\-])+@([a-zA-Z0-9_\-])+(([a-zA-Z0-9_\-])*\.([a-zA-Z0-9_\-])+)+
OneCharStringType: String of a single character.
TimeZoneCodeType: Coded values specifying time zones as an offset from Greenwich Meridian Time. For example, United States Eastern Standard Time is -5.00.
- Restricts: xs:string
- Code: Other -
- Code: 12.00 -
- Code: 11.45 -
- Code: 11.30 -
- Code: 11.15 -
- Code: 11.00 -
- Code: 10.45 -
- Code: 10.30 -
- Code: 10.15 -
- Code: 10.00 -
- Code: 09.45 -
- Code: 09.30 -
- Code: 09.15 -
- Code: 09.00 -
- Code: 08.45 -
- Code: 08.30 -
- Code: 08.15 -
- Code: 08.00 -
- Code: 07.45 -
- Code: 07.30 -
- Code: 07.15 -
- Code: 07.00 -
- Code: 06.45 -
- Code: 06.30 -
- Code: 06.15 -
- Code: 06.00 -
- Code: 05.45 -
- Code: 05.30 -
- Code: 05.15 -
- Code: 05.00 -
- Code: 04.45 -
- Code: 04.30 -
- Code: 04.15 -
- Code: 04.00 -
- Code: 03.45 -
- Code: 03.30 -
- Code: 03.15 -
- Code: 03.00 -
- Code: 02.45 -
- Code: 02.30 -
- Code: 02.15 -
- Code: 02.00 -
- Code: 01.45 -
- Code: 01.30 -
- Code: 01.15 -
- Code: 01.00 -
- Code: 00.45 -
- Code: 00.30 -
- Code: 00.15 -
- Code: 00.00 -
- Code: -00.15 -
- Code: -00.30 -
- Code: -00.45 -
- Code: -01.00 -
- Code: -01.15 -
- Code: -01.30 -
- Code: -01.45 -
- Code: -02.00 -
- Code: -02.15 -
- Code: -02.30 -
- Code: -02.45 -
- Code: -03.00 -
- Code: -03.15 -
- Code: -03.30 -
- Code: -03.45 -
- Code: -04.00 -
- Code: -04.15 -
- Code: -04.30 -
- Code: -04.45 -
- Code: -05.00 -
- Code: -05.15 -
- Code: -05.30 -
- Code: -05.45 -
- Code: -06.00 -
- Code: -06.15 -
- Code: -06.30 -
- Code: -06.45 -
- Code: -07.00 -
- Code: -07.15 -
- Code: -07.30 -
- Code: -07.45 -
- Code: -08.00 -
- Code: -08.15 -
- Code: -08.30 -
- Code: -08.45 -
- Code: -09.00 -
- Code: -09.15 -
- Code: -09.30 -
- Code: -09.45 -
- Code: -10.00 -
- Code: -10.15 -
- Code: -10.30 -
- Code: -10.45 -
- Code: -11.00 -
- Code: -11.15 -
- Code: -11.30 -
- Code: -11.45 -
- Code: -12.00 -
NumericTypeCodeType: Provides an enumerated list of data types.
- Restricts: xs:NMTOKEN
- Code: BigInteger -
An integer of unlimited size. An integer datatype corresponding to W3C XML Schema's xs:integer datatype.
- Code: Integer -
An integer number can hold a whole number, but no fraction. Integers may be either signed (allowing negative values) or unsigned (nonnegative values only). An integer datatype corresponding to W3C XML Schema's xs:int datatype.
- Code: Long -
An integer of up to 32 bits in size (corresponding to an unsigned range of 0 to 4,294,967,295 or a signed range of -2,147,483,648 to +2,147,483,647). A numeric datatype corresponding to W3C XML Schema's xs:long datatype.
- Code: Short -
An integer of up to 16 bits in size (corresponding to an unsigned range of 0 to 65,535 or a signed range of -32,768 to +32,767), A numeric datatype corresponding to W3C XML Schema's xs:short datatype.
- Code: Decimal -
A real number (allows fractions expressed as decimals). A numeric datatype corresponding to W3C XML Schema's xs:decimal datatype.
- Code: Float -
Real numbers that may be stored in scientific notation (example: 20.0005, 99.9, -5000.12, 6.02e23). A numeric datatype corresponding to W3C XML Schema's xs:float datatype.
- Code: Double -
Float of up to 32 bits. A numeric datatype corresponding to W3C XML Schema's xs:double datatype.
- Code: Count -
Ordinal number of objects in a finite set, discrete. A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1".
- Code: Incremental -
A value that is continuous and infinite can be interval or ratio. This value indicates that the value increments according to the value provided in the interval facet, and has a true value for the isSequence facet.
DateTypeCodeType: Provides an enumerated list of data types.(ISO 8601 usage)
- Restricts: xs:NMTOKEN
- Code: DateTime -
Contains both the date and time as dateTtime. A time datatype corresponding to W3C XML Schema's xs:dateTime datatype.
- Code: Date -
Contains the full date from the Gregorian calender YYYY-MM-DD unless an alternative format is provided. A time datatype corresponding to W3C XML Schema's xs:date datatype.
- Code: Time -
Contains the full time on a 24-hour clock system unless alternative format is provided. hh:mm:ss. Precision can be dropped resulting in hh:mm or hh. A time zone can be added timeZ using the standard time zone designation +-hh:mm or +-hh. A time datatype corresponding to W3C XML Schema's xs:time datatype.
- Code: Year -
Contains the 4 digit year YYYY. A time datatype corresponding to W3C XML Schema's xs:gYear datatype.
- Code: Month -
Contains the 2 digit month MM. A time datatype corresponding to W3C XML Schema's xs:gMonth datatype.
- Code: Day -
Contains the 2 digit day DD. A time datatype corresponding to W3C XML Schema's xs:gDay datatype.
- Code: MonthDay -
Contains the 2 digit month followed by the 2 digit day as MM-DD unless an alternative format is provided. A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype.
- Code: YearMonth -
Contains the 4 digit year followed by the 2 digit month as YYYY-MM unless an alternative format is provided. A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype.
- Code: Duration -
Provides a duration of time represetned by one of the following formats (specific format must be declared) PnnYnnMnnDTnnHnnMnnS where n is replaced with the number of unit types for example "P3Y6M4DT12H30M0S" defines "a period of three years, six months, four days, twelve hours, thirty minutes, and zero seconds". Elements may be omitted if their value is zero. T is used to separate date and time elements so that P3M is 3 months and PT3M is three minutes. Alternative format PdateTtime "P0003-06-04T12:30:00". A time datatype corresponding to W3C XML Schema's xs:duration datatype.
- Code: Timespan -
This is not allowed as a date type when describing an NCube dimension as it represents two dimensions. Complex structure containing start/end, start/duration, or duration/end. Start and end can follow any of the designated datetime structures and should be declared in format. star>/end example: "2007-03-01T13:00:00/2008-05-11T15:30:00" start/duration example: "2007-03-01T13:00:00/P1Y2M10DT2H30M" duration/end example "P1Y2M10DT2H30M/2008-05-11T15:30:00" For start/end expressions, if any elment are missing from the end valude, they are assumed to be the same as for the start value including the time zone if used. For example a 2 hour meeting "2007-12-14T13:30/15:30". A complex datatype specifying a start date (xs:dateTime) and a duration (xs:duration). Note that this is not allowed as thre text type representing a dimension.
CountryCodeType: Union of xs:string and ISO country codes.
IsoCountryCodeType: Union of ISO numeric, 2-letter and 3-letter country codes (PH)
Iso2CountryCodeType: Enumeration of ISO 2-letter country codes.
- Restricts: xs:string
- Code: AX -
Aaland Islands
- Code: AF -
Afghanistan
- Code: AL -
Albania
- Code: DZ -
Algeria
- Code: AS -
American Samoa
- Code: AD -
Andorra
- Code: AO -
Angola
- Code: AI -
Anguilla
- Code: AQ -
Antarctica
- Code: AG -
Antigua and Barbuda
- Code: AR -
Argentina
- Code: AM -
Armenia
- Code: AW -
Aruba
- Code: AU -
Australia
- Code: AT -
Austria
- Code: AZ -
Azerbaijan
- Code: BS -
Bahamas
- Code: BH -
Bahrain
- Code: BD -
Bangladesh
- Code: BB -
Barbados
- Code: BY -
Belarus
- Code: BE -
Belgium
- Code: BZ -
Belize
- Code: BJ -
Benin
- Code: BM -
Bermuda
- Code: BT -
Bhutan
- Code: BO -
Bolivia
- Code: BA -
Bosnia and Herzegowina
- Code: BW -
Botswana
- Code: BV -
Bouvet Island
- Code: BR -
Brazil
- Code: IO -
British Indian Ocean Territory
- Code: BN -
Brunei Darussalam
- Code: BG -
Bulgaria
- Code: BF -
Burkina Faso
- Code: BI -
Burundi
- Code: KH -
Cambodia
- Code: CM -
Cameroon
- Code: CA -
Canada
- Code: CV -
Cape Verde
- Code: KY -
Cayman Islands
- Code: CF -
Central African Republic
- Code: TD -
Chad
- Code: CL -
Chile
- Code: CN -
China
- Code: CX -
Christmas Island
- Code: CC -
Cocos (Keeling) Islands
- Code: CO -
Colombia
- Code: KM -
Comoros
- Code: CD -
Congo, Democratic Republic Of (was Zaire)
- Code: CG -
Congo, Republic Of
- Code: CK -
Cook Islands
- Code: CR -
Costa Rica
- Code: CI -
Cote D'ivoire
- Code: HR -
Croatia (Local Name: Hrvatska)
- Code: CU -
Cuba
- Code: CY -
Cyprus
- Code: CZ -
Czech Republic
- Code: DK -
Denmark
- Code: DJ -
Djibouti
- Code: DM -
Dominica
- Code: DO -
Dominican Republic
- Code: EC -
Ecuador
- Code: EG -
Egypt
- Code: SV -
El Salvador
- Code: GQ -
Equatorial Guinea
- Code: ER -
Eritrea
- Code: EE -
Estonia
- Code: ET -
Ethiopia
- Code: FK -
Falkland Islands (Malvinas)
- Code: FO -
Faroe Islands
- Code: FJ -
Fiji
- Code: FI -
Finland
- Code: FR -
France
- Code: GF -
French Guiana
- Code: PF -
French Polynesia
- Code: TF -
French Southern Territories
- Code: GA -
Gabon
- Code: GM -
Gambia
- Code: GE -
Georgia
- Code: DE -
Germany
- Code: GH -
Ghana
- Code: GI -
Gibraltar
- Code: GR -
Greece
- Code: GL -
Greenland
- Code: GD -
Grenada
- Code: GP -
Guadeloupe
- Code: GU -
Guam
- Code: GT -
Guatemala
- Code: GN -
Guinea
- Code: GW -
Guinea-Bissau
- Code: GY -
Guyana
- Code: HT -
Haiti
- Code: HM -
Heard and Mc Donald Islands
- Code: HN -
Honduras
- Code: HK -
Hong Kong
- Code: HU -
Hungary
- Code: IS -
Iceland
- Code: IN -
India
- Code: ID -
Indonesia
- Code: IR -
Iran (Islamic Republic Of)
- Code: IQ -
Iraq
- Code: IE -
Ireland
- Code: IL -
Israel
- Code: IT -
Italy
- Code: JM -
Jamaica
- Code: JP -
Japan
- Code: JO -
Jordan
- Code: KZ -
Kazakhstan
- Code: KE -
Kenya
- Code: KI -
Kiribati
- Code: KP -
Korea, Democratic People's Republic Of
- Code: KR -
Korea, Republic Of
- Code: KW -
Kuwait
- Code: KG -
Kyrgyzstan
- Code: LA -
Lao People's Democratic Republic
- Code: LV -
Latvia
- Code: LB -
Lebanon
- Code: LS -
Lesotho
- Code: LR -
Liberia
- Code: LY -
Libyan Arab Jamahiriya
- Code: LI -
Liechtenstein
- Code: LT -
Lithuania
- Code: LU -
Luxembourg
- Code: MO -
Macau
- Code: MK -
Macedonia, The Former Yugoslav Republic Of
- Code: MG -
Madagascar
- Code: MW -
Malawi
- Code: MY -
Malaysia
- Code: MV -
Maldives
- Code: ML -
Mali
- Code: MT -
Malta
- Code: MH -
Marshall Islands
- Code: MQ -
Martinique
- Code: MR -
Mauritania
- Code: MU -
Mauritius
- Code: YT -
Mayotte
- Code: MX -
Mexico
- Code: FM -
Micronesia, Federated States Of
- Code: MD -
Moldova, Republic Of
- Code: MC -
Monaco
- Code: MN -
Mongolia
- Code: MS -
Montserrat
- Code: MA -
Morocco
- Code: MZ -
Mozambique
- Code: MM -
Myanmar
- Code: NA -
Namibia
- Code: NR -
Nauru
- Code: NP -
Nepal
- Code: NL -
Netherlands
- Code: AN -
Netherlands Antilles
- Code: NC -
New Caledonia
- Code: NZ -
New Zealand
- Code: NI -
Nicaragua
- Code: NE -
Niger
- Code: NG -
Nigeria
- Code: NU -
Niue
- Code: NF -
Norfolk Island
- Code: MP -
Northern Mariana Islands
- Code: NO -
Norway
- Code: OM -
Oman
- Code: PK -
Pakistan
- Code: PW -
Palau
- Code: PS -
Palestinian Territory, Occupied
- Code: PA -
Panama
- Code: PG -
Papua New Guinea
- Code: PY -
Paraguay
- Code: PE -
Peru
- Code: PH -
Philippines
- Code: PN -
Pitcairn
- Code: PL -
Poland
- Code: PT -
Portugal
- Code: PR -
Puerto Rico
- Code: QA -
Qatar
- Code: RE -
Reunion
- Code: RO -
Romania
- Code: RU -
Russian Federation
- Code: RW -
Rwanda
- Code: SH -
Saint Helena
- Code: KN -
Saint Kitts and Nevis
- Code: LC -
Saint Lucia
- Code: PM -
Saint Pierre and Miquelon
- Code: VC -
Saint Vincent and The Grenadines
- Code: WS -
Samoa
- Code: SM -
San Marino
- Code: ST -
Sao Tome and Principe
- Code: SA -
Saudi Arabia
- Code: SN -
Senegal
- Code: CS -
Serbia and Montenegro
- Code: SC -
Seychelles
- Code: SL -
Sierra Leone
- Code: SG -
Singapore
- Code: SK -
Slovakia
- Code: SI -
Slovenia
- Code: SB -
Solomon Islands
- Code: SO -
Somalia
- Code: ZA -
South Africa
- Code: GS -
South Georgia and The South Sandwich Islands
- Code: ES -
Spain
- Code: LK -
Sri Lanka
- Code: SD -
Sudan
- Code: SR -
Suriname
- Code: SJ -
Svalbard and Jan Mayen Islands
- Code: SZ -
Swaziland
- Code: SE -
Sweden
- Code: CH -
Switzerland
- Code: SY -
Syrian Arab Republic
- Code: TW -
Taiwan
- Code: TJ -
Tajikistan
- Code: TZ -
Tanzania, United Republic Of
- Code: TH -
Thailand
- Code: TL -
Timor-Leste
- Code: TG -
Togo
- Code: TK -
Tokelau
- Code: TO -
Tonga
- Code: TT -
Trinidad and Tobago
- Code: TN -
Tunisia
- Code: TR -
Turkey
- Code: TM -
Turkmenistan
- Code: TC -
Turks and Caicos Islands
- Code: TV -
Tuvalu
- Code: UG -
Uganda
- Code: UA -
Ukraine
- Code: AE -
United Arab Emirates
- Code: GB -
United Kingdom
- Code: US -
United States
- Code: UM -
United States Minor Outlying Islands
- Code: UY -
Uruguay
- Code: UZ -
Uzbekistan
- Code: VU -
Vanuatu
- Code: VA -
Vatican City State (Holy See)
- Code: VE -
Venezuela
- Code: VN -
Viet Nam
- Code: VG -
Virgin Islands (British)
- Code: VI -
Virgin Islands (U.S.)
- Code: WF -
Wallis and Futuna Islands
- Code: EH -
Western Sahara
- Code: YE -
Yemen
- Code: ZM -
Zambia
- Code: ZW -
Zimbabwe
Iso3CountryCodeType: Enumeration of ISO 3-letter country codes (PH)
- Restricts: xs:string
- Code: ALA -
Aaland Islands
- Code: AFG -
Afghanistan
- Code: ALB -
Albania
- Code: DZA -
Algeria
- Code: ASM -
American Samoa
- Code: AND -
Andorra
- Code: AGO -
Angola
- Code: AIA -
Anguilla
- Code: ATA -
Antarctica
- Code: ATG -
Antigua and Barbuda
- Code: ARG -
Argentina
- Code: ARM -
Armenia
- Code: ABW -
Aruba
- Code: AUS -
Australia
- Code: AUT -
Austria
- Code: AZE -
Azerbaijan
- Code: BHS -
Bahamas
- Code: BHR -
Bahrain
- Code: BGD -
Bangladesh
- Code: BRB -
Barbados
- Code: BLR -
Belarus
- Code: BEL -
Belgium
- Code: BLZ -
Belize
- Code: BEN -
Benin
- Code: BMU -
Bermuda
- Code: BTN -
Bhutan
- Code: BOL -
Bolivia
- Code: BIH -
Bosnia and Herzegowina
- Code: BWA -
Botswana
- Code: BVT -
Bouvet Island
- Code: BRA -
Brazil
- Code: IOT -
British Indian Ocean Territory
- Code: BRN -
Brunei Darussalam
- Code: BGR -
Bulgaria
- Code: BFA -
Burkina Faso
- Code: BDI -
Burundi
- Code: KHM -
Cambodia
- Code: CMR -
Cameroon
- Code: CAN -
Canada
- Code: CPV -
Cape Verde
- Code: CYM -
Cayman Islands
- Code: CAF -
Central African Republic
- Code: TCD -
Chad
- Code: CHL -
Chile
- Code: CHN -
China
- Code: CXR -
Christmas Island
- Code: CCK -
Cocos (Keeling) Islands
- Code: COL -
Colombia
- Code: COM -
Comoros
- Code: COD -
Congo, Democratic Republic Of (was Zaire)
- Code: COG -
Congo, Republic Of
- Code: COK -
Cook Islands
- Code: CRI -
Costa Rica
- Code: CIV -
Cote D'ivoire
- Code: HRV -
Croatia (Local Name: Hrvatska)
- Code: CUB -
Cuba
- Code: CYP -
Cyprus
- Code: CZE -
Czech Republic
- Code: DNK -
Denmark
- Code: DJI -
Djibouti
- Code: DMA -
Dominica
- Code: DOM -
Dominican Republic
- Code: ECU -
Ecuador
- Code: EGY -
Egypt
- Code: SLV -
El Salvador
- Code: GNQ -
Equatorial Guinea
- Code: ERI -
Eritrea
- Code: EST -
Estonia
- Code: ETH -
Ethiopia
- Code: FLK -
Falkland Islands (Malvinas)
- Code: FRO -
Faroe Islands
- Code: FJI -
Fiji
- Code: FIN -
Finland
- Code: FRA -
France
- Code: GUF -
French Guiana
- Code: PYF -
French Polynesia
- Code: ATF -
French Southern Territories
- Code: GAB -
Gabon
- Code: GMB -
Gambia
- Code: GEO -
Georgia
- Code: DEU -
Germany
- Code: GHA -
Ghana
- Code: GIB -
Gibraltar
- Code: GRC -
Greece
- Code: GRL -
Greenland
- Code: GRD -
Grenada
- Code: GLP -
Guadeloupe
- Code: GUM -
Guam
- Code: GTM -
Guatemala
- Code: GIN -
Guinea
- Code: GNB -
Guinea-Bissau
- Code: GUY -
Guyana
- Code: HTI -
Haiti
- Code: HMD -
Heard and Mc Donald Islands
- Code: HND -
Honduras
- Code: HKG -
Hong Kong
- Code: HUN -
Hungary
- Code: ISL -
Iceland
- Code: IND -
India
- Code: IDN -
Indonesia
- Code: IRN -
Iran (Islamic Republic Of)
- Code: IRQ -
Iraq
- Code: IRL -
Ireland
- Code: ISR -
Israel
- Code: ITA -
Italy
- Code: JAM -
Jamaica
- Code: JPN -
Japan
- Code: JOR -
Jordan
- Code: KAZ -
Kazakhstan
- Code: KEN -
Kenya
- Code: KIR -
Kiribati
- Code: PRK -
Korea, Democratic People's Republic Of
- Code: KOR -
Korea, Republic Of
- Code: KWT -
Kuwait
- Code: KGZ -
Kyrgyzstan
- Code: LAO -
Lao People's Democratic Republic
- Code: LVA -
Latvia
- Code: LBN -
Lebanon
- Code: LSO -
Lesotho
- Code: LBR -
Liberia
- Code: LBY -
Libyan Arab Jamahiriya
- Code: LIE -
Liechtenstein
- Code: LTU -
Lithuania
- Code: LUX -
Luxembourg
- Code: MAC -
Macau
- Code: MKD -
Macedonia, The Former Yugoslav Republic Of
- Code: MDG -
Madagascar
- Code: MWI -
Malawi
- Code: MYS -
Malaysia
- Code: MDV -
Maldives
- Code: MLI -
Mali
- Code: MLT -
Malta
- Code: MHL -
Marshall Islands
- Code: MTQ -
Martinique
- Code: MRT -
Mauritania
- Code: MUS -
Mauritius
- Code: MYT -
Mayotte
- Code: MEX -
Mexico
- Code: FSM -
Micronesia, Federated States Of
- Code: MDA -
Moldova, Republic Of
- Code: MCO -
Monaco
- Code: MNG -
Mongolia
- Code: MSR -
Montserrat
- Code: MAR -
Morocco
- Code: MOZ -
Mozambique
- Code: MMR -
Myanmar
- Code: NAM -
Namibia
- Code: NRU -
Nauru
- Code: NPL -
Nepal
- Code: NLD -
Netherlands
- Code: ANT -
Netherlands Antilles
- Code: NCL -
New Caledonia
- Code: NZL -
New Zealand
- Code: NIC -
Nicaragua
- Code: NER -
Niger
- Code: NGA -
Nigeria
- Code: NIU -
Niue
- Code: NFK -
Norfolk Island
- Code: MNP -
Northern Mariana Islands
- Code: NOR -
Norway
- Code: OMN -
Oman
- Code: PAK -
Pakistan
- Code: PLW -
Palau
- Code: PSE -
Palestinian Territory, Occupied
- Code: PAN -
Panama
- Code: PNG -
Papua New Guinea
- Code: PRY -
Paraguay
- Code: PER -
Peru
- Code: PHL -
Philippines
- Code: PCN -
Pitcairn
- Code: POL -
Poland
- Code: PRT -
Portugal
- Code: PRI -
Puerto Rico
- Code: QAT -
Qatar
- Code: REU -
Reunion
- Code: ROU -
Romania
- Code: RUS -
Russian Federation
- Code: RWA -
Rwanda
- Code: SHN -
Saint Helena
- Code: KNA -
Saint Kitts and Nevis
- Code: LCA -
Saint Lucia
- Code: SPM -
Saint Pierre and Miquelon
- Code: VCT -
Saint Vincent and The Grenadines
- Code: WSM -
Samoa
- Code: SMR -
San Marino
- Code: STP -
Sao Tome and Principe
- Code: SAU -
Saudi Arabia
- Code: SEN -
Senegal
- Code: SCG -
Serbia and Montenegro
- Code: SYC -
Seychelles
- Code: SLE -
Sierra Leone
- Code: SGP -
Singapore
- Code: SVK -
Slovakia
- Code: SVN -
Slovenia
- Code: SLB -
Solomon Islands
- Code: SOM -
Somalia
- Code: ZAF -
South Africa
- Code: SGS -
South Georgia and The South Sandwich Islands
- Code: ESP -
Spain
- Code: LKA -
Sri Lanka
- Code: SDN -
Sudan
- Code: SUR -
Suriname
- Code: SJM -
Svalbard and Jan Mayen Islands
- Code: SWZ -
Swaziland
- Code: SWE -
Sweden
- Code: CHE -
Switzerland
- Code: SYR -
Syrian Arab Republic
- Code: TWN -
Taiwan
- Code: TJK -
Tajikistan
- Code: TZA -
Tanzania, United Republic Of
- Code: THA -
Thailand
- Code: TLS -
Timor-Leste
- Code: TGO -
Togo
- Code: TKL -
Tokelau
- Code: TON -
Tonga
- Code: TTO -
Trinidad and Tobago
- Code: TUN -
Tunisia
- Code: TUR -
Turkey
- Code: TKM -
Turkmenistan
- Code: TCA -
Turks and Caicos Islands
- Code: TUV -
Tuvalu
- Code: UGA -
Uganda
- Code: UKR -
Ukraine
- Code: ARE -
United Arab Emirates
- Code: GBR -
United Kingdom
- Code: USA -
United States
- Code: UMI -
United States Minor Outlying Islands
- Code: URY -
Uruguay
- Code: UZB -
Uzbekistan
- Code: VUT -
Vanuatu
- Code: VAT -
Vatican City State (Holy See)
- Code: VEN -
Venezuela
- Code: VNM -
Viet Nam
- Code: VGB -
Virgin Islands (British)
- Code: VIR -
Virgin Islands (U.S.)
- Code: WLF -
Wallis and Futuna Islands
- Code: ESH -
Western Sahara
- Code: YEM -
Yemen
- Code: ZMB -
Zambia
- Code: ZWE -
Zimbabwe
IsoNCountryCodeType: Enumeration of ISO numeric country codes.
- Restricts: xs:short
- Code: 248 -
Aaland Islands
- Code: 004 -
Afghanistan
- Code: 008 -
Albania
- Code: 012 -
Algeria
- Code: 016 -
American Samoa
- Code: 020 -
Andorra
- Code: 024 -
Angola
- Code: 660 -
Anguilla
- Code: 010 -
Antarctica
- Code: 028 -
Antigua and Barbuda
- Code: 032 -
Argentina
- Code: 051 -
Armenia
- Code: 533 -
Aruba
- Code: 036 -
Australia
- Code: 040 -
Austria
- Code: 031 -
Azerbaijan
- Code: 044 -
Bahamas
- Code: 048 -
Bahrain
- Code: 050 -
Bangladesh
- Code: 052 -
Barbados
- Code: 112 -
Belarus
- Code: 056 -
Belgium
- Code: 084 -
Belize
- Code: 204 -
Benin
- Code: 060 -
Bermuda
- Code: 064 -
Bhutan
- Code: 068 -
Bolivia
- Code: 070 -
Bosnia and Herzegowina
- Code: 072 -
Botswana
- Code: 074 -
Bouvet Island
- Code: 076 -
Brazil
- Code: 086 -
British Indian Ocean Territory
- Code: 096 -
Brunei Darussalam
- Code: 100 -
Bulgaria
- Code: 854 -
Burkina Faso
- Code: 108 -
Burundi
- Code: 116 -
Cambodia
- Code: 120 -
Cameroon
- Code: 124 -
Canada
- Code: 132 -
Cape Verde
- Code: 136 -
Cayman Islands
- Code: 140 -
Central African Republic
- Code: 148 -
Chad
- Code: 152 -
Chile
- Code: 156 -
China
- Code: 162 -
Christmas Island
- Code: 166 -
Cocos (Keeling) Islands
- Code: 170 -
Colombia
- Code: 174 -
Comoros
- Code: 180 -
Congo, Democratic Republic Of (was Zaire)
- Code: 178 -
Congo, Republic Of
- Code: 184 -
Cook Islands
- Code: 188 -
Costa Rica
- Code: 384 -
Cote D'ivoire
- Code: 191 -
Croatia (Local Name: Hrvatska)
- Code: 192 -
Cuba
- Code: 196 -
Cyprus
- Code: 203 -
Czech Republic
- Code: 208 -
Denmark
- Code: 262 -
Djibouti
- Code: 212 -
Dominica
- Code: 214 -
Dominican Republic
- Code: 218 -
Ecuador
- Code: 818 -
Egypt
- Code: 222 -
El Salvador
- Code: 226 -
Equatorial Guinea
- Code: 232 -
Eritrea
- Code: 233 -
Estonia
- Code: 231 -
Ethiopia
- Code: 238 -
Falkland Islands (Malvinas)
- Code: 234 -
Faroe Islands
- Code: 242 -
Fiji
- Code: 246 -
Finland
- Code: 250 -
France
- Code: 254 -
French Guiana
- Code: 258 -
French Polynesia
- Code: 260 -
French Southern Territories
- Code: 266 -
Gabon
- Code: 270 -
Gambia
- Code: 268 -
Georgia
- Code: 276 -
Germany
- Code: 288 -
Ghana
- Code: 292 -
Gibraltar
- Code: 300 -
Greece
- Code: 304 -
Greenland
- Code: 308 -
Grenada
- Code: 312 -
Guadeloupe
- Code: 316 -
Guam
- Code: 320 -
Guatemala
- Code: 324 -
Guinea
- Code: 624 -
Guinea-Bissau
- Code: 328 -
Guyana
- Code: 332 -
Haiti
- Code: 334 -
Heard and Mc Donald Islands
- Code: 340 -
Honduras
- Code: 344 -
Hong Kong
- Code: 348 -
Hungary
- Code: 352 -
Iceland
- Code: 356 -
India
- Code: 360 -
Indonesia
- Code: 364 -
Iran (Islamic Republic Of)
- Code: 368 -
Iraq
- Code: 372 -
Ireland
- Code: 376 -
Israel
- Code: 380 -
Italy
- Code: 388 -
Jamaica
- Code: 392 -
Japan
- Code: 400 -
Jordan
- Code: 398 -
Kazakhstan
- Code: 404 -
Kenya
- Code: 296 -
Kiribati
- Code: 408 -
Korea, Democratic People's Republic Of
- Code: 410 -
Korea, Republic Of
- Code: 414 -
Kuwait
- Code: 417 -
Kyrgyzstan
- Code: 418 -
Lao People's Democratic Republic
- Code: 428 -
Latvia
- Code: 422 -
Lebanon
- Code: 426 -
Lesotho
- Code: 430 -
Liberia
- Code: 434 -
Libyan Arab Jamahiriya
- Code: 438 -
Liechtenstein
- Code: 440 -
Lithuania
- Code: 442 -
Luxembourg
- Code: 446 -
Macau
- Code: 807 -
Macedonia, The Former Yugoslav Republic Of
- Code: 450 -
Madagascar
- Code: 454 -
Malawi
- Code: 458 -
Malaysia
- Code: 462 -
Maldives
- Code: 466 -
Mali
- Code: 470 -
Malta
- Code: 584 -
Marshall Islands
- Code: 474 -
Martinique
- Code: 478 -
Mauritania
- Code: 480 -
Mauritius
- Code: 175 -
Mayotte
- Code: 484 -
Mexico
- Code: 583 -
Micronesia, Federated States Of
- Code: 498 -
Moldova, Republic Of
- Code: 492 -
Monaco
- Code: 496 -
Mongolia
- Code: 500 -
Montserrat
- Code: 504 -
Morocco
- Code: 508 -
Mozambique
- Code: 104 -
Myanmar
- Code: 516 -
Namibia
- Code: 520 -
Nauru
- Code: 524 -
Nepal
- Code: 528 -
Netherlands
- Code: 530 -
Netherlands Antilles
- Code: 540 -
New Caledonia
- Code: 554 -
New Zealand
- Code: 558 -
Nicaragua
- Code: 562 -
Niger
- Code: 566 -
Nigeria
- Code: 570 -
Niue
- Code: 574 -
Norfolk Island
- Code: 580 -
Northern Mariana Islands
- Code: 578 -
Norway
- Code: 512 -
Oman
- Code: 586 -
Pakistan
- Code: 585 -
Palau
- Code: 275 -
Palestinian Territory, Occupied
- Code: 591 -
Panama
- Code: 598 -
Papua New Guinea
- Code: 600 -
Paraguay
- Code: 604 -
Peru
- Code: 608 -
Philippines
- Code: 612 -
Pitcairn
- Code: 616 -
Poland
- Code: 620 -
Portugal
- Code: 630 -
Puerto Rico
- Code: 634 -
Qatar
- Code: 638 -
Reunion
- Code: 642 -
Romania
- Code: 643 -
Russian Federation
- Code: 646 -
Rwanda
- Code: 654 -
Saint Helena
- Code: 659 -
Saint Kitts and Nevis
- Code: 662 -
Saint Lucia
- Code: 666 -
Saint Pierre and Miquelon
- Code: 670 -
Saint Vincent and The Grenadines
- Code: 882 -
Samoa
- Code: 674 -
San Marino
- Code: 678 -
Sao Tome and Principe
- Code: 682 -
Saudi Arabia
- Code: 686 -
Senegal
- Code: 891 -
Serbia and Montenegro
- Code: 690 -
Seychelles
- Code: 694 -
Sierra Leone
- Code: 702 -
Singapore
- Code: 703 -
Slovakia
- Code: 705 -
Slovenia
- Code: 090 -
Solomon Islands
- Code: 706 -
Somalia
- Code: 710 -
South Africa
- Code: 239 -
South Georgia and The South Sandwich Islands
- Code: 724 -
Spain
- Code: 144 -
Sri Lanka
- Code: 736 -
Sudan
- Code: 740 -
Suriname
- Code: 744 -
Svalbard and Jan Mayen Islands
- Code: 748 -
Swaziland
- Code: 752 -
Sweden
- Code: 756 -
Switzerland
- Code: 760 -
Syrian Arab Republic
- Code: 158 -
Taiwan
- Code: 762 -
Tajikistan
- Code: 834 -
Tanzania, United Republic Of
- Code: 764 -
Thailand
- Code: 626 -
Timor-Leste
- Code: 768 -
Togo
- Code: 772 -
Tokelau
- Code: 776 -
Tonga
- Code: 780 -
Trinidad and Tobago
- Code: 788 -
Tunisia
- Code: 792 -
Turkey
- Code: 795 -
Turkmenistan
- Code: 796 -
Turks and Caicos Islands
- Code: 798 -
Tuvalu
- Code: 800 -
Uganda
- Code: 804 -
Ukraine
- Code: 784 -
United Arab Emirates
- Code: 826 -
United Kingdom
- Code: 840 -
United States
- Code: 581 -
United States Minor Outlying Islands
- Code: 858 -
Uruguay
- Code: 860 -
Uzbekistan
- Code: 548 -
Vanuatu
- Code: 336 -
Vatican City State (Holy See)
- Code: 862 -
Venezuela
- Code: 704 -
Viet Nam
- Code: 092 -
Virgin Islands (British)
- Code: 850 -
Virgin Islands (U.S.)
- Code: 876 -
Wallis and Futuna Islands
- Code: 732 -
Western Sahara
- Code: 887 -
Yemen
- Code: 894 -
Zambia
- Code: 716 -
Zimbabwe
CountryCodeClassCodeType: Type of country code classification
RecommendedCountryCodeClassCodeType: Recommended types of country code
- Restricts: xs:string
- Code: ISO-3166 -
- Code: ISO-3166, 2-letter -
- Code: ISO-3166, 3-letter) -
- Code: ISO-3166, numeric -
This documentation is extracted from the inline documentation of DDI 3.0 XML Schema and is licensed under the terms of the GNU General Public License as the schema itself.