1. Introduction

The common namespace defines a collection of constructs that are reused across the various components of SDMX. Most important of these are the referencing mechanism. The goal of the reference construct was to define a generic structure that could be processed uniformly regardless of the context where the reference was used. But it was also important that references be required to be complete whenever possible.

Any object can be referenced either explicitly with a URN or by a set of complete reference fields. To meet the previously stated requirements, and very general mechanism was created based on the URN structure of SDMX objects for these reference fields.

There was also a requirement that the references be able to be refined to meet particular needs outside of the common namespace. An example of this is in the metadata structure specific schemas. It is a requirement that if an target object is specified as having to come from a particular scheme, that a type based on the reference structure be created that enforced the requirement.

Typically, this would not have been an issues as all of the components which make up the references are of atomic types, and therefore can be expressed as XML attributes which are easily refined and restricted since the XML Schema design principles in SDMX always treats attributes as unqualified.

However, the requirement to allow both a URN and/or a complete set of reference field necessitate that these properties be contained in elements. The fact that they are elements typically would mean that the only way a refinement outside of the namespace could happen was if the element were global and allowed for substitutions. This however would mean that every distinct type of referenced object would have a unique set of elements. This moved away from the requirement that the structure be easy to process regardless of context.

The solution to this problem was to deviate from the normal SDMX XML Schema design principle of always using qualified elements and allowing for these to be unqualified. Doing so allows other namespace to derive from these types and place further restrictions on what can be referenced. The deviation from this principle was justified in that it met the all of the requirements and was not deemed to major of a shift since these properties normally would have been expressed as unqualified attributes if it weren't for the complete reference requirement.

2. Schema Documentation

2.1 Common Namespace

http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common

2.1.1 Summary

Referenced Namespaces:

Contents:
81 Global Elements
292 Complex Types
77 Simple Types

2.1.2 Global Elements

Name (TextType): Name is a reusable element, used for providing a human-readable name for an object.

Description (TextType): Description is a reusable element, used for providing a longer human-readable description of an object.

Text (TextType): Text is a reusable element, used for providing a language specific text value for general purposes (i.e. not for a name or description).

StructuredText (XHTMLType): StructuredText is a reusable element, used for providing a language specific text value structured as XHTML.

Annotations (AnnotationsType): Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

Any (EmptyType): Any is an empty element that denotes an object of any type.

Agency (EmptyType): Agency is an empty element that denotes an agency object.

AgencyScheme (EmptyType): AgencyScheme is an empty element that denotes an agency scheme object.

AttachmentConstraint (EmptyType): AttachmentConstraint is an empty element that denotes an attachment constraint object.

Attribute (EmptyType): Attribute is an empty element that denotes an attribute object.

AttributeDescriptor (EmptyType): AttributeDescriptor is an empty element that denotes an attribute descriptor object.

Categorisation (EmptyType): Categorisation is an empty element that denotes a categorisation object.

Category (EmptyType): Category is an empty element that denotes a category object.

CategorySchemeMap (EmptyType): CategorySchemeMap is an empty element that denotes a category scheme map object.

CategoryScheme (EmptyType): CategoryScheme is an empty element that denotes a category scheme object.

Code (EmptyType): Code is an empty element that denotes a code object.

CodeMap (EmptyType): CodeMap is an empty element that denotes a code map object.

Codelist (EmptyType): Codelist is an empty element that denotes a code list object.

CodelistMap (EmptyType): CodelistMap is an empty element that denotes a code list map object.

ComponentMap (EmptyType): ComponentMap is an empty element that denotes a component map object.

Concept (EmptyType): Concept is an empty element that denotes a concept object.

ConceptMap (EmptyType): ConceptMap is an empty element that denotes a concept map object.

ConceptScheme (EmptyType): ConceptScheme is an empty element that denotes a concept scheme object.

ConceptSchemeMap (EmptyType): ConceptSchemeMap is an empty element that denotes a concept scheme map object.

ConstraintTarget (EmptyType): ConstraintTarget is an empty element that denotes a constraint target object.

ContentConstraint (EmptyType): ContentConstraint is an empty element that denotes a content constraint object.

CustomType (EmptyType): CustomType is an empty element that denotes a custom type object.

CustomTypeScheme (EmptyType): CustomTypeScheme is an empty element that denotes a custom type scheme object.

Dataflow (EmptyType): Dataflow is an empty element that denotes a data flow object.

DataConsumer (EmptyType): DataConsumer is an empty element that denotes a data consumer object.

DataConsumerScheme (EmptyType): DataConsumerScheme is an empty element that denotes a data consumer scheme object.

DataProvider (EmptyType): DataProvider is an empty element that denotes a data provider object.

DataProviderScheme (EmptyType): DataProviderScheme is an empty element that denotes a data provider scheme object.

DataSetTarget (EmptyType): DataSetTarget is an empty element that denotes a data set target object.

DataStructure (EmptyType): DataStructure is an empty element that denotes a data structure definition object.

Dimension (EmptyType): Dimension is an empty element that denotes a dimension object.

DimensionDescriptor (EmptyType): DimensionDescriptor is an empty element that denotes a dimension descriptor object.

DimensionDescriptorValuesTarget (EmptyType): DimensionDescriptorValuesTarget is an empty element that denotes a dimension descriptor values target object.

GroupDimensionDescriptor (EmptyType): GroupDimensionDescriptor is an empty element that denotes a group dimension descriptor object.

HierarchicalCode (EmptyType): HierarchicalCode is an empty element that denotes a hierarchical code object.

HierarchicalCodelist (EmptyType): HierarchicalCodelist is an empty element that denotes a hierarchical codelist object.

Hierarchy (EmptyType): Hierarchy is an empty element that denotes a hierarchy within a hiearcharchical codelist.

HybridCodelistMap (EmptyType): HybridCodelistMap is an empty element that denotes a hybrid codelist map object.

HybridCodeMap (EmptyType): HybridCodeMap is an empty element that denotes a hybrid code map object.

IdentifiableObjectTarget (EmptyType): IdentifiableObjectTarget is an empty element that denotes an identifiable object target object.

Level (EmptyType): Level is an empty element that denotes a level object.

MeasureDescriptor (EmptyType): MeasureDescriptor is an empty element that denotes a measure descriptor object.

MeasureDimension (EmptyType): MeasureDimension is an empty element that denotes a measure dimension object.

