1. Introduction

The query constructs in SDMX have been modified to more closely follow the information model. The intention is to create a consistent structure for all queries so that they can be more easily processed and so that there is no ambiguity as to what the purpose of the request is. This means that for structural metadata, the queries derive from types as they do in the information model. Because a data flow and a metadata flow both are derived from the structure usage, there query constructs are nearly identical. The same basic principle is applied to the data and metadata queries. Where possible, they are consistent with each other.

To allow for web services to be explicit in the inputs to their functions, specific messages have been created for the various structural objects. This allows a function for querying codelists to be explicit as to the fact that the only acceptable input to this query is a codelist query.

Finally, a mechanism for requesting structure specific schemas has been introduced. The intentions is that one could request the schemas from an organisation so that they will have them readily available for processing of data retrieved from the same organisation.

2. Schema Documentation

2.2 Query Namespace

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

2.2.1 Summary

Referenced Namespaces:

Contents:
52 Global Elements
145 Complex Types
11 Simple Types

2.2.2 Global Elements

StructuralMetadataWhere (MaintainableWhereType): StructuralMetadataWhere is an abstract substitution head that forms the basis of any structural metadata query's details. This contains the actual parameters to be matched. These parameters are implicitly joined by an "and" connector (i.e. each of the parameters must be matched in order to satisfy the query). If it is necessary to supply "or" conditions for a parameter, this should be done by supplying multiple queries.

Substitutions: CategorisationWhere, CategorySchemeWhere, CodelistWhere, ConceptSchemeWhere, ConstraintWhere, DataflowWhere, DataStructureWhere, HierarchicalCodelistWhere, MetadataflowWhere, MetadataStructureWhere, OrganisationSchemeWhere, ProcessWhere, ProvisionAgreementWhere, ReportingTaxonomyWhere, StructureSetWhere, StructuresWhere, TransformationSchemeWhere, VtlMappingSchemeWhere, NamePersonalisationSchemeWhere, RulesetSchemeWhere, UserDefinedOperatorSchemeWhere, CustomTypeSchemeWhere

ItemWhere (ItemWhereType): ItemWhere is an abstract substitution head to query for an item within a parent item where or an item scheme query. An item where query is implicitly an and-query - that is the conditions within the item where must all be met in order to return a match. If this is nested within another item where, the meaning is that the conditions specified must be matched within the hierarchy provided.

Substitutions: CategoryWhere, CodeWhere, ConceptWhere, OrganisationWhere, ReportingCategoryWhere, TransformationWhere, VtlMappingWhere, NamePersonalisationWhere, RulesetWhere, UserDefinedOperatorWhere, CustomTypeWhere

ComponentListWhere (ComponentListWhereType): ComponentListWhere is an abstract substitution head to query for a component list within a structure. A component list where query is implicitly an and-query - that is the conditions within the component list where must all be met in order to return a match.

Substitutions: GroupWhere, MetadataTargetWhere, ReportStructureWhere

ComponentWhere (ComponentWhereType): ComponentWhere is an abstract substitution head to query for a component within a component list or a structure. A component where query is implicitly an and-query - that is the conditions within the component where must all be met in order to return a match.

Substitutions: GroupDimensionWhere, AttributeWhere, DimensionWhere, TimeDimensionWhere, PrimaryMeasureWhere, MeasureDimensionWhere, TargetObjectWhere, MetadataAttributeWhere

NumericValue (NumericValueType): NumericValue is used to query for a the value of a concept or component based on a numeric search. This is typically used when the value needs to be searched explicitly as a number, such as when data is sought with an observed value greater than some threshold. If only a simple match is required (i.e. the numeric value equals 'x') then the Value element can be used.

TextValue (QueryTextType): TextValue is used to query for the value of a concept or component based on textual parameters. The text value can be language specific (where parallel multi-lingual values are available) and is qualified with an operator indicating how the supplied text should be matched against the sought components. If only a simple equality check is necessary, regardless of language, the Value element can be used.

TimeValue (TimePeriodValueType): TimeValue is used to query for the value of a concept or component based on time parameters. This is typically used when the value needs to be treated explicitly as a time, for example when searching for data after a particular point in time. If only a simple equality check is necessary, the Value element can be used.

Value (SimpleValueType): Value is used to query for the value of a component. This should be used for concepts or components based on a simple value (e.g. a code or a simple string). This should be used when a simple equal/not equal operator is all that is necessary for matching the sought value.

CategorisationWhere (CategorisationWhereType): CategorisationWhere defines the parameters for a categorisation query. All parameters must be matched for an object to satisfy the query.In addition to querying based on the basic maintainable properties, it is also possible to search based on the source object being categorized and target category the object is categorized against.

Substitution For: StructuralMetadataWhere

CategorySchemeWhere (CategorySchemeWhereType): CategorySchemeWhere contains the parameters for a category scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a category scheme based on the details of its categories. In any case, the category scheme will be returned according the indicated return detail.

Substitution For: StructuralMetadataWhere

CategoryWhere (CategoryWhereType): CategoryWhere is used to query for categories matching the parameters supplied. It allows for nested category queries so that hierarchical categories can be queried explicitly by their nested level, although a top level category will always result in a search for categories at any level. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.

Substitution For: ItemWhere

CodelistWhere (CodelistWhereType): CodelistWhere defines the parameters for a codelist query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a codlist based on the details of its codes. In any case, the codelist will be returned according the indicated return detail.

Substitution For: StructuralMetadataWhere

CodeWhere (CodeWhereType): CodeWhere is used to query for codes matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.

Substitution For: ItemWhere

ConceptSchemeWhere (ConceptSchemeWhereType): ConceptSchemeWhere defines the parameters for a concept scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a concept scheme based on the details of its concepts. In any case, the concept scheme will be returned according the indicated return detail.

Substitution For: StructuralMetadataWhere

ConceptWhere (ConceptWhereType): ConceptWhere is used to query for concepts matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.

Substitution For: ItemWhere

ConstraintWhere (ConstraintWhereType): AttachmentConstraintWhere contains the parameters for a constraint query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a constraint based on the objects it applies to.

Substitution For: StructuralMetadataWhere

DataflowWhere (DataflowWhereType): DataflowWhere defines the parameters for a dataflow query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a dataflow based on the key family it defines the usage of.

