Skip to Content

Wiki source code of Part III. Structure

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