Metadataflow (EmptyType): Metadataflow is an empty element that denotes a metadata flow object.

MetadataAttribute (EmptyType): MetadataAttribute is an empty element that denotes a metadata attribute object.

MetadataSet (EmptyType): MetadataSet is an empty element that denotes a metadata set object.

MetadataStructure (EmptyType): MetadataStructure is an empty element that denotes a metadata structure definition object.

MetadataTarget (EmptyType): MetadataTarget is an empty element that denotes a metadata target object.

NamePersonalisation (EmptyType): NamePersonalisation is an empty element that denotes a name personalisation object.

NamePersonalisationScheme (EmptyType): NamePersonalisationScheme is an empty element that denotes a name personalisation scheme object.

OrganisationMap (EmptyType): OrganisationMap is an empty element that denotes an organisation map object.

OrganisationSchemeMap (EmptyType): OrganisationSchemeMap is an empty element that denotes an organisation scheme map object.

OrganisationUnit (EmptyType): OrganisationUnit is an empty element that denotes an organisation unit object.

OrganisationUnitScheme (EmptyType): OrganisationUnitScheme is an empty element that denotes an organisation unit scheme object.

PrimaryMeasure (EmptyType): PrimaryMeasure is an empty element that denotes a primary measure object.

Process (EmptyType): Process is an empty element that denotes a process object.

ProcessStep (EmptyType): ProcessStep is an empty element that denotes a process step object.

ProvisionAgreement (EmptyType): ProvisionAgreement is an empty element that denotes a provision agreement object.

ReportingCategory (EmptyType): ReportingCategory is an empty element that denotes a reporting category object.

ReportingCategoryMap (EmptyType): ReportingCategoryMap is an empty element that denotes a reporting category map object.

ReportingTaxonomy (EmptyType): ReportingTaxonomy is an empty element that denotes a reporting taxonomy object.

ReportingTaxonomyMap (EmptyType): ReportingTaxonomyMap is an empty element that denotes a reporting taxonomy map object.

ReportPeriodTarget (EmptyType): ReportPeriodTarget is an empty element that denotes a report period target object.

ReportStructure (EmptyType): ReportStructure is an empty element that denotes a report structure object.

Ruleset (EmptyType): Ruleset is an empty element that denotes a ruleset object.

RulesetScheme (EmptyType): RulesetScheme is an empty element that denotes a ruleset scheme object.

StructureMap (EmptyType): StructureMap is an empty element that denotes a structure map object.

StructureSet (EmptyType): StructureSet is an empty element that denotes a structure set object.

TimeDimension (EmptyType): TimeDimension is an empty element that denotes a time dimension object.

Transformation (EmptyType): Transformation is an empty element that denotes a transformation object.

TransformationScheme (EmptyType): TransformationScheme is an empty element that denotes a transformation scheme object.

Transition (EmptyType): Transition is an empty element that denotes a transition object.

UserDefinedOperator (EmptyType): UserDefinedOperator is an empty element that denotes an user defined operator object.

UserDefinedOperatorScheme (EmptyType): UserDefinedOperatorScheme is an empty element that denotes an user defined operator scheme object.

VtlMapping (EmptyType): VtlMapping is an empty element that denotes a VTL Mapping object.

VtlMappingScheme (EmptyType): VtlMappingScheme is an empty element that denotes a VTL mapping scheme object.

2.1.3 Complex Types

TextType: TextType provides for a set of language-specific alternates to be provided for any human-readable constructs in the instance.

Derivation:

• xs:anySimpleType (restriction)
  • xs:string (extension)
    • TextType

Attributes:
xml:lang?

Content:

Attribute Documentation:

StatusMessageType: StatusMessageType describes the structure of an error or warning message. A message contains the text of the message, as well as an optional language indicator and an optional code.

Attributes:
code?

Content:
Text+

Attribute Documentation:

Element Documentation:

CodedStatusMessageType: CodedStatusMessageType describes the structure of an error or warning message which required a code.

Derivation:

• StatusMessageType (restriction)
  • CodedStatusMessageType

Attributes:
code

Content:
Text+

Attribute Documentation:

Element Documentation:

AnnotableType: AnnotableType is an abstract base type used for all annotable artefacts. Any type that provides for annotations should extend this type.

Content:
Annotations?

Element Documentation:

AnnotationsType: AnnotationsType provides for a list of annotations to be attached to data and structure messages.

Content:
Annotation+

Element Documentation:

AnnotationType: AnnotationType provides for non-documentation notes and annotations to be embedded in data and structure messages. It provides optional fields for providing a title, a type description, a URI, and the text of the annotation.

Attributes:
id?

Content:
AnnotationTitle?, AnnotationType?, AnnotationURL?, AnnotationText*

Attribute Documentation:

Element Documentation:

ReferencePeriodType: Specifies the inclusive start and end times.

Attributes:
startTime, endTime

Content:
{Empty}

Attribute Documentation:

QueryableDataSourceType: QueryableDataSourceType describes a data source which is accepts an standard SDMX Query message and responds appropriately.

Attributes:
isRESTDatasource, isWebServiceDatasource

Content:
DataURL, WSDLURL?, WADLURL?

Attribute Documentation:

Element Documentation:

XHTMLType: XHTMLType allows for mixed content of text and XHTML tags. When using this type, one will have to provide a reference to the XHTML schema, since the processing of the tags within this type is strict, meaning that they are validated against the XHTML schema provided.

Attributes:
xml:lang?

