ddi:physicalinstance:3_0

Global Elements

PhysicalInstance (PhysicalInstanceType): Includes information about the physical instance of a data product (an actual data file). It completes the documentation contained in the Physical Data Product module, which describes the physical layout and other characteristics of the data that do not change when a file is merged with another related file, or split into subsets.

Fingerprint (FingerprintType): Allows for assigning a digital fingerprint to the data file.

Path (PathType): Provides a machine-readable path expression (e.g., Java). for the data file's location

URI (URIType): URI for the data file.

CategoryStatisticType (r:CodeValueType): A generic element for specifying the type of category statistic. Note that this element can be substituted with an element that extends the reusable code type to restrict the possible values to an enumeration.

CategoryStatisticTypeCoded (CategoryStatisticTypeCodedType): [substitution: CategoryStatisticType] A suggested enumeration of category statistics.

SummaryStatisticType (r:CodeValueType): A generic element for specifying the type of summary statistic. Note that this element can be substituted with an element that extends the reusable code type to restrict the possible values to an enumeration.

SummaryStatisticTypeCoded (SummaryStatisticTypeCodedType): [substitution: SummaryStatisticType] A suggested enumeration of summary statistics.

RecordLayoutReference (r:ReferenceType): References the record layout of the data documented in the physical instance.

DataFileIdentification (DataFileIdentificationType): Identifies the data file documented in the physical instance and provides information about its location.

Statistics (StatisticsType): Includes variable and category statistics data documented in the physical instance, or a reference to a physical instance where the statistics are described or located in line.

GrossFileStructure (GrossFileStructureType): Includes information about the file structure, as well as other characteristics that are specific to the physical instance.

CreationSoftware (r:SoftwareType): Indicates the software that was used to create the data file.

StatisticalDataFileReference (StatisticalDataFileReferenceType): This is a reference to a PhysicalInstance module that describes a data file containing the summary and/or category statistics OR contains the statistics in-line. For example, when the same data are stored as an ascii file and as an ORACLE file, the summary and category statistics would only be listed in one of the physical instance files, and referenced in the other(s).

DataFileReference (r:ReferenceType): References a data file description.

VariableStatistics (VariableStatisticsType): One or more statistical measures that describe the responses to a particular variable.

VariableReference (r:ReferenceType): Reference to the variable to which the statistics apply.

Filter (FilterType): Provides for a filter on the category statistics. Filter values must be the same type as those for the category statistic.

FilterVariableReference (r:ReferenceType): A filter value allows for a crosstabulation of one variable by another. For example variable may be crossed with country as is done in the Eurobarometer when reporting category statistics.

FilterCategoryStatistics (FilterCategoryStatisticsType): Provides filter category statistics.

FilterCategoryStatistic (FilterCategoryStatisticType): Can be repeated to provide both weighted and unweighted values.

SummaryStatistic (SummaryStatisticType): Includes a summary statistic for the referenced variable.

CategoryStatistics (CategoryStatisticsType): Includes a category-level statistic for the referenced variable.

CategoryStatistic (CategoryStatisticType): Includes a statistic for the category value indicated in the sibling CategoryValue element.

WeightUsedReference (r:ReferenceType): Reference to a weight described in the sample procedure in the mehtodology description.

WeightVariableReference (r:ReferenceType): Reference to the variable containing a record specific weight used to weight the statistic.

ExcludedMissingCategoryReference (r:ReferenceType): Indicates the missing values that were excluded from the statistic. Contains a reference to the category. For the missing value.

ProcessingCheck (r:StructuredStringType): Documents processing checks and other operations performed on the data file.

Complex Types

PhysicalInstanceType: Includes information about the physical instance of a data product (an actual data file). It completes the documentation contained in the Physical Data Product module, which describes the physical layout and other characteristics of the data that do not change when a file is merged with another related file, or split into subsets.

