Skip to Content

Wiki source code of Part III. Structure

Version 7.21 by Helena on 2025/07/02 12:18
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 = 1 Introduction =
6
7 The structure namespace contains the definition of all [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] constructs. These constructs are intended to be very tightly coupled with the information model to ease the burden of implementers on translating the information from the XML messages into objects based on the information model.
8
9 The conformance with the information was achieved through derivation by extensions, restrictions, and substitutions. Because of some the limitations of XML Schema in these areas, it was often necessary to create intermediate type which formed the basis of the final types which make up the information that is actually exchanged in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] messages. The intermediate types are all abstract, so they are not explicitly used in a message. They do however serve the purpose of creating a strong relation of the schemas to the information model.
10
11 = 2 Schema Documentation =
12
13 == 2.1 Structure Namespace ==
14
15 http://www.sdmx.org/resources/sdmxml/schemas/v3_1/structure
16
17 === 2.1.1 Summary ===
18
19 Referenced Namespaces:
20
21 (% style="width:1042.29px" %)
22 |(% style="width:559px" %) **Namespace**|(% style="width:481px" %) **Prefix**
23 |(% style="width:559px" %) http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|(% style="width:481px" %) common
24 |(% style="width:559px" %) http://www.w3.org/2001/XMLSchema|(% style="width:481px" %) xs
25
26 Contents:
27 38 Global Elements
28 235 Complex Types
29 19 Simple Types
30
31 === 2.1.2 Global Elements ===
32
33 **Structures (StructuresType):** Structures contains constructs for all structural metadata components.
34
35 **//Item (ItemType)//:** Item is an abstract element that serves as a substitution head for all items in an item scheme, including those items nested within other items. Concrete instances of this must use a concrete instance of ItemType.
36
37 Substitutions: Category, Code, *GeoRefCode*, GeoFeatureSetCode, GeoGridCode, Concept, *Organisation*, Agency, DataConsumer, DataProvider, MetadataProvider, OrganisationUnit, ReportingCategory, Transformation, VtlMapping, NamePersonalisation, Ruleset, UserDefinedOperator, CustomType
38
39 **Grouping (GroupingType):** Grouping is an abstract element that serves as a substitution head for all structure groupings. Groupings contain a collection of component lists for a structure. Concrete instances of this must use a concrete instance of GroupingType.
40
41 Substitutions: DataStructureComponents, MetadataStructureComponents
42
43 **ComponentList (ComponentListType):** ComponentList is an abstract element that serves as a substitution head for all component lists. Concrete instances of this must use a concrete instance of ComponentListType.
44
45 Substitutions: AttributeList, DimensionList, Group, MeasureList, MetadataAttributeList
46
47 **Component (ComponentType):** Component is an abstract element that serves as a substitution head for all components. Concrete instances of this must use a concrete instance of ComponentType.
48
49 Substitutions: Attribute, MetadataAttributeUsage, Dimension, TimeDimension, GroupDimension, Measure, MetadataAttribute
50
51 **Category (CategoryType):** Category represents a set of nested categories which describe a simple classification hierarchy.
52
53 Substitution For: Item
54
55 **Code (CodeType):** Code describes a code in a codelist. In addition to the identification and description of the code, basic presentational information is also available. Presentational information not present may be added through the use of annotations.
56
57 Substitution For: Item
58
59 Substitutions: GeoRefCode, GeoFeatureSetCode, GeoGridCode
60
61 ***GeoRefCode* (*GeoRefCodeType*):** GeoRefCode is the abstract base from which specific types of geographic codes will be derived.
62
63 Substitution For: Code
64
65 Substitutions: GeoFeatureSetCode, GeoGridCode
66
67 **GeoFeatureSetCode (GeoFeatureSetCodeType):** 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.
68
69 Substitution For: GeoRefCode
70
71 **GeoGridCode (GeoGridCodeType):** GeoGridCode is a code the represents a geographic grid cell that belongs to a specific grid definition.
72
73 Substitution For: GeoRefCode
74
75 **Concept (ConceptType):** Concept describes the details of a concept within a concept scheme.
76
77 Substitution For: Item
78
79 **DataStructureComponents (DataStructureComponentsType):** DataStructureComponents defines the grouping of the sets of metadata concepts that have a defined structural role in the data structure definition. Note that for any component or group defined in a data structure definition, its id must be unique. This applies to the identifiers explicitly defined by the components as well as those inherited from the concept identity of a component. For example, if two dimensions take their identity from concepts with same identity (regardless of whether the concepts exist in different schemes) one of the dimensions must be provided a different explicit identifier. Although there are XML schema constraints to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a concept from which a component takes its identity cannot be validated against this constraint. Therefore, systems processing data structure definitions will have to perform this check outside of the XML validation. There are also two reserved identifiers in a data structure definition; TIME\_PERIOD, and REPORTING\_YEAR\_START\_DAY. These identifiers may not be used outside of their respective defintions (TimeDimension and ReportingYearStartDay). This applies to both the explicit identifiers that can be assigned to the components or groups as well as an identifier inherited by a component from its concept identity. For example, if an ordinary dimension (i.e. not the time dimension) takes its concept identity from a concept with the identifier TIME\_PERIOD, that dimension must provide a different explicit identifier.
80
81 Substitution For: Grouping
82
83 **AttributeList (AttributeListType):** AttributeList describes the attribute descriptor for the data structure definition. It is a collection of metadata concepts that define the attributes of the data structure definition.
84
85 Substitution For: ComponentList
86
87 **Attribute (AttributeType):** Attribute describes the definition of a data attribute, which is defined as a characteristic of an object or entity.
88
89 Substitution For: Component
90
91 **MetadataAttributeUsage (MetadataAttributeUsageType):** 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 reporing of a metadata attribute to a specific part of the data.
92
93 Substitution For: Component
94
95 **DimensionList (DimensionListType):** DimensionList describes the key descriptor for the data structure definition. It is an ordered set of metadata concepts that, combined, classify a statistical series, such as a time series, and whose values, when combined (the key) in an instance such as a data set, uniquely identify a specific series.
96
97 Substitution For: ComponentList
98
99 **Dimension (DimensionType):** Dimension describes the structure of a dimension, which is defined as a statistical concept used (most probably together with other statistical concepts) to identify a statistical series, such as a time series, e.g. a statistical concept indicating certain economic activity or a geographical reference area.
100
101 Substitution For: Component
102
103 **TimeDimension (TimeDimensionType):** TimeDimension is a special dimension which designates the period in time in which the data identified by the full series key applies.
104
105 Substitution For: Component
106
107 **Group (GroupType):** Group describes a group descriptor in a data structure definition. It is a set metadata concepts (and possibly their values) that define a partial key derived from the key descriptor in a data structure definition.
108
109 Substitution For: ComponentList
110
111 **GroupDimension (GroupDimensionType):** GroupDimension is a component which contains only a reference to a dimension in the key descriptor (DimensionList). Although it is conventional to declare dimensions in the same order as they are declared in the ordered key, there is no requirement to do so - the ordering of the values of the key are taken from the order in which the dimensions are declared. Note that the id of a dimension may be inherited from its underlying concept - therefore this reference value may actually be the id of the concept.
112
113 Substitution For: Component
114
115 **MeasureList (MeasureListType):** MeasureList describes the measure descriptor for a data structure.
116
117 Substitution For: ComponentList
118
119 **Measure (MeasureType):** 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.
120
121 Substitution For: Component
122
123 **MetadataStructureComponents (MetadataStructureComponentsType):** MetadataStructureComponents defines the grouping of the sets of the components that make up the metadata structure definition.
124
125 Substitution For: Grouping
126
127 **MetadataAttributeList (MetadataAttributeListType):** 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.
128
129 Substitution For: ComponentList
130
131 **MetadataAttribute (MetadataAttributeType):** MetadataAttribute defines the a metadata attribute, which is the value of an attribute, such as the instance of a coded or uncoded attribute in a metadata structure definition.
132
133 Substitution For: Component
134
135 ***Organisation* (*OrganisationType*):** Organisation is an abstract substitution head for a generic organisation.
136
137 Substitution For: Item
138
139 Substitutions: Agency, DataConsumer, DataProvider, MetadataProvider, OrganisationUnit
140
141 **Agency (AgencyType):** Agency is an organisation which maintains structural metadata such as classifications, concepts, data structures, and metadata structures.
142
143 Substitution For: Organisation
144
145 **DataConsumer (DataConsumerType):** DataConsumer describes an organisation using data as input for further processing.
146
147 Substitution For: Organisation
148
149 **DataProvider (DataProviderType):** DataProvider describes an organisation that produces data.
150
151 Substitution For: Organisation
152
153 **MetadataProvider (MetadataProviderType):** MetadataProvider describes an organisation that produces metadata .
154
155 Substitution For: Organisation
156
157 **OrganisationUnit (OrganisationUnitType):** OrganisationUnit describes a generic organisation, which serves not predefined role in SDMX.
158
159 Substitution For: Organisation
160
161 **ReportingCategory (ReportingCategoryType):** ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages.
162
163 Substitution For: Item
164
165 **Transformation (TransformationType):** Transformation describes the details of a single transformation within a transformation scheme.
166
167 Substitution For: Item
168
169 **VtlMapping (VtlMappingType):** VtlMapping details a mapping between SDMX and VTL transformation.
170
171 Substitution For: Item
172
173 **NamePersonalisation (NamePersonalisationType):** NamePersonalisation details a name personalisation that is used in a transformation.
174
175 Substitution For: Item
176
177 **Ruleset (RulesetType):** Ruleset details a ruleset within a ruleset scheme.
178
179 Substitution For: Item
180
181 **UserDefinedOperator (UserDefinedOperatorType):** UserDefinedOperator details a user defined operators within a user defined operator scheme.
182
183 Substitution For: Item
184
185 **CustomType (CustomTypeType):** CustomType details a custom type within a custom type scheme.
186
187 Substitution For: Item
188
189 === 2.1.3 Complex Types ===
190
191 **StructuresType:** StructuresType describes the structure of the container for all structural metadata components. The structural components may be explicitly detailed, or referenced from an external structure document or registry service. Best practices dictate that, at a minimum, any structural component that is referenced by another structural component be included by reference.
192
193 Content:
194 ALL(AgencySchemesCategorisationsCategorySchemeMapsCategorySchemesCodelistsConceptSchemeMapsConceptSchemesCustomTypeSchemesDataConstraintsDataConsumerSchemesDataflowsDataProviderSchemesDataStructuresGeographicCodelistsGeoGridCodelistsHierarchiesHierarchyAssociationsMetadataConstraintsMetadataflowsMetadataProviderSchemesMetadataProvisionAgreementsMetadataStructuresNamePersonalisationSchemesOrganisationSchemeMapsOrganisationUnitSchemesProcessesProvisionAgreementsReportingTaxonomiesReportingTaxonomyMapsRepresentationMapsRulesetSchemesStructureMapsTransformationSchemesUserDefinedOperatorSchemesValueListsVtlMappingSchemes)
195
196 Element Documentation:
197
198 |**Name**|**Type**|**Documentation**
199 |AgencySchemes|AgencySchemesType|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.
200 |Categorisations|CategorisationsType|Categorisations contains a collection of structural object categorisations. This container may contain categorisations for many types of objects. The categorisations may be detailed in full, or referenced from an external structure document or registry service.
201 |CategorySchemeMaps|CategorySchemeMapsType|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.
202 |CategorySchemes|CategorySchemesType|CategorySchemes contains a collection of category scheme descriptions. The category schemes may be detailed in full, or referenced from an external structure document or registry service.
203 |Codelists|CodelistsType|Codelists contains a collection of code list descriptions. The code lists may be detailed in full, or referenced from an external structure document or registry service.
204 |ConceptSchemeMaps|ConceptSchemeMapsType|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.
205 |ConceptSchemes|ConceptSchemesType|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.
206 |CustomTypeSchemes|CustomTypeSchemesType|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.
207 |DataConstraints|DataConstraintsType|DataConstraints contains a collection of data constraint descriptions. The constraints may be detailed in full, or referenced from an external structure document or registry service.
208 |DataConsumerSchemes|DataConsumerSchemesType|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.
209 |Dataflows|DataflowsType|Dataflows contains a collection of data flow descriptions. The data flows may be detailed in full, or referenced from an external structure document or registry service.
210 |DataProviderSchemes|DataProviderSchemesType|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.
211 |DataStructures|DataStructuresType|DataStructures contains a collection of data structure definitions. The data structure definitions may be detailed in full, or referenced from an external structure document or registry service.
212 |GeographicCodelists|GeographicCodelistsType|GeographicCodelists contains a collection of geographi codelist descriptions. The codelists may be detailed in full, or referenced from an external structure document or registry service.
213 |GeoGridCodelists|GeoGridCodelistsType|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.
214 |Hierarchies|HierarchiesType|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.
215 |HierarchyAssociation s|HierarchyAssociationsType|HierarchyAssociations contains a collection of hierarchy associations. The associations may be detailed in full, or referenced from an external structure document or registry service.
216 |MetadataConstraints|MetadataConstraintsType|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.
217 |Metadataflows|MetadataflowsType|Metadataflows contains a collection of metadata flow descriptions. The metadata flows may be detailed in full, or referenced from an external structure document or registry service.
218 |MetadataProviderSchemes|MetadataProviderSchemesType|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.
219 |MetadataProvisionAreements|MetadataProvisionAgreementsType|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.
220 |MetadataStructures|MetadataStructuresType|MetadataStructures contains a collection of metadata structure definition descriptions. The metadata structure definitions may be detailed in full, or referenced from an external structure document or registry service.
221 |NamePersonalisationSchemes|NamePersonalisationSchemesType|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.
222 |OrganisationSchemeMaps|OrganisationSchemeMapsType|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.
223 |OrganisationUnitSchemes|OrganisationUnitSchemesType|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.
224 |Processes|ProcessesType|Processes contains a collection of process descriptions. The processes may be detailed in full, or referenced from an external structure document or registry service.
225 |ProvisionAgreements|ProvisionAgreementsType|ProvisionAgreements contains a collection of provision agreements. The provision agreements may be detailed in full, or referenced from an external structure document or registry service.
226 |ReportingTaxonomies|ReportingTaxonomiesType|ReportingTaxonomies contains a collection of reporting taxonomy descriptions. The reporting taxonomies may be detailed in full, or referenced from an external structure document or registry service.
227 |ReportingTaxonomyMaps|ReportingTaxonomyMapsType|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.
228 |RepresentationMaps|RepresentationMapsType|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.
229 |RulesetSchemes|RulesetSchemesType|RulesetSchemes contains a collection of ruleset schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service.
230 |StructureMaps|StructureMapsType|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.
231 |TransformationSchemes|TransformationScheme sType|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.
232 |UserDefinedOperatorSchemes|UserDefinedOperatorSchemesType|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.
233 |ValueLists|ValueListsType|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.
234 |VtlMappingSchemes|VtlMappingSchemesType|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.
235
236 **AgencySchemesType:** 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.
237
238 Content:
239 AgencyScheme+
240
241 Element Documentation:
242
243 |**Name**|**Type**|**Documentation**
244 |AgencyScheme|AgencySchemeType|AgencyScheme provides the details of an agency scheme, in which agencies are described.
245
246 **CategorisationsType:** CategorisationsType describes the structure of the categorisations container. It contains one or more categorisation of a specific object type, which can be explicitly detailed or referenced from an external structure document or registry service. This container may contain categorisations for multiple types of structural objects.
247
248 Content:
249 Categorisation+
250
251 Element Documentation:
252
253 |**Name**|**Type**|**Documentation**
254 |Categorisation|CategorisationType|Categorisation allows for the association of an identifiable object to a category, providing for the classifications of the reference identifiable object. This must either contain the full details of the categorisation, or provide a name and identification information and reference the full details from an external structure document or registry service.
255
256 **CategorySchemeMapsType:** 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.
257
258 Content:
259 CategorySchemeMap+
260
261 Element Documentation:
262
263 |**Name**|**Type**|**Documentation**
264 |CategorySchemeMap|CategorySchemeMapType|CategorySchemeMap provides the details of a category scheme map, which descibes mappings between categories in different schemes.
265
266 **CategorySchemesType:** CategorySchemesType describes the structure of the category schemes container. It contains one or more category scheme, which can be explicitly detailed or referenced from an external structure document or registry service.
267
268 Content:
269 CategoryScheme+
270
271 Element Documentation:
272
273 |**Name**|**Type**|**Documentation**
274 |CategoryScheme|CategorySchemeType|CategoryScheme provides the details of a category scheme, which is the descriptive information for an arrangement or division of categories into groups based on characteristics, which the objects have in common. This provides for a simple, leveled hierarchy or categories.
275
276 **ConceptSchemeMapsType:** 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.
277
278 Content:
279 ConceptSchemeMap+
280
281 Element Documentation:
282
283 |**Name**|**Type**|**Documentation**
284 |ConceptSchemeMap|ConceptSchemeMapType|ConceptSchemeMap provides the details of a concept scheme map, which descibes mappings between concepts in different schemes.
285
286 **ConceptSchemesType:** 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.
287
288 Content:
289 ConceptScheme
290
291 Element Documentation:
292
293 |**Name**|**Type**|**Documentation**
294 |ConceptScheme|ConceptSchemeType|ConceptScheme provides the details of a concept scheme, which is the descriptive information for an arrangement or division of concepts into groups based on characteristics, which the objects have in common. It contains a collection of concept definitions, that may be arranged in simple hierarchies.
295
296 **CodelistsType:** 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.
297
298 Content:
299 Codelist+
300
301 Element Documentation:
302
303 |**Name**|**Type**|**Documentation**
304 |Codelist|CodelistType|Codelist provides the details of a codelist, which is defined as a list from which some statistical concepts (coded concepts) take their values.
305
306 **CustomTypeSchemesType:** 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.
307
308 Content:
309 CustomTypeScheme+
310
311 Element Documentation:
312
313 |**Name**|**Type**|**Documentation**
314 |CustomTypeScheme|CustomTypeSchemeType|CustomTypeScheme provides the details of a custom type scheme, in which user defined operators are described.
315
316 **DataConstraintsType:** DataConstraintsType describes the structure of the data constraints container. It contains one or more data 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.
317
318 Content:
319 DataConstraint+
320
321 Element Documentation:
322
323 |**Name**|**Type**|**Documentation**
324 |DataConstraint|DataConstraintType|DataConstraint specifies a sub set of the definition of the allowable or available content of a data set in terms of the content or in terms of the set of key combinations.
325
326 **DataConsumerSchemesType:** 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.
327
328 Content:
329 DataConsumerScheme+
330
331 Element Documentation:
332
333 |**Name**|**Type**|**Documentation**|
334 |DataConsumerScheme|DataConsumerSchemeType|DataConsumerScheme provides the details of an data consumer scheme, in which data consumers are described.|
335
336 **DataflowsType:** DataflowsType describes the structure of the data flows container. It contains one or more data flow, which can be explicitly detailed or referenced from an external structure document or registry service.
337
338 Content:
339
340 Dataflow+
341
342 Element Documentation:
343
344 |**Name**|**Type**|**Documentation**
345 |Dataflow|DataflowType|Dataflow provides the details of a data flow, which is defined as the structure of data that will be provided for different reference periods.
346
347 **DataProviderSchemesType:** 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.
348
349 Content:
350 DataProviderScheme+
351
352 Element Documentation:
353
354 |**Name**|**Type**|**Documentation**
355 |DataProviderScheme|DataProviderSchemeType|DataProviderScheme provides the details of an data provider scheme, in which data providers are described.
356
357 **DataStructuresType:** DataStructuresType describes the structure of the data structure definitions container. It contains one or more data structure definition, which can be explicitly detailed or referenced from an external structure document or registry service.
358
359 Content:
360 DataStructure+
361
362 Element Documentation:
363
364 |**Name**|**Type**|**Documentation**
365 |DataStructure|DataStructureType|DataStructure provides the details of a data structure definition, which is defined as a collection of metadata concepts, their structure and usage when used to collect or disseminate data.
366
367 **GeographicCodelistsType:** 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.
368
369 Content:
370 GeographicCodelist+
371
372 Element Documentation:
373
374 |**Name**|**Type**|**Documentation**
375 |GeographicCodelist|GeographicCodelistType|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.
376
377 **GeoGridCodelistsType:** 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.
378
379 Content:
380 GeoGridCodelist+
381
382 Element Documentation:
383
384 |**Name**|**Type**|**Documentation**
385 |GeoGridCodelist|GeoGridCodelistType|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.
386
387 **HierarchiesType:** 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.
388
389 Content:
390 Hierarchy+
391
392 Element Documentation:
393
394 |**Name**|**Type**|**Documentation**
395 |Hierarchy|HierarchyType|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.
396
397 **HierarchyAssociationsType:** HiearchyAssociationsType describes the structure of the hierarchy assoications container. It contains one or more hiearchy associations, which can be explicitly detailed or referenced from an external structure document or registry service.
398
399 Content:
400 HierarchyAssociation+
401
402 Element Documentation:
403
404 |**Name**|**Type**|**Documentation**
405 |HierarchyAssociation|HierarchyAssociation Type|HierarchyAssociation provides the details of a hiearchy assoication, which associates a hiearchy with an identifiable object in the context of another object.
406
407 **MetadataConstraintsType:** 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.
408
409 Content:
410 MetadataConstraint+
411
412 Element Documentation:
413
414 |**Name**|**Type**|**Documentation**
415 |MetadataConstraint|MetadataConstraintType|MetadataConstraint specifies a sub set of the definition of the allowable content of a metadata set.
416
417 **MetadataflowsType:** MetadataflowsType describes the structure of the metadata flows container. It contains one or more metadata flow, which can be explicitly detailed or referenced from an external structure document or registry service.
418
419 Content:
420 Metadataflow+
421
422 Element Documentation:
423
424 |**Name**|**Type**|**Documentation**
425 |Metadataflow|MetadataflowType|Metadataflow provides the details of a metadata flow, which is defined as the structure of reference metadata that will be provided for different reference periods
426
427 **MetadataProviderSchemesType:** 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.
428
429 Content:
430 MetadataProviderScheme+
431
432 Element Documentation:
433
434 |**Name**|**Type**|**Documentation**
435 |MetadataProviderSche me|MetadataProviderSchemeType|MetadataProviderScheme provides the details of an metadata provider scheme, in which metadata providers are described.
436
437 **MetadataProvisionAgreementsType:** 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.
438
439 Content:
440 MetadataProvisionAgreement+
441
442 Element Documentation:
443
444 |**Name**|**Type**|**Documentation**|
445 |MetadataProvisionAgreement|MetadataProvisionAgreementType|MetadataProvisionAgreement provides the details of a metadata provision agreement, which is an agreement for a metadata provider to report reference metadata against a flow.|
446
447 **MetadataStructuresType:** MetadataStructuresType describes the structure of the metadata structure definitions container. It contains one or more metadata structure definition, which can be explicitly detailed or referenced from an external structure document or registry service.
448
449 Content:
450 MetadataStructure+
451
452 Element Documentation:
453
454 |**Name**|**Type**|**Documentation**
455 |MetadataStructure|MetadataStructureType|MetadataStructure provides the details of a metadata structure definition, which is defined as a collection of metadata concepts, their structure and usage when used to collect or disseminate reference metadata. A metadata structure definition performs several functions: it groups sets of objects into "targets" against which reference metadata may be reported. Targets define the structure of the reference metadata "keys" which identify specific types of reported metadata, and describe the valid values for populating the keys. Also, metadata structure definitions provide a presentational organization of concepts for reporting purposes. The structure of reference metadata is derived from this presentational structure.
456
457 **NamePersonalisationSchemesType:** 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.
458
459 Content:
460 NamePersonalisationScheme+
461
462 Element Documentation:
463
464 |**Name**|**Type**|**Documentation**
465 |NamePersonalisationScheme|NamePersonalisationSchemeType|NamePersonalisationScheme provides the details of a name personalisation scheme, in which name personalisations are described.
466
467 **OrganisationSchemeMapsType:** 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.
468
469 Content:
470 OrganisationSchemeMap+
471
472 Element Documentation:
473
474 |**Name**|**Type**|**Documentation**
475 |OrganisationSchemeMap|OrganisationSchemeMapType|OrganisationSchemeMap provides the details of a organisation scheme map, which descibes mappings between organisations in different schemes.
476
477 **OrganisationUnitSchemesType:** 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.
478
479 Content:
480 OrganisationUnitScheme+
481
482 Element Documentation:
483
484 |**Name**|**Type**|**Documentation**
485 |OrganisationUnitScheme|OrganisationUnitSchemeType|OrganisationUnitScheme provides the details of an organisation unit scheme, in which organisation units are described.
486
487 **ProcessesType:** ProcessesType describes the structure of the processes container. It contains one or more process, which can be explicitly detailed or referenced from an external structure document or registry service.
488
489 Content:
490 Process+
491
492 Element Documentation:
493
494 |**Name**|**Type**|**Documentation**
495 |Process|ProcessType|Process provides the details of a process, which is a scheme which defines or documents the operations performed on data in order to validate data or to derive new information according to a given set of rules. It is not meant to support process automation, but serves as a description of how processes occur. The primary use for this structural mechanism is the attachment of reference metadata regarding statistical processing. This must either contain the full details of the category scheme, or provide a name and identification information and reference the full details from an external structure document or registry service.
496
497 **ProvisionAgreementsType:** ProvisionAgreementsType describes the structure of the provision agreements container. It contains one or more provision agreement, which can be explicitly detailed or referenced from an external structure document or registry service.
498
499 Content:
500 ProvisionAgreement+
501
502 Element Documentation:
503
504 |**Name**|**Type**|**Documentation**
505 |ProvisionAgreement|ProvisionAgreementType|ProvisionAgreement provides the details of a provision agreement, which is an agreement for a data provider to report data against a flow.
506
507 **ReportingTaxonomiesType:** ReportingTaxonomiesType describes the structure of the reporting taxonomies container. It contains one or more reporting taxonomy, which can be explicitly detailed or referenced from an external structure document or registry service.
508
509 Content:
510 ReportingTaxonomy+
511
512 Element Documentation:
513
514 |**Name**|**Type**|**Documentation**
515 |ReportingTaxonomy|ReportingTaxonomyType|ReportingTaxonomy provides the details of a reporting taxonomy, which is a scheme which defines the composition structure of a data report where each component can be described by an independent data or metadata flow definition.
516
517 **ReportingTaxonomyMapsType:** 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.
518
519 Content:
520 ReportingTaxonomyMap+
521
522 Element Documentation:
523
524 |**Name**|**Type**|**Documentation**
525 |ReportingTaxonomyMap|ReportingTaxonomyMapType|ReportingTaxonomyMap provides the details of a reporting taxonomy map, which descibes mappings between reporting taxonomies.
526
527 **RepresentationMapsType:** 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.
528
529 Content:
530 RepresentationMap+
531
532 Element Documentation:
533
534 |**Name**|**Type**|**Documentation**
535 |RepresentationMap|RepresentationMapType|RepresentationMap provides the details of a represenation map, which describes mappings between various component represenations.
536
537 **RulesetSchemesType:** 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.
538
539 Content:
540 RulesetScheme+
541
542 Element Documentation:
543
544 |**Name**|**Type**|**Documentation**
545 |RulesetScheme|RulesetSchemeType|RulesetScheme provides the details of a ruleset scheme, in which rulesets are described.
546
547 **StructureMapsType:** 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.
548
549 Content:
550 StructureMap+
551
552 Element Documentation:
553
554 |**Name**|**Type**|**Documentation**
555 |StructureMap|StructureMapType|StructureMap provides the details or a structure map, which describes mapping between data structures or dataflows.
556
557 **TransformationSchemesType:** 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.
558
559 Content:
560
561 TransformationScheme+
562
563 Element Documentation:
564
565 |**Name**|**Type**|**Documentation**
566 |TransformationScheme|TransformationScheme Type|TransformationScheme provides the details of a transformation scheme, in which transformations are described.
567
568 **UserDefinedOperatorSchemesType:** 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.
569
570 Content:
571 UserDefinedOperatorScheme+
572
573 Element Documentation:
574
575 |**Name**|**Type**|**Documentation**
576 |UserDefinedOperatorScheme|UserDefinedOperatorSchemeType|UserDefinedOperatorScheme provides the details of a user defined operator scheme, in which user defined operators are described.
577
578 **ValueListsType:** 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.
579
580 Content:
581
582 ValueList+
583
584 Element Documentation:
585
586 |**Name**|**Type**|**Documentation**
587
588 **VtlMappingSchemesType:** 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.
589
590 Content:
591
592 VtlMappingScheme+
593
594 Element Documentation:
595
596 |**Name**|**Type**|**Documentation**
597 |VtlMappingScheme|VtlMappingSchemeType|VtlMappingScheme provides the details of a VTL mapping scheme, in which VTL mappings are described.
598
599 **ItemSchemeType:** ItemSchemeType is an abstract base type for all item scheme objects. It contains a collection of items. Concrete instances of this type should restrict the actual types of items allowed within the scheme.
600
601 Derivation:
602 AnnotableType (extension)
603 IdentifiableType (extension)
604 NameableType (extension)
605 VersionableType (restriction)
606 MaintainableBaseType (extension)
607 MaintainableType (extension)
608 ItemSchemeType
609
610 Attributes:
611 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?
612
613 Content:
614 Annotations?, Link*, Name+, Description*, Item*
615
616 Attribute Documentation:
617
618 |**Name**|**Type**|**Documentation**
619 |id|IDType|The id is the identifier for the object.
620 |urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
621 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
622 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
623 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
624 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
625 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
626 |isExternalReference default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
627 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
628 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
629 |isPartialLanguage (default: false)|xs:boolean|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’.
630 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.
631
632 Element Documentation:
633
634 |**Name**|**Type**|**Documentation**
635 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
636 |Link|LinkType|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.
637 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
638 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
639 |*Item*|*ItemType*|Item is an abstract element that serves as a substitution head for all items in an item scheme, including those items nested within other items. Concrete instances of this must use a concrete instance of ItemType.
640
641 **ItemBaseType:** ItemBaseType is an abstract base type that forms the basis for the ItemType. It requires that at least an id be supplied for an item.
642
643 Derivation:
644 AnnotableType (extension)
645 IdentifiableType (extension)
646 NameableType (restriction)
647 ItemBaseType
648
649 Attributes:
650 id, urn?, uri?
651
652 Content:
653 Annotations?, Link*, Name+, Description
654
655 Attribute Documentation:
656
657 |**Name**|**Type**|**Documentation**
658 |id|IDType|The id is the identifier for the object.
659 |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
660 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
661
662 Element Documentation:
663
664 |**Name**|**Type**|**Documentation**
665 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
666 |Link|LinkType|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.
667 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
668 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
669
670 ***ItemType*:** ItemType is an abstract base type for all items with in an item scheme. Concrete instances of this type may or may not utilize the nested item, but if so should restrict the actual types of item allowed.
671
672 Derivation:
673 AnnotableType (extension)
674 IdentifiableType (extension)
675 NameableType (restriction)
676 ItemBaseType (extension)
677 ItemType
678
679 Attributes:
680 id, urn?, uri?
681
682 Content:
683 Annotations?, Link*, Name+, Description*, (Parent |Item+ )?
684
685 Attribute Documentation:
686
687 |**Name**|**Type**|**Documentation**
688 |id|IDType|The id is the identifier for the object.
689 |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
690 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
691
692 Element Documentation:
693
694 |**Name**|**Type**|**Documentation**
695 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
696 |Link|LinkType|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.
697 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
698 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
699 |Parent|NestedIDType|
700 |*Item*|*ItemType*|Item is an abstract element that serves as a substitution head for all items in an item scheme, including those items nested within other items. Concrete instances of this must use a concrete instance of ItemType.
701
702 ***UnnestedItemType*:** UnnestedItemType is an abstract base type for all items with in an item scheme that do not contain nested items.
703
704 Derivation:
705 AnnotableType (extension)
706 IdentifiableType (extension)
707 NameableType (restriction)
708 ItemBaseType (extension)
709 ItemType (restriction)
710 UnnestedItemType
711
712 Attributes:
713 id, urn?, uri?
714
715 Content:
716 Annotations?, Link, Name+, Description
717
718 Attribute Documentation:
719
720 |**Name**|**Type**|**Documentation**
721 |id|IDType|The id is the identifier for the object.
722 |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
723 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
724
725 Element Documentation:
726
727 |**Name**|**Type**|**Documentation**
728 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
729 |Link|LinkType|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.
730 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
731 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
732
733 ***StructureType*:** StructureType is an abstract base type for all structure objects. Concrete instances of this should restrict to a concrete grouping.
734
735 Derivation:
736 AnnotableType (extension)
737 IdentifiableType (extension)
738 NameableType (extension)
739 VersionableType (restriction)
740 MaintainableBaseType (extension)
741 MaintainableType (extension)
742 StructureType
743
744 Attributes:
745 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
746
747 Content:
748 Annotations?, Link*, Name+, Description*, Grouping?
749
750 Attribute Documentation:
751
752 |**Name**|**Type**|**Documentation**
753 |id|IDType|The id is the identifier for the object.
754 |urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
755 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
756 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
757 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
758 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
759 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
760 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
761 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
762 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
763 |isPartialLanguage (default: false)|xs:boolean|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’.
764
765 Element Documentation:
766
767 |**Name**|**Type**|**Documentation**
768 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
769 |Link|LinkType|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.
770 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
771 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
772 |*Grouping*|*GroupingType*|Grouping is an abstract element that serves as a substitution head for all structure groupings. Groupings contain a collection of component lists for a structure. Concrete instances of this must use a concrete instance of GroupingType.
773
774 ***GroupingType*:** GroupType is an abstract base type for specific structure groupings. It contains a collection of component lists. Concrete instances of this should restrict to specific concrete component lists.
775
776 Content:
777 ComponentList
778
779 Element Documentation:
780
781 |**Name**|**Type**|**Documentation**|
782 |*ComponentList*|*ComponentListType*|ComponentList is an abstract element that serves as a substitution head for all component lists. Concrete instances of this must use a concrete instance of ComponentListType.|
783
784 ***ComponentListType*:** ComponentListType is an abstract base type for all component lists. It contains a collection of components. Concrete types should restrict this to specific concrete components.
785
786 Derivation:
787 AnnotableType (extension)
788 IdentifiableType (extension)
789 ComponentListType
790
791 Attributes:
792 id?, urn?, uri?
793
794 Content:
795 Annotations?, Link*, Component
796
797 Attribute Documentation:
798
799 |**Name**|**Type**|**Documentation**
800 |id|IDType|The id is the identifier for the object.
801 |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
802 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
803
804 Element Documentation:
805
806 |**Name**|**Type**|**Documentation**
807 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
808 |Link|LinkType|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.
809 |*Component*|*ComponentType*|Component is an abstract element that serves as a substitution head for all components. Concrete instances of this must use a concrete instance of ComponentType.
810
811 ***ComponentBaseType*:** ComponentBaseType is an abstract type that only serves the purpose of forming the base for the actual ComponentType. It only restricts the format of the id attribute to the NCNameIDType.
812
813 Derivation:
814 AnnotableType (extension)
815 IdentifiableType (restriction)
816 ComponentBaseType
817
818 Attributes:
819 id?, urn?, uri?
820
821 Content:
822 Annotations?, Link
823
824 Attribute Documentation:
825
826 |**Name**|**Type**|**Documentation**
827 |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).
828 |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
829 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
830
831 Element Documentation:
832
833 |**Name**|**Type**|**Documentation**
834 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
835 |Link|LinkType|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.
836
837 ***ComponentType*:** ComponentType is an abstract base type for all components. It contains information pertaining to a component, including an optional reference to a concept, an optional role played by the concept, an optional text format description, and an optional local representation.
838
839 Derivation:
840 AnnotableType (extension)
841 IdentifiableType (restriction)
842 ComponentBaseType (extension)
843 ComponentType
844
845 Attributes:
846 id?, urn?, uri?
847
848 Content:
849 Annotations?, Link*, ConceptIdentity?, LocalRepresentation?
850
851 Attribute Documentation:
852
853 |**Name**|**Type**|**Documentation**
854 |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).
855 |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
856 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
857
858 Element Documentation:
859
860 |**Name**|**Type**|**Documentation**
861 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
862 |Link|LinkType|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.
863 |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.
864 |LocalRepresentation|*RepresentationType*|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.
865
866 ***StructureUsageType*:** StructureUsageType is an abstract base type for all structure usages. It contains a reference to a structure. Concrete instances of this type should restrict the type of structure referenced.
867
868 Derivation:
869 AnnotableType (extension)
870 IdentifiableType (extension)
871 NameableType (extension)
872 VersionableType (restriction)
873 MaintainableBaseType (extension)
874 MaintainableType (extension)
875 StructureUsageType
876
877 Attributes:
878 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
879
880 Content:
881 Annotations?, Link*, Name+, Description*, Structure?
882
883 Attribute Documentation:
884
885 |**Name**|**Type**|**Documentation**
886 |id|IDType|The id is the identifier for the object.
887 |urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
888 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
889 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
890 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
891 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
892 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
893 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
894 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
895 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
896 |isPartialLanguage (default: false)|xs:boolean|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’.
897
898 Element Documentation:
899
900 |**Name**|**Type**|**Documentation**
901 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
902 |Link|LinkType|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.
903 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
904 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
905 |Structure|StructureReferenceType|Structure references the structure (data structure or metadata structure definition) which the structure usage is based upon. Implementations will have to refine the type to use a concrete structure reference (i.e. either a data structure or metadata structure definition reference).
906
907 ***RepresentationType*:** RepresentationType is an abstract type that defines a representation. Because the type of item schemes that are allowed as the an enumeration vary based on the object in which this is defined, this type is abstract to force that the enumeration reference be restricted to the proper type of item scheme reference.
908
909 Attributes:
910 minOccurs?, maxOccurs?
911
912 Content:
913 (TextFormat|(Enumeration, EnumerationFormat?))
914
915 Attribute Documentation:
916
917 |**Name**|**Type**|**Documentation**
918 |minOccurs (default: 1)|xs: nonNegativeInteger|The minOccurs attribute indicates the minimum number of value that must be reported for the component.
919 |maxOccurs|OccurenceType|The maxOccurs attribute indicates the maximum number of values that can be reported for the component.
920
921 Element Documentation:
922
923 |**Name**|**Type**|**Documentation**
924 |TextFormat|TextFormatType|TextFormat describes an uncoded textual format.
925 |Enumeration|AnyCodelistReferenceType|Enumeration references an item scheme that enumerates the allowable values for this representation.
926 |EnumerationFormat|CodedTextFormatType|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.
927
928 **TextFormatType:** TextFormatType defines the information for describing a full range of text formats and may place restrictions on the values of the other attributes, referred to as "facets".
929
930 Attributes:
931 textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?, isMultiLingual?
932
933 Content:
934 SentinelValue
935
936 Attribute Documentation:
937
938 |**Name**|**Type**|**Documentation**
939 |textType (default: String)|DataType|The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets.
940 |isSequence|xs:boolean|The isSequence attribute indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue attributes or the timeInterval, startTime, and endTime, attributes. If this attribute holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely.
941 |interval|xs:decimal|The interval attribute specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence attribute must have a value of true.
942 |startValue|xs:decimal|The startValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed.
943 |endValue|xs:decimal|The endValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates that ending point (if any) of the sequence.
944 |timeInterval|xs:duration|The timeInterval attribute indicates the permitted duration in a time sequence. In order for this to be used, the isSequence attribute must have a value of true.
945 |startTime|StandardTimePeriodType|The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.
946 |endTime|StandardTimePeriodType|The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence.
947 |minLength|xs:positiveInteger|The minLength attribute specifies the minimum and length of the value in characters.
948 |maxLength|xs:positiveInteger|The maxLength attribute specifies the maximum length of the value in characters.
949 |minValue|xs:decimal|The minValue attribute is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid value will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive.
950 |maxValue|xs:decimal|The maxValue attribute is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid value will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive.
951 |decimals|xs:positiveInteger|The decimals attribute indicates the number of characters allowed after the decimal separator.
952 |pattern|xs:string|The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema.
953 |isMultiLingual (default: true)|xs:boolean|The isMultiLingual attribute indicates for a text format of type "string", whether the value should allow for multiple values in different languages.
954
955 Element Documentation:
956
957 |**Name**|**Type**|**Documentation**
958 |SentinelValue|SentinelValueType|SentinelValue defines a value that has a special meaning within the text format representation of a component.
959
960 **SentinelValueType:** 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.
961
962 Attributes:
963 value
964
965 Content:
966 Name+, Description
967
968 Attribute Documentation:
969
970 |**Name**|**Type**|**Documentation**
971 |value|xs:anySimpleType|The sentinel value being described.
972
973 Element Documentation:
974
975 |**Name**|**Type**|**Documentation**
976 |Name|TextType|Name is a reusable element, used for providing a human-readable name for an object.
977 |Description|TextType|Description is a reusable element, used for providing a longer human-readable description of an object.
978
979 **BasicComponentTextFormatType:** BasicComponentTextFormatType is a restricted version of the TextFormatType that restricts the text type to the representations allowed for all components except for target objects.
980
981 Derivation:
982 TextFormatType (restriction)
983 BasicComponentTextFormatType
984
985 Attributes:
986 textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?, isMultiLingual?
987
988 Content:
989 SentinelValue
990
991 Attribute Documentation:
992
993 |**Name**|**Type**|**Documentation**
994 |textType (default: String)|BasicComponentDataType|The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets.
995 |isSequence|xs:boolean|The isSequence attribute indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue attributes or the timeInterval, startTime, and endTime, attributes. If this attribute holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely.
996 |interval|xs:decimal|The interval attribute specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence attribute must have a value of true.
997 |startValue|xs:decimal|The startValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed.
998 |endValue|xs:decimal|The endValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates that ending point (if any) of the sequence.
999 |timeInterval|xs:duration|The timeInterval attribute indicates the permitted duration in a time sequence. In order for this to be used, the isSequence attribute must have a value of true.
1000 |startTime|StandardTimePeriodType|The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.
1001 |endTime|StandardTimePeriodType|The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence.
1002 |minLength|xs:positiveInteger|The minLength attribute specifies the minimum and length of the value in characters.
1003 |maxLength|xs:positiveInteger|The maxLength attribute specifies the maximum length of the value in characters.
1004 |minValue|xs:decimal|The minValue attribute is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid value will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive.
1005 |maxValue|xs:decimal|The maxValue attribute is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid value will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive.
1006 |decimals|xs:positiveInteger|The decimals attribute indicates the number of characters allowed after the decimal separator.
1007 |pattern|xs:string|The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema.
1008 |isMultiLingual (default: true)|xs:boolean|The isMultiLingual attribute indicates for a text format of type "string", whether the value should allow for multiple values in different languages.
1009
1010 Element Documentation:
1011
1012 |**Name**|**Type**|**Documentation**
1013 |SentinelValue|SentinelValueType|SentinelValue defines a value that has a special meaning within the text format representation of a component.
1014
1015 **SimpleComponentTextFormatType:** SimpleComponentTextFormatType is a restricted version of the BasicComponentTextFormatType that does not allow for multi-lingual values.
1016
1017 Derivation:
1018 TextFormatType (restriction)
1019 BasicComponentTextFormatType (restriction)
1020 SimpleComponentTextFormatType
1021
1022 Attributes:
1023 textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?
1024
1025 Content:
1026 SentinelValue
1027
1028 Attribute Documentation:
1029
1030 |**Name**|**Type**|**Documentation**
1031 |textType (default: String)|SimpleDataType|The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets.
1032 |isSequence|xs:boolean|The isSequence attribute indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue attributes or the timeInterval, startTime, and endTime, attributes. If this attribute holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely.
1033 |interval|xs:decimal|The interval attribute specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence attribute must have a value of true.
1034 |startValue|xs:decimal|The startValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed.
1035 |endValue|xs:decimal|The endValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates that ending point (if any) of the sequence.
1036 |timeInterval|xs:duration|The timeInterval attribute indicates the permitted duration in a time sequence. In order for this to be used, the isSequence attribute must have a value of true.
1037 |startTime|StandardTimePeriodType|The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.
1038 |endTime|StandardTimePeriodType|The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence.
1039 |minLength|xs:positiveInteger|The minLength attribute specifies the minimum and length of the value in characters.
1040 |maxLength|xs:positiveInteger|The maxLength attribute specifies the maximum length of the value in characters.
1041 |minValue|xs:decimal|The minValue attribute is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid value will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive.
1042 |maxValue|xs:decimal|The maxValue attribute is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid value will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive.
1043 |decimals|xs:positiveInteger|The decimals attribute indicates the number of characters allowed after the decimal separator.
1044 |pattern|xs:string|The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema.
1045
1046 Element Documentation:
1047
1048 |**Name**|**Type**|**Documentation**
1049 |SentinelValue|SentinelValueType|SentinelValue defines a value that has a special meaning within the text format representation of a component.
1050
1051 **CodedTextFormatType:** CodedTextFormatType is a restricted version of the SimpleComponentTextFormatType that only allows factets and text types applicable to codes. Although the time facets permit any value, an actual code identifier does not support the necessary characters for time. Therefore these facets should not contain time in their values.
1052
1053 Derivation:
1054 TextFormatType (restriction)
1055 BasicComponentTextFormatType (restriction)
1056 SimpleComponentTextFormatType (restriction)
1057 CodedTextFormatType
1058
1059 Attributes:
1060 textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, pattern?
1061
1062 Content:
1063 {Empty}
1064
1065 Attribute Documentation:
1066
1067 |**Name**|**Type**|**Documentation**
1068 |textType|CodeDataType|The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets.
1069 |isSequence|xs:boolean|The isSequence attribute indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue attributes or the timeInterval, startTime, and endTime, attributes. If this attribute holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely.
1070 |interval|xs:integer|The interval attribute specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence attribute must have a value of true.
1071 |startValue|xs:integer|The startValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed.
1072 |endValue|xs:integer|The endValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates that ending point (if any) of the sequence.
1073 |timeInterval|xs:duration|The timeInterval attribute indicates the permitted duration in a time sequence. In order for this to be used, the isSequence attribute must have a value of true.
1074 |startTime|StandardTimePeriodType|The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.
1075 |endTime|StandardTimePeriodType|The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence.
1076 |minLength|xs:positiveInteger|The minLength attribute specifies the minimum and length of the value in characters.
1077 |maxLength|xs:positiveInteger|The maxLength attribute specifies the maximum length of the value in characters.
1078 |minValue|xs:integer|The minValue attribute is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid value will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive.
1079 |maxValue|xs:integer|The maxValue attribute is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid value will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive.
1080 |pattern|xs:string|The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema.
1081
1082 **NonFacetedTextFormatType:** NonFacetedTextFormatType is a restricted version of the SimpleComponentTextFormatType that does not allow for any facets.
1083
1084 Derivation:
1085 TextFormatType (restriction)
1086 BasicComponentTextFormatType (restriction)
1087 SimpleComponentTextFormatType (restriction)
1088 NonFacetedTextFormatType
1089
1090 Attributes:
1091 textType?
1092
1093 Content:
1094 {Empty}
1095
1096 Attribute Documentation:
1097
1098 |**Name**|**Type**|**Documentation**
1099 |textType|SimpleDataType|The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets.
1100
1101 **TimeTextFormatType:** TimeTextFormat is a restricted version of the SimpleComponentTextFormatType that only allows time based format and specifies a default ObservationalTimePeriod representation and facets of a start and end time.
1102
1103 Derivation:
1104 TextFormatType (restriction)
1105 BasicComponentTextFormatType (restriction)
1106 SimpleComponentTextFormatType (restriction)
1107 TimeTextFormatType
1108
1109 Attributes:
1110 textType?, startTime?, endTime?
1111
1112 Content:
1113 SentinelValue
1114
1115 Attribute Documentation:
1116
1117 |**Name**|**Type**|**Documentation**
1118 |textType (default: ObservationalTimePeriod)|TimeDataType|The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets.
1119 |startTime|StandardTimePeriodType|The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.
1120 |endTime|StandardTimePeriodType|The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence.
1121
1122 Element Documentation:
1123
1124 |**Name**|**Type**|**Documentation**|
1125 |SentinelValue|SentinelValueType|SentinelValue defines a value that has a special meaning within the text format representation of a component.|
1126
1127 ***CategorisationBaseType*:** CategorisationBaseType defines the base refinement of the CategorisationType. Its purpose is to retrict the urn attribute.
1128
1129 Derivation:
1130 AnnotableType (extension)
1131 IdentifiableType (extension)
1132 NameableType (extension)
1133 VersionableType (restriction)
1134 MaintainableBaseType (extension)
1135 MaintainableType (restriction)
1136 CategorisationBaseType
1137
1138 Attributes:
1139 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
1140
1141 Content:
1142 Annotations?, Link*, Name+, Description
1143
1144 Attribute Documentation:
1145
1146 |**Name**|**Type**|**Documentation**
1147 |id|IDType|The id is the identifier for the object.
1148 |urn|CategorisationUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1149 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1150 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
1151 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1152 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1153 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1154 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1155 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1156 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1157 |isPartialLanguage (default: false)|xs:boolean|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’.
1158
1159 Element Documentation:
1160
1161 |**Name**|**Type**|**Documentation**
1162 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1163 |Link|LinkType|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.
1164 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1165 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1166
1167 **CategorisationType:** CategorisationType is defines the structure for a categorisation. A source object is referenced via an object reference and the target category is referenced via the target category.
1168
1169 Derivation:
1170 AnnotableType (extension)
1171 IdentifiableType (extension)
1172 NameableType (extension)
1173 VersionableType (restriction)
1174 MaintainableBaseType (extension)
1175 MaintainableType (restriction)
1176 CategorisationBaseType (extension)
1177 CategorisationType
1178
1179 Attributes:
1180 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
1181
1182 Content:
1183 Annotations?, Link*, Name+, Description*, (Source, Target)?
1184
1185 Attribute Documentation:
1186
1187 |**Name**|**Type**|**Documentation**
1188 |id|IDType|The id is the identifier for the object.
1189 |urn|CategorisationUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1190 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1191 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
1192 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1193 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1194 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1195 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1196 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1197 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1198 |isPartialLanguage (default: false)|xs:boolean|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’.
1199
1200 Element Documentation:
1201
1202 |**Name**|**Type**|**Documentation**
1203 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1204 |Link|LinkType|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.
1205 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1206 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1207 |Source|UrnReferenceType|Source is a reference to an object to be categorized.
1208 |Target|CategoryReferenceType|Target is reference to the category that the referenced object is to be mapped to.
1209
1210 **CategorySchemeType:** CategorySchemeType describes the structure of a category scheme. A category scheme is the descriptive information for an arrangement or division of categories into groups based on characteristics, which the objects have in common. This provides for a simple, leveled hierarchy or categories.
1211
1212 Derivation:
1213 AnnotableType (extension)
1214 IdentifiableType (extension)
1215 NameableType (extension)
1216 VersionableType (restriction)
1217 MaintainableBaseType (extension)
1218 MaintainableType (restriction)
1219 ItemSchemeType (restriction)
1220 CategorySchemeType
1221
1222 Attributes:
1223 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?
1224
1225 Content:
1226 Annotations?, Link*, Name+, Description*, Category
1227
1228 Attribute Documentation:
1229
1230 |**Name**|**Type**|**Documentation**
1231 |id|NCNameIDType|The id attribute holds the identification of the category scheme. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the category scheme may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).
1232 |urn|CategorySchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1233 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1234 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
1235 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1236 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1237 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1238 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1239 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1240 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1241 |isPartialLanguage (default: false)|xs:boolean|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’.
1242 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.
1243
1244 Element Documentation:
1245
1246 |**Name**|**Type**|**Documentation**
1247 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1248 |Link|LinkType|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.
1249 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1250 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1251 |Category|CategoryType|Category represents a set of nested categories which describe a simple classification hierarchy.
1252
1253 **CategoryType:** CategoryType describes the details of a category. A category is defined as an item at any level in a classification. The Category element represents a set of nested categories which are child categories.
1254
1255 Derivation:
1256 AnnotableType (extension)
1257 IdentifiableType (extension)
1258 NameableType (restriction)
1259 ItemBaseType (extension)
1260 ItemType (restriction)
1261 CategoryType
1262
1263 Attributes:
1264 id, urn?, uri?
1265
1266 Content:
1267 Annotations?, Link*, Name+, Description*, Category\
1268
1269 Attribute Documentation:
1270
1271 |**Name**|**Type**|**Documentation**
1272 |id|IDType|The id is the identifier for the object.
1273 |urn|CategoryUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1274 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1275
1276 Element Documentation:
1277
1278 |**Name**|**Type**|**Documentation**
1279 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1280 |Link|LinkType|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.
1281 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1282 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1283 |Category|CategoryType|Category represents a set of nested categories which describe a simple classification hierarchy.
1284
1285 ***CodelistBaseType*:** CodelistType defines the structure of a codelist. A codelist is defined as a list from which some statistical concepts (coded concepts) take their values.
1286
1287 Derivation:
1288 AnnotableType (extension)
1289 IdentifiableType (extension)
1290 NameableType (extension)
1291 VersionableType (restriction)
1292 MaintainableBaseType (extension)
1293 MaintainableType (restriction)
1294 ItemSchemeType (restriction)
1295 CodelistBaseType
1296
1297 Attributes:
1298 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?
1299
1300 Content:
1301 Annotations?, Link*, Name+, Description*, (Code|GeoFeatureSetCode|GeoGridCode)
1302
1303 Attribute Documentation:
1304
1305 |**Name**|**Type**|**Documentation**
1306 |id|NCNameIDType|The id attribute holds the identification of the code list. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the code list may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).
1307 |urn|CodelistUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1308 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1309 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
1310 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1311 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1312 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1313 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1314 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1315 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1316 |isPartialLanguage (default: false)|xs:boolean|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’.
1317 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.
1318
1319 Element Documentation:
1320
1321 |**Name**|**Type**|**Documentation**
1322 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1323 |Link|LinkType|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.
1324 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1325 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1326 |Code|CodeType|Code describes a code in a codelist. In addition to the identification and description of the code, basic presentational information is also available. Presentational information not present may be added through the use of annotations.
1327
1328 **CodelistType:**
1329
1330 Derivation:
1331 AnnotableType (extension)
1332 IdentifiableType (extension)
1333 NameableType (extension)
1334 VersionableType (restriction)
1335 MaintainableBaseType (extension)
1336 MaintainableType (restriction)
1337 ItemSchemeType (restriction)
1338 CodelistBaseType (extension)
1339 CodelistType
1340
1341 Attributes:
1342 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?
1343
1344 Content:
1345 Annotations?, Link*, Name+, Description*, (Code|GeoFeatureSetCode|GeoGridCode)*, CodelistExtension
1346
1347 Attribute Documentation:
1348
1349 |**Name**|**Type**|**Documentation**
1350 |id|NCNameIDType|The id attribute holds the identification of the code list. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the code list may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).
1351 |urn|CodelistUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1352 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1353 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
1354 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1355 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1356 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1357 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1358 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1359 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1360 |isPartialLanguage (default: false)|xs:boolean|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’.
1361 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.
1362
1363 Element Documentation:
1364
1365 |**Name**|**Type**|**Documentation**
1366 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1367 |Link|LinkType|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.
1368 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1369 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1370 |Code|CodeType|Code describes a code in a codelist. In addition to the identification and description of the code, basic presentational information is also available. Presentational information not present may be added through the use of annotations.**Substitutions:** GeoFeatureSetCode, GeoGridCode
1371 |CodelistExtension|CodelistExtensionType|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.
1372
1373 **CodeType:** CodeType describes the structure of a code. A code is defined as a language independent set of letters, numbers or symbols that represent a concept whose meaning is described in a natural language. Presentational information not present may be added through the use of annotations.
1374
1375 Derivation:
1376 AnnotableType (extension)
1377 IdentifiableType (extension)
1378 NameableType (restriction)
1379 ItemBaseType (extension)
1380 ItemType (restriction)
1381 CodeType
1382
1383 Attributes:
1384 id, urn?, uri?
1385
1386 Content:
1387 Annotations?, Link*, Name+, Description*, Parent?
1388
1389 Attribute Documentation:
1390
1391 |**Name**|**Type**|**Documentation**
1392 |id|IDType|The id is the identifier for the object.
1393 |urn|CodeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1394 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1395
1396 Element Documentation:
1397
1398 |**Name**|**Type**|**Documentation**
1399 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1400 |Link|LinkType|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.
1401 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. It may be used in place of a short description.
1402 |Description|TextType|Description provides a plain text, human-readable description of the code. This may be provided in multiple, parallel language-equivalent forms.
1403 |Parent|SingleNCNameIDType|Parent provides the ability to describe simple hierarchies within a single codelist, by referencing the id value of another code in the same codelist.
1404
1405 **CodelistExtensionType:** 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.
1406
1407 Attributes:
1408 prefix?
1409
1410 Content:
1411 Codelist, (InclusiveCodeSelection|ExclusiveCodeSelection)?
1412
1413 Attribute Documentation:
1414
1415 |**Name**|**Type**|**Documentation**
1416 |prefix|xs:string|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.
1417
1418 Element Documentation:
1419
1420 |**Name**|**Type**|**Documentation**
1421 |Codelist|CodelistReferenceType|
1422 |InclusiveCodeSelection|CodeSelectionType|Selection of codes from the referenced (extended) codelist to be included in the extending codelist.
1423 |ExclusiveCodeSelection|CodeSelectionType|Selection of codes from the referenced (extended) codelist to be excluded in the extending codelist.
1424
1425 **CodeSelectionType:** CodeSelectionType defines the structure for code selection to be used as inclusive or exclusive extensions.
1426
1427 Content:
1428 MemberValue+
1429
1430 Element Documentation:
1431
1432 |**Name**|**Type**|**Documentation**
1433 |MemberValue|MemberValueType|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.
1434
1435 **MemberValueType:** Allows for a ditinct reference or a wildcard expression for selecting codes from a codelist.
1436
1437 Derivation:
1438
1439 xs:anySimpleType (restriction)
1440 xs:string (restriction)
1441 WildcardedMemberValueType (extension)
1442 MemberValueType
1443
1444 Attributes:
1445 cascadeValues?
1446
1447 Content:
1448
1449 Attribute Documentation:
1450
1451 |**Name**|**Type**|**Documentation**
1452 |cascadeValues|CascadeSelectionType|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)).
1453
1454 ***GeoCodelistBaseType*:** GeoCodelistBaseType is an abstract base refinement of a codelist that restricts the cods to be derived from the abstract GeoRefCode.
1455
1456 Derivation:
1457 AnnotableType (extension)
1458 IdentifiableType (extension)
1459 NameableType (extension)
1460 VersionableType (restriction)
1461 MaintainableBaseType (extension)
1462 MaintainableType (restriction)
1463 ItemSchemeType (restriction)
1464 CodelistBaseType (extension)
1465 CodelistType (restriction)
1466 GeoCodelistBaseType
1467
1468 Attributes:
1469 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?
1470
1471 Content:
1472 Annotations?, Link*, Name+, Description*, GeoRefCode, CodelistExtension
1473
1474 Attribute Documentation:
1475
1476 |**Name**|**Type**|**Documentation**
1477 |id|NCNameIDType|The id attribute holds the identification of the code list. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the code list may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).
1478 |urn|CodelistUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1479 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1480 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
1481 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1482 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1483 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1484 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1485 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1486 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1487 |isPartialLanguage (default: false)|xs:boolean|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’.
1488 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.
1489
1490 Element Documentation:
1491
1492 |**Name**|**Type**|**Documentation**
1493 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1494 |Link|LinkType|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.
1495 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1496 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1497 |*GeoRefCode*|*GeoRefCodeType*|GeoRefCode is the abstract base from which specific types of geographic codes will be derived.
1498 |CodelistExtension|CodelistExtensionType|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.
1499
1500 ***GeoCodelistType*:** GeoCodelistType is an abstract refinement of a codelist from which specific types of geographic codelists will be derived.
1501
1502 Derivation:
1503 AnnotableType (extension)
1504 IdentifiableType (extension)
1505 NameableType (extension)
1506 VersionableType (restriction)
1507 MaintainableBaseType (extension)
1508 MaintainableType (restriction)
1509 ItemSchemeType (restriction)
1510 CodelistBaseType (extension)
1511 CodelistType (restriction)
1512 GeoCodelistBaseType (extension)
1513 GeoCodelistType
1514
1515 Attributes:
1516 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, geoType
1517
1518 Content:
1519 Annotations?, Link*, Name+, Description*, GeoRefCode, CodelistExtension
1520
1521 Attribute Documentation:
1522
1523 |**Name**|**Type**|**Documentation**|
1524 |id|NCNameIDType|The id attribute holds the identification of the code list. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the code list may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).|
1525 |urn|CodelistUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
1526 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
1527 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
1528 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
1529 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
1530 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
1531 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
1532 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
1533 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
1534 |isPartialLanguage (default: false)|xs:boolean|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’.|
1535 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.|
1536 |geoType|GeoCodelistTypeType|The type of geographic codelist. The will be refined and provided a fixed value in the specific geographic codelist type implementations.|
1537
1538 Element Documentation:
1539
1540 |**Name**|**Type**|**Documentation**|
1541 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
1542 |Link|LinkType|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.|
1543 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
1544 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
1545 |*GeoRefCode*|*GeoRefCodeType*|GeoRefCode is the abstract base from which specific types of geographic codes will be derived.|
1546 |CodelistExtension|CodelistExtensionType|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.|
1547
1548 **GeoRefCodeType:** GeoRefCodeType is the abstract base type defining the structure of geographic codes.
1549
1550 Derivation:
1551 AnnotableType (extension)
1552 IdentifiableType (extension)
1553 NameableType (restriction)
1554 ItemBaseType (extension)
1555 ItemType (restriction)
1556 CodeType (extension)
1557 GeoRefCodeType
1558
1559 Attributes:
1560 id, urn?, uri?
1561
1562 Content:
1563 Annotations?, Link*, Name+, Description*, Parent?
1564
1565 Attribute Documentation:
1566
1567 |**Name**|**Type**|**Documentation**|
1568 |id|IDType|The id is the identifier for the object.|
1569 |urn|CodeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
1570 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
1571
1572 Element Documentation:
1573
1574 |**Name**|**Type**|**Documentation**
1575 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1576 |Link|LinkType|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.
1577 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. It may be used in place of a short description.
1578 |Description|TextType|Description provides a plain text, human-readable description of the code. This may be provided in multiple, parallel language-equivalent forms.
1579 |Parent|SingleNCNameIDType|Parent provides the ability to describe simple hierarchies within a single codelist, by referencing the id value of another code in the same codelist.
1580
1581 **GeographicCodelistType:** GeographicCodelistType defines the sturcture 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.
1582
1583 Derivation:
1584 AnnotableType (extension)
1585 IdentifiableType (extension)
1586 NameableType (extension)
1587 VersionableType (restriction)
1588 MaintainableBaseType (extension)
1589 MaintainableType (restriction)
1590 ItemSchemeType (restriction)
1591 CodelistBaseType (extension)
1592 CodelistType (restriction)
1593 GeoCodelistBaseType (extension)
1594 GeoCodelistType (restriction)
1595 GeographicCodelistType
1596
1597 Attributes:
1598 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, geoType
1599
1600 Content:
1601 Annotations?, Link*, Name+, Description*, GeoFeatureSetCode\*, CodelistExtension
1602
1603 Attribute Documentation:
1604
1605 |**Name**|**Type**|**Documentation**
1606 |id|NCNameIDType|The id attribute holds the identification of the code list. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the code list may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).
1607 |urn|CodelistUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1608 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1609 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
1610 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1611 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1612 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1613 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1614 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1615 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1616 |isPartialLanguage (default: false)|xs:boolean|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’.
1617 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.
1618 |geoType (fixed: GeographicCodelist)|GeoCodelistTypeType|The type of geographic codelist. The will be refined and provided a fixed value in the specific geographic codelist type implementations.
1619
1620 Element Documentation:
1621
1622 |**Name**|**Type**|**Documentation**
1623 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1624 |Link|LinkType|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.
1625 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1626 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1627 |GeoFeatureSetCode|GeoFeatureSetCodeType|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.
1628 |CodelistExtension|CodelistExtensionType|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.
1629
1630 **GeoFeatureSetCodeType:** GeoFeatureSetCodeType defines the structure of a geogrphic code.
1631
1632 Derivation:
1633 AnnotableType (extension)
1634 IdentifiableType (extension)
1635 NameableType (restriction)
1636 ItemBaseType (extension)
1637 ItemType (restriction)
1638 CodeType (extension)
1639 GeoRefCodeType (extension)
1640 GeoFeatureSetCodeType
1641
1642 Attributes:
1643 id, urn?, uri?, value
1644
1645 Content:
1646 Annotations?, Link*, Name+, Description*, Parent?
1647
1648 Attribute Documentation:
1649
1650 |**Name**|**Type**|**Documentation**
1651 |id|IDType|The id is the identifier for the object.
1652 |urn|CodeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1653 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1654 |value|xs:string|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).
1655
1656 Element Documentation:
1657
1658 |**Name**|**Type**|**Documentation**| |
1659 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| |
1660 |Link|LinkType|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.| |
1661 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. It may be used in place of a short description.| |
1662 |Description|TextType|Description provides a plain text, human-readable description of the code. This may be provided in multiple, parallel language-equivalent forms.| |
1663 |Parent|SingleNCNameIDType|Parent provides the ability to describe simple hierarchies within a single codelist, by referencing the id value of another code in the same codelist.| |
1664
1665 ***GeoGridCodelistBaseType*:** GeoGridCodelistBaseType is the abstract base refinement for a geographic grid codelist.
1666
1667 Derivation:
1668 AnnotableType (extension)
1669 IdentifiableType (extension)
1670 NameableType (extension)
1671 VersionableType (restriction)
1672 MaintainableBaseType (extension)
1673 MaintainableType (restriction)
1674 ItemSchemeType (restriction)
1675 CodelistBaseType (extension)
1676 CodelistType (restriction)
1677 GeoCodelistBaseType (extension)
1678 GeoCodelistType (restriction)
1679 GeoGridCodelistBaseType
1680
1681 Attributes:
1682 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, geoType
1683
1684 Content:
1685 Annotations?, Link*, Name+, Description*, GeoGridCode*, CodelistExtension
1686
1687 Attribute Documentation:
1688
1689 |**Name**|**Type**|**Documentation**
1690 |id|NCNameIDType|The id attribute holds the identification of the code list. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the code list may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).
1691 |urn|CodelistUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1692 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1693 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
1694 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1695 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1696 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1697 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1698 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1699 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1700 |isPartialLanguage (default: false)|xs:boolean|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’.
1701 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.
1702 |geoType (fixed: GeoGridCodelist)|GeoCodelistTypeType|The type of geographic codelist. The will be refined and provided a fixed value in the specific geographic codelist type implementations.
1703
1704 Element Documentation:
1705
1706 |**Name**|**Type**|**Documentation**|
1707 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
1708 |Link|LinkType|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.|
1709 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
1710 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
1711 |GeoGridCode|GeoGridCodeType|GeoGridCode is a code the represents a geographic grid cell that belongs to a specific grid definition.|
1712 |CodelistExtension|CodelistExtensionType|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.|
1713
1714 **GeoGridCodelistType:** 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.
1715
1716 Derivation:
1717 AnnotableType (extension)
1718 IdentifiableType (extension)
1719 NameableType (extension)
1720 VersionableType (restriction)
1721 MaintainableBaseType (extension)
1722 MaintainableType (restriction)
1723 ItemSchemeType (restriction)
1724 CodelistBaseType (extension)
1725 CodelistType (restriction)
1726 GeoCodelistBaseType (extension)
1727 GeoCodelistType (restriction)
1728 GeoGridCodelistBaseType (extension)
1729 GeoGridCodelistType
1730
1731 Attributes:
1732 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, geoType
1733
1734 Content:
1735 Annotations?, Link*, Name+, Description*, GeoGridCode*, CodelistExtension*, GridDefinition
1736
1737 Attribute Documentation:
1738
1739 |**Name**|**Type**|**Documentation**
1740 |id|NCNameIDType|The id attribute holds the identification of the code list. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the code list may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).
1741 |urn|CodelistUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1742 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1743 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
1744 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1745 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1746 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1747 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1748 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1749 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1750 |isPartialLanguage (default: false)|xs:boolean|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’.
1751 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.
1752 |geoType (fixed: GeoGridCodelist)|GeoCodelistTypeType|The type of geographic codelist. The will be refined and provided a fixed value in the specific geographic codelist type implementations.
1753
1754 Element Documentation:
1755
1756 |**Name**|**Type**|**Documentation**
1757 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1758 |Link|LinkType|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.
1759 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1760 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1761 |GeoGridCode|GeoGridCodeType|GeoGridCode is a code the represents a geographic grid cell that belongs to a specific grid definition.
1762 |CodelistExtension|CodelistExtensionType|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.
1763 |GridDefinition|xs:string|Contains a regular expression string corresponding to the grid definition for the GeoGrid Codelist.
1764
1765 **GeoGridCodeType:** GeoGridCodeType defines the structure of a geographic grid cell.
1766
1767 Derivation:
1768 AnnotableType (extension)
1769 IdentifiableType (extension)
1770 NameableType (restriction)
1771 ItemBaseType (extension)
1772 ItemType (restriction)
1773 CodeType (extension)
1774 GeoRefCodeType (extension)
1775 GeoGridCodeType
1776
1777 Attributes:
1778 id, urn?, uri?
1779
1780 Content:
1781 Annotations?, Link*, Name+, Description*, Parent?, GeoCell
1782
1783 Attribute Documentation:
1784
1785 |**Name**|**Type**|**Documentation**| |
1786 |id|IDType|The id is the identifier for the object.| |
1787 |urn|CodeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| |
1788 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| |
1789
1790 Element Documentation:
1791
1792 |**Name**|**Type**|**Documentation**
1793 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1794 |Link|LinkType|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.
1795 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. It may be used in place of a short description.
1796 |Description|TextType|Description provides a plain text, human-readable description of the code. This may be provided in multiple, parallel language-equivalent forms.
1797 |Parent|SingleNCNameIDType|Parent provides the ability to describe simple hierarchies within a single codelist, by referencing the id value of another code in the same codelist.
1798 |GeoCell|xs:string|The value used to assign the Code to one cell in the grid.
1799
1800 ***ValueListBaseType*:** ValueListBaseType defines the base refinement of the ValueListType. Its purpose is to retrict the urn attribute.
1801
1802 Derivation:
1803 AnnotableType (extension)
1804 IdentifiableType (extension)
1805 NameableType (extension)
1806 VersionableType (restriction)
1807 MaintainableBaseType (extension)
1808 MaintainableType (restriction)
1809 ValueListBaseType
1810
1811 Attributes:
1812 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
1813
1814 Content:
1815
1816 Annotations?, Link*, Name+, Description
1817
1818 Attribute Documentation:
1819
1820 |**Name**|**Type**|**Documentation**
1821 |id|IDType|The id is the identifier for the object.
1822 |urn|ValueListUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1823 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1824 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
1825 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1826 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1827 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1828 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1829 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1830 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1831 |isPartialLanguage (default: false)|xs:boolean|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’.
1832
1833 Element Documentation:
1834
1835 |**Name**|**Type**|**Documentation**
1836 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1837 |Link|LinkType|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.
1838 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1839 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1840
1841 **ValueListType:** 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).
1842
1843 Derivation:
1844 AnnotableType (extension)
1845 IdentifiableType (extension)
1846 NameableType (extension)
1847 VersionableType (restriction)
1848 MaintainableBaseType (extension)
1849 MaintainableType (restriction)
1850 ValueListBaseType (extension)
1851 ValueListType
1852
1853 Attributes:
1854 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
1855
1856 Content:
1857 Annotations?, Link*, Name+, Description*, ValueItem
1858
1859 Attribute Documentation:
1860
1861 |**Name**|**Type**|**Documentation**
1862 |id|IDType|The id is the identifier for the object.
1863 |urn|ValueListUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1864 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1865 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
1866 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1867 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1868 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1869 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1870 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1871 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1872 |isPartialLanguage (default: false)|xs:boolean|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’.
1873
1874 Element Documentation:
1875
1876 |**Name**|**Type**|**Documentation**
1877 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1878 |Link|LinkType|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.
1879 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1880 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1881 |ValueItem|ValueItemType|
1882
1883 **ValueItemType:** ValueItemType defines the structure of a value item. A value must be provided, and a longer name and description can be provided to provide additiona meaning to the value (similar to a code in a code list).
1884
1885 Derivation:
1886 AnnotableType (extension)
1887 ValueItemType
1888
1889 Attributes:
1890 id
1891
1892 Content:
1893 Annotations?, Name*, Description
1894
1895 Attribute Documentation:
1896
1897 |**Name**|**Type**|**Documentation**
1898 |id|xs:string|
1899
1900 Element Documentation:
1901
1902 |**Name**|**Type**|**Documentation**
1903 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1904 |Name|TextType|Name is a reusable element, used for providing a human-readable name for an object.
1905 |Description|TextType|Description is a reusable element, used for providing a longer human-readable description of an object.
1906
1907 **ConceptSchemeType:** ConceptSchemeType describes the structure of a concept scheme. A concept scheme is the descriptive information for an arrangement or division of concepts into groups based on characteristics, which the objects have in common. It contains a collection of concept definitions, that may be arranged in simple hierarchies.
1908
1909 Derivation:
1910 AnnotableType (extension)
1911 IdentifiableType (extension)
1912 NameableType (extension)
1913 VersionableType (restriction)
1914 MaintainableBaseType (extension)
1915 MaintainableType (restriction)
1916 ItemSchemeType (restriction)
1917 ConceptSchemeType
1918
1919 Attributes:
1920 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?
1921
1922 Content:
1923 Annotations?, Link*, Name+, Description*, Concept
1924
1925 Attribute Documentation:
1926
1927 |**Name**|**Type**|**Documentation**
1928 |id|NCNameIDType|The id attribute holds the identification of the concept scheme. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the concept scheme may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).
1929 |urn|ConceptSchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1930 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1931 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
1932 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1933 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1934 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1935 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1936 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1937 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1938 |isPartialLanguage (default: false)|xs:boolean|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’.
1939 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.
1940
1941 Element Documentation:
1942
1943 |**Name**|**Type**|**Documentation**
1944 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1945 |Link|LinkType|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.
1946 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1947 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1948 |Concept|ConceptType|Concept describes the details of a concept within a concept scheme.
1949
1950 **ConceptBaseType:** ConceptBaseType is an abstract base type the forms the basis of the ConceptType by requiring a name and id, and restricting the content of the id.
1951
1952 Derivation:
1953 AnnotableType (extension)
1954 IdentifiableType (extension)
1955 NameableType (restriction)
1956 ItemBaseType (extension)
1957 ItemType (restriction)
1958 ConceptBaseType
1959
1960 Attributes:
1961 id, urn?, uri?
1962
1963 Content:
1964 Annotations?, Link*, Name+, Description*, Parent?
1965
1966 Attribute Documentation:
1967
1968 |**Name**|**Type**|**Documentation**|
1969 |id|NCNameIDType|The id attribute holds the identification of the concept. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since concept id may be used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).|
1970 |urn|ConceptUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
1971 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
1972
1973 Element Documentation:
1974
1975 |**Name**|**Type**|**Documentation**|
1976 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
1977 |Link|LinkType|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.|
1978 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
1979 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
1980 |Parent|SingleNCNameIDType|Parent captures the semantic relationships between concepts which occur within a single concept scheme. This identifies the concept of which the current concept is a qualification (in the ISO 11179 sense) or subclass.|
1981
1982 **ConceptType:** ConceptType describes the details of a concept. A concept is defined as a unit of knowledge created by a unique combination of characteristics. If a concept does not specify a TextFormat or a core representation, then the representation of the concept is assumed to be represented by any set of valid characters (corresponding to the xs:string datatype of W3C XML Schema).
1983
1984 Derivation:
1985 AnnotableType (extension)
1986 IdentifiableType (extension)
1987 NameableType (restriction)
1988 ItemBaseType (extension)
1989 ItemType (restriction)
1990 ConceptBaseType (extension)
1991 ConceptType
1992
1993 Attributes:
1994 id, urn?, uri?
1995
1996 Content:
1997 Annotations?, Link*, Name+, Description*, Parent?, CoreRepresentation?, ISOConceptReference?
1998
1999 Attribute Documentation:
2000
2001 |**Name**|**Type**|**Documentation**|
2002 |urn|ConceptUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
2003 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
2004
2005 Element Documentation:
2006
2007 |**Name**|**Type**|**Documentation**
2008 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2009 |Link|LinkType|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.
2010 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
2011 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
2012 |Parent|SingleNCNameIDType|Parent captures the semantic relationships between concepts which occur within a single concept scheme. This identifies the concept of which the current concept is a qualification (in the ISO 11179 sense) or subclass.
2013 |CoreRepresentation|ConceptRepresentation|
2014 |ISOConceptReference|ISOConceptReferenceType|Provides a reference to an ISO 11179 concept.
2015
2016 **ConceptRepresentation:** ConceptRepresentation defines the core representation that are allowed for a concept. The text format allowed for a concept is that which is allowed for any non-target object component.
2017
2018 Derivation:
2019 RepresentationType (restriction)
2020 ConceptRepresentation
2021
2022 Attributes:
2023 minOccurs?, maxOccurs?
2024
2025 Content:
2026 (TextFormat|(Enumeration, EnumerationFormat?))
2027
2028 Attribute Documentation:
2029
2030 |**Name**|**Type**|**Documentation**
2031 |minOccurs (default: 1)|xs: nonNegativeInteger|The minOccurs attribute indicates the minimum number of value that must be reported for the component.
2032 |maxOccurs|OccurenceType|The maxOccurs attribute indicates the maximum number of values that can be reported for the component.
2033
2034 Element Documentation:
2035
2036 |**Name**|**Type**|**Documentation**
2037 |TextFormat|BasicComponentTextFo rmatType|TextFormat describes an uncoded textual format.
2038 |Enumeration|AnyCodelistReference Type|Enumeration references a codelist which enumerates the possible values that can be used as the representation of this concept.
2039 |EnumerationFormat|CodedTextFormatType|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.
2040
2041 **ISOConceptReferenceType:** ISOConceptReferenceType provides a reference to and ISO 11179 concept.
2042
2043 Content:
2044 ConceptAgency, ConceptSchemeID, ConceptID
2045
2046 Element Documentation:
2047
2048 |**Name**|**Type**|**Documentation**|
2049 |ConceptAgency|xs:string|
2050 |ConceptSchemeID|xs:string|
2051 |ConceptID|xs:string|
2052
2053 **ConstraintBaseType:** ConstraintBaseType is an abstract base type that forms the basis of the main abstract ConstraintType. It requires that a name be provided.
2054
2055 Derivation:
2056
2057 AnnotableType (extension)
2058 IdentifiableType (extension)
2059 NameableType (extension)
2060 VersionableType (restriction)
2061 MaintainableBaseType (extension)
2062 MaintainableType (restriction)
2063 ConstraintBaseType
2064
2065 Attributes:
2066 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
2067
2068 Content:
2069 Annotations?, Link*, Name+, Description
2070
2071 Attribute Documentation:
2072
2073 |**Name**|**Type**|**Documentation**|
2074 |id|IDType|The id is the identifier for the object.|
2075 |urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
2076 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
2077 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
2078 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
2079 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
2080 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
2081 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
2082 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
2083 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
2084 |isPartialLanguage (default: false)|xs:boolean|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’.|
2085
2086 Element Documentation:
2087
2088 |**Name**|**Type**|**Documentation**|
2089 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
2090 |Link|LinkType|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.|
2091 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
2092 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
2093
2094 **ConstraintType:** ConstraintType is an abstract base type that specific types of constraints (data and metadata) restrict and extend to describe their details. These constraint types both define a constraint attachment and a release calendar.
2095
2096 Derivation:
2097
2098 AnnotableType (extension)
2099 IdentifiableType (extension)
2100 NameableType (extension)
2101 VersionableType (restriction)
2102 MaintainableBaseType (extension)
2103 MaintainableType (restriction)
2104 ConstraintBaseType (extension)
2105 ConstraintType
2106
2107 Attributes:
2108 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role
2109
2110 Content:
2111 Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?
2112
2113 Attribute Documentation:
2114
2115 |**Name**|**Type**|**Documentation**
2116 |id|IDType|The id is the identifier for the object.
2117 |urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2118 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2119 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
2120 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
2121 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
2122 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
2123 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
2124 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
2125 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
2126 |isPartialLanguage (default: false)|xs:boolean|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’.
2127 |role|ConstraintRoleType|The role attribute indicates whether this constraint states what data is actually present for the constraint attachment, or if it defines what content is allowed.
2128
2129 Element Documentation:
2130
2131 |**Name**|**Type**|**Documentation**
2132 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2133 |Link|LinkType|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.
2134 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
2135 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
2136 |ConstraintAttachment|*ConstraintAttachment Type*|ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to.
2137 |ReleaseCalendar|ReleaseCalendarType|ReleaseCalendar defines dates on which the constrained data is to be made available.
2138
2139 **DataConstraintBaseType:** DataConstraintBaseType is an abstract base refinement of ConstraintType. The constraint attachment is restricted to constrainable artefacts related to data.
2140
2141 Derivation:
2142
2143 AnnotableType (extension)
2144 IdentifiableType (extension)
2145 NameableType (extension)
2146 VersionableType (restriction)
2147 MaintainableBaseType (extension)
2148 MaintainableType (restriction)
2149 ConstraintBaseType (extension)
2150 ConstraintType (restriction)
2151 DataConstraintBaseType
2152
2153 Attributes:
2154 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role
2155
2156 Content:
2157 Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?
2158
2159 Attribute Documentation:
2160
2161 |**Name**|**Type**|**Documentation**|
2162 |id|IDType|The id is the identifier for the object.|
2163 |urn|DataConstraintUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
2164 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
2165 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
2166 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
2167 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
2168 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
2169 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
2170 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
2171 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
2172 |isPartialLanguage (default: false)|xs:boolean|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’.|
2173 |role|ConstraintRoleType|The role attribute indicates whether this constraint states what data is actually present for the constraint attachment, or if it defines what content is allowed.|
2174
2175 Element Documentation:
2176
2177 |**Name**|**Type**|**Documentation**|
2178 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
2179 |Link|LinkType|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.|
2180 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
2181 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
2182 |ConstraintAttachment|DataConstraintAttach mentType|ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to.|
2183 |ReleaseCalendar|ReleaseCalendarType|ReleaseCalendar defines dates on which the constrained data is to be made available.|
2184
2185 **DataConstraintType:** DataConstraintType defines the structure of a data constraint. A data constraint can specify either the available set of keys (DataKeySet) or set of component values (CubeRegion) in a data source, or the allowable keys that can be constructed from a data structure definition. Multiple such constraints may be present for a constrained artefact. For instance, there may be a constraing that specifies the values allowed for the data source (role is "Allowed") which can be used for validation or for constructing a partial code list, whilst another constraing can specify the actual content of a data source (role is "Actual").
2186
2187 Derivation:
2188
2189 AnnotableType (extension)
2190 IdentifiableType (extension)
2191 NameableType (extension)
2192 VersionableType (restriction)
2193 MaintainableBaseType (extension)
2194 MaintainableType (restriction)
2195 ConstraintBaseType (extension)
2196 ConstraintType (restriction)
2197 DataConstraintBaseType (extension)
2198 DataConstraintType
2199
2200 Attributes:
2201 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role
2202
2203 Content:
2204 Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?, DataKeySet*, CubeRegion[0..2]
2205
2206 Attribute Documentation:
2207
2208 |**Name**|**Type**|**Documentation**|
2209 |id|IDType|The id is the identifier for the object.|
2210 |urn|DataConstraintUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
2211 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
2212 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
2213 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
2214 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
2215 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
2216 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
2217 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
2218 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
2219 |isPartialLanguage (default: false)|xs:boolean|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’.|
2220 |role|ConstraintRoleType|The role attribute indicates whether this constraint states what data is actually present for the constraint attachment, or if it defines what content is allowed.|
2221
2222 Element Documentation:
2223
2224 |**Name**|**Type**|**Documentation**|
2225 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
2226 |Link|LinkType|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.|
2227 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
2228 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
2229 |ConstraintAttachment|DataConstraintAttach mentType|ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to.|
2230 |ReleaseCalendar|ReleaseCalendarType|ReleaseCalendar defines dates on which the constrained data is to be made available.|
2231 |DataKeySet|DataKeySetType|DataKeySet defines a full, distinct set of dimension values and the attribute values associated with the key.|
2232 |CubeRegion|CubeRegionType|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.|
2233
2234 ***MetadataConstraintBaseType*:** MetadataConstraintBaseType is an abstract base refinement of ConstraintType. The constraint attachment is restricted to constrainable artefacts related to metadata, and the only possible role is "Allowed".
2235
2236 Derivation:
2237
2238 AnnotableType (extension)
2239 IdentifiableType (extension)
2240 NameableType (extension)
2241 VersionableType (restriction)
2242 MaintainableBaseType (extension)
2243 MaintainableType (restriction)
2244 ConstraintBaseType (extension)
2245 ConstraintType (restriction)
2246 MetadataConstraintBaseType
2247
2248 Attributes:
2249 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role
2250
2251 Content:
2252 Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?
2253
2254 Attribute Documentation:
2255
2256 |**Name**|**Type**|**Documentation**|
2257 |id|IDType|The id is the identifier for the object.|
2258 |urn|MetadataConstraintUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
2259 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
2260 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
2261 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
2262 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
2263 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
2264 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
2265 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
2266 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
2267 |isPartialLanguage (default: false)|xs:boolean|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’.|
2268 |role (fixed: Allowed)|ConstraintRoleType|The role attribute indicates whether this constraint states what data is actually present for the constraint attachment, or if it defines what content is allowed.|
2269
2270 Element Documentation:
2271
2272 |**Name**|**Type**|**Documentation**|
2273 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
2274 |Link|LinkType|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.|
2275 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
2276 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
2277 |ConstraintAttachment|MetadataConstraintAttachmentType|ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to.|
2278 |ReleaseCalendar|ReleaseCalendarType|ReleaseCalendar defines dates on which the constrained data is to be made available.|
2279
2280 **MetadataConstraintType:** MetadataConstraintType defines the structure of a metadata constraint. A metadata constraint can specify allowed attribute values for metadata described by the constrained artefact.
2281
2282 Derivation:
2283
2284 AnnotableType (extension)
2285 IdentifiableType (extension)
2286 NameableType (extension)
2287 VersionableType (restriction)
2288 MaintainableBaseType (extension)
2289 MaintainableType (restriction)
2290 ConstraintBaseType (extension)
2291 ConstraintType (restriction)
2292 MetadataConstraintBaseType (extension)
2293 MetadataConstraintType
2294
2295 Attributes:
2296 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role
2297
2298 Content:
2299 Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?, MetadataTargetRegion[0..2]
2300
2301 Attribute Documentation:
2302
2303 |**Name**|**Type**|**Documentation**|
2304 |id|IDType|The id is the identifier for the object.|
2305 |urn|MetadataConstraintUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
2306 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
2307 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
2308 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
2309 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
2310 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
2311 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
2312 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
2313 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
2314 |isPartialLanguage (default: false)|xs:boolean|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’.|
2315 |role (fixed: Allowed)|ConstraintRoleType|The role attribute indicates whether this constraint states what data is actually present for the constraint attachment, or if it defines what content is allowed.|
2316
2317 Element Documentation:
2318
2319 |**Name**|**Type**|**Documentation**|
2320 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
2321 |Link|LinkType|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.|
2322 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
2323 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
2324 |ConstraintAttachment|MetadataConstraintAttachmentType|ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to.|
2325 |ReleaseCalendar|ReleaseCalendarType|ReleaseCalendar defines dates on which the constrained data is to be made available.|
2326 |MetadataTargetRegion|MetadataTargetRegionType|MetadataTargetRegion describes the values allowed for metadata attributes.|
2327
2328 **ReleaseCalendarType:** ReleaseCalendarType describes information about the timing of releases of the constrained data. All of these values use the standard "P7D" - style format.
2329
2330 Content:
2331 Periodicity, Offset, Tolerance
2332
2333 Element Documentation
2334
2335 |**Name**|**Type**|**Documentation**|
2336 |Periodicity|xs:string|Periodicity is the period between releases of the data set.|
2337 |Offset|xs:string|Offset is the interval between January first and the first release of data within the year.|
2338 |Tolerance|xs:string|Tolerance is the period after which the release of data may be deemed late.|
2339
2340 **DataKeySetType:** DataKeySetType defines a collection of full or partial data keys (dimension values).
2341
2342 Attributes:
2343 isIncluded
2344
2345 Content:
2346 Key+
2347
2348 Attribute Documentation:
2349
2350 |**Name**|**Type**|**Documentation**
2351 |isIncluded|xs:boolean|The isIncluded attribute indicates whether the keys defined in this key set are inclusive or exclusive to the constraint.
2352
2353 Element Documentation:
2354
2355 |**Name**|**Type**|**Documentation**
2356 |Key|DataKeyType|Key contains a set of dimension values which identify a full set of data.
2357
2358 **ConstraintAttachmentType:** ConstraintAttachmentType describes a collection of references to constrainable artefacts.
2359
2360 Content:
2361 (DataProvider|MetadataProvider|MetadataSet+|SimpleDataSource+|(DataStructure+, QueryableDataSource*)|(MetadataStructure+, QueryableDataSource*)|(Dataflow+, QueryableDataSource*)|(Metadataflow+, QueryableDataSource*)|(ProvisionAgreement+, QueryableDataSource*)|(MetadataProvisionAgreement+, QueryableDataSource*))
2362
2363 Element Documentation:
2364
2365 |**Name**|**Type**|**Documentation**|
2366 |DataProvider|DataProviderReferenceType|DataProvider is reference to a data provider to which the constraint is attached. If this is used, then only the release calendar is relevant. The referenced is provided as a URN and/or a full set of reference fields.|
2367 |MetadataProvider|MetadataProviderReferenceType|MetadataProvider is reference to a metadata provider to which the constraint is attached. If this is used, then only the release calendar is relevant. The referenced is provided as a URN and/or a full set of reference fields.|
2368 |MetadataSet|MetadataSetReferenceType|MetadataSet is reference to a metadata set to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields.|
2369 |SimpleDataSource|xs:anyURI|SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message.|
2370 |DataStructure|DataStructureReferenceType|DataStructure is reference to a data structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached.|
2371 |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable data source to which the constraint is attached.|
2372 |MetadataStructure|MetadataStructureReferenceType|MetadataStructure is reference to a metadata structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached.|
2373 |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable data source to which the constraint is attached.|
2374 |Dataflow|DataflowReferenceType|Dataflow is reference to a data flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one dataflow, and the dataflows do not necessarily have to be usages of the same data structure. However, a constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached.|
2375 |QueryableDataSource|QueryableDataSourcType|QueryableDataSource describes a queryable data source to which the constraint is attached.|
2376 |Metadataflow|MetadataflowReferenceType|Metadataflow is reference to a metadata flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one metadataflow, and the metadataflows do not necessarily have to be usages of the same metadata structure. However, a constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached.|
2377 |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable data source to which the constraint is attached.|
2378 |ProvisionAgreement|ProvisionAgreementReferenceType|ProvisionAgreementReference is reference to a provision agreement to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one provision aggreement, and the provision agreements do not necessarily have to be references structure usages based on the same structure. However, a constraint which is attached to more than one provision agreement must only express key sets and/or cube/target regions where the identifier of the components are common across all structures to which the constraint is attached.|
2379 |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable data source to which the constraint is attached.|
2380 |MetadataProvisionAgreement|MetadataProvisionAgreementReferenceType|ProvisionAgreementReference is reference to a provision agreement to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one provision aggreement, and the provision agreements do not necessarily have to be references structure usages based on the same structure. However, a constraint which is attached to more than one provision agreement must only express key sets and/or cube/target regions where the identifier of the components are common across all structures to which the constraint is attached.|
2381 |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable data source to which the constraint is attached.|
2382
2383 **DataConstraintAttachmentType:** DataConstraintAttachmentType restricts the base ConstraintAttachmentType to only allow artefacts related to data.
2384
2385 Derivation:
2386
2387 ConstraintAttachmentType (restriction)
2388 DataConstraintAttachmentType
2389
2390 Content:
2391 (DataProvider|SimpleDataSource+|(DataStructure+, QueryableDataSource*)|(Dataflow+, QueryableDataSource*)|(ProvisionAgreement+, QueryableDataSource*))
2392
2393 Element Documentation:
2394
2395 |**Name**|**Type**|**Documentation**|
2396 |DataProvider|DataProviderReferenc eType|DataProvider is reference to a data provider to which the constraint is attached. If this is used, then only the release calendar is relevant. The referenced is provided as a URN and/or a full set of reference fields.|
2397 |SimpleDataSource|xs:anyURI|SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message.|
2398 |DataStructure|DataStructureReferenceType|DataStructure is reference to a data structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached.|
2399 |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable data source to which the constraint is attached.|
2400 |Dataflow|DataflowReferenceType|Dataflow is reference to a data flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one dataflow, and the dataflows do not necessarily have to be usages of the same data structure. However, a constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached.|
2401 |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable data source to which the constraint is attached.|
2402 |ProvisionAgreement|ProvisionAgreementReferenceType|ProvisionAgreementReference is reference to a provision agreement to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one provision aggreement, and the provision agreements do not necessarily have to be references structure usages based on the same structure. However, a constraint which is attached to more than one provision agreement must only express key sets and/or cube/target regions where the identifier of the components are common across all structures to which the constraint is attached.|
2403 |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable data source to which the constraint is attached.|
2404
2405 **MetadataConstraintAttachmentType:** MetadataConstraintAttachmentType restricts the base ConstraintAttachmentType to only allow artefacts related to metadata.
2406
2407 Derivation:
2408
2409 ConstraintAttachmentType (restriction)
2410 MetadataConstraintAttachmentType
2411
2412 Content:
2413 (MetadataProvider|MetadataSet+|SimpleDataSource+|(MetadataStructure+, QueryableDataSource*)|(Metadataflow+, QueryableDataSource*)|(MetadataProvisionAgreement+, QueryableDataSource*))
2414
2415 Element Documentation:
2416
2417 |**Name**|**Type**|**Documentation**|
2418 |MetadataProvider|MetadataProviderReferenceType|MetadataProvider is reference to a metadata provider to which the constraint is attached. If this is used, then only the release calendar is relevant. The referenced is provided as a URN and/or a full set of reference fields.|
2419 |MetadataSet|MetadataSetReferenceType|MetadataSet is reference to a metadata set to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields.|
2420 |SimpleDataSource|xs:anyURI|SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message.|
2421 |MetadataStructure|MetadataStructureReferenceType|MetadataStructure is reference to a metadata structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached.|
2422 |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable data source to which the constraint is attached.|
2423 |Metadataflow|MetadataflowReferenceype|Metadataflow is reference to a metadata flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one metadataflow, and the metadataflows do not necessarily have to be usages of the same metadata structure. However, a constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached.|
2424 |QueryableDataSource|QueryableDataSourceType|QueryableDataSource describes a queryable data source to which the constraint is attached.|
2425 |MetadataProvisionAgr eement|MetadataProvisionAgreementReferenceType|ProvisionAgreementReference is reference to a provision agreement to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one provision aggreement, and the provision agreements do not necessarily have to be references structure usages based on the same structure. However, a constraint which is attached to more than one provision agreement must only express key sets and/or cube/target regions where the identifier of the components are common across all structures to which the constraint is attached.|
2426 |QueryableDataSource|QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.|
2427
2428 ***RegionType*:** RegionType is an abstract type which defines a generic constraint region. This type can be refined to define regions for data or metadata sets. A region is defined by a collection of key values - each of which a collection of values for a component which disambiguates data (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 flagged as being included or excluded, although this flag only makes sense when the region is used in a particular context.
2429
2430 Derivation:
2431
2432 AnnotableType (extension)
2433 RegionType
2434
2435 Attributes:
2436
2437 include?, validFrom?, validTo?
2438
2439 Content:
2440
2441 Annotations?, KeyValue*, Component
2442
2443 Attribute Documentation:
2444
2445 |**Name**|**Type**|**Documentation**|
2446 |include (default: true)|xs:boolean|The include attribute indicates that the region is to be included or excluded within the context in which it is defined. For example, if the regions is defined as part of a content constraint, the exclude flag would mean the data identified by the region is not present.|
2447 |validFrom|StandardTimePeriodType| |
2448 |validTo|StandardTimePeriodType| |
2449
2450 Element Documentation:
2451
2452 |**Name**|**Type**|**Documentation**|
2453 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
2454 |KeyValue|*MemberSelectionType*|KeyValue contains a reference to a component which disambiguates the data (i.e. a dimension) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region.|
2455 |Component|*MemberSelectionType*|Component contains a reference to a component (data attribute, metadata attribute, or measure) and provides a collection of values for the referenced component. This serves to state that for the key which defines the region, the components that are specified here have or do not have (depending on the include attribute of the value set) the values provided. It is possible to provide a component reference without specifying values, for the purpose of stating the component is absent (include = false) or present with an unbounded set of values. As opposed to key components, which are assumed to be wild carded if absent, no assumptions are made about the absence of a component. Only components which are explicitly stated to be present or absent from the region will be know. All unstated components for the set cannot be assumed to absent or present.|
2456
2457 **MemberSelectionType:** 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.
2458
2459 Attributes:
2460
2461 id, include?, removePrefix?, validFrom?, validTo?
2462
2463 Content:
2464
2465 (Value+|TimeRange)?
2466
2467 Attribute Documentation:
2468
2469 |**Name**|**Type**|**Documentation**|
2470 |id|NestedNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.|
2471 |include (default: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included or excluded from the region in which they are defined.|
2472 |removePrefix|xs:boolean|The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist.|
2473 |validFrom|StandardTimePeriodType| |
2474 |validTo|StandardTimePeriodType| |
2475
2476 Element Documentation:
2477
2478 |**Name**|**Type**|**Documentation**|
2479 |Value|SimpleComponentValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.|
2480 |TimeRange|TimeRangeValueType|TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).|
2481
2482 **DataKeyType:** DataKeyType is a region which defines a distinct full or partial data key. The key consists of a set of values, each referencing a dimension and providing a single value for that dimension. The purpose of the key is to define a subset of a data set (i.e. the observed value and data attribute) which have the dimension values provided in this definition. Any dimension not stated explicitly in this key is assumed to be wild carded, thus allowing for the definition of partial data keys.
2483
2484 Derivation:
2485
2486 AnnotableType (extension)
2487 RegionType (restriction)
2488 DataKeyType
2489
2490 Attributes:
2491
2492 include?, validFrom?, validTo?
2493
2494 Content:
2495
2496 Annotations?, KeyValue*, Component
2497
2498 Attribute Documentation:
2499
2500 |**Name**|**Type**|**Documentation**|
2501 |include (fixed: true)|xs:boolean|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.|
2502 |validFrom|StandardTimePeriodType| |
2503 |validTo|StandardTimePeriodType| |
2504
2505 Element Documentation:
2506
2507 |**Name**|**Type**|**Documentation**|
2508 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
2509 |KeyValue|DataKeyValueType|KeyValue contains a reference to a component which disambiguates the data (i.e. a dimension) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region.|
2510 |Component|DataComponentValueSetType|Component contains a reference to a component (data attribute, metadata attribute, or measure) and provides a collection of values for the referenced component. This serves to state that for the key which defines the region, the components that are specified here have or do not have (depending on the include attribute of the value set) the values provided. It is possible to provide a component reference without specifying values, for the purpose of stating the component is absent (include = false) or present with an unbounded set of values. As opposed to key components, which are assumed to be wild carded if absent, no assumptions are made about the absence of a component. Only components which are explicitly stated to be present or absent from the region will be know. All unstated components for the set cannot be assumed to absent or present.|
2511
2512 **DataKeyValueType:** DataKeyValueType is a type for providing a dimension value for the purpose of defining a distinct data key. Only a single value can be provided for the dimension.
2513
2514 Derivation:
2515
2516 MemberSelectionType (restriction)
2517 DataKeyValueType
2518
2519 Attributes:
2520
2521 id, include?, removePrefix?
2522
2523 Content:
2524
2525 Value
2526
2527 Attribute Documentation:
2528
2529 |**Name**|**Type**|**Documentation**|
2530 |id|SingleNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.|
2531 |include (fixed: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included or excluded from the region in which they are defined.|
2532 |removePrefix|xs:boolean|The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist.|
2533
2534 Element Documentation:
2535
2536 |**Name**|**Type**|**Documentation**|
2537 |Value|SimpleKeyValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.|
2538
2539 **DataComponentValueSetType:** 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.
2540
2541 Derivation:
2542
2543 MemberSelectionType (restriction)
2544 DataComponentValueSetType
2545
2546 Attributes:
2547
2548 id, include?, removePrefix?
2549
2550 Content:
2551
2552 (Value+|TimeRange)?
2553
2554 Attribute Documentation:
2555
2556 |**Name**|**Type**|**Documentation**|
2557 |id|NestedNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.|
2558 |include (default: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included or excluded from the region in which they are defined.|
2559 |removePrefix|xs:boolean|The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist.|
2560
2561 Element Documentation:
2562
2563 |**Name**|**Type**|**Documentation**|
2564 |Value|DataComponentValueTy pe|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.|
2565 |TimeRange|TimeRangeValueType|TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).|
2566
2567 **CubeRegionType:** CubeRegionType defines the structure of a data cube region. This is based on the abstract RegionType and simply refines the key and attribute values to conform with what is applicable for dimensions and attributes, respectively. See the documentation of the base type for more details on how a region is defined.
2568
2569 Derivation:
2570
2571 AnnotableType (extension)
2572 RegionType (restriction)
2573 CubeRegionType
2574
2575 Attributes:
2576
2577 include?
2578
2579 Content:
2580
2581 Annotations?, KeyValue*, Component
2582
2583 Attribute Documentation:
2584
2585 |**Name**|**Type**|**Documentation**|
2586 |include (default: true)|xs:boolean|The include attribute indicates that the region is to be included or excluded within the context in which it is defined. For example, if the regions is defined as part of a content constraint, the exclude flag would mean the data identified by the region is not present.|
2587
2588 Element Documentation:
2589
2590 |**Name**|**Type**|**Documentation**
2591 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2592 |KeyValue|CubeRegionKeyType|KeyValue contains a reference to a component which disambiguates the data (i.e. a dimension) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region.
2593 |Component|ComponentValueSetType|Component contains a reference to a component (data attribute, metadata attribute, or measure) and provides a collection of values for the referenced component. This serves to state that for the key which defines the region, the components that are specified here have or do not have (depending on the include attribute of the value set) the values provided. It is possible to provide a component reference without specifying values, for the purpose of stating the component is absent (include = false) or present with an unbounded set of values. As opposed to key components, which are assumed to be wild carded if absent, no assumptions are made about the absence of a component. Only components which are explicitly stated to be present or absent from the region will be know. All unstated components for the set cannot be assumed to absent or present.
2594
2595 **MetadataTargetRegionType:** MetadataTargetRegionType defines the structure of a metadata target region. A metadata target region must define the report structure and the metadata target from that structure on which the region is based. This type is based on the abstract RegionType and simply refines the key and attribute values to conform with what is applicable for target objects and metadata attributes, respectively. See the documentation of the base type for more details on how a region is defined.
2596
2597 Derivation:
2598
2599 AnnotableType (extension)
2600 RegionType (restriction)
2601 MetadataTargetRegionType
2602
2603 Attributes:
2604
2605 include?, validFrom?, validTo?
2606
2607 Content:
2608
2609 Component
2610
2611 Attribute Documentation:
2612
2613 |**Name**|**Type**|**Documentation**|
2614 |include (default: true)|xs:boolean|The include attribute indicates that the region is to be included or excluded within the context in which it is defined. For example, if the regions is defined as part of a content constraint, the exclude flag would mean the data identified by the region is not present.|
2615 |validFrom|StandardTimePeriodTy pe| |
2616 |validTo|StandardTimePeriodTy pe| |
2617
2618 Element Documentation:
2619
2620 |**Name**|**Type**|**Documentation**|
2621 |Component|MetadataAttributeVal ueSetType|Component contains a reference to a component (data attribute, metadata attribute, or measure) and provides a collection of values for the referenced component. This serves to state that for the key which defines the region, the components that are specified here have or do not have (depending on the include attribute of the value set) the values provided. It is possible to provide a component reference without specifying values, for the purpose of stating the component is absent (include = false) or present with an unbounded set of values. As opposed to key components, which are assumed to be wild carded if absent, no assumptions are made about the absence of a component. Only components which are explicitly stated to be present or absent from the region will be know. All unstated components for the set cannot be assumed to absent or present.|
2622
2623 **CubeRegionKeyType:** CubeRegionKeyType is a type for providing a set of values for a dimension for the purpose of defining a data cube region. A set of distinct value can be provided, or if this dimension is represented as time, and time range can be specified.
2624
2625 Derivation:
2626
2627 MemberSelectionType (restriction)
2628 CubeRegionKeyType
2629
2630 Attributes:
2631
2632 id, include?, removePrefix?, validFrom?, validTo?
2633
2634 Content:
2635
2636 (Value+|TimeRange)
2637
2638 Attribute Documentation:
2639
2640 |**Name**|**Type**|**Documentation**|
2641 |id|SingleNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.|
2642 |include (default: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included or excluded from the region in which they are defined.|
2643 |removePrefix|xs:boolean|The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist.|
2644 |validFrom|StandardTimePeriodType| |
2645 |validTo|StandardTimePeriodType| |
2646
2647 Element Documentation:
2648
2649 |**Name**|**Type**|**Documentation**|
2650 |Value|CubeKeyValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.|
2651 |TimeRange|TimeRangeValueType|TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).|
2652
2653 **ComponentValueSetType:** 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.
2654
2655 Derivation:
2656
2657 MemberSelectionType (restriction)
2658 ComponentValueSetType
2659
2660 Attributes:
2661
2662 id, include?, removePrefix?
2663
2664 Content:
2665
2666 (Value+|TimeRange)?
2667
2668 Attribute Documentation:
2669
2670 |**Name**|**Type**|**Documentation**|
2671 |id|NestedNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.|
2672 |include (default: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included or excluded from the region in which they are defined.|
2673 |removePrefix|xs:boolean|The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist.|
2674
2675 Element Documentation:
2676
2677 |**Name**|**Type**|**Documentation**|
2678 |Value|SimpleComponentValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.|
2679 |TimeRange|TimeRangeValueType|TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).|
2680
2681 **MetadataAttributeValueSetType:** MetadataAttributeValueSetType defines the structure for providing values for a metadata attribute. If no values are provided, the attribute is implied to include/excluded from the region in which it is defined, with no regard to the value of the metadata attribute.
2682
2683 Derivation:
2684
2685 MemberSelectionType (restriction)
2686 MetadataAttributeValueSetType
2687
2688 Attributes:
2689
2690 id, include?, removePrefix?
2691
2692 Content:
2693
2694 (Value+|TimeRange)?
2695
2696 Attribute Documentation:
2697
2698 |**Name**|**Type**|**Documentation**|
2699 |id|NestedNCNameIDType|The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate.|
2700 |include (default: true)|xs:boolean|The include attribute indicates whether the values provided for the referenced component are to be included or excluded from the region in which they are defined.|
2701 |removePrefix|xs:boolean|The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist.|
2702
2703 Element Documentation:
2704
2705 |**Name**|**Type**|**Documentation**|
2706 |Value|SimpleComponentValueType|Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes.|
2707 |TimeRange|TimeRangeValueType|TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive).|
2708
2709 **SimpleComponentValueType:** 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.
2710
2711 Derivation:
2712
2713 xs:anySimpleType (restriction)
2714 xs:string (extension)
2715 SimpleComponentValueType
2716
2717 Attributes:
2718
2719 cascadeValues?, xml:lang?, validFrom?, validTo?
2720
2721 Content:
2722
2723 Attribute Documentation:
2724
2725 |**Name**|**Type**|**Documentation**|
2726 |cascadeValues (default: false)|CascadeSelectionType|The cascadeValues attribute, if true, indicates that if the value is taken from a code all child codes in a simple hierarchy are understood be included in the region.|
2727 |xml:lang|xs:language|The xml:lang attribute specifies a language code for the value. This is used when the component value support multi-lingual values.|
2728 |validFrom|StandardTimePeriodTy pe| |
2729 |validTo|StandardTimePeriodTy pe| |
2730
2731 **CubeKeyValueType:** CubeKeyValueType derives from the SimpleValueType, but does not allow for a locale (xml:lang).
2732
2733 Derivation:
2734
2735 xs:anySimpleType (restriction)
2736 xs:string (extension)
2737 SimpleComponentValueType (restriction)
2738 CubeKeyValueType
2739
2740 Attributes:
2741
2742 cascadeValues?, validFrom?, validTo?
2743
2744 Content:
2745
2746 Attribute Documentation:
2747
2748 |**Name**|**Type**|**Documentation**
2749 |cascadeValues (default: false)|CascadeSelectionType|The cascadeValues attribute, if true, indicates that if the value is taken from a code all child codes in a simple hierarchy are understood be included in the region.
2750 |validFrom|StandardTimePeriodType|
2751 |validTo|StandardTimePeriodType|
2752
2753 **DataComponentValueType:** DataComponentValueType derives from the SimpleValueType, but does not allow for validity dates.
2754
2755 Derivation:
2756
2757 xs:anySimpleType (restriction)
2758 xs:string (extension)
2759 SimpleComponentValueType (restriction)
2760 DataComponentValueType
2761
2762 Attributes:
2763
2764 cascadeValues?, xml:lang?
2765
2766 Content:
2767
2768 Attribute Documentation:
2769
2770 |**Name**|**Type**|**Documentation**
2771 |cascadeValues (default: false)|CascadeSelectionType|The cascadeValues attribute, if true, indicates that if the value is taken from a code all child codes in a simple hierarchy are understood be included in the region.
2772 |xml:lang|xs:language|The xml:lang attribute specifies a language code for the value. This is used when the component value support multi-lingual values.
2773
2774 **SimpleKeyValueType:** SimpleKeyValueType derives from the SimpleValueType, but does not allow for the cascading of value in the hierarchy, as keys are meant to describe a distinct full or partial key.
2775
2776 Derivation:
2777
2778 xs:anySimpleType (restriction)
2779 xs:string (extension)
2780 SimpleComponentValueType (restriction)
2781 SimpleKeyValueType
2782
2783 Content:
2784
2785 **TimeRangeValueType:** TimeRangeValueType allows a time period value to be expressed as a range. It can be expressed as the period before a period, after a period, or between two periods. Each of these properties can specify their inclusion in regards to the range.
2786
2787 Attributes:
2788 validFrom?, validTo?
2789
2790 Content:
2791 (BeforePeriod|AfterPeriod|(StartPeriod, EndPeriod))
2792
2793 Attribute Documentation:
2794
2795 |**Name**|**Type**|**Documentation**
2796 |validFrom|StandardTimePeriodTy pe|
2797 |validTo|StandardTimePeriodTy pe|
2798
2799 Element Documentation:
2800
2801 |**Name**|**Type**|**Documentation**|
2802 |BeforePeriod|TimePeriodRangeType|BeforePeriod is the period before which the period is meant to cover. This date may be inclusive or exclusive in the range.|
2803 |AfterPeriod|TimePeriodRangeType|AfterPeriod is the period after which the period is meant to cover. This date may be inclusive or exclusive in the range.|
2804 |StartPeriod|TimePeriodRangeType|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.|
2805 |EndPeriod|TimePeriodRangeType|EndPeriod is the end period of the range. This date may be inclusive or exclusive in the range.|
2806
2807 **TimePeriodRangeType:** TimePeriodRangeType defines a time period, and indicates whether it is inclusive in a range.
2808
2809 Derivation:
2810
2811 xs:anySimpleType (restriction)
2812 ObservationalTimePeriodType (extension)
2813 TimePeriodRangeType
2814
2815 Attributes:
2816 isInclusive?
2817
2818 Content:
2819 Attribute Documentation:
2820
2821 |**Name**|**Type**|**Documentation**|
2822 |isInclusive (default: true)|xs:boolean|The isInclusive attribute, when true, indicates that the time period specified is included in the range.|
2823
2824 ***DataStructureBaseType*:** 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.
2825
2826 Derivation:
2827
2828 AnnotableType (extension)
2829 IdentifiableType (extension)
2830 NameableType (extension)
2831 VersionableType (restriction)
2832 MaintainableBaseType (extension)
2833 MaintainableType (restriction)
2834 StructureType (restriction)
2835 DataStructureBaseType
2836
2837 Attributes:
2838 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
2839
2840 Content:
2841 Annotations?, Link*, Name+, Description*, DataStructureComponents?
2842
2843 Attribute Documentation:
2844
2845 |**Name**|**Type**|**Documentation**|
2846 |id|IDType|The id is the identifier for the object.|
2847 |urn|DataStructureUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
2848 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
2849 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
2850 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
2851 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
2852 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
2853 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
2854 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
2855 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
2856 |isPartialLanguage (default: false)|xs:boolean|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’.|
2857
2858 Element Documentation:
2859
2860 |**Name**|**Type**|**Documentation**|
2861 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
2862 |Link|LinkType|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.|
2863 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
2864 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
2865 |DataStructureComponents|DataStructureComponentsType|DataStructureComponents defines the grouping of the sets of metadata concepts that have a defined structural role in the data structure definition. Note that for any component or group defined in a data structure definition, its id must be unique. This applies to the identifiers explicitly defined by the components as well as those inherited from the concept identity of a component. For example, if two dimensions take their identity from concepts with same identity (regardless of whether the concepts exist in different schemes) one of the dimensions must be provided a different explicit identifier. Although there are XML schema constraints to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a concept from which a component takes its identity cannot be validated against this constraint. Therefore, systems processing data structure definitions will have to perform this check outside of the XML validation. There are also two reserved identifiers in a data structure definition; TIME\_PERIOD, and REPORTING\_YEAR\_START\_DAY. These identifiers may not be used outside of their respective defintions (TimeDimension and ReportingYearStartDay). This applies to both the explicit identifiers that can be assigned to the components or groups as well as an identifier inherited by a component from its concept identity. For example, if an ordinary dimension (i.e. not the time dimension) takes its concept identity from a concept with the identifier TIME\_PERIOD, that dimension must provide a different explicit identifier.|
2866
2867 **DataStructureType:** 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.
2868
2869 Derivation:
2870
2871 AnnotableType (extension)
2872 IdentifiableType (extension)
2873 NameableType (extension)
2874 VersionableType (restriction)
2875 MaintainableBaseType (extension)
2876 MaintainableType (restriction)
2877 StructureType (restriction)
2878 DataStructureBaseType (extension)
2879 DataStructureType
2880
2881 Attributes:
2882 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
2883
2884 Content:
2885 Annotations?, Link*, Name+, Description*, DataStructureComponents?, Metadata?
2886
2887 Attribute Documentation:
2888
2889 (% style="width:2116.68px" %)
2890 |**Name**|**Type**|(% style="width:1572.38px" %)**Documentation**
2891 |id|IDType|(% style="width:1572.38px" %)The id is the identifier for the object.
2892 |urn|DataStructureUrnType|(% style="width:1572.38px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2893 |uri|xs:anyURI|(% style="width:1572.38px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2894 |version|VersionType|(% style="width:1572.38px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
2895 |validFrom|xs:dateTime|(% style="width:1572.38px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
2896 |validTo|xs:dateTime|(% style="width:1572.38px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
2897 |agencyID|NestedNCNameIDType|(% style="width:1572.38px" %)The agencyID must be provided, and identifies the maintenance agency of the object.
2898 |isExternalReference (default: false)|xs:boolean|(% style="width:1572.38px" %)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.
2899 |serviceURL|xs:anyURI|(% style="width:1572.38px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
2900 |structureURL|xs:anyURI|(% style="width:1572.38px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
2901 |isPartialLanguage (default: false)|xs:boolean|(% style="width:1572.38px" %)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’.
2902
2903 Element Documentation:
2904
2905 |**Name**|**Type**|**Documentation**
2906 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2907 |Link|LinkType|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.
2908 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
2909 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
2910 |DataStructureComponents|DataStructureComponentsType|DataStructureComponents defines the grouping of the sets of metadata concepts that have a defined structural role in the data structure definition. Note that for any component or group defined in a data structure definition, its id must be unique. This applies to the identifiers explicitly defined by the components as well as those inherited from the concept identity of a component. For example, if two dimensions take their identity from concepts with same identity (regardless of whether the concepts exist in different schemes) one of the dimensions must be provided a different explicit identifier. Although there are XML schema constraints to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a concept from which a component takes its identity cannot be validated against this constraint. Therefore, systems processing data structure definitions will have to perform this check outside of the XML validation. There are also two reserved identifiers in a data structure definition; TIME\_PERIOD, and REPORTING\_YEAR\_START\_DAY. These identifiers may not be used outside of their respective defintions (TimeDimension and ReportingYearStartDay). This applies to both the explicit identifiers that can be assigned to the components or groups as well as an identifier inherited by a component from its concept identity. For example, if an ordinary dimension (i.e. not the time dimension) takes its concept identity from a concept with the identifier TIME\_PERIOD, that dimension must provide a different explicit identifier.
2911 |Metadata|MetadataStructureReferenceType|A data structure definition may be related to a metadata structure definition in order to use its metadata attributes as part of the data. Note that the referenced metadata set cannot contain nested metadata attributes, as these are not supported in the data. By default all metadata attributes can be associated at any level of the data. However, a metadata attribute usage can be used to provide a specific attribute relationshp for a given metadata attribute.
2912
2913 ***DataStructureComponentsBaseType*:** DataStructureComponentsBaseType is an abstract base type the serves as the basis for the DataStructureComponentsType. This type is necessary to allow for valid substitutions of component lists.
2914
2915 Derivation:
2916
2917 GroupingType (restriction)
2918 DataStructureComponentsBaseType
2919
2920 Content:
2921 {Empty}
2922
2923 **DataStructureComponentsType:** DataStructureComponentsType describes the structure of the grouping to the sets of metadata concepts that have a defined structural role in the data structure definition. At a minimum at least one dimension must be defined.
2924
2925 Derivation:
2926
2927 GroupingType (restriction)
2928 DataStructureComponentsBaseType (extension)
2929 DataStructureComponentsType
2930
2931 Content:
2932 DimensionList, Group*, AttributeList?, MeasureList?
2933
2934 Element Documentation:
2935
2936 |**Name**|**Type**|**Documentation**|
2937 |DimensionList|DimensionListType|DimensionList describes the key descriptor for the data structure definition. It is an ordered set of metadata concepts that, combined, classify a statistical series, such as a time series, and whose values, when combined (the key) in an instance such as a data set, uniquely identify a specific series.|
2938 |Group|GroupType|Group describes a group descriptor in a data structure definition. It is a set metadata concepts (and possibly their values) that define a partial key derived from the key descriptor in a data structure definition.|
2939 |AttributeList|AttributeListType|AttributeList describes the attribute descriptor for the data structure definition. It is a collection of metadata concepts that define the attributes of the data structure definition.|
2940 |MeasureList|MeasureListType|MeasureList describes the measure descriptor for a data structure.|
2941
2942 ***AttributeListBaseType*:** AttributeListBaseType is an abstract base type used as the basis for the AttributeListType.
2943
2944 Derivation:
2945
2946 AnnotableType (extension)
2947 IdentifiableType (extension)
2948 ComponentListType (restriction)
2949 AttributeListBaseType
2950
2951 Attributes:
2952 id?, urn?, uri?
2953
2954 Content:
2955 Annotations?, Link
2956
2957 Attribute Documentation:
2958
2959 |**Name**|**Type**|**Documentation**|
2960 |id (fixed: AttributeDescriptor)|IDType|The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor.|
2961 |urn|AttributeDescriptorUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
2962 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
2963
2964 Element Documentation:
2965
2966 |**Name**|**Type**|**Documentation**|
2967 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
2968 |Link|LinkType|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.|
2969
2970 **AttributeListType:** AttributeListType describes the attribute descriptor for the data structure definition.
2971
2972 Derivation:
2973
2974 AnnotableType (extension)
2975 IdentifiableType (extension)
2976 ComponentListType (restriction)
2977 AttributeListBaseType (extension)
2978 AttributeListType
2979
2980 Attributes:
2981 id?, urn?, uri?
2982
2983 Content:
2984 Annotations?, Link*, (Attribute|MetadataAttributeUsage)+
2985
2986 Attribute Documentation:
2987
2988 |**Name**|**Type**|**Documentation**|
2989 |id (fixed: AttributeDescriptor)|IDType|The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor.|
2990 |urn|AttributeDescriptorUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
2991 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
2992
2993 Element Documentation:
2994
2995 |**Name**|**Type**|**Documentation**|
2996 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
2997 |Link|LinkType|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.|
2998 |Attribute|AttributeType|Attribute describes the definition of a data attribute, which is defined as a characteristic of an object or entity.|
2999 |MetadataAttributeUsage|MetadataAttributeUsageType|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 reporing of a metadata attribute to a specific part of the data.|
3000
3001 ***AttributeBaseType*:** AttributeBaseType is an abstract base type that serves as the basis for the AttributeType. It restricts the text format base to a text format valid for data components (that does not allow for XHTML representation). The local representation is restricted to the values defined in codelist. The concept role is restricted to the values valid for a data attribute.
3002
3003 Derivation:
3004
3005 AnnotableType (extension)
3006 IdentifiableType (extension)
3007 ComponentBaseType (extension)
3008 ComponentType (restriction)
3009 AttributeBaseType
3010
3011 Attributes:
3012 id?, urn?, uri?
3013
3014 Content:
3015 Annotations?, Link*, ConceptIdentity, LocalRepresentation?
3016
3017 Attribute Documentation:
3018
3019 |**Name**|**Type**|**Documentation**
3020 |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).
3021 |urn|DataAttributeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3022 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3023
3024 Element Documentation:
3025
3026 |**Name**|**Type**|**Documentation**
3027 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3028 |Link|LinkType|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.
3029 |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.
3030 |LocalRepresentation|AttributeRepresentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.
3031
3032 **AttributeType:** AttributeType describes the structure of a data attribute, which is defined as a characteristic of an object or entity. The attribute takes its semantic, and in some cases it representation, from its concept identity. An attribute can be coded by referencing a code list from its coded local representation. It can also specify its text format, which is used as the representation of the attribute if a coded representation is not defined. Neither the coded or uncoded representation are necessary, since the attribute may take these from the referenced concept. An attribute specifies its relationship with other data structure components and is given an assignment status. These two properties dictate where in a data message the attribute will be attached, and whether or not the attribute will be required to be given a value. A set of roles defined in concept scheme can be assigned to the attribute.
3033
3034 Derivation:
3035
3036 AnnotableType (extension)
3037 IdentifiableType (extension)
3038 ComponentBaseType (extension)
3039 ComponentType (restriction)
3040 AttributeBaseType (extension)
3041 AttributeType
3042
3043 Attributes:
3044 id?, urn?, uri?, usage?
3045
3046 Content:
3047 Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole*, AttributeRelationship, MeasureRelationship?
3048
3049 Attribute Documentation:
3050
3051 |**Name**|**Type**|**Documentation**
3052 |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).
3053 |urn|DataAttributeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3054 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3055 |usage (default: optional)|UsageType|The usage attribute indicates whether an attribute value must be available for any corresponding existing observation.
3056
3057 Element Documentation:
3058
3059 |**Name**|**Type**|**Documentation**|
3060 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3061 |Link|LinkType|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.|
3062 |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.|
3063 |LocalRepresentation|AttributeRepresentat ionType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.|
3064 |ConceptRole|ConceptReferenceType|ConceptRole references concepts which define roles which this attribute serves.|
3065 |AttributeRelationshi p|AttributeRelationshi pType|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.|
3066 |MeasureRelationship|MeasureRelationshipT ype|MeasureRelationship identifies the measures that the attribute applies to. If this is not used, the attribute is assumed to apply to all measures.|
3067
3068 **AttributeRelationshipType:** AttributeRelationshipType defines the structure for stating the relationship between an attribute and other data structure definition components.
3069
3070 Content:
3071
3072 (Dataflow|Dimension+|Group|Observation)
3073
3074 Element Documentation:
3075
3076 |**Name**|**Type**|**Documentation**|
3077 |Dataflow|EmptyType|This means that the value of the attribute varies per dataflow. It is the data modeller's responsibility to design or use non-overlapping dataflows that do not have observations in common, otherwise the integrity of dataflow-specific attribute values is not assured by the model, e.g. when querying those data through its DSD.|
3078 |Dimension|OptionalLocalDimensionReferenceType|This is used to reference dimensions in the data structure definition on which the value of this attribute depends. An attribute using this relationship can be either a group, series (or section), or observation level attribute. The attachment level of the attribute will be determined by the data format and which dimensions are referenced.|
3079 |Group|IDType|This is used as a convenience to referencing all of the dimension defined by the referenced group. The attribute will also be attached to this group.|
3080 |Observation|EmptyType|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.|
3081
3082 **OptionalLocalDimensionReferenceType:**
3083
3084 Derivation:
3085
3086 xs:anySimpleType (restriction)
3087 xs:string (restriction)
3088 NestedIDType (restriction)
3089 IDType (restriction)
3090 NCNameIDType (extension)
3091 OptionalLocalDimensionReferenceType
3092
3093 Attributes:
3094
3095 optional?
3096
3097 Content:
3098
3099 Attribute Documentation:
3100
3101 (% style="width:1017.29px" %)
3102 |(% style="width:332px" %)**Name**|(% style="width:307px" %)**Type**|(% style="width:375px" %)**Documentation**
3103 |(% style="width:332px" %)optional (default: false)|(% style="width:307px" %)xs:boolean|(% style="width:375px" %)
3104
3105 **MeasureRelationshipType:** MeasureRelationshipType allows for the description of an attributes relationship to one or more measures
3106
3107 Content:
3108
3109 Measure+
3110
3111 Element Documentation:
3112
3113 |**Name**|**Type**|**Documentation**|
3114 |Measure|NCNameIDType|This is a reference to a measure defined in this data structure definition.|
3115
3116 **MetadataAttributeUsageBaseType:** 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 refernce to the metadata attribute being used.
3117
3118 Derivation:
3119
3120 AnnotableType (extension)
3121 IdentifiableType (extension)
3122 ComponentBaseType (extension)
3123 ComponentType (restriction)
3124 MetadataAttributeUsageBaseType
3125
3126 Attributes:
3127
3128 urn?, uri?
3129
3130 Content:
3131
3132 Annotations?, Link?
3133
3134 Attribute Documentation:
3135
3136 |**Name**|**Type**|**Documentation**|
3137 |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
3138 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
3139
3140 Element Documentation:
3141
3142 |**Name**|**Type**|**Documentation**|
3143 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3144 |Link|LinkType|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.|
3145
3146 **MetadataAttributeUsageType:** 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.
3147
3148 Derivation:
3149
3150 AnnotableType (extension)
3151 IdentifiableType (extension)
3152 ComponentBaseType (extension)
3153 ComponentType (restriction)
3154 MetadataAttributeUsageBaseType (extension)
3155 MetadataAttributeUsageType
3156
3157 Attributes:
3158 urn?, uri?
3159
3160 Content:
3161
3162 Annotations?, Link?, MetadataAttributeReference, AttributeRelationship
3163
3164 Attribute Documentation:
3165
3166 |**Name**|**Type**|**Documentation**|
3167 |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
3168 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
3169
3170 Element Documentation:
3171
3172 |**Name**|**Type**|**Documentation**|
3173 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3174 |Link|LinkType|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.|
3175 |MetadataAttributeReference|NCNameIDType|MetadataAttributeReference is a local reference to a metadata attribute defined in the metadata structure referenced by this data structure.|
3176 |AttributeRelationship|AttributeRelationshipType|AttributeRelationship defines the relationship between the referenced metadata attribute and the components of the data structure.|
3177
3178 ***DimensionListBaseType*:** DimensionListBaseType is an abstract base type used as the basis for the DimensionListType.
3179
3180 Derivation:
3181
3182 AnnotableType (extension)
3183 IdentifiableType (extension)
3184 ComponentListType (restriction)
3185 DimensionListBaseType
3186
3187 Attributes:
3188
3189 id?, urn?, uri?
3190
3191 Content:
3192
3193 Annotations?, Link
3194
3195 Attribute Documentation:
3196
3197 |**Name**|**Type**|**Documentation**|
3198 |id (fixed: DimensionDescriptor)|IDType|The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor.|
3199 |urn|DimensionDescriptorUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
3200 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
3201
3202 Element Documentation:
3203
3204 |**Name**|**Type**|**Documentation**|
3205 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3206 |Link|LinkType|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.|
3207
3208 **DimensionListType:** DimensionListType describes the key descriptor for a data structure definition. The order of the declaration of child dimensions is significant: it is used to describe the order in which they will appear in data formats for which key values are supplied in an ordered fashion (exclusive of the time dimension, which is not represented as a member of the ordered key). Any data structure definition which uses the time dimension should also declare a frequency dimension, conventionally the first dimension in the key (the set of ordered non-time dimensions). If is not necessary to assign a time dimension, as data can be organised in any fashion required.
3209
3210 Derivation:
3211
3212 AnnotableType (extension)
3213 IdentifiableType (extension)
3214 ComponentListType (restriction)
3215 DimensionListBaseType (extension)
3216 DimensionListType
3217
3218 Attributes:
3219
3220 id?, urn?, uri?
3221
3222 Content:
3223
3224 Annotations?, Link*, Dimension+, TimeDimension?
3225
3226 Attribute Documentation:
3227
3228 |**Name**|**Type**|**Documentation**|
3229 |id (fixed: DimensionDescriptor)|IDType|The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor.|
3230 |urn|DimensionDescriptorUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
3231 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
3232
3233 Element Documentation:
3234
3235 |**Name**|**Type**|**Documentation**|
3236 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3237 |Link|LinkType|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.|
3238 |Dimension|DimensionType|Dimension describes the structure of a dimension, which is defined as a statistical concept used (most probably together with other statistical concepts) to identify a statistical series, such as a time series, e.g. a statistical concept indicating certain economic activity or a geographical reference area.|
3239 |TimeDimension|TimeDimensionType|TimeDimension is a special dimension which designates the period in time in which the data identified by the full series key applies.|
3240
3241 ***BaseDimensionBaseType*:** BaseDimensionBaseType is an abstract base type that serves as the basis for any dimension. It restricts the text format base to a text format valid for data components (that does not allow for XHTML representation).
3242
3243 Derivation:
3244
3245 AnnotableType (extension)
3246 IdentifiableType (extension)
3247 ComponentBaseType (extension)
3248 ComponentType (restriction)
3249 BaseDimensionBaseType
3250
3251 Attributes:
3252
3253 id?, urn?, uri?
3254
3255 Content:
3256
3257 Annotations?, Link*, ConceptIdentity, LocalRepresentation?
3258
3259 Attribute Documentation:
3260
3261 |**Name**|**Type**|**Documentation**|
3262 |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).|
3263 |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
3264 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
3265
3266 Element Documentation:
3267
3268 |**Name**|**Type**|**Documentation**|
3269 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3270 |Link|LinkType|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.|
3271 |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.|
3272 |LocalRepresentation|*DataStructureRepresentationType*|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.|
3273
3274 ***BaseDimensionType*:** BaseDimensionType is an abstract base type which defines the basic structure of all dimensions.
3275
3276 Derivation:
3277
3278 AnnotableType (extension)
3279 IdentifiableType (extension)
3280 ComponentBaseType (extension)
3281 ComponentType (restriction)
3282 BaseDimensionBaseType (extension)
3283 BaseDimensionType
3284
3285 Attributes:
3286
3287 id?, urn?, uri?, position?
3288
3289 Content:
3290
3291 Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole
3292
3293 Attribute Documentation:
3294
3295 |**Name**|**Type**|**Documentation**|
3296 |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).|
3297 |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
3298 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
3299 |position|xs:int|The order of the dimensions in the key descriptor (DimensionList element) defines the order of the dimensions in the data structure. This position attribute explicitly specifies the position of the dimension in the data structure. It is optional and if specified must be consistent with the position of the dimension in the key descriptor.|
3300
3301 Element Documentation:
3302
3303 |**Name**|**Type**|**Documentation**|
3304 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3305 |Link|LinkType|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.|
3306 |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.|
3307 |LocalRepresentation|*DataStructureRepresentationType*|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.|
3308 |ConceptRole|ConceptReferenceType|ConceptRole references concepts which define roles which this dimension serves.|
3309
3310 **DimensionType:** DimensionType describes the structure of an ordinary dimension, which is defined as a statistical concept used (most probably together with other statistical concepts) to identify a statistical series, such as a time series, e.g. a statistical concept indicating certain economic activity or a geographical reference area. The dimension takes its semantic, and in some cases it representation, from its concept identity. A dimension can be coded by referencing a code list from its coded local representation. It can also specify its text format, which is used as the representation of the dimension if a coded representation is not defined. Neither the coded or uncoded representation are necessary, since the dimension may take these from the referenced concept.
3311
3312 Derivation:
3313
3314 AnnotableType (extension)
3315 IdentifiableType (extension)
3316 ComponentBaseType (extension)
3317 ComponentType (restriction)
3318 BaseDimensionBaseType (extension)
3319 BaseDimensionType (restriction)
3320 DimensionType
3321
3322 Attributes:
3323
3324 id?, urn?, uri?, position?
3325
3326 Content:
3327
3328 Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole
3329
3330 Attribute Documentation:
3331
3332 |**Name**|**Type**|**Documentation**|
3333 |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).|
3334 |urn|DimensionUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
3335 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
3336 |position|xs:int|The order of the dimensions in the key descriptor (DimensionList element) defines the order of the dimensions in the data structure. This position attribute explicitly specifies the position of the dimension in the data structure. It is optional and if specified must be consistent with the position of the dimension in the key descriptor.|
3337
3338 Element Documentation:
3339
3340 |**Name**|**Type**|**Documentation**
3341 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3342 |Link|LinkType|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.
3343 |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.
3344 |LocalRepresentation|SimpleDataStructureRepresentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.
3345 |ConceptRole|ConceptReferenceType|ConceptRole references concepts which define roles which this dimension serves.
3346
3347 **TimeDimensionType:** TimeDimensionType describes the structure of a time dimension. The time dimension takes its semantic from its concept identity (usually the TIME\_PERIOD concept), yet is always has a fixed identifier (TIME\_PERIOD). The time dimension always has a fixed text format, which specifies that its format is always the in the value set of the observational time period (see common:ObservationalTimePeriodType). It is possible that the format may be a sub-set of the observational time period value set. For example, it is possible to state that the representation might always be a calendar year. See the enumerations of the textType attribute in the LocalRepresentation/TextFormat for more details of the possible sub-sets. It is also possible to facet this representation with start and end dates. The purpose of such facts is to restrict the value of the time dimension to occur within the specified range. If the time dimension is expected to allow for the standard reporting periods (see common:ReportingTimePeriodType) to be used, then it is strongly recommended that the reporting year start day attribute also be included in the data structure definition. When the reporting year start day attribute is used, any standard reporting period values will be assumed to be based on the start day contained in this attribute. If the reporting year start day attribute is not included and standard reporting periods are used, these values will be assumed to be based on a reporting year which begins January 1.
3348
3349 Derivation:
3350
3351 AnnotableType (extension)
3352 IdentifiableType (extension)
3353 ComponentBaseType (extension)
3354 ComponentType (restriction)
3355 BaseDimensionBaseType (extension)
3356 BaseDimensionType (restriction)
3357 TimeDimensionType
3358
3359 Attributes:
3360 id?, urn?, uri?
3361
3362 Content:
3363 nnotations?, Link*, ConceptIdentity, LocalRepresentation
3364
3365 Attribute Documentation:
3366
3367 |**Name**|**Type**|**Documentation**|
3368 |id (fixed: TIME\_PERIOD)|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).|
3369 |urn|TimeDimensionUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
3370 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
3371
3372 Element Documentation:
3373
3374 |**Name**|**Type**|**Documentation**
3375 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3376 |Link|LinkType|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.
3377 |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.
3378 |LocalRepresentation|TimeDimensionRepresentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.
3379
3380 **GroupBaseType:** GroupBaseType is an abstract base type that forms the basis for the GroupType.
3381
3382 Derivation:
3383
3384 AnnotableType (extension)
3385 IdentifiableType (extension)
3386 ComponentListType (restriction)
3387 GroupBaseType
3388
3389 Attributes:
3390 id, urn?, uri?
3391
3392 Content:
3393 Annotations?
3394
3395 Attribute Documentation:
3396
3397 |**Name**|**Type**|**Documentation**
3398 |id|IDType|The id is the identifier for the object.
3399 |urn|GroupDimensionDescriptorUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3400 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3401
3402 Element Documentation:
3403
3404 |**Name**|**Type**|**Documentation**|
3405 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3406
3407 **GroupType:** GroupType describes the structure of a group descriptor in a data structure definition. A group may consist of a of partial key, or collection of distinct cube regions or key sets to which attributes may be attached. The purpose of a group is to specify attributes values which have the same value based on some common dimensionality. All groups declared in the data structure must be unique - that is, you may not have duplicate partial keys. All groups must be given unique identifiers.
3408
3409 Derivation:
3410
3411 AnnotableType (extension)
3412 IdentifiableType (extension)
3413 ComponentListType (restriction)
3414 GroupBaseType (extension)
3415 GroupType
3416
3417 Attributes:
3418
3419 id, urn?, uri?
3420
3421 Content:
3422
3423 Annotations?, GroupDimension+
3424
3425 Attribute Documentation:
3426
3427 |**Name**|**Type**|**Documentation**|
3428 |id|IDType|The id is the identifier for the object.|
3429 |urn|GroupDimensionDescriptorUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
3430 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
3431
3432 Element Documentation:
3433
3434 |**Name**|**Type**|**Documentation**|
3435 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3436 |GroupDimension|GroupDimensionType|GroupDimension is a component which contains only a reference to a dimension in the key descriptor (DimensionList). Although it is conventional to declare dimensions in the same order as they are declared in the ordered key, there is no requirement to do so - the ordering of the values of the key are taken from the order in which the dimensions are declared. Note that the id of a dimension may be inherited from its underlying concept - therefore this reference value may actually be the id of the concept.|
3437
3438 ***GroupDimensionBaseType*:** GroupDimensionBaseType is an abstract base type which refines the base ComponentType in order to form the basis for the GroupDimensionType.
3439
3440 Derivation:
3441
3442 AnnotableType (extension)
3443 IdentifiableType (extension)
3444 ComponentBaseType (extension)
3445 ComponentType (restriction)
3446 GroupDimensionBaseType
3447
3448 Content:
3449
3450 {Empty}
3451
3452 **GroupDimensionType:** GroupDimensionType defines a dimension component with a group key descriptor component list. Although technically a component, this is essentially a reference to a dimension defined in the key descriptor. Therefore, the identification, name, and description, concept identity and representation properties that are typically available for a component are not allowed here, as they are all inherited from the referenced dimension.
3453
3454 Derivation:
3455
3456 AnnotableType (extension)
3457 IdentifiableType (extension)
3458 ComponentBaseType (extension)
3459 ComponentType (restriction)
3460 GroupDimensionBaseType (extension)
3461 GroupDimensionType
3462
3463 Content:
3464
3465 DimensionReference
3466
3467 Element Documentation:
3468
3469 |**Name**|**Type**|**Documentation**|
3470 |DimensionReference|NCNameIDType|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.|
3471
3472 **MeasureListType:** MeasureListType describes the structure of the measure descriptor for a data structure definition.
3473
3474 Derivation:
3475
3476 AnnotableType (extension)
3477 IdentifiableType (extension)
3478 ComponentListType (restriction)
3479 MeasureListType
3480
3481 Attributes:
3482
3483 id?, urn?, uri?
3484
3485 Content:
3486
3487 Annotations?, Link*, Measure+
3488
3489 Attribute Documentation:
3490
3491 |**Name**|**Type**|**Documentation**|
3492 |id (fixed: MeasureDescriptor)|IDType|The id is the identifier for the object.|
3493 |urn|MeasureDescriptorUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
3494 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
3495
3496 Element Documentation:
3497
3498 |**Name**|**Type**|**Documentation**|
3499 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3500 |Link|LinkType|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.|
3501 |Measure|MeasureType|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.|
3502
3503 ***MeasureBaseType*:** MeasureBaseType is an abstract base type that refines ComponentType to rerstrict the represenations to those which are applicable for a measure.
3504
3505 Derivation:
3506
3507 AnnotableType (extension)
3508 IdentifiableType (extension)
3509 ComponentBaseType (extension)
3510 ComponentType (restriction)
3511 MeasureBaseType
3512
3513 Attributes:
3514
3515 id?, urn?, uri?
3516
3517 Content:
3518
3519 Annotations?, Link*, ConceptIdentity, LocalRepresentation?
3520
3521 Attribute Documentation:
3522
3523 |**Name**|**Type**|**Documentation**|
3524 |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).|
3525 |urn|MeasureUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
3526 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
3527
3528 Element Documentation:
3529
3530 |**Name**|**Type**|**Documentation**|
3531 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3532 |Link|LinkType|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.|
3533 |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.|
3534 |LocalRepresentation|MeasureRepresentatio nType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.|
3535
3536 **MeasureType:** 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.
3537
3538 Derivation:
3539
3540 AnnotableType (extension)
3541 IdentifiableType (extension)
3542 ComponentBaseType (extension)
3543 ComponentType (restriction)
3544 MeasureBaseType (extension)
3545 MeasureType
3546
3547 Attributes:
3548
3549 id?, urn?, uri?, usage?
3550
3551 Content:
3552
3553 Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole
3554
3555 Attribute Documentation:
3556
3557 |**Name**|**Type**|**Documentation**|
3558 |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).|
3559 |urn|MeasureUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
3560 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
3561 |usage (default: optional)|UsageType|The usage attribute indicates whether a measure value must be available for any corresponding existing observation.|
3562
3563 Element Documentation:
3564
3565 |**Name**|**Type**|**Documentation**|
3566 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3567 |Link|LinkType|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.|
3568 |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.|
3569 |LocalRepresentation|MeasureRepresentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.|
3570 |ConceptRole|ConceptReferenceType|ConceptRole references concepts which define roles which this measure serves.|
3571
3572 ***DataStructureRepresentationType*:** DataStructureRepresentationType is an abstract base type which defines the allowable representations for any data structure definition component. The enumeration must be restricted to the proper type for item scheme for a given component.
3573
3574 Derivation:
3575
3576 RepresentationType (restriction)
3577 DataStructureRepresentationType
3578
3579 Attributes:
3580
3581 maxOccurs?
3582
3583 Content:
3584
3585 (TextFormat|(Enumeration, EnumerationFormat?))
3586
3587 Attribute Documentation:
3588
3589 |**Name**|**Type**|**Documentation**|
3590 |maxOccurs|OccurenceType|The maxOccurs attribute indicates the maximum number of values that can be reported for the component.|
3591
3592 Element Documentation:
3593
3594 |**Name**|**Type**|**Documentation**|
3595 |TextFormat|SimpleComponentTextF ormatType|TextFormat describes an uncoded textual format.|
3596 |Enumeration|AnyCodelistReference Type|Enumeration references an item scheme that enumerates the allowable values for this representation.|
3597 |EnumerationFormat|CodedTextFormatType|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.|
3598
3599 **AttributeRepresentationType:** 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.
3600
3601 Derivation:
3602
3603 RepresentationType (restriction)
3604 AttributeRepresentationType
3605
3606 Attributes:
3607
3608 minOccurs?, maxOccurs?
3609
3610 Content:
3611
3612 (TextFormat|(Enumeration, EnumerationFormat?))
3613
3614 Attribute Documentation:
3615
3616 |**Name**|**Type**|**Documentation**|
3617 |minOccurs (default: 1)|xs: nonNegativeInteger|The minOccurs attribute indicates the minimum number of value that must be reported for the component.|
3618 |maxOccurs (default: 1)|OccurenceType|The maxOccurs attribute indicates the maximum number of values that can be reported for the component.|
3619
3620 Element Documentation:
3621
3622 |**Name**|**Type**|**Documentation**|
3623 |TextFormat|BasicComponentTextFo rmatType|TextFormat describes an uncoded textual format.|
3624 |Enumeration|AnyCodelistReference Type|Enumeration references an item scheme that enumerates the allowable values for this representation.|
3625 |EnumerationFormat|CodedTextFormatType|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.|
3626
3627 **MeasureRepresentationType:** 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.
3628
3629 Derivation:
3630
3631 RepresentationType (restriction)
3632 MeasureRepresentationType
3633
3634 Attributes:
3635 minOccurs?, maxOccurs?
3636
3637 Content:
3638 (TextFormat|(Enumeration, EnumerationFormat?))
3639
3640 Attribute Documentation:
3641
3642 |**Name**|**Type**|**Documentation**|
3643 |minOccurs (default: 1)|xs: nonNegativeInteger|The minOccurs attribute indicates the minimum number of value that must be reported for the component.|
3644 |maxOccurs (default: 1)|OccurenceType|The maxOccurs attribute indicates the maximum number of values that can be reported for the component.|
3645
3646 Element Documentation:
3647
3648 |**Name**|**Type**|**Documentation**|
3649 |TextFormat|BasicComponentTextFo rmatType|TextFormat describes an uncoded textual format.|
3650 |Enumeration|AnyCodelistReference Type|Enumeration references an item scheme that enumerates the allowable values for this representation.|
3651 |EnumerationFormat|CodedTextFormatType|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.|
3652
3653 **SimpleDataStructureRepresentationType:** SimpleDataStructureRepresentationType defines the representation for any non-time dimension data structure definition component.
3654
3655 Derivation:
3656
3657 RepresentationType (restriction)
3658 DataStructureRepresentationType (restriction)
3659 SimpleDataStructureRepresentationType
3660
3661 Content:
3662 (TextFormat|(Enumeration, EnumerationFormat?))
3663
3664 Element Documentation:
3665
3666 |**Name**|**Type**|**Documentation**|
3667 |TextFormat|SimpleComponentTextF ormatType|TextFormat describes an uncoded textual format.|
3668 |Enumeration|CodelistReferenceTyp e|Enumeration references an item scheme that enumerates the allowable values for this representation.|
3669 |EnumerationFormat|CodedTextFormatType|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.|
3670
3671 **TimeDimensionRepresentationType:** TimeDimensionRepresentationType defines the representation for the time dimension. Enumerated values are not allowed.
3672
3673 Derivation:
3674
3675 RepresentationType (restriction)
3676 DataStructureRepresentationType (restriction)
3677 SimpleDataStructureRepresentationType (restriction)
3678 TimeDimensionRepresentationType
3679
3680 Content:
3681 TextFormat
3682
3683 Element Documentation:
3684
3685 |**Name**|**Type**|**Documentation**|
3686 |TextFormat|TimeTextFormatType|TextFormat describes an uncoded textual format.|
3687
3688 **DataflowType:** DataflowType describes the structure of a data flow. A data flow is defined as the structure of data that will provided for different reference periods. If this type is not referenced externally, then a reference to a data structure must be provided.
3689
3690 Derivation:
3691
3692 AnnotableType (extension)
3693 IdentifiableType (extension)
3694 NameableType (extension)
3695 VersionableType (restriction)
3696 MaintainableBaseType (extension)
3697 MaintainableType (restriction)
3698 StructureUsageType (restriction)
3699 DataflowType
3700
3701 Attributes:
3702 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
3703
3704 Content:
3705 Annotations?, Link*, Name+, Description*, Structure?
3706
3707 Attribute Documentation:
3708
3709 |**Name**|**Type**|**Documentation**|
3710 |id|IDType|The id is the identifier for the object.|
3711 |urn|DataflowUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
3712 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
3713 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
3714 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
3715 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
3716 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
3717 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
3718 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
3719 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
3720 |isPartialLanguage (default: false)|xs:boolean|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’.|
3721
3722 Element Documentation:
3723
3724 |**Name**|**Type**|**Documentation**|
3725 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3726 |Link|LinkType|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.|
3727 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
3728 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
3729 |Structure|DataStructureReferenceType|Structure provides a reference to the data structure definition which defines the structure of all data for this flow.|
3730
3731 ***HierarchyBaseType*:** HierarchyBaseType is an abstract base class that is the basis for the HierarchyType. It requires that a name be supplied.
3732
3733 Derivation:
3734
3735 AnnotableType (extension)
3736 IdentifiableType (extension)
3737 NameableType (extension)
3738 VersionableType (restriction)
3739 MaintainableBaseType (extension)
3740 MaintainableType (restriction)
3741 HierarchyBaseType
3742
3743 Attributes:
3744 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
3745
3746 Content:
3747 Annotations?, Link*, Name+, Description
3748
3749 Attribute Documentation:
3750
3751 |**Name**|**Type**|**Documentation**
3752 |id|IDType|The id is the identifier for the object.
3753 |urn|HierarchyUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3754 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3755 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
3756 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
3757 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
3758 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
3759 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
3760 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
3761 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
3762 |isPartialLanguage (default: false)|xs:boolean|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’.
3763
3764 Element Documentation:
3765
3766 |**Name**|**Type**|**Documentation**|
3767 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3768 |Link|LinkType|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.|
3769 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
3770 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
3771
3772 **HierarchyType:** 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.
3773
3774 Derivation:
3775
3776 AnnotableType (extension)
3777 IdentifiableType (extension)
3778 NameableType (extension)
3779 VersionableType (restriction)
3780 MaintainableBaseType (extension)
3781 MaintainableType (restriction)
3782 HierarchyBaseType (extension)
3783 HierarchyType
3784
3785 Attributes:
3786 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, hasFormalLevels
3787
3788 Content:
3789 Annotations?, Link*, Name+, Description*, Level?, HierarchicalCode+
3790
3791 Attribute Documentation:
3792
3793 |**Name**|**Type**|**Documentation**|
3794 |id|IDType|The id is the identifier for the object.|
3795 |urn|HierarchyUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
3796 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
3797 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
3798 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
3799 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
3800 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
3801 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
3802 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
3803 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
3804 |isPartialLanguage (default: false)|xs:boolean|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’.|
3805 |hasFormalLevels|xs:boolean|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.|
3806
3807 Element Documentation:
3808
3809 |**Name**|**Type**|**Documentation**|
3810 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3811 |Link|LinkType|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.|
3812 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
3813 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
3814 |Level|LevelType|In a formally leveled hierarchy, Level describes a group of codes which are characterised by homogeneous coding, and where the parent of each code in the group is at the same higher level of the hierarchy. In a value based hierarchy Level describes information about the codes at the specified nesting level. This structure is recursive to indicate the hierarchy of the levels.|
3815 |HierarchicalCode|HierarchicalCodeType|HierarchicalCode is used to assemble the codes from the codelist(s) referenced into a hierarchy.|
3816
3817 **HierarchicalCodeBaseType:** HierarchicalCodeBaseType is an abstract base type the creates the basis for the HierarchicalCodeType. It removes the urn and uri.
3818
3819 Derivation:
3820
3821 AnnotableType (extension)
3822 IdentifiableType (extension)
3823 HierarchicalCodeBaseType
3824
3825 Attributes:
3826 id, urn?, uri?
3827
3828 Content:
3829 Annotations?, Link
3830
3831 Attribute Documentation:
3832
3833 |**Name**|**Type**|**Documentation**|
3834 |id|IDType|The id attribute allows for an id to be assigned to the use of the particular code at that specific point in the hierarchy. This value is unique within the hierarchy being created, and is used to map the hierarchy against external structures.|
3835 |urn|HierarchicalCodeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
3836 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
3837
3838 Element Documentation:
3839
3840 |**Name**|**Type**|**Documentation**|
3841 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3842 |Link|LinkType|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.|
3843
3844 **HierarchicalCodeType:** HierarchicalCodeType describes the structure of a hierarchical code. A hierarchical code provides for a reference to a code that is referenced within the hierarchical code list via either a complete reference to a code through either a URN or full set of reference fields. 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.
3845
3846 Derivation:
3847
3848 AnnotableType (extension)
3849 IdentifiableType (extension)
3850 HierarchicalCodeBaseType (extension)
3851 HierarchicalCodeType
3852
3853 Attributes:
3854 id, urn?, uri?, validFrom?, validTo?
3855
3856 Content:
3857 Annotations?, Link*, Code, HierarchicalCode*, Level?
3858
3859 Attribute Documentation:
3860
3861 |**Name**|**Type**|**Documentation**
3862 |id|IDType|The id attribute allows for an id to be assigned to the use of the particular code at that specific point in the hierarchy. This value is unique within the hierarchy being created, and is used to map the hierarchy against external structures.
3863 |urn|HierarchicalCodeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3864 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3865 |validFrom|xs:dateTime|The validFrom attriubte indicates the point in time in which the hiearchical code became effective. This can be used to track the historicity of codes changing over time.
3866 |validTo|xs:dateTime|The validTo attriubte indicates the point in time in which the hiearchical code became no longer effective. This can be used to track the historicity of codes changing over time.
3867
3868 Element Documentation:
3869
3870 |**Name**|**Type**|**Documentation**
3871 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3872 |Link|LinkType|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.
3873 |Code|CodeReferenceType|Code provides a complete, explicit reference to a code through either its URN, or a complete reference to the codelist and code.
3874 |HierarchicalCode|HierarchicalCodeType|HierarchicalCode is used to nest referenced codes into a value based hierarchy.
3875 |Level|IDType|Level references a formal level defined within the hierarchy which defines this hierarchical code. This is only necessary if the nesting depth of the hierarchical code does not correspond to the nesting depth of the level to which it belongs (i.e. the hieararchical code is to skip down a level). Otherwise, the code is assumed to exist at the level in which the nesting depth of the level matches the nesting depth of the code.
3876
3877 **LevelBaseType:** LevelBaseType is an abstract base type that makes up the basis for the LevelType. It requires a name and id.
3878
3879 Derivation:
3880
3881 AnnotableType (extension)
3882 IdentifiableType (extension)
3883 NameableType (restriction)
3884 LevelBaseType
3885
3886 Attributes:
3887 id, urn?, uri?
3888
3889 Content:
3890 Annotations?, Link*, Name+, Description
3891
3892 Attribute Documentation:
3893
3894 |**Name**|**Type**|**Documentation**|
3895 |id|IDType|The id is the identifier for the object.|
3896 |urn|LevelUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
3897 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
3898
3899 Element Documentation:
3900
3901 |**Name**|**Type**|**Documentation**|
3902 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3903 |Link|LinkType|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.|
3904 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
3905 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
3906
3907 **LevelType:** LevelType describes a level in a hierarchical codelist. Where level is defined as a group where codes can be characterised by homogeneous coding, and where the parent of each code in the group is at the same higher level of the hierarchy.
3908
3909 Derivation:
3910
3911 AnnotableType (extension)
3912 IdentifiableType (extension)
3913 NameableType (restriction)
3914 LevelBaseType (extension)
3915 LevelType
3916
3917 Attributes:
3918
3919 id, urn?, uri?
3920
3921 Content:
3922
3923 Annotations?, Link*, Name+, Description*, CodingFormat?, Level?
3924
3925 Attribute Documentation:
3926
3927 |**Name**|**Type**|**Documentation**|
3928 |id|IDType|The id is the identifier for the object.|
3929 |urn|LevelUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
3930 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
3931
3932 Element Documentation:
3933
3934 |**Name**|**Type**|**Documentation**|
3935 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
3936 |Link|LinkType|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.|
3937 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
3938 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
3939 |CodingFormat|CodingTextFormatType|CodingFormat specifies the text formatting of the codes in this level. This includes facets such as the expected characters and the length of the codes.|
3940 |Level|LevelType|Level describes the next level down in the hierarchy.|
3941
3942 **CodingTextFormatType:**
3943
3944 Derivation:
3945
3946 TextFormatType (restriction)
3947 BasicComponentTextFormatType (restriction)
3948 SimpleComponentTextFormatType (restriction)
3949 CodingTextFormatType
3950
3951 Attributes:
3952 textType?, isSequence?, interval?, startValue?, endValue?, minLength?, maxLength?, minValue?, maxValue?, pattern?
3953
3954 Content:
3955
3956 {Empty}
3957
3958 Attribute Documentation:
3959
3960 |**Name**|**Type**|**Documentation**|
3961 |textType|SimpleCodeDataType|The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets.|
3962 |isSequence|xs:boolean|The isSequence attribute indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue attributes or the timeInterval, startTime, and endTime, attributes. If this attribute holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely.|
3963 |interval|xs:integer|The interval attribute specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence attribute must have a value of true.|
3964 |startValue|xs:positiveInteger|The startValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed.|
3965 |endValue|xs:positiveInteger|The endValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates that ending point (if any) of the sequence.|
3966 |minLength|xs:positiveInteger|The minLength attribute specifies the minimum and length of the value in characters.|
3967 |maxLength|xs:positiveInteger|The maxLength attribute specifies the maximum length of the value in characters.|
3968 |minValue|xs:positiveInteger|The minValue attribute is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid value will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive.|
3969 |maxValue|xs:positiveInteger|The maxValue attribute is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid value will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive.|
3970 |pattern|xs:string|The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema.|
3971
3972 ***HierarchyAssociationBaseType*:** HierarchyAssociationBaseType defines the base refinement of the HierarchyAssociationType. Its purpose is to retrict the urn attribute.
3973
3974 Derivation:
3975
3976 AnnotableType (extension)
3977 IdentifiableType (extension)
3978 NameableType (extension)
3979 VersionableType (restriction)
3980 MaintainableBaseType (extension)
3981 MaintainableType (restriction)
3982 HierarchyAssociationBaseType
3983
3984 Attributes:
3985
3986 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
3987
3988 Content:
3989
3990 Annotations?, Link*, Name+, Description
3991
3992 Attribute Documentation:
3993
3994 |**Name**|**Type**|**Documentation**
3995 |id|IDType|The id is the identifier for the object.
3996 |urn|HierarchyAssociation UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3997 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3998 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
3999 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4000 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4001 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4002 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4003 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4004 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4005 |isPartialLanguage (default: false)|xs:boolean|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’.
4006
4007 Element Documentation:
4008
4009 |**Name**|**Type**|**Documentation**|
4010 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4011 |Link|LinkType|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.|
4012 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4013 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4014
4015 **HierarchyAssociationType:** HierarchyAssociationType defines the structure of a hiearchy 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).
4016
4017 Derivation:
4018
4019 AnnotableType (extension)
4020 IdentifiableType (extension)
4021 NameableType (extension)
4022 VersionableType (restriction)
4023 MaintainableBaseType (extension)
4024 MaintainableType (restriction)
4025 HierarchyAssociationType
4026
4027 Attributes:
4028
4029 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
4030
4031 Content:
4032
4033 Annotations?, Link*, Name+, Description*, LinkedHierarchy, LinkedObject, ContextObject?
4034
4035 Attribute Documentation:
4036
4037 |**Name**|**Type**|**Documentation**|
4038 |id|IDType|The id is the identifier for the object.|
4039 |urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
4040 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
4041 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
4042 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
4043 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
4044 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
4045 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
4046 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
4047 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
4048 |isPartialLanguage (default: false)|xs:boolean|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’.|
4049
4050 Element Documentation:
4051
4052 |**Name**|**Type**|**Documentation**|
4053 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4054 |Link|LinkType|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.|
4055 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4056 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4057 |LinkedHierarchy|HierarchyReferenceType|The associated hierarchy.|
4058 |LinkedObject|UrnReferenceType|Associates the Identifiable Artefact that needs the Hierarchy.|
4059 |ContextObject|UrnReferenceType|The context within which the association is performed.|
4060
4061 ***MetadataflowBaseType*:** MetadataflowBaseType is an abstract base type that serves as the basis for the MetadataflowType. It restricts the structure to reference a metadata structure definition.
4062
4063 Derivation:
4064
4065 AnnotableType (extension)
4066 IdentifiableType (extension)
4067 NameableType (extension)
4068 VersionableType (restriction)
4069 MaintainableBaseType (extension)
4070 MaintainableType (restriction)
4071 StructureUsageType (restriction)
4072 MetadataflowBaseType
4073
4074 Attributes:
4075
4076 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
4077
4078 Content:
4079
4080 Annotations?, Link*, Name+, Description*, Structure?
4081
4082 Attribute Documentation:
4083
4084 |**Name**|**Type**|**Documentation**|
4085 |id|IDType|The id is the identifier for the object.|
4086 |urn|MetadataflowUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
4087 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
4088 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
4089 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
4090 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
4091 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
4092 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
4093 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
4094 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
4095 |isPartialLanguage (default: false)|xs:boolean|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’.|
4096
4097 Element Documentation:
4098
4099 |**Name**|**Type**|**Documentation**|
4100 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4101 |Link|LinkType|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.|
4102 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4103 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4104 |Structure|MetadataStructureReferenceType|Structure provides a reference to the metadata structure definition describing the structure of all reference metadata for this flow.|
4105
4106 **MetadataflowType:** MetadataflowType describes the structure of a metadata flow. A dataflow is defined as the structure of reference metadata that will be provided for different reference periods. If this type is not referenced externally, then a reference to a metadata structure definition must be provided
4107
4108 Derivation:
4109
4110 AnnotableType (extension)
4111 IdentifiableType (extension)
4112 NameableType (extension)
4113 VersionableType (restriction)
4114 MaintainableBaseType (extension)
4115 MaintainableType (restriction)
4116 StructureUsageType (restriction)
4117 MetadataflowBaseType (extension)
4118 MetadataflowType
4119
4120 Attributes:
4121
4122 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
4123
4124 Content:
4125
4126 Annotations?, Link*, Name+, Description*, Structure?, Target+
4127
4128 Attribute Documentation:
4129
4130 |**Name**|**Type**|**Documentation**|
4131 |id|IDType|The id is the identifier for the object.|
4132 |urn|MetadataflowUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
4133 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
4134 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
4135 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
4136 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
4137 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
4138 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
4139 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
4140 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
4141 |isPartialLanguage (default: false)|xs:boolean|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’.|
4142
4143 Element Documentation:
4144
4145 |**Name**|**Type**|**Documentation**|
4146 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4147 |Link|LinkType|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.|
4148 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4149 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4150 |Structure|MetadataStructureRef erenceType|Structure provides a reference to the metadata structure definition describing the structure of all reference metadata for this flow.|
4151 |Target|WildcardUrnType|References identifiable structures to which the refernece metadata described by the referenced metadata structure should be restricted to. These references may include wildcards for parts of the reference.|
4152
4153 **MetadataStructureType:** MetadataStructureType is used to describe a metadata structure definition, which is defined as a collection of metadata concepts, their structure and usage when used to collect or disseminate reference metadata.
4154
4155 Derivation:
4156
4157 AnnotableType (extension)
4158 IdentifiableType (extension)
4159 NameableType (extension)
4160 VersionableType (restriction)
4161 MaintainableBaseType (extension)
4162 MaintainableType (restriction)
4163 StructureType (restriction)
4164 MetadataStructureType
4165
4166 Attributes:
4167
4168 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
4169
4170 Content:
4171
4172 Annotations?, Link*, Name+, Description*, MetadataStructureComponents?
4173
4174 Attribute Documentation:
4175
4176 |**Name**|**Type**|**Documentation**|
4177 |id|IDType|The id is the identifier for the object.|
4178 |urn|MetadataStructureUrn Type|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
4179 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
4180 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
4181 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
4182 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
4183 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
4184 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
4185 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
4186 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
4187 |isPartialLanguage (default: false)|xs:boolean|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’.|
4188
4189 Element Documentation:
4190
4191 |**Name**|**Type**|**Documentation**|
4192 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4193 |Link|LinkType|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.|
4194 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4195 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4196 |MetadataStructureCom ponents|MetadataStructureCom ponentsType|MetadataStructureComponents defines the grouping of the sets of the components that make up the metadata structure definition.|
4197
4198 **MetadataStructureComponentsBaseType:** MetadataStructureComponentsBaseType is an abstract base type that forms the basis for the MetadataStructureComponentsType.
4199
4200 Derivation:
4201
4202 GroupingType (restriction)
4203 MetadataStructureComponentsBaseType
4204
4205 Content:
4206
4207 {Empty}
4208
4209 **MetadataStructureComponentsType:** MetadataStructureComponentsType describes the structure of the grouping of the sets of the components that make up the metadata structure definition.
4210
4211 Derivation:
4212
4213 GroupingType (restriction)
4214 MetadataStructureComponentsBaseType (extension)
4215 MetadataStructureComponentsType
4216
4217 Content:
4218
4219 MetadataAttributeList
4220
4221 Element Documentation:
4222
4223 |**Name**|**Type**|**Documentation**
4224 |MetadataAttributeList|MetadataAttributeListType|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.
4225
4226 **MetadataAttributeListType:** MetadataAttributeListType describes the structure of a meta data attribute list. It comprises a set of metadata attributes that can be defined as a hierarchy.
4227
4228 Derivation:
4229
4230 AnnotableType (extension)
4231 IdentifiableType (extension)
4232 ComponentListType (restriction)
4233 MetadataAttributeListType
4234
4235 Attributes:
4236
4237 id?, urn?, uri?
4238
4239 Content:
4240
4241 Annotations?, Link*, MetadataAttribute+
4242
4243 Attribute Documentation:
4244
4245 |**Name**|**Type**|**Documentation**|
4246 |id (fixed: MetadataAttributeDescriptor)|IDType|The id attribute is provided in this case for completeness. However, its value is fixed to MetadataAttributeDescriptor.|
4247 |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
4248 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
4249
4250 Element Documentation:
4251
4252 |**Name**|**Type**|**Documentation**|
4253 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4254 |Link|LinkType|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.|
4255 |MetadataAttribute|MetadataAttributeType|MetadataAttribute defines the a metadata attribute, which is the value of an attribute, such as the instance of a coded or uncoded attribute in a metadata structure definition.|
4256
4257 **MetadataAttributeBaseType:** MetadataAttributeBaseType is an abstract base type the serves as the basis for the MetadataAttributeType.
4258
4259 Derivation:
4260
4261 AnnotableType (extension)
4262 IdentifiableType (extension)
4263 ComponentBaseType (extension)
4264 ComponentType (restriction)
4265 MetadataAttributeBaseType
4266
4267 Attributes:
4268
4269 id?, urn?, uri?
4270
4271 Content:
4272
4273 Annotations?, Link*, ConceptIdentity, LocalRepresentation?
4274
4275 Attribute Documentation:
4276
4277 |**Name**|**Type**|**Documentation**|
4278 |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).|
4279 |urn|MetadataAttributeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
4280 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
4281
4282 Element Documentation:
4283
4284 |**Name**|**Type**|**Documentation**
4285 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4286 |Link|LinkType|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.
4287 |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.
4288 |LocalRepresentation|MetadataAttributeRepresentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.
4289
4290 **MetadataAttributeType:** MetadataAttributeType describes the structure of a metadata attribute. The metadata attribute takes its semantic, and in some cases it representation, from its concept identity. A metadata attribute may be coded (via the local representation), uncoded (via the text format), or take no value. In addition to this value, the metadata attribute may also specify subordinate metadata attributes. If a metadata attribute only serves the purpose of containing subordinate metadata attributes, then the isPresentational attribute should be used. Otherwise, it is assumed to also take a value. If the metadata attribute does take a value, and a representation is not defined, it will be inherited from the concept it takes its semantic from. The optional id on the metadata attribute uniquely identifies it within the metadata structured definition. If this id is not supplied, its value is assumed to be that of the concept referenced from the concept identity. Note that a metadata attribute (as identified by the id attribute) definition must be unique across the entire metadata structure definition.
4291
4292 Derivation:
4293
4294 AnnotableType (extension)
4295 IdentifiableType (extension)
4296 ComponentBaseType (extension)
4297 ComponentType (restriction)
4298 MetadataAttributeBaseType (extension)
4299 MetadataAttributeType
4300
4301 Attributes:
4302
4303 id?, urn?, uri?, minOccurs?, maxOccurs?, isPresentational?
4304
4305 Content:
4306
4307 Annotations?, Link*, ConceptIdentity, LocalRepresentation?, MetadataAttribute
4308
4309 Attribute Documentation:
4310
4311 |**Name**|**Type**|**Documentation**|
4312 |id|NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).|
4313 |urn|MetadataAttributeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
4314 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
4315 |minOccurs (default: 1)|xs: nonNegativeInteger|The minOccurs attribute indicates the minimum number of times this metadata attribute must occur within its parent object.|
4316 |maxOccurs (default: 1)|OccurenceType|The maxOccurs attribute indicates the maximum number of times this metadata attribute can occur within its parent object.|
4317 |isPresentational (default: false)|xs:boolean|The isPresentational attribute indicates whether the metadata attribute should allow for a value. A value of true, meaning the metadata attribute is presentational means that the attribute only contains child metadata attributes, and does not contain a value. If this attribute is not set to true, and a representation (coded or uncoded) is not defined, then the representation of the metadata attribute will be inherited from the concept from which it takes its identity.|
4318
4319 Element Documentation:
4320
4321 |**Name**|**Type**|**Documentation**|
4322 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4323 |Link|LinkType|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.|
4324 |ConceptIdentity|ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.|
4325 |LocalRepresentation|MetadataAttributeRepresentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.|
4326 |MetadataAttribute|MetadataAttributeType|MetadataAttribute defines the a metadata attribute, which is the value of an attribute, such as the instance of a coded or uncoded attribute in a metadata structure definition.|
4327
4328 **MetadataAttributeRepresentationType:** MetadataAttributeRepresentationType defines the possible local representations of a metadata attribute.
4329
4330 Derivation:
4331
4332 RepresentationType (restriction)
4333 MetadataAttributeRepresentationType
4334
4335 Content:
4336
4337 (TextFormat|(Enumeration, EnumerationFormat?))
4338
4339 Element Documentation:
4340
4341 |**Name**|**Type**|**Documentation**|
4342 |TextFormat|BasicComponentTextFormatType|TextFormat describes an uncoded textual format.|
4343 |Enumeration|CodelistReferenceType|Enumeration references an item scheme that enumerates the allowable values for this representation.|
4344 |EnumerationFormat|CodedTextFormatType|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.|
4345
4346 ***OrganisationSchemeBaseType*:** OrganisationSchemeBaseType is an abstract base type for any organisation scheme.
4347
4348 Derivation:
4349
4350 AnnotableType (extension)
4351 IdentifiableType (extension)
4352 NameableType (extension)
4353 VersionableType (restriction)
4354 MaintainableBaseType (extension)
4355 MaintainableType (restriction)
4356 ItemSchemeType (restriction)
4357 OrganisationSchemeBaseType
4358
4359 Attributes:
4360
4361 id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?
4362
4363 Content:
4364
4365 Annotations?, Link*, Name+, Description
4366
4367 Attribute Documentation:
4368
4369 |**Name**|**Type**|**Documentation**|
4370 |id|IDType|The id is the identifier for the object.|
4371 |urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
4372 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
4373 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
4374 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
4375 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
4376 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
4377 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
4378 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
4379 |isPartialLanguage (default: false)|xs:boolean|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’.|
4380 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.|
4381
4382 Element Documentation:
4383
4384 |**Name**|**Type**|**Documentation**|
4385 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4386 |Link|LinkType|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.|
4387 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4388 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4389
4390 **OrganisationSchemeType:** OrganisationSchemeType describes the structure of an organisation scheme.
4391
4392 Derivation:
4393
4394 AnnotableType (extension)
4395 IdentifiableType (extension)
4396 NameableType (extension)
4397 VersionableType (restriction)
4398 MaintainableBaseType (extension)
4399 MaintainableType (restriction)
4400 ItemSchemeType (restriction)
4401 OrganisationSchemeBaseType (extension)
4402 OrganisationSchemeType
4403
4404 Attributes:
4405
4406 id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?
4407
4408 Content:
4409
4410 Annotations?, Link*, Name+, Description*, Organisation*
4411
4412 Attribute Documentation:
4413
4414 |**Name**|**Type**|**Documentation**|
4415 |id|IDType|The id is the identifier for the object.|
4416 |urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
4417 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
4418 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
4419 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
4420 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
4421 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
4422 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
4423 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
4424 |isPartialLanguage (default: false)|xs:boolean|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’.|
4425 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.|
4426
4427 Element Documentation:
4428
4429 |(% style="width:120px" %)**Name**|(% style="width:175px" %)**Type**|**Documentation**|
4430 |(% style="width:120px" %)Annotations|(% style="width:175px" %)AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4431 |(% style="width:120px" %)Link|(% style="width:175px" %)LinkType|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.|
4432 |(% style="width:120px" %)Name|(% style="width:175px" %)TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4433 |(% style="width:120px" %)Description|(% style="width:175px" %)TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4434 |(% style="width:120px" %)//Organisation//|(% style="width:175px" %)//OrganisationType//|Organisation is an abstract substitution head for a generic organisation.|
4435
4436 **BaseOrganisationType:** BaseOrganisationType is an abstract base type the forms the basis for the OrganisationType.
4437
4438 Derivation:
4439
4440 AnnotableType (extension)
4441 IdentifiableType (extension)
4442 NameableType (restriction)
4443 ItemBaseType (extension)
4444 ItemType (restriction)
4445 BaseOrganisationType
4446
4447 Attributes:
4448
4449 id, urn?, uri?
4450
4451 Content:
4452
4453 Annotations?, Link*, Name+, Description*, Parent?
4454
4455 Attribute Documentation:
4456
4457 |**Name**|**Type**|**Documentation**|
4458 |id|IDType|The id is the identifier for the object.|
4459 |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
4460 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
4461
4462 Element Documentation:
4463
4464 |**Name**|**Type**|**Documentation**|
4465 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4466 |Link|LinkType|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.|
4467 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4468 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4469 |Parent|IDType|If the particular organisation scheme allows, an organisation may reference a parent organisation defined in the same scheme. This does not affect the identification of the organisation, but rather only serves to state the relationship.|
4470
4471 **OrganisationType:** OrganisationType in an abstract type which describes the structure of the details of an organisation. In addition to the basic organisation identification, contact details can be provided.
4472
4473 Derivation:
4474
4475 AnnotableType (extension)
4476 IdentifiableType (extension)
4477 NameableType (restriction)
4478 ItemBaseType (extension)
4479 ItemType (restriction)
4480 BaseOrganisationType (extension)
4481 OrganisationType
4482
4483 Attributes:
4484
4485 id, urn?, uri?
4486
4487 Content:
4488
4489 Annotations?, Link*, Name+, Description*, Parent?, Contact
4490
4491 Attribute Documentation:
4492
4493 |**Name**|**Type**|**Documentation**|
4494 |id|IDType|The id is the identifier for the object.|
4495 |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
4496 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
4497
4498 Element Documentation:
4499
4500 |**Name**|**Type**|**Documentation**|
4501 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4502 |Link|LinkType|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.|
4503 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4504 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4505 |Parent|IDType|If the particular organisation scheme allows, an organisation may reference a parent organisation defined in the same scheme. This does not affect the identification of the organisation, but rather only serves to state the relationship.|
4506 |Contact|ContactType|Contact describes a contact for the organisation,|
4507
4508 **AgencySchemeType:** AgencySchemeType defines a specific type of organisation scheme which contains only maintenance agencies. The agency scheme maintained by a particular maintenance agency is always provided a fixed identifier and 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.
4509
4510 Derivation:
4511
4512 AnnotableType (extension)
4513 IdentifiableType (extension)
4514 NameableType (extension)
4515 VersionableType (restriction)
4516 MaintainableBaseType (extension)
4517 MaintainableType (restriction)
4518 ItemSchemeType (restriction)
4519 OrganisationSchemeBaseType (extension)
4520 OrganisationSchemeType (restriction)
4521 AgencySchemeType
4522
4523 Attributes:
4524
4525 id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?
4526
4527 Content:
4528
4529 Annotations?, Link*, Name+, Description*, Agency
4530
4531 Attribute Documentation:
4532
4533 |**Name**|**Type**|**Documentation**|
4534 |id (fixed: AGENCIES)|IDType|The id is the identifier for the object.|
4535 |urn|AgencySchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
4536 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
4537 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
4538 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
4539 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
4540 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
4541 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
4542 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
4543 |isPartialLanguage (default: false)|xs:boolean|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’.|
4544 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.|
4545
4546 Element Documentation:
4547
4548 |**Name**|**Type**|**Documentation**|
4549 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4550 |Link|LinkType|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.|
4551 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4552 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4553 |Agency|AgencyType|Agency is an organisation which maintains structural metadata such as classifications, concepts, data structures, and metadata structures.|
4554
4555 **DataConsumerSchemeType:** DataConsumerSchemeType defines a type of organisation scheme which contains only data consumers. The data consumer scheme maintained by a particular maintenance agency is always provided a fixed identifier and 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.
4556
4557 Derivation:
4558
4559 AnnotableType (extension)
4560 IdentifiableType (extension)
4561 NameableType (extension)
4562 VersionableType (restriction)
4563 MaintainableBaseType (extension)
4564 MaintainableType (restriction)
4565 ItemSchemeType (restriction)
4566 OrganisationSchemeBaseType (extension)
4567 OrganisationSchemeType (restriction)
4568 DataConsumerSchemeType
4569
4570 Attributes:
4571
4572 id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?
4573
4574 Content:
4575
4576 Annotations?, Link*, Name+, Description*, DataConsumer
4577
4578 Attribute Documentation:
4579
4580 |**Name**|**Type**|**Documentation**|
4581 |id (fixed: DATA\_CONSUMERS)|IDType|The id is the identifier for the object.|
4582 |urn|DataConsumerSchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
4583 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
4584 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
4585 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
4586 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
4587 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
4588 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
4589 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
4590 |isPartialLanguage (default: false)|xs:boolean|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’.|
4591 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.|
4592
4593 Element Documentation:
4594
4595 |**Name**|**Type**|**Documentation**|
4596 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4597 |Link|LinkType|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.|
4598 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4599 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4600 |DataConsumer|DataConsumerType|DataConsumer describes an organisation using data as input for further processing.|
4601
4602 **DataProviderSchemeType:** DataProviderSchemeType defines a type of organisation scheme which contains only data providers. The data provider scheme maintained by a particular maintenance agency is always provided a fixed identifier and 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
4603
4604 Derivation:
4605
4606 AnnotableType (extension)
4607 IdentifiableType (extension)
4608 NameableType (extension)
4609 VersionableType (restriction)
4610 MaintainableBaseType (extension)
4611 MaintainableType (restriction)
4612 ItemSchemeType (restriction)
4613 OrganisationSchemeBaseType (extension)
4614 OrganisationSchemeType (restriction)
4615 DataProviderSchemeType
4616
4617 Attributes:
4618
4619 id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?
4620
4621 Content:
4622
4623 Annotations?, Link*, Name+, Description*, DataProvider
4624
4625 Attribute Documentation:
4626
4627 |**Name**|**Type**|**Documentation**
4628 |id (fixed: DATA\_PROVIDERS)|IDType|The id is the identifier for the object.
4629 |urn|DataProviderSchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4630 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4631 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4632 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4633 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4634 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4635 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4636 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4637 |isPartialLanguage (default: false)|xs:boolean|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’.
4638 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.
4639
4640 Element Documentation:
4641
4642 |**Name**|**Type**|**Documentation**
4643 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4644 |Link|LinkType|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.
4645 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4646 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4647 |DataProvider|DataProviderType|DataProvider describes an organisation that produces data.
4648
4649 **MetadataProviderSchemeType:** 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
4650
4651 Derivation:
4652
4653 AnnotableType (extension)
4654 IdentifiableType (extension)
4655 NameableType (extension)
4656 VersionableType (restriction)
4657 MaintainableBaseType (extension)
4658 MaintainableType (restriction)
4659 ItemSchemeType (restriction)
4660 OrganisationSchemeBaseType (extension)
4661 OrganisationSchemeType (restriction)
4662 MetadataProviderSchemeType
4663
4664 Attributes:
4665
4666 id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?
4667
4668 Content:
4669
4670 Annotations?, Link*, Name+, Description*, MetadataProvider
4671
4672 Attribute Documentation:
4673
4674 |**Name**|**Type**|**Documentation**
4675 |id (fixed: METADATA\_PROVIDERS)|IDType|The id is the identifier for the object.
4676 |urn|MetadataProviderSchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4677 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4678 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4679 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4680 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4681 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4682 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4683 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4684 |isPartialLanguage (default: false)|xs:boolean|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’.
4685 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.
4686
4687 Element Documentation:
4688
4689 |**Name**|**Type**|**Documentation**|
4690 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4691 |Link|LinkType|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.|
4692 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4693 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4694 |MetadataProvider|MetadataProviderType|MetadataProvider describes an organisation that produces metadata .|
4695
4696 **OrganisationUnitSchemeType:** OrganisationUnitSchemeType defines a type of organisation scheme which simply defines organisations and there parent child relationships. Organisations in this scheme are assigned no particular role, and may in fact exist within the other type of organisation schemes as well.
4697
4698 Derivation:
4699
4700 AnnotableType (extension)
4701 IdentifiableType (extension)
4702 NameableType (extension)
4703 VersionableType (restriction)
4704 MaintainableBaseType (extension)
4705 MaintainableType (restriction)
4706 ItemSchemeType (restriction)
4707 OrganisationSchemeBaseType (extension)
4708 OrganisationSchemeType (restriction)
4709 OrganisationUnitSchemeType
4710
4711 Attributes:
4712
4713 id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?
4714
4715 Content:
4716
4717 Annotations?, Link*, Name+, Description*, OrganisationUnit
4718
4719 Attribute Documentation:
4720
4721 |**Name**|**Type**|**Documentation**|
4722 |id|IDType|The id is the identifier for the object.|
4723 |urn|OrganisationUnitSche meUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
4724 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
4725 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
4726 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
4727 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
4728 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
4729 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
4730 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
4731 |isPartialLanguage (default: false)|xs:boolean|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’.|
4732 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.|
4733
4734 Element Documentation:
4735
4736 |**Name**|**Type**|**Documentation**|
4737 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4738 |Link|LinkType|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.|
4739 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4740 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4741 |OrganisationUnit|OrganisationUnitType|OrganisationUnit describes a generic organisation, which serves not predefined role in SDMX.|
4742
4743 **AgencyType:** AgencyType defines the structure of an agency description. The contacts defined for the organisation are specific to the agency role the organisation is serving.
4744
4745 Derivation:
4746
4747 AnnotableType (extension)
4748 IdentifiableType (extension)
4749 NameableType (restriction)
4750 ItemBaseType (extension)
4751 ItemType (restriction)
4752 BaseOrganisationType (extension)
4753 OrganisationType (restriction)
4754 AgencyType
4755
4756 Attributes:
4757
4758 id, urn?, uri?
4759
4760 Content:
4761
4762 Annotations?, Link*, Name+, Description*, Contact
4763
4764 Attribute Documentation:
4765
4766 |**Name**|**Type**|**Documentation**|
4767 |id|NCNameIDType|The id attribute holds the identification of the agency. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the agency identifier will be used as part of the name for simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).|
4768 |urn|AgencyUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
4769 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
4770
4771 Element Documentation:
4772
4773 |**Name**|**Type**|**Documentation**|
4774 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4775 |Link|LinkType|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.|
4776 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4777 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4778 |Contact|ContactType|Contact describes a contact for the organisation,|
4779
4780 **DataConsumerType:** DataConsumerType defines the structure of a data consumer description. The contacts defined for the organisation are specific to the data consumer role the organisation is serving.
4781
4782 Derivation:
4783
4784 AnnotableType (extension)
4785 IdentifiableType (extension)
4786 NameableType (restriction)
4787 ItemBaseType (extension)
4788 ItemType (restriction)
4789 BaseOrganisationType (extension)
4790 OrganisationType (restriction)
4791 DataConsumerType
4792
4793 Attributes:
4794
4795 id, urn?, uri?
4796
4797 Content:
4798
4799 Annotations?, Link*, Name+, Description*, Contact
4800
4801 Attribute Documentation:
4802
4803 |**Name**|**Type**|**Documentation**|
4804 |id|IDType|The id is the identifier for the object.|
4805 |urn|DataConsumerUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
4806 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
4807
4808 Element Documentation:
4809
4810 |**Name**|**Type**|**Documentation**|
4811 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4812 |Link|LinkType|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.|
4813 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4814 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4815 |Contact|ContactType|Contact describes a contact for the organisation,|
4816
4817 **DataProviderType:** DataProviderType defines the structure of a data provider description. The contacts defined for the organisation are specific to the data provider role the organisation is serving.
4818
4819 Derivation:
4820
4821 AnnotableType (extension)
4822 IdentifiableType (extension)
4823 NameableType (restriction)
4824 ItemBaseType (extension)
4825 ItemType (restriction)
4826 BaseOrganisationType (extension)
4827 OrganisationType (restriction)
4828 DataProviderType
4829
4830 Attributes:
4831
4832 id, urn?, uri?
4833
4834 Content:
4835
4836 Annotations?, Link*, Name+, Description*, Contact
4837
4838 Attribute Documentation:
4839
4840 |**Name**|**Type**|**Documentation**|
4841 |id|IDType|The id is the identifier for the object.|
4842 |urn|DataProviderUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
4843 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
4844
4845 Element Documentation:
4846
4847 |**Name**|**Type**|**Documentation**|
4848 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4849 |Link|LinkType|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.|
4850 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4851 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4852 |Contact|ContactType|Contact describes a contact for the organisation,|
4853
4854 **MetadataProviderType:** 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.
4855
4856 Derivation:
4857
4858 AnnotableType (extension)
4859 IdentifiableType (extension)
4860 NameableType (restriction)
4861 ItemBaseType (extension)
4862 ItemType (restriction)
4863 BaseOrganisationType (extension)
4864 OrganisationType (restriction)
4865 MetadataProviderType
4866
4867 Attributes:
4868
4869 id, urn?, uri?
4870
4871 Content:
4872
4873 Annotations?, Link*, Name+, Description*, Contact
4874
4875 Attribute Documentation:
4876
4877 (% style="width:1051.29px" %)
4878 |**Name**|**Type**|(% style="width:660px" %)**Documentation**
4879 |id|IDType|(% style="width:660px" %)The id is the identifier for the object.
4880 |urn|MetadataProviderUrnType|(% style="width:660px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4881 |uri|xs:anyURI|(% style="width:660px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4882
4883 Element Documentation:
4884
4885 |**Name**|**Type**|**Documentation**|
4886 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4887 |Link|LinkType|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.|
4888 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4889 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4890 |Contact|ContactType|Contact describes a contact for the organisation,|
4891
4892 **OrganisationUnitType:** OrganisationUnitType defines the structure of an organisation unit description. In addition to general identification and contact information, an organisation unit can specify a relationship with another organisation unit from the same scheme which is its parent organisation.
4893
4894 Derivation:
4895
4896 AnnotableType (extension)
4897 IdentifiableType (extension)
4898 NameableType (restriction)
4899 ItemBaseType (extension)
4900 ItemType (restriction)
4901 BaseOrganisationType (extension)
4902 OrganisationType (restriction)
4903 OrganisationUnitType
4904
4905 Attributes:
4906
4907 id, urn?, uri?
4908
4909 Content:
4910
4911 Annotations?, Link*, Name+, Description*, Parent?, Contact
4912
4913 Attribute Documentation:
4914
4915 (% style="width:999.294px" %)
4916 |**Name**|**Type**|**Documentation**
4917 |id|IDType|The id is the identifier for the object.
4918 |urn|OrganisationUnitUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4919 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4920
4921 Element Documentation:
4922
4923 |**Name**|**Type**|**Documentation**|
4924 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4925 |Link|LinkType|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.|
4926 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4927 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4928 |Parent|IDType|If the particular organisation scheme allows, an organisation may reference a parent organisation defined in the same scheme. This does not affect the identification of the organisation, but rather only serves to state the relationship.|
4929 |Contact|ContactType|Contact describes a contact for the organisation,|
4930
4931 **ContactType:** ContactType describes the structure of a contact's details.
4932
4933 Attributes:
4934
4935 id?
4936
4937 Content:
4938
4939 Name*, Department*, Role*, (Telephone|Fax|X400|URI|Email)
4940
4941 Attribute Documentation:
4942
4943 |**Name**|**Type**|**Documentation**|
4944 |id|IDType|The id attribute is used to carry user id information for the contact.|
4945
4946 Element Documentation:
4947
4948 |**Name**|**Type**|**Documentation**|
4949 |Name|TextType|Name is a reusable element, used for providing a human-readable name for an object.|
4950 |Department|TextType|Department is designation of the organisational structure by a linguistic expression, within which the contact person works.|
4951 |Role|TextType|Role is the responsibility of the contact person with respect to the object for which this person is the contact.|
4952 |Telephone|xs:string|Telephone holds the telephone number for the contact person.|
4953 |Fax|xs:string|Fax holds the fax number for the contact person.|
4954 |X400|xs:string|X400 holds the X.400 address for the contact person.|
4955 |URI|xs:anyURI|URI holds an information URL for the contact person.|
4956 |Email|xs:string|Email holds the email address for the contact person.|
4957
4958 //**ProvisionAgreementBaseType:**// ProvisionAgreementBaseType defines the base refinement of the ProvisionAgreementType. Its purpose is to retrict the urn attribute.
4959
4960 Derivation:
4961
4962 AnnotableType (extension)
4963 IdentifiableType (extension)
4964 NameableType (extension)
4965 VersionableType (restriction)
4966 MaintainableBaseType (extension)
4967 MaintainableType (restriction)
4968 ProvisionAgreementBaseType
4969
4970 Attributes:
4971 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
4972
4973 Content:
4974 Annotations?, Link*, Name+, Description
4975
4976 Attribute Documentation:
4977
4978 (% style="width:1155.29px" %)
4979 |**Name**|**Type**|(% style="width:737px" %)**Documentation**
4980 |id|IDType|(% style="width:737px" %)The id is the identifier for the object.
4981 |urn|ProvisionAgreementUrnType|(% style="width:737px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4982 |uri|xs:anyURI|(% style="width:737px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4983 |version|VersionType|(% style="width:737px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
4984 |validFrom|xs:dateTime|(% style="width:737px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4985 |validTo|xs:dateTime|(% style="width:737px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4986 |agencyID|NestedNCNameIDType|(% style="width:737px" %)The agencyID must be provided, and identifies the maintenance agency of the object.
4987 |isExternalReference (default: false)|xs:boolean|(% style="width:737px" %)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.
4988 |serviceURL|xs:anyURI|(% style="width:737px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4989 |structureURL|xs:anyURI|(% style="width:737px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4990 |isPartialLanguage (default: false)|xs:boolean|(% style="width:737px" %)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’.
4991
4992 Element Documentation:
4993
4994 |**Name**|**Type**|**Documentation**|
4995 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
4996 |Link|LinkType|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.|
4997 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
4998 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
4999
5000 **ProvisionAgreementType:** 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.
5001
5002 Derivation:
5003
5004 AnnotableType (extension)
5005 IdentifiableType (extension)
5006 NameableType (extension)
5007 VersionableType (restriction)
5008 MaintainableBaseType (extension)
5009 MaintainableType (restriction)
5010 ProvisionAgreementBaseType (extension)
5011 ProvisionAgreementType
5012
5013 Attributes:
5014
5015 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
5016
5017 Content:
5018
5019 Annotations?, Link*, Name+, Description*, Dataflow, DataProvider
5020
5021 Attribute Documentation:
5022
5023 |**Name**|**Type**|**Documentation**|
5024 |id|IDType|The id is the identifier for the object.|
5025 |urn|ProvisionAgreementUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
5026 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
5027 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
5028 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
5029 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
5030 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
5031 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
5032 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
5033 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
5034 |isPartialLanguage (default: false)|xs:boolean|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’.|
5035
5036 Element Documentation:
5037
5038 |**Name**|**Type**|**Documentation**|
5039 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
5040 |Link|LinkType|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.|
5041 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
5042 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
5043 |Dataflow|DataflowReferenceTyp e|Dataflow provides a reference to a pre-existing dataflow in the registry. The reference is provided via a URN and/or a full set of reference fields.|
5044 |DataProvider|DataProviderReferenc eType|DataProvider provides a reference to a pre-existing data provider in the registry. The reference is provided via a URN and/or a full set of reference fields.|
5045
5046 //**MetadataProvisionAgreementBaseType:**// MetadataProvisionAgreementBaseType defines the base refinement of the MetadataProvisionAgreementType. Its purpose is to retrict the urn attribute.
5047
5048 Derivation:
5049
5050 AnnotableType (extension)
5051 IdentifiableType (extension)
5052 NameableType (extension)
5053 VersionableType (restriction)
5054 MaintainableBaseType (extension)
5055 MaintainableType (restriction)
5056 MetadataProvisionAgreementBaseType
5057
5058 Attributes:
5059
5060 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
5061
5062 Content:
5063
5064 Annotations?, Link*, Name+, Description
5065
5066 Attribute Documentation:
5067
5068 (% style="width:1191.29px" %)
5069 |**Name**|**Type**|**Documentation**
5070 |id|IDType|The id is the identifier for the object.
5071 |urn|MetadataProvisionAgreementUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5072 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5073 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
5074 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5075 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5076 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5077 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5078 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5079 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5080 |isPartialLanguage (default: false)|xs:boolean|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’.
5081
5082 Element Documentation:
5083
5084 |**Name**|**Type**|**Documentation**|
5085 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
5086 |Link|LinkType|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.|
5087 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
5088 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
5089
5090 **MetadataProvisionAgreementType:** 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.
5091
5092 Derivation:
5093
5094 AnnotableType (extension)
5095 IdentifiableType (extension)
5096 NameableType (extension)
5097 VersionableType (restriction)
5098 MaintainableBaseType (extension)
5099 MaintainableType (restriction)
5100 MetadataProvisionAgreementBaseType (extension)
5101 MetadataProvisionAgreementType
5102
5103 Attributes:
5104 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
5105
5106 Content:
5107 Annotations?, Link*, Name+, Description*, Metadataflow, MetadataProvider, Target
5108
5109 Attribute Documentation:
5110
5111 |**Name**|**Type**|**Documentation**|
5112 |id|IDType|The id is the identifier for the object.|
5113 |urn|MetadataProvisionAgr eementUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
5114 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
5115 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
5116 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
5117 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
5118 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
5119 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
5120 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
5121 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
5122 |isPartialLanguage (default: false)|xs:boolean|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’.|
5123
5124 Element Documentation:
5125
5126 (% style="width:1114.29px" %)
5127 |**Name**|**Type**|(% style="width:693px" %)**Documentation**
5128 |Annotations|AnnotationsType|(% style="width:693px" %)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.
5129 |Link|LinkType|(% style="width:693px" %)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.
5130 |Name|TextType|(% style="width:693px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5131 |Description|TextType|(% style="width:693px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5132 |Metadataflow|MetadataflowReferenceType|(% style="width:693px" %)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.
5133 |MetadataProvider|MetadataProviderReferenceType|(% style="width:693px" %)MetadataProvider provides a reference to a pre-existing metadata provider in the registry. The reference is provided via a URN and/or a full set of reference fields.
5134 |Target|WildcardUrnType|(% style="width:693px" %)References identifiable structures to which the refernece metadata described by the metadata structure used by the metadaflow should be restricted to. These references may include wildcards for parts of the reference.
5135
5136 ***ProcessBaseType*:** ProcessBaseType defines the base refinement of the ProcessType. Its purpose is to retrict the urn attribute.
5137
5138 Derivation:
5139
5140 AnnotableType (extension)
5141 IdentifiableType (extension)
5142 NameableType (extension)
5143 VersionableType (restriction)
5144 MaintainableBaseType (extension)
5145 MaintainableType (restriction)
5146 ProcessBaseType
5147
5148 Attributes:
5149 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
5150
5151 Content:
5152 Annotations?, Link*, Name+, Description
5153
5154 Attribute Documentation:
5155
5156 |**Name**|**Type**|**Documentation**|
5157 |id|IDType|The id is the identifier for the object.|
5158 |urn|ProcessUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
5159 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
5160 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
5161 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
5162 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
5163 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
5164 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
5165 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
5166 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
5167 |isPartialLanguage (default: false)|xs:boolean|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’.|
5168
5169 Element Documentation:
5170
5171 |**Name**|**Type**|**Documentation**|
5172 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
5173 |Link|LinkType|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.|
5174 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
5175 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
5176
5177 **ProcessType:** ProcessType describes the structure of a process, which is a scheme which defines or documents the operations performed on data in order to validate data or to derive new information according to a given set of rules. Processes occur in order, and will continue in order unless a transition dictates another step should occur.
5178
5179 Derivation:
5180
5181 AnnotableType (extension)
5182 IdentifiableType (extension)
5183 NameableType (extension)
5184 VersionableType (restriction)
5185 MaintainableBaseType (extension)
5186 MaintainableType (restriction)
5187 ProcessBaseType (extension)
5188 ProcessType
5189
5190 Attributes:
5191 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
5192
5193 Content:
5194 Annotations?, Link*, Name+, Description*, ProcessStep
5195
5196 Attribute Documentation:
5197
5198 |**Name**|**Type**|**Documentation**|
5199 |id|IDType|The id is the identifier for the object.|
5200 |urn|ProcessUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
5201 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
5202 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
5203 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
5204 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
5205 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
5206 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
5207 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
5208 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
5209 |isPartialLanguage (default: false)|xs:boolean|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’.|
5210
5211 Element Documentation:
5212
5213 |**Name**|**Type**|**Documentation**|
5214 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
5215 |Link|LinkType|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.|
5216 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
5217 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
5218 |ProcessStep|ProcessStepType|ProcessStep defines a process step, which is a specific operation, performed on data in order to validate or to derive new information according to a given set of rules.|
5219
5220 ***ProcessStepBaseType*:** ProcessStepBaseType is an abstract base type used as the basis for the ProcessStepType.
5221
5222 Derivation:
5223
5224 AnnotableType (extension)
5225 IdentifiableType (extension)
5226 NameableType (restriction)
5227 ProcessStepBaseType
5228
5229 Attributes:
5230 id, urn?, uri?
5231
5232 Content:
5233 Annotations?, Link*, Name+, Description
5234
5235 Attribute Documentation:
5236
5237 |**Name**|**Type**|**Documentation**|
5238 |id|IDType|The id is the identifier for the object.|
5239 |urn|ProcessStepUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
5240 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
5241
5242 Element Documentation:
5243
5244 |**Name**|**Type**|**Documentation**|
5245 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
5246 |Link|LinkType|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.|
5247 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
5248 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
5249
5250 **ProcessStepType:** ProcessStepType describes the structure of a process step. A nested process step is automatically sub-ordinate, and followed as the next step. If the following step is conditional, it should be referenced in a transition.
5251
5252 Derivation:
5253
5254 AnnotableType (extension)
5255 IdentifiableType (extension)
5256 NameableType (restriction)
5257 ProcessStepBaseType (extension)
5258 ProcessStepType
5259
5260 Attributes:
5261
5262 id, urn?, uri?
5263
5264 Content:
5265
5266 Annotations?, Link*, Name+, Description*, Input*, Output*, Computation?, Transition*, ProcessStep
5267
5268 Attribute Documentation:
5269
5270 |**Name**|**Type**|**Documentation**|
5271 |id|IDType|The id is the identifier for the object.|
5272 |urn|ProcessStepUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
5273 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
5274
5275 Element Documentation:
5276
5277 |**Name**|**Type**|**Documentation**|
5278 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
5279 |Link|LinkType|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.|
5280 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
5281 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
5282 |Input|InputOutputType|Input references an object which is an input to the process step.|
5283 |Output|InputOutputType|Output references an object which is an output form the process step.|
5284 |Computation|ComputationType|Computation describes the computations involved in the process, in any form desired by the user (these are informational rather than machine-actionable), and so may be supplied in multiple, parallel-language versions.|
5285 |Transition|TransitionType|Transition describes the next process steps. Each transition in a process step should be evaluated, allowing for multiple process step branches from a single process step.|
5286 |ProcessStep|ProcessStepType|ProcessStep defines a process step, which is a specific operation, performed on data in order to validate or to derive new information according to a given set of rules.|
5287
5288 ***TransitionBaseType*:** TransitionBaseType defines the base refinement of the TransitionType. Its purpose is to retrict the urn attribute.
5289
5290 Derivation:
5291
5292 AnnotableType (extension)
5293 IdentifiableType (extension)
5294 TransitionBaseType
5295
5296 Attributes:
5297
5298 id?, urn?, uri?
5299
5300 Content:
5301
5302 Annotations?, Link
5303
5304 Attribute Documentation:
5305
5306 |**Name**|**Type**|**Documentation**|
5307 |id|IDType|The id is the identifier for the object.|
5308 |urn|TransitionUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
5309 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
5310
5311 Element Documentation:
5312
5313 |**Name**|**Type**|**Documentation**|
5314 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
5315 |Link|LinkType|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.|
5316
5317 **TransitionType:** TransitionType describes the details of a transition, which is an expression in a textual or formalised way of the transformation of data between two specific operations performed on the data.
5318
5319 Derivation:
5320
5321 AnnotableType (extension)
5322 IdentifiableType (extension)
5323 TransitionBaseType (extension)
5324 TransitionType
5325
5326 Attributes:
5327
5328 id?, urn?, uri?, localID?
5329
5330 Content:
5331
5332 Annotations?, Link*, TargetStep, Condition+
5333
5334 Attribute Documentation:
5335
5336 |**Name**|**Type**|**Documentation**|
5337 |id|IDType|The id is the identifier for the object.|
5338 |urn|TransitionUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
5339 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
5340 |localID|IDType|The localID attribute is an optional identification for the transition within the process.|
5341
5342 Element Documentation:
5343
5344 |**Name**|**Type**|**Documentation**|
5345 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
5346 |Link|LinkType|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.|
5347 |TargetStep|NestedIDType|TargetStep references a process step within the process that should be transitioned to, should the conditions described be met.|
5348 |Condition|TextType|Condition is a textual description of the conditions to be met in order for the target step to be proceeded to. It is informational only (not machine-actionable), and may be supplied in multiple, parallel-language form.|
5349
5350 **ComputationType:** ComputationType describes a computation in a process.
5351
5352 Derivation:
5353
5354 AnnotableType (extension)
5355 ComputationType
5356
5357 Attributes:
5358
5359 localID?, softwarePackage?, softwareLanguage?, softwareVersion?
5360
5361 Content:
5362
5363 Annotations?, Description+
5364
5365 Attribute Documentation:
5366
5367 |**Name**|**Type**|**Documentation**|
5368 |localID|IDType|The localID attribute is an optional identification for the computation within the process.|
5369 |softwarePackage|xs:string|The softwarePackage attribute holds the name of the software package that is used to perform the computation.|
5370 |softwareLanguage|xs:string|The softwareLanguage attribute holds the coding language that the software package used to perform the computation is written in.|
5371 |softwareVersion|xs:string|The softwareVersion attribute hold the version of the software package that is used to perform that computation.|
5372
5373 Element Documentation:
5374
5375 |**Name**|**Type**|**Documentation**|
5376 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
5377 |Description|TextType|Description describe the computation in any form desired by the user (these are informational rather than machine-actionable), and so may be supplied in multiple, parallel-language versions,|
5378
5379 **InputOutputType:** InputOutputType describes the structure of an input or output to a process step. It provides a reference to the object that is the input or output.
5380
5381 Derivation:
5382
5383 AnnotableType (extension)
5384 InputOutputType
5385
5386 Attributes:
5387
5388 localID?
5389
5390 Content:
5391
5392 Annotations?, ObjectReference
5393
5394 Attribute Documentation:
5395
5396 |**Name**|**Type**|**Documentation**|
5397 |localID|IDType|The localID attribute is an optional identification for the input or output within the process.|
5398
5399 Element Documentation:
5400
5401 |**Name**|**Type**|**Documentation**|
5402 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
5403 |ObjectReference|UrnReferenceType|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.|
5404
5405 **ReportingTaxonomyType:** ReportingTaxonomyType describes the structure of a reporting taxonomy, which is a scheme which defines the composition structure of a data report where each component can be described by an independent structure or structure usage description.
5406
5407 Derivation:
5408
5409 AnnotableType (extension)
5410 IdentifiableType (extension)
5411 NameableType (extension)
5412 VersionableType (restriction)
5413 MaintainableBaseType (extension)
5414 MaintainableType (restriction)
5415 ItemSchemeType (restriction)
5416 ReportingTaxonomyType
5417
5418 Attributes:
5419
5420 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?
5421
5422 Content:
5423
5424 Annotations?, Link*, Name+, Description*, ReportingCategory
5425
5426 Attribute Documentation:
5427
5428 (% style="width:1245.29px" %)
5429 |**Name**|**Type**|(% style="width:829px" %)**Documentation**
5430 |id|IDType|(% style="width:829px" %)The id is the identifier for the object.
5431 |urn|ReportingTaxonomyUrnType|(% style="width:829px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5432 |uri|xs:anyURI|(% style="width:829px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5433 |version|VersionType|(% style="width:829px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
5434 |validFrom|xs:dateTime|(% style="width:829px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5435 |validTo|xs:dateTime|(% style="width:829px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5436 |agencyID|NestedNCNameIDType|(% style="width:829px" %)The agencyID must be provided, and identifies the maintenance agency of the object.
5437 |isExternalReference (default: false)|xs:boolean|(% style="width:829px" %)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.
5438 |serviceURL|xs:anyURI|(% style="width:829px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5439 |structureURL|xs:anyURI|(% style="width:829px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5440 |isPartialLanguage (default: false)|xs:boolean|(% style="width:829px" %)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’.
5441 |isPartial (default: false)|xs:boolean|(% style="width:829px" %)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.
5442
5443 Element Documentation:
5444
5445 (% style="width:1249.29px" %)
5446 |**Name**|**Type**|(% style="width:878px" %)**Documentation**
5447 |Annotations|AnnotationsType|(% style="width:878px" %)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.
5448 |Link|LinkType|(% style="width:878px" %)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.
5449 |Name|TextType|(% style="width:878px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5450 |Description|TextType|(% style="width:878px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5451 |ReportingCategory|ReportingCategoryType|(% style="width:878px" %)ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages.
5452
5453 //**ReportingCategoryBaseType:**// ReportingCategoryBaseType is an abstract base type that serves as the basis for the ReportingCategoryType.
5454
5455 Derivation:
5456
5457 AnnotableType (extension)
5458 IdentifiableType (extension)
5459 NameableType (restriction)
5460 ItemBaseType (extension)
5461 ItemType (restriction)
5462 ReportingCategoryBaseType
5463
5464 Attributes:
5465
5466 id, urn?, uri?
5467
5468 Content:
5469
5470 Annotations?, Link*, Name+, Description*, ReportingCategory
5471
5472 Attribute Documentation:
5473
5474 (% style="width:1053.29px" %)
5475 |**Name**|**Type**|**Documentation**
5476 |id|IDType|The id is the identifier for the object.
5477 |urn|ReportingCategoryUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5478 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5479
5480 Element Documentation:
5481
5482 (% style="width:1060.29px" %)
5483 |**Name**|**Type**|**Documentation**
5484 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5485 |Link|LinkType|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.
5486 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5487 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5488 |ReportingCategory|ReportingCategoryType|ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages.
5489
5490 **ReportingCategoryType:** ReportingCategoryType describes the structure of a reporting category, which groups structure usages into useful sub-packages. Sub ordinate reporting categories can be nested within the category definition.
5491
5492 Derivation:
5493
5494 AnnotableType (extension)
5495 IdentifiableType (extension)
5496 NameableType (restriction)
5497 ItemBaseType (extension)
5498 ItemType (restriction)
5499 ReportingCategoryBaseType (extension)
5500 ReportingCategoryType
5501
5502 Attributes:
5503
5504 id, urn?, uri?
5505
5506 Content:
5507
5508 Annotations?, Link*, Name+, Description*, ReportingCategory*, (StructuralMetadata*|ProvisioningMetadata*)
5509
5510 Attribute Documentation:
5511
5512 (% style="width:1040.29px" %)
5513 |**Name**|**Type**|**Documentation**
5514 |id|IDType|The id is the identifier for the object.
5515 |urn|ReportingCategoryUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5516 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5517
5518 Element Documentation:
5519
5520 (% style="width:1121.29px" %)
5521 |**Name**|**Type**|**Documentation**
5522 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5523 |Link|LinkType|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.
5524 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5525 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5526 |ReportingCategory|ReportingCategoryType|ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages.
5527 |StructuralMetadata|StructureReferenceType|StructuralMetadata provides a reference for data structure definition and metadata structure definition references which are grouped in the reporting category. It is assumed that all structural metadata objects referenced from a category will be of the same type.
5528 |ProvisioningMetadata|StructureUsageReferenceType|ProvisioningMetadata provides a reference for dataflow and metadataflow references which are grouped in the reporting category. It is assumed that all provisioning metadata objects referenced from a category will be of the same type.
5529
5530 //**ItemSchemeMapBaseType:**// ItemSchemeMapBaseType is an abstract base type which forms the basis for the ItemSchemeMapType.
5531
5532 Derivation:
5533
5534 AnnotableType (extension)
5535 IdentifiableType (extension)
5536 NameableType (extension)
5537 VersionableType (restriction)
5538 MaintainableBaseType (extension)
5539 MaintainableType (restriction)
5540 ItemSchemeMapBaseType
5541
5542 Attributes:
5543
5544 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
5545
5546 Content:
5547
5548 Annotations?, Link*, Name+, Description
5549
5550 Attribute Documentation:
5551
5552 |**Name**|**Type**|**Documentation**|
5553 |id|IDType|The id is the identifier for the object.|
5554 |urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
5555 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
5556 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
5557 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
5558 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
5559 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
5560 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
5561 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
5562 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
5563 |isPartialLanguage (default: false)|xs:boolean|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’.|
5564
5565 Element Documentation:
5566
5567 |**Name**|**Type**|**Documentation**|
5568 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
5569 |Link|LinkType|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.|
5570 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
5571 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
5572
5573 //**ItemSchemeMapType:**// ItemSchemeMapType is an abstract base type which forms the basis for mapping items between item schemes of the same type.
5574
5575 Derivation:
5576
5577 AnnotableType (extension)
5578 IdentifiableType (extension)
5579 NameableType (extension)
5580 VersionableType (restriction)
5581 MaintainableBaseType (extension)
5582 MaintainableType (restriction)
5583 ItemSchemeMapBaseType (extension)
5584 ItemSchemeMapType
5585
5586 Attributes:
5587
5588 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
5589
5590 Content:
5591
5592 Annotations?, Link*, Name+, Description*, Source, Target, ItemMap
5593
5594 Attribute Documentation:
5595
5596 |**Name**|**Type**|**Documentation**|
5597 |id|IDType|The id is the identifier for the object.|
5598 |urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
5599 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
5600 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
5601 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
5602 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
5603 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
5604 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
5605 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
5606 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
5607 |isPartialLanguage (default: false)|xs:boolean|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’.|
5608
5609 Element Documentation:
5610
5611 |**Name**|**Type**|**Documentation**|
5612 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
5613 |Link|LinkType|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.|
5614 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
5615 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
5616 |Source|MaintainableUrnRefer enceType|Source provides a reference to the item scheme which items are mapped from.|
5617 |Target|MaintainableUrnRefer enceType|Target provides a reference to the item scheme which items are mapped to.|
5618 |ItemMap|SingleValueMappingTy pe| |
5619
5620 **OrganisationSchemeMapType:** OrganisationSchemeMapType defines the structure of a map which identifies relationships between organisations in different organisation schemes.
5621
5622 Derivation:
5623
5624 AnnotableType (extension)
5625 IdentifiableType (extension)
5626 NameableType (extension)
5627 VersionableType (restriction)
5628 MaintainableBaseType (extension)
5629 MaintainableType (restriction)
5630 ItemSchemeMapBaseType (extension)
5631 ItemSchemeMapType (restriction)
5632 OrganisationSchemeMapType
5633
5634 Attributes:
5635
5636 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
5637
5638 Content:
5639
5640 Annotations?, Link*, Name+, Description*, Source, Target, ItemMap
5641
5642 Attribute Documentation:
5643
5644 (% style="width:1170.29px" %)
5645 |**Name**|**Type**|**Documentation**
5646 |id|IDType|The id is the identifier for the object.
5647 |urn|OrganisationSchemeMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5648 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5649 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
5650 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5651 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5652 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5653 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5654 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5655 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5656 |isPartialLanguage (default: false)|xs:boolean|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’.
5657
5658 Element Documentation:
5659
5660 (% style="width:1169.29px" %)
5661 |**Name**|(% style="width:321px" %)**Type**|(% style="width:736px" %)**Documentation**
5662 |Annotations|(% style="width:321px" %)AnnotationsType|(% style="width:736px" %)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.
5663 |Link|(% style="width:321px" %)LinkType|(% style="width:736px" %)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.
5664 |Name|(% style="width:321px" %)TextType|(% style="width:736px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5665 |Description|(% style="width:321px" %)TextType|(% style="width:736px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5666 |Source|(% style="width:321px" %)OrganisationSchemeReferenceType|(% style="width:736px" %)Source provides a reference to the item scheme which items are mapped from.
5667 |Target|(% style="width:321px" %)OrganisationSchemeReferenceType|(% style="width:736px" %)Target provides a reference to the item scheme which items are mapped to.
5668 |ItemMap|(% style="width:321px" %)SingleValueMappingTy pe|(% style="width:736px" %)
5669
5670 **CategorySchemeMapType:** CategorySchemeMapType defines the structure of a map which identifies relationships between categories in different category schemes.
5671
5672 Derivation:
5673
5674 AnnotableType (extension)
5675 IdentifiableType (extension)
5676 NameableType (extension)
5677 VersionableType (restriction)
5678 MaintainableBaseType (extension)
5679 MaintainableType (restriction)
5680 ItemSchemeMapBaseType (extension)
5681 ItemSchemeMapType (restriction)
5682 CategorySchemeMapType
5683
5684 Attributes:
5685
5686 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
5687
5688 Content:
5689
5690 Annotations?, Link*, Name+, Description*, Source, Target, ItemMap
5691
5692 Attribute Documentation:
5693
5694 (% style="width:1273.29px" %)
5695 |**Name**|**Type**|(% style="width:844px" %)**Documentation**
5696 |id|IDType|(% style="width:844px" %)The id is the identifier for the object.
5697 |urn|CategorySchemeMapUrnType|(% style="width:844px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5698 |uri|xs:anyURI|(% style="width:844px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5699 |version|VersionType|(% style="width:844px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
5700 |validFrom|xs:dateTime|(% style="width:844px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5701 |validTo|xs:dateTime|(% style="width:844px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5702 |agencyID|NestedNCNameIDType|(% style="width:844px" %)The agencyID must be provided, and identifies the maintenance agency of the object.
5703 |isExternalReference (default: false)|xs:boolean|(% style="width:844px" %)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.
5704 |serviceURL|xs:anyURI|(% style="width:844px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5705 |structureURL|xs:anyURI|(% style="width:844px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5706 |isPartialLanguage (default: false)|xs:boolean|(% style="width:844px" %)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’.
5707
5708 Element Documentation:
5709
5710 (% style="width:1280.29px" %)
5711 |**Name**|(% style="width:323px" %)**Type**|(% style="width:854px" %)**Documentation**
5712 |Annotations|(% style="width:323px" %)AnnotationsType|(% style="width:854px" %)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.
5713 |Link|(% style="width:323px" %)LinkType|(% style="width:854px" %)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.
5714 |Name|(% style="width:323px" %)TextType|(% style="width:854px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5715 |Description|(% style="width:323px" %)TextType|(% style="width:854px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5716 |Source|(% style="width:323px" %)CategorySchemeReferenceType|(% style="width:854px" %)Source provides a reference to the item scheme which items are mapped from.
5717 |Target|(% style="width:323px" %)CategorySchemeReferenceType|(% style="width:854px" %)Target provides a reference to the item scheme which items are mapped to.
5718 |ItemMap|(% style="width:323px" %)SingleValueMappingType|(% style="width:854px" %)
5719
5720 **ConceptSchemeMapType:** ConceptSchemeMapType defines the structure of a map which identifies relationships between concepts in different concept schemes.
5721
5722 Derivation:
5723
5724 AnnotableType (extension)
5725 IdentifiableType (extension)
5726 NameableType (extension)
5727 VersionableType (restriction)
5728 MaintainableBaseType (extension)
5729 MaintainableType (restriction)
5730 ItemSchemeMapBaseType (extension)
5731 ItemSchemeMapType (restriction)
5732 ConceptSchemeMapType
5733
5734 Attributes:
5735
5736 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
5737
5738 Content:
5739
5740 Annotations?, Link*, Name+, Description*, Source, Target, ItemMap
5741
5742 Attribute Documentation:
5743
5744 (% style="width:1242.29px" %)
5745 |**Name**|**Type**|**Documentation**
5746 |id|IDType|The id is the identifier for the object.
5747 |urn|ConceptSchemeMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5748 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5749 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
5750 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5751 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5752 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5753 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5754 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5755 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5756 |isPartialLanguage (default: false)|xs:boolean|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’.
5757
5758 Element Documentation:
5759
5760 (% style="width:1125.29px" %)
5761 |**Name**|**Type**|(% style="width:747px" %)**Documentation**
5762 |Annotations|AnnotationsType|(% style="width:747px" %)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.
5763 |Link|LinkType|(% style="width:747px" %)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.
5764 |Name|TextType|(% style="width:747px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5765 |Description|TextType|(% style="width:747px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5766 |Source|ConceptSchemeReferenceType|(% style="width:747px" %)Source provides a reference to the item scheme which items are mapped from.
5767 |Target|ConceptSchemeReferenceType|(% style="width:747px" %)Target provides a reference to the item scheme which items are mapped to.
5768 |ItemMap|SingleValueMappingType|(% style="width:747px" %)
5769
5770 **ReportingTaxonomyMapType:** ReportingTaxonomyMapType defines the structure of a map which identifies relationships between reporting categories in different reporting taxonomies.
5771
5772 Derivation:
5773
5774 AnnotableType (extension)
5775 IdentifiableType (extension)
5776 NameableType (extension)
5777 VersionableType (restriction)
5778 MaintainableBaseType (extension)
5779 MaintainableType (restriction)
5780 ItemSchemeMapBaseType (extension)
5781 ItemSchemeMapType (restriction)
5782 ReportingTaxonomyMapType
5783
5784 Attributes:
5785
5786 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
5787
5788 Content:
5789
5790 Annotations?, Link*, Name+, Description*, Source, Target, ItemMap
5791
5792 Attribute Documentation:
5793
5794 (% style="width:1171.29px" %)
5795 |**Name**|**Type**|**Documentation**
5796 |id|IDType|The id is the identifier for the object.
5797 |urn|ReportingTaxonomyMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5798 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5799 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
5800 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5801 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5802 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5803 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5804 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5805 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5806 |isPartialLanguage (default: false)|xs:boolean|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’.
5807
5808 Element Documentation:
5809
5810 (% style="width:1177.29px" %)
5811 |**Name**|**Type**|(% style="width:778px" %)**Documentation**
5812 |Annotations|AnnotationsType|(% style="width:778px" %)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.
5813 |Link|LinkType|(% style="width:778px" %)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.
5814 |Name|TextType|(% style="width:778px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5815 |Description|TextType|(% style="width:778px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5816 |Source|ReportingTaxonomyReferenceType|(% style="width:778px" %)Source provides a reference to the item scheme which items are mapped from.
5817 |Target|ReportingTaxonomyReferenceType|(% style="width:778px" %)Target provides a reference to the item scheme which items are mapped to.
5818 |ItemMap|SingleValueMappingType|(% style="width:778px" %)
5819
5820 ***StructureMapBaseType*:** StructureMapBaseType defines the base refinement of the StructureMapType. Its purpose is to retrict the urn attribute.
5821
5822 Derivation:
5823
5824 AnnotableType (extension)
5825 IdentifiableType (extension)
5826 NameableType (extension)
5827 VersionableType (restriction)
5828 MaintainableBaseType (extension)
5829 MaintainableType (restriction)
5830 StructureMapBaseType
5831
5832 Attributes:
5833 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
5834
5835 Content:
5836 Annotations?, Link*, Name+, Description
5837
5838 Attribute Documentation:
5839
5840 |**Name**|**Type**|**Documentation**|
5841 |id|IDType|The id is the identifier for the object.|
5842 |urn|StructureMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
5843 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
5844 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
5845 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
5846 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
5847 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
5848 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
5849 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
5850 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
5851 |isPartialLanguage (default: false)|xs:boolean|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’.|
5852
5853 Element Documentation:
5854
5855 |**Name**|**Type**|**Documentation**|
5856 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
5857 |Link|LinkType|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.|
5858 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
5859 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
5860
5861 **StructureMapType:** StructureMapType defines the structure for mapping components of one structure to components of another structure. A structure may be referenced directly meaning the map applies wherever the structure is used, or it may be a reference via a structure usage meaning the map only applies within the context of that usage. Using the related structures, one can make extrapolations between maps. For example, if key families, A, B, and C, are all grouped in a related structures container, then a map from 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.
5862
5863 Derivation:
5864
5865 AnnotableType (extension)
5866 IdentifiableType (extension)
5867 NameableType (extension)
5868 VersionableType (restriction)
5869 MaintainableBaseType (extension)
5870 MaintainableType (restriction)
5871 StructureMapBaseType (extension)
5872 StructureMapType
5873
5874 Attributes:
5875 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
5876
5877 Content:
5878 Annotations?, Link*, Name+, Description*, Source, Target, EpochMap*, DatePatternMap*, FrequencyFormatMapping*, ComponentMap*, FixedValueMap
5879
5880 Attribute Documentation:
5881
5882 |**Name**|**Type**|**Documentation**|
5883 |id|IDType|The id is the identifier for the object.|
5884 |urn|StructureMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
5885 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
5886 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
5887 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
5888 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
5889 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
5890 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
5891 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
5892 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
5893 |isPartialLanguage (default: false)|xs:boolean|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’.|
5894
5895 Element Documentation:
5896
5897 (% style="width:1140.29px" %)
5898 |**Name**|**Type**|**Documentation**
5899 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5900 |Link|LinkType|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.
5901 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5902 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5903 |Source|StructureOrUsageReferenceType|Source provides a reference to a structure (data or metadata) or a structure usage (dataflow or metadataflow) from which components defined by the actual structure are to mapped.
5904 |Target|StructureOrUsageReferenceType|Target provides a reference to a structure (data or metadata) or a structure usage (dataflow or metadataflow) to which components from the source are to mapped.
5905 |EpochMap|EpochMapType|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.
5906 |DatePatternMap|DatePatternMapType|Provides the ability to map source to target date formats. The source date is described as a pattern (for example MM-YYYY).
5907 |FrequencyFormatMappi ng|FrequencyFormatMappingType|
5908 |ComponentMap|ComponentMapType|ComponentMap defines the relationship between the components of the source and target structures, including information on how the value from the source component relates to values in the target component.
5909 |FixedValueMap|FixedValueMapType|FixedValueMap defines a fixed value for a source or target component in the mapping.
5910
5911 **FixedValueMapType:** FixedValueMapType defines the structure for providing a fixed value for a source or target component.
5912
5913 Derivation:
5914
5915 AnnotableType (extension)
5916 FixedValueMapType
5917
5918 Content:
5919
5920 Annotations?, (Source|Target), Value
5921
5922 Element Documentation:
5923
5924 |**Name**|**Type**|**Documentation**|
5925 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
5926 |Source|IDType| |
5927 |Target|IDType| |
5928 |Value|xs:string|The fixed value for the component.|
5929
5930 **ComponentMapType:** ComponentMapType defines the structure for relating a component in a source structure to a component in a target structure.
5931
5932 Derivation:
5933
5934 AnnotableType (extension)
5935 ComponentMapType
5936
5937 Content:
5938
5939 Annotations?, Source+, Target+, RepresentationMap?
5940
5941 Element Documentation:
5942
5943 (% style="width:1153.29px" %)
5944 |**Name**|**Type**|(% style="width:632px" %)**Documentation**
5945 |Annotations|AnnotationsType|(% style="width:632px" %)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.
5946 |Source|IDType|(% style="width:632px" %)
5947 |Target|IDType|(% style="width:632px" %)
5948 |RepresentationMap|RepresentationMapReferenceType|(% style="width:632px" %)
5949
5950 **//FrequencyFormatMappingBaseType//:** FrequencyFormatMappingBaseType defines the base refinement of the FrequencyFormatMappingType. Its purpose is to retrict the urn attribute.
5951
5952 Derivation:
5953
5954 AnnotableType (extension)
5955 IdentifiableType (extension)
5956 FrequencyFormatMappingBaseType
5957
5958 Attributes:
5959 id?, urn?, uri?
5960
5961 Content:
5962 Annotations?, Link
5963
5964 Attribute Documentation:
5965
5966 (% style="width:1142.29px" %)
5967 |**Name**|**Type**|(% style="width:682px" %)**Documentation**
5968 |id|IDType|(% style="width:682px" %)The id is the identifier for the object.
5969 |urn|FrequencyFormatMappingUrnType|(% style="width:682px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5970 |uri|xs:anyURI|(% style="width:682px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5971
5972 Element Documentation:
5973
5974 |**Name**|**Type**|**Documentation**
5975 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5976 |Link|LinkType|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.
5977
5978 **FrequencyFormatMappingType:**
5979
5980 Derivation:
5981
5982 AnnotableType (extension)
5983 IdentifiableType (extension)
5984 FrequencyFormatMappingBaseType (extension)
5985 FrequencyFormatMappingType
5986
5987 Attributes:
5988 id?, urn?, uri?
5989
5990 Content:
5991 Annotations?, Link*, FrequencyId, DatePattern
5992
5993 Attribute Documentation:
5994
5995 (% style="width:1281.29px" %)
5996 |**Name**|(% style="width:282px" %)**Type**|(% style="width:911px" %)**Documentation**
5997 |id|(% style="width:282px" %)IDType|(% style="width:911px" %)The id is the identifier for the object.
5998 |urn|(% style="width:282px" %)FrequencyFormatMappingUrnType|(% style="width:911px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5999 |uri|(% style="width:282px" %)xs:anyURI|(% style="width:911px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
6000
6001 Element Documentation:
6002
6003 |**Name**|**Type**|**Documentation**|
6004 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6005 |Link|LinkType|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.|
6006 |FrequencyId|IDType| |
6007 |DatePattern|xs:string| |
6008
6009 //**DateMapType:**//
6010
6011 Derivation:
6012
6013 AnnotableType (extension)
6014 IdentifiableType (extension)
6015 DateMapType
6016
6017 Attributes:
6018 id?, urn?, uri?, resolvePeriod?
6019
6020 Content:
6021 Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*)|TargetFrequencyID)
6022
6023 Attribute Documentation:
6024
6025 |**Name**|**Type**|**Documentation**|
6026 |id|IDType|The id is the identifier for the object.|
6027 |urn|UrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
6028 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
6029 |resolvePeriod|ResolvePeriodType|Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods.|
6030
6031 Element Documentation:
6032
6033 |**Name**|**Type**|**Documentation**|
6034 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6035 |Link|LinkType|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.|
6036 |Source|IDType| |
6037 |Target|IDType| |
6038 |FrequencyDimension|IDType| |
6039 |MappedFrequencies|IDType| |
6040 |TargetFrequencyID|IDType| |
6041
6042 //**EpochMapBaseType:**// EpochMapBaseType defines the base refinement of the EpochMapType. Its purpose is to retrict the urn attribute.
6043
6044 Derivation:
6045
6046 AnnotableType (extension)
6047 IdentifiableType (extension)
6048 DateMapType (restriction)
6049 EpochMapBaseType
6050
6051 Attributes:
6052 id?, urn?, uri?, resolvePeriod?
6053
6054 Content:
6055 Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*)|TargetFrequencyID)
6056
6057 Attribute Documentation:
6058
6059 |**Name**|**Type**|**Documentation**|
6060 |id|IDType|The id is the identifier for the object.|
6061 |urn|EpochMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
6062 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
6063 |resolvePeriod|ResolvePeriodType|Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods.|
6064
6065 Element Documentation:
6066
6067 |**Name**|**Type**|**Documentation**|
6068 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6069 |Link|LinkType|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.|
6070 |Source|IDType| |
6071 |Target|IDType| |
6072 |FrequencyDimension|IDType| |
6073 |MappedFrequencies|IDType| |
6074 |TargetFrequencyID|IDType| |
6075
6076 **EpochMapType:**
6077
6078 Derivation:
6079
6080 AnnotableType (extension)
6081 IdentifiableType (extension)
6082 DateMapType (restriction)
6083 EpochMapBaseType (extension)
6084 EpochMapType
6085
6086 Attributes:
6087 id?, urn?, uri?, resolvePeriod?, basePeriod, epochPeriod
6088
6089 Content:
6090 Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*)|TargetFrequencyID)
6091
6092 Attribute Documentation:
6093
6094 |**Name**|**Type**|**Documentation**|
6095 |id|IDType|The id is the identifier for the object.|
6096 |urn|EpochMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
6097 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
6098 |resolvePeriod|ResolvePeriodType|Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods.|
6099 |basePeriod|xs:string| |
6100 |epochPeriod|EpochPeriodType| |
6101
6102 Element Documentation:
6103
6104 |**Name**|**Type**|**Documentation**|
6105 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6106 |Link|LinkType|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.|
6107 |Source|IDType| |
6108 |Target|IDType| |
6109 |FrequencyDimension|IDType| |
6110 |MappedFrequencies|IDType| |
6111 |TargetFrequencyID|IDType| |
6112
6113 //**DatePatternMapBaseType:**// DatePatternMapBaseType defines the base refinement of the DatePatternMapType. Its purpose is to retrict the urn attribute.
6114
6115 Derivation:
6116
6117 AnnotableType (extension)
6118 IdentifiableType (extension)
6119 DateMapType (restriction)
6120 DatePatternMapBaseType
6121
6122 Attributes:
6123 id?, urn?, uri?, resolvePeriod?
6124
6125 Content:
6126 Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*)|TargetFrequencyID)
6127
6128 Attribute Documentation:
6129
6130 (% style="width:1144.29px" %)
6131 |**Name**|**Type**|**Documentation**
6132 |id|IDType|The id is the identifier for the object.
6133 |urn|DatePatternMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
6134 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
6135 |resolvePeriod|ResolvePeriodType|Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods.
6136
6137 Element Documentation:
6138
6139 |**Name**|**Type**|**Documentation**|
6140 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6141 |Link|LinkType|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.|
6142 |Source|IDType| |
6143 |Target|IDType| |
6144 |FrequencyDimension|IDType| |
6145 |MappedFrequencies|IDType| |
6146 |TargetFrequencyID|IDType| |
6147
6148 **DatePatternMapType:**
6149
6150 Derivation:
6151
6152 AnnotableType (extension)
6153 IdentifiableType (extension)
6154 DateMapType (restriction)
6155 DatePatternMapBaseType (extension)
6156 DatePatternMapType
6157
6158 Attributes:
6159 id?, urn?, uri?, resolvePeriod?, sourcePattern, locale
6160
6161 Content:
6162 Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*)|TargetFrequencyID)
6163
6164 Attribute Documentation:
6165
6166 (% style="width:1196.29px" %)
6167 |**Name**|**Type**|(% style="width:753px" %)**Documentation**
6168 |id|IDType|(% style="width:753px" %)The id is the identifier for the object.
6169 |urn|DatePatternMapUrnType|(% style="width:753px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
6170 |uri|xs:anyURI|(% style="width:753px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
6171 |resolvePeriod|ResolvePeriodType|(% style="width:753px" %)Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods.
6172 |sourcePattern|xs:string|(% style="width:753px" %)Describes the source date using conventions for describing years, months, days, etc.
6173 |locale|xs:string|(% style="width:753px" %)The locale on which the input will be parsed according to the pattern.
6174
6175 Element Documentation:
6176
6177 |**Name**|**Type**|**Documentation**|
6178 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6179 |Link|LinkType|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.|
6180 |Source|IDType| |
6181 |Target|IDType| |
6182 |FrequencyDimension|IDType| |
6183 |MappedFrequencies|IDType| |
6184 |TargetFrequencyID|IDType| |
6185
6186 ***RepresentationMapBaseType*:** RepresentationMapBaseType defines the base refinement of the RepresentationMapType. Its purpose is to retrict the urn attribute.
6187
6188 Derivation:
6189
6190 AnnotableType (extension)
6191 IdentifiableType (extension)
6192 NameableType (extension)
6193 VersionableType (restriction)
6194 MaintainableBaseType (extension)
6195 MaintainableType (restriction)
6196 RepresentationMapBaseType
6197
6198 Attributes:
6199 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
6200
6201 Content:
6202 Annotations?, Link*, Name+, Description
6203
6204 Attribute Documentation:
6205
6206 (% style="width:1160.29px" %)
6207 |**Name**|**Type**|**Documentation**
6208 |id|IDType|The id is the identifier for the object.
6209 |urn|RepresentationMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
6210 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
6211 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
6212 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
6213 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
6214 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
6215 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
6216 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
6217 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
6218 |isPartialLanguage (default: false)|xs:boolean|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’.
6219
6220 Element Documentation:
6221
6222 |**Name**|**Type**|**Documentation**|
6223 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6224 |Link|LinkType|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.|
6225 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
6226 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
6227
6228 **RepresentationMapType:**
6229
6230 Derivation:
6231
6232 AnnotableType (extension)
6233 IdentifiableType (extension)
6234 NameableType (extension)
6235 VersionableType (restriction)
6236 MaintainableBaseType (extension)
6237 MaintainableType (restriction)
6238 RepresentationMapBaseType (extension)
6239 RepresentationMapType
6240
6241 Attributes:
6242 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
6243
6244 Content:
6245 Annotations?, Link*, Name+, Description*, (SourceCodelist|SourceDataType)+, (TargetCodelist|TargetDataType)+, RepresentationMapping
6246
6247 Attribute Documentation:
6248
6249 (% style="width:1159.29px" %)
6250 |**Name**|**Type**|**Documentation**
6251 |id|IDType|The id is the identifier for the object.
6252 |urn|RepresentationMapUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
6253 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
6254 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
6255 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
6256 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
6257 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
6258 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
6259 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
6260 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
6261 |isPartialLanguage (default: false)|xs:boolean|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’.
6262
6263 Element Documentation:
6264
6265 (% style="width:1172.29px" %)
6266 |**Name**|**Type**|(% style="width:748px" %)**Documentation**
6267 |Annotations|AnnotationsType|(% style="width:748px" %)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.
6268 |Link|LinkType|(% style="width:748px" %)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.
6269 |Name|TextType|(% style="width:748px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
6270 |Description|TextType|(% style="width:748px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
6271 |SourceCodelist|AnyCodelistReferenceType|(% style="width:748px" %)
6272 |SourceDataType|DataType|(% style="width:748px" %)
6273 |TargetCodelist|AnyCodelistReferenceType|(% style="width:748px" %)
6274 |TargetDataType|DataType|(% style="width:748px" %)
6275 |RepresentationMapping|ValueMappingType|(% style="width:748px" %)
6276
6277 **SingleValueMappingType:** SingleValueMappingType defines a mapping with a single source and optional target.
6278
6279 Derivation:
6280
6281 AnnotableType (extension)
6282 SingleValueMappingType
6283
6284 Attributes:
6285
6286 validFrom?, validTo?
6287
6288 Content:
6289
6290 Annotations?, SourceValue, TargetValue?
6291
6292 Attribute Documentation:
6293
6294 |**Name**|**Type**|**Documentation**|
6295 |validFrom|xs:date| |
6296 |validTo|xs:date| |
6297
6298 Element Documentation:
6299
6300 |**Name**|**Type**|**Documentation**|
6301 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6302 |SourceValue|MappedValueType|There should be a source value for each source represention (e.g. codelist, data type). Source values can be pattern matched by using regular expression or substrings using start/end indexes.|
6303 |TargetValue|xs:string|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.|
6304
6305 **ValueMappingType:** ValueMappingType defines a mapping of multiple sources to multiple targets.
6306
6307 Derivation:
6308
6309 AnnotableType (extension)
6310 ValueMappingType
6311
6312 Attributes:
6313
6314 validFrom?, validTo?
6315
6316 Content:
6317
6318 Annotations?, SourceValue+, TargetValue
6319
6320 Attribute Documentation:
6321
6322 |**Name**|**Type**|**Documentation**|
6323 |validFrom|xs:date| |
6324 |validTo|xs:date| |
6325
6326 Element Documentation:
6327
6328 |**Name**|**Type**|**Documentation**|
6329 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6330 |SourceValue|MappedValueType|There should be a source value for each source represention (e.g. codelist, data type). Source values can be pattern matched by using regular expression or substrings using start/end indexes.|
6331 |TargetValue|xs:string|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.|
6332
6333 **MappedValueType:**
6334
6335 Derivation:
6336
6337 xs:anySimpleType (restriction)
6338 xs:string (extension)
6339 MappedValueType
6340
6341 Attributes:
6342
6343 isRegEx?, startIndex?, endIndex?
6344
6345 Content:
6346
6347 Attribute Documentation:
6348
6349 |**Name**|**Type**|**Documentation**|
6350 |isRegEx|xs:boolean| |
6351 |startIndex|xs:int| |
6352 |endIndex|xs:int| |
6353
6354 //**VtlDefinitionSchemeType:**// VtlDefinitionSchemeType is an abstract extension of the ItemSchemeType for VTL schemes.
6355
6356 Derivation:
6357
6358 AnnotableType (extension)
6359 IdentifiableType (extension)
6360 NameableType (extension)
6361 VersionableType (restriction)
6362 MaintainableBaseType (extension)
6363 MaintainableType (extension)
6364 ItemSchemeType (extension)
6365 VtlDefinitionSchemeType
6366
6367 Attributes:
6368
6369 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
6370
6371 Content:
6372
6373 Annotations?, Link*, Name+, Description*, Item*
6374
6375 Attribute Documentation:
6376
6377 |**Name**|**Type**|**Documentation**|
6378 |id|IDType|The id is the identifier for the object.|
6379 |urn|MaintainableUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
6380 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
6381 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
6382 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
6383 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
6384 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
6385 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
6386 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
6387 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
6388 |isPartialLanguage (default: false)|xs:boolean|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’.|
6389 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.|
6390 |vtlVersion|xs:string|Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version.|
6391
6392 Element Documentation:
6393
6394 |**Name**|**Type**|**Documentation**|
6395 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6396 |Link|LinkType|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.|
6397 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
6398 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
6399 |//Item//|//ItemType//|Item is an abstract element that serves as a substitution head for all items in an item scheme, including those items nested within other items. Concrete instances of this must use a concrete instance of ItemType.|
6400
6401 //**TransformationSchemeBaseType:**// TransformationSchemeBaseType is an abstract base type for the TransformationSchemeType. It restricts the item types to be only transformations.
6402
6403 Derivation:
6404
6405 AnnotableType (extension)
6406 IdentifiableType (extension)
6407 NameableType (extension)
6408 VersionableType (restriction)
6409 MaintainableBaseType (extension)
6410 MaintainableType (extension)
6411 ItemSchemeType (extension)
6412 VtlDefinitionSchemeType (restriction)
6413 TransformationSchemeBaseType
6414
6415 Attributes:
6416
6417 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
6418
6419 Content:
6420
6421 Annotations?, Link*, Name+, Description*, Transformation
6422
6423 Attribute Documentation:
6424
6425 (% style="width:1314.29px" %)
6426 |**Name**|**Type**|(% style="width:875px" %)**Documentation**
6427 |id|IDType|(% style="width:875px" %)The id is the identifier for the object.
6428 |urn|TransformationSchemeUrnType|(% style="width:875px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
6429 |uri|xs:anyURI|(% style="width:875px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
6430 |version|VersionType|(% style="width:875px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
6431 |validFrom|xs:dateTime|(% style="width:875px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
6432 |validTo|xs:dateTime|(% style="width:875px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
6433 |agencyID|NestedNCNameIDType|(% style="width:875px" %)The agencyID must be provided, and identifies the maintenance agency of the object.
6434 |isExternalReference (default: false)|xs:boolean|(% style="width:875px" %)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.
6435 |serviceURL|xs:anyURI|(% style="width:875px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
6436 |structureURL|xs:anyURI|(% style="width:875px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
6437 |isPartialLanguage (default: false)|xs:boolean|(% style="width:875px" %)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’.
6438 |isPartial (default: false)|xs:boolean|(% style="width:875px" %)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.
6439 |vtlVersion|xs:string|(% style="width:875px" %)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.
6440
6441 Element Documentation:
6442
6443 |**Name**|**Type**|**Documentation**|
6444 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6445 |Link|LinkType|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.|
6446 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
6447 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
6448 |Transformation|TransformationType|Transformation describes the details of a single transformation within a transformation scheme.|
6449
6450 **TransformationSchemeType:** TransformationSchemeType describes the structure of a transformation scheme. A transformation scheme contains a set of transformations to be executed together (in the same run). It can contain any number of transformations that produce any number of results.
6451
6452 Derivation:
6453
6454 AnnotableType (extension)
6455 IdentifiableType (extension)
6456 NameableType (extension)
6457 VersionableType (restriction)
6458 MaintainableBaseType (extension)
6459 MaintainableType (extension)
6460 ItemSchemeType (extension)
6461 VtlDefinitionSchemeType (restriction)
6462 TransformationSchemeBaseType (extension)
6463 TransformationSchemeType
6464
6465 Attributes:
6466
6467 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
6468
6469 Content:
6470
6471 Annotations?, Link*, Name+, Description*, Transformation*, VtlMappingScheme?, NamePersonalisationScheme?, CustomTypeScheme?, RulesetScheme*, UserDefinedOperatorScheme
6472
6473 Attribute Documentation:
6474
6475 (% style="width:1198.29px" %)
6476 |**Name**|**Type**|**Documentation**
6477 |id|IDType|The id is the identifier for the object.
6478 |urn|TransformationSchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
6479 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
6480 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
6481 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
6482 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
6483 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
6484 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
6485 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
6486 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
6487 |isPartialLanguage (default: false)|xs:boolean|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’.
6488 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.
6489 |vtlVersion|xs:string|Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version.
6490
6491 Element Documentation:
6492
6493 (% style="width:1326.29px" %)
6494 |**Name**|**Type**|(% style="width:756px" %)**Documentation**
6495 |Annotations|AnnotationsType|(% style="width:756px" %)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.
6496 |Link|LinkType|(% style="width:756px" %)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.
6497 |Name|TextType|(% style="width:756px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
6498 |Description|TextType|(% style="width:756px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
6499 |Transformation|TransformationType|(% style="width:756px" %)Transformation describes the details of a single transformation within a transformation scheme.
6500 |VtlMappingScheme|VtlMappingSchemeReferenceType|(% style="width:756px" %)References a VTL mapping scheme which defines aliases for given SDMX artefacts that are used in the transformations as well as the mapping methods used when converting between SDMX and VTL data structures. All aliases must be defined in the referenced scheme. This also must be used if the basic mapping methods are not used.
6501 |NamePersonalisationScheme|NamePersonalisationSchemeReferenceType|(% style="width:756px" %)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.
6502 |CustomTypeScheme|CustomTypeSchemeReferenceType|(% style="width:756px" %)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.
6503 |RulesetScheme|RulesetSchemeReferen ceType|(% style="width:756px" %)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.
6504 |UserDefinedOperatorS cheme|UserDefinedOperatorSchemeReferenceType|(% style="width:756px" %)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.
6505
6506 //**TransformationBaseType:**// TransformationBaseType defines the base refinement of the TransformationType. Its purpose is to retrict the urn attribute.
6507
6508 Derivation:
6509
6510 AnnotableType (extension)
6511 IdentifiableType (extension)
6512 NameableType (restriction)
6513 ItemBaseType (extension)
6514 ItemType (restriction)
6515 UnnestedItemType (restriction)
6516 TransformationBaseType
6517
6518 Attributes:
6519
6520 id, urn?, uri?
6521
6522 Content:
6523
6524 Annotations?, Link*, Name+, Description
6525
6526 Attribute Documentation:
6527
6528 (% style="width:1149.29px" %)
6529 |**Name**|**Type**|**Documentation**
6530 |id|IDType|The id is the identifier for the object.
6531 |urn|TransformationUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
6532 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
6533
6534 Element Documentation:
6535
6536 |**Name**|**Type**|**Documentation**|
6537 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6538 |Link|LinkType|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.|
6539 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
6540 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
6541
6542 **TransformationType:** TransformationType defines the structure of a transformation. A transformation is an assignment of a VTL expression to a specific result.
6543
6544 Derivation:
6545
6546 AnnotableType (extension)
6547 IdentifiableType (extension)
6548 NameableType (restriction)
6549 ItemBaseType (extension)
6550 ItemType (restriction)
6551 UnnestedItemType (restriction)
6552 TransformationBaseType (extension)
6553 TransformationType
6554
6555 Attributes:
6556
6557 id, urn?, uri?, isPersistent
6558
6559 Content:
6560
6561 Annotations?, Link*, Name+, Description*, Expression, Result
6562
6563 Attribute Documentation:
6564
6565 (% style="width:1160.29px" %)
6566 |**Name**|**Type**|**Documentation**
6567 |id|IDType|The id is the identifier for the object.
6568 |urn|TransformationUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
6569 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
6570 |isPersistent|xs:boolean|Indicates if the the result is permanently stored. A persistent result (value of true) can be used by transformation defined in other transformation schemes, but a non-persistent result (value of false) can only be used by transformations within the same transformation scheme.
6571
6572 Element Documentation:
6573
6574 |**Name**|**Type**|**Documentation**|
6575 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6576 |Link|LinkType|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.|
6577 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
6578 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
6579 |Expression|xs:string|The right-hand side of the VTL statement. This is expression that is executed for this transformation. It include references to operands and other artefacts. The expression may contain references to SDMX artefacts using the reduced URN format; see Section 6 SDMX Standards ("SDMX Technical Notes"), 10.2.3 ("Abbreviation of the URN").|
6580 |Result|xs:string|The left-hand side of the VTL statement. This identifies the result artefact, which may be used in subsequent transformations. If the result is an SDMX artefact, the is expressed using the alias; see Section 6 SDMX Standards ("SDMX Technical Notes"), 10.2.3 ("Abbreviation of the URN").|
6581
6582 **VtlMappingSchemeType:** VtlMappingSchemeType defines a set of mappings between SDMX and VTL.
6583
6584 Derivation:
6585
6586 AnnotableType (extension)
6587 IdentifiableType (extension)
6588 NameableType (extension)
6589 VersionableType (restriction)
6590 MaintainableBaseType (extension)
6591 MaintainableType (extension)
6592 ItemSchemeType (restriction)
6593 VtlMappingSchemeType
6594
6595 Attributes:
6596
6597 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?
6598
6599 Content:
6600
6601 Annotations?, Link*, Name+, Description*, VtlMapping
6602
6603 Attribute Documentation:
6604
6605 (% style="width:1146.29px" %)
6606 |**Name**|**Type**|(% style="width:733px" %)**Documentation**
6607 |id|IDType|(% style="width:733px" %)The id is the identifier for the object.
6608 |urn|VtlMappingSchemeUrnType|(% style="width:733px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
6609 |uri|xs:anyURI|(% style="width:733px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
6610 |version|VersionType|(% style="width:733px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
6611 |validFrom|xs:dateTime|(% style="width:733px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
6612 |validTo|xs:dateTime|(% style="width:733px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
6613 |agencyID|NestedNCNameIDType|(% style="width:733px" %)The agencyID must be provided, and identifies the maintenance agency of the object.
6614 |isExternalReference (default: false)|xs:boolean|(% style="width:733px" %)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.
6615 |serviceURL|xs:anyURI|(% style="width:733px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
6616 |structureURL|xs:anyURI|(% style="width:733px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
6617 |isPartialLanguage (default: false)|xs:boolean|(% style="width:733px" %)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’.
6618 |isPartial (default: false)|xs:boolean|(% style="width:733px" %)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.
6619
6620 Element Documentation:
6621
6622 |**Name**|**Type**|**Documentation**|
6623 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6624 |Link|LinkType|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.|
6625 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
6626 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
6627 |VtlMapping|VtlMappingType|VtlMapping details a mapping between SDMX and VTL transformation.|
6628
6629 //**VtlMappingBaseType:**// VtlMappingBaseType defines the base refinement of the VtlMappingType. Its purpose is to retrict the urn attribute.
6630
6631 Derivation:
6632
6633 AnnotableType (extension)
6634 IdentifiableType (extension)
6635 NameableType (restriction)
6636 ItemBaseType (extension)
6637 ItemType (restriction)
6638 UnnestedItemType (restriction)
6639 VtlMappingBaseType
6640
6641 Attributes:
6642
6643 id, urn?, uri?
6644
6645 Content:
6646
6647 Annotations?, Link*, Name+, Description
6648
6649 Attribute Documentation:
6650
6651 |**Name**|**Type**|**Documentation**|
6652 |id|IDType|The id is the identifier for the object.|
6653 |urn|VtlMappingUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
6654 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
6655
6656 Element Documentation:
6657
6658 |**Name**|**Type**|**Documentation**|
6659 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6660 |Link|LinkType|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.|
6661 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
6662 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
6663
6664 **VtlMappingType:** VtlMappingType defines the structure of a single mapping between the reference to a SDMX artefact made from VTL transformations, rulesets, user defined operators and the corresponding SDMX structure identifier. These are used to assign an alternative names to SDMX Dataflows, Codelists, Concept Schemes, or Concepts. Although are distinct sub-classes in the Information Model, this structure serves to express them all. The references SDMX artefact serves to distinguish which type of sub-class (VtlDatflowMapping 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 deault Basic mapping methods used for Dataflows by utilizing the GenericDataflow element in place of a reference to a specific Dataflow.
6665
6666 Derivation:
6667
6668 AnnotableType (extension)
6669 IdentifiableType (extension)
6670 NameableType (restriction)
6671 ItemBaseType (extension)
6672 ItemType (restriction)
6673 UnnestedItemType (restriction)
6674 VtlMappingBaseType (extension)
6675 VtlMappingType
6676
6677 Attributes:
6678
6679 id, urn?, uri?, alias
6680
6681 Content:
6682
6683 Annotations?, Link*, Name+, Description*, ( ( (Dataflow|GenericDataflow), ToVtlMapping?, FromVtlMapping?)|Codelist|Concept)
6684
6685 Attribute Documentation:
6686
6687 |**Name**|**Type**|**Documentation**|
6688 |id|IDType|The id is the identifier for the object.|
6689 |urn|VtlMappingUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
6690 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
6691 |alias|xs:string|The alias used to refer to the reference SDMX artefact in the transformations. This must be unique within the mapping scheme in which it is defined.|
6692
6693 Element Documentation:
6694
6695 (% style="width:1196.29px" %)
6696 |**Name**|**Type**|**Documentation**
6697 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
6698 |Link|LinkType|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.
6699 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
6700 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
6701 |Dataflow|DataflowReferenceType|A reference to the SDMX Dataflow that the mapping is defined for. This is used to create a VtlDataflowMapping. In this case, it is possible to specify the mapping details to and from VTL.
6702 |GenericDataflow|EmptyType|Indicates that the ToVtlMapping and FromVtlMapping are the default mapping methods to be applied, overriding the Basic methods if necessary. The mapping methods in this case would be applied to any dataflows that are not explicitly defined in other VtlMappings.
6703 |ToVtlMapping|ToVtlMappingType|Describes the mapping from a SDMX dataflow to a VTL data structure.
6704 |FromVtlMapping|FromVtlMappingType|Describes the mapping to a SDMX dataflow from a VTL data structure.
6705 |Codelist|CodelistReferenceType|A reference to the SDMX Codelist that the mapping is defined for. This is used to create a VtlCodelistMapping.
6706 |Concept|ConceptReferenceType|A reference to the SDMX Concept that the mapping is defined for. This is used to create a VtlConceptMapping.
6707
6708 **ToVtlMappingType:** ToVtlMappingType defines the mapping method and filter used when mapping from SDMX to VTL.
6709
6710 Attributes:
6711
6712 method?
6713
6714 Content:
6715
6716 ToVtlSubSpace?
6717
6718 Attribute Documentation:
6719
6720 (% style="width:1045.29px" %)
6721 |**Name**|**Type**|(% style="width:721px" %)**Documentation**
6722 |method|ToVtlMappingMethodType|(% style="width:721px" %)The mapping method used when mapping from SDMX to VTL. This is typically a StandardToVtlMappingMethodType, but can be any other value to allow for non-standard methods. The implied default is Basic.
6723
6724 Element Documentation:
6725
6726 (% style="width:1054.29px" %)
6727 |**Name**|**Type**|(% style="width:659px" %)**Documentation**
6728 |ToVtlSubSpace|SpaceKeyType|(% style="width:659px" %)Identfies a sub space of the mapped dataflow that the mapping applies to. This is a collection of references to the dimensions that make up the space.
6729
6730 **FromVtlMappingType:** FromVtlMappingType defines the mapping method and filter used when mapping from VTL to SDMX.
6731
6732 Attributes:
6733
6734 method?
6735
6736 Content:
6737
6738 FromVtlSuperSpace?
6739
6740 Attribute Documentation:
6741
6742 (% style="width:1085.29px" %)
6743 |**Name**|**Type**|(% style="width:789px" %)**Documentation**
6744 |method|FromVtlMappingMethodType|(% style="width:789px" %)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.
6745
6746 Element Documentation:
6747
6748 |**Name**|**Type**|**Documentation**|
6749 |FromVtlSuperSpace|SpaceKeyType|Identfies a super space of the mapped dataflow that the mapping applies to. This is a collection of references to the dimensions that make up the space.|
6750
6751 **SpaceKeyType:** SpaceKey defines the structure of a super- or sub- space for a SDMX Dataflow. It is a collection of references to the dimensions that make up the space.
6752
6753 Content:
6754
6755 Key+
6756
6757 Element Documentation:
6758
6759 |**Name**|**Type**|**Documentation**|
6760 |Key|SingleNCNameIDType|A reference to a dimension by its identifier.|
6761
6762 **NamePersonalisationSchemeType:** NamePersonalisationSchemeType defines a set of personalisations of VTL standard names that are used in a set of transformations.
6763
6764 Derivation:
6765
6766 AnnotableType (extension)
6767 IdentifiableType (extension)
6768 NameableType (extension)
6769 VersionableType (restriction)
6770 MaintainableBaseType (extension)
6771 MaintainableType (extension)
6772 ItemSchemeType (extension)
6773 VtlDefinitionSchemeType (restriction)
6774 NamePersonalisationSchemeType
6775
6776 Attributes:
6777
6778 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
6779
6780 Content:
6781
6782 Annotations?, Link*, Name+, Description*, NamePersonalisation
6783
6784 Attribute Documentation:
6785
6786 |**Name**|**Type**|**Documentation**|
6787 |id|IDType|The id is the identifier for the object.|
6788 |urn|NamePersonalisationS chemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
6789 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
6790 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
6791 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
6792 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
6793 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
6794 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
6795 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
6796 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
6797 |isPartialLanguage (default: false)|xs:boolean|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’.|
6798 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.|
6799 |vtlVersion|xs:string|Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version.|
6800
6801 Element Documentation:
6802
6803 (% style="width:1228.29px" %)
6804 |**Name**|**Type**|(% style="width:826px" %)**Documentation**
6805 |Annotations|AnnotationsType|(% style="width:826px" %)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.
6806 |Link|LinkType|(% style="width:826px" %)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.
6807 |Name|TextType|(% style="width:826px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
6808 |Description|TextType|(% style="width:826px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
6809 |NamePersonalisation|NamePersonalisationType|(% style="width:826px" %)NamePersonalisation details a name personalisation that is used in a transformation.
6810
6811 //**NamePersonalisationBaseType:**// NamePersonalisationBaseType defines the base refinement of the NamePersonalisationType. Its purpose is to retrict the urn attribute.
6812
6813 Derivation:
6814
6815 AnnotableType (extension)
6816 IdentifiableType (extension)
6817 NameableType (restriction)
6818 ItemBaseType (extension)
6819 ItemType (restriction)
6820 UnnestedItemType (restriction)
6821 NamePersonalisationBaseType
6822
6823 Attributes:
6824
6825 id, urn?, uri?
6826
6827 Content:
6828
6829 Annotations?, Link*, Name+, Description
6830
6831 Attribute Documentation:
6832
6833 (% style="width:1223.29px" %)
6834 |**Name**|**Type**|**Documentation**
6835 |id|IDType|The id is the identifier for the object.
6836 |urn|NamePersonalisationUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
6837 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
6838
6839 Element Documentation:
6840
6841 |**Name**|**Type**|**Documentation**|
6842 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6843 |Link|LinkType|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.|
6844 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
6845 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
6846
6847 **NamePersonalisationType:** NamePersonalisationType defines the structure of a name personalisation. A name personalisation is is used in place of a standard VTL name in some VTL operations.
6848
6849 Derivation:
6850
6851 AnnotableType (extension)
6852 IdentifiableType (extension)
6853 NameableType (restriction)
6854 ItemBaseType (extension)
6855 ItemType (restriction)
6856 UnnestedItemType (restriction)
6857 NamePersonalisationBaseType (extension)
6858 NamePersonalisationType
6859
6860 Attributes:
6861
6862 id, urn?, uri?, vtlArtefact
6863
6864 Content:
6865
6866 Annotations?, Link*, Name+, Description*, VtlDefaultName, PersonalisedName
6867
6868 Attribute Documentation:
6869
6870 (% style="width:1127.29px" %)
6871 |**Name**|(% style="width:250px" %)**Type**|(% style="width:750px" %)**Documentation**
6872 |id|(% style="width:250px" %)IDType|(% style="width:750px" %)The id is the identifier for the object.
6873 |urn|(% style="width:250px" %)NamePersonalisationUrnType|(% style="width:750px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
6874 |uri|(% style="width:250px" %)xs:anyURI|(% style="width:750px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
6875 |vtlArtefact|(% style="width:250px" %)xs:string|(% style="width:750px" %)Identifies the type of VTL model artefact that is being personalised. In VTL 2.0, this is valuedomain or variable.
6876
6877 Element Documentation:
6878
6879 |**Name**|**Type**|**Documentation**|
6880 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6881 |Link|LinkType|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.|
6882 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
6883 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
6884 |VtlDefaultName|xs:string|Provides the VTL standard name that is being personalised.|
6885 |PersonalisedName|xs:string|Provides the personalised name that is used in place of the VTL standard name in the transformation expressions.|
6886
6887 ***RulesetSchemeBaseType*:** RulesetSchemeBaseType is an abstract base type for the RulesetSchemeType. It restricts the item types to be only rulesets.
6888
6889 Derivation:
6890
6891 AnnotableType (extension)
6892 IdentifiableType (extension)
6893 NameableType (extension)
6894 VersionableType (restriction)
6895 MaintainableBaseType (extension)
6896 MaintainableType (extension)
6897 ItemSchemeType (extension)
6898 VtlDefinitionSchemeType (restriction)
6899 RulesetSchemeBaseType
6900
6901 Attributes:
6902
6903 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
6904
6905 Content:
6906
6907 Annotations?, Link*, Name+, Description*, Ruleset
6908
6909 Attribute Documentation:
6910
6911 |**Name**|**Type**|**Documentation**|
6912 |id|IDType|The id is the identifier for the object.|
6913 |urn|RulesetSchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
6914 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
6915 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
6916 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
6917 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
6918 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
6919 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
6920 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
6921 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
6922 |isPartialLanguage (default: false)|xs:boolean|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’.|
6923 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.|
6924 |vtlVersion|xs:string|Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version.|
6925
6926 Element Documentation:
6927
6928 |**Name**|**Type**|**Documentation**|
6929 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
6930 |Link|LinkType|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.|
6931 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
6932 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
6933 |Ruleset|RulesetType|Ruleset details a ruleset within a ruleset scheme.|
6934
6935 **RulesetSchemeType:** RulesetSchemeType defines a collection of rulesets that are used in transformations.
6936
6937 Derivation:
6938
6939 AnnotableType (extension)
6940 IdentifiableType (extension)
6941 NameableType (extension)
6942 VersionableType (restriction)
6943 MaintainableBaseType (extension)
6944 MaintainableType (extension)
6945 ItemSchemeType (extension)
6946 VtlDefinitionSchemeType (restriction)
6947 RulesetSchemeBaseType (extension)
6948 RulesetSchemeType
6949
6950 Attributes:
6951
6952 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
6953
6954 Content:
6955
6956 Annotations?, Link*, Name+, Description*, Ruleset*, VtlMappingScheme?
6957
6958 Attribute Documentation:
6959
6960 |**Name**|**Type**|**Documentation**|
6961 |id|IDType|The id is the identifier for the object.|
6962 |urn|RulesetSchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
6963 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
6964 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
6965 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
6966 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
6967 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.|
6968 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
6969 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
6970 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
6971 |isPartialLanguage (default: false)|xs:boolean|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’.|
6972 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.|
6973 |vtlVersion|xs:string|Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version.|
6974
6975 Element Documentation:
6976
6977 (% style="width:1185.29px" %)
6978 |**Name**|**Type**|**Documentation**
6979 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
6980 |Link|LinkType|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.
6981 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
6982 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
6983 |Ruleset|RulesetType|Ruleset details a ruleset within a ruleset scheme.
6984 |VtlMappingScheme|VtlMappingSchemeReferenceType|References a VTL mapping scheme which defines aliases for given SDMX artefacts that are used in the rulesets. Rulesets defined on value domains reference Codelists or Concept Schemes (the latter in VTL are considered as the Value Domains of the variables corresponding to the SDMX Measure Dimensions). The rulesets defined on variables reference Concepts (for which a definite representation is assumed). Therefore, a ruleset should only refer to Codelists, Concept Schemes, and Concepts.
6985
6986 //**RulesetBaseType:**// RulesetBaseType defines the base refinement of the RulesetType. Its purpose is to retrict the urn attribute.
6987
6988 Derivation:
6989
6990 AnnotableType (extension)
6991 IdentifiableType (extension)
6992 NameableType (restriction)
6993 ItemBaseType (extension)
6994 ItemType (restriction)
6995 UnnestedItemType (restriction)
6996 RulesetBaseType
6997
6998 Attributes:
6999
7000 id, urn?, uri?
7001
7002 Content:
7003
7004 Annotations?, Link*, Name+, Description
7005
7006 Attribute Documentation:
7007
7008 |**Name**|**Type**|**Documentation**|
7009 |id|IDType|The id is the identifier for the object.|
7010 |urn|RulesetUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
7011 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
7012
7013 Element Documentation:
7014
7015 |**Name**|**Type**|**Documentation**|
7016 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
7017 |Link|LinkType|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.|
7018 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
7019 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
7020
7021 **RulesetType:** RulesetType defines the structure of a ruleset. A ruleset is a persistent set of rules which can be invoked by using appropriate VTL operators.
7022
7023 Derivation:
7024
7025 AnnotableType (extension)
7026 IdentifiableType (extension)
7027 NameableType (restriction)
7028 ItemBaseType (extension)
7029 ItemType (restriction)
7030 UnnestedItemType (restriction)
7031 RulesetBaseType (extension)
7032 RulesetType
7033
7034 Attributes:
7035
7036 id, urn?, uri?, rulesetType, rulesetScope
7037
7038 Content:
7039
7040 Annotations?, Link*, Name+, Description*, RulesetDefinition
7041
7042 Attribute Documentation:
7043
7044 |**Name**|**Type**|**Documentation**|
7045 |id|IDType|The id is the identifier for the object.|
7046 |urn|RulesetUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
7047 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
7048 |rulesetType|xs:string|The VTL type of the ruleset. In VTL 2.0, this is datapoint or hierarchical|
7049 |rulesetScope|xs:string|This model artefact on which the ruleset is defined. In VTL 2.0, this is value domain or variable.|
7050
7051 Element Documentation:
7052
7053 |**Name**|**Type**|**Documentation**|
7054 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
7055 |Link|LinkType|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.|
7056 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
7057 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
7058 |RulesetDefinition|xs:string|A VTL statement for the definition of a ruleset. This must conform to the syntax of the VTL definition language.|
7059
7060 //**UserDefinedOperatorSchemeBaseType:**// UserDefinedOperatorSchemeBaseType is an abstract base type for the UserDefinedOperatorSchemeType. It restricts the item types to be only user defined operators.
7061
7062 Derivation:
7063
7064 AnnotableType (extension)
7065 IdentifiableType (extension)
7066 NameableType (extension)
7067 VersionableType (restriction)
7068 MaintainableBaseType (extension)
7069 MaintainableType (extension)
7070 ItemSchemeType (extension)
7071 VtlDefinitionSchemeType (restriction)
7072 UserDefinedOperatorSchemeBaseType
7073
7074 Attributes:
7075
7076 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
7077
7078 Content:
7079
7080 Annotations?, Link*, Name+, Description*, UserDefinedOperator
7081
7082 Attribute Documentation:
7083
7084 (% style="width:1289.29px" %)
7085 |**Name**|**Type**|**Documentation**
7086 |id|IDType|The id is the identifier for the object.
7087 |urn|UserDefinedOperatorSchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
7088 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
7089 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
7090 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
7091 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
7092 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
7093 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
7094 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
7095 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
7096 |isPartialLanguage (default: false)|xs:boolean|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’.
7097 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.
7098 |vtlVersion|xs:string|Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version.
7099
7100 Element Documentation:
7101
7102 (% style="width:1146.29px" %)
7103 |**Name**|**Type**|(% style="width:744px" %)**Documentation**
7104 |Annotations|AnnotationsType|(% style="width:744px" %)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.
7105 |Link|LinkType|(% style="width:744px" %)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.
7106 |Name|TextType|(% style="width:744px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
7107 |Description|TextType|(% style="width:744px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
7108 |UserDefinedOperator|UserDefinedOperatorType|(% style="width:744px" %)UserDefinedOperator details a user defined operators within a user defined operator scheme.
7109
7110 **UserDefinedOperatorSchemeType:** UserDefinedOperatorSchemeType defines a collection of user defined operators that are used in transformations.
7111
7112 Derivation:
7113
7114 AnnotableType (extension)
7115 IdentifiableType (extension)
7116 NameableType (extension)
7117 VersionableType (restriction)
7118 MaintainableBaseType (extension)
7119 MaintainableType (extension)
7120 ItemSchemeType (extension)
7121 VtlDefinitionSchemeType (restriction)
7122 UserDefinedOperatorSchemeBaseType (extension)
7123 UserDefinedOperatorSchemeType
7124
7125 Attributes:
7126 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
7127
7128 Content:
7129 Annotations?, Link*, Name+, Description*, UserDefinedOperator*, VtlMappingScheme?, RulesetScheme
7130
7131 Attribute Documentation:
7132
7133 (% style="width:1233.29px" %)
7134 |**Name**|**Type**|**Documentation**
7135 |id|IDType|The id is the identifier for the object.
7136 |urn|UserDefinedOperatorSchemeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
7137 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
7138 |version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
7139 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
7140 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
7141 |agencyID|NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
7142 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
7143 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
7144 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
7145 |isPartialLanguage (default: false)|xs:boolean|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’.
7146 |isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint.
7147 |vtlVersion|xs:string|Identifies the VTL version to which the items in the defined scheme comply. Note that definition schemes can only reference definition schemes using the same VTL version.
7148
7149 Element Documentation:
7150
7151 (% style="width:1153.29px" %)
7152 |**Name**|**Type**|(% style="width:717px" %)**Documentation**
7153 |Annotations|AnnotationsType|(% style="width:717px" %)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.
7154 |Link|LinkType|(% style="width:717px" %)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.
7155 |Name|TextType|(% style="width:717px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
7156 |Description|TextType|(% style="width:717px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
7157 |UserDefinedOperator|UserDefinedOperatorType|(% style="width:717px" %)UserDefinedOperator details a user defined operators within a user defined operator scheme.
7158 |VtlMappingScheme|VtlMappingSchemeReferenceType|(% style="width:717px" %)References a VTL mapping scheme which defines aliases for given SDMX artefacts that are used in the user defined operators. Although the VTL user defined operators are conceived to be defined on generic operands, so that the specific artefacts to be manipulated are passed as parameters at the invocation, it is also possible that they reference specific SDMX artefacts like Dataflows, Codelists and ConceptSchemes. In this case, the mapping schemes referenced here define the mappings to those artefacts.
7159 |RulesetScheme|RulesetSchemeReferenceType|(% style="width:717px" %)References a ruleset scheme defining rulesets utilized in the user defined operators.
7160
7161 //**UserDefinedOperatorBaseType:**// UserDefinedOperatorBaseType defines the base refinement of the UserDefinedOperatorType. Its purpose is to retrict the urn attribute.
7162
7163 Derivation:
7164
7165 AnnotableType (extension)
7166 IdentifiableType (extension)
7167 NameableType (restriction)
7168 ItemBaseType (extension)
7169 ItemType (restriction)
7170 UnnestedItemType (restriction)
7171 UserDefinedOperatorBaseType
7172
7173 Attributes:
7174 id, urn?, uri?
7175
7176 Content:
7177 Annotations?, Link, Name+, Description
7178
7179 Attribute Documentation:
7180
7181 (% style="width:1187.29px" %)
7182 |**Name**|**Type**|**Documentation**
7183 |id|IDType|The id is the identifier for the object.
7184 |urn|UserDefinedOperatorUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
7185 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
7186
7187 Element Documentation:
7188
7189 |**Name**|**Type**|**Documentation**|
7190 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
7191 |Link|LinkType|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.|
7192 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
7193 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
7194
7195 **UserDefinedOperatorType:** UserDefinedOperatorType defines the structure of a user defined operator. A user defined operator is a custom VTL operator (not existing in the standard library) that extends the VTL standard library for specific purposes. In addition to its identification and name, and definition of the operator must be provided.
7196
7197 Derivation:
7198
7199 AnnotableType (extension)
7200 IdentifiableType (extension)
7201 NameableType (restriction)
7202 ItemBaseType (extension)
7203 ItemType (restriction)
7204 UnnestedItemType (restriction)
7205 UserDefinedOperatorBaseType (extension)
7206 UserDefinedOperatorType
7207
7208 Attributes:
7209 id, urn?, uri?
7210
7211 Content:
7212 Annotations?, Link, Name+, Description, OperatorDefinition
7213
7214 Attribute Documentation:
7215
7216 (% style="width:1104.29px" %)
7217 |**Name**|(% style="width:242px" %)**Type**|(% style="width:772px" %)**Documentation**
7218 |id|(% style="width:242px" %)IDType|(% style="width:772px" %)The id is the identifier for the object.
7219 |urn|(% style="width:242px" %)UserDefinedOperatorUrnType|(% style="width:772px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
7220 |uri|(% style="width:242px" %)xs:anyURI|(% style="width:772px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
7221
7222 Element Documentation:
7223
7224 |**Name**|**Type**|**Documentation**|
7225 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
7226 |Link|LinkType|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.|
7227 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
7228 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
7229 |OperatorDefinition|xs:string|A VTL statement for the definition of a new operator: it specifies the operator name, its parameters and their data types, the VTL expression that defines its behaviour.|
7230
7231 **CustomTypeSchemeType:** CustomTypeSchemeType defines a collection of custom types that are used in transformations.
7232
7233 Derivation:
7234
7235 AnnotableType (extension)
7236 IdentifiableType (extension)
7237 NameableType (extension)
7238 VersionableType (restriction)
7239 MaintainableBaseType (extension)
7240 MaintainableType (extension)
7241 ItemSchemeType (extension)
7242 VtlDefinitionSchemeType (restriction)
7243 CustomTypeSchemeType
7244
7245 Attributes:
7246 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
7247
7248 Content:
7249 Annotations?, Link*, Name+, Description*, CustomType
7250
7251 Attribute Documentation:
7252
7253 (% style="width:1182.29px" %)
7254 |**Name**|**Type**|(% style="width:760px" %)**Documentation**
7255 |id|IDType|(% style="width:760px" %)The id is the identifier for the object.
7256 |urn|CustomTypeSchemeUrnType|(% style="width:760px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
7257 |uri|xs:anyURI|(% style="width:760px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
7258 |version|VersionType|(% style="width:760px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
7259 |validFrom|xs:dateTime|(% style="width:760px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
7260 |validTo|xs:dateTime|(% style="width:760px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
7261 |agencyID|NestedNCNameIDType|(% style="width:760px" %)The agencyID must be provided, and identifies the maintenance agency of the object.
7262 |isExternalReference (default: false)|xs:boolean|(% style="width:760px" %)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.
7263 |serviceURL|xs:anyURI|(% style="width:760px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
7264 |structureURL|xs:anyURI|(% style="width:760px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
7265 |isPartialLanguage (default: false)|xs:boolean|(% style="width:760px" %)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’.
7266 |isPartial (default: false)|xs:boolean|(% style="width:760px" %)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.
7267 |vtlVersion|xs:string|(% style="width:760px" %)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.
7268
7269 Element Documentation:
7270
7271 |**Name**|**Type**|**Documentation**|
7272 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
7273 |Link|LinkType|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.|
7274 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
7275 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
7276 |CustomType|CustomTypeType|CustomType details a custom type within a custom type scheme.|
7277
7278 //**CustomTypeBaseType:**// CustomTypeBaseType defines the base refinement of the CustomTypeType. Its purpose is to retrict the urn attribute.
7279
7280 Derivation:
7281
7282 AnnotableType (extension)
7283 IdentifiableType (extension)
7284 NameableType (restriction)
7285 ItemBaseType (extension)
7286 ItemType (restriction)
7287 UnnestedItemType (restriction)
7288 CustomTypeBaseType
7289
7290 Attributes:
7291 id, urn?, uri?
7292
7293 Content:
7294 Annotations?, Link, Name+, Description
7295
7296 Attribute Documentation:
7297
7298 |**Name**|**Type**|**Documentation**|
7299 |id|IDType|The id is the identifier for the object.|
7300 |urn|CustomTypeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
7301 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
7302
7303 Element Documentation:
7304
7305 |**Name**|**Type**|**Documentation**|
7306 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
7307 |Link|LinkType|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.|
7308 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
7309 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
7310
7311 **CustomTypeType:** CustomTypeType defines the structure of a custom type. A custom type specifies a custom conversion for a VTL scalar type to a resulting data type. This conversion overrides the default conversion.
7312
7313 Derivation:
7314
7315 AnnotableType (extension)
7316 IdentifiableType (extension)
7317 NameableType (restriction)
7318 ItemBaseType (extension)
7319 ItemType (restriction)
7320 UnnestedItemType (restriction)
7321 CustomTypeBaseType (extension)
7322 CustomTypeType
7323
7324 Attributes:
7325 id, urn?, uri?
7326
7327 Content:
7328 Annotations?, Link*, Name+, Description*, VtlScalarType, DataType, VtlLiteralFormat?, OutputFormat?, NullValue?
7329
7330 Attribute Documentation:
7331
7332 |**Name**|**Type**|**Documentation**|
7333 |id|IDType|The id is the identifier for the object.|
7334 |urn|CustomTypeUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
7335 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
7336
7337 Element Documentation:
7338
7339 |**Name**|**Type**|**Documentation**|
7340 |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
7341 |Link|LinkType|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.|
7342 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
7343 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
7344 |VtlScalarType|xs:string|Identifies the VTL scalar type that is to be converted to an resulting output data type.|
7345 |DataType|CustomTypeDataType|Identifies the resulting output data type the VTL scalar type is to be converted to. If this is an SDMX data type, it must use the proper SimpleDataType enumeration value. For all other data types, a string value can be used to identify the type.|
7346 |VtlLiteralFormat|xs:string|The format in which the literals of the VTL scalar type are expressed in the transformations. This is only needed if the format is different than the output format expressed by means of the VTL type.|
7347 |OutputFormat|xs:string|The format the VTL scalar type has to assume (e.g. YYYY-MM-DD; see VTL specifications), both for the literals in the VTL expressions and for the conversion to the output.|
7348 |NullValue|xs:string|The value to be produced in the output of the conversion when a component has a null value.|
7349
7350 === 2.1.4 Simple Types ===
7351
7352 **CodeDataType:** CodeDataType is a restriction of the basic data types that are applicable to codes. Although some of the higher level time period formats are perimitted, it should be noted that any value which contains time (which includes a time zone offset) is not allowable as a code identifier.
7353
7354 Derived by restriction of SimpleDataType.
7355
7356 Enumerations:
7357
7358 |**Value**|**Documentation**|
7359 |String|A string datatype corresponding to W3C XML Schema's xs:string datatype.|
7360 |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.|
7361 |AlphaNumeric|A string datatype which only allows for the simple alphabetic character set of A-Z, a-z plus the simple numeric character set of 0-9.|
7362 |Numeric|A string datatype which only allows for the simple numeric character set of 0-9. This format is not treated as an integer, and therefore can having leading zeros.|
7363 |BigInteger|An integer datatype corresponding to W3C XML Schema's xs:integer datatype.|
7364 |Integer|An integer datatype corresponding to W3C XML Schema's xs:int datatype.|
7365 |Long|A numeric datatype corresponding to W3C XML Schema's xs:long datatype.|
7366 |Short|A numeric datatype corresponding to W3C XML Schema's xs:short datatype.|
7367 |Boolean|A datatype corresponding to W3C XML Schema's xs:boolean datatype.|
7368 |URI|A datatype corresponding to W3C XML Schema's xs:anyURI datatype.|
7369 |Count|A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1".|
7370 |InclusiveValueRange|This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal.|
7371 |ExclusiveValueRange|This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal.|
7372 |Incremental|This value indicates that the value increments according to the value provided in the interval facet, and has a true value for the isSequence facet.|
7373 |ObservationalTimePeriod|Observational time periods are the superset of all time periods in SDMX. It is the union of the standard time periods (i.e. Gregorian time periods, the reporting time periods, and date time) and a time range.|
7374 |StandardTimePeriod|Standard time periods is a superset of distinct time period in SDMX. It is the union of the basic time periods (i.e. the Gregorian time periods and date time) and the reporting time periods.|
7375 |BasicTimePeriod|BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.|
7376 |GregorianTimePeriod|Gregorian time periods correspond to calendar periods and are represented in ISO-8601 formats. This is the union of the year, year month, and date formats.|
7377 |GregorianYear|A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.|
7378 |GregorianYearMonth|A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.|
7379 |GregorianDay|A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.|
7380 |ReportingTimePeriod|Reporting time periods represent periods of a standard length within a reporting year, where to start of the year (defined as a month and day) must be defined elsewhere or it is assumed to be January 1. This is the union of the reporting year, semester, trimester, quarter, month, week, and day.|
7381 |ReportingYear|A reporting year represents a period of 1 year (P1Y) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingYearType.|
7382 |ReportingSemester|A reporting semester represents a period of 6 months (P6M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingSemesterType.|
7383 |ReportingTrimester|A reporting trimester represents a period of 4 months (P4M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingTrimesterType.|
7384 |ReportingQuarter|A reporting quarter represents a period of 3 months (P3M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingQuarterType.|
7385 |ReportingMonth|A reporting month represents a period of 1 month (P1M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingMonthType.|
7386 |ReportingWeek|A reporting week represents a period of 7 days (P7D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingWeekType.|
7387 |ReportingDay|A reporting day represents a period of 1 day (P1D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingDayType.|
7388 |Month|A time datatype corresponding to W3C XML Schema's xs:gMonth datatype.|
7389 |MonthDay|A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype.|
7390 |Day|A time datatype corresponding to W3C XML Schema's xs:gDay datatype.|
7391 |Duration|A time datatype corresponding to W3C XML Schema's xs:duration datatype.|
7392
7393 **WildcardedMemberValueType:** WildcardedMemberValueType allows for an optional wildcard characters ('%') in an identifier.
7394
7395 Derived by restriction of xs:string.
7396 Regular Expression Pattern: [A-Za-z0-9_@$-%]+
7397
7398 **GeoCodelistTypeType:** GeoCodelistTypeType defines an enumeration of the speicfic types of geographic codelists.
7399
7400 Derived by restriction of xs:string.
7401
7402 Enumerations:
7403
7404 (% style="width:469.294px" %)
7405 |(% style="width:225px" %)**Value**|(% style="width:240px" %)**Documentation**
7406 |(% style="width:225px" %)GeographicCodelist|(% style="width:240px" %)
7407 |(% style="width:225px" %)GeoGridCodelist|(% style="width:240px" %)
7408
7409 **ConstraintRoleType:** ConstraintRoleType defines a list of roles for a content constraint. A constraint can state which data is present or which content is allowed for the constraint attachment.
7410
7411 Derived by restriction of xs:string.
7412
7413 Enumerations:
7414
7415 |**Value**|**Documentation**|
7416 |Allowed|The constraint contains the allowed values for attachable object.|
7417 |Actual|The constraints contains the actual data present for the attachable object.|
7418
7419 **SimpleOperatorType:** SimpleOperatorType provides an enumeration of simple operators to be applied to any value.
7420
7421 Derived by restriction of xs:string.
7422
7423 Enumerations:
7424
7425 (% style="width:705.894px" %)
7426 |(% style="width:250px" %) **Value**|(% style="width:454px" %) **Documentation**
7427 |(% style="width:250px" %) notEqual|(% style="width:454px" %) () - value must not be equal to the value supplied.
7428 |(% style="width:250px" %) equal|(% style="width:454px" %) (=) - value must be exactly equal to the value supplied.
7429
7430 **RangeOperatorType:** RangeOperatorType provides an enumeration of range operators to be applied to an ordered value.
7431
7432 Derived by restriction of xs:string.
7433
7434 Enumerations:
7435
7436 |**Value**|**Documentation**|
7437 |greaterThanOrEqual|(>=) - value must be greater than or equal to the value supplied.|
7438 |lessThanOrEqual|(<=) - value must be less than or equal to the value supplied.|
7439 |greaterThan|(>) - value must be greater than the value supplied.|
7440 |lessThan|(<) - value must be less than the value supplied.|
7441
7442 **TextSearchOperatorType:** TextSearchOperatorType provides an enumeration of text search operators.
7443
7444 Derived by restriction of xs:string.
7445
7446 Enumerations:
7447
7448 |**Value**|**Documentation**|
7449 |contains|The text being searched must contain the supplied text.|
7450 |startsWith|The text being searched must start with the supplied text.|
7451 |endsWith|The text being searched must end with the supplied text.|
7452 |doesNotContain|The text being searched cannot contain the supplied text.|
7453 |doesNotStartWith|The text being searched cannot start with the supplied text.|
7454 |doesNotEndWith|The text being searched cannot end with the supplied text.|
7455
7456 **OrderedOperatorType:** OrderedOperatorType combines the SimpleOperatorType and the RangeOperatorType to provide a full range or operators for any ordered value.
7457
7458 Union of:
7459 SimpleOperatorType, RangeOperatorType.
7460
7461 **TextOperatorType:**
7462
7463 Union of:
7464 SimpleOperatorType, TextSearchOperatorType.
7465
7466 **TimeOperatorType:** TimeOperatorType derives from the OrderedOperatorType to remove the notEqual operator.
7467
7468 Derived by restriction of OrderedOperatorType.
7469
7470 Enumerations:
7471
7472 |**Value**|**Documentation**|
7473 |equal| |
7474 |greaterThanOrEqual| |
7475 |lessThanOrEqual| |
7476 |greaterThan| |
7477 |lessThan| |
7478
7479 **UsageType:** An enumeration of optional|mandatory to indicate the usage of an attribute or measure.
7480
7481 Derived by restriction of xs:string.
7482
7483 Enumerations:
7484
7485 |**Value**|**Documentation**|
7486 |mandatory| |
7487 |optional| |
7488
7489 **SimpleCodeDataType:** SimpleCodeDataType restricts SimpleDataType to specify the allowable data types for a simple code. The possible values are simply Alpha, AlphaNumeric, or Numeric.
7490
7491 Derived by restriction of SimpleDataType.
7492
7493 Enumerations:
7494
7495 |**Value**|**Documentation**|
7496 |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.|
7497 |AlphaNumeric|A string datatype which only allows for the simple alphabetic character set of A-Z, a-z plus the simple numeric character set of 0-9.|
7498 |Numeric|A string datatype which only allows for the simple numeric character set of 0-9. This format is not treated as an integer, and therefore can having leading zeros.|
7499
7500 **EpochPeriodType:** EpochPeriodType defines an enumeration of epoch period types.
7501
7502 Derived by restriction of xs:string.
7503
7504 Enumerations:
7505
7506 |**Value**|**Documentation**|
7507 |nanosecond| |
7508 |millisecond| |
7509 |microsecond| |
7510 |second| |
7511 |day| |
7512
7513 **ResolvePeriodType:** ResolvePeriodType defines an enumeration of how date periods should be resolved.
7514
7515 Derived by restriction of xs:string.
7516
7517 Enumerations:
7518
7519 |**Value**|**Documentation**|
7520 |startOfPeriod| |
7521 |endOfPeriod| |
7522 |midPeriod| |
7523
7524 **StandardToVtlMappingMethodType:** A simple type enumerating the standard mapping methods when converting from data structures from SDMX to VLT.
7525
7526 Derived by restriction of xs:string.
7527
7528 Enumerations:
7529
7530 |**Value**|**Documentation**|
7531 |Basic|The default mapping method. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.1 ("Basic Mapping").|
7532 |Basic-A2M|The basic mapping method, using attributes to measures. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.3 ("From SDMX DataAttributes to VTL Measures").|
7533 |Pivot-A2M|The pivot mapping method, using attributes to measures. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.3 ("From SDMX DataAttributes to VTL Measures").|
7534
7535 **ToVtlMappingMethodType:** A simple type that allows for a standard to VTL mapping method enumeration value or a string value for other mapping methods.
7536
7537 Union of:
7538 StandardToVtlMappingMethodType, xs:string.
7539
7540 **StandardFromVtlMappingMethodType:** A simple type enumerating the standard mapping methods when converting from data structures from VTL to SDMX.
7541
7542 Derived by restriction of xs:string.
7543
7544 Enumerations:
7545
7546 |**Value**|**Documentation**
7547 |Basic|The default mapping method, applicable only when the VLT data structure has just one measure component. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.4.1 ("Basic Mapping").
7548 |M2A|Mapping of multi-measure VTL where on measure is mapped to the SDMX primary measure and the remaining measures are mapped as data attributes. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.4.3 ("From VTL Measures to SDMX DataAttributes").
7549
7550 **FromVtlMappingMethodType:** A simple type that allows for standard from VTL mapping method enumeration value or a string value for other mapping methods.
7551
7552 Union of:
7553 StandardFromVtlMappingMethodType, xs:string.
7554
7555 **CustomTypeDataType:** A simple type that allows for a SDMX simple data type enumeration value or a string value for other data types.
7556
7557 Union of:
7558 SimpleDataType, xs:string.