Substitution For: StructuralMetadataWhere

DataStructureWhere (DataStructureWhereType): DataStructureWhere contains the parameters for a data structure definition query. All parameters must be matched for an object to satisfy the query. The query is simply a refinement of the base structure query to make the parameters specific to the data structure definition.

Substitution For: StructuralMetadataWhere

GroupWhere (GroupWhereType): GroupWhere is used to query for a data structure definition that contains a group meeting the conditions detailed in this container. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Substitution For: ComponentListWhere

GroupDimensionWhere (DimensionWhereType): GroupDimensionWhere is used to query a group based on the details of the dimensions it groups. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Substitution For: ComponentWhere

AttributeWhere (AttributeWhereType): AttributeWhere is used to query for a data structure definition that contains an attribute meeting the conditions contained in this structure. The attribute can be queried based on its identification, the concept from which it takes its semantic, its attachment level, the role it plays, and the code list it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Substitution For: ComponentWhere

DimensionWhere (DimensionWhereType): DimensionWhere is used to query for a data structure definition that contains a dimension meeting the conditions contained in this structure. The dimension can be queried based on its identification, the concept from which it takes its semantic, the role it plays, and the code list it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Substitution For: ComponentWhere

TimeDimensionWhere (TimeDimensionWhereType): TimeDimensionWhere is used to query for a data structure definition that contains a time dimension meeting the conditions contained in this structure. The time dimension can be queried based on its identification and the concept from which it takes its semantic. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Substitution For: ComponentWhere

PrimaryMeasureWhere (PrimaryMeasureWhereType): PrimaryMeasureWhere is used to query for a data structure definition that contains a primary measure meeting the conditions contained in this structure. The primary measure can be queried based on its identification, the concept from which it takes its semantic, and the code list it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Substitution For: ComponentWhere

MeasureDimensionWhere (MeasureDimensionWhereType): MeasureDimensionWhere is used to query for a data structure definition that contains a measure dimension meeting the conditions contained in this structure. The cross-sectional measure can be queried based on its identification, the concept from which it takes its semantic, and the concept scheme it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Substitution For: ComponentWhere

HierarchicalCodelistWhere (HierarchicalCodelistWhereType): HierarchicalCodelistWhere defines the parameters for a hierarchical codelist query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a hierarchical codelist based on the codelists it arranges into hierarchies.

Substitution For: StructuralMetadataWhere

MetadataflowWhere (MetadataflowWhereType): MetadataflowWhere contains the parameters for a metadataflow query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a metadataflow based on the metadata structure definition it defines the usage of.

Substitution For: StructuralMetadataWhere

MetadataStructureWhere (MetadataStructureWhereType): MetadataStructureWhere contains the parameters for a metadata structure definition query. All parameters must be matched for an object to satisfy the query. The query is simply a refinement of the base structure query to make the parameters specific to the metadata structure definition.

Substitution For: StructuralMetadataWhere

MetadataTargetWhere (MetadataTargetWhereType): MetadataTargetWhere is used to query for a metadata structure definition that contains a metadata target meeting the conditions contained in this structure. The metadata target can be queried based on its identification and/or the details of its target objects. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Substitution For: ComponentListWhere

TargetObjectWhere (TargetObjectWhereType): IdentifierComponentWhere is used to query for specific target identifiers or metadata structure definitions where a contained identifier component meets the conditions detailed. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Substitution For: ComponentWhere

ReportStructureWhere (ReportStructureWhereType): ReportStructureWhere is used to query for metadata structure definitions where a given report structure meets the conditions specified. A report structure can be queried based on identification or details about its metadata attributes. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Substitution For: ComponentListWhere

MetadataAttributeWhere (MetadataAttributeWhereType): MetadataAttributeWhere is a parameter which is used in a report structure parameter or to query metadata structure definitions where a contained metadata attribute meets the conditions specified. A metadata attribute can be queried based on its identification, the concept from which it takes its semantic, and an item scheme it uses as its representation. Nested metadata attributes allow for the querying of metadata attributes explicitly at nested level, although a top level metadata attribute query will be processed by querying metadata attributes at any level. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Substitution For: ComponentWhere

OrganisationSchemeWhere (OrganisationSchemeWhereType): OrganisationSchemeWhere defines the parameters for an organisation scheme query, regardless of the specific type of organisation scheme being sought. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for an organisation scheme based on the details of its organisations. In any case, the organisation scheme will be returned according the indicated return detail.

Substitution For: StructuralMetadataWhere

OrganisationWhere (OrganisationWhereType): OrganisationWhere is used to query for organisations matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.

Substitution For: ItemWhere

ProcessWhere (ProcessWhereType): ProcessWhere contains the parameters for a process query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the process steps defined within the process. In any case, the entire process will be returned according the indicated return detail.

Substitution For: StructuralMetadataWhere

ProvisionAgreementWhere (ProvisionAgreementWhereType): ProvisionAgreementWhere contains the parameters for a provision agreement query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a provision agreement based on the data provider and the structure usage it pairs.

Substitution For: StructuralMetadataWhere

ReportingTaxonomyWhere (ReportingTaxonomyWhereType): ReportingTaxonomyWhere contains the parameters for a reporting taxonomy query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search for a reporting taxonomy based on the details of its reporting categories. In any case, the reporting taxonomy will be returned according the indicated return detail.

Substitution For: StructuralMetadataWhere

ReportingCategoryWhere (ReportingCategoryWhereType): ReportingCategoryWhere is used to query for reporting categories matching the parameters supplied. It allows for nested reporting category queries so that hierarchical reporting categories can be queried explicitly by their nested level, although a top level reporting category will always result in a search for reporting categories at any level. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.

Substitution For: ItemWhere

StructureSetWhere (StructureSetWhereType): StructureSetWhere contains the parameters for a structure query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to search based on the structures that are related by the set or the objects which are mapped by the set's maps. In any case, the structure set will be returned according the indicated return detail.

Substitution For: StructuralMetadataWhere

StructuresWhere (StructuresWhereType): StructuresWhere defines the parameters for a structures query. All parameters must be matched for an object to satisfy the query. Only the basic maintainable parameters are available.

Substitution For: StructuralMetadataWhere

