Part III. Structure Namespace
- Contents
Corrigendum
The following problems with the specification dated April 2011 have been rectified as described below.
1. Problem
Various parts of the the documentation refer to stand-alone concepts, which were part of earlier draft releases but ultimately excluded from the final release of the standard.
Rectification
The documentation has been updated to remove this reference. This documentation includes:
- Concepts entry for Element Documentation of StructuresType (table beginning line 226).
- ConceptsType (line 270).
1. Problem
The ComponentMap element in the complex type StructureMapType has a maximum occurrence of 1. Therefore, it is not possible to completely map all components of a structure.
Rectification
The documentation of the StructureMapType has been updated to reflect that maximum occurrence of "unbounded" (line 2508).
1 Introduction
The structure namespace contains the definition of all structural metadata constructs. These constructs are intended to be very tightly coupled with the information model to ease the burden of implementers on translating the information from the XML messages into objects based on the information model.
The conformance with the information was achieved through derivation by extensions, restrictions, and substitutions. Because of some the limitations of XML Schema in these areas, it was often necessary to create intermediate type which frmed the basis of the final types which make up the information that is actually exchanged in SDMX messages. The intermediate types are all abstract, so they are not explicitly used in a message. They do however serve the purpose of creating a strong relation of the schemas to the information model.
2 Schema Documentation
2.1 Structure Namespace
http://www.sdmx.org/resources/sdmxml/schemas/v2_1/structure
2.1.1 Summary
Referenced Namespaces:
Namespace Prefix http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common com http://www.w3.org/2001/XMLSchema xs Contents:
47 Global Elements
199 Complex Types
10 Simple Types2.1.2 Global Elements
Structures (StructuresType): Structures contains constructs for all structural metadata components.
Item (ItemType): Item is an abstract element that serves as a substitution head for all items in an item scheme, including those items nested within other items. Concrete instances of this must use a concrete instance of ItemType.
Substitutions: Category, Code, Concept, Organisation, Agency, DataConsumer, DataProvider, OrganisationUnit, ReportingCategory, Transformation, VtlMapping, NamePersonalisation, Ruleset, UserDefinedOperator, CustomType
Grouping (GroupingType): Grouping is an abstract element that serves as a substitution head for all structure groupings. Groupings contain a collection of component lists for a structure. Concrete instances of this must use a concrete instance of GroupingType.
Substitutions: DataStructureComponents, MetadataStructureComponents
ComponentList (ComponentListType): ComponentList is an abstract element that serves as a substitution head for all component lists. Concrete instances of this must use a concrete instance of ComponentListType.
Substitutions: AttributeList, DimensionList, Group, MeasureList, MetadataTarget, ReportStructure
Component (ComponentType): Component is an abstract element that serves as a substitution head for all components. Concrete instances of this must use a concrete instance of ComponentType.
Substitutions: Attribute, ReportingYearStartDay, Dimension, TimeDimension, MeasureDimension, GroupDimension, PrimaryMeasure, KeyDescriptorValuesTarget, DataSetTarget, ConstraintContentTarget, ReportPeriodTarget, IdentifiableObjectTarget, MetadataAttribute
Category (CategoryType): Category represents a set of nested categories which describe a simple classification hierarchy.
Substitution For: Item
Code (CodeType): Code describes a code in a codelist. In addition to the identification and description of the code, basic presentational information is also available. Presentational information not present may be added through the use of annotations.
Substitution For: Item
Concept (ConceptType): Concept describes the details of a concept within a concept scheme.
Substitution For: Item
DataStructureComponents (DataStructureComponentsType): DataStructureComponents defines the grouping of the sets of metadata concepts that have a defined structural role in the data structure definition. Note that for any component or group defined in a data structure definition, its id must be unique. This applies to the identifiers explicitly defined by the components as well as those inherited from the concept identity of a component. For example, if two dimensions take their identity from concepts with same identity (regardless of whether the concepts exist in different schemes) one of the dimensions must be provided a different explicit identifier. Although there are XML schema constraints to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a concept from which a component takes its identity cannot be validated against this constraint. Therefore, systems processing data structure definitions will have to perform this check outside of the XML validation. There are also three reserved identifiers in a data structure definition; OBS_VALUE, TIME_PERIOD, and REPORTING_PERIOD_START_DAY. These identifiers may not be used outside of their respective defintions (PrimaryMeasure, TimeDimension, and ReportingYearStartDay). This applies to both the explicit identifiers that can be assigned to the components or groups as well as an identifier inherited by a component from its concept identity. For example, if an ordinary dimension (i.e. not the time dimension) takes its concept identity from a concept with the identifier TIME_PERIOD, that dimension must provide a different explicit identifier.
Substitution For: Grouping
AttributeList (AttributeListType): AttributeList describes the attribute descriptor for the data structure definition. It is a collection of metadata concepts that define the attributes of the data structure definition.
Substitution For: ComponentList
Attribute (AttributeType): Attribute describes the definition of a data attribute, which is defined as a characteristic of an object or entity.
Substitution For: Component
ReportingYearStartDay (ReportingYearStartDayType): ReportingYearStartDay is a specialized data attribute which provides important context to the time dimension. If the value of the time dimension is one of the standard reporting periods (see common:ReportingTimePeriodType) then this attribute is used to state the month and day that the reporting year begins. This provides a reference point from which the actual calendar dates covered by these periods can be determined. If this attribute does not occur in a data set, then the reporting year start day will be assumed to be January 1.
Substitution For: Component
DimensionList (DimensionListType): DimensionList describes the key descriptor for the data structure definition. It is an ordered set of metadata concepts that, combined, classify a statistical series, such as a time series, and whose values, when combined (the key) in an instance such as a data set, uniquely identify a specific series.
Substitution For: ComponentList
Dimension (DimensionType): Dimension describes the structure of a dimension, which is defined as a statistical concept used (most probably together with other statistical concepts) to identify a statistical series, such as a time series, e.g. a statistical concept indicating certain economic activity or a geographical reference area.
Substitution For: Component
TimeDimension (TimeDimensionType): TimeDimension is a special dimension which designates the period in time in which the data identified by the full series key applies.
Substitution For: Component
MeasureDimension (MeasureDimensionType): MeasureDimension is a special type of dimension which defines multiple measures in a key family. This is represented as any other dimension in a unless it is the observation dimension. It takes it representation from a concept scheme, and this scheme defines the measures and their representations. When data is formatted with this as the observation dimension, these measures can be made explicit or the value of the dimension can be treated as any other dimension. If the measures are explicit, the representation of the observation will be specific to the core representation for each concept in the representation concept scheme. Note that it is necessary that these representations are compliant (the same or derived from) with that of the primary measure.
Substitution For: Component
Group (GroupType): Group describes a group descriptor in a data structure definition. It is a set metadata concepts (and possibly their values) that define a partial key derived from the key descriptor in a data structure definition.
Substitution For: ComponentList
GroupDimension (GroupDimensionType): GroupDimension is a component which contains only a reference to a dimension in the key descriptor (DimensionList). Although it is conventional to declare dimensions in the same order as they are declared in the ordered key, there is no requirement to do so - the ordering of the values of the key are taken from the order in which the dimensions are declared. Note that the id of a dimension may be inherited from its underlying concept - therefore this reference value may actually be the id of the concept.
Substitution For: Component
MeasureList (MeasureListType): MeasureList describes the measure descriptor for a key family. It contains a single metadata concepts that define the primary measures of a data structure.
Substitution For: ComponentList
PrimaryMeasure (PrimaryMeasureType): PrimaryMeasure defines the structure of the primary measure, which is the concept that is the value of the phenomenon to be measured in a data set. Although this may take its semantic from any concept, this is provided a fixed identifier (OBS_VALUE) so that it may be easily distinguished in data messages.
Substitution For: Component
MetadataStructureComponents (MetadataStructureComponentsType): MetadataStructureComponents defines the grouping of the sets of the components that make up the metadata structure definition. All components and component list (target identifiers, identifier components, report structures, and metadata attributes) in the structure definition must have a unique identification.
Substitution For: Grouping
MetadataTarget (MetadataTargetType): MetadataTarget is a collection of target objects which when taken together describe a structure which defines the key of an object type to which metadata may be attached and serve to disambiguate reference metadata set reports.
Substitution For: ComponentList
KeyDescriptorValuesTarget (KeyDescriptorValuesTargetType): KeyDescriptorValuesTarget is target object which references a data key for the purpose of attach reference metadata to portions of data. A data key is a set of dimension references and values for those dimension. This component on its own is not of much use, as the data key only has local references to the dimensions. Therefore it is typical that this is used in combination with some sort of reference to the data (either a data set reference or a reference to the underlying structure, structure usage, or provision agreement of the data.
Substitution For: Component
DataSetTarget (DataSetTargetType): DataSetTarget is target object which references a data set for the purpose of attaching reference metadata data. A data set reference is a full reference to a data provider and an identifier for the data set.
Substitution For: Component
ConstraintContentTarget (ConstraintContentTargetType): ConstraintContentTarget is target object which references an attachment constraint for the purpose of attaching reference metadata data to data key sets or cube regions defined by the constraint.
Substitution For: Component
ReportPeriodTarget (ReportPeriodTargetType): ReportPeriodTarget is target object which specifies a reporting period to which a metadata report applies.
Substitution For: Component
IdentifiableObjectTarget (IdentifiableObjectTargetType): IdentifiableObjectTarget is target object which references an Identifiable object as defined in the SDMX Information Model. The reference must be complete (i.e. a URN or a complete set of reference fields). For an item object, it is possible to define a local representation of an item scheme from which the item must be referenced.
Substitution For: Component
ReportStructure (ReportStructureType): ReportStructure defines a report structure, which comprises a set of metadata attributes that can be defined as a hierarchy, for reporting reference metadata about a target object. The identification of metadata attributes must be unique at any given level of the report structure. Although there are XML schema constraints to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a concept from which a metadata attribute takes its identity cannot be validated against this constraint. Therefore, systems processing metadata structure definitions will have to perform this check outside of the XML validation.
Substitution For: ComponentList
MetadataAttribute (MetadataAttributeType): MetadataAttribute defines the a metadata attribute, which is the value of an attribute, such as the instance of a coded or uncoded attribute in a metadata structure definition.
Substitution For: Component
Organisation (OrganisationType): Organisation is an abstract substitution head for a generic organisation.
Substitution For: Item
Substitutions: Agency, DataConsumer, DataProvider, OrganisationUnit
Agency (AgencyType): Agency is an organisation which maintains structural metadata such as statistical classifications, glossaries, key family structural definitions, and metadata structure definitions..
Substitution For: Organisation
DataConsumer (DataConsumerType): DataConsumer describes an organisation using data as input for further processing.
Substitution For: Organisation
DataProvider (DataProviderType): DataProvider describes an organisation that produces data or reference metadata.
Substitution For: Organisation
OrganisationUnit (OrganisationUnitType): OrganisationUnit describes a generic organisation, which serves not predefined role in SDMX.
Substitution For: Organisation
ReportingCategory (ReportingCategoryType): ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages.
Substitution For: Item
ItemAssociation (ItemAssociationType): ItemAssociation is an abstract description of the relation between two items for the purpose of mapping.
Substitutions: OrganisationMap, CategoryMap, CodeMap, ConceptMap, ReportingCategoryMap
OrganisationMap (OrganisationMapType): OrganisationMap relates a source organisation to a target organisation.
Substitution For: ItemAssociation
CategoryMap (CategoryMapType): CategoryMap defines the structure of a map which identifies relationships between categories in different category schemes.
Substitution For: ItemAssociation
CodeMap (CodeMapType): CodeMap defines the structure of a map which identifies relationships between codes in different codelists.
Substitution For: ItemAssociation
ConceptMap (ConceptMapType): ConceptMap defines the structure of a map which identifies relationships between concepts in different concept schemes.
Substitution For: ItemAssociation
ReportingCategoryMap (ReportingCategoryMapType): ReportingCategoryMap defines the structure of a map which identifies relationships between reporting categories in different reporting taxonomies.
Substitution For: ItemAssociation
Transformation (TransformationType): Transformation describes the details of a single transformation within a transformation scheme.
Substitution For: Item
VtlMapping (VtlMappingType): VtlMapping details a mapping between SDMX and VTL transformation.
Substitution For: Item
NamePersonalisation (NamePersonalisationType): NamePersonalisation details a name personalisation that is used in a transformation.
Substitution For: Item
Ruleset (RulesetType): Ruleset details a ruleset within a ruleset scheme.
Substitution For: Item
UserDefinedOperator (UserDefinedOperatorType): UserDefinedOperator details a user defined operators within a user defined operator scheme.
Substitution For: Item
CustomType (CustomTypeType): CustomType details a custom type within a custom type scheme.
Substitution For: Item
2.1.3 Complex Types
StructuresType: StructuresType describes the structure of the container for all structural metadata components. The structural components may be explicitly detailed, or referenced from an external structure document or registry service. Best practices dictate that, at a minimum, any structural component that is referenced by another structural component be included by reference.
Content:
OrganisationSchemes?, Dataflows?, Metadataflows?, CategorySchemes?, Categorisations?, Codelists?, HierarchicalCodelists?, Concepts?, MetadataStructures?, DataStructures?, StructureSets?, ReportingTaxonomies?, Processes?, Constraints?, ProvisionAgreements?, CustomTypes?, VtlMappings?, NamePersonalisations?, Rulesets?, Transformations?, UserDefinedOperators?
Element Documentation:
Name Type Documentation OrganisationSchemes OrganisationSchemesType OrganisationSchemes contains a collection of organisation scheme descriptions. The organisation schemes may be detailed in full, or referenced from an external structure document or registry service. Dataflows DataflowsType Dataflows contains a collection of data flow descriptions. The data flows may be detailed in full, or referenced from an external structure document or registry service. Metadataflows MetadataflowsType Metadataflows contains a collection of metadata flow descriptions. The metadata flows may be detailed in full, or referenced from an external structure document or registry service. CategorySchemes CategorySchemesType CategorySchemes contains a collection of category scheme descriptions. The category schemes may be detailed in full, or referenced from an external structure document or registry service. Categorisations CategorisationsType Categorisations contains a collection of structural object categorisations. This container may contain categorisations for many types of objects. The categorisations may be detailed in full, or referenced from an external structure document or registry service. Codelists CodelistsType Codelists contains a collection of code list descriptions. The code lists may be detailed in full, or referenced from an external structure document or registry service. HierarchicalCodelists HierarchicalCodelistsType HierarchicalCodelists contains a collection of hierarchical code list descriptions. The hierarchical code lists may be detailed in full, or referenced from an external structure document or registry service. Concepts ConceptsType Concepts contains a collection of concept descriptions. The concepts described are contained within schemes. The concepts may be detailed in full, or referenced from an external structure document or registry service. MetadataStructures MetadataStructuresType MetadataStructures contains a collection of metadata structure definition descriptions. The metadata structure definitions may be detailed in full, or referenced from an external structure document or registry service. DataStructures DataStructuresType DataStructures contains a collection of data structure definitions. The data structure definitions may be detailed in full, or referenced from an external structure document or registry service. StructureSets StructureSetsType StructureSets contains a collection of structure set descriptions. The structure sets may be detailed in full, or referenced from an external structure document or registry service. ReportingTaxonomies ReportingTaxonomiesType ReportingTaxonomies contains a collection of reporting taxonomy descriptions. The reporting taxonomies may be detailed in full, or referenced from an external structure document or registry service. Processes ProcessesType Processes contains a collection of process descriptions. The processes may be detailed in full, or referenced from an external structure document or registry service. Constraints ConstraintsType Constraints contains a collection of constraint descriptions. This container may contain both attachment and content constraints. The constraints may be detailed in full, or referenced from an external structure document or registry service. ProvisionAgreements ProvisionAgreementsType ProvisionAgreements contains a collection of provision agreements. The provision agreements may be detailed in full, or referenced from an external structure document or registry service. CustomTypes CustomTypesType CustomTypes contains a collection of custom type schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. VtlMappings VtlMappingsType VtlMappings contains a collection of VTL mapping schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. NamePersonalisations NamePersonalisations Type NamePersonalisations contains a collection of name personalisation schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. Rulesets RulesetsType Rulsets contains a collection of ruleset schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. Transformations TransformationsType Transformations contains a collection of transformation schemes. The transformation schemes may be detailed in full, or referenced from an external structure document or registry service. UserDefinedOperators UserDefinedOperatorsType UserDefinedOperators contains a collection of user defined operator schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. OrganisationSchemesType: OrganisationSchemesType describes the structure of the organisation schemes container. It contains one or more organisation scheme, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
(AgencyScheme | DataConsumerScheme | DataProviderScheme | OrganisationUnitScheme)+Element Documentation:
Name Type Documentation AgencyScheme AgencySchemeType AgencyScheme provides the details of an agency scheme, in which agencies are described. DataConsumerScheme DataConsumerSchemeType DataConsumerScheme provides the details of an data consumer scheme, in which data consumers are described. DataProviderScheme DataProviderSchemeType DataProviderScheme provides the details of an data provider scheme, in which data providers are described. OrganisationUnitSche me OrganisationUnitSchemeType OrganisationUnitScheme provides the details of an organisation unit scheme, in which organisation units are described. DataflowsType: DataflowsType describes the structure of the data flows container. It contains one or more data flow, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
Dataflow+Element Documentation:
Name Type Documentation Dataflow DataflowType Dataflow provides the details of a data flow, which is defined as the structure of data that will be provided for different reference periods. MetadataflowsType: MetadataflowsType describes the structure of the metadata flows container. It contains one or more metadata flow, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
Metadataflow+Element Documentation:
Name Type Documentation Metadataflow MetadataflowType Metadataflow provides the details of a metadata flow, which is defined as the structure of reference metadata that will be provided for different reference periods CategorySchemesType: CategorySchemesType describes the structure of the category schemes container. It contains one or more category scheme, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
CategoryScheme+Element Documentation:
Name Type Documentation CategoryScheme CategorySchemeType CategoryScheme provides the details of a category scheme, which is the descriptive information for an arrangement or division of categories into groups based on characteristics, which the objects have in common. This provides for a simple, leveled hierarchy or categories. CategorisationsType: CategorisationsType describes the structure of the categorisations container. It contains one or more categorisation of a specific object type, which can be explicitly detailed or referenced from an external structure document or registry service. This container may contain categorisations for multiple types of structural objects.
Content:
Categorisation+Element Documentation:
Name Type Documentation Categorisation CategorisationType Categorisation allows for the association of an identifiable object to a category, providing for the classifications of the reference identifiable object. This must either contain the full details of the categorisation, or provide a name and identification information and reference the full details from an external structure document or registry service. CodelistsType: CodelistsType describes the structure of the code lists container. It contains one or more code list, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
Codelist+Element Documentation:
Name Type Documentation Codelist CodelistType Codelist provides the details of a code list, which is defined as a list from which some statistical concepts (coded concepts) take their values. HierarchicalCodelistsType: HierarchicalCodelistsType describes the structure of the hierarchical code lists container. It contains one or more hierarchical code list, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
HierarchicalCodelist+Element Documentation:
Name Type Documentation HierarchicalCodelist HierarchicalCodelistType HierarchicalCodelist provides the details of a hierarchical code list, which is defined as an organised collection of codes that may participate in many parent/child relationships with other codes in the list, as defined by one or more hierarchy of the list. ConceptsType: ConceptsType describes the structure of the concepts container. It contains one or more concept schemes, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
ConceptScheme*Element Documentation:
Name Type Documentation ConceptScheme ConceptSchemeType ConceptScheme provides the details of a concept scheme, which is the descriptive information for an arrangement or division of concepts into groups based on characteristics, which the objects have in common. It contains a collection of concept definitions, that may be arranged in simple hierarchies. MetadataStructuresType: MetadataStructuresType describes the structure of the metadata structure definitions container. It contains one or more metadata structure definition, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
MetadataStructure+Element Documentation:
Name Type Documentation MetadataStructure MetadataStructureType MetadataStructure provides the details of a metadata structure definition, which is defined as a collection of metadata concepts, their structure and usage when used to collect or disseminate reference metadata. A metadata structure definition performs several functions: it groups sets of objects into "targets" against which reference metadata may be reported. Targets define the structure of the reference metadata "keys" which identify specific types of reported metadata, and describe the valid values for populating the keys. Also, metadata structure definitions provide a presentational organization of concepts for reporting purposes. The structure of a reference metadata report is derived from this presentational structure. DataStructuresType: DataStructuresType describes the structure of the data structure definitions container. It contains one or more data structure definition, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
DataStructure+Element Documentation:
Name Type Documentation DataStructure DataStructureType DataStructure provides the details of a data structure definition, which is defined as a collection of metadata concepts, their structure and usage when used to collect or disseminate data. StructureSetsType: StructureSetsType describes the structure of the structure sets container. It contains one or more structure set, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
StructureSet+Element Documentation:
Name Type Documentation StructureSet StructureSetType StructureSet provides the details or a structure set, which allows components in one structure, structure usage, or item scheme to be mapped to components in another structural component of the same type. ReportingTaxonomiesType: ReportingTaxonomiesType describes the structure of the reporting taxonomies container. It contains one or more reporting taxonomy, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
ReportingTaxonomy+Element Documentation:
Name Type Documentation ReportingTaxonomy ReportingTaxonomyType ReportingTaxonomy provides the details of a reporting taxonomy, which is a scheme which defines the composition structure of a data report where each component can be described by an independent data or metadata flow definition. ProcessesType: ProcessesType describes the structure of the processes container. It contains one or more process, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
Process+Element Documentation:
Name Type Documentation Process ProcessType Process provides the details of a process, which is a scheme which defines or documents the operations performed on data in order to validate data or to derive new information according to a given set of rules. It is not meant to support process automation, but serves as a description of how processes occur. The primary use for this structural mechanism is the attachment of reference metadata regarding statistical processing. This must either contain the full details of the category scheme, or provide a name and identification information and reference the full details from an external structure document or registry service. ConstraintsType: ConstraintsType describes the structure of the constraints container. It contains one or more constraint, which can be explicitly detailed or referenced from an external structure document or registry service. This container may contain both attachment and content constraints.
Content
(AttachmentConstraint | ContentConstraint)+Element Documentation:
Name Type Documentation AttachmentConstraint AttachmentConstraintType AttachmentConstraint describes sub sets of the content of a data or metadata set in terms of the content regions or in terms of the set of key combinations to which attributes or reference metadata (as defined by structure definitions) may be attached. ContentConstraint ContentConstraintType ContentConstraint specifies a sub set of the definition of the allowable or available content of a data or metadata set in terms of the content or in terms of the set of key combinations. ProvisionAgreementsType: ProvisionAgreementsType describes the structure of the provision agreements container. It contains one or more provision agreement, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
ProvisionAgreement+Element Documentation:
Name Type Documentation ProvisionAgreement ProvisionAgreementType ProvisionAgreement provides the details of a provision agreement, which is an agreement for a data provider to report data or reference metadata against a flow. CustomTypesType: CustomTypesType describes the structure of the custom type schemes container. It contains one or more custom type scheme, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
CustomTypeScheme+Element Documentation:
Name Type Documentation CustomTypeScheme CustomTypeSchemeType CustomTypeScheme provides the details of a custom type scheme, in which user defined operators are described. VtlMappingsType: VtlMappingsType describes the structure of the VTL mappings schemes container. It contains one or more VTL mapping schemes, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
VtlMappingScheme+Element Documentation:
Name Type Documentation VtlMappingScheme VtlMappingSchemeType VtlMappingScheme provides the details of a VTL mapping scheme, in which VTL mappings are described. NamePersonalisationsType: NamePersonalisationsType describes the structure of the name personalisation schemes container. It contains one or more name personalisation scheme, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
NamePersonalisationScheme+Element Documentation:
Name Type Documentation NamePersonalisationScheme NamePersonalisationSchemeType NamePersonalisationScheme provides the details of a name personalisation scheme, in which name personalisations are described. RulesetsType: RulesetsType describes the structure of the ruleset schemes container. It contains one or more ruleset scheme, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
RulesetScheme+Element Documentation:
Name Type Documentation RulesetScheme RulesetSchemeType RulesetScheme provides the details of a ruleset scheme, in which rulesets are described. TransformationsType: TransformationsType describes the structure of the transformations container. It contains one or more transformation schemes, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
TransformationScheme+Element Documentation
Name Type Documentation TransformationScheme TransformationSchemeType TransformationScheme provides the details of a transformation scheme, in which transformations are described. UserDefinedOperatorsType: UserDefinedOperatorsType describes the structure of the user defined operator schemes container. It contains one or more user defined operator scheme, which can be explicitly detailed or referenced from an external structure document or registry service.
Content:
UserDefinedOperatorScheme+Element Documentation:
Name Type Documentation UserDefinedOperatorScheme UserDefinedOperatorS chemeType UserDefinedOperatorScheme provides the details of a user defined operator scheme, in which user defined operators are described. IdentifiableType: IdentifiableType is an abstract base type for all identifiable objects.
Derivation:
- com:AnnotableType (extension)
- dentifiableType
Attributes:
id?, urn?, uri?Conten:
com:Annotations?Attribute Documentation:
Name Type Documentation d com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. NameableType: NameableType is an abstract base type for all nameable objects.
Derivation:
- com:AnnotableType (extension)
- IdentifiableType (extension)
- NameableType
- IdentifiableType (extension)
Attributes:
id?, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. VersionableType: VersionableType is an abstract base type for all versionable objects.
Derivation:
- com:AnnotableType (extension)
- IdentifiableType (extension)
- NameableType (extension)
- VersionableType
- NameableType (extension)
- IdentifiableType (extension)
Attributes:
id?, urn?, uri?, version?, validFrom?, validTo?Content:
com:Annotations?, com:Name+, com:Description*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. MaintainableBaseType: MaintainableBaseType is an abstract type that only serves the purpose of forming the base for the actual MaintainableType. The purpose of this type is to restrict the VersionableType to require the id attribute.
Derivation:
- com:AnnotableType (extension)
- IdentifiableType (extension)
- NameableType (extension)
- VersionableType (restriction)
- MaintainableBaseType
- VersionableType (restriction)
- NameableType (extension)
- IdentifiableType (extension)
Attributes:
id, urn?, uri?, version?, validFrom?, validTo?Content:
com:Annotations?, com:Name+, com:Description*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. MaintainableType: MaintainableType is an abstract base type for all maintainable objects.
Derivation:
- com:AnnotableType (extension)
- IdentifiableType (extension)
- NameableType (extension)
- VersionableType (restriction)
- MaintainableBaseType (extension)
- MaintainableType
- MaintainableBaseType (extension)
- VersionableType (restriction)
- NameableType (extension)
- IdentifiableType (extension)
Attributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. ItemSchemeType: ItemSchemeType is an abstract base type for all item scheme objects. It contains a collection of items. Concrete instances of this type should restrict the actual types of items allowed within the scheme.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?Content:
com:Annotations?, com:Name+, com:Description*, Item*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Item ItemType Item is an abstract element that serves as a substitution head for all items in an item scheme, including those items nested within other items. Concrete instances of this must use a concrete instance of ItemType. ItemBaseType: ItemBaseType is an abstract base type that forms the basis for the ItemType. It requires that at least an id be supplied for an item.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. ItemType: ItemType is an abstract base type for all items with in an item scheme. Concrete instances of this type may or may not utilize the nested item, but if so should restrict the actual types of item allowed.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, (Parent | Item+)?Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Parent com: LocalItemReferenceType Item ItemType Item is an abstract element that serves as a substitution head for all items in an item scheme, including those items nested within other items. Concrete instances of this must use a concrete instance of ItemType. UnnestedItemType: UnnestedItemType is an abstract base type for all items with in an item scheme that do not contain nexted items.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NmeableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
UnnestedItemTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. StructureType: StructureType is an abstract base type for all structure objects. Concrete instances of this should restrict to a concrete grouping.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
StructureTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*, Grouping?Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Grouping GroupingType Grouping is an abstract element that serves as a substitution head for all structure groupings. Groupings contain a collection of component lists for a structure. Concrete instances of this must use a concrete instance of GroupingType. GroupingType: GroupType is an abstract base type for specific structure groupings. It contains a collection of component lists. Concrete instances of this should restrict to specific concrete component lists.
Content:
ComponentList*Element Documentation:
Name Type Documentation ComponentList ComponentListType ComponentList is an abstract element that serves as a substitution head for all component lists. Concrete instances of this must use a concrete instance of ComponentListType. ComponentListType: ComponentListType is an abstract base type for all component lists. It contains a collection of components. Concrete types should restrict this to specific concrete components.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
ComponentListTypeAttributes:
id?, urn?, uri?Content:
com:Annotations?, Component*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. Component ComponentType Component is an abstract element that serves as a substitution head for all components. Concrete instances of this must use a concrete instance of ComponentType. ComponentBaseType: ComponentBaseType is an abstract type that only serves the purpose of forming the base for the actual ComponentType. It only restricts the format of the id attribute to the NCNameIDType.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseTypeAttributes:
id?, urn?, uri?Content:
com:Annotations?Attribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. ComponentType: ComponentType is an abstract base type for all components. It contains information pertaining to a component, including an optional reference to a concept, an optional role played by the concept, an optional text format description, and an optional local representation.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentTypeAttributes:
id?, urn?, uri?Content:
com:Annotations?, ConceptIdentity?, LocalRepresentation?Attribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. ConceptIdentity com: ConceptReferenceType ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. LocalRepresentation RepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. StructureUsageType: StructureUsageType is an abstract base type for all structure usages. It contains a reference to a structure. Concrete instances of this type should restrict the type of structure referenced.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
StructureUsageTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*, Structure?Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Structure com: StructureReferenceBaseType Structure references the structure (data structure or metadata structure definition) which the structure usage is based upon. Implementations will have to refine the type to use a concrete structure reference (i.e. either a data structure or metadata structure definition reference). RepresentationType: RepresentationType is an abstract type that defines a representation. Because the type of item schemes that are allowed as the an enumeration vary based on the object in which this is defined, this type is abstract to force that the enumeration reference be restricted to the proper type of item scheme reference.
Content:
(TextFormat | (Enumeration, EnumerationFormat?))Element Documentation:
Name Type Documentation TextFormat TextFormatType TextFormat describes an uncoded textual format. Enumeration com: ItemSchemeReferenceBaseType Enumeration references an item scheme that enumerates the allowable values for this representation. EnumerationFormat CodededTextFormatTyp e EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. TextFormatType: TextFormatType defines the information for describing a full range of text formats and may place restrictions on the values of the other attributes, referred to as "facets".
Attributes:
textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?, isMultiLingual?Content:
{Empty}Attribute Documentation:
Name Type Documentation textType (default: String) com:DataType The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets. isSequence xs:boolean The isSequence attribute indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue attributes or the timeInterval, startTime, and endTime, attributes. If this attribute holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely. interval xs:decimal The interval attribute specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence attribute must have a value of true. startValue xs:decimal The startValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed. endValue xs:decimal The endValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates that ending point (if any) of the sequence. timeInterval xs:duration The timeInterval attribute indicates the permitted duration in a time sequence. In order for this to be used, the isSequence attribute must have a value of true. startTime com: StandardTimePeriodType The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed. endTime com: StandardTimePeriodType The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence. minLength xs:positiveInteger The minLength attribute specifies the minimum and length of the value in characters. maxLength xs:positiveInteger The maxLength attribute specifies the maximum length of the value in characters. minValue xs:decimal The minValue attribute is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid value will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive. maxValue xs:decimal The maxValue attribute is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid value will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive. decimals xs:positiveInteger The decimals attribute indicates the number of characters allowed after the decimal separator. pattern xs:string The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema. isMultiLingual (default: true) xs:boolean The isMultiLingual attribute indicates for a text format of type "string", whether the value should allow for multiple values in different languages. BasicComponentTextFormatType: BasicComponentTextFormatType is a restricted version of the TextFormatType that restricts the text type to the representations allowed for all components except for target objects.
Derivation:
TextFormatType (restriction)
BasicComponentTextFormatTypeAttributes:
textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?, isMultiLingual?Content:
{Empty}Attribute Documentation:
Name Type Documentation textType (default: String) com: BasicComponentDataType The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets. isSequence xs:boolean The isSequence attribute indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue attributes or the timeInterval, startTime, and endTime, attributes. If this attribute holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely. interval xs:decimal The interval attribute specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence attribute must have a value of true. startValue xs:decimal The startValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed. endValue xs:decimal The endValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates that ending point (if any) of the sequence. timeInterval xs:duration The timeInterval attribute indicates the permitted duration in a time sequence. In order for this to be used, the isSequence attribute must have a value of true. startTime com: StandardTimePeriodType The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed. endTime com: StandardTimePeriodType The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence. minLength xs:positiveInteger The minLength attribute specifies the minimum and length of the value in characters. maxLength xs:positiveInteger The maxLength attribute specifies the maximum length of the value in characters. minValue xs:decimal The minValue attribute is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid value will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive. maxValue xs:decimal The maxValue attribute is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid value will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive. decimals xs:positiveInteger The decimals attribute indicates the number of characters allowed after the decimal separator. pattern xs:string The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema. isMultiLingual (default: true) xs:boolean The isMultiLingual attribute indicates for a text format of type "string", whether the value should allow for multiple values in different languages. SimpleComponentTextFormatType: SimpleComponentTextFormatType is a restricted version of the BasicComponentTextFormatType that does not allow for multi-lingual values.
Derivation:
TextFormatType (restriction)
BasicComponentTextFormatType (restriction)
SimpleComponentTextFormatTypeAttributes:
textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?Content:
{Empty}Attribute Documentation:
Name Type Documentation textType (default: String) com:SimpleDataType The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets. isSequence xs:boolean The isSequence attribute indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue attributes or the timeInterval, startTime, and endTime, attributes. If this attribute holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely. interval xs:decimal The interval attribute specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence attribute must have a value of true. startValue xs:decimal The startValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed. endValue xs:decimal The endValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates that ending point (if any) of the sequence. timeInterval xs:duration The timeInterval attribute indicates the permitted duration in a time sequence. In order for this to be used, the isSequence attribute must have a value of true. startTime com: StandardTimePeriodType The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed. endTime com: StandardTimePeriodType The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence. minLength xs:positiveInteger The minLength attribute specifies the minimum and length of the value in characters. maxLength xs:positiveInteger The maxLength attribute specifies the maximum length of the value in characters. minValue xs:decimal The minValue attribute is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid value will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive. maxValue xs:decimal The maxValue attribute is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid value will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive. decimals xs:positiveInteger The decimals attribute indicates the number of characters allowed after the decimal separator. pattern xs:string The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema. CodededTextFormatType: CodededTextFormatType is a restricted version of the SimpleComponentTextFormatType that only allows factets and text types applicable to codes. Although the time facets permit any value, an actual code identifier does not support the necessary characters for time. Therefore these facets should not contain time in their values.
Derivation:
TextFormatType (restriction)
BasicComponentTextFormatType (restriction)
SimpleComponentTextFormatType (restriction)
CodededTextFormatTypeAttributes:
textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, pattern?Content:
{Empty}Attribute Documentation:
Name Type Documentation textType CodeDataType The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets. isSequence xs:boolean The isSequence attribute indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue attributes or the timeInterval, startTime, and endTime, attributes. If this attribute holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely. interval xs:integer The interval attribute specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence attribute must have a value of true. startValue xs:integer The startValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed. endValue xs:integer The endValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates that ending point (if any) of the sequence. timeInterval xs:duration The timeInterval attribute indicates the permitted duration in a time sequence. In order for this to be used, the isSequence attribute must have a value of true. startTime com: StandardTimePeriodType The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed. endTime com: StandardTimePeriodType The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence. minLength xs:positiveInteger The minLength attribute specifies the minimum and length of the value in characters. maxLength xs:positiveInteger The maxLength attribute specifies the maximum length of the value in characters. minValue xs:integer The minValue attribute is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid value will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive. maxValue xs:integer The maxValue attribute is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid value will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive. pattern xs:string The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema. NonFacetedTextFormatType: NonFacetedTextFormatType is a restricted version of the SimpleComponentTextFormatType that does not allow for any facets.
Derivation:
TextFormatType (restriction)
BasicComponentTextFormatType (restriction)
SimpleComponentTextFormatType (restriction)
NonFacetedTextFormatTypeAttributes:
textType?Content:
{Empty}Attribute Documentation:
Name Type Documentation textType com:SimpleDataType The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets. TimeTextFormatType: TimeTextFormat is a restricted version of the SimpleComponentTextFormatType that only allows time based format and specifies a default ObservationalTimePeriod representation and facets of a start and end time.
Derivation:
TextFormatType (restriction)
BasicComponentTextFormatType (restriction)
SimpleComponentTextFormatType (restriction)
TimeTextFormatTypeAttributes:
textType?, startTime?, endTime?Content:
{Empty}Attribute Documentation:
Name Type Documentation textType (default: ObservationalTimePeriod) com:TimeDataType The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets. startTime com: StandardTimePeriodType The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed. endTime com: StandardTimePeriodType The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence. CategorisationType: CategorisationType is defines the structure for a categorisation. A source object is referenced via an object reference and the target category is referenced via the target category.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
CategorisationTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*, (Source, Target)?Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Source com: ObjectReferenceType Source is a reference to an object to be categorized. Target com: CategoryReferenceType Target is reference to the category that the referenced object is to be mapped to. CategorySchemeType: CategorySchemeType describes the structure of a category scheme. A category scheme is the descriptive information for an arrangement or division of categories into groups based on characteristics, which the objects have in common. This provides for a simple, leveled hierarchy or categories.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (restriction)
CategorySchemeTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?Content:
com:Annotations?, com:Name+, com:Description*, Category*Attribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds the identification of the category scheme. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the category scheme may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Category CategoryType Category represents a set of nested categories which describe a simple classification hierarchy. CategoryType: CategoryType describes the details of a category. A category is defined as an item at any level in a classification. The Category element represents a set of nested categories which are child categories.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
CategoryTypeAttributes:
ёёid, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, Category*
Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Category CategoryType Category represents a set of nested categories which describe a simple classification hierarchy. CodelistType: CodelistType defines the structure of a codelist. A codelist is defined as a list from which some statistical concepts (coded concepts) take their values.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (restriction)
CodelistTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?Content:
com:Annotations?, com:Name+, com:Description*, Code*Attribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds the identification of the code list. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the code list may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Code CodeType Code describes a code in a codelist. In addition to the identification and description of the code, basic presentational information is also available. Presentational information not present may be added through the use of annotations. CodeType: CodeType describes the structure of a code. A code is defined as a language independent set of letters, numbers or symbols that represent a concept whose meaning is described in a natural language. Presentational information not present may be added through the use of annotations.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
CodeTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, Parent?Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. It may be used in place of a short description. com:Description com:TextType Description provides a plain text, human-readable description of the code. This may be provided in multiple, parallel language-equivalent forms. Parent com: LocalCodeReferenceType Parent provides the ability to describe simple hierarchies within a single codelist, by referencing the id value of another code in the same codelist. ConceptSchemeType: ConceptSchemeType describes the structure of a concept scheme. A concept scheme is the descriptive information for an arrangement or division of concepts into groups based on characteristics, which the objects have in common. It contains a collection of concept definitions, that may be arranged in simple hierarchies.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (restriction)
ConceptSchemeTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?Content:
com:Annotations?, com:Name+, com:Description*, Concept*Attribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds the identification of the concept scheme. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the concept scheme may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Concept ConceptType Concept describes the details of a concept within a concept scheme. ConceptBaseType: ConceptBaseType is an abstract base type the forms the basis of the ConceptType by requiring a name and id, and restricting the content of the id.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
ConceptBaseTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, Parent?Attribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds the identification of the concept. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since concept id may be used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Parent com: LocalConceptReferenceType Parent captures the semantic relationships between concepts which occur within a single concept scheme. This identifies the concept of which the current concept is a qualification (in the ISO 11179 sense) or subclass. ConceptType: ConceptType describes the details of a concept. A concept is defined as a unit of knowledge created by a unique combination of characteristics. If a concept does not specify a TextFormat or a core representation, then the representation of the concept is assumed to be represented by any set of valid characters (corresponding to the xs:string datatype of W3C XML Schema).
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
ConceptBaseType (extension)
ConceptTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, Parent?, CoreRepresentation?, ISOConceptReference?Attribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds the identification of the concept. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since concept id may be used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Parent com: LocalConceptReferenceType Parent captures the semantic relationships between concepts which occur within a single concept scheme. This identifies the concept of which the current concept is a qualification (in the ISO 11179 sense) or subclass. CoreRepresentation ConceptRepresentation ISOConceptReference ISOConceptReferenceType Provides a reference to an ISO 11179 concept. ConceptRepresentation: ConceptRepresentation defines the core representation that are allowed for a concept. The text format allowed for a concept is that which is allowed for any non-target object component.
Derivation:
RepresentationType (restriction)
ConceptRepresentationContent:
(TextFormat | (Enumeration, EnumerationFormat?))Element Documentation:
Name Type Documentation TextFormat BasicComponentTextFormatType TextFormat describes an uncoded textual format. Enumeration com: CodelistReferenceType Enumeration references a codelist which enumerates the possible values that can be used as the representation of this concept. EnumerationFormat CodededTextFormatType EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. ISOConceptReferenceType: ISOConceptReferenceType provides a reference to and ISO 11179 concept.
Content:
ConceptAgency, ConceptSchemeID, ConceptIDElement Documentation:
Name Type Documentation ConceptAgency xs:string ConceptSchemeID xs:string ConceptID xs:string ConstraintBaseType: ConstraintBaseType is an abstract base type that forms the basis of the main abstract ConstraintType. It requires that a name be provided.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (restriction)
ConstraintBaseTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. ConstraintType: ConstraintType is an abstract base type that specific types of constraints (content and attachment) restrict and extend to describe their details. The inclusion of a key or region in a constraint is determined by first processing the included key sets, and then removing those keys defined in the excluded key sets. If no included key sets are defined, then it is assumed the all possible keys or regions are included, and any excluded key or regions are removed from this complete set.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (restriction)
ConstraintBaseType (extension)
ConstraintTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. ConstraintAttachment ConstraintAttachmentType ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. DataKeySet DataKeySetType MetadataKeySet MetadataKeySetType CubeRegion com:CubeRegionType MetadataTargetRegion com: MetadataTargetRegionType AttachmentConstraintType: AttachmentConstraintType describes the details of an attachment constraint by defining the data or metadata key sets or component regions that attributes or reference metadata may be attached in the constraint attachment objects.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (restriction)
ConstraintBaseType (extension)
ConstraintType (restriction)
AttachmentConstraintTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet)*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. ConstraintAttachment AttachmentConstraint AttachmentType ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. DataKeySet DataKeySetType MetadataKeySet MetadataKeySetType ContentConstraintBaseType: ContentConstraintBaseType is an abstract base type that forms the basis for the ContentConstraintType.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (restriction)
ConstraintBaseType (extension)
ConstraintType (restriction)
ContentConstraintBaseTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. ConstraintAttachment ContentConstraintAttachmentType ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. DataKeySet DataKeySetType DataKeySet defines a collection of full or partial data keys. MetadataKeySet MetadataKeySetType MetadataKeySet defines a collection of metadata keys. CubeRegion com:CubeRegionType CubeRegion describes a set of dimension values which define a region and attributes which relate to the region for the purpose of describing a constraint. MetadataTargetRegion com: MetadataTargetRegionType MetadataTargetRegion describes a set of target object values for a given report structure which define a region, and the metadata attribute which relate to the target for the purpose of describing a constraint. ContentConstraintType: ContentConstraintType describes the details of a content constraint by defining the content regions, key sets, or release information for the constraint attachment objects. Note that if the constraint is for a data provider, then only release calendar information is relevant, as there is no reliable way of determining which key family is being used to frame constraints in terms of cube regions or key sets.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (restriction)
ConstraintBaseType (extension)
ConstraintType (restriction)
ContentConstraintBaseType (extension)
ContentConstraintTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, type?Content:
com:Annotations?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*, ReleaseCalendar?, ReferencePeriod?Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. type (default: Actual) com: ContentConstraintTypeCodeType The type attribute indicates whether this constraint states what data is actually present for the constraint attachment, or if it defines what content is allowed. The default value is "Actual", meaning the data actually present for the constraint attachment. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. ConstraintAttachment ContentConstraintAttachmentType ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. DataKeySet DataKeySetType DataKeySet defines a collection of full or partial data keys. MetadataKeySet MetadataKeySetType MetadataKeySet defines a collection of metadata keys. CubeRegion com:CubeRegionType CubeRegion describes a set of dimension values which define a region and attributes which relate to the region for the purpose of describing a constraint. MetadataTargetRegion com: MetadataTargetRegionType MetadataTargetRegion describes a set of target object values for a given report structure which define a region, and the metadata attribute which relate to the target for the purpose of describing a constraint. ReleaseCalendar ReleaseCalendarType ReleaseCalendar defines dates on which the constrained data is to be made available. ReferencePeriod com: ReferencePeriodType ReferencePeriod is used to report start date and end date constraints. ReleaseCalendarType: ReleaseCalendarType describes information about the timing of releases of the constrained data. All of these values use the standard "P7D" - style format.
Content:
Periodicity, Offset, ToleranceElement Documentation:
Name Type Documentation Periodicity xs:string Periodicity is the period between releases of the data set. Offset xs:string Offset is the interval between January first and the first release of data within the year. Tolerance xs:string Tolerance is the period after which the release of data may be deemed late. KeySetType: KeySetType is an abstract base type for defining a collection of keys.
Attributes:
isIncludedContent:
Key+Attribute Documentation:
Name Type Documentation isIncluded xs:boolean The isIncluded attribute indicates whether the keys defined in this key set are inclusive or exclusive to the constraint. Element Documentation:
Name Type Documentation Key com:DistinctKeyType Key contains a data or metadata key, which are sets of component values which identify the data or metadata. DataKeySetType: DataKeySetType defines a collection of full or partial data keys (dimension values).
Derivation:
KeySetType (restriction)
DataKeySetTypeAttributes:
isIncludedContent:
Key+Attribute Documentation:
Name Type Documentation isIncluded xs:boolean The isIncluded attribute indicates whether the keys defined in this key set are inclusive or exclusive to the constraint. Element Documentation:
Name Type Documentation Key com:DataKeyType Key contains a set of dimension values which identify a full set of data. MetadataKeySetType: MetadataKeySetType defines a collection of metadata keys (identifier component values).
Derivation:
KeySetType (restriction)
MetadataKeySetTypeAttributes:
isIncludedContent:
Key+Attribute Documentation:
Name Type Documentation isIncluded xs:boolean The isIncluded attribute indicates whether the keys defined in this key set are inclusive or exclusive to the constraint. Element Documentation:
Name Type Documentation Key com:MetadataKeyType Key contains a set of target object values for a specified report structure which serve to identify which object reference metadata conforming to the specified report structure is available for. ConstraintAttachmentType: ConstraintAttachmentType describes a collection of references to constrainable artefacts.
Content:
(DataProvider | DataSet+ | MetadataSet+ | SimpleDataSource+ | (DataStructure+, QueryableDataSource*) | (MetadataStructure+, QueryableDataSource*) | (Dataflow+, QueryableDataSource*) | (Metadataflow+, QueryableDataSource*) | (ProvisionAgreement+, QueryableDataSource*))Element Documentation:
Name Type Documentation DataProvider com: DataProviderReferenceType DataProvider is reference to a data provider to which the constraint is attached. If this is used, then only the release calendar is relevant. The referenced is provided as a URN and/or a full set of reference fields. DataSet com:SetReferenceType DataSet is reference to a data set to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. MetadataSet com:SetReferenceType MetadataSet is reference to a metadata set to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. SimpleDataSource xs:anyURI SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message. DataStructure com: DataStructureReferenceType DataStructure is reference to a data structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached. QueryableDataSource com: QueryableDataSourceType QueryableDataSource describes a queryable data source to which the constraint is attached. MetadataStructure com: MetadataStructureReferenceType MetadataStructure is reference to a metadata structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached. QueryableDataSource com: QueryableDataSourceType QueryableDataSource describes a queryable data source to which the constraint is attached. Dataflow com: DataflowReferenceType Dataflow is reference to a data flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one dataflow, and the dataflows do not necessarily have to be usages of the same data structure. However, a constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached. QueryableDataSource com: QueryableDataSourceT ype QueryableDataSource describes a queryable data source to which the constraint is attached. Metadataflow com: MetadataflowReferenc eType Metadataflow is reference to a metadata flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one metadataflow, and the metadataflows do not necessarily have to be usages of the same metadata structure. However, a constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached. QueryableDataSource com: QueryableDataSourceType QueryableDataSource describes a queryable data source to which the constraint is attached. ProvisionAgreement com: ProvisionAgreementReferenceType ProvisionAgreementReference is reference to a provision agreement to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one provision aggreement, and the provision agreements do not necessarily have to be references structure usages based on the same structure. However, a constraint which is attached to more than one provision agreement must only express key sets and/or cube/target regions where the identifier of the components are common across all structures to which the constraint is attached. QueryableDataSource com: QueryableDataSourceType QueryableDataSource describes a queryable data source to which the constraint is attached. AttachmentConstraintAttachmentType: AttachmentConstraintAttachmentType defines the structure for specifying the object to which an attachment constraints applies.
Derivation:
ConstraintAttachmentType (restriction)
AttachmentConstraintAttachmentTypeContent:
(DataSet+ | MetadataSet+ | SimpleDataSource+ | DataStructure+ | MetadataStructure+ | Dataflow+ | Metadataflow+ | ProvisionAgreement+)Element Documentation:
Name Type Documentation DataSet com:SetReferenceType DataSet is reference to a data set to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. Multiple instance can only be used if they have the same underlying structure. MetadataSet com:SetReferenceType MetadataSet is reference to a metadata set to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. Multiple instance can only be used if they have the same underlying structure. SimpleDataSource xs:anyURI SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message. Multiple instance can only be used if they have the same underlying structure. DataStructure com: DataStructureReferenceType DataStructure is reference to a data structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached. MetadataStructure com: MetadataStructureReferenceType MetadataStructure is reference to a metadata structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached. Dataflow com: DataflowReferenceTyp Dataflow is reference to a data flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one dataflow, and the dataflows do not necessarily have to be usages of the same data structure. However, a constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached. Metadataflow com: MetadataflowReferenceType Metadataflow is reference to a metadata flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one metadataflow, and the metadataflows do not necessarily have to be usages of the same metadata structure. However, a constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached. ProvisionAgreement com: ProvisionAgreementReferenceType ProvisionAgreementReference is reference to a provision agreement to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one provision aggreement, and the provision agreements do not necessarily have to be references structure usages based on the same structure. However, a constraint which is attached to more than one provision agreement must only express key sets and/or cube/target regions where the identifier of the components are common across all structures to which the constraint is attached. ContentConstraintAttachmentType: ContentConstraintAttachmentType defines the structure for specifying the target object(s) of a content constraint.
Derivation:
ConstraintAttachmentType (restriction)
ContentConstraintAttachmentTypeContent:
(DataProvider | DataSet | MetadataSet | SimpleDataSource | (DataStructure+, QueryableDataSource*) | (MetadataStructure+, QueryableDataSource*) | (Dataflow+, QueryableDataSource*) | (Metadataflow+, QueryableDataSource*) | (ProvisionAgreement+, QueryableDataSource*))Element Documentation:
Name Type Documentation DataProvider com: DataProviderReferenceType DataProvider is reference to a data provider to which the constraint is attached. If this is used, then only the release calendar is relevant. The referenced is provided as a URN and/or a full set of reference fields. DataSet com:SetReferenceType DataSet is reference to a data set to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. MetadataSet com:SetReferenceType MetadataSet is reference to a metadata set to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. SimpleDataSource xs:anyURI SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message. DataStructure com: DataStructureReferenceType DataStructure is reference to a data structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached. QueryableDataSource com: QueryableDataSourceType QueryableDataSource describes a queryable data source to which the constraint is attached. MetadataStructure com: MetadataStructureReferenceType MetadataStructure is reference to a metadata structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached. QueryableDataSource com: QueryableDataSourceType QueryableDataSource describes a queryable data source to which the constraint is attached. Dataflow com: DataflowReferenceType Dataflow is reference to a data flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one dataflow, and the dataflows do not necessarily have to be usages of the same data structure. However, a constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached. QueryableDataSource com: QueryableDataSourceType QueryableDataSource describes a queryable data source to which the constraint is attached. Metadataflow com: MetadataflowReferenc eType Metadataflow is reference to a metadata flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one metadataflow, and the metadataflows do not necessarily have to be usages of the same metadata structure. However, a constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached. QueryableDataSource com: QueryableDataSourceType QueryableDataSource describes a queryable data source to which the constraint is attached. ProvisionAgreement com: ProvisionAgreementReferenceType ProvisionAgreementReference is reference to a provision agreement to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one provision aggreement, and the provision agreements do not necessarily have to be references structure usages based on the same structure. However, a constraint which is attached to more than one provision agreement must only express key sets and/or cube/target regions where the identifier of the components are common across all structures to which the constraint is attached. QueryableDataSource com: QueryableDataSourceType QueryableDataSource describes a queryable data source to which the constraint is attached. DataStructureType: DataStructureType describes the structure of a data structure definition. A data structure definition is defined as a collection of metadata concepts, their structure and usage when used to collect or disseminate data.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
StructureType (restriction)
DataStructureTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*, DataStructureComponents?Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. DataStructureCompone nts DataStructureComponentsType DataStructureComponents defines the grouping of the sets of metadata concepts that have a defined structural role in the data structure definition. Note that for any component or group defined in a data structure definition, its id must be unique. This applies to the identifiers explicitly defined by the components as well as those inherited from the concept identity of a component. For example, if two dimensions take their identity from concepts with same identity (regardless of whether the concepts exist in different schemes) one of the dimensions must be provided a different explicit identifier. Although there are XML schema constraints to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a concept from which a component takes its identity cannot be validated against this constraint. Therefore, systems processing data structure definitions will have to perform this check outside of the XML validation. There are also three reserved identifiers in a data structure definition; OBS_VALUE, TIME_PERIOD, and REPORTING_PERIOD_START_DAY. These identifiers may not be used outside of their respective defintions (PrimaryMeasure, TimeDimension, and ReportingYearStartDay). This applies to both the explicit identifiers that can be assigned to the components or groups as well as an identifier inherited by a component from its concept identity. For example, if an ordinary dimension (i.e. not the time dimension) takes its concept identity from a concept with the identifier TIME_PERIOD, that dimension must provide a different explicit identifier. DataStructureComponentsBaseType: DataStructureComponentsBaseType is an abstract base type the serves as the basis for the DataStructureComponentsType. This type is necessary to allow for valid substitutions of component lists.
Derivation:
GroupingType (restriction)
DataStructureComponentsBaseTypeContent:
{Empty}DataStructureComponentsType: DataStructureComponentsType describes the structure of the grouping to the sets of metadata concepts that have a defined structural role in the data structure definition. At a minimum at least one dimension and a primary measure must be defined.
Derivation:
GroupingType (restriction)
DataStructureComponentsBaseType (extension)
DataStructureComponentsTypeContent:
DimensionList, Group*, AttributeList?, MeasureListElement Documentation:
Name Type Documentation DimensionList DimensionListType DimensionList describes the key descriptor for the data structure definition. It is an ordered set of metadata concepts that, combined, classify a statistical series, such as a time series, and whose values, when combined (the key) in an instance such as a data set, uniquely identify a specific series. Group GroupType Group describes a group descriptor in a data structure definition. It is a set metadata concepts (and possibly their values) that define a partial key derived from the key descriptor in a data structure definition. AttributeList AttributeListType AttributeList describes the attribute descriptor for the data structure definition. It is a collection of metadata concepts that define the attributes of the data structure definition. MeasureList MeasureListType MeasureList describes the measure descriptor for a key family. It contains a single metadata concepts that define the primary measures of a data structure. AttributeListBaseType: AttributeListBaseType is an abstract base type used as the basis for the AttributeListType.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
ComponentListType (restriction)
AttributeListBaseTypeAttributes:
id?, urn?, uri?Content:
com:Annotations?Attribute Documentation:
Name Type Documentation id (fixed: AttributeDescriptor) com:IDType The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. AttributeListType: AttributeListType describes the attribute descriptor for the data structure definition.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
ComponentListType (restriction)
AttributeListBaseType (extension)
AttributeListTypeAttributes:
id?, urn?, uri?Content:
com:Annotations?, (Attribute | ReportingYearStartDay)+Attribute Documentation:
Name Type Documentation id (fixed: AttributeDescriptor) com:IDType The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. Attribute AttributeType Attribute describes the definition of a data attribute, which is defined as a characteristic of an object or entity. ReportingYearStartDa y ReportingYearStartDayType ReportingYearStartDay is a specialized data attribute which provides important context to the time dimension. If the value of the time dimension is one of the standard reporting periods (see common:ReportingTimePeriodType) then this attribute is used to state the month and day that the reporting year begins. This provides a reference point from which the actual calendar dates covered by these periods can be determined. If this attribute does not occur in a data set, then the reporting year start day will be assumed to be January 1. AttributeBaseType: AttributeBaseType is an abstract base type that serves as the basis for the AttributeType. It restricts the text format base to a text format valid for data components (that does not allow for XHTML representation). The local representation is restricted to the values defined in codelist. The concept role is restricted to the values valid for a data attribute.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (restriction)
AttributeBaseTypeAttributes:
id?, urn?, uri?Content:
com:Annotations?, ConceptIdentity, LocalRepresentation?Attribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. ConceptIdentity com: ConceptReferenceType ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. LocalRepresentation SimpleDataStructureRepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. AttributeType: AttributeType describes the structure of a data attribute, which is defined as a characteristic of an object or entity. The attribute takes its semantic, and in some cases it representation, from its concept identity. An attribute can be coded by referencing a code list from its coded local representation. It can also specify its text format, which is used as the representation of the attribute if a coded representation is not defined. Neither the coded or uncoded representation are necessary, since the attribute may take these from the referenced concept. An attribute specifies its relationship with other data structure components and is given an assignment status. These two properties dictate where in a data message the attribute will be attached, and whether or not the attribute will be required to be given a value. A set of roles defined in concept scheme can be assigned to the attribute.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (restriction)
AttributeBaseType (extension)
AttributeTypeAttributes:
id?, urn?, uri?, assignmentStatusContent:
com:Annotations?, ConceptIdentity, LocalRepresentation?, ConceptRole*, AttributeRelationshipAttribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. assignmentStatus UsageStatusType The assignmentStatus attribute indicates whether a value must be provided for the attribute when sending documentation along with the data. Element Documentation:
Name Type Documentation com:Annotations com: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. ConceptIdentity com: ConceptReferenceType ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. LocalRepresentation SimpleDataStructureRepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. ConceptRole com: ConceptReferenceType ConceptRole references concepts which define roles which this attribute serves. If the concept from which the attribute takes its identity also defines a role the concept serves, then the isConceptRole indicator can be set to true on the concept identity rather than repeating the reference here. AttributeRelationshi p AttributeRelationshipType AttributeRelationship describes how the value of this attribute varies with the values of other components. These relationships will be used to determine the attachment level of the attribute in the various data formats. AttributeRelationshipType: AttributeRelationshipType defines the structure for stating the relationship between an attribute and other data structure definition components.
Content:
(None | (Dimension+, AttachmentGroup*) | Group | PrimaryMeasure)Element Documentation:
Name Type Documentation None com:EmptyType This means that value of the attribute will not vary with any of the other key family components. This will always be treated as a data set level attribute. Dimension com: LocalDimensionReferenceType This is used to reference dimensions in the data structure definition on which the value of this attribute depends. An attribute using this relationship can be either a group, series (or section), or observation level attribute. The attachment level of the attribute will be determined by the data format and which dimensions are referenced. AttachmentGroup com: LocalGroupKeyDescriptorReferenceType This is used to specify that the attribute should always be attached to the groups referenced here. Note that if one of the referenced dimensions is the time dimension, the groups referenced here will be ignored. Group com: LocalGroupKeyDescriptorReferenceType This is used as a convenience to referencing all of the dimension defined by the referenced group. The attribute will also be attached to this group. PrimaryMeasure com: LocalPrimaryMeasureReferenceType This is used to specify that the value of the attribute is dependent upon the observed value. An attribute with this relationship will always be treated as an observation level attribute. ReportingYearStartDayType: ReportingYearStartDayType defines the structure of the reporting year start day attribute. The reporting year start day attribute takes its semantic from its concept identity (usually the REPORTING_YEAR_START_DAY concept), yet is always has a fixed identifier (REPORTING_YEAR_START_DAY). The reporting year start day attribute always has a fixed text format, which specifies that the format of its value is always a day and month in the ISO 8601 format of 'MM-DD'. As with any other attribute, an attribute relationship must be specified. this relationship should be carefully selected as it will determin what type of data the data structure definition will allow. For example, if an attribute relationship of none is specified, this will mean the data sets conforming to this data structure definition can only contain data with standard reporting periods where the all reporting periods have the same start day. In this case, data reported as standard reporting periods from two entities with different fiscal year start days could not be contained in the same data set.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (restriction)
AttributeBaseType (extension)
AttributeType (restriction)
ReportingYearStartDayTypeAttributes:
id?, urn?, uri?, assignmentStatusContent:
com:Annotations?, ConceptIdentity, LocalRepresentation, AttributeRelationshipAttribute Documentation:
Name Type Documentation id (fixed: REPORTING_YEAR_START_DAY) com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. assignmentStatus UsageStatusType The assignmentStatus attribute indicates whether a value must be provided for the attribute when sending documentation along with the data. Element Documentation:
Name Type Documentation com:Annotations com: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. ConceptIdentity com: ConceptReferenceType ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. LocalRepresentation ReportingYearStartDayRepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. AttributeRelationshi p AttributeRelationshipType AttributeRelationship describes how the value of this attribute varies with the values of other components. These relationships will be used to determine the attachment level of the attribute in the various data formats. ReportingYearStartDayRepresentationType: ReportingYearStartDayRepresentationType defines the representation for the reporting year start day attribute. Enumerated values are not allowed and the text format is fixed to be a day and month in the ISO 8601 format of 'MM-DD'.
Derivation:
RepresentationType (restriction)
DataStructureRepresentationType (restriction)
SimpleDataStructureRepresentationType (restriction)
ReportingYearStartDayRepresentationTypeContent:
TextFormatElement Documentation:
Name Type Documentation TextFormat ReportingYearStartDa yTextFormatType TextFormat describes an uncoded textual format. ReportingYearStartDayTextFormatType: ReportingYearStartDayTextFormatType is a restricted version of the NonFacetedTextFormatType that fixes the value of the text type to be DayMonth. This type exists solely for the purpose of fixing the representation of the reporting year start day attribute.
Derivation:
TextFormatType (restriction)
BasicComponentTextFormatType (restriction)
SimpleComponentTextFormatType (restriction)
NonFacetedTextFormatType (restriction)
ReportingYearStartDayTextFormatTypeAttributes:
textType?Content:
{Empty}Attribute Documentation:
Name Type Documentation textType (fixed: MonthDay) com:SimpleDataType The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets. DimensionListBaseType: DimensionListBaseType is an abstract base type used as the basis for the DimensionListType.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
ComponentListType (restriction)
DimensionListBaseTypeAttributes:
id?, urn?, uri?Content:
com:Annotations?Attribute Documentation:
Name Type Documentation id (fixed: DimensionDescriptor) com:IDType The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. DimensionListType: DimensionListType describes the key descriptor for a data structure definition. The order of the declaration of child dimensions is significant: it is used to describe the order in which they will appear in data formats for which key values are supplied in an ordered fashion (exclusive of the time dimension, which is not represented as a member of the ordered key). Any data structure definition which uses the time dimension should also declare a frequency dimension, conventionally the first dimension in the key (the set of ordered non-time dimensions). If is not necessary to assign a time dimension, as data can be organised in any fashion required.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
ComponentListType (restriction)
DimensionListBaseType (extension)
DimensionListTypeAttributes:
id?, urn?, uri?Content:
com:Annotations?, (Dimension | MeasureDimension | TimeDimension)+Attribute Documentation:
Name Type Documentation id (fixed: DimensionDescriptor) com:IDType The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. Dimension DimensionType Dimension describes the structure of a dimension, which is defined as a statistical concept used (most probably together with other statistical concepts) to identify a statistical series, such as a time series, e.g. a statistical concept indicating certain economic activity or a geographical reference area. MeasureDimension MeasureDimensionType MeasureDimension is a special type of dimension which defines multiple measures in a key family. This is represented as any other dimension in a unless it is the observation dimension. It takes it representation from a concept scheme, and this scheme defines the measures and their representations. When data is formatted with this as the observation dimension, these measures can be made explicit or the value of the dimension can be treated as any other dimension. If the measures are explicit, the representation of the observation will be specific to the core representation for each concept in the representation concept scheme. Note that it is necessary that these representations are compliant (the same or derived from) with that of the primary measure. TimeDimension TimeDimensionType TimeDimension is a special dimension which designates the period in time in which the data identified by the full series key applies. BaseDimensionBaseType: BaseDimensionBaseType is an abstract base type that serves as the basis for any dimension. It restricts the text format base to a text format valid for data components (that does not allow for XHTML representation).
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (restriction)
BaseDimensionBaseTypeAttributes:
id?, urn?, uri?Content:
com:Annotations?, ConceptIdentity, LocalRepresentation?Attribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. ConceptIdentity com: ConceptReferenceType ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. LocalRepresentation DataStructureRepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. BaseDimensionType: BaseDimensionType is an abstract base type which defines the basic structure of all dimensions.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (restriction)
BaseDimensionBaseType (extension)
BaseDimensionTypeAttributes:
id?, urn?, uri?, position?, type?Content:
com:Annotations?, ConceptIdentity, LocalRepresentation?, ConceptRole*Attribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. position xs:int The position attribute specifies the position of the dimension in the data structure definition. It is optional an the position of the dimension in the key descriptor (DimensionList element) always takes precedence over the value supplied here. This is strictly for informational purposes only. type com: DimensionTypeType The type attribute identifies whether then dimension is a measure dimension, the time dimension, or a regular dimension. Although these are all apparent by the element names, this attribute allows for each dimension to be processed independent of its element as well as maintaining the restriction of only one measure and time dimension while still allowing dimension to occur in any order. Element Documentation:
Name Type Documentation com:Annotations com: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. ConceptIdentity com: ConceptReferenceType ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. LocalRepresentation DataStructureRepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. ConceptRole com: ConceptReferenceType ConceptRole references concepts which define roles which this dimension serves. If the concept from which the attribute takes its identity also defines a role the concept serves, then the isConceptRole indicator can be set to true on the concept identity rather than repeating the reference here. DimensionType: DimensionType describes the structure of an ordinary dimension, which is defined as a statistical concept used (most probably together with other statistical concepts) to identify a statistical series, such as a time series, e.g. a statistical concept indicating certain economic activity or a geographical reference area. The dimension takes its semantic, and in some cases it representation, from its concept identity. A dimension can be coded by referencing a code list from its coded local representation. It can also specify its text format, which is used as the representation of the dimension if a coded representation is not defined. Neither the coded or uncoded representation are necessary, since the dimension may take these from the referenced concept.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (restriction)
BaseDimensionBaseType (extension)
BaseDimensionType (restriction)
DimensionTypeAttributes:
id?, urn?, uri?, position?, type?Content:
com:Annotations?, ConceptIdentity, LocalRepresentation?, ConceptRole*Attribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. position xs:int The position attribute specifies the position of the dimension in the data structure definition. It is optional an the position of the dimension in the key descriptor (DimensionList element) always takes precedence over the value supplied here. This is strictly for informational purposes only. type (fixed: Dimension) com: DimensionTypeType The type attribute identifies whether then dimension is a measure dimension, the time dimension, or a regular dimension. Although these are all apparent by the element names, this attribute allows for each dimension to be processed independent of its element as well as maintaining the restriction of only one measure and time dimension while still allowing dimension to occur in any order. Element Documentation:
Name Type Documentation com:Annotations com: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. ConceptIdentity com: ConceptReferenceType ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. LocalRepresentation SimpleDataStructureRepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. ConceptRole com: ConceptReferenceType ConceptRole references concepts which define roles which this dimension serves. If the concept from which the attribute takes its identity also defines a role the concept serves, then the isConceptRole indicator can be set to true on the concept identity rather than repeating the reference here. TimeDimensionType: TimeDimensionType describes the structure of a time dimension. The time dimension takes its semantic from its concept identity (usually the TIME_PERIOD concept), yet is always has a fixed identifier (TIME_PERIOD). The time dimension always has a fixed text format, which specifies that its format is always the in the value set of the observational time period (see common:ObservationalTimePeriodType). It is possible that the format may be a sub-set of the observational time period value set. For example, it is possible to state that the representation might always be a calendar year. See the enumerations of the textType attribute in the LocalRepresentation/TextFormat for more details of the possible sub-sets. It is also possible to facet this representation with start and end dates. The purpose of such facts is to restrict the value of the time dimension to occur within the specified range. If the time dimension is expected to allow for the standard reporting periods (see common:ReportingTimePeriodType) to be used, then it is strongly recommended that the reporting year start day attribute also be included in the data structure definition. When the reporting year start day attribute is used, any standard reporting period values will be assumed to be based on the start day contained in this attribute. If the reporting year start day attribute is not included and standard reporting periods are used, these values will be assumed to be based on a reporting year which begins January 1.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (restriction)
BaseDimensionBaseType (extension)
BaseDimensionType (restriction)
TimeDimensionTypeAttributes:
id?, urn?, uri?, position?, type?Content:
com:Annotations?, ConceptIdentity, LocalRepresentationAttribute Documentation:
Name Type Documentation id (fixed: TIME_PERIOD) com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. position xs:int The position attribute specifies the position of the dimension in the data structure definition. It is optional an the position of the dimension in the key descriptor (DimensionList element) always takes precedence over the value supplied here. This is strictly for informational purposes only. type (fixed: TimeDimension) com: DimensionTypeType The type attribute identifies whether then dimension is a measure dimension, the time dimension, or a regular dimension. Although these are all apparent by the element names, this attribute allows for each dimension to be processed independent of its element as well as maintaining the restriction of only one measure and time dimension while still allowing dimension to occur in any order. Element Documentation:
Name Type Documentation com:Annotations com: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. ConceptIdentity com: ConceptReferenceType ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. LocalRepresentation TimeDimensionRepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. MeasureDimensionType: MeasureDimensionType defines the structure of the measure dimension. It is derived from the base dimension structure, but requires that a coded representation taken from a concept scheme is given.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (restriction)
BaseDimensionBaseType (extension)
BaseDimensionType (restriction)
MeasureDimensionTypeAttributes:
id?, urn?, uri?, position?, type?Content:
com:Annotations?, ConceptIdentity, LocalRepresentation, ConceptRole*Attribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. position xs:int The position attribute specifies the position of the dimension in the data structure definition. It is optional an the position of the dimension in the key descriptor (DimensionList element) always takes precedence over the value supplied here. This is strictly for informational purposes only. type (fixed: MeasureDimension) com: DimensionTypeType The type attribute identifies whether then dimension is a measure dimension, the time dimension, or a regular dimension. Although these are all apparent by the element names, this attribute allows for each dimension to be processed independent of its element as well as maintaining the restriction of only one measure and time dimension while still allowing dimension to occur in any order. Element Documentation:
Name Type Documentation com:Annotations com: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. ConceptIdentity com: ConceptReferenceType ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. LocalRepresentation MeasureDimensionRepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. ConceptRole com: ConceptReferenceType ConceptRole references concepts which define roles which this dimension serves. If the concept from which the attribute takes its identity also defines a role the concept serves, then the isConceptRole indicator can be set to true on the concept identity rather than repeating the reference here. GroupBaseType: GroupBaseType is an abstract base type that forms the basis for the GroupType.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
ComponentListType (restriction)
GroupBaseTypeAttributes:
id, urn?, uri?Content:
com:Annotations?Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. GroupType: GroupType describes the structure of a group descriptor in a data structure definition. A group may consist of a of partial key, or collection of distinct cube regions or key sets to which attributes may be attached. The purpose of a group is to specify attributes values which have the same value based on some common dimensionality. All groups declared in the data structure must be unique - that is, you may not have duplicate partial keys. All groups must be given unique identifiers.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
ComponentListType (restriction)
GroupBaseType (extension)
GroupTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, (GroupDimension+ | AttachmentConstraint)Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. GroupDimension GroupDimensionType GroupDimension is a component which contains only a reference to a dimension in the key descriptor (DimensionList). Although it is conventional to declare dimensions in the same order as they are declared in the ordered key, there is no requirement to do so - the ordering of the values of the key are taken from the order in which the dimensions are declared. Note that the id of a dimension may be inherited from its underlying concept - therefore this reference value may actually be the id of the concept. AttachmentConstraint com: AttachmentConstraintReferenceType AttachmentConstraint references an attachment constraint that defines the key sets and/or cube regions that attributes may be attached to. This is an alternative to referencing the dimensions, and allows attributes to be attached to data for given values of dimensions. GroupDimensionBaseType: GroupDimensionBaseType is an abstract base type which refines the base ComponentType in order to form the basis for the GroupDimensionType.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (restriction)
GroupDimensionBaseTypeContent:
{Empty}GroupDimensionType: GroupDimensionType defines a dimension component with a group key descriptor component list. Although technically a component, this is essentially a reference to a dimension defined in the key descriptor. Therefore, the identification, name, and description, concept identity and representation properties that are typically available for a component are not allowed here, as they are all inherited from the referenced dimension.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (restriction)
GroupDimensionBaseType (extension)
GroupDimensionTypeContent:
DimensionReferenceElement Documentation:
Name Type Documentation DimensionReference com: LocalDimensionReferenceType DimensionReference provides a reference to a dimension defined in the key descriptor of the data structure definition in which this group key descriptor is defined. MeasureListType: MeasureListType describes the structure of the measure descriptor for a data structure definition. Only a primary may be defined.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
ComponentListType (restriction)
MeasureListTypeAttributes:
id?, urn?, uri?Content:
com:Annotations?, PrimaryMeasureAttribute Documentation:
Name Type Documentation id (fixed: MeasureDescriptor) com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. PrimaryMeasure PrimaryMeasureType PrimaryMeasure defines the structure of the primary measure, which is the concept that is the value of the phenomenon to be measured in a data set. Although this may take its semantic from any concept, this is provided a fixed identifier (OBS_VALUE) so that it may be easily distinguished in data messages. PrimaryMeasureType: PrimaryMeasureType describes the structure of the primary measure. It describes the observation values for all presentations of the data. The primary measure takes its semantic, and in some cases it representation, from its concept identity (conventionally the OBS_VALUE concept). The primary measure can be coded by referencing a code list from its coded local representation. It can also specify its text format, which is used as the representation of the primary measure if a coded representation is not defined. Neither the coded or uncoded representation are necessary, since the primary measure may take these from the referenced concept. Note that if the data structure declares a measure dimension, the representation of this must be a superset of all possible measure concept representations.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (restriction)
PrimaryMeasureTypeAttributes:
id?, urn?, uri?Content:
com:Annotations?, ConceptIdentity, LocalRepresentation?Attribute Documentation:
Name Type Documentation id (fixed: OBS_VALUE) com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. ConceptIdentity com: ConceptReferenceType ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. LocalRepresentation SimpleDataStructureRepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. DataStructureRepresentationType: DataStructureRepresentationType is an abstract base type which defines the allowable representations for any data structure definition component. The enumeration must be restricted to the proper type for item scheme for a given component.
Derivation:
RepresentationType (restriction)
DataStructureRepresentationTypeContent:
(TextFormat | (Enumeration, EnumerationFormat?))Element Documentation:
Name Type Documentation TextFormat SimpleComponentTextF ormatType TextFormat describes an uncoded textual format. Enumeration com: ItemSchemeReferenceBaseType Enumeration references an item scheme that enumerates the allowable values for this representation. EnumerationFormat CodededTextFormatType EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. SimpleDataStructureRepresentationType: SimpleDataStructureRepresentationType defines the representation for any non-measure and non-time dimension data structure definition component.
Derivation:
RepresentationType (restriction)
DataStructureRepresentationType (restriction)
SimpleDataStructureRepresentationTypeContent:
(TextFormat | (Enumeration, EnumerationFormat?))Element Documentation:
Name Type Documentation TextFormat SimpleComponentTextFormatType TextFormat describes an uncoded textual format. Enumeration com: CodelistReferenceType Enumeration references an item scheme that enumerates the allowable values for this representation. EnumerationFormat CodededTextFormatType EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. MeasureDimensionRepresentationType: BaseDimensionRepresentationType is an abstract base which defines the representation for a measure dimension.
Derivation:
RepresentationType (restriction)
DataStructureRepresentationType (restriction)
MeasureDimensionRepresentationTypeContent:
EnumerationElement Documentation:
Name Type Documentation Enumeration com: ConceptSchemeReferenceType Enumeration references an item scheme that enumerates the allowable values for this representation. TimeDimensionRepresentationType: TimeDimensionRepresentationType defines the representation for the time dimension. Enumerated values are not allowed.
Derivation:
RepresentationType (restriction)
DataStructureRepresentationType (restriction)
SimpleDataStructureRepresentationType (restriction)
TimeDimensionRepresentationTypeContent:
TextFormatElement Documentation:
Name Type Documentation TextFormat TimeTextFormatType TextFormat describes an uncoded textual format. DataflowType: DataflowType describes the structure of a data flow. A data flow is defined as the structure of data that will provided for different reference periods. If this type is not referenced externally, then a reference to a key family definition must be provided.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
StructureUsageType (restriction)
DataflowTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*, Structure?Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Structure com: DataStructureReferenceType Structure provides a reference to the data structure definition which defines the structure of all data for this flow. HierarchicalCodelistBaseType: HierarchicalCodelistBaseType is an abstract base class that is the basis for the HierarchicalCodelistType. It requires that a name be supplied.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (restriction)
HierarchicalCodelistBaseTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. HierarchicalCodelistType: HierarchicalCodelistType describes the structure of a hierarchical codelist. A hierarchical code list is defined as an organised collection of codes that may participate in many parent/child relationships with other codes in the list, as defined by one or more hierarchy of the list.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (restriction)
HierarchicalCodelistBaseType (extension)
HierarchicalCodelistTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*, IncludedCodelist*, Hierarchy*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. IncludedCodelist IncludedCodelistReferenceType IndludedCodelist provides a collection of references to the code lists whose codes are arranged in this hierarchical code list. Hierarchy HierarchyType Hierarchy describes a classification structure arranged in levels of detail from the broadest to the most detailed level. These levels can be formal or informal, and are not necessary to describe. If the hierarchy does contain levels, then each hierarchical code is assumed to exist in the level where the depths of nesting match. HierarchyBaseType: HierarchyBaseType is an abstract base type that serves as the basis for the HierarchyType. It requires a name and id be provided.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
HierarchyBaseTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. HierarchyType: The Hierarchy is an abstract type that provides for a classification structure of referenced codes arranged in levels of detail from the broadest to the most detailed level. The levels in which the code exist can be formal or informal.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
HierarchyBaseType (extension)
HierarchyTypeAttributes:
id, urn?, uri?, leveled?Content:
com:Annotations?, com:Name+, com:Description*, HierarchicalCode+, Level?Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. leveled (default: false) xs:boolean The leveled attribute indicates that the hierarchy has formal levels. In this case, every code should have a level associated with it. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. HierarchicalCode HierarchicalCodeType HierarchicalCode is used to assemble the codes from the codelist(s) referenced into a hierarchy. Level LevelType In a formally leveled hierarchy, Level describes a group of codes which are characterised by homogeneous coding, and where the parent of each code in the group is at the same higher level of the hierarchy. In a value based hierarchy Level describes information about the codes at the specified nesting level. This structure is recursive to indicate the hierarchy of the levels. HierarchicalCodeBaseType: HierarchicalCodeBaseType is an abstract base type the creates the basis for the HierarchicalCodeType. It removes the urn and uri.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
HierarchicalCodeBaseTypeAttributes:
id, urn?, uri?Content:
com:Annotations?Attribute Documentation:
Name Type Documentation id com:IDType The id attribute allows for an id to be assigned to the use of the particular code at that specific point in the hierarchy. This value is unique within the hierarchy being created, and is used to map the hierarchy against external structures. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. HierarchicalCodeType: HierarchicalCodeType describes the structure of a hierarchical code. A hierarchical code provides for a reference to a code that is referenced within the hierarchical code list via either a complete reference to a code through either a URN or full set of reference fields, or a local reference which utilizes the included codelist reference alias and the identification of a code from the list. Codes are arranged in a hierarchy by this reference. Note that it is possible to reference a single code such that it has multiple parents within the hierarchy. Further, the hierarchy may or may not be a leveled one.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
HierarchicalCodeBaseType (extension)
HierarchicalCodeTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?Content:
com:Annotations?, (Code | (CodelistAliasRef, CodeID)), HierarchicalCode*, Level?Attribute Documentation:
Name Type Documentation id com:IDType The id attribute allows for an id to be assigned to the use of the particular code at that specific point in the hierarchy. This value is unique within the hierarchy being created, and is used to map the hierarchy against external structures. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version com:VersionType The version attriubte contains a version number for the hierarchical code. A hierarchical code is not formally versionable, therefore each code must have a unique identifier. The version supplied here is for informational purposes only and is not used to uniquely identity the code. validFrom xs:dateTime The validFrom attriubte indicates the point in time in which the hiearchical code became effective. This can be used to track the historicity of codes changing over time. validTo xs:dateTime The validTo attriubte indicates the point in time in which the hiearchical code became no longer effective. This can be used to track the historicity of codes changing over time. Element Documentation:
Name Type Documentation com:Annotations com: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. Code com: CodeReferenceType Code provides a complete, explicit reference to a code through either its URN, or a complete reference to the codelist and code. CodelistAliasRef com:IDType CodelistAliasRef references an alias assigned in a IncludedCodelistReference element in the containing hierarchical codelist. This is used in conjunction with the CodeID element to reference a code from one of the included codelists. CodeID com: LocalCodeReferenceTy pe CodeID references the id of a code from the codelist that is referenced through the CodelistAliaRef element. HierarchicalCode HierarchicalCodeType HierarchicalCode is used to nest referenced codes into a value based hierarchy. Level com: LocalLevelReferenceType Level references a formal level defined within the hierarchy which defines this hierarchical code. This is only necessary if the nesting depth of the hierarchical code does not correspond to the nesting depth of the level to which it belongs (i.e. the hieararchical code is to skip down a level). Otherwise, the code is assumed to exist at the level in which the nesting depth of the level matches the nesting depth of the code. LevelBaseType: LevelBaseType is an abstract base type that makes up the basis for the LevelType. It requires a name and id.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
LevelBaseTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. LevelType: LevelType describes a level in a hierarchical codelist. Where level is defined as a group where codes can be characterised by homogeneous coding, and where the parent of each code in the group is at the same higher level of the hierarchy.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
LevelBaseType (extension)
LevelTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, CodingFormat?, Level?Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. CodingFormat CodingTextFormatType CodingFormat specifies the text formatting of the codes in this level. This includes facets such as the expected characters and the length of the codes. Level LevelType Level describes the next level down in the hierarchy. IncludedCodelistReferenceType: IncludedCodelistReferenceType provides the structure for a referencing a codelist and optionally providing a local alias identification for this reference.
Derivation:
com:ReferenceType (restriction)
com:MaintainableReferenceBaseType (restriction)
com:ItemSchemeReferenceBaseType (restriction)
com:CodelistReferenceType (extension)
IncludedCodelistReferenceTypeAttributes:
alias?Content:
( (Ref, URN?) | URN)Attribute Documentation:
Name Type Documentation alias com:IDType The alias attribute is used to carry the identifier for the referenced codelist, so that codes from that list can be easily referenced by the hierarchical codes contained in the parent hierarchy, without having to repeat the reference to the codelist itself. The alias attribute must be unique within the parent hierarchical codelist. Element Documentation:
Name Type Documentation Ref com:CodelistRefType Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference. URN xs:anyURI URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element. URN xs:anyURI URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element. CodingTextFormatType:
Derivation:
TextFormatType (restriction)
BasicComponentTextFormatType (restriction)
SimpleComponentTextFormatType (restriction)
CodingTextFormatTypeAttributes:
textType?, isSequence?, interval?, startValue?, endValue?, minLength?, maxLength?, minValue?, maxValue?, pattern?Content:
{Empty}Attribute Documentation:
Name Type Documentation textType SimpleCodeDataType The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets. isSequence xs:boolean The isSequence attribute indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue attributes or the timeInterval, startTime, and endTime, attributes. If this attribute holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely. interval xs:integer The interval attribute specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence attribute must have a value of true. startValue xs:positiveInteger The startValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed. endValue xs:positiveInteger The endValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates that ending point (if any) of the sequence. minLength xs:positiveInteger The minLength attribute specifies the minimum and length of the value in characters. maxLength xs:positiveInteger The maxLength attribute specifies the maximum length of the value in characters. minValue xs:positiveInteger The minValue attribute is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid value will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive. maxValue xs:positiveInteger The maxValue attribute is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid value will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive. pattern xs:string The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema. MetadataflowType: MetadataflowType describes the structure of a metadata flow. A dataflow is defined as the structure of reference metadata that will be provided for different reference periods. If this type is not referenced externally, then a reference to a metadata structure definition must be provided
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
StructureUsageType (restriction)
MetadataflowTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*, Structure?Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Structure com: MetadataStructureReferenceType Structure provides a reference to the metadata structure definition describing the structure of all reference metadata for this flow. MetadataStructureType: MetadataStructureType is used to describe a metadata structure definition, which is defined as a collection of metadata concepts, their structure and usage when used to collect or disseminate reference metadata.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
StructureType (restriction)
MetadataStructureTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*, MetadataStructureComponents?Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. MetadataStructureCom ponents MetadataStructureComponentsType MetadataStructureComponents defines the grouping of the sets of the components that make up the metadata structure definition. All components and component list (target identifiers, identifier components, report structures, and metadata attributes) in the structure definition must have a unique identification. MetadataStructureComponentsBaseType: MetadataStructureComponentsBaseType is an abstract base type that forms the basis for the MetadataStructureComponentsType.
Derivation:
GroupingType (restriction)
MetadataStructureComponentsBaseTypeContent:
{Empty}MetadataStructureComponentsType: MetadataStructureComponentsType describes the structure of the grouping of the sets of the components that make up the metadata structure definition. At a minimum, a full target identifier and at least one report structure must be defined.
Derivation:
GroupingType (restriction)
MetadataStructureComponentsBaseType (extension)
MetadataStructureComponentsTypeContent:
MetadataTarget+, ReportStructure+Element Documentation:
Name Type Documentation MetadataTarget MetadataTargetType MetadataTarget is a collection of target objects which when taken together describe a structure which defines the key of an object type to which metadata may be attached and serve to disambiguate reference metadata set reports. ReportStructure ReportStructureType ReportStructure defines a report structure, which comprises a set of metadata attributes that can be defined as a hierarchy, for reporting reference metadata about a target object. The identification of metadata attributes must be unique at any given level of the report structure. Although there are XML schema constraints to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a concept from which a metadata attribute takes its identity cannot be validated against this constraint. Therefore, systems processing metadata structure definitions will have to perform this check outside of the XML validation. MetadataTargetBaseType: MetadataTargetBaseType is an abstract base type which forms the basis for the MetadataTargetType.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
ComponentListType (restriction)
MetadataTargetBaseTypeAttributes:
id, urn?, uri?Content:
com:Annotations?Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. MetadataTargetType:
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
ComponentListType (restriction)
MetadataTargetBaseType (extension)
MetadataTargetTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, (KeyDescriptorValuesTarget | DataSetTarget | ConstraintContentTarget | ReportPeriodTarget | IdentifiableObjectTarget)+Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. KeyDescriptorValuesT arget KeyDescriptorValuesTargetType KeyDescriptorValuesTarget is target object which references a data key for the purpose of attach reference metadata to portions of data. A data key is a set of dimension references and values for those dimension. This component on its own is not of much use, as the data key only has local references to the dimensions. Therefore it is typical that this is used in combination with some sort of reference to the data (either a data set reference or a reference to the underlying structure, structure usage, or provision agreement of the data. DataSetTarget DataSetTargetType DataSetTarget is target object which references a data set for the purpose of attaching reference metadata data. A data set reference is a full reference to a data provider and an identifier for the data set. ConstraintContentTar get ConstraintContentTargetType ConstraintContentTarget is target object which references an attachment constraint for the purpose of attaching reference metadata data to data key sets or cube regions defined by the constraint. ReportPeriodTarget ReportPeriodTargetType ReportPeriodTarget is target object which specifies a reporting period to which a metadata report applies. IdentifiableObjectTa rget IdentifiableObjectTargetType IdentifiableObjectTarget is target object which references an Identifiable object as defined in the SDMX Information Model. The reference must be complete (i.e. a URN or a complete set of reference fields). For an item object, it is possible to define a local representation of an item scheme from which the item must be referenced. TargetObject: TargetObject is an abstract base type from which all target objects of a metadata target are derived. It is based on a component. Implementations of this will refined the local representation so that the allowed values accurately reflect the representation of the target object reference.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (extension)
TargetObjectAttributes:
id?, urn?, uri?Content:
com:Annotations?, ConceptIdentity?, LocalRepresentation?Attribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. ConceptIdentity com: ConceptReferenceType ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. LocalRepresentation RepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. KeyDescriptorValuesTargetType: KeyDescriptorValuesTargetType defines the structure of a key descriptor values target object. The key descriptor values target object has a fixed representation and identifier.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (extension)
TargetObject (restriction)
KeyDescriptorValuesTargetTypeAttributes:
id?, urn?, uri?Content:
com:Annotations?, LocalRepresentationAttribute Documentation:
Name Type Documentation id (fixed: DIMENSION_DESCRIPTOR_VALUES_TARGET) com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. LocalRepresentation KeyDescriptorValuesRepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. DataSetTargetType: DataSetTargetType defines the structure of a data set target object. The data set target object has a fixed representation and identifier.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (extension)
TargetObject (restriction)
DataSetTargetTypeAttributes:
id?, urn?, uri?Content:
com:Annotations?, LocalRepresentationAttribute Documentation:
Name Type Documentation id (fixed: DATA_SET_TARGET) com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. LocalRepresentation DataSetRepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. ConstraintContentTargetType: ConstraintTargetType defines the structure of a constraint target object. The constraint target object has a fixed representation and identifier.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (extension)
TargetObject (restriction)
ConstraintContentTargetTypeAttributes:
id?, urn?, uri?Content:
com:Annotations?, LocalRepresentationAttribute Documentation:
Name Type Documentation id (fixed: CONSTRAINT_CONTENT_TARGET) com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. LocalRepresentation ConstraintRepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. ReportPeriodTargetType: ReportPeriodTargetType defines the structure of a report period target object. The report period target object has a fixed representation and identifier.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (extension)
TargetObject (restriction)
ReportPeriodTargetTypeAttributes:
id?, urn?, uri?Content:
com:Annotations?, LocalRepresentationAttribute Documentation:
Name Type Documentation id (fixed: REPORT_PERIOD_TARGET) com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. LocalRepresentation ReportPeriodRepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. IdentifiableObjectTargetBaseType: IdentifiableObjectTargetBaseType is an abstract base type which forms the basis for the IdentifiableObjectTargetType.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (extension)
TargetObject (restriction)
IdentifiableObjectTargetBaseTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, LocalRepresentationAttribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. LocalRepresentation IdentifiableObjectRepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. IdentifiableObjectTargetType: IdentifiableObjectTargetType defines the structure of an identifiable target object. The identifiable target object has a fixed representation of a reference and can specify a local representation of any item scheme for the purpose of restricting which items may be referenced. The identifiable object target must specify the object type which the target object is meant to reference.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (extension)
TargetObject (restriction)
IdentifiableObjectTargetBaseType (extension)
IdentifiableObjectTargetTypeAttributes:
id, urn?, uri?, objectTypeContent:
com:Annotations?, LocalRepresentationAttribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. objectType com: ObjectTypeCodelistTy pe Element Documentation:
Name Type Documentation com:Annotations com: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. LocalRepresentation IdentifiableObjectRepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. ReportStructureBaseType: ReportStructureBaseType is an abstract base type that serves as the basis for the ReportStructureType.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
ComponentListType (restriction)
ReportStructureBaseTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, MetadataAttribute+Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. MetadataAttribute MetadataAttributeType MetadataAttribute defines the a metadata attribute, which is the value of an attribute, such as the instance of a coded or uncoded attribute in a metadata structure definition. ReportStructureType: ReportStructureType describes the structure of a report structure. It comprises a set of metadata attributes that can be defined as a hierarchy, and identifies the potential attachment of these attributes to an object by referencing a target identifier.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
ComponentListType (restriction)
ReportStructureBaseType (extension)
ReportStructureTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, MetadataAttribute+, MetadataTarget+Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. MetadataAttribute MetadataAttributeType MetadataAttribute defines the a metadata attribute, which is the value of an attribute, such as the instance of a coded or uncoded attribute in a metadata structure definition. MetadataTarget com: LocalMetadataTargetReferenceType MetadataTarget references a metadata target defined in the metadata structure definition. A report structure can reference multiple metadata targets which allows a report structure to be reused for attaching metadata to different types of targets. MetadataAttributeBaseType: MetadataAttributeBaseType is an abstract base type the serves as the basis for the MetadataAttributeType.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (restriction)
MetadataAttributeBaseTypeAttributes:
id?, urn?, uri?Content:
com:Annotations?, ConceptIdentity, LocalRepresentation?Attribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. ConceptIdentity com: ConceptReferenceType ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. LocalRepresentation MetadataAttributeRepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. MetadataAttributeType: MetadataAttributeType describes the structure of a metadata attribute. The metadata attribute takes its semantic, and in some cases it representation, from its concept identity. A metadata attribute may be coded (via the local representation), uncoded (via the text format), or take no value. In addition to this value, the metadata attribute may also specify subordinate metadata attributes. If a metadata attribute only serves the purpose of containing subordinate metadata attributes, then the isPresentational attribute should be used. Otherwise, it is assumed to also take a value. If the metadata attribute does take a value, and a representation is not defined, it will be inherited from the concept it takes its semantic from. The optional id on the metadata attribute uniquely identifies it within the metadata structured definition. If this id is not supplied, its value is assumed to be that of the concept referenced from the concept identity. Note that a metadata attribute (as identified by the id attribute) definition must be unique across the entire metadata structure definition (including target identifier, identifier component, and report structure ids). A metadata attribute may be used in multiple report structures and at different levels, but the content (value and/or child metadata attributes and their cardinality) of the metadata attribute cannot change.
Derivation:
com:AnnotableType (extension)
IdentifiableType (restriction)
ComponentBaseType (extension)
ComponentType (restriction)
MetadataAttributeBaseType (extension)
MetadataAttributeTypeAttributes:
id?, urn?, uri?, minOccurs?, maxOccurs?, isPresentational?Content:
com:Annotations?, ConceptIdentity, LocalRepresentation?, MetadataAttribute*Attribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. minOccurs (default: 1) xs: nonNegativeInteger The minOccurs attribute indicates the minimum number of times this metadata attribute can occur within its parent object. maxOccurs (default: 1) com:OccurenceType The maxOccurs attribute indicates the maximum number of times this metadata attribute can occur within its parent object. isPresentational (default: false) xs:boolean The isPresentational attribute indicates whether the metadata attribute should allow for a value. A value of true, meaning the metadata attribute is presentational means that the attribute only contains child metadata attributes, and does not contain a value. If this attribute is not set to true, and a representation (coded or uncoded) is not defined, then the representation of the metadata attribute will be inherited from the concept from which it takes its identity. Element Documentation:
Name Type Documentation com:Annotations com: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. ConceptIdentity com: ConceptReferenceType ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. LocalRepresentation MetadataAttributeRepresentationType LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. MetadataAttribute MetadataAttributeType MetadataAttribute defines the a metadata attribute, which is the value of an attribute, such as the instance of a coded or uncoded attribute in a metadata structure definition. KeyDescriptorValuesRepresentationType: KeyDescriptorValuesRepresentationType defines the possible local representations of a key descriptor values target object. The representation is fixed to always be a data key (KeyValues).
Derivation:
RepresentationType (restriction)
KeyDescriptorValuesRepresentationTypeContent:
TextFormatElement Documentation:
Name Type Documentation TextFormat KeyDescriptorValuesTextFormatType TextFormat describes an uncoded textual format. DataSetRepresentationType: DataSetRepresentationType defines the possible local representations of a data set reference target object. The representation is fixed to always be a data set reference.
Derivation:
RepresentationType (restriction)
DataSetRepresentationTypeContent:
TextFormatElement Documentation:
Name Type Documentation TextFormat DataSetTextFormatType TextFormat describes an uncoded textual format. ConstraintRepresentationType: ConstraintRepresentationType defines the possible local representations of a constraint reference target object. The representation is fixed to always be an attachment constraint reference.
Derivation:
RepresentationType (restriction)
ConstraintRepresentationTypeContent:
TextFormatElement Documentation:
Name Type Documentation TextFormat ConstraintTextFormatType TextFormat describes an uncoded textual format. ReportPeriodRepresentationType: ReportPeriodRepresentationType defines the possible local representations of a report period target object. The reprentation must be a time period or a subset of this representation.
Derivation:
RepresentationType (restriction)
ReportPeriodRepresentationTypeContent:
TextFormatElement Documentation:
Name Type Documentation TextFormat TimeTextFormatType TextFormat describes an uncoded textual format. IdentifiableObjectRepresentationType: IdentifiableObjectRepresentationType defines the possible local representations of an identifiable object target object.
Derivation:
RepresentationType (restriction)
IdentifiableObjectRepresentationTypeContent:
(TextFormat | Enumeration)Element Documentation:
Name Type Documentation TextFormat IdentifiableObjectTextFormatType TextFormat describes an uncoded textual format. Enumeration com: ItemSchemeReferenceType Enumeration is only permissible if the object type of the identifiable object target is an item in an item scheme. This enumeration is meant to limit the referencable objects to the items defined in the referenced item scheme. MetadataAttributeRepresentationType: MetadataAttributeRepresentationType defines the possible local representations of a metadata attribute.
Derivation:
RepresentationType (restriction)
MetadataAttributeRepresentationTypeContent:
(TextFormat | (Enumeration, EnumerationFormat?))Element Documentation:
Name Type Documentation TextFormat BasicComponentTextFormatType TextFormat describes an uncoded textual format. Enumeration com: CodelistReferenceType Enumeration references an item scheme that enumerates the allowable values for this representation. EnumerationFormat CodededTextFormatType EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. TargetObjectTextFormatType: TargetObjectTextFormatType is a restricted version of the TextFormatType that does not allow for any facets and only allows the text types for target objects.
Derivation:
TextFormatType (restriction)
TargetObjectTextFormatTypeAttributes:
textType?Content:
{Empty}Attribute Documentation:
Name Type Documentation textType TargetObjectDataType The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets. KeyDescriptorValuesTextFormatType: KeyDescriptorValuesTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed KeyValues representation.
Derivation:
TextFormatType (restriction)
TargetObjectTextFormatType (restriction)
KeyDescriptorValuesTextFormatTypeAttributes:
textType?Content:
{Empty}Attribute Documentation:
Name Type Documentation textType (fixed: KeyValues) TargetObjectDataType The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets. DataSetTextFormatType: DataSetTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed DataSetReference representation.
Derivation:
TextFormatType (restriction)
TargetObjectTextFormatType (restriction)
DataSetTextFormatTypeAttributes:
textType?Content:
{Empty}Attribute Documentation:
Name Type Documentation textType (fixed: DataSetReference) TargetObjectDataType The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets. ConstraintTextFormatType: ConstraintTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed AttachmentConstraintReference representation.
Derivation:
TextFormatType (restriction)
TargetObjectTextFormatType (restriction)
ConstraintTextFormatTypeAttributes:
textType?Content:
{Empty}Attribute Documentation:
Name Type Documentation textType (fixed: AttachmentConstraintReference) TargetObjectDataType The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets. IdentifiableObjectTextFormatType: IdentifiableObjectTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed IdentifiableReference representation.
Derivation:
TextFormatType (restriction)
TargetObjectTextFormatType (restriction)
IdentifiableObjectTextFormatTypeAttributes:
textType?Content:
{Empty}Attribute Documentation:
Name Type Documentation textType (fixed: IdentifiableReference) TargetObjectDataType The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets. OrganisationSchemeBaseType: OrganisationSchemeBaseType is an abstract base type for any organisation scheme.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (restriction)
OrganisationSchemeBaseTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?Content:
com:Annotations?, com:Name+, com:Description*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. OrganisationSchemeType: OrganisationSchemeType describes the structure of an organisation scheme.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (restriction)
OrganisationSchemeBaseType (extension)
OrganisationSchemeTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?Content:
com:Annotations?, com:Name+, com:Description*, Organisation*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Organisation OrganisationType Organisation is an abstract substitution head for a generic organisation. BaseOrganisationType: BaseOrganisationType is an abstract base type the forms the basis for the OrganisationType.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
BaseOrganisationTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, Parent?Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Parent com: LocalOrganisationReferenceBaseType If the particular organisation scheme allows, an organisation may reference a parent organisation defined in the same scheme. This does not affect the identification of the organisation, but rather only serves to state the relationship. OrganisationType: OrganisationType in an abstract type which describes the structure of the details of an organisation. In addition to the basic organisation identification, contact details can be provided.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
BaseOrganisationType (extension)
OrganisationTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, Parent?, Contact*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Parent com: LocalOrganisationReferenceBaseType If the particular organisation scheme allows, an organisation may reference a parent organisation defined in the same scheme. This does not affect the identification of the organisation, but rather only serves to state the relationship. Contact ContactType Contact describes a contact for the organisation, AgencySchemeType: AgencySchemeType defines a specific type of organisation scheme which contains only maintenance agencies. The agency scheme maintained by a particular maintenance agency is always provided a fixed identifier and version, and is never final. Therefore, agencies can be added or removed without have to version the scheme. Agencies schemes have no hierarchy, meaning that no agency may define a relationship with another agency in the scheme. In fact, the actual parent agency for an agency in a scheme is the agency which defines the scheme.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (restriction)
OrganisationSchemeBaseType (extension)
OrganisationSchemeType (restriction)
AgencySchemeTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?Content:
com:Annotations?, com:Name+, com:Description*, Agency*Attribute Documentation:
Name Type Documentation id (fixed: AGENCIES) com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (fixed: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (fixed: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Agency AgencyType Agency is an organisation which maintains structural metadata such as statistical classifications, glossaries, key family structural definitions, and metadata structure definitions.. DataConsumerSchemeType: DataConsumerSchemeType defines a type of organisation scheme which contains only data consumers. The data consumer scheme maintained by a particular maintenance agency is always provided a fixed identifier and version, and is never final. Therefore, consumers can be added or removed without have to version the scheme. This scheme has no hierarchy, meaning that no organisation may define a relationship with another organisation in the scheme.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (restriction)
OrganisationSchemeBaseType (extension)
OrganisationSchemeType (restriction)
DataConsumerSchemeTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?Content:
com:Annotations?, com:Name+, com:Description*, DataConsumer*Attribute Documentation:
Name Type Documentation id (fixed: DATA_CONSUMERS) com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (fixed: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (fixed: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. DataConsumer DataConsumerType DataConsumer describes an organisation using data as input for further processing. DataProviderSchemeType: DataProviderSchemeType defines a type of organisation scheme which contains only data providers. The data provider scheme maintained by a particular maintenance agency is always provided a fixed identifier and version, and is never final. Therefore, providers can be added or removed without have to version the scheme. This scheme has no hierarchy, meaning that no organisation may define a relationship with another organisation in the scheme
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (restriction)
OrganisationSchemeBaseType (extension)
OrganisationSchemeType (restriction)
DataProviderSchemeTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?Content:
com:Annotations?, com:Name+, com:Description*, DataProvider*Attribute Documentation:
Name Type Documentation id (fixed: DATA_PROVIDERS) com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (fixed: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (fixed: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. DataProvider DataProviderType DataProvider describes an organisation that produces data or reference metadata. OrganisationUnitSchemeType: OrganisationUnitSchemeType defines a type of organisation scheme which simply defines organisations and there parent child relationships. Organisations in this scheme are assigned no particular role, and may in fact exist within the other type of organisation schemes as well.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (restriction)
OrganisationSchemeBaseType (extension)
OrganisationSchemeType (restriction)
OrganisationUnitSchemeTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?Content:
com:Annotations?, com:Name+, com:Description*, OrganisationUnit*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. OrganisationUnit OrganisationUnitType OrganisationUnit describes a generic organisation, which serves not predefined role in SDMX. AgencyType: AgencyType defines the structure of an agency description. The contacts defined for the organisation are specific to the agency role the organisation is serving.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
BaseOrganisationType (extension)
OrganisationType (restriction)
AgencyTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, Contact*Attribute Documentation:
Name Type Documentation id com:NCNameIDType The id attribute holds the identification of the agency. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the agency identifier will be used as part of the name for simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Contact ContactType Contact describes a contact for the organisation, DataConsumerType: DataConsumerType defines the structure of a data consumer description. The contacts defined for the organisation are specific to the data consumer role the organisation is serving.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
BaseOrganisationType (extension)
OrganisationType (restriction)
DataConsumerTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, Contact*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Contact ContactType Contact describes a contact for the organisation, DataProviderType: DataProviderType defines the structure of a data provider description. The contacts defined for the organisation are specific to the data provider role the organisation is serving.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
BaseOrganisationType (extension)
OrganisationType (restriction)
DataProviderTypeid, urn?, uri?
Content:
com:Annotations?, com:Name+, com:Description*, Contact*
Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Contact ContactType Contact describes a contact for the organisation, OrganisationUnitType: OrganisationUnitType defines the structure of an organisation unit description. In addition to general identification and contact information, an organisation unit can specify a relationship with another organisation unit from the same scheme which is its parent organisation.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
BaseOrganisationType (extension)
OrganisationType (restriction)
OrganisationUnitTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, Parent?, Contact*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Parent com: LocalOrganisationUnitReferenceType If the particular organisation scheme allows, an organisation may reference a parent organisation defined in the same scheme. This does not affect the identification of the organisation, but rather only serves to state the relationship. Contact ContactType Contact describes a contact for the organisation, ContactType: ContactType describes the structure of a contact's details.
Attributes:
id?Content:
com:Name*, Department*, Role*, (Telephone | Fax | X400 | URI | Email)*Attribute Documentation:
Name Type Documentation id com:IDType The id attribute is used to carry user id information for the contact. Element Documentation:
Name Type Documentation com:Name com:TextType Name is a reusable element, used for providing a human-readable name for an object. Department com:TextType Department is designation of the organisational structure by a linguistic expression, within which the contact person works. Role com:TextType Role is the responsibility of the contact person with respect to the object for which this person is the contact. Telephone xs:string Telephone holds the telephone number for the contact person. Fax xs:string Fax holds the fax number for the contact person. X400 xs:string X400 holds the X.400 address for the contact person. URI xs:anyURI URI holds an information URL for the contact person. Email xs:string Email holds the email address for the contact person. ProvisionAgreementType: ProvisionAgreementType describes the structure of a provision agreement. A provision agreement defines an agreement for a data provider to report data or reference metadata against a flow. Attributes which describe how the registry must behave when data or metadata is registered against this provision agreement are supplied.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ProvisionAgreementTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*, StructureUsage, DataProviderAttribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. StructureUsage com: StructureUsageReferenceType DataflowReference provides a reference to a pre-existing structure usage (i.e. a dataflow or metadataflow) in the registry. The reference is provided via a URN and/or a full set of reference fields. DataProvider com: DataProviderReferenceType DataProvider provides a reference to a pre-existing data (or metadata) provider in the registry. The reference is provided via a URN and/or a full set of reference fields. ProcessType: ProcessType describes the structure of a process, which is a scheme which defines or documents the operations performed on data in order to validate data or to derive new information according to a given set of rules. Processes occur in order, and will continue in order unless a transition dictates another step should occur.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ProcessTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*, ProcessStep*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. ProcessStep ProcessStepType ProcessStep defines a process step, which is a specific operation, performed on data in order to validate or to derive new information according to a given set of rules. ProcessStepBaseType: ProcessStepBaseType is an abstract base type used as the basis for the ProcessStepType.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ProcessStepBaseTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. ProcessStepType: ProcessStepType describes the structure of a process step. A nested process step is automatically sub-ordinate, and followed as the next step. If the following step is conditional, it should be referenced in a transition.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ProcessStepBaseType (extension)
ProcessStepTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, Input*, Output*, Computation?, Transition*, ProcessStep*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Input InputOutputType Input references an object which is an input to the process step. Output InputOutputType Output references an object which is an output form the process step. Computation ComputationType Computation describes the computations involved in the process, in any form desired by the user (these are informational rather than machine-actionable), and so may be supplied in multiple, parallel-language versions. Transition TransitionType Transition describes the next process steps. Each transition in a process step should be evaluated, allowing for multiple process step branches from a single process step. ProcessStep ProcessStepType ProcessStep defines a process step, which is a specific operation, performed on data in order to validate or to derive new information according to a given set of rules. TransitionType: TransitionType describes the details of a transition, which is an expression in a textual or formalised way of the transformation of data between two specific operations performed on the data.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
TransitionTypeAttributes:
id?, urn?, uri?, localID?Content:
com:Annotations?, TargetStep, Condition+Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. localID com:IDType The localID attribute is an optional identification for the transition within the process. Element Documentation:
Name Type Documentation com:Annotations com: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. TargetStep com: LocalProcessStepReferenceType TargetStep references a process step within the process that should be transitioned to, should the conditions described be met. Condition com:TextType Condition is a textual description of the conditions to be met in order for the target step to be proceeded to. It is informational only (not machine-actionable), and may be supplied in multiple, parallel-language form. ComputationType: ComputationType describes a computation in a process.
Derivation:
com:AnnotableType (extension)
ComputationTypeAttributes:
localID?, softwarePackage?, softwareLanguage?, softwareVersion?Content:
com:Annotations?, com:Description+Attribute Documentation:
Name Type Documentation localID com:IDType The localID attribute is an optional identification for the computation within the process. softwarePackage xs:string The softwarePackage attribute holds the name of the software package that is used to perform the computation. softwareLanguage xs:string The softwareLanguage attribute holds the coding language that the software package used to perform the computation is written in. softwareVersion xs:string The softwareVersion attribute hold the version of the software package that is used to perform that computation. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Description com:TextType Description describe the computation in any form desired by the user (these are informational rather than machine-actionable), and so may be supplied in multiple, parallel-language versions, InputOutputType: InputOutputType describes the structure of an input or output to a process step. It provides a reference to the object that is the input or output.
Derivation:
com:AnnotableType (extension)
InputOutputTypeAttributes:
localID?Content:
com:Annotations?, ObjectReferenceAttribute Documentation:
Name Type Documentation localID com:IDType The localID attribute is an optional identification for the input or output within the process. Element Documentation:
Name Type Documentation com:Annotations com: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. ObjectReference com: ObjectReferenceType ObjectReference is an abstract substitution head that references the object that is an input or output. It is substituted with a concrete reference to an explicit object type. ReportingTaxonomyType: ReportingTaxonomyType describes the structure of a reporting taxonomy, which is a scheme which defines the composition structure of a data report where each component can be described by an independent structure or structure usage description.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (restriction)
ReportingTaxonomyTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?Content:
com:Annotations?, com:Name+, com:Description*, ReportingCategory*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. ReportingCategory ReportingCategoryType ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages. ReportingCategoryBaseType: ReportingCategoryBaseType is an abstract base type that serves as the basis for the ReportingCategoryType.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
ReportingCategoryBaseTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, ReportingCategory*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. ReportingCategory ReportingCategoryType ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages. ReportingCategoryType: ReportingCategoryType describes the structure of a reporting category, which groups structure usages into useful sub-packages. Sub ordinate reporting categories can be nested within the category definition.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
ReportingCategoryBaseType (extension)
ReportingCategoryTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, ReportingCategory*, (StructuralMetadata* | ProvisioningMetadata*)Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. ReportingCategory ReportingCategoryType ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages. StructuralMetadata com: StructureReferenceType StructuralMetadata provides a reference for data structure definition and metadata structure definition references which are grouped in the reporting category. It is assumed that all structural metadata objects referenced from a category will be of the same type. ProvisioningMetadata com: StructureUsageReferenceType ProvisioningMetadata provides a reference for dataflow and metadataflow references which are grouped in the reporting category. It is assumed that all provisioning metadata objects referenced from a category will be of the same type. StructureSetBaseType: StructureSetBaseType is an abstract base type that forms the basis for the StructureSetType.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (restriction)
StructureSetBaseTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. StructureSetType: StructureSetType describes the structure of a structure set. It allows components in one structure, structure usage, or item scheme to be mapped to components in another structural component of the same type.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (restriction)
StructureSetBaseType (extension)
StructureSetTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?Content:
com:Annotations?, com:Name+, com:Description*, RelatedStructure*, (OrganisationSchemeMap | CategorySchemeMap | CodelistMap | ConceptSchemeMap | ReportingTaxonomyMap | HybridCodelistMap | StructureMap)*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. RelatedStructure com: StructureOrUsageReferenceType RelatedStructures contains references to structures (key families and metadata structure definitions) and structure usages (data flows and metadata flows) to indicate that a semantic relationship exist between them. The details of these relationships can be found in the structure maps. OrganisationSchemeMa p OrganisationSchemeMapType OrganisationSchemeMap links a source and target organisations from different schemes where there is a semantic equivalence between them. Organisations are mapped without regard to role. CategorySchemeMap CategorySchemeMapType CategorySchemeMap links a source and target categories from different schemes where there is a semantic equivalence between them. CodelistMap CodelistMapType CodelistMap links a source and target codes from different lists where there is a semantic equivalence between them. ConceptSchemeMap ConceptSchemeMapType ConceptSchemeMap links a source and target concepts from different schemes where there is a semantic equivalence between them. ReportingTaxonomyMap ReportingTaxonomyMapType ReportingTaxonomyMap links a source and target reporting categories from different taxonomies where there is a semantic equivalence between them. HybridCodelistMap HybridCodelistMapType HybridCodelistMap links a source and target codes from different codelists, which may be hierarchical or flat, where there is a semantic equivalence between them. StructureMap StructureMapType StructureMap maps components from one structure to components to another structure, and can describe how the value of the components are related. ItemSchemeMapBaseType: ItemSchemeMapBaseType is an abstract base type which forms the basis for the ItemSchemeMapType.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemSchemeMapBaseTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. ItemSchemeMapType: ItemSchemeMapType is an abstract base type which forms the basis for mapping items between item schemes of the same type.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemSchemeMapBaseType (extension)
ItemSchemeMapTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, Source, Target, ItemAssociation+Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Source com: ItemSchemeReferenceBaseType Source provides a reference to the item scheme which items are mapped from. Target com: ItemSchemeReferenceBaseType Target provides a reference to the item scheme which items are mapped to. ItemAssociation ItemAssociationType ItemAssociation is an abstract description of the relation between two items for the purpose of mapping. ItemAssociationType: ItemAssociationType is an abstract type which defines the relationship between two items from the source and target item schemes of an item scheme map.
Derivation:
com:AnnotableType (extension)
ItemAssociationTypeContent:
com:Annotations?, Source, TargetElement Documentation:
Name Type Documentation com:Annotations com: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. Source com: LocalItemReferenceType Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item. Target com: LocalItemReferenceType Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item. OrganisationSchemeMapType: OrganisationSchemeMapType defines the structure of a map which identifies relationships between organisations in different organisation schemes.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemSchemeMapBaseType (extension)
ItemSchemeMapType (restriction)
OrganisationSchemeMapTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, Source, Target, OrganisationMap+Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Source com: OrganisationSchemeReferenceType Source provides a reference to the item scheme which items are mapped from. Target com: OrganisationSchemeReferenceType Target provides a reference to the item scheme which items are mapped to. OrganisationMap OrganisationMapType OrganisationMap relates a source organisation to a target organisation. OrganisationMapType: OrganisationMapType defines the structure for mapping two organisations. A local reference is provided both the source and target organisation.
Derivation:
com:AnnotableType (extension)
ItemAssociationType (restriction)
OrganisationMapTypeContent:
com:Annotations?, Source, TargetElement Documentation:
Name Type Documentation com:Annotations com: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. Source com: LocalOrganisationReferenceType Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item. Target com: LocalOrganisationReferenceType Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item. CategorySchemeMapType: CategorySchemeMapType defines the structure of a map which identifies relationships between categories in different category schemes.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemSchemeMapBaseType (extension)
ItemSchemeMapType (restriction)
CategorySchemeMapTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, Source, Target, CategoryMap+Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Source com: CategorySchemeReferenceType Source provides a reference to the item scheme which items are mapped from. Target com: CategorySchemeReferenceType Target provides a reference to the item scheme which items are mapped to. CategoryMap CategoryMapType CategoryMap defines the structure of a map which identifies relationships between categories in different category schemes. CategoryMapType: CategoryMapType defines the structure for mapping two categories. A local reference is provided both the source and target category.
Derivation:
com:AnnotableType (extension)
ItemAssociationType (restriction)
CategoryMapTypeContent:
com:Annotations?, Source, TargetElement Documentation:
Name Type Documentation com:Annotations com: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. Source com: LocalCategoryReferenceType Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item. Target com: LocalCategoryReferenceType Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item. CodelistMapType: CodelistMapType defines the structure of a map which identifies relationships between codes in different codelists.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemSchemeMapBaseType (extension)
ItemSchemeMapType (restriction)
CodelistMapTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, Source, Target, CodeMap+Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Source com: CodelistReferenceType Source provides a reference to the item scheme which items are mapped from. Target com: CodelistReferenceType Target provides a reference to the item scheme which items are mapped to. CodeMap CodeMapType CodeMap defines the structure of a map which identifies relationships between codes in different codelists. CodeMapType: CodeMapType defines the structure for mapping two codes. A local reference is provided both the source and target code.
Derivation:
com:AnnotableType (extension)
ItemAssociationType (restriction)
CodeMapTypeContent:
com:Annotations?, Source, TargetElement Documentation:
Name Type Documentation com:Annotations com: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. Source com: LocalCodeReferenceType Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item. Target com: LocalCodeReferenceType Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item. ConceptSchemeMapType: ConceptSchemeMapType defines the structure of a map which identifies relationships between concepts in different concept schemes.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemSchemeMapBaseType (extension)
ItemSchemeMapType (restriction)
ConceptSchemeMapTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, Source, Target, ConceptMap+Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Source com: ConceptSchemeReferenceType Source provides a reference to the item scheme which items are mapped from. Target com: ConceptSchemeReferenceType Target provides a reference to the item scheme which items are mapped to. ConceptMap ConceptMapType ConceptMap defines the structure of a map which identifies relationships between concepts in different concept schemes. ConceptMapType: ConceptMapType defines the structure for mapping two concepts. A local reference is provided both the source and target concept.
Derivation:
com:AnnotableType (extension)
ItemAssociationType (restriction)
ConceptMapTypeContent:
com:Annotations?, Source, TargetElement Documentation:
Name Type Documentation com:Annotations com: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. Source com: LocalConceptReferenceType Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item. Target com: LocalConceptReferenceType Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item. ReportingTaxonomyMapType: ReportingTaxonomyMapType defines the structure of a map which identifies relationships between reporting categories in different reporting taxonomies.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemSchemeMapBaseType (extension)
ItemSchemeMapType (restriction)
ReportingTaxonomyMapTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, Source, Target, ReportingCategoryMap+Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Source com: ReportingTaxonomyReferenceType Source provides a reference to the item scheme which items are mapped from. Target com: ReportingTaxonomyReferenceType Target provides a reference to the item scheme which items are mapped to. ReportingCategoryMap ReportingCategoryMapType ReportingCategoryMap defines the structure of a map which identifies relationships between reporting categories in different reporting taxonomies. ReportingCategoryMapType: ReportingCategoryMapType defines the structure for mapping two reporting categories. A local reference is provided both the source and target category.
Derivation:
com:AnnotableType (extension)
ItemAssociationType (restriction)
ReportingCategoryMapTypeContent:
com:Annotations?, Source, TargetElement Documentation:
Name Type Documentation com:Annotations com: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. Source com: LocalReportingCategoryReferenceType Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item. Target com: LocalReportingCategoryReferenceType Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item. HybridCodelistMapBaseType: HybridCodelistMapBaseType is an abstract base type which forms the basis for the HybridCodelistMapType.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
HybridCodelistMapBaseTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. HybridCodelistMapType: HybridCodelistMapType defines the structure of a map which relates codes (possibly hierarchical) from different code lists.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
HybridCodelistMapBaseType (extension)
HybridCodelistMapTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, Source, Target, HybridCodeMap+Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Source com: AnyCodelistReferenceType Source provides a reference to either a codelist or a hierarchical codelist, from which the codes are to be mapped. Target com: AnyCodelistReferenceType Target provides a reference to either a codelist or a hierarchical codelist, to which the source codes are to be mapped. HybridCodeMap HybridCodeMapType HybridCodeMap defines the relationship of a code in the source list to code in the target list. HybridCodeMapType: CodeMapType defines the structure for associating a code from a source codelist to a code in a target codelist. Note that either of these may come from a hierarchical codelist.
Derivation:
com:AnnotableType (extension)
HybridCodeMapTypeContent:
com:Annotations?, Source, TargetElement Documentation:
Name Type Documentation com:Annotations com: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. Source com: AnyLocalCodeReferenceType Source provides a local reference to the code which is to be mapped. If this code is from a hierarchical codelist, a reference to the hierarchy in which it is defined must also be provided. Target com: AnyLocalCodeReferenceType Target provides a local reference to the code to which the source code is mapped. If this code is from a hierarchical codelist, a reference to the hierarchy in which it is defined must also be provided. StructureMapBaseType: StructureMapBaseType is an abstract base type which forms the basis for the StructureMapType.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
StructureMapBaseTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. StructureMapType: StructureMapType defines the structure for mapping components of one structure to components of another structure. A structure may be referenced directly meaning the map applies wherever the structure is used, or it may be a reference via a structure usage meaning the map only applies within the context of that usage. Using the related structures, one can make extrapolations between maps. For example, if key families, A, B, and C, are all grouped in a related structures container, then a map from key family A to C and a map from key family B to C could be used to infer a relation between key family A to C.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
StructureMapBaseType (extension)
StructureMapTypeAttributes:
id, urn?, uri?, isExtension?Content:
com:Annotations?, com:Name+, com:Description*, Source, Target, ComponentMap+Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. isExtension (default: false) xs:boolean The isExtension attribute, when true, indicates that the target structure definition inherits all properties of the referenced structure definition, and may have additional components. Note that this attribute may only be set to true if the structure map has a source structure and a target structure of either two key families or two metadata structure definitions. It is not possible inherit the underlying concepts of components between the two type of structures using this mechanism. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Source com: StructureOrUsageReferenceType Source provides a reference to a structure (data or metadata) or a structure usage (dataflow or metadataflow) from which components defined by the actual structure are to mapped. Target com: StructureOrUsageReferenceType Target provides a reference to a structure (data or metadata) or a structure usage (dataflow or metadataflow) to which components from the source are to mapped. ComponentMap ComponentMapType ComponentMap defines the relationship between the components of the source and target structures, including information on how the value from the source component relates to values in the target component. ComponentMapType: ComponentMapType defines the structure for relating a component in a source structure to a component in a target structure.
Derivation:
com:AnnotableType (extension)
ComponentMapTypeContent:
com:Annotations?, Source, Target, RepresentationMapping?Element Documentation:
Name Type Documentation com:Annotations com: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. Source com: LocalComponentListComponentReferenceType Target com: LocalComponentListComponentReferenceType RepresentationMapping RepresentationMapType RepresentationMapping describes the mapping rules to map the value of the source component to the target component. Note that is a representation mapping is not supplied, then the value of the source component is mapped directly to the value of the target component without any manipulation. RepresentationMapType: RepresentationMapType describes the structure of the mapping of the value of a source to component to a target component. Either a reference to another map defined within the containing structure set or a description of the source and target text formats must be provided. Note that for key family components, only a reference to a codelist map is relevant, since that is the only type of coded representation allowed in a key family.
Content:
(CodelistMap | (ToTextFormat, ToValueType) | ValueMap)Element Documentation:
Name Type Documentation CodelistMap com: LocalCodelistMapReferenceType CodelistMap references a codelist map defined in the same structure set which maps the enumeration of the representation of the source component to the enumeration of the representation of the target component. ToTextFormat TextFormatType ToTextFormat describes the un-coded representation of the target to which the value of the referenced component should be transformed. ToValueType ToValueTypeType ToValueType notes whether the value, name, or description of the source value should be used in the target value. ValueMap ValueMapType ValueMap provides for a simple mapping of a source value to a target value without having to define a codelist map. This is available to allow mappings in situations such as the source or target is not being formally coded, or the source and/or target being a measure dimension in which case its representation is not mappable from a codelist map. ValueMapType: ValueMapType contains a collection of value mappings, which give a source and target value.
Content:
ValueMapping+Element Documentation:
Name Type Documentation ValueMapping ValueMappingType ValueMapping provides a source and target value for the purpose of mapping. ValueMappingType: ValueMappingType specifies the relationship between two values as a source and target.
Attributes:
source, targetContent:
{Empty}Attribute Documentation:
Name Type Documentation source xs:string target xs:string VtlDefinitionSchemeType: VtlDefinitionSchemeType is an abstract extension of the ItemSchemeType for VTL schemes.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (extension)
VtlDefinitionSchemeTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersionContent:
com:Annotations?, com:Name+, com:Description*, Item*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. vtlVersion xs:string Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Item ItemType Item is an abstract element that serves as a substitution head for all items in an item scheme, including those items nested within other items. Concrete instances of this must use a concrete instance of ItemType. TransformationSchemeBaseType: TransformationSchemeBaseType is an abstract base type for the TransformationSchemeType. It restricts the item types to be only transformations.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (extension)
VtlDefinitionSchemeType (restriction)
TransformationSchemeBaseTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersionContent:
com:Annotations?, com:Name+, com:Description*, Transformation*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. vtlVersion xs:string Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Transformation TransformationType Transformation describes the details of a single transformation within a transformation scheme. TransformationSchemeType: TransformationSchemeType describes the structure of a transformation scheme. A transformation scheme contains a set of transformations to be executed together (in the same run). It can contain any number of transformations that produce any number of results.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (extension)
VtlDefinitionSchemeType (restriction)
TransformationSchemeBaseType (extension)
TransformationSchemeTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersionContent:
com:Annotations?, com:Name+, com:Description*, Transformation*, VtlMappingScheme?, NamePersonalisationScheme?, CustomTypeScheme?, RulesetScheme*, UserDefinedOperatorScheme*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. vtlVersion xs:string Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Transformation TransformationType Transformation describes the details of a single transformation within a transformation scheme. VtlMappingScheme com: VtlMappingSchemeReferenceType References a VTL mapping scheme which defines aliases for given SDMX artefacts that are used in the transformations as well as the mapping methods used when converting between SDMX and VTL data structures. All aliases must be defined in the referenced scheme. This also must be used if the basic mapping methods are not used. NamePersonalisationScheme com: NamePersonalisationSchemeReferenceType References a name personalisation scheme, which defines the overriding of some standard VTL names (to be assigned to some measures and/or attributes of the data structure) with some corresponding personalised names. This must be used if transformations within a transformation scheme personalise standard names. All personalisations must be defined in the referenced scheme. CustomTypeScheme com: CustomTypeSchemeReferenceType References a custom type scheme which defines custom conversions of VTL scalar types to SDMX data types. This must be used if custom type conversions are used in the transformations defined in a transformation scheme. All custom conversions must be defined in the referenced scheme. RulesetScheme com: RulesetSchemeReferen ceType References a ruleset scheme that defines one or more previously defined rulesets which can be invoked by VTL operators. If a transformation defined in a transformation scheme refers to a ruleset, the scheme in which the ruleset is defined must be referenced here. UserDefinedOperatorScheme com: UserDefinedOperatorSchemeReferenceType References a user defined operator scheme that defines one or more user defined operators used by the transformations defined in a transformation scheme. If a transformation in a transformation scheme refers to a user defined operator, the scheme in which the user defined operator is defined must be referenced here. TransformationType: TransformationType defines the structure of a transformation. A transformation is an assignment of a VTL expression to a specific result.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
UnnestedItemType (extension)
TransformationTypeAttributes:
id, urn?, uri?, isPersistentContent:
com:Annotations?, com:Name+, com:Description*, Expression, ResultAttribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. isPersistent xs:boolean Indicates if the the result is permanently stored. A persistent result (value of true) can be used by transformation defined in other transformation schemes, but a non-persistent result (value of false) can only be used by transformations within the same transformation scheme. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Expression xs:string The right-hand side of the VTL statement. This is expression that is executed for this transformation. It include references to operands and other artefacts. The expression may contain references to SDMX artefacts using the reduced URN format; see Section 6 SDMX Standards ("SDMX Technical Notes"), 10.2.3 ("Abbreviation of the URN"). Result xs:string The left-hand side of the VTL statement. This identifies the result artefact, which may be used in subsequent transformations. If the result is an SDMX artefact, the is expressed using the alias; see Section 6 SDMX Standards ("SDMX Technical Notes"), 10.2.3 ("Abbreviation of the URN"). VtlMappingSchemeType: VtlMappingSchemeType defines a set of mappings between SDMX and VTL.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (restriction)
VtlMappingSchemeTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?Content:
com:Annotations?, com:Name+, com:Description*, VtlMapping*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. VtlMapping VtlMappingType VtlMapping details a mapping between SDMX and VTL transformation. VtlMappingType: VtlMappingType defines the structure of a single mapping between the reference to a SDMX artefact made from VTL transformations, rulesets, user defined operators and the corresponding SDMX structure identifier. These are used to assign an alternative names to SDMX Dataflows, Codelists, Concept Schemes, or Concepts. Although are distinct sub-classes in the Information Model, this structure serves to express them all. The references SDMX artefact serves to distinguish which type of sub-class (VtlDatflowMapping, VtlCodelistMapping, or VtlConceptSchemeMapping) is being described. When this is used to assign an alias for a SDMX Dataflow, this can also be used to indicate the methods used to convert the data structure from SDMX to VTL and vice-versa. Finally, this can be used to override the deault Basic mapping methods used for Dataflows by utilizing the GenericDataflow element in place of a reference to a specific Dataflow.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
UnnestedItemType (extension)
VtlMappingTypeAttributes:
id, urn?, uri?, aliasContent:
com:Annotations?, com:Name+, com:Description*, ( ( (Dataflow | GenericDataflow), ToVtlMapping?, FromVtlMapping?) | Codelist | ConceptScheme | Concept)Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. alias xs:string The alias used to refer to the reference SDMX artefact in the transformations. This must be unique within the mapping scheme in which it is defined. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Dataflow com: DataflowReferenceType A reference to the SDMX Dataflow that the mapping is defined for. This is used to create a VtlDataflowMapping. In this case, it is possible to specify the mapping details to and from VTL. GenericDataflow com:EmptyType Indicates that the ToVtlMapping and FromVtlMapping are the default mapping methods to be applied, overriding the Basic methods if necessary. The mapping methods in this case would be applied to any dataflows that are not explicitly defined in other VtlMappings. ToVtlMapping ToVtlMappingType Describes the mapping from a SDMX dataflow to a VTL data structure. FromVtlMapping FromVtlMappingType Describes the mapping to a SDMX dataflow from a VTL data structure. Codelist com: CodelistReferenceType A reference to the SDMX Codelist that the mapping is defined for. This is used to create a VtlCodelistMapping. ConceptScheme com: ConceptSchemeReferenceType A reference to the SDMX Concept Scheme that the mapping is defined for. This is used to create a VtlConceptSchemeMapping. Concept com: ConceptReferenceType A reference to the SDMX Concept that the mapping is defined for. This is used to create a VtlConceptMapping. ToVtlMappingType: ToVtlMappingType defines the mapping method and filter used when mapping from SDMX to VTL.
Attributes:
method?Content:
ToVtlSubSpace?Attribute Documentation:
Name Type Documentation method ToVtlMappingMethodTy pe The mapping method used when mapping from SDMX to VTL. This is typically a StandardToVtlMappingMethodType, but can be any other value to allow for non-standard methods. The implied default is Basic. Element Documentation:
Name Type Documentation ToVtlSubSpace SpaceKeyType Identfies a sub space of the mapped dataflow that the mapping applies to. This is a collection of references to the dimensions that make up the space. FromVtlMappingType: FromVtlMappingType defines the mapping method and filter used when mapping from VTL to SDMX.
Attributes:
method?Content:
FromVtlSuperSpace?Attribute Documentation:
Name Type Documentation method FromVtlMappingMethodType The mapping method used when mapping from VTL to SDMX. This is typically a StandardFromVtlMappingMethodType, but can be any other value to allow for non-standard methods. The implied default is Basic for single-measure VTL data structures and Unpivot for multi-meausre VTL data structures. Element Documentation:
Name Type Documentation FromVtlSuperSpace SpaceKeyType Identfies a super space of the mapped dataflow that the mapping applies to. This is a collection of references to the dimensions that make up the space. SpaceKeyType: SpaceKey defines the structure of a super- or sub- space for a SDMX Dataflow. It is a collection of references to the dimensions that make up the space.
Content:
Key+Element Documentation:
Name Type Documentation Key com: SingleNCNameIDType A reference to a dimension by its identifier. NamePersonalisationSchemeType: NamePersonalisationSchemeType defines a set of personalisations of VTL standard names that are used in a set of transformations.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (extension)
VtlDefinitionSchemeType (restriction)
NamePersonalisationSchemeTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersionContent:
com:Annotations?, com:Name+, com:Description*, NamePersonalisation*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. vtlVersion xs:string Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. NamePersonalisation NamePersonalisationType NamePersonalisation details a name personalisation that is used in a transformation. NamePersonalisationType: NamePersonalisationType defines the structure of a name personalisation. A name personalisation is is used in place of a standard VTL name in some VTL operations.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
UnnestedItemType (extension)
NamePersonalisationTypeAttributes:
id, urn?, uri?, vtlArtefactContent:
com:Annotations?, com:Name+, com:Description*, VtlDefaultName, PersonalisedNameAttribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. vtlArtefact xs:string Identifies the type of VTL model artefact that is being personalised. In VTL 2.0, this is valuedomain or variable. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. VtlDefaultName xs:string Provides the VTL standard name that is being personalised. PersonalisedName xs:string Provides the personalised name that is used in place of the VTL standard name in the transformation expressions. RulesetSchemeBaseType: RulesetSchemeBaseType is an abstract base type for the RulesetSchemeType. It restricts the item types to be only rulesets.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (extension)
VtlDefinitionSchemeType (restriction)
RulesetSchemeBaseTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersionContent:
com:Annotations?, com:Name+, com:Description*, Ruleset*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. vtlVersion xs:string Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Ruleset RulesetType Ruleset details a ruleset within a ruleset scheme. RulesetSchemeType: RulesetSchemeType defines a collection of rulesets that are used in transformations.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (extension)
VtlDefinitionSchemeType (restriction)
RulesetSchemeBaseType (extension)
RulesetSchemeTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersionContent:
com:Annotations?, com:Name+, com:Description*, Ruleset*, VtlMappingScheme?Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. vtlVersion xs:string Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. Ruleset RulesetType Ruleset details a ruleset within a ruleset scheme. VtlMappingScheme com: VtlMappingSchemeReferenceType References a VTL mapping scheme which defines aliases for given SDMX artefacts that are used in the rulesets. Rulesets defined on value domains reference Codelists or Concept Schemes (the latter in VTL are considered as the Value Domains of the variables corresponding to the SDMX Measure Dimensions). The rulesets defined on variables reference Concepts (for which a definite representation is assumed). Therefore, a ruleset should only refer to Codelists, Concept Schemes, and Concepts. RulesetType: RulesetType defines the structure of a ruleset. A ruleset is a persistent set of rules which can be invoked by using appropriate VTL operators.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
UnnestedItemType (extension)
RulesetTypeAttributes:
id, urn?, uri?, rulesetType, rulesetScopeContent:
com:Annotations?, com:Name+, com:Description*, RulesetDefinitionAttribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. rulesetType xs:string The VTL type of the ruleset. In VTL 2.0, this is datapoint or hierarchical rulesetScope xs:string This model artefact on which the ruleset is defined. In VTL 2.0, this is value domain or variable. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. RulesetDefinition xs:string A VTL statement for the definition of a ruleset. This must conform to the syntax of the VTL definition language. UserDefinedOperatorSchemeBaseType: UserDefinedOperatorSchemeBaseType is an abstract base type for the UserDefinedOperatorSchemeType. It restricts the item types to be only user defined operators.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (extension)
VtlDefinitionSchemeType (restriction)
UserDefinedOperatorSchemeBaseTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersionContent:
com:Annotations?, com:Name+, com:Description*, UserDefinedOperator*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. vtlVersion xs:string Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. UserDefinedOperator UserDefinedOperatorType UserDefinedOperator details a user defined operators within a user defined operator scheme. UserDefinedOperatorSchemeType: UserDefinedOperatorSchemeType defines a collection of user defined operators that are used in transformations.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (extension)
VtlDefinitionSchemeType (restriction)
UserDefinedOperatorSchemeBaseType (extension)
UserDefinedOperatorSchemeTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersionContent:
com:Annotations?, com:Name+, com:Description*, UserDefinedOperator*, VtlMappingScheme?, RulesetScheme*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. vtlVersion xs:string Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. UserDefinedOperator UserDefinedOperatorType UserDefinedOperator details a user defined operators within a user defined operator scheme. VtlMappingScheme com: VtlMappingSchemeReferenceType References a VTL mapping scheme which defines aliases for given SDMX artefacts that are used in the user defined operators. Although the VTL user defined operators are conceived to be defined on generic operands, so that the specific artefacts to be manipulated are passed as parameters at the invocation, it is also possible that they reference specific SDMX artefacts like Dataflows, Codelists and ConceptSchemes. In this case, the mapping schemes referenced here define the mappings to those artefacts. RulesetScheme com: RulesetSchemeReferenceType References a ruleset scheme defining rulesets utilized in the user defined operators. UserDefinedOperatorType: UserDefinedOperatorType defines the structure of a user defined operator. A user defined operator is a custom VTL operator (not existing in the standard library) that extends the VTL standard library for specific purposes. In addition to its identification and name, and definition of the operator must be provided.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
UnnestedItemType (extension)
UserDefinedOperatorTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, OperatorDefinitionAttribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. OperatorDefinition xs:string A VTL statement for the definition of a new operator: it specifies the operator name, its parameters and their data types, the VTL expression that defines its behaviour. CustomTypeSchemeType: CustomTypeSchemeType defines a collection of custom types that are used in transformations.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (extension)
VersionableType (restriction)
MaintainableBaseType (extension)
MaintainableType (extension)
ItemSchemeType (extension)
VtlDefinitionSchemeType (restriction)
CustomTypeSchemeTypeAttributes:
id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersionContent:
com:Annotations?, com:Name+, com:Description*, CustomType*Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. version (default: 1.0) com:VersionType This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0. validFrom xs:dateTime The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. validTo xs:dateTime The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. agencyID com: NestedNCNameIDType The agencyID must be provided, and identifies the maintenance agency of the object. isFinal (default: false) xs:boolean The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final. isExternalReference (default: false) xs:boolean The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. serviceURL xs:anyURI The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. structureURL xs:anyURI The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. isPartial (default: false) xs:boolean The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint. vtlVersion xs:string Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. CustomType CustomTypeType CustomType details a custom type within a custom type scheme. CustomTypeType: CustomTypeType defines the structure of a custom type. A custom type specifies a custom conversion for a VTL scalar type to a resulting data type. This conversion overrides the default conversion.
Derivation:
com:AnnotableType (extension)
IdentifiableType (extension)
NameableType (restriction)
ItemBaseType (extension)
ItemType (restriction)
UnnestedItemType (extension)
CustomTypeTypeAttributes:
id, urn?, uri?Content:
com:Annotations?, com:Name+, com:Description*, VtlScalarType, DataType, VtlLiteralFormat?, OutputFormat?, NullValue?Attribute Documentation:
Name Type Documentation id com:IDType The id is the identifier for the object. urn xs:anyURI The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). uri xs:anyURI The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. Element Documentation:
Name Type Documentation com:Annotations com: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. com:Name com:TextType Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. com:Description com:TextType Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. VtlScalarType xs:string Identifies the VTL scalar type that is to be converted to an resulting output data type. DataType CustomTypeDataType Identifies the resulting output data type the VTL scalar type is to be converted to. If this is an SDMX data type, it must use the proper SimpleDataType enumeration value. For all other data types, a string value can be used to identify the type. VtlLiteralFormat xs:string The format in which the literals of the VTL scalar type are expressed in the transformations. This is only needed if the format is different than the output format expressed by means of the VTL type. OutputFormat xs:string The format the VTL scalar type has to assume (e.g. YYYY-MM-DD; see VTL specifications), both for the literals in the VTL expressions and for the conversion to the output. NullValue xs:string The value to be produced in the output of the conversion when a component has a null value. 2.1.4 Simple Types
UsageStatusType: UsageStatusType provides a list of enumerated types for indicating whether reporting a given attribute is mandatory or conditional.
Derived by restriction of xs:NMTOKEN .
Enumerations:
Value Documentation Mandatory Reporting the associated attribute is mandatory - a value must be supplied. Conditional Reporting the associated attribute is not mandatory - a value may be supplied, but is not required. CodeDataType: CodeDataType is a restriction of the basic data types that are applicable to codes. Although some of the higher level time period formats are perimitted, it should be noted that any value which contains time (which includes a time zone offset) is not allowable as a code identifier.
Derived by restriction of com:SimpleDataType .
Enumerations:
Value Documentation String A string datatype corresponding to W3C XML Schema's xs:string datatype. Alpha A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z. AlphaNumeric A string datatype which only allows for the simple alphabetic character set of A-Z, a-z plus the simple numeric character set of 0-9. Numeric A string datatype which only allows for the simple numeric character set of 0-9. This format is not treated as an integer, and therefore can having leading zeros. BigInteger An integer datatype corresponding to W3C XML Schema's xs:integer datatype. Integer An integer datatype corresponding to W3C XML Schema's xs:int datatype. Long A numeric datatype corresponding to W3C XML Schema's xs:long datatype. Short A numeric datatype corresponding to W3C XML Schema's xs:short datatype. Boolean A datatype corresponding to W3C XML Schema's xs:boolean datatype. URI A datatype corresponding to W3C XML Schema's xs:anyURI datatype. Count A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1". InclusiveValueRange This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal. ExclusiveValueRange This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal. Incremental This value indicates that the value increments according to the value provided in the interval facet, and has a true value for the isSequence facet. ObservationalTimePeriod Observational time periods are the superset of all time periods in SDMX. It is the union of the standard time periods (i.e. Gregorian time periods, the reporting time periods, and date time) and a time range. StandardTimePeriod Standard time periods is a superset of distinct time period in SDMX. It is the union of the basic time periods (i.e. the Gregorian time periods and date time) and the reporting time periods. BasicTimePeriod BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time. GregorianTimePeriod Gregorian time periods correspond to calendar periods and are represented in ISO-8601 formats. This is the union of the year, year month, and date formats. GregorianYear A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601. GregorianYearMonth A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601. GregorianDay A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601. ReportingTimePeriod Reporting time periods represent periods of a standard length within a reporting year, where to start of the year (defined as a month and day) must be defined elsewhere or it is assumed to be January 1. This is the union of the reporting year, semester, trimester, quarter, month, week, and day. ReportingYear A reporting year represents a period of 1 year (P1Y) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingYearType. ReportingSemester A reporting semester represents a period of 6 months (P6M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingSemesterType. ReportingTrimester A reporting trimester represents a period of 4 months (P4M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingTrimesterType. ReportingQuarter A reporting quarter represents a period of 3 months (P3M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingQuarterType. ReportingMonth A reporting month represents a period of 1 month (P1M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingMonthType. ReportingWeek A reporting week represents a period of 7 days (P7D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingWeekType. ReportingDay A reporting day represents a period of 1 day (P1D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingDayType. Month A time datatype corresponding to W3C XML Schema's xs:gMonth datatype. MonthDay A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype. Day A time datatype corresponding to W3C XML Schema's xs:gDay datatype. Duration A time datatype corresponding to W3C XML Schema's xs:duration datatype. SimpleCodeDataType: SimpleCodeDataType restricts SimpleDataType to specify the allowable data types for a simple code. The possible values are simply Alpha, AlphaNumeric, or Numeric.
Derived by restriction of com:SimpleDataType .
Enumerations:
Value Documentation Alpha A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z. AlphaNumeric A string datatype which only allows for the simple alphabetic character set of A-Z, a-z plus the simple numeric character set of 0-9. Numeric A string datatype which only allows for the simple numeric character set of 0-9. This format is not treated as an integer, and therefore can having leading zeros. TargetObjectDataType: TargetObjectDataType restricts DataType to specify the allowable data types for representing a target object value.
Derived by restriction of com:DataType .
Enumerations:
Value Documentation KeyValues This value indicates that the content of the component will be data key (a set of dimension references and values for the dimensions). IdentifiableReference This value indicates that the content of the component will be complete reference (either URN or full set of reference fields) to an Identifiable object in the SDMX Information Model. DataSetReference This value indicates that the content of the component will be reference to a data provider, which is actually a formal reference to a data provider and a data set identifier value. AttachmentConstraintReference This value indicates that the content of the component will be reference to an attachment constraint, which is actually a combination of a collection of full or partial key values and a reference to a data set or data structure, usage, or provision agreement. ToValueTypeType: ToValueTypeType provides an enumeration of available text-equivalents for translation of coded values into textual formats.
Derived by restriction of xs:NMTOKEN .
Enumerations:
Value Documentation Value Code or other tokenized value, as provided in the representation scheme. Name The human-readable name of the Value, as provided in the representation scheme. Description The human-readable description of the Value, as provided in the representation scheme. StandardToVtlMappingMethodType: A simple type enumerating the standard mapping methods when converting from data structures from SDMX to VLT.
Derived by restriction of xs:string.
Enumerations:
Value Documentation Basic The default mapping method. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.1 ("Basic Mapping"). Pivot Method for mapping multi-measure data. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.2 ("Pivot Mapping"). Basic-A2M The basic mapping method, using attributes to measures. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.3 ("From SDMX DataAttributes to VTL Measures"). Pivot-A2M The pivot mapping method, using attributes to measures. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.3 ("From SDMX DataAttributes to VTL Measures"). ToVtlMappingMethodType: A simple type that allows for a standard to VTL mapping method enumeration value or a string value for other mapping methods.
Union of:
StandardToVtlMappingMethodType, xs:string.StandardFromVtlMappingMethodType: A simple type enumerating the standard mapping methods when converting from data structures from VTL to SDMX.
Derived by restriction of xs:string .
Enumerations:
Value Documentation Basic The default mapping method, applicable only when the VLT data structure has just one measure component. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.4.1 ("Basic Mapping"). Unpivot The mapping method to be used when the VTL data structure has more than one measure component. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.4.2 ("Unpivot Mapping"). M2A Mapping of multi-measure VTL where on measure is mapped to the SDMX primary measure and the remaining measures are mapped as data attributes. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.4.3 ("From VTL Measures to SDMX DataAttributes"). FromVtlMappingMethodType: A simple type that allows for standard from VTL mapping method enumeration value or a string value for other mapping methods.
Union of:
StandardFromVtlMappingMethodType, xs:string.CustomTypeDataType: A simple type that allows for a SDMX simple data type enumeration value or a string value for other data types.
Union of:
com:SimpleDataType, xs:string.