• Content:
  • Extends: r:MaintainableType
  • Base Content
    • Extends: AbstractMaintainableType
    • Base Content
      • Extends: AbstractVersionableType
      • Base Content
        • Extends: AbstractIdentifiableType
        • Base Content
          • Sequence of:
            • [Reference] (Name) - min. 0 - max. unbounded
              • Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
        • Extended Content
          • Sequence of:
            • VersionResponsibility (xs:string) - min. 0
              • Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
            • [Reference] (VersionRationale) - min. 0 - max. unbounded
              • Textual description of the rationale/purpose for a version change.
        • Base Attributes
          • id (BaseIDType) - required
            • Assigned ID, unique within its maintainable object.
          • urn (xs:anyURI) - optional
            • DDI-structured URN of the element as described in Part I of the Technical Documentation.
          • action (ActionCodeType) - optional
            • Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
        • Extended Attributes
          • version (NewVersionType) - optional
            • Restricted string - numeric with optional decimal points.
          • versionDate (BaseDateType) - optional
            • Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
      • Extended Attributes
        • agency (xs:NCName) - optional
          • Maintaining agency as described in Part 1 of the Technical Specification.
    • Extended Attributes
      • isMaintainable (xs:boolean) - fixed: true
  • Extended Content
    • Sequence of:
      • [Reference] (r:Citation) - min. 0
        • Includes a citation for the physical instance of a data set.
      • [Reference] (Fingerprint) - min. 0 - max. unbounded
        • Allows for assigning a digital fingerprint to the data file.
      • [Reference] (r:Coverage) - min. 0
        • Includes information about the topical, spatial, and temporal coverage of the physical instance.
      • [Reference] (r:OtherMaterial) - min. 0 - max. unbounded
        • Provides information about other resources related to the physical instance.
      • [Reference] (r:Note) - min. 0 - max. unbounded
        • Note regarding the physical instance.
      • [Reference] (RecordLayoutReference) - max. unbounded
        • References the record layout of the data documented in the physical instance.
      • [Reference] (DataFileIdentification) - max. unbounded
        • Identifies the data file documented in the physical instance and provides information about its location.
      • [Reference] (GrossFileStructure) - min. 0
        • Includes information about the file structure, as well as other characteristics that are specific to the physical instance.
      • [Reference] (r:ProprietaryInfo) - min. 0
        • Contains information proprietary to the software package which produced the data file. This is expressed as a set of name-value pairs. The value may be taken from a controlled vocabulary.
      • [Reference] (Statistics) - min. 0
        • Includes variable and category statistics data documented in the physical instance, or a reference to a physical instance where the statistics are described or located in line.

FingerprintType: Allows for assigning a digital fingerprint to the data file.

• Content:
  • Sequence of:
    • Value (xs:string)
      • Contains the value of the digital fingerprint.
    • AlgorithmSpecification (xs:string)
      • Specifies the type of the fingerprint (what algorithm or scheme).
    • AlgorithmVersion (xs:string) - min. 0
      • Contains the version of the algorithm.

GrossFileStructureType: Includes information about the file structure, as well as other characteristics that are specific to the physical instance.

• Content:
  • Extends: r: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
      • isIdentifiable (xs:boolean) - fixed: true
  • Extended Content
    • Sequence of:
      • PlaceOfProduction (xs:string) - min. 0
        • Indicates the place where the physical instance was produced.
      • [Reference] (ProcessingCheck) - min. 0 - max. unbounded
        • Documents processing checks and other operations performed on the data file.
      • ProcessingStatus (xs:string) - min. 0
        • Processing status of the data file.
      • [Reference] (CreationSoftware) - min. 0
        • Indicates the software that was used to create the data file.
      • CaseQuantity (xs:integer) - min. 0
        • Number of cases or observations in the data file.
      • OverallRecordCount (xs:integer) - min. 0
        • Overall record count in the data file.

DataFileIdentificationType: Identifies the data file documented in the physical instance and provides information about its location.

