ddi:comparative:3_0

Global Elements

Comparison (ComparisonType): Structures information that is necessary to compare members of a group. This module contains the mapping(s) that inform comparisons and facilitate automation. Note that all maps are pairwise, identifying two schemes and the correlation between two items in those schemes. By using a set of pairwise comparisons, it is possible to describe more complex correspondences - pairwise comparisons are easier to process.

ComparisonDescription (r:StructuredStringType): Description of the comparison, intended to be human-readable.

ConceptMap (GenericMapType): Maps comparable concepts from two different concept schemes.

VariableMap (GenericMapType): Maps comparable variables from two different variable schemes.

QuestionMap (GenericMapType): Maps comparable questions from two different question schemes.

CategoryMap (GenericMapType): Maps comparable categories from two different category schemes.

CodeMap (CodeMapType): Maps comparable codes from two different code schemes.

UniverseMap (GenericMapType): Maps comparable universes from two different universe schemes.

SourceSchemeReference (r:ReferenceType): References the scheme that is the source for the mapping.

TargetSchemeReference (r:ReferenceType): References the scheme that is the target for the mapping.

Correspondence (CorrespondenceType): Describes the correspondence between the target and source schemes.

ItemMap (ItemMapType): Maps an individual item in the source scheme to an item in the target scheme.

Commonality (r:StructuredStringType): Describes the commonality between source and target schemes/items.

Difference (r:StructuredStringType): Describes the differences between source and target schemes/items.

CommonalityTypeCoded (r:CodeValueType): Provides a type code defining the commonality between source and target schemes/items.

UserDefinedCorrespondenceProperty (UserDefinedCorrespondencePropertyType): Provides a user-defined name-value pair describing the correspondence between source and target schemes/items.

Complex Types

ComparisonType: Structures information that is necessary to compare members of a group. Contains the mapping(s) That inform comparisons and facilitate automation. Note that all maps are pairwise, identifying two schemes and the correlation between two items in those schemes. By using a set of pairwise comparisons, it is possible to describe more complex correspondences - pairwise comparisons are easier to process.

• 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] (ComparisonDescription) - min. 0 - max. unbounded
        • Description of the comparison, intended to be human-readable.
      • [Reference] (ConceptMap) - min. 0 - max. unbounded
        • Maps comparable concepts from two different concept schemes.
      • [Reference] (VariableMap) - min. 0 - max. unbounded
        • Maps comparable variables from two different variable schemes.
      • [Reference] (QuestionMap) - min. 0 - max. unbounded
        • Maps comparable questions from two different question schemes.
      • [Reference] (CategoryMap) - min. 0 - max. unbounded
        • Maps comparable categories from two different category schemes.
      • [Reference] (CodeMap) - min. 0 - max. unbounded
        • Maps comparable codes from two different code schemes.
      • [Reference] (UniverseMap) - min. 0 - max. unbounded
        • Maps comparable universes from two different universe schemes.
      • [Reference] (r:Note) - min. 0 - max. unbounded
        • Notes regarding any information in the module.

GenericMapType: Maps comparable items from two different schemes.

• Content:
  • Extends: r: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
      • isVersionable (xs:boolean) - fixed: true
  • Extended Content
    • Sequence of:
      • [Reference] (SourceSchemeReference)
        • References the scheme that is the source for the mapping.
      • [Reference] (TargetSchemeReference)
        • References the scheme that is the target for the mapping.
      • [Reference] (Correspondence)
        • Describes the correspondence between the target and source schemes.
      • [Reference] (ItemMap) - min. 0 - max. unbounded
        • Maps an individual item in the source scheme to an item in the target scheme.

CorrespondenceType: Describes the correspondence between source and target schemes/items.

• Content:
  • Sequence of:
    • [Reference] (Commonality) - max. unbounded
      • Textual description of the common aspects of the two schemes/items.
    • [Reference] (Difference) - max. unbounded
      • Textual description of the differing aspects of the two schemes/items.
    • [Reference] (CommonalityTypeCoded) - min. 0
      • Provides a type code for commonality of the two schemes/items. Suggested values are "Identical", "High", "Medium", "Low", "None".
    • CommonalityWeight (CommonalityWeightType) - min. 0
      • A value between 0 and 1 expressing the degree of commonality (0 indicates none, 1 indicates that they are identical).
    • [Reference] (UserDefinedCorrespondenceProperty) - min. 0 - max. unbounded
      • A user-defined property defining the corrrespondence.

UserDefinedCorrespondencePropertyType: User-defined correspondence of two schemes or items, consisting of a name and a value.

• Content:
  • Sequence of:
    • Name (xs:string)
      • Name for the correspondence of two schemes or items
    • Value (xs:string)
      • Value for the correspondence of two schemes or items

CodeMapType: Maps comparable codes from two different code schemes.

• Content:
  • Extends: r: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
      • isVersionable (xs:boolean) - fixed: true
  • Extended Content
    • Sequence of:
      • [Reference] (SourceSchemeReference)
        • References the code scheme that is the source for the mapping.
      • [Reference] (TargetSchemeReference)
        • References the coce scheme that is the target for the mapping.
      • [Reference] (Correspondence)
        • Describes the difference between source and target schemes.
      • [Reference] (d:GenerationInstruction) - min. 0 - max. unbounded
        • Allows for use of programmatic logic to construct a detailed comparison map between individual codes in the source and target schemes.

ItemMapType: Maps two items (codes, concepts, categories, questions, variables, etc.) from different schemes.

• Content:
  • Sequence of:
    • SourceItem (xs:NCName)
      • References an item in the source scheme.
    • TargetItem (xs:NCName)
      • References a comparable item in the target scheme.
    • [Reference] (Correspondence)
      • Describes the correspondence between source and target items
• Attributes:
  • alias (xs:NCName) - optional
    • Allows for an alias to be assigned to the correspondence between two items, so that it can be referred to with a single name, that would include both related items.

Simple Types

CommonalityWeightType:

• Restricts: xs:float
• minInclusive: 0
• maxInclusive: 1