Content:
{text} x {any element with namespace of http://www.w3.org/1999/xhtml}*

Attribute Documentation:

RegionType: RegionType is an abstract type which defines a generic constraint region. This type can be refined to define regions for data or metadata sets. A region is defined by a collection of key values - each of which a collection of values for a component which disambiguates data or metadata (i.e. dimensions or the target objects of a metadata target). For each region, as collection of attribute values can be provided. Taken together, the key values and attributes serve to identify or describe a subset of a data or metadata set. Finally, the region can flagged as being included or excluded, although this flag only makes sense when the region is used in a particular context.

Attributes:
include?

Content:
KeyValue*, Attribute*

Attribute Documentation:

Element Documentation:

ComponentValueSetType: ComponentValueSetType is an abstract base type which is used to provide a set of value for a referenced component. Implementations of this type will be based on a particular component type and refine the allowed values to reflect the types of values that are possible for that type of component.

Attributes:
id, include?

Content:
(Value+ | DataSet+ | DataKey+ | Object+ | TimeRange)?

Attribute Documentation:

Element Documentation:

DistinctKeyType: DistinctKeyType is an abstract base type which is a special type of region that only defines a distinct region of data or metadata. For each component defined in the region, only a single values is provided. However, the same rules that apply to the general region about unstated components being wild carded apply here as well. Thus, this type can define a distinct full or partial key for data or metadata.

Derivation:

• RegionType (restriction)
  • DistinctKeyType

Attributes:
include?

Content:
KeyValue+

Attribute Documentation:

Element Documentation:

DinstinctKeyValueType: DinstinctKeyValueType is an abstract base type which defines a singular, required value for a key component.

Derivation:

• ComponentValueSetType (restriction)
  • DinstinctKeyValueType

Attributes:
id, include?

Content:
(Value | DataSet | DataKey | Object)

Attribute Documentation:

Element Documentation:

DataKeyType: DataKeyType is a region which defines a distinct full or partial data key. The key consists of a set of values, each referencing a dimension and providing a single value for that dimension. The purpose of the key is to define a subset of a data set (i.e. the observed value and data attribute) which have the dimension values provided in this definition. Any dimension not stated explicitly in this key is assumed to be wild carded, thus allowing for the definition of partial data keys.

Derivation:

• RegionType (restriction)
  • DistinctKeyType (restriction)
    • DataKeyType

Attributes:
include?

Content:
KeyValue+

Attribute Documentation:

Element Documentation:

DataKeyValueType: DataKeyValueType is a type for providing a dimension value for the purpose of defining a distinct data key. Only a single value can be provided for the dimension.

Derivation:

• ComponentValueSetType (restriction)
  • DinstinctKeyValueType (restriction)
    • DataKeyValueType

Attributes:
id, include?

Content:
Value

Attribute Documentation:

Element Documentation:

MetadataKeyType: MetadataKeyType is a region which defines a distinct full or partial metadata key. The key consists of a set of values, each referencing a target object for the metadata target referenced in the metadataTarget attribute, which must be defined in the report structure referenced in the report attribute. Each target object can be assigned a single value. If an target object from the reference metadata target is not included in this key, the value of that is assumed to be all known objects for a reference target object, all possible keys for a key descriptor values target object, or all dates for report period target object. The purpose of this key reference a metadata conforming to a particular report structure for given object or set of objects.

Derivation:

• RegionType (restriction)
  • DistinctKeyType (restriction)
    • MetadataKeyType

Attributes:
include?, report, metadataTarget

Content:
KeyValue+

Attribute Documentation:

Element Documentation:

MetadataKeyValueType: MetadataKeyValueType is a type for providing a target object value for the purpose of defining a distinct metadata key. Only a single value can be provided for the target object.

Derivation:

• ComponentValueSetType (restriction)
  • DinstinctKeyValueType (restriction)
    • MetadataKeyValueType

Attributes:
id, include?

Content:
(Value | DataSet | DataKey | Object)

Attribute Documentation:

Element Documentation:

CubeRegionType: CubeRegionType defines the structure of a data cube region. This is based on the abstract RegionType and simply refines the key and attribute values to conform with what is applicable for dimensions and attributes, respectively. See the documentation of the base type for more details on how a region is defined.

Derivation:

• RegionType (restriction)
  • CubeRegionType

Attributes:
include?

Content:
KeyValue*, Attribute*

Attribute Documentation:

Element Documentation:

MetadataTargetRegionType: MetadataTargetRegionType defines the structure of a metadata target region. A metadata target region must define the report structure and the metadata target from that structure on which the region is based. This type is based on the abstract RegionType and simply refines the key and attribute values to conform with what is applicable for target objects and metadata attributes, respectively. See the documentation of the base type for more details on how a region is defined.

Derivation:

• RegionType (restriction)
  • MetadataTargetRegionType

Attributes:
include?, report, metadataTarget

Content:
KeyValue*, Attribute*

Attribute Documentation:

Element Documentation:

CubeRegionKeyType: CubeRegionKeyType is a type for providing a set of values for a dimension for the purpose of defining a data cube region. A set of distinct value can be provided, or if this dimension is represented as time, and time range can be specified.

Derivation:

• ComponentValueSetType (restriction)
  • CubeRegionKeyType

Attributes:
id, include?

Content:
(Value+ | TimeRange)

Attribute Documentation:

Element Documentation:

MetadataTargetRegionKeyType: MetadataTargetRegionKeyType is a type for providing a set of values for a target object in a metadata target of a re fence metadata report. A set of values or a time range can be provided for a report period target object. A collection of the respective types of references can be provided for data set reference and identifiable object reference target objects. For a key descriptor values target object, a collection of data keys can be provided.

Derivation:

• ComponentValueSetType (restriction)
  • MetadataTargetRegionKeyType

Attributes:
id, include?

Content:
(Value+ | DataSet+ | DataKey+ | Object+ | TimeRange)

Attribute Documentation:

Element Documentation:

AttributeValueSetType: AttributeValueSetType defines the structure for providing values for a data attribute. If no values are provided, the attribute is implied to include/excluded from the region in which it is defined, with no regard to the value of the data attribute. Note that for metadata attributes which occur within other metadata attributes, a nested identifier can be provided. For example, a value of CONTACT.ADDRESS.STREET refers to the metadata attribute with the identifier STREET which exists in the ADDRESS metadata attribute in the CONTACT metadata attribute, which is defined at the root of the report structure.

Derivation:

• ComponentValueSetType (restriction)
  • AttributeValueSetType

Attributes:
id, include?

Content:
(Value+ | TimeRange)?

Attribute Documentation:

Element Documentation:

MetadataAttributeValueSetType: MetadataAttributeValueSetType defines the structure for providing values for a metadata attribute. If no values are provided, the attribute is implied to include/excluded from the region in which it is defined, with no regard to the value of the metadata attribute.

Derivation:

• ComponentValueSetType (restriction)
  • MetadataAttributeValueSetType

Attributes:
id, include?

Content:
(Value+ | TimeRange)?

Attribute Documentation:

Element Documentation:

SimpleValueType: SimpleValueType contains a simple value for a component, and if that value is from a code list, the ability to indicate that child codes in a simple hierarchy are part of the value set of the component for the region.

Derivation:

• xs:anySimpleType (restriction)
  • xs:string (extension)
    • SimpleValueType

Attributes:
cascadeValues?

Content:

Attribute Documentation:

SimpleKeyValueType: SimpleKeyValueType derives from the SimpleValueType, but does not allow for the cascading of value in the hierarchy, as keys are meant to describe a distinct full or partial key.

Derivation:

• xs:anySimpleType (restriction)
  • 
    
    • xs:string (extension)
      • SimpleValueType (restriction)
        • SimpleKeyValueType

Content:
TimeRangeValueType: TimeRangeValueType allows a time period value to be expressed as a range. It can be expressed as the period before a period, after a period, or between two periods. Each of these properties can specify their inclusion in regards to the range.

Content:
(BeforePeriod | AfterPeriod | (StartPeriod, EndPeriod))

Element Documentation:

TimePeriodRangeType: TimePeriodRangeType defines a time period, and indicates whether it is inclusive in a range.

Derivation:

• xs:anySimpleType (restriction)
  • ObservationalTimePeriodType (extension)
    • TimePeriodRangeType

Attributes:
isInclusive?

Content:
Attribute Documentation:

PayloadStructureType: PayloadStructureType is an abstract base type used to define the structural information for data or metadata sets. A reference to the structure is provided (either explicitly or through a reference to a structure usage).

Attributes:
structureID, schemaURL?, namespace?, dimensionAtObservation?, explicitMeasures?, serviceURL?, structureURL?

Content:
(ProvisionAgrement | StructureUsage | Structure)

Attribute Documentation:

Element Documentation:

DataStructureType: DataStructureType is an abstract base type the forms the basis for the structural information for a data set.

Derivation:

• PayloadStructureType (restriction)
  • DataStructureType

Attributes:
structureID, schemaURL?, namespace?, dimensionAtObservation?, explicitMeasures?, serviceURL?, structureURL?

Content:
(ProvisionAgrement | StructureUsage | Structure)

Attribute Documentation:

Element Documentation:

DataStructureRequestType: DataStructureRequestType is a variation of a the DataStructureType for querying purposes. Only the observation dimension and the explicit measures flag are allowed.

Derivation:

• PayloadStructureType (restriction)
  • DataStructureType (restriction)
    • DataStructureRequestType

Attributes:
structureID, dimensionAtObservation, explicitMeasures?, serviceURL?, structureURL?

Content:
(ProvisionAgrement | StructureUsage | Structure)

Attribute Documentation:

Element Documentation:

GenericDataStructureRequestType: GenericDataStructureRequestType is a variation of a the DataStructureRequestType for querying purposes. The explicit measure flag in not allowed.

Derivation:

• PayloadStructureType (restriction)
  • DataStructureType (restriction)
    • DataStructureRequestType (restriction)
      • GenericDataStructureRequestType

Attributes:
structureID, dimensionAtObservation, serviceURL?, structureURL?

Content:
(ProvisionAgrement | StructureUsage | Structure)

Attribute Documentation:

Element Documentation:

TimeSeriesDataStructureRequestType: TimeSeriesDataStructureRequestType is a variation of a the DataStructureRequestType for querying purposes. The observation dimension is fixed to TIME_PERIOD

Derivation:

• PayloadStructureType (restriction)
  • DataStructureType (restriction)
    • 
      
      • DataStructureRequestType (restriction)
        • TimeSeriesDataStructureRequestType

Attributes:
structureID, dimensionAtObservation, explicitMeasures?, serviceURL?, structureURL?

Content:
(ProvisionAgrement | StructureUsage | Structure)

Attribute Documentation:

Element Documentation:

TimeSeriesGenericDataStructureRequestType: TimeSeriesGenericDataStructureRequestType is a variation of a the GenericDataStructureRequestType for querying purposes. The observation dimension is fixed to TIME_PERIOD.

Derivation:

• PayloadStructureType (restriction)
  • DataStructureType (restriction)
    • DataStructureRequestType (restriction)
      • GenericDataStructureRequestType (restriction)
        • TimeSeriesGenericDataStructureRequestType

Attributes:
structureID, dimensionAtObservation, serviceURL?, structureURL?

Content:
(ProvisionAgrement | StructureUsage | Structure)

Attribute Documentation:

Element Documentation:

GenericDataStructureType: GenericDataStructureType defines the structural information for a generic data set. A reference to the structure, either explicitly or through a dataflow or provision agreement is required as well as the dimension which occurs at the observation level.

Derivation:

• PayloadStructureType (restriction)
  • DataStructureType (restriction)
    • GenericDataStructureType

Attributes:
structureID, dimensionAtObservation, serviceURL?, structureURL?

Content:
(ProvisionAgrement | StructureUsage | Structure)

Attribute Documentation:

Element Documentation:

GenericTimeSeriesDataStructureType: GenericTimeSeriesDataStructureType defines the structural information for a generic time series based data set. The dimension at the observation level is fixed to be TIME_PERIOD.

Derivation:

• PayloadStructureType (restriction)
  • DataStructureType (restriction)
    • GenericDataStructureType (restriction)
      • GenericTimeSeriesDataStructureType

Attributes:
structureID, dimensionAtObservation, serviceURL?, structureURL?

Content:
(ProvisionAgrement | StructureUsage | Structure)

Attribute Documentation:

Element Documentation:

StructureSpecificDataStructureType: StructureSpecificDataStructureType defines the structural information for a structured data set. In addition to referencing the data structure or dataflow which defines the structure of the data, the namespace for the data structure specific schema as well as which dimension is used at the observation level must be provided. It is also necessary to state whether the format uses explicit measures, although this is technically only applicable is the dimension at the observation level is the measure dimension or the flat data format is used.

Derivation:

• PayloadStructureType (restriction)
  • DataStructureType (restriction)
    • StructureSpecificDataStructureType

Attributes:
structureID, schemaURL?, namespace, dimensionAtObservation, explicitMeasures?, serviceURL?, structureURL?

Content:
(ProvisionAgrement | StructureUsage | Structure)

Attribute Documentation:

Element Documentation:

StructureSpecificDataTimeSeriesStructureType: StructureSpecificDataTimeSeriesStructureType defines the structural information for a structure definition specific time series data set. The dimension at the observation level is fixed to be TIME_PERIOD.

Derivation:

• PayloadStructureType (restriction)
  • DataStructureType (restriction)
    • StructureSpecificDataStructureType (restriction)
      • StructureSpecificDataTimeSeriesStructureType

Attributes:
structureID, schemaURL?, namespace, dimensionAtObservation, serviceURL?, structureURL?

Content:
(ProvisionAgrement | StructureUsage | Structure)

Attribute Documentation:

Element Documentation:

MetadataStructureType: MetadataStructureType is an abstract base type the forms the basis of the structural information for any metadata message. A reference to the metadata structure definition or a metadataflow must be provided. This can be used to determine the structure of the message.

Derivation:

• PayloadStructureType (restriction)
  • MetadataStructureType

Attributes:
structureID, schemaURL?, namespace?, serviceURL?, structureURL?

Content:
(ProvisionAgrement | StructureUsage | Structure)

Attribute Documentation:

Element Documentation:

StructureSpecificMetadataStructureType: StructureSpecificMetadataStructureType defines the structural information for a structured metadata message.

Derivation:

• PayloadStructureType (restriction)
  • MetadataStructureType (restriction)
    • StructureSpecificMetadataStructureType

Attributes:
structureID, schemaURL?, namespace, serviceURL?, structureURL?

Content:
(ProvisionAgrement | StructureUsage | Structure)

Attribute Documentation:

Element Documentation:

GenericMetadataStructureType: GenericMetadataStructureType defines the structural information for a generic metadata message.

Derivation:

• PayloadStructureType (restriction)
  • MetadataStructureType (restriction)
    • GenericMetadataStructureType

Attributes:
structureID, schemaURL?, serviceURL?, structureURL?

Content:
(ProvisionAgrement | StructureUsage | Structure)

Attribute Documentation:

Element Documentation:

EmptyType: EmptyType is an empty complex type for elements where the presence of the tag indicates all that is necessary.

Content:
{Empty}

ReferenceType: ReferenceType is an abstract base type. It is used as the basis for all references, to all for a top level generic object reference that can be substituted with an explicit reference to any object. Any reference can consist of a Ref (which contains all required reference fields separately) and/or a URN. These must result in the identification of the same object. Note that the Ref and URN elements are local and unqualified in order to allow for refinement of this structure outside of the namespace. This allows any reference to further refined by a different namespace. For example, a metadata structure definition specific metadata set might wish to restrict the URN to only allow for a value from an enumerated list. The general URN structure, for the purpose of mapping the reference fields is as follows: urn:sdmx:org.package-name.class-name=agency-idmaintainable-parent-object-id[maintainable-parent-object-version].)?(container-object-id.)?object-id([object-version])?.