• Content:
  • Extends: r: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
      • isIdentifiable (xs:boolean) - fixed: true
  • Extended Content
    • Sequence of:
      • Location (xs:string) - min. 0 - max. unbounded
        • Documents the location of the data file as human-readable text.
      • [Reference] (Path) - min. 0 - max. unbounded
        • Provides a machine-readable path expression for the data file's location (eg Java).
      • [Reference] (URI) - max. unbounded
        • URI for the data file.
  • Extended Attributes
    • isMaster (xs:boolean) - optional
      • A value of true indicates that the mentioned file is the master file, in the case that there are multiple copies of the file identified.

PathType: Provides a machine-readable path expression for the data file's location (eg Java).

• Content:
  • Extends: xs:string
  • Extended Attributes
    • isPublic (xs:boolean) - default: true
      • Indicates that the location is publically available.

URIType: URI for the data file.

• Content:
  • Extends: xs:anyURI
  • Extended Attributes
    • isPublic (xs:boolean) - default: true
      • Indicates that the location is publically available.

StatisticsType: Includes variable and category statistics, as well as a reference to the logical product module that describes the intellectual content of the data documented in the physical instance.

• Content:
  • Sequence of:
    • [Reference] (StatisticalDataFileReference) - min. 0 - max. unbounded
      • This is a reference to a physicalinstance that describes a data file containing the summary and/or category statistics OR contains the statistics in-line as in the case of the same data stored as an ascii file and as an ORACLE file where the summary and category statistics are listed only in one of the physical instance files.
    • [Reference] (VariableStatistics) - min. 0 - max. unbounded
      • One or more statistical measures that describe the responses to a particular variable.

StatisticalDataFileReferenceType: References a PhysicalInstance module that describes a data file containing the summary and/or category statistics OR contains the statistics in-line. For example, when the same data are stored as an ascii file and as an ORACLE file, the summary and category statistics would only be listed in one of the physical instance files, and referenced in the other(s).

• Content:
  • Sequence of:
    • [Reference] (DataFileReference)
      • References a data file description.
• Attributes:
  • isInline (xs:boolean) - required
    • Boolean attribute where true indicates that the summary/category statistics are found inline in the referenced physical instance, false indicates that they are in the datafile associated with the physical instance.

VariableStatisticsType: Includes statistical measures that describe responses to individual variables.

• Content:
  • Sequence of:
    • [Reference] (VariableReference)
      • Reference to the variable to which the statistics apply.
    • TotalResponses (xs:integer) - min. 0
      • The total number of responses to this variable. This element is especially useful if the number of responses does not match added case counts. It may also be used to sum the frequencies for variable categories.
    • Choice Of:
      • [Reference] (WeightUsedReference) - min. 0
        • Reference to a weight described in the sample procedure in the methodology description that was used to create the statisitic.
      • [Reference] (WeightVariableReference) - min. 0
        • Reference to a variable to use for weight.
    • [Reference] (ExcludedMissingCategoryReference) - min. 0 - max. unbounded
      • Indicates the missing values that were excluded from the statistic. Contains a reference to the category. For the missing value.Indicates the missing values that were excluded from the statistic. Contains a reference to the category for the missing value.
    • [Reference] (SummaryStatistic) - min. 0 - max. unbounded
      • Includes a summary statistic for the referenced variable.
    • [Reference] (CategoryStatistics) - min. 0 - max. unbounded
      • Includes a category-level statistic for the referenced variable.

CategoryStatisticsType: Includes a category-level statistic.

• Content:
  • Sequence of:
    • CategoryValue (xs:string)
      • Includes a category value.
    • [Reference] (CategoryStatistic) - max. unbounded
      • Includes a statistic for the category value indicated in the sibling CategoryValue element.

CategoryStatisticType: Includes a statistic for a category value.

• Content:
  • Sequence of:
    • [Reference] (CategoryStatisticType)
      • Type of category statistic.
    • Weighted (xs:boolean)
      • Value of true indicates that the weight referenced at the variable statistics level was used.
    • Value (xs:decimal)
      • Container for the statistic.
    • [Reference] (Filter) - min. 0
      • Provides for a filter on the category statistic. Filter values must be the same type as those for the category statistic.

CategoryStatisticTypeCodedType: A suggested enumeration of category statistics.

