Skip to Content

Wiki source code of Part III. Structure

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