ddi:ddiprofile:3_0

Global Elements

DDIProfile (DDIProfileType): Provides a description of which elements and attributes of the DDI are used in a particular profile of use. A profile of use is that set of fields used in a given instance, by a particular organization or agency, or supported by a DDI-conformant application. It uses XPath expressions which identify the used or unused fields in terms of the DDI instance.

Used (UsedType): Describes an element in the DDI which is used by the profile.

NotUsed (NotUsedType): Describes an element in the DDI which is not used by the profile.

Complex Types

DDIProfileType:

• 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:
      • XPathVersion (xs:decimal)
        • Provides the version of XPath used. Values are 1.0, 2.0 at this time.
      • DDINamespace (xs:decimal) - min. 0
        • Provides the version of DDI schemas used. Values are 3.0, 3.1, etc.
      • Description (r:StructuredStringType) - min. 0 - max. unbounded
        • Provides a human-readable description of the profile. XHTML may be used, and it may be supplied in several language-versions.
      • Instructions (r:StructuredStringType) - min. 0 - max. unbounded
        • Provides human-readable instructions for the profile. XHTML may be used, and it may be supplied in several language-versions.
      • Choice Of: - min. 0 - max. unbounded
        • [Reference] (Used)
          • Indicates an element in the DDI which is used by the profile.
        • [Reference] (NotUsed)
          • Indicates an element in the DDI which is not used by the profile. You cannot make anything which is required in the DDI schemas not used, as this would produce invalid XML instances.

UsedType:

• Content:
  • Sequence of:
    • AlternateName (r:InternationalStringType) - min. 0 - max. unbounded
      • Provides an alternate name for the element, for presentation purposes (not for use in the XML instance). It may be supplied in several language-versions.
    • Description (r:StructuredStringType) - min. 0 - max. unbounded
      • Provides a human-readable description of the profile. XHTML may be used, and it may be supplied in several language-versions.
    • Instructions (r:StructuredStringType) - min. 0 - max. unbounded
      • Provides human-readable instructions for the profile. XHTML may be used, and it may be supplied in several language-versions.
• Attributes:
  • required (xs:boolean) - default: false
    • If true indicates that an element described as optional in DDI is required by the profile.
  • path (xs:string) - required
    • Contains an XPath which points to an element or attribute in DDI instances which is used by the profile. All subelements of a used element are assumed to be supported unless explicitly addressed by the profile. The number of supported repetitions may be included in the XPath expression.
  • defaultValue (xs:string) - optional
    • This field provides a default value for the specified element or attribute if it holds simple content, and the value must be a valid one per the DDI schemas. This assumes that the value is not specified in the DDI instance itself, which would override the default. The value should also be provided as part of the XPath expression supplied for the field.
  • fixedValue (xs:boolean) - default: false
    • This field, if set to true, provides an indication that the default value supplied in the fixedValue attribute is the only one which is allowed for the profile - other values will be overriden with the default (a warning should be issued to the creator of the instance); the value must be a valid one per the DDI schemas.

NotUsedType:

• Content:
  • Extends: xs:string
  • Extended Attributes
    • path (xs:string) - required
      • Contains an XPath which points to an element or attribute in DDI instances which is not used by the profile. All subelements of an unused element are assumed to be included unless explicitly addressed by the profile. The number of supported repetitions may be included in the XPath expression.