Content:
( (Ref, URN?) | URN)

Element Documentation:

RefBaseType: RefBaseType is an abstract base type the defines the basis for any set of complete reference fields. This should be refined by derived types so that only the necessary fields are available and required as necessary. This can be used for both full and local references (when some of the values are implied from another context). A local reference is indicated with the local attribute. The values in this type correspond directly to the components of the URN structure, and thus can be used to compose a URN when the local attribute value is false. As this is the case, any reference components which are not part of the URN structure should not be present in the derived types.

Attributes:
agencyID?, maintainableParentID?, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

ObjectReferenceType: ObjectReferenceType is a generic reference which allows for any object to be referenced. The type of object actually referenced can be determined from the URN or from the class attribute of the full set of reference fields.

Derivation:

• ReferenceType (restriction)
  • ObjectReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

ObjectRefType: ObjectRefType contains a set of reference fields for the purpose of referencing any object. This cannot be a local reference, therefore the agency identifier is required. It is also required that the class and package be supplied for the referenced object such that a complete URN reference can be built from the values provided. Note that this is not capable of fully validating that all necessary fields are supplied for a given object type.

Derivation:

• RefBaseType (restriction)
  • ObjectRefType

Attributes:
agencyID, maintainableParentID?, maintainableParentVersion?, containerID?, id, version?, local?, class, package

