Skip to Content

Wiki source code of Part III. Structure

Version 7.6 by Helena on 2025/06/30 23:13
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 **Corrigendum**
6
7 The following problems with the specification dated April 2011 have been rectified as described below.
8
9 1. **Problem**
10
11 Various parts of the the documentation refer to stand-alone concepts, which were part of earlier draft releases but ultimately excluded from the final release of the standard.
12
13 **Rectification**
14
15 The documentation has been updated to remove this reference. This documentation includes:
16
17 * Concepts entry for Element Documentation of StructuresType (table beginning line 226).
18 * ConceptsType (line 270).
19
20 1. **Problem**
21
22 The ComponentMap element in the complex type StructureMapType has a maximum occurrence of 1. Therefore, it is not possible to completely map all components of a structure.
23
24 **Rectification**
25
26 The documentation of the StructureMapType has been updated to reflect that maximum occurrence of "unbounded" (line 2508).
27
28 = 1 Introduction =
29
30 The structure namespace contains the definition of all structural metadata constructs. These constructs are intended to be very tightly coupled with the information model to ease the burden of implementers on translating the information from the XML messages into objects based on the information model.
31
32 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 frmed the basis of the final types which make up the information that is actually exchanged in SDMX messages. The intermediate types are all abstract, so they are not explicitly used in a message. They do however serve the purpose of creating a strong relation of the schemas to the information model.
33
34 = 2 Schema Documentation =
35
36 == 2.1 Structure Namespace ==
37
38 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/structure**
39
40 === 2.1.1 Summary ===
41
42 Referenced Namespaces:
43
44 |**Namespace**|**Prefix**
45 | |
46 |http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
47 |http:~/~/www.w3.org/2001/XMLSchema|xs
48
49 Contents:
50
51 47 Global Elements
52 199 Complex Types
53 10 Simple Types
54
55 === 2.1.2 Global Elements ===
56
57 **Structures (StructuresType): **Structures contains constructs for all structural metadata components.
58
59 //**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.
60
61 Substitutions: Category, Code, Concept, //Organisation//, Agency, DataConsumer, DataProvider, OrganisationUnit, ReportingCategory, Transformation, VtlMapping, NamePersonalisation, Ruleset, UserDefinedOperator, CustomType
62
63 //**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.
64
65 Substitutions: DataStructureComponents, MetadataStructureComponents
66
67 //**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.
68
69 Substitutions: AttributeList, DimensionList, Group, MeasureList, MetadataTarget, ReportStructure
70
71 //**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.
72
73 Substitutions: Attribute, ReportingYearStartDay, Dimension, TimeDimension, MeasureDimension, GroupDimension, PrimaryMeasure, KeyDescriptorValuesTarget, DataSetTarget, ConstraintContentTarget, ReportPeriodTarget, IdentifiableObjectTarget, MetadataAttribute
74
75 **Category (CategoryType): **Category represents a set of nested categories which describe a simple classification hierarchy.
76
77 Substitution For: //Item//
78
79 **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.
80
81 Substitution For: //Item//
82
83 **Concept (ConceptType): **Concept describes the details of a concept within a concept scheme.
84
85 Substitution For: //Item//
86
87 **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 three reserved identifiers in a data structure definition; OBS_VALUE, TIME_PERIOD, and REPORTING_PERIOD_START_DAY. These identifiers may not be used outside of their respective defintions (PrimaryMeasure, 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.
88
89 Substitution For: //Grouping//
90
91 **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.
92
93 Substitution For: //ComponentList//
94
95 **Attribute (AttributeType): **Attribute describes the definition of a data attribute, which is defined as a characteristic of an object or entity.
96
97 Substitution For: //Component//
98
99 **ReportingYearStartDay (ReportingYearStartDayType): **ReportingYearStartDay is a specialized data attribute which provides important context to the time dimension. If the value of the time dimension is one of the standard reporting periods (see common:ReportingTimePeriodType) then this attribute is used to state the month and day that the reporting year begins. This provides a reference point from which the actual calendar dates covered by these periods can be determined. If this attribute does not occur in a data set, then the reporting year start day will be assumed to be January 1.
100
101 Substitution For: //Component//
102
103 **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.
104
105 Substitution For: //ComponentList//
106
107 **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.
108
109 Substitution For: //Component//
110
111 **TimeDimension (TimeDimensionType): **TimeDimension is a special dimension which designates the period in time in which the data identified by the full series key applies.
112
113 Substitution For: //Component//
114
115 **MeasureDimension (MeasureDimensionType): **MeasureDimension is a special type of dimension which defines multiple measures in a key family. This is represented as any other dimension in a unless it is the observation dimension. It takes it representation from a concept scheme, and this scheme defines the measures and their representations. When data is formatted with this as the observation dimension, these measures can be made explicit or the value of the dimension can be treated as any other dimension. If the measures are explicit, the representation of the observation will be specific to the core representation for each concept in the representation concept scheme. Note that it is necessary that these representations are compliant (the same or derived from) with that of the primary measure.
116
117 Substitution For: //Component//
118
119 **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.
120
121 Substitution For: //ComponentList//
122
123 **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.
124
125 Substitution For: //Component//
126
127 **MeasureList (MeasureListType): **MeasureList describes the measure descriptor for a key family. It contains a single metadata concepts that define the primary measures of a data structure.
128
129 Substitution For: //ComponentList//
130
131 **PrimaryMeasure (PrimaryMeasureType): **PrimaryMeasure defines the structure of the primary measure, which is the concept that is the value of the phenomenon to be measured in a data set. Although this may take its semantic from any concept, this is provided a fixed identifier (OBS_VALUE) so that it may be easily distinguished in data messages.
132
133 Substitution For: //Component//
134
135 **MetadataStructureComponents (MetadataStructureComponentsType): **MetadataStructureComponents defines the grouping of the sets of the components that make up the metadata structure definition. All components and component list (target identifiers, identifier components, report structures, and metadata attributes) in the structure definition must have a unique identification.
136
137 Substitution For: //Grouping//
138
139 **MetadataTarget (MetadataTargetType): **MetadataTarget is a collection of target objects which when taken together describe a structure which defines the key of an object type to which metadata may be attached and serve to disambiguate reference metadata set reports.
140
141 Substitution For: //ComponentList//
142
143 **KeyDescriptorValuesTarget (KeyDescriptorValuesTargetType): **KeyDescriptorValuesTarget is target object which references a data key for the purpose of attach reference metadata to portions of data. A data key is a set of dimension references and values for those dimension. This component on its own is not of much use, as the data key only has local references to the dimensions. Therefore it is typical that this is used in combination with some sort of reference to the data (either a data set reference or a reference to the underlying structure, structure usage, or provision agreement of the data.
144
145 Substitution For: //Component//
146
147 **DataSetTarget (DataSetTargetType): **DataSetTarget is target object which references a data set for the purpose of attaching reference metadata data. A data set reference is a full reference to a data provider and an identifier for the data set.
148
149 Substitution For: //Component//
150
151 **ConstraintContentTarget (ConstraintContentTargetType): **ConstraintContentTarget is target object which references an attachment constraint for the purpose of attaching reference metadata data to data key sets or cube regions defined by the constraint.
152
153 Substitution For: //Component//
154
155 **ReportPeriodTarget (ReportPeriodTargetType): **ReportPeriodTarget is target object which specifies a reporting period to which a metadata report applies.
156
157 Substitution For: //Component//
158
159 **IdentifiableObjectTarget (IdentifiableObjectTargetType): **IdentifiableObjectTarget is target object which references an Identifiable object as defined in the SDMX Information Model. The reference must be complete (i.e. a URN or a complete set of reference fields). For an item object, it is possible to define a local representation of an item scheme from which the item must be referenced.
160
161 Substitution For: //Component//
162
163 **ReportStructure (ReportStructureType): **ReportStructure defines a report structure, which comprises a 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 report 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.
164
165 Substitution For: //ComponentList//
166
167 **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.
168
169 Substitution For: //Component//
170
171 //**Organisation**//** (//OrganisationType//): **Organisation is an abstract substitution head for a generic organisation.
172
173 Substitution For: //Item//
174
175 Substitutions: Agency, DataConsumer, DataProvider, OrganisationUnit
176
177 **Agency (AgencyType): **Agency is an organisation which maintains structural metadata such as statistical classifications, glossaries, key family structural definitions, and metadata structure definitions..
178
179 Substitution For: //Organisation//
180
181 **DataConsumer (DataConsumerType): **DataConsumer describes an organisation using data as input for further processing.
182
183 Substitution For: //Organisation//
184
185 **DataProvider (DataProviderType): **DataProvider describes an organisation that produces data or reference metadata.
186
187 Substitution For: //Organisation//
188
189 **OrganisationUnit (OrganisationUnitType): **OrganisationUnit describes a generic organisation, which serves not predefined role in SDMX.
190
191 Substitution For: //Organisation//
192
193 **ReportingCategory (ReportingCategoryType): **ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages.
194
195 Substitution For: //Item//
196
197 //**ItemAssociation**//** (//ItemAssociationType//): **ItemAssociation is an abstract description of the relation between two items for the purpose of mapping.
198
199 Substitutions: OrganisationMap, CategoryMap, CodeMap, ConceptMap, ReportingCategoryMap
200
201 **OrganisationMap (OrganisationMapType): **OrganisationMap relates a source organisation to a target organisation.
202
203 Substitution For: //ItemAssociation//
204
205 **CategoryMap (CategoryMapType): **CategoryMap defines the structure of a map which identifies relationships between categories in different category schemes.
206
207 Substitution For: //ItemAssociation//
208
209 **CodeMap (CodeMapType): **CodeMap defines the structure of a map which identifies relationships between codes in different codelists.
210
211 Substitution For: //ItemAssociation//
212
213 **ConceptMap (ConceptMapType): **ConceptMap defines the structure of a map which identifies relationships between concepts in different concept schemes.
214
215 Substitution For: //ItemAssociation//
216
217 **ReportingCategoryMap (ReportingCategoryMapType): **ReportingCategoryMap defines the structure of a map which identifies relationships between reporting categories in different reporting taxonomies.
218
219 Substitution For: //ItemAssociation//
220
221 **Transformation (TransformationType): **Transformation describes the details of a single transformation within a transformation scheme.
222
223 Substitution For: //Item//
224
225 **VtlMapping (VtlMappingType): **VtlMapping details a mapping between SDMX and VTL transformation.
226
227 Substitution For: //Item//
228
229 **NamePersonalisation (NamePersonalisationType): **NamePersonalisation details a name personalisation that is used in a transformation.
230
231 Substitution For: //Item//
232
233 **Ruleset (RulesetType): **Ruleset details a ruleset within a ruleset scheme.
234
235 Substitution For: //Item//
236
237 **UserDefinedOperator (UserDefinedOperatorType): **UserDefinedOperator details a user defined operators within a user defined operator scheme.
238
239 Substitution For: //Item//
240
241 **CustomType (CustomTypeType): **CustomType details a custom type within a custom type scheme.
242
243 Substitution For: //Item//
244
245 === 2.1.3 Complex Types ===
246
247 **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.
248
249 Content:
250
251 OrganisationSchemes?, Dataflows?, Metadataflows?, CategorySchemes?, Categorisations?, Codelists?, HierarchicalCodelists?, Concepts?, MetadataStructures?, DataStructures?, StructureSets?, ReportingTaxonomies?, Processes?, Constraints?, ProvisionAgreements?, CustomTypes?, VtlMappings?, NamePersonalisations?, Rulesets?, Transformations?, UserDefinedOperators?
252
253 Element Documentation:
254
255 |**Name**|**Type**|**Documentation**
256 |OrganisationSchemes|OrganisationSchemesType|OrganisationSchemes contains a collection of organisation scheme descriptions. The organisation schemes may be detailed in full, or referenced from an external structure document or registry service.
257 |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.
258 |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.
259 |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.
260 |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.
261 |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.
262 |HierarchicalCodelists|HierarchicalCodelistsType|HierarchicalCodelists 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.
263 |Concepts|ConceptsType|Concepts contains a collection of concept descriptions. The concepts described are contained within schemes. The concepts may be detailed in full, or referenced from an external structure document or registry service.
264 |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.
265 |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.
266 |StructureSets|StructureSetsType|StructureSets contains a collection of structure set descriptions. The structure sets may be detailed in full, or referenced from an external structure document or registry service.
267 |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.
268 |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.
269 |Constraints|ConstraintsType|Constraints contains a collection of constraint descriptions. This container may contain both attachment and content constraints. The constraints may be detailed in full, or referenced from an external structure document or registry service.
270 |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.
271 |CustomTypes|CustomTypesType|CustomTypes contains a collection of custom type schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service.
272 |VtlMappings|VtlMappingsType|VtlMappings contains a collection of VTL mapping schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service.
273 |NamePersonalisations|NamePersonalisations Type|NamePersonalisations contains a collection of name personalisation schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service.
274 |Rulesets|RulesetsType|Rulsets contains a collection of ruleset schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service.
275 |Transformations|TransformationsType|Transformations contains a collection of transformation schemes. The transformation schemes may be detailed in full, or referenced from an external structure document or registry service.
276 |UserDefinedOperators|UserDefinedOperatorsType|UserDefinedOperators 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.
277
278 **OrganisationSchemesType: **OrganisationSchemesType describes the structure of the organisation schemes container. It contains one or more organisation scheme, which can be explicitly detailed or referenced from an external structure document or registry service.
279
280 Content:
281
282 (AgencyScheme | DataConsumerScheme | DataProviderScheme | OrganisationUnitScheme)+
283
284 Element Documentation:
285
286 |**Name**|**Type**|**Documentation**
287 |AgencyScheme|AgencySchemeType|AgencyScheme provides the details of an agency scheme, in which agencies are described.
288 |DataConsumerScheme|DataConsumerSchemeType|DataConsumerScheme provides the details of an data consumer scheme, in which data consumers are described.
289 |DataProviderScheme|DataProviderSchemeType|DataProviderScheme provides the details of an data provider scheme, in which data providers are described.
290 |OrganisationUnitSche me|OrganisationUnitSchemeType|OrganisationUnitScheme provides the details of an organisation unit scheme, in which organisation units are described.
291
292 **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.
293
294 Content:
295
296 Dataflow+
297
298 Element Documentation:
299
300 |**Name**|**Type**|**Documentation**
301 |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.
302
303 **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.
304
305 Content:
306
307 Metadataflow+
308
309 Element Documentation:
310
311 |**Name**|**Type**|**Documentation**
312 |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
313
314 **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.
315
316 Content:
317
318 CategoryScheme+
319
320 Element Documentation:
321
322 |**Name**|**Type**|**Documentation**
323 |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.
324
325 **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.
326
327 Content:
328
329 Categorisation+
330
331 Element Documentation:
332
333 |**Name**|**Type**|**Documentation**
334 |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.
335
336 **CodelistsType: **CodelistsType describes the structure of the code lists container. It contains one or more code list, which can be explicitly detailed or referenced from an external structure document or registry service.
337
338 Content:
339
340 Codelist+
341
342 Element Documentation:
343
344 |**Name**|**Type**|**Documentation**
345 |Codelist|CodelistType|Codelist provides the details of a code list, which is defined as a list from which some statistical concepts (coded concepts) take their values.
346
347 **HierarchicalCodelistsType: **HierarchicalCodelistsType describes the structure of the hierarchical code lists container. It contains one or more hierarchical code list, which can be explicitly detailed or referenced from an external structure document or registry service.
348
349 Content:
350
351 HierarchicalCodelist+
352
353 Element Documentation:
354
355 |**Name**|**Type**|**Documentation**
356 |HierarchicalCodelist|HierarchicalCodelistType|HierarchicalCodelist provides the details of a hierarchical code list, which is defined as an organised collection of codes that may participate in many parent/child relationships with other codes in the list, as defined by one or more hierarchy of the list.
357
358 **ConceptsType: **ConceptsType describes the structure of the concepts container. It contains one or more concept schemes, which can be explicitly detailed or referenced from an external structure document or registry service.
359
360 Content:
361
362 ConceptScheme*
363
364 Element Documentation:
365
366 |**Name**|**Type**|**Documentation**
367 |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.
368
369 **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.
370
371 Content:
372
373 MetadataStructure+
374
375 Element Documentation:
376
377 |**Name**|**Type**|**Documentation**
378 |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 a reference metadata report is derived from this presentational structure.
379
380 **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.
381
382 Content:
383
384 DataStructure+
385
386 Element Documentation:
387
388 |**Name**|**Type**|**Documentation**
389 |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.
390
391 **StructureSetsType: **StructureSetsType describes the structure of the structure sets container. It contains one or more structure set, which can be explicitly detailed or referenced from an external structure document or registry service.
392
393 Content:
394
395 StructureSet+
396
397 Element Documentation:
398
399 |**Name**|**Type**|**Documentation**
400 |StructureSet|StructureSetType|StructureSet provides the details or a structure set, which allows components in one structure, structure usage, or item scheme to be mapped to components in another structural component of the same type.
401
402 **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.
403
404 Content:
405
406 ReportingTaxonomy+
407
408 Element Documentation:
409
410 |**Name**|**Type**|**Documentation**
411 |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.
412
413 **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.
414
415 Content:
416
417 Process+
418
419 Element Documentation:
420
421 |**Name**|**Type**|**Documentation**
422 |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.
423
424 **ConstraintsType: **ConstraintsType describes the structure of the constraints container. It contains one or more 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.
425
426 Content
427
428 (AttachmentConstraint | ContentConstraint)+
429
430 Element Documentation:
431
432 |**Name**|**Type**|**Documentation**
433 |AttachmentConstraint|AttachmentConstraintType|AttachmentConstraint describes sub sets of the content of a data or metadata set in terms of the content regions or in terms of the set of key combinations to which attributes or reference metadata (as defined by structure definitions) may be attached.
434 |ContentConstraint|ContentConstraintType|ContentConstraint specifies a sub set of the definition of the allowable or available content of a data or metadata set in terms of the content or in terms of the set of key combinations.
435
436 **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.
437
438 Content:
439
440 ProvisionAgreement+
441
442 Element Documentation:
443
444 |**Name**|**Type**|**Documentation**
445 |ProvisionAgreement|ProvisionAgreementTy pe|ProvisionAgreement provides the details of a provision agreement, which is an agreement for a data provider to report data or reference metadata against a flow.
446
447 **CustomTypesType: **CustomTypesType 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.
448
449 Content:
450
451 CustomTypeScheme+
452
453 Element Documentation:
454
455 |**Name**|**Type**|**Documentation**
456 |CustomTypeScheme|CustomTypeSchemeType|CustomTypeScheme provides the details of a custom type scheme, in which user defined operators are described.
457
458 **VtlMappingsType: **VtlMappingsType 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.
459
460 Content:
461
462 VtlMappingScheme+
463
464 Element Documentation:
465
466 |**Name**|**Type**|**Documentation**
467 |VtlMappingScheme|VtlMappingSchemeType|VtlMappingScheme provides the details of a VTL mapping scheme, in which VTL mappings are described.
468
469 **NamePersonalisationsType: **NamePersonalisationsType 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.
470
471 Content:
472
473 NamePersonalisationScheme+
474
475 Element Documentation:
476
477 |**Name**|**Type**|**Documentation**
478 |NamePersonalisationS cheme|NamePersonalisationSchemeType|NamePersonalisationScheme provides the details of a name personalisation scheme, in which name personalisations are described.
479
480 **RulesetsType: **RulesetsType 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.
481
482 Content:
483
484 RulesetScheme+
485
486 Element Documentation:
487
488 |**Name**|**Type**|**Documentation**
489 |RulesetScheme|RulesetSchemeType|RulesetScheme provides the details of a ruleset scheme, in which rulesets are described.
490
491 **TransformationsType: **TransformationsType 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.
492
493 Content:
494
495 TransformationScheme+
496
497 Element Documentation
498
499 |**Name**|**Type**|**Documentation**
500 |TransformationScheme|TransformationSchemeType|TransformationScheme provides the details of a transformation scheme, in which transformations are described.
501
502 **UserDefinedOperatorsType: **UserDefinedOperatorsType 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.
503
504 Content:
505
506 UserDefinedOperatorScheme+
507
508 Element Documentation:
509
510 |**Name**|**Type**|**Documentation**
511 |UserDefinedOperatorS cheme|UserDefinedOperatorS chemeType|UserDefinedOperatorScheme provides the details of a user defined operator scheme, in which user defined operators are described.
512
513 //**IdentifiableType**//**: **IdentifiableType is an abstract base type for all identifiable objects.
514
515 Derivation:
516
517 //com:AnnotableType// (extension)
518 //dentifiableType//
519
520 Attributes:
521
522 id?, urn?, uri?
523
524 Content:
525
526 com:Annotations?
527
528 Attribute Documentation:
529
530 |**Name**|**Type**|**Documentation**
531 |d|com:IDType|The id is the identifier for the object.
532 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
533 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
534
535 Element Documentation:
536
537 |**Name**|**Type**|**Documentation**
538 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
539
540 //**NameableType**//**: **NameableType is an abstract base type for all nameable objects.
541
542 Derivation:
543
544 //com:AnnotableType// (extension)
545 //IdentifiableType// (extension)
546 //NameableType//
547
548 Attributes:
549
550 id?, urn?, uri?
551
552 Content:
553
554 com:Annotations?, com:Name+, com:Description*
555
556 Attribute Documentation:
557
558 |**Name**|**Type**|**Documentation**
559 |id|com:IDType|The id is the identifier for the object.
560 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
561 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
562
563 Element Documentation:
564
565 |**Name**|**Type**|**Documentation**
566 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
567 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
568 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
569
570 //**VersionableType**//**: **VersionableType is an abstract base type for all versionable objects.
571
572 Derivation:
573
574 //com:AnnotableType// (extension)
575 //IdentifiableType// (extension)
576 //NameableType// (extension)
577 //VersionableType//
578
579 Attributes:
580
581 id?, urn?, uri?, version?, validFrom?, validTo?
582
583 Content:
584
585 com:Annotations?, com:Name+, com:Description*
586
587 Attribute Documentation:
588
589 |**Name**|**Type**|**Documentation**
590 |id|com:IDType|The id is the identifier for the object.
591 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
592 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
593 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
594 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
595 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
596
597 Element Documentation:
598
599 |**Name**|**Type**|**Documentation**
600 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
601 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
602 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
603
604 //**MaintainableBaseType**//**: **MaintainableBaseType is an abstract type that only serves the purpose of forming the base for the actual MaintainableType. The purpose of this type is to restrict the VersionableType to require the id attribute.
605
606 Derivation:
607
608 //com:AnnotableType// (extension)
609
610 //IdentifiableType// (extension)
611 //NameableType// (extension)
612 //VersionableType// (restriction)
613 //MaintainableBaseType//
614
615 Attributes:
616
617 id, urn?, uri?, version?, validFrom?, validTo?
618
619 Content:
620
621 com:Annotations?, com:Name+, com:Description*
622
623 Attribute Documentation:
624
625 |**Name**|**Type**|**Documentation**
626 |id|com:IDType|The id is the identifier for the object.
627 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
628 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
629 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
630 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
631 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
632
633 Element Documentation:
634
635 |**Name**|**Type**|**Documentation**
636 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
637 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
638 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
639
640 //**MaintainableType**//**: **MaintainableType is an abstract base type for all maintainable objects.
641
642 Derivation:
643
644 //com:AnnotableType// (extension)
645 //IdentifiableType// (extension)
646 //NameableType// (extension)
647 //VersionableType// (restriction)
648 //MaintainableBaseType// (extension)
649 //MaintainableType//
650
651 Attributes:
652
653 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
654
655 Content:
656
657 com:Annotations?, com:Name+, com:Description*
658
659 Attribute Documentation:
660
661 |**Name**|**Type**|**Documentation**
662 |id|com:IDType|The id is the identifier for the object.
663 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
664 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
665 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
666 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
667 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
668 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
669 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
670 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
671 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
672 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
673
674 Element Documentation:
675
676 |**Name**|**Type**|**Documentation**
677 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
678 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
679 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
680
681 //**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.
682
683 Derivation:
684
685 //com:AnnotableType// (extension)
686 //IdentifiableType// (extension)
687 //NameableType// (extension)
688 //VersionableType// (restriction)
689 //MaintainableBaseType// (extension)
690 //MaintainableType// (extension)
691 //ItemSchemeType//
692
693 Attributes:
694
695 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
696
697 Content:
698
699 com:Annotations?, com:Name+, com:Description*, //Item*//
700
701 Attribute Documentation:
702
703 |**Name**|**Type**|**Documentation**
704 |id|com:IDType|The id is the identifier for the object.
705 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
706 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
707 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
708 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
709 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
710 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
711 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
712 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
713 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
714 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
715 |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 key family in the context of a constraint.
716
717 Element Documentation:
718
719 |**Name**|**Type**|**Documentation**
720 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
721 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
722 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
723 |//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.
724
725 //**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.
726
727 Derivation:
728
729 //com:AnnotableType// (extension)
730 //IdentifiableType// (extension)
731 //NameableType// (restriction)
732 //ItemBaseType//
733
734 Attributes:
735
736 id, urn?, uri?
737
738 Content:
739
740 com:Annotations?, com:Name+, com:Description*
741
742 Attribute Documentation:
743
744 |**Name**|**Type**|**Documentation**
745 |id|com:IDType|The id is the identifier for the object.
746 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
747 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
748
749 Element Documentation:
750
751 |**Name**|**Type**|**Documentation**
752 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
753 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
754 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
755
756 //**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.
757
758 Derivation:
759
760 //com:AnnotableType// (extension)
761 //IdentifiableType// (extension)
762 //NameableType// (restriction)
763 //ItemBaseType// (extension)
764 //ItemType//
765
766 Attributes:
767
768 id, urn?, uri?
769
770 Content:
771
772 com:Annotations?, com:Name+, com:Description*, (Parent | //Item+//)?
773
774 Attribute Documentation:
775
776 |**Name**|**Type**|**Documentation**
777 |id|com:IDType|The id is the identifier for the object.
778 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
779 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
780
781 Element Documentation:
782
783 |**Name**|**Type**|**Documentation**
784 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
785 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
786 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
787 |Parent|//com: LocalItemReferenceTy pe//|
788 |//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.
789
790 //**UnnestedItemType**//**: **UnnestedItemType is an abstract base type for all items with in an item scheme that do not contain nexted items.
791
792 Derivation:
793
794 //com:AnnotableType// (extension)
795 //IdentifiableType// (extension)
796 //NmeableType// (restriction)
797 //ItemBaseType// (extension)
798 //ItemType// (restriction)
799 //UnnestedItemType//
800
801 Attributes:
802
803 id, urn?, uri?
804
805 Content:
806
807 com:Annotations?, com:Name+, com:Description*
808
809 Attribute Documentation:
810
811 |**Name**|**Type**|**Documentation**
812 |id|com:IDType|The id is the identifier for the object.
813 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
814 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
815
816 Element Documentation:
817
818 |**Name**|**Type**|**Documentation**
819 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
820 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
821 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
822
823 //**StructureType**//**: **StructureType is an abstract base type for all structure objects. Concrete instances of this should restrict to a concrete grouping.
824
825 Derivation:
826
827 //com:AnnotableType// (extension)
828 //IdentifiableType// (extension)
829 //NameableType// (extension)
830 //VersionableType// (restriction)
831 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
832 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
833 [[image:inherit.gif||height="9" width="9"]] //StructureType//
834
835 Attributes:
836
837 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
838
839 Content:
840
841 com:Annotations?, com:Name+, com:Description*, //Grouping?//
842
843 Attribute Documentation:
844
845 |**Name**|**Type**|**Documentation**
846 |id|com:IDType|The id is the identifier for the object.
847 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
848 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
849 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
850 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
851 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
852 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
853 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
854 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
855 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
856 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
857
858 Element Documentation:
859
860 |**Name**|**Type**|**Documentation**
861 |com:Annotations|com:AnnotationsType|Annotations is a reusable 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 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
863 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
864 |//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.
865
866 //**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.
867
868 Content:
869
870 //ComponentList*//
871
872 Element Documentation:
873
874 |**Name**|**Type**|**Documentation**
875 |//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.
876
877 //**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.
878
879 Derivation:
880
881 //com:AnnotableType// (extension)
882 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
883 [[image:inherit.gif||height="9" width="9"]] //ComponentListType//
884
885 Attributes:
886
887 id?, urn?, uri?
888
889 Content:
890
891 com:Annotations?, //Component*//
892
893 Attribute Documentation:
894
895 |**Name**|**Type**|**Documentation**
896 |id|com:IDType|The id is the identifier for the object.
897 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
898 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
899
900 Element Documentation:
901
902 |**Name**|**Type**|**Documentation**
903 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
904 |//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.
905
906 //**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.
907
908 Derivation:
909
910 //com:AnnotableType// (extension)
911 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
912 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType//
913
914 Attributes:
915
916 id?, urn?, uri?
917
918 Content:
919
920 com:Annotations?
921
922 Attribute Documentation:
923
924 |**Name**|**Type**|**Documentation**
925 |id|com: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).
926 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
927 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
928
929 Element Documentation:
930
931 |**Name**|**Type**|**Documentation**
932 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
933
934 //**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.
935
936 Derivation:
937
938 //com:AnnotableType// (extension)
939 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
940 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
941 [[image:inherit.gif||height="9" width="9"]] //ComponentType//
942
943 Attributes:
944
945 id?, urn?, uri?
946
947 Content:
948
949 com:Annotations?, ConceptIdentity?, LocalRepresentation?
950
951 Attribute Documentation:
952
953 |**Name**|**Type**|**Documentation**
954 |id|com: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).
955 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
956 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
957
958 Element Documentation:
959
960 |**Name**|**Type**|**Documentation**
961 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
962 |ConceptIdentity|com: 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.
963 |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.
964
965 //**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.
966
967 Derivation:
968
969 //com:AnnotableType// (extension)
970 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
971 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
972 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
973 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
974 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
975 [[image:inherit.gif||height="9" width="9"]] //StructureUsageType//
976
977 Attributes:
978
979 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
980
981 Content:
982
983 com:Annotations?, com:Name+, com:Description*, Structure?
984
985 Attribute Documentation:
986
987 |**Name**|**Type**|**Documentation**
988 |id|com:IDType|The id is the identifier for the object.
989 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
990 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
991 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
992 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
993 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
994 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
995 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
996 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
997 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
998 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
999
1000 Element Documentation:
1001
1002 |**Name**|**Type**|**Documentation**
1003 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1004 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1005 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1006 |Structure|//com: StructureReferenceBa seType//|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).
1007
1008 //**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.
1009
1010 Content:
1011
1012 (TextFormat | (Enumeration, EnumerationFormat?))
1013
1014 Element Documentation:
1015
1016 |**Name**|**Type**|**Documentation**
1017 |TextFormat|TextFormatType|TextFormat describes an uncoded textual format.
1018 |Enumeration|//com: ItemSchemeReferenceB aseType//|Enumeration references an item scheme that enumerates the allowable values for this representation.
1019 |EnumerationFormat|CodededTextFormatTyp e|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.
1020
1021 **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".
1022
1023 Attributes:
1024
1025 textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?, isMultiLingual?
1026
1027 Content:
1028
1029 {Empty}
1030
1031 Attribute Documentation:
1032
1033 |**Name**|**Type**|**Documentation**
1034 |textType (default: String)|com: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.
1035 |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.
1036 |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.
1037 |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.
1038 |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.
1039 |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.
1040 |startTime|com: StandardTimePeriodTy pe|The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.
1041 |endTime|com: StandardTimePeriodTy pe|The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence.
1042 |minLength|xs:positiveInteger|The minLength attribute specifies the minimum and length of the value in characters.
1043 |maxLength|xs:positiveInteger|The maxLength attribute specifies the maximum length of the value in characters.
1044 |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.
1045 |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.
1046 |decimals|xs:positiveInteger|The decimals attribute indicates the number of characters allowed after the decimal separator.
1047 |pattern|xs:string|The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema.
1048 |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.
1049
1050 **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.
1051
1052 Derivation:
1053
1054 TextFormatType (restriction)
1055 [[image:inherit.gif||height="9" width="9"]] BasicComponentTextFormatType
1056
1057 Attributes:
1058
1059 textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?, isMultiLingual?
1060
1061 Content:
1062
1063 {Empty}
1064
1065 Attribute Documentation:
1066
1067 |**Name**|**Type**|**Documentation**
1068 |textType (default: String)|com: BasicComponentDataTy pe|The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets.
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: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.
1071 |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.
1072 |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.
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|com: StandardTimePeriodTy pe|The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.
1075 |endTime|com: StandardTimePeriodTy pe|The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence.
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: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.
1079 |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.
1080 |decimals|xs:positiveInteger|The decimals attribute indicates the number of characters allowed after the decimal separator.
1081 |pattern|xs:string|The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema.
1082 |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.
1083
1084 **SimpleComponentTextFormatType: **SimpleComponentTextFormatType is a restricted version of the BasicComponentTextFormatType that does not allow for multi-lingual values.
1085
1086 Derivation:
1087
1088 TextFormatType (restriction)
1089 [[image:inherit.gif||height="9" width="9"]] BasicComponentTextFormatType (restriction)
1090 [[image:inherit.gif||height="9" width="9"]] SimpleComponentTextFormatType
1091
1092 Attributes:
1093
1094 textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?
1095
1096 Content:
1097
1098 {Empty}
1099
1100 Attribute Documentation:
1101
1102 |**Name**|**Type**|**Documentation**
1103 |textType (default: String)|com: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.
1104 |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.
1105 |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.
1106 |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.
1107 |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.
1108 |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.
1109 |startTime|com: StandardTimePeriodTy pe|The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.
1110 |endTime|com: StandardTimePeriodTy pe|The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence.
1111 |minLength|xs:positiveInteger|The minLength attribute specifies the minimum and length of the value in characters.
1112 |maxLength|xs:positiveInteger|The maxLength attribute specifies the maximum length of the value in characters.
1113 |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.
1114 |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.
1115 |decimals|xs:positiveInteger|The decimals attribute indicates the number of characters allowed after the decimal separator.
1116 |pattern|xs:string|The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema.
1117
1118 **CodededTextFormatType: **CodededTextFormatType 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.
1119
1120 Derivation:
1121
1122 TextFormatType (restriction)
1123 [[image:inherit.gif||height="9" width="9"]] BasicComponentTextFormatType (restriction)
1124 [[image:inherit.gif||height="9" width="9"]] SimpleComponentTextFormatType (restriction)
1125 [[image:inherit.gif||height="9" width="9"]] CodededTextFormatType
1126
1127 Attributes:
1128
1129 textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, pattern?
1130
1131 Content:
1132
1133 {Empty}
1134
1135 Attribute Documentation:
1136
1137 |**Name**|**Type**|**Documentation**
1138 |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.
1139 |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.
1140 |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.
1141 |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.
1142 |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.
1143 |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.
1144 |startTime|com: StandardTimePeriodTy pe|The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.
1145 |endTime|com: StandardTimePeriodTy pe|The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence.
1146 |minLength|xs:positiveInteger|The minLength attribute specifies the minimum and length of the value in characters.
1147 |maxLength|xs:positiveInteger|The maxLength attribute specifies the maximum length of the value in characters.
1148 |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.
1149 |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.
1150 |pattern|xs:string|The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema.
1151
1152 **NonFacetedTextFormatType: **NonFacetedTextFormatType is a restricted version of the SimpleComponentTextFormatType that does not allow for any facets.
1153
1154 Derivation:
1155
1156 TextFormatType (restriction)
1157 [[image:inherit.gif||height="9" width="9"]] BasicComponentTextFormatType (restriction)
1158 [[image:inherit.gif||height="9" width="9"]] SimpleComponentTextFormatType (restriction)
1159 [[image:inherit.gif||height="9" width="9"]] NonFacetedTextFormatType
1160
1161 Attributes:
1162
1163 textType?
1164
1165 Content:
1166
1167 {Empty}
1168
1169 Attribute Documentation:
1170
1171 |**Name**|**Type**|**Documentation**
1172 |textType|com: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.
1173
1174 **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.
1175
1176 Derivation:
1177
1178 TextFormatType (restriction)
1179 [[image:inherit.gif||height="9" width="9"]] BasicComponentTextFormatType (restriction)
1180 [[image:inherit.gif||height="9" width="9"]] SimpleComponentTextFormatType (restriction)
1181 [[image:inherit.gif||height="9" width="9"]] TimeTextFormatType
1182
1183 Attributes:
1184
1185 textType?, startTime?, endTime?
1186
1187 Content:
1188
1189 {Empty}
1190
1191 Attribute Documentation:
1192
1193 |**Name**|**Type**|**Documentation**
1194 |textType (default: ObservationalTimePeriod)|com: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.
1195 |startTime|com: StandardTimePeriodTy pe|The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.
1196 |endTime|com: StandardTimePeriodTy pe|The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence.
1197
1198 **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.
1199
1200 Derivation:
1201
1202 //com:AnnotableType// (extension)
1203 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
1204 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
1205 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
1206 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
1207 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
1208 [[image:inherit.gif||height="9" width="9"]] CategorisationType
1209
1210 Attributes:
1211
1212 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
1213
1214 Content:
1215
1216 com:Annotations?, com:Name+, com:Description*, (Source, Target)?
1217
1218 Attribute Documentation:
1219
1220 |**Name**|**Type**|**Documentation**
1221 |id|com:IDType|The id is the identifier for the object.
1222 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1223 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1224 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
1225 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1226 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1227 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1228 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
1229 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1230 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1231 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1232
1233 Element Documentation:
1234
1235 |**Name**|**Type**|**Documentation**
1236 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1237 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1238 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1239 |Source|com: ObjectReferenceType|Source is a reference to an object to be categorized.
1240 |Target|com: CategoryReferenceTyp e|Target is reference to the category that the referenced object is to be mapped to.
1241
1242 **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.
1243
1244 Derivation:
1245
1246 //com:AnnotableType// (extension)
1247 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
1248 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
1249 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
1250 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
1251 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
1252 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)
1253 [[image:inherit.gif||height="9" width="9"]] CategorySchemeType
1254
1255 Attributes:
1256
1257 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
1258
1259 Content:
1260
1261 com:Annotations?, com:Name+, com:Description*, Category*
1262
1263 Attribute Documentation:
1264
1265 |**Name**|**Type**|**Documentation**
1266 |id|com: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).
1267 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1268 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1269 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
1270 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1271 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1272 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1273 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
1274 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1275 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1276 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1277 |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 key family in the context of a constraint.
1278
1279 Element Documentation:
1280
1281 |**Name**|**Type**|**Documentation**
1282 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1283 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1284 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1285 |Category|CategoryType|Category represents a set of nested categories which describe a simple classification hierarchy.
1286
1287 **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.
1288
1289 Derivation:
1290
1291 //com:AnnotableType// (extension)
1292 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
1293 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
1294 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
1295 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
1296 [[image:inherit.gif||height="9" width="9"]] CategoryType
1297
1298 Attributes:
1299
1300 id, urn?, uri?
1301
1302 Content:
1303
1304 com:Annotations?, com:Name+, com:Description*, Category*
1305
1306 Attribute Documentation:
1307
1308 |**Name**|**Type**|**Documentation**
1309 |id|com:IDType|The id is the identifier for the object.
1310 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1311 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1312
1313 Element Documentation:
1314
1315 |**Name**|**Type**|**Documentation**
1316 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1317 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1318 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1319 |Category|CategoryType|Category represents a set of nested categories which describe a simple classification hierarchy.
1320
1321 **CodelistType: **CodelistType defines the structure of a codelist. A codelist is defined as a list from which some statistical concepts (coded concepts) take their values.
1322
1323 Derivation:
1324
1325 //com:AnnotableType// (extension)
1326 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
1327 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
1328 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
1329 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
1330 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
1331 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)
1332 [[image:inherit.gif||height="9" width="9"]] CodelistType
1333
1334 Attributes:
1335
1336 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
1337
1338 Content:
1339
1340 com:Annotations?, com:Name+, com:Description*, Code*
1341
1342 Attribute Documentation:
1343
1344 |**Name**|**Type**|**Documentation**
1345 |id|com: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).
1346 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1347 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1348 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
1349 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1350 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1351 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1352 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
1353 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1354 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1355 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1356 |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 key family in the context of a constraint.
1357
1358 Element Documentation:
1359
1360 |**Name**|**Type**|**Documentation**
1361 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1362 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1363 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1364 |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.
1365
1366 **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.
1367
1368 Derivation:
1369
1370 //com:AnnotableType// (extension)
1371 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
1372 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
1373 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
1374 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
1375 [[image:inherit.gif||height="9" width="9"]] CodeType
1376
1377 Attributes:
1378
1379 id, urn?, uri?
1380
1381 Content:
1382
1383 com:Annotations?, com:Name+, com:Description*, Parent?
1384
1385 Attribute Documentation:
1386
1387 |**Name**|**Type**|**Documentation**
1388 |id|com:IDType|The id is the identifier for the object.
1389 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1390 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1391
1392 Element Documentation:
1393
1394 |**Name**|**Type**|**Documentation**
1395 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1396 |com:Name|com: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.
1397 |com:Description|com:TextType|Description provides a plain text, human-readable description of the code. This may be provided in multiple, parallel language-equivalent forms.
1398 |Parent|com: LocalCodeReferenceTy pe|Parent provides the ability to describe simple hierarchies within a single codelist, by referencing the id value of another code in the same codelist.
1399
1400 **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.
1401
1402 Derivation:
1403
1404 //com:AnnotableType// (extension)
1405 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
1406 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
1407 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
1408 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
1409 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
1410 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)
1411 [[image:inherit.gif||height="9" width="9"]] ConceptSchemeType
1412
1413 Attributes:
1414
1415 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
1416
1417 Content:
1418
1419 com:Annotations?, com:Name+, com:Description*, Concept*
1420
1421 Attribute Documentation:
1422
1423 |**Name**|**Type**|**Documentation**
1424 |id|com: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).
1425 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1426 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1427 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
1428 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1429 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1430 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1431 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
1432 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1433 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1434 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1435 |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 key family in the context of a constraint.
1436
1437 Element Documentation:
1438
1439 |**Name**|**Type**|**Documentation**
1440 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1441 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1442 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1443 |Concept|ConceptType|Concept describes the details of a concept within a concept scheme.
1444
1445 //**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.
1446
1447 Derivation:
1448
1449 //com:AnnotableType// (extension)
1450 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
1451 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
1452 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
1453 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
1454 [[image:inherit.gif||height="9" width="9"]] //ConceptBaseType//
1455
1456 Attributes:
1457
1458 id, urn?, uri?
1459
1460 Content:
1461
1462 com:Annotations?, com:Name+, com:Description*, Parent?
1463
1464 Attribute Documentation:
1465
1466 |**Name**|**Type**|**Documentation**
1467 |id|com: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).
1468 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1469 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1470
1471 Element Documentation:
1472
1473 |**Name**|**Type**|**Documentation**
1474 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1475 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1476 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1477 |Parent|com: LocalConceptReferenc eType|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.
1478
1479 **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).
1480
1481 Derivation:
1482
1483 //com:AnnotableType// (extension)
1484 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
1485 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
1486 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
1487 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
1488 [[image:inherit.gif||height="9" width="9"]] //ConceptBaseType// (extension)
1489 [[image:inherit.gif||height="9" width="9"]] ConceptType
1490
1491 Attributes:
1492
1493 id, urn?, uri?
1494
1495 Content:
1496
1497 com:Annotations?, com:Name+, com:Description*, Parent?, CoreRepresentation?, ISOConceptReference?
1498
1499 Attribute Documentation:
1500
1501 |**Name**|**Type**|**Documentation**
1502 |id|com: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).
1503 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1504 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1505
1506 Element Documentation:
1507
1508 |**Name**|**Type**|**Documentation**
1509 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1510 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1511 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1512 |Parent|com: LocalConceptReferenc eType|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.
1513 |CoreRepresentation|ConceptRepresentatio n|
1514 |ISOConceptReference|ISOConceptReferenceT ype|Provides a reference to an ISO 11179 concept.
1515
1516 **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.
1517
1518 Derivation:
1519
1520 //RepresentationType// (restriction)
1521 [[image:inherit.gif||height="9" width="9"]] ConceptRepresentation
1522
1523 Content:
1524
1525 (TextFormat | (Enumeration, EnumerationFormat?))
1526
1527 Element Documentation:
1528
1529 |**Name**|**Type**|**Documentation**
1530 |TextFormat|BasicComponentTextFo rmatType|TextFormat describes an uncoded textual format.
1531 |Enumeration|com: CodelistReferenceTyp e|Enumeration references a codelist which enumerates the possible values that can be used as the representation of this concept.
1532 |EnumerationFormat|CodededTextFormatTyp e|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.
1533
1534 **ISOConceptReferenceType: **ISOConceptReferenceType provides a reference to and ISO 11179 concept.
1535
1536 Content:
1537
1538 ConceptAgency, ConceptSchemeID, ConceptID
1539
1540 Element Documentation:
1541
1542 |**Name**|**Type**|**Documentation**
1543 |ConceptAgency|xs:string|
1544 |ConceptSchemeID|xs:string|
1545 |ConceptID|xs:string|
1546
1547 //**ConstraintBaseType**//**: **ConstraintBaseType is an abstract base type that forms the basis of the main abstract ConstraintType. It requires that a name be provided.
1548
1549 Derivation:
1550
1551 //com:AnnotableType// (extension)
1552 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
1553 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
1554 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
1555 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
1556 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)
1557 [[image:inherit.gif||height="9" width="9"]] //ConstraintBaseType//
1558
1559 Attributes:
1560
1561 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
1562
1563 Content:
1564
1565 com:Annotations?, com:Name+, com:Description*
1566
1567 Attribute Documentation:
1568
1569 |**Name**|**Type**|**Documentation**
1570 |id|com:IDType|The id is the identifier for the object.
1571 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1572 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1573 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
1574 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1575 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1576 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1577 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
1578 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1579 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1580 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1581
1582 Element Documentation:
1583
1584 |**Name**|**Type**|**Documentation**
1585 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1586 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1587 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1588
1589 //**ConstraintType**//**: **ConstraintType is an abstract base type that specific types of constraints (content and attachment) restrict and extend to describe their details. The inclusion of a key or region in a constraint is determined by first processing the included key sets, and then removing those keys defined in the excluded key sets. If no included key sets are defined, then it is assumed the all possible keys or regions are included, and any excluded key or regions are removed from this complete set.
1590
1591 Derivation:
1592
1593 //com:AnnotableType// (extension)
1594 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
1595 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
1596 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
1597 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
1598 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)
1599 [[image:inherit.gif||height="9" width="9"]] //ConstraintBaseType// (extension)
1600 [[image:inherit.gif||height="9" width="9"]] //ConstraintType//
1601
1602 Attributes:
1603
1604 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
1605
1606 Content:
1607
1608 com:Annotations?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*
1609
1610 Attribute Documentation:
1611
1612 |**Name**|**Type**|**Documentation**
1613 |id|com:IDType|The id is the identifier for the object.
1614 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1615 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1616 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
1617 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1618 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1619 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1620 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
1621 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1622 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1623 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1624
1625 Element Documentation:
1626
1627 |**Name**|**Type**|**Documentation**
1628 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1629 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1630 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1631 |ConstraintAttachment|//ConstraintAttachment Type//|ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to.
1632 |DataKeySet|DataKeySetType|
1633 |MetadataKeySet|MetadataKeySetType|
1634 |CubeRegion|com:CubeRegionType|
1635 |MetadataTargetRegion|com: MetadataTargetRegion Type|
1636
1637 **AttachmentConstraintType: **AttachmentConstraintType describes the details of an attachment constraint by defining the data or metadata key sets or component regions that attributes or reference metadata may be attached in the constraint attachment objects.
1638
1639 Derivation:
1640
1641 //com:AnnotableType// (extension)
1642 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
1643 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
1644 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
1645 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
1646 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)
1647 [[image:inherit.gif||height="9" width="9"]] //ConstraintBaseType// (extension)
1648 [[image:inherit.gif||height="9" width="9"]] //ConstraintType// (restriction)
1649 [[image:inherit.gif||height="9" width="9"]] AttachmentConstraintType
1650
1651 Attributes:
1652
1653 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
1654
1655 Content:
1656
1657 com:Annotations?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet)*
1658
1659 Attribute Documentation:
1660
1661 |**Name**|**Type**|**Documentation**
1662 |id|com:IDType|The id is the identifier for the object.
1663 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1664 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1665 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
1666 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1667 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1668 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1669 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
1670 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1671 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1672 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1673
1674 Element Documentation:
1675
1676 |**Name**|**Type**|**Documentation**
1677 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1678 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1679 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1680 |ConstraintAttachment|AttachmentConstraint AttachmentType|ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to.
1681 |DataKeySet|DataKeySetType|
1682 |MetadataKeySet|MetadataKeySetType|
1683
1684 //**ContentConstraintBaseType**//**: **ContentConstraintBaseType is an abstract base type that forms the basis for the ContentConstraintType.
1685
1686 Derivation:
1687
1688 //com:AnnotableType// (extension)
1689 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
1690 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
1691 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
1692 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
1693 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)
1694 [[image:inherit.gif||height="9" width="9"]] //ConstraintBaseType// (extension)
1695 [[image:inherit.gif||height="9" width="9"]] //ConstraintType// (restriction)
1696 [[image:inherit.gif||height="9" width="9"]] //ContentConstraintBaseType//
1697
1698 Attributes:
1699
1700 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
1701
1702 Content:
1703
1704 com:Annotations?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*
1705
1706 Attribute Documentation:
1707
1708 |**Name**|**Type**|**Documentation**
1709 |id|com:IDType|The id is the identifier for the object.
1710 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1711 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1712 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
1713 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1714 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1715 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1716 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
1717 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1718 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1719 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1720
1721 Element Documentation:
1722
1723 |**Name**|**Type**|**Documentation**
1724 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1725 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1726 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1727 |ConstraintAttachment|ContentConstraintAtt achmentType|ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to.
1728 |DataKeySet|DataKeySetType|DataKeySet defines a collection of full or partial data keys.
1729 |MetadataKeySet|MetadataKeySetType|MetadataKeySet defines a collection of metadata keys.
1730 |CubeRegion|com:CubeRegionType|CubeRegion describes a set of dimension values which define a region and attributes which relate to the region for the purpose of describing a constraint.
1731 |MetadataTargetRegion|com: MetadataTargetRegion Type|MetadataTargetRegion describes a set of target object values for a given report structure which define a region, and the metadata attribute which relate to the target for the purpose of describing a constraint.
1732
1733 **ContentConstraintType: **ContentConstraintType describes the details of a content constraint by defining the content regions, key sets, or release information for the constraint attachment objects. Note that if the constraint is for a data provider, then only release calendar information is relevant, as there is no reliable way of determining which key family is being used to frame constraints in terms of cube regions or key sets.
1734
1735 Derivation:
1736
1737 //com:AnnotableType// (extension)
1738 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
1739 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
1740 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
1741 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
1742 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)
1743 [[image:inherit.gif||height="9" width="9"]] //ConstraintBaseType// (extension)
1744 [[image:inherit.gif||height="9" width="9"]] //ConstraintType// (restriction)
1745 [[image:inherit.gif||height="9" width="9"]] //ContentConstraintBaseType// (extension)
1746 [[image:inherit.gif||height="9" width="9"]] ContentConstraintType
1747
1748 Attributes:
1749
1750 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, type?
1751
1752 Content:
1753
1754 com:Annotations?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*, ReleaseCalendar?, ReferencePeriod?
1755
1756 Attribute Documentation:
1757
1758 |**Name**|**Type**|**Documentation**
1759 |id|com:IDType|The id is the identifier for the object.
1760 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1761 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1762 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
1763 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1764 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1765 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1766 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
1767 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1768 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1769 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1770 |type (default: Actual)|com: ContentConstraintTyp eCodeType|The type attribute indicates whether this constraint states what data is actually present for the constraint attachment, or if it defines what content is allowed. The default value is "Actual", meaning the data actually present for the constraint attachment.
1771
1772 Element Documentation:
1773
1774 |**Name**|**Type**|**Documentation**
1775 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1776 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1777 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1778 |ConstraintAttachment|ContentConstraintAtt achmentType|ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to.
1779 |DataKeySet|DataKeySetType|DataKeySet defines a collection of full or partial data keys.
1780 |MetadataKeySet|MetadataKeySetType|MetadataKeySet defines a collection of metadata keys.
1781 |CubeRegion|com:CubeRegionType|CubeRegion describes a set of dimension values which define a region and attributes which relate to the region for the purpose of describing a constraint.
1782 |MetadataTargetRegion|com: MetadataTargetRegion Type|MetadataTargetRegion describes a set of target object values for a given report structure which define a region, and the metadata attribute which relate to the target for the purpose of describing a constraint.
1783 |ReleaseCalendar|ReleaseCalendarType|ReleaseCalendar defines dates on which the constrained data is to be made available.
1784 |ReferencePeriod|com: ReferencePeriodType|ReferencePeriod is used to report start date and end date constraints.
1785
1786 **ReleaseCalendarType: **ReleaseCalendarType describes information about the timing of releases of the constrained data. All of these values use the standard "P7D" - style format.
1787
1788 Content:
1789
1790 Periodicity, Offset, Tolerance
1791
1792 Element Documentation:
1793
1794 |**Name**|**Type**|**Documentation**
1795 |Periodicity|xs:string|Periodicity is the period between releases of the data set.
1796 |Offset|xs:string|Offset is the interval between January first and the first release of data within the year.
1797 |Tolerance|xs:string|Tolerance is the period after which the release of data may be deemed late.
1798
1799 //**KeySetType**//**: **KeySetType is an abstract base type for defining a collection of keys.
1800
1801 Attributes:
1802
1803 isIncluded
1804
1805 Content:
1806
1807 Key+
1808
1809 Attribute Documentation:
1810
1811 |**Name**|**Type**|**Documentation**
1812 |isIncluded|xs:boolean|The isIncluded attribute indicates whether the keys defined in this key set are inclusive or exclusive to the constraint.
1813
1814 Element Documentation:
1815
1816 |**Name**|**Type**|**Documentation**
1817 |Key|//com:DistinctKeyType//|Key contains a data or metadata key, which are sets of component values which identify the data or metadata.
1818
1819 **DataKeySetType: **DataKeySetType defines a collection of full or partial data keys (dimension values).
1820
1821 Derivation:
1822
1823 //KeySetType// (restriction)
1824 [[image:inherit.gif||height="9" width="9"]] DataKeySetType
1825
1826 Attributes:
1827
1828 isIncluded
1829
1830 Content:
1831
1832 Key+
1833
1834 Attribute Documentation:
1835
1836 |**Name**|**Type**|**Documentation**
1837 |isIncluded|xs:boolean|The isIncluded attribute indicates whether the keys defined in this key set are inclusive or exclusive to the constraint.
1838
1839 Element Documentation:
1840
1841 |**Name**|**Type**|**Documentation**
1842 |Key|com:DataKeyType|Key contains a set of dimension values which identify a full set of data.
1843
1844 **MetadataKeySetType: **MetadataKeySetType defines a collection of metadata keys (identifier component values).
1845
1846 Derivation:
1847
1848 //KeySetType// (restriction)
1849 [[image:inherit.gif||height="9" width="9"]] MetadataKeySetType
1850
1851 Attributes:
1852
1853 isIncluded
1854
1855 Content:
1856
1857 Key+
1858
1859 Attribute Documentation:
1860
1861 |**Name**|**Type**|**Documentation**
1862 |isIncluded|xs:boolean|The isIncluded attribute indicates whether the keys defined in this key set are inclusive or exclusive to the constraint.
1863
1864 Element Documentation:
1865
1866 |**Name**|**Type**|**Documentation**
1867 |Key|com:MetadataKeyType|Key contains a set of target object values for a specified report structure which serve to identify which object reference metadata conforming to the specified report structure is available for.
1868
1869 //**ConstraintAttachmentType**//**: **ConstraintAttachmentType describes a collection of references to constrainable artefacts.
1870
1871 Content:
1872
1873 (DataProvider | DataSet+ | MetadataSet+ | SimpleDataSource+ | (DataStructure+, QueryableDataSource*) | (MetadataStructure+, QueryableDataSource*) | (Dataflow+, QueryableDataSource*) | (Metadataflow+, QueryableDataSource*) | (ProvisionAgreement+, QueryableDataSource*))
1874
1875 Element Documentation:
1876
1877 |**Name**|**Type**|**Documentation**
1878 |DataProvider|com: 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.
1879 |DataSet|com:SetReferenceType|DataSet is reference to a data set to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields.
1880 |MetadataSet|com:SetReferenceType|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.
1881 |SimpleDataSource|xs:anyURI|SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message.
1882 |DataStructure|com: DataStructureReferen ceType|DataStructure is reference to a data structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached.
1883 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1884 |MetadataStructure|com: MetadataStructureRef erenceType|MetadataStructure is reference to a metadata structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached.
1885 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1886 |Dataflow|com: DataflowReferenceTyp e|Dataflow is reference to a data flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one dataflow, and the dataflows do not necessarily have to be usages of the same data structure. However, a constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached.
1887 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1888 |Metadataflow|com: MetadataflowReferenc eType|Metadataflow is reference to a metadata flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one metadataflow, and the metadataflows do not necessarily have to be usages of the same metadata structure. However, a constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached.
1889 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1890 |ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreementReference is reference to a provision agreement to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one provision aggreement, and the provision agreements do not necessarily have to be references structure usages based on the same structure. However, a constraint which is attached to more than one provision agreement must only express key sets and/or cube/target regions where the identifier of the components are common across all structures to which the constraint is attached.
1891 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1892
1893 **AttachmentConstraintAttachmentType: **AttachmentConstraintAttachmentType defines the structure for specifying the object to which an attachment constraints applies.
1894
1895 Derivation:
1896
1897 //ConstraintAttachmentType// (restriction)
1898 [[image:inherit.gif||height="9" width="9"]] AttachmentConstraintAttachmentType
1899
1900 Content:
1901
1902 (DataSet+ | MetadataSet+ | SimpleDataSource+ | DataStructure+ | MetadataStructure+ | Dataflow+ | Metadataflow+ | ProvisionAgreement+)
1903
1904 Element Documentation:
1905
1906 |**Name**|**Type**|**Documentation**
1907 |DataSet|com:SetReferenceType|DataSet is reference to a data set to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. Multiple instance can only be used if they have the same underlying structure.
1908 |MetadataSet|com:SetReferenceType|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. Multiple instance can only be used if they have the same underlying structure.
1909 |SimpleDataSource|xs:anyURI|SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message. Multiple instance can only be used if they have the same underlying structure.
1910 |DataStructure|com: DataStructureReferen ceType|DataStructure is reference to a data structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached.
1911 |MetadataStructure|com: MetadataStructureRef erenceType|MetadataStructure is reference to a metadata structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached.
1912 |Dataflow|com: DataflowReferenceTyp e|Dataflow is reference to a data flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one dataflow, and the dataflows do not necessarily have to be usages of the same data structure. However, a constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached.
1913 |Metadataflow|com: MetadataflowReferenc eType|Metadataflow is reference to a metadata flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one metadataflow, and the metadataflows do not necessarily have to be usages of the same metadata structure. However, a constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached.
1914 |ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreementReference is reference to a provision agreement to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one provision aggreement, and the provision agreements do not necessarily have to be references structure usages based on the same structure. However, a constraint which is attached to more than one provision agreement must only express key sets and/or cube/target regions where the identifier of the components are common across all structures to which the constraint is attached.
1915
1916 **ContentConstraintAttachmentType: **ContentConstraintAttachmentType defines the structure for specifying the target object(s) of a content constraint.
1917
1918 Derivation:
1919
1920 //ConstraintAttachmentType// (restriction)
1921 [[image:inherit.gif||height="9" width="9"]] ContentConstraintAttachmentType
1922
1923 Content:
1924
1925 (DataProvider | DataSet | MetadataSet | SimpleDataSource | (DataStructure+, QueryableDataSource*) | (MetadataStructure+, QueryableDataSource*) | (Dataflow+, QueryableDataSource*) | (Metadataflow+, QueryableDataSource*) | (ProvisionAgreement+, QueryableDataSource*))
1926
1927 Element Documentation:
1928
1929 |**Name**|**Type**|**Documentation**
1930 |DataProvider|com: 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.
1931 |DataSet|com:SetReferenceType|DataSet is reference to a data set to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields.
1932 |MetadataSet|com:SetReferenceType|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.
1933 |SimpleDataSource|xs:anyURI|SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message.
1934 |DataStructure|com: DataStructureReferen ceType|DataStructure is reference to a data structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached.
1935 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1936 |MetadataStructure|com: MetadataStructureRef erenceType|MetadataStructure is reference to a metadata structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached.
1937 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1938 |Dataflow|com: DataflowReferenceTyp e|Dataflow is reference to a data flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one dataflow, and the dataflows do not necessarily have to be usages of the same data structure. However, a constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached.
1939 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1940 |Metadataflow|com: MetadataflowReferenc eType|Metadataflow is reference to a metadata flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one metadataflow, and the metadataflows do not necessarily have to be usages of the same metadata structure. However, a constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached.
1941 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1942 |ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreementReference is reference to a provision agreement to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one provision aggreement, and the provision agreements do not necessarily have to be references structure usages based on the same structure. However, a constraint which is attached to more than one provision agreement must only express key sets and/or cube/target regions where the identifier of the components are common across all structures to which the constraint is attached.
1943 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1944
1945 **DataStructureType: **DataStructureType describes the structure of 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.
1946
1947 Derivation:
1948
1949 //com:AnnotableType// (extension)
1950 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
1951 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
1952 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
1953 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
1954 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
1955 [[image:inherit.gif||height="9" width="9"]] //StructureType// (restriction)
1956 [[image:inherit.gif||height="9" width="9"]] DataStructureType
1957
1958 Attributes:
1959
1960 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
1961
1962 Content:
1963
1964 com:Annotations?, com:Name+, com:Description*, DataStructureComponents?
1965
1966 Attribute Documentation:
1967
1968 |**Name**|**Type**|**Documentation**
1969 |id|com:IDType|The id is the identifier for the object.
1970 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1971 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1972 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
1973 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1974 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1975 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1976 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
1977 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1978 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1979 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1980
1981 Element Documentation:
1982
1983 |**Name**|**Type**|**Documentation**
1984 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
1985 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1986 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
1987 |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 three reserved identifiers in a data structure definition; OBS_VALUE, TIME_PERIOD, and REPORTING_PERIOD_START_DAY. These identifiers may not be used outside of their respective defintions (PrimaryMeasure, 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.
1988
1989 //**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.
1990
1991 Derivation:
1992
1993 //GroupingType// (restriction)
1994 [[image:inherit.gif||height="9" width="9"]] //DataStructureComponentsBaseType//
1995
1996 Content:
1997
1998 {Empty}
1999
2000 **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 and a primary measure must be defined.
2001
2002 Derivation:
2003
2004 //GroupingType// (restriction)
2005 [[image:inherit.gif||height="9" width="9"]] //DataStructureComponentsBaseType// (extension)
2006 [[image:inherit.gif||height="9" width="9"]] DataStructureComponentsType
2007
2008 Content:
2009
2010 DimensionList, Group*, AttributeList?, MeasureList
2011
2012 Element Documentation:
2013
2014 |**Name**|**Type**|**Documentation**
2015 |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.
2016 |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.
2017 |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.
2018 |MeasureList|MeasureListType|MeasureList describes the measure descriptor for a key family. It contains a single metadata concepts that define the primary measures of a data structure.
2019
2020 //**AttributeListBaseType**//**: **AttributeListBaseType is an abstract base type used as the basis for the AttributeListType.
2021
2022 Derivation:
2023
2024 //com:AnnotableType// (extension)
2025 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
2026 [[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)
2027 [[image:inherit.gif||height="9" width="9"]] //AttributeListBaseType//
2028
2029 Attributes:
2030
2031 id?, urn?, uri?
2032
2033 Content:
2034
2035 com:Annotations?
2036
2037 Attribute Documentation:
2038
2039 |**Name**|**Type**|**Documentation**
2040 |id (fixed: AttributeDescriptor)|com:IDType|The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor.
2041 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2042 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2043
2044 Element Documentation:
2045
2046 |**Name**|**Type**|**Documentation**
2047 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2048
2049 **AttributeListType: **AttributeListType describes the attribute descriptor for the data structure definition.
2050
2051 Derivation:
2052
2053 //com:AnnotableType// (extension)
2054 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
2055 [[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)
2056 [[image:inherit.gif||height="9" width="9"]] //AttributeListBaseType// (extension)
2057 [[image:inherit.gif||height="9" width="9"]] AttributeListType
2058
2059 Attributes:
2060
2061 id?, urn?, uri?
2062
2063 Content:
2064
2065 com:Annotations?, (Attribute | ReportingYearStartDay)+
2066
2067 Attribute Documentation:
2068
2069 |**Name**|**Type**|**Documentation**
2070 |id (fixed: AttributeDescriptor)|com:IDType|The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor.
2071 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2072 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2073
2074 Element Documentation:
2075
2076 |**Name**|**Type**|**Documentation**
2077 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2078 |Attribute|AttributeType|Attribute describes the definition of a data attribute, which is defined as a characteristic of an object or entity.
2079 |ReportingYearStartDa y|ReportingYearStartDa yType|ReportingYearStartDay is a specialized data attribute which provides important context to the time dimension. If the value of the time dimension is one of the standard reporting periods (see common:ReportingTimePeriodType) then this attribute is used to state the month and day that the reporting year begins. This provides a reference point from which the actual calendar dates covered by these periods can be determined. If this attribute does not occur in a data set, then the reporting year start day will be assumed to be January 1.
2080
2081 //**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.
2082
2083 Derivation:
2084
2085 //com:AnnotableType// (extension)
2086 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
2087 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
2088 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)
2089 [[image:inherit.gif||height="9" width="9"]] //AttributeBaseType//
2090
2091 Attributes:
2092
2093 id?, urn?, uri?
2094
2095 Content:
2096
2097 com:Annotations?, ConceptIdentity, LocalRepresentation?
2098
2099 Attribute Documentation:
2100
2101 |**Name**|**Type**|**Documentation**
2102 |id|com: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).
2103 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2104 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2105
2106 Element Documentation:
2107
2108 |**Name**|**Type**|**Documentation**
2109 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2110 |ConceptIdentity|com: 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.
2111 |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.
2112
2113 **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.
2114
2115 Derivation:
2116
2117 //com:AnnotableType// (extension)
2118 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
2119 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
2120 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)
2121 [[image:inherit.gif||height="9" width="9"]] //AttributeBaseType// (extension)
2122 [[image:inherit.gif||height="9" width="9"]] AttributeType
2123
2124 Attributes:
2125
2126 id?, urn?, uri?, assignmentStatus
2127
2128 Content:
2129
2130 com:Annotations?, ConceptIdentity, LocalRepresentation?, ConceptRole*, AttributeRelationship
2131
2132 Attribute Documentation:
2133
2134 |**Name**|**Type**|**Documentation**
2135 |id|com: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).
2136 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2137 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2138 |assignmentStatus|UsageStatusType|The assignmentStatus attribute indicates whether a value must be provided for the attribute when sending documentation along with the data.
2139
2140 Element Documentation:
2141
2142 |**Name**|**Type**|**Documentation**
2143 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2144 |ConceptIdentity|com: 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.
2145 |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.
2146 |ConceptRole|com: ConceptReferenceType|ConceptRole references concepts which define roles which this attribute serves. If the concept from which the attribute takes its identity also defines a role the concept serves, then the isConceptRole indicator can be set to true on the concept identity rather than repeating the reference here.
2147 |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.
2148
2149 **AttributeRelationshipType: **AttributeRelationshipType defines the structure for stating the relationship between an attribute and other data structure definition components.
2150
2151 Content:
2152
2153 (None | (Dimension+, AttachmentGroup*) | Group | PrimaryMeasure)
2154
2155 Element Documentation:
2156
2157 |**Name**|**Type**|**Documentation**
2158 |None|com:EmptyType|This means that value of the attribute will not vary with any of the other key family components. This will always be treated as a data set level attribute.
2159 |Dimension|com: LocalDimensionRefere nceType|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.
2160 |AttachmentGroup|com: LocalGroupKeyDescrip torReferenceType|This is used to specify that the attribute should always be attached to the groups referenced here. Note that if one of the referenced dimensions is the time dimension, the groups referenced here will be ignored.
2161 |Group|com: LocalGroupKeyDescrip torReferenceType|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.
2162 |PrimaryMeasure|com: LocalPrimaryMeasureR eferenceType|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.
2163
2164 **ReportingYearStartDayType: **ReportingYearStartDayType defines the structure of the reporting year start day attribute. The reporting year start day attribute takes its semantic from its concept identity (usually the REPORTING_YEAR_START_DAY concept), yet is always has a fixed identifier (REPORTING_YEAR_START_DAY). The reporting year start day attribute always has a fixed text format, which specifies that the format of its value is always a day and month in the ISO 8601 format of '~-~-MM-DD'. As with any other attribute, an attribute relationship must be specified. this relationship should be carefully selected as it will determin what type of data the data structure definition will allow. For example, if an attribute relationship of none is specified, this will mean the data sets conforming to this data structure definition can only contain data with standard reporting periods where the all reporting periods have the same start day. In this case, data reported as standard reporting periods from two entities with different fiscal year start days could not be contained in the same data set.
2165
2166 Derivation:
2167
2168 //com:AnnotableType// (extension)
2169 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
2170 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
2171 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)
2172 [[image:inherit.gif||height="9" width="9"]] //AttributeBaseType// (extension)
2173 [[image:inherit.gif||height="9" width="9"]] AttributeType (restriction)
2174 [[image:inherit.gif||height="9" width="9"]] ReportingYearStartDayType
2175
2176 Attributes:
2177
2178 id?, urn?, uri?, assignmentStatus
2179
2180 Content:
2181
2182 com:Annotations?, ConceptIdentity, LocalRepresentation, AttributeRelationship
2183
2184 Attribute Documentation:
2185
2186 |**Name**|**Type**|**Documentation**
2187 |id (fixed: REPORTING_YEAR_START_DAY)|com: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).
2188 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2189 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2190 |assignmentStatus|UsageStatusType|The assignmentStatus attribute indicates whether a value must be provided for the attribute when sending documentation along with the data.
2191
2192 Element Documentation:
2193
2194 |**Name**|**Type**|**Documentation**
2195 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2196 |ConceptIdentity|com: 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.
2197 |LocalRepresentation|ReportingYearStartDa yRepresentationType|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.
2198 |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.
2199
2200 **ReportingYearStartDayRepresentationType: **ReportingYearStartDayRepresentationType defines the representation for the reporting year start day attribute. Enumerated values are not allowed and the text format is fixed to be a day and month in the ISO 8601 format of '~-~-MM-DD'.
2201
2202 Derivation:
2203
2204 //RepresentationType// (restriction)
2205 [[image:inherit.gif||height="9" width="9"]] //DataStructureRepresentationType// (restriction)
2206 [[image:inherit.gif||height="9" width="9"]] SimpleDataStructureRepresentationType (restriction)
2207 [[image:inherit.gif||height="9" width="9"]] ReportingYearStartDayRepresentationType
2208
2209 Content:
2210
2211 TextFormat
2212
2213 Element Documentation:
2214
2215 |**Name**|**Type**|**Documentation**
2216 |TextFormat|ReportingYearStartDa yTextFormatType|TextFormat describes an uncoded textual format.
2217
2218 **ReportingYearStartDayTextFormatType: **ReportingYearStartDayTextFormatType is a restricted version of the NonFacetedTextFormatType that fixes the value of the text type to be DayMonth. This type exists solely for the purpose of fixing the representation of the reporting year start day attribute.
2219
2220 Derivation:
2221
2222 TextFormatType (restriction)
2223 [[image:inherit.gif||height="9" width="9"]] BasicComponentTextFormatType (restriction)
2224 [[image:inherit.gif||height="9" width="9"]] SimpleComponentTextFormatType (restriction)
2225 [[image:inherit.gif||height="9" width="9"]] NonFacetedTextFormatType (restriction)
2226 [[image:inherit.gif||height="9" width="9"]] ReportingYearStartDayTextFormatType
2227
2228 Attributes:
2229
2230 textType?
2231
2232 Content:
2233
2234 {Empty}
2235
2236 Attribute Documentation:
2237
2238 |**Name**|**Type**|**Documentation**
2239 |textType (fixed: MonthDay)|com: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.
2240
2241 //**DimensionListBaseType**//**: **DimensionListBaseType is an abstract base type used as the basis for the DimensionListType.
2242
2243 Derivation:
2244
2245 //com:AnnotableType// (extension)
2246 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
2247 [[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)
2248 [[image:inherit.gif||height="9" width="9"]] //DimensionListBaseType//
2249
2250 Attributes:
2251
2252 id?, urn?, uri?
2253
2254 Content:
2255
2256 com:Annotations?
2257
2258 Attribute Documentation:
2259
2260 |**Name**|**Type**|**Documentation**
2261 |id (fixed: DimensionDescriptor)|com:IDType|The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor.
2262 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2263 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2264
2265 Element Documentation:
2266
2267 |**Name**|**Type**|**Documentation**
2268 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2269
2270 **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.
2271
2272 Derivation:
2273
2274 //com:AnnotableType// (extension)
2275 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
2276 [[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)
2277 [[image:inherit.gif||height="9" width="9"]] //DimensionListBaseType// (extension)
2278 [[image:inherit.gif||height="9" width="9"]] DimensionListType
2279
2280 Attributes:
2281
2282 id?, urn?, uri?
2283
2284 Content:
2285
2286 com:Annotations?, (Dimension | MeasureDimension | TimeDimension)+
2287
2288 Attribute Documentation:
2289
2290 |**Name**|**Type**|**Documentation**
2291 |id (fixed: DimensionDescriptor)|com:IDType|The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor.
2292 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2293 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2294
2295 Element Documentation:
2296
2297 |**Name**|**Type**|**Documentation**
2298 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2299 |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.
2300 |MeasureDimension|MeasureDimensionType|MeasureDimension is a special type of dimension which defines multiple measures in a key family. This is represented as any other dimension in a unless it is the observation dimension. It takes it representation from a concept scheme, and this scheme defines the measures and their representations. When data is formatted with this as the observation dimension, these measures can be made explicit or the value of the dimension can be treated as any other dimension. If the measures are explicit, the representation of the observation will be specific to the core representation for each concept in the representation concept scheme. Note that it is necessary that these representations are compliant (the same or derived from) with that of the primary measure.
2301 |TimeDimension|TimeDimensionType|TimeDimension is a special dimension which designates the period in time in which the data identified by the full series key applies.
2302
2303 //**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).
2304
2305 Derivation:
2306
2307 //com:AnnotableType// (extension)
2308 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
2309 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
2310 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)
2311 [[image:inherit.gif||height="9" width="9"]] //BaseDimensionBaseType//
2312
2313 Attributes:
2314
2315 id?, urn?, uri?
2316
2317 Content:
2318
2319 com:Annotations?, ConceptIdentity, LocalRepresentation?
2320
2321 Attribute Documentation:
2322
2323 |**Name**|**Type**|**Documentation**
2324 |id|com: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).
2325 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2326 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2327
2328 Element Documentation:
2329
2330 |**Name**|**Type**|**Documentation**
2331 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2332 |ConceptIdentity|com: 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.
2333 |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.
2334
2335 //**BaseDimensionType**//**: **BaseDimensionType is an abstract base type which defines the basic structure of all dimensions.
2336
2337 Derivation:
2338
2339 //com:AnnotableType// (extension)
2340 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
2341 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
2342 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)
2343 [[image:inherit.gif||height="9" width="9"]] //BaseDimensionBaseType// (extension)
2344 [[image:inherit.gif||height="9" width="9"]] //BaseDimensionType//
2345
2346 Attributes:
2347
2348 id?, urn?, uri?, position?, type?
2349
2350 Content:
2351
2352 com:Annotations?, ConceptIdentity, LocalRepresentation?, ConceptRole*
2353
2354 Attribute Documentation:
2355
2356 |**Name**|**Type**|**Documentation**
2357 |id|com: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).
2358 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2359 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2360 |position|xs:int|The position attribute specifies the position of the dimension in the data structure definition. It is optional an the position of the dimension in the key descriptor (DimensionList element) always takes precedence over the value supplied here. This is strictly for informational purposes only.
2361 |type|com: DimensionTypeType|The type attribute identifies whether then dimension is a measure dimension, the time dimension, or a regular dimension. Although these are all apparent by the element names, this attribute allows for each dimension to be processed independent of its element as well as maintaining the restriction of only one measure and time dimension while still allowing dimension to occur in any order.
2362
2363 Element Documentation:
2364
2365 |**Name**|**Type**|**Documentation**
2366 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2367 |ConceptIdentity|com: 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.
2368 |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.
2369 |ConceptRole|com: ConceptReferenceType|ConceptRole references concepts which define roles which this dimension serves. If the concept from which the attribute takes its identity also defines a role the concept serves, then the isConceptRole indicator can be set to true on the concept identity rather than repeating the reference here.
2370
2371 **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.
2372
2373 Derivation:
2374
2375 //com:AnnotableType// (extension)
2376 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
2377 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
2378 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)
2379 [[image:inherit.gif||height="9" width="9"]] //BaseDimensionBaseType// (extension)
2380 [[image:inherit.gif||height="9" width="9"]] //BaseDimensionType// (restriction)
2381 [[image:inherit.gif||height="9" width="9"]] DimensionType
2382
2383 Attributes:
2384
2385 id?, urn?, uri?, position?, type?
2386
2387 Content:
2388
2389 com:Annotations?, ConceptIdentity, LocalRepresentation?, ConceptRole*
2390
2391 Attribute Documentation:
2392
2393 |**Name**|**Type**|**Documentation**
2394 |id|com: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).
2395 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2396 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2397 |position|xs:int|The position attribute specifies the position of the dimension in the data structure definition. It is optional an the position of the dimension in the key descriptor (DimensionList element) always takes precedence over the value supplied here. This is strictly for informational purposes only.
2398 |type (fixed: Dimension)|com: DimensionTypeType|The type attribute identifies whether then dimension is a measure dimension, the time dimension, or a regular dimension. Although these are all apparent by the element names, this attribute allows for each dimension to be processed independent of its element as well as maintaining the restriction of only one measure and time dimension while still allowing dimension to occur in any order.
2399
2400 Element Documentation:
2401
2402 |**Name**|**Type**|**Documentation**
2403 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2404 |ConceptIdentity|com: 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.
2405 |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.
2406 |ConceptRole|com: ConceptReferenceType|ConceptRole references concepts which define roles which this dimension serves. If the concept from which the attribute takes its identity also defines a role the concept serves, then the isConceptRole indicator can be set to true on the concept identity rather than repeating the reference here.
2407
2408 **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.
2409
2410 Derivation:
2411
2412 //com:AnnotableType// (extension)
2413 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
2414 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
2415 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)
2416 [[image:inherit.gif||height="9" width="9"]] //BaseDimensionBaseType// (extension)
2417 [[image:inherit.gif||height="9" width="9"]] //BaseDimensionType// (restriction)
2418 [[image:inherit.gif||height="9" width="9"]] TimeDimensionType
2419
2420 Attributes:
2421
2422 id?, urn?, uri?, position?, type?
2423
2424 Content:
2425
2426 com:Annotations?, ConceptIdentity, LocalRepresentation
2427
2428 Attribute Documentation:
2429
2430 |**Name**|**Type**|**Documentation**
2431 |id (fixed: TIME_PERIOD)|com: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).
2432 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2433 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2434 |position|xs:int|The position attribute specifies the position of the dimension in the data structure definition. It is optional an the position of the dimension in the key descriptor (DimensionList element) always takes precedence over the value supplied here. This is strictly for informational purposes only.
2435 |type (fixed: TimeDimension)|com: DimensionTypeType|The type attribute identifies whether then dimension is a measure dimension, the time dimension, or a regular dimension. Although these are all apparent by the element names, this attribute allows for each dimension to be processed independent of its element as well as maintaining the restriction of only one measure and time dimension while still allowing dimension to occur in any order.
2436
2437 Element Documentation:
2438
2439 |**Name**|**Type**|**Documentation**
2440 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2441 |ConceptIdentity|com: 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.
2442 |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.
2443
2444 **MeasureDimensionType: **MeasureDimensionType defines the structure of the measure dimension. It is derived from the base dimension structure, but requires that a coded representation taken from a concept scheme is given.
2445
2446 Derivation:
2447
2448 //com:AnnotableType// (extension)
2449 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
2450 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
2451 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)
2452 [[image:inherit.gif||height="9" width="9"]] //BaseDimensionBaseType// (extension)
2453 [[image:inherit.gif||height="9" width="9"]] //BaseDimensionType// (restriction)
2454 [[image:inherit.gif||height="9" width="9"]] MeasureDimensionType
2455
2456 Attributes:
2457
2458 id?, urn?, uri?, position?, type?
2459
2460 Content:
2461
2462 com:Annotations?, ConceptIdentity, LocalRepresentation, ConceptRole*
2463
2464 Attribute Documentation:
2465
2466 |**Name**|**Type**|**Documentation**
2467 |id|com: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).
2468 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2469 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2470 |position|xs:int|The position attribute specifies the position of the dimension in the data structure definition. It is optional an the position of the dimension in the key descriptor (DimensionList element) always takes precedence over the value supplied here. This is strictly for informational purposes only.
2471 |type (fixed: MeasureDimension)|com: DimensionTypeType|The type attribute identifies whether then dimension is a measure dimension, the time dimension, or a regular dimension. Although these are all apparent by the element names, this attribute allows for each dimension to be processed independent of its element as well as maintaining the restriction of only one measure and time dimension while still allowing dimension to occur in any order.
2472
2473 Element Documentation:
2474
2475 |**Name**|**Type**|**Documentation**
2476 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2477 |ConceptIdentity|com: 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.
2478 |LocalRepresentation|MeasureDimensionRepr esentationType|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.
2479 |ConceptRole|com: ConceptReferenceType|ConceptRole references concepts which define roles which this dimension serves. If the concept from which the attribute takes its identity also defines a role the concept serves, then the isConceptRole indicator can be set to true on the concept identity rather than repeating the reference here.
2480
2481 //**GroupBaseType**//**: **GroupBaseType is an abstract base type that forms the basis for the GroupType.
2482
2483 Derivation:
2484
2485 //com:AnnotableType// (extension)
2486 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
2487 [[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)
2488 [[image:inherit.gif||height="9" width="9"]] //GroupBaseType//
2489
2490 Attributes:
2491
2492 id, urn?, uri?
2493
2494 Content:
2495
2496 com:Annotations?
2497
2498 Attribute Documentation:
2499
2500 |**Name**|**Type**|**Documentation**
2501 |id|com:IDType|The id is the identifier for the object.
2502 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2503 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2504
2505 Element Documentation:
2506
2507 |**Name**|**Type**|**Documentation**
2508 |com:Annotations|com:AnnotationsType|Annotations is a reusable 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
2510 **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.
2511
2512 Derivation:
2513
2514 //com:AnnotableType// (extension)
2515 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
2516 [[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)
2517 [[image:inherit.gif||height="9" width="9"]] //GroupBaseType// (extension)
2518 [[image:inherit.gif||height="9" width="9"]] GroupType
2519
2520 Attributes:
2521
2522 id, urn?, uri?
2523
2524 Content:
2525
2526 com:Annotations?, (GroupDimension+ | AttachmentConstraint)
2527
2528 Attribute Documentation:
2529
2530 |**Name**|**Type**|**Documentation**
2531 |id|com:IDType|The id is the identifier for the object.
2532 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2533 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2534
2535 Element Documentation:
2536
2537 |**Name**|**Type**|**Documentation**
2538 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2539 |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.
2540 |AttachmentConstraint|com: AttachmentConstraint ReferenceType|AttachmentConstraint references an attachment constraint that defines the key sets and/or cube regions that attributes may be attached to. This is an alternative to referencing the dimensions, and allows attributes to be attached to data for given values of dimensions.
2541
2542 //**GroupDimensionBaseType**//**: **GroupDimensionBaseType is an abstract base type which refines the base ComponentType in order to form the basis for the GroupDimensionType.
2543
2544 Derivation:
2545
2546 //com:AnnotableType// (extension)
2547 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
2548 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
2549 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)
2550 [[image:inherit.gif||height="9" width="9"]] //GroupDimensionBaseType//
2551
2552 Content:
2553
2554 {Empty}
2555
2556 **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.
2557
2558 Derivation:
2559
2560 //com:AnnotableType// (extension)
2561 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
2562 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
2563 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)
2564 [[image:inherit.gif||height="9" width="9"]] //GroupDimensionBaseType// (extension)
2565 [[image:inherit.gif||height="9" width="9"]] GroupDimensionType
2566
2567 Content:
2568
2569 DimensionReference
2570
2571 Element Documentation:
2572
2573 |**Name**|**Type**|**Documentation**
2574 |DimensionReference|com: LocalDimensionRefere nceType|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.
2575
2576 **MeasureListType: **MeasureListType describes the structure of the measure descriptor for a data structure definition. Only a primary may be defined.
2577
2578 Derivation:
2579
2580 //com:AnnotableType// (extension)
2581 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
2582 [[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)
2583 [[image:inherit.gif||height="9" width="9"]] MeasureListType
2584
2585 Attributes:
2586
2587 id?, urn?, uri?
2588
2589 Content:
2590
2591 com:Annotations?, PrimaryMeasure
2592
2593 Attribute Documentation:
2594
2595 |**Name**|**Type**|**Documentation**
2596 |id (fixed: MeasureDescriptor)|com:IDType|The id is the identifier for the object.
2597 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2598 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2599
2600 Element Documentation:
2601
2602 |**Name**|**Type**|**Documentation**
2603 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2604 |PrimaryMeasure|PrimaryMeasureType|PrimaryMeasure defines the structure of the primary measure, which is the concept that is the value of the phenomenon to be measured in a data set. Although this may take its semantic from any concept, this is provided a fixed identifier (OBS_VALUE) so that it may be easily distinguished in data messages.
2605
2606 **PrimaryMeasureType: **PrimaryMeasureType describes the structure of the primary measure. It describes the observation values for all presentations of the data. The primary measure takes its semantic, and in some cases it representation, from its concept identity (conventionally the OBS_VALUE concept). The primary measure 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 primary measure if a coded representation is not defined. Neither the coded or uncoded representation are necessary, since the primary measure may take these from the referenced concept. Note that if the data structure declares a measure dimension, the representation of this must be a superset of all possible measure concept representations.
2607
2608 Derivation:
2609
2610 //com:AnnotableType// (extension)
2611 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
2612 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
2613 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)
2614 [[image:inherit.gif||height="9" width="9"]] PrimaryMeasureType
2615
2616 Attributes:
2617
2618 id?, urn?, uri?
2619
2620 Content:
2621
2622 com:Annotations?, ConceptIdentity, LocalRepresentation?
2623
2624 Attribute Documentation:
2625
2626 |**Name**|**Type**|**Documentation**
2627 |id (fixed: OBS_VALUE)|com: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).
2628 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2629 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2630
2631 Element Documentation:
2632
2633 |**Name**|**Type**|**Documentation**
2634 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2635 |ConceptIdentity|com: 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.
2636 |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.
2637
2638 //**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.
2639
2640 Derivation:
2641
2642 //RepresentationType// (restriction)
2643 [[image:inherit.gif||height="9" width="9"]] //DataStructureRepresentationType//
2644
2645 Content:
2646
2647 (TextFormat | (Enumeration, EnumerationFormat?))
2648
2649 Element Documentation:
2650
2651 |**Name**|**Type**|**Documentation**
2652 |TextFormat|SimpleComponentTextF ormatType|TextFormat describes an uncoded textual format.
2653 |Enumeration|//com: ItemSchemeReferenceB aseType//|Enumeration references an item scheme that enumerates the allowable values for this representation.
2654 |EnumerationFormat|CodededTextFormatTyp e|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.
2655
2656 **SimpleDataStructureRepresentationType: **SimpleDataStructureRepresentationType defines the representation for any non-measure and non-time dimension data structure definition component.
2657
2658 Derivation:
2659
2660 //RepresentationType// (restriction)
2661 [[image:inherit.gif||height="9" width="9"]] //DataStructureRepresentationType// (restriction)
2662 [[image:inherit.gif||height="9" width="9"]] SimpleDataStructureRepresentationType
2663
2664 Content:
2665
2666 (TextFormat | (Enumeration, EnumerationFormat?))
2667
2668 Element Documentation:
2669
2670 |**Name**|**Type**|**Documentation**
2671 |TextFormat|SimpleComponentTextF ormatType|TextFormat describes an uncoded textual format.
2672 |Enumeration|com: CodelistReferenceTyp e|Enumeration references an item scheme that enumerates the allowable values for this representation.
2673 |EnumerationFormat|CodededTextFormatTyp e|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.
2674
2675 **MeasureDimensionRepresentationType: **BaseDimensionRepresentationType is an abstract base which defines the representation for a measure dimension.
2676
2677 Derivation:
2678
2679 //RepresentationType// (restriction)
2680 [[image:inherit.gif||height="9" width="9"]] //DataStructureRepresentationType// (restriction)
2681 [[image:inherit.gif||height="9" width="9"]] MeasureDimensionRepresentationType
2682
2683 Content:
2684
2685 Enumeration
2686
2687 Element Documentation:
2688
2689 |**Name**|**Type**|**Documentation**
2690 |Enumeration|com: ConceptSchemeReferen ceType|Enumeration references an item scheme that enumerates the allowable values for this representation.
2691
2692 **TimeDimensionRepresentationType: **TimeDimensionRepresentationType defines the representation for the time dimension. Enumerated values are not allowed.
2693
2694 Derivation:
2695
2696 //RepresentationType// (restriction)
2697 [[image:inherit.gif||height="9" width="9"]] //DataStructureRepresentationType// (restriction)
2698 [[image:inherit.gif||height="9" width="9"]] SimpleDataStructureRepresentationType (restriction)
2699 [[image:inherit.gif||height="9" width="9"]] TimeDimensionRepresentationType
2700
2701 Content:
2702
2703 TextFormat
2704
2705 Element Documentation:
2706
2707 |**Name**|**Type**|**Documentation**
2708 |TextFormat|TimeTextFormatType|TextFormat describes an uncoded textual format.
2709
2710 **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 key family definition must be provided.
2711
2712 Derivation:
2713
2714 //com:AnnotableType// (extension)
2715 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
2716 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
2717 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
2718 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
2719 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
2720 [[image:inherit.gif||height="9" width="9"]] //StructureUsageType// (restriction)
2721 [[image:inherit.gif||height="9" width="9"]] DataflowType
2722
2723 Attributes:
2724
2725 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
2726
2727 Content:
2728
2729 com:Annotations?, com:Name+, com:Description*, Structure?
2730
2731 Attribute Documentation:
2732
2733 |**Name**|**Type**|**Documentation**
2734 |id|com:IDType|The id is the identifier for the object.
2735 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2736 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2737 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
2738 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
2739 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
2740 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
2741 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
2742 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
2743 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
2744 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
2745
2746 Element Documentation:
2747
2748 |**Name**|**Type**|**Documentation**
2749 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2750 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
2751 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
2752 |Structure|com: DataStructureReferen ceType|Structure provides a reference to the data structure definition which defines the structure of all data for this flow.
2753
2754 //**HierarchicalCodelistBaseType**//**: **HierarchicalCodelistBaseType is an abstract base class that is the basis for the HierarchicalCodelistType. It requires that a name be supplied.
2755
2756 Derivation:
2757
2758 //com:AnnotableType// (extension)
2759 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
2760 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
2761 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
2762 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
2763 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)
2764 [[image:inherit.gif||height="9" width="9"]] //HierarchicalCodelistBaseType//
2765
2766 Attributes:
2767
2768 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
2769
2770 Content:
2771
2772 com:Annotations?, com:Name+, com:Description*
2773
2774 Attribute Documentation:
2775
2776 |**Name**|**Type**|**Documentation**
2777 |id|com:IDType|The id is the identifier for the object.
2778 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2779 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2780 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
2781 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
2782 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
2783 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
2784 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
2785 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
2786 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
2787 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
2788
2789 Element Documentation:
2790
2791 |**Name**|**Type**|**Documentation**
2792 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2793 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
2794 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
2795
2796 **HierarchicalCodelistType: **HierarchicalCodelistType 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, as defined by one or more hierarchy of the list.
2797
2798 Derivation:
2799
2800 //com:AnnotableType// (extension)
2801 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
2802 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
2803 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
2804 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
2805 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)
2806 [[image:inherit.gif||height="9" width="9"]] //HierarchicalCodelistBaseType// (extension)
2807 [[image:inherit.gif||height="9" width="9"]] HierarchicalCodelistType
2808
2809 Attributes:
2810
2811 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
2812
2813 Content:
2814
2815 com:Annotations?, com:Name+, com:Description*, IncludedCodelist*, Hierarchy*
2816
2817 Attribute Documentation:
2818
2819 |**Name**|**Type**|**Documentation**
2820 |id|com:IDType|The id is the identifier for the object.
2821 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2822 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2823 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
2824 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
2825 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
2826 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
2827 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
2828 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
2829 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
2830 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
2831
2832 Element Documentation:
2833
2834 |**Name**|**Type**|**Documentation**
2835 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2836 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
2837 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
2838 |IncludedCodelist|IncludedCodelistRefe renceType|IndludedCodelist provides a collection of references to the code lists whose codes are arranged in this hierarchical code list.
2839 |Hierarchy|HierarchyType|Hierarchy describes a classification structure arranged in levels of detail from the broadest to the most detailed level. These levels can be formal or informal, and are not necessary to describe. If the hierarchy does contain levels, then each hierarchical code is assumed to exist in the level where the depths of nesting match.
2840
2841 //**HierarchyBaseType**//**: **HierarchyBaseType is an abstract base type that serves as the basis for the HierarchyType. It requires a name and id be provided.
2842
2843 Derivation:
2844
2845 //com:AnnotableType// (extension)
2846 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
2847 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
2848 [[image:inherit.gif||height="9" width="9"]] //HierarchyBaseType//
2849
2850 Attributes:
2851
2852 id, urn?, uri?
2853
2854 Content:
2855
2856 com:Annotations?, com:Name+, com:Description*
2857
2858 Attribute Documentation:
2859
2860 |**Name**|**Type**|**Documentation**
2861 |id|com:IDType|The id is the identifier for the object.
2862 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2863 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2864
2865 Element Documentation:
2866
2867 |**Name**|**Type**|**Documentation**
2868 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2869 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
2870 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
2871
2872 **HierarchyType: **The Hierarchy is an abstract type that provides for a classification structure of referenced codes arranged in levels of detail from the broadest to the most detailed level. The levels in which the code exist can be formal or informal.
2873
2874 Derivation:
2875
2876 //com:AnnotableType// (extension)
2877 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
2878 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
2879 [[image:inherit.gif||height="9" width="9"]] //HierarchyBaseType// (extension)
2880 [[image:inherit.gif||height="9" width="9"]] HierarchyType
2881
2882 Attributes:
2883
2884 id, urn?, uri?, leveled?
2885
2886 Content:
2887
2888 com:Annotations?, com:Name+, com:Description*, HierarchicalCode+, Level?
2889
2890 Attribute Documentation:
2891
2892 |**Name**|**Type**|**Documentation**
2893 |id|com:IDType|The id is the identifier for the object.
2894 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2895 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2896 |leveled (default: false)|xs:boolean|The leveled attribute indicates that the hierarchy has formal levels. In this case, every code should have a level associated with it.
2897
2898 Element Documentation:
2899
2900 |**Name**|**Type**|**Documentation**
2901 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2902 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
2903 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
2904 |HierarchicalCode|HierarchicalCodeType|HierarchicalCode is used to assemble the codes from the codelist(s) referenced into a hierarchy.
2905 |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.
2906
2907 //**HierarchicalCodeBaseType**//**: **HierarchicalCodeBaseType is an abstract base type the creates the basis for the HierarchicalCodeType. It removes the urn and uri.
2908
2909 Derivation:
2910
2911 //com:AnnotableType// (extension)
2912 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
2913 [[image:inherit.gif||height="9" width="9"]] //HierarchicalCodeBaseType//
2914
2915 Attributes:
2916
2917 id, urn?, uri?
2918
2919 Content:
2920
2921 com:Annotations?
2922
2923 Attribute Documentation:
2924
2925 |**Name**|**Type**|**Documentation**
2926 |id|com: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.
2927 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2928 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2929
2930 Element Documentation:
2931
2932 |**Name**|**Type**|**Documentation**
2933 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2934
2935 **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, or a local reference which utilizes the included codelist reference alias and the identification of a code from the list. 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.
2936
2937 Derivation:
2938
2939 //com:AnnotableType// (extension)
2940 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
2941 [[image:inherit.gif||height="9" width="9"]] //HierarchicalCodeBaseType// (extension)
2942 [[image:inherit.gif||height="9" width="9"]] HierarchicalCodeType
2943
2944 Attributes:
2945
2946 id, urn?, uri?, version?, validFrom?, validTo?
2947
2948 Content:
2949
2950 com:Annotations?, (Code | (CodelistAliasRef, CodeID)), HierarchicalCode*, Level?
2951
2952 Attribute Documentation:
2953
2954 |**Name**|**Type**|**Documentation**
2955 |id|com: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.
2956 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2957 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2958 |version|com:VersionType|The version attriubte contains a version number for the hierarchical code. A hierarchical code is not formally versionable, therefore each code must have a unique identifier. The version supplied here is for informational purposes only and is not used to uniquely identity the code.
2959 |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.
2960 |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.
2961
2962 Element Documentation:
2963
2964 |**Name**|**Type**|**Documentation**
2965 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
2966 |Code|com: CodeReferenceType|Code provides a complete, explicit reference to a code through either its URN, or a complete reference to the codelist and code.
2967 |CodelistAliasRef|com:IDType|CodelistAliasRef references an alias assigned in a IncludedCodelistReference element in the containing hierarchical codelist. This is used in conjunction with the CodeID element to reference a code from one of the included codelists.
2968 |CodeID|com: LocalCodeReferenceTy pe|CodeID references the id of a code from the codelist that is referenced through the CodelistAliaRef element.
2969 |HierarchicalCode|HierarchicalCodeType|HierarchicalCode is used to nest referenced codes into a value based hierarchy.
2970 |Level|com: LocalLevelReferenceT ype|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.
2971
2972 //**LevelBaseType**//**: **LevelBaseType is an abstract base type that makes up the basis for the LevelType. It requires a name and id.
2973
2974 Derivation:
2975
2976 //com:AnnotableType// (extension)
2977 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
2978 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
2979 [[image:inherit.gif||height="9" width="9"]] //LevelBaseType//
2980
2981 Attributes:
2982
2983 id, urn?, uri?
2984
2985 Content:
2986
2987 com:Annotations?, com:Name+, com:Description*
2988
2989 Attribute Documentation:
2990
2991 |**Name**|**Type**|**Documentation**
2992 |id|com:IDType|The id is the identifier for the object.
2993 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2994 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2995
2996 Element Documentation:
2997
2998 |**Name**|**Type**|**Documentation**
2999 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3000 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3001 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
3002
3003 **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.
3004
3005 Derivation:
3006
3007 //com:AnnotableType// (extension)
3008 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
3009 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
3010 [[image:inherit.gif||height="9" width="9"]] //LevelBaseType// (extension)
3011 [[image:inherit.gif||height="9" width="9"]] LevelType
3012
3013 Attributes:
3014
3015 id, urn?, uri?
3016
3017 Content:
3018
3019 com:Annotations?, com:Name+, com:Description*, CodingFormat?, Level?
3020
3021 Attribute Documentation:
3022
3023 |**Name**|**Type**|**Documentation**
3024 |id|com:IDType|The id is the identifier for the object.
3025 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3026 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3027
3028 Element Documentation:
3029
3030 |**Name**|**Type**|**Documentation**
3031 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3032 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3033 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
3034 |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.
3035 |Level|LevelType|Level describes the next level down in the hierarchy.
3036
3037 **IncludedCodelistReferenceType: **IncludedCodelistReferenceType provides the structure for a referencing a codelist and optionally providing a local alias identification for this reference.
3038
3039 Derivation:
3040
3041 //com:ReferenceType// (restriction)
3042 [[image:inherit.gif||height="9" width="9"]] //com:MaintainableReferenceBaseType// (restriction)
3043 [[image:inherit.gif||height="9" width="9"]] //com:ItemSchemeReferenceBaseType// (restriction)
3044 [[image:inherit.gif||height="9" width="9"]] com:CodelistReferenceType (extension)
3045 [[image:inherit.gif||height="9" width="9"]] IncludedCodelistReferenceType
3046
3047 Attributes:
3048
3049 alias?
3050
3051 Content:
3052
3053 ( (Ref, URN?) | URN)
3054
3055 Attribute Documentation:
3056
3057 |**Name**|**Type**|**Documentation**
3058 |alias|com:IDType|The alias attribute is used to carry the identifier for the referenced codelist, so that codes from that list can be easily referenced by the hierarchical codes contained in the parent hierarchy, without having to repeat the reference to the codelist itself. The alias attribute must be unique within the parent hierarchical codelist.
3059
3060 Element Documentation:
3061
3062 |**Name**|**Type**|**Documentation**
3063 |Ref|com:CodelistRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.
3064 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3065 |URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.
3066
3067 **CodingTextFormatType:**
3068
3069 Derivation:
3070
3071 TextFormatType (restriction)
3072 [[image:inherit.gif||height="9" width="9"]] BasicComponentTextFormatType (restriction)
3073 [[image:inherit.gif||height="9" width="9"]] SimpleComponentTextFormatType (restriction)
3074 [[image:inherit.gif||height="9" width="9"]] CodingTextFormatType
3075
3076 Attributes:
3077
3078 textType?, isSequence?, interval?, startValue?, endValue?, minLength?, maxLength?, minValue?, maxValue?, pattern?
3079
3080 Content:
3081
3082 {Empty}
3083
3084 Attribute Documentation:
3085
3086 |**Name**|**Type**|**Documentation**
3087 |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.
3088 |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.
3089 |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.
3090 |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.
3091 |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.
3092 |minLength|xs:positiveInteger|The minLength attribute specifies the minimum and length of the value in characters.
3093 |maxLength|xs:positiveInteger|The maxLength attribute specifies the maximum length of the value in characters.
3094 |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.
3095 |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.
3096 |pattern|xs:string|The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema.
3097
3098 **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
3099
3100 Derivation:
3101
3102 //com:AnnotableType// (extension)
3103 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
3104 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
3105 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
3106 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
3107 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
3108 [[image:inherit.gif||height="9" width="9"]] //StructureUsageType// (restriction)
3109 [[image:inherit.gif||height="9" width="9"]] MetadataflowType
3110
3111 Attributes:
3112
3113 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
3114
3115 Content:
3116
3117 com:Annotations?, com:Name+, com:Description*, Structure?
3118
3119 Attribute Documentation:
3120
3121 |**Name**|**Type**|**Documentation**
3122 |id|com:IDType|The id is the identifier for the object.
3123 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3124 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3125 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
3126 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
3127 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
3128 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
3129 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
3130 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
3131 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
3132 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
3133
3134 Element Documentation:
3135
3136 |**Name**|**Type**|**Documentation**
3137 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3138 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3139 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
3140 |Structure|com: MetadataStructureRef erenceType|Structure provides a reference to the metadata structure definition describing the structure of all reference metadata for this flow.
3141
3142 **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.
3143
3144 Derivation:
3145
3146 //com:AnnotableType// (extension)
3147 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
3148 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
3149 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
3150 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
3151 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
3152 [[image:inherit.gif||height="9" width="9"]] //StructureType// (restriction)
3153 [[image:inherit.gif||height="9" width="9"]] MetadataStructureType
3154
3155 Attributes:
3156
3157 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
3158
3159 Content:
3160
3161 com:Annotations?, com:Name+, com:Description*, MetadataStructureComponents?
3162
3163 Attribute Documentation:
3164
3165 |**Name**|**Type**|**Documentation**
3166 |id|com:IDType|The id is the identifier for the object.
3167 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3168 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3169 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
3170 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
3171 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
3172 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
3173 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
3174 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
3175 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
3176 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
3177
3178 Element Documentation:
3179
3180 |**Name**|**Type**|**Documentation**
3181 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3182 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3183 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
3184 |MetadataStructureCom ponents|MetadataStructureCom ponentsType|MetadataStructureComponents defines the grouping of the sets of the components that make up the metadata structure definition. All components and component list (target identifiers, identifier components, report structures, and metadata attributes) in the structure definition must have a unique identification.
3185
3186 **MetadataStructureComponentsBaseType: **MetadataStructureComponentsBaseType is an abstract base type that forms the basis for the MetadataStructureComponentsType.
3187
3188 Derivation:
3189
3190 //GroupingType// (restriction)
3191 [[image:inherit.gif||height="9" width="9"]] MetadataStructureComponentsBaseType
3192
3193 Content:
3194
3195 {Empty}
3196
3197 **MetadataStructureComponentsType: **MetadataStructureComponentsType describes the structure of the grouping of the sets of the components that make up the metadata structure definition. At a minimum, a full target identifier and at least one report structure must be defined.
3198
3199 Derivation:
3200
3201 //GroupingType// (restriction)
3202 [[image:inherit.gif||height="9" width="9"]] MetadataStructureComponentsBaseType (extension)
3203 [[image:inherit.gif||height="9" width="9"]] MetadataStructureComponentsType
3204
3205 Content:
3206
3207 MetadataTarget+, ReportStructure+
3208
3209 Element Documentation:
3210
3211 |**Name**|**Type**|**Documentation**
3212 |MetadataTarget|MetadataTargetType|MetadataTarget is a collection of target objects which when taken together describe a structure which defines the key of an object type to which metadata may be attached and serve to disambiguate reference metadata set reports.
3213 |ReportStructure|ReportStructureType|ReportStructure defines a report structure, which comprises a 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 report 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.
3214
3215 //**MetadataTargetBaseType**//**: **MetadataTargetBaseType is an abstract base type which forms the basis for the MetadataTargetType.
3216
3217 Derivation:
3218
3219 //com:AnnotableType// (extension)
3220 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
3221 [[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)
3222 [[image:inherit.gif||height="9" width="9"]] //MetadataTargetBaseType//
3223
3224 Attributes:
3225
3226 id, urn?, uri?
3227
3228 Content:
3229
3230 com:Annotations?
3231
3232 Attribute Documentation:
3233
3234 |**Name**|**Type**|**Documentation**
3235 |id|com:IDType|The id is the identifier for the object.
3236 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3237 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3238
3239 Element Documentation:
3240
3241 |**Name**|**Type**|**Documentation**
3242 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3243
3244 **MetadataTargetType:**
3245
3246 Derivation:
3247
3248 //com:AnnotableType// (extension)
3249 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
3250 [[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)
3251 [[image:inherit.gif||height="9" width="9"]] //MetadataTargetBaseType// (extension)
3252 [[image:inherit.gif||height="9" width="9"]] MetadataTargetType
3253
3254 Attributes:
3255
3256 id, urn?, uri?
3257
3258 Content:
3259
3260 com:Annotations?, (KeyDescriptorValuesTarget | DataSetTarget | ConstraintContentTarget | ReportPeriodTarget | IdentifiableObjectTarget)+
3261
3262 Attribute Documentation:
3263
3264 |**Name**|**Type**|**Documentation**
3265 |id|com:IDType|The id is the identifier for the object.
3266 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3267 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3268
3269 Element Documentation:
3270
3271 |**Name**|**Type**|**Documentation**
3272 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3273 |KeyDescriptorValuesT arget|KeyDescriptorValuesT argetType|KeyDescriptorValuesTarget is target object which references a data key for the purpose of attach reference metadata to portions of data. A data key is a set of dimension references and values for those dimension. This component on its own is not of much use, as the data key only has local references to the dimensions. Therefore it is typical that this is used in combination with some sort of reference to the data (either a data set reference or a reference to the underlying structure, structure usage, or provision agreement of the data.
3274 |DataSetTarget|DataSetTargetType|DataSetTarget is target object which references a data set for the purpose of attaching reference metadata data. A data set reference is a full reference to a data provider and an identifier for the data set.
3275 |ConstraintContentTar get|ConstraintContentTar getType|ConstraintContentTarget is target object which references an attachment constraint for the purpose of attaching reference metadata data to data key sets or cube regions defined by the constraint.
3276 |ReportPeriodTarget|ReportPeriodTargetTy pe|ReportPeriodTarget is target object which specifies a reporting period to which a metadata report applies.
3277 |IdentifiableObjectTa rget|IdentifiableObjectTa rgetType|IdentifiableObjectTarget is target object which references an Identifiable object as defined in the SDMX Information Model. The reference must be complete (i.e. a URN or a complete set of reference fields). For an item object, it is possible to define a local representation of an item scheme from which the item must be referenced.
3278
3279 //**TargetObject**//**: **TargetObject is an abstract base type from which all target objects of a metadata target are derived. It is based on a component. Implementations of this will refined the local representation so that the allowed values accurately reflect the representation of the target object reference.
3280
3281 Derivation:
3282
3283 //com:AnnotableType// (extension)
3284 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
3285 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
3286 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (extension)
3287 [[image:inherit.gif||height="9" width="9"]] //TargetObject//
3288
3289 Attributes:
3290
3291 id?, urn?, uri?
3292
3293 Content:
3294
3295 com:Annotations?, ConceptIdentity?, LocalRepresentation?
3296
3297 Attribute Documentation:
3298
3299 |**Name**|**Type**|**Documentation**
3300 |id|com: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).
3301 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3302 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3303
3304 Element Documentation:
3305
3306 |**Name**|**Type**|**Documentation**
3307 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3308 |ConceptIdentity|com: 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.
3309 |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.
3310
3311 **KeyDescriptorValuesTargetType: **KeyDescriptorValuesTargetType defines the structure of a key descriptor values target object. The key descriptor values target object has a fixed representation and identifier.
3312
3313 Derivation:
3314
3315 //com:AnnotableType// (extension)
3316 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
3317 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
3318 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (extension)
3319 [[image:inherit.gif||height="9" width="9"]] //TargetObject// (restriction)
3320 [[image:inherit.gif||height="9" width="9"]] KeyDescriptorValuesTargetType
3321
3322 Attributes:
3323
3324 id?, urn?, uri?
3325
3326 Content:
3327
3328 com:Annotations?, LocalRepresentation
3329
3330 Attribute Documentation:
3331
3332 |**Name**|**Type**|**Documentation**
3333 |id (fixed: DIMENSION_DESCRIPTOR_VALUES_TARGET)|com:NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).
3334 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3335 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3336
3337 Element Documentation:
3338
3339 |**Name**|**Type**|**Documentation**
3340 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3341 |LocalRepresentation|KeyDescriptorValuesR 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.
3342
3343 **DataSetTargetType: **DataSetTargetType defines the structure of a data set target object. The data set target object has a fixed representation and identifier.
3344
3345 Derivation:
3346
3347 //com:AnnotableType// (extension)
3348 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
3349 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
3350 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (extension)
3351 [[image:inherit.gif||height="9" width="9"]] //TargetObject// (restriction)
3352 [[image:inherit.gif||height="9" width="9"]] DataSetTargetType
3353
3354 Attributes:
3355
3356 id?, urn?, uri?
3357
3358 Content:
3359
3360 com:Annotations?, LocalRepresentation
3361
3362 Attribute Documentation:
3363
3364 |**Name**|**Type**|**Documentation**
3365 |id (fixed: DATA_SET_TARGET)|com: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).
3366 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3367 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3368
3369 Element Documentation:
3370
3371 |**Name**|**Type**|**Documentation**
3372 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3373 |LocalRepresentation|DataSetRepresentatio 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.
3374
3375 **ConstraintContentTargetType: **ConstraintTargetType defines the structure of a constraint target object. The constraint target object has a fixed representation and identifier.
3376
3377 Derivation:
3378
3379 //com:AnnotableType// (extension)
3380 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
3381 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
3382 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (extension)
3383 [[image:inherit.gif||height="9" width="9"]] //TargetObject// (restriction)
3384 [[image:inherit.gif||height="9" width="9"]] ConstraintContentTargetType
3385
3386 Attributes:
3387
3388 id?, urn?, uri?
3389
3390 Content:
3391
3392 com:Annotations?, LocalRepresentation
3393
3394 Attribute Documentation:
3395
3396 |**Name**|**Type**|**Documentation**
3397 |id (fixed: CONSTRAINT_CONTENT_TARGET)|com: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).
3398 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3399 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3400
3401 Element Documentation:
3402
3403 |**Name**|**Type**|**Documentation**
3404 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3405 |LocalRepresentation|ConstraintRepresenta tionType|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.
3406
3407 **ReportPeriodTargetType: **ReportPeriodTargetType defines the structure of a report period target object. The report period target object has a fixed representation and identifier.
3408
3409 Derivation:
3410
3411 //com:AnnotableType// (extension)
3412 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
3413 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
3414 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (extension)
3415 [[image:inherit.gif||height="9" width="9"]] //TargetObject// (restriction)
3416 [[image:inherit.gif||height="9" width="9"]] ReportPeriodTargetType
3417
3418 Attributes:
3419
3420 id?, urn?, uri?
3421
3422 Content:
3423
3424 com:Annotations?, LocalRepresentation
3425
3426 Attribute Documentation:
3427
3428 |**Name**|**Type**|**Documentation**
3429 |id (fixed: REPORT_PERIOD_TARGET)|com: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).
3430 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3431 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3432
3433 Element Documentation:
3434
3435 |**Name**|**Type**|**Documentation**
3436 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3437 |LocalRepresentation|ReportPeriodRepresen tationType|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.
3438
3439 //**IdentifiableObjectTargetBaseType**//**: **IdentifiableObjectTargetBaseType is an abstract base type which forms the basis for the IdentifiableObjectTargetType.
3440
3441 Derivation:
3442
3443 //com:AnnotableType// (extension)
3444 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
3445 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
3446 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (extension)
3447 [[image:inherit.gif||height="9" width="9"]] //TargetObject// (restriction)
3448 [[image:inherit.gif||height="9" width="9"]] //IdentifiableObjectTargetBaseType//
3449
3450 Attributes:
3451
3452 id, urn?, uri?
3453
3454 Content:
3455
3456 com:Annotations?, LocalRepresentation
3457
3458 Attribute Documentation:
3459
3460 |**Name**|**Type**|**Documentation**
3461 |id|com: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).
3462 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3463 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3464
3465 Element Documentation:
3466
3467 |**Name**|**Type**|**Documentation**
3468 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3469 |LocalRepresentation|IdentifiableObjectRe presentationType|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.
3470
3471 **IdentifiableObjectTargetType: **IdentifiableObjectTargetType defines the structure of an identifiable target object. The identifiable target object has a fixed representation of a reference and can specify a local representation of any item scheme for the purpose of restricting which items may be referenced. The identifiable object target must specify the object type which the target object is meant to reference.
3472
3473 Derivation:
3474
3475 //com:AnnotableType// (extension)
3476 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
3477 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
3478 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (extension)
3479 [[image:inherit.gif||height="9" width="9"]] //TargetObject// (restriction)
3480 [[image:inherit.gif||height="9" width="9"]] //IdentifiableObjectTargetBaseType// (extension)
3481 [[image:inherit.gif||height="9" width="9"]] IdentifiableObjectTargetType
3482
3483 Attributes:
3484
3485 id, urn?, uri?, objectType
3486
3487 Content:
3488
3489 com:Annotations?, LocalRepresentation
3490
3491 Attribute Documentation:
3492
3493 |**Name**|**Type**|**Documentation**
3494 |id|com: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).
3495 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3496 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3497 |objectType|com: ObjectTypeCodelistTy pe|
3498
3499 Element Documentation:
3500
3501 |**Name**|**Type**|**Documentation**
3502 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3503 |LocalRepresentation|IdentifiableObjectRe presentationType|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.
3504
3505 //**ReportStructureBaseType**//**: **ReportStructureBaseType is an abstract base type that serves as the basis for the ReportStructureType.
3506
3507 Derivation:
3508
3509 //com:AnnotableType// (extension)
3510 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
3511 [[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)
3512 [[image:inherit.gif||height="9" width="9"]] //ReportStructureBaseType//
3513
3514 Attributes:
3515
3516 id, urn?, uri?
3517
3518 Content:
3519
3520 com:Annotations?, MetadataAttribute+
3521
3522 Attribute Documentation:
3523
3524 |**Name**|**Type**|**Documentation**
3525 |id|com:IDType|The id is the identifier for the object.
3526 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3527 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3528
3529 Element Documentation:
3530
3531 |**Name**|**Type**|**Documentation**
3532 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3533 |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.
3534
3535 **ReportStructureType: **ReportStructureType describes the structure of a report structure. It comprises a set of metadata attributes that can be defined as a hierarchy, and identifies the potential attachment of these attributes to an object by referencing a target identifier.
3536
3537 Derivation:
3538
3539 //com:AnnotableType// (extension)
3540 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
3541 [[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)
3542 [[image:inherit.gif||height="9" width="9"]] //ReportStructureBaseType// (extension)
3543 [[image:inherit.gif||height="9" width="9"]] ReportStructureType
3544
3545 Attributes:
3546
3547 id, urn?, uri?
3548
3549 Content:
3550
3551 com:Annotations?, MetadataAttribute+, MetadataTarget+
3552
3553 Attribute Documentation:
3554
3555 |**Name**|**Type**|**Documentation**
3556 |id|com:IDType|The id is the identifier for the object.
3557 |urn|xs:anyURI|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
3560 Element Documentation:
3561
3562 |**Name**|**Type**|**Documentation**
3563 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3564 |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.
3565 |MetadataTarget|com: LocalMetadataTargetR eferenceType|MetadataTarget references a metadata target defined in the metadata structure definition. A report structure can reference multiple metadata targets which allows a report structure to be reused for attaching metadata to different types of targets.
3566
3567 //**MetadataAttributeBaseType**//**: **MetadataAttributeBaseType is an abstract base type the serves as the basis for the MetadataAttributeType.
3568
3569 Derivation:
3570
3571 //com:AnnotableType// (extension)
3572 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
3573 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
3574 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)
3575 [[image:inherit.gif||height="9" width="9"]] //MetadataAttributeBaseType//
3576
3577 Attributes:
3578
3579 id?, urn?, uri?
3580
3581 Content:
3582
3583 com:Annotations?, ConceptIdentity, LocalRepresentation?
3584
3585 Attribute Documentation:
3586
3587 |**Name**|**Type**|**Documentation**
3588 |id|com: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).
3589 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3590 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3591
3592 Element Documentation:
3593
3594 |**Name**|**Type**|**Documentation**
3595 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3596 |ConceptIdentity|com: 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.
3597 |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.
3598
3599 **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 (including target identifier, identifier component, and report structure ids). A metadata attribute may be used in multiple report structures and at different levels, but the content (value and/or child metadata attributes and their cardinality) of the metadata attribute cannot change.
3600
3601 Derivation:
3602
3603 //com:AnnotableType// (extension)
3604 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)
3605 [[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)
3606 [[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)
3607 [[image:inherit.gif||height="9" width="9"]] //MetadataAttributeBaseType// (extension)
3608 [[image:inherit.gif||height="9" width="9"]] MetadataAttributeType
3609
3610 Attributes:
3611
3612 id?, urn?, uri?, minOccurs?, maxOccurs?, isPresentational?
3613
3614 Content:
3615
3616 com:Annotations?, ConceptIdentity, LocalRepresentation?, MetadataAttribute*
3617
3618 Attribute Documentation:
3619
3620 |**Name**|**Type**|**Documentation**
3621 |id|com: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).
3622 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3623 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3624 |minOccurs (default: 1)|xs: nonNegativeInteger|The minOccurs attribute indicates the minimum number of times this metadata attribute can occur within its parent object.
3625 |maxOccurs (default: 1)|com:OccurenceType|The maxOccurs attribute indicates the maximum number of times this metadata attribute can occur within its parent object.
3626 |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.
3627
3628 Element Documentation:
3629
3630 |**Name**|**Type**|**Documentation**
3631 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3632 |ConceptIdentity|com: 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.
3633 |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.
3634 |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.
3635
3636 **KeyDescriptorValuesRepresentationType: **KeyDescriptorValuesRepresentationType defines the possible local representations of a key descriptor values target object. The representation is fixed to always be a data key (KeyValues).
3637
3638 Derivation:
3639
3640 //RepresentationType// (restriction)
3641 [[image:inherit.gif||height="9" width="9"]] KeyDescriptorValuesRepresentationType
3642
3643 Content:
3644
3645 TextFormat
3646
3647 Element Documentation:
3648
3649 |**Name**|**Type**|**Documentation**
3650 |TextFormat|KeyDescriptorValuesT extFormatType|TextFormat describes an uncoded textual format.
3651
3652 **DataSetRepresentationType: **DataSetRepresentationType defines the possible local representations of a data set reference target object. The representation is fixed to always be a data set reference.
3653
3654 Derivation:
3655
3656 //RepresentationType// (restriction)
3657 [[image:inherit.gif||height="9" width="9"]] DataSetRepresentationType
3658
3659 Content:
3660
3661 TextFormat
3662
3663 Element Documentation:
3664
3665 |**Name**|**Type**|**Documentation**
3666 |TextFormat|DataSetTextFormatTyp e|TextFormat describes an uncoded textual format.
3667
3668 **ConstraintRepresentationType: **ConstraintRepresentationType defines the possible local representations of a constraint reference target object. The representation is fixed to always be an attachment constraint reference.
3669
3670 Derivation:
3671
3672 //RepresentationType// (restriction)
3673 [[image:inherit.gif||height="9" width="9"]] ConstraintRepresentationType
3674
3675 Content:
3676
3677 TextFormat
3678
3679 Element Documentation:
3680
3681 |**Name**|**Type**|**Documentation**
3682 |TextFormat|ConstraintTextFormat Type|TextFormat describes an uncoded textual format.
3683
3684 **ReportPeriodRepresentationType: **ReportPeriodRepresentationType defines the possible local representations of a report period target object. The reprentation must be a time period or a subset of this representation.
3685
3686 Derivation:
3687
3688 //RepresentationType// (restriction)
3689 [[image:inherit.gif||height="9" width="9"]] ReportPeriodRepresentationType
3690
3691 Content:
3692
3693 TextFormat
3694
3695 Element Documentation:
3696
3697 |**Name**|**Type**|**Documentation**
3698 |TextFormat|TimeTextFormatType|TextFormat describes an uncoded textual format.
3699
3700 **IdentifiableObjectRepresentationType: **IdentifiableObjectRepresentationType defines the possible local representations of an identifiable object target object.
3701
3702 Derivation:
3703
3704 //RepresentationType// (restriction)
3705 [[image:inherit.gif||height="9" width="9"]] IdentifiableObjectRepresentationType
3706
3707 Content:
3708
3709 (TextFormat | Enumeration)
3710
3711 Element Documentation:
3712
3713 |**Name**|**Type**|**Documentation**
3714 |TextFormat|IdentifiableObjectTe xtFormatType|TextFormat describes an uncoded textual format.
3715 |Enumeration|com: ItemSchemeReferenceT ype|Enumeration is only permissible if the object type of the identifiable object target is an item in an item scheme. This enumeration is meant to limit the referencable objects to the items defined in the referenced item scheme.
3716
3717 **MetadataAttributeRepresentationType: **MetadataAttributeRepresentationType defines the possible local representations of a metadata attribute.
3718
3719 Derivation:
3720
3721 //RepresentationType// (restriction)
3722 [[image:inherit.gif||height="9" width="9"]] MetadataAttributeRepresentationType
3723
3724 Content:
3725
3726 (TextFormat | (Enumeration, EnumerationFormat?))
3727
3728 Element Documentation:
3729
3730 |**Name**|**Type**|**Documentation**
3731 |TextFormat|BasicComponentTextFo rmatType|TextFormat describes an uncoded textual format.
3732 |Enumeration|com: CodelistReferenceTyp e|Enumeration references an item scheme that enumerates the allowable values for this representation.
3733 |EnumerationFormat|CodededTextFormatTyp e|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.
3734
3735 **TargetObjectTextFormatType: **TargetObjectTextFormatType is a restricted version of the TextFormatType that does not allow for any facets and only allows the text types for target objects.
3736
3737 Derivation:
3738
3739 TextFormatType (restriction)
3740 [[image:inherit.gif||height="9" width="9"]] TargetObjectTextFormatType
3741
3742 Attributes:
3743
3744 textType?
3745
3746 Content:
3747
3748 {Empty}
3749
3750 Attribute Documentation:
3751
3752 |**Name**|**Type**|**Documentation**
3753 |textType|TargetObjectDataType|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.
3754
3755 **KeyDescriptorValuesTextFormatType: **KeyDescriptorValuesTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed KeyValues representation.
3756
3757 Derivation:
3758
3759 TextFormatType (restriction)
3760 [[image:inherit.gif||height="9" width="9"]] TargetObjectTextFormatType (restriction)
3761 [[image:inherit.gif||height="9" width="9"]] KeyDescriptorValuesTextFormatType
3762
3763 Attributes:
3764
3765 textType?
3766
3767 Content:
3768
3769 {Empty}
3770
3771 Attribute Documentation:
3772
3773 |**Name**|**Type**|**Documentation**
3774 |textType (fixed: KeyValues)|TargetObjectDataType|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.
3775
3776 **DataSetTextFormatType: **DataSetTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed DataSetReference representation.
3777
3778 Derivation:
3779
3780 TextFormatType (restriction)
3781 [[image:inherit.gif||height="9" width="9"]] TargetObjectTextFormatType (restriction)
3782 [[image:inherit.gif||height="9" width="9"]] DataSetTextFormatType
3783
3784 Attributes:
3785
3786 textType?
3787
3788 Content:
3789
3790 {Empty}
3791
3792 Attribute Documentation:
3793
3794 |**Name**|**Type**|**Documentation**
3795 |textType (fixed: DataSetReference)|TargetObjectDataType|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.
3796
3797 **ConstraintTextFormatType: **ConstraintTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed AttachmentConstraintReference representation.
3798
3799 Derivation:
3800
3801 TextFormatType (restriction)
3802 [[image:inherit.gif||height="9" width="9"]] TargetObjectTextFormatType (restriction)
3803 [[image:inherit.gif||height="9" width="9"]] ConstraintTextFormatType
3804
3805 Attributes:
3806
3807 textType?
3808
3809 Content:
3810
3811 {Empty}
3812
3813 Attribute Documentation:
3814
3815 |**Name**|**Type**|**Documentation**
3816 |textType (fixed: AttachmentConstraintReference)|TargetObjectDataType|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.
3817
3818 **IdentifiableObjectTextFormatType: **IdentifiableObjectTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed IdentifiableReference representation.
3819
3820 Derivation:
3821
3822 TextFormatType (restriction)
3823 [[image:inherit.gif||height="9" width="9"]] TargetObjectTextFormatType (restriction)
3824 [[image:inherit.gif||height="9" width="9"]] IdentifiableObjectTextFormatType
3825
3826 Attributes:
3827
3828 textType?
3829
3830 Content:
3831
3832 {Empty}
3833
3834 Attribute Documentation:
3835
3836 |**Name**|**Type**|**Documentation**
3837 |textType (fixed: IdentifiableReference)|TargetObjectDataType|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.
3838
3839 //**OrganisationSchemeBaseType**//**: **OrganisationSchemeBaseType is an abstract base type for any organisation scheme.
3840
3841 Derivation:
3842
3843 //com:AnnotableType// (extension)
3844 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
3845 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
3846 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
3847 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
3848 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
3849 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)
3850 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeBaseType//
3851
3852 Attributes:
3853
3854 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
3855
3856 Content:
3857
3858 com:Annotations?, com:Name+, com:Description*
3859
3860 Attribute Documentation:
3861
3862 |**Name**|**Type**|**Documentation**
3863 |id|com:IDType|The id is the identifier for the object.
3864 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3865 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3866 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
3867 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
3868 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
3869 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
3870 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
3871 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
3872 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
3873 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
3874 |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 key family in the context of a constraint.
3875
3876 Element Documentation:
3877
3878 |**Name**|**Type**|**Documentation**
3879 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3880 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3881 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
3882
3883 //**OrganisationSchemeType**//**: **OrganisationSchemeType describes the structure of an organisation scheme.
3884
3885 Derivation:
3886
3887 //com:AnnotableType// (extension)
3888 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
3889 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
3890 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
3891 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
3892 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
3893 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)
3894 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeBaseType// (extension)
3895 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeType//
3896
3897 Attributes:
3898
3899 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
3900
3901 Content:
3902
3903 com:Annotations?, com:Name+, com:Description*, //Organisation*//
3904
3905 Attribute Documentation:
3906
3907 |**Name**|**Type**|**Documentation**
3908 |id|com:IDType|The id is the identifier for the object.
3909 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3910 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3911 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
3912 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
3913 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
3914 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
3915 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
3916 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
3917 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
3918 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
3919 |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 key family in the context of a constraint.
3920
3921 Element Documentation:
3922
3923 |**Name**|**Type**|**Documentation**
3924 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3925 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3926 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
3927 |//Organisation//|//OrganisationType//|Organisation is an abstract substitution head for a generic organisation.
3928
3929 //**BaseOrganisationType**//**: **BaseOrganisationType is an abstract base type the forms the basis for the OrganisationType.
3930
3931 Derivation:
3932
3933 //com:AnnotableType// (extension)
3934 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
3935 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
3936 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
3937 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
3938 [[image:inherit.gif||height="9" width="9"]] //BaseOrganisationType//
3939
3940 Attributes:
3941
3942 id, urn?, uri?
3943
3944 Content:
3945
3946 com:Annotations?, com:Name+, com:Description*, Parent?
3947
3948 Attribute Documentation:
3949
3950 |**Name**|**Type**|**Documentation**
3951 |id|com:IDType|The id is the identifier for the object.
3952 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3953 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3954
3955 Element Documentation:
3956
3957 |**Name**|**Type**|**Documentation**
3958 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3959 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3960 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
3961 |Parent|//com: LocalOrganisationRef erenceBaseType//|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.
3962
3963 //**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.
3964
3965 Derivation:
3966
3967 //com:AnnotableType// (extension)
3968 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
3969 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
3970 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
3971 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
3972 [[image:inherit.gif||height="9" width="9"]] //BaseOrganisationType// (extension)
3973 [[image:inherit.gif||height="9" width="9"]] //OrganisationType//
3974
3975 Attributes:
3976
3977 id, urn?, uri?
3978
3979 Content:
3980
3981 com:Annotations?, com:Name+, com:Description*, Parent?, Contact*
3982
3983 Attribute Documentation:
3984
3985 |**Name**|**Type**|**Documentation**
3986 |id|com:IDType|The id is the identifier for the object.
3987 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3988 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3989
3990 Element Documentation:
3991
3992 |**Name**|**Type**|**Documentation**
3993 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
3994 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3995 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
3996 |Parent|//com: LocalOrganisationRef erenceBaseType//|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.
3997 |Contact|ContactType|Contact describes a contact for the organisation,
3998
3999 **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 version, and is never final. 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.
4000
4001 Derivation:
4002
4003 //com:AnnotableType// (extension)
4004 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4005 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
4006 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
4007 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
4008 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
4009 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)
4010 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeBaseType// (extension)
4011 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeType// (restriction)
4012 [[image:inherit.gif||height="9" width="9"]] AgencySchemeType
4013
4014 Attributes:
4015
4016 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
4017
4018 Content:
4019
4020 com:Annotations?, com:Name+, com:Description*, Agency*
4021
4022 Attribute Documentation:
4023
4024 |**Name**|**Type**|**Documentation**
4025 |id (fixed: AGENCIES)|com:IDType|The id is the identifier for the object.
4026 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4027 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4028 |version (fixed: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
4029 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4030 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4031 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4032 |isFinal (fixed: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
4033 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4034 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4035 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4036 |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 key family in the context of a constraint.
4037
4038 Element Documentation:
4039
4040 |**Name**|**Type**|**Documentation**
4041 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4042 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4043 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4044 |Agency|AgencyType|Agency is an organisation which maintains structural metadata such as statistical classifications, glossaries, key family structural definitions, and metadata structure definitions..
4045
4046 **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 version, and is never final. 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.
4047
4048 Derivation:
4049
4050 //com:AnnotableType// (extension)
4051 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4052 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
4053 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
4054 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
4055 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
4056 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)
4057 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeBaseType// (extension)
4058 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeType// (restriction)
4059 [[image:inherit.gif||height="9" width="9"]] DataConsumerSchemeType
4060
4061 Attributes:
4062
4063 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
4064
4065 Content:
4066
4067 com:Annotations?, com:Name+, com:Description*, DataConsumer*
4068
4069 Attribute Documentation:
4070
4071 |**Name**|**Type**|**Documentation**
4072 |id (fixed: DATA_CONSUMERS)|com:IDType|The id is the identifier for the object.
4073 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4074 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4075 |version (fixed: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
4076 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4077 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4078 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4079 |isFinal (fixed: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
4080 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4081 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4082 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4083 |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 key family in the context of a constraint.
4084
4085 Element Documentation:
4086
4087 |**Name**|**Type**|**Documentation**
4088 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4089 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4090 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4091 |DataConsumer|DataConsumerType|DataConsumer describes an organisation using data as input for further processing.
4092
4093 **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 version, and is never final. 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
4094
4095 Derivation:
4096
4097 //com:AnnotableType// (extension)
4098 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4099 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
4100 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
4101 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
4102 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
4103 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)
4104 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeBaseType// (extension)
4105 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeType// (restriction)
4106 [[image:inherit.gif||height="9" width="9"]] DataProviderSchemeType
4107
4108 Attributes:
4109
4110 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
4111
4112 Content:
4113
4114 com:Annotations?, com:Name+, com:Description*, DataProvider*
4115
4116 Attribute Documentation:
4117
4118 |**Name**|**Type**|**Documentation**
4119 |id (fixed: DATA_PROVIDERS)|com:IDType|The id is the identifier for the object.
4120 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4121 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4122 |version (fixed: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
4123 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4124 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4125 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4126 |isFinal (fixed: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
4127 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4128 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4129 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4130 |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 key family in the context of a constraint.
4131
4132 Element Documentation:
4133
4134 |**Name**|**Type**|**Documentation**
4135 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4136 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4137 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4138 |DataProvider|DataProviderType|DataProvider describes an organisation that produces data or reference metadata.
4139
4140 **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.
4141
4142 Derivation:
4143
4144 //com:AnnotableType// (extension)
4145 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4146 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
4147 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
4148 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
4149 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
4150 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)
4151 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeBaseType// (extension)
4152 [[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeType// (restriction)
4153 [[image:inherit.gif||height="9" width="9"]] OrganisationUnitSchemeType
4154
4155 Attributes:
4156
4157 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
4158
4159 Content:
4160
4161 com:Annotations?, com:Name+, com:Description*, OrganisationUnit*
4162
4163 Attribute Documentation:
4164
4165 |**Name**|**Type**|**Documentation**
4166 |id|com:IDType|The id is the identifier for the object.
4167 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4168 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4169 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
4170 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4171 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4172 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4173 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
4174 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4175 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4176 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4177 |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 key family in the context of a constraint.
4178
4179 Element Documentation:
4180
4181 |**Name**|**Type**|**Documentation**
4182 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4183 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4184 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4185 |OrganisationUnit|OrganisationUnitType|OrganisationUnit describes a generic organisation, which serves not predefined role in SDMX.
4186
4187 **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.
4188
4189 Derivation:
4190
4191 //com:AnnotableType// (extension)
4192 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4193 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
4194 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
4195 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
4196 [[image:inherit.gif||height="9" width="9"]] //BaseOrganisationType// (extension)
4197 [[image:inherit.gif||height="9" width="9"]] //OrganisationType// (restriction)
4198 [[image:inherit.gif||height="9" width="9"]] AgencyType
4199
4200 Attributes:
4201
4202 id, urn?, uri?
4203
4204 Content:
4205
4206 com:Annotations?, com:Name+, com:Description*, Contact*
4207
4208 Attribute Documentation:
4209
4210 |**Name**|**Type**|**Documentation**
4211 |id|com: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).
4212 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4213 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4214
4215 Element Documentation:
4216
4217 |**Name**|**Type**|**Documentation**
4218 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4219 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4220 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4221 |Contact|ContactType|Contact describes a contact for the organisation,
4222
4223 **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.
4224
4225 Derivation:
4226
4227 //com:AnnotableType// (extension)
4228 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4229 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
4230 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
4231 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
4232 [[image:inherit.gif||height="9" width="9"]] //BaseOrganisationType// (extension)
4233 [[image:inherit.gif||height="9" width="9"]] //OrganisationType// (restriction)
4234 [[image:inherit.gif||height="9" width="9"]] DataConsumerType
4235
4236 Attributes:
4237
4238 id, urn?, uri?
4239
4240 Content:
4241
4242 com:Annotations?, com:Name+, com:Description*, Contact*
4243
4244 Attribute Documentation:
4245
4246 |**Name**|**Type**|**Documentation**
4247 |id|com:IDType|The id is the identifier for the object.
4248 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4249 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4250
4251 Element Documentation:
4252
4253 |**Name**|**Type**|**Documentation**
4254 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4255 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4256 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4257 |Contact|ContactType|Contact describes a contact for the organisation,
4258
4259 **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.
4260
4261 Derivation:
4262
4263 //com:AnnotableType// (extension)
4264 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4265 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
4266 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
4267 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
4268 [[image:inherit.gif||height="9" width="9"]] //BaseOrganisationType// (extension)
4269 [[image:inherit.gif||height="9" width="9"]] //OrganisationType// (restriction)
4270 [[image:inherit.gif||height="9" width="9"]] DataProviderType
4271
4272 Attributes:
4273
4274 id, urn?, uri?
4275
4276 Content:
4277
4278 com:Annotations?, com:Name+, com:Description*, Contact*
4279
4280 Attribute Documentation:
4281
4282 |**Name**|**Type**|**Documentation**
4283 |id|com:IDType|The id is the identifier for the object.
4284 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4285 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4286
4287 Element Documentation:
4288
4289 |**Name**|**Type**|**Documentation**
4290 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4291 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4292 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4293 |Contact|ContactType|Contact describes a contact for the organisation,
4294
4295 **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.
4296
4297 Derivation:
4298
4299 //com:AnnotableType// (extension)
4300 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4301 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
4302 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
4303 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
4304 [[image:inherit.gif||height="9" width="9"]] //BaseOrganisationType// (extension)
4305 [[image:inherit.gif||height="9" width="9"]] //OrganisationType// (restriction)
4306 [[image:inherit.gif||height="9" width="9"]] OrganisationUnitType
4307
4308 Attributes:
4309
4310 id, urn?, uri?
4311
4312 Content:
4313
4314 com:Annotations?, com:Name+, com:Description*, Parent?, Contact*
4315
4316 Attribute Documentation:
4317
4318 |**Name**|**Type**|**Documentation**
4319 |id|com:IDType|The id is the identifier for the object.
4320 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4321 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4322
4323 Element Documentation:
4324
4325 |**Name**|**Type**|**Documentation**
4326 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4327 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4328 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4329 |Parent|com: LocalOrganisationUni tReferenceType|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.
4330 |Contact|ContactType|Contact describes a contact for the organisation,
4331
4332 **ContactType: **ContactType describes the structure of a contact's details.
4333
4334 Attributes:
4335
4336 id?
4337
4338 Content:
4339
4340 com:Name*, Department*, Role*, (Telephone | Fax | X400 | URI | Email)*
4341
4342 Attribute Documentation:
4343
4344 |**Name**|**Type**|**Documentation**
4345 |id|com:IDType|The id attribute is used to carry user id information for the contact.
4346
4347 Element Documentation:
4348
4349 |**Name**|**Type**|**Documentation**
4350 |com:Name|com:TextType|Name is a reusable element, used for providing a human-readable name for an object.
4351 |Department|com:TextType|Department is designation of the organisational structure by a linguistic expression, within which the contact person works.
4352 |Role|com:TextType|Role is the responsibility of the contact person with respect to the object for which this person is the contact.
4353 |Telephone|xs:string|Telephone holds the telephone number for the contact person.
4354 |Fax|xs:string|Fax holds the fax number for the contact person.
4355 |X400|xs:string|X400 holds the X.400 address for the contact person.
4356 |URI|xs:anyURI|URI holds an information URL for the contact person.
4357 |Email|xs:string|Email holds the email address for the contact person.
4358
4359 **ProvisionAgreementType: **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.
4360
4361 Derivation:
4362
4363 //com:AnnotableType// (extension)
4364 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4365 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
4366 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
4367 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
4368 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
4369 [[image:inherit.gif||height="9" width="9"]] ProvisionAgreementType
4370
4371 Attributes:
4372
4373 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
4374
4375 Content:
4376
4377 com:Annotations?, com:Name+, com:Description*, StructureUsage, DataProvider
4378
4379 Attribute Documentation:
4380
4381 |**Name**|**Type**|**Documentation**
4382 |id|com:IDType|The id is the identifier for the object.
4383 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4384 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4385 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
4386 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4387 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4388 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4389 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
4390 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4391 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4392 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4393
4394 Element Documentation:
4395
4396 |**Name**|**Type**|**Documentation**
4397 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4398 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4399 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4400 |StructureUsage|com: StructureUsageRefere nceType|DataflowReference provides a reference to a pre-existing structure usage (i.e. a dataflow or metadataflow) in the registry. The reference is provided via a URN and/or a full set of reference fields.
4401 |DataProvider|com: DataProviderReferenc eType|DataProvider provides a reference to a pre-existing data (or metadata) provider in the registry. The reference is provided via a URN and/or a full set of reference fields.
4402
4403 **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.
4404
4405 Derivation:
4406
4407 //com:AnnotableType// (extension)
4408 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4409 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
4410 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
4411 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
4412 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
4413 [[image:inherit.gif||height="9" width="9"]] ProcessType
4414
4415 Attributes:
4416
4417 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
4418
4419 Content:
4420
4421 com:Annotations?, com:Name+, com:Description*, ProcessStep*
4422
4423 Attribute Documentation:
4424
4425 |**Name**|**Type**|**Documentation**
4426 |id|com:IDType|The id is the identifier for the object.
4427 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4428 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4429 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
4430 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4431 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4432 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4433 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
4434 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4435 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4436 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4437
4438 Element Documentation:
4439
4440 |**Name**|**Type**|**Documentation**
4441 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4442 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4443 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4444 |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.
4445
4446 //**ProcessStepBaseType**//**: **ProcessStepBaseType is an abstract base type used as the basis for the ProcessStepType.
4447
4448 Derivation:
4449
4450 //com:AnnotableType// (extension)
4451 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4452 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
4453 [[image:inherit.gif||height="9" width="9"]] //ProcessStepBaseType//
4454
4455 Attributes:
4456
4457 id, urn?, uri?
4458
4459 Content:
4460
4461 com:Annotations?, com:Name+, com:Description*
4462
4463 Attribute Documentation:
4464
4465 |**Name**|**Type**|**Documentation**
4466 |id|com:IDType|The id is the identifier for the object.
4467 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4468 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4469
4470 Element Documentation:
4471
4472 |**Name**|**Type**|**Documentation**
4473 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4474 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4475 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4476
4477 **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.
4478
4479 Derivation:
4480
4481 //com:AnnotableType// (extension)
4482 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4483 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
4484 [[image:inherit.gif||height="9" width="9"]] //ProcessStepBaseType// (extension)
4485 [[image:inherit.gif||height="9" width="9"]] ProcessStepType
4486
4487 Attributes:
4488
4489 id, urn?, uri?
4490
4491 Content:
4492
4493 com:Annotations?, com:Name+, com:Description*, Input*, Output*, Computation?, Transition*, ProcessStep*
4494
4495 Attribute Documentation:
4496
4497 |**Name**|**Type**|**Documentation**
4498 |id|com:IDType|The id is the identifier for the object.
4499 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4500 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4501
4502 Element Documentation:
4503
4504 |**Name**|**Type**|**Documentation**
4505 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4506 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4507 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4508 |Input|InputOutputType|Input references an object which is an input to the process step.
4509 |Output|InputOutputType|Output references an object which is an output form the process step.
4510 |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.
4511 |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.
4512 |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.
4513
4514 **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.
4515
4516 Derivation:
4517
4518 //com:AnnotableType// (extension)
4519 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4520 [[image:inherit.gif||height="9" width="9"]] TransitionType
4521
4522 Attributes:
4523
4524 id?, urn?, uri?, localID?
4525
4526 Content:
4527
4528 com:Annotations?, TargetStep, Condition+
4529
4530 Attribute Documentation:
4531
4532 |**Name**|**Type**|**Documentation**
4533 |id|com:IDType|The id is the identifier for the object.
4534 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4535 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4536 |localID|com:IDType|The localID attribute is an optional identification for the transition within the process.
4537
4538 Element Documentation:
4539
4540 |**Name**|**Type**|**Documentation**
4541 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4542 |TargetStep|com: LocalProcessStepRefe renceType|TargetStep references a process step within the process that should be transitioned to, should the conditions described be met.
4543 |Condition|com: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.
4544
4545 **ComputationType: **ComputationType describes a computation in a process.
4546
4547 Derivation:
4548
4549 //com:AnnotableType// (extension)
4550 [[image:inherit.gif||height="9" width="9"]] ComputationType
4551
4552 Attributes:
4553
4554 localID?, softwarePackage?, softwareLanguage?, softwareVersion?
4555
4556 Content:
4557
4558 com:Annotations?, com:Description+
4559
4560 Attribute Documentation:
4561
4562 |**Name**|**Type**|**Documentation**
4563 |localID|com:IDType|The localID attribute is an optional identification for the computation within the process.
4564 |softwarePackage|xs:string|The softwarePackage attribute holds the name of the software package that is used to perform the computation.
4565 |softwareLanguage|xs:string|The softwareLanguage attribute holds the coding language that the software package used to perform the computation is written in.
4566 |softwareVersion|xs:string|The softwareVersion attribute hold the version of the software package that is used to perform that computation.
4567
4568 Element Documentation:
4569
4570 |**Name**|**Type**|**Documentation**
4571 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4572 |com:Description|com: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,
4573
4574 **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.
4575
4576 Derivation:
4577
4578 //com:AnnotableType// (extension)
4579 [[image:inherit.gif||height="9" width="9"]] InputOutputType
4580
4581 Attributes:
4582
4583 localID?
4584
4585 Content:
4586
4587 com:Annotations?, ObjectReference
4588
4589 Attribute Documentation:
4590
4591 |**Name**|**Type**|**Documentation**
4592 |localID|com:IDType|The localID attribute is an optional identification for the input or output within the process.
4593
4594 Element Documentation:
4595
4596 |**Name**|**Type**|**Documentation**
4597 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4598 |ObjectReference|com: ObjectReferenceType|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.
4599
4600 **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.
4601
4602 Derivation:
4603
4604 //com:AnnotableType// (extension)
4605 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4606 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
4607 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
4608 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
4609 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
4610 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)
4611 [[image:inherit.gif||height="9" width="9"]] ReportingTaxonomyType
4612
4613 Attributes:
4614
4615 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
4616
4617 Content:
4618
4619 com:Annotations?, com:Name+, com:Description*, ReportingCategory*
4620
4621 Attribute Documentation:
4622
4623 |**Name**|**Type**|**Documentation**
4624 |id|com:IDType|The id is the identifier for the object.
4625 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4626 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4627 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
4628 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4629 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4630 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4631 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
4632 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4633 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4634 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4635 |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 key family in the context of a constraint.
4636
4637 Element Documentation:
4638
4639 |**Name**|**Type**|**Documentation**
4640 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4641 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4642 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4643 |ReportingCategory|ReportingCategoryTyp e|ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages.
4644
4645 //**ReportingCategoryBaseType**//**: **ReportingCategoryBaseType is an abstract base type that serves as the basis for the ReportingCategoryType.
4646
4647 Derivation:
4648
4649 //com:AnnotableType// (extension)
4650 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4651 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
4652 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
4653 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
4654 [[image:inherit.gif||height="9" width="9"]] //ReportingCategoryBaseType//
4655
4656 Attributes:
4657
4658 id, urn?, uri?
4659
4660 Content:
4661
4662 com:Annotations?, com:Name+, com:Description*, ReportingCategory*
4663
4664 Attribute Documentation:
4665
4666 |**Name**|**Type**|**Documentation**
4667 |id|com:IDType|The id is the identifier for the object.
4668 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4669 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4670
4671 Element Documentation:
4672
4673 |**Name**|**Type**|**Documentation**
4674 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4675 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4676 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4677 |ReportingCategory|ReportingCategoryTyp e|ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages.
4678
4679 **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.
4680
4681 Derivation:
4682
4683 //com:AnnotableType// (extension)
4684 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4685 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
4686 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
4687 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
4688 [[image:inherit.gif||height="9" width="9"]] //ReportingCategoryBaseType// (extension)
4689 [[image:inherit.gif||height="9" width="9"]] ReportingCategoryType
4690
4691 Attributes:
4692
4693 id, urn?, uri?
4694
4695 Content:
4696
4697 com:Annotations?, com:Name+, com:Description*, ReportingCategory*, (StructuralMetadata* | ProvisioningMetadata*)
4698
4699 Attribute Documentation:
4700
4701 |**Name**|**Type**|**Documentation**
4702 |id|com:IDType|The id is the identifier for the object.
4703 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4704 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4705
4706 Element Documentation:
4707
4708 |**Name**|**Type**|**Documentation**
4709 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4710 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4711 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4712 |ReportingCategory|ReportingCategoryTyp e|ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages.
4713 |StructuralMetadata|com: 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.
4714 |ProvisioningMetadata|com: 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.
4715
4716 //**StructureSetBaseType**//**: **StructureSetBaseType is an abstract base type that forms the basis for the StructureSetType.
4717
4718 Derivation:
4719
4720 //com:AnnotableType// (extension)
4721 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4722 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
4723 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
4724 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
4725 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)
4726 [[image:inherit.gif||height="9" width="9"]] //StructureSetBaseType//
4727
4728 Attributes:
4729
4730 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
4731
4732 Content:
4733
4734 com:Annotations?, com:Name+, com:Description*
4735
4736 Attribute Documentation:
4737
4738 |**Name**|**Type**|**Documentation**
4739 |id|com:IDType|The id is the identifier for the object.
4740 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4741 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4742 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
4743 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4744 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4745 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4746 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
4747 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4748 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4749 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4750
4751 Element Documentation:
4752
4753 |**Name**|**Type**|**Documentation**
4754 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4755 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4756 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4757
4758 **StructureSetType: **StructureSetType describes the structure of a structure set. It allows components in one structure, structure usage, or item scheme to be mapped to components in another structural component of the same type.
4759
4760 Derivation:
4761
4762 //com:AnnotableType// (extension)
4763 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4764 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
4765 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
4766 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
4767 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)
4768 [[image:inherit.gif||height="9" width="9"]] //StructureSetBaseType// (extension)
4769 [[image:inherit.gif||height="9" width="9"]] StructureSetType
4770
4771 Attributes:
4772
4773 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
4774
4775 Content:
4776
4777 com:Annotations?, com:Name+, com:Description*, RelatedStructure*, (OrganisationSchemeMap | CategorySchemeMap | CodelistMap | ConceptSchemeMap | ReportingTaxonomyMap | HybridCodelistMap | StructureMap)*
4778
4779 Attribute Documentation:
4780
4781 |**Name**|**Type**|**Documentation**
4782 |id|com:IDType|The id is the identifier for the object.
4783 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4784 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4785 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
4786 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4787 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4788 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4789 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
4790 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4791 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4792 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4793
4794 Element Documentation:
4795
4796 |**Name**|**Type**|**Documentation**
4797 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4798 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4799 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4800 |RelatedStructure|com: StructureOrUsageRefe renceType|RelatedStructures contains references to structures (key families and metadata structure definitions) and structure usages (data flows and metadata flows) to indicate that a semantic relationship exist between them. The details of these relationships can be found in the structure maps.
4801 |OrganisationSchemeMa p|OrganisationSchemeMa pType|OrganisationSchemeMap links a source and target organisations from different schemes where there is a semantic equivalence between them. Organisations are mapped without regard to role.
4802 |CategorySchemeMap|CategorySchemeMapTyp e|CategorySchemeMap links a source and target categories from different schemes where there is a semantic equivalence between them.
4803 |CodelistMap|CodelistMapType|CodelistMap links a source and target codes from different lists where there is a semantic equivalence between them.
4804 |ConceptSchemeMap|ConceptSchemeMapType|ConceptSchemeMap links a source and target concepts from different schemes where there is a semantic equivalence between them.
4805 |ReportingTaxonomyMap|ReportingTaxonomyMap Type|ReportingTaxonomyMap links a source and target reporting categories from different taxonomies where there is a semantic equivalence between them.
4806 |HybridCodelistMap|HybridCodelistMapTyp e|HybridCodelistMap links a source and target codes from different codelists, which may be hierarchical or flat, where there is a semantic equivalence between them.
4807 |StructureMap|StructureMapType|StructureMap maps components from one structure to components to another structure, and can describe how the value of the components are related.
4808
4809 //**ItemSchemeMapBaseType**//**: **ItemSchemeMapBaseType is an abstract base type which forms the basis for the ItemSchemeMapType.
4810
4811 Derivation:
4812
4813 //com:AnnotableType// (extension)
4814 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4815 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
4816 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapBaseType//
4817
4818 Attributes:
4819
4820 id, urn?, uri?
4821
4822 Content:
4823
4824 com:Annotations?, com:Name+, com:Description*
4825
4826 Attribute Documentation:
4827
4828 |**Name**|**Type**|**Documentation**
4829 |id|com:IDType|The id is the identifier for the object.
4830 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4831 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4832
4833 Element Documentation:
4834
4835 |**Name**|**Type**|**Documentation**
4836 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4837 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4838 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4839
4840 //**ItemSchemeMapType**//**: **ItemSchemeMapType is an abstract base type which forms the basis for mapping items between item schemes of the same type.
4841
4842 Derivation:
4843
4844 //com:AnnotableType// (extension)
4845 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4846 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
4847 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapBaseType// (extension)
4848 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapType//
4849
4850 Attributes:
4851
4852 id, urn?, uri?
4853
4854 Content:
4855
4856 com:Annotations?, com:Name+, com:Description*, Source, Target, //ItemAssociation+//
4857
4858 Attribute Documentation:
4859
4860 |**Name**|**Type**|**Documentation**
4861 |id|com:IDType|The id is the identifier for the object.
4862 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4863 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4864
4865 Element Documentation:
4866
4867 |**Name**|**Type**|**Documentation**
4868 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4869 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4870 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4871 |Source|//com: ItemSchemeReferenceB aseType//|Source provides a reference to the item scheme which items are mapped from.
4872 |Target|//com: ItemSchemeReferenceB aseType//|Target provides a reference to the item scheme which items are mapped to.
4873 |//ItemAssociation//|//ItemAssociationType//|ItemAssociation is an abstract description of the relation between two items for the purpose of mapping.
4874
4875 //**ItemAssociationType**//**: **ItemAssociationType is an abstract type which defines the relationship between two items from the source and target item schemes of an item scheme map.
4876
4877 Derivation:
4878
4879 //com:AnnotableType// (extension)
4880 [[image:inherit.gif||height="9" width="9"]] //ItemAssociationType//
4881
4882 Content:
4883
4884 com:Annotations?, Source, Target
4885
4886 Element Documentation:
4887
4888 |**Name**|**Type**|**Documentation**
4889 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4890 |Source|//com: LocalItemReferenceTy pe//|Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item.
4891 |Target|//com: LocalItemReferenceTy pe//|Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item.
4892
4893 **OrganisationSchemeMapType: **OrganisationSchemeMapType defines the structure of a map which identifies relationships between organisations in different organisation schemes.
4894
4895 Derivation:
4896
4897 //com:AnnotableType// (extension)
4898 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4899 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
4900 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapBaseType// (extension)
4901 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapType// (restriction)
4902 [[image:inherit.gif||height="9" width="9"]] OrganisationSchemeMapType
4903
4904 Attributes:
4905
4906 id, urn?, uri?
4907
4908 Content:
4909
4910 com:Annotations?, com:Name+, com:Description*, Source, Target, OrganisationMap+
4911
4912 Attribute Documentation:
4913
4914 |**Name**|**Type**|**Documentation**
4915 |id|com:IDType|The id is the identifier for the object.
4916 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4917 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4918
4919 Element Documentation:
4920
4921 |**Name**|**Type**|**Documentation**
4922 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4923 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4924 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4925 |Source|com: OrganisationSchemeRe ferenceType|Source provides a reference to the item scheme which items are mapped from.
4926 |Target|com: OrganisationSchemeRe ferenceType|Target provides a reference to the item scheme which items are mapped to.
4927 |OrganisationMap|OrganisationMapType|OrganisationMap relates a source organisation to a target organisation.
4928
4929 **OrganisationMapType: **OrganisationMapType defines the structure for mapping two organisations. A local reference is provided both the source and target organisation.
4930
4931 Derivation:
4932
4933 //com:AnnotableType// (extension)
4934 [[image:inherit.gif||height="9" width="9"]] //ItemAssociationType// (restriction)
4935 [[image:inherit.gif||height="9" width="9"]] OrganisationMapType
4936
4937 Content:
4938
4939 com:Annotations?, Source, Target
4940
4941 Element Documentation:
4942
4943 |**Name**|**Type**|**Documentation**
4944 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4945 |Source|com: LocalOrganisationRef erenceType|Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item.
4946 |Target|com: LocalOrganisationRef erenceType|Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item.
4947
4948 **CategorySchemeMapType: **CategorySchemeMapType defines the structure of a map which identifies relationships between categories in different category schemes.
4949
4950 Derivation:
4951
4952 //com:AnnotableType// (extension)
4953 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
4954 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
4955 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapBaseType// (extension)
4956 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapType// (restriction)
4957 [[image:inherit.gif||height="9" width="9"]] CategorySchemeMapType
4958
4959 Attributes:
4960
4961 id, urn?, uri?
4962
4963 Content:
4964
4965 com:Annotations?, com:Name+, com:Description*, Source, Target, CategoryMap+
4966
4967 Attribute Documentation:
4968
4969 |**Name**|**Type**|**Documentation**
4970 |id|com:IDType|The id is the identifier for the object.
4971 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4972 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4973
4974 Element Documentation:
4975
4976 |**Name**|**Type**|**Documentation**
4977 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
4978 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4979 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
4980 |Source|com: CategorySchemeRefere nceType|Source provides a reference to the item scheme which items are mapped from.
4981 |Target|com: CategorySchemeRefere nceType|Target provides a reference to the item scheme which items are mapped to.
4982 |CategoryMap|CategoryMapType|CategoryMap defines the structure of a map which identifies relationships between categories in different category schemes.
4983
4984 **CategoryMapType: **CategoryMapType defines the structure for mapping two categories. A local reference is provided both the source and target category.
4985
4986 Derivation:
4987
4988 //com:AnnotableType// (extension)
4989 [[image:inherit.gif||height="9" width="9"]] //ItemAssociationType// (restriction)
4990 [[image:inherit.gif||height="9" width="9"]] CategoryMapType
4991
4992 Content:
4993
4994 com:Annotations?, Source, Target
4995
4996 Element Documentation:
4997
4998 |**Name**|**Type**|**Documentation**
4999 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5000 |Source|com: LocalCategoryReferen ceType|Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item.
5001 |Target|com: LocalCategoryReferen ceType|Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item.
5002
5003 **CodelistMapType: **CodelistMapType defines the structure of a map which identifies relationships between codes in different codelists.
5004
5005 Derivation:
5006
5007 //com:AnnotableType// (extension)
5008 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5009 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
5010 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapBaseType// (extension)
5011 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapType// (restriction)
5012 [[image:inherit.gif||height="9" width="9"]] CodelistMapType
5013
5014 Attributes:
5015
5016 id, urn?, uri?
5017
5018 Content:
5019
5020 com:Annotations?, com:Name+, com:Description*, Source, Target, CodeMap+
5021
5022 Attribute Documentation:
5023
5024 |**Name**|**Type**|**Documentation**
5025 |id|com:IDType|The id is the identifier for the object.
5026 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5027 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5028
5029 Element Documentation:
5030
5031 |**Name**|**Type**|**Documentation**
5032 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5033 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5034 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5035 |Source|com: CodelistReferenceTyp e|Source provides a reference to the item scheme which items are mapped from.
5036 |Target|com: CodelistReferenceTyp e|Target provides a reference to the item scheme which items are mapped to.
5037 |CodeMap|CodeMapType|CodeMap defines the structure of a map which identifies relationships between codes in different codelists.
5038
5039 **CodeMapType: **CodeMapType defines the structure for mapping two codes. A local reference is provided both the source and target code.
5040
5041 Derivation:
5042
5043 //com:AnnotableType// (extension)
5044 [[image:inherit.gif||height="9" width="9"]] //ItemAssociationType// (restriction)
5045 [[image:inherit.gif||height="9" width="9"]] CodeMapType
5046
5047 Content:
5048
5049 com:Annotations?, Source, Target
5050
5051 Element Documentation:
5052
5053 |**Name**|**Type**|**Documentation**
5054 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5055 |Source|com: LocalCodeReferenceTy pe|Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item.
5056 |Target|com: LocalCodeReferenceTy pe|Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item.
5057
5058 **ConceptSchemeMapType: **ConceptSchemeMapType defines the structure of a map which identifies relationships between concepts in different concept schemes.
5059
5060 Derivation:
5061
5062 //com:AnnotableType// (extension)
5063 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5064 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
5065 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapBaseType// (extension)
5066 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapType// (restriction)
5067 [[image:inherit.gif||height="9" width="9"]] ConceptSchemeMapType
5068
5069 Attributes:
5070
5071 id, urn?, uri?
5072
5073 Content:
5074
5075 com:Annotations?, com:Name+, com:Description*, Source, Target, ConceptMap+
5076
5077 Attribute Documentation:
5078
5079 |**Name**|**Type**|**Documentation**
5080 |id|com:IDType|The id is the identifier for the object.
5081 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5082 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5083
5084 Element Documentation:
5085
5086 |**Name**|**Type**|**Documentation**
5087 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5088 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5089 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5090 |Source|com: ConceptSchemeReferen ceType|Source provides a reference to the item scheme which items are mapped from.
5091 |Target|com: ConceptSchemeReferen ceType|Target provides a reference to the item scheme which items are mapped to.
5092 |ConceptMap|ConceptMapType|ConceptMap defines the structure of a map which identifies relationships between concepts in different concept schemes.
5093
5094 **ConceptMapType: **ConceptMapType defines the structure for mapping two concepts. A local reference is provided both the source and target concept.
5095
5096 Derivation:
5097
5098 //com:AnnotableType// (extension)
5099 [[image:inherit.gif||height="9" width="9"]] //ItemAssociationType// (restriction)
5100 [[image:inherit.gif||height="9" width="9"]] ConceptMapType
5101
5102 Content:
5103
5104 com:Annotations?, Source, Target
5105
5106 Element Documentation:
5107
5108 |**Name**|**Type**|**Documentation**
5109 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5110 |Source|com: LocalConceptReferenc eType|Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item.
5111 |Target|com: LocalConceptReferenc eType|Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item.
5112
5113 **ReportingTaxonomyMapType: **ReportingTaxonomyMapType defines the structure of a map which identifies relationships between reporting categories in different reporting taxonomies.
5114
5115 Derivation:
5116
5117 //com:AnnotableType// (extension)
5118 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5119 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
5120 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapBaseType// (extension)
5121 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapType// (restriction)
5122 [[image:inherit.gif||height="9" width="9"]] ReportingTaxonomyMapType
5123
5124 Attributes:
5125
5126 id, urn?, uri?
5127
5128 Content:
5129
5130 com:Annotations?, com:Name+, com:Description*, Source, Target, ReportingCategoryMap+
5131
5132 Attribute Documentation:
5133
5134 |**Name**|**Type**|**Documentation**
5135 |id|com:IDType|The id is the identifier for the object.
5136 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5137 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5138
5139 Element Documentation:
5140
5141 |**Name**|**Type**|**Documentation**
5142 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5143 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5144 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5145 |Source|com: ReportingTaxonomyRef erenceType|Source provides a reference to the item scheme which items are mapped from.
5146 |Target|com: ReportingTaxonomyRef erenceType|Target provides a reference to the item scheme which items are mapped to.
5147 |ReportingCategoryMap|ReportingCategoryMap Type|ReportingCategoryMap defines the structure of a map which identifies relationships between reporting categories in different reporting taxonomies.
5148
5149 **ReportingCategoryMapType: **ReportingCategoryMapType defines the structure for mapping two reporting categories. A local reference is provided both the source and target category.
5150
5151 Derivation:
5152
5153 //com:AnnotableType// (extension)
5154 [[image:inherit.gif||height="9" width="9"]] //ItemAssociationType// (restriction)
5155 [[image:inherit.gif||height="9" width="9"]] ReportingCategoryMapType
5156
5157 Content:
5158
5159 com:Annotations?, Source, Target
5160
5161 Element Documentation:
5162
5163 |**Name**|**Type**|**Documentation**
5164 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5165 |Source|com: LocalReportingCatego ryReferenceType|Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item.
5166 |Target|com: LocalReportingCatego ryReferenceType|Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item.
5167
5168 //**HybridCodelistMapBaseType**//**: **HybridCodelistMapBaseType is an abstract base type which forms the basis for the HybridCodelistMapType.
5169
5170 Derivation:
5171
5172 //com:AnnotableType// (extension)
5173 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5174 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
5175 [[image:inherit.gif||height="9" width="9"]] //HybridCodelistMapBaseType//
5176
5177 Attributes:
5178
5179 id, urn?, uri?
5180
5181 Content:
5182
5183 com:Annotations?, com:Name+, com:Description*
5184
5185 Attribute Documentation:
5186
5187 |**Name**|**Type**|**Documentation**
5188 |id|com:IDType|The id is the identifier for the object.
5189 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5190 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5191
5192 Element Documentation:
5193
5194 |**Name**|**Type**|**Documentation**
5195 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5196 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5197 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5198
5199 **HybridCodelistMapType: **HybridCodelistMapType defines the structure of a map which relates codes (possibly hierarchical) from different code lists.
5200
5201 Derivation:
5202
5203 //com:AnnotableType// (extension)
5204 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5205 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
5206 [[image:inherit.gif||height="9" width="9"]] //HybridCodelistMapBaseType// (extension)
5207 [[image:inherit.gif||height="9" width="9"]] HybridCodelistMapType
5208
5209 Attributes:
5210
5211 id, urn?, uri?
5212
5213 Content:
5214
5215 com:Annotations?, com:Name+, com:Description*, Source, Target, HybridCodeMap+
5216
5217 Attribute Documentation:
5218
5219 |**Name**|**Type**|**Documentation**
5220 |id|com:IDType|The id is the identifier for the object.
5221 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5222 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5223
5224 Element Documentation:
5225
5226 |**Name**|**Type**|**Documentation**
5227 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5228 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5229 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5230 |Source|com: AnyCodelistReference Type|Source provides a reference to either a codelist or a hierarchical codelist, from which the codes are to be mapped.
5231 |Target|com: AnyCodelistReference Type|Target provides a reference to either a codelist or a hierarchical codelist, to which the source codes are to be mapped.
5232 |HybridCodeMap|HybridCodeMapType|HybridCodeMap defines the relationship of a code in the source list to code in the target list.
5233
5234 **HybridCodeMapType: **CodeMapType defines the structure for associating a code from a source codelist to a code in a target codelist. Note that either of these may come from a hierarchical codelist.
5235
5236 Derivation:
5237
5238 //com:AnnotableType// (extension)
5239 [[image:inherit.gif||height="9" width="9"]] HybridCodeMapType
5240
5241 Content:
5242
5243 com:Annotations?, Source, Target
5244
5245 Element Documentation:
5246
5247 |**Name**|**Type**|**Documentation**
5248 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5249 |Source|com: AnyLocalCodeReferenc eType|Source provides a local reference to the code which is to be mapped. If this code is from a hierarchical codelist, a reference to the hierarchy in which it is defined must also be provided.
5250 |Target|com: AnyLocalCodeReferenc eType|Target provides a local reference to the code to which the source code is mapped. If this code is from a hierarchical codelist, a reference to the hierarchy in which it is defined must also be provided.
5251
5252 //**StructureMapBaseType**//**: **StructureMapBaseType is an abstract base type which forms the basis for the StructureMapType.
5253
5254 Derivation:
5255
5256 //com:AnnotableType// (extension)
5257 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5258 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
5259 [[image:inherit.gif||height="9" width="9"]] //StructureMapBaseType//
5260
5261 Attributes:
5262
5263 id, urn?, uri?
5264
5265 Content:
5266
5267 com:Annotations?, com:Name+, com:Description*
5268
5269 Attribute Documentation:
5270
5271 |**Name**|**Type**|**Documentation**
5272 |id|com:IDType|The id is the identifier for the object.
5273 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5274 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5275
5276 Element Documentation:
5277
5278 |**Name**|**Type**|**Documentation**
5279 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5280 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5281 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5282
5283 **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 key family A to C and a map from key family B to C could be used to infer a relation between key family A to C.
5284
5285 Derivation:
5286
5287 //com:AnnotableType// (extension)
5288 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5289 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
5290 [[image:inherit.gif||height="9" width="9"]] //StructureMapBaseType// (extension)
5291 [[image:inherit.gif||height="9" width="9"]] StructureMapType
5292
5293 Attributes:
5294
5295 id, urn?, uri?, isExtension?
5296
5297 Content:
5298
5299 com:Annotations?, com:Name+, com:Description*, Source, Target, ComponentMap+
5300
5301 Attribute Documentation:
5302
5303 |**Name**|**Type**|**Documentation**
5304 |id|com:IDType|The id is the identifier for the object.
5305 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5306 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5307 |isExtension (default: false)|xs:boolean|The isExtension attribute, when true, indicates that the target structure definition inherits all properties of the referenced structure definition, and may have additional components. Note that this attribute may only be set to true if the structure map has a source structure and a target structure of either two key families or two metadata structure definitions. It is not possible inherit the underlying concepts of components between the two type of structures using this mechanism.
5308
5309 Element Documentation:
5310
5311 |**Name**|**Type**|**Documentation**
5312 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5313 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5314 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5315 |Source|com: 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.
5316 |Target|com: 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.
5317 |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.
5318
5319 **ComponentMapType: **ComponentMapType defines the structure for relating a component in a source structure to a component in a target structure.
5320
5321 Derivation:
5322
5323 //com:AnnotableType// (extension)
5324 [[image:inherit.gif||height="9" width="9"]] ComponentMapType
5325
5326 Content:
5327
5328 com:Annotations?, Source, Target, RepresentationMapping?
5329
5330 Element Documentation:
5331
5332 |**Name**|**Type**|**Documentation**
5333 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5334 |Source|com: LocalComponentListCo mponentReferenceType|
5335 |Target|com: LocalComponentListCo mponentReferenceType|
5336 |RepresentationMappin g|RepresentationMapTyp e|RepresentationMapping describes the mapping rules to map the value of the source component to the target component. Note that is a representation mapping is not supplied, then the value of the source component is mapped directly to the value of the target component without any manipulation.
5337
5338 **RepresentationMapType: **RepresentationMapType describes the structure of the mapping of the value of a source to component to a target component. Either a reference to another map defined within the containing structure set or a description of the source and target text formats must be provided. Note that for key family components, only a reference to a codelist map is relevant, since that is the only type of coded representation allowed in a key family.
5339
5340 Content:
5341
5342 (CodelistMap | (ToTextFormat, ToValueType) | ValueMap)
5343
5344 Element Documentation:
5345
5346 |**Name**|**Type**|**Documentation**
5347 |CodelistMap|com: LocalCodelistMapRefe renceType|CodelistMap references a codelist map defined in the same structure set which maps the enumeration of the representation of the source component to the enumeration of the representation of the target component.
5348 |ToTextFormat|TextFormatType|ToTextFormat describes the un-coded representation of the target to which the value of the referenced component should be transformed.
5349 |ToValueType|ToValueTypeType|ToValueType notes whether the value, name, or description of the source value should be used in the target value.
5350 |ValueMap|ValueMapType|ValueMap provides for a simple mapping of a source value to a target value without having to define a codelist map. This is available to allow mappings in situations such as the source or target is not being formally coded, or the source and/or target being a measure dimension in which case its representation is not mappable from a codelist map.
5351
5352 **ValueMapType: **ValueMapType contains a collection of value mappings, which give a source and target value.
5353
5354 Content:
5355
5356 ValueMapping+
5357
5358 Element Documentation:
5359
5360 |**Name**|**Type**|**Documentation**
5361 |ValueMapping|ValueMappingType|ValueMapping provides a source and target value for the purpose of mapping.
5362
5363 **ValueMappingType: **ValueMappingType specifies the relationship between two values as a source and target.
5364
5365 Attributes:
5366
5367 source, target
5368
5369 Content:
5370
5371 {Empty}
5372
5373 Attribute Documentation:
5374
5375 |**Name**|**Type**|**Documentation**
5376 |source|xs:string|
5377 |target|xs:string|
5378
5379 //**VtlDefinitionSchemeType**//**: **VtlDefinitionSchemeType is an abstract extension of the ItemSchemeType for VTL schemes.
5380
5381 Derivation:
5382
5383 //com:AnnotableType// (extension)
5384 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5385 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
5386 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
5387 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
5388 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
5389 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)
5390 [[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType//
5391
5392 Attributes:
5393
5394 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
5395
5396 Content:
5397
5398 com:Annotations?, com:Name+, com:Description*, //Item*//
5399
5400 Attribute Documentation:
5401
5402 |**Name**|**Type**|**Documentation**
5403 |id|com:IDType|The id is the identifier for the object.
5404 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5405 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5406 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
5407 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5408 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5409 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5410 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
5411 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5412 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5413 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5414 |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 key family in the context of a constraint.
5415 |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.
5416
5417 Element Documentation:
5418
5419 |**Name**|**Type**|**Documentation**
5420 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5421 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5422 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5423 |//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.
5424
5425 //**TransformationSchemeBaseType**//**: **TransformationSchemeBaseType is an abstract base type for the TransformationSchemeType. It restricts the item types to be only transformations.
5426
5427 Derivation:
5428
5429 //com:AnnotableType// (extension)
5430 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5431 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
5432 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
5433 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
5434 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
5435 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)
5436 [[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)
5437 [[image:inherit.gif||height="9" width="9"]] //TransformationSchemeBaseType//
5438
5439 Attributes:
5440
5441 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
5442
5443 Content:
5444
5445 com:Annotations?, com:Name+, com:Description*, Transformation*
5446
5447 Attribute Documentation:
5448
5449 |**Name**|**Type**|**Documentation**
5450 |id|com:IDType|The id is the identifier for the object.
5451 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5452 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5453 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
5454 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5455 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5456 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5457 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
5458 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5459 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5460 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5461 |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 key family in the context of a constraint.
5462 |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.
5463
5464 Element Documentation:
5465
5466 |**Name**|**Type**|**Documentation**
5467 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5468 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5469 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5470 |Transformation|TransformationType|Transformation describes the details of a single transformation within a transformation scheme.
5471
5472 **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.
5473
5474 Derivation:
5475
5476 //com:AnnotableType// (extension)
5477 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5478 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
5479 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
5480 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
5481 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
5482 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)
5483 [[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)
5484 [[image:inherit.gif||height="9" width="9"]] //TransformationSchemeBaseType// (extension)
5485 [[image:inherit.gif||height="9" width="9"]] TransformationSchemeType
5486
5487 Attributes:
5488
5489 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
5490
5491 Content:
5492
5493 com:Annotations?, com:Name+, com:Description*, Transformation*, VtlMappingScheme?, NamePersonalisationScheme?, CustomTypeScheme?, RulesetScheme*, UserDefinedOperatorScheme*
5494
5495 Attribute Documentation:
5496
5497 |**Name**|**Type**|**Documentation**
5498 |id|com:IDType|The id is the identifier for the object.
5499 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5500 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5501 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
5502 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5503 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5504 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5505 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
5506 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5507 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5508 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5509 |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 key family in the context of a constraint.
5510 |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.
5511
5512 Element Documentation:
5513
5514 |**Name**|**Type**|**Documentation**
5515 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5516 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5517 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5518 |Transformation|TransformationType|Transformation describes the details of a single transformation within a transformation scheme.
5519 |VtlMappingScheme|com: 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.
5520 |NamePersonalisationS cheme|com: 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.
5521 |CustomTypeScheme|com: 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.
5522 |RulesetScheme|com: 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.
5523 |UserDefinedOperatorS cheme|com: 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.
5524
5525 **TransformationType: **TransformationType defines the structure of a transformation. A transformation is an assignment of a VTL expression to a specific result.
5526
5527 Derivation:
5528
5529 //com:AnnotableType// (extension)
5530 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5531 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
5532 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
5533 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
5534 [[image:inherit.gif||height="9" width="9"]] //UnnestedItemType// (extension)
5535 [[image:inherit.gif||height="9" width="9"]] TransformationType
5536
5537 Attributes:
5538
5539 id, urn?, uri?, isPersistent
5540
5541 Content:
5542
5543 com:Annotations?, com:Name+, com:Description*, Expression, Result
5544
5545 Attribute Documentation:
5546
5547 |**Name**|**Type**|**Documentation**
5548 |id|com:IDType|The id is the identifier for the object.
5549 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5550 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5551 |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.
5552
5553 Element Documentation:
5554
5555 |**Name**|**Type**|**Documentation**
5556 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5557 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5558 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5559 |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").
5560 |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").
5561
5562 **VtlMappingSchemeType: **VtlMappingSchemeType defines a set of mappings between SDMX and VTL.
5563
5564 Derivation:
5565
5566 //com:AnnotableType// (extension)
5567 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5568 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
5569 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
5570 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
5571 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
5572 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)
5573 [[image:inherit.gif||height="9" width="9"]] VtlMappingSchemeType
5574
5575 Attributes:
5576
5577 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
5578
5579 Content:
5580
5581 com:Annotations?, com:Name+, com:Description*, VtlMapping*
5582
5583 Attribute Documentation:
5584
5585 |**Name**|**Type**|**Documentation**
5586 |id|com:IDType|The id is the identifier for the object.
5587 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5588 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5589 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
5590 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5591 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5592 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5593 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
5594 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5595 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5596 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5597 |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 key family in the context of a constraint.
5598
5599 Element Documentation:
5600
5601 |**Name**|**Type**|**Documentation**
5602 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5603 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5604 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5605 |VtlMapping|VtlMappingType|VtlMapping details a mapping between SDMX and VTL transformation.
5606
5607 **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, VtlCodelistMapping, or VtlConceptSchemeMapping) 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.
5608
5609 Derivation:
5610
5611 //com:AnnotableType// (extension)
5612 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5613 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
5614 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
5615 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
5616 [[image:inherit.gif||height="9" width="9"]] //UnnestedItemType// (extension)
5617 [[image:inherit.gif||height="9" width="9"]] VtlMappingType
5618
5619 Attributes:
5620
5621 id, urn?, uri?, alias
5622
5623 Content:
5624
5625 com:Annotations?, com:Name+, com:Description*, ( ( (Dataflow | GenericDataflow), ToVtlMapping?, FromVtlMapping?) | Codelist | ConceptScheme | Concept)
5626
5627 Attribute Documentation:
5628
5629 |**Name**|**Type**|**Documentation**
5630 |id|com:IDType|The id is the identifier for the object.
5631 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5632 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5633 |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.
5634
5635 Element Documentation:
5636
5637 |**Name**|**Type**|**Documentation**
5638 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5639 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5640 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5641 |Dataflow|com: 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.
5642 |GenericDataflow|com: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.
5643 |ToVtlMapping|ToVtlMappingType|Describes the mapping from a SDMX dataflow to a VTL data structure.
5644 |FromVtlMapping|FromVtlMappingType|Describes the mapping to a SDMX dataflow from a VTL data structure.
5645 |Codelist|com: CodelistReferenceTyp e|A reference to the SDMX Codelist that the mapping is defined for. This is used to create a VtlCodelistMapping.
5646 |ConceptScheme|com: ConceptSchemeReferen ceType|A reference to the SDMX Concept Scheme that the mapping is defined for. This is used to create a VtlConceptSchemeMapping.
5647 |Concept|com: ConceptReferenceType|A reference to the SDMX Concept that the mapping is defined for. This is used to create a VtlConceptMapping.
5648
5649 **ToVtlMappingType: **ToVtlMappingType defines the mapping method and filter used when mapping from SDMX to VTL.
5650
5651 Attributes:
5652
5653 method?
5654
5655 Content:
5656
5657 ToVtlSubSpace?
5658
5659 Attribute Documentation:
5660
5661 |**Name**|**Type**|**Documentation**
5662 |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.
5663
5664 Element Documentation:
5665
5666 |**Name**|**Type**|**Documentation**
5667 |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.
5668
5669 **FromVtlMappingType: **FromVtlMappingType defines the mapping method and filter used when mapping from VTL to SDMX.
5670
5671 Attributes:
5672
5673 method?
5674
5675 Content:
5676
5677 FromVtlSuperSpace?
5678
5679 Attribute Documentation:
5680
5681 |**Name**|**Type**|**Documentation**
5682 |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.
5683
5684 Element Documentation:
5685
5686 |**Name**|**Type**|**Documentation**
5687 |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.
5688
5689 **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.
5690
5691 Content:
5692
5693 Key+
5694
5695 Element Documentation:
5696
5697 |**Name**|**Type**|**Documentation**
5698 |Key|com: SingleNCNameIDType|A reference to a dimension by its identifier.
5699
5700 **NamePersonalisationSchemeType: **NamePersonalisationSchemeType defines a set of personalisations of VTL standard names that are used in a set of transformations.
5701
5702 Derivation:
5703
5704 //com:AnnotableType// (extension)
5705 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5706 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
5707 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
5708 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
5709 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
5710 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)
5711 [[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)
5712 [[image:inherit.gif||height="9" width="9"]] NamePersonalisationSchemeType
5713
5714 Attributes:
5715
5716 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
5717
5718 Content:
5719
5720 com:Annotations?, com:Name+, com:Description*, NamePersonalisation*
5721
5722 Attribute Documentation:
5723
5724 |**Name**|**Type**|**Documentation**
5725 |id|com:IDType|The id is the identifier for the object.
5726 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5727 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5728 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
5729 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5730 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5731 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5732 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
5733 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5734 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5735 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5736 |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 key family in the context of a constraint.
5737 |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.
5738
5739 Element Documentation:
5740
5741 |**Name**|**Type**|**Documentation**
5742 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5743 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5744 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5745 |NamePersonalisation|NamePersonalisationT ype|NamePersonalisation details a name personalisation that is used in a transformation.
5746
5747 **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.
5748
5749 Derivation:
5750
5751 //com:AnnotableType// (extension)
5752 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5753 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
5754 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
5755 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
5756 [[image:inherit.gif||height="9" width="9"]] //UnnestedItemType// (extension)
5757 [[image:inherit.gif||height="9" width="9"]] NamePersonalisationType
5758
5759 Attributes:
5760
5761 id, urn?, uri?, vtlArtefact
5762
5763 Content:
5764
5765 com:Annotations?, com:Name+, com:Description*, VtlDefaultName, PersonalisedName
5766
5767 Attribute Documentation:
5768
5769 |**Name**|**Type**|**Documentation**
5770 |id|com:IDType|The id is the identifier for the object.
5771 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5772 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5773 |vtlArtefact|xs:string|Identifies the type of VTL model artefact that is being personalised. In VTL 2.0, this is valuedomain or variable.
5774
5775 Element Documentation:
5776
5777 |**Name**|**Type**|**Documentation**
5778 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5779 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5780 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5781 |VtlDefaultName|xs:string|Provides the VTL standard name that is being personalised.
5782 |PersonalisedName|xs:string|Provides the personalised name that is used in place of the VTL standard name in the transformation expressions.
5783
5784 //**RulesetSchemeBaseType**//**: **RulesetSchemeBaseType is an abstract base type for the RulesetSchemeType. It restricts the item types to be only rulesets.
5785
5786 Derivation:
5787
5788 //com:AnnotableType// (extension)
5789 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5790 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
5791 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
5792 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
5793 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
5794 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)
5795 [[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)
5796 [[image:inherit.gif||height="9" width="9"]] //RulesetSchemeBaseType//
5797
5798 Attributes:
5799
5800 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
5801
5802 Content:
5803
5804 com:Annotations?, com:Name+, com:Description*, Ruleset*
5805
5806 Attribute Documentation:
5807
5808 |**Name**|**Type**|**Documentation**
5809 |id|com:IDType|The id is the identifier for the object.
5810 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5811 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5812 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
5813 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5814 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5815 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5816 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
5817 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5818 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5819 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5820 |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 key family in the context of a constraint.
5821 |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.
5822
5823 Element Documentation:
5824
5825 |**Name**|**Type**|**Documentation**
5826 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5827 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5828 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5829 |Ruleset|RulesetType|Ruleset details a ruleset within a ruleset scheme.
5830
5831 **RulesetSchemeType: **RulesetSchemeType defines a collection of rulesets that are used in transformations.
5832
5833 Derivation:
5834
5835 //com:AnnotableType// (extension)
5836 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5837 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
5838 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
5839 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
5840 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
5841 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)
5842 [[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)
5843 [[image:inherit.gif||height="9" width="9"]] //RulesetSchemeBaseType// (extension)
5844 [[image:inherit.gif||height="9" width="9"]] RulesetSchemeType
5845
5846 Attributes:
5847
5848 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
5849
5850 Content:
5851
5852 com:Annotations?, com:Name+, com:Description*, Ruleset*, VtlMappingScheme?
5853
5854 Attribute Documentation:
5855
5856 |**Name**|**Type**|**Documentation**
5857 |id|com:IDType|The id is the identifier for the object.
5858 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5859 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5860 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
5861 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5862 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5863 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5864 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
5865 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5866 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5867 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5868 |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 key family in the context of a constraint.
5869 |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.
5870
5871 Element Documentation:
5872
5873 |**Name**|**Type**|**Documentation**
5874 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5875 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5876 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5877 |Ruleset|RulesetType|Ruleset details a ruleset within a ruleset scheme.
5878 |VtlMappingScheme|com: 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.
5879
5880 **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.
5881
5882 Derivation:
5883
5884 //com:AnnotableType// (extension)
5885 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5886 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
5887 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
5888 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
5889 [[image:inherit.gif||height="9" width="9"]] //UnnestedItemType// (extension)
5890 [[image:inherit.gif||height="9" width="9"]] RulesetType
5891
5892 Attributes:
5893
5894 id, urn?, uri?, rulesetType, rulesetScope
5895
5896 Content:
5897
5898 com:Annotations?, com:Name+, com:Description*, RulesetDefinition
5899
5900 Attribute Documentation:
5901
5902 |**Name**|**Type**|**Documentation**
5903 |id|com:IDType|The id is the identifier for the object.
5904 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5905 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5906 |rulesetType|xs:string|The VTL type of the ruleset. In VTL 2.0, this is datapoint or hierarchical
5907 |rulesetScope|xs:string|This model artefact on which the ruleset is defined. In VTL 2.0, this is value domain or variable.
5908
5909 Element Documentation:
5910
5911 |**Name**|**Type**|**Documentation**
5912 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5913 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5914 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5915 |RulesetDefinition|xs:string|A VTL statement for the definition of a ruleset. This must conform to the syntax of the VTL definition language.
5916
5917 //**UserDefinedOperatorSchemeBaseType**//**: **UserDefinedOperatorSchemeBaseType is an abstract base type for the UserDefinedOperatorSchemeType. It restricts the item types to be only user defined operators.
5918
5919 Derivation:
5920
5921 //com:AnnotableType// (extension)
5922 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5923 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
5924 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
5925 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
5926 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
5927 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)
5928 [[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)
5929 [[image:inherit.gif||height="9" width="9"]] //UserDefinedOperatorSchemeBaseType//
5930
5931 Attributes:
5932
5933 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
5934
5935 Content:
5936
5937 com:Annotations?, com:Name+, com:Description*, UserDefinedOperator*
5938
5939 Attribute Documentation:
5940
5941 |**Name**|**Type**|**Documentation**
5942 |id|com:IDType|The id is the identifier for the object.
5943 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5944 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5945 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
5946 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5947 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5948 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5949 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
5950 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5951 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5952 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5953 |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 key family in the context of a constraint.
5954 |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.
5955
5956 Element Documentation:
5957
5958 |**Name**|**Type**|**Documentation**
5959 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
5960 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5961 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
5962 |UserDefinedOperator|UserDefinedOperatorT ype|UserDefinedOperator details a user defined operators within a user defined operator scheme.
5963
5964 **UserDefinedOperatorSchemeType: **UserDefinedOperatorSchemeType defines a collection of user defined operators that are used in transformations.
5965
5966 Derivation:
5967
5968 //com:AnnotableType// (extension)
5969 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5970 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
5971 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
5972 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
5973 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
5974 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)
5975 [[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)
5976 [[image:inherit.gif||height="9" width="9"]] //UserDefinedOperatorSchemeBaseType// (extension)
5977 [[image:inherit.gif||height="9" width="9"]] UserDefinedOperatorSchemeType
5978
5979 Attributes:
5980
5981 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
5982
5983 Content:
5984
5985 com:Annotations?, com:Name+, com:Description*, UserDefinedOperator*, VtlMappingScheme?, RulesetScheme*
5986
5987 Attribute Documentation:
5988
5989 |**Name**|**Type**|**Documentation**
5990 |id|com:IDType|The id is the identifier for the object.
5991 |urn|xs:anyURI|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 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
5994 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5995 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5996 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5997 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
5998 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5999 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
6000 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
6001 |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 key family in the context of a constraint.
6002 |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.
6003
6004 Element Documentation:
6005
6006 |**Name**|**Type**|**Documentation**
6007 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
6008 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
6009 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
6010 |UserDefinedOperator|UserDefinedOperatorT ype|UserDefinedOperator details a user defined operators within a user defined operator scheme.
6011 |VtlMappingScheme|com: 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.
6012 |RulesetScheme|com: RulesetSchemeReferen ceType|References a ruleset scheme defining rulesets utilized in the user defined operators.
6013
6014 **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.
6015
6016 Derivation:
6017
6018 //com:AnnotableType// (extension)
6019 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
6020 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
6021 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
6022 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
6023 [[image:inherit.gif||height="9" width="9"]] //UnnestedItemType// (extension)
6024 [[image:inherit.gif||height="9" width="9"]] UserDefinedOperatorType
6025
6026 Attributes:
6027
6028 id, urn?, uri?
6029
6030 Content:
6031
6032 com:Annotations?, com:Name+, com:Description*, OperatorDefinition
6033
6034 Attribute Documentation:
6035
6036 |**Name**|**Type**|**Documentation**
6037 |id|com:IDType|The id is the identifier for the object.
6038 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
6039 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
6040
6041 Element Documentation:
6042
6043 |**Name**|**Type**|**Documentation**
6044 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
6045 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
6046 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
6047 |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.
6048
6049 **CustomTypeSchemeType: **CustomTypeSchemeType defines a collection of custom types that are used in transformations.
6050
6051 Derivation:
6052
6053 //com:AnnotableType// (extension)
6054 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
6055 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
6056 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
6057 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
6058 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
6059 //ItemSchemeType// (extension)
6060 [[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)
6061 [[image:inherit.gif||height="9" width="9"]] CustomTypeSchemeType
6062
6063 Attributes:
6064
6065 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
6066
6067 Content:
6068
6069 com:Annotations?, com:Name+, com:Description*, CustomType*
6070
6071 Attribute Documentation:
6072
6073 |**Name**|**Type**|**Documentation**
6074 |id|com:IDType|The id is the identifier for the object.
6075 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
6076 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
6077 |version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.
6078 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
6079 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
6080 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
6081 |isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.
6082 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
6083 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
6084 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
6085 |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 key family in the context of a constraint.
6086 |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.
6087
6088 Element Documentation:
6089
6090 |**Name**|**Type**|**Documentation**
6091 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
6092 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
6093 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
6094 |CustomType|CustomTypeType|CustomType details a custom type within a custom type scheme.
6095
6096 **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.
6097
6098 Derivation:
6099
6100 //com:AnnotableType// (extension)
6101 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
6102 //NameableType// (restriction)
6103 //ItemBaseType// (extension)
6104 //ItemType// (restriction)
6105 //UnnestedItemType// (extension)
6106 CustomTypeType
6107
6108 Attributes:
6109
6110 id, urn?, uri?
6111
6112 Content:
6113
6114 com:Annotations?, com:Name+, com:Description*, VtlScalarType, DataType, VtlLiteralFormat?, OutputFormat?, NullValue?
6115
6116 Attribute Documentation:
6117
6118 |**Name**|**Type**|**Documentation**
6119 |id|com:IDType|The id is the identifier for the object.
6120 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
6121 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
6122
6123 Element Documentation:
6124
6125 |**Name**|**Type**|**Documentation**
6126 |com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
6127 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
6128 |com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
6129 |VtlScalarType|xs:string|Identifies the VTL scalar type that is to be converted to an resulting output data type.
6130 |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.
6131 |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.
6132 |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.
6133 |NullValue|xs:string|The value to be produced in the output of the conversion when a component has a null value.
6134
6135 === 2.1.4 Simple Types ===
6136
6137 **UsageStatusType: **UsageStatusType provides a list of enumerated types for indicating whether reporting a given attribute is mandatory or conditional.
6138
6139 Derived by restriction of xs:NMTOKEN .
6140
6141 Enumerations:
6142
6143 |**Value**|**Documentation**
6144 |Mandatory|Reporting the associated attribute is mandatory - a value must be supplied.
6145 |Conditional|Reporting the associated attribute is not mandatory - a value may be supplied, but is not required.
6146
6147 **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.
6148
6149 Derived by restriction of com:SimpleDataType .
6150
6151 Enumerations:
6152
6153 (% style="width:1015.83px" %)
6154 |**Value**|(% style="width:816px" %)**Documentation**
6155 |String|(% style="width:816px" %)A string datatype corresponding to W3C XML Schema's xs:string datatype.
6156 |Alpha|(% style="width:816px" %)A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.
6157 |AlphaNumeric|(% style="width:816px" %)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.
6158 |Numeric|(% style="width:816px" %)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.
6159 |BigInteger|(% style="width:816px" %)An integer datatype corresponding to W3C XML Schema's xs:integer datatype.
6160 |Integer|(% style="width:816px" %)An integer datatype corresponding to W3C XML Schema's xs:int datatype.
6161 |Long|(% style="width:816px" %)A numeric datatype corresponding to W3C XML Schema's xs:long datatype.
6162 |Short|(% style="width:816px" %)A numeric datatype corresponding to W3C XML Schema's xs:short datatype.
6163 |Boolean|(% style="width:816px" %)A datatype corresponding to W3C XML Schema's xs:boolean datatype.
6164 |URI|(% style="width:816px" %)A datatype corresponding to W3C XML Schema's xs:anyURI datatype.
6165 |Count|(% style="width:816px" %)A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1".
6166 |InclusiveValueRange|(% style="width:816px" %)This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal.
6167 |ExclusiveValueRange|(% style="width:816px" %)This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal.
6168 |Incremental|(% style="width:816px" %)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.
6169 |ObservationalTimePeriod|(% style="width:816px" %)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.
6170 |StandardTimePeriod|(% style="width:816px" %)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.
6171 |BasicTimePeriod|(% style="width:816px" %)BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
6172 |GregorianTimePeriod|(% style="width:816px" %)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.
6173 |GregorianYear|(% style="width:816px" %)A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
6174 |GregorianYearMonth|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
6175 |GregorianDay|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
6176 |ReportingTimePeriod|(% style="width:816px" %)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.
6177 |ReportingYear|(% style="width:816px" %)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.
6178 |ReportingSemester|(% style="width:816px" %)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.
6179 |ReportingTrimester|(% style="width:816px" %)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.
6180 |ReportingQuarter|(% style="width:816px" %)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.
6181 |ReportingMonth|(% style="width:816px" %)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.
6182 |ReportingWeek|(% style="width:816px" %)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.
6183 |ReportingDay|(% style="width:816px" %)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.
6184 |Month|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:gMonth datatype.
6185 |MonthDay|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype.
6186 |Day|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:gDay datatype.
6187 |Duration|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:duration datatype.
6188
6189 **SimpleCodeDataType: **SimpleCodeDataType restricts SimpleDataType to specify the allowable data types for a simple code. The possible values are simply Alpha, AlphaNumeric, or Numeric.
6190
6191 Derived by restriction of com:SimpleDataType .
6192
6193 Enumerations:
6194
6195 |**Value**|**Documentation**
6196 |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.
6197 |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.
6198 |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.
6199
6200 **TargetObjectDataType: **TargetObjectDataType restricts DataType to specify the allowable data types for representing a target object value.
6201
6202 Derived by restriction of com:DataType .
6203
6204 Enumerations:
6205
6206 |**Value**|**Documentation**
6207 |KeyValues|This value indicates that the content of the component will be data key (a set of dimension references and values for the dimensions).
6208 |IdentifiableReference|This value indicates that the content of the component will be complete reference (either URN or full set of reference fields) to an Identifiable object in the SDMX Information Model.
6209 |DataSetReference|This value indicates that the content of the component will be reference to a data provider, which is actually a formal reference to a data provider and a data set identifier value.
6210 |AttachmentConstraintReference|This value indicates that the content of the component will be reference to an attachment constraint, which is actually a combination of a collection of full or partial key values and a reference to a data set or data structure, usage, or provision agreement.
6211
6212 **ToValueTypeType: **ToValueTypeType provides an enumeration of available text-equivalents for translation of coded values into textual formats.
6213
6214 Derived by restriction of xs:NMTOKEN .
6215
6216 Enumerations:
6217
6218 |**Value**|**Documentation**
6219 |Value|Code or other tokenized value, as provided in the representation scheme.
6220 |Name|The human-readable name of the Value, as provided in the representation scheme.
6221 |Description|The human-readable description of the Value, as provided in the representation scheme.
6222
6223 **StandardToVtlMappingMethodType: **A simple type enumerating the standard mapping methods when converting from data structures from SDMX to VLT.
6224
6225 Derived by restriction of xs:string .
6226
6227 Enumerations:
6228
6229 |**Value**|**Documentation**
6230 |Basic|The default mapping method. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.1 ("Basic Mapping").
6231 |Pivot|Method for mapping multi-measure data. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.2 ("Pivot Mapping").
6232 |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").
6233 |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").
6234
6235 **ToVtlMappingMethodType: **A simple type that allows for a standard to VTL mapping method enumeration value or a string value for other mapping methods.
6236
6237 Union of:
6238
6239 StandardToVtlMappingMethodType, xs:string.
6240
6241 **StandardFromVtlMappingMethodType: **A simple type enumerating the standard mapping methods when converting from data structures from VTL to SDMX.
6242
6243 Derived by restriction of xs:string .
6244
6245 Enumerations:
6246
6247 |**Value**|**Documentation**
6248 |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").
6249 |Unpivot|The mapping method to be used when the VTL data structure has more than one measure component. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.4.2 ("Unpivot Mapping").
6250 |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").
6251
6252 **FromVtlMappingMethodType: **A simple type that allows for standard from VTL mapping method enumeration value or a string value for other mapping methods.
6253
6254 Union of:
6255
6256 StandardFromVtlMappingMethodType, xs:string.
6257
6258 **CustomTypeDataType: **A simple type that allows for a SDMX simple data type enumeration value or a string value for other data types.
6259
6260 Union of:
6261
6262 com:SimpleDataType, xs:string.