• Content:
  • Restricts: r:CodeValueType
  • Code: Frequency - Frequency
  • Code: Percent - Percent
  • Code: CrossTabulation - Cross Tabulation
  • Code: ValidCases - Valid Cases
  • Code: InvalidCases - Invalid Cases
  • Code: Minimum - Mimimum
  • Code: Maximum - Maximum
  • Code: StandardDeviation - Standard Deviation
  • Code: CumulativePercent - CumulativePercent
  • Code: UseOther - See otherValue attribute Other
  • Attributes:
    • codeListID (xs:string) - required - fixed: Category Statistic Type
      • Identification of the code list that this value is taken from.
    • codeListAgency (xs:string) - required - fixed: DDI
      • Agency maintaining the code list.
    • codeListVersion (xs:string) - fixed: 1.0
      • Version of the code list.
    • otherValue (xs:string) - optional
      • Other Value.

FilterType: Provides for a filter on the category statistics. Filter values must be the same type as those for the category statistic.

• Content:
  • Sequence of:
    • [Reference] (FilterVariableReference) - min. 0
      • A filter value allows for a crosstabulation of one variable by another. For example variable may be crossed with country as is done in the Eurobarometer when reporting category statistics.
    • [Reference] (FilterCategoryStatistics) - min. 0
      • Provides filtered category statistics.

FilterCategoryStatisticsType: Provides a filtered category statistic.

• Content:
  • Sequence of:
    • FilterCategoryValue (xs:string)
      • Value of the FilterVariable category
    • [Reference] (FilterCategoryStatistic) - max. unbounded
      • Repeatable to provide both weighted and unweighted values.

FilterCategoryStatisticType: Provides filtered category statistics.

• Content:
  • Sequence of:
    • Weighted (xs:boolean)
      • Value of true indicates that the weight reference at the variable statistics level is used.
    • Value (xs:decimal)
      • Container for the statistic.

SummaryStatisticType: Includes a summary statistic for a variable.

• Content:
  • Sequence of:
    • [Reference] (SummaryStatisticType)
      • Type of summary statistic.
    • Weighted (xs:boolean)
      • Value of true indicates that the weight reference at the variable statistics level is used.
    • Value (xs:decimal)
      • Container for the actual summary statistic.

SummaryStatisticTypeCodedType:

• Content:
  • Restricts: r:CodeValueType
  • Code: Mean - Mean (2nd Quartile)
  • Code: Mode - Mode
  • Code: Median - Median
  • Code: ValidCases - Valid Cases
  • Code: InvalidCases - Invalid Cases
  • Code: Minimum - Mimimum
  • Code: Maximum - Maximum
  • Code: StandardDeviation - Standard Deviation
  • Code: FirstQuartile - First quartile
  • Code: ThirdQuartile - Third quartile
  • Code: FourthQuartile - Fourth quartile
  • Code: FirstQuintile - First quintile
  • Code: SecondQuintile - Second quintile
  • Code: ThirdQuintile - Third quintile
  • Code: FourthQuintile - FourthQuintile
  • Code: FifthQuintile - FifthQuintile
  • Code: FirstDecile - First Decile
  • Code: SecondDecile - Second Decile
  • Code: ThirdDecile - Third Decile
  • Code: FourthDecile - FourthDecile
  • Code: FifthDecile - FifthDecile
  • Code: SixthDecile - Sixth Decile
  • Code: SeventhDecile - Seventh Decile
  • Code: EightDecile - Eigth Decile
  • Code: NinthDecile - NinthDecile
  • Code: TenthDecile - TenthDecile
  • Code: UseOther - See otherValue attribute Other
  • Attributes:
    • codeListID (xs:string) - required - fixed: Summary Statistic Type
      • Identification of the code list that this value is taken from.
    • codeListAgency (xs:string) - required - fixed: DDI
      • Agency maintaining the code list.
    • codeListVersion (xs:string) - fixed: 1.0
      • Version of the code list.
    • otherValue (xs:string) - optional
      • Other Value.