NotApplicableType is a reusable simple type that allows for not applicable dimension values to be reported. This is required for datasets against a DSD which includes data from Dataflows, which only use a subset of Dimensions as defined by a Dimension Constraint, or for data-related reference metadata attributes that are not attached to all dimensions.
TransformationSchemeBaseType is an abstract base type for the TransformationSchemeType. It restricts the item types to be only transformations.
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.
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.
Is a geographic code in a geographic codelist. It adds a value to a code that folows a pattern to represent a geo feature set.
Urn type for a metadata structure.
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.
StandardTimePeriodType defines the set of standard time periods in SDMX. This includes the reporting time periods and the basic date type (i.e. the calendar time periods and the dateTime format).
CodelistType defines the structure of a codelist. A codelist is defined as a list from which some statistical concepts (coded concepts) take their values.
StructuralRepositoryEventsType details the structural events for the subscription. At least one maintenance agency must be specified, although it may be given a wildcard value (meaning the subscription is for the structural events of all agencies). This can also be a list of agencies to allow the subscription to subscribe the events of more than one agency. It should be noted that when doing so, all of the subsequent objects are assumed to apply to every agency in the list. The subscription is then refined by detailing the structural objects maintained by the agency for which the subscription should apply. It is possible to explicitly select all object events, all objects of given types, or to individually list out specific objects. Note that for any object, it is also possible to provide an explicit URN to reference a distinct object. In this case, the reference to maintenance agency described above is ignored. Although it is not required, if specific objects are being referenced by explicit URNs, it is good practice to list the agencies.
ComponentValueSetType defines the structure for providing values for a data attributes, measures, or metadata attributes. If no values are provided, the component is implied to include/excluded from the region in which it is defined, with no regard to the value of the component. Note that for metadata attributes which occur within other metadata attributes, a nested identifier can be provided. For example, a value of CONTACT.ADDRESS.STREET refers to the metadata attribute with the identifier STREET which exists in the ADDRESS metadata attribute in the CONTACT metadata attribute, which is defined at the root of the report structure.
SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources.
Indicates whether child codes should be selected when the codelist is hierarchical. Possible values are true (include the selected and child codes), false (only include the selected code(s)), and excluderoot (include the children but not the selected code(s)).
TextType provides for a set of language-specific alternates to be provided for any human-readable constructs in the instance.
ItemType is an abstract base type for all items within 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.
URN subscribes to the events of the specific instance of the object type referenced by this URN. Note that when this field is used, the agency information inherited from the structural repository event container is ignored.
MetadataProviderSchemesType describes the structure of the metadata provider schemes container. It contains one or more metadata provider scheme, which can be explicitly detailed or referenced from an external structure document or registry service.
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.
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. 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.
The status attribute carries the status of the query or request.
TextValueType is a restriction of ValueType that allows multiple Text elements to express a text value in multiple languages. The content of this should be restricted in its use to only allow a language code (xml:lang) to be used once within an element of this type.
HierarchicalCodeBaseType is an abstract base type the creates the basis for the HierarchicalCodeType. It removes the urn and uri.
NamePersonalisation details a name personalisation that is used in a transformation.
MissingType is a reusable simple type that allows for missing values to be reported. This is required for attributes and measures to report an intentionally missing value of any other type than double or float.
The SetAttributeGroup defines a common set of attributes for use in data and reference metadata sets.
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.
A reference type for a transformation.
UserDefinedOperatorSchemesType 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.
A simple type enumerating the standard mapping methods when converting from data structures from VTL to SDMX.
NestedIDType is the least restrictive form of an identifier used throughout all SDMX-ML messages. It allows for a hierarchical identifier, with each portion separated by the '.' character. For the identifier portions, valid characters include A-Z, a-z, @, 0-9, _, -, $.
RangeOperatorType provides an enumeration of range operators to be applied to an ordered value.
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.
This refines the prefix, classes, and agency patterns to validate the maintainable ID part of the URN (:<maintainable_id(<version_number>)). Note that it does not restrict the version part as it is intended to be further restricted.
HierarchyType 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.
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.
A reference type for a frequency format mapping.
SingleNCNameIDType restricts the NestedNCNameIDType to allow only one level. Note that this is the same pattern as the NCNameIDType, but can be used when the base type to be restricted is a nested NCNameIDType (where as the NCNameIDType could only restrict the IDType).
QueryType provides an enumeration of values which specify the objects in the result-set for a registry query.
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.
BaseHeaderType in an abstract base type that defines the basis for all message headers. Specific message formats will refine this.
HierarchicalCodelist is used to subscribe to changes of hierarchical code lists. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
KeyFamily is used to subscribe to changes of key families. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
GeoRefCodeType is the abstract base type defining the structure of geographic codes.
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.
TimeDimension is a special dimension which designates the period in time in which the data identified by the full series key applies.
DataProvider describes an organisation that produces data.
SemanticVersionReferenceType is a simple type for referencing semantic version numbers. It allows for the wildcarding of only one the major, minor, or patch version parts using "+".
URI holds an information URL for the contact person.
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.
Output references an object which is an output form the process step.
AlphaType is a reusable simple type that allows for only mixed-case alphabetical characters. This is derived from the AlphaNumericType.
Urn type for a provision agreement.
The validFrom attribute indicates the point in time in which the hierarchical code became effective. This can be used to track the historicity of codes changing over time.
MetadataStructureDefinitionReference subscribes to all metadata registration events for the metadata structure definitions referenced by this object. This may reference one or more metadata structure definitions, as the specific references fields allow for a wild-carded value.
A reference type for a representation map.
LevelBaseType is an abstract base type that makes up the basis for the LevelType. It requires a name and id.
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 hierarchical 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.
The indexReportingPeriod, if true, indicates that the registry must index the time period ranges for which data is present for the data source. The default value is false, and the attribute will always be assumed false when the provision agreement references a metadata flow.
ConceptSchemesType describes the structure of the concept schemes container. It contains one or more concept schemes, which can be explicitly detailed or referenced from an external structure document or registry service.
ValueListType defines the structure of value list. These represent a closed set of values the can occur for a dimension, measure, or attribute. These may be values, or values with names and descriptions (similar to a codelist).
ResolvePeriodType defines an enumeration of how date periods should be resolved.
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.
This refines the prefix to make specific restrictions of package and class values. Note that only one of the patterns must match. It is intended to be further restricted.
The lastUpdated attribute provides a timestamp for the last time the data source was updated.
A reference type for a data constraint.
EmptyType is an empty complex type for elements where the presence of the tag indicates all that is necessary.
ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages.
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.
TransformationBaseType defines the base refinement of the TransformationType. Its purpose is to restrict the urn attribute.
Reporting Quarter Or Not Applicable Type
A reference type for a category scheme map.
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 data structure A to C and a map from data structure B to C could be used to infer a relation between data structure A to C.
GeoGridCodelistBaseType is the abstract base refinement for a geographic grid codelist.
DataStructureType is an abstract base type the forms the basis for the structural information for a data set.
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.
NameAliasScheme is used to subscribe to changes of a name alias scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
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 is also one reserved identifier in a data structure definition, TIME_PERIOD. This identifier may not be used outside of its definition, TimeDimension. 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.
UserDefinedOperatorSchemes 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.
Metadataflow provides a reference to a pre-existing metadataflow in the registry. The reference is provided via a URN and/or a full set of reference fields.
AlphaNumericType is a reusable simple type that allows for only mixed-case alphabetical and numeric characters.
Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata.
Indicates if 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.
A simple type enumerating the standard mapping methods when converting from data structures from SDMX to VLT.
MetadataRegistrationEvents details the metadata registration events for the subscription.
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.
StructureMap provides the details or a structure map, which describes mapping between data structures or dataflows.
ReportingTaxonomyMap provides the details of a reporting taxonomy map, which describes mappings between reporting taxonomies.
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.
The startTime attributes contains the inclusive start date for the reference period.
StructureLocation provides the location of a SDMX-ML Structure message, external to the repository that can be retrieved by the repository submission service.
OrganisationUnitSchemes contains a collection of organisation unit scheme descriptions. The organisation unit schemes may be detailed in full, or referenced from an external structure document or registry service.
Key contains a set of dimension values which identify a full set of data.
NestedNCNameIDType restricts the NestedIDType, so that the id may be used to generate valid XML components. IDs created from this type conform to the W3C XML Schema NCNAME type, and therefore can be used as element or attribute names.
NotifyRegistryEvent is sent by the registry services to subscribers, to notify them of specific registration and change events. Basic information about the event, such as the object that triggered it, the time of the event, the action that took place, and the subscription that triggered the notification are always sent. Optionally, the details of the changed object may also be provided.
HierarchyAssociation provides the details of a hierarchy association, which associates a hierarchy with an identifiable object in the context of another object.
EventTime specifies the time of the triggering event.
ProvisionAgreementBaseType defines the base refinement of the ProvisionAgreementType. Its purpose is to retrict the urn attribute.
CustomType details a custom type within a custom type scheme.
The SetAttributeGroup defines a common set of attributes pertaining to any data set. The attributes are qualified, so that they will be easily distinguished from attributes that are specific to the data structure. Note that many of these attributes are duplications of fields available in the header of the data messages. The reason for this is to allow the header values to be overridden at the data set level when a message contains more than one data set. If an attribute here does not have a value, then the value from the header is applied to the data set.
MetadataProvisionAgreementsType describes the structure of the metadata provision agreements container. It contains one or more metadata provision agreement, which can be explicitly detailed or referenced from an external structure document or registry service.
GeoGridCodeType defines the structure of a geographic grid cell.
SubmissionResult provides a status for each submitted structural object.
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.
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.
MetadataConstraintsType describes the structure of the metadata constraints container. It contains one or more metadata 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.
Email holds the email address for the contact person.
Gregorian Time Period Or Not Applicable Type
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 is never versioned. 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.
Selection of codes from the referenced (extended) codelist to be excluded in the extending codelist.
ConstraintBaseType is an abstract base type that forms the basis of the main abstract ConstraintType. It requires that a name be provided.
A reference type for an organisation unit scheme.
MaintainableType is an abstract base type for all maintainable objects.
HierarchyAssociationType defines the structure of a hierarchy association, which links a hierarchy with and identifiable object in the context of another object (e.g. a dimension within the context of a dataflow).
A reference type for a reporting category.
AnnotableType is an abstract base type used for all annotable artefacts. Any type that provides for annotations should extend this type.
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.
ContentConstraint is used to subscribe to changes of content constraints. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
A reference type for a metadata provider scheme.
SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, concepts and concept schemes, code lists, etc.) to be submitted may be communicated in-line or be supplied in a referenced SDMX-ML Structure messages external to the registry. A response will indicate status and contain any relevant error information.
BaseOrganisationType is an abstract base type the forms the basis for the OrganisationType.
UserDefinedOperatorSchemeType defines a collection of user defined operators that are used in transformations.
Specifies the fixed list of Dimensions (by ID) to which a Dataflow may be constrained. This is a required property if the DataStructure defines itself as an evolving structure, indicating that it can change dimensionality under a minor version change, and if the Dataflow references that DataStructure using a wildcarded minor version number. New minor DSD version can so still be used by this Dataflow even if that DSD version defines new additional dimensions. Dimensions not listed should not be used in Datasets for this Dataflow. The Time Dimension is not to be listed, as it is always to be used when defined in the DSD, and it cannot be added to a DSD without increasing its major version.
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.
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.
StructuralRepositoryEvents details structural events for the subscription.
AgencyType defines the structure of an agency description. The contacts defined for the organisation are specific to the agency role the organisation is serving.
SubmitStructureResponse is returned by the registry when a structure submission request is received. It indicates the status of the submission, and carries any error messages which are generated, if relevant.
StatusType provides an enumeration of values that detail the status of queries or requests.
MetadataStructureComponentsBaseType is an abstract base type that forms the basis for the MetadataStructureComponentsType.
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.
SimpleComponentTextFormatType is a restricted version of the BasicComponentTextFormatType that does not allow for multi-lingual values.
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.
GeoFeatureSetCodeType defines the structure of a geographic code.
XHTMLType allows for mixed content of text and XHTML tags. When using this type, one will have to provide a reference to the XHTML schema, since the processing of the tags within this type is strict, meaning that they are validated against the XHTML schema provided.
SubscriptionType describes the details of a subscription to a registration or change event for registry resources. When it occurs as the content of a response message, the registry URN must be provided, unless the response is a failure notification for the creation of a new subscription.
MaintainableEventType provides a reference to a maintainable object's event with either the URN of the specific object, or a set of potentially wild-carded reference fields.
NestedIDQueryType is a simple type that allows for a nested identifier to be substituted with a wild card character ("%").
DataConstraintAttachmentType restricts the base ConstraintAttachmentType to only allow artefacts related to data.
ContactType provides defines the contact information about a party.
The structureID attribute uniquely identifies the structure for the purpose of referencing it from the payload. This is only used in structure specific formats. Although it is required, it is only useful when more than one data set is present in the message.
StatusMessageType carries the text of error messages and/or warnings in response to queries or requests.
Version subscribes to the events of the specific instance of the object type where the value provided in the id field matches the id of the object and the value here matches the version of the object. The default value is the wildcard character("%"). Note that in addition to being wild-carded, this can also be bound to the latest version of the object with the late-bound character("*").
The target value(s) is always an absolute string. However, if source value is a regular expression, the target value can output the capture group from the source.
Reporting Trimester Or Not Applicable Type
StructureMapsType describes the structure of the structure maps container. It contains one or more structure maps, which can be explicitly detailed or referenced from an external structure document or registry service.
Datasource identifies the data source(s) where the registered data can be retrieved.
ReportingTaxonomyMapType defines the structure of a map which identifies relationships between reporting categories in different reporting taxonomies.
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.
MessageType is an abstract type which is used by all of the messages, to allow inheritance of common features. Every message consists of a mandatory header, followed by optional payload (which may occur multiple times), and finally an optional footer section for conveying error, warning, and informational messages.
The localID attribute is an optional identification for the computation within the process.
Provides the VTL standard name that is being personalised.
MetadataStructureComponentsType describes the structure of the grouping of the sets of the components that make up the metadata structure definition.
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).
ErrorType describes the structure of an error response.
DataConstraint specifies the allowed content for a set of data.
Urn type for a measure descriptor.
ReportingCategoryType describes the structure of a reporting category, which groups structure usages into useful sub-packages. Subordinate reporting categories can be nested within the category definition.
SubscriberAssignedID is the id assigned by the subscriber to the subscription. If it existed in the subscription request, it will be returned.
MetadataConstraints contains a collection of metadata constraint descriptions. The constraints may be detailed in full, or referenced from an external structure document or registry service.
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.
AvailabilityConstraintType defines the structure of an availability constraint. This type of constraint contains the actual data currently present for the referenced object and is used to express data availability either by listing the available sets of keys (DataKeySet) or a set of component values (CubeRegion), e.g., in a data source. Availability constraints should not be (semantically) versioned.
SimpleValueType contains a simple value for a component, and if that value is from a code list, the ability to indicate that child codes in a simple hierarchy are part of the value set of the component for the region.
CodelistsType describes the structure of the codelists container. It contains one or more codelist, which can be explicitly detailed or referenced from an external structure document or registry service.
OrganisationUnitScheme provides the details of an organisation unit scheme, in which organisation units are described.
The TIME_PERIOD attribute is an explicit attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.
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 is never versioned. 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.
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.
StringValueType is a refinement of SimpleValueType limiting the content to be a string. This can be further refined with facets, patterns, etc.
QueryRegistrationRequestType describes the structure of a registration query request. The type of query (data, reference metadata, or both) must be specified. It is possible to query for registrations for a particular provision agreement, data provider, or structure usage, or to query for all registrations in the registry. In addition the search can be refined by providing constraints in the form of explicit time periods, constraint regions, and key sets. When constraint regions and key sets are provided they will be effectively processed by first matching all data for the included keys and regions (all available data if there are none) and then removing any data matching the excluded keys or regions.
The type attribute reference the identifier of the group as defined in the data structure definition. This is optional, but derived group types will provide a fixed value for this so that it always available in the post validation information set. This allows the group to be processed in a generic manner.
StructuralEventType provides the details of a structure event, specifically the object that changed.
ConceptSchemes contains a collection of concept scheme descriptions. The concept schemes described are contained within schemes. The concepts may be detailed in full, or referenced from an external structure document or registry service.
Obs is an un-grouped observation. This observation has a key which is a set of values for all dimensions declared in the data structure definition. In addition to the key, the value of the observation can be provided along with values for all data and metadata attributes which have an association with the observation or any dimension (so long as it does not specify a group attachment).
A reference type for a group dimension descriptor.
Group Dimension Descriptor Reference Type
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.
A reference type for an organisation scheme map.
AllEvents subscribes to all data registration events in the repository.
MetadataAttributeRepresentationType defines the possible local representations of a metadata attribute.
Urn type for a name personalisation scheme.
MetadataAttributeReference is a local reference to a metadata attribute defined in the metadata structure referenced by this data structure.
MessageText contains the text of the error and/or warning message. It can occur multiple times to communicate message for multiple warnings or errors.
IdentifiableQueryType describes the structure of a query for an identifiable object.
Urn type for a concept scheme map.
OccurenceType is used to express the maximum occurrence of an object. It combines an integer, equal or greater than 1, and the literal text, "unbounded", for objects which have no upper limit on its occurrence.
KeyFamilyReference subscribes to all data registration events for the key families referenced by this object. This may reference one or more key families, as the specific references fields allow for a wild-carded value.
The softwarePackage attribute holds the name of the software package that is used to perform the computation.
ValueMappingType defines a mapping of multiple sources to multiple targets.
MeasureType defines the structure of a measure descriptor. In addition to the identifying concept and representation, a usage status and max occurs can be defined.
Urn type for a VTL mapping scheme.
A reference type for an agency scheme.
AttributeListType describes the attribute descriptor for the data structure definition.
ValueLists contains a collection of value list descriptions. The value lists may be detailed in full, or referenced from an external structure document or registry service.
SubscriptionStatusType describes the structure a status for a single subscription request.
TransformationType defines the structure of a transformation. A transformation is an assignment of a VTL expression to a specific result.
ReportingDayType defines a time period of 1 day (P1D) in relation to a reporting year which has a start day (day-month) specified in the specialized reporting year start day attribute. In the absence of a start day for the reporting year, a day of January 1 is assumed. The format of a reporting day is YYYY-Dddd (e.g. 2000-D001), where ddd is a three-digit day (i.e. 001-366).
Urn type for an organisation unit.
GeoGridCodelistType defines the structure of a geographic grid code list. These define a geographical grid composed of cells representing regular squared portions of the Earth.
A reference type for a data provider.
The isSOAP attribute, if true, indicates the provided URL expects the notification to be sent in a SOAP message.
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.
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.
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.
BeforePeriod is the period before which the period is meant to cover. This date may be inclusive or exclusive in the range.
RangeValidLeapYearType is a derivation of the RangeValidMonthDayType which validates that a date of February 29 occurs in a valid leap year (i.e. if the year is divisible 4 and not by 100, unless it is also divisible by 400). This type is meant to be derived from for further validation.
CodelistExtensionType defines the structure of a codelist to be extended by the codelist defining the extension. It provides a reference to the extended codelist and selection criteria to indicate the codes to be included in the extending codelist.
The url of the object being linked.
FooterType describes the structure of a message footer. The footer is used to convey any error, information, or warning messages. This is to be used when the message has payload, but also needs to communicate additional information. If an error occurs and no payload is generated, an Error message should be returned.
VersionQueryType is a simple type that allows for a version number to be substituted with a wild card character ("%") or a late bound character ("*").
ObservationalTimePeriodValueType is a refinement of SimpleValueType limiting the content to be an observational time period.
StructureHeaderType defines the structure for structural metadata messages.
AnnotationType provides for non-documentation notes and annotations to be embedded in data and structure messages. It provides optional fields for providing a title, a type description, a URI, and the text of the annotation.
ResultType contains the details about a data or metadata source, through the complete registration information. In addition, a reference to the content constraints for the data source may be provided, if the query requested this information.
A reference type for any type of organisation.
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".
MetadataConstraint specifies a subset of the definition of the allowable content of a metadata set.
A reference type for a metadata constraint.
MetadataAttributeList defines the 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 metadata 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.
GeographicCodelistType defines the structure of a geographic codelist. It comprises a set of GeoFeatureSetCodes, by adding a value in the Code that follows a pattern to represent a geo feature set.
Indicates the point in time to resolve to when mapping from low frequency periods to higher frequency periods.
Range Valid Time Zone Or Not Applicable Type
The indexAttributes, if true, indicates that the registry must index the range of actual (present) values for each attribute of the data set or the presence of the metadata attributes of the metadata set (as indicated in the set's structure definition). The default value is false.
GenericMetadataType defines the contents of a generic metadata message.
An enumeration of optional | mandatory to indicate the usage of an attribute or measure.
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.
The locale on which the input will be parsed according to the pattern.
QuerySubscriptionResponseType describes the structure of a subscription query response. A status will describe the success or failure of the request (and provide error or warning messages if necessary). If the query was successful, details of all of the organisation's subscriptions will be provided.
A reference type for a custom type.
Value holds any simple value (enumerated or not) for the metadata attribute.
Observational Time Period Or Not Applicable Type
Transformation describes the details of a single transformation within a transformation scheme.
UserDefinedOperator details a user defined operators within a user defined operator scheme.
TimeDimensionRepresentationType defines the representation for the time dimension. Enumerated values are not allowed.
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.
EventAction indicates the nature of the event - whether the action was an addition, a modification, or a deletion.
VersionReferenceType defines the structure of version number in a reference. When semantic versioning is used, the major, minor, or patch version parts can be wildcarded using "+" as an extension. For example, 2+.3.1 means the currently latest available version >= 2.3.1 (even if not backwards compatible). Note that wildcarded semantic version references cannot be combined with version extended reference (e.g. 2.3+.1-draft is not permissible). Version-extended (e.g. 1.3.1-draft) and legacy version numbers (e.g. 1 or 1.0) are also supported.
BasicTimePeriodType contains the basic dates and calendar periods. It is a combination of the Gregorian time periods and the date time type.
ObsType is the abstract type which defines the structure of a grouped or un-grouped observation. The observation must be provided a key, which is either a value for the dimension which is declared to be at the observation level if the observation is grouped, or a full set of values for all dimensions in the data structure definition if the observation is un-grouped. This key should disambiguate the observation within the context in which it is defined (e.g. there should not be another observation with the same dimension value in a series). The observation can contain an observed value and/or attribute values. Data structure definition schemas will derive a type or types based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. The dimension value(s) which make up the key and the data and metadata attribute values associated with the key dimension(s) or the primary measure will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived observation type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attribute(s) will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived observation type be for the observation dimension(s) and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.
FooterMessageType defines the structure of a message that is contained in the footer of a message. It is a status message that have a severity code of Error, Information, or Warning added to it.
ReportingQuarterType defines a time period of 3 months (P3M) in relation to a reporting year which has a start day (day-month) specified in the specialized reporting year start day attribute. In the absence of a start day for the reporting year, a day of January 1 is assumed. The format of a reporting quarter is YYYY-Qq (e.g. 2000-Q1), where q is a value between 1 and 4.
Error is used to communicate that an error has occurred when responding to a request in an non-registry environment. The content will be a collection of error messages.
A reference type for a measure descriptor.
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.
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.
GeoGridCode is a code the represents a geographic grid cell that belongs to a specific grid definition.
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.
Concept describes the details of a concept within a concept scheme.
RulesetSchemeBaseType is an abstract base type for the RulesetSchemeType. It restricts the item types to be only rulesets.
Associates the Identifiable Artefact that needs the Hierarchy.
The validTo attribute indicates the point in time in which the hierarchical code became no longer effective. This can be used to track the historicity of codes changing over time.
HierarchyBaseType is an abstract base class that is the basis for the HierarchyType. It requires that a name be supplied.
The value to be produced in the output of the conversion when a component has a null value.
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.
GroupType is the abstract type which defines a structure which is used to communicate attribute values for a group defined in a data structure definition. The group can consist of either a subset of the dimensions defined by the data structure definition, or an association to an attachment constraint, which in turn defines key sets to which attributes can be attached. In the case that the group is based on an attachment constraint, only the identification of group is provided. It is expected that a system which is processing this will relate that identifier to the key sets defined in the constraint and apply the values provided for the attributes appropriately. Data structure definition schemas will drive types based on this for each group defined in the data structure definition. Both the dimension values which make up the key (if applicable) and the attribute values associated with the group will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived group type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the group dimensions and data or metadata attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.
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.
ReportingMonthType defines a time period of 1 month (P1M) in relation to a reporting year which has a start day (day-month) specified in the specialized reporting year start day attribute. In the absence of a start day for the reporting year, a day of January 1 is assumed. In this case a reporting month will coincide with a calendar month. The format of a reporting month is YYYY-Mmm (e.g. 2000-M01), where mm is a two-digit month (i.e. 01-12).
CustomTypeBaseType defines the base refinement of the CustomTypeType. Its purpose is to restrict the urn attribute.
ReportingCategoryBaseType is an abstract base type that serves as the basis for the ReportingCategoryType.
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.
UserDefinedOperatorBaseType defines the base refinement of the UserDefinedOperatorType. Its purpose is to restrict the urn attribute.
MetadataAttributeListType describes the structure of a meta data attribute list. It comprises a set of metadata attributes that can be defined as a hierarchy.
SentinelValueType defines the structure of a sentinel value. A sentinel is a value that has a special meaning within the text format representation of a component. The value is associated with a multi-lingual name and description.
Registration provides the changed details of the data or metadata registration.
HiearchyAssociationsType describes the structure of the hierarchy associations container. It contains one or more hiearchy associations, which can be explicitly detailed or referenced from an external structure document or registry service.
FrequencyFormatMappingBaseType defines the base refinement of the FrequencyFormatMappingType. Its purpose is to restrict the urn attribute.
The completes the refinement of the prefix, classes, agency, maintainable id, and version number patterns to validate the last, and optional, nested component part of a wildcarded URN reference (e.g. (<version_number>)<containerobject-id>.<object-id>*). The nested patterns provide a complete validation of the URN pattern.
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.
CustomTypeSchemeType defines a collection of custom types that are used in transformations.
DataConsumer describes an organisation using data as input for further processing.
MetadataConstraintType defines the structure of a metadata constraint. A metadata constraint can specify allowed attribute values for metadata described by the constrained artefact.
TimeOperatorType derives from the OrderedOperatorType to remove the notEqual operator.
Identifies 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.
SubmittedStructure provides a reference to the submitted structural object and echoes back the action requested for it.
BaseDimensionType is an abstract base type which defines the basic structure of all dimensions.
A reference type for a metadata set.
If “true”, this indicates a hierarchy where the structure is arranged in levels of detail from the broadest to the most detailed level. If “false”, this indicates a hierarchy structure where the items in the hierarchy have no formal level structure.
Urn type for a frequency format mapping.
MetadataTargetRegionType defines the structure of a metadata target region. A metadata target region must define the report structure and the metadata target from that structure on which the region is based. This type is based on the abstract RegionType and simply refines the key and attribute values to conform with what is applicable for target objects and metadata attributes, respectively. See the documentation of the base type for more details on how a region is defined.
The id attribute identifies the metadata attribute that the value is being reported for.
RegistryURN is used to identify the subscription in the case of deletion or modification. This should be provided in all response messages, unless the response it a notification of the failure to create a newly submitted subscription - in which case there will be no registry assigned URN.
CategorySchemeMapsType describes the structure of the category scheme maps container. It contains one or more category scheme map, which can be explicitly detailed or referenced from an external structure document or registry service.
AgencyID specifies a maintenance agency for the object or objects indicated in the other fields. This can be either a specific ID, or a single wildcard character ("%"). A wild card character can be used to select all agencies, allowing a subscription to all events for particular object types. This can occur multiple times to list a of group of maintenance agencies, creating event subscriptions for all of the subsequent objects for each agency in the group. Note that if multiple agencies are supplied, then the wildcard character should not be used for any of them.
DataProviderSchemesType describes the structure of the data provider schemes container. It contains one or more data provider scheme, which can be explicitly detailed or referenced from an external structure document or registry service.
A reference type for a data consumer scheme.
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.
ConceptSchemeMapType defines the structure of a map which identifies relationships between concepts in different concept schemes.
BaseReportPeriodType is a simple type which frames the general pattern of a reporting period for validation purposes. This regular expression is only a general validation which is meant to validate the following structure [year]-[period][time zone]?. This type is meant to be derived from for further validation.
RegistrationStatusType describes the structure of a registration status.
GeoGridCodelistsType describes the structure of the codelists container. It contains one or more geographic grid codelist, which can be explicitly detailed or referenced from an external structure document or registry service.
Restricts the URN reference so that the pattern ends after the version part.
The maxOccurs attribute indicates the maximum number of times this metadata attribute can occur within its parent object.
A reference type for a data structure.
Fax holds the fax number for the contact person.
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.
A reference type for a structure.
CubeRegionKeyType is a type for providing a set of values for a dimension for the purpose of defining a data cube region. A set of distinct value can be provided, or if this dimension is represented as time, and time range can be specified.
IDType provides a type which is used for restricting the characters in codes and IDs throughout all SDMX-ML messages. Valid characters include A-Z, a-z, @, 0-9, _, -, $.
Urn type for a metadata attribute.
TransformationSchemesType 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.
This provides the details of a data or metadata registration event for the purposes of notification.
SeriesType is the abstract type which defines a structure which is used to group a collection of observations which have a key in common. The key for a series is every dimension defined in the data structure definition, save the dimension declared to be at the observation level for this data set. In addition to observations, values can be provided for data and metadata attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have an relationship with the observation dimension). It is possible for the series to contain only observations or only attribute values, or both. Data structure definition schemas will derive a type based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. Both the dimension values which make up the key and the attribute values associated with the key dimensions will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived series type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the series dimensions and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.
RegionType is an abstract type which defines a generic constraint region. This type can be refined to define regions for data or metadata sets. A region is defined by a collection of key values - each of which a collection of values for a component which disambiguates data (i.e. dimensions of a dataset). For each region, a collection of attribute values can be provided. Taken together, the key values and attributes serve to identify or describe a subset of a data or metadata set. Finally, the region can be flagged as being included or excluded, although this flag only makes sense when the region is used in a particular context.
Urn type for a reporting taxonomy.
A reference type for a name personalisation scheme.
Name Personalisation Scheme Reference Type
QueryRegistrationResponse is sent as a response to any query of the contents of a registry. The result set contains a set of links to data and/or metadata If the result set is null, or there is some other problem with the query, then appropriate error messages and statuses will be returned.
StructureMaps contains a collection of structure map descriptions. The structure maps may be detailed in full, or referenced from an external structure document or registry service.
VersionType is used to communicate version information. Semantic versioning, based on 3 or 4 version parts (major.minor.patch[-extension]) is supported. The legacy SDMX version format is also supported.
Timezone specifies the time zone of the sender, and if specified can be applied to all un-time zoned time values in the message. In the absence of this, any dates without time zone are implied to be in an indeterminate "local time".
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.
EpochPeriodType defines an enumeration of epoch period types.
WildcardType is a single value code list, used to include the '*' character - indicating that the identification component is wildcarded.
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.
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.
MetadataType describes the structure for reference metadata associated with datasets, groups, series or observations.
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.
StartDate is an inclusive start date for the subscription.
GeographicCodelists contains a collection of geographic codelist descriptions. The codelists may be detailed in full, or referenced from an external structure document or registry service.
NotificationMailTo holds an e-mail address (the "mailto:" protocol). Multiple email address can be notified for a single subscription.
BasicComponentTextFormatType is a restricted version of the TextFormatType that restricts the text type to the representations allowed for all components except for target objects.
Metadataflow provides a reference to the.
Provides a union type of xs:date and xs:dateTime for the header fields in the message.
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.
MeasureBaseType is an abstract base type that refines ComponentType to restrict the representations to those which are applicable for a measure.
QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.
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.
StructureSpecificDataType defines the structure of the structure specific data message. Note that the data set payload type is abstract, and therefore it will have to be assigned a type in an instance. This type must be derived from the base type referenced. This base type defines a general structure which can be followed to allow for generic processing of the data even if the exact details of the data structure specific format are not known.
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).
QueryableDataSourceType describes a data source which is accepts a standard SDMX Query message and responds appropriately.
SubmittedStructureType generally references a submitted structural object. When used in a submit structure request, its purpose is to override the default action or external dependency resolution behaviour. If neither of these indicators are set, then it will be ignored. In a submit structure response, it is used to reference a submitted object for the purpose of providing a status for the submission. In this case, the action attribute should be populated in order to echo the requested action.
CategorisationBaseType defines the base refinement of the CategorisationType. Its purpose is to restrict the urn attribute.
AgencyScheme provides the details of an agency scheme, in which agencies are described.
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 must be defined.
A reference type for a metadata provider.
HierarchyAssociationBaseType defines the base refinement of the HierarchyAssociationType. Its purpose is to restrict the urn attribute.
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.
ConstraintType is an abstract base type that specific types of constraints (data and metadata) restrict and extend to describe their details.
SimpleDataStructureRepresentationType defines the representation for any non-time dimension data structure definition component.
Simple Data Structure Representation Type
Description is a reusable element, used for providing a longer human-readable description of an object.
HierarchicalCode is used to nest referenced codes into a value based hierarchy.
AvailabilityConstraint specifies the available content for a set of data.
RegistrationStatus provided the status details for the submitted registration. It echoes the original submission and provides status information about the request.
RulesetType defines the structure of a ruleset. A ruleset is a persistent set of rules which can be invoked by using appropriate VTL operators.
MeasureRelationship identifies the measures that the attribute applies to. If this is not used, the attribute is assumed to apply to all measures.
All subscribes to the events all instances of the containing object meeting the other criteria specified.
MetadataConstraintAttachmentType restricts the base ConstraintAttachmentType to only allow artefacts related to metadata.
A reference type for a custom type scheme.
RegistrationRequestType describes the structure of a single registration request. It contains the details of a registation and an action field to indicate the action to be taken on the contained registration.
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.
Urn type for a name personalisation.
DataConsmerScheme is used to subscribe to changes of data consumer schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
NotificationHTTP holds an http address to which notifications can be addressed as POSTs. Multiple http address may be notified for a single subscription event.
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.
SubmitStructureRequestType defines the structure of a registry submit structure request document.
X400 holds the X.400 address for the contact person.
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.
SubmitSubscriptionsRequestType defines the payload of a request message used to submit additions, updates, or deletions of subscriptions. Subscriptions are submitted to the registry to subscribe to registration and change events for specific registry resources.
ProvisionAgreementType describes the structure of a provision agreement. A provision agreement defines an agreement for a data provider to report data against a dataflow. Attributes which describe how the registry must behave when data or metadata is registered against this provision agreement are supplied.
MeasureRepresentationType defines the representation for a measure. A measure can be text (including XHTML and multi-lingual values), a simple value, or an enumerated value.
TextSearchOperatorType provides an enumeration of text search operators.
ValidityPeriodType specifies inclusive start and end-dates for the subscription period.
DataTypeType provides an enumerated list of the types of data formats allowed as the for the representation of an object.
A reference type for a ruleset scheme.
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.
AnnotationText holds a language-specific string containing the text of the annotation.
RegistrationEvent is used to provide the details or the registration object that has changed.
GroupDimensionBaseType is an abstract base type which refines the base ComponentType in order to form the basis for the GroupDimensionType.
A reference type for a hierarchy.
DataConstraintsType describes the structure of the container for data constraints.
VersionableQueryType describes the structure of a query for a versionable object.
ProcessStepBaseType is an abstract base type used as the basis for the ProcessStepType.
GeoGridCodelist provides the details of a geographic grid code list, which comprises a set of GridCodes, which are related to the gridDefinition specified in the GeoGridCodelist.
Measure defines the structure of a measure, which is the concept that is the value of the phenomenon to be measured in a data set.
Provides the ability to map source to target date formats. The source date is described as the number of epochs since a point in time, where the duration of each epoch is defined, e.g. number of milliseconds since 1970.
ConstraintAttachment describes the Constrainable structure the availability information is for
QueryType defines the type of sets (data, metadata, or both) that are being queried for.
Attribute describes the definition of a data attribute, which is defined as a characteristic of an object or entity.
ReportingTrimesterType defines a time period of 4 months (P4M) in relation to a reporting year which has a start day (day-month) specified in the specialized reporting year start day attribute. In the absence of a start day for the reporting year, a day of January 1 is assumed. The format of a reporting trimester is YYYY-Tt (e.g. 2000-T1), where s is either 1, 2, or 3.
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.
A reference type for a metadata attribute.
QueryableDataSourceType describes a queryable data source, and add a fixed attribute for ensuring only one queryable source can be provided.
The isInclusive attribute, when true, indicates that the time period specified is included in the range.
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.
Ref provides a reference to potentially many objects through the use of possible wild-carded reference fields.
This restricts the prefix and classes patterns to validate the agency part of the URN (=<agency_id>:).
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.
GenericMetadata contains reported metadata in a format which supports any metadata structure definition.
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
MetadataStructureType is an abstract base type the forms the basis of the structural information for any metadata message. A reference to the metadata structure definition or a metadataflow must be provided. This can be used to determine the structure of the message.
Atts contains a set of data or metadata attribute values with an attachment level of none (i.e. data set level) or reported against a partial set of dimension values.
Reporting Time Period Or Not Applicable Type
MetadataProviderType defines the structure of a metadata provider description. The contacts defined for the organisation are specific to the metadata provider role the organisation is serving.
The returnConstraints attribute determines whether information about the constraints on the data or metadata sets returned should also be sent the results.
Urn type for a representation map.
The isIncluded attribute indicates whether the keys defined in this key set are inclusive or exclusive to the constraint.
DataRegistrationEventsType details the data registration events for the subscription. It is possible to subscribe to all data registration events in the repository, or specific events for; single registrations, provision agreements, data providers, data flows, key families, and categories that categorize data flows or key families.
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.
EpochMapBaseType defines the base refinement of the EpochMapType. Its purpose is to restrict the urn attribute.
StructureMapBaseType defines the base refinement of the StructureMapType. Its purpose is to restrict the urn attribute.
Ruleset details a ruleset within a ruleset scheme.
RangeValidTimeType is a derivation of the RangeValidLeapYearType which validates that the time (if provided) is validly formatted. The base type will have provided basic validation already. The patterns below validate that the time falls between 00:00:00 and 24:00:00. Note that as the XML dateTime type does, seconds are required. It is also permissible to have fractions of seconds, but only within the boundaries of the range specified. This type is meant to be derived from for further validation.
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.
MetadataAttributeUsageType defines the structure of how a metadata attribute is used in a data structure. This is a local reference to a metadata attribute from the metadata structure referenced by the data structure. An attribute relationship can be defined in order to describe the relationship of the metadata attribute to the data structure components.
GeoRefCode is the abstract base from which specific types of geographic codes will be derived.
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.
GroupBaseType is an abstract base type that forms the basis for the GroupType.
ObsDimensionsCodeType is an enumeration containing the values "TimeDimension" and "AllDimensions"
A VTL statement for the definition of a ruleset. This must conform to the syntax of the VTL definition language.
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.
The value used to assign the Code to one cell in the grid.
VtlMappingSchemesType 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.
DataProviderScheme provides the details of a data provider scheme, in which data providers are described.
A reference type for a provision agreement.
AvailabilityConstraints contains a collection of availability constraints. The constraints may be detailed in full, or referenced from an external structure document or registry service.
The usage attribute indicates whether an attribute value must be available for any corresponding existing observation.
A reference type for a concept scheme map.
The minOccurs attribute indicates the minimum number of times this metadata attribute must occur within its parent object.
SubmitStructureResponseType defines the structure of a registry submit registration response document.
CodelistExtension allows for the extension of codelists by referencing the codelists to be extended and providing inclusion/exclusion rules for selecting the codes to extend. The order of these is important as it is indicates the order of precedence of the extended codelists for conflict resolution of codes. However, the prefix property can be used to ensure uniqueness of inherited codes in the extending codelist, in case conflicting codes must be included.
TYPE is a fixed attribute that is used to ensure only of each event selector may be provided, when it is referenced in a uniqueness constraint.
CategorySchemeMapType defines the structure of a map which identifies relationships between categories in different category schemes.
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.
UnnestedItemType is an abstract base type for all items within an item scheme that do not contain nested items.
NamePersonalisationSchemesType 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.
QueryResult contains a result for a successful registration query. It can occur multiple times, for each registration the meets the conditions specified in the query.
ValueItemType defines the structure of a value item. A value must be provided, and a longer name and description can be provided to provide additional meaning to the value (similar to a code in a code list).
QueryResultType describes the structure of a query result for a single data source. Either a data result or metadata result is detailed, depending on the data source.
SubmitStructureRequestType describes the structure of a structure submission. Structural components are provided either in-line or referenced via a SDMX-ML Structure message external to the registry. A default action and external reference resolution action are all provided for each of the contained components, but can be overridden on a per component basis.
ConceptSchemeMapsType describes the structure of the concept scheme maps container. It contains one or more concept scheme map, which can be explicitly detailed or referenced from an external structure document or registry service.
SimpleDataSourceType describes a simple data source. The URL of the data is contained in the content.
SingleValueMappingType defines a mapping with a single source and optional target.
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").
VtlMappingBaseType defines the base refinement of the VtlMappingType. Its purpose is to restrict the urn attribute.
The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header 'Accept-Language'.
Describes the source date using conventions for describing years, months, days, etc.
PartyType defines the information which is sent about various parties such as senders and receivers of messages.
MeasureList describes the measure descriptor for a data structure.
Extends StructureUsageType by adding a DimensionConstraint.
MetadataProvider describes an organisation that produces metadata.
FixedValueMap defines a fixed value for a source or target component in the mapping.
Describes the mapping from a SDMX dataflow to a VTL data structure.
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.
SimpleOperatorType provides an enumeration of simple operators to be applied to any value.
DatePatternMapBaseType defines the base refinement of the DatePatternMapType. Its purpose is to retrict the urn attribute.
Urn type for an attribute descriptor.
The type of object that is being linked to. The url of the object being linked. A SDMX registry urn of the object being linked (if applicable). The type of link (e.g. PDF, text, HTML, reference metadata).
A reference type for a name personalisation.
A reference type for a cateogry scheme.
ObjectURN provides the URN of the object on which the event occurred, unless the event is related to a registration, in which case the RegistrationID element should be used.
StructuralEvent is used to provide the details of the structural object that has changed.
A reference type for a data provider scheme.
Identifies the type of VTL model artefact that is being personalised. In VTL 2.0, this is valuedomain or variable.
AnnotationURLType defines an external resource. These can indicate localisation by specifying a language for the resource.
The isWebServiceDatasource attribute indicates, if true, that the queryable data source is accessible via Web Services protocols.
AgencySchemes contains a collection of agency scheme descriptions. The agency schemes may be detailed in full, or referenced from an external structure document or registry service.
DataConsumerSchemes contains a collection of data consumer scheme descriptions. The data consumer schemes may be detailed in full, or referenced from an external structure document or registry service.
SubmitRegistrationsResponse is sent to the agency or data/metadata provider in response to a submit registrations request. It indicates the success or failure of each registration request, and contains any error messages generated by the registration service.
DataProviderSchemes contains a collection of data provider scheme descriptions. The data provider schemes may be detailed in full, or referenced from an external structure document or registry service.
MetadataflowBaseType is an abstract base type that serves as the basis for the MetadataflowType. It restricts the structure to reference a metadata structure definition.
A reference type for any type of organisation scheme.
Describes the source date using conventions for describing years, months, days, etc. The locale on which the input will be parsed according to the pattern.
AttributeRelationshipType defines the structure for stating the relationship between an attribute and other data structure definition components.
Contains a regular expression string corresponding to the grid definition for the GeoGrid Codelist.
A simple type that allows for a standard to VTL mapping method enumeration value or a string value for other mapping methods.
A reference type for a codelist or value list.
Hierarchies 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.
MetadataAttribute defines the metadata attribute, which is the value of an attribute, such as the instance of a coded or uncoded attribute in a metadata structure definition.
The agencyID must be provided and identifies the maintenance agency of the object.
VtlMapping details a mapping between SDMX and VTL transformation.
MetadataAttributeBaseType is an abstract base type the serves as the basis for the MetadataAttributeType.
LegacyVersionNumberType describes the version number format previously supported in SDMX. The format is restricted to allow for simple incrementing and sorting of version number. The version consists of a set of maximum 2 numeric components, separated by the '.' character. When processing version, each numeric component (the number preceding and following any '.' character) should be parsed as an integer. Thus, a version of 1.3 and 1.03 would be equivalent, as both the '3' component and the '03' component would parse to an integer value of 3.
The action attribute indicates whether this is an addition, a modification, or a deletion of a registration.
StructuredTextValueType is a restriction of ValueType that allows multiple StructuredText (XHTML mixed content) elements to express a text value in multiple languages. The content of this should be restricted in its use to only allow a language code (xml:lang) to be used once within an element of this type.
A reference type for a process step.
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.
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.
Role is the responsibility of the contact person with respect to the object for which this person is the contact.
OrganisationSchemeMapType defines the structure of a map which identifies relationships between organisations in different organisation schemes.
GenericMetadataHeaderType defines the header format for generic reference metadata.
GregorianTimePeriodType defines the set of standard calendar periods in SDMX.
ReportingYearType defines a time period of 1 year (P1Y) in relation to a reporting year which has a start day (day-month) specified in the specialized reporting year start day attribute. In the absence of a start day for the reporting year, a day of January 1 is assumed. In this case a reporting year will coincide with a calendar year. The format of a reporting year is YYYY-A1 (e.g. 2000-A1). Note that the period value of 1 is fixed.
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.
CustomTypeSchemes contains a collection of custom type schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service.
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.
UnboundedCodeType provides single textual value of "unbounded", for use in OccurentType.
Input references an object which is an input to the process step.
AvailabilityConstraintsType describes the structure of the container for availability constraints.
MetadataProviderScheme provides the details of a metadata provider scheme, in which metadata providers are described.
TargetStep references a process step within the process that should be transitioned to, should the conditions described be met.
DataSourceType specifies the properties of a data or metadata source. Either a simple data source, a queryable data source, or both must be specified.
Attribute elements hold the reported values for a given metadata attribute. These values conform to the definition of the metadata attribute in the metadata structure definition.
StructuredText is a reusable element, used for providing a language specific text value structured as XHTML.
Series contains a collection of observations that share a common key (set of dimension values). The key of a series is every dimension defined in the data structure definition, save the dimension at the observation level. In addition to the key and observations, the series contains values for data and metadata attributes which have a relationship with any dimension that is part of the series key, so long as the attribute does not specify an attachment group or also has a relationship with the dimension declared to be at the observation level.
Urn type for a transformation scheme.
NumericType is a reusable simple type that allows for only numeric characters. This is not to be confused with an integer, as this may be used to numeric strings which have leading zeros. These leading zeros are not ignored. This is derived from the AlphaNumericType.
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.
RangeValidMonthDayType is a derivation of the RangeValidTimeType which validates that the time zone provided in the base type is valid. The base type will have provided basic validation already. The patterns below validate that the time zone is "Z" or that it is between -14:00 and +14:00, or that there is no time zone provided. This type is meant to be derived from for further validation.
Subscription contains the details of a subscription for the organisation. This may occur multiple times for each subscription.
Structures contains constructs for all structural metadata components.
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.
NamePersonalisationSchemeType defines a set of personalisations of VTL standard names that are used in a set of transformations.
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.
OrganisationSchemeMap provides the details of an organisation scheme map, which describes mappings between organisations in different schemes.
CodeDataType is a restriction of the basic data types that are applicable to codes. Although some of the higher level time period formats are permitted, it should be noted that any value which contains time (which includes a time zone offset) is not allowable as a code identifier.
Reporting Semester Or Not Applicable Type
SubmitRegistrationsRequestType defines the payload of a request message used to submit additions, updates, or deletions of data/metadata set registrations.
A reference type for a user defined operator.
StartPeriod is the start date or the range that the queried date must occur within. This date may be inclusive or exclusive in the range.
AttributeRepresentationType defines the representation for a data attribute. A data attribute can be text (including XHTML and multi-lingual values), a simple value, or an enumerated value.
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.
NamePersonalisationBaseType defines the base refinement of the NamePersonalisationType. Its purpose is to restrict the urn attribute.
StructureSpecificDataStructureType defines the structural information for a structured data set. In addition to referencing the data structure or dataflow which defines the structure of the data, the namespace for the data structure specific schema as well as which dimension is used at the observation level must be provided. It is also necessary to state whether the format uses explicit measures, although this is technically only applicable is the dimension at the observation level is the measure dimension or the flat data format is used.
DataflowType describes the structure of a data flow. Using a DimensionConstraint and/or a DataConstraint a data flow can define a subset of data defined by a DataStructure. Unless the dataflow artefact is defined externally, a reference to a DataStructure must be provided.
The isRESTDatasource attribute indicates, if true, that the queryable data source is accessible via the REST protocol.
GeographicCodelistsType describes the structure of the geographic code lists container. It contains one or more geographic codelist, which can be explicitly detailed or referenced from an external structure document or registry service.
Urn type for a reporting category.
AgencySchemesType describes the structure of the agency schemes container. It contains one or more agency scheme, which can be explicitly detailed or referenced from an external structure document or registry service.
GeoCodelistType is an abstract refinement of a codelist from which specific types of geographic codelists will be derived.
SubmitSubscriptionsResponseType describes the structure of the response to a new subscription submission. A status is provided for each subscription in the request.
Required if the DataStructure defines itself as an evolving structure, indicating that it can change dimensionality under a minor version change, and if the Dataflow references that DataStructure using a wildcarded minor version number. New minor DSD version can so still be used by this Dataflow even if that DSD version defines new additional Dimensions.
This restricts the prefix and classes patterns to validate the agency part of a wildcarded URN reference (=<agency_id>:).
ConceptSchemeMaps contains a collection of concept scheme map descriptions. The concept scheme maps may be detailed in full, or referenced from an external structure document or registry service.
DataKeyType is a region which defines a distinct full or partial data key. The key consists of a set of values, each referencing a dimension and providing a single value for that dimension. The purpose of the key is to define a subset of a data set (i.e. the observed value and data attribute) which have the dimension values provided in this definition. Any dimension not stated explicitly in this key is assumed to be wild carded, thus allowing for the definition of partial data keys.
DataComponentValueSetType defines the structure for providing values for a data attributes, measures, or metadata attributes. If no values are provided, the component is implied to include/excluded from the region in which it is defined, with no regard to the value of the component. Note that for metadata attributes which occur within other metadata attributes, a nested identifier can be provided. For example, a value of CONTACT.ADDRESS.STREET refers to the metadata attribute with the identifier STREET which exists in the ADDRESS metadata attribute in the CONTACT metadata attribute, which is defined at the root of the report structure.
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.
A reference type for a categorisation.
The indexDataSet, if true, indicates that the registry must index the range of actual (present) values for each dimension of the data set or identifier component of the metadata set (as indicated in the set's structure definition). The default value is false.
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.
Constraint provides a reference to a data or metadata constraint in the registry for the resulting data source (or possibly constraints base on the registration provision agreement, data provider, structure usage, or structure). The reference is provided for by a URN and/or a complete set of reference fields.
Processes contains a collection of process descriptions. The processes may be detailed in full, or referenced from an external structure document or registry service.
DataKeyValueType is a type for providing one or more dimension values for the purpose of defining a distinct data key.
A reference type for a metadata provision agreement.
Metadata Provision Agreement Reference Type
VersionableType is an abstract base type for all versionable objects.
Urn type for an organisation unit scheme.
RepresentationType is an abstract type that defines a representation. Because the type of item schemes that are allowed as the 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.
Hierarchy provides the details of a hierarchy, which is defined as an organised collection of codes that may participate in many parent/child relationships with other codes in the list.
NotifyRegistryEventType describes the structure a registry notification, in response to a subscription to a registry event. At a minimum, the event time, a reference to the change object, a reference to the underlying subscription triggering the notification, and the action that took place on the object are sent. In addition, the full details of the object may be provided at the discretion of the registry. In the event that the details are not sent, it will be possible to query for the details of the changed object using the reference provided.
SimpleKeyValueType derives from the SimpleValueType, but does not allow for the cascading of value in the hierarchy, as keys are meant to describe a distinct full or partial key.
WildcardVersionType combines the VersionType and WildcardType to allow a reference to either a specific version of an object, or to wildcard the version in the reference by specifying the '*' value.
The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist.
RulesetSchemes contains a collection of ruleset schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service.
MetadataProvisionAgreementBaseType defines the base refinement of the MetadataProvisionAgreementType. Its purpose is to restrict the urn attribute.
ValueList provides the details of a value list, which is a closed set of values that can occur for a dimension, measure, or attribute. This may be a simple list of values, or a list of values with names and descriptions (similar to a codelist).
A reference to the SDMX Codelist that the mapping is defined for. This is used to create a VtlCodelistMapping.
BooleanValueType is a refinement of SimpleValueType limiting the content to be a boolean.
DataComponentValueType derives from the SimpleValueType, but does not allow for validity dates.
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.
RepresentationMaps contains a collection of representation map descriptions. The representation maps may be detailed in full, or referenced from an external structure document or registry service.
IDQueryType is a simple type that allows for an identifier to be substituted with a wild card character ("%").
A reference to a codelist may contain a prefix. If a prefix is provided, this prefix will be applied to all the codes in the codelist before they are imported into the extended codelist.
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.
CustomTypeSchemesType 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.
The timeSeriesMatch attribute is true when the result is an exact match with the key found in the registry - that is, when the registered data source provides a matching key. It is set to false when the data source is registered with cube-region constraints, or in any other circumstance when it cannot be established that the sought-for keys have been exactly matched. This is always true when the resulting data source is the source of a metadata set.
StructureSpecificDataHeaderType defines the header structure for a structure specific data message.
DimensionListBaseType is an abstract base type used as the basis for the DimensionListType.
CodedTextFormatType is a restricted version of the SimpleComponentTextFormatType that only allows facets 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.
MetadataStructureComponents defines the grouping of the sets of the components that make up the metadata structure definition.
A reference type for structure usage.
RulesetSchemesType 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.
A reference type for a structure or structure usage.
MetadataProviderSchemeType defines a type of organisation scheme which contains only metadata providers. The metadata provider scheme maintained by a particular maintenance agency is always provided a fixed identifier and is never versioned. 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.
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.
This refines the prefix, classes, agency, and maintainable id patterns to validate the version number part of the URN ((<version_number)). It accounts for both legacy and semantic versioning, but not wildcarding (for referencing). It is meant to be further refined, although all parts after this are optional.
SubscriptionStatus contains information which describes the success or failure of a subscription request, providing any error messages in the event of failure. The statuses should occur in the same order as the requests when responding to a message with multiple subscription requests. If a subscriber-assigned identification for the subscription is provided, it will be returned to allow for accurate matching of the responses to the requests. A registry assigned URN will be returned for any successfully created, updated, or deleted subscription.
DataStructureBaseType describes base refinement of the StructureType for 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.
StructureSet is used to subscribe to changes of structure sets. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
Footer is used to communicate information such as error and warnings after the payload of a message.
Urn type for a data provider scheme.
TimeRangeValueType allows a time period value to be expressed as a range. It can be expressed as the period before a period, after a period, or between two periods. Each of these properties can specify their inclusion in regards to the range.
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.
Restricts the URN so that the pattern ends after the first component part.
BasicComponentDataType provides an enumerated list of the types of characters allowed in the textType attribute for all non-target object components.
SenderType extends the basic party structure to add an optional time zone declaration.
NonFacetedTextFormatType is a restricted version of the SimpleComponentTextFormatType that does not allow for any facets.
A reference type for a reporting taxonomy map.
The VTL type of the ruleset. In VTL 2.0, this is datapoint or hierarchical.
BasicHeaderType defines the most basic header information used in simple message exchanges.
Text is a reusable element, used for providing a language specific text value for general purposes (i.e. not for a name or description).
RegistrationID subscribes to all the data registration events for the unique registration referenced.
This refines the prefix, classes, and agency patterns to validate the maintainable ID part of a wildcarded URN reference (:<maintainable_id(<version_number>)). Note that it does not restrict the version part as it is intended to be further restricted.
StructureType is an abstract base type for all structure objects. Concrete instances of this should restrict to a concrete grouping.
CategorySchemeMap provides the details of a category scheme map, which describes mappings between categories in different schemes.
Structure is a message that contains structural metadata. It may contain any of the following; categorisations, category schemes, code lists, concepts (concept schemes), constraints (attachment and content) data flows, hierarchical code lists, metadata flows, metadata structure definitions, organisation schemes, processes, reporting taxonomies, and structure sets.
SubscriptionURN provides the registry/repository URN of the subscription that is the cause of this notification being sent.
The geo feature set of the Code, which represents a set of points defining a feature in a format defined a predefined pattern (see section 6).
Urn type for a metadata provider scheme.
TransformationScheme is used to subscribe to changes of a transformation scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
RepresentationMapsType describes the structure of the representation maps container. It contains one or more representation map, which can be explicitly detailed or referenced from an external structure document or registry service.
Standard Time Period Or Not Applicable Type
This is a type which describes a structure for holding all of the various dedicated registry interface message types.
MetadataAttributeValueSetType defines the structure for providing values for a metadata attribute. If no values are provided, the attribute is implied to include/excluded from the region in which it is defined, with no regard to the value of the metadata attribute.
Restricts the URN so that the pattern ends after the version part.
ItemSchemeMapType is an abstract base type which forms the basis for mapping items between item schemes of the same type.
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.
ReportingWeekType defines a time period of 7 days (P7D) in relation to a reporting year which has a start day (day-month) specified in the specialized reporting year start day attribute. A standard reporting week is based on the ISO 8601 definition of a week date, in relation to the reporting period start day. The first week is defined as the week with the first Thursday on or after the reporting year start day. An equivalent definition is the week starting with the Monday nearest in time to the reporting year start day. There are other equivalent definitions, all of which should be adjusted based on the reporting year start day. In the absence of a start day for the reporting year, a day of January 1 is assumed. The format of a reporting week is YYYY-Www (e.g. 2000-W01), where mm is a two-digit week (i.e. 01-53).
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.
SimpleCodeDataType restricts SimpleDataType to specify the allowable data types for a simple code. The possible values are simply Alpha, AlphaNumeric, or Numeric.
Organisation is an abstract substitution head for a generic organisation.
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.
ReportingTaxonomyMapsType describes the structure of the reporting taxonomy maps container. It contains one or reporting taxonomy map, which can be explicitly detailed or referenced from an external structure document or registry service.
Identifies 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.
Message contains a single error, information, or warning message. A code is provided along with an optional severity. The text of the message can be expressed in multiple languages.
OrganisationUnitSchemesType describes the structure of the organisation unit schemes container. It contains one or more organisation unit scheme, which can be explicitly detailed or referenced from an external structure document or registry service.
The completes the refinement of the prefix, classes, agency, maintainable id, and version number patterns to validate the last, and optional, nested component part of a URN reference (e.g. (<version_number>)<containerobject-id>.<object-id>*). The nested patterns provide a complete validation of the URN pattern.
TimePeriodRangeType defines a time period, and indicates whether it is inclusive in a range.
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.
This refines the prefix, classes, agency, and maintainable id patterns to validate the version number part of a wildcarded URN reference ((<version_number)). It accounts for both legacy and semantic versioning (including late binding). It is meant to be further refined, although all parts after this are optional.
SemanticVersionNumberType is a simple type for validating semantic version in the format (major.minor.patch[-extension]).
QueryRegistrationRequest is used to query the contents of a registry for data sets and metadata sets. It specifies whether the result set should include metadata sets, data sets, or both. The search can be characterized by providing constraints including reference periods, data regions, and data keys.
Selection of codes from the referenced (extended) codelist to be included in the extending codelist.
TimeDataType restricts SimpleDataType to specify the allowable data types for representing a time value.
ObservationDimensionType allows for the dimension at the observation level to be specified by either providing the dimension identifier or using the explicit value "AllDimensions".
DataConstraintType defines the structure of a data constraint. A data constraint contains the allowed values for the referencing artefact. These values are expressed either as sets of keys (DataKeySets) or sets of component values (CubeRegion) constructed from a data structure definition. Data constraints can be used, e.g., for validation or for defining a partial code list.
AfterPeriod is the period after which the period is meant to cover. This date may be inclusive or exclusive in the range.
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.
EndPeriod is the end period of the range. This date may be inclusive or exclusive in the range.
VersionableObjectEventType describes the structure of a reference to a versionable object's events. Either all instances of the object matching the inherited criteria, a specific instance, or specific instances of the object may be selected.
DataURL contains the URL of the data source.
MetadataRegistrationEventsType details the metadata registration events for the subscription. It is possible to subscribe to all metadata registration events in the repository, or specific events for; single registrations, provision agreements, data providers, metadata flows, metadata structure definitions, and categories that categorize metadata flows or metadata structure definitions.
ValueType is an abstract class that is the basis for any component value that cannot be simply represented as a space-normalized value (e.g. in an XML attribute). Although its content is mixed, it should be restricted so that only character data or the Text or Structured text is used. See StringValueType, IntValueType, ObserverationalTimeValueType, TextValueType, and StructuredTextValueType for details.
A reference type for a metadataflow.
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 is never versioned. 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.
MetadataAttributeUsageBaseType is the abstract base refinement of a metadata attribute usage. Since this is a usage of metadata attribute already defined in metadata structure, the typical id, concept identity, and representation are excluded in place of a local reference to the metadata attribute being used.
Identifies the VTL scalar type that is to be converted to an resulting output data type.
ConceptSchemeMap provides the details of a concept scheme map, which describes mappings between concepts in different schemes.
Error indicates the status message corresponds to an error. Warning indicates that the status message corresponds to a warning. Information indicates that the status message corresponds to an informational message.
IntValueType is a refinement of SimpleValueType limiting the content to be an integer. This can be further refined ranges, etc.
QueryableDatasource describes a data source that can be queried using the SDMX REST interfaces.
DoubleValueType is a refinement of SimpleValueType limiting the content to be a double. This can be further refined ranges, etc.
SubmitRegistrationsResponseType describes the structure of a registration response. For each submitted registration in the request, a registration status is provided. The status elements should be provided in the same order as the submitted registrations, although each status will echo the request to ensure accurate processing of the responses.
DataStructureType defines the structure for 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.
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.
MaxOccursNumberType is a base type used to restrict an integer to be greater than 1, for the purpose of expressing the maximum number of occurrences of an object.
The externalDependencies attribute indicates the default resolution of external dependencies. This should be set to true if the repository is expected to use external reference URLs in the structural components to retrieve any externally referenced objects that is used by a non-external object.
ReportingTaxonomyMaps contains a collection of reporting taxonomy map descriptions. The reporting taxonomy maps may be detailed in full, or referenced from an external structure document or registry service.
OrganisationUnit describes a generic organisation, which serves not predefined role in SDMX.
A reference type for a data consumer.
A reference for any type of constraint.
SubmitSubscriptionsResponse is the response to a submit subscriptions request. It contains information which describes the success or failure of each subscription request, providing any error messages in the event of failure. If successful, it returns the registry URN of the subscription, and the subscriber-assigned ID.
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.
ISOConceptReferenceType provides a reference to and ISO 11179 concept.
GeoCodelistTypeType defines an enumeration of the specific types of geographic codelists.
A reference type for a data attribute.
The completes the refinement of the prefix, classes, agency, maintainable id, and version number patterns to validate the last, and optional, nested component part of the URN (e.g. (<version_number>)<containerobject-id>.<object-id>*). The nested patterns provide a complete validation of the URN pattern.
Agency is an organisation which maintains structural metadata such as classifications, concepts, data structures, and metadata structures.
DataConstraintBaseType is an abstract base refinement of ConstraintType to define allowed data content. The constraint attachment is restricted to constrainable artefacts related to data.
HierarchyAssociations contains a collection of hierarchy associations. The associations may be detailed in full, or referenced from an external structure document or registry service.
AnnotationTitle provides a title for the annotation.
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.
DataKeySetType defines a collection of full or partial data keys (dimension values).
A reference type for a transformation scheme.
TransformationSchemes contains a collection of transformation schemes. The transformation schemes may be detailed in full, or referenced from an external structure document or registry service.
ProcessBaseType defines the base refinement of the ProcessType. Its purpose is to restrict the urn attribute.
CubeRegion defines a slice of the data set (dimensions and attribute values) for the constrained artefact. A set of included or excluded regions can be described.
ContactType describes the structure of a contact's details.
StatusMessage provides that status for the registration query request, and if necessary, any error or warning information.
A reference type for a reporting taxonomy.
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.
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.
VtlMappingSchemeType defines a set of mappings between SDMX and VTL.
DataflowReference subscribes to all data registration events for the data flows referenced by this object. This may reference one or more data flows, as the specific references fields allow for a wild-carded value.
QuerySubscriptionResponse is sent as a response to a subscription query. If the query is successful, the details of all subscriptions for the requested organisation are sent.
GeoGridCodelists contains a collection of geographic grid codelist descriptions. The codelists may be detailed in full, or referenced from an external structure document or registry service.
QuerySubscriptionRequestType describes the structure of a query for subscriptions. Subscriptions for a given organisation may be retrieved.
A reference type for a dimension descriptor.
Urn type for a metadata provision agreement.
TimeRangeType defines the structure of a time range in SDMX. The pattern of a time range can be generally described as [start date]\[duration], where start date is an date or dateTime type as defined in XML Schema and duration is a time duration as defined in XML Schema. Note that it is permissible for a time zone offset to be provided on the date or date time.
This model artefact on which the ruleset is defined. In VTL 2.0, this is value domain or variable.
OrganisationSchemeMaps contains a collection of organisation scheme map descriptions. The organisation scheme maps may be detailed in full, or referenced from an external structure document or registry service.
A reference type for a time dimension.
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.
An explicit or wildcard selection of a code(s) from the codelist selected for inclusion/exclusion. If a wildcard expression is used, it is evaluated to determine codes selected for inclusion/exclusion. Otherwise, each member value is a distinct code. If the extended list is hierarchical, this can indicate whether child codes are to be included.
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.
The schemaURL attribute provides a location from which the structure specific schema can be located.
ReportingSemesterType defines a time period of 6 months (P6M) in relation to a reporting year which has a start day (day-month) specified in the specialized reporting year start day attribute. In the absence of a start day for the reporting year, a day of January 1 is assumed. The format of a reporting semester is YYYY-Ss (e.g. 2000-S1), where s is either 1 or 2.
A simple type that allows for standard from VTL mapping method enumeration value or a string value for other mapping methods.
StructureSpecificData is used to convey data structure specific according to data structure definition. The payload of this message (i.e. the data sets) will be based on XML schemas which are specific to the data structure definition and the orientation (i.e. the observation dimension) of the data.
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.
VtlMappingSchemes contains a collection of VTL mapping schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service.
The type of object that is being linked to.
Department is designation of the organisational structure by a linguistic expression, within which the contact person works.
SubmitStructureResponseType describes the structure of a response to a structure submission. For each submitted structure, a Result will be returned.
TimezoneType defines the pattern for a time zone. An offset of -14:00 to +14:00 or Z can be specified.
RegistrationRequest provides the details of a requested registration and the action to take on it. A reference to a provision agreement that exists in the registry must be provide along with a simple and/or queryable data source. The id should only be provided when updating or deleting a registration.
Observational Time Period Or Missing Type
VtlDefinitionSchemeType is an abstract extension of the ItemSchemeType for VTL schemes.
MaintainableQueryType describes the structure of a query for a maintainable object.
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.
DataConsumerSchemesType describes the structure of the data consumer schemes container. It contains one or more data consumer scheme, which can be explicitly detailed or referenced from an external structure document or registry service.
MetadataStructureDefinition is used to subscribe to changes of metadata structure definitions. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
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.
EventSelector indicates an event or events for the subscription.
OrganisationUnitSchemeType defines a type of organisation scheme which simply defines organisations and their 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.
UserDefinedOperatorSchemeBaseType is an abstract base type for the UserDefinedOperatorSchemeType. It restricts the item types to be only user defined operators.
AttributeListBaseType is an abstract base type used as the basis for the AttributeListType.
A simple type that allows for a SDMX simple data type enumeration value or a string value for other data types.
TransitionBaseType defines the base refinement of the TransitionType. Its purpose is to restrict the urn attribute.
ComputationType describes a computation in a process.
OrganisationSchemeType describes the structure of an organisation scheme.
WildcardedMemberValueType allows for an optional wildcard characters ('%') in an identifier.
FromVtlMappingType defines the mapping method and filter used when mapping from VTL to SDMX.
The indexTimeSeries, if true, indicates that the registry must index all time series for the registered data. The default value is false, and the attribute will always be assumed false when the provision agreement references a metadata flow.
CodeSelectionType defines the structure for code selection to be used as inclusive or exclusive extensions.
RepresentationMapBaseType defines the base refinement of the RepresentationMapType. Its purpose is to retrict the urn attribute.
ReferencePeriod provides an inclusive start and end date for the data or metadata being sought.
Basic Time Period Or Not Applicable Type
Provides the personalised name that is used in place of the VTL standard name in the transformation expressions.
AttachmentConstraint is used to subscribe to changes of attachment constraints. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.
There should be a source value for each source representation (e.g. codelist, data type). Source values can be pattern matched by using regular expression or substrings using start/end indexes.
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.
NotificationURLType describes the structure of an http or email address. The content holds the addresses while an attribute indicates whether or not is expects the contents in a SOAP message.
ValueListBaseType defines the base refinement of the ValueListType. Its purpose is to restrict the urn attribute.
Category represents a set of nested categories which describe a simple classification hierarchy.
MetadataTargetRegion describes the values allowed for metadata attributes.
EndDate is an inclusive end date for the subscription.
Urn type for a user defined operator scheme.
StatusMessageType describes the structure of an error or warning message. A message contains the text of the message, as well as an optional language indicator and an optional code.
SubmitRegistrationsRequest is sent to the registry by an agency or data/metadata provider to request one or more registrations for a data set or metadata set. The data source to be registered must be accessible to the registry services at an indicated URL, so that it can be processed by those services.
ActionType provides a list of actions, describing the intention of the data transmission from the sender's side. Each action provided at the data or metadata set level applies to the entire data set for which it is given. Note that the actions indicated in the Message Header are optional, and used to summarize specific actions indicated with this data type for all registry interactions. When absent (not recommended), Merge is assumed.
DataKeySet defines a full, distinct set of dimension values and the attribute values associated with the key.
GeographiCodelist provides the details of a geographic codelists container, which comprises a set of GeoFeatureSetCodes, by adding a value in the Code that follows a pattern to represent a geo feature set.
OrganisationSchemeMapsType describes the structure of the organisation scheme maps container. It contains one or more organisation scheme map, which can be explicitly detailed or referenced from an external structure document or registry service.
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 or VtlCodelistMapping, or VtlConceptMapping) 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 default Basic mapping methods used for Dataflows by utilizing the GenericDataflow element in place of a reference to a specific Dataflow.
MeasureRelationshipType allows for the description of an attribute's relationship to one or more measures.
DataConstraints contains a collection of data constraints. The constraints may be detailed in full, or referenced from an external structure document or registry service.
A reference type for a user defined operator scheme.
User Defined Operator Scheme Reference Type
AnnotationsType provides for a list of annotations to be attached to data and structure messages.
MeasureListType describes the structure of the measure descriptor for a data structure definition.
CodedStatusMessageType describes the structure of an error or warning message which required a code.
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.
CategorySchemeMaps contains a collection of category scheme map descriptions. The category scheme maps may be detailed in full, or referenced from an external structure document or registry service.
IdentifiableObjectEventType describes the structure of a reference to an identifiable object's events. Either all instances of the object matching the inherited criteria, a specific instance, or specific instances of the object may be selected.
AnnotationValue holds a non-localised value for the annotation.
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.
A reference type for a value list.
Urn type for a category scheme map.
Urn type for a group dimension descriptor.
Validity period sets a start and end date for the subscription.
ComponentMapType defines the structure for relating a component in a source structure to a component in a target structure.
A reference type for a hierarchical code.
Name is a reusable element, used for providing a human-readable name for an object.
EventSelectorType describes the details of the events for a subscription. It allows subscribers to specify registry and repository events for which they wish to receive notifications.
MetadataAttributeUsage refines the details of how a metadata attribute from the metadata structure referenced from the data structure is used. By default, metadata attributes can be expressed at any level of the data. This allows an attribute relationship to be defined in order restrict the reporting of a metadata attribute to a specific part of the data.
A reference type for an epoch map.
MetadataSetType describes the structure for a metadata set, which contains a collection of reported metadata against a set of targets. The targets should conform to the restrictions described by the metadata provision or the metadataflow. Note that this is maintainable, and as such must specify in agency. In this case, the agency is the metadata provider. If a metadata provision agreement is referenced, it is assumed that the metadata provider described in the provision will be the same as the agency for this set.
WSDLURL provides the location of a WSDL instance on the internet which describes the queryable data source.
ValueListsType describes the structure of the value lists container. It contains one or more value list, which can be explicitly detailed or referenced from an external structure document or registry service.
The right-hand side of the VTL statement. This is expression that is executed for this transformation. It includes 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").
Urn type for a user defined operator.
A reference type for a VTL mapping scheme.
MetadataConstraintBaseType is an abstract base refinement of ConstraintType to define allowed metadata content. The constraint attachment is restricted to constrainable artefacts related to metadata.
SimpleDataType restricts BasicComponentDataType to specify the allowable data types for a data structure definition component. The XHTML representation is removed as a possible type.
Registration provides the information needed for data and reference metadata set registration. A data source must be supplied here if not already provided in the provision agreement. The data set or metadata set must be associated with a provision agreement, a metadata flow, or a dataflow definition. If possible, the provision agreement should be specified. Only in cases where this is not possible should the dataflow or metadata flow be used.
SubscriptionRequestType describes the structure of a single subscription request. It contains subscription details and an action field to indicate the action to be taken on the contained subscription. Note that if the action is update or delete, then the registry supplied URN for the subscription must be included.
Urn type for a data consumer scheme.
A reference type for a VTL mapping.
Comp contains the details of the data or metadata attributes that have complex representation and cannot be expressed as XML attributes.
CubeRegionType defines the structure of a data cube region. This is based on the abstract RegionType and simply refines the key and attribute values to conform with what is applicable for dimensions and attributes, respectively. See the documentation of the base type for more details on how a region is defined.
NamePersonalisationSchemes contains a collection of name personalisation schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service.
Allows for a ditinct reference or a wildcard expression for selecting codes from a codelist.
RulesetBaseType defines the base refinement of the RulesetType. Its purpose is to restrict the urn attribute.
A reference type for a date pattern map.
A reference type for a concept scheme.
This refines the prefix, classes, agency, and maintainable id patterns to validate the version number part of a URN reference ((<version_number)). It accounts for both legacy and semantic versioning (including late binding). It is meant to be further refined, although all parts after this are optional.
ErrorMessage contains the error message. It can occur multiple times to communicate message for multiple errors, or to communicate the error message in parallel languages. If both messages for multiple errors and parallel language messages are used, then each error message should be given a code in order to distinguish message for unique errors.
PayloadStructureType is an abstract base type used to define the structural information for data or metadata sets. A reference to the structure is provided (either explicitly or through a reference to a structure usage).
DataConsumerScheme provides the details of an data consumer scheme, in which data consumers are described.
Urn type for a custom type scheme.
Urn type for a metadata constraint.
Allows for attachment of reference metadata against to the data set.
RangeValidMonthDayType is a derivation of the BaseTimeRangeType which validates that the day provided is valid for the month, without regard to leap years. The base type will have provided basic validation already. The patterns below validate that there are up to 29 days in February, up to 30 days in April, June, September, and November and up to 31 days in January, March, May, July, August, October, and December. This type is meant to be derived from for further validation.
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.
Restricts the URN reference so that the pattern ends after the first component part.
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.
Urn type for a metadata provider.
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.
NameableType is an abstract base type for all nameable objects.
Urn type for a hierarchical code.
RulesetSchemeType defines a collection of rulesets that are used in transformations.
A reference type for a transition.
NCNameIDType restricts the IDType, so that the id may be used to generate valid XML components. IDs created from this type conform to the W3C XML Schema NCNAME type, and therefore can be used as element or attribute names.
IdentifiableType is an abstract base type for all identifiable objects.
Urn type for a hierarchy association.
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.
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.
BaseTimeRangeType is a simple type which frames the general pattern for a time range in SDMX. A time range pattern is generally described as [xs:date or xs:dateTime]\[xs:duration], where the referenced types are defined by XML Schema. This type is meant to be derived from for further validation.
A reference type for a dimension.
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.
RegistryInterface is used to conduct all interactions with the SDMX Registry Services.
Urn type for an organisation scheme map.
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.
MetadataProviderSchemes contains a collection of metadata provider scheme descriptions. The meatadata provider schemes may be detailed in full, or referenced from an external structure document or registry service.
AvailabilityConstraintAttachmentType describes a collection of references to data-related artefacts, for which availability is provided.
MetadataSetBaseType defines the base refinement of the MetadataSetType. Its purpose is to restrict the urn attribute.
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.
CompType is the abstract base for any component value (e.g. a data or metadata attribute, or a measure) that cannot be represented as an XML attribute. For example, a repeated value, a text value in multiple languages, or a value with structured text (XHTML) cannot be expressed as an XML attribute. This type is meant to be restricted based on the component to restrict the cardinality and type of its Value element to conform to the component definition. The type of the value element should be restricted to common:SimpleValueType, common:TextValueType, or common:StructuredValueType. In addition, the id attribute should be restricted to be a fixed value with the component identifier. This restricted type based on the component can then be used on Comp elements by using the xsi:type to state the component being expressed and refine the contents of the element to the values allowed by the component.
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.
HierarchiesType describes the structure of the hierarchies container. It contains one or more hierarchy, which can be explicitly detailed or referenced from an external structure document or registry service.
MetadataflowReference subscribes to all metadata registration events for the metadata flows referenced by this object. This may reference one or more metadata flows, as the specific references fields allow for a wild-carded value.
The endTime attributes contains the inclusive end date for the reference period.
DataRegistrationEvents details the data registration events for the subscription.
Telephone holds the telephone number for the contact person.
StructureType defines the contents of a structure message. The payload is optional since this message may be returned from a web service with only information in the footer.
This is validates the first part of the URN (urn:sdmx.org.infomodel.<package>.<class=). It is intended to be further restricted.
ReportingTimePeriodType defines standard reporting periods in SDMX, which are all in relation to the start day (day-month) of a reporting year which is specified in the specialized reporting year start day attribute. If the reporting year start day is not defined, a day of January 1 is assumed. The reporting year must be expressed as the year at the beginning of the period. Therefore, if the reporting year runs from April to March, any given reporting year is expressed as the year for April. The general format of a report period can be described as [year]-[period][time zone]?, where the type of period is designated with a single character followed by a number representing the period. Note that all periods allow for an optional time zone offset. See the details of each member type for the specifics of its format.
MemberSelectionType is an abstract base type which is used to provide a set of values for a referenced component. Implementations of this type will be based on a particular component type and refine the allowed values to reflect the types of values that are possible for that type of component.
A reference type for a metadata structure.
QueryRegistrationResponseType describes the structure of a registration query response. It provides a status for the request, and if successful, the resulting data and/or metadata results.
TwoLevelIDType defines an identifier with exactly two levels.
WADLURL provides the location of a WADL instance on the internet which describes the REST protocol of the queryable data source.
Provides a reference to an ISO 11179 concept.
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.
An evolving data structure indicates that new Dimensions may be added under a minor version update e.g. 1.0.0 to 1.1.0. Evolving Data Structures can only be used by Dataflows if they include a DimensionConstraint to fix the Dimensions to the subset required by the Dataflow.
ExcludeRootType is a single enumerated value that indciates that child values should be included, but that the actual root should not.
FixedValueMapType defines the structure for providing a fixed value for a source or target component.
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 data structure in the context of a constraint.
GeoCodelistBaseType is an abstract base refinement of a codelist that restricts the cods to be derived from the abstract GeoRefCode.
DataSetType is the abstract type which defines the base structure for any data structure definition specific data set. A derived data set type will be created that is specific to a data structure definition and the details of the organisation of the data (i.e. which dimension is the observation dimension). Data is organised into either a collection of series (grouped observations) or a collection of un-grouped observations. The derived data set type will restrict this choice to be either grouped or un-grouped observations. If this dimension is "AllDimensions" then the derived data set type must consist of a collection of un-grouped observations; otherwise the data set will contain a collection of series with the observations in the series disambiguated by the specified dimension at the observation level. This data set is capable of containing data (observed values) and/or documentation (data and metadata attribute values) and can be used for incremental updates and deletions (i.e. only the relevant updates or deletes are exchanged). It is assumed that each series or un-grouped observation will be distinct in its purpose. For example, if series contains both data and documentation, it assumed that each series will have a unique key. If the series contains only data or only documentation, then it is possible that another series with the same key might exist, but with not with the same purpose (i.e. to provide data or documentation) as the first series. This base type is designed such that derived types can be processed in a generic manner; it assures that data structure definition specific data will have a consistent structure. The group, series, obs, and atts elements are unqualified, meaning that they are not qualified with a namespace in an instance. This means that in the derived data set types, the elements will always be the same, regardless of the target namespace of the schemas which defines these derived types. This allows for consistent processing of the structure without regard to what the namespace might be for the data structure definition specific schema.
ReportPeriodValidTimeZoneType is a derivation of the BaseReportPeriodType which validates that the time zone provided in the base type is valid. The base type will have provided basic validation already. The patterns below validate that the time zone is "Z" or that it is between -14:00 and +14:00, or that there is no time zone provided. This type is meant to be derived from for further validation.
The softwareVersion attribute hold the version of the software package that is used to perform that computation.
AttsType is the abstract type which defines a structure which is used to group a collection of data or metadata attributes which have a key in common. The key for a attribute collection is a subset of the dimension defined in the data structure definition. This is also used for data set level attributes (i.e. those with an attribute relationship of none). In this case, the subset of dimensions is empty. Data structure definition schemas will derive a type based on this that is specific to the data structure definition. The dimension values which make up the key will be represented with local (non-namespace qualified) XML attributes. The metadata attribute values associated with the key dimensions will be expressed as XML local (non-namespace qualified) attributes if they are simple values (e.g. enumerated, dates, numbers) and are not repeatable. Metadata attributes that are repeatable, or do not have simple values (e.g. text) will be expressed using the Comp element. This dimensions and simple attributes are specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived series type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the series dimensions and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.
The context within which the association is performed.
GenericMetadataStructureType defines the structural information for a generic metadata message.
ConstraintAttachmentType describes a collection of references to constrainable artefacts.
ItemSchemeMapBaseType is an abstract base type which forms the basis for the ItemSchemeMapType.
Urn type for a dimension descriptor.
OrderedOperatorType combines the SimpleOperatorType and the RangeOperatorType to provide a full range or operators for any ordered value.
OrganisationSchemeBaseType is an abstract base type for any organisation scheme.
CubeKeyValueType derives from the SimpleValueType, but does not allow for a locale (xml:lang).
ObservationalTimePeriodType specifies a distinct time period or point in time in SDMX. The time period can either be a Gregorian calendar period, a standard reporting period, a distinct point in time, or a time range with a specific date and duration.
Specifies the inclusive start and end times.
A reference type for a structure map.
AttributeType defines the structure for a reported metadata attribute. A value for the attribute can be supplied as either a single value (enumerated or non-enumerated single value), or multi-lingual text values (either structured or unstructured). Optional child attributes are also available if the metadata attribute definition defines nested metadata attributes.
The softwareLanguage attribute holds the coding language that the software package used to perform the computation is written in.
SimpleDatasource describes a data source that is an SDMX-ML data or metadata message. It requires only the URL of the data.
AnnotationURL is a URI - typically a URL - which points to an external resource which may contain or supplement the annotation. These can be localised by indicating a language for the resource. If a language is not specified, the resource is assumed to not be localised. If a specific behaviour is desired, an annotation type should be defined which specifies the use of this field more exactly.
SubmissionResultType provides the status of the structural object submission request. It will identify the object submitted, report back the action requested, and convey the status and any error messages which are relevant to the submission.
The include attribute has a fixed value of true for a distinct key, since such a key is always assumed to identify existing data or metadata.
TimeRangeValidDateDurationType is an abstract derivation of the RangeValidTimeType which validates that duration provided is generally valid, up to the time component.
Range Valid Month Day Or Not Applicable Type
WildCardValueType is a single value code list, used to include the '%' character - indicating that an entire field is wildcarded.
ToVtlMappingType defines the mapping method and filter used when mapping from SDMX to VTL.
A reference type for an organisation unit.
Urn type for a reporting taxonomy map.
ConceptRole references concepts which define roles which this attribute serves.
Provides the ability to map source to target date formats. The source date is described as a pattern (for example MM-YYYY).
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.
A reference type for an attribute descriptor.
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.
Describes the mapping to a SDMX dataflow from a VTL data structure.
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.
A reference type for a hierarchy association.