Content:
{Empty}

Attribute Documentation:

MaintainableRefBaseType: MaintainableRefBaseType is an abstract base type for referencing a maintainable object.

Derivation:

• RefBaseType (restriction)
  • MaintainableRefBaseType

Attributes:
agencyID, id, version?, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

MaintainableRefType: MaintainableRefType contains a complete set of reference fields for referencing any maintainable object.

Derivation:

• RefBaseType (restriction)
  • MaintainableRefBaseType (restriction)
    • MaintainableRefType

Attributes:
agencyID, id, version?, local?, class, package

Content:
{Empty}

Attribute Documentation:

ItemSchemeRefBaseType: ItemSchemeRefBaseType is an abstract base type for referencing an item scheme.

Derivation:

• RefBaseType (restriction)
  • MaintainableRefBaseType (restriction)
    • ItemSchemeRefBaseType

Attributes:
agencyID, id, version?, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

ItemSchemeRefType: ItemSchemeRefType contains a complete set of reference fields for referencing any item scheme. The class and package a required so that the reference is explicit as to the exact object being referenced.

Derivation:

• RefBaseType (restriction)
  • MaintainableRefBaseType (restriction)
    • ItemSchemeRefBaseType (restriction)
      • ItemSchemeRefType

Attributes:
agencyID, id, version?, local?, class, package

Content:
{Empty}

Attribute Documentation:

StructureOrUsageRefBaseType: StructureOrUsageRefBaseType is an abstract base type for referencing a structure or structure usage.

Derivation:

• RefBaseType (restriction)
  • MaintainableRefBaseType (restriction)
    • StructureOrUsageRefBaseType

Attributes:
agencyID, id, version?, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

StructureRefBaseType: StructureRefBaseType is an abstract base type for referencing a structure.

Derivation:

• RefBaseType (restriction)
  • MaintainableRefBaseType (restriction)
    • StructureOrUsageRefBaseType (restriction)
      • StructureRefBaseType

Attributes:
agencyID, id, version?, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

StructureRefType: StructureRefType contains a set of reference fields for referencing any structure.

Derivation:

• RefBaseType (restriction)
  • MaintainableRefBaseType (restriction)
    • StructureOrUsageRefBaseType (restriction)
      • StructureRefBaseType (restriction)
        • StructureRefType

Attributes:
agencyID, id, version?, local?, class, package

Content:
{Empty}

Attribute Documentation:

StructureUsageRefBaseType: StructureUsageRefBaseType is an abstract base type for referencing a structure usage.

Derivation:

• RefBaseType (restriction)
  • MaintainableRefBaseType (restriction)
    • StructureOrUsageRefBaseType (restriction)
      • StructureUsageRefBaseType