TransformationSchemeWhere (TransformationSchemeWhereType): TransformationSchemeWhere contains the parameters for a transformation scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the transformations defined within the scheme.

Substitution For: StructuralMetadataWhere

TransformationWhere (TransformationWhereType): TransformationWhere is used to query for transformations matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.

Substitution For: ItemWhere

VtlMappingSchemeWhere (VtlMappingSchemeWhereType): VtlMappingSchemeWhere contains the parameters for a VTL mapping scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the VTL mappings defined within the scheme.

Substitution For: StructuralMetadataWhere

VtlMappingWhere (VtlMappingWhereType): VtlMappingWhere is used to query for VTL mappings matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.

Substitution For: ItemWhere

NamePersonalisationSchemeWhere (NamePersonalisationSchemeWhereType): NamePersonalisationSchemeWhere contains the parameters for a name personalisation scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the name personalisations defined within the scheme.

Substitution For: StructuralMetadataWhere

NamePersonalisationWhere (NamePersonalisationWhereType): NamePersonalisationWhere is used to query for name personalisations matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.

Substitution For: ItemWhere

RulesetSchemeWhere (RulesetSchemeWhereType): RulesetSchemeWhere contains the parameters for a ruleset scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the rulesets defined within the scheme.

Substitution For: StructuralMetadataWhere

RulesetWhere (RulesetWhereType): RulesetWhere is used to query for rulesets matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.

Substitution For: ItemWhere

UserDefinedOperatorSchemeWhere (UserDefinedOperatorSchemeWhereType): UserDefinedOperatorSchemeWhere contains the parameters for a user defined operator scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the user defined operators defined within the scheme.

Substitution For: StructuralMetadataWhere

UserDefinedOperatorWhere (UserDefinedOperatorWhereType): UserDefinedOperatorWhere is used to query for user defined operators matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.

Substitution For: ItemWhere

CustomTypeSchemeWhere (CustomTypeSchemeWhereType): CustomTypeSchemeWhere contains the parameters for a custom type scheme query. All parameters must be matched for an object to satisfy the query. In addition to querying based on the basic maintainable properties, it is also possible to query based on the details of the custom types defined within the scheme.

Substitution For: StructuralMetadataWhere

CustomTypeWhere (CustomTypeWhereType): CustomTypeWhere is used to query for custom types matching the parameters supplied. This is an implicit set of "and" parameters, meaning all of the conditions must be met in order to return a match.

Substitution For: ItemWhere

2.1.3 Complex Types

ReturnDetailsBaseType: ReturnDetailsBaseType is an abstract type that forms the basis for any query return details.

Attributes:
defaultLimit?, detail?

Content:
{Empty}

Attribute Documentation:

StructuralMetadataQueryType: StructureWhereQueryType is an abstract base type that serves as the basis for any structural metadata query. Concrete instances of this type are implied to be an and-query. A structural object will be returned for any object where all of the conditions are met.

Content:
ReturnDetails, StructuralMetadataWhere

Element Documentation:

StructureReturnDetailsBaseType: StructureReturnDetailsBaseType is an abstract base type which forms the basis of StructureReturnDetailsType.

Derivation:

• ReturnDetailsBaseType (restriction)
  • StructureReturnDetailsBaseType

Attributes:
defaultLimit?, detail?

Content:
{Empty}

Attribute Documentation:

StructureReturnDetailsType: StructureReturnDetailsType defines the structure of the return details for any structural metadata query.

Derivation:

• ReturnDetailsBaseType (restriction)
  • StructureReturnDetailsBaseType (extension)
    • StructureReturnDetailsType

Attributes:
defaultLimit?, detail?, returnMatchedArtefact?

Content:
References

Attribute Documentation:

Element Documentation:

MaintainableReturnDetailsType: MaintainableReturnDetailsType defines the structure for the return details of a non-item scheme maintainable object. It eliminates the detail options that are specific to searching an item scheme

Derivation:

• ReturnDetailsBaseType (restriction)
  • StructureReturnDetailsBaseType (extension)
    • StructureReturnDetailsType (restriction)
      • MaintainableReturnDetailsType

Attributes:
defaultLimit?, detail?, returnMatchedArtefact?

Content:
References

Attribute Documentation:

Element Documentation:

ReferencesType: ReferencesType defines the structure for indicating which referenced objects should be returned in a structural metadata query. It is possible to return both objects which reference the object(s) matched by the query and objects referenced from the match object(s). The type(s) of reference objects to be returned consists of a choice between None, All, Default, or an explicit list of object types.

Attributes:
processConstraints?, detail?

Content:
(None | All | Parents | ParentsAndSiblings | Children | Descendants | SpecificObjects)

Attribute Documentation:

Element Documentation:

AnnotableWhereType: AnnotableWhereType is an abstract base type for querying an annotable artefact.

Content:
Annotation?

Element Documentation:

AnnotationWhereType: AnnotationWhereType defines the structure for querying the details of an annotation.

Content:
Type?, Title?, Text?

Element Documentation:

IdentifiableWhereType: IdentifiableWhereType is an abstract base type that serves as the basis for any query for an identifiable object.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType

Content:
Annotation?, URN?, ID?

Element Documentation:

NameableWhereType: NameableWhereType is an abstract base type that serves as the basis for any query for a nameable object.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType

Content:
Annotation?, URN?, ID?, Name?, Description?

Element Documentation:

VersionableWhereType: VersionableQueryType is an abstract base type that serves as the basis for any query for a versionable object.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?

Element Documentation:

MaintainableWhereType: MaintainableQueryType is an abstract base type that serves as the basis for any query for a maintainable object.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?

Attribute Documentation:

Element Documentation:

ItemSchemeWhereType: ItemSchemeQueryType is an abstract base type that serves as the basis for any query for an item scheme.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (extension)
          • ItemSchemeWhereType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, ItemWhere*

Attribute Documentation:

Element Documentation:

ItemWhereType: ItemQueryType is an abstract base type that serves as the basis for a query for an item within an item scheme query. A nested item where is provided to query for items nested within other items. The conditions within an item query are implied to be in an and-query. If an id and a child item where condition are supplied, then both conditions will have to met in order for the item query to return true. If, for instance, a query based on names in multiple languages is required, then multiple instances of the element utilizing this type should be used within an or-query container.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • ItemWhereType

