Skip to Content

Wiki source code of Part III. Structure

Version 4.7 by Helena on 2025/07/01 19:28
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 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 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 | DataProviderSchemesT ype | 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 | MetadataProviderSche mes | 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 | MetadataProvisionAgreements | 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 | NamePersonalisationS chemes | 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 | TransformationScheme s | 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 | UserDefinedOperatorS chemes | UserDefinedOperatorS chemesType | 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 | VtlMappingSchemesTyp e | 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 | --- --| --- --| --- --|
245 | AgencyScheme | AgencySchemeType | AgencyScheme provides the details of an agency scheme, in which agencies are described. |
246
247 **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.
248
249 Content:
250 `Categorisation+`
251
252 Element Documentation:
253
254 | **Name** | **Type** | **Documentation** |
255 | --- --| --- --| --- --|
256 | 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. |
257
258 **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.
259
260 Content:
261 CategorySchemeMap+
262
263 Element Documentation:
264
265 | **Name** | **Type** | **Documentation** |
266 | --- --| --- --| --- --|
267 | CategorySchemeMap | CategorySchemeMapTyp e | CategorySchemeMap provides the details of a category scheme map, which descibes mappings between categories in different schemes. |
268
269 **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.
270
271 Content:
272 CategoryScheme+
273
274 Element Documentation:
275
276 | **Name** | **Type** | **Documentation** |
277 | --- --| --- --| --- --|
278 | 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. |
279
280 **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.
281
282 Content:
283 ConceptSchemeMap+
284
285 Element Documentation:
286
287 | **Name** | **Type** | **Documentation** |
288 | --- --| --- --| --- --|
289 | ConceptSchemeMap | ConceptSchemeMapType | ConceptSchemeMap provides the details of a concept scheme map, which descibes mappings between concepts in different schemes. |
290
291 **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.
292
293 Content:
294
295 `ConceptScheme*`
296
297 Element Documentation:
298
299 | **Name** | **Type** | **Documentation** |
300 | --- --| --- --| --- --|
301 | 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. |
302
303 **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.
304
305 Content:
306 Codelist+
307
308 Element Documentation:
309
310 | **Name** | **Type** | **Documentation** |
311 | --- --| --- --| --- --|
312 | 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. |
313
314 **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.
315
316 Content:
317
318 `CustomTypeScheme+`
319
320 Element Documentation:
321
322 | **Name** | **Type** | **Documentation** |
323 | --- --| --- --| --- --|
324 | CustomTypeScheme | CustomTypeSchemeType | CustomTypeScheme provides the details of a custom type scheme, in which user defined operators are described. |
325
326 **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.
327
328 Content:
329 DataConstraint+
330
331 Element Documentation:
332
333 | **Name** | **Type** | **Documentation** |
334 | --- --| --- --| --- --|
335 | 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. |
336
337 **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.
338
339 Content:
340 DataConsumerScheme+
341
342 Element Documentation:
343
344 | **Name** | **Type** | **Documentation** |
345 | --- --| --- --| --- --|
346 | DataConsumerScheme | DataConsumerSchemeTy pe | DataConsumerScheme provides the details of an data consumer scheme, in which data consumers are described. |
347
348 **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.
349
350 Content:
351
352 `Dataflow+`
353
354 Element Documentation:
355
356 | **Name** | **Type** | **Documentation** |
357 | --- --| --- --| --- --|
358 | 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. |
359
360 **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.
361
362 Content:
363 DataProviderScheme+
364
365 Element Documentation:
366
367 | **Name** | **Type** | **Documentation** |
368 | --- --| --- --| --- --|
369 | DataProviderScheme | DataProviderSchemeTy pe | DataProviderScheme provides the details of an data provider scheme, in which data providers are described. |
370
371 **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.
372
373 Content:
374 DataStructure+
375
376 Element Documentation:
377
378 | **Name** | **Type** | **Documentation** |
379 | --- --| --- --| --- --|
380 | 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. |
381
382 **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.
383
384 Content:
385 GeographicCodelist+
386
387 Element Documentation:
388
389 | **Name** | **Type** | **Documentation** |
390 | --- --| --- --| --- --|
391 | GeographicCodelist | GeographicCodelistTy pe | 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. |
392
393 **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.
394
395 Content:
396 GeoGridCodelist+
397
398 Element Documentation:
399
400 | **Name** | **Type** | **Documentation** |
401 | --- --| --- --| --- --|
402 | 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. |
403
404 **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.
405
406 Content:
407 Hierarchy+
408
409 Element Documentation:
410
411 | **Name** | **Type** | **Documentation** |
412 | --- --| --- --| --- --|
413 | 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. |
414
415 **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.
416
417 Content:
418 HierarchyAssociation+
419
420 Element Documentation:
421
422 | **Name** | **Type** | **Documentation** |
423 | --- --| --- --| --- --|
424 | 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. |
425
426 **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.
427
428 Content:
429 MetadataConstraint+
430
431 Element Documentation:
432
433 | **Name** | **Type** | **Documentation** |
434 | --- --| --- --| --- --|
435 | MetadataConstraint | MetadataConstraintTy pe | MetadataConstraint specifies a sub set of the definition of the allowable content of a metadata set. |
436
437 **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.
438
439 Content:
440 Metadataflow+
441
442 Element Documentation:
443
444 | **Name** | **Type** | **Documentation** |
445 | --- --| --- --| --- --|
446 | 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 |
447
448 **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.
449
450 Content:
451 MetadataProviderScheme+
452
453 Element Documentation:
454
455 | **Name** | **Type** | **Documentation** |
456 | --- --| --- --| --- --|
457 | MetadataProviderSche me | MetadataProviderSche meType | MetadataProviderScheme provides the details of an metadata provider scheme, in which metadata providers are described. |
458
459 **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.
460
461 Content:
462 MetadataProvisionAgreement+
463
464 Element Documentation:
465
466 | **Name** | **Type** | **Documentation** |
467 | --- --| --- --| --- --|
468 | MetadataProvisionAgr eement | MetadataProvisionAgr eementType | MetadataProvisionAgreement provides the details of a metadata provision agreement, which is an agreement for a metadata provider to report reference metadata against a flow. |
469
470 **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.
471
472 Content:
473 MetadataStructure+
474
475 Element Documentation:
476
477 | **Name** | **Type** | **Documentation** |
478 | --- --| --- --| --- --|
479 | MetadataStructure | MetadataStructureTyp e | 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. |
480
481 **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.
482
483 Content:
484 NamePersonalisationScheme+
485
486 Element Documentation:
487
488 | **Name** | **Type** | **Documentation** |
489 | --- --| --- --| --- --|
490 | NamePersonalisationS cheme | NamePersonalisationS chemeType | NamePersonalisationScheme provides the details of a name personalisation scheme, in which name personalisations are described. |
491
492 **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.
493
494 Content:
495 OrganisationSchemeMap+
496
497 Element Documentation:
498
499 | **Name** | **Type** | **Documentation** |
500 | --- --| --- --| --- --|
501 | OrganisationSchemeMa p | OrganisationSchemeMa pType | OrganisationSchemeMap provides the details of a organisation scheme map, which descibes mappings between organisations in different schemes. |
502
503 **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.
504
505 Content:
506 OrganisationUnitScheme+
507
508 Element Documentation:
509
510 | **Name** | **Type** | **Documentation** |
511 | --- --| --- --| --- --|
512 | OrganisationUnitSche me | OrganisationUnitSche meType | OrganisationUnitScheme provides the details of an organisation unit scheme, in which organisation units are described. |
513
514 **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.
515
516 Content:
517 Process+
518
519 Element Documentation:
520
521 | **Name** | **Type** | **Documentation** |
522 | --- --| --- --| --- --|
523 | 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. |
524
525 **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.
526
527 Content:
528 ProvisionAgreement+
529
530 Element Documentation:
531
532 | **Name** | **Type** | **Documentation** |
533 | --- --| --- --| --- --|
534 | ProvisionAgreement | ProvisionAgreementTy pe | ProvisionAgreement provides the details of a provision agreement, which is an agreement for a data provider to report data against a flow. |
535
536 **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.
537
538 Content:
539 ReportingTaxonomy+
540
541 Element Documentation:
542
543 | **Name** | **Type** | **Documentation** |
544 | --- --| --- --| --- --|
545 | ReportingTaxonomy | ReportingTaxonomyTyp e | 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. |
546
547 **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.
548
549 Content:
550 ReportingTaxonomyMap+
551
552 Element Documentation:
553
554 | **Name** | **Type** | **Documentation** |
555 | --- --| --- --| --- --|
556 | ReportingTaxonomyMap | ReportingTaxonomyMap Type | ReportingTaxonomyMap provides the details of a reporting taxonomy map, which descibes mappings between reporting taxonomies. |
557
558 **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.
559
560 Content:
561 RepresentationMap+
562
563 Element Documentation:
564
565 | **Name** | **Type** | **Documentation** |
566 | --- --| --- --| --- --|
567 | RepresentationMap | RepresentationMapTyp e | RepresentationMap provides the details of a represenation map, which describes mappings between various component represenations. |
568
569 **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.
570
571 Content:
572 RulesetScheme+
573
574 Element Documentation:
575
576 | **Name** | **Type** | **Documentation** |
577 | --- --| --- --| --- --|
578 | RulesetScheme | RulesetSchemeType | RulesetScheme provides the details of a ruleset scheme, in which rulesets are described. |
579
580 **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.
581
582 Content:
583 StructureMap+
584
585 Element Documentation:
586
587 | **Name** | **Type** | **Documentation** |
588 | --- --| --- --| --- --|
589 | StructureMap | StructureMapType | StructureMap provides the details or a structure map, which describes mapping between data structures or dataflows. |
590
591 **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.
592
593 Content:
594
595 `TransformationScheme+`
596
597 Element Documentation:
598
599 | **Name** | **Type** | **Documentation** |
600 | --- --| --- --| --- --|
601 | TransformationScheme | TransformationScheme Type | TransformationScheme provides the details of a transformation scheme, in which transformations are described. |
602
603 **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.
604
605 Content:
606 UserDefinedOperatorScheme+
607
608 Element Documentation:
609
610 | **Name** | **Type** | **Documentation** |
611 | --- --| --- --| --- --|
612 | UserDefinedOperatorS cheme | UserDefinedOperatorS chemeType | UserDefinedOperatorScheme provides the details of a user defined operator scheme, in which user defined operators are described. |
613
614 **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.
615
616 Content:
617
618 `ValueList+`
619
620 Element Documentation:
621
622 | **Name** | **Type** | **Documentation** |
623 | --- --| --- --| --- --|
624 | ValueList | ValueListType | ValueList provides the details of a value list, which is a closed set of values that can occur for a dimension, measure, or attribute. This may be a simple list of values, or a list of values with names and descriptions (similar to a codelist). |
625
626 **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.
627
628 Content:
629
630 `VtlMappingScheme+`
631
632 Element Documentation:
633
634 | **Name** | **Type** | **Documentation** |
635 | --- --| --- --| --- --|
636 | VtlMappingScheme | VtlMappingSchemeType | VtlMappingScheme provides the details of a VTL mapping scheme, in which VTL mappings are described. |
637
638 ***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.
639
640 Derivation:
641 AnnotableType`*` (extension)`
642 IdentifiableType`*` (extension)`
643 NameableType`*` (extension)`
644 VersionableType`*` (restriction)`
645 MaintainableBaseType`*` (extension)`
646 MaintainableType`*` (extension)`
647 ItemSchemeType`*
648
649 Attributes:
650 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`
651
652 Content:
653 Annotations?, Link*, Name+, Description*, `*`Item*`*
654
655 Attribute Documentation:
656
657 | **Name** | **Type** | **Documentation** |
658 | --- --| --- --| --- --|
659 | id | IDType | The id is the identifier for the object. |
660 | urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
661 | 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. |
662 | 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. |
663 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
664 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
665 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
666 | 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. |
667 | 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. |
668 | 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. |
669 | 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’. |
670 | 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. |
671
672 Element Documentation:
673
674 | **Name** | **Type** | **Documentation** |
675 | --- --| --- --| --- --|
676 | 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. |
677 | 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. |
678 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
679 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
680 | *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. |
681
682 ***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.
683
684 Derivation:
685 AnnotableType`*` (extension)`
686 IdentifiableType`*` (extension)`
687 NameableType`*` (restriction)`
688 ItemBaseType`*
689
690 Attributes:
691 `id, urn?, uri?`
692
693 Content:
694 `Annotations?, Link*, Name+, Description*`
695
696 Attribute Documentation:
697
698 | **Name** | **Type** | **Documentation** |
699 | --- --| --- --| --- --|
700 | id | IDType | The id is the identifier for the object. |
701 | urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
702 | 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. |
703
704 Element Documentation:
705
706 | **Name** | **Type** | **Documentation** |
707 | --- --| --- --| --- --|
708 | 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. |
709 | 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. |
710 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
711 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
712
713 ***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.
714
715 Derivation:
716 AnnotableType (extension)
717 IdentifiableType (extension)
718 NameableType (restriction)
719 ItemBaseType (extension)
720 ItemType
721
722 Attributes:
723 `id, urn?, uri?`
724
725 Content:
726 `Annotations?, Link*, Name+, Description*, (Parent | `*`Item+`*`)?`
727
728 Attribute Documentation:
729
730 | **Name** | **Type** | **Documentation** |
731 | --- --| --- --| --- --|
732 | id | IDType | The id is the identifier for the object. |
733 | urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
734 | 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. |
735
736 Element Documentation:
737
738 | **Name** | **Type** | **Documentation** |
739 | --- --| --- --| --- --|
740 | 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. |
741 | 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. |
742 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
743 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
744 | Parent | NestedIDType | |
745 | *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. |
746
747 ***UnnestedItemType*:** UnnestedItemType is an abstract base type for all items with in an item scheme that do not contain nested items.
748
749 Derivation:
750 *`AnnotableType`* `(extension)`
751 *`IdentifiableType`*` (extension)`
752 *`NameableType`* `(restriction)`
753 *`ItemBaseType`*` (extension)`
754 *`ItemType`*` (restriction)`
755 *`UnnestedItemType`*
756
757 Attributes:
758 id, urn?, uri?
759
760 Content:
761 Annotations?, Link, Name+, Description*`
762
763 Attribute Documentation:
764
765 | **Name** | **Type** | **Documentation** |
766 | --- --| --- --| --- --|
767 | id | IDType | The id is the identifier for the object. |
768 | urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
769 | 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. |
770
771 Element Documentation:
772
773 | **Name** | **Type** | **Documentation** |
774 | --- --| --- --| --- --|
775 | 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. |
776 | 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. |
777 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
778 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
779
780 ***StructureType*:** StructureType is an abstract base type for all structure objects. Concrete instances of this should restrict to a concrete grouping.
781
782 Derivation:
783 AnnotableType (extension)
784 *`IdentifiableType`*` (extension)`
785 *`NameableType`*` (extension)`
786 *`VersionableType`*` (restriction)`
787 *`MaintainableBaseType`*` (extension)`
788 *`MaintainableType`*` (extension)`
789 *`StructureType`*
790
791 Attributes:
792 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
793
794 Content:
795 Annotations?, Link*, Name+, Description*, `*`Grouping?
796
797 Attribute Documentation:
798
799 | **Name** | **Type** | **Documentation** |
800 | --- --| --- --| --- --|
801 | id | IDType | The id is the identifier for the object. |
802 | urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
803 | 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. |
804 | 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. |
805 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
806 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
807 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
808 | 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.|
809 | 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.|
810 | 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.|
811 | 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’.|
812
813 Element Documentation:
814
815 | **Name** | **Type** | **Documentation** |
816 | --- --| --- --| --- --|
817 | 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. |
818 | 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. |
819 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
820 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
821 | *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. |
822
823 ***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.
824
825 Content:
826 ComponentList
827
828 Element Documentation:
829
830 | **Name** | **Type** | **Documentation** |
831 | --- --| --- --| --- --|
832 | *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. |
833
834 ***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.
835
836 Derivation:
837 AnnotableType`*` (extension)`
838 *`IdentifiableType`*` (extension)`
839 *`ComponentListType`*
840
841 Attributes:
842 id?, urn?, uri?
843
844 Content:
845 Annotations?, Link*, `*`Component
846
847 Attribute Documentation:
848
849 | **Name** | **Type** | **Documentation** |
850 | --- --| --- --| --- --|
851 | id | IDType | The id is the identifier for the object. |
852 | urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
853 | 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. |
854
855 Element Documentation:
856
857 | **Name** | **Type** | **Documentation** |
858 | --- --| --- --| --- --|
859 | 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. |
860 | 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. |
861 | *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. |
862
863 ***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.
864
865 Derivation:
866 AnnotableType`*` (extension)`
867 *`IdentifiableType`*` (restriction)`
868 *`ComponentBaseType`*
869
870 Attributes:
871 id?, urn?, uri?`
872
873 Content:
874 Annotations?, Link*`
875
876 Attribute Documentation:
877
878 | **Name** | **Type** | **Documentation** |
879 | --- --| --- --| --- --|
880 | 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). |
881 | urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
882 | 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. |
883
884 Element Documentation:
885
886 | **Name** | **Type** | **Documentation** |
887 | --- --| --- --| --- --|
888 | 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. |
889 | 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. |
890
891 ***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.
892
893 Derivation:
894 AnnotableType`*` (extension)`
895 *`IdentifiableType`*` (restriction)`
896 *`ComponentBaseType`*` (extension)`
897 *`ComponentType`*
898
899 Attributes:
900 id?, urn?, uri?`
901
902 Content:
903 Annotations?, Link*, ConceptIdentity?, LocalRepresentation?`
904
905 Attribute Documentation:
906
907 | **Name** | **Type** | **Documentation** |
908 | --- --| --- --| --- --|
909 | 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). |
910 | urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
911 | 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. |
912
913 Element Documentation:
914
915 | **Name** | **Type** | **Documentation** |
916 | --- --| --- --| --- --|
917 | 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. |
918 | 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. |
919 | 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. |
920 | 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. |
921
922 ***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.
923
924 Derivation:
925 AnnotableType`*` (extension)`
926 *`IdentifiableType`*` (extension)`
927 *`NameableType`*` (extension)`
928 *`VersionableType`*` (restriction)`
929 *`MaintainableBaseType`*` (extension)`
930 *`MaintainableType`*` (extension)`
931 *`StructureUsageType`*
932
933 Attributes:
934 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
935
936 Content:
937 Annotations?, Link*, Name+, Description*, Structure?`
938
939 Attribute Documentation:
940
941 | **Name** | **Type** | **Documentation** |
942 | --- --| --- --| --- --|
943 | id | IDType | The id is the identifier for the object. |
944 | urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
945 | 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. |
946 | 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. |
947 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
948 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
949 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
950 | 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. |
951 | 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. |
952 | 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. |
953 | 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’. |
954
955 Element Documentation:
956
957 | **Name** | **Type** | **Documentation** |
958 | --- --| --- --| --- --|
959 | 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. |
960 | 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. |
961 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
962 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
963 | Structure | StructureReferenceTy pe | 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). |
964
965 ***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.
966
967 Attributes:
968 minOccurs?, maxOccurs?`
969
970 Content:
971 (TextFormat | (Enumeration, EnumerationFormat?))`
972
973 Attribute Documentation:
974
975 | **Name** | **Type** | **Documentation** |
976 | --- --| --- --| --- --|
977 | minOccurs (default: 1) | xs: nonNegativeInteger | The minOccurs attribute indicates the minimum number of value that must be reported for the component. |
978 | maxOccurs | OccurenceType | The maxOccurs attribute indicates the maximum number of values that can be reported for the component. |
979
980 Element Documentation:
981
982 | **Name** | **Type** | **Documentation** |
983 | --- --| --- --| --- --|
984 | TextFormat | TextFormatType | TextFormat describes an uncoded textual format. |
985 | Enumeration | AnyCodelistReference Type | Enumeration references an item scheme that enumerates the allowable values for this representation. |
986 | EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |
987
988 **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".
989
990 Attributes:
991 textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?, isMultiLingual?`
992
993 Content:
994 SentinelValue*`
995
996 Attribute Documentation:
997
998 | **Name** | **Type** | **Documentation** |
999 | --- --| --- --| --- --|
1000 | 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. |
1001 | 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. |
1002 | 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. |
1003 | 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. |
1004 | 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. |
1005 | 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. |
1006 | startTime | StandardTimePeriodTy pe | 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. |
1007 | endTime | StandardTimePeriodTy pe | 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. |
1008 | minLength | xs:positiveInteger | The minLength attribute specifies the minimum and length of the value in characters. |
1009 | maxLength | xs:positiveInteger | The maxLength attribute specifies the maximum length of the value in characters. |
1010 | 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. |
1011 | 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. |
1012 | decimals | xs:positiveInteger | The decimals attribute indicates the number of characters allowed after the decimal separator. |
1013 | pattern | xs:string | The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema. |
1014 | 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. |
1015
1016 Element Documentation:
1017
1018 | **Name** | **Type** | **Documentation** |
1019 | --- --| --- --| --- --|
1020 | SentinelValue | SentinelValueType | SentinelValue defines a value that has a special meaning within the text format representation of a component. |
1021
1022 **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.
1023
1024 Attributes:
1025 value
1026
1027 Content:
1028 Name+, Description
1029
1030 Attribute Documentation:
1031
1032 | **Name** | **Type** | **Documentation** |
1033 | --- --| --- --| --- --|
1034 | value | xs:anySimpleType | The sentinel value being described. |
1035
1036 Element Documentation:
1037
1038 | **Name** | **Type** | **Documentation** |
1039 | --- --| --- --| --- --|
1040 | Name | TextType | Name is a reusable element, used for providing a human-readable name for an object. |
1041 | Description | TextType | Description is a reusable element, used for providing a longer human-readable description of an object. |
1042
1043 **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.
1044
1045 Derivation:
1046 TextFormatType (restriction)
1047 BasicComponentTextFormatType
1048
1049 Attributes:
1050 textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?, isMultiLingual?
1051
1052 Content:
1053 SentinelValue
1054
1055 Attribute Documentation:
1056
1057 | **Name** | **Type** | **Documentation** |
1058 | --- --| --- --| --- --|
1059 | textType (default: String) | BasicComponentDataTy pe | 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. |
1060 | 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. |
1061 | 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. |
1062 | 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. |
1063 | 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. |
1064 | 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. |
1065 | startTime | StandardTimePeriodTy pe | 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. |
1066 | endTime | StandardTimePeriodTy pe | 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. |
1067 | minLength | xs:positiveInteger | The minLength attribute specifies the minimum and length of the value in characters. |
1068 | maxLength | xs:positiveInteger | The maxLength attribute specifies the maximum length of the value in characters. |
1069 | 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. |
1070 | 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. |
1071 | decimals | xs:positiveInteger | The decimals attribute indicates the number of characters allowed after the decimal separator. |
1072 | pattern | xs:string | The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema. |
1073 | 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. |
1074
1075 Element Documentation:
1076
1077 | **Name** | **Type** | **Documentation** |
1078 | --- --| --- --| --- --|
1079 | SentinelValue | SentinelValueType | SentinelValue defines a value that has a special meaning within the text format representation of a component. |
1080
1081 **SimpleComponentTextFormatType:** SimpleComponentTextFormatType is a restricted version of the BasicComponentTextFormatType that does not allow for multi-lingual values.
1082
1083 Derivation:
1084 TextFormatType (restriction)
1085 BasicComponentTextFormatType (restriction)
1086 SimpleComponentTextFormatType`
1087
1088 Attributes:
1089 textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?`
1090
1091 Content:
1092 SentinelValue*`
1093
1094 Attribute Documentation:
1095
1096 | **Name** | **Type** | **Documentation** |
1097 | --- --| --- --| --- --|
1098 | 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. |
1099 | 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. |
1100 | 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. |
1101 | 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. |
1102 | 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. |
1103 | 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. |
1104 | startTime | StandardTimePeriodTy pe | 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. |
1105 | endTime | StandardTimePeriodTy pe | 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. |
1106 | minLength | xs:positiveInteger | The minLength attribute specifies the minimum and length of the value in characters. |
1107 | maxLength | xs:positiveInteger | The maxLength attribute specifies the maximum length of the value in characters. |
1108 | 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. |
1109 | 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. |
1110 | decimals | xs:positiveInteger | The decimals attribute indicates the number of characters allowed after the decimal separator. |
1111 | pattern | xs:string | The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema. |
1112
1113 Element Documentation:
1114
1115 | **Name** | **Type** | **Documentation** |
1116 | --- --| --- --| --- --|
1117 | SentinelValue | SentinelValueType | SentinelValue defines a value that has a special meaning within the text format representation of a component. |
1118
1119 **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.
1120
1121 Derivation:
1122 TextFormatType (restriction)`
1123 BasicComponentTextFormatType (restriction)`
1124 SimpleComponentTextFormatType (restriction)`
1125 CodedTextFormatType`
1126
1127 Attributes:
1128 textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, pattern?`
1129
1130 Content:
1131 {Empty}`
1132
1133 Attribute Documentation:
1134
1135 | **Name** | **Type** | **Documentation** |
1136 | --- --| --- --| --- --|
1137 | 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. |
1138 | 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. |
1139 | 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. |
1140 | 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. |
1141 | 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. |
1142 | 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. |
1143 | startTime | StandardTimePeriodTy pe | 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. |
1144 | endTime | StandardTimePeriodTy pe | 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. |
1145 | minLength | xs:positiveInteger | The minLength attribute specifies the minimum and length of the value in characters. |
1146 | maxLength | xs:positiveInteger | The maxLength attribute specifies the maximum length of the value in characters. |
1147 | 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. |
1148 | 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. |
1149 | pattern | xs:string | The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema. |
1150
1151 **NonFacetedTextFormatType:** NonFacetedTextFormatType is a restricted version of the SimpleComponentTextFormatType that does not allow for any facets.
1152
1153 Derivation:
1154 TextFormatType (restriction)`
1155 BasicComponentTextFormatType (restriction)`
1156 SimpleComponentTextFormatType (restriction)`
1157 NonFacetedTextFormatType`
1158
1159 Attributes:
1160 textType?`
1161
1162 Content:
1163 {Empty}`
1164
1165 Attribute Documentation:
1166
1167 | **Name** | **Type** | **Documentation** |
1168 | --- --| --- --| --- --|
1169 | 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. |
1170
1171 **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.
1172
1173 Derivation:
1174 `TextFormatType (restriction)`
1175 `BasicComponentTextFormatType (restriction)`
1176 `SimpleComponentTextFormatType (restriction)`
1177 `TimeTextFormatType`
1178
1179 Attributes:
1180 textType?, startTime?, endTime?`
1181
1182 Content:
1183 SentinelValue*`
1184
1185 Attribute Documentation:
1186
1187 | **Name** | **Type** | **Documentation** |
1188 | --- --| --- --| --- --|
1189 | 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. |
1190 | startTime | StandardTimePeriodTy pe | 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. |
1191 | endTime | StandardTimePeriodTy pe | 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. |
1192
1193 Element Documentation:
1194
1195 | **Name** | **Type** | **Documentation** |
1196 | --- --| --- --| --- --|
1197 | SentinelValue | SentinelValueType | SentinelValue defines a value that has a special meaning within the text format representation of a component. |
1198
1199 ***CategorisationBaseType*:** CategorisationBaseType defines the base refinement of the CategorisationType. Its purpose is to retrict the urn attribute.
1200
1201 Derivation:
1202 AnnotableType`*` (extension)`
1203 *`IdentifiableType`*` (extension)`
1204 *`NameableType`*` (extension)`
1205 *`VersionableType`*` (restriction)`
1206 *`MaintainableBaseType`*` (extension)`
1207 *`MaintainableType`*` (restriction)`
1208 *`CategorisationBaseType`*
1209
1210 Attributes:
1211 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
1212
1213 Content:
1214 Annotations?, Link*, Name+, Description*`
1215
1216 Attribute Documentation:
1217
1218 | **Name** | **Type** | **Documentation** |
1219 | --- --| --- --| --- --|
1220 | id | IDType | The id is the identifier for the object. |
1221 | urn | CategorisationUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
1222 | 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. |
1223 | 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. |
1224 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
1225 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
1226 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
1227 | 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. |
1228 | 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. |
1229 | 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. |
1230 | 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’. |
1231
1232 Element Documentation:
1233
1234 | **Name** | **Type** | **Documentation** |
1235 | --- --| --- --| --- --|
1236 | 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. |
1237 | 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. |
1238 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
1239 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
1240
1241 **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.
1242
1243 Derivation:
1244 AnnotableType`*` (extension)`
1245 *`IdentifiableType`*` (extension)`
1246 *`NameableType`*` (extension)`
1247 *`VersionableType`*` (restriction)`
1248 *`MaintainableBaseType`*` (extension)`
1249 *`MaintainableType`*` (restriction)`
1250 *`CategorisationBaseType`*` (extension)`
1251 `CategorisationType`
1252
1253 Attributes:
1254 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
1255
1256 Content:
1257 Annotations?, Link*, Name+, Description*, (Source, Target)?`
1258
1259 Attribute Documentation:
1260
1261 | **Name** | **Type** | **Documentation** |
1262 | --- --| --- --| --- --|
1263 | id | IDType | The id is the identifier for the object. |
1264 | urn | CategorisationUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
1265 | 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. |
1266 | 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. |
1267 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
1268 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
1269 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
1270 | 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. |
1271 | 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. |
1272 | 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. |
1273 | 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’. |
1274
1275 Element Documentation:
1276
1277 | **Name** | **Type** | **Documentation** |
1278 | --- --| --- --| --- --|
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 | Source | UrnReferenceType | Source is a reference to an object to be categorized. |
1284 | Target | CategoryReferenceTyp e | Target is reference to the category that the referenced object is to be mapped to. |
1285
1286 **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.
1287
1288 Derivation:
1289 AnnotableType`*` (extension)`
1290 *`IdentifiableType`*` (extension)`
1291 *`NameableType`*` (extension)`
1292 *`VersionableType`*` (restriction)`
1293 *`MaintainableBaseType`*` (extension)`
1294 *`MaintainableType`*` (restriction)`
1295 *`ItemSchemeType`*` (restriction)`
1296 `CategorySchemeType`
1297
1298 Attributes:
1299 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`
1300
1301 Content:
1302 Annotations?, Link*, Name+, Description*, Category*`
1303
1304 Attribute Documentation:
1305
1306 | **Name** | **Type** | **Documentation** |
1307 | --- --| --- --| --- --|
1308 | 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). |
1309 | urn | CategorySchemeUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
1310 | 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. |
1311 | 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. |
1312 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
1313 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
1314 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
1315 | 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. |
1316 | 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. |
1317 | 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. |
1318 | 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’. |
1319 | 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. |
1320
1321 Element Documentation:
1322
1323 | **Name** | **Type** | **Documentation** |
1324 | --- --| --- --| --- --|
1325 | 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. |
1326 | 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. |
1327 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
1328 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
1329 | Category | CategoryType | Category represents a set of nested categories which describe a simple classification hierarchy. |
1330
1331 **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.
1332
1333 Derivation:
1334 AnnotableType`*` (extension)`
1335 *`IdentifiableType`*` (extension)`
1336 *`NameableType`*` (restriction)`
1337 *`ItemBaseType`*` (extension)`
1338 *`ItemType`*` (restriction)`
1339 `CategoryType`
1340
1341 Attributes:
1342 id, urn?, uri?`
1343
1344 Content:
1345 Annotations?, Link*, Name+, Description*, Category\*`
1346
1347 Attribute Documentation:
1348
1349 | **Name** | **Type** | **Documentation** |
1350 | --- --| --- --| --- --|
1351 | id | IDType | The id is the identifier for the object. |
1352 | urn | CategoryUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
1353 | 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. |
1354
1355 Element Documentation:
1356
1357 | **Name** | **Type** | **Documentation** |
1358 | --- --| --- --| --- --|
1359 | 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. |
1360 | 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. |
1361 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
1362 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
1363 | Category | CategoryType | Category represents a set of nested categories which describe a simple classification hierarchy. |
1364
1365 ***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.
1366
1367 Derivation:
1368 AnnotableType`*` (extension)`
1369 *`IdentifiableType`*` (extension)`
1370 *`NameableType`*` (extension)`
1371 *`VersionableType`*` (restriction)`
1372 *`MaintainableBaseType`*` (extension)`
1373 *`MaintainableType`*` (restriction)`
1374 *`ItemSchemeType`*` (restriction)`
1375 *`CodelistBaseType`*
1376
1377 Attributes:
1378 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`
1379
1380 Content:
1381 Annotations?, Link*, Name+, Description*, (Code | GeoFeatureSetCode | GeoGridCode)*`
1382
1383 Attribute Documentation:
1384
1385 | **Name** | **Type** | **Documentation** |
1386 | --- --| --- --| --- --|
1387 | 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). |
1388 | urn | CodelistUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
1389 | 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. |
1390 | 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. |
1391 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
1392 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
1393 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
1394 | 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. |
1395 | 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. |
1396 | 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. |
1397 | 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’. |
1398 | 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. |
1399
1400 Element Documentation:
1401
1402 | **Name** | **Type** | **Documentation** |
1403 | --- --| --- --| --- --|
1404 | 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. |
1405 | 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. |
1406 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
1407 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
1408 | 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. |
1409
1410 **CodelistType:**
1411
1412 Derivation:
1413 AnnotableType`*` (extension)`
1414 *`IdentifiableType`*` (extension)`
1415 *`NameableType`*` (extension)`
1416 *`VersionableType`*` (restriction)`
1417 *`MaintainableBaseType`*` (extension)`
1418 *`MaintainableType`*` (restriction)`
1419 *`ItemSchemeType`*` (restriction)`
1420 *`CodelistBaseType`*` (extension)`
1421 `CodelistType`
1422
1423 Attributes:
1424 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`
1425
1426 Content:
1427 Annotations?, Link*, Name+, Description*, (Code | GeoFeatureSetCode | GeoGridCode)*, CodelistExtension*`
1428
1429 Attribute Documentation:
1430
1431 | **Name** | **Type** | **Documentation** |
1432 | --- --| --- --| --- --|
1433 | 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). |
1434 | urn | CodelistUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
1435 | 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. |
1436 | 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. |
1437 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
1438 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
1439 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
1440 | 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. |
1441 | 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. |
1442 | 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. |
1443 | 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’. |
1444 | 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. |
1445
1446 Element Documentation:
1447
1448 | **Name** | **Type** | **Documentation** |
1449 | --- --| --- --| --- --|
1450 | 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. |
1451 | 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. |
1452 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
1453 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
1454 | 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 |
1455 | CodelistExtension | CodelistExtensionTyp e | 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. |
1456
1457 **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.
1458
1459 Derivation:
1460 AnnotableType`*` (extension)`
1461 *`IdentifiableType`*` (extension)`
1462 *`NameableType`*` (restriction)`
1463 *`ItemBaseType`*` (extension)`
1464 *`ItemType`*` (restriction)`
1465 `CodeType`
1466
1467 Attributes:
1468 id, urn?, uri?`
1469
1470 Content:
1471 Annotations?, Link*, Name+, Description*, Parent?`
1472
1473 Attribute Documentation:
1474
1475 | **Name** | **Type** | **Documentation** |
1476 | --- --| --- --| --- --|
1477 | id | IDType | The id is the identifier for the object. |
1478 | urn | CodeUrnType | 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
1481 Element Documentation:
1482
1483 | **Name** | **Type** | **Documentation** |
1484 | --- --| --- --| --- --|
1485 | 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. |
1486 | 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. |
1487 | 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. |
1488 | Description | TextType | Description provides a plain text, human-readable description of the code. This may be provided in multiple, parallel language-equivalent forms. |
1489 | 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. |
1490
1491 **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.
1492
1493 Attributes:
1494 prefix?`
1495
1496 Content:
1497 Codelist, (InclusiveCodeSelection | ExclusiveCodeSelection)?`
1498
1499 Attribute Documentation:
1500
1501 | **Name** | **Type** | **Documentation** |
1502 | --- --| --- --| --- --|
1503 | 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. |
1504
1505 Element Documentation:
1506
1507 | **Name** | **Type** | **Documentation** |
1508 | --- --| --- --| --- --|
1509 | Codelist | CodelistReferenceTyp e | |
1510 | InclusiveCodeSelecti on | CodeSelectionType | Selection of codes from the referenced (extended) codelist to be included in the extending codelist. |
1511 | ExclusiveCodeSelecti on | CodeSelectionType | Selection of codes from the referenced (extended) codelist to be excluded in the extending codelist. |
1512
1513 **CodeSelectionType:** CodeSelectionType defines the structure for code selection to be used as inclusive or exclusive extensions.
1514
1515 Content:
1516 MemberValue+`
1517
1518 Element Documentation:
1519
1520 | **Name** | **Type** | **Documentation** |
1521 | --- --| --- --| --- --|
1522 | 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. |
1523
1524 **MemberValueType:** Allows for a ditinct reference or a wildcard expression for selecting codes from a codelist.
1525
1526 Derivation:
1527
1528 `xs:anySimpleType (restriction)`
1529 `xs:string (restriction)`
1530 `WildcardedMemberValueType (extension)`
1531 `MemberValueType`
1532
1533 Attributes:
1534 cascadeValues?`
1535
1536 Content:
1537
1538 Attribute Documentation:
1539
1540 | **Name** | **Type** | **Documentation** |
1541 | --- --| --- --| --- --|
1542 | 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)). |
1543
1544 ***GeoCodelistBaseType*:** GeoCodelistBaseType is an abstract base refinement of a codelist that restricts the cods to be derived from the abstract GeoRefCode.
1545
1546 Derivation:
1547 AnnotableType`*` (extension)`
1548 *`IdentifiableType`*` (extension)`
1549 *`NameableType`*` (extension)`
1550 *`VersionableType`*` (restriction)`
1551 *`MaintainableBaseType`*` (extension)`
1552 *`MaintainableType`*` (restriction)`
1553 *`ItemSchemeType`*` (restriction)`
1554 *`CodelistBaseType`*` (extension)`
1555 `CodelistType (restriction)`
1556 *`GeoCodelistBaseType`*
1557
1558 Attributes:
1559 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`
1560
1561 Content:
1562 Annotations?, Link*, Name+, Description*, `*`GeoRefCode*`*`, CodelistExtension*`
1563
1564 Attribute Documentation:
1565
1566 | **Name** | **Type** | **Documentation** |
1567 | --- --| --- --| --- --|
1568 | 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). |
1569 | urn | CodelistUrnType | 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 | 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. |
1572 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
1573 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
1574 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
1575 | 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. |
1576 | 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. |
1577 | 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. |
1578 | 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’. |
1579 | 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. |
1580
1581 Element Documentation:
1582
1583 | **Name** | **Type** | **Documentation** |
1584 | --- --| --- --| --- --|
1585 | 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. |
1586 | 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. |
1587 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
1588 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
1589 | *GeoRefCode* | *GeoRefCodeType* | GeoRefCode is the abstract base from which specific types of geographic codes will be derived. |
1590 | CodelistExtension | CodelistExtensionTyp e | 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. |
1591
1592 ***GeoCodelistType*:** GeoCodelistType is an abstract refinement of a codelist from which specific types of geographic codelists will be derived.
1593
1594 Derivation:
1595 AnnotableType`*` (extension)`
1596 *`IdentifiableType`*` (extension)`
1597 *`NameableType`*` (extension)`
1598 *`VersionableType`*` (restriction)`
1599 *`MaintainableBaseType`*` (extension)`
1600 *`MaintainableType`*` (restriction)`
1601 *`ItemSchemeType`*` (restriction)`
1602 *`CodelistBaseType`*` (extension)`
1603 `CodelistType (restriction)`
1604 *`GeoCodelistBaseType`*` (extension)`
1605 *`GeoCodelistType`*
1606
1607 Attributes:
1608 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, geoType`
1609
1610 Content:
1611 Annotations?, Link*, Name+, Description*, `*`GeoRefCode*`*`, CodelistExtension*`
1612
1613 Attribute Documentation:
1614
1615 | **Name** | **Type** | **Documentation** |
1616 | --- --| --- --| --- --|
1617 | 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). |
1618 | urn | CodelistUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
1619 | 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. |
1620 | 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. |
1621 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
1622 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
1623 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
1624 | 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. |
1625 | 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. |
1626 | 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. |
1627 | 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’. |
1628 | 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. |
1629 | geoType | GeoCodelistTypeType | The type of geographic codelist. The will be refined and provided a fixed value in the specific geographic codelist type implementations. |
1630
1631 Element Documentation:
1632
1633 | **Name** | **Type** | **Documentation** |
1634 | --- --| --- --| --- --|
1635 | 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. |
1636 | 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. |
1637 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
1638 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
1639 | *GeoRefCode* | *GeoRefCodeType* | GeoRefCode is the abstract base from which specific types of geographic codes will be derived. |
1640 | CodelistExtension | CodelistExtensionTyp e | 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. |
1641
1642 ***GeoRefCodeType*:** GeoRefCodeType is the abstract base type defining the structure of geographic codes.
1643
1644 Derivation:
1645 AnnotableType`*` (extension)`
1646 *`IdentifiableType`*` (extension)`
1647 *`NameableType`*` (restriction)`
1648 *`ItemBaseType`*` (extension)`
1649 *`ItemType`*` (restriction)`
1650 `CodeType (extension)`
1651 *`GeoRefCodeType`*
1652
1653 Attributes:
1654 id, urn?, uri?`
1655
1656 Content:
1657 Annotations?, Link*, Name+, Description*, Parent?`
1658
1659 Attribute Documentation:
1660
1661 | **Name** | **Type** | **Documentation** |
1662 | --- --| --- --| --- --|
1663 | id | IDType | The id is the identifier for the object. |
1664 | urn | CodeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
1665 | 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. |
1666
1667 Element Documentation:
1668
1669 | **Name** | **Type** | **Documentation** |
1670 | --- --| --- --| --- --|
1671 | 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. |
1672 | 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. |
1673 | 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. |
1674 | Description | TextType | Description provides a plain text, human-readable description of the code. This may be provided in multiple, parallel language-equivalent forms. |
1675 | 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. |
1676
1677 **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.
1678
1679 Derivation:
1680 AnnotableType`*` (extension)`
1681 *`IdentifiableType`*` (extension)`
1682 *`NameableType`*` (extension)`
1683 *`VersionableType`*` (restriction)`
1684 *`MaintainableBaseType`*` (extension)`
1685 *`MaintainableType`*` (restriction)`
1686 *`ItemSchemeType`*` (restriction)`
1687 *`CodelistBaseType`*` (extension)`
1688 `CodelistType (restriction)`
1689 *`GeoCodelistBaseType`*` (extension)`
1690 *`GeoCodelistType`*` (restriction)`
1691 `GeographicCodelistType`
1692
1693 Attributes:
1694 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, geoType`
1695
1696 Content:
1697 Annotations?, Link*, Name+, Description*, GeoFeatureSetCode\*, CodelistExtension*`
1698
1699 Attribute Documentation:
1700
1701 | **Name** | **Type** | **Documentation** |
1702 | --- --| --- --| --- --|
1703 | 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). |
1704 | urn | CodelistUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
1705 | 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. |
1706 | 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. |
1707 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
1708 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
1709 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
1710 | 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. |
1711 | 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. |
1712 | 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. |
1713 | 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’. |
1714 | 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. |
1715 | 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. |
1716
1717 Element Documentation:
1718
1719 | **Name** | **Type** | **Documentation** |
1720 | --- --| --- --| --- --|
1721 | 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. |
1722 | 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. |
1723 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
1724 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
1725 | GeoFeatureSetCode | GeoFeatureSetCodeTyp e | 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. |
1726 | CodelistExtension | CodelistExtensionTyp e | 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. |
1727
1728 **GeoFeatureSetCodeType:** GeoFeatureSetCodeType defines the structure of a geogrphic code.
1729
1730 Derivation:
1731 AnnotableType`*` (extension)`
1732 *`IdentifiableType`*` (extension)`
1733 *`NameableType`*` (restriction)`
1734 *`ItemBaseType`*` (extension)`
1735 *`ItemType`*` (restriction)`
1736 `CodeType (extension)`
1737 *`GeoRefCodeType`*` (extension)`
1738 `GeoFeatureSetCodeType`
1739
1740 Attributes:
1741 id, urn?, uri?, value`
1742
1743 Content:
1744 Annotations?, Link*, Name+, Description*, Parent?`
1745
1746 Attribute Documentation:
1747
1748 | **Name** | **Type** | **Documentation** |
1749 | --- --| --- --| --- --|
1750 | id | IDType | The id is the identifier for the object. |
1751 | urn | CodeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
1752 | 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. |
1753 | 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). |
1754
1755 Element Documentation:
1756
1757 | **Name** | **Type** | **Documentation** |
1758 | --- --| --- --| --- --|
1759 | 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. |
1760 | 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. |
1761 | 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. |
1762 | Description | TextType | Description provides a plain text, human-readable description of the code. This may be provided in multiple, parallel language-equivalent forms. |
1763 | 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. |
1764
1765 ***GeoGridCodelistBaseType*:** GeoGridCodelistBaseType is the abstract base refinement for a geographic grid codelist.
1766
1767 Derivation:
1768 AnnotableType`*` (extension)`
1769 *`IdentifiableType`*` (extension)`
1770 *`NameableType`*` (extension)`
1771 *`VersionableType`*` (restriction)`
1772 *`MaintainableBaseType`*` (extension)`
1773 *`MaintainableType`*` (restriction)`
1774 *`ItemSchemeType`*` (restriction)`
1775 *`CodelistBaseType`*` (extension)`
1776 `CodelistType (restriction)`
1777 *`GeoCodelistBaseType`*` (extension)`
1778 *`GeoCodelistType`*` (restriction)` *`GeoGridCodelistBaseType`*
1779
1780 Attributes:
1781 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, geoType`
1782
1783 Content:
1784 Annotations?, Link*, Name+, Description*, GeoGridCode*, CodelistExtension*`
1785
1786 Attribute Documentation:
1787
1788 | **Name** | **Type** | **Documentation** |
1789 | --- --| --- --| --- --|
1790 | 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). |
1791 | urn | CodelistUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
1792 | 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. |
1793 | 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. |
1794 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
1795 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
1796 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
1797 | 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. |
1798 | 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. |
1799 | 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. |
1800 | 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’. |
1801 | 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. |
1802 | 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. |
1803
1804 Element Documentation:
1805
1806 | **Name** | **Type** | **Documentation** |
1807 | --- --| --- --| --- --|
1808 | 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. |
1809 | 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. |
1810 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
1811 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
1812 | GeoGridCode | GeoGridCodeType | GeoGridCode is a code the represents a geographic grid cell that belongs to a specific grid definition. |
1813 | CodelistExtension | CodelistExtensionTyp e | 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. |
1814
1815 **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.
1816
1817 Derivation:
1818 AnnotableType`*` (extension)`
1819 *`IdentifiableType`*` (extension)`
1820 *`NameableType`*` (extension)`
1821 *`VersionableType`*` (restriction)`
1822 *`MaintainableBaseType`*` (extension)`
1823 *`MaintainableType`*` (restriction)`
1824 *`ItemSchemeType`*` (restriction)`
1825 *`CodelistBaseType`*` (extension)`
1826 `CodelistType (restriction)`
1827 *`GeoCodelistBaseType`*` (extension)`
1828 *`GeoCodelistType`*` (restriction)` *`GeoGridCodelistBaseType`*` (extension)`
1829 `GeoGridCodelistType`
1830
1831 Attributes:
1832 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, geoType`
1833
1834 Content:
1835 Annotations?, Link*, Name+, Description*, GeoGridCode*, CodelistExtension*, GridDefinition`
1836
1837 Attribute Documentation:
1838
1839 | **Name** | **Type** | **Documentation** |
1840 | --- --| --- --| --- --|
1841 | 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). |
1842 | urn | CodelistUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
1843 | 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. |
1844 | 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. |
1845 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
1846 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
1847 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
1848 | 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. |
1849 | 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. |
1850 | 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. |
1851 | 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’. |
1852 | 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. |
1853 | 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. |
1854
1855 Element Documentation:
1856
1857 | **Name** | **Type** | **Documentation** |
1858 | --- --| --- --| --- --|
1859 | 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. |
1860 | 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. |
1861 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
1862 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
1863 | GeoGridCode | GeoGridCodeType | GeoGridCode is a code the represents a geographic grid cell that belongs to a specific grid definition. |
1864 | CodelistExtension | CodelistExtensionTyp e | 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. |
1865 | GridDefinition | xs:string | Contains a regular expression string corresponding to the grid definition for the GeoGrid Codelist. |
1866
1867 **GeoGridCodeType:** GeoGridCodeType defines the structure of a geographic grid cell.
1868
1869 Derivation:
1870 AnnotableType`*` (extension)`
1871 *`IdentifiableType`*` (extension)`
1872 *`NameableType`*` (restriction)`
1873 *`ItemBaseType`*` (extension)`
1874 *`ItemType`*` (restriction)`
1875 `CodeType (extension)`
1876 *`GeoRefCodeType`*` (extension)`
1877 `GeoGridCodeType`
1878
1879 Attributes:
1880 id, urn?, uri?`
1881
1882 Content:
1883 Annotations?, Link*, Name+, Description*, Parent?, GeoCell`
1884
1885 Attribute Documentation:
1886
1887 | **Name** | **Type** | **Documentation** |
1888 | --- --| --- --| --- --|
1889 | id | IDType | The id is the identifier for the object. |
1890 | urn | CodeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
1891 | 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. |
1892
1893 Element Documentation:
1894
1895 | **Name** | **Type** | **Documentation** |
1896 | --- --| --- --| --- --|
1897 | 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. |
1898 | 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. |
1899 | 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. |
1900 | Description | TextType | Description provides a plain text, human-readable description of the code. This may be provided in multiple, parallel language-equivalent forms. |
1901 | 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. |
1902 | GeoCell | xs:string | The value used to assign the Code to one cell in the grid. |
1903
1904 ***ValueListBaseType*:** ValueListBaseType defines the base refinement of the ValueListType. Its purpose is to retrict the urn attribute.
1905
1906 Derivation:
1907 AnnotableType`*` (extension)`
1908 *`IdentifiableType`*` (extension)`
1909 *`NameableType`*` (extension)`
1910 *`VersionableType`*` (restriction)`
1911 *`MaintainableBaseType`*` (extension)`
1912 *`MaintainableType`*` (restriction)`
1913 *`ValueListBaseType`*
1914
1915 Attributes:
1916 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
1917
1918 Content:
1919
1920 `Annotations?, Link*, Name+, Description*`
1921
1922 Attribute Documentation:
1923
1924 | **Name** | **Type** | **Documentation** |
1925 | --- --| --- --| --- --|
1926 | id | IDType | The id is the identifier for the object. |
1927 | urn | ValueListUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
1928 | 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. |
1929 | 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. |
1930 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
1931 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
1932 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
1933 | 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. |
1934 | 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. |
1935 | 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. |
1936 | 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’. |
1937
1938 Element Documentation:
1939
1940 | **Name** | **Type** | **Documentation** |
1941 | --- --| --- --| --- --|
1942 | 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. |
1943 | 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. |
1944 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
1945 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
1946
1947 **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).
1948
1949 Derivation:
1950 AnnotableType`*` (extension)`
1951 *`IdentifiableType`*` (extension)`
1952 *`NameableType`*` (extension)`
1953 *`VersionableType`*` (restriction)`
1954 *`MaintainableBaseType`*` (extension)`
1955 *`MaintainableType`*` (restriction)`
1956 *`ValueListBaseType`*` (extension)`
1957 `ValueListType`
1958
1959 Attributes:
1960 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
1961
1962 Content:
1963 Annotations?, Link*, Name+, Description*, ValueItem*`
1964
1965 Attribute Documentation:
1966
1967 | **Name** | **Type** | **Documentation** |
1968 | --- --| --- --| --- --|
1969 | id | IDType | The id is the identifier for the object. |
1970 | urn | ValueListUrnType | 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 | 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. |
1973 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
1974 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
1975 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
1976 | 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. |
1977 | 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. |
1978 | 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. |
1979 | 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’. |
1980
1981 Element Documentation:
1982
1983 | **Name** | **Type** | **Documentation** |
1984 | --- --| --- --| --- --|
1985 | 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. |
1986 | 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. |
1987 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
1988 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
1989 | ValueItem | ValueItemType | |
1990
1991 **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).
1992
1993 Derivation:
1994 AnnotableType`*` (extension)`
1995 `ValueItemType`
1996
1997 Attributes:
1998 id`
1999
2000 Content:
2001 Annotations?, Name*, Description*`
2002
2003 Attribute Documentation:
2004
2005 | **Name** | **Type** | **Documentation** |
2006 | --- --| --- --| --- --|
2007 | id | xs:string | |
2008
2009 Element Documentation:
2010
2011 | **Name** | **Type** | **Documentation** |
2012 | --- --| --- --| --- --|
2013 | 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. |
2014 | Name | TextType | Name is a reusable element, used for providing a human-readable name for an object. |
2015 | Description | TextType | Description is a reusable element, used for providing a longer human-readable description of an object. |
2016
2017 **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.
2018
2019 Derivation:
2020 AnnotableType`*` (extension)`
2021 *`IdentifiableType`*` (extension)`
2022 *`NameableType`*` (extension)`
2023 *`VersionableType`*` (restriction)`
2024 *`MaintainableBaseType`*` (extension)`
2025 *`MaintainableType`*` (restriction)`
2026 *`ItemSchemeType`*` (restriction)`
2027 `ConceptSchemeType`
2028
2029 Attributes:
2030 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`
2031
2032 Content:
2033 Annotations?, Link*, Name+, Description*, Concept*`
2034
2035 Attribute Documentation:
2036
2037 | **Name** | **Type** | **Documentation** |
2038 | --- --| --- --| --- --|
2039 | 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). |
2040 | urn | ConceptSchemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
2041 | 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. |
2042 | 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. |
2043 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
2044 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
2045 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
2046 | 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. |
2047 | 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. |
2048 | 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. |
2049 | 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’. |
2050 | 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. |
2051
2052 Element Documentation:
2053
2054 | **Name** | **Type** | **Documentation** |
2055 | --- --| --- --| --- --|
2056 | 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. |
2057 | 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. |
2058 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
2059 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
2060 | Concept | ConceptType | Concept describes the details of a concept within a concept scheme. |
2061
2062 ***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.
2063
2064 Derivation:
2065 AnnotableType`*` (extension)`
2066 *`IdentifiableType`*` (extension)`
2067 *`NameableType`*` (restriction)`
2068 *`ItemBaseType`*` (extension)`
2069 *`ItemType`*` (restriction)`
2070 *`ConceptBaseType`*
2071
2072 Attributes:
2073 id, urn?, uri?`
2074
2075 Content:
2076 Annotations?, Link*, Name+, Description*, Parent?`
2077
2078 Attribute Documentation:
2079
2080 | **Name** | **Type** | **Documentation** |
2081 | --- --| --- --| --- --|
2082 | 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). |
2083 | urn | ConceptUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
2084 | 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. |
2085
2086 Element Documentation:
2087
2088 | **Name** | **Type** | **Documentation** |
2089 | --- --| --- --| --- --|
2090 | 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. |
2091 | 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. |
2092 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
2093 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
2094 | 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. |
2095
2096 **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).
2097
2098 Derivation:
2099 AnnotableType`*` (extension)`
2100 *`IdentifiableType`*` (extension)`
2101 *`NameableType`*` (restriction)`
2102 *`ItemBaseType`*` (extension)`
2103 *`ItemType`*` (restriction)`
2104 *`ConceptBaseType`*` (extension)`
2105 `ConceptType`
2106
2107 Attributes:
2108 id, urn?, uri?`
2109
2110 Content:
2111 Annotations?, Link*, Name+, Description*, Parent?, CoreRepresentation?, ISOConceptReference?`
2112
2113 Attribute Documentation:
2114
2115 | **Name** | **Type** | **Documentation** |
2116 | --- --| --- --| --- --|
2117 | 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). |
2118 | urn | ConceptUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
2119 | 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. |
2120
2121 Element Documentation:
2122
2123 | **Name** | **Type** | **Documentation** |
2124 | --- --| --- --| --- --|
2125 | 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. |
2126 | 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. |
2127 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
2128 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
2129 | 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. |
2130 | CoreRepresentation | ConceptRepresentatio n | |
2131 | ISOConceptReference | ISOConceptReferenceT ype | Provides a reference to an ISO 11179 concept. |
2132
2133 **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.
2134
2135 Derivation:
2136 RepresentationType (restriction)
2137 ConceptRepresentation
2138
2139 Attributes:
2140 minOccurs?, maxOccurs?`
2141
2142 Content:
2143 (TextFormat | (Enumeration, EnumerationFormat?))`
2144
2145 Attribute Documentation:
2146
2147 | **Name** | **Type** | **Documentation** |
2148 | --- --| --- --| --- --|
2149 | minOccurs (default: 1) | xs: nonNegativeInteger | The minOccurs attribute indicates the minimum number of value that must be reported for the component. |
2150 | maxOccurs | OccurenceType | The maxOccurs attribute indicates the maximum number of values that can be reported for the component. |
2151
2152 Element Documentation:
2153
2154 | **Name** | **Type** | **Documentation** |
2155 | --- --| --- --| --- --|
2156 | TextFormat | BasicComponentTextFo rmatType | TextFormat describes an uncoded textual format. |
2157 | Enumeration | AnyCodelistReference Type | Enumeration references a codelist which enumerates the possible values that can be used as the representation of this concept. |
2158 | EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |
2159
2160 **ISOConceptReferenceType:** ISOConceptReferenceType provides a reference to and ISO 11179 concept.
2161
2162 Content:
2163 ConceptAgency, ConceptSchemeID, ConceptID`
2164
2165 Element Documentation:
2166
2167 | **Name** | **Type** | **Documentation** |
2168 | --- --| --- --| --- --|
2169 | ConceptAgency | xs:string | |
2170 | ConceptSchemeID | xs:string | |
2171 | ConceptID | xs:string | |
2172
2173 ***ConstraintBaseType*:** ConstraintBaseType is an abstract base type that forms the basis of the main abstract ConstraintType. It requires that a name be provided.
2174
2175 Derivation:
2176
2177 *`AnnotableType`*` (extension)`
2178 *`IdentifiableType`*` (extension)`
2179 *`NameableType`*` (extension)`
2180 *`VersionableType`*` (restriction)`
2181 *`MaintainableBaseType`*` (extension)`
2182 *`MaintainableType`*` (restriction)`
2183 *`ConstraintBaseType`*
2184
2185 Attributes:
2186 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
2187
2188 Content:
2189 Annotations?, Link*, Name+, Description*`
2190
2191 Attribute Documentation:
2192
2193 | **Name** | **Type** | **Documentation** |
2194 | --- --| --- --| --- --|
2195 | id | IDType | The id is the identifier for the object. |
2196 | urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
2197 | 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. |
2198 | 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. |
2199 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
2200 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
2201 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
2202 | 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. |
2203 | 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. |
2204 | 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. |
2205 | 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’. |
2206
2207 Element Documentation:
2208
2209 | **Name** | **Type** | **Documentation** |
2210 | --- --| --- --| --- --|
2211 | 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. |
2212 | 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. |
2213 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
2214 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
2215
2216 ***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.
2217
2218 Derivation:
2219
2220 *`AnnotableType`*` (extension)`
2221 *`IdentifiableType`*` (extension)`
2222 *`NameableType`*` (extension)`
2223 *`VersionableType`*` (restriction)`
2224 *`MaintainableBaseType`*` (extension)`
2225 *`MaintainableType`*` (restriction)`
2226 *`ConstraintBaseType`*` (extension)`
2227 *`ConstraintType`*
2228
2229 Attributes:
2230 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role
2231
2232 Content:
2233 Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?
2234
2235 Attribute Documentation:
2236
2237 | **Name** | **Type** | **Documentation** |
2238 | --- --| --- --| --- --|
2239 | id | IDType | The id is the identifier for the object. |
2240 | urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
2241 | 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. |
2242 | 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. |
2243 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
2244 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
2245 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
2246 | 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. |
2247 | 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. |
2248 | 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. |
2249 | 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’. |
2250 | 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. |
2251
2252 Element Documentation:
2253
2254 | **Name** | **Type** | **Documentation** |
2255 | --- --| --- --| --- --|
2256 | 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. |
2257 | 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. |
2258 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
2259 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
2260 | ConstraintAttachment | *ConstraintAttachment Type* | ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. |
2261 | ReleaseCalendar | ReleaseCalendarType | ReleaseCalendar defines dates on which the constrained data is to be made available. |
2262
2263 ***DataConstraintBaseType*:** DataConstraintBaseType is an abstract base refinement of ConstraintType. The constraint attachment is restricted to constrainable artefacts related to data.
2264
2265 Derivation:
2266
2267 *`AnnotableType`*` (extension)`
2268 *`IdentifiableType`*` (extension)`
2269 *`NameableType`*` (extension)`
2270 *`VersionableType`*` (restriction)`
2271 *`MaintainableBaseType`*` (extension)`
2272 *`MaintainableType`*` (restriction)`
2273 *`ConstraintBaseType`*` (extension)`
2274 *`ConstraintType`*` (restriction)`
2275 *`DataConstraintBaseType`*
2276
2277 Attributes:
2278 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role
2279
2280 Content:
2281 Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?
2282
2283 Attribute Documentation:
2284
2285 | **Name** | **Type** | **Documentation** |
2286 | --- --| --- --| --- --|
2287 | id | IDType | The id is the identifier for the object. |
2288 | urn | DataConstraintUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
2289 | 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. |
2290 | 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. |
2291 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
2292 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
2293 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
2294 | 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. |
2295 | 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. |
2296 | 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. |
2297 | 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’. |
2298 | 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. |
2299
2300 Element Documentation:
2301
2302 | **Name** | **Type** | **Documentation** |
2303 | --- --| --- --| --- --|
2304 | 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. |
2305 | 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. |
2306 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
2307 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
2308 | ConstraintAttachment | DataConstraintAttach mentType | ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. |
2309 | ReleaseCalendar | ReleaseCalendarType | ReleaseCalendar defines dates on which the constrained data is to be made available. |
2310
2311 **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").
2312
2313 Derivation:
2314
2315 *`AnnotableType`*` (extension)`
2316 *`IdentifiableType`*` (extension)`
2317 *`NameableType`*` (extension)`
2318 *`VersionableType`*` (restriction)`
2319 *`MaintainableBaseType`*` (extension)`
2320 *`MaintainableType`*` (restriction)`
2321 *`ConstraintBaseType`*` (extension)`
2322 *`ConstraintType`*` (restriction)`
2323 *`DataConstraintBaseType`*` (extension)`
2324 `DataConstraintType`
2325
2326 Attributes:
2327 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role
2328
2329 Content:
2330 Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?, DataKeySet*, CubeRegion[0..2]
2331
2332 Attribute Documentation:
2333
2334 | **Name** | **Type** | **Documentation** |
2335 | --- --| --- --| --- --|
2336 | id | IDType | The id is the identifier for the object. |
2337 | urn | DataConstraintUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
2338 | 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. |
2339 | 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. |
2340 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
2341 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
2342 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
2343 | 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. |
2344 | 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. |
2345 | 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. |
2346 | 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’. |
2347 | 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. |
2348
2349 Element Documentation:
2350
2351 | **Name** | **Type** | **Documentation** |
2352 | --- --| --- --| --- --|
2353 | 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. |
2354 | 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. |
2355 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
2356 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
2357 | ConstraintAttachment | DataConstraintAttach mentType | ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. |
2358 | ReleaseCalendar | ReleaseCalendarType | ReleaseCalendar defines dates on which the constrained data is to be made available. |
2359 | DataKeySet | DataKeySetType | DataKeySet defines a full, distinct set of dimension values and the attribute values associated with the key. |
2360 | 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. |
2361
2362 ***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".
2363
2364 Derivation:
2365
2366 *`AnnotableType`*` (extension)`
2367 *`IdentifiableType`*` (extension)`
2368 *`NameableType`*` (extension)`
2369 *`VersionableType`*` (restriction)`
2370 *`MaintainableBaseType`*` (extension)`
2371 *`MaintainableType`*` (restriction)`
2372 *`ConstraintBaseType`*` (extension)`
2373 *`ConstraintType`*` (restriction)`
2374 *`MetadataConstraintBaseType`*
2375
2376 Attributes:
2377 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role
2378
2379 Content:
2380 Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?
2381
2382 Attribute Documentation:
2383
2384 | **Name** | **Type** | **Documentation** |
2385 | --- --| --- --| --- --|
2386 | id | IDType | The id is the identifier for the object. |
2387 | urn | MetadataConstraintUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
2388 | 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. |
2389 | 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. |
2390 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
2391 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
2392 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
2393 | 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. |
2394 | 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. |
2395 | 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. |
2396 | 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’. |
2397 | 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. |
2398
2399 Element Documentation:
2400
2401 | **Name** | **Type** | **Documentation** |
2402 | --- --| --- --| --- --|
2403 | 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. |
2404 | 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. |
2405 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
2406 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
2407 | ConstraintAttachment | MetadataConstraintAt tachmentType | ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. |
2408 | ReleaseCalendar | ReleaseCalendarType | ReleaseCalendar defines dates on which the constrained data is to be made available. |
2409
2410 **MetadataConstraintType:** MetadataConstraintType defines the structure of a metadata constraint. A metadata constraint can specify allowed attribute values for metadata described by the constrained artefact.
2411
2412 Derivation:
2413
2414 *`AnnotableType`*` (extension)`
2415 *`IdentifiableType`*` (extension)`
2416 *`NameableType`*` (extension)`
2417 *`VersionableType`*` (restriction)`
2418 *`MaintainableBaseType`*` (extension)`
2419 *`MaintainableType`*` (restriction)`
2420 *`ConstraintBaseType`*` (extension)`
2421 *`ConstraintType`*` (restriction)`
2422 *`MetadataConstraintBaseType`*` (extension)`
2423 `MetadataConstraintType`
2424
2425 Attributes:
2426 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role
2427
2428 Content:
2429 Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?, MetadataTargetRegion[0..2]
2430
2431 Attribute Documentation:
2432
2433 | **Name** | **Type** | **Documentation** |
2434 | --- --| --- --| --- --|
2435 | id | IDType | The id is the identifier for the object. |
2436 | urn | MetadataConstraintUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
2437 | 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. |
2438 | 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. |
2439 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
2440 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
2441 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
2442 | 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. |
2443 | 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. |
2444 | 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. |
2445 | 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’. |
2446 | 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. |
2447
2448 Element Documentation:
2449
2450 | **Name** | **Type** | **Documentation** |
2451 | --- --| --- --| --- --|
2452 | 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. |
2453 | 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. |
2454 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
2455 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
2456 | ConstraintAttachment | MetadataConstraintAt tachmentType | ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. |
2457 | ReleaseCalendar | ReleaseCalendarType | ReleaseCalendar defines dates on which the constrained data is to be made available. |
2458 | MetadataTargetRegion | MetadataTargetRegion Type | MetadataTargetRegion describes the values allowed for metadata attributes. |
2459
2460 **ReleaseCalendarType:** ReleaseCalendarType describes information about the timing of releases of the constrained data. All of these values use the standard "P7D" - style format.
2461
2462 Content:
2463 Periodicity, Offset, Tolerance
2464
2465 Element Documentation:
2466
2467 | **Name** | **Type** | **Documentation** |
2468 | --- --| --- --| --- --|
2469 | Periodicity | xs:string | Periodicity is the period between releases of the data set. |
2470 | Offset | xs:string | Offset is the interval between January first and the first release of data within the year. |
2471 | Tolerance | xs:string | Tolerance is the period after which the release of data may be deemed late. |
2472
2473 **DataKeySetType:** DataKeySetType defines a collection of full or partial data keys (dimension values).
2474
2475 Attributes:
2476 isIncluded
2477
2478 Content:
2479 Key+
2480
2481 Attribute Documentation:
2482
2483 | **Name** | **Type** | **Documentation** |
2484 | --- --| --- --| --- --|
2485 | isIncluded | xs:boolean | The isIncluded attribute indicates whether the keys defined in this key set are inclusive or exclusive to the constraint. |
2486
2487 Element Documentation:
2488
2489 | **Name** | **Type** | **Documentation** |
2490 | --- --| --- --| --- --|
2491 | Key | DataKeyType | Key contains a set of dimension values which identify a full set of data. |
2492
2493 ***ConstraintAttachmentType*:** ConstraintAttachmentType describes a collection of references to constrainable artefacts.
2494
2495 Content:
2496 (DataProvider | MetadataProvider | MetadataSet+ | SimpleDataSource+ | (DataStructure+, QueryableDataSource*) | (MetadataStructure+, QueryableDataSource*) | (Dataflow+, QueryableDataSource*) | (Metadataflow+, QueryableDataSource*) | (ProvisionAgreement+, QueryableDataSource*) | (MetadataProvisionAgreement+, QueryableDataSource*))
2497
2498 Element Documentation:
2499
2500 | **Name** | **Type** | **Documentation** |
2501 | --- --| --- --| --- --|
2502 | 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. |
2503 | MetadataProvider | MetadataProviderRefe renceType | 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. |
2504 | MetadataSet | MetadataSetReference Type | 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. |
2505 | SimpleDataSource | xs:anyURI | SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message. |
2506 | DataStructure | DataStructureReferen ceType | 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. |
2507 | QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |
2508 | MetadataStructure | MetadataStructureRef erenceType | 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. |
2509 | QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |
2510 | Dataflow | DataflowReferenceTyp e | 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. |
2511 | QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |
2512 | Metadataflow | MetadataflowReferenc eType | Metadataflow is reference to a metadata flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one metadataflow, and the metadataflows do not necessarily have to be usages of the same metadata structure. However, a constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached. |
2513 | QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |
2514 | ProvisionAgreement | ProvisionAgreementRe ferenceType | 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. |
2515 | QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |
2516 | MetadataProvisionAgr eement | MetadataProvisionAgr eementReferenceType | 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. |
2517 | QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |
2518
2519 **DataConstraintAttachmentType:** DataConstraintAttachmentType restricts the base ConstraintAttachmentType to only allow artefacts related to data.
2520
2521 Derivation:
2522
2523 *`ConstraintAttachmentType`*` (restriction)`
2524 `DataConstraintAttachmentType`
2525
2526 Content:
2527 (DataProvider | SimpleDataSource+ | (DataStructure+, QueryableDataSource*) | (Dataflow+, QueryableDataSource*) | (ProvisionAgreement+, QueryableDataSource*))
2528
2529 Element Documentation:
2530
2531 | **Name** | **Type** | **Documentation** |
2532 | --- --| --- --| --- --|
2533 | 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. |
2534 | SimpleDataSource | xs:anyURI | SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message. |
2535 | DataStructure | DataStructureReferen ceType | 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. |
2536 | QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |
2537 | Dataflow | DataflowReferenceTyp e | 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. |
2538 | QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |
2539 | ProvisionAgreement | ProvisionAgreementRe ferenceType | 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. |
2540 | QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |
2541
2542 **MetadataConstraintAttachmentType:** MetadataConstraintAttachmentType restricts the base ConstraintAttachmentType to only allow artefacts related to metadata.
2543
2544 Derivation:
2545
2546 ConstraintAttachmentType (restriction)
2547 `MetadataConstraintAttachmentType`
2548
2549 Content:
2550 (MetadataProvider | MetadataSet+ | SimpleDataSource+ | (MetadataStructure+, QueryableDataSource*) | (Metadataflow+, QueryableDataSource*) | (MetadataProvisionAgreement+, QueryableDataSource*))
2551
2552 Element Documentation:
2553
2554 | **Name** | **Type** | **Documentation** |
2555 | --- --| --- --| --- --|
2556 | MetadataProvider | MetadataProviderRefe renceType | 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. |
2557 | MetadataSet | MetadataSetReference Type | 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. |
2558 | SimpleDataSource | xs:anyURI | SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message. |
2559 | MetadataStructure | MetadataStructureRef erenceType | 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. |
2560 | QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |
2561 | Metadataflow | MetadataflowReferenc eType | Metadataflow is reference to a metadata flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one metadataflow, and the metadataflows do not necessarily have to be usages of the same metadata structure. However, a constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached. |
2562 | QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |
2563 | MetadataProvisionAgr eement | MetadataProvisionAgr eementReferenceType | 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. |
2564 | QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |
2565
2566 ***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.
2567
2568 Derivation:
2569
2570 *`AnnotableType`*` (extension)`
2571 *`RegionType`*
2572
2573 Attributes:
2574
2575 `include?, validFrom?, validTo?`
2576
2577 Content:
2578
2579 `Annotations?, KeyValue*, Component*`
2580
2581 Attribute Documentation:
2582
2583 | **Name** | **Type** | **Documentation** |
2584 | --- --| --- --| --- --|
2585 | 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. |
2586 | validFrom | StandardTimePeriodTy pe | |
2587 | validTo | StandardTimePeriodTy pe | |
2588
2589 Element Documentation:
2590
2591 | **Name** | **Type** | **Documentation** |
2592 | --- --| --- --| --- --|
2593 | 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. |
2594 | 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. |
2595 | 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. |
2596
2597 ***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.
2598
2599 Attributes:
2600
2601 `id, include?, removePrefix?, validFrom?, validTo?`
2602
2603 Content:
2604
2605 `(Value+ | TimeRange)?`
2606
2607 Attribute Documentation:
2608
2609 | **Name** | **Type** | **Documentation** |
2610 | --- --| --- --| --- --|
2611 | 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. |
2612 | 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. |
2613 | removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |
2614 | validFrom | StandardTimePeriodTy pe | |
2615 | validTo | StandardTimePeriodTy pe | |
2616
2617 Element Documentation:
2618
2619 | **Name** | **Type** | **Documentation** |
2620 | --- --| --- --| --- --|
2621 | Value | SimpleComponentValue Type | 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. |
2622 | 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). |
2623
2624 **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.
2625
2626 Derivation:
2627
2628 *`AnnotableType`*` (extension)`
2629 *`RegionType`* `(restriction)`
2630 `DataKeyType`
2631
2632 Attributes:
2633
2634 `include?, validFrom?, validTo?`
2635
2636 Content:
2637
2638 `Annotations?, KeyValue*, Component*`
2639
2640 Attribute Documentation:
2641
2642 | **Name** | **Type** | **Documentation** |
2643 | --- --| --- --| --- --|
2644 | 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. |
2645 | validFrom | StandardTimePeriodTy pe | |
2646 | validTo | StandardTimePeriodTy pe | |
2647
2648 Element Documentation:
2649
2650 | **Name** | **Type** | **Documentation** |
2651 | --- --| --- --| --- --|
2652 | 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. |
2653 | 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. |
2654 | Component | DataComponentValueSe tType | 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. |
2655
2656 **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.
2657
2658 Derivation:
2659
2660 *`MemberSelectionType`*` (restriction)`
2661 `DataKeyValueType`
2662
2663 Attributes:
2664
2665 `id, include?, removePrefix?`
2666
2667 Content:
2668
2669 `Value`
2670
2671 Attribute Documentation:
2672
2673 | **Name** | **Type** | **Documentation** |
2674 | --- --| --- --| --- --|
2675 | 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. |
2676 | 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. |
2677 | removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |
2678
2679 Element Documentation:
2680
2681 | **Name** | **Type** | **Documentation** |
2682 | --- --| --- --| --- --|
2683 | 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. |
2684
2685 **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.
2686
2687 Derivation:
2688
2689 *`MemberSelectionType`*` (restriction)`
2690 `DataComponentValueSetType`
2691
2692 Attributes:
2693
2694 `id, include?, removePrefix?`
2695
2696 Content:
2697
2698 `(Value+ | TimeRange)?`
2699
2700 Attribute Documentation:
2701
2702 | **Name** | **Type** | **Documentation** |
2703 | --- --| --- --| --- --|
2704 | 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. |
2705 | 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. |
2706 | removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |
2707
2708 Element Documentation:
2709
2710 | **Name** | **Type** | **Documentation** |
2711 | --- --| --- --| --- --|
2712 | 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. |
2713 | 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). |
2714
2715 **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.
2716
2717 Derivation:
2718
2719 *`AnnotableType`*` (extension)`
2720 *`RegionType`* `(restriction)`
2721 `CubeRegionType`
2722
2723 Attributes:
2724
2725 `include?`
2726
2727 Content:
2728
2729 `Annotations?, KeyValue*, Component*`
2730
2731 Attribute Documentation:
2732
2733 | **Name** | **Type** | **Documentation** |
2734 | --- --| --- --| --- --|
2735 | 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. |
2736
2737 Element Documentation:
2738
2739 | **Name** | **Type** | **Documentation** |
2740 | --- --| --- --| --- --|
2741 | 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. |
2742 | 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. |
2743 | Component | ComponentValueSetTyp e | 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. |
2744
2745 **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.
2746
2747 Derivation:
2748
2749 *`AnnotableType`*` (extension)`
2750 *`RegionType`* `(restriction)`
2751 `MetadataTargetRegionType`
2752
2753 Attributes:
2754
2755 `include?, validFrom?, validTo?`
2756
2757 Content:
2758
2759 `Component*`
2760
2761 Attribute Documentation:
2762
2763 | **Name** | **Type** | **Documentation** |
2764 | --- --| --- --| --- --|
2765 | 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. |
2766 | validFrom | StandardTimePeriodTy pe | |
2767 | validTo | StandardTimePeriodTy pe | |
2768
2769 Element Documentation:
2770
2771 | **Name** | **Type** | **Documentation** |
2772 | --- --| --- --| --- --|
2773 | 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. |
2774
2775 **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.
2776
2777 Derivation:
2778
2779 *`MemberSelectionType`*` (restriction)`
2780 `CubeRegionKeyType`
2781
2782 Attributes:
2783
2784 `id, include?, removePrefix?, validFrom?, validTo?`
2785
2786 Content:
2787
2788 `(Value+ | TimeRange)`
2789
2790 Attribute Documentation:
2791
2792 | **Name** | **Type** | **Documentation** |
2793 | --- --| --- --| --- --|
2794 | 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. |
2795 | 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. |
2796 | removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |
2797 | validFrom | StandardTimePeriodTy pe | |
2798 | validTo | StandardTimePeriodTy pe | |
2799
2800 Element Documentation:
2801
2802 | **Name** | **Type** | **Documentation** |
2803 | --- --| --- --| --- --|
2804 | 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. |
2805 | 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). |
2806
2807 **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.
2808
2809 Derivation:
2810
2811 *`MemberSelectionType`*` (restriction)`
2812 `ComponentValueSetType`
2813
2814 Attributes:
2815
2816 `id, include?, removePrefix?`
2817
2818 Content:
2819
2820 `(Value+ | TimeRange)?`
2821
2822 Attribute Documentation:
2823
2824 | **Name** | **Type** | **Documentation** |
2825 | --- --| --- --| --- --|
2826 | 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. |
2827 | 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. |
2828 | removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |
2829
2830 Element Documentation:
2831
2832 | **Name** | **Type** | **Documentation** |
2833 | --- --| --- --| --- --|
2834 | Value | SimpleComponentValue Type | 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. |
2835 | 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). |
2836
2837 **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.
2838
2839 Derivation:
2840
2841 *`MemberSelectionType`*` (restriction)`
2842 `MetadataAttributeValueSetType`
2843
2844 Attributes:
2845
2846 `id, include?, removePrefix?`
2847
2848 Content:
2849
2850 `(Value+ | TimeRange)?`
2851
2852 Attribute Documentation:
2853
2854 | **Name** | **Type** | **Documentation** |
2855 | --- --| --- --| --- --|
2856 | 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. |
2857 | 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. |
2858 | removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |
2859
2860 Element Documentation:
2861
2862 | **Name** | **Type** | **Documentation** |
2863 | --- --| --- --| --- --|
2864 | Value | SimpleComponentValue Type | 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. |
2865 | 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). |
2866
2867 **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.
2868
2869 Derivation:
2870
2871 ``xs:anySimpleType (restriction)` `
2872 `xs:string (extension)`
2873 `SimpleComponentValueType`
2874
2875 Attributes:
2876
2877 `cascadeValues?, xml:lang?, validFrom?, validTo?`
2878
2879 Content:
2880
2881 Attribute Documentation:
2882
2883 | **Name** | **Type** | **Documentation** |
2884 | --- --| --- --| --- --|
2885 | 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. |
2886 | 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. |
2887 | validFrom | StandardTimePeriodTy pe | |
2888 | validTo | StandardTimePeriodTy pe | |
2889
2890 **CubeKeyValueType:** CubeKeyValueType derives from the SimpleValueType, but does not allow for a locale (xml:lang).
2891
2892 Derivation:
2893
2894 ``xs:anySimpleType (restriction)` `
2895 `xs:string (extension)`
2896 `SimpleComponentValueType (restriction)`
2897 `CubeKeyValueType`
2898
2899 Attributes:
2900
2901 `cascadeValues?, validFrom?, validTo?`
2902
2903 Content:
2904
2905 Attribute Documentation:
2906
2907 | **Name** | **Type** | **Documentation** |
2908 | --- --| --- --| --- --|
2909 | 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. |
2910 | validFrom | StandardTimePeriodTy pe | |
2911 | validTo | StandardTimePeriodTy pe | |
2912
2913 **DataComponentValueType:** DataComponentValueType derives from the SimpleValueType, but does not allow for validity dates.
2914
2915 Derivation:
2916
2917 ``xs:anySimpleType (restriction)` `
2918 `xs:string (extension)`
2919 `SimpleComponentValueType (restriction)`
2920 `DataComponentValueType`
2921
2922 Attributes:
2923
2924 `cascadeValues?, xml:lang?`
2925
2926 Content:
2927
2928 Attribute Documentation:
2929
2930 | **Name** | **Type** | **Documentation** |
2931 | --- --| --- --| --- --|
2932 | 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. |
2933 | 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. |
2934
2935 **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.
2936
2937 Derivation:
2938
2939 ``xs:anySimpleType (restriction)` `
2940 `xs:string (extension)`
2941 `SimpleComponentValueType (restriction)`
2942 `SimpleKeyValueType`
2943
2944 Content:
2945
2946 **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.
2947
2948 Attributes:
2949
2950 `validFrom?, validTo?`
2951
2952 Content:
2953
2954 `(BeforePeriod | AfterPeriod | (StartPeriod, EndPeriod))`
2955
2956 Attribute Documentation:
2957
2958 | **Name** | **Type** | **Documentation** |
2959 | --- --| --- --| --- --|
2960 | validFrom | StandardTimePeriodTy pe | |
2961 | validTo | StandardTimePeriodTy pe | |
2962
2963 Element Documentation:
2964
2965 | **Name** | **Type** | **Documentation** |
2966 | --- --| --- --| --- --|
2967 | BeforePeriod | TimePeriodRangeType | BeforePeriod is the period before which the period is meant to cover. This date may be inclusive or exclusive in the range. |
2968 | AfterPeriod | TimePeriodRangeType | AfterPeriod is the period after which the period is meant to cover. This date may be inclusive or exclusive in the range. |
2969 | 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. |
2970 | EndPeriod | TimePeriodRangeType | EndPeriod is the end period of the range. This date may be inclusive or exclusive in the range. |
2971
2972 **TimePeriodRangeType:** TimePeriodRangeType defines a time period, and indicates whether it is inclusive in a range.
2973
2974 Derivation:
2975
2976 `xs:anySimpleType (restriction)`
2977 `ObservationalTimePeriodType (extension)`
2978 `TimePeriodRangeType`
2979
2980 Attributes:
2981
2982 `isInclusive?`
2983
2984 Content:
2985
2986 Attribute Documentation:
2987
2988 | **Name** | **Type** | **Documentation** |
2989 | --- --| --- --| --- --|
2990 | isInclusive (default: true) | xs:boolean | The isInclusive attribute, when true, indicates that the time period specified is included in the range. |
2991
2992 ***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.
2993
2994 Derivation:
2995
2996 *`AnnotableType`*` (extension)`
2997 *`IdentifiableType`*` (extension)`
2998 *`NameableType`*` (extension)`
2999 *`VersionableType`*` (restriction)`
3000 *`MaintainableBaseType`*` (extension)`
3001 *`MaintainableType`*` (restriction)`
3002 *`StructureType`*` (restriction)`
3003 *`DataStructureBaseType`*
3004
3005 Attributes:
3006
3007 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
3008
3009 Content:
3010
3011 `Annotations?, Link*, Name+, Description*, DataStructureComponents?`
3012
3013 Attribute Documentation:
3014
3015 | **Name** | **Type** | **Documentation** |
3016 | --- --| --- --| --- --|
3017 | id | IDType | The id is the identifier for the object. |
3018 | urn | DataStructureUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3019 | 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. |
3020 | 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. |
3021 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
3022 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
3023 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
3024 | 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. |
3025 | 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. |
3026 | 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. |
3027 | 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’. |
3028
3029 Element Documentation:
3030
3031 | **Name** | **Type** | **Documentation** |
3032 | --- --| --- --| --- --|
3033 | 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. |
3034 | 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. |
3035 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
3036 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
3037 | DataStructureCompone nts | DataStructureCompone ntsType | 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. |
3038
3039 **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.
3040
3041 Derivation:
3042
3043 *`AnnotableType`*` (extension)`
3044 *`IdentifiableType`*` (extension)`
3045 *`NameableType`*` (extension)`
3046 *`VersionableType`*` (restriction)`
3047 *`MaintainableBaseType`*` (extension)`
3048 *`MaintainableType`*` (restriction)`
3049 *`StructureType`*` (restriction)`
3050 *`DataStructureBaseType`*` (extension)`
3051 `DataStructureType`
3052
3053 Attributes:
3054
3055 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
3056
3057 Content:
3058
3059 `Annotations?, Link*, Name+, Description*, DataStructureComponents?, Metadata?`
3060
3061 Attribute Documentation:
3062
3063 | **Name** | **Type** | **Documentation** |
3064 | --- --| --- --| --- --|
3065 | id | IDType | The id is the identifier for the object. |
3066 | urn | DataStructureUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3067 | 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. |
3068 | 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. |
3069 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
3070 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
3071 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
3072 | 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. |
3073 | 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. |
3074 | 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. |
3075 | 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’. |
3076
3077 Element Documentation:
3078
3079 | **Name** | **Type** | **Documentation** |
3080 | --- --| --- --| --- --|
3081 | 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. |
3082 | 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. |
3083 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
3084 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
3085 | DataStructureCompone nts | DataStructureCompone ntsType | 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. |
3086 | Metadata | MetadataStructureRef erenceType | 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. |
3087
3088 ***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.
3089
3090 Derivation:
3091
3092 *`GroupingType`*` (restriction)`
3093 *`DataStructureComponentsBaseType`*
3094
3095 Content:
3096
3097 `{Empty}`
3098
3099 **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.
3100
3101 Derivation:
3102
3103 *`GroupingType`*` (restriction)`
3104 *`DataStructureComponentsBaseType`*` (extension)`
3105 `DataStructureComponentsType`
3106
3107 Content:
3108
3109 `DimensionList, Group*, AttributeList?, MeasureList?`
3110
3111 Element Documentation:
3112
3113 | **Name** | **Type** | **Documentation** |
3114 | --- --| --- --| --- --|
3115 | 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. |
3116 | 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. |
3117 | 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. |
3118 | MeasureList | MeasureListType | MeasureList describes the measure descriptor for a data structure. |
3119
3120 ***AttributeListBaseType*:** AttributeListBaseType is an abstract base type used as the basis for the AttributeListType.
3121
3122 Derivation:
3123
3124 *`AnnotableType`*` (extension)`
3125 *`IdentifiableType`*` (extension)`
3126 *`ComponentListType`*` (restriction)`
3127 *`AttributeListBaseType`*
3128
3129 Attributes:
3130
3131 `id?, urn?, uri?`
3132
3133 Content:
3134
3135 `Annotations?, Link*`
3136
3137 Attribute Documentation:
3138
3139 | **Name** | **Type** | **Documentation** |
3140 | --- --| --- --| --- --|
3141 | id (fixed: AttributeDescriptor) | IDType | The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor. |
3142 | urn | AttributeDescriptorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3143 | 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. |
3144
3145 Element Documentation:
3146
3147 | **Name** | **Type** | **Documentation** |
3148 | --- --| --- --| --- --|
3149 | 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. |
3150 | 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. |
3151
3152 **AttributeListType:** AttributeListType describes the attribute descriptor for the data structure definition.
3153
3154 Derivation:
3155
3156 *`AnnotableType`*` (extension)`
3157 *`IdentifiableType`*` (extension)`
3158 *`ComponentListType`*` (restriction)`
3159 *`AttributeListBaseType`*` (extension)`
3160 `AttributeListType`
3161
3162 Attributes:
3163
3164 `id?, urn?, uri?`
3165
3166 Content:
3167
3168 `Annotations?, Link*, (Attribute | MetadataAttributeUsage)+`
3169
3170 Attribute Documentation:
3171
3172 | **Name** | **Type** | **Documentation** |
3173 | --- --| --- --| --- --|
3174 | id (fixed: AttributeDescriptor) | IDType | The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor. |
3175 | urn | AttributeDescriptorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3176 | 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. |
3177
3178 Element Documentation:
3179
3180 | **Name** | **Type** | **Documentation** |
3181 | --- --| --- --| --- --|
3182 | 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. |
3183 | 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. |
3184 | Attribute | AttributeType | Attribute describes the definition of a data attribute, which is defined as a characteristic of an object or entity. |
3185 | MetadataAttributeUsa ge | MetadataAttributeUsa geType | 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. |
3186
3187 ***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.
3188
3189 Derivation:
3190
3191 *`AnnotableType`*` (extension)`
3192 *`IdentifiableType`*` (extension)`
3193 *`ComponentBaseType`*` (extension)`
3194 *`ComponentType`*` (restriction)`
3195 *`AttributeBaseType`*
3196
3197 Attributes:
3198
3199 `id?, urn?, uri?`
3200
3201 Content:
3202
3203 `Annotations?, Link*, ConceptIdentity, LocalRepresentation?`
3204
3205 Attribute Documentation:
3206
3207 | **Name** | **Type** | **Documentation** |
3208 | --- --| --- --| --- --|
3209 | 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). |
3210 | urn | DataAttributeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3211 | 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. |
3212
3213 Element Documentation:
3214
3215 | **Name** | **Type** | **Documentation** |
3216 | --- --| --- --| --- --|
3217 | 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. |
3218 | 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. |
3219 | 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. |
3220 | 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. |
3221
3222 **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.
3223
3224 Derivation:
3225
3226 *`AnnotableType`*` (extension)`
3227 *`IdentifiableType`*` (extension)`
3228 *`ComponentBaseType`*` (extension)`
3229 *`ComponentType`*` (restriction)`
3230 *`AttributeBaseType`*` (extension)`
3231 `AttributeType`
3232
3233 Attributes:
3234
3235 `id?, urn?, uri?, usage?`
3236
3237 Content:
3238
3239 `Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole*, AttributeRelationship, MeasureRelationship?`
3240
3241 Attribute Documentation:
3242
3243 | **Name** | **Type** | **Documentation** |
3244 | --- --| --- --| --- --|
3245 | 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). |
3246 | urn | DataAttributeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3247 | 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. |
3248 | usage (default: optional) | UsageType | The usage attribute indicates whether an attribute value must be available for any corresponding existing observation. |
3249
3250 Element Documentation:
3251
3252 | **Name** | **Type** | **Documentation** |
3253 | --- --| --- --| --- --|
3254 | 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. |
3255 | 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. |
3256 | 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. |
3257 | 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. |
3258 | ConceptRole | ConceptReferenceType | ConceptRole references concepts which define roles which this attribute serves. |
3259 | 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. |
3260 | 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. |
3261
3262 **AttributeRelationshipType:** AttributeRelationshipType defines the structure for stating the relationship between an attribute and other data structure definition components.
3263
3264 Content:
3265
3266 `(Dataflow | Dimension+ | Group | Observation)`
3267
3268 Element Documentation:
3269
3270 | **Name** | **Type** | **Documentation** |
3271 | --- --| --- --| --- --|
3272 | 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. |
3273 | Dimension | OptionalLocalDimensi onReferenceType | 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. |
3274 | 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. |
3275 | 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. |
3276
3277 **OptionalLocalDimensionReferenceType:**
3278
3279 Derivation:
3280
3281 `xs:anySimpleType (restriction)`
3282 `xs:string (restriction)`
3283 `NestedIDType (restriction)`
3284 `IDType (restriction)`
3285 `NCNameIDType (extension)`
3286 `OptionalLocalDimensionReferenceType`
3287
3288 Attributes:
3289
3290 `optional?`
3291
3292 Content:
3293
3294 Attribute Documentation:
3295
3296 | **Name** | **Type** | **Documentation** |
3297 | --- --| --- --| --- --|
3298 | optional (default: false) | xs:boolean | |
3299
3300 **MeasureRelationshipType:** MeasureRelationshipType allows for the description of an attributes relationship to one or more measures
3301
3302 Content:
3303
3304 `Measure+`
3305
3306 Element Documentation:
3307
3308 | **Name** | **Type** | **Documentation** |
3309 | --- --| --- --| --- --|
3310 | Measure | NCNameIDType | This is a reference to a measure defined in this data structure definition. |
3311
3312 ***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.
3313
3314 Derivation:
3315
3316 *`AnnotableType`*` (extension)`
3317 *`IdentifiableType`*` (extension)`
3318 *`ComponentBaseType`*` (extension)`
3319 *`ComponentType`*` (restriction)`
3320 *`MetadataAttributeUsageBaseType`*
3321
3322 Attributes:
3323
3324 `urn?, uri?`
3325
3326 Content:
3327
3328 `Annotations?, Link?`
3329
3330 Attribute Documentation:
3331
3332 | **Name** | **Type** | **Documentation** |
3333 | --- --| --- --| --- --|
3334 | urn | UrnType | 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
3337 Element Documentation:
3338
3339 | **Name** | **Type** | **Documentation** |
3340 | --- --| --- --| --- --|
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
3344 **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.
3345
3346 Derivation:
3347
3348 *`AnnotableType`*` (extension)`
3349 *`IdentifiableType`*` (extension)`
3350 *`ComponentBaseType`*` (extension)`
3351 *`ComponentType`*` (restriction)`
3352 *`MetadataAttributeUsageBaseType`*` (extension)`
3353 `MetadataAttributeUsageType`
3354
3355 Attributes:
3356
3357 `urn?, uri?`
3358
3359 Content:
3360
3361 `Annotations?, Link?, MetadataAttributeReference, AttributeRelationship`
3362
3363 Attribute Documentation:
3364
3365 | **Name** | **Type** | **Documentation** |
3366 | --- --| --- --| --- --|
3367 | urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3368 | 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. |
3369
3370 Element Documentation:
3371
3372 | **Name** | **Type** | **Documentation** |
3373 | --- --| --- --| --- --|
3374 | 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. |
3375 | 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. |
3376 | MetadataAttributeRef erence | NCNameIDType | MetadataAttributeReference is a local reference to a metadata attribute defined in the metadata structure referenced by this data structure. |
3377 | AttributeRelationshi p | AttributeRelationshi pType | AttributeRelationship defines the relationship between the referenced metadata attribute and the components of the data structure. |
3378
3379 ***DimensionListBaseType*:** DimensionListBaseType is an abstract base type used as the basis for the DimensionListType.
3380
3381 Derivation:
3382
3383 *`AnnotableType`*` (extension)`
3384 *`IdentifiableType`*` (extension)`
3385 *`ComponentListType`*` (restriction)`
3386 *`DimensionListBaseType`*
3387
3388 Attributes:
3389
3390 `id?, urn?, uri?`
3391
3392 Content:
3393
3394 `Annotations?, Link*`
3395
3396 Attribute Documentation:
3397
3398 | **Name** | **Type** | **Documentation** |
3399 | --- --| --- --| --- --|
3400 | id (fixed: DimensionDescriptor) | IDType | The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor. |
3401 | urn | DimensionDescriptorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3402 | 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. |
3403
3404 Element Documentation:
3405
3406 | **Name** | **Type** | **Documentation** |
3407 | --- --| --- --| --- --|
3408 | 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. |
3409 | 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. |
3410
3411 **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.
3412
3413 Derivation:
3414
3415 *`AnnotableType`*` (extension)`
3416 *`IdentifiableType`*` (extension)`
3417 *`ComponentListType`*` (restriction)`
3418 *`DimensionListBaseType`*` (extension)`
3419 `DimensionListType`
3420
3421 Attributes:
3422
3423 `id?, urn?, uri?`
3424
3425 Content:
3426
3427 `Annotations?, Link*, Dimension+, TimeDimension?`
3428
3429 Attribute Documentation:
3430
3431 | **Name** | **Type** | **Documentation** |
3432 | --- --| --- --| --- --|
3433 | id (fixed: DimensionDescriptor) | IDType | The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor. |
3434 | urn | DimensionDescriptorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3435 | 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. |
3436
3437 Element Documentation:
3438
3439 | **Name** | **Type** | **Documentation** |
3440 | --- --| --- --| --- --|
3441 | 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. |
3442 | 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. |
3443 | 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. |
3444 | TimeDimension | TimeDimensionType | TimeDimension is a special dimension which designates the period in time in which the data identified by the full series key applies. |
3445
3446 ***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).
3447
3448 Derivation:
3449
3450 *`AnnotableType`*` (extension)`
3451 *`IdentifiableType`*` (extension)`
3452 *`ComponentBaseType`*` (extension)`
3453 *`ComponentType`*` (restriction)`
3454 *`BaseDimensionBaseType`*
3455
3456 Attributes:
3457
3458 `id?, urn?, uri?`
3459
3460 Content:
3461
3462 `Annotations?, Link*, ConceptIdentity, LocalRepresentation?`
3463
3464 Attribute Documentation:
3465
3466 | **Name** | **Type** | **Documentation** |
3467 | --- --| --- --| --- --|
3468 | 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). |
3469 | urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3470 | 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. |
3471
3472 Element Documentation:
3473
3474 | **Name** | **Type** | **Documentation** |
3475 | --- --| --- --| --- --|
3476 | 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. |
3477 | 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. |
3478 | 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. |
3479 | LocalRepresentation | *DataStructureReprese ntationType* | 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. |
3480
3481 ***BaseDimensionType*:** BaseDimensionType is an abstract base type which defines the basic structure of all dimensions.
3482
3483 Derivation:
3484
3485 *`AnnotableType`*` (extension)`
3486 *`IdentifiableType`*` (extension)`
3487 *`ComponentBaseType`*` (extension)`
3488 *`ComponentType`*` (restriction)`
3489 *`BaseDimensionBaseType`*` (extension)`
3490 *`BaseDimensionType`*
3491
3492 Attributes:
3493
3494 `id?, urn?, uri?, position?`
3495
3496 Content:
3497
3498 `Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole*`
3499
3500 Attribute Documentation:
3501
3502 | **Name** | **Type** | **Documentation** |
3503 | --- --| --- --| --- --|
3504 | 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). |
3505 | urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3506 | 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. |
3507 | 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. |
3508
3509 Element Documentation:
3510
3511 | **Name** | **Type** | **Documentation** |
3512 | --- --| --- --| --- --|
3513 | 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. |
3514 | 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. |
3515 | 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. |
3516 | LocalRepresentation | *DataStructureReprese ntationType* | 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. |
3517 | ConceptRole | ConceptReferenceType | ConceptRole references concepts which define roles which this dimension serves. |
3518
3519 **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.
3520
3521 Derivation:
3522
3523 *`AnnotableType`*` (extension)`
3524 *`IdentifiableType`*` (extension)`
3525 *`ComponentBaseType`*` (extension)`
3526 *`ComponentType`*` (restriction)`
3527 *`BaseDimensionBaseType`*` (extension)`
3528 *`BaseDimensionType`*` (restriction)`
3529 `DimensionType`
3530
3531 Attributes:
3532
3533 `id?, urn?, uri?, position?`
3534
3535 Content:
3536
3537 `Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole*`
3538
3539 Attribute Documentation:
3540
3541 | **Name** | **Type** | **Documentation** |
3542 | --- --| --- --| --- --|
3543 | 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). |
3544 | urn | DimensionUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3545 | 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. |
3546 | 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. |
3547
3548 Element Documentation:
3549
3550 | **Name** | **Type** | **Documentation** |
3551 | --- --| --- --| --- --|
3552 | 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. |
3553 | 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. |
3554 | 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. |
3555 | LocalRepresentation | SimpleDataStructureR epresentationType | 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. |
3556 | ConceptRole | ConceptReferenceType | ConceptRole references concepts which define roles which this dimension serves. |
3557
3558 **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.
3559
3560 Derivation:
3561
3562 *`AnnotableType`*` (extension)`
3563 *`IdentifiableType`*` (extension)`
3564 *`ComponentBaseType`*` (extension)`
3565 *`ComponentType`*` (restriction)`
3566 *`BaseDimensionBaseType`*` (extension)`
3567 *`BaseDimensionType`*` (restriction)`
3568 `TimeDimensionType`
3569
3570 Attributes:
3571
3572 `id?, urn?, uri?`
3573
3574 Content:
3575
3576 `Annotations?, Link*, ConceptIdentity, LocalRepresentation`
3577
3578 Attribute Documentation:
3579
3580 | **Name** | **Type** | **Documentation** |
3581 | --- --| --- --| --- --|
3582 | 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). |
3583 | urn | TimeDimensionUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3584 | 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. |
3585
3586 Element Documentation:
3587
3588 | **Name** | **Type** | **Documentation** |
3589 | --- --| --- --| --- --|
3590 | 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. |
3591 | 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. |
3592 | 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. |
3593 | LocalRepresentation | TimeDimensionReprese ntationType | 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. |
3594
3595 ***GroupBaseType*:** GroupBaseType is an abstract base type that forms the basis for the GroupType.
3596
3597 Derivation:
3598
3599 *`AnnotableType`*` (extension)`
3600 *`IdentifiableType`*` (extension)`
3601 *`ComponentListType`*` (restriction)`
3602 *`GroupBaseType`*
3603
3604 Attributes:
3605
3606 `id, urn?, uri?`
3607
3608 Content:
3609
3610 `Annotations?`
3611
3612 Attribute Documentation:
3613
3614 | **Name** | **Type** | **Documentation** |
3615 | --- --| --- --| --- --|
3616 | id | IDType | The id is the identifier for the object. |
3617 | urn | GroupDimensionDescri ptorUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3618 | 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. |
3619
3620 Element Documentation:
3621
3622 | **Name** | **Type** | **Documentation** |
3623 | --- --| --- --| --- --|
3624 | 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. |
3625
3626 **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.
3627
3628 Derivation:
3629
3630 *`AnnotableType`*` (extension)`
3631 *`IdentifiableType`*` (extension)`
3632 *`ComponentListType`*` (restriction)`
3633 *`GroupBaseType`*` (extension)`
3634 `GroupType`
3635
3636 Attributes:
3637
3638 `id, urn?, uri?`
3639
3640 Content:
3641
3642 `Annotations?, GroupDimension+`
3643
3644 Attribute Documentation:
3645
3646 | **Name** | **Type** | **Documentation** |
3647 | --- --| --- --| --- --|
3648 | id | IDType | The id is the identifier for the object. |
3649 | urn | GroupDimensionDescri ptorUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3650 | 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. |
3651
3652 Element Documentation:
3653
3654 | **Name** | **Type** | **Documentation** |
3655 | --- --| --- --| --- --|
3656 | 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. |
3657 | 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. |
3658
3659 ***GroupDimensionBaseType*:** GroupDimensionBaseType is an abstract base type which refines the base ComponentType in order to form the basis for the GroupDimensionType.
3660
3661 Derivation:
3662
3663 *`AnnotableType`*` (extension)`
3664 *`IdentifiableType`*` (extension)`
3665 *`ComponentBaseType`*` (extension)`
3666 *`ComponentType`*` (restriction)`
3667 *`GroupDimensionBaseType`*
3668
3669 Content:
3670
3671 `{Empty}`
3672
3673 **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.
3674
3675 Derivation:
3676
3677 *`AnnotableType`*` (extension)`
3678 *`IdentifiableType`*` (extension)`
3679 *`ComponentBaseType`*` (extension)`
3680 *`ComponentType`*` (restriction)`
3681 *`GroupDimensionBaseType`*` (extension)`
3682 `GroupDimensionType`
3683
3684 Content:
3685
3686 `DimensionReference`
3687
3688 Element Documentation:
3689
3690 | **Name** | **Type** | **Documentation** |
3691 | --- --| --- --| --- --|
3692 | 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. |
3693
3694 **MeasureListType:** MeasureListType describes the structure of the measure descriptor for a data structure definition.
3695
3696 Derivation:
3697
3698 *`AnnotableType`*` (extension)`
3699 *`IdentifiableType`*` (extension)`
3700 *`ComponentListType`*` (restriction)`
3701 `MeasureListType`
3702
3703 Attributes:
3704
3705 `id?, urn?, uri?`
3706
3707 Content:
3708
3709 `Annotations?, Link*, Measure+`
3710
3711 Attribute Documentation:
3712
3713 | **Name** | **Type** | **Documentation** |
3714 | --- --| --- --| --- --|
3715 | id (fixed: MeasureDescriptor) | IDType | The id is the identifier for the object. |
3716 | urn | MeasureDescriptorUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3717 | 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. |
3718
3719 Element Documentation:
3720
3721 | **Name** | **Type** | **Documentation** |
3722 | --- --| --- --| --- --|
3723 | 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. |
3724 | 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. |
3725 | 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. |
3726
3727 ***MeasureBaseType*:** MeasureBaseType is an abstract base type that refines ComponentType to rerstrict the represenations to those which are applicable for a measure.
3728
3729 Derivation:
3730
3731 *`AnnotableType`*` (extension)`
3732 *`IdentifiableType`*` (extension)`
3733 *`ComponentBaseType`*` (extension)`
3734 *`ComponentType`*` (restriction)`
3735 *`MeasureBaseType`*
3736
3737 Attributes:
3738
3739 `id?, urn?, uri?`
3740
3741 Content:
3742
3743 `Annotations?, Link*, ConceptIdentity, LocalRepresentation?`
3744
3745 Attribute Documentation:
3746
3747 | **Name** | **Type** | **Documentation** |
3748 | --- --| --- --| --- --|
3749 | 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). |
3750 | urn | MeasureUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3751 | 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. |
3752
3753 Element Documentation:
3754
3755 | **Name** | **Type** | **Documentation** |
3756 | --- --| --- --| --- --|
3757 | 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. |
3758 | 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. |
3759 | 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. |
3760 | 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. |
3761
3762 **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.
3763
3764 Derivation:
3765
3766 *`AnnotableType`*` (extension)`
3767 *`IdentifiableType`*` (extension)`
3768 *`ComponentBaseType`*` (extension)`
3769 *`ComponentType`*` (restriction)`
3770 *`MeasureBaseType`*` (extension)`
3771 `MeasureType`
3772
3773 Attributes:
3774
3775 `id?, urn?, uri?, usage?`
3776
3777 Content:
3778
3779 `Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole*`
3780
3781 Attribute Documentation:
3782
3783 | **Name** | **Type** | **Documentation** |
3784 | --- --| --- --| --- --|
3785 | 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). |
3786 | urn | MeasureUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3787 | 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. |
3788 | usage (default: optional) | UsageType | The usage attribute indicates whether a measure value must be available for any corresponding existing observation. |
3789
3790 Element Documentation:
3791
3792 | **Name** | **Type** | **Documentation** |
3793 | --- --| --- --| --- --|
3794 | 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. |
3795 | 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. |
3796 | 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. |
3797 | 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. |
3798 | ConceptRole | ConceptReferenceType | ConceptRole references concepts which define roles which this measure serves. |
3799
3800 ***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.
3801
3802 Derivation:
3803
3804 *`RepresentationType`*` (restriction)`
3805 *`DataStructureRepresentationType`*
3806
3807 Attributes:
3808
3809 `maxOccurs?`
3810
3811 Content:
3812
3813 `(TextFormat | (Enumeration, EnumerationFormat?))`
3814
3815 Attribute Documentation:
3816
3817 | **Name** | **Type** | **Documentation** |
3818 | --- --| --- --| --- --|
3819 | maxOccurs | OccurenceType | The maxOccurs attribute indicates the maximum number of values that can be reported for the component. |
3820
3821 Element Documentation:
3822
3823 | **Name** | **Type** | **Documentation** |
3824 | --- --| --- --| --- --|
3825 | TextFormat | SimpleComponentTextF ormatType | TextFormat describes an uncoded textual format. |
3826 | Enumeration | AnyCodelistReference Type | Enumeration references an item scheme that enumerates the allowable values for this representation. |
3827 | EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |
3828
3829 **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.
3830
3831 Derivation:
3832
3833 *`RepresentationType`*` (restriction)`
3834 `AttributeRepresentationType`
3835
3836 Attributes:
3837
3838 `minOccurs?, maxOccurs?`
3839
3840 Content:
3841
3842 `(TextFormat | (Enumeration, EnumerationFormat?))`
3843
3844 Attribute Documentation:
3845
3846 | **Name** | **Type** | **Documentation** |
3847 | --- --| --- --| --- --|
3848 | minOccurs (default: 1) | xs: nonNegativeInteger | The minOccurs attribute indicates the minimum number of value that must be reported for the component. |
3849 | maxOccurs (default: 1) | OccurenceType | The maxOccurs attribute indicates the maximum number of values that can be reported for the component. |
3850
3851 Element Documentation:
3852
3853 | **Name** | **Type** | **Documentation** |
3854 | --- --| --- --| --- --|
3855 | TextFormat | BasicComponentTextFo rmatType | TextFormat describes an uncoded textual format. |
3856 | Enumeration | AnyCodelistReference Type | Enumeration references an item scheme that enumerates the allowable values for this representation. |
3857 | EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |
3858
3859 **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.
3860
3861 Derivation:
3862
3863 *`RepresentationType`*` (restriction)`
3864 `MeasureRepresentationType`
3865
3866 Attributes:
3867
3868 `minOccurs?, maxOccurs?`
3869
3870 Content:
3871
3872 `(TextFormat | (Enumeration, EnumerationFormat?))`
3873
3874 Attribute Documentation:
3875
3876 | **Name** | **Type** | **Documentation** |
3877 | --- --| --- --| --- --|
3878 | minOccurs (default: 1) | xs: nonNegativeInteger | The minOccurs attribute indicates the minimum number of value that must be reported for the component. |
3879 | maxOccurs (default: 1) | OccurenceType | The maxOccurs attribute indicates the maximum number of values that can be reported for the component. |
3880
3881 Element Documentation:
3882
3883 | **Name** | **Type** | **Documentation** |
3884 | --- --| --- --| --- --|
3885 | TextFormat | BasicComponentTextFo rmatType | TextFormat describes an uncoded textual format. |
3886 | Enumeration | AnyCodelistReference Type | Enumeration references an item scheme that enumerates the allowable values for this representation. |
3887 | EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |
3888
3889 **SimpleDataStructureRepresentationType:** SimpleDataStructureRepresentationType defines the representation for any non-time dimension data structure definition component.
3890
3891 Derivation:
3892
3893 *`RepresentationType`*` (restriction)`
3894 *`DataStructureRepresentationType`*` (restriction)`
3895 `SimpleDataStructureRepresentationType`
3896
3897 Content:
3898
3899 `(TextFormat | (Enumeration, EnumerationFormat?))`
3900
3901 Element Documentation:
3902
3903 | **Name** | **Type** | **Documentation** |
3904 | --- --| --- --| --- --|
3905 | TextFormat | SimpleComponentTextF ormatType | TextFormat describes an uncoded textual format. |
3906 | Enumeration | CodelistReferenceTyp e | Enumeration references an item scheme that enumerates the allowable values for this representation. |
3907 | EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |
3908
3909 **TimeDimensionRepresentationType:** TimeDimensionRepresentationType defines the representation for the time dimension. Enumerated values are not allowed.
3910
3911 Derivation:
3912
3913 *`RepresentationType`*` (restriction)`
3914 *`DataStructureRepresentationType`*` (restriction)`
3915 `SimpleDataStructureRepresentationType (restriction)`
3916 `TimeDimensionRepresentationType`
3917
3918 Content:
3919
3920 `TextFormat`
3921
3922 Element Documentation:
3923
3924 | **Name** | **Type** | **Documentation** |
3925 | --- --| --- --| --- --|
3926 | TextFormat | TimeTextFormatType | TextFormat describes an uncoded textual format. |
3927
3928 **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.
3929
3930 Derivation:
3931
3932 *`AnnotableType`*` (extension)`
3933 *`IdentifiableType`*` (extension)`
3934 *`NameableType`*` (extension)`
3935 *`VersionableType`*` (restriction)`
3936 *`MaintainableBaseType`*` (extension)`
3937 *`MaintainableType`*` (restriction)`
3938 *`StructureUsageType`*` (restriction)`
3939 `DataflowType`
3940
3941 Attributes:
3942
3943 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
3944
3945 Content:
3946
3947 `Annotations?, Link*, Name+, Description*, Structure?`
3948
3949 Attribute Documentation:
3950
3951 | **Name** | **Type** | **Documentation** |
3952 | --- --| --- --| --- --|
3953 | id | IDType | The id is the identifier for the object. |
3954 | urn | DataflowUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
3955 | 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. |
3956 | 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. |
3957 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
3958 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
3959 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
3960 | 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. |
3961 | 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. |
3962 | 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. |
3963 | 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’. |
3964
3965 Element Documentation:
3966
3967 | **Name** | **Type** | **Documentation** |
3968 | --- --| --- --| --- --|
3969 | 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. |
3970 | 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. |
3971 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
3972 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
3973 | Structure | DataStructureReferen ceType | Structure provides a reference to the data structure definition which defines the structure of all data for this flow. |
3974
3975 ***HierarchyBaseType*:** HierarchyBaseType is an abstract base class that is the basis for the HierarchyType. It requires that a name be supplied.
3976
3977 Derivation:
3978
3979 *`AnnotableType`*` (extension)`
3980 *`IdentifiableType`*` (extension)`
3981 *`NameableType`*` (extension)`
3982 *`VersionableType`*` (restriction)`
3983 *`MaintainableBaseType`*` (extension)`
3984 *`MaintainableType`*` (restriction)`
3985 *`HierarchyBaseType`*
3986
3987 Attributes:
3988
3989 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
3990
3991 Content:
3992
3993 `Annotations?, Link*, Name+, Description*`
3994
3995 Attribute Documentation:
3996
3997 | **Name** | **Type** | **Documentation** |
3998 | --- --| --- --| --- --|
3999 | id | IDType | The id is the identifier for the object. |
4000 | urn | HierarchyUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4001 | 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. |
4002 | 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. |
4003 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
4004 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
4005 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
4006 | 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. |
4007 | 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. |
4008 | 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. |
4009 | 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’. |
4010
4011 Element Documentation:
4012
4013 | **Name** | **Type** | **Documentation** |
4014 | --- --| --- --| --- --|
4015 | 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. |
4016 | 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. |
4017 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
4018 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
4019
4020 **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.
4021
4022 Derivation:
4023
4024 *`AnnotableType`*` (extension)`
4025 *`IdentifiableType`*` (extension)`
4026 *`NameableType`*` (extension)`
4027 *`VersionableType`*` (restriction)`
4028 *`MaintainableBaseType`*` (extension)`
4029 *`MaintainableType`*` (restriction)`
4030 *`HierarchyBaseType`*` (extension)`
4031 `HierarchyType`
4032
4033 Attributes:
4034
4035 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, hasFormalLevels`
4036
4037 Content:
4038
4039 `Annotations?, Link*, Name+, Description*, Level?, HierarchicalCode+`
4040
4041 Attribute Documentation:
4042
4043 | **Name** | **Type** | **Documentation** |
4044 | --- --| --- --| --- --|
4045 | id | IDType | The id is the identifier for the object. |
4046 | urn | HierarchyUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4047 | 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. |
4048 | 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. |
4049 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
4050 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
4051 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
4052 | 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. |
4053 | 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. |
4054 | 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. |
4055 | 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’. |
4056 | 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. |
4057
4058 Element Documentation:
4059
4060 | **Name** | **Type** | **Documentation** |
4061 | --- --| --- --| --- --|
4062 | 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. |
4063 | 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. |
4064 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
4065 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
4066 | 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. |
4067 | HierarchicalCode | HierarchicalCodeType | HierarchicalCode is used to assemble the codes from the codelist(s) referenced into a hierarchy. |
4068
4069 ***HierarchicalCodeBaseType*:** HierarchicalCodeBaseType is an abstract base type the creates the basis for the HierarchicalCodeType. It removes the urn and uri.
4070
4071 Derivation:
4072
4073 *`AnnotableType`*` (extension)`
4074 *`IdentifiableType`*` (extension)`
4075 *`HierarchicalCodeBaseType`*
4076
4077 Attributes:
4078
4079 `id, urn?, uri?`
4080
4081 Content:
4082
4083 `Annotations?, Link*`
4084
4085 Attribute Documentation:
4086
4087 | **Name** | **Type** | **Documentation** |
4088 | --- --| --- --| --- --|
4089 | 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. |
4090 | urn | HierarchicalCodeUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4091 | 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. |
4092
4093 Element Documentation:
4094
4095 | **Name** | **Type** | **Documentation** |
4096 | --- --| --- --| --- --|
4097 | 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. |
4098 | 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. |
4099
4100 **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.
4101
4102 Derivation:
4103
4104 *`AnnotableType`*` (extension)`
4105 *`IdentifiableType`*` (extension)`
4106 *`HierarchicalCodeBaseType`*` (extension)`
4107 `HierarchicalCodeType`
4108
4109 Attributes:
4110
4111 `id, urn?, uri?, validFrom?, validTo?`
4112
4113 Content:
4114
4115 `Annotations?, Link*, Code, HierarchicalCode*, Level?`
4116
4117 Attribute Documentation:
4118
4119 | **Name** | **Type** | **Documentation** |
4120 | --- --| --- --| --- --|
4121 | 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. |
4122 | urn | HierarchicalCodeUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4123 | 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. |
4124 | 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. |
4125 | 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. |
4126
4127 Element Documentation:
4128
4129 | **Name** | **Type** | **Documentation** |
4130 | --- --| --- --| --- --|
4131 | 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. |
4132 | 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. |
4133 | Code | CodeReferenceType | Code provides a complete, explicit reference to a code through either its URN, or a complete reference to the codelist and code. |
4134 | HierarchicalCode | HierarchicalCodeType | HierarchicalCode is used to nest referenced codes into a value based hierarchy. |
4135 | 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. |
4136
4137 ***LevelBaseType*:** LevelBaseType is an abstract base type that makes up the basis for the LevelType. It requires a name and id.
4138
4139 Derivation:
4140
4141 *`AnnotableType`*` (extension)`
4142 *`IdentifiableType`*` (extension)`
4143 *`NameableType`*` (restriction)`
4144 *`LevelBaseType`*
4145
4146 Attributes:
4147
4148 `id, urn?, uri?`
4149
4150 Content:
4151
4152 `Annotations?, Link*, Name+, Description*`
4153
4154 Attribute Documentation:
4155
4156 | **Name** | **Type** | **Documentation** |
4157 | --- --| --- --| --- --|
4158 | id | IDType | The id is the identifier for the object. |
4159 | urn | LevelUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4160 | 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. |
4161
4162 Element Documentation:
4163
4164 | **Name** | **Type** | **Documentation** |
4165 | --- --| --- --| --- --|
4166 | 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. |
4167 | 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. |
4168 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
4169 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
4170
4171 **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.
4172
4173 Derivation:
4174
4175 *`AnnotableType`*` (extension)`
4176 *`IdentifiableType`*` (extension)`
4177 *`NameableType`*` (restriction)`
4178 *`LevelBaseType`*` (extension)`
4179 `LevelType`
4180
4181 Attributes:
4182
4183 `id, urn?, uri?`
4184
4185 Content:
4186
4187 `Annotations?, Link*, Name+, Description*, CodingFormat?, Level?`
4188
4189 Attribute Documentation:
4190
4191 | **Name** | **Type** | **Documentation** |
4192 | --- --| --- --| --- --|
4193 | id | IDType | The id is the identifier for the object. |
4194 | urn | LevelUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4195 | 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. |
4196
4197 Element Documentation:
4198
4199 | **Name** | **Type** | **Documentation** |
4200 | --- --| --- --| --- --|
4201 | 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. |
4202 | 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. |
4203 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
4204 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
4205 | 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. |
4206 | Level | LevelType | Level describes the next level down in the hierarchy. |
4207
4208 **CodingTextFormatType:**
4209
4210 Derivation:
4211
4212 `TextFormatType (restriction)`
4213 `BasicComponentTextFormatType (restriction)`
4214 `SimpleComponentTextFormatType (restriction)`
4215 `CodingTextFormatType`
4216
4217 Attributes:
4218
4219 `textType?, isSequence?, interval?, startValue?, endValue?, minLength?, maxLength?, minValue?, maxValue?, pattern?`
4220
4221 Content:
4222
4223 `{Empty}`
4224
4225 Attribute Documentation:
4226
4227 | **Name** | **Type** | **Documentation** |
4228 | --- --| --- --| --- --|
4229 | 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. |
4230 | 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. |
4231 | 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. |
4232 | 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. |
4233 | 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. |
4234 | minLength | xs:positiveInteger | The minLength attribute specifies the minimum and length of the value in characters. |
4235 | maxLength | xs:positiveInteger | The maxLength attribute specifies the maximum length of the value in characters. |
4236 | 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. |
4237 | 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. |
4238 | pattern | xs:string | The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema. |
4239
4240 ***HierarchyAssociationBaseType*:** HierarchyAssociationBaseType defines the base refinement of the HierarchyAssociationType. Its purpose is to retrict the urn attribute.
4241
4242 Derivation:
4243
4244 *`AnnotableType`*` (extension)`
4245 *`IdentifiableType`*` (extension)`
4246 *`NameableType`*` (extension)`
4247 *`VersionableType`*` (restriction)`
4248 *`MaintainableBaseType`*` (extension)`
4249 *`MaintainableType`*` (restriction)`
4250 *`HierarchyAssociationBaseType`*
4251
4252 Attributes:
4253
4254 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
4255
4256 Content:
4257
4258 `Annotations?, Link*, Name+, Description*`
4259
4260 Attribute Documentation:
4261
4262 | **Name** | **Type** | **Documentation** |
4263 | --- --| --- --| --- --|
4264 | id | IDType | The id is the identifier for the object. |
4265 | urn | HierarchyAssociation UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4266 | 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. |
4267 | 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. |
4268 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
4269 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
4270 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
4271 | 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. |
4272 | 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. |
4273 | 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. |
4274 | 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’. |
4275
4276 Element Documentation:
4277
4278 | **Name** | **Type** | **Documentation** |
4279 | --- --| --- --| --- --|
4280 | 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. |
4281 | 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. |
4282 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
4283 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
4284
4285 **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).
4286
4287 Derivation:
4288
4289 *`AnnotableType`*` (extension)`
4290 *`IdentifiableType`*` (extension)`
4291 *`NameableType`*` (extension)`
4292 *`VersionableType`*` (restriction)`
4293 *`MaintainableBaseType`*` (extension)`
4294 *`MaintainableType`*` (restriction)`
4295 `HierarchyAssociationType`
4296
4297 Attributes:
4298
4299 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
4300
4301 Content:
4302
4303 `Annotations?, Link*, Name+, Description*, LinkedHierarchy, LinkedObject, ContextObject?`
4304
4305 Attribute Documentation:
4306
4307 | **Name** | **Type** | **Documentation** |
4308 | --- --| --- --| --- --|
4309 | id | IDType | The id is the identifier for the object. |
4310 | urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4311 | 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. |
4312 | 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. |
4313 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
4314 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
4315 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
4316 | 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. |
4317 | 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. |
4318 | 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. |
4319 | 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’. |
4320
4321 Element Documentation:
4322
4323 | **Name** | **Type** | **Documentation** |
4324 | --- --| --- --| --- --|
4325 | 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. |
4326 | 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. |
4327 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
4328 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
4329 | LinkedHierarchy | HierarchyReferenceTy pe | The associated hierarchy. |
4330 | LinkedObject | UrnReferenceType | Associates the Identifiable Artefact that needs the Hierarchy. |
4331 | ContextObject | UrnReferenceType | The context within which the association is performed. |
4332
4333 ***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.
4334
4335 Derivation:
4336
4337 *`AnnotableType`*` (extension)`
4338 *`IdentifiableType`*` (extension)`
4339 *`NameableType`*` (extension)`
4340 *`VersionableType`*` (restriction)`
4341 *`MaintainableBaseType`*` (extension)`
4342 *`MaintainableType`*` (restriction)`
4343 *`StructureUsageType`*` (restriction)`
4344 *`MetadataflowBaseType`*
4345
4346 Attributes:
4347
4348 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
4349
4350 Content:
4351
4352 `Annotations?, Link*, Name+, Description*, Structure?`
4353
4354 Attribute Documentation:
4355
4356 | **Name** | **Type** | **Documentation** |
4357 | --- --| --- --| --- --|
4358 | id | IDType | The id is the identifier for the object. |
4359 | urn | MetadataflowUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4360 | 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. |
4361 | 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. |
4362 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
4363 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
4364 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
4365 | 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. |
4366 | 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. |
4367 | 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. |
4368 | 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’. |
4369
4370 Element Documentation:
4371
4372 | **Name** | **Type** | **Documentation** |
4373 | --- --| --- --| --- --|
4374 | 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. |
4375 | 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. |
4376 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
4377 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
4378 | Structure | MetadataStructureRef erenceType | Structure provides a reference to the metadata structure definition describing the structure of all reference metadata for this flow. |
4379
4380 **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
4381
4382 Derivation:
4383
4384 *`AnnotableType`*` (extension)`
4385 *`IdentifiableType`*` (extension)`
4386 *`NameableType`*` (extension)`
4387 *`VersionableType`*` (restriction)`
4388 *`MaintainableBaseType`*` (extension)`
4389 *`MaintainableType`*` (restriction)`
4390 *`StructureUsageType`*` (restriction)`
4391 *`MetadataflowBaseType`*` (extension)`
4392 `MetadataflowType`
4393
4394 Attributes:
4395
4396 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
4397
4398 Content:
4399
4400 `Annotations?, Link*, Name+, Description*, Structure?, Target+`
4401
4402 Attribute Documentation:
4403
4404 | **Name** | **Type** | **Documentation** |
4405 | --- --| --- --| --- --|
4406 | id | IDType | The id is the identifier for the object. |
4407 | urn | MetadataflowUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4408 | 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. |
4409 | 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. |
4410 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
4411 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
4412 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
4413 | 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. |
4414 | 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. |
4415 | 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. |
4416 | 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’. |
4417
4418 Element Documentation:
4419
4420 | **Name** | **Type** | **Documentation** |
4421 | --- --| --- --| --- --|
4422 | 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. |
4423 | 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. |
4424 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
4425 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
4426 | Structure | MetadataStructureRef erenceType | Structure provides a reference to the metadata structure definition describing the structure of all reference metadata for this flow. |
4427 | 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. |
4428
4429 **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.
4430
4431 Derivation:
4432
4433 *`AnnotableType`*` (extension)`
4434 *`IdentifiableType`*` (extension)`
4435 *`NameableType`*` (extension)`
4436 *`VersionableType`*` (restriction)`
4437 *`MaintainableBaseType`*` (extension)`
4438 *`MaintainableType`*` (restriction)`
4439 *`StructureType`*` (restriction)`
4440 `MetadataStructureType`
4441
4442 Attributes:
4443
4444 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
4445
4446 Content:
4447
4448 `Annotations?, Link*, Name+, Description*, MetadataStructureComponents?`
4449
4450 Attribute Documentation:
4451
4452 | **Name** | **Type** | **Documentation** |
4453 | --- --| --- --| --- --|
4454 | id | IDType | The id is the identifier for the object. |
4455 | urn | MetadataStructureUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4456 | 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. |
4457 | 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. |
4458 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
4459 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
4460 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
4461 | 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. |
4462 | 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. |
4463 | 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. |
4464 | 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’. |
4465
4466 Element Documentation:
4467
4468 | **Name** | **Type** | **Documentation** |
4469 | --- --| --- --| --- --|
4470 | 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. |
4471 | 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. |
4472 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
4473 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
4474 | MetadataStructureCom ponents | MetadataStructureCom ponentsType | MetadataStructureComponents defines the grouping of the sets of the components that make up the metadata structure definition. |
4475
4476 **MetadataStructureComponentsBaseType:** MetadataStructureComponentsBaseType is an abstract base type that forms the basis for the MetadataStructureComponentsType.
4477
4478 Derivation:
4479
4480 *`GroupingType`*` (restriction)`
4481 `MetadataStructureComponentsBaseType`
4482
4483 Content:
4484
4485 `{Empty}`
4486
4487 **MetadataStructureComponentsType:** MetadataStructureComponentsType describes the structure of the grouping of the sets of the components that make up the metadata structure definition.
4488
4489 Derivation:
4490
4491 *`GroupingType`*` (restriction)`
4492 `MetadataStructureComponentsBaseType (extension)`
4493 `MetadataStructureComponentsType`
4494
4495 Content:
4496
4497 `MetadataAttributeList`
4498
4499 Element Documentation:
4500
4501 | **Name** | **Type** | **Documentation** |
4502 | --- --| --- --| --- --|
4503 | MetadataAttributeLis t | MetadataAttributeLis tType | 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. |
4504
4505 **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.
4506
4507 Derivation:
4508
4509 *`AnnotableType`*` (extension)`
4510 *`IdentifiableType`*` (extension)`
4511 *`ComponentListType`*` (restriction)`
4512 `MetadataAttributeListType`
4513
4514 Attributes:
4515
4516 `id?, urn?, uri?`
4517
4518 Content:
4519
4520 `Annotations?, Link*, MetadataAttribute+`
4521
4522 Attribute Documentation:
4523
4524 | **Name** | **Type** | **Documentation** |
4525 | --- --| --- --| --- --|
4526 | id (fixed: MetadataAttributeDescriptor) | IDType | The id attribute is provided in this case for completeness. However, its value is fixed to MetadataAttributeDescriptor. |
4527 | urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4528 | 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. |
4529
4530 Element Documentation:
4531
4532 | **Name** | **Type** | **Documentation** |
4533 | --- --| --- --| --- --|
4534 | 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. |
4535 | 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. |
4536 | MetadataAttribute | MetadataAttributeTyp e | 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. |
4537
4538 ***MetadataAttributeBaseType*:** MetadataAttributeBaseType is an abstract base type the serves as the basis for the MetadataAttributeType.
4539
4540 Derivation:
4541
4542 *`AnnotableType`*` (extension)`
4543 *`IdentifiableType`*` (extension)`
4544 *`ComponentBaseType`*` (extension)`
4545 *`ComponentType`*` (restriction)`
4546 *`MetadataAttributeBaseType`*
4547
4548 Attributes:
4549
4550 `id?, urn?, uri?`
4551
4552 Content:
4553
4554 `Annotations?, Link*, ConceptIdentity, LocalRepresentation?`
4555
4556 Attribute Documentation:
4557
4558 | **Name** | **Type** | **Documentation** |
4559 | --- --| --- --| --- --|
4560 | 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). |
4561 | urn | MetadataAttributeUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4562 | 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. |
4563
4564 Element Documentation:
4565
4566 | **Name** | **Type** | **Documentation** |
4567 | --- --| --- --| --- --|
4568 | 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. |
4569 | 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. |
4570 | 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. |
4571 | LocalRepresentation | MetadataAttributeRep resentationType | 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. |
4572
4573 **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.
4574
4575 Derivation:
4576
4577 *`AnnotableType`*` (extension)`
4578 *`IdentifiableType`*` (extension)`
4579 *`ComponentBaseType`*` (extension)`
4580 *`ComponentType`*` (restriction)`
4581 *`MetadataAttributeBaseType`*` (extension)`
4582 `MetadataAttributeType`
4583
4584 Attributes:
4585
4586 `id?, urn?, uri?, minOccurs?, maxOccurs?, isPresentational?`
4587
4588 Content:
4589
4590 `Annotations?, Link*, ConceptIdentity, LocalRepresentation?, MetadataAttribute*`
4591
4592 Attribute Documentation:
4593
4594 | **Name** | **Type** | **Documentation** |
4595 | --- --| --- --| --- --|
4596 | 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). |
4597 | urn | MetadataAttributeUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4598 | 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. |
4599 | minOccurs (default: 1) | xs: nonNegativeInteger | The minOccurs attribute indicates the minimum number of times this metadata attribute must occur within its parent object. |
4600 | maxOccurs (default: 1) | OccurenceType | The maxOccurs attribute indicates the maximum number of times this metadata attribute can occur within its parent object. |
4601 | 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. |
4602
4603 Element Documentation:
4604
4605 | **Name** | **Type** | **Documentation** |
4606 | --- --| --- --| --- --|
4607 | 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. |
4608 | 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. |
4609 | 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. |
4610 | LocalRepresentation | MetadataAttributeRep resentationType | 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. |
4611 | MetadataAttribute | MetadataAttributeTyp e | 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. |
4612
4613 **MetadataAttributeRepresentationType:** MetadataAttributeRepresentationType defines the possible local representations of a metadata attribute.
4614
4615 Derivation:
4616
4617 *`RepresentationType`*` (restriction)`
4618 `MetadataAttributeRepresentationType`
4619
4620 Content:
4621
4622 `(TextFormat | (Enumeration, EnumerationFormat?))`
4623
4624 Element Documentation:
4625
4626 | **Name** | **Type** | **Documentation** |
4627 | --- --| --- --| --- --|
4628 | TextFormat | BasicComponentTextFo rmatType | TextFormat describes an uncoded textual format. |
4629 | Enumeration | CodelistReferenceTyp e | Enumeration references an item scheme that enumerates the allowable values for this representation. |
4630 | EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |
4631
4632 ***OrganisationSchemeBaseType*:** OrganisationSchemeBaseType is an abstract base type for any organisation scheme.
4633
4634 Derivation:
4635
4636 *`AnnotableType`*` (extension)`
4637 *`IdentifiableType`*` (extension)`
4638 *`NameableType`*` (extension)`
4639 *`VersionableType`*` (restriction)`
4640 *`MaintainableBaseType`*` (extension)`
4641 *`MaintainableType`*` (restriction)`
4642 *`ItemSchemeType`*` (restriction)`
4643 *`OrganisationSchemeBaseType`*
4644
4645 Attributes:
4646
4647 `id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`
4648
4649 Content:
4650
4651 `Annotations?, Link*, Name+, Description*`
4652
4653 Attribute Documentation:
4654
4655 | **Name** | **Type** | **Documentation** |
4656 | --- --| --- --| --- --|
4657 | id | IDType | The id is the identifier for the object. |
4658 | urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4659 | 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. |
4660 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
4661 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
4662 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
4663 | 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. |
4664 | 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. |
4665 | 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. |
4666 | 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’. |
4667 | 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. |
4668
4669 Element Documentation:
4670
4671 | **Name** | **Type** | **Documentation** |
4672 | --- --| --- --| --- --|
4673 | 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. |
4674 | 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. |
4675 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
4676 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
4677
4678 ***OrganisationSchemeType*:** OrganisationSchemeType describes the structure of an organisation scheme.
4679
4680 Derivation:
4681
4682 *`AnnotableType`*` (extension)`
4683 *`IdentifiableType`*` (extension)`
4684 *`NameableType`*` (extension)`
4685 *`VersionableType`*` (restriction)`
4686 *`MaintainableBaseType`*` (extension)`
4687 *`MaintainableType`*` (restriction)`
4688 *`ItemSchemeType`*` (restriction)`
4689 *`OrganisationSchemeBaseType`*` (extension)`
4690 *`OrganisationSchemeType`*
4691
4692 Attributes:
4693
4694 `id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`
4695
4696 Content:
4697
4698 `Annotations?, Link*, Name+, Description*, `*`Organisation*`*
4699
4700 Attribute Documentation:
4701
4702 | **Name** | **Type** | **Documentation** |
4703 | --- --| --- --| --- --|
4704 | id | IDType | The id is the identifier for the object. |
4705 | urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4706 | 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. |
4707 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
4708 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
4709 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
4710 | 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. |
4711 | 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. |
4712 | 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. |
4713 | 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’. |
4714 | 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. |
4715
4716 Element Documentation:
4717
4718 | **Name** | **Type** | **Documentation** |
4719 | --- --| --- --| --- --|
4720 | 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. |
4721 | 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. |
4722 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
4723 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
4724 | *Organisation* | *OrganisationType* | Organisation is an abstract substitution head for a generic organisation. |
4725
4726 ***BaseOrganisationType*:** BaseOrganisationType is an abstract base type the forms the basis for the OrganisationType.
4727
4728 Derivation:
4729
4730 *`AnnotableType`*` (extension)`
4731 *`IdentifiableType`*` (extension)`
4732 *`NameableType`*` (restriction)`
4733 *`ItemBaseType`*` (extension)`
4734 *`ItemType`*` (restriction)`
4735 *`BaseOrganisationType`*
4736
4737 Attributes:
4738
4739 `id, urn?, uri?`
4740
4741 Content:
4742
4743 `Annotations?, Link*, Name+, Description*, Parent?`
4744
4745 Attribute Documentation:
4746
4747 | **Name** | **Type** | **Documentation** |
4748 | --- --| --- --| --- --|
4749 | id | IDType | The id is the identifier for the object. |
4750 | urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4751 | 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. |
4752
4753 Element Documentation:
4754
4755 | **Name** | **Type** | **Documentation** |
4756 | --- --| --- --| --- --|
4757 | 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. |
4758 | 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. |
4759 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
4760 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
4761 | 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. |
4762
4763 ***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.
4764
4765 Derivation:
4766
4767 *`AnnotableType`*` (extension)`
4768 *`IdentifiableType`*` (extension)`
4769 *`NameableType`*` (restriction)`
4770 *`ItemBaseType`*` (extension)`
4771 *`ItemType`*` (restriction)`
4772 *`BaseOrganisationType`*` (extension)`
4773 *`OrganisationType`*
4774
4775 Attributes:
4776
4777 `id, urn?, uri?`
4778
4779 Content:
4780
4781 `Annotations?, Link*, Name+, Description*, Parent?, Contact*`
4782
4783 Attribute Documentation:
4784
4785 | **Name** | **Type** | **Documentation** |
4786 | --- --| --- --| --- --|
4787 | id | IDType | The id is the identifier for the object. |
4788 | urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4789 | 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. |
4790
4791 Element Documentation:
4792
4793 | **Name** | **Type** | **Documentation** |
4794 | --- --| --- --| --- --|
4795 | 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. |
4796 | 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. |
4797 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
4798 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
4799 | 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. |
4800 | Contact | ContactType | Contact describes a contact for the organisation, |
4801
4802 **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.
4803
4804 Derivation:
4805
4806 *`AnnotableType`*` (extension)`
4807 *`IdentifiableType`*` (extension)`
4808 *`NameableType`*` (extension)`
4809 *`VersionableType`*` (restriction)`
4810 *`MaintainableBaseType`*` (extension)`
4811 *`MaintainableType`*` (restriction)`
4812 *`ItemSchemeType`*` (restriction)`
4813 *`OrganisationSchemeBaseType`*` (extension)`
4814 *`OrganisationSchemeType`*` (restriction)`
4815 `AgencySchemeType`
4816
4817 Attributes:
4818
4819 `id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`
4820
4821 Content:
4822
4823 `Annotations?, Link*, Name+, Description*, Agency*`
4824
4825 Attribute Documentation:
4826
4827 | **Name** | **Type** | **Documentation** |
4828 | --- --| --- --| --- --|
4829 | id (fixed: AGENCIES) | IDType | The id is the identifier for the object. |
4830 | urn | AgencySchemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4831 | 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. |
4832 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
4833 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
4834 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
4835 | 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. |
4836 | 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. |
4837 | 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. |
4838 | 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’. |
4839 | 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. |
4840
4841 Element Documentation:
4842
4843 | **Name** | **Type** | **Documentation** |
4844 | --- --| --- --| --- --|
4845 | 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. |
4846 | 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. |
4847 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
4848 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
4849 | Agency | AgencyType | Agency is an organisation which maintains structural metadata such as classifications, concepts, data structures, and metadata structures. |
4850
4851 **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.
4852
4853 Derivation:
4854
4855 *`AnnotableType`*` (extension)`
4856 *`IdentifiableType`*` (extension)`
4857 *`NameableType`*` (extension)`
4858 *`VersionableType`*` (restriction)`
4859 *`MaintainableBaseType`*` (extension)`
4860 *`MaintainableType`*` (restriction)`
4861 *`ItemSchemeType`*` (restriction)`
4862 *`OrganisationSchemeBaseType`*` (extension)`
4863 *`OrganisationSchemeType`*` (restriction)`
4864 ` DataConsumerSchemeType`
4865
4866 Attributes:
4867
4868 `id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`
4869
4870 Content:
4871
4872 `Annotations?, Link*, Name+, Description*, DataConsumer*`
4873
4874 Attribute Documentation:
4875
4876 | **Name** | **Type** | **Documentation** |
4877 | --- --| --- --| --- --|
4878 | id (fixed: DATA\_CONSUMERS) | IDType | The id is the identifier for the object. |
4879 | urn | DataConsumerSchemeUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4880 | 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. |
4881 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
4882 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
4883 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
4884 | 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. |
4885 | 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. |
4886 | 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. |
4887 | 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’. |
4888 | 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. |
4889
4890 Element Documentation:
4891
4892 | **Name** | **Type** | **Documentation** |
4893 | --- --| --- --| --- --|
4894 | 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. |
4895 | 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. |
4896 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
4897 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
4898 | DataConsumer | DataConsumerType | DataConsumer describes an organisation using data as input for further processing. |
4899
4900 **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
4901
4902 Derivation:
4903
4904 *`AnnotableType`*` (extension)`
4905 *`IdentifiableType`*` (extension)`
4906 *`NameableType`*` (extension)`
4907 *`VersionableType`*` (restriction)`
4908 *`MaintainableBaseType`*` (extension)`
4909 *`MaintainableType`*` (restriction)`
4910 *`ItemSchemeType`*` (restriction)`
4911 *`OrganisationSchemeBaseType`*` (extension)`
4912 *`OrganisationSchemeType`*` (restriction)`
4913 `DataProviderSchemeType`
4914
4915 Attributes:
4916
4917 `id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`
4918
4919 Content:
4920
4921 `Annotations?, Link*, Name+, Description*, DataProvider*`
4922
4923 Attribute Documentation:
4924
4925 | **Name** | **Type** | **Documentation** |
4926 | --- --| --- --| --- --|
4927 | id (fixed: DATA\_PROVIDERS) | IDType | The id is the identifier for the object. |
4928 | urn | DataProviderSchemeUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4929 | 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. |
4930 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
4931 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
4932 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
4933 | 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. |
4934 | 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. |
4935 | 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. |
4936 | 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’. |
4937 | 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. |
4938
4939 Element Documentation:
4940
4941 | **Name** | **Type** | **Documentation** |
4942 | --- --| --- --| --- --|
4943 | 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. |
4944 | 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. |
4945 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
4946 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
4947 | DataProvider | DataProviderType | DataProvider describes an organisation that produces data. |
4948
4949 **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
4950
4951 Derivation:
4952
4953 *`AnnotableType`*` (extension)`
4954 *`IdentifiableType`*` (extension)`
4955 *`NameableType`*` (extension)`
4956 *`VersionableType`*` (restriction)`
4957 *`MaintainableBaseType`*` (extension)`
4958 *`MaintainableType`*` (restriction)`
4959 *`ItemSchemeType`*` (restriction)`
4960 *`OrganisationSchemeBaseType`*` (extension)`
4961 *`OrganisationSchemeType`*` (restriction)`
4962 `MetadataProviderSchemeType`
4963
4964 Attributes:
4965
4966 `id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`
4967
4968 Content:
4969
4970 `Annotations?, Link*, Name+, Description*, MetadataProvider*`
4971
4972 Attribute Documentation:
4973
4974 | **Name** | **Type** | **Documentation** |
4975 | --- --| --- --| --- --|
4976 | id (fixed: METADATA\_PROVIDERS) | IDType | The id is the identifier for the object. |
4977 | urn | MetadataProviderSche meUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
4978 | 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. |
4979 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
4980 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
4981 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
4982 | 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. |
4983 | 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. |
4984 | 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. |
4985 | 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’. |
4986 | 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. |
4987
4988 Element Documentation:
4989
4990 | **Name** | **Type** | **Documentation** |
4991 | --- --| --- --| --- --|
4992 | 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. |
4993 | 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. |
4994 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
4995 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
4996 | MetadataProvider | MetadataProviderType | MetadataProvider describes an organisation that produces metadata . |
4997
4998 **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.
4999
5000 Derivation:
5001
5002 *`AnnotableType`*` (extension)`
5003 *`IdentifiableType`*` (extension)`
5004 *`NameableType`*` (extension)`
5005 *`VersionableType`*` (restriction)`
5006 *`MaintainableBaseType`*` (extension)`
5007 *`MaintainableType`*` (restriction)`
5008 *`ItemSchemeType`*` (restriction)`
5009 *`OrganisationSchemeBaseType`*` (extension)`
5010 *`OrganisationSchemeType`*` (restriction)`
5011 `OrganisationUnitSchemeType`
5012
5013 Attributes:
5014
5015 `id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`
5016
5017 Content:
5018
5019 `Annotations?, Link*, Name+, Description*, OrganisationUnit*`
5020
5021 Attribute Documentation:
5022
5023 | **Name** | **Type** | **Documentation** |
5024 | --- --| --- --| --- --|
5025 | id | IDType | The id is the identifier for the object. |
5026 | urn | OrganisationUnitSche meUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5027 | 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. |
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 | 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. |
5036
5037 Element Documentation:
5038
5039 | **Name** | **Type** | **Documentation** |
5040 | --- --| --- --| --- --|
5041 | 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. |
5042 | 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. |
5043 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5044 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5045 | OrganisationUnit | OrganisationUnitType | OrganisationUnit describes a generic organisation, which serves not predefined role in SDMX. |
5046
5047 **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.
5048
5049 Derivation:
5050
5051 *`AnnotableType`*` (extension)`
5052 *`IdentifiableType`*` (extension)`
5053 *`NameableType`*` (restriction)`
5054 *`ItemBaseType`*` (extension)`
5055 *`ItemType`*` (restriction)`
5056 *`BaseOrganisationType`*` (extension)`
5057 *`OrganisationType`*` (restriction)`
5058 `AgencyType`
5059
5060 Attributes:
5061
5062 `id, urn?, uri?`
5063
5064 Content:
5065
5066 `Annotations?, Link*, Name+, Description*, Contact*`
5067
5068 Attribute Documentation:
5069
5070 | **Name** | **Type** | **Documentation** |
5071 | --- --| --- --| --- --|
5072 | 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). |
5073 | urn | AgencyUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5074 | 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. |
5075
5076 Element Documentation:
5077
5078 | **Name** | **Type** | **Documentation** |
5079 | --- --| --- --| --- --|
5080 | 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. |
5081 | 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. |
5082 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5083 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5084 | Contact | ContactType | Contact describes a contact for the organisation, |
5085
5086 **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.
5087
5088 Derivation:
5089
5090 *`AnnotableType`*` (extension)`
5091 *`IdentifiableType`*` (extension)`
5092 *`NameableType`*` (restriction)`
5093 *`ItemBaseType`*` (extension)`
5094 *`ItemType`*` (restriction)`
5095 *`BaseOrganisationType`*` (extension)`
5096 *`OrganisationType`*` (restriction)`
5097 `DataConsumerType`
5098
5099 Attributes:
5100
5101 `id, urn?, uri?`
5102
5103 Content:
5104
5105 `Annotations?, Link*, Name+, Description*, Contact*`
5106
5107 Attribute Documentation:
5108
5109 | **Name** | **Type** | **Documentation** |
5110 | --- --| --- --| --- --|
5111 | id | IDType | The id is the identifier for the object. |
5112 | urn | DataConsumerUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5113 | 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. |
5114
5115 Element Documentation:
5116
5117 | **Name** | **Type** | **Documentation** |
5118 | --- --| --- --| --- --|
5119 | 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. |
5120 | 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. |
5121 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5122 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5123 | Contact | ContactType | Contact describes a contact for the organisation, |
5124
5125 **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.
5126
5127 Derivation:
5128
5129 *`AnnotableType`*` (extension)`
5130 *`IdentifiableType`*` (extension)`
5131 *`NameableType`*` (restriction)`
5132 *`ItemBaseType`*` (extension)`
5133 *`ItemType`*` (restriction)`
5134 *`BaseOrganisationType`*` (extension)`
5135 *`OrganisationType`*` (restriction)`
5136 `DataProviderType`
5137
5138 Attributes:
5139
5140 `id, urn?, uri?`
5141
5142 Content:
5143
5144 `Annotations?, Link*, Name+, Description*, Contact*`
5145
5146 Attribute Documentation:
5147
5148 | **Name** | **Type** | **Documentation** |
5149 | --- --| --- --| --- --|
5150 | id | IDType | The id is the identifier for the object. |
5151 | urn | DataProviderUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5152 | 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. |
5153
5154 Element Documentation:
5155
5156 | **Name** | **Type** | **Documentation** |
5157 | --- --| --- --| --- --|
5158 | 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. |
5159 | 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. |
5160 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5161 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5162 | Contact | ContactType | Contact describes a contact for the organisation, |
5163
5164 **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.
5165
5166 Derivation:
5167
5168 *`AnnotableType`*` (extension)`
5169 *`IdentifiableType`*` (extension)`
5170 *`NameableType`*` (restriction)`
5171 *`ItemBaseType`*` (extension)`
5172 *`ItemType`*` (restriction)`
5173 *`BaseOrganisationType`*` (extension)`
5174 *`OrganisationType`*` (restriction)`
5175 `MetadataProviderType`
5176
5177 Attributes:
5178
5179 `id, urn?, uri?`
5180
5181 Content:
5182
5183 `Annotations?, Link*, Name+, Description*, Contact*`
5184
5185 Attribute Documentation:
5186
5187 | **Name** | **Type** | **Documentation** |
5188 | --- --| --- --| --- --|
5189 | id | IDType | The id is the identifier for the object. |
5190 | urn | MetadataProviderUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5191 | 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. |
5192
5193 Element Documentation:
5194
5195 | **Name** | **Type** | **Documentation** |
5196 | --- --| --- --| --- --|
5197 | 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. |
5198 | 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. |
5199 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5200 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5201 | Contact | ContactType | Contact describes a contact for the organisation, |
5202
5203 **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.
5204
5205 Derivation:
5206
5207 *`AnnotableType`*` (extension)`
5208 *`IdentifiableType`*` (extension)`
5209 *`NameableType`*` (restriction)`
5210 *`ItemBaseType`*` (extension)`
5211 *`ItemType`*` (restriction)`
5212 *`BaseOrganisationType`*` (extension)`
5213 *`OrganisationType`*` (restriction)`
5214 `OrganisationUnitType`
5215
5216 Attributes:
5217
5218 `id, urn?, uri?`
5219
5220 Content:
5221
5222 `Annotations?, Link*, Name+, Description*, Parent?, Contact*`
5223
5224 Attribute Documentation:
5225
5226 | **Name** | **Type** | **Documentation** |
5227 | --- --| --- --| --- --|
5228 | id | IDType | The id is the identifier for the object. |
5229 | urn | OrganisationUnitUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5230 | 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. |
5231
5232 Element Documentation:
5233
5234 | **Name** | **Type** | **Documentation** |
5235 | --- --| --- --| --- --|
5236 | 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. |
5237 | 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. |
5238 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5239 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5240 | 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. |
5241 | Contact | ContactType | Contact describes a contact for the organisation, |
5242
5243 **ContactType:** ContactType describes the structure of a contact's details.
5244
5245 Attributes:
5246
5247 `id?`
5248
5249 Content:
5250
5251 `Name*, Department*, Role*, (Telephone | Fax | X400 | URI | Email)*`
5252
5253 Attribute Documentation:
5254
5255 | **Name** | **Type** | **Documentation** |
5256 | --- --| --- --| --- --|
5257 | id | IDType | The id attribute is used to carry user id information for the contact. |
5258
5259 Element Documentation:
5260
5261 | **Name** | **Type** | **Documentation** |
5262 | --- --| --- --| --- --|
5263 | Name | TextType | Name is a reusable element, used for providing a human-readable name for an object. |
5264 | Department | TextType | Department is designation of the organisational structure by a linguistic expression, within which the contact person works. |
5265 | Role | TextType | Role is the responsibility of the contact person with respect to the object for which this person is the contact. |
5266 | Telephone | xs:string | Telephone holds the telephone number for the contact person. |
5267 | Fax | xs:string | Fax holds the fax number for the contact person. |
5268 | X400 | xs:string | X400 holds the X.400 address for the contact person. |
5269 | URI | xs:anyURI | URI holds an information URL for the contact person. |
5270 | Email | xs:string | Email holds the email address for the contact person. |
5271
5272 ***ProvisionAgreementBaseType*:** ProvisionAgreementBaseType defines the base refinement of the ProvisionAgreementType. Its purpose is to retrict the urn attribute.
5273
5274 Derivation:
5275
5276 *`AnnotableType`*` (extension)`
5277 *`IdentifiableType`*` (extension)`
5278 *`NameableType`*` (extension)`
5279 *`VersionableType`*` (restriction)`
5280 *`MaintainableBaseType`*` (extension)`
5281 *`MaintainableType`*` (restriction)`
5282 *`ProvisionAgreementBaseType`*
5283
5284 Attributes:
5285
5286 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
5287
5288 Content:
5289
5290 `Annotations?, Link*, Name+, Description*`
5291
5292 Attribute Documentation:
5293
5294 | **Name** | **Type** | **Documentation** |
5295 | --- --| --- --| --- --|
5296 | id | IDType | The id is the identifier for the object. |
5297 | urn | ProvisionAgreementUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5298 | 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. |
5299 | 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. |
5300 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
5301 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
5302 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
5303 | 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. |
5304 | 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. |
5305 | 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. |
5306 | 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’. |
5307
5308 Element Documentation:
5309
5310 | **Name** | **Type** | **Documentation** |
5311 | --- --| --- --| --- --|
5312 | 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. |
5313 | 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. |
5314 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5315 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5316
5317 **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.
5318
5319 Derivation:
5320
5321 *`AnnotableType`*` (extension)`
5322 *`IdentifiableType`*` (extension)`
5323 *`NameableType`*` (extension)`
5324 *`VersionableType`*` (restriction)`
5325 *`MaintainableBaseType`*` (extension)`
5326 *`MaintainableType`*` (restriction)`
5327 *`ProvisionAgreementBaseType`*` (extension)`
5328 `ProvisionAgreementType`
5329
5330 Attributes:
5331
5332 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
5333
5334 Content:
5335
5336 `Annotations?, Link*, Name+, Description*, Dataflow, DataProvider`
5337
5338 Attribute Documentation:
5339
5340 | **Name** | **Type** | **Documentation** |
5341 | --- --| --- --| --- --|
5342 | id | IDType | The id is the identifier for the object. |
5343 | urn | ProvisionAgreementUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5344 | 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. |
5345 | 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. |
5346 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
5347 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
5348 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
5349 | 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. |
5350 | 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. |
5351 | 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. |
5352 | 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’. |
5353
5354 Element Documentation:
5355
5356 | **Name** | **Type** | **Documentation** |
5357 | --- --| --- --| --- --|
5358 | 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. |
5359 | 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. |
5360 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5361 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5362 | 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. |
5363 | 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. |
5364
5365 ***MetadataProvisionAgreementBaseType*:** MetadataProvisionAgreementBaseType defines the base refinement of the MetadataProvisionAgreementType. Its purpose is to retrict the urn attribute.
5366
5367 Derivation:
5368
5369 *`AnnotableType`*` (extension)`
5370 *`IdentifiableType`*` (extension)`
5371 *`NameableType`*` (extension)`
5372 *`VersionableType`*` (restriction)`
5373 *`MaintainableBaseType`*` (extension)`
5374 *`MaintainableType`*` (restriction)`
5375 *`MetadataProvisionAgreementBaseType`*
5376
5377 Attributes:
5378
5379 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
5380
5381 Content:
5382
5383 `Annotations?, Link*, Name+, Description*`
5384
5385 Attribute Documentation:
5386
5387 | **Name** | **Type** | **Documentation** |
5388 | --- --| --- --| --- --|
5389 | id | IDType | The id is the identifier for the object. |
5390 | urn | MetadataProvisionAgr eementUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5391 | 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. |
5392 | 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. |
5393 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
5394 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
5395 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
5396 | 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. |
5397 | 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. |
5398 | 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. |
5399 | 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’. |
5400
5401 Element Documentation:
5402
5403 | **Name** | **Type** | **Documentation** |
5404 | --- --| --- --| --- --|
5405 | 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. |
5406 | 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. |
5407 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5408 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5409
5410 **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.
5411
5412 Derivation:
5413
5414 *`AnnotableType`*` (extension)`
5415 *`IdentifiableType`*` (extension)`
5416 *`NameableType`*` (extension)`
5417 *`VersionableType`*` (restriction)`
5418 *`MaintainableBaseType`*` (extension)`
5419 *`MaintainableType`*` (restriction)`
5420 *`MetadataProvisionAgreementBaseType`*` (extension)`
5421 `MetadataProvisionAgreementType`
5422
5423 Attributes:
5424
5425 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
5426
5427 Content:
5428
5429 `Annotations?, Link*, Name+, Description*, Metadataflow, MetadataProvider, Target*`
5430
5431 Attribute Documentation:
5432
5433 | **Name** | **Type** | **Documentation** |
5434 | --- --| --- --| --- --|
5435 | id | IDType | The id is the identifier for the object. |
5436 | urn | MetadataProvisionAgr eementUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5437 | 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. |
5438 | 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. |
5439 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
5440 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
5441 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
5442 | 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. |
5443 | 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. |
5444 | 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. |
5445 | 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’. |
5446
5447 Element Documentation:
5448
5449 | **Name** | **Type** | **Documentation** |
5450 | --- --| --- --| --- --|
5451 | 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. |
5452 | 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. |
5453 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5454 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5455 | Metadataflow | MetadataflowReferenc eType | 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. |
5456 | MetadataProvider | MetadataProviderRefe renceType | 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. |
5457 | Target | WildcardUrnType | 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. |
5458
5459 ***ProcessBaseType*:** ProcessBaseType defines the base refinement of the ProcessType. Its purpose is to retrict the urn attribute.
5460
5461 Derivation:
5462
5463 *`AnnotableType`*` (extension)`
5464 *`IdentifiableType`*` (extension)`
5465 *`NameableType`*` (extension)`
5466 *`VersionableType`*` (restriction)`
5467 *`MaintainableBaseType`*` (extension)`
5468 *`MaintainableType`*` (restriction)`
5469 *`ProcessBaseType`*
5470
5471 Attributes:
5472
5473 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
5474
5475 Content:
5476
5477 `Annotations?, Link*, Name+, Description*`
5478
5479 Attribute Documentation:
5480
5481 | **Name** | **Type** | **Documentation** |
5482 | --- --| --- --| --- --|
5483 | id | IDType | The id is the identifier for the object. |
5484 | urn | ProcessUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5485 | 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. |
5486 | 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. |
5487 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
5488 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
5489 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
5490 | 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. |
5491 | 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. |
5492 | 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. |
5493 | 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’. |
5494
5495 Element Documentation:
5496
5497 | **Name** | **Type** | **Documentation** |
5498 | --- --| --- --| --- --|
5499 | 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. |
5500 | 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. |
5501 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5502 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5503
5504 **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.
5505
5506 Derivation:
5507
5508 *`AnnotableType`*` (extension)`
5509 *`IdentifiableType`*` (extension)`
5510 *`NameableType`*` (extension)`
5511 *`VersionableType`*` (restriction)`
5512 *`MaintainableBaseType`*` (extension)`
5513 *`MaintainableType`*` (restriction)`
5514 *`ProcessBaseType`*` (extension)`
5515 `ProcessType`
5516
5517 Attributes:
5518
5519 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
5520
5521 Content:
5522
5523 `Annotations?, Link*, Name+, Description*, ProcessStep*`
5524
5525 Attribute Documentation:
5526
5527 | **Name** | **Type** | **Documentation** |
5528 | --- --| --- --| --- --|
5529 | id | IDType | The id is the identifier for the object. |
5530 | urn | ProcessUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5531 | 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. |
5532 | 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. |
5533 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
5534 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
5535 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
5536 | 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. |
5537 | 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. |
5538 | 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. |
5539 | 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’. |
5540
5541 Element Documentation:
5542
5543 | **Name** | **Type** | **Documentation** |
5544 | --- --| --- --| --- --|
5545 | 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. |
5546 | 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. |
5547 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5548 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5549 | 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. |
5550
5551 ***ProcessStepBaseType*:** ProcessStepBaseType is an abstract base type used as the basis for the ProcessStepType.
5552
5553 Derivation:
5554
5555 *`AnnotableType`*` (extension)`
5556 *`IdentifiableType`*` (extension)`
5557 *`NameableType`*` (restriction)`
5558 *`ProcessStepBaseType`*
5559
5560 Attributes:
5561
5562 `id, urn?, uri?`
5563
5564 Content:
5565
5566 `Annotations?, Link*, Name+, Description*`
5567
5568 Attribute Documentation:
5569
5570 | **Name** | **Type** | **Documentation** |
5571 | --- --| --- --| --- --|
5572 | id | IDType | The id is the identifier for the object. |
5573 | urn | ProcessStepUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5574 | 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. |
5575
5576 Element Documentation:
5577
5578 | **Name** | **Type** | **Documentation** |
5579 | --- --| --- --| --- --|
5580 | 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. |
5581 | 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. |
5582 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5583 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5584
5585 **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.
5586
5587 Derivation:
5588
5589 *`AnnotableType`*` (extension)`
5590 *`IdentifiableType`*` (extension)`
5591 *`NameableType`*` (restriction)`
5592 *`ProcessStepBaseType`*` (extension)`
5593 `ProcessStepType`
5594
5595 Attributes:
5596
5597 `id, urn?, uri?`
5598
5599 Content:
5600
5601 `Annotations?, Link*, Name+, Description*, Input*, Output*, Computation?, Transition*, ProcessStep*`
5602
5603 Attribute Documentation:
5604
5605 | **Name** | **Type** | **Documentation** |
5606 | --- --| --- --| --- --|
5607 | id | IDType | The id is the identifier for the object. |
5608 | urn | ProcessStepUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5609 | 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. |
5610
5611 Element Documentation:
5612
5613 | **Name** | **Type** | **Documentation** |
5614 | --- --| --- --| --- --|
5615 | 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. |
5616 | 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. |
5617 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5618 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5619 | Input | InputOutputType | Input references an object which is an input to the process step. |
5620 | Output | InputOutputType | Output references an object which is an output form the process step. |
5621 | 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. |
5622 | 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. |
5623 | 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. |
5624
5625 ***TransitionBaseType*:** TransitionBaseType defines the base refinement of the TransitionType. Its purpose is to retrict the urn attribute.
5626
5627 Derivation:
5628
5629 *`AnnotableType`*` (extension)`
5630 *`IdentifiableType`*` (extension)`
5631 *`TransitionBaseType`*
5632
5633 Attributes:
5634
5635 `id?, urn?, uri?`
5636
5637 Content:
5638
5639 `Annotations?, Link*`
5640
5641 Attribute Documentation:
5642
5643 | **Name** | **Type** | **Documentation** |
5644 | --- --| --- --| --- --|
5645 | id | IDType | The id is the identifier for the object. |
5646 | urn | TransitionUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5647 | 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. |
5648
5649 Element Documentation:
5650
5651 | **Name** | **Type** | **Documentation** |
5652 | --- --| --- --| --- --|
5653 | 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. |
5654 | 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. |
5655
5656 **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.
5657
5658 Derivation:
5659
5660 *`AnnotableType`*` (extension)`
5661 *`IdentifiableType`*` (extension)`
5662 *`TransitionBaseType`*` (extension)`
5663 `TransitionType`
5664
5665 Attributes:
5666
5667 `id?, urn?, uri?, localID?`
5668
5669 Content:
5670
5671 `Annotations?, Link*, TargetStep, Condition+`
5672
5673 Attribute Documentation:
5674
5675 | **Name** | **Type** | **Documentation** |
5676 | --- --| --- --| --- --|
5677 | id | IDType | The id is the identifier for the object. |
5678 | urn | TransitionUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5679 | 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. |
5680 | localID | IDType | The localID attribute is an optional identification for the transition within the process. |
5681
5682 Element Documentation:
5683
5684 | **Name** | **Type** | **Documentation** |
5685 | --- --| --- --| --- --|
5686 | 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. |
5687 | 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. |
5688 | TargetStep | NestedIDType | TargetStep references a process step within the process that should be transitioned to, should the conditions described be met. |
5689 | 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. |
5690
5691 **ComputationType:** ComputationType describes a computation in a process.
5692
5693 Derivation:
5694
5695 *`AnnotableType`*` (extension)`
5696 `ComputationType`
5697
5698 Attributes:
5699
5700 `localID?, softwarePackage?, softwareLanguage?, softwareVersion?`
5701
5702 Content:
5703
5704 `Annotations?, Description+`
5705
5706 Attribute Documentation:
5707
5708 | **Name** | **Type** | **Documentation** |
5709 | --- --| --- --| --- --|
5710 | localID | IDType | The localID attribute is an optional identification for the computation within the process. |
5711 | softwarePackage | xs:string | The softwarePackage attribute holds the name of the software package that is used to perform the computation. |
5712 | softwareLanguage | xs:string | The softwareLanguage attribute holds the coding language that the software package used to perform the computation is written in. |
5713 | softwareVersion | xs:string | The softwareVersion attribute hold the version of the software package that is used to perform that computation. |
5714
5715 Element Documentation:
5716
5717 | **Name** | **Type** | **Documentation** |
5718 | --- --| --- --| --- --|
5719 | 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. |
5720 | 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, |
5721
5722 **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.
5723
5724 Derivation:
5725
5726 *`AnnotableType`*` (extension)`
5727 `InputOutputType`
5728
5729 Attributes:
5730
5731 `localID?`
5732
5733 Content:
5734
5735 `Annotations?, ObjectReference`
5736
5737 Attribute Documentation:
5738
5739 | **Name** | **Type** | **Documentation** |
5740 | --- --| --- --| --- --|
5741 | localID | IDType | The localID attribute is an optional identification for the input or output within the process. |
5742
5743 Element Documentation:
5744
5745 | **Name** | **Type** | **Documentation** |
5746 | --- --| --- --| --- --|
5747 | 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. |
5748 | 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. |
5749
5750 **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.
5751
5752 Derivation:
5753
5754 *`AnnotableType`*` (extension)`
5755 *`IdentifiableType`*` (extension)`
5756 *`NameableType`*` (extension)`
5757 *`VersionableType`*` (restriction)`
5758 *`MaintainableBaseType`*` (extension)`
5759 *`MaintainableType`*` (restriction)`
5760 *`ItemSchemeType`*` (restriction)`
5761 `ReportingTaxonomyType`
5762
5763 Attributes:
5764
5765 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`
5766
5767 Content:
5768
5769 `Annotations?, Link*, Name+, Description*, ReportingCategory*`
5770
5771 Attribute Documentation:
5772
5773 | **Name** | **Type** | **Documentation** |
5774 | --- --| --- --| --- --|
5775 | id | IDType | The id is the identifier for the object. |
5776 | urn | ReportingTaxonomyUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5777 | 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. |
5778 | 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. |
5779 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
5780 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
5781 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
5782 | 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. |
5783 | 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. |
5784 | 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. |
5785 | 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’. |
5786 | 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. |
5787
5788 Element Documentation:
5789
5790 | **Name** | **Type** | **Documentation** |
5791 | --- --| --- --| --- --|
5792 | 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. |
5793 | 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. |
5794 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5795 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5796 | ReportingCategory | ReportingCategoryTyp e | ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages. |
5797
5798 ***ReportingCategoryBaseType*:** ReportingCategoryBaseType is an abstract base type that serves as the basis for the ReportingCategoryType.
5799
5800 Derivation:
5801
5802 *`AnnotableType`*` (extension)`
5803 *`IdentifiableType`*` (extension)`
5804 *`NameableType`*` (restriction)`
5805 *`ItemBaseType`*` (extension)`
5806 *`ItemType`*` (restriction)`
5807 *`ReportingCategoryBaseType`*
5808
5809 Attributes:
5810
5811 `id, urn?, uri?`
5812
5813 Content:
5814
5815 `Annotations?, Link*, Name+, Description*, ReportingCategory*`
5816
5817 Attribute Documentation:
5818
5819 | **Name** | **Type** | **Documentation** |
5820 | --- --| --- --| --- --|
5821 | id | IDType | The id is the identifier for the object. |
5822 | urn | ReportingCategoryUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5823 | 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. |
5824
5825 Element Documentation:
5826
5827 | **Name** | **Type** | **Documentation** |
5828 | --- --| --- --| --- --|
5829 | 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. |
5830 | 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. |
5831 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5832 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5833 | ReportingCategory | ReportingCategoryTyp e | ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages. |
5834
5835 **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.
5836
5837 Derivation:
5838
5839 *`AnnotableType`*` (extension)`
5840 *`IdentifiableType`*` (extension)`
5841 *`NameableType`*` (restriction)`
5842 *`ItemBaseType`*` (extension)`
5843 *`ItemType`*` (restriction)`
5844 *`ReportingCategoryBaseType`*` (extension)`
5845 `ReportingCategoryType`
5846
5847 Attributes:
5848
5849 `id, urn?, uri?`
5850
5851 Content:
5852
5853 `Annotations?, Link*, Name+, Description*, ReportingCategory*, (StructuralMetadata* | ProvisioningMetadata*)`
5854
5855 Attribute Documentation:
5856
5857 | **Name** | **Type** | **Documentation** |
5858 | --- --| --- --| --- --|
5859 | id | IDType | The id is the identifier for the object. |
5860 | urn | ReportingCategoryUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5861 | 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. |
5862
5863 Element Documentation:
5864
5865 | **Name** | **Type** | **Documentation** |
5866 | --- --| --- --| --- --|
5867 | 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. |
5868 | 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. |
5869 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5870 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5871 | ReportingCategory | ReportingCategoryTyp e | ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages. |
5872 | StructuralMetadata | StructureReferenceTy pe | 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. |
5873 | ProvisioningMetadata | StructureUsageRefere nceType | 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. |
5874
5875 ***ItemSchemeMapBaseType*:** ItemSchemeMapBaseType is an abstract base type which forms the basis for the ItemSchemeMapType.
5876
5877 Derivation:
5878
5879 *`AnnotableType`*` (extension)`
5880 *`IdentifiableType`*` (extension)`
5881 *`NameableType`*` (extension)`
5882 *`VersionableType`*` (restriction)`
5883 *`MaintainableBaseType`*` (extension)`
5884 *`MaintainableType`*` (restriction)`
5885 *`ItemSchemeMapBaseType`*
5886
5887 Attributes:
5888
5889 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
5890
5891 Content:
5892
5893 `Annotations?, Link*, Name+, Description*`
5894
5895 Attribute Documentation:
5896
5897 | **Name** | **Type** | **Documentation** |
5898 | --- --| --- --| --- --|
5899 | id | IDType | The id is the identifier for the object. |
5900 | urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5901 | 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. |
5902 | 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. |
5903 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
5904 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
5905 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
5906 | 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. |
5907 | 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. |
5908 | 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. |
5909 | 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’. |
5910
5911 Element Documentation:
5912
5913 | **Name** | **Type** | **Documentation** |
5914 | --- --| --- --| --- --|
5915 | 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. |
5916 | 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. |
5917 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5918 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5919
5920 ***ItemSchemeMapType*:** ItemSchemeMapType is an abstract base type which forms the basis for mapping items between item schemes of the same type.
5921
5922 Derivation:
5923
5924 *`AnnotableType`*` (extension)`
5925 *`IdentifiableType`*` (extension)`
5926 *`NameableType`*` (extension)`
5927 *`VersionableType`*` (restriction)`
5928 *`MaintainableBaseType`*` (extension)`
5929 *`MaintainableType`*` (restriction)`
5930 *`ItemSchemeMapBaseType`*` (extension)`
5931 *`ItemSchemeMapType`*
5932
5933 Attributes:
5934
5935 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
5936
5937 Content:
5938
5939 `Annotations?, Link*, Name+, Description*, Source, Target, ItemMap*`
5940
5941 Attribute Documentation:
5942
5943 | **Name** | **Type** | **Documentation** |
5944 | --- --| --- --| --- --|
5945 | id | IDType | The id is the identifier for the object. |
5946 | urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5947 | 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. |
5948 | 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. |
5949 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
5950 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
5951 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
5952 | 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. |
5953 | 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. |
5954 | 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. |
5955 | 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’. |
5956
5957 Element Documentation:
5958
5959 | **Name** | **Type** | **Documentation** |
5960 | --- --| --- --| --- --|
5961 | 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. |
5962 | 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. |
5963 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
5964 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
5965 | Source | MaintainableUrnRefer enceType | Source provides a reference to the item scheme which items are mapped from. |
5966 | Target | MaintainableUrnRefer enceType | Target provides a reference to the item scheme which items are mapped to. |
5967 | ItemMap | SingleValueMappingTy pe | |
5968
5969 **OrganisationSchemeMapType:** OrganisationSchemeMapType defines the structure of a map which identifies relationships between organisations in different organisation schemes.
5970
5971 Derivation:
5972
5973 *`AnnotableType`*` (extension)`
5974 *`IdentifiableType`*` (extension)`
5975 *`NameableType`*` (extension)`
5976 *`VersionableType`*` (restriction)`
5977 *`MaintainableBaseType`*` (extension)`
5978 *`MaintainableType`*` (restriction)`
5979 *`ItemSchemeMapBaseType`*` (extension)`
5980 *`ItemSchemeMapType`*` (restriction)`
5981 `OrganisationSchemeMapType`
5982
5983 Attributes:
5984
5985 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
5986
5987 Content:
5988
5989 `Annotations?, Link*, Name+, Description*, Source, Target, ItemMap*`
5990
5991 Attribute Documentation:
5992
5993 | **Name** | **Type** | **Documentation** |
5994 | --- --| --- --| --- --|
5995 | id | IDType | The id is the identifier for the object. |
5996 | urn | OrganisationSchemeMa pUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
5997 | 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. |
5998 | 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. |
5999 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
6000 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
6001 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
6002 | 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. |
6003 | 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. |
6004 | 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. |
6005 | 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’. |
6006
6007 Element Documentation:
6008
6009 | **Name** | **Type** | **Documentation** |
6010 | --- --| --- --| --- --|
6011 | 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. |
6012 | 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. |
6013 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
6014 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
6015 | Source | OrganisationSchemeRe ferenceType | Source provides a reference to the item scheme which items are mapped from. |
6016 | Target | OrganisationSchemeRe ferenceType | Target provides a reference to the item scheme which items are mapped to. |
6017 | ItemMap | SingleValueMappingTy pe | |
6018
6019 **CategorySchemeMapType:** CategorySchemeMapType defines the structure of a map which identifies relationships between categories in different category schemes.
6020
6021 Derivation:
6022
6023 *`AnnotableType`*` (extension)`
6024 *`IdentifiableType`*` (extension)`
6025 *`NameableType`*` (extension)`
6026 *`VersionableType`*` (restriction)`
6027 *`MaintainableBaseType`*` (extension)`
6028 *`MaintainableType`*` (restriction)`
6029 *`ItemSchemeMapBaseType`*` (extension)`
6030 *`ItemSchemeMapType`*` (restriction)`
6031 `CategorySchemeMapType`
6032
6033 Attributes:
6034
6035 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
6036
6037 Content:
6038
6039 `Annotations?, Link*, Name+, Description*, Source, Target, ItemMap*`
6040
6041 Attribute Documentation:
6042
6043 | **Name** | **Type** | **Documentation** |
6044 | --- --| --- --| --- --|
6045 | id | IDType | The id is the identifier for the object. |
6046 | urn | CategorySchemeMapUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6047 | 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. |
6048 | 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. |
6049 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
6050 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
6051 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
6052 | 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. |
6053 | 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. |
6054 | 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. |
6055 | 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’. |
6056
6057 Element Documentation:
6058
6059 | **Name** | **Type** | **Documentation** |
6060 | --- --| --- --| --- --|
6061 | 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. |
6062 | 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. |
6063 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
6064 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
6065 | Source | CategorySchemeRefere nceType | Source provides a reference to the item scheme which items are mapped from. |
6066 | Target | CategorySchemeRefere nceType | Target provides a reference to the item scheme which items are mapped to. |
6067 | ItemMap | SingleValueMappingTy pe | |
6068
6069 **ConceptSchemeMapType:** ConceptSchemeMapType defines the structure of a map which identifies relationships between concepts in different concept schemes.
6070
6071 Derivation:
6072
6073 *`AnnotableType`*` (extension)`
6074 *`IdentifiableType`*` (extension)`
6075 *`NameableType`*` (extension)`
6076 *`VersionableType`*` (restriction)`
6077 *`MaintainableBaseType`*` (extension)`
6078 *`MaintainableType`*` (restriction)`
6079 *`ItemSchemeMapBaseType`*` (extension)`
6080 *`ItemSchemeMapType`*` (restriction)`
6081 ` ConceptSchemeMapType`
6082
6083 Attributes:
6084
6085 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
6086
6087 Content:
6088
6089 `Annotations?, Link*, Name+, Description*, Source, Target, ItemMap*`
6090
6091 Attribute Documentation:
6092
6093 | **Name** | **Type** | **Documentation** |
6094 | --- --| --- --| --- --|
6095 | id | IDType | The id is the identifier for the object. |
6096 | urn | ConceptSchemeMapUrnT ype | 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 | 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. |
6099 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
6100 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
6101 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
6102 | 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. |
6103 | 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. |
6104 | 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. |
6105 | 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’. |
6106
6107 Element Documentation:
6108
6109 | **Name** | **Type** | **Documentation** |
6110 | --- --| --- --| --- --|
6111 | 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. |
6112 | 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. |
6113 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
6114 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
6115 | Source | ConceptSchemeReferen ceType | Source provides a reference to the item scheme which items are mapped from. |
6116 | Target | ConceptSchemeReferen ceType | Target provides a reference to the item scheme which items are mapped to. |
6117 | ItemMap | SingleValueMappingTy pe | |
6118
6119 **ReportingTaxonomyMapType:** ReportingTaxonomyMapType defines the structure of a map which identifies relationships between reporting categories in different reporting taxonomies.
6120
6121 Derivation:
6122
6123 *`AnnotableType`*` (extension)`
6124 *`IdentifiableType`*` (extension)`
6125 *`NameableType`*` (extension)`
6126 *`VersionableType`*` (restriction)`
6127 *`MaintainableBaseType`*` (extension)`
6128 *`MaintainableType`*` (restriction)`
6129 *`ItemSchemeMapBaseType`*` (extension)`
6130 *`ItemSchemeMapType`*` (restriction)`
6131 `ReportingTaxonomyMapType`
6132
6133 Attributes:
6134
6135 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
6136
6137 Content:
6138
6139 `Annotations?, Link*, Name+, Description*, Source, Target, ItemMap*`
6140
6141 Attribute Documentation:
6142
6143 | **Name** | **Type** | **Documentation** |
6144 | --- --| --- --| --- --|
6145 | id | IDType | The id is the identifier for the object. |
6146 | urn | ReportingTaxonomyMap UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6147 | 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. |
6148 | 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. |
6149 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
6150 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
6151 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
6152 | 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. |
6153 | 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. |
6154 | 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. |
6155 | 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’. |
6156
6157 Element Documentation:
6158
6159 | **Name** | **Type** | **Documentation** |
6160 | --- --| --- --| --- --|
6161 | 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. |
6162 | 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. |
6163 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
6164 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
6165 | Source | ReportingTaxonomyRef erenceType | Source provides a reference to the item scheme which items are mapped from. |
6166 | Target | ReportingTaxonomyRef erenceType | Target provides a reference to the item scheme which items are mapped to. |
6167 | ItemMap | SingleValueMappingTy pe | |
6168
6169 ***StructureMapBaseType*:** StructureMapBaseType defines the base refinement of the StructureMapType. Its purpose is to retrict the urn attribute.
6170
6171 Derivation:
6172
6173 *`AnnotableType`*` (extension)`
6174 *`IdentifiableType`*` (extension)`
6175 *`NameableType`*` (extension)`
6176 *`VersionableType`*` (restriction)`
6177 *`MaintainableBaseType`*` (extension)`
6178 *`MaintainableType`*` (restriction)`
6179 *`StructureMapBaseType`*
6180
6181 Attributes:
6182
6183 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
6184
6185 Content:
6186
6187 `Annotations?, Link*, Name+, Description*`
6188
6189 Attribute Documentation:
6190
6191 | **Name** | **Type** | **Documentation** |
6192 | --- --| --- --| --- --|
6193 | id | IDType | The id is the identifier for the object. |
6194 | urn | StructureMapUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6195 | 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. |
6196 | 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. |
6197 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
6198 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
6199 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
6200 | 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. |
6201 | 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. |
6202 | 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. |
6203 | 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’. |
6204
6205 Element Documentation:
6206
6207 | **Name** | **Type** | **Documentation** |
6208 | --- --| --- --| --- --|
6209 | 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. |
6210 | 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. |
6211 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
6212 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
6213
6214 **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.
6215
6216 Derivation:
6217
6218 *`AnnotableType`*` (extension)`
6219 *`IdentifiableType`*` (extension)`
6220 *`NameableType`*` (extension)`
6221 *`VersionableType`*` (restriction)`
6222 *`MaintainableBaseType`*` (extension)`
6223 *`MaintainableType`*` (restriction)`
6224 *`StructureMapBaseType`*` (extension)`
6225 `StructureMapType`
6226
6227 Attributes:
6228
6229 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
6230
6231 Content:
6232
6233 `Annotations?, Link*, Name+, Description*, Source, Target, EpochMap*, DatePatternMap*, FrequencyFormatMapping*, ComponentMap*, FixedValueMap*`
6234
6235 Attribute Documentation:
6236
6237 | **Name** | **Type** | **Documentation** |
6238 | --- --| --- --| --- --|
6239 | id | IDType | The id is the identifier for the object. |
6240 | urn | StructureMapUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6241 | 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. |
6242 | 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. |
6243 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
6244 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
6245 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
6246 | 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. |
6247 | 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. |
6248 | 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. |
6249 | 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’. |
6250
6251 Element Documentation:
6252
6253 | **Name** | **Type** | **Documentation** |
6254 | --- --| --- --| --- --|
6255 | 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. |
6256 | 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. |
6257 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
6258 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
6259 | Source | StructureOrUsageRefe renceType | 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. |
6260 | Target | StructureOrUsageRefe renceType | 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. |
6261 | 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. |
6262 | DatePatternMap | DatePatternMapType | Provides the ability to map source to target date formats. The source date is described as a pattern (for example MM-YYYY). |
6263 | FrequencyFormatMappi ng | FrequencyFormatMappi ngType | |
6264 | 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. |
6265 | FixedValueMap | FixedValueMapType | FixedValueMap defines a fixed value for a source or target component in the mapping. |
6266
6267 **FixedValueMapType:** FixedValueMapType defines the structure for providing a fixed value for a source or target component.
6268
6269 Derivation:
6270
6271 *`AnnotableType`*` (extension)`
6272 `FixedValueMapType`
6273
6274 Content:
6275
6276 `Annotations?, (Source | Target), Value*`
6277
6278 Element Documentation:
6279
6280 | **Name** | **Type** | **Documentation** |
6281 | --- --| --- --| --- --|
6282 | 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. |
6283 | Source | IDType | |
6284 | Target | IDType | |
6285 | Value | xs:string | The fixed value for the component. |
6286
6287 **ComponentMapType:** ComponentMapType defines the structure for relating a component in a source structure to a component in a target structure.
6288
6289 Derivation:
6290
6291 *`AnnotableType`*` (extension)`
6292 `ComponentMapType`
6293
6294 Content:
6295
6296 `Annotations?, Source+, Target+, RepresentationMap?`
6297
6298 Element Documentation:
6299
6300 | **Name** | **Type** | **Documentation** |
6301 | --- --| --- --| --- --|
6302 | 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. |
6303 | Source | IDType | |
6304 | Target | IDType | |
6305 | RepresentationMap | RepresentationMapRef erenceType | |
6306
6307 ***FrequencyFormatMappingBaseType*:** FrequencyFormatMappingBaseType defines the base refinement of the FrequencyFormatMappingType. Its purpose is to retrict the urn attribute.
6308
6309 Derivation:
6310
6311 *`AnnotableType`*` (extension)`
6312 *`IdentifiableType`*` (extension)`
6313 *`FrequencyFormatMappingBaseType`*
6314
6315 Attributes:
6316
6317 `id?, urn?, uri?`
6318
6319 Content:
6320
6321 `Annotations?, Link*`
6322
6323 Attribute Documentation:
6324
6325 | **Name** | **Type** | **Documentation** |
6326 | --- --| --- --| --- --|
6327 | id | IDType | The id is the identifier for the object. |
6328 | urn | FrequencyFormatMappi ngUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6329 | 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. |
6330
6331 Element Documentation:
6332
6333 | **Name** | **Type** | **Documentation** |
6334 | --- --| --- --| --- --|
6335 | 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. |
6336 | 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. |
6337
6338 **FrequencyFormatMappingType:**
6339
6340 Derivation:
6341
6342 *`AnnotableType`*` (extension)`
6343 *`IdentifiableType`*` (extension)`
6344 *`FrequencyFormatMappingBaseType`*` (extension)`
6345 `FrequencyFormatMappingType`
6346
6347 Attributes:
6348
6349 `id?, urn?, uri?`
6350
6351 Content:
6352
6353 `Annotations?, Link*, FrequencyId, DatePattern`
6354
6355 Attribute Documentation:
6356
6357 | **Name** | **Type** | **Documentation** |
6358 | --- --| --- --| --- --|
6359 | id | IDType | The id is the identifier for the object. |
6360 | urn | FrequencyFormatMappi ngUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6361 | 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. |
6362
6363 Element Documentation:
6364
6365 | **Name** | **Type** | **Documentation** |
6366 | --- --| --- --| --- --|
6367 | 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. |
6368 | 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. |
6369 | FrequencyId | IDType | |
6370 | DatePattern | xs:string | |
6371
6372 ***DateMapType*:**
6373
6374 Derivation:
6375
6376 *`AnnotableType`*` (extension)`
6377 *`IdentifiableType`*` (extension)`
6378 *`DateMapType`*
6379
6380 Attributes:
6381
6382 `id?, urn?, uri?, resolvePeriod?`
6383
6384 Content:
6385
6386 `Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*) | TargetFrequencyID)`
6387
6388 Attribute Documentation:
6389
6390 | **Name** | **Type** | **Documentation** |
6391 | --- --| --- --| --- --|
6392 | id | IDType | The id is the identifier for the object. |
6393 | urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6394 | 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. |
6395 | resolvePeriod | ResolvePeriodType | Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods. |
6396
6397 Element Documentation:
6398
6399 | **Name** | **Type** | **Documentation** |
6400 | --- --| --- --| --- --|
6401 | 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. |
6402 | 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. |
6403 | Source | IDType | |
6404 | Target | IDType | |
6405 | FrequencyDimension | IDType | |
6406 | MappedFrequencies | IDType | |
6407 | TargetFrequencyID | IDType | |
6408
6409 ***EpochMapBaseType*:** EpochMapBaseType defines the base refinement of the EpochMapType. Its purpose is to retrict the urn attribute.
6410
6411 Derivation:
6412
6413 *`AnnotableType`*` (extension)`
6414 *`IdentifiableType`*` (extension)`
6415 *`DateMapType`*` (restriction)`
6416 *`EpochMapBaseType`*
6417
6418 Attributes:
6419
6420 `id?, urn?, uri?, resolvePeriod?`
6421
6422 Content:
6423
6424 `Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*) | TargetFrequencyID)`
6425
6426 Attribute Documentation:
6427
6428 | **Name** | **Type** | **Documentation** |
6429 | --- --| --- --| --- --|
6430 | id | IDType | The id is the identifier for the object. |
6431 | urn | EpochMapUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6432 | 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. |
6433 | resolvePeriod | ResolvePeriodType | Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods. |
6434
6435 Element Documentation:
6436
6437 | **Name** | **Type** | **Documentation** |
6438 | --- --| --- --| --- --|
6439 | 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. |
6440 | 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. |
6441 | Source | IDType | |
6442 | Target | IDType | |
6443 | FrequencyDimension | IDType | |
6444 | MappedFrequencies | IDType | |
6445 | TargetFrequencyID | IDType | |
6446
6447 **EpochMapType:**
6448
6449 Derivation:
6450
6451 *`AnnotableType`*` (extension)`
6452 *`IdentifiableType`*` (extension)`
6453 *`DateMapType`*` (restriction)`
6454 *`EpochMapBaseType`*` (extension)`
6455 `EpochMapType`
6456
6457 Attributes:
6458
6459 `id?, urn?, uri?, resolvePeriod?, basePeriod, epochPeriod`
6460
6461 Content:
6462
6463 `Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*) | TargetFrequencyID)`
6464
6465 Attribute Documentation:
6466
6467 | **Name** | **Type** | **Documentation** |
6468 | --- --| --- --| --- --|
6469 | id | IDType | The id is the identifier for the object. |
6470 | urn | EpochMapUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6471 | 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. |
6472 | resolvePeriod | ResolvePeriodType | Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods. |
6473 | basePeriod | xs:string | |
6474 | epochPeriod | EpochPeriodType | |
6475
6476 Element Documentation:
6477
6478 | **Name** | **Type** | **Documentation** |
6479 | --- --| --- --| --- --|
6480 | 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. |
6481 | 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. |
6482 | Source | IDType | |
6483 | Target | IDType | |
6484 | FrequencyDimension | IDType | |
6485 | MappedFrequencies | IDType | |
6486 | TargetFrequencyID | IDType | |
6487
6488 ***DatePatternMapBaseType*:** DatePatternMapBaseType defines the base refinement of the DatePatternMapType. Its purpose is to retrict the urn attribute.
6489
6490 Derivation:
6491
6492 *`AnnotableType`*` (extension)`
6493 *`IdentifiableType`*` (extension)`
6494 *`DateMapType`*` (restriction)`
6495 *`DatePatternMapBaseType`*
6496
6497 Attributes:
6498
6499 `id?, urn?, uri?, resolvePeriod?`
6500
6501 Content:
6502
6503 `Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*) | TargetFrequencyID)`
6504
6505 Attribute Documentation:
6506
6507 | **Name** | **Type** | **Documentation** |
6508 | --- --| --- --| --- --|
6509 | id | IDType | The id is the identifier for the object. |
6510 | urn | DatePatternMapUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6511 | 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. |
6512 | resolvePeriod | ResolvePeriodType | Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods. |
6513
6514 Element Documentation:
6515
6516 | **Name** | **Type** | **Documentation** |
6517 | --- --| --- --| --- --|
6518 | 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. |
6519 | 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. |
6520 | Source | IDType | |
6521 | Target | IDType | |
6522 | FrequencyDimension | IDType | |
6523 | MappedFrequencies | IDType | |
6524 | TargetFrequencyID | IDType | |
6525
6526 **DatePatternMapType:**
6527
6528 Derivation:
6529
6530 *`AnnotableType`*` (extension)`
6531 *`IdentifiableType`*` (extension)`
6532 *`DateMapType`*` (restriction)`
6533 *`DatePatternMapBaseType`*` (extension)`
6534 `DatePatternMapType`
6535
6536 Attributes:
6537
6538 `id?, urn?, uri?, resolvePeriod?, sourcePattern, locale`
6539
6540 Content:
6541
6542 `Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*) | TargetFrequencyID)`
6543
6544 Attribute Documentation:
6545
6546 | **Name** | **Type** | **Documentation** |
6547 | --- --| --- --| --- --|
6548 | id | IDType | The id is the identifier for the object. |
6549 | urn | DatePatternMapUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6550 | 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. |
6551 | resolvePeriod | ResolvePeriodType | Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods. |
6552 | sourcePattern | xs:string | Describes the source date using conventions for describing years, months, days, etc. |
6553 | locale | xs:string | The locale on which the input will be parsed according to the pattern. |
6554
6555 Element Documentation:
6556
6557 | **Name** | **Type** | **Documentation** |
6558 | --- --| --- --| --- --|
6559 | 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. |
6560 | 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. |
6561 | Source | IDType | |
6562 | Target | IDType | |
6563 | FrequencyDimension | IDType | |
6564 | MappedFrequencies | IDType | |
6565 | TargetFrequencyID | IDType | |
6566
6567 ***RepresentationMapBaseType*:** RepresentationMapBaseType defines the base refinement of the RepresentationMapType. Its purpose is to retrict the urn attribute.
6568
6569 Derivation:
6570
6571 *`AnnotableType`*` (extension)`
6572 *`IdentifiableType`*` (extension)`
6573 *`NameableType`*` (extension)`
6574 *`VersionableType`*` (restriction)`
6575 *`MaintainableBaseType`*` (extension)`
6576 *`MaintainableType`*` (restriction)`
6577 *`RepresentationMapBaseType`*
6578
6579 Attributes:
6580
6581 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
6582
6583 Content:
6584
6585 `Annotations?, Link*, Name+, Description*`
6586
6587 Attribute Documentation:
6588
6589 | **Name** | **Type** | **Documentation** |
6590 | --- --| --- --| --- --|
6591 | id | IDType | The id is the identifier for the object. |
6592 | urn | RepresentationMapUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6593 | 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. |
6594 | 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. |
6595 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
6596 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
6597 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
6598 | 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. |
6599 | 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. |
6600 | 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. |
6601 | 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’. |
6602
6603 Element Documentation:
6604
6605 | **Name** | **Type** | **Documentation** |
6606 | --- --| --- --| --- --|
6607 | 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. |
6608 | 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. |
6609 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
6610 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
6611
6612 **RepresentationMapType:**
6613
6614 Derivation:
6615
6616 *`AnnotableType`*` (extension)`
6617 *`IdentifiableType`*` (extension)`
6618 *`NameableType`*` (extension)`
6619 *`VersionableType`*` (restriction)`
6620 *`MaintainableBaseType`*` (extension)`
6621 *`MaintainableType`*` (restriction)`
6622 *`RepresentationMapBaseType`*` (extension)`
6623 `RepresentationMapType`
6624
6625 Attributes:
6626
6627 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`
6628
6629 Content:
6630
6631 `Annotations?, Link*, Name+, Description*, (SourceCodelist | SourceDataType)+, (TargetCodelist | TargetDataType)+, RepresentationMapping*`
6632
6633 Attribute Documentation:
6634
6635 | **Name** | **Type** | **Documentation** |
6636 | --- --| --- --| --- --|
6637 | id | IDType | The id is the identifier for the object. |
6638 | urn | RepresentationMapUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6639 | 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. |
6640 | 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. |
6641 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
6642 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
6643 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
6644 | 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. |
6645 | 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. |
6646 | 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. |
6647 | 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’. |
6648
6649 Element Documentation:
6650
6651 | **Name** | **Type** | **Documentation** |
6652 | --- --| --- --| --- --|
6653 | 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. |
6654 | 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. |
6655 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
6656 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
6657 | SourceCodelist | AnyCodelistReferenceTyp e | |
6658 | SourceDataType | DataType | |
6659 | TargetCodelist | AnyCodelistReferenceTyp e | |
6660 | TargetDataType | DataType | |
6661 | RepresentationMappin g | ValueMappingType | |
6662
6663 **SingleValueMappingType:** SingleValueMappingType defines a mapping with a single source and optional target.
6664
6665 Derivation:
6666
6667 *`AnnotableType`*` (extension)`
6668 `SingleValueMappingType`
6669
6670 Attributes:
6671
6672 `validFrom?, validTo?`
6673
6674 Content:
6675
6676 `Annotations?, SourceValue, TargetValue?`
6677
6678 Attribute Documentation:
6679
6680 | **Name** | **Type** | **Documentation** |
6681 | --- --| --- --| --- --|
6682 | validFrom | xs:date | |
6683 | validTo | xs:date | |
6684
6685 Element Documentation:
6686
6687 | **Name** | **Type** | **Documentation** |
6688 | --- --| --- --| --- --|
6689 | 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. |
6690 | 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. |
6691 | 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. |
6692
6693 **ValueMappingType:** ValueMappingType defines a mapping of multiple sources to multiple targets.
6694
6695 Derivation:
6696
6697 *`AnnotableType`*` (extension)`
6698 `ValueMappingType`
6699
6700 Attributes:
6701
6702 `validFrom?, validTo?`
6703
6704 Content:
6705
6706 `Annotations?, SourceValue+, TargetValue*`
6707
6708 Attribute Documentation:
6709
6710 | **Name** | **Type** | **Documentation** |
6711 | --- --| --- --| --- --|
6712 | validFrom | xs:date | |
6713 | validTo | xs:date | |
6714
6715 Element Documentation:
6716
6717 | **Name** | **Type** | **Documentation** |
6718 | --- --| --- --| --- --|
6719 | 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. |
6720 | 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. |
6721 | 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. |
6722
6723 **MappedValueType:**
6724
6725 Derivation:
6726
6727 `xs:anySimpleType (restriction)`
6728 `xs:string (extension)`
6729 `MappedValueType`
6730
6731 Attributes:
6732
6733 `isRegEx?, startIndex?, endIndex?`
6734
6735 Content:
6736
6737 Attribute Documentation:
6738
6739 | **Name** | **Type** | **Documentation** |
6740 | --- --| --- --| --- --|
6741 | isRegEx | xs:boolean | |
6742 | startIndex | xs:int | |
6743 | endIndex | xs:int | |
6744
6745 ***VtlDefinitionSchemeType*:** VtlDefinitionSchemeType is an abstract extension of the ItemSchemeType for VTL schemes.
6746
6747 Derivation:
6748
6749 *`AnnotableType`*` (extension)`
6750 *`IdentifiableType`*` (extension)`
6751 *`NameableType`*` (extension)`
6752 *`VersionableType`*` (restriction)`
6753 *`MaintainableBaseType`*` (extension)`
6754 *`MaintainableType`*` (extension)`
6755 *`ItemSchemeType`*` (extension)`
6756 *`VtlDefinitionSchemeType`*
6757
6758 Attributes:
6759
6760 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`
6761
6762 Content:
6763
6764 `Annotations?, Link*, Name+, Description*, `*`Item*`*
6765
6766 Attribute Documentation:
6767
6768 | **Name** | **Type** | **Documentation** |
6769 | --- --| --- --| --- --|
6770 | id | IDType | The id is the identifier for the object. |
6771 | urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6772 | 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. |
6773 | 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. |
6774 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
6775 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
6776 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
6777 | 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. |
6778 | 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. |
6779 | 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. |
6780 | 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’. |
6781 | 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. |
6782 | 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. |
6783
6784 Element Documentation:
6785
6786 | **Name** | **Type** | **Documentation** |
6787 | --- --| --- --| --- --|
6788 | 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. |
6789 | 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. |
6790 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
6791 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
6792 | *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. |
6793
6794 ***TransformationSchemeBaseType*:** TransformationSchemeBaseType is an abstract base type for the TransformationSchemeType. It restricts the item types to be only transformations.
6795
6796 Derivation:
6797
6798 *`AnnotableType`*` (extension)`
6799 *`IdentifiableType`*` (extension)`
6800 *`NameableType`*` (extension)`
6801 *`VersionableType`*` (restriction)`
6802 *`MaintainableBaseType`*` (extension)`
6803 *`MaintainableType`*` (extension)`
6804 *`ItemSchemeType`*` (extension)`
6805 *`VtlDefinitionSchemeType`*` (restriction)`
6806 *`TransformationSchemeBaseType`*
6807
6808 Attributes:
6809
6810 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`
6811
6812 Content:
6813
6814 `Annotations?, Link*, Name+, Description*, Transformation*`
6815
6816 Attribute Documentation:
6817
6818 | **Name** | **Type** | **Documentation** |
6819 | --- --| --- --| --- --|
6820 | id | IDType | The id is the identifier for the object. |
6821 | urn | TransformationScheme UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6822 | 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. |
6823 | 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. |
6824 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
6825 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
6826 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
6827 | 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. |
6828 | 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. |
6829 | 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. |
6830 | 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’. |
6831 | 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. |
6832 | 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. |
6833
6834 Element Documentation:
6835
6836 | **Name** | **Type** | **Documentation** |
6837 | --- --| --- --| --- --|
6838 | 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. |
6839 | 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. |
6840 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
6841 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
6842 | Transformation | TransformationType | Transformation describes the details of a single transformation within a transformation scheme. |
6843
6844 **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.
6845
6846 Derivation:
6847
6848 *`AnnotableType`*` (extension)`
6849 *`IdentifiableType`*` (extension)`
6850 *`NameableType`*` (extension)`
6851 *`VersionableType`*` (restriction)`
6852 *`MaintainableBaseType`*` (extension)`
6853 *`MaintainableType`*` (extension)`
6854 *`ItemSchemeType`*` (extension)`
6855 *`VtlDefinitionSchemeType`*` (restriction)`
6856 *`TransformationSchemeBaseType`*` (extension)`
6857 `TransformationSchemeType`
6858
6859 Attributes:
6860
6861 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`
6862
6863 Content:
6864
6865 `Annotations?, Link*, Name+, Description*, Transformation*, VtlMappingScheme?, NamePersonalisationScheme?, CustomTypeScheme?, RulesetScheme*, UserDefinedOperatorScheme*`
6866
6867 Attribute Documentation:
6868
6869 | **Name** | **Type** | **Documentation** |
6870 | --- --| --- --| --- --|
6871 | id | IDType | The id is the identifier for the object. |
6872 | urn | TransformationScheme UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6873 | 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. |
6874 | 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. |
6875 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
6876 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
6877 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
6878 | 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. |
6879 | 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. |
6880 | 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. |
6881 | 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’. |
6882 | 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. |
6883 | 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. |
6884
6885 Element Documentation:
6886
6887 | **Name** | **Type** | **Documentation** |
6888 | --- --| --- --| --- --|
6889 | 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. |
6890 | 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. |
6891 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
6892 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
6893 | Transformation | TransformationType | Transformation describes the details of a single transformation within a transformation scheme. |
6894 | VtlMappingScheme | VtlMappingSchemeRefe renceType | 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. |
6895 | NamePersonalisationS cheme | NamePersonalisationS chemeReferenceType | 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. |
6896 | CustomTypeScheme | CustomTypeSchemeRefe renceType | 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. |
6897 | RulesetScheme | RulesetSchemeReferen ceType | References a ruleset scheme that defines one or more previously defined rulesets which can be invoked by VTL operators. If a transformation defined in a transformation scheme refers to a ruleset, the scheme in which the ruleset is defined must be referenced here. |
6898 | UserDefinedOperatorS cheme | UserDefinedOperatorS chemeReferenceType | 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. |
6899
6900 ***TransformationBaseType*:** TransformationBaseType defines the base refinement of the TransformationType. Its purpose is to retrict the urn attribute.
6901
6902 Derivation:
6903
6904 *`AnnotableType`*` (extension)`
6905 *`IdentifiableType`*` (extension)`
6906 *`NameableType`*` (restriction)`
6907 *`ItemBaseType`*` (extension)`
6908 *`ItemType`*` (restriction)`
6909 *`UnnestedItemType`*` (restriction)`
6910 *`TransformationBaseType`*
6911
6912 Attributes:
6913
6914 `id, urn?, uri?`
6915
6916 Content:
6917
6918 `Annotations?, Link*, Name+, Description*`
6919
6920 Attribute Documentation:
6921
6922 | **Name** | **Type** | **Documentation** |
6923 | --- --| --- --| --- --|
6924 | id | IDType | The id is the identifier for the object. |
6925 | urn | TransformationUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6926 | 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. |
6927
6928 Element Documentation:
6929
6930 | **Name** | **Type** | **Documentation** |
6931 | --- --| --- --| --- --|
6932 | 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. |
6933 | 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. |
6934 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
6935 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
6936
6937 **TransformationType:** TransformationType defines the structure of a transformation. A transformation is an assignment of a VTL expression to a specific result.
6938
6939 Derivation:
6940
6941 *`AnnotableType`*` (extension)`
6942 *`IdentifiableType`*` (extension)`
6943 *`NameableType`*` (restriction)`
6944 *`ItemBaseType`*` (extension)`
6945 *`ItemType`*` (restriction)`
6946 *`UnnestedItemType`*` (restriction)`
6947 *`TransformationBaseType`*` (extension)`
6948 `TransformationType`
6949
6950 Attributes:
6951
6952 `id, urn?, uri?, isPersistent`
6953
6954 Content:
6955
6956 `Annotations?, Link*, Name+, Description*, Expression, Result`
6957
6958 Attribute Documentation:
6959
6960 | **Name** | **Type** | **Documentation** |
6961 | --- --| --- --| --- --|
6962 | id | IDType | The id is the identifier for the object. |
6963 | urn | TransformationUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
6964 | 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. |
6965 | 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. |
6966
6967 Element Documentation:
6968
6969 | **Name** | **Type** | **Documentation** |
6970 | --- --| --- --| --- --|
6971 | 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. |
6972 | 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. |
6973 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
6974 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
6975 | 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"). |
6976 | 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"). |
6977
6978 **VtlMappingSchemeType:** VtlMappingSchemeType defines a set of mappings between SDMX and VTL.
6979
6980 Derivation:
6981
6982 *`AnnotableType`*` (extension)`
6983 *`IdentifiableType`*` (extension)`
6984 *`NameableType`*` (extension)`
6985 *`VersionableType`*` (restriction)`
6986 *`MaintainableBaseType`*` (extension)`
6987 *`MaintainableType`*` (extension)`
6988 *`ItemSchemeType`*` (restriction)`
6989 `VtlMappingSchemeType`
6990
6991 Attributes:
6992
6993 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`
6994
6995 Content:
6996
6997 `Annotations?, Link*, Name+, Description*, VtlMapping*`
6998
6999 Attribute Documentation:
7000
7001 | **Name** | **Type** | **Documentation** |
7002 | --- --| --- --| --- --|
7003 | id | IDType | The id is the identifier for the object. |
7004 | urn | VtlMappingSchemeUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
7005 | 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. |
7006 | 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. |
7007 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
7008 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
7009 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
7010 | 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. |
7011 | 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. |
7012 | 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. |
7013 | 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’. |
7014 | 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. |
7015
7016 Element Documentation:
7017
7018 | **Name** | **Type** | **Documentation** |
7019 | --- --| --- --| --- --|
7020 | 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. |
7021 | 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. |
7022 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
7023 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
7024 | VtlMapping | VtlMappingType | VtlMapping details a mapping between SDMX and VTL transformation. |
7025
7026 ***VtlMappingBaseType*:** VtlMappingBaseType defines the base refinement of the VtlMappingType. Its purpose is to retrict the urn attribute.
7027
7028 Derivation:
7029
7030 *`AnnotableType`*` (extension)`
7031 *`IdentifiableType`*` (extension)`
7032 *`NameableType`*` (restriction)`
7033 *`ItemBaseType`*` (extension)`
7034 *`ItemType`*` (restriction)`
7035 *`UnnestedItemType`*` (restriction)`
7036 *`VtlMappingBaseType`*
7037
7038 Attributes:
7039
7040 `id, urn?, uri?`
7041
7042 Content:
7043
7044 `Annotations?, Link*, Name+, Description*`
7045
7046 Attribute Documentation:
7047
7048 | **Name** | **Type** | **Documentation** |
7049 | --- --| --- --| --- --|
7050 | id | IDType | The id is the identifier for the object. |
7051 | urn | VtlMappingUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
7052 | 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. |
7053
7054 Element Documentation:
7055
7056 | **Name** | **Type** | **Documentation** |
7057 | --- --| --- --| --- --|
7058 | 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. |
7059 | 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. |
7060 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
7061 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
7062
7063 **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.
7064
7065 Derivation:
7066
7067 *`AnnotableType`*` (extension)`
7068 *`IdentifiableType`*` (extension)`
7069 *`NameableType`*` (restriction)`
7070 *`ItemBaseType`*` (extension)`
7071 *`ItemType`*` (restriction)`
7072 *`UnnestedItemType`*` (restriction)`
7073 *`VtlMappingBaseType`*` (extension)`
7074 `VtlMappingType`
7075
7076 Attributes:
7077
7078 `id, urn?, uri?, alias`
7079
7080 Content:
7081
7082 `Annotations?, Link*, Name+, Description*, ( ( (Dataflow | GenericDataflow), ToVtlMapping?, FromVtlMapping?) | Codelist | Concept)`
7083
7084 Attribute Documentation:
7085
7086 | **Name** | **Type** | **Documentation** |
7087 | --- --| --- --| --- --|
7088 | id | IDType | The id is the identifier for the object. |
7089 | urn | VtlMappingUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
7090 | 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. |
7091 | 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. |
7092
7093 Element Documentation:
7094
7095 | **Name** | **Type** | **Documentation** |
7096 | --- --| --- --| --- --|
7097 | 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. |
7098 | 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. |
7099 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
7100 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
7101 | Dataflow | DataflowReferenceTyp e | 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. |
7102 | 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. |
7103 | ToVtlMapping | ToVtlMappingType | Describes the mapping from a SDMX dataflow to a VTL data structure. |
7104 | FromVtlMapping | FromVtlMappingType | Describes the mapping to a SDMX dataflow from a VTL data structure. |
7105 | Codelist | CodelistReferenceTyp e | A reference to the SDMX Codelist that the mapping is defined for. This is used to create a VtlCodelistMapping. |
7106 | Concept | ConceptReferenceType | A reference to the SDMX Concept that the mapping is defined for. This is used to create a VtlConceptMapping. |
7107
7108 **ToVtlMappingType:** ToVtlMappingType defines the mapping method and filter used when mapping from SDMX to VTL.
7109
7110 Attributes:
7111
7112 `method?`
7113
7114 Content:
7115
7116 `ToVtlSubSpace?`
7117
7118 Attribute Documentation:
7119
7120 | **Name** | **Type** | **Documentation** |
7121 | --- --| --- --| --- --|
7122 | method | ToVtlMappingMethodTy pe | The mapping method used when mapping from SDMX to VTL. This is typically a StandardToVtlMappingMethodType, but can be any other value to allow for non-standard methods. The implied default is Basic. |
7123
7124 Element Documentation:
7125
7126 | **Name** | **Type** | **Documentation** |
7127 | --- --| --- --| --- --|
7128 | ToVtlSubSpace | SpaceKeyType | Identfies a sub space of the mapped dataflow that the mapping applies to. This is a collection of references to the dimensions that make up the space. |
7129
7130 **FromVtlMappingType:** FromVtlMappingType defines the mapping method and filter used when mapping from VTL to SDMX.
7131
7132 Attributes:
7133
7134 `method?`
7135
7136 Content:
7137
7138 `FromVtlSuperSpace?`
7139
7140 Attribute Documentation:
7141
7142 | **Name** | **Type** | **Documentation** |
7143 | --- --| --- --| --- --|
7144 | method | FromVtlMappingMethod Type | 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. |
7145
7146 Element Documentation:
7147
7148 | **Name** | **Type** | **Documentation** |
7149 | --- --| --- --| --- --|
7150 | 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. |
7151
7152 **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.
7153
7154 Content:
7155
7156 `Key+`
7157
7158 Element Documentation:
7159
7160 | **Name** | **Type** | **Documentation** |
7161 | --- --| --- --| --- --|
7162 | Key | SingleNCNameIDType | A reference to a dimension by its identifier. |
7163
7164 **NamePersonalisationSchemeType:** NamePersonalisationSchemeType defines a set of personalisations of VTL standard names that are used in a set of transformations.
7165
7166 Derivation:
7167
7168 *`AnnotableType`*` (extension)`
7169 *`IdentifiableType`*` (extension)`
7170 *`NameableType`*` (extension)`
7171 *`VersionableType`*` (restriction)`
7172 *`MaintainableBaseType`*` (extension)`
7173 *`MaintainableType`*` (extension)`
7174 *`ItemSchemeType`*` (extension)`
7175 *`VtlDefinitionSchemeType`*` (restriction)`
7176 `NamePersonalisationSchemeType`
7177
7178 Attributes:
7179
7180 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`
7181
7182 Content:
7183
7184 `Annotations?, Link*, Name+, Description*, NamePersonalisation*`
7185
7186 Attribute Documentation:
7187
7188 | **Name** | **Type** | **Documentation** |
7189 | --- --| --- --| --- --|
7190 | id | IDType | The id is the identifier for the object. |
7191 | urn | NamePersonalisationS chemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
7192 | 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. |
7193 | 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. |
7194 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
7195 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
7196 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
7197 | 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. |
7198 | 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. |
7199 | 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. |
7200 | 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’. |
7201 | 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. |
7202 | 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. |
7203
7204 Element Documentation:
7205
7206 | **Name** | **Type** | **Documentation** |
7207 | --- --| --- --| --- --|
7208 | 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. |
7209 | 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. |
7210 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
7211 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
7212 | NamePersonalisation | NamePersonalisationT ype | NamePersonalisation details a name personalisation that is used in a transformation. |
7213
7214 ***NamePersonalisationBaseType*:** NamePersonalisationBaseType defines the base refinement of the NamePersonalisationType. Its purpose is to retrict the urn attribute.
7215
7216 Derivation:
7217
7218 *`AnnotableType`*` (extension)`
7219 *`IdentifiableType`*` (extension)`
7220 *`NameableType`*` (restriction)`
7221 *`ItemBaseType`*` (extension)`
7222 *`ItemType`*` (restriction)`
7223 *`UnnestedItemType`*` (restriction)`
7224 *`NamePersonalisationBaseType`*
7225
7226 Attributes:
7227
7228 `id, urn?, uri?`
7229
7230 Content:
7231
7232 `Annotations?, Link*, Name+, Description*`
7233
7234 Attribute Documentation:
7235
7236 | **Name** | **Type** | **Documentation** |
7237 | --- --| --- --| --- --|
7238 | id | IDType | The id is the identifier for the object. |
7239 | urn | NamePersonalisationU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
7240 | 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. |
7241
7242 Element Documentation:
7243
7244 | **Name** | **Type** | **Documentation** |
7245 | --- --| --- --| --- --|
7246 | 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. |
7247 | 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. |
7248 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
7249 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
7250
7251 **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.
7252
7253 Derivation:
7254
7255 *`AnnotableType`*` (extension)`
7256 *`IdentifiableType`*` (extension)`
7257 *`NameableType`*` (restriction)`
7258 *`ItemBaseType`*` (extension)`
7259 *`ItemType`*` (restriction)`
7260 *`UnnestedItemType`*` (restriction)`
7261 *`NamePersonalisationBaseType`*` (extension)`
7262 `NamePersonalisationType`
7263
7264 Attributes:
7265
7266 `id, urn?, uri?, vtlArtefact`
7267
7268 Content:
7269
7270 `Annotations?, Link*, Name+, Description*, VtlDefaultName, PersonalisedName`
7271
7272 Attribute Documentation:
7273
7274 | **Name** | **Type** | **Documentation** |
7275 | --- --| --- --| --- --|
7276 | id | IDType | The id is the identifier for the object. |
7277 | urn | NamePersonalisationU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
7278 | 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. |
7279 | vtlArtefact | xs:string | Identifies the type of VTL model artefact that is being personalised. In VTL 2.0, this is valuedomain or variable. |
7280
7281 Element Documentation:
7282
7283 | **Name** | **Type** | **Documentation** |
7284 | --- --| --- --| --- --|
7285 | 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. |
7286 | 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. |
7287 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
7288 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
7289 | VtlDefaultName | xs:string | Provides the VTL standard name that is being personalised. |
7290 | PersonalisedName | xs:string | Provides the personalised name that is used in place of the VTL standard name in the transformation expressions. |
7291
7292 ***RulesetSchemeBaseType*:** RulesetSchemeBaseType is an abstract base type for the RulesetSchemeType. It restricts the item types to be only rulesets.
7293
7294 Derivation:
7295
7296 *`AnnotableType`*` (extension)`
7297 *`IdentifiableType`*` (extension)`
7298 *`NameableType`*` (extension)`
7299 *`VersionableType`*` (restriction)`
7300 *`MaintainableBaseType`*` (extension)`
7301 *`MaintainableType`*` (extension)`
7302 *`ItemSchemeType`*` (extension)`
7303 *`VtlDefinitionSchemeType`*` (restriction)`
7304 *`RulesetSchemeBaseType`*
7305
7306 Attributes:
7307
7308 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`
7309
7310 Content:
7311
7312 `Annotations?, Link*, Name+, Description*, Ruleset*`
7313
7314 Attribute Documentation:
7315
7316 | **Name** | **Type** | **Documentation** |
7317 | --- --| --- --| --- --|
7318 | id | IDType | The id is the identifier for the object. |
7319 | urn | RulesetSchemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
7320 | 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. |
7321 | 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. |
7322 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
7323 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
7324 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
7325 | 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. |
7326 | 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. |
7327 | 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. |
7328 | 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’. |
7329 | 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. |
7330 | 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. |
7331
7332 Element Documentation:
7333
7334 | **Name** | **Type** | **Documentation** |
7335 | --- --| --- --| --- --|
7336 | 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. |
7337 | 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. |
7338 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
7339 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
7340 | Ruleset | RulesetType | Ruleset details a ruleset within a ruleset scheme. |
7341
7342 **RulesetSchemeType:** RulesetSchemeType defines a collection of rulesets that are used in transformations.
7343
7344 Derivation:
7345
7346 *`AnnotableType`*` (extension)`
7347 *`IdentifiableType`*` (extension)`
7348 *`NameableType`*` (extension)`
7349 *`VersionableType`*` (restriction)`
7350 *`MaintainableBaseType`*` (extension)`
7351 *`MaintainableType`*` (extension)`
7352 *`ItemSchemeType`*` (extension)`
7353 *`VtlDefinitionSchemeType`*` (restriction)`
7354 *`RulesetSchemeBaseType`*` (extension)`
7355 `RulesetSchemeType`
7356
7357 Attributes:
7358
7359 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`
7360
7361 Content:
7362
7363 `Annotations?, Link*, Name+, Description*, Ruleset*, VtlMappingScheme?`
7364
7365 Attribute Documentation:
7366
7367 | **Name** | **Type** | **Documentation** |
7368 | --- --| --- --| --- --|
7369 | id | IDType | The id is the identifier for the object. |
7370 | urn | RulesetSchemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
7371 | 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. |
7372 | 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. |
7373 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
7374 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
7375 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
7376 | 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. |
7377 | 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. |
7378 | 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. |
7379 | 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’. |
7380 | 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. |
7381 | 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. |
7382
7383 Element Documentation:
7384
7385 | **Name** | **Type** | **Documentation** |
7386 | --- --| --- --| --- --|
7387 | 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. |
7388 | 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. |
7389 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
7390 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
7391 | Ruleset | RulesetType | Ruleset details a ruleset within a ruleset scheme. |
7392 | VtlMappingScheme | VtlMappingSchemeRefe renceType | 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. |
7393
7394 ***RulesetBaseType*:** RulesetBaseType defines the base refinement of the RulesetType. Its purpose is to retrict the urn attribute.
7395
7396 Derivation:
7397
7398 *`AnnotableType`*` (extension)`
7399 *`IdentifiableType`*` (extension)`
7400 *`NameableType`*` (restriction)`
7401 *`ItemBaseType`*` (extension)`
7402 *`ItemType`*` (restriction)`
7403 *`UnnestedItemType`*` (restriction)`
7404 *`RulesetBaseType`*
7405
7406 Attributes:
7407
7408 `id, urn?, uri?`
7409
7410 Content:
7411
7412 `Annotations?, Link*, Name+, Description*`
7413
7414 Attribute Documentation:
7415
7416 | **Name** | **Type** | **Documentation** |
7417 | --- --| --- --| --- --|
7418 | id | IDType | The id is the identifier for the object. |
7419 | urn | RulesetUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
7420 | 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. |
7421
7422 Element Documentation:
7423
7424 | **Name** | **Type** | **Documentation** |
7425 | --- --| --- --| --- --|
7426 | 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. |
7427 | 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. |
7428 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
7429 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
7430
7431 **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.
7432
7433 Derivation:
7434
7435 *`AnnotableType`*` (extension)`
7436 *`IdentifiableType`*` (extension)`
7437 *`NameableType`*` (restriction)`
7438 *`ItemBaseType`*` (extension)`
7439 *`ItemType`*` (restriction)`
7440 *`UnnestedItemType`*` (restriction)`
7441 *`RulesetBaseType`*` (extension)`
7442 `RulesetType`
7443
7444 Attributes:
7445
7446 `id, urn?, uri?, rulesetType, rulesetScope`
7447
7448 Content:
7449
7450 `Annotations?, Link*, Name+, Description*, RulesetDefinition`
7451
7452 Attribute Documentation:
7453
7454 | **Name** | **Type** | **Documentation** |
7455 | --- --| --- --| --- --|
7456 | id | IDType | The id is the identifier for the object. |
7457 | urn | RulesetUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
7458 | 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. |
7459 | rulesetType | xs:string | The VTL type of the ruleset. In VTL 2.0, this is datapoint or hierarchical |
7460 | rulesetScope | xs:string | This model artefact on which the ruleset is defined. In VTL 2.0, this is value domain or variable. |
7461
7462 Element Documentation:
7463
7464 | **Name** | **Type** | **Documentation** |
7465 | --- --| --- --| --- --|
7466 | 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. |
7467 | 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. |
7468 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
7469 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
7470 | RulesetDefinition | xs:string | A VTL statement for the definition of a ruleset. This must conform to the syntax of the VTL definition language. |
7471
7472 ***UserDefinedOperatorSchemeBaseType*:** UserDefinedOperatorSchemeBaseType is an abstract base type for the UserDefinedOperatorSchemeType. It restricts the item types to be only user defined operators.
7473
7474 Derivation:
7475
7476 *`AnnotableType`*` (extension)`
7477 *`IdentifiableType`*` (extension)`
7478 *`NameableType`*` (extension)`
7479 *`VersionableType`*` (restriction)`
7480 *`MaintainableBaseType`*` (extension)`
7481 *`MaintainableType`*` (extension)`
7482 *`ItemSchemeType`*` (extension)`
7483 *`VtlDefinitionSchemeType`*` (restriction)`
7484 *`UserDefinedOperatorSchemeBaseType`*
7485
7486 Attributes:
7487
7488 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`
7489
7490 Content:
7491
7492 `Annotations?, Link*, Name+, Description*, UserDefinedOperator*`
7493
7494 Attribute Documentation:
7495
7496 | **Name** | **Type** | **Documentation** |
7497 | --- --| --- --| --- --|
7498 | id | IDType | The id is the identifier for the object. |
7499 | urn | UserDefinedOperatorS chemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
7500 | 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. |
7501 | 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. |
7502 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
7503 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
7504 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
7505 | 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. |
7506 | 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. |
7507 | 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. |
7508 | 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’. |
7509 | 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. |
7510 | 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. |
7511
7512 Element Documentation:
7513
7514 | **Name** | **Type** | **Documentation** |
7515 | --- --| --- --| --- --|
7516 | 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. |
7517 | 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. |
7518 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
7519 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
7520 | UserDefinedOperator | UserDefinedOperatorT ype | UserDefinedOperator details a user defined operators within a user defined operator scheme. |
7521
7522 **UserDefinedOperatorSchemeType:** UserDefinedOperatorSchemeType defines a collection of user defined operators that are used in transformations.
7523
7524 Derivation:
7525
7526 *`AnnotableType`*` (extension)`
7527 *`IdentifiableType`*` (extension)`
7528 *`NameableType`*` (extension)`
7529 *`VersionableType`*` (restriction)`
7530 *`MaintainableBaseType`*` (extension)`
7531 *`MaintainableType`*` (extension)`
7532 *`ItemSchemeType`*` (extension)`
7533 *`VtlDefinitionSchemeType`*` (restriction)`
7534 *`UserDefinedOperatorSchemeBaseType`*` (extension)`
7535 `UserDefinedOperatorSchemeType`
7536
7537 Attributes:
7538
7539 `id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`
7540
7541 Content:
7542
7543 `Annotations?, Link*, Name+, Description*, UserDefinedOperator*, VtlMappingScheme?, RulesetScheme*`
7544
7545 Attribute Documentation:
7546
7547 | **Name** | **Type** | **Documentation** |
7548 | --- --| --- --| --- --|
7549 | id | IDType | The id is the identifier for the object. |
7550 | urn | UserDefinedOperatorS chemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
7551 | 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. |
7552 | 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. |
7553 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
7554 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
7555 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
7556 | 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. |
7557 | 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. |
7558 | 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. |
7559 | 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’. |
7560 | 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. |
7561 | 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. |
7562
7563 Element Documentation:
7564
7565 | **Name** | **Type** | **Documentation** |
7566 | --- --| --- --| --- --|
7567 | 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. |
7568 | 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. |
7569 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
7570 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
7571 | UserDefinedOperator | UserDefinedOperatorT ype | UserDefinedOperator details a user defined operators within a user defined operator scheme. |
7572 | VtlMappingScheme | VtlMappingSchemeRefe renceType | 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. |
7573 | RulesetScheme | RulesetSchemeReferen ceType | References a ruleset scheme defining rulesets utilized in the user defined operators. |
7574
7575 ***UserDefinedOperatorBaseType*:** UserDefinedOperatorBaseType defines the base refinement of the UserDefinedOperatorType. Its purpose is to retrict the urn attribute.
7576
7577 Derivation:
7578
7579 *`AnnotableType`*` (extension)`
7580 *`IdentifiableType`*` (extension)`
7581 *`NameableType`*` (restriction)`
7582 *`ItemBaseType`*` (extension)`
7583 *`ItemType`*` (restriction)`
7584 *`UnnestedItemType`*` (restriction)`
7585 *`UserDefinedOperatorBaseType`*
7586
7587 Attributes:
7588
7589 `id, urn?, uri?`
7590
7591 Content:
7592
7593 `Annotations?, Link*, Name+, Description*`
7594
7595 Attribute Documentation:
7596
7597 | **Name** | **Type** | **Documentation** |
7598 | --- --| --- --| --- --|
7599 | id | IDType | The id is the identifier for the object. |
7600 | urn | UserDefinedOperatorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
7601 | 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. |
7602
7603 Element Documentation:
7604
7605 | **Name** | **Type** | **Documentation** |
7606 | --- --| --- --| --- --|
7607 | 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. |
7608 | 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. |
7609 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
7610 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
7611
7612 **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.
7613
7614 Derivation:
7615
7616 *`AnnotableType`*` (extension)`
7617 *`IdentifiableType`*` (extension)`
7618 *`NameableType`*` (restriction)`
7619 *`ItemBaseType`*` (extension)`
7620 *`ItemType`*` (restriction)`
7621 *`UnnestedItemType`*` (restriction)`
7622 *`UserDefinedOperatorBaseType`*` (extension)`
7623 `UserDefinedOperatorType`
7624
7625 Attributes:
7626 id, urn?, uri?
7627
7628 Content:
7629 Annotations?, Link, Name+, Description, OperatorDefinition
7630
7631 Attribute Documentation:
7632
7633 | **Name** | **Type** | **Documentation** |
7634 | --- --| --- --| --- --|
7635 | id | IDType | The id is the identifier for the object. |
7636 | urn | UserDefinedOperatorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
7637 | 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. |
7638
7639 Element Documentation:
7640
7641 | **Name** | **Type** | **Documentation** |
7642 | --- --| --- --| --- --|
7643 | 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. |
7644 | 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. |
7645 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
7646 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
7647 | 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. |
7648
7649 **CustomTypeSchemeType:** CustomTypeSchemeType defines a collection of custom types that are used in transformations.
7650
7651 Derivation:
7652
7653 *`AnnotableType`*` (extension)`
7654 *`IdentifiableType`*` (extension)`
7655 *`NameableType`*` (extension)`
7656 *`VersionableType`*` (restriction)`
7657 *`MaintainableBaseType`*` (extension)`
7658 *`MaintainableType`*` (extension)`
7659 *`ItemSchemeType`*` (extension)`
7660 *`VtlDefinitionSchemeType`*` (restriction)`
7661 `CustomTypeSchemeType`
7662
7663 Attributes:
7664 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
7665
7666 Content:
7667 Annotations?, Link*, Name+, Description*, CustomType
7668
7669 Attribute Documentation:
7670
7671 | **Name** | **Type** | **Documentation** |
7672 | --- --| --- --| --- --|
7673 | id | IDType | The id is the identifier for the object. |
7674 | urn | CustomTypeSchemeUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
7675 | 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. |
7676 | 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. |
7677 | validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |
7678 | validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |
7679 | agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |
7680 | 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. |
7681 | 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. |
7682 | 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. |
7683 | 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’. |
7684 | 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. |
7685 | 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. |
7686
7687 Element Documentation:
7688
7689 | **Name** | **Type** | **Documentation** |
7690 | --- --| --- --| --- --|
7691 | 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. |
7692 | 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. |
7693 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
7694 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
7695 | CustomType | CustomTypeType | CustomType details a custom type within a custom type scheme. |
7696
7697 ***CustomTypeBaseType*:** CustomTypeBaseType defines the base refinement of the CustomTypeType. Its purpose is to retrict the urn attribute.
7698
7699 Derivation:
7700
7701 *`AnnotableType`*` (extension)`
7702 *`IdentifiableType`*` (extension)`
7703 *`NameableType`*` (restriction)`
7704 *`ItemBaseType`*` (extension)`
7705 *`ItemType`*` (restriction)`
7706 *`UnnestedItemType`*` (restriction)`
7707 *`CustomTypeBaseType`*
7708
7709 Attributes:
7710 id, urn?, uri?
7711
7712 Content:
7713 Annotations?, Link, Name+, Description
7714
7715 Attribute Documentation:
7716
7717 | **Name** | **Type** | **Documentation** |
7718 | --- --| --- --| --- --|
7719 | id | IDType | The id is the identifier for the object. |
7720 | urn | CustomTypeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
7721 | 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. |
7722
7723 Element Documentation:
7724
7725 | **Name** | **Type** | **Documentation** |
7726 | --- --| --- --| --- --|
7727 | 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. |
7728 | 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. |
7729 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
7730 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
7731
7732 **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.
7733
7734 Derivation:
7735
7736 *`AnnotableType`*` (extension)`
7737 *`IdentifiableType`*` (extension)`
7738 *`NameableType`*` (restriction)`
7739 *`ItemBaseType`*` (extension)`
7740 *`ItemType`*` (restriction)`
7741 *`UnnestedItemType`*` (restriction)`
7742 *`CustomTypeBaseType`*` (extension)`
7743 `CustomTypeType`
7744
7745 Attributes:
7746 id, urn?, uri?
7747
7748 Content:
7749 Annotations?, Link*, Name+, Description*, VtlScalarType, DataType, VtlLiteralFormat?, OutputFormat?, NullValue?
7750
7751 Attribute Documentation:
7752
7753 | **Name** | **Type** | **Documentation** |
7754 | --- --| --- --| --- --|
7755 | id | IDType | The id is the identifier for the object. |
7756 | urn | CustomTypeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |
7757 | 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. |
7758
7759 Element Documentation:
7760
7761 | **Name** | **Type** | **Documentation** |
7762 | --- --| --- --| --- --|
7763 | 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. |
7764 | 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. |
7765 | Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |
7766 | Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |
7767 | VtlScalarType | xs:string | Identifies the VTL scalar type that is to be converted to an resulting output data type. |
7768 | 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. |
7769 | 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. |
7770 | 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. |
7771 | NullValue | xs:string | The value to be produced in the output of the conversion when a component has a null value. |
7772
7773 === 2.1.4 Simple Types ===
7774
7775 **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.
7776
7777 Derived by restriction of `SimpleDataType`.
7778
7779 Enumerations:
7780
7781 | **Value** | **Documentation** |
7782 | --- --| --- --|
7783 | String | A string datatype corresponding to W3C XML Schema's xs:string datatype. |
7784 | Alpha | A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z. |
7785 | 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. |
7786 | 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. |
7787 | BigInteger | An integer datatype corresponding to W3C XML Schema's xs:integer datatype. |
7788 | Integer | An integer datatype corresponding to W3C XML Schema's xs:int datatype. |
7789 | Long | A numeric datatype corresponding to W3C XML Schema's xs:long datatype. |
7790 | Short | A numeric datatype corresponding to W3C XML Schema's xs:short datatype. |
7791 | Boolean | A datatype corresponding to W3C XML Schema's xs:boolean datatype. |
7792 | URI | A datatype corresponding to W3C XML Schema's xs:anyURI datatype. |
7793 | Count | A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1". |
7794 | InclusiveValueRange | This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal. |
7795 | ExclusiveValueRange | This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal. |
7796 | 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. |
7797 | 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. |
7798 | 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. |
7799 | BasicTimePeriod | BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time. |
7800 | 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. |
7801 | GregorianYear | A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601. |
7802 | GregorianYearMonth | A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601. |
7803 | GregorianDay | A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601. |
7804 | 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. |
7805 | 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. |
7806 | 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. |
7807 | 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. |
7808 | 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. |
7809 | 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. |
7810 | 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. |
7811 | 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. |
7812 | Month | A time datatype corresponding to W3C XML Schema's xs:gMonth datatype. |
7813 | MonthDay | A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype. |
7814 | Day | A time datatype corresponding to W3C XML Schema's xs:gDay datatype. |
7815 | Duration | A time datatype corresponding to W3C XML Schema's xs:duration datatype. |
7816
7817 **WildcardedMemberValueType:** WildcardedMemberValueType allows for an optional wildcard characters ('%') in an identifier.
7818
7819 Derived by restriction of `xs:string`.
7820 Regular Expression Pattern: `[A-Za-z0-9_@$-%]+`
7821
7822 **GeoCodelistTypeType:** GeoCodelistTypeType defines an enumeration of the speicfic types of geographic codelists.
7823
7824 Derived by restriction of `xs:string`.
7825
7826 Enumerations:
7827
7828 | **Value** | **Documentation** |
7829 | --- --| --- --|
7830 | GeographicCodelist | |
7831 | GeoGridCodelist | |
7832
7833 **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.
7834
7835 Derived by restriction of `xs:string`.
7836
7837 Enumerations:
7838
7839 | **Value** | **Documentation** |
7840 | --- --| --- --|
7841 | Allowed | The constraint contains the allowed values for attachable object. |
7842 | Actual | The constraints contains the actual data present for the attachable object. |
7843
7844 **SimpleOperatorType:** SimpleOperatorType provides an enumeration of simple operators to be applied to any value.
7845
7846 Derived by restriction of `xs:string`.
7847
7848 Enumerations:
7849
7850 | **Value** | **Documentation** |
7851 | --- --| --- --|
7852 | notEqual | (|=) - value must not be equal to the value supplied. |
7853 | equal | (=) - value must be exactly equal to the value supplied. |
7854
7855 **RangeOperatorType:** RangeOperatorType provides an enumeration of range operators to be applied to an ordered value.
7856
7857 Derived by restriction of `xs:string`.
7858
7859 Enumerations:
7860
7861 | **Value** | **Documentation** |
7862 | --- --| --- --|
7863 | greaterThanOrEqual | (>=) - value must be greater than or equal to the value supplied. |
7864 | lessThanOrEqual | (<=) - value must be less than or equal to the value supplied. |
7865 | greaterThan | (>) - value must be greater than the value supplied. |
7866 | lessThan | (<) - value must be less than the value supplied. |
7867
7868 **TextSearchOperatorType:** TextSearchOperatorType provides an enumeration of text search operators.
7869
7870 Derived by restriction of `xs:string`.
7871
7872 Enumerations:
7873
7874 | **Value** | **Documentation** |
7875 | --- --| --- --|
7876 | contains | The text being searched must contain the supplied text. |
7877 | startsWith | The text being searched must start with the supplied text. |
7878 | endsWith | The text being searched must end with the supplied text. |
7879 | doesNotContain | The text being searched cannot contain the supplied text. |
7880 | doesNotStartWith | The text being searched cannot start with the supplied text. |
7881 | doesNotEndWith | The text being searched cannot end with the supplied text. |
7882
7883 **OrderedOperatorType:** OrderedOperatorType combines the SimpleOperatorType and the RangeOperatorType to provide a full range or operators for any ordered value.
7884
7885 Union of:
7886 SimpleOperatorType, RangeOperatorType.
7887
7888 **TextOperatorType:**
7889
7890 Union of:
7891 SimpleOperatorType, TextSearchOperatorType.
7892
7893 **TimeOperatorType:** TimeOperatorType derives from the OrderedOperatorType to remove the notEqual operator.
7894
7895 Derived by restriction of `OrderedOperatorType`.
7896
7897 Enumerations:
7898
7899 | **Value** | **Documentation** |
7900 | --- --| --- --|
7901 | equal | |
7902 | greaterThanOrEqual | |
7903 | lessThanOrEqual | |
7904 | greaterThan | |
7905 | lessThan | |
7906
7907 **UsageType:** An enumeration of optional | mandatory to indicate the usage of an attribute or measure.
7908
7909 Derived by restriction of `xs:string`.
7910
7911 Enumerations:
7912
7913 | **Value** | **Documentation** |
7914 | --- --| --- --|
7915 | mandatory | |
7916 | optional | |
7917
7918 **SimpleCodeDataType:** SimpleCodeDataType restricts SimpleDataType to specify the allowable data types for a simple code. The possible values are simply Alpha, AlphaNumeric, or Numeric.
7919
7920 Derived by restriction of `SimpleDataType`.
7921
7922 Enumerations:
7923
7924 | **Value** | **Documentation** |
7925 | --- --| --- --|
7926 | Alpha | A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z. |
7927 | 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. |
7928 | 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. |
7929
7930 **EpochPeriodType:** EpochPeriodType defines an enumeration of epoch period types.
7931
7932 Derived by restriction of `xs:string`.
7933
7934 Enumerations:
7935
7936 | **Value** | **Documentation** |
7937 | --- --| --- --|
7938 | nanosecond | |
7939 | millisecond | |
7940 | microsecond | |
7941 | second | |
7942 | day | |
7943
7944 **ResolvePeriodType:** ResolvePeriodType defines an enumeration of how date periods should be resolved.
7945
7946 Derived by restriction of `xs:string`.
7947
7948 Enumerations:
7949
7950 | **Value** | **Documentation** |
7951 | --- --| --- --|
7952 | startOfPeriod | |
7953 | endOfPeriod | |
7954 | midPeriod | |
7955
7956 **StandardToVtlMappingMethodType:** A simple type enumerating the standard mapping methods when converting from data structures from SDMX to VLT.
7957
7958 Derived by restriction of `xs:string`.
7959
7960 Enumerations:
7961
7962 | **Value** | **Documentation** |
7963 | --- --| --- --|
7964 | Basic | The default mapping method. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.1 ("Basic Mapping"). |
7965 | Pivot | Method for mapping multi-measure data. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.2 ("Pivot Mapping"). |
7966 | 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"). |
7967 | 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"). |
7968
7969 **ToVtlMappingMethodType:** A simple type that allows for a standard to VTL mapping method enumeration value or a string value for other mapping methods.
7970
7971 Union of:
7972 StandardToVtlMappingMethodType, xs:string.
7973
7974 **StandardFromVtlMappingMethodType:** A simple type enumerating the standard mapping methods when converting from data structures from VTL to SDMX.
7975
7976 Derived by restriction of `xs:string`.
7977
7978 Enumerations:
7979
7980 |**Value**|**Documentation**|
7981 | --- --| --- --|
7982 | 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"). |
7983 | Unpivot | The mapping method to be used when the VTL data structure has more than one measure component. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.4.2 ("Unpivot Mapping"). |
7984 | 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").|
7985
7986 **FromVtlMappingMethodType:** A simple type that allows for standard from VTL mapping method enumeration value or a string value for other mapping methods.
7987
7988 Union of:
7989 StandardFromVtlMappingMethodType, xs:string.
7990
7991 **CustomTypeDataType:** A simple type that allows for a SDMX simple data type enumeration value or a string value for other data types.
7992
7993 Union of:
7994 SimpleDataType, xs:string.