Attributes:
agencyID, id, version?, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

StructureUsageRefType: StructureUsageRefType contains a set of reference fields for referencing any structure usage.

Derivation:

• RefBaseType (restriction)
  • MaintainableRefBaseType (restriction)
    • StructureOrUsageRefBaseType (restriction)
      • StructureUsageRefBaseType (restriction)
        • StructureUsageRefType

Attributes:
agencyID, id, version?, local?, class, package

Content:
{Empty}

Attribute Documentation:

ChildObjectRefBaseType: ChildObjectRefBaseType is an abstract base type for referencing any child object defined directly within a maintainable object.

Derivation:

• RefBaseType (restriction)
  • ChildObjectRefBaseType

Attributes:
agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

ContainerChildObjectRefBaseType: ContainerChildObjectRefBaseType is an abstract base type for referencing any child object within container defined in a maintainable object.

Derivation:

• RefBaseType (restriction)
  • ContainerChildObjectRefBaseType

Attributes:
agencyID, maintainableParentID, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

ItemRefBaseType: ItemRefBaseType is an abstract base type for referencing an item within an item scheme.

Derivation:

• RefBaseType (restriction)
  • ChildObjectRefBaseType (restriction)
    • ItemRefBaseType

Attributes:
agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

ComponentListRefBaseType: ComponentListRefBaseType is an abstract base type for referencing a component list within a structure.

Derivation:

• RefBaseType (restriction)
  • ChildObjectRefBaseType (restriction)
    • ComponentListRefBaseType

Attributes:
agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

ComponentRefBaseType: ComponentRefBaseType is an abstract base type for referencing a component contained in a component list within a structure.

Derivation:

• RefBaseType (restriction)
  • ContainerChildObjectRefBaseType (restriction)
    • ComponentRefBaseType

Attributes:
agencyID, maintainableParentID, maintainableParentVersion?, containerID?, id, version?, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

AnyCodelistRefType: AnyCodelistRefType is a type for referencing any codelist object (either a codelist or a hierarchical codelist).

Derivation:

• RefBaseType (restriction)
  • MaintainableRefBaseType (restriction)
    • AnyCodelistRefType

Attributes:
agencyID, id, version?, local?, class, package?

Content:
{Empty}

Attribute Documentation:

StructureOrUsageRefType: StructureOrUsageRefType is a type for referencing a structure or structure usage.

Derivation:

• RefBaseType (restriction)
  • MaintainableRefBaseType (restriction)
    • StructureOrUsageRefBaseType (restriction)
      • StructureOrUsageRefType

Attributes:
agencyID, id, version?, local?, class, package

Content:
{Empty}

Attribute Documentation:

LocalIdentifiableRefBaseType: LocalIdentifiableRefBaseType is an abstract base type which provides a local reference to any identifiable object.

Derivation:

• RefBaseType (restriction)
  • LocalIdentifiableRefBaseType

Attributes:
containerID?, id, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

LocalItemRefBaseType: LocalItemRefBaseType is an abstract base type which provides a local reference to a item object.

Derivation:

• RefBaseType (restriction)
  • LocalIdentifiableRefBaseType (restriction)
    • LocalItemRefBaseType

Attributes:
id, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

LocalComponentListRefBaseType: LocalComponentListRefBaseType is an abstract base type which provides a local reference to a component list object.

Derivation:

• RefBaseType (restriction)
  • LocalIdentifiableRefBaseType (restriction)
    • LocalComponentListRefBaseType

Attributes:
id, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

LocalComponentListComponentRefBaseType: LocalComponentRefBaseType is an abstract base type which provides a local reference to a component object.

Derivation:

• RefBaseType (restriction)
  • LocalIdentifiableRefBaseType (restriction)
    • LocalComponentListComponentRefBaseType

Attributes:
containerID?, id, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

LocalComponentListComponentRefType: LocalComponentListComponentRefType provides a local reference to any component object within a specific component list. References for both of these are required as well as an indication of which type of type of component is being referenced via the class attribute.

Derivation:

• RefBaseType (restriction)
  • LocalIdentifiableRefBaseType (restriction)
    • LocalComponentListComponentRefBaseType (restriction)
      • LocalComponentListComponentRefType

Attributes:
containerID, id, local?, class, package

Content:
{Empty}

Attribute Documentation:

LocalComponentRefBaseType: LocalComponentRefBaseType is an abstract base type which provides a local reference to a component object.

Derivation:

• RefBaseType (restriction)
  • LocalIdentifiableRefBaseType (restriction)
    • LocalComponentListComponentRefBaseType (restriction)
      • LocalComponentRefBaseType

Attributes:
id, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

LocalComponentRefType: LocalComponentRefType provides a local reference to any type component object.

Derivation:

• RefBaseType (restriction)
  • LocalIdentifiableRefBaseType (restriction)
    • LocalComponentListComponentRefBaseType (restriction)
      • LocalComponentRefBaseType (restriction)
        • LocalComponentRefType

Attributes:
id, local?, class, package

Content:
{Empty}

Attribute Documentation:

AnyLocalCodeRefType: AnyLocalCodeRefType provides a local reference to any code object.

Derivation:

• RefBaseType (restriction)
  • AnyLocalCodeRefType

Attributes:
containerID?, id, version?, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

URNReferenceType: URNReferenceType is a type referencing any object via its URN. The exact type of object is not specified, although it can be determined from the URN value.

Derivation:

• ReferenceType (restriction)
  • URNReferenceType

Content:
URN

Element Documentation:

MaintainableReferenceBaseType: MaintainableReferenceBaseType is an abstract base type for referencing a maintainable object. It consists of a URN and/or a complete set of reference fields; agency, id, and version.

Derivation:

• ReferenceType (restriction)
  • MaintainableReferenceBaseType

Content:
( (Ref, URN?) | URN)

Element Documentation:

MaintainableReferenceType: MaintainableReferenceType is a type for referencing any maintainable object. It consists of a URN and/or a complete set of reference fields; agency, id, and version.

Derivation:

• ReferenceType (restriction)
  • MaintainableReferenceBaseType (restriction)
    • MaintainableReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

LocalIdentifiableReferenceType: LocalIdentifiableReferenceType is an abstract base type for referencing an identifiable object locally, where the maintainable object in which it is defined is referenced in another context..

Derivation:

• ReferenceType (restriction)
  • LocalIdentifiableReferenceType

Content:
Ref