Content:
Annotation?, URN?, ID?, Name?, Description?, (Parent | ItemWhere+)?

Element Documentation:

StructureWhereType: StructureWhereType is an abstract base type that serves as the basis for a query for a structure object.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (extension)
          • StructureWhereType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, UsedConcept*, UsedRepresentation*, ComponentListWhere*, ComponentWhere*

Attribute Documentation:

Element Documentation:

ComponentListWhereType: ComponentListWhereType is an abstract base type that serves as the basis for a query for a component list within a structure query. A list of component where children are provided to query for the list's child components. The conditions within a component list query are implied to be in an and-query. If an id and a child component where condition are supplied, then both conditions will have to met in order for the component list query to return true. If, for instance, a query based on names in multiple languages is required, then multiple instances of the element utilizing this type should be used within an or-query container.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • ComponentListWhereType

Content:
Annotation?, URN?, ID?, ComponentWhere*

Element Documentation:

ComponentWhereType: ComponentWhereType is an abstract base type that serves as the basis for a query for a component within a component list where or a structure query. A concept identity and a local representation condition are available to seek a component that utilizes a particular concept or representation scheme. The conditions within a component query are implied to be in an and-query. If an id and a concept identity condition are supplied, then both conditions will have to met in order for the component query to return true. If, for instance, a query based on names in multiple languages is required, then multiple instances of the element utilizing this type should be used within an or-query container.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • ComponentWhereType

Content:
Annotation?, URN?, ID?, ConceptIdentity?, Enumeration?

Element Documentation:

StructureUsageWhereType: StructureUsageWhereType is an abstract base type that serves as the basis for a query for a structure usage object.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (extension)
          • StructureUsageWhereType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, Structure?

Attribute Documentation:

Element Documentation:

ConceptValueType: ConceptValueType describes the structure of a query for the value of the underlying concept of a component. It provides a reference to a concept in a concept scheme via a URN and/or a complete set of reference fields, as well as a numeric, text, or un-typed value.

Content:
Concept, (NumericValue[1..2] | TextValue+ | TimeValue[1..2] | Value)

Element Documentation:

CodeValueType: CodeValueType is used to query for data or reference metadata where a component which uses the referenced codelist as its representation enumeration has the value provided. Note that this is only applicable when the value is a coded value, which is to say that it does not apply to a codelist which is specified as the representation or an identifiable object target in a metadata target.

Attributes:
value

Content:
Codelist

Attribute Documentation:

Element Documentation:

SimpleValueType: SimpleValueType describes the structure of a simple value query. A value is provided as the content in string format.

Derivation:

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

Attributes:
operator?

Content:
Attribute Documentation:

NumericValueType: NumericValueType describes the structure of a numeric query. A value is provided as the content in decimal format.

Derivation:

• xs:anySimpleType (restriction)
  • xs:decimal (extension)
    • NumericValueType

Attributes:
operator?

Content:
Attribute Documentation:

QueryStringType: QueryStringType defines the structure of a string query.

Derivation:

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

Attributes:
operator?

Content:
Attribute Documentation:

QueryIDType: QueryIDType defines the structure of a query for an identifier.

Derivation:

• xs:anySimpleType (restriction)
  • xs:string (restriction)
    • com:NestedIDType (restriction)
      • com:IDType (extension)
        • QueryIDType

Attributes:
operator?

Content:
Attribute Documentation:

QueryNestedIDType: QueryNestedIDType defines the structure of a query for a nested identifier.

Derivation:

• xs:anySimpleType (restriction)
  • xs:string (restriction)
    • com:NestedIDType (extension)
      • QueryNestedIDType

Attributes:
operator?

Content:
Attribute Documentation:

QueryTextType: QueryTextType describes the structure of a textual query value. A language must be specified if parallel multi-lingual values are available, otherwise it is ignored.

Derivation:

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

Attributes:
xml:lang?, operator?

Content:
Attribute Documentation:

TimePeriodValueType: TimePeriodValueType describes the structure of a time period query. A value is provided as the content in the SDMX time period format.

Derivation:

• xs:anySimpleType (restriction)
  • com:ObservationalTimePeriodType (extension)
    • TimePeriodValueType

Attributes:
operator?, reportingYearStartDay?

Content:

Attribute Documentation:

CategorisationQueryType: CategorisationQueryType defines the structure of a categorisation query. The parameters for the query are contained in the CategorisationWhere element. The References element is used to indicate how objects that are referenced from the matched categorisations should be returned.

Derivation:

• StructuralMetadataQueryType (restriction)
  • CategorisationQueryType

Content:
ReturnDetails, CategorisationWhere

Element Documentation:

CategorisationWhereBaseType: CategorisationWhereBaseType is an abstract base type which forms the basis for the CategorisationWhereType.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (restriction)
          • CategorisationWhereBaseType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?

Attribute Documentation:

Element Documentation:

CategorisationWhereType: CategorisationWhereType contains a set of parameters for a categorisation query. All supplied parameters must be matched in order for an object to satisfy the query.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (restriction)
          • CategorisationWhereBaseType (extension)
            • CategorisationWhereType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, CategoryScheme?, TargetCategory?, ObjectReference?, CategorisedObjectType*

Attribute Documentation:

Element Documentation:

CategorySchemeQueryType: CategorySchemeQueryType defines the structure of a category scheme query. The parameters for the query are contained in the CategorySchemeWhere element. The References element is used to indicate how objects that reference the matched category scheme should be returned.

Derivation:

• StructuralMetadataQueryType (restriction)
  • CategorySchemeQueryType

Content:
ReturnDetails, CategorySchemeWhere

Element Documentation:

CategorySchemeWhereType: CategorySchemeWhereType defines the parameters of a category scheme query. All supplied parameters must be matched in order for an object to satisfy the query.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (extension)
          • ItemSchemeWhereType (restriction)
            • CategorySchemeWhereType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, CategoryWhere*

Attribute Documentation:

Element Documentation:

CategoryWhereType: CategoryQueryWhereType contains a set of parameters for matching a category. All supplied parameters must be matched in order for an object to satisfy the query.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • ItemWhereType (restriction)
        • CategoryWhereType