Element Documentation:

StructureReferenceBaseType: StructureReferneceBaseType is a specific type of MaintainableReference that is used for referencing structure definitions. It consists of a URN and/or a complete set of reference fields; agency, id, and version.

Derivation:

• ReferenceType (restriction)
  • MaintainableReferenceBaseType (restriction)
    • StructureReferenceBaseType

Content:
( (Ref, URN?) | URN)

Element Documentation:

StructureReferenceType: StructureReferenceType is a specific type of MaintainableReference that is used for referencing any structure. It consists of a URN and/or a complete set of reference fields; agency, id, and version.

Derivation:

• ReferenceType (restriction)
  • MaintainableReferenceBaseType (restriction)
    • StructureReferenceBaseType (restriction)
      • StructureReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

StructureUsageReferenceBaseType: StructureUsageReferenceBaseType is a specific type of MaintainableReference that is used for referencing structure usages. It consists of a URN and/or a complete set of reference fields; agency, id, and version.

Derivation:

• ReferenceType (restriction)
  • MaintainableReferenceBaseType (restriction)
    • StructureUsageReferenceBaseType

Content:
( (Ref, URN?) | URN)

Element Documentation:

StructureUsageReferenceType: StructureUsageReferenceType is a specific type of MaintainableReference that is used for referencing any structure usages. It consists of a URN and/or a complete set of reference fields; agency, id, and version.

Derivation:

• ReferenceType (restriction)
  • MaintainableReferenceBaseType (restriction)
    • StructureUsageReferenceBaseType (restriction)
      • StructureUsageReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

ItemSchemeReferenceBaseType: ItemSchemeReferenceBaseType is a specific type of MaintainableReference that is used for referencing item schemes. It consists of a URN and/or a complete set of reference fields; agency, id, and version.

Derivation:

• ReferenceType (restriction)
  • MaintainableReferenceBaseType (restriction)
    • ItemSchemeReferenceBaseType

Content:
( (Ref, URN?) | URN)

Element Documentation:

ItemSchemeReferenceType: ItemSchemeReferenceType is a reference that is used for referencing any type of item scheme. It consists of a URN and/or a complete set of reference fields; agency, id, and version.

Derivation:

• ReferenceType (restriction)
  • MaintainableReferenceBaseType (restriction)
    • ItemSchemeReferenceBaseType (restriction)
      • ItemSchemeReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

ChildObjectReferenceType: ChildObjectReferenceType is an abstract base type used for referencing a particular object defined directly within a maintainable object. It consists of a URN and/or a complete set of reference fields; agency, maintainable id (maintainableParentID), maintainable version (maintainableParentVersion), the object id (which can be nested), and optionally the object version (if applicable).

Derivation:

• ReferenceType (restriction)
  • ChildObjectReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

ContainerChildObjectReferenceType: ContainerChildObjectReferenceType is an abstract base type used for referencing a particular object defined in a container object within a maintainable object. It consists of a URN and/or a complete set of reference fields; agency, maintainable id (maintainableParentID), maintainable version (maintainableParentVersion), container id (which is optional in order to allow for containers with fixed values to be omitted), container version (if applicable), the object id (which can be nested), and optionally the object version (if applicable).

Derivation:

• ReferenceType (restriction)
  • ContainerChildObjectReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

ItemReferenceType: ItemReferenceType is an abstract base type used for referencing a particular item within an item scheme. Note that this reference also has the ability to reference items contained within other items inside of the item scheme. It consists of a URN and/or a complete set of reference fields; agency, scheme id (maintainableParentID), scheme version (maintainableParentVersion), and item id (which can be nested).

Derivation:

• ReferenceType (restriction)
  • ChildObjectReferenceType (restriction)
    • ItemReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

ComponentListReferenceType: ComponentListReferenceType is an abstract base type used for referencing component lists within a structure. It consists of a URN and/or a complete set of reference fields (structure agency, structure id, structure version, and component list id).

Derivation:

• ReferenceType (restriction)
  • ChildObjectReferenceType (restriction)
    • ComponentListReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

ComponentReferenceType: ComponentReferenceType is an abstract base type used for referencing components within a structure definition. It consists of a URN and/or a complete set of reference fields (structure agency, structure id, structure version, component list id, and component id).

Derivation:

• ReferenceType (restriction)
  • ContainerChildObjectReferenceType (restriction)
    • ComponentReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

LocalItemReferenceType: LocalItemReferenceType is an abstract base type which provides a simple reference to an item where the reference to the item scheme which defines it are provided in another context.

Derivation:

• ReferenceType (restriction)
  • LocalItemReferenceType

Content:
Ref

Element Documentation:

LocalComponentListReferenceType: LocalComponentListReferenceType is an abstract base type which provides a simple reference to a component list where the reference to the structure which defines it is provided in another context.

Derivation:

• ReferenceType (restriction)
  • LocalComponentListReferenceType

Content:
Ref

Element Documentation:

LocalComponentListComponentReferenceBaseType: LocalComponentListComponentReferenceBaseType is an abstract base type which provides a simple reference to any type of component in a specific component list where the reference to the structure which defines it are provided in another context, and the component list may or may not be defined in another context.

Derivation:

• ReferenceType (restriction)
  • LocalComponentListComponentReferenceBaseType

Content:
Ref

Element Documentation:

LocalComponentListComponentReferenceType: LocalComponentListComponentReferenceType provides a simple reference to any type of component in a specific component list where the reference to the structure which defines it are provided in another context.

Derivation:

• ReferenceType (restriction)
  • LocalComponentListComponentReferenceBaseType (restriction)
    • LocalComponentListComponentReferenceType

Content:
Ref

Element Documentation:

LocalComponentReferenceBaseType: LocalComponentReferenceBaseType is an abstract base type which provides a simple reference to a component where the references to the component list which contains it and the structure which defines it are provided in another context.

Derivation:

• ReferenceType (restriction)
  • LocalComponentListComponentReferenceBaseType (restriction)
    • LocalComponentReferenceBaseType

Content:
Ref

Element Documentation:

LocalComponentReferenceType: LocalComponentReferenceType provides a simple reference to any type of component in a component list where the references to the component list and the structure which defines them are provided in another context.

Derivation:

• ReferenceType (restriction)
  • LocalComponentListComponentReferenceBaseType (restriction)
    • LocalComponentReferenceType

Content:
Ref

Element Documentation:

StructureOrUsageReferenceType: StructureOrUsageReferenceType is a specific type of a reference for referencing either a structure or a structure usage. It consists of a URN and/or a complete set of reference fields; agency, id and version. If the complete set of reference fields is used, it is required that a class and package be provided so that the type of object referenced is clear.

Derivation:

• ReferenceType (restriction)
  • MaintainableReferenceBaseType (restriction)
    • StructureOrUsageReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

CategorisationReferenceType: CategorisationReferenceType is a type for referencing a categorisation object. It consists of a URN and/or a complete set of reference fields.

Derivation:

• ReferenceType (restriction)
  • MaintainableReferenceBaseType (restriction)
    • CategorisationReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

CategorisationRefType: CategorisationRefType provides a reference to a categorisation via a complete set of reference fields.

Derivation:

• RefBaseType (restriction)
  • MaintainableRefBaseType (restriction)
    • CategorisationRefType

Attributes:
agencyID, id, version?, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

CategorySchemeReferenceType: CategorySchemeReferenceType is a type for referencing a category scheme object. It consists of a URN and/or a complete set of reference fields.

Derivation:

• ReferenceType (restriction)
  • MaintainableReferenceBaseType (restriction)
    • ItemSchemeReferenceBaseType (restriction)
      • CategorySchemeReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

CategorySchemeRefType: CategorySchemeRefType provides a reference to a category scheme via a complete set of reference fields.

Derivation:

• RefBaseType (restriction)
  • MaintainableRefBaseType (restriction)
    • ItemSchemeRefBaseType (restriction)
      • CategorySchemeRefType

Attributes:
agencyID, id, version?, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

CategoryReferenceType: CategoryReferenceType is a type for referencing a category object. It consists of a URN and/or a complete set of reference fields.

Derivation:

• ReferenceType (restriction)
  • ChildObjectReferenceType (restriction)
    • ItemReferenceType (restriction)
      • CategoryReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

CategoryRefType: CategoryRefType references a category from within a category scheme. Reference fields are required for both the scheme and the item.

Derivation:

• RefBaseType (restriction)
  • ChildObjectRefBaseType (restriction)
    • ItemRefBaseType (restriction)
      • CategoryRefType

Attributes:
agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

LocalCategoryReferenceType: LocalCategoryReferenceType provides a simple references to a category where the identification of the category scheme which defines it is contained in another context.

Derivation:

• ReferenceType (restriction)
  • LocalItemReferenceType (restriction)
    • LocalCategoryReferenceType

Content:
Ref

Element Documentation:

LocalCategoryRefType: LocalCategoryRefType references a category locally where the references to the category scheme which defines it is provided elsewhere.

Derivation:

• RefBaseType (restriction)
  • LocalIdentifiableRefBaseType (restriction)
    • LocalItemRefBaseType (restriction)
      • LocalCategoryRefType

Attributes:
id, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

CodelistReferenceType: CodelistReferenceType is a type for referencing a codelist object. It consists of a URN and/or a complete set of reference fields.

Derivation:

• ReferenceType (restriction)
  • MaintainableReferenceBaseType (restriction)
    • ItemSchemeReferenceBaseType (restriction)
      • CodelistReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

CodelistRefType: CodelistRefType provides a reference to a codelist via a complete set of reference fields.

Derivation:

• RefBaseType (restriction)
  • MaintainableRefBaseType (restriction)
    • ItemSchemeRefBaseType (restriction)
      • CodelistRefType

Attributes:
agencyID, id, version?, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

CodeReferenceType: CodeReferenceType is a type for referencing a code object. It consists of a URN and/or a complete set of reference fields.

Derivation:

• ReferenceType (restriction)
  • ChildObjectReferenceType (restriction)
    • ItemReferenceType (restriction)
      • CodeReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

CodeRefType: CodeRefType references a code from within a codelist. Reference fields are required for both the scheme and the item.

Derivation:

• RefBaseType (restriction)
  • ChildObjectRefBaseType (restriction)
    • ItemRefBaseType (restriction)
      • CodeRefType

Attributes:
agencyID, maintainableParentID, maintainableParentVersion?, id, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

LocalCodeReferenceType: LocalCodeReferenceType provides a simple references to a code where the identification of the codelist which defines it is contained in another context.

Derivation:

• ReferenceType (restriction)
  • LocalItemReferenceType (restriction)
    • LocalCodeReferenceType

Content:
Ref

Element Documentation:

LocalCodeRefType: LocalCodeRefType references a code locally where the references to the codelist which defines it is provided elsewhere.

Derivation:

• RefBaseType (restriction)
  • LocalIdentifiableRefBaseType (restriction)
    • LocalItemRefBaseType (restriction)
      • LocalCodeRefType

Attributes:
id, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

AnyCodelistReferenceType: AnyCodelistReferenceType is a specific type of a reference for referencing either a codelist or a hierarchical codelist usage. It consists of a URN and/or a complete set of reference fields; agency, id and version. If the complete set of reference fields is used, it is required that a class be provided so that the type of object referenced is clear.

Derivation:

• ReferenceType (restriction)
  • MaintainableReferenceBaseType (restriction)
    • AnyCodelistReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

AnyLocalCodeReferenceType: AnyLocalCodeReferenceType provides a simple references to any code or hierarchical code where the identification of the codelist or hierarchical codelist which defines it is contained in another context.

Derivation:

• ReferenceType (restriction)
  • AnyLocalCodeReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

ConceptSchemeReferenceType: ConceptSchemeReferenceType is a type for referencing a concept scheme object. It consists of a URN and/or a complete set of reference fields.

Derivation:

• ReferenceType (restriction)
  • MaintainableReferenceBaseType (restriction)
    • ItemSchemeReferenceBaseType (restriction)
      • ConceptSchemeReferenceType

Content:
( (Ref, URN?) | URN)

Element Documentation:

ConceptSchemeRefType: ConceptSchemeRefType provides a reference to a concept scheme via a complete set of reference fields.

Derivation:

• RefBaseType (restriction)
  • MaintainableRefBaseType (restriction)
    • ItemSchemeRefBaseType (restriction)
      • ConceptSchemeRefType

Attributes:
agencyID, id, version?, local?, class?, package?

Content:
{Empty}

Attribute Documentation:

ConceptReferenceType: ConceptReferenceType is a type for referencing a concept object. It consists of a URN and/or a complete set of reference fields.