Content:
Annotation?, ID?, Name?, Description?, CategoryWhere*

Element Documentation:

CodelistQueryType: CodelistQueryType defines the structure of a codelist query. The parameters for the query are contained in the CodelistWhere element. The References element is used to indicate how objects that reference the matched codelist should be returned.

Derivation:

• StructuralMetadataQueryType (restriction)
  • CodelistQueryType

Content:
ReturnDetails, CodelistWhere

Element Documentation:

CodelistWhereType: CodelistWhereType contains the parameters of a codelist query. All supplied parameters must be matched in order for an object to satisfy the query.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (extension)
          • ItemSchemeWhereType (restriction)
            • CodelistWhereType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, CodeWhere*

Attribute Documentation:

Element Documentation:

CodeWhereType: CodeWhereType defines a set of parameters for matching a code. All supplied parameters must be matched in order for an object to satisfy the query.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • ItemWhereType (restriction)
        • CodeWhereType

Content:
Annotation?, ID?, Name?, Description?, Parent?

Element Documentation:

ConceptSchemeQueryType: ConceptSchemeQueryType defines the structure of a category scheme query. The parameters for the query are contained in the ConceptSchemeWhere element. The References element is used to indicate how objects that reference or are referenced from the matched concept scheme should be returned.

Derivation:

• StructuralMetadataQueryType (restriction)
  • ConceptSchemeQueryType

Content:
ReturnDetails, ConceptSchemeWhere

Element Documentation:

ConceptSchemeWhereType: ConceptSchemeWhereType contains the parameters of a concept scheme query. All supplied parameters must be matched in order for an object to satisfy the query.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (extension)
          • ItemSchemeWhereType (restriction)
            • ConceptSchemeWhereType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, ConceptWhere*

Attribute Documentation:

Element Documentation:

ConceptWhereBaseType: ConceptWhereBaseType is an abstract base type that forms the basis for the ConceptWhereType.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • ItemWhereType (restriction)
        • ConceptWhereBaseType

Content:
Annotation?, ID?, Name?, Description?, Parent?

Element Documentation:

ConceptWhereType: ConceptWhereType defines a set of parameters for matching a concept. All supplied parameters must be matched in order for an object to satisfy the query. In addition to the base parameters for an item, a concept can be queried based on the item scheme that is used as a core representation.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • ItemWhereType (restriction)
        • ConceptWhereBaseType (extension)
          • ConceptWhereType

Content:
Annotation?, ID?, Name?, Description?, Parent?, Enumeration?

Element Documentation:

ConstraintQueryType: ConstraintQueryType defines the structure of a constraint query. The parameters for the query are contained in the ConstraintWhere element. The References element is used to indicate how objects that are referenced from the matched constraint should be returned.

Derivation:

• StructuralMetadataQueryType (restriction)
  • ConstraintQueryType

Content:
ReturnDetails, ConstraintWhere

Element Documentation:

ConstraintWhereBaseType: ConstraintWhereBaseType is an abstract base type which forms the basis for the ConstraintWhereType.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (restriction)
          • ConstraintWhereBaseType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?

Attribute Documentation:

Element Documentation:

ConstraintWhereType: ConstraintWhereType contains the parameters of a constraint query. All supplied parameters must be matched in order for an object to stratify the query.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (restriction)
          • ConstraintWhereBaseType (extension)
            • ConstraintWhereType

Attributes:
type?, allowable?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, ConstraintAttachmentWhere?

Attribute Documentation:

Element Documentation:

ConstraintAttachmentWhereType: ConstraintAttachmentWhereType describes the structure for querying for a constraint based on the objects it is attached to. A constraint attachment query is implicitly an and-query meaning all of the referenced objects must be part of a constraints attachment in order to return a match. It is treated as a condition within its parent query.

Content:
(DataProvider | Dataflow | DataStructure | Metadataflow | MetadataStructure | ProvisionAgreement | DataSet | MetadataSet | DataSourceURL)+

Element Documentation:

DataQueryType: DataQueryType defines the structure of a query for data. This is generally appliable for any data request, but can be refined depending on the type of data being queried (generic or structured, time series specific or not) to the requirements of the requested format.

Content:
ReturnDetails, DataWhere

Element Documentation:

TimeSeriesDataQueryType: TimeSeriesDataQueryType defines the structure of a query for data. This specifically applies to requesting time series only structured data.

Derivation:

• DataQueryType (restriction)
  • TimeSeriesDataQueryType

Content:
ReturnDetails, DataWhere

Element Documentation:

GenericDataQueryType: GenericDataQueryType defines the structure of a query for data formatted in the generic format. This structure generally applies to any type of generic data request, but can be refined to request time series only data.

Derivation:

• DataQueryType (restriction)
  • GenericDataQueryType

Content:
ReturnDetails, DataWhere

Element Documentation:

GenericTimeSeriesDataQueryType: GenericTimeSeriesDataQueryType defines the structure of a query for time series only data formatted in the generic format.

Derivation:

• DataQueryType (restriction)
  • GenericDataQueryType (restriction)
    • GenericTimeSeriesDataQueryType

Content:
ReturnDetails, DataWhere

Element Documentation:

DataReturnDetailsBaseType: DataReturnDetailsBaseType is an abstract base type which forms the basis of the DataReturnDetailsType.

Derivation:

• ReturnDetailsBaseType (restriction)
  • DataReturnDetailsBaseType

Attributes:
defaultLimit?, detail?

Content:
{Empty}

Attribute Documentation:

DataReturnDetailsType: DataReturnDetailsType specifies the specifics of the how data should be returned, including how it should be structured and how many and what type (e.g. active or deleted) observations should be returned.

Derivation:

• ReturnDetailsBaseType (restriction)
  • DataReturnDetailsBaseType (extension)
    • DataReturnDetailsType

Attributes:
defaultLimit?, detail?, observationAction?

Content:
FirstNObservations?, LastNObservations?, Structure*

Attribute Documentation:

Element Documentation:

GenericDataReturnDetailsType: GenericDataReturnDetailsType specifies the specifics of the how data should be returned as it pertains to a request for generic data.

Derivation:

• ReturnDetailsBaseType (restriction)
  • DataReturnDetailsBaseType (extension)
    • DataReturnDetailsType (restriction)
      • GenericDataReturnDetailsType

Attributes:
defaultLimit?, detail?, observationAction?

Content:
FirstNObservations?, LastNObservations?, Structure*

Attribute Documentation:

Element Documentation:

GenericTimeSeriesDataReturnDetailsType: GenericTimeSeriesDataReturnDetailsType specifies the specifics of the how data should be returned as it pertains to a request for time series only oriented data in the generic format.

Derivation:

• ReturnDetailsBaseType (restriction)
  • DataReturnDetailsBaseType (extension)
    • DataReturnDetailsType (restriction)
      • GenericDataReturnDetailsType (restriction)
        • GenericTimeSeriesDataReturnDetailsType

Attributes:
defaultLimit?, detail?, observationAction?

Content:
FirstNObservations?, LastNObservations?, Structure*

Attribute Documentation:

Element Documentation:

TimeSeriesDataReturnDetailsType: TimeSeriesDataReturnDetailsType specifies the specifics of the how data should be returned as it pertains to a request for time series only oriented data in the structured format.

Derivation:

• ReturnDetailsBaseType (restriction)
  • DataReturnDetailsBaseType (extension)
    • DataReturnDetailsType (restriction)
      • TimeSeriesDataReturnDetailsType

Attributes:
defaultLimit?, detail?, observationAction?

Content:
FirstNObservations?, LastNObservations?, Structure*

Attribute Documentation:

Element Documentation:

DataParametersType: DataParametersType defines the parameters for querying for data. This structure is refined by separate And/Or constructs which make logical restrictions on which parameters apply in such cases.

Content:
DataSetID*, DataProvider*, DataStructure*, Dataflow*, ProvisionAgreement*, Category*, Updated[0..2], ConceptValue*, RepresentationValue*, DimensionValue*, TimeDimensionValue*, AttributeValue*, PrimaryMeasureValue*, AttachmentConstraint*, TimeFormat*, Or*, And*

Element Documentation:

DataParametersOrType: DataParametersOrType refines the base data parameters to define a set of parameters joined by an "or" condition. Only one of the parameters supplied in an instance of this type can be satisfied to result in a match.

Derivation:

• DataParametersType (restriction)
  • DataParametersOrType

Content:
DataSetID*, DataProvider*, DataStructure*, Dataflow*, ProvisionAgreement*, Category*, Updated[0..2], ConceptValue*, RepresentationValue*, DimensionValue*, TimeDimensionValue*, AttributeValue*, PrimaryMeasureValue*, AttachmentConstraint*, TimeFormat*, And*

Element Documentation:

DataParametersAndType: DataParametersAndType refines the base data parameters to define a set of parameters joined by an "and" conditions. All of the parameters supplied in an instance of this type must be satisfied to result in a match. As a result of this condition, the maximum occurrence of some parameters has been reduced so as to not allow for impossible conditions to be specified (for example data cannot be matched is it is specified that the data set identifier should be "xyz" and the data identifier should be "abc".

Derivation:

• DataParametersType (restriction)
  • DataParametersAndType

Content:
DataSetID?, DataProvider?, DataStructure?, Dataflow?, ProvisionAgreement?, Category*, Updated[0..2], ConceptValue*, RepresentationValue*, DimensionValue*, TimeDimensionValue?, AttributeValue*, PrimaryMeasureValue?, AttachmentConstraint*, TimeFormat?, Or*

Element Documentation:

DataStructureComponentValueQueryType: DataStructureComponentValueQueryType is an abstract base type that is the basis for query a data structure definition component for a particular value. Multiple values may be supplied, but the component value must match all of the value conditions supplied in order to return a match.

Content:
ID?, (NumericValue[1..2] | TextValue+ | TimeValue[1..2] | Value)?

Element Documentation:

DimensionValueType: DimensionValueType is used to query for data where a given dimension has a particular value.

Derivation:

• DataStructureComponentValueQueryType (restriction)
  • DimensionValueType

Content:
ID, (NumericValue[1..2] | TimeValue[1..2] | Value)

Element Documentation:

AttributeValueType: AttributeValueType is used to query for data where a given attribute has a particular value.

Derivation:

• DataStructureComponentValueQueryType (restriction)
  • AttributeValueType

Content:
ID, (NumericValue[1..2] | TextValue | TimeValue[1..2] | Value)

Element Documentation:

PrimaryMeasureValueType: PrimaryMeasureValueType is used to query for data where the primary measure (i.e. the observed value) has a particular value.

Derivation:

• DataStructureComponentValueQueryType (restriction)
  • PrimaryMeasureValueType

Content:
ID?, (NumericValue[1..2] | TextValue | TimeValue[1..2] | Value)

Element Documentation:

TimeDimensionValueType: TimeDimensionValueType is used to query for data where the time dimension has a particular value.

Derivation:

• DataStructureComponentValueQueryType (restriction)
  • TimeDimensionValueType

Content:
ID?, TimeValue[1..2]

Element Documentation:

DataflowQueryType: DataflowQueryType defines the structure of a dataflow query. The parameters for the query are contained in the DataflowWhere element. The References element is used to indicate how objects that reference or are referenced from the matched dataflow should be returned.

Derivation:

• StructuralMetadataQueryType (restriction)
  • DataflowQueryType

Content:
ReturnDetails, DataflowWhere

Element Documentation:

DataflowWhereType: DataflowWhereType contains the parameters of a dataflow query. All supplied parameters must be matched in order for an object to satisfy the query.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (extension)
          • StructureUsageWhereType (restriction)
            • DataflowWhereType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, Structure?

Attribute Documentation:

Element Documentation:

DataStructureQueryType: DataStructureQueryType defines the structure of a data structure definition query. The parameters for the query are contained in the DataStructureWhere element. The References element is used to indicate how objects that reference or are referenced from the matched data structure definition should be returned.

Derivation:

• StructuralMetadataQueryType (restriction)
  • DataStructureQueryType

Content:
ReturnDetails, DataStructureWhere

Element Documentation:

DataStructureWhereBaseType: DataStructureWhereBaseType is an abstract base type that forms the basis of the DataStructureWhereType.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (extension)
          • StructureWhereType (restriction)
            • DataStructureWhereBaseType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, UsedConcept*, UsedRepresentation*, GroupWhere*

Attribute Documentation:

Element Documentation:

DataStructureWhereType: DataStructureWhereType defines the parameters of a data structure definition query. In addition to querying based on the identification, it is also possible to search for data structure definitions based on information about its components.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (extension)
          • StructureWhereType (restriction)
            • DataStructureWhereBaseType (extension)
              • DataStructureWhereType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, UsedConcept*, UsedRepresentation*, GroupWhere*, AttributeWhere*, DimensionWhere*, MeasureDimensionWhere?, TimeDimensionWhere?, PrimaryMeasureWhere?

Attribute Documentation:

Element Documentation:

GroupWhereBaseType: GroupWhereBaseType is an abstract base type that forms the basis for the GroupWhereType.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • ComponentListWhereType (restriction)
      • GroupWhereBaseType

Content:
Annotation?, ID?, GroupDimensionWhere*

Element Documentation:

GroupWhereType: GroupWhereType defines the parameters querying for a data structure definition based a group meeting the conditions detailed. Parameters include identification, dimensions used in the group, and the group's referenced attachment constraint. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • ComponentListWhereType (restriction)
      • GroupWhereBaseType (extension)
        • GroupWhereType

Content:
Annotation?, ID?, GroupDimensionWhere*, AttachmentConstraint?

Element Documentation:

DataStructureComponentWhereType: DataStructureComponentWhereType defines the basic information for querying for a data structure definition component. The component can be queried based on its identification, the concept from which it takes its semantic, and the code list it uses as its representation,. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • ComponentWhereType (restriction)
      • DataStructureComponentWhereType

Content:
Annotation?, ID?, ConceptIdentity?, Enumeration?

Element Documentation:

AttributeWhereType: AttributeWhereType describes the structure of an attribute query. An attribute can be queried based on its identification, the concept from which it takes its semantic, the role it plays, and the code list it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • ComponentWhereType (restriction)
      • DataStructureComponentWhereType (extension)
        • AttributeWhereType

Content:
Annotation?, ID?, ConceptIdentity?, Enumeration?, Role*

Element Documentation:

DimensionWhereType: DimensionWhereType describes the structure of a dimension query. A dimension can be queried based on its identification, the concept from which it takes its semantic, the role it plays, and the code list it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • ComponentWhereType (restriction)
      • DataStructureComponentWhereType (extension)
        • DimensionWhereType

Content:
Annotation?, ID?, ConceptIdentity?, Enumeration?, Role*

Element Documentation:

TimeDimensionWhereType: TimeDimensionWhereType describes the structure of a time dimension query. The time dimension can be queried based on the concept from which it takes its semantic. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • ComponentWhereType (restriction)
      • DataStructureComponentWhereType (restriction)
        • TimeDimensionWhereType

Content:
Annotation?, ConceptIdentity?

Element Documentation:

MeasureDimensionWhereBaseType: MeasureDimensionWhereBaseType is an abstract base type which forms the basis for a measure dimension query.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • ComponentWhereType (restriction)
      • MeasureDimensionWhereBaseType

Content:
Annotation?, ID?, ConceptIdentity?, Enumeration?

Element Documentation:

MeasureDimensionWhereType: MeasureDimensionWhereType describes the structure of a measure dimension query. A measure dimension can be queried based on its identification, the concept from which it takes its semantic, the role it plays, and the concept scheme which defines its measure concepts. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • ComponentWhereType (restriction)
      • MeasureDimensionWhereBaseType (extension)
        • MeasureDimensionWhereType

Content:
Annotation?, ID?, ConceptIdentity?, Enumeration?, Role*

Element Documentation:

PrimaryMeasureWhereType: MeasureWhereType describes the structure of a measure query. The primary measure can be queried based on the concept from which it takes its semantic, and the code list it uses as the enumeration of its representation. This is an implicit set of "and" parameters, that is the conditions within this must all be met in order to return a match.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • ComponentWhereType (restriction)
      • DataStructureComponentWhereType (restriction)
        • PrimaryMeasureWhereType

Content:
Annotation?, ConceptIdentity?, Enumeration?

Element Documentation:

HierarchicalCodelistQueryType: HierarchicalCodelistQueryType defines the structure of a hierarchical codelist query. The parameters for the query are contained in the HierarchicalCodelistWhere element. The References element is used to indicate how objects that are referenced from the matched hierarchical codelist should be returned.

Derivation:

• StructuralMetadataQueryType (restriction)
  • HierarchicalCodelistQueryType

Content:
ReturnDetails, HierarchicalCodelistWhere

Element Documentation:

HierarchicalCodelistWhereBaseType: HierarchicalCodelistWhereBaseType is an abstract base type which forms the basis for the HierarchicalCodelistWhereType.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (restriction)
          • HierarchicalCodelistWhereBaseType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?

Attribute Documentation:

Element Documentation:

HierarchicalCodelistWhereType: HierarchicalCodelistWhereType contains the parameters of a hierarchical codelist query. All supplied parameters must be matched in order for an object to satisfy the query.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (restriction)
          • HierarchicalCodelistWhereBaseType (extension)
            • HierarchicalCodelistWhereType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, IncludedCodelist*

Attribute Documentation:

Element Documentation:

MetadataQueryType: MetadataQueryType defines the structure of a reference metadata query. Reference metadata is queried as individual reports. The result of this query will be a collection of metadata sets, with only the relevant metadata reports contained within them. If no report level parameters are specified, then the query will result in entire metadata sets being returned.

Content:
ReturnDetails, MetadataParameters

Element Documentation:

MetadataReturnDetailsType: MetadataReturnDetailsType is a structure for detailing how reference metadata should be returned. Only a default size limit can be specified.

Derivation:

• ReturnDetailsBaseType (extension)
  • MetadataReturnDetailsType

Attributes:
defaultLimit?, detail?

Content:
{Empty}

Attribute Documentation:

MetadataParametersType: MetadataParametersType defines the parameters for querying for reference metadata. This structure is refined by separate And/Or constructs which make logical restrictions on which parameters apply in such cases.

Content:
MetadataSetID*, DataProvider*, MetadataStructure*, Metadataflow*, ProvisionAgreement*, Category*, Updated*, ConceptValue*, RepresentationValue*, MetadataTargetValue*, ReportStructureValue*, AttachmentConstraint*, AttachedObject*, AttachedDataKey*, AttachedDataSet*, AttachedReportingPeriod*, Or*, And*

Element Documentation:

MetadataParametersOrType: MetadataParametersOrType refines the base data parameters to define a set of parameters joined by an "or" condition. Only one of the parameters supplied in an instance of this type can be satisfied to result in a match.

Derivation:

• MetadataParametersType (restriction)
  • MetadataParametersOrType

Content:
MetadataSetID*, DataProvider*, MetadataStructure*, Metadataflow*, ProvisionAgreement*, Category*, Updated*, ConceptValue*, RepresentationValue*, MetadataTargetValue*, ReportStructureValue*, AttachmentConstraint*, AttachedObject*, AttachedDataKey*, AttachedDataSet*, AttachedReportingPeriod*, And*

Element Documentation:

MetadataParametersAndType: MetadataParametersAndType refines the base data parameters to define a set of parameters joined by an "and" conditions. All of the parameters supplied in an instance of this type must be satisfied to result in a match. As a result of this condition, the maximum occurrence of some parameters has been reduced so as to not allow for impossible conditions to be specified (for example data cannot be matched is it is specified that the data set identifier should be "xyz" and the data identifier should be "abc".

Derivation:

• MetadataParametersType (restriction)
  • MetadataParametersAndType

Content:
MetadataSetID?, DataProvider?, MetadataStructure?, Metadataflow?, ProvisionAgreement*, Category*, Updated?, ConceptValue*, RepresentationValue*, MetadataTargetValue?, ReportStructureValue?, AttachmentConstraint*, AttachedObject*, AttachedDataKey?, AttachedDataSet?, AttachedReportingPeriod?, Or*

Element Documentation:

MetadataTargetValueType: MetadataTargetValueType describes the structure that is used to match reference metadata where a given metadata target's target object have particular values. If a value is not given for a target object which is part of the metadata target, it is assumed that all values are allowed for that target object. Thus, if no target object values are given in the entire metadata target, the query will simply match ant report where the reference metadata target is used. All target object value conditions must be met to constitute a match.

Content:
ID, TargetObjectValue*

Element Documentation:

TargetObjectValueType: IdentifierComponentValueType describes the structure that is used to match reference metadata where a given identifier component has a particular value.

Content:
ID, (DataSet | DataKey | Object | TimeValue[1..2])

Element Documentation:

ReportStructureValueType: ReportStructureValueType describes the structure that is used to match reference metadata where the metadata attributes of a report structure have particular values. All metadata attribute value conditions must be met to constitute a match.

Content:
ID, MetadataAttributeValue*

Element Documentation:

MetadataAttributeValueType: MetadataAttributeValueType describes the structure that is used to match reference metadata where a metadata attribute has a particular value. Metadata attribute value queries can be nested for querying nested metadata attributes. If no value is provided, then simply the presence of the metadata attribute within the given context will result in a match. All nested metadata attribute value conditions must be met to constitute a match.

Content:
ID, (Value | TextValue+ | NumericValue[1..2] | TimeValue[1..2])?, MetadataAttributeValue*

Element Documentation:

MetadataflowQueryType: MetadataflowQueryType defines the structure of a metadataflow query. The parameters for the query are contained in the MetadataflowWhere element. The References element is used to indicate how objects that reference or are referenced from the matched metadataflow should be returned.

Derivation:

• StructuralMetadataQueryType (restriction)
  • MetadataflowQueryType

Content:
ReturnDetails, MetadataflowWhere

Element Documentation:

MetadataflowWhereType: MetadataflowWhereType contains the parameters of a metadataflow query. All supplied parameters must be matched in order for an object to satisfy the query.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (extension)
          • StructureUsageWhereType (restriction)
            • MetadataflowWhereType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, Structure?

Attribute Documentation:

Element Documentation:

MetadataStructureQueryType: MetadataStructureQueryType defines the structure of a metadata structure definition query. The parameters for the query are contained in the MetadataStructureDefinitionWhere element. The References element is used to indicate how objects that reference or are referenced from the matched metadata structure definition should be returned.

Derivation:

• StructuralMetadataQueryType (restriction)
  • MetadataStructureQueryType

Content:
ReturnDetails, MetadataStructureWhere

Element Documentation:

MetadataStructureWhereBaseType: MetadataStructureWhereBaseType is an abstract base type the forms the basis for the MetadataStructureWhereType.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (extension)
          • StructureWhereType (restriction)
            • MetadataStructureWhereBaseType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, UsedConcept*, UsedRepresentation*

Attribute Documentation:

Element Documentation:

MetadataStructureWhereType: MetadataStructureWhereType defines the parameters of a metadata structure definition query. In addition to querying based on the identification, it is also possible to search for metadata structure definitions based on information about its components.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • NameableWhereType (extension)
      • VersionableWhereType (extension)
        • MaintainableWhereType (extension)
          • StructureWhereType (restriction)
            • MetadataStructureWhereBaseType (extension)
              • MetadataStructureWhereType

Attributes:
type?

Content:
Annotation?, URN?, ID?, Name?, Description?, Version?, VersionTo?, VersionFrom?, VersionActive?, AgencyID?, UsedConcept*, UsedRepresentation*, MetadataTargetWhere*, TargetObjectWhere*, ReportStructureWhere*, MetadataAttributeWhere*

Attribute Documentation:

Element Documentation:

MetadataTargetWhereType: MetadataTargetWhereType describes the structure that is used to query for metadata structure definitions containing a metadata target meeting the conditions detailed. Conditions include the identification and the details of the target objects which make up the metadata target.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • ComponentListWhereType (restriction)
      • MetadataTargetWhereType

Content:
Annotation?, ID?, TargetObjectWhere*

Element Documentation:

TargetObjectWhereBaseType: TargetObjectWhereBaseType is an abstract base type that forms the basis for the TargetObjectWhereType.

Derivation:

• AnnotableWhereType (extension)
  • IdentifiableWhereType (extension)
    • ComponentWhereType (restriction)
      • TargetObjectWhereBaseType

Content:
Annotation?, ID?, Enumeration?

Element Documentation: