Skip to Content

Wiki source code of Part III. Structure

Version 16.12 by Helena on 2025/07/01 14:09
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 (AgencyScheme | DataConsumerScheme | DataProviderScheme | OrganisationUnitScheme)+
282
283 Element Documentation:
284
285 |**Name**|**Type**|**Documentation**
286 |AgencyScheme|AgencySchemeType|AgencyScheme provides the details of an agency scheme, in which agencies are described.
287 |DataConsumerScheme|DataConsumerSchemeType|DataConsumerScheme provides the details of an data consumer scheme, in which data consumers are described.
288 |DataProviderScheme|DataProviderSchemeType|DataProviderScheme provides the details of an data provider scheme, in which data providers are described.
289 |OrganisationUnitSche me|OrganisationUnitSchemeType|OrganisationUnitScheme provides the details of an organisation unit scheme, in which organisation units are described.
290
291 **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.
292
293 Content:
294 Dataflow+
295
296 Element Documentation:
297
298 |**Name**|**Type**|**Documentation**
299 |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.
300
301 **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.
302
303 Content:
304 Metadataflow+
305
306 Element Documentation:
307
308 |**Name**|**Type**|**Documentation**
309 |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
310
311 **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.
312
313 Content:
314 CategoryScheme+
315
316 Element Documentation:
317
318 |**Name**|**Type**|**Documentation**
319 |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.
320
321 **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.
322
323 Content:
324 Categorisation+
325
326 Element Documentation:
327
328 |**Name**|**Type**|**Documentation**
329 |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.
330
331 **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.
332
333 Content:
334 Codelist+
335
336 Element Documentation:
337
338 |**Name**|**Type**|**Documentation**
339 |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.
340
341 **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.
342
343 Content:
344 HierarchicalCodelist+
345
346 Element Documentation:
347
348 |**Name**|**Type**|**Documentation**
349 |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.
350
351 **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.
352
353 Content:
354 ConceptScheme*
355
356 Element Documentation:
357
358 |**Name**|**Type**|**Documentation**
359 |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.
360
361 **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.
362
363 Content:
364 MetadataStructure+
365
366 Element Documentation:
367
368 |**Name**|**Type**|**Documentation**
369 |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.
370
371 **DataStructuresType: **DataStructuresType describes the structure of the data structure definitions container. It contains one or more data structure definition, which can be explicitly detailed or referenced from an external structure document or registry service.
372
373 Content:
374 DataStructure+
375
376 Element Documentation:
377
378 |**Name**|**Type**|**Documentation**
379 |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.
380
381 **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.
382
383 Content:
384 StructureSet+
385
386 Element Documentation:
387
388 |**Name**|**Type**|**Documentation**
389 |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.
390
391 **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.
392
393 Content:
394 ReportingTaxonomy+
395
396 Element Documentation:
397
398 |**Name**|**Type**|**Documentation**
399 |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.
400
401 **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.
402
403 Content:
404 Process+
405
406 Element Documentation:
407
408 |**Name**|**Type**|**Documentation**
409 |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.
410
411 **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.
412
413 Content
414 (AttachmentConstraint | ContentConstraint)+
415
416 Element Documentation:
417
418 |**Name**|**Type**|**Documentation**
419 |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.
420 |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.
421
422 **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.
423
424 Content:
425 ProvisionAgreement+
426
427 Element Documentation:
428
429 |**Name**|**Type**|**Documentation**
430 |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.
431
432 **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.
433
434 Content:
435 CustomTypeScheme+
436
437 Element Documentation:
438
439 |**Name**|**Type**|**Documentation**
440 |CustomTypeScheme|CustomTypeSchemeType|CustomTypeScheme provides the details of a custom type scheme, in which user defined operators are described.
441
442 **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.
443
444 Content:
445 VtlMappingScheme+
446
447 Element Documentation:
448
449 |**Name**|**Type**|**Documentation**
450 |VtlMappingScheme|VtlMappingSchemeType|VtlMappingScheme provides the details of a VTL mapping scheme, in which VTL mappings are described.
451
452 **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.
453
454 Content:
455 NamePersonalisationScheme+
456
457 Element Documentation:
458
459 |**Name**|**Type**|**Documentation**
460 |NamePersonalisationS cheme|NamePersonalisationSchemeType|NamePersonalisationScheme provides the details of a name personalisation scheme, in which name personalisations are described.
461
462 **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.
463
464 Content:
465 RulesetScheme+
466
467 Element Documentation:
468
469 |**Name**|**Type**|**Documentation**
470 |RulesetScheme|RulesetSchemeType|RulesetScheme provides the details of a ruleset scheme, in which rulesets are described.
471
472 **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.
473
474 Content:
475 TransformationScheme+
476
477 Element Documentation
478
479 |**Name**|**Type**|**Documentation**
480 |TransformationScheme|TransformationSchemeType|TransformationScheme provides the details of a transformation scheme, in which transformations are described.
481
482 **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.
483
484 Content:
485 UserDefinedOperatorScheme+
486
487 Element Documentation:
488
489 |**Name**|**Type**|**Documentation**
490 |UserDefinedOperatorS cheme|UserDefinedOperatorS chemeType|UserDefinedOperatorScheme provides the details of a user defined operator scheme, in which user defined operators are described.
491
492 //**IdentifiableType**//**: **IdentifiableType is an abstract base type for all identifiable objects.
493
494 Derivation:
495
496 * //com:AnnotableType// (extension)
497 ** //dentifiableType//
498
499 Attributes:
500 id?, urn?, uri?
501
502 Conten:
503
504 com:Annotations?
505
506 Attribute Documentation:
507
508 |**Name**|**Type**|**Documentation**
509 |d|com:IDType|The id is the identifier for the object.
510 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
511 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
512
513 Element Documentation:
514
515 |**Name**|**Type**|**Documentation**
516 |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.
517
518 //**NameableType**//**: **NameableType is an abstract base type for all nameable objects.
519
520 Derivation:
521
522 * //com:AnnotableType// (extension)
523 ** //IdentifiableType// (extension)
524 *** //NameableType//
525
526 Attributes:
527 id?, urn?, uri?
528
529 Content:
530 com:Annotations?, com:Name+, com:Description*
531
532 Attribute Documentation:
533
534 |**Name**|**Type**|**Documentation**
535 |id|com:IDType|The id is the identifier for the object.
536 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
537 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
538
539 Element Documentation:
540
541 |**Name**|**Type**|**Documentation**
542 |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.
543 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
544 |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.
545
546 //**VersionableType**//**: **VersionableType is an abstract base type for all versionable objects.
547
548 Derivation:
549
550 * //com:AnnotableType// (extension)
551 ** //IdentifiableType// (extension)
552 *** //NameableType// (extension)
553 **** //VersionableType//
554
555 Attributes:
556 id?, urn?, uri?, version?, validFrom?, validTo?
557
558 Content:
559 com:Annotations?, com:Name+, com:Description*
560
561 Attribute Documentation:
562
563 |**Name**|**Type**|**Documentation**
564 |id|com:IDType|The id is the identifier for the object.
565 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
566 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
567 |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.
568 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
569 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
570
571 Element Documentation:
572
573 |**Name**|**Type**|**Documentation**
574 |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.
575 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
576 |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.
577
578 //**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.
579
580 Derivation:
581
582 * //com:AnnotableType// (extension)
583 ** //IdentifiableType// (extension)
584 *** //NameableType// (extension)
585 **** //VersionableType// (restriction)
586 ***** //MaintainableBaseType//
587
588 Attributes:
589 id, urn?, uri?, version?, validFrom?, validTo?
590
591 Content:
592 com:Annotations?, com:Name+, com:Description*
593
594 Attribute Documentation:
595
596 |**Name**|**Type**|**Documentation**
597 |id|com:IDType|The id is the identifier for the object.
598 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
599 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
600 |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.
601 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
602 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
603
604 Element Documentation:
605
606 |**Name**|**Type**|**Documentation**
607 |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.
608 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
609 |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.
610
611 //**MaintainableType**//**: **MaintainableType is an abstract base type for all maintainable objects.
612
613 Derivation:
614
615 * //com:AnnotableType// (extension)
616 ** //IdentifiableType// (extension)
617 *** //NameableType// (extension)
618 **** //VersionableType// (restriction)
619 ***** //MaintainableBaseType// (extension)
620 ****** //MaintainableType//
621
622 Attributes:
623 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
624
625 Content:
626 com:Annotations?, com:Name+, com:Description*
627
628 Attribute Documentation:
629
630 |**Name**|**Type**|**Documentation**
631 |id|com:IDType|The id is the identifier for the object.
632 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
633 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
634 |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.
635 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
636 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
637 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
638 |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.
639 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
640 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
641 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
642
643 Element Documentation:
644
645 |**Name**|**Type**|**Documentation**
646 |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.
647 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
648 |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.
649
650 //**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.
651
652 Derivation:
653 //com:AnnotableType// (extension)
654 //IdentifiableType// (extension)
655 //NameableType// (extension)
656 //VersionableType// (restriction)
657 //MaintainableBaseType// (extension)
658 //MaintainableType// (extension)
659 //ItemSchemeType//
660
661 Attributes:
662 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
663
664 Content:
665 com:Annotations?, com:Name+, com:Description*, //Item*//
666
667 Attribute Documentation:
668
669 |**Name**|**Type**|**Documentation**
670 |id|com:IDType|The id is the identifier for the object.
671 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
672 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
673 |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.
674 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
675 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
676 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
677 |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.
678 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
679 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
680 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
681 |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.
682
683 Element Documentation:
684
685 |**Name**|**Type**|**Documentation**
686 |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.
687 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
688 |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.
689 |//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.
690
691 //**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.
692
693 Derivation:
694 //com:AnnotableType// (extension)
695 //IdentifiableType// (extension)
696 //NameableType// (restriction)
697 //ItemBaseType//
698
699 Attributes:
700 id, urn?, uri?
701
702 Content:
703 com:Annotations?, com:Name+, com:Description*
704
705 Attribute Documentation:
706
707 |**Name**|**Type**|**Documentation**
708 |id|com:IDType|The id is the identifier for the object.
709 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
710 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
711
712 Element Documentation:
713
714 |**Name**|**Type**|**Documentation**
715 |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.
716 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
717 |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.
718
719 //**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.
720
721 Derivation:
722 //com:AnnotableType// (extension)
723 //IdentifiableType// (extension)
724 //NameableType// (restriction)
725 //ItemBaseType// (extension)
726 //ItemType//
727
728 Attributes:
729 id, urn?, uri?
730
731 Content:
732 com:Annotations?, com:Name+, com:Description*, (Parent | //Item+//)?
733
734 Attribute Documentation:
735
736 |**Name**|**Type**|**Documentation**
737 |id|com:IDType|The id is the identifier for the object.
738 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
739 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
740
741 Element Documentation:
742
743 |**Name**|**Type**|**Documentation**
744 |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.
745 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
746 |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.
747 |Parent|//com: LocalItemReferenceTy pe//|
748 |//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.
749
750 //**UnnestedItemType**//**: **UnnestedItemType is an abstract base type for all items with in an item scheme that do not contain nexted items.
751
752 Derivation:
753 //com:AnnotableType// (extension)
754 //IdentifiableType// (extension)
755 //NmeableType// (restriction)
756 //ItemBaseType// (extension)
757 //ItemType// (restriction)
758 //UnnestedItemType//
759
760 Attributes:
761 id, urn?, uri?
762
763 Content:
764 com:Annotations?, com:Name+, com:Description*
765
766 Attribute Documentation:
767
768 |**Name**|**Type**|**Documentation**
769 |id|com:IDType|The id is the identifier for the object.
770 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
771 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
772
773 Element Documentation:
774
775 |**Name**|**Type**|**Documentation**
776 |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.
777 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
778 |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.
779
780 //**StructureType**//**: **StructureType is an abstract base type for all structure objects. Concrete instances of this should restrict to a concrete grouping.
781
782 Derivation:
783 //com:AnnotableType// (extension)
784 //IdentifiableType// (extension)
785 //NameableType// (extension)
786 //VersionableType// (restriction)
787 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
788 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
789 [[image:inherit.gif||height="9" width="9"]] //StructureType//
790
791 Attributes:
792 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
793
794 Content:
795 com:Annotations?, com:Name+, com:Description*, //Grouping?//
796
797 Attribute Documentation:
798
799 |**Name**|**Type**|**Documentation**
800 |id|com:IDType|The id is the identifier for the object.
801 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
802 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
803 |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.
804 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
805 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
806 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
807 |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.
808 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
809 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
810 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
811
812 Element Documentation:
813
814 |**Name**|**Type**|**Documentation**
815 |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.
816 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
817 |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.
818 |//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.
819
820 //**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.
821
822 Content:
823 //ComponentList*//
824
825 Element Documentation:
826
827 |**Name**|**Type**|**Documentation**
828 |//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.
829
830 //**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.
831
832 Derivation:
833 //com:AnnotableType// (extension)
834 //IdentifiableType// (extension)
835 //ComponentListType//
836
837 Attributes:
838 id?, urn?, uri?
839
840 Content:
841 com:Annotations?, //Component*//
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
850 Element Documentation:
851
852 |**Name**|**Type**|**Documentation**
853 |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.
854 |//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.
855
856 //**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.
857
858 Derivation:
859 //com:AnnotableType// (extension)
860 //IdentifiableType// (restriction)
861 //ComponentBaseType//
862
863 Attributes:
864 id?, urn?, uri?
865
866 Content:
867 com:Annotations?
868
869 Attribute Documentation:
870
871 |**Name**|**Type**|**Documentation**
872 |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).
873 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
874 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
875
876 Element Documentation:
877
878 |**Name**|**Type**|**Documentation**
879 |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.
880
881 //**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.
882
883 Derivation:
884 //com:AnnotableType// (extension)
885 //IdentifiableType// (restriction)
886 //ComponentBaseType// (extension)
887 //ComponentType//
888
889 Attributes:
890 id?, urn?, uri?
891
892 Content:
893 com:Annotations?, ConceptIdentity?, LocalRepresentation?
894
895 Attribute Documentation:
896
897 |**Name**|**Type**|**Documentation**
898 |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).
899 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
900 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
901
902 Element Documentation:
903
904 |**Name**|**Type**|**Documentation**
905 |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.
906 |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.
907 |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.
908
909 //**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.
910
911 Derivation:
912 //com:AnnotableType// (extension)
913 //IdentifiableType// (extension)
914 //NameableType// (extension)
915 //VersionableType// (restriction)
916 //MaintainableBaseType// (extension)
917 //MaintainableType// (extension)
918 //StructureUsageType//
919
920 Attributes:
921 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
922
923 Content:
924 com:Annotations?, com:Name+, com:Description*, Structure?
925
926 Attribute Documentation:
927
928 |**Name**|**Type**|**Documentation**
929 |id|com:IDType|The id is the identifier for the object.
930 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
931 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
932 |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.
933 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
934 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
935 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
936 |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.
937 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
938 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
939 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
940
941 Element Documentation:
942
943 |**Name**|**Type**|**Documentation**
944 |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.
945 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
946 |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.
947 |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).
948
949 //**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.
950
951 Content:
952 (TextFormat | (Enumeration, EnumerationFormat?))
953
954 Element Documentation:
955
956 |**Name**|**Type**|**Documentation**
957 |TextFormat|TextFormatType|TextFormat describes an uncoded textual format.
958 |Enumeration|//com: ItemSchemeReferenceB aseType//|Enumeration references an item scheme that enumerates the allowable values for this representation.
959 |EnumerationFormat|CodededTextFormatTyp e|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.
960
961 **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".
962
963 Attributes:
964 textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?, isMultiLingual?
965
966 Content:
967 {Empty}
968
969 Attribute Documentation:
970
971 |**Name**|**Type**|**Documentation**
972 |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.
973 |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.
974 |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.
975 |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.
976 |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.
977 |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.
978 |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.
979 |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.
980 |minLength|xs:positiveInteger|The minLength attribute specifies the minimum and length of the value in characters.
981 |maxLength|xs:positiveInteger|The maxLength attribute specifies the maximum length of the value in characters.
982 |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.
983 |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.
984 |decimals|xs:positiveInteger|The decimals attribute indicates the number of characters allowed after the decimal separator.
985 |pattern|xs:string|The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema.
986 |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.
987
988 **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.
989
990 Derivation:
991
992 TextFormatType (restriction)
993 [[image:inherit.gif||height="9" width="9"]] BasicComponentTextFormatType
994
995 Attributes:
996 textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?, isMultiLingual?
997
998 Content:
999 {Empty}
1000
1001 Attribute Documentation:
1002
1003 |**Name**|**Type**|**Documentation**
1004 |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.
1005 |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.
1006 |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.
1007 |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.
1008 |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.
1009 |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.
1010 |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.
1011 |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.
1012 |minLength|xs:positiveInteger|The minLength attribute specifies the minimum and length of the value in characters.
1013 |maxLength|xs:positiveInteger|The maxLength attribute specifies the maximum length of the value in characters.
1014 |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.
1015 |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.
1016 |decimals|xs:positiveInteger|The decimals attribute indicates the number of characters allowed after the decimal separator.
1017 |pattern|xs:string|The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema.
1018 |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.
1019
1020 **SimpleComponentTextFormatType: **SimpleComponentTextFormatType is a restricted version of the BasicComponentTextFormatType that does not allow for multi-lingual values.
1021
1022 Derivation:
1023 TextFormatType (restriction)
1024 BasicComponentTextFormatType (restriction)
1025 SimpleComponentTextFormatType
1026
1027 Attributes:
1028 textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?
1029
1030 Content:
1031 {Empty}
1032
1033 Attribute Documentation:
1034
1035 |**Name**|**Type**|**Documentation**
1036 |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.
1037 |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.
1038 |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.
1039 |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.
1040 |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.
1041 |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.
1042 |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.
1043 |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.
1044 |minLength|xs:positiveInteger|The minLength attribute specifies the minimum and length of the value in characters.
1045 |maxLength|xs:positiveInteger|The maxLength attribute specifies the maximum length of the value in characters.
1046 |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.
1047 |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.
1048 |decimals|xs:positiveInteger|The decimals attribute indicates the number of characters allowed after the decimal separator.
1049 |pattern|xs:string|The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema.
1050
1051 **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.
1052
1053 Derivation:
1054 TextFormatType (restriction)
1055 BasicComponentTextFormatType (restriction)
1056 SimpleComponentTextFormatType (restriction)
1057 CodededTextFormatType
1058
1059 Attributes:
1060 textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, pattern?
1061
1062 Content:
1063 {Empty}
1064
1065 Attribute Documentation:
1066
1067 |**Name**|**Type**|**Documentation**
1068 |textType|CodeDataType|The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets.
1069 |isSequence|xs:boolean|The isSequence attribute indicates whether the values are intended to be ordered, and it may work in combination with the interval, startValue, and endValue attributes or the timeInterval, startTime, and endTime, attributes. If this attribute holds a value of true, a start value or time and a numeric or time interval must supplied. If an end value is not given, then the sequence continues indefinitely.
1070 |interval|xs:integer|The interval attribute specifies the permitted interval (increment) in a sequence. In order for this to be used, the isSequence attribute must have a value of true.
1071 |startValue|xs:integer|The startValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates the starting point of the sequence. This value is mandatory for a numeric sequence to be expressed.
1072 |endValue|xs:integer|The endValue attribute is used in conjunction with the isSequence and interval attributes (which must be set in order to use this attribute). This attribute is used for a numeric sequence, and indicates that ending point (if any) of the sequence.
1073 |timeInterval|xs:duration|The timeInterval attribute indicates the permitted duration in a time sequence. In order for this to be used, the isSequence attribute must have a value of true.
1074 |startTime|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:integer|The minValue attribute is used for inclusive and exclusive ranges, indicating what the lower bound of the range is. If this is used with an inclusive range, a valid value will be greater than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive.
1079 |maxValue|xs:integer|The maxValue attribute is used for inclusive and exclusive ranges, indicating what the upper bound of the range is. If this is used with an inclusive range, a valid value will be less than or equal to the value specified here. If the inclusive and exclusive data type is not specified (e.g. this facet is used with an integer data type), the value is assumed to be inclusive.
1080 |pattern|xs:string|The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema.
1081
1082 **NonFacetedTextFormatType: **NonFacetedTextFormatType is a restricted version of the SimpleComponentTextFormatType that does not allow for any facets.
1083
1084 Derivation:
1085 TextFormatType (restriction)
1086 BasicComponentTextFormatType (restriction)
1087 SimpleComponentTextFormatType (restriction)
1088 NonFacetedTextFormatType
1089
1090 Attributes:
1091 textType?
1092
1093 Content:
1094 {Empty}
1095
1096 Attribute Documentation:
1097
1098 |**Name**|**Type**|**Documentation**
1099 |textType|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.
1100
1101 **TimeTextFormatType: **TimeTextFormat is a restricted version of the SimpleComponentTextFormatType that only allows time based format and specifies a default ObservationalTimePeriod representation and facets of a start and end time.
1102
1103 Derivation:
1104 TextFormatType (restriction)
1105 BasicComponentTextFormatType (restriction)
1106 SimpleComponentTextFormatType (restriction)
1107 TimeTextFormatType
1108
1109 Attributes:
1110 textType?, startTime?, endTime?
1111
1112 Content:
1113 {Empty}
1114
1115 Attribute Documentation:
1116
1117 |**Name**|**Type**|**Documentation**
1118 |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.
1119 |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.
1120 |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.
1121
1122 **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.
1123
1124 Derivation:
1125 //com:AnnotableType// (extension)
1126 //IdentifiableType// (extension)
1127 //NameableType// (extension)
1128 //VersionableType// (restriction)
1129 //MaintainableBaseType// (extension)
1130 //MaintainableType// (extension)
1131 CategorisationType
1132
1133 Attributes:
1134 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
1135
1136 Content:
1137 com:Annotations?, com:Name+, com:Description*, (Source, Target)?
1138
1139 Attribute Documentation:
1140
1141 |**Name**|**Type**|**Documentation**
1142 |id|com:IDType|The id is the identifier for the object.
1143 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1144 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1145 |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.
1146 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1147 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1148 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1149 |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.
1150 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1151 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1152 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1153
1154 Element Documentation:
1155
1156 |**Name**|**Type**|**Documentation**
1157 |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.
1158 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1159 |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.
1160 |Source|com: ObjectReferenceType|Source is a reference to an object to be categorized.
1161 |Target|com: CategoryReferenceTyp e|Target is reference to the category that the referenced object is to be mapped to.
1162
1163 **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.
1164
1165 Derivation:
1166 //com:AnnotableType// (extension)
1167 //IdentifiableType// (extension)
1168 //NameableType// (extension)
1169 //VersionableType// (restriction)
1170 //MaintainableBaseType// (extension)
1171 //MaintainableType// (extension)
1172 //ItemSchemeType// (restriction)
1173 CategorySchemeType
1174
1175 Attributes:
1176 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
1177
1178 Content:
1179 com:Annotations?, com:Name+, com:Description*, Category*
1180
1181 Attribute Documentation:
1182
1183 |**Name**|**Type**|**Documentation**
1184 |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).
1185 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1186 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1187 |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.
1188 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1189 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1190 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1191 |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.
1192 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1193 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1194 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1195 |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.
1196
1197 Element Documentation:
1198
1199 |**Name**|**Type**|**Documentation**
1200 |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.
1201 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1202 |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.
1203 |Category|CategoryType|Category represents a set of nested categories which describe a simple classification hierarchy.
1204
1205 **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.
1206
1207 Derivation:
1208 //com:AnnotableType// (extension)
1209 //IdentifiableType// (extension)
1210 //NameableType// (restriction)
1211 //ItemBaseType// (extension)
1212 //ItemType// (restriction)
1213 CategoryType
1214
1215 Attributes:
1216 ёёid, urn?, uri?
1217
1218 Content:
1219
1220 com:Annotations?, com:Name+, com:Description*, Category*
1221
1222 Attribute Documentation:
1223
1224 |**Name**|**Type**|**Documentation**
1225 |id|com:IDType|The id is the identifier for the object.
1226 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1227 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1228
1229 Element Documentation:
1230
1231 |**Name**|**Type**|**Documentation**
1232 |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.
1233 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1234 |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.
1235 |Category|CategoryType|Category represents a set of nested categories which describe a simple classification hierarchy.
1236
1237 **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.
1238
1239 Derivation:
1240
1241 //com:AnnotableType// (extension)
1242 //IdentifiableType// (extension)
1243 //NameableType// (extension)
1244 //VersionableType// (restriction)
1245 //MaintainableBaseType// (extension)
1246 //MaintainableType// (extension)
1247 //ItemSchemeType// (restriction)
1248 CodelistType
1249
1250 Attributes:
1251 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
1252
1253 Content:
1254 com:Annotations?, com:Name+, com:Description*, Code*
1255
1256 Attribute Documentation:
1257
1258 |**Name**|**Type**|**Documentation**
1259 |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).
1260 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1261 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1262 |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.
1263 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1264 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1265 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1266 |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.
1267 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1268 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1269 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1270 |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.
1271
1272 Element Documentation:
1273
1274 |**Name**|**Type**|**Documentation**
1275 |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.
1276 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1277 |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.
1278 |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.
1279
1280 **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.
1281
1282 Derivation:
1283 //com:AnnotableType// (extension)
1284 //IdentifiableType// (extension)
1285 //NameableType// (restriction)
1286 //ItemBaseType// (extension)
1287 //ItemType// (restriction)
1288 CodeType
1289
1290 Attributes:
1291 id, urn?, uri?
1292
1293 Content:
1294 com:Annotations?, com:Name+, com:Description*, Parent?
1295
1296 Attribute Documentation:
1297
1298 |**Name**|**Type**|**Documentation**
1299 |id|com:IDType|The id is the identifier for the object.
1300 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1301 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1302
1303 Element Documentation:
1304
1305 |**Name**|**Type**|**Documentation**
1306 |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.
1307 |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.
1308 |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.
1309 |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.
1310
1311 **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.
1312
1313 Derivation:
1314 //com:AnnotableType// (extension)
1315 //IdentifiableType// (extension)
1316 //NameableType// (extension)
1317 //VersionableType// (restriction)
1318 //MaintainableBaseType// (extension)
1319 //MaintainableType// (extension)
1320 //ItemSchemeType// (restriction)
1321 ConceptSchemeType
1322
1323 Attributes:
1324 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
1325
1326 Content:
1327 com:Annotations?, com:Name+, com:Description*, Concept*
1328
1329 Attribute Documentation:
1330
1331 |**Name**|**Type**|**Documentation**
1332 |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).
1333 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1334 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1335 |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.
1336 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1337 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1338 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1339 |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.
1340 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1341 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1342 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1343 |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.
1344
1345 Element Documentation:
1346
1347 |**Name**|**Type**|**Documentation**
1348 |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.
1349 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1350 |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.
1351 |Concept|ConceptType|Concept describes the details of a concept within a concept scheme.
1352
1353 //**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.
1354
1355 Derivation:
1356 //com:AnnotableType// (extension)
1357 //IdentifiableType// (extension)
1358 //NameableType// (restriction)
1359 //ItemBaseType// (extension)
1360 //ItemType// (restriction)
1361 //ConceptBaseType//
1362
1363 Attributes:
1364 id, urn?, uri?
1365
1366 Content:
1367 com:Annotations?, com:Name+, com:Description*, Parent?
1368
1369 Attribute Documentation:
1370
1371 |**Name**|**Type**|**Documentation**
1372 |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).
1373 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1374 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1375
1376 Element Documentation:
1377
1378 |**Name**|**Type**|**Documentation**
1379 |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.
1380 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1381 |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.
1382 |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.
1383
1384 **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).
1385
1386 Derivation:
1387 //com:AnnotableType// (extension)
1388 //IdentifiableType// (extension)
1389 //NameableType// (restriction)
1390 //ItemBaseType// (extension)
1391 //ItemType// (restriction)
1392 //ConceptBaseType// (extension)
1393 ConceptType
1394
1395 Attributes:
1396 id, urn?, uri?
1397
1398 Content:
1399 com:Annotations?, com:Name+, com:Description*, Parent?, CoreRepresentation?, ISOConceptReference?
1400
1401 Attribute Documentation:
1402
1403 |**Name**|**Type**|**Documentation**
1404 |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).
1405 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1406 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1407
1408 Element Documentation:
1409
1410 |**Name**|**Type**|**Documentation**
1411 |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.
1412 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1413 |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.
1414 |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.
1415 |CoreRepresentation|ConceptRepresentatio n|
1416 |ISOConceptReference|ISOConceptReferenceT ype|Provides a reference to an ISO 11179 concept.
1417
1418 **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.
1419
1420 Derivation:
1421
1422 //RepresentationType// (restriction)
1423 ConceptRepresentation
1424
1425 Content:
1426 (TextFormat | (Enumeration, EnumerationFormat?))
1427
1428 Element Documentation:
1429
1430 |**Name**|**Type**|**Documentation**
1431 |TextFormat|BasicComponentTextFo rmatType|TextFormat describes an uncoded textual format.
1432 |Enumeration|com: CodelistReferenceTyp e|Enumeration references a codelist which enumerates the possible values that can be used as the representation of this concept.
1433 |EnumerationFormat|CodededTextFormatTyp e|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.
1434
1435 **ISOConceptReferenceType: **ISOConceptReferenceType provides a reference to and ISO 11179 concept.
1436
1437 Content:
1438 ConceptAgency, ConceptSchemeID, ConceptID
1439
1440 Element Documentation:
1441
1442 |**Name**|**Type**|**Documentation**
1443 |ConceptAgency|xs:string|
1444 |ConceptSchemeID|xs:string|
1445 |ConceptID|xs:string|
1446
1447 //**ConstraintBaseType**//**: **ConstraintBaseType is an abstract base type that forms the basis of the main abstract ConstraintType. It requires that a name be provided.
1448
1449 Derivation:
1450 //com:AnnotableType// (extension)
1451 //IdentifiableType// (extension)
1452 //NameableType// (extension)
1453 //VersionableType// (restriction)
1454 //MaintainableBaseType// (extension)
1455 //MaintainableType// (restriction)
1456 //ConstraintBaseType//
1457
1458 Attributes:
1459 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
1460
1461 Content:
1462 com:Annotations?, com:Name+, com:Description*
1463
1464 Attribute Documentation:
1465
1466 |**Name**|**Type**|**Documentation**
1467 |id|com:IDType|The id is the identifier for the object.
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 |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.
1471 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1472 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1473 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1474 |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.
1475 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1476 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1477 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1478
1479 Element Documentation:
1480
1481 |**Name**|**Type**|**Documentation**
1482 |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.
1483 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1484 |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.
1485
1486 //**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.
1487
1488 Derivation:
1489 //com:AnnotableType// (extension)
1490 //IdentifiableType// (extension)
1491 //NameableType// (extension)
1492 //VersionableType// (restriction)
1493 //MaintainableBaseType// (extension)
1494 //MaintainableType// (restriction)
1495 //ConstraintBaseType// (extension)
1496 //ConstraintType//
1497
1498 Attributes:
1499 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
1500
1501 Content:
1502 com:Annotations?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*
1503
1504 Attribute Documentation:
1505
1506 |**Name**|**Type**|**Documentation**
1507 |id|com:IDType|The id is the identifier for the object.
1508 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1509 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1510 |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.
1511 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1512 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1513 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1514 |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.
1515 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1516 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1517 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1518
1519 Element Documentation:
1520
1521 |**Name**|**Type**|**Documentation**
1522 |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.
1523 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1524 |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.
1525 |ConstraintAttachment|//ConstraintAttachment Type//|ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to.
1526 |DataKeySet|DataKeySetType|
1527 |MetadataKeySet|MetadataKeySetType|
1528 |CubeRegion|com:CubeRegionType|
1529 |MetadataTargetRegion|com: MetadataTargetRegion Type|
1530
1531 **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.
1532
1533 Derivation:
1534 //com:AnnotableType// (extension)
1535 //IdentifiableType// (extension)
1536 //NameableType// (extension)
1537 //VersionableType// (restriction)
1538 //MaintainableBaseType// (extension)
1539 //MaintainableType// (restriction)
1540 //ConstraintBaseType// (extension)
1541 //ConstraintType// (restriction)
1542 AttachmentConstraintType
1543
1544 Attributes:
1545 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
1546
1547 Content:
1548 com:Annotations?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet)*
1549
1550 Attribute Documentation:
1551
1552 |**Name**|**Type**|**Documentation**
1553 |id|com:IDType|The id is the identifier for the object.
1554 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1555 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1556 |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.
1557 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1558 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1559 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1560 |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.
1561 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1562 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1563 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1564
1565 Element Documentation:
1566
1567 |**Name**|**Type**|**Documentation**
1568 |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.
1569 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1570 |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.
1571 |ConstraintAttachment|AttachmentConstraint AttachmentType|ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to.
1572 |DataKeySet|DataKeySetType|
1573 |MetadataKeySet|MetadataKeySetType|
1574
1575 //**ContentConstraintBaseType**//**: **ContentConstraintBaseType is an abstract base type that forms the basis for the ContentConstraintType.
1576
1577 Derivation:
1578 //com:AnnotableType// (extension)
1579 //IdentifiableType// (extension)
1580 //NameableType// (extension)
1581 //VersionableType// (restriction)
1582 //MaintainableBaseType// (extension)
1583 //MaintainableType// (restriction)
1584 //ConstraintBaseType// (extension)
1585 //ConstraintType// (restriction)
1586 //ContentConstraintBaseType//
1587
1588 Attributes:
1589 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
1590
1591 Content:
1592 com:Annotations?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*
1593
1594 Attribute Documentation:
1595
1596 |**Name**|**Type**|**Documentation**
1597 |id|com:IDType|The id is the identifier for the object.
1598 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1599 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1600 |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.
1601 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1602 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1603 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1604 |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.
1605 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1606 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1607 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1608
1609 Element Documentation:
1610
1611 |**Name**|**Type**|**Documentation**
1612 |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.
1613 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1614 |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.
1615 |ConstraintAttachment|ContentConstraintAtt achmentType|ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to.
1616 |DataKeySet|DataKeySetType|DataKeySet defines a collection of full or partial data keys.
1617 |MetadataKeySet|MetadataKeySetType|MetadataKeySet defines a collection of metadata keys.
1618 |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.
1619 |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.
1620
1621 **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.
1622
1623 Derivation:
1624 //com:AnnotableType// (extension)
1625 //IdentifiableType// (extension)
1626 //NameableType// (extension)
1627 //VersionableType// (restriction)
1628 //MaintainableBaseType// (extension)
1629 //MaintainableType// (restriction)
1630 //ConstraintBaseType// (extension)
1631 //ConstraintType// (restriction)
1632 //ContentConstraintBaseType// (extension)
1633 ContentConstraintType
1634
1635 Attributes:
1636 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, type?
1637
1638 Content:
1639 com:Annotations?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*, ReleaseCalendar?, ReferencePeriod?
1640
1641 Attribute Documentation:
1642
1643 |**Name**|**Type**|**Documentation**
1644 |id|com:IDType|The id is the identifier for the object.
1645 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1646 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1647 |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.
1648 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1649 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1650 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1651 |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.
1652 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1653 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1654 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1655 |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.
1656
1657 Element Documentation:
1658
1659 |**Name**|**Type**|**Documentation**
1660 |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.
1661 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1662 |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.
1663 |ConstraintAttachment|ContentConstraintAtt achmentType|ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to.
1664 |DataKeySet|DataKeySetType|DataKeySet defines a collection of full or partial data keys.
1665 |MetadataKeySet|MetadataKeySetType|MetadataKeySet defines a collection of metadata keys.
1666 |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.
1667 |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.
1668 |ReleaseCalendar|ReleaseCalendarType|ReleaseCalendar defines dates on which the constrained data is to be made available.
1669 |ReferencePeriod|com: ReferencePeriodType|ReferencePeriod is used to report start date and end date constraints.
1670
1671 **ReleaseCalendarType: **ReleaseCalendarType describes information about the timing of releases of the constrained data. All of these values use the standard "P7D" - style format.
1672
1673 Content:
1674 Periodicity, Offset, Tolerance
1675
1676 Element Documentation:
1677
1678 |**Name**|**Type**|**Documentation**
1679 |Periodicity|xs:string|Periodicity is the period between releases of the data set.
1680 |Offset|xs:string|Offset is the interval between January first and the first release of data within the year.
1681 |Tolerance|xs:string|Tolerance is the period after which the release of data may be deemed late.
1682
1683 //**KeySetType**//**: **KeySetType is an abstract base type for defining a collection of keys.
1684
1685 Attributes:
1686 isIncluded
1687
1688 Content:
1689 Key+
1690
1691 Attribute Documentation:
1692
1693 |**Name**|**Type**|**Documentation**
1694 |isIncluded|xs:boolean|The isIncluded attribute indicates whether the keys defined in this key set are inclusive or exclusive to the constraint.
1695
1696 Element Documentation:
1697
1698 |**Name**|**Type**|**Documentation**
1699 |Key|//com:DistinctKeyType//|Key contains a data or metadata key, which are sets of component values which identify the data or metadata.
1700
1701 **DataKeySetType: **DataKeySetType defines a collection of full or partial data keys (dimension values).
1702
1703 Derivation:
1704 //KeySetType// (restriction)
1705 DataKeySetType
1706
1707 Attributes:
1708 isIncluded
1709
1710 Content:
1711 Key+
1712
1713 Attribute Documentation:
1714
1715 |**Name**|**Type**|**Documentation**
1716 |isIncluded|xs:boolean|The isIncluded attribute indicates whether the keys defined in this key set are inclusive or exclusive to the constraint.
1717
1718 Element Documentation:
1719
1720 |**Name**|**Type**|**Documentation**
1721 |Key|com:DataKeyType|Key contains a set of dimension values which identify a full set of data.
1722
1723 **MetadataKeySetType: **MetadataKeySetType defines a collection of metadata keys (identifier component values).
1724
1725 Derivation:
1726 //KeySetType// (restriction)
1727 MetadataKeySetType
1728
1729 Attributes:
1730 isIncluded
1731
1732 Content:
1733 Key+
1734
1735 Attribute Documentation:
1736
1737 |**Name**|**Type**|**Documentation**
1738 |isIncluded|xs:boolean|The isIncluded attribute indicates whether the keys defined in this key set are inclusive or exclusive to the constraint.
1739
1740 Element Documentation:
1741
1742 |**Name**|**Type**|**Documentation**
1743 |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.
1744
1745 //**ConstraintAttachmentType**//**: **ConstraintAttachmentType describes a collection of references to constrainable artefacts.
1746
1747 Content:
1748 (DataProvider | DataSet+ | MetadataSet+ | SimpleDataSource+ | (DataStructure+, QueryableDataSource*) | (MetadataStructure+, QueryableDataSource*) | (Dataflow+, QueryableDataSource*) | (Metadataflow+, QueryableDataSource*) | (ProvisionAgreement+, QueryableDataSource*))
1749
1750 Element Documentation:
1751
1752 |**Name**|**Type**|**Documentation**
1753 |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.
1754 |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.
1755 |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.
1756 |SimpleDataSource|xs:anyURI|SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message.
1757 |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.
1758 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1759 |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.
1760 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1761 |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.
1762 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1763 |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.
1764 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1765 |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.
1766 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1767
1768 **AttachmentConstraintAttachmentType: **AttachmentConstraintAttachmentType defines the structure for specifying the object to which an attachment constraints applies.
1769
1770 Derivation:
1771 //ConstraintAttachmentType// (restriction)
1772 AttachmentConstraintAttachmentType
1773
1774 Content:
1775 (DataSet+ | MetadataSet+ | SimpleDataSource+ | DataStructure+ | MetadataStructure+ | Dataflow+ | Metadataflow+ | ProvisionAgreement+)
1776
1777 Element Documentation:
1778
1779 |**Name**|**Type**|**Documentation**
1780 |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.
1781 |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.
1782 |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.
1783 |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.
1784 |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.
1785 |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.
1786 |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.
1787 |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.
1788
1789 **ContentConstraintAttachmentType: **ContentConstraintAttachmentType defines the structure for specifying the target object(s) of a content constraint.
1790
1791 Derivation:
1792 //ConstraintAttachmentType// (restriction)
1793 ContentConstraintAttachmentType
1794
1795 Content:
1796 (DataProvider | DataSet | MetadataSet | SimpleDataSource | (DataStructure+, QueryableDataSource*) | (MetadataStructure+, QueryableDataSource*) | (Dataflow+, QueryableDataSource*) | (Metadataflow+, QueryableDataSource*) | (ProvisionAgreement+, QueryableDataSource*))
1797
1798 Element Documentation:
1799
1800 |**Name**|**Type**|**Documentation**
1801 |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.
1802 |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.
1803 |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.
1804 |SimpleDataSource|xs:anyURI|SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message.
1805 |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.
1806 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1807 |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.
1808 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1809 |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.
1810 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1811 |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.
1812 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1813 |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.
1814 |QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.
1815
1816 **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.
1817
1818 Derivation:
1819 //com:AnnotableType// (extension)
1820 //IdentifiableType// (extension)
1821 //NameableType// (extension)
1822 //VersionableType// (restriction)
1823 //MaintainableBaseType// (extension)
1824 //MaintainableType// (extension)
1825 //StructureType// (restriction)
1826 DataStructureType
1827
1828 Attributes:
1829 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
1830
1831 Content:
1832 com:Annotations?, com:Name+, com:Description*, DataStructureComponents?
1833
1834 Attribute Documentation:
1835
1836 |**Name**|**Type**|**Documentation**
1837 |id|com:IDType|The id is the identifier for the object.
1838 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1839 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1840 |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.
1841 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
1842 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
1843 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
1844 |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.
1845 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
1846 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
1847 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
1848
1849 Element Documentation:
1850
1851 |**Name**|**Type**|**Documentation**
1852 |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.
1853 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
1854 |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.
1855 |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.
1856
1857 //**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.
1858
1859 Derivation:
1860 //GroupingType// (restriction)
1861 //DataStructureComponentsBaseType//
1862
1863 Content:
1864 {Empty}
1865
1866 **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.
1867
1868 Derivation:
1869 //GroupingType// (restriction)
1870 //DataStructureComponentsBaseType// (extension)
1871 DataStructureComponentsType
1872
1873 Content:
1874 DimensionList, Group*, AttributeList?, MeasureList
1875
1876 Element Documentation:
1877
1878 |**Name**|**Type**|**Documentation**
1879 |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.
1880 |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.
1881 |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.
1882 |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.
1883
1884 //**AttributeListBaseType**//**: **AttributeListBaseType is an abstract base type used as the basis for the AttributeListType.
1885
1886 Derivation:
1887
1888 //com:AnnotableType// (extension)
1889 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
1890 [[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)
1891 [[image:inherit.gif||height="9" width="9"]] //AttributeListBaseType//
1892
1893 Attributes:
1894 id?, urn?, uri?
1895
1896 Content:
1897 com:Annotations?
1898
1899 Attribute Documentation:
1900
1901 |**Name**|**Type**|**Documentation**
1902 |id (fixed: AttributeDescriptor)|com:IDType|The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor.
1903 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1904 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1905
1906 Element Documentation:
1907
1908 |**Name**|**Type**|**Documentation**
1909 |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.
1910
1911 **AttributeListType: **AttributeListType describes the attribute descriptor for the data structure definition.
1912
1913 Derivation:
1914 //com:AnnotableType// (extension)
1915 //IdentifiableType// (extension)
1916 //ComponentListType// (restriction)
1917 //AttributeListBaseType// (extension)
1918 AttributeListType
1919
1920 Attributes:
1921 id?, urn?, uri?
1922
1923 Content:
1924 com:Annotations?, (Attribute | ReportingYearStartDay)+
1925
1926 Attribute Documentation:
1927
1928 |**Name**|**Type**|**Documentation**
1929 |id (fixed: AttributeDescriptor)|com:IDType|The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor.
1930 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1931 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1932
1933 Element Documentation:
1934
1935 |**Name**|**Type**|**Documentation**
1936 |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.
1937 |Attribute|AttributeType|Attribute describes the definition of a data attribute, which is defined as a characteristic of an object or entity.
1938 |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.
1939
1940 //**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.
1941
1942 Derivation:
1943 //com:AnnotableType// (extension)
1944 //IdentifiableType// (restriction)
1945 //ComponentBaseType// (extension)
1946 //ComponentType// (restriction)
1947 //AttributeBaseType//
1948
1949 Attributes:
1950 id?, urn?, uri?
1951
1952 Content:
1953 com:Annotations?, ConceptIdentity, LocalRepresentation?
1954
1955 Attribute Documentation:
1956
1957 |**Name**|**Type**|**Documentation**
1958 |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).
1959 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1960 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1961
1962 Element Documentation:
1963
1964 |**Name**|**Type**|**Documentation**
1965 |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.
1966 |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.
1967 |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.
1968
1969 **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.
1970
1971 Derivation:
1972 //com:AnnotableType// (extension)
1973 //IdentifiableType// (restriction)
1974 //ComponentBaseType// (extension)
1975 //ComponentType// (restriction)
1976 //AttributeBaseType// (extension)
1977 AttributeType
1978
1979 Attributes:
1980 id?, urn?, uri?, assignmentStatus
1981
1982 Content:
1983 com:Annotations?, ConceptIdentity, LocalRepresentation?, ConceptRole*, AttributeRelationship
1984
1985 Attribute Documentation:
1986
1987 |**Name**|**Type**|**Documentation**
1988 |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).
1989 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
1990 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
1991 |assignmentStatus|UsageStatusType|The assignmentStatus attribute indicates whether a value must be provided for the attribute when sending documentation along with the data.
1992
1993 Element Documentation:
1994
1995 |**Name**|**Type**|**Documentation**
1996 |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.
1997 |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.
1998 |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.
1999 |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.
2000 |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.
2001
2002 **AttributeRelationshipType: **AttributeRelationshipType defines the structure for stating the relationship between an attribute and other data structure definition components.
2003
2004 Content:
2005 (None | (Dimension+, AttachmentGroup*) | Group | PrimaryMeasure)
2006
2007 Element Documentation:
2008
2009 |**Name**|**Type**|**Documentation**
2010 |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.
2011 |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.
2012 |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.
2013 |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.
2014 |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.
2015
2016 **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.
2017
2018 Derivation:
2019 //com:AnnotableType// (extension)
2020 //IdentifiableType// (restriction)
2021 //ComponentBaseType// (extension)
2022 //ComponentType// (restriction)
2023 //AttributeBaseType// (extension)
2024 AttributeType (restriction)
2025 ReportingYearStartDayType
2026
2027 Attributes:
2028 id?, urn?, uri?, assignmentStatus
2029
2030 Content:
2031 com:Annotations?, ConceptIdentity, LocalRepresentation, AttributeRelationship
2032
2033 Attribute Documentation:
2034
2035 |**Name**|**Type**|**Documentation**
2036 |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).
2037 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2038 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2039 |assignmentStatus|UsageStatusType|The assignmentStatus attribute indicates whether a value must be provided for the attribute when sending documentation along with the data.
2040
2041 Element Documentation:
2042
2043 |**Name**|**Type**|**Documentation**
2044 |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.
2045 |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.
2046 |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.
2047 |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.
2048
2049 **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'.
2050
2051 Derivation:
2052 //RepresentationType// (restriction)
2053 //DataStructureRepresentationType// (restriction)
2054 SimpleDataStructureRepresentationType (restriction)
2055 ReportingYearStartDayRepresentationType
2056
2057 Content:
2058 TextFormat
2059
2060 Element Documentation:
2061
2062 |**Name**|**Type**|**Documentation**
2063 |TextFormat|ReportingYearStartDa yTextFormatType|TextFormat describes an uncoded textual format.
2064
2065 **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.
2066
2067 Derivation:
2068 TextFormatType (restriction)
2069 BasicComponentTextFormatType (restriction)
2070 SimpleComponentTextFormatType (restriction)
2071 NonFacetedTextFormatType (restriction)
2072 ReportingYearStartDayTextFormatType
2073
2074 Attributes:
2075 textType?
2076
2077 Content:
2078 {Empty}
2079
2080 Attribute Documentation:
2081
2082 |**Name**|**Type**|**Documentation**
2083 |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.
2084
2085 //**DimensionListBaseType**//**: **DimensionListBaseType is an abstract base type used as the basis for the DimensionListType.
2086
2087 Derivation:
2088 //com:AnnotableType// (extension)
2089 //IdentifiableType// (extension)
2090 //ComponentListType// (restriction)
2091 //DimensionListBaseType//
2092
2093 Attributes:
2094 id?, urn?, uri?
2095
2096 Content:
2097 com:Annotations?
2098
2099 Attribute Documentation:
2100
2101 |**Name**|**Type**|**Documentation**
2102 |id (fixed: DimensionDescriptor)|com:IDType|The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor.
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
2111 **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.
2112
2113 Derivation:
2114 //com:AnnotableType// (extension)
2115 //IdentifiableType// (extension)
2116 //ComponentListType// (restriction)
2117 //DimensionListBaseType// (extension)
2118 DimensionListType
2119
2120 Attributes:
2121 id?, urn?, uri?
2122
2123 Content:
2124 com:Annotations?, (Dimension | MeasureDimension | TimeDimension)+
2125
2126 Attribute Documentation:
2127
2128 |**Name**|**Type**|**Documentation**
2129 |id (fixed: DimensionDescriptor)|com:IDType|The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor.
2130 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2131 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2132
2133 Element Documentation:
2134
2135 |**Name**|**Type**|**Documentation**
2136 |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.
2137 |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.
2138 |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.
2139 |TimeDimension|TimeDimensionType|TimeDimension is a special dimension which designates the period in time in which the data identified by the full series key applies.
2140
2141 //**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).
2142
2143 Derivation:
2144 //com:AnnotableType// (extension)
2145 //IdentifiableType// (restriction)
2146 //ComponentBaseType// (extension)
2147 //ComponentType// (restriction)
2148 //BaseDimensionBaseType//
2149
2150 Attributes:
2151 id?, urn?, uri?
2152
2153 Content:
2154 com:Annotations?, ConceptIdentity, LocalRepresentation?
2155
2156 Attribute Documentation:
2157
2158 |**Name**|**Type**|**Documentation**
2159 |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).
2160 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2161 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2162
2163 Element Documentation:
2164
2165 |**Name**|**Type**|**Documentation**
2166 |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.
2167 |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.
2168 |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.
2169
2170 //**BaseDimensionType**//**: **BaseDimensionType is an abstract base type which defines the basic structure of all dimensions.
2171
2172 Derivation:
2173 //com:AnnotableType// (extension)
2174 //IdentifiableType// (restriction)
2175 //ComponentBaseType// (extension)
2176 //ComponentType// (restriction)
2177 //BaseDimensionBaseType// (extension)
2178 //BaseDimensionType//
2179
2180 Attributes:
2181 id?, urn?, uri?, position?, type?
2182
2183 Content:
2184 com:Annotations?, ConceptIdentity, LocalRepresentation?, ConceptRole*
2185
2186 Attribute Documentation:
2187
2188 |**Name**|**Type**|**Documentation**
2189 |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).
2190 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2191 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2192 |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.
2193 |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.
2194
2195 Element Documentation:
2196
2197 |**Name**|**Type**|**Documentation**
2198 |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.
2199 |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.
2200 |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.
2201 |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.
2202
2203 **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.
2204
2205 Derivation:
2206 //com:AnnotableType// (extension)
2207 //IdentifiableType// (restriction)
2208 //ComponentBaseType// (extension)
2209 //ComponentType// (restriction)
2210 //BaseDimensionBaseType// (extension)
2211 //BaseDimensionType// (restriction)
2212 DimensionType
2213
2214 Attributes:
2215 id?, urn?, uri?, position?, type?
2216
2217 Content:
2218 com:Annotations?, ConceptIdentity, LocalRepresentation?, ConceptRole*
2219
2220 Attribute Documentation:
2221
2222 |**Name**|**Type**|**Documentation**
2223 |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).
2224 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2225 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2226 |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.
2227 |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.
2228
2229 Element Documentation:
2230
2231 |**Name**|**Type**|**Documentation**
2232 |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.
2233 |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.
2234 |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.
2235 |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.
2236
2237 **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.
2238
2239 Derivation:
2240 //com:AnnotableType// (extension)
2241 //IdentifiableType// (restriction)
2242 //ComponentBaseType// (extension)
2243 //ComponentType// (restriction)
2244 //BaseDimensionBaseType// (extension)
2245 //BaseDimensionType// (restriction)
2246 TimeDimensionType
2247
2248 Attributes:
2249 id?, urn?, uri?, position?, type?
2250
2251 Content:
2252 com:Annotations?, ConceptIdentity, LocalRepresentation
2253
2254 Attribute Documentation:
2255
2256 |**Name**|**Type**|**Documentation**
2257 |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).
2258 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2259 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2260 |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.
2261 |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.
2262
2263 Element Documentation:
2264
2265 |**Name**|**Type**|**Documentation**
2266 |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.
2267 |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.
2268 |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.
2269
2270 **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.
2271
2272 Derivation:
2273 //com:AnnotableType// (extension)
2274 //IdentifiableType// (restriction)
2275 //ComponentBaseType// (extension)
2276 //ComponentType// (restriction)
2277 //BaseDimensionBaseType// (extension)
2278 //BaseDimensionType// (restriction)
2279 MeasureDimensionType
2280
2281 Attributes:
2282 id?, urn?, uri?, position?, type?
2283
2284 Content:
2285 com:Annotations?, ConceptIdentity, LocalRepresentation, ConceptRole*
2286
2287 Attribute Documentation:
2288
2289 |**Name**|**Type**|**Documentation**
2290 |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).
2291 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2292 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2293 |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.
2294 |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.
2295
2296 Element Documentation:
2297
2298 |**Name**|**Type**|**Documentation**
2299 |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.
2300 |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.
2301 |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.
2302 |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.
2303
2304 //**GroupBaseType**//**: **GroupBaseType is an abstract base type that forms the basis for the GroupType.
2305
2306 Derivation:
2307 //com:AnnotableType// (extension)
2308 //IdentifiableType// (extension)
2309 //ComponentListType// (restriction)
2310 //GroupBaseType//
2311
2312 Attributes:
2313 id, urn?, uri?
2314
2315 Content:
2316 com:Annotations?
2317
2318 Attribute Documentation:
2319
2320 |**Name**|**Type**|**Documentation**
2321 |id|com:IDType|The id is the identifier for the object.
2322 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2323 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2324
2325 Element Documentation:
2326
2327 |**Name**|**Type**|**Documentation**
2328 |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.
2329
2330 **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.
2331
2332 Derivation:
2333 //com:AnnotableType// (extension)
2334 //IdentifiableType// (extension)
2335 //ComponentListType// (restriction)
2336 //GroupBaseType// (extension)
2337 GroupType
2338
2339 Attributes:
2340 id, urn?, uri?
2341
2342 Content:
2343 com:Annotations?, (GroupDimension+ | AttachmentConstraint)
2344
2345 Attribute Documentation:
2346
2347 |**Name**|**Type**|**Documentation**
2348 |id|com:IDType|The id is the identifier for the object.
2349 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2350 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2351
2352 Element Documentation:
2353
2354 |**Name**|**Type**|**Documentation**
2355 |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.
2356 |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.
2357 |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.
2358
2359 //**GroupDimensionBaseType**//**: **GroupDimensionBaseType is an abstract base type which refines the base ComponentType in order to form the basis for the GroupDimensionType.
2360
2361 Derivation:
2362 //com:AnnotableType// (extension)
2363 //IdentifiableType// (restriction)
2364 //ComponentBaseType// (extension)
2365 //ComponentType// (restriction)
2366 //GroupDimensionBaseType//
2367
2368 Content:
2369 {Empty}
2370
2371 **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.
2372
2373 Derivation:
2374 //com:AnnotableType// (extension)
2375 //IdentifiableType// (restriction)
2376 //ComponentBaseType// (extension)
2377 //ComponentType// (restriction)
2378 //GroupDimensionBaseType// (extension)
2379 GroupDimensionType
2380
2381 Content:
2382 DimensionReference
2383
2384 Element Documentation:
2385
2386 |**Name**|**Type**|**Documentation**
2387 |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.
2388
2389 **MeasureListType: **MeasureListType describes the structure of the measure descriptor for a data structure definition. Only a primary may be defined.
2390
2391 Derivation:
2392 //com:AnnotableType// (extension)
2393 //IdentifiableType// (extension)
2394 //ComponentListType// (restriction)
2395 MeasureListType
2396
2397 Attributes:
2398 id?, urn?, uri?
2399
2400 Content:
2401 com:Annotations?, PrimaryMeasure
2402
2403 Attribute Documentation:
2404
2405 |**Name**|**Type**|**Documentation**
2406 |id (fixed: MeasureDescriptor)|com:IDType|The id is the identifier for the object.
2407 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2408 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2409
2410 Element Documentation:
2411
2412 |**Name**|**Type**|**Documentation**
2413 |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.
2414 |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.
2415
2416 **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.
2417
2418 Derivation:
2419 //com:AnnotableType// (extension)
2420 //IdentifiableType// (restriction)
2421 //ComponentBaseType// (extension)
2422 //ComponentType// (restriction)
2423 PrimaryMeasureType
2424
2425 Attributes:
2426 id?, urn?, uri?
2427
2428 Content:
2429 com:Annotations?, ConceptIdentity, LocalRepresentation?
2430
2431 Attribute Documentation:
2432
2433 |**Name**|**Type**|**Documentation**
2434 |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).
2435 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2436 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2437
2438 Element Documentation:
2439
2440 |**Name**|**Type**|**Documentation**
2441 |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.
2442 |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.
2443 |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.
2444
2445 //**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.
2446
2447 Derivation:
2448 //RepresentationType// (restriction)
2449 //DataStructureRepresentationType//
2450
2451 Content:
2452 (TextFormat | (Enumeration, EnumerationFormat?))
2453
2454 Element Documentation:
2455
2456 |**Name**|**Type**|**Documentation**
2457 |TextFormat|SimpleComponentTextF ormatType|TextFormat describes an uncoded textual format.
2458 |Enumeration|//com: ItemSchemeReferenceB aseType//|Enumeration references an item scheme that enumerates the allowable values for this representation.
2459 |EnumerationFormat|CodededTextFormatTyp e|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.
2460
2461 **SimpleDataStructureRepresentationType: **SimpleDataStructureRepresentationType defines the representation for any non-measure and non-time dimension data structure definition component.
2462
2463 Derivation:
2464
2465 //RepresentationType// (restriction)
2466 [[image:inherit.gif||height="9" width="9"]] //DataStructureRepresentationType// (restriction)
2467 [[image:inherit.gif||height="9" width="9"]] SimpleDataStructureRepresentationType
2468
2469 Content:
2470 (TextFormat | (Enumeration, EnumerationFormat?))
2471
2472 Element Documentation:
2473
2474 |**Name**|**Type**|**Documentation**
2475 |TextFormat|SimpleComponentTextF ormatType|TextFormat describes an uncoded textual format.
2476 |Enumeration|com: CodelistReferenceTyp e|Enumeration references an item scheme that enumerates the allowable values for this representation.
2477 |EnumerationFormat|CodededTextFormatTyp e|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.
2478
2479 **MeasureDimensionRepresentationType: **BaseDimensionRepresentationType is an abstract base which defines the representation for a measure dimension.
2480
2481 Derivation:
2482 //RepresentationType// (restriction)
2483 //DataStructureRepresentationType// (restriction)
2484 MeasureDimensionRepresentationType
2485
2486 Content:
2487 Enumeration
2488
2489 Element Documentation:
2490
2491 |**Name**|**Type**|**Documentation**
2492 |Enumeration|com: ConceptSchemeReferen ceType|Enumeration references an item scheme that enumerates the allowable values for this representation.
2493
2494 **TimeDimensionRepresentationType: **TimeDimensionRepresentationType defines the representation for the time dimension. Enumerated values are not allowed.
2495
2496 Derivation:
2497 //RepresentationType// (restriction)
2498 //DataStructureRepresentationType// (restriction)
2499 SimpleDataStructureRepresentationType (restriction)
2500 TimeDimensionRepresentationType
2501
2502 Content:
2503 TextFormat
2504
2505 Element Documentation:
2506
2507 |**Name**|**Type**|**Documentation**
2508 |TextFormat|TimeTextFormatType|TextFormat describes an uncoded textual format.
2509
2510 **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.
2511
2512 Derivation:
2513 //com:AnnotableType// (extension)
2514 //IdentifiableType// (extension)
2515 //NameableType// (extension)
2516 //VersionableType// (restriction)
2517 //MaintainableBaseType// (extension)
2518 //MaintainableType// (extension)
2519 //StructureUsageType// (restriction)
2520 DataflowType
2521
2522 Attributes:
2523 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
2524
2525 Content:
2526 com:Annotations?, com:Name+, com:Description*, Structure?
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 |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.
2535 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
2536 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
2537 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
2538 |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.
2539 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
2540 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
2541 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
2542
2543 Element Documentation:
2544
2545 |**Name**|**Type**|**Documentation**
2546 |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.
2547 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
2548 |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.
2549 |Structure|com: DataStructureReferen ceType|Structure provides a reference to the data structure definition which defines the structure of all data for this flow.
2550
2551 //**HierarchicalCodelistBaseType**//**: **HierarchicalCodelistBaseType is an abstract base class that is the basis for the HierarchicalCodelistType. It requires that a name be supplied.
2552
2553 Derivation:
2554 //com:AnnotableType// (extension)
2555 //IdentifiableType// (extension)
2556 //NameableType// (extension)
2557 //VersionableType// (restriction)
2558 //MaintainableBaseType// (extension)
2559 //MaintainableType// (restriction)
2560 //HierarchicalCodelistBaseType//
2561
2562 Attributes:
2563 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
2564
2565 Content:
2566 com:Annotations?, com:Name+, com:Description*
2567
2568 Attribute Documentation:
2569
2570 |**Name**|**Type**|**Documentation**
2571 |id|com:IDType|The id is the identifier for the object.
2572 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2573 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2574 |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.
2575 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
2576 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
2577 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
2578 |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.
2579 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
2580 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
2581 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
2582
2583 Element Documentation:
2584
2585 |**Name**|**Type**|**Documentation**
2586 |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.
2587 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
2588 |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.
2589
2590 **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.
2591
2592 Derivation:
2593 //com:AnnotableType// (extension)
2594 //IdentifiableType// (extension)
2595 //NameableType// (extension)
2596 //VersionableType// (restriction)
2597 //MaintainableBaseType// (extension)
2598 //MaintainableType// (restriction)
2599 //HierarchicalCodelistBaseType// (extension)
2600 HierarchicalCodelistType
2601
2602 Attributes:
2603 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
2604
2605 Content:
2606 com:Annotations?, com:Name+, com:Description*, IncludedCodelist*, Hierarchy*
2607
2608 Attribute Documentation:
2609
2610 |**Name**|**Type**|**Documentation**
2611 |id|com:IDType|The id is the identifier for the object.
2612 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2613 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2614 |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.
2615 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
2616 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
2617 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
2618 |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.
2619 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
2620 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
2621 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
2622
2623 Element Documentation:
2624
2625 |**Name**|**Type**|**Documentation**
2626 |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.
2627 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
2628 |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.
2629 |IncludedCodelist|IncludedCodelistRefe renceType|IndludedCodelist provides a collection of references to the code lists whose codes are arranged in this hierarchical code list.
2630 |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.
2631
2632 //**HierarchyBaseType**//**: **HierarchyBaseType is an abstract base type that serves as the basis for the HierarchyType. It requires a name and id be provided.
2633
2634 Derivation:
2635 //com:AnnotableType// (extension)
2636 //IdentifiableType// (extension)
2637 //NameableType// (restriction)
2638 //HierarchyBaseType//
2639
2640 Attributes:
2641 id, urn?, uri?
2642
2643 Content:
2644 com:Annotations?, com:Name+, com:Description*
2645
2646 Attribute Documentation:
2647
2648 |**Name**|**Type**|**Documentation**
2649 |id|com:IDType|The id is the identifier for the object.
2650 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2651 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2652
2653 Element Documentation:
2654
2655 |**Name**|**Type**|**Documentation**
2656 |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.
2657 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
2658 |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.
2659
2660 **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.
2661
2662 Derivation:
2663 //com:AnnotableType// (extension)
2664 //IdentifiableType// (extension)
2665 //NameableType// (restriction)
2666 //HierarchyBaseType// (extension)
2667 HierarchyType
2668
2669 Attributes:
2670 id, urn?, uri?, leveled?
2671
2672 Content:
2673 com:Annotations?, com:Name+, com:Description*, HierarchicalCode+, Level?
2674
2675 Attribute Documentation:
2676
2677 |**Name**|**Type**|**Documentation**
2678 |id|com:IDType|The id is the identifier for the object.
2679 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2680 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2681 |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.
2682
2683 Element Documentation:
2684
2685 |**Name**|**Type**|**Documentation**
2686 |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.
2687 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
2688 |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.
2689 |HierarchicalCode|HierarchicalCodeType|HierarchicalCode is used to assemble the codes from the codelist(s) referenced into a hierarchy.
2690 |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.
2691
2692 //**HierarchicalCodeBaseType**//**: **HierarchicalCodeBaseType is an abstract base type the creates the basis for the HierarchicalCodeType. It removes the urn and uri.
2693
2694 Derivation:
2695 //com:AnnotableType// (extension)
2696 //IdentifiableType// (restriction)
2697 //HierarchicalCodeBaseType//
2698
2699 Attributes:
2700 id, urn?, uri?
2701
2702 Content:
2703 com:Annotations?
2704
2705 Attribute Documentation:
2706
2707 |**Name**|**Type**|**Documentation**
2708 |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.
2709 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2710 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2711
2712 Element Documentation:
2713
2714 |**Name**|**Type**|**Documentation**
2715 |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.
2716
2717 **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.
2718
2719 Derivation:
2720 //com:AnnotableType// (extension)
2721 //IdentifiableType// (restriction)
2722 //HierarchicalCodeBaseType// (extension)
2723 HierarchicalCodeType
2724
2725 Attributes:
2726 id, urn?, uri?, version?, validFrom?, validTo?
2727
2728 Content:
2729 com:Annotations?, (Code | (CodelistAliasRef, CodeID)), HierarchicalCode*, Level?
2730
2731 Attribute Documentation:
2732
2733 |**Name**|**Type**|**Documentation**
2734 |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.
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|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.
2738 |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.
2739 |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.
2740
2741 Element Documentation:
2742
2743 |**Name**|**Type**|**Documentation**
2744 |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.
2745 |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.
2746 |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.
2747 |CodeID|com: LocalCodeReferenceTy pe|CodeID references the id of a code from the codelist that is referenced through the CodelistAliaRef element.
2748 |HierarchicalCode|HierarchicalCodeType|HierarchicalCode is used to nest referenced codes into a value based hierarchy.
2749 |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.
2750
2751 //**LevelBaseType**//**: **LevelBaseType is an abstract base type that makes up the basis for the LevelType. It requires a name and id.
2752
2753 Derivation:
2754 //com:AnnotableType// (extension)
2755 //IdentifiableType// (extension)
2756 //NameableType// (restriction)
2757 //LevelBaseType//
2758
2759 Attributes:
2760 id, urn?, uri?
2761
2762 Content:
2763 com:Annotations?, com:Name+, com:Description*
2764
2765 Attribute Documentation:
2766
2767 |**Name**|**Type**|**Documentation**
2768 |id|com:IDType|The id is the identifier for the object.
2769 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2770 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2771
2772 Element Documentation:
2773
2774 |**Name**|**Type**|**Documentation**
2775 |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.
2776 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
2777 |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.
2778
2779 **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.
2780
2781 Derivation:
2782 //com:AnnotableType// (extension)
2783 //IdentifiableType// (extension)
2784 //NameableType// (restriction)
2785 //LevelBaseType// (extension)
2786 LevelType
2787
2788 Attributes:
2789 id, urn?, uri?
2790
2791 Content:
2792 com:Annotations?, com:Name+, com:Description*, CodingFormat?, Level?
2793
2794 Attribute Documentation:
2795
2796 |**Name**|**Type**|**Documentation**
2797 |id|com:IDType|The id is the identifier for the object.
2798 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2799 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2800
2801 Element Documentation:
2802
2803 |**Name**|**Type**|**Documentation**
2804 |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.
2805 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
2806 |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.
2807 |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.
2808 |Level|LevelType|Level describes the next level down in the hierarchy.
2809
2810 **IncludedCodelistReferenceType: **IncludedCodelistReferenceType provides the structure for a referencing a codelist and optionally providing a local alias identification for this reference.
2811
2812 Derivation:
2813 //com:ReferenceType// (restriction)
2814 //com:MaintainableReferenceBaseType// (restriction)
2815 //com:ItemSchemeReferenceBaseType// (restriction)
2816 com:CodelistReferenceType (extension)
2817 IncludedCodelistReferenceType
2818
2819 Attributes:
2820 alias?
2821
2822 Content:
2823 ( (Ref, URN?) | URN)
2824
2825 Attribute Documentation:
2826
2827 |**Name**|**Type**|**Documentation**
2828 |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.
2829
2830 Element Documentation:
2831
2832 |**Name**|**Type**|**Documentation**
2833 |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.
2834 |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.
2835 |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.
2836
2837 **CodingTextFormatType:**
2838
2839 Derivation:
2840 TextFormatType (restriction)
2841 BasicComponentTextFormatType (restriction)
2842 SimpleComponentTextFormatType (restriction)
2843 CodingTextFormatType
2844
2845 Attributes:
2846 textType?, isSequence?, interval?, startValue?, endValue?, minLength?, maxLength?, minValue?, maxValue?, pattern?
2847
2848 Content:
2849 {Empty}
2850
2851 Attribute Documentation:
2852
2853 |**Name**|**Type**|**Documentation**
2854 |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.
2855 |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.
2856 |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.
2857 |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.
2858 |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.
2859 |minLength|xs:positiveInteger|The minLength attribute specifies the minimum and length of the value in characters.
2860 |maxLength|xs:positiveInteger|The maxLength attribute specifies the maximum length of the value in characters.
2861 |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.
2862 |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.
2863 |pattern|xs:string|The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema.
2864
2865 **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
2866
2867 Derivation:
2868 //com:AnnotableType// (extension)
2869 //IdentifiableType// (extension)
2870 //NameableType// (extension)
2871 //VersionableType// (restriction)
2872 //MaintainableBaseType// (extension)
2873 //MaintainableType// (extension)
2874 //StructureUsageType// (restriction)
2875 MetadataflowType
2876
2877 Attributes:
2878 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
2879
2880 Content:
2881 com:Annotations?, com:Name+, com:Description*, Structure?
2882
2883 Attribute Documentation:
2884
2885 |**Name**|**Type**|**Documentation**
2886 |id|com:IDType|The id is the identifier for the object.
2887 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2888 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2889 |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.
2890 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
2891 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
2892 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
2893 |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.
2894 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
2895 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
2896 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
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 |Structure|com: MetadataStructureRef erenceType|Structure provides a reference to the metadata structure definition describing the structure of all reference metadata for this flow.
2905
2906 **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.
2907
2908 Derivation:
2909 //com:AnnotableType// (extension)
2910 //IdentifiableType// (extension)
2911 //NameableType// (extension)
2912 //VersionableType// (restriction)
2913 //MaintainableBaseType// (extension)
2914 //MaintainableType// (extension)
2915 //StructureType// (restriction)
2916 MetadataStructureType
2917
2918 Attributes:
2919 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
2920
2921 Content:
2922 com:Annotations?, com:Name+, com:Description*, MetadataStructureComponents?
2923
2924 Attribute Documentation:
2925
2926 |**Name**|**Type**|**Documentation**
2927 |id|com:IDType|The id is the identifier for the object.
2928 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2929 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2930 |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.
2931 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
2932 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
2933 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
2934 |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.
2935 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
2936 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
2937 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
2938
2939 Element Documentation:
2940
2941 |**Name**|**Type**|**Documentation**
2942 |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.
2943 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
2944 |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.
2945 |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.
2946
2947 **MetadataStructureComponentsBaseType: **MetadataStructureComponentsBaseType is an abstract base type that forms the basis for the MetadataStructureComponentsType.
2948
2949 Derivation:
2950 //GroupingType// (restriction)
2951 MetadataStructureComponentsBaseType
2952
2953 Content:
2954 {Empty}
2955
2956 **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.
2957
2958 Derivation:
2959 //GroupingType// (restriction)
2960 MetadataStructureComponentsBaseType (extension)
2961 MetadataStructureComponentsType
2962
2963 Content:
2964 MetadataTarget+, ReportStructure+
2965
2966 Element Documentation:
2967
2968 |**Name**|**Type**|**Documentation**
2969 |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.
2970 |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.
2971
2972 //**MetadataTargetBaseType**//**: **MetadataTargetBaseType is an abstract base type which forms the basis for the MetadataTargetType.
2973
2974 Derivation:
2975 //com:AnnotableType// (extension)
2976 //IdentifiableType// (extension)
2977 //ComponentListType// (restriction)
2978 //MetadataTargetBaseType//
2979
2980 Attributes:
2981 id, urn?, uri?
2982
2983 Content:
2984 com:Annotations?
2985
2986 Attribute Documentation:
2987
2988 |**Name**|**Type**|**Documentation**
2989 |id|com:IDType|The id is the identifier for the object.
2990 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
2991 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
2992
2993 Element Documentation:
2994
2995 |**Name**|**Type**|**Documentation**
2996 |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.
2997
2998 **MetadataTargetType:**
2999
3000 Derivation:
3001 //com:AnnotableType// (extension)
3002 //IdentifiableType// (extension)
3003 //ComponentListType// (restriction)
3004 //MetadataTargetBaseType// (extension)
3005 MetadataTargetType
3006
3007 Attributes:
3008 id, urn?, uri?
3009
3010 Content:
3011 com:Annotations?, (KeyDescriptorValuesTarget | DataSetTarget | ConstraintContentTarget | ReportPeriodTarget | IdentifiableObjectTarget)+
3012
3013 Attribute Documentation:
3014
3015 |**Name**|**Type**|**Documentation**
3016 |id|com:IDType|The id is the identifier for the object.
3017 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3018 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3019
3020 Element Documentation:
3021
3022 |**Name**|**Type**|**Documentation**
3023 |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.
3024 |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.
3025 |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.
3026 |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.
3027 |ReportPeriodTarget|ReportPeriodTargetTy pe|ReportPeriodTarget is target object which specifies a reporting period to which a metadata report applies.
3028 |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.
3029
3030 //**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.
3031
3032 Derivation:
3033 //com:AnnotableType// (extension)
3034 //IdentifiableType// (restriction)
3035 //ComponentBaseType// (extension)
3036 //ComponentType// (extension)
3037 //TargetObject//
3038
3039 Attributes:
3040 id?, urn?, uri?
3041
3042 Content:
3043 com:Annotations?, ConceptIdentity?, LocalRepresentation?
3044
3045 Attribute Documentation:
3046
3047 |**Name**|**Type**|**Documentation**
3048 |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).
3049 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3050 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3051
3052 Element Documentation:
3053
3054 |**Name**|**Type**|**Documentation**
3055 |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.
3056 |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.
3057 |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.
3058
3059 **KeyDescriptorValuesTargetType: **KeyDescriptorValuesTargetType defines the structure of a key descriptor values target object. The key descriptor values target object has a fixed representation and identifier.
3060
3061 Derivation:
3062 //com:AnnotableType// (extension)
3063 //IdentifiableType// (restriction)
3064 //ComponentBaseType// (extension)
3065 //ComponentType// (extension)
3066 //TargetObject// (restriction)
3067 KeyDescriptorValuesTargetType
3068
3069 Attributes:
3070 id?, urn?, uri?
3071
3072 Content:
3073 com:Annotations?, LocalRepresentation
3074
3075 Attribute Documentation:
3076
3077 |**Name**|**Type**|**Documentation**
3078 |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).
3079 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3080 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3081
3082 Element Documentation:
3083
3084 |**Name**|**Type**|**Documentation**
3085 |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.
3086 |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.
3087
3088 **DataSetTargetType: **DataSetTargetType defines the structure of a data set target object. The data set target object has a fixed representation and identifier.
3089
3090 Derivation:
3091 //com:AnnotableType// (extension)
3092 //IdentifiableType// (restriction)
3093 //ComponentBaseType// (extension)
3094 //ComponentType// (extension)
3095 //TargetObject// (restriction)
3096 DataSetTargetType
3097
3098 Attributes:
3099 id?, urn?, uri?
3100
3101 Content:
3102 com:Annotations?, LocalRepresentation
3103
3104 Attribute Documentation:
3105
3106 |**Name**|**Type**|**Documentation**
3107 |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).
3108 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3109 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3110
3111 Element Documentation:
3112
3113 |**Name**|**Type**|**Documentation**
3114 |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.
3115 |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.
3116
3117 **ConstraintContentTargetType: **ConstraintTargetType defines the structure of a constraint target object. The constraint target object has a fixed representation and identifier.
3118
3119 Derivation:
3120 //com:AnnotableType// (extension)
3121 //IdentifiableType// (restriction)
3122 //ComponentBaseType// (extension)
3123 //ComponentType// (extension)
3124 //TargetObject// (restriction)
3125 ConstraintContentTargetType
3126
3127 Attributes:
3128 id?, urn?, uri?
3129
3130 Content:
3131 com:Annotations?, LocalRepresentation
3132
3133 Attribute Documentation:
3134
3135 |**Name**|**Type**|**Documentation**
3136 |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).
3137 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3138 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3139
3140 Element Documentation:
3141
3142 |**Name**|**Type**|**Documentation**
3143 |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.
3144 |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.
3145
3146 **ReportPeriodTargetType: **ReportPeriodTargetType defines the structure of a report period target object. The report period target object has a fixed representation and identifier.
3147
3148 Derivation:
3149 //com:AnnotableType// (extension)
3150 //IdentifiableType// (restriction)
3151 //ComponentBaseType// (extension)
3152 //ComponentType// (extension)
3153 //TargetObject// (restriction)
3154 ReportPeriodTargetType
3155
3156 Attributes:
3157 id?, urn?, uri?
3158
3159 Content:
3160 com:Annotations?, LocalRepresentation
3161
3162 Attribute Documentation:
3163
3164 |**Name**|**Type**|**Documentation**
3165 |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).
3166 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3167 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3168
3169 Element Documentation:
3170
3171 |**Name**|**Type**|**Documentation**
3172 |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.
3173 |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.
3174
3175 //**IdentifiableObjectTargetBaseType**//**: **IdentifiableObjectTargetBaseType is an abstract base type which forms the basis for the IdentifiableObjectTargetType.
3176
3177 Derivation:
3178 //com:AnnotableType// (extension)
3179 //IdentifiableType// (restriction)
3180 //ComponentBaseType// (extension)
3181 //ComponentType// (extension)
3182 //TargetObject// (restriction)
3183 //IdentifiableObjectTargetBaseType//
3184
3185 Attributes:
3186 id, urn?, uri?
3187
3188 Content:
3189 com:Annotations?, LocalRepresentation
3190
3191 Attribute Documentation:
3192
3193 |**Name**|**Type**|**Documentation**
3194 |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).
3195 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3196 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3197
3198 Element Documentation:
3199
3200 |**Name**|**Type**|**Documentation**
3201 |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.
3202 |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.
3203
3204 **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.
3205
3206 Derivation:
3207 //com:AnnotableType// (extension)
3208 //IdentifiableType// (restriction)
3209 //ComponentBaseType// (extension)
3210 //ComponentType// (extension)
3211 //TargetObject// (restriction)
3212 //IdentifiableObjectTargetBaseType// (extension)
3213 IdentifiableObjectTargetType
3214
3215 Attributes:
3216 id, urn?, uri?, objectType
3217
3218 Content:
3219 com:Annotations?, LocalRepresentation
3220
3221 Attribute Documentation:
3222
3223 |**Name**|**Type**|**Documentation**
3224 |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).
3225 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3226 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3227 |objectType|com: ObjectTypeCodelistTy pe|
3228
3229 Element Documentation:
3230
3231 |**Name**|**Type**|**Documentation**
3232 |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.
3233 |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.
3234
3235 //**ReportStructureBaseType**//**: **ReportStructureBaseType is an abstract base type that serves as the basis for the ReportStructureType.
3236
3237 Derivation:
3238 //com:AnnotableType// (extension)
3239 //IdentifiableType// (extension)
3240 //ComponentListType// (restriction)
3241 //ReportStructureBaseType//
3242
3243 Attributes:
3244 id, urn?, uri?
3245
3246 Content:
3247 com:Annotations?, MetadataAttribute+
3248
3249 Attribute Documentation:
3250
3251 |**Name**|**Type**|**Documentation**
3252 |id|com:IDType|The id is the identifier for the object.
3253 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3254 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3255
3256 Element Documentation:
3257
3258 |**Name**|**Type**|**Documentation**
3259 |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.
3260 |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.
3261
3262 **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.
3263
3264 Derivation:
3265
3266 //com:AnnotableType// (extension)
3267 //IdentifiableType// (extension)
3268 //ComponentListType// (restriction)
3269 //ReportStructureBaseType// (extension)
3270 ReportStructureType
3271
3272 Attributes:
3273 id, urn?, uri?
3274
3275 Content:
3276 com:Annotations?, MetadataAttribute+, MetadataTarget+
3277
3278 Attribute Documentation:
3279
3280 |**Name**|**Type**|**Documentation**
3281 |id|com:IDType|The id is the identifier for the object.
3282 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3283 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3284
3285 Element Documentation:
3286
3287 |**Name**|**Type**|**Documentation**
3288 |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.
3289 |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.
3290 |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.
3291
3292 //**MetadataAttributeBaseType**//**: **MetadataAttributeBaseType is an abstract base type the serves as the basis for the MetadataAttributeType.
3293
3294 Derivation:
3295 //com:AnnotableType// (extension)
3296 //IdentifiableType// (restriction)
3297 //ComponentBaseType// (extension)
3298 //ComponentType// (restriction)
3299 //MetadataAttributeBaseType//
3300
3301 Attributes:
3302 id?, urn?, uri?
3303
3304 Content:
3305 com:Annotations?, ConceptIdentity, LocalRepresentation?
3306
3307 Attribute Documentation:
3308
3309 |**Name**|**Type**|**Documentation**
3310 |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).
3311 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3312 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3313
3314 Element Documentation:
3315
3316 |**Name**|**Type**|**Documentation**
3317 |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.
3318 |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.
3319 |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.
3320
3321 **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.
3322
3323 Derivation:
3324 //com:AnnotableType// (extension)
3325 //IdentifiableType// (restriction)
3326 //ComponentBaseType// (extension)
3327 //ComponentType// (restriction)
3328 //MetadataAttributeBaseType// (extension)
3329 MetadataAttributeType
3330
3331 Attributes:
3332 id?, urn?, uri?, minOccurs?, maxOccurs?, isPresentational?
3333
3334 Content:
3335 com:Annotations?, ConceptIdentity, LocalRepresentation?, MetadataAttribute*
3336
3337 Attribute Documentation:
3338
3339 |**Name**|**Type**|**Documentation**
3340 |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).
3341 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3342 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3343 |minOccurs (default: 1)|xs: nonNegativeInteger|The minOccurs attribute indicates the minimum number of times this metadata attribute can occur within its parent object.
3344 |maxOccurs (default: 1)|com:OccurenceType|The maxOccurs attribute indicates the maximum number of times this metadata attribute can occur within its parent object.
3345 |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.
3346
3347 Element Documentation:
3348
3349 |**Name**|**Type**|**Documentation**
3350 |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.
3351 |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.
3352 |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.
3353 |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.
3354
3355 **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).
3356
3357 Derivation:
3358 //RepresentationType// (restriction)
3359 KeyDescriptorValuesRepresentationType
3360
3361 Content:
3362 TextFormat
3363
3364 Element Documentation:
3365
3366 |**Name**|**Type**|**Documentation**
3367 |TextFormat|KeyDescriptorValuesT extFormatType|TextFormat describes an uncoded textual format.
3368
3369 **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.
3370
3371 Derivation:
3372 //RepresentationType// (restriction)
3373 DataSetRepresentationType
3374
3375 Content:
3376 TextFormat
3377
3378 Element Documentation:
3379
3380 |**Name**|**Type**|**Documentation**
3381 |TextFormat|DataSetTextFormatTyp e|TextFormat describes an uncoded textual format.
3382
3383 **ConstraintRepresentationType: **ConstraintRepresentationType defines the possible local representations of a constraint reference target object. The representation is fixed to always be an attachment constraint reference.
3384
3385 Derivation:
3386 //RepresentationType// (restriction)
3387 ConstraintRepresentationType
3388
3389 Content:
3390 TextFormat
3391
3392 Element Documentation:
3393
3394 |**Name**|**Type**|**Documentation**
3395 |TextFormat|ConstraintTextFormat Type|TextFormat describes an uncoded textual format.
3396
3397 **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.
3398
3399 Derivation:
3400 //RepresentationType// (restriction)
3401 ReportPeriodRepresentationType
3402
3403 Content:
3404 TextFormat
3405
3406 Element Documentation:
3407
3408 |**Name**|**Type**|**Documentation**
3409 |TextFormat|TimeTextFormatType|TextFormat describes an uncoded textual format.
3410
3411 **IdentifiableObjectRepresentationType: **IdentifiableObjectRepresentationType defines the possible local representations of an identifiable object target object.
3412
3413 Derivation:
3414 //RepresentationType// (restriction)
3415 IdentifiableObjectRepresentationType
3416
3417 Content:
3418 (TextFormat | Enumeration)
3419
3420 Element Documentation:
3421
3422 |**Name**|**Type**|**Documentation**
3423 |TextFormat|IdentifiableObjectTe xtFormatType|TextFormat describes an uncoded textual format.
3424 |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.
3425
3426 **MetadataAttributeRepresentationType: **MetadataAttributeRepresentationType defines the possible local representations of a metadata attribute.
3427
3428 Derivation:
3429 //RepresentationType// (restriction)
3430 MetadataAttributeRepresentationType
3431
3432 Content:
3433 (TextFormat | (Enumeration, EnumerationFormat?))
3434
3435 Element Documentation:
3436
3437 |**Name**|**Type**|**Documentation**
3438 |TextFormat|BasicComponentTextFo rmatType|TextFormat describes an uncoded textual format.
3439 |Enumeration|com: CodelistReferenceTyp e|Enumeration references an item scheme that enumerates the allowable values for this representation.
3440 |EnumerationFormat|CodededTextFormatTyp e|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.
3441
3442 **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.
3443
3444 Derivation:
3445 TextFormatType (restriction)
3446 TargetObjectTextFormatType
3447
3448 Attributes:
3449 textType?
3450
3451 Content:
3452 {Empty}
3453
3454 Attribute Documentation:
3455
3456 |**Name**|**Type**|**Documentation**
3457 |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.
3458
3459 **KeyDescriptorValuesTextFormatType: **KeyDescriptorValuesTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed KeyValues representation.
3460
3461 Derivation:
3462 TextFormatType (restriction)
3463 TargetObjectTextFormatType (restriction)
3464 KeyDescriptorValuesTextFormatType
3465
3466 Attributes:
3467 textType?
3468
3469 Content:
3470 {Empty}
3471
3472 Attribute Documentation:
3473
3474 |**Name**|**Type**|**Documentation**
3475 |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.
3476
3477 **DataSetTextFormatType: **DataSetTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed DataSetReference representation.
3478
3479 Derivation:
3480 TextFormatType (restriction)
3481 TargetObjectTextFormatType (restriction)
3482 DataSetTextFormatType
3483
3484 Attributes:
3485 textType?
3486
3487 Content:
3488 {Empty}
3489
3490 Attribute Documentation:
3491
3492 |**Name**|**Type**|**Documentation**
3493 |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.
3494
3495 **ConstraintTextFormatType: **ConstraintTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed AttachmentConstraintReference representation.
3496
3497 Derivation:
3498
3499 TextFormatType (restriction)
3500 [[image:inherit.gif||height="9" width="9"]] TargetObjectTextFormatType (restriction)
3501 [[image:inherit.gif||height="9" width="9"]] ConstraintTextFormatType
3502
3503 Attributes:
3504 textType?
3505
3506 Content:
3507 {Empty}
3508
3509 Attribute Documentation:
3510
3511 |**Name**|**Type**|**Documentation**
3512 |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.
3513
3514 **IdentifiableObjectTextFormatType: **IdentifiableObjectTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed IdentifiableReference representation.
3515
3516 Derivation:
3517 TextFormatType (restriction)
3518 TargetObjectTextFormatType (restriction)
3519 IdentifiableObjectTextFormatType
3520
3521 Attributes:
3522 textType?
3523
3524 Content:
3525 {Empty}
3526
3527 Attribute Documentation:
3528
3529 |**Name**|**Type**|**Documentation**
3530 |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.
3531
3532 //**OrganisationSchemeBaseType**//**: **OrganisationSchemeBaseType is an abstract base type for any organisation scheme.
3533
3534 Derivation:
3535 //com:AnnotableType// (extension)
3536 //IdentifiableType// (extension)
3537 //NameableType// (extension)
3538 //VersionableType// (restriction)
3539 //MaintainableBaseType// (extension)
3540 //MaintainableType// (extension)
3541 //ItemSchemeType// (restriction)
3542 //OrganisationSchemeBaseType//
3543
3544 Attributes:
3545 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
3546
3547 Content:
3548 com:Annotations?, com:Name+, com:Description*
3549
3550 Attribute Documentation:
3551
3552 |**Name**|**Type**|**Documentation**
3553 |id|com:IDType|The id is the identifier for the object.
3554 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3555 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3556 |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.
3557 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
3558 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
3559 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
3560 |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.
3561 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
3562 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
3563 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
3564 |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.
3565
3566 Element Documentation:
3567
3568 |**Name**|**Type**|**Documentation**
3569 |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.
3570 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3571 |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.
3572
3573 //**OrganisationSchemeType**//**: **OrganisationSchemeType describes the structure of an organisation scheme.
3574
3575 Derivation:
3576 //com:AnnotableType// (extension)
3577 //IdentifiableType// (extension)
3578 //NameableType// (extension)
3579 //VersionableType// (restriction)
3580 //MaintainableBaseType// (extension)
3581 //MaintainableType// (extension)
3582 //ItemSchemeType// (restriction)
3583 //OrganisationSchemeBaseType// (extension)
3584 //OrganisationSchemeType//
3585
3586 Attributes:
3587 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
3588
3589 Content:
3590 com:Annotations?, com:Name+, com:Description*, //Organisation*//
3591
3592 Attribute Documentation:
3593
3594 |**Name**|**Type**|**Documentation**
3595 |id|com:IDType|The id is the identifier for the object.
3596 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3597 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3598 |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.
3599 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
3600 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
3601 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
3602 |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.
3603 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
3604 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
3605 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
3606 |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.
3607
3608 Element Documentation:
3609
3610 |**Name**|**Type**|**Documentation**
3611 |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.
3612 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3613 |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.
3614 |//Organisation//|//OrganisationType//|Organisation is an abstract substitution head for a generic organisation.
3615
3616 //**BaseOrganisationType**//**: **BaseOrganisationType is an abstract base type the forms the basis for the OrganisationType.
3617
3618 Derivation:
3619 //com:AnnotableType// (extension)
3620 //IdentifiableType// (extension)
3621 //NameableType// (restriction)
3622 //ItemBaseType// (extension)
3623 //ItemType// (restriction)
3624 //BaseOrganisationType//
3625
3626 Attributes:
3627 id, urn?, uri?
3628
3629 Content:
3630 com:Annotations?, com:Name+, com:Description*, Parent?
3631
3632 Attribute Documentation:
3633
3634 |**Name**|**Type**|**Documentation**
3635 |id|com:IDType|The id is the identifier for the object.
3636 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3637 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3638
3639 Element Documentation:
3640
3641 |**Name**|**Type**|**Documentation**
3642 |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.
3643 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3644 |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.
3645 |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.
3646
3647 //**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.
3648
3649 Derivation:
3650 //com:AnnotableType// (extension)
3651 //IdentifiableType// (extension)
3652 //NameableType// (restriction)
3653 //ItemBaseType// (extension)
3654 //ItemType// (restriction)
3655 //BaseOrganisationType// (extension)
3656 //OrganisationType//
3657
3658 Attributes:
3659 id, urn?, uri?
3660
3661 Content:
3662 com:Annotations?, com:Name+, com:Description*, Parent?, Contact*
3663
3664 Attribute Documentation:
3665
3666 |**Name**|**Type**|**Documentation**
3667 |id|com:IDType|The id is the identifier for the object.
3668 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3669 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3670
3671 Element Documentation:
3672
3673 |**Name**|**Type**|**Documentation**
3674 |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.
3675 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3676 |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.
3677 |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.
3678 |Contact|ContactType|Contact describes a contact for the organisation,
3679
3680 **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.
3681
3682 Derivation:
3683 //com:AnnotableType// (extension)
3684 //IdentifiableType// (extension)
3685 //NameableType// (extension)
3686 //VersionableType// (restriction)
3687 //MaintainableBaseType// (extension)
3688 //MaintainableType// (extension)
3689 //ItemSchemeType// (restriction)
3690 //OrganisationSchemeBaseType// (extension)
3691 //OrganisationSchemeType// (restriction)
3692 AgencySchemeType
3693
3694 Attributes:
3695 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
3696
3697 Content:
3698 com:Annotations?, com:Name+, com:Description*, Agency*
3699
3700 Attribute Documentation:
3701
3702 |**Name**|**Type**|**Documentation**
3703 |id (fixed: AGENCIES)|com:IDType|The id is the identifier for the object.
3704 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3705 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3706 |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.
3707 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
3708 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
3709 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
3710 |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.
3711 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
3712 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
3713 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
3714 |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.
3715
3716 Element Documentation:
3717
3718 |**Name**|**Type**|**Documentation**
3719 |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.
3720 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3721 |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.
3722 |Agency|AgencyType|Agency is an organisation which maintains structural metadata such as statistical classifications, glossaries, key family structural definitions, and metadata structure definitions..
3723
3724 **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.
3725
3726 Derivation:
3727 //com:AnnotableType// (extension)
3728 //IdentifiableType// (extension)
3729 //NameableType// (extension)
3730 //VersionableType// (restriction)
3731 //MaintainableBaseType// (extension)
3732 //MaintainableType// (extension)
3733 //ItemSchemeType// (restriction)
3734 //OrganisationSchemeBaseType// (extension)
3735 //OrganisationSchemeType// (restriction)
3736 DataConsumerSchemeType
3737
3738 Attributes:
3739 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
3740
3741 Content:
3742 com:Annotations?, com:Name+, com:Description*, DataConsumer*
3743
3744 Attribute Documentation:
3745
3746 |**Name**|**Type**|**Documentation**
3747 |id (fixed: DATA_CONSUMERS)|com:IDType|The id is the identifier for the object.
3748 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3749 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3750 |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.
3751 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
3752 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
3753 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
3754 |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.
3755 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
3756 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
3757 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
3758 |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.
3759
3760 Element Documentation:
3761
3762 |**Name**|**Type**|**Documentation**
3763 |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.
3764 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3765 |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.
3766 |DataConsumer|DataConsumerType|DataConsumer describes an organisation using data as input for further processing.
3767
3768 **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
3769
3770 Derivation:
3771 //com:AnnotableType// (extension)
3772 //IdentifiableType// (extension)
3773 //NameableType// (extension)
3774 //VersionableType// (restriction)
3775 //MaintainableBaseType// (extension)
3776 //MaintainableType// (extension)
3777 //ItemSchemeType// (restriction)
3778 //OrganisationSchemeBaseType// (extension)
3779 //OrganisationSchemeType// (restriction)
3780 DataProviderSchemeType
3781
3782 Attributes:
3783 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
3784
3785 Content:
3786 com:Annotations?, com:Name+, com:Description*, DataProvider*
3787
3788 Attribute Documentation:
3789
3790 |**Name**|**Type**|**Documentation**
3791 |id (fixed: DATA_PROVIDERS)|com:IDType|The id is the identifier for the object.
3792 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3793 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3794 |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.
3795 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
3796 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
3797 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
3798 |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.
3799 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
3800 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
3801 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
3802 |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.
3803
3804 Element Documentation:
3805
3806 |**Name**|**Type**|**Documentation**
3807 |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.
3808 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3809 |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.
3810 |DataProvider|DataProviderType|DataProvider describes an organisation that produces data or reference metadata.
3811
3812 **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.
3813
3814 Derivation:
3815 //com:AnnotableType// (extension)
3816 //IdentifiableType// (extension)
3817 //NameableType// (extension)
3818 //VersionableType// (restriction)
3819 //MaintainableBaseType// (extension)
3820 //MaintainableType// (extension)
3821 //ItemSchemeType// (restriction)
3822 //OrganisationSchemeBaseType// (extension)
3823 //OrganisationSchemeType// (restriction)
3824 OrganisationUnitSchemeType
3825
3826 Attributes:
3827 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
3828
3829 Content:
3830 com:Annotations?, com:Name+, com:Description*, OrganisationUnit*
3831
3832 Attribute Documentation:
3833
3834 |**Name**|**Type**|**Documentation**
3835 |id|com:IDType|The id is the identifier for the object.
3836 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3837 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3838 |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.
3839 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
3840 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
3841 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
3842 |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.
3843 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
3844 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
3845 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
3846 |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.
3847
3848 Element Documentation:
3849
3850 |**Name**|**Type**|**Documentation**
3851 |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.
3852 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3853 |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.
3854 |OrganisationUnit|OrganisationUnitType|OrganisationUnit describes a generic organisation, which serves not predefined role in SDMX.
3855
3856 **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.
3857
3858 Derivation:
3859 //com:AnnotableType// (extension)
3860 //IdentifiableType// (extension)
3861 //NameableType// (restriction)
3862 //ItemBaseType// (extension)
3863 //ItemType// (restriction)
3864 //BaseOrganisationType// (extension)
3865 //OrganisationType// (restriction)
3866 AgencyType
3867
3868 Attributes:
3869 id, urn?, uri?
3870
3871 Content:
3872 com:Annotations?, com:Name+, com:Description*, Contact*
3873
3874 Attribute Documentation:
3875
3876 |**Name**|**Type**|**Documentation**
3877 |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).
3878 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3879 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3880
3881 Element Documentation:
3882
3883 |**Name**|**Type**|**Documentation**
3884 |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.
3885 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3886 |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.
3887 |Contact|ContactType|Contact describes a contact for the organisation,
3888
3889 **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.
3890
3891 Derivation:
3892 //com:AnnotableType// (extension)
3893 //IdentifiableType// (extension)
3894 //NameableType// (restriction)
3895 //ItemBaseType// (extension)
3896 //ItemType// (restriction)
3897 //BaseOrganisationType// (extension)
3898 //OrganisationType// (restriction)
3899 DataConsumerType
3900
3901 Attributes:
3902 id, urn?, uri?
3903
3904 Content:
3905 com:Annotations?, com:Name+, com:Description*, Contact*
3906
3907 Attribute Documentation:
3908
3909 |**Name**|**Type**|**Documentation**
3910 |id|com:IDType|The id is the identifier for the object.
3911 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3912 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3913
3914 Element Documentation:
3915
3916 |**Name**|**Type**|**Documentation**
3917 |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.
3918 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3919 |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.
3920 |Contact|ContactType|Contact describes a contact for the organisation,
3921
3922 **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.
3923
3924 Derivation:
3925
3926 //com:AnnotableType// (extension)
3927 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
3928 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
3929 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
3930 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
3931 [[image:inherit.gif||height="9" width="9"]] //BaseOrganisationType// (extension)
3932 [[image:inherit.gif||height="9" width="9"]] //OrganisationType// (restriction)
3933 [[image:inherit.gif||height="9" width="9"]] DataProviderType
3934
3935 Attributes:
3936
3937 id, urn?, uri?
3938
3939 Content:
3940
3941 com:Annotations?, com:Name+, com:Description*, Contact*
3942
3943 Attribute Documentation:
3944
3945 |**Name**|**Type**|**Documentation**
3946 |id|com:IDType|The id is the identifier for the object.
3947 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3948 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3949
3950 Element Documentation:
3951
3952 |**Name**|**Type**|**Documentation**
3953 |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.
3954 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3955 |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.
3956 |Contact|ContactType|Contact describes a contact for the organisation,
3957
3958 **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.
3959
3960 Derivation:
3961
3962 //com:AnnotableType// (extension)
3963 //IdentifiableType// (extension)
3964 //NameableType// (restriction)
3965 //ItemBaseType// (extension)
3966 //ItemType// (restriction)
3967 //BaseOrganisationType// (extension)
3968 //OrganisationType// (restriction)
3969 OrganisationUnitType
3970
3971 Attributes:
3972 id, urn?, uri?
3973
3974 Content:
3975 com:Annotations?, com:Name+, com:Description*, Parent?, Contact*
3976
3977 Attribute Documentation:
3978
3979 |**Name**|**Type**|**Documentation**
3980 |id|com:IDType|The id is the identifier for the object.
3981 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
3982 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
3983
3984 Element Documentation:
3985
3986 |**Name**|**Type**|**Documentation**
3987 |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.
3988 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
3989 |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.
3990 |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.
3991 |Contact|ContactType|Contact describes a contact for the organisation,
3992
3993 **ContactType: **ContactType describes the structure of a contact's details.
3994
3995 Attributes:
3996 id?
3997
3998 Content:
3999 com:Name*, Department*, Role*, (Telephone | Fax | X400 | URI | Email)*
4000
4001 Attribute Documentation:
4002
4003 |**Name**|**Type**|**Documentation**
4004 |id|com:IDType|The id attribute is used to carry user id information for the contact.
4005
4006 Element Documentation:
4007
4008 |**Name**|**Type**|**Documentation**
4009 |com:Name|com:TextType|Name is a reusable element, used for providing a human-readable name for an object.
4010 |Department|com:TextType|Department is designation of the organisational structure by a linguistic expression, within which the contact person works.
4011 |Role|com:TextType|Role is the responsibility of the contact person with respect to the object for which this person is the contact.
4012 |Telephone|xs:string|Telephone holds the telephone number for the contact person.
4013 |Fax|xs:string|Fax holds the fax number for the contact person.
4014 |X400|xs:string|X400 holds the X.400 address for the contact person.
4015 |URI|xs:anyURI|URI holds an information URL for the contact person.
4016 |Email|xs:string|Email holds the email address for the contact person.
4017
4018 **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.
4019
4020 Derivation:
4021 //com:AnnotableType// (extension)
4022 //IdentifiableType// (extension)
4023 //NameableType// (extension)
4024 //VersionableType// (restriction)
4025 //MaintainableBaseType// (extension)
4026 //MaintainableType// (extension)
4027 ProvisionAgreementType
4028
4029 Attributes:
4030 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
4031
4032 Content:
4033 com:Annotations?, com:Name+, com:Description*, StructureUsage, DataProvider
4034
4035 Attribute Documentation:
4036
4037 |**Name**|**Type**|**Documentation**
4038 |id|com:IDType|The id is the identifier for the object.
4039 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4040 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4041 |version (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.
4042 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4043 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4044 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4045 |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.
4046 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4047 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4048 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4049
4050 Element Documentation:
4051
4052 |**Name**|**Type**|**Documentation**
4053 |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.
4054 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4055 |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.
4056 |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.
4057 |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.
4058
4059 **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.
4060
4061 Derivation:
4062 //com:AnnotableType// (extension)
4063 //IdentifiableType// (extension)
4064 //NameableType// (extension)
4065 //VersionableType// (restriction)
4066 //MaintainableBaseType// (extension)
4067 //MaintainableType// (extension)
4068 ProcessType
4069
4070 Attributes:
4071 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
4072
4073 Content:
4074 com:Annotations?, com:Name+, com:Description*, ProcessStep*
4075
4076 Attribute Documentation:
4077
4078 |**Name**|**Type**|**Documentation**
4079 |id|com:IDType|The id is the identifier for the object.
4080 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4081 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4082 |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.
4083 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4084 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4085 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4086 |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.
4087 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4088 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4089 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4090
4091 Element Documentation:
4092
4093 |**Name**|**Type**|**Documentation**
4094 |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.
4095 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4096 |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.
4097 |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.
4098
4099 //**ProcessStepBaseType**//**: **ProcessStepBaseType is an abstract base type used as the basis for the ProcessStepType.
4100
4101 Derivation:
4102 //com:AnnotableType// (extension)
4103 //IdentifiableType// (extension)
4104 //NameableType// (restriction)
4105 //ProcessStepBaseType//
4106
4107 Attributes:
4108 id, urn?, uri?
4109
4110 Content:
4111 com:Annotations?, com:Name+, com:Description*
4112
4113 Attribute Documentation:
4114
4115 |**Name**|**Type**|**Documentation**
4116 |id|com:IDType|The id is the identifier for the object.
4117 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4118 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4119
4120 Element Documentation:
4121
4122 |**Name**|**Type**|**Documentation**
4123 |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.
4124 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4125 |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.
4126
4127 **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.
4128
4129 Derivation:
4130 //com:AnnotableType// (extension)
4131 //IdentifiableType// (extension)
4132 //NameableType// (restriction)
4133 //ProcessStepBaseType// (extension)
4134 ProcessStepType
4135
4136 Attributes:
4137 id, urn?, uri?
4138
4139 Content:
4140 com:Annotations?, com:Name+, com:Description*, Input*, Output*, Computation?, Transition*, ProcessStep*
4141
4142 Attribute Documentation:
4143
4144 |**Name**|**Type**|**Documentation**
4145 |id|com:IDType|The id is the identifier for the object.
4146 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4147 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4148
4149 Element Documentation:
4150
4151 |**Name**|**Type**|**Documentation**
4152 |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.
4153 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4154 |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.
4155 |Input|InputOutputType|Input references an object which is an input to the process step.
4156 |Output|InputOutputType|Output references an object which is an output form the process step.
4157 |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.
4158 |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.
4159 |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.
4160
4161 **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.
4162
4163 Derivation:
4164 //com:AnnotableType// (extension)
4165 //IdentifiableType// (extension)
4166 TransitionType
4167
4168 Attributes:
4169 id?, urn?, uri?, localID?
4170
4171 Content:
4172 com:Annotations?, TargetStep, Condition+
4173
4174 Attribute Documentation:
4175
4176 |**Name**|**Type**|**Documentation**
4177 |id|com:IDType|The id is the identifier for the object.
4178 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4179 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4180 |localID|com:IDType|The localID attribute is an optional identification for the transition within the process.
4181
4182 Element Documentation:
4183
4184 |**Name**|**Type**|**Documentation**
4185 |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.
4186 |TargetStep|com: LocalProcessStepRefe renceType|TargetStep references a process step within the process that should be transitioned to, should the conditions described be met.
4187 |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.
4188
4189 **ComputationType: **ComputationType describes a computation in a process.
4190
4191 Derivation:
4192 //com:AnnotableType// (extension)
4193 ComputationType
4194
4195 Attributes:
4196 localID?, softwarePackage?, softwareLanguage?, softwareVersion?
4197
4198 Content:
4199 com:Annotations?, com:Description+
4200
4201 Attribute Documentation:
4202
4203 |**Name**|**Type**|**Documentation**
4204 |localID|com:IDType|The localID attribute is an optional identification for the computation within the process.
4205 |softwarePackage|xs:string|The softwarePackage attribute holds the name of the software package that is used to perform the computation.
4206 |softwareLanguage|xs:string|The softwareLanguage attribute holds the coding language that the software package used to perform the computation is written in.
4207 |softwareVersion|xs:string|The softwareVersion attribute hold the version of the software package that is used to perform that computation.
4208
4209 Element Documentation:
4210
4211 |**Name**|**Type**|**Documentation**
4212 |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.
4213 |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,
4214
4215 **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.
4216
4217 Derivation:
4218
4219 //com:AnnotableType// (extension)
4220 InputOutputType
4221
4222 Attributes:
4223 localID?
4224
4225 Content:
4226 com:Annotations?, ObjectReference
4227
4228 Attribute Documentation:
4229
4230 |**Name**|**Type**|**Documentation**
4231 |localID|com:IDType|The localID attribute is an optional identification for the input or output within the process.
4232
4233 Element Documentation:
4234
4235 |**Name**|**Type**|**Documentation**
4236 |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.
4237 |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.
4238
4239 **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.
4240
4241 Derivation:
4242 //com:AnnotableType// (extension)
4243 //IdentifiableType// (extension)
4244 //NameableType// (extension)
4245 //VersionableType// (restriction)
4246 //MaintainableBaseType// (extension)
4247 //MaintainableType// (extension)
4248 //ItemSchemeType// (restriction)
4249 ReportingTaxonomyType
4250
4251 Attributes:
4252 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
4253
4254 Content:
4255 com:Annotations?, com:Name+, com:Description*, ReportingCategory*
4256
4257 Attribute Documentation:
4258
4259 |**Name**|**Type**|**Documentation**
4260 |id|com:IDType|The id is the identifier for the object.
4261 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4262 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4263 |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.
4264 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4265 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4266 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4267 |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.
4268 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4269 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4270 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4271 |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.
4272
4273 Element Documentation:
4274
4275 |**Name**|**Type**|**Documentation**
4276 |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.
4277 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4278 |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.
4279 |ReportingCategory|ReportingCategoryTyp e|ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages.
4280
4281 //**ReportingCategoryBaseType**//**: **ReportingCategoryBaseType is an abstract base type that serves as the basis for the ReportingCategoryType.
4282
4283 Derivation:
4284 //com:AnnotableType// (extension)
4285 //IdentifiableType// (extension)
4286 //NameableType// (restriction)
4287 //ItemBaseType// (extension)
4288 //ItemType// (restriction)
4289 //ReportingCategoryBaseType//
4290
4291 Attributes:
4292 id, urn?, uri?
4293
4294 Content:
4295 com:Annotations?, com:Name+, com:Description*, ReportingCategory*
4296
4297 Attribute Documentation:
4298
4299 |**Name**|**Type**|**Documentation**
4300 |id|com:IDType|The id is the identifier for the object.
4301 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4302 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4303
4304 Element Documentation:
4305
4306 |**Name**|**Type**|**Documentation**
4307 |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.
4308 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4309 |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.
4310 |ReportingCategory|ReportingCategoryTyp e|ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages.
4311
4312 **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.
4313
4314 Derivation:
4315 //com:AnnotableType// (extension)
4316 //IdentifiableType// (extension)
4317 //NameableType// (restriction)
4318 //ItemBaseType// (extension)
4319 //ItemType// (restriction)
4320 //ReportingCategoryBaseType// (extension)
4321 ReportingCategoryType
4322
4323 Attributes:
4324 id, urn?, uri?
4325
4326 Content:
4327 com:Annotations?, com:Name+, com:Description*, ReportingCategory*, (StructuralMetadata* | ProvisioningMetadata*)
4328
4329 Attribute Documentation:
4330
4331 |**Name**|**Type**|**Documentation**
4332 |id|com:IDType|The id is the identifier for the object.
4333 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4334 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4335
4336 Element Documentation:
4337
4338 |**Name**|**Type**|**Documentation**
4339 |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.
4340 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4341 |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.
4342 |ReportingCategory|ReportingCategoryTyp e|ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages.
4343 |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.
4344 |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.
4345
4346 //**StructureSetBaseType**//**: **StructureSetBaseType is an abstract base type that forms the basis for the StructureSetType.
4347
4348 Derivation:
4349 //com:AnnotableType// (extension)
4350 //IdentifiableType// (extension)
4351 //NameableType// (extension)
4352 //VersionableType// (restriction)
4353 //MaintainableBaseType// (extension)
4354 //MaintainableType// (restriction)
4355 //StructureSetBaseType//
4356
4357 Attributes:
4358 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
4359
4360 Content:
4361 com:Annotations?, com:Name+, com:Description*
4362
4363 Attribute Documentation:
4364
4365 |**Name**|**Type**|**Documentation**
4366 |id|com:IDType|The id is the identifier for the object.
4367 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4368 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4369 |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.
4370 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4371 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4372 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4373 |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.
4374 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4375 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4376 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4377
4378 Element Documentation:
4379
4380 |**Name**|**Type**|**Documentation**
4381 |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.
4382 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4383 |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.
4384
4385 **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.
4386
4387 Derivation:
4388 //com:AnnotableType// (extension)
4389 //IdentifiableType// (extension)
4390 //NameableType// (extension)
4391 //VersionableType// (restriction)
4392 //MaintainableBaseType// (extension)
4393 //MaintainableType// (restriction)
4394 //StructureSetBaseType// (extension)
4395 StructureSetType
4396
4397 Attributes:
4398 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?
4399
4400 Content:
4401 com:Annotations?, com:Name+, com:Description*, RelatedStructure*, (OrganisationSchemeMap | CategorySchemeMap | CodelistMap | ConceptSchemeMap | ReportingTaxonomyMap | HybridCodelistMap | StructureMap)*
4402
4403 Attribute Documentation:
4404
4405 |**Name**|**Type**|**Documentation**
4406 |id|com:IDType|The id is the identifier for the object.
4407 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4408 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4409 |version (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.
4410 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4411 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4412 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4413 |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.
4414 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4415 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4416 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4417
4418 Element Documentation:
4419
4420 |**Name**|**Type**|**Documentation**
4421 |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.
4422 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4423 |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.
4424 |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.
4425 |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.
4426 |CategorySchemeMap|CategorySchemeMapTyp e|CategorySchemeMap links a source and target categories from different schemes where there is a semantic equivalence between them.
4427 |CodelistMap|CodelistMapType|CodelistMap links a source and target codes from different lists where there is a semantic equivalence between them.
4428 |ConceptSchemeMap|ConceptSchemeMapType|ConceptSchemeMap links a source and target concepts from different schemes where there is a semantic equivalence between them.
4429 |ReportingTaxonomyMap|ReportingTaxonomyMap Type|ReportingTaxonomyMap links a source and target reporting categories from different taxonomies where there is a semantic equivalence between them.
4430 |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.
4431 |StructureMap|StructureMapType|StructureMap maps components from one structure to components to another structure, and can describe how the value of the components are related.
4432
4433 //**ItemSchemeMapBaseType**//**: **ItemSchemeMapBaseType is an abstract base type which forms the basis for the ItemSchemeMapType.
4434
4435 Derivation:
4436 //com:AnnotableType// (extension)
4437 //IdentifiableType// (extension)
4438 //NameableType// (restriction)
4439 //ItemSchemeMapBaseType//
4440
4441 Attributes:
4442 id, urn?, uri?
4443
4444 Content:
4445 com:Annotations?, com:Name+, com:Description*
4446
4447 Attribute Documentation:
4448
4449 |**Name**|**Type**|**Documentation**
4450 |id|com:IDType|The id is the identifier for the object.
4451 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4452 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4453
4454 Element Documentation:
4455
4456 |**Name**|**Type**|**Documentation**
4457 |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.
4458 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4459 |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.
4460
4461 //**ItemSchemeMapType**//**: **ItemSchemeMapType is an abstract base type which forms the basis for mapping items between item schemes of the same type.
4462
4463 Derivation:
4464
4465 //com:AnnotableType// (extension)
4466 //IdentifiableType// (extension)
4467 //NameableType// (restriction)
4468 //ItemSchemeMapBaseType// (extension)
4469 //ItemSchemeMapType//
4470
4471 Attributes:
4472 id, urn?, uri?
4473
4474 Content:
4475 com:Annotations?, com:Name+, com:Description*, Source, Target, //ItemAssociation+//
4476
4477 Attribute Documentation:
4478
4479 |**Name**|**Type**|**Documentation**
4480 |id|com:IDType|The id is the identifier for the object.
4481 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4482 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4483
4484 Element Documentation:
4485
4486 |**Name**|**Type**|**Documentation**
4487 |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.
4488 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4489 |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.
4490 |Source|//com: ItemSchemeReferenceB aseType//|Source provides a reference to the item scheme which items are mapped from.
4491 |Target|//com: ItemSchemeReferenceB aseType//|Target provides a reference to the item scheme which items are mapped to.
4492 |//ItemAssociation//|//ItemAssociationType//|ItemAssociation is an abstract description of the relation between two items for the purpose of mapping.
4493
4494 //**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.
4495
4496 Derivation:
4497 //com:AnnotableType// (extension)
4498 //ItemAssociationType//
4499
4500 Content:
4501 com:Annotations?, Source, Target
4502
4503 Element Documentation:
4504
4505 |**Name**|**Type**|**Documentation**
4506 |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.
4507 |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.
4508 |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.
4509
4510 **OrganisationSchemeMapType: **OrganisationSchemeMapType defines the structure of a map which identifies relationships between organisations in different organisation schemes.
4511
4512 Derivation:
4513 //com:AnnotableType// (extension)
4514 //IdentifiableType// (extension)
4515 //NameableType// (restriction)
4516 //ItemSchemeMapBaseType// (extension)
4517 //ItemSchemeMapType// (restriction)
4518 OrganisationSchemeMapType
4519
4520 Attributes:
4521 id, urn?, uri?
4522
4523 Content:
4524 com:Annotations?, com:Name+, com:Description*, Source, Target, OrganisationMap+
4525
4526 Attribute Documentation:
4527
4528 |**Name**|**Type**|**Documentation**
4529 |id|com:IDType|The id is the identifier for the object.
4530 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4531 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4532
4533 Element Documentation:
4534
4535 |**Name**|**Type**|**Documentation**
4536 |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.
4537 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4538 |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.
4539 |Source|com: OrganisationSchemeRe ferenceType|Source provides a reference to the item scheme which items are mapped from.
4540 |Target|com: OrganisationSchemeRe ferenceType|Target provides a reference to the item scheme which items are mapped to.
4541 |OrganisationMap|OrganisationMapType|OrganisationMap relates a source organisation to a target organisation.
4542
4543 **OrganisationMapType: **OrganisationMapType defines the structure for mapping two organisations. A local reference is provided both the source and target organisation.
4544
4545 Derivation:
4546 //com:AnnotableType// (extension)
4547 //ItemAssociationType// (restriction)
4548 OrganisationMapType
4549
4550 Content:
4551 com:Annotations?, Source, Target
4552
4553 Element Documentation:
4554
4555 |**Name**|**Type**|**Documentation**
4556 |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.
4557 |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.
4558 |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.
4559
4560 **CategorySchemeMapType: **CategorySchemeMapType defines the structure of a map which identifies relationships between categories in different category schemes.
4561
4562 Derivation:
4563 //com:AnnotableType// (extension)
4564 //IdentifiableType// (extension)
4565 //NameableType// (restriction)
4566 //ItemSchemeMapBaseType// (extension)
4567 //ItemSchemeMapType// (restriction)
4568 CategorySchemeMapType
4569
4570 Attributes:
4571 id, urn?, uri?
4572
4573 Content:
4574 com:Annotations?, com:Name+, com:Description*, Source, Target, CategoryMap+
4575
4576 Attribute Documentation:
4577
4578 |**Name**|**Type**|**Documentation**
4579 |id|com:IDType|The id is the identifier for the object.
4580 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4581 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4582
4583 Element Documentation:
4584
4585 |**Name**|**Type**|**Documentation**
4586 |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.
4587 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4588 |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.
4589 |Source|com: CategorySchemeRefere nceType|Source provides a reference to the item scheme which items are mapped from.
4590 |Target|com: CategorySchemeRefere nceType|Target provides a reference to the item scheme which items are mapped to.
4591 |CategoryMap|CategoryMapType|CategoryMap defines the structure of a map which identifies relationships between categories in different category schemes.
4592
4593 **CategoryMapType: **CategoryMapType defines the structure for mapping two categories. A local reference is provided both the source and target category.
4594
4595 Derivation:
4596 //com:AnnotableType// (extension)
4597 //ItemAssociationType// (restriction)
4598 CategoryMapType
4599
4600 Content:
4601 com:Annotations?, Source, Target
4602
4603 Element Documentation:
4604
4605 |**Name**|**Type**|**Documentation**
4606 |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.
4607 |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.
4608 |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.
4609
4610 **CodelistMapType: **CodelistMapType defines the structure of a map which identifies relationships between codes in different codelists.
4611
4612 Derivation:
4613 //com:AnnotableType// (extension)
4614 //IdentifiableType// (extension)
4615 //NameableType// (restriction)
4616 //ItemSchemeMapBaseType// (extension)
4617 //ItemSchemeMapType// (restriction)
4618 CodelistMapType
4619
4620 Attributes:
4621 id, urn?, uri?
4622
4623 Content:
4624 com:Annotations?, com:Name+, com:Description*, Source, Target, CodeMap+
4625
4626 Attribute Documentation:
4627
4628 |**Name**|**Type**|**Documentation**
4629 |id|com:IDType|The id is the identifier for the object.
4630 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4631 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4632
4633 Element Documentation:
4634
4635 |**Name**|**Type**|**Documentation**
4636 |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.
4637 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4638 |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.
4639 |Source|com: CodelistReferenceTyp e|Source provides a reference to the item scheme which items are mapped from.
4640 |Target|com: CodelistReferenceTyp e|Target provides a reference to the item scheme which items are mapped to.
4641 |CodeMap|CodeMapType|CodeMap defines the structure of a map which identifies relationships between codes in different codelists.
4642
4643 **CodeMapType: **CodeMapType defines the structure for mapping two codes. A local reference is provided both the source and target code.
4644
4645 Derivation:
4646 //com:AnnotableType// (extension)
4647 //ItemAssociationType// (restriction)
4648 CodeMapType
4649
4650 Content:
4651 com:Annotations?, Source, Target
4652
4653 Element Documentation:
4654
4655 |**Name**|**Type**|**Documentation**
4656 |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.
4657 |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.
4658 |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.
4659
4660 **ConceptSchemeMapType: **ConceptSchemeMapType defines the structure of a map which identifies relationships between concepts in different concept schemes.
4661
4662 Derivation:
4663 //com:AnnotableType// (extension)
4664 //IdentifiableType// (extension)
4665 //NameableType// (restriction)
4666 //ItemSchemeMapBaseType// (extension)
4667 //ItemSchemeMapType// (restriction)
4668 ConceptSchemeMapType
4669
4670 Attributes:
4671 id, urn?, uri?
4672
4673 Content:
4674 com:Annotations?, com:Name+, com:Description*, Source, Target, ConceptMap+
4675
4676 Attribute Documentation:
4677
4678 |**Name**|**Type**|**Documentation**
4679 |id|com:IDType|The id is the identifier for the object.
4680 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4681 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4682
4683 Element Documentation:
4684
4685 |**Name**|**Type**|**Documentation**
4686 |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.
4687 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4688 |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.
4689 |Source|com: ConceptSchemeReferen ceType|Source provides a reference to the item scheme which items are mapped from.
4690 |Target|com: ConceptSchemeReferen ceType|Target provides a reference to the item scheme which items are mapped to.
4691 |ConceptMap|ConceptMapType|ConceptMap defines the structure of a map which identifies relationships between concepts in different concept schemes.
4692
4693 **ConceptMapType: **ConceptMapType defines the structure for mapping two concepts. A local reference is provided both the source and target concept.
4694
4695 Derivation:
4696 //com:AnnotableType// (extension)
4697 //ItemAssociationType// (restriction)
4698 ConceptMapType
4699
4700 Content:
4701 com:Annotations?, Source, Target
4702
4703 Element Documentation:
4704
4705 |**Name**|**Type**|**Documentation**
4706 |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.
4707 |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.
4708 |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.
4709
4710 **ReportingTaxonomyMapType: **ReportingTaxonomyMapType defines the structure of a map which identifies relationships between reporting categories in different reporting taxonomies.
4711
4712 Derivation:
4713 //com:AnnotableType// (extension)
4714 //IdentifiableType// (extension)
4715 //NameableType// (restriction)
4716 //ItemSchemeMapBaseType// (extension)
4717 //ItemSchemeMapType// (restriction)
4718 ReportingTaxonomyMapType
4719
4720 Attributes:
4721 id, urn?, uri?
4722
4723 Content:
4724 com:Annotations?, com:Name+, com:Description*, Source, Target, ReportingCategoryMap+
4725
4726 Attribute Documentation:
4727
4728 |**Name**|**Type**|**Documentation**
4729 |id|com:IDType|The id is the identifier for the object.
4730 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4731 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4732
4733 Element Documentation:
4734
4735 |**Name**|**Type**|**Documentation**
4736 |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.
4737 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4738 |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.
4739 |Source|com: ReportingTaxonomyRef erenceType|Source provides a reference to the item scheme which items are mapped from.
4740 |Target|com: ReportingTaxonomyRef erenceType|Target provides a reference to the item scheme which items are mapped to.
4741 |ReportingCategoryMap|ReportingCategoryMap Type|ReportingCategoryMap defines the structure of a map which identifies relationships between reporting categories in different reporting taxonomies.
4742
4743 **ReportingCategoryMapType: **ReportingCategoryMapType defines the structure for mapping two reporting categories. A local reference is provided both the source and target category.
4744
4745 Derivation:
4746 //com:AnnotableType// (extension)
4747 //ItemAssociationType// (restriction)
4748 ReportingCategoryMapType
4749
4750 Content:
4751 com:Annotations?, Source, Target
4752
4753 Element Documentation:
4754
4755 |**Name**|**Type**|**Documentation**
4756 |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.
4757 |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.
4758 |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.
4759
4760 //**HybridCodelistMapBaseType**//**: **HybridCodelistMapBaseType is an abstract base type which forms the basis for the HybridCodelistMapType.
4761
4762 Derivation:
4763 //com:AnnotableType// (extension)
4764 //IdentifiableType// (extension)
4765 //NameableType// (restriction)
4766 //HybridCodelistMapBaseType//
4767
4768 Attributes:
4769 id, urn?, uri?
4770
4771 Content:
4772 com:Annotations?, com:Name+, com:Description*
4773
4774 Attribute Documentation:
4775
4776 |**Name**|**Type**|**Documentation**
4777 |id|com:IDType|The id is the identifier for the object.
4778 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4779 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4780
4781 Element Documentation:
4782
4783 |**Name**|**Type**|**Documentation**
4784 |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.
4785 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4786 |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.
4787
4788 **HybridCodelistMapType: **HybridCodelistMapType defines the structure of a map which relates codes (possibly hierarchical) from different code lists.
4789
4790 Derivation:
4791 //com:AnnotableType// (extension)
4792 //IdentifiableType// (extension)
4793 //NameableType// (restriction)
4794 //HybridCodelistMapBaseType// (extension)
4795 HybridCodelistMapType
4796
4797 Attributes:
4798 id, urn?, uri?
4799
4800 Content:
4801 com:Annotations?, com:Name+, com:Description*, Source, Target, HybridCodeMap+
4802
4803 Attribute Documentation:
4804
4805 |**Name**|**Type**|**Documentation**
4806 |id|com:IDType|The id is the identifier for the object.
4807 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4808 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4809
4810 Element Documentation:
4811
4812 |**Name**|**Type**|**Documentation**
4813 |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.
4814 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4815 |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.
4816 |Source|com: AnyCodelistReference Type|Source provides a reference to either a codelist or a hierarchical codelist, from which the codes are to be mapped.
4817 |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.
4818 |HybridCodeMap|HybridCodeMapType|HybridCodeMap defines the relationship of a code in the source list to code in the target list.
4819
4820 **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.
4821
4822 Derivation:
4823 //com:AnnotableType// (extension)
4824 HybridCodeMapType
4825
4826 Content:
4827 com:Annotations?, Source, Target
4828
4829 Element Documentation:
4830
4831 |**Name**|**Type**|**Documentation**
4832 |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.
4833 |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.
4834 |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.
4835
4836 //**StructureMapBaseType**//**: **StructureMapBaseType is an abstract base type which forms the basis for the StructureMapType.
4837
4838 Derivation:
4839 //com:AnnotableType// (extension)
4840 //IdentifiableType// (extension)
4841 //NameableType// (restriction)
4842 //StructureMapBaseType//
4843
4844 Attributes:
4845 id, urn?, uri?
4846
4847 Content:
4848 com:Annotations?, com:Name+, com:Description*
4849
4850 Attribute Documentation:
4851
4852 |**Name**|**Type**|**Documentation**
4853 |id|com:IDType|The id is the identifier for the object.
4854 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4855 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4856
4857 Element Documentation:
4858
4859 |**Name**|**Type**|**Documentation**
4860 |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.
4861 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4862 |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.
4863
4864 **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.
4865
4866 Derivation:
4867 //com:AnnotableType// (extension)
4868 //IdentifiableType// (extension)
4869 //NameableType// (restriction)
4870 //StructureMapBaseType// (extension)
4871 StructureMapType
4872
4873 Attributes:
4874 id, urn?, uri?, isExtension?
4875
4876 Content:
4877 com:Annotations?, com:Name+, com:Description*, Source, Target, ComponentMap+
4878
4879 Attribute Documentation:
4880
4881 |**Name**|**Type**|**Documentation**
4882 |id|com:IDType|The id is the identifier for the object.
4883 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4884 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4885 |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.
4886
4887 Element Documentation:
4888
4889 |**Name**|**Type**|**Documentation**
4890 |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.
4891 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4892 |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.
4893 |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.
4894 |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.
4895 |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.
4896
4897 **ComponentMapType: **ComponentMapType defines the structure for relating a component in a source structure to a component in a target structure.
4898
4899 Derivation:
4900 //com:AnnotableType// (extension)
4901 ComponentMapType
4902
4903 Content:
4904 com:Annotations?, Source, Target, RepresentationMapping?
4905
4906 Element Documentation:
4907
4908 |**Name**|**Type**|**Documentation**
4909 |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.
4910 |Source|com: LocalComponentListCo mponentReferenceType|
4911 |Target|com: LocalComponentListCo mponentReferenceType|
4912 |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.
4913
4914 **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.
4915
4916 Content:
4917 (CodelistMap | (ToTextFormat, ToValueType) | ValueMap)
4918
4919 Element Documentation:
4920
4921 |**Name**|**Type**|**Documentation**
4922 |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.
4923 |ToTextFormat|TextFormatType|ToTextFormat describes the un-coded representation of the target to which the value of the referenced component should be transformed.
4924 |ToValueType|ToValueTypeType|ToValueType notes whether the value, name, or description of the source value should be used in the target value.
4925 |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.
4926
4927 **ValueMapType: **ValueMapType contains a collection of value mappings, which give a source and target value.
4928
4929 Content:
4930 ValueMapping+
4931
4932 Element Documentation:
4933
4934 |**Name**|**Type**|**Documentation**
4935 |ValueMapping|ValueMappingType|ValueMapping provides a source and target value for the purpose of mapping.
4936
4937 **ValueMappingType: **ValueMappingType specifies the relationship between two values as a source and target.
4938
4939 Attributes:
4940 source, target
4941
4942 Content:
4943 {Empty}
4944
4945 Attribute Documentation:
4946
4947 |**Name**|**Type**|**Documentation**
4948 |source|xs:string|
4949 |target|xs:string|
4950
4951 //**VtlDefinitionSchemeType**//**: **VtlDefinitionSchemeType is an abstract extension of the ItemSchemeType for VTL schemes.
4952
4953 Derivation:
4954 //com:AnnotableType// (extension)
4955 //IdentifiableType// (extension)
4956 //NameableType// (extension)
4957 //VersionableType// (restriction)
4958 //MaintainableBaseType// (extension)
4959 //MaintainableType// (extension)
4960 //ItemSchemeType// (extension)
4961 //VtlDefinitionSchemeType//
4962
4963 Attributes:
4964 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
4965
4966 Content:
4967 com:Annotations?, com:Name+, com:Description*, //Item*//
4968
4969 Attribute Documentation:
4970
4971 |**Name**|**Type**|**Documentation**
4972 |id|com:IDType|The id is the identifier for the object.
4973 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
4974 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
4975 |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.
4976 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
4977 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
4978 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
4979 |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.
4980 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
4981 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
4982 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
4983 |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.
4984 |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.
4985
4986 Element Documentation:
4987
4988 |**Name**|**Type**|**Documentation**
4989 |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.
4990 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
4991 |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.
4992 |//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.
4993
4994 //**TransformationSchemeBaseType**//**: **TransformationSchemeBaseType is an abstract base type for the TransformationSchemeType. It restricts the item types to be only transformations.
4995
4996 Derivation:
4997 //com:AnnotableType// (extension)
4998 //IdentifiableType// (extension)
4999 //NameableType// (extension)
5000 //VersionableType// (restriction)
5001 //MaintainableBaseType// (extension)
5002 //MaintainableType// (extension)
5003 //ItemSchemeType// (extension)
5004 //VtlDefinitionSchemeType// (restriction)
5005 //TransformationSchemeBaseType//
5006
5007 Attributes:
5008 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
5009
5010 Content:
5011 com:Annotations?, com:Name+, com:Description*, Transformation*
5012
5013 Attribute Documentation:
5014
5015 |**Name**|**Type**|**Documentation**
5016 |id|com:IDType|The id is the identifier for the object.
5017 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5018 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5019 |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.
5020 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5021 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5022 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5023 |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.
5024 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5025 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5026 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5027 |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.
5028 |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.
5029
5030 Element Documentation:
5031
5032 |**Name**|**Type**|**Documentation**
5033 |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.
5034 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5035 |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.
5036 |Transformation|TransformationType|Transformation describes the details of a single transformation within a transformation scheme.
5037
5038 **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.
5039
5040 Derivation:
5041 //com:AnnotableType// (extension)
5042 //IdentifiableType// (extension)
5043 //NameableType// (extension)
5044 //VersionableType// (restriction)
5045 //MaintainableBaseType// (extension)
5046 //MaintainableType// (extension)
5047 //ItemSchemeType// (extension)
5048 //VtlDefinitionSchemeType// (restriction)
5049 //TransformationSchemeBaseType// (extension)
5050 TransformationSchemeType
5051
5052 Attributes:
5053 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
5054
5055 Content:
5056 com:Annotations?, com:Name+, com:Description*, Transformation*, VtlMappingScheme?, NamePersonalisationScheme?, CustomTypeScheme?, RulesetScheme*, UserDefinedOperatorScheme*
5057
5058 Attribute Documentation:
5059
5060 |**Name**|**Type**|**Documentation**
5061 |id|com:IDType|The id is the identifier for the object.
5062 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5063 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5064 |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.
5065 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5066 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5067 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5068 |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.
5069 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5070 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5071 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5072 |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.
5073 |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.
5074
5075 Element Documentation:
5076
5077 |**Name**|**Type**|**Documentation**
5078 |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.
5079 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5080 |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.
5081 |Transformation|TransformationType|Transformation describes the details of a single transformation within a transformation scheme.
5082 |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.
5083 |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.
5084 |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.
5085 |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.
5086 |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.
5087
5088 **TransformationType: **TransformationType defines the structure of a transformation. A transformation is an assignment of a VTL expression to a specific result.
5089
5090 Derivation:
5091 //com:AnnotableType// (extension)
5092 //IdentifiableType// (extension)
5093 //NameableType// (restriction)
5094 //ItemBaseType// (extension)
5095 //ItemType// (restriction)
5096 //UnnestedItemType// (extension)
5097 TransformationType
5098
5099 Attributes:
5100 id, urn?, uri?, isPersistent
5101
5102 Content:
5103 com:Annotations?, com:Name+, com:Description*, Expression, Result
5104
5105 Attribute Documentation:
5106
5107 |**Name**|**Type**|**Documentation**
5108 |id|com:IDType|The id is the identifier for the object.
5109 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5110 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5111 |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.
5112
5113 Element Documentation:
5114
5115 |**Name**|**Type**|**Documentation**
5116 |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.
5117 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5118 |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.
5119 |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").
5120 |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").
5121
5122 **VtlMappingSchemeType: **VtlMappingSchemeType defines a set of mappings between SDMX and VTL.
5123
5124 Derivation:
5125 //com:AnnotableType// (extension)
5126 //IdentifiableType// (extension)
5127 //NameableType// (extension)
5128 //VersionableType// (restriction)
5129 //MaintainableBaseType// (extension)
5130 //MaintainableType// (extension)
5131 //ItemSchemeType// (restriction)
5132 VtlMappingSchemeType
5133
5134 Attributes:
5135 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?
5136
5137 Content:
5138 com:Annotations?, com:Name+, com:Description*, VtlMapping*
5139
5140 Attribute Documentation:
5141
5142 |**Name**|**Type**|**Documentation**
5143 |id|com:IDType|The id is the identifier for the object.
5144 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5145 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5146 |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.
5147 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5148 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5149 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5150 |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.
5151 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5152 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5153 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5154 |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.
5155
5156 Element Documentation:
5157
5158 |**Name**|**Type**|**Documentation**
5159 |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.
5160 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5161 |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.
5162 |VtlMapping|VtlMappingType|VtlMapping details a mapping between SDMX and VTL transformation.
5163
5164 **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.
5165
5166 Derivation:
5167
5168 //com:AnnotableType// (extension)
5169 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5170 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
5171 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
5172 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
5173 [[image:inherit.gif||height="9" width="9"]] //UnnestedItemType// (extension)
5174 [[image:inherit.gif||height="9" width="9"]] VtlMappingType
5175
5176 Attributes:
5177
5178 id, urn?, uri?, alias
5179
5180 Content:
5181
5182 com:Annotations?, com:Name+, com:Description*, ( ( (Dataflow | GenericDataflow), ToVtlMapping?, FromVtlMapping?) | Codelist | ConceptScheme | Concept)
5183
5184 Attribute Documentation:
5185
5186 |**Name**|**Type**|**Documentation**
5187 |id|com:IDType|The id is the identifier for the object.
5188 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5189 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5190 |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.
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 |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.
5199 |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.
5200 |ToVtlMapping|ToVtlMappingType|Describes the mapping from a SDMX dataflow to a VTL data structure.
5201 |FromVtlMapping|FromVtlMappingType|Describes the mapping to a SDMX dataflow from a VTL data structure.
5202 |Codelist|com: CodelistReferenceTyp e|A reference to the SDMX Codelist that the mapping is defined for. This is used to create a VtlCodelistMapping.
5203 |ConceptScheme|com: ConceptSchemeReferen ceType|A reference to the SDMX Concept Scheme that the mapping is defined for. This is used to create a VtlConceptSchemeMapping.
5204 |Concept|com: ConceptReferenceType|A reference to the SDMX Concept that the mapping is defined for. This is used to create a VtlConceptMapping.
5205
5206 **ToVtlMappingType: **ToVtlMappingType defines the mapping method and filter used when mapping from SDMX to VTL.
5207
5208 Attributes:
5209
5210 method?
5211
5212 Content:
5213
5214 ToVtlSubSpace?
5215
5216 Attribute Documentation:
5217
5218 |**Name**|**Type**|**Documentation**
5219 |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.
5220
5221 Element Documentation:
5222
5223 |**Name**|**Type**|**Documentation**
5224 |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.
5225
5226 **FromVtlMappingType: **FromVtlMappingType defines the mapping method and filter used when mapping from VTL to SDMX.
5227
5228 Attributes:
5229
5230 method?
5231
5232 Content:
5233
5234 FromVtlSuperSpace?
5235
5236 Attribute Documentation:
5237
5238 |**Name**|**Type**|**Documentation**
5239 |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.
5240
5241 Element Documentation:
5242
5243 |**Name**|**Type**|**Documentation**
5244 |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.
5245
5246 **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.
5247
5248 Content:
5249
5250 Key+
5251
5252 Element Documentation:
5253
5254 |**Name**|**Type**|**Documentation**
5255 |Key|com: SingleNCNameIDType|A reference to a dimension by its identifier.
5256
5257 **NamePersonalisationSchemeType: **NamePersonalisationSchemeType defines a set of personalisations of VTL standard names that are used in a set of transformations.
5258
5259 Derivation:
5260
5261 //com:AnnotableType// (extension)
5262 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5263 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
5264 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
5265 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
5266 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
5267 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)
5268 [[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)
5269 [[image:inherit.gif||height="9" width="9"]] NamePersonalisationSchemeType
5270
5271 Attributes:
5272
5273 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
5274
5275 Content:
5276
5277 com:Annotations?, com:Name+, com:Description*, NamePersonalisation*
5278
5279 Attribute Documentation:
5280
5281 |**Name**|**Type**|**Documentation**
5282 |id|com:IDType|The id is the identifier for the object.
5283 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5284 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5285 |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.
5286 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5287 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5288 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5289 |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.
5290 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5291 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5292 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5293 |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.
5294 |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.
5295
5296 Element Documentation:
5297
5298 |**Name**|**Type**|**Documentation**
5299 |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.
5300 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5301 |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.
5302 |NamePersonalisation|NamePersonalisationT ype|NamePersonalisation details a name personalisation that is used in a transformation.
5303
5304 **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.
5305
5306 Derivation:
5307
5308 //com:AnnotableType// (extension)
5309 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5310 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
5311 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
5312 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
5313 [[image:inherit.gif||height="9" width="9"]] //UnnestedItemType// (extension)
5314 [[image:inherit.gif||height="9" width="9"]] NamePersonalisationType
5315
5316 Attributes:
5317
5318 id, urn?, uri?, vtlArtefact
5319
5320 Content:
5321
5322 com:Annotations?, com:Name+, com:Description*, VtlDefaultName, PersonalisedName
5323
5324 Attribute Documentation:
5325
5326 |**Name**|**Type**|**Documentation**
5327 |id|com:IDType|The id is the identifier for the object.
5328 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5329 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5330 |vtlArtefact|xs:string|Identifies the type of VTL model artefact that is being personalised. In VTL 2.0, this is valuedomain or variable.
5331
5332 Element Documentation:
5333
5334 |**Name**|**Type**|**Documentation**
5335 |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.
5336 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5337 |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.
5338 |VtlDefaultName|xs:string|Provides the VTL standard name that is being personalised.
5339 |PersonalisedName|xs:string|Provides the personalised name that is used in place of the VTL standard name in the transformation expressions.
5340
5341 //**RulesetSchemeBaseType**//**: **RulesetSchemeBaseType is an abstract base type for the RulesetSchemeType. It restricts the item types to be only rulesets.
5342
5343 Derivation:
5344
5345 //com:AnnotableType// (extension)
5346 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5347 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
5348 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
5349 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
5350 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
5351 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)
5352 [[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)
5353 [[image:inherit.gif||height="9" width="9"]] //RulesetSchemeBaseType//
5354
5355 Attributes:
5356
5357 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
5358
5359 Content:
5360
5361 com:Annotations?, com:Name+, com:Description*, Ruleset*
5362
5363 Attribute Documentation:
5364
5365 |**Name**|**Type**|**Documentation**
5366 |id|com:IDType|The id is the identifier for the object.
5367 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5368 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5369 |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.
5370 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5371 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5372 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5373 |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.
5374 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5375 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5376 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5377 |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.
5378 |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.
5379
5380 Element Documentation:
5381
5382 |**Name**|**Type**|**Documentation**
5383 |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.
5384 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5385 |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.
5386 |Ruleset|RulesetType|Ruleset details a ruleset within a ruleset scheme.
5387
5388 **RulesetSchemeType: **RulesetSchemeType defines a collection of rulesets that are used in transformations.
5389
5390 Derivation:
5391
5392 //com:AnnotableType// (extension)
5393 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5394 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
5395 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
5396 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
5397 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
5398 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)
5399 [[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)
5400 [[image:inherit.gif||height="9" width="9"]] //RulesetSchemeBaseType// (extension)
5401 [[image:inherit.gif||height="9" width="9"]] RulesetSchemeType
5402
5403 Attributes:
5404
5405 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
5406
5407 Content:
5408
5409 com:Annotations?, com:Name+, com:Description*, Ruleset*, VtlMappingScheme?
5410
5411 Attribute Documentation:
5412
5413 |**Name**|**Type**|**Documentation**
5414 |id|com:IDType|The id is the identifier for the object.
5415 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5416 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5417 |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.
5418 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5419 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5420 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5421 |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.
5422 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5423 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5424 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5425 |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.
5426 |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.
5427
5428 Element Documentation:
5429
5430 |**Name**|**Type**|**Documentation**
5431 |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.
5432 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5433 |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.
5434 |Ruleset|RulesetType|Ruleset details a ruleset within a ruleset scheme.
5435 |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.
5436
5437 **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.
5438
5439 Derivation:
5440
5441 //com:AnnotableType// (extension)
5442 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5443 [[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)
5444 [[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)
5445 [[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)
5446 [[image:inherit.gif||height="9" width="9"]] //UnnestedItemType// (extension)
5447 [[image:inherit.gif||height="9" width="9"]] RulesetType
5448
5449 Attributes:
5450
5451 id, urn?, uri?, rulesetType, rulesetScope
5452
5453 Content:
5454
5455 com:Annotations?, com:Name+, com:Description*, RulesetDefinition
5456
5457 Attribute Documentation:
5458
5459 |**Name**|**Type**|**Documentation**
5460 |id|com:IDType|The id is the identifier for the object.
5461 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5462 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5463 |rulesetType|xs:string|The VTL type of the ruleset. In VTL 2.0, this is datapoint or hierarchical
5464 |rulesetScope|xs:string|This model artefact on which the ruleset is defined. In VTL 2.0, this is value domain or variable.
5465
5466 Element Documentation:
5467
5468 |**Name**|**Type**|**Documentation**
5469 |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.
5470 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5471 |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.
5472 |RulesetDefinition|xs:string|A VTL statement for the definition of a ruleset. This must conform to the syntax of the VTL definition language.
5473
5474 //**UserDefinedOperatorSchemeBaseType**//**: **UserDefinedOperatorSchemeBaseType is an abstract base type for the UserDefinedOperatorSchemeType. It restricts the item types to be only user defined operators.
5475
5476 Derivation:
5477
5478 //com:AnnotableType// (extension)
5479 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5480 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
5481 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
5482 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
5483 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
5484 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)
5485 [[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)
5486 [[image:inherit.gif||height="9" width="9"]] //UserDefinedOperatorSchemeBaseType//
5487
5488 Attributes:
5489
5490 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
5491
5492 Content:
5493
5494 com:Annotations?, com:Name+, com:Description*, UserDefinedOperator*
5495
5496 Attribute Documentation:
5497
5498 |**Name**|**Type**|**Documentation**
5499 |id|com:IDType|The id is the identifier for the object.
5500 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5501 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5502 |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.
5503 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5504 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5505 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5506 |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.
5507 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5508 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5509 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5510 |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.
5511 |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.
5512
5513 Element Documentation:
5514
5515 |**Name**|**Type**|**Documentation**
5516 |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.
5517 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5518 |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.
5519 |UserDefinedOperator|UserDefinedOperatorT ype|UserDefinedOperator details a user defined operators within a user defined operator scheme.
5520
5521 **UserDefinedOperatorSchemeType: **UserDefinedOperatorSchemeType defines a collection of user defined operators that are used in transformations.
5522
5523 Derivation:
5524
5525 //com:AnnotableType// (extension)
5526 [[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)
5527 [[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)
5528 [[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)
5529 [[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)
5530 [[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)
5531 [[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)
5532 [[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)
5533 [[image:inherit.gif||height="9" width="9"]] //UserDefinedOperatorSchemeBaseType// (extension)
5534 [[image:inherit.gif||height="9" width="9"]] UserDefinedOperatorSchemeType
5535
5536 Attributes:
5537
5538 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
5539
5540 Content:
5541
5542 com:Annotations?, com:Name+, com:Description*, UserDefinedOperator*, VtlMappingScheme?, RulesetScheme*
5543
5544 Attribute Documentation:
5545
5546 |**Name**|**Type**|**Documentation**
5547 |id|com:IDType|The id is the identifier for the object.
5548 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5549 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5550 |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.
5551 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5552 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5553 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5554 |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.
5555 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5556 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5557 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5558 |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.
5559 |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.
5560
5561 Element Documentation:
5562
5563 |**Name**|**Type**|**Documentation**
5564 |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.
5565 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5566 |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.
5567 |UserDefinedOperator|UserDefinedOperatorT ype|UserDefinedOperator details a user defined operators within a user defined operator scheme.
5568 |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.
5569 |RulesetScheme|com: RulesetSchemeReferen ceType|References a ruleset scheme defining rulesets utilized in the user defined operators.
5570
5571 **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.
5572
5573 Derivation:
5574
5575 //com:AnnotableType// (extension)
5576 //IdentifiableType// (extension)
5577 //NameableType// (restriction)
5578 //ItemBaseType// (extension)
5579 //ItemType// (restriction)
5580 //UnnestedItemType// (extension)
5581 UserDefinedOperatorType
5582
5583 Attributes:
5584
5585 id, urn?, uri?
5586
5587 Content:
5588
5589 com:Annotations?, com:Name+, com:Description*, OperatorDefinition
5590
5591 Attribute Documentation:
5592
5593 |**Name**|**Type**|**Documentation**
5594 |id|com:IDType|The id is the identifier for the object.
5595 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5596 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5597
5598 Element Documentation:
5599
5600 |**Name**|**Type**|**Documentation**
5601 |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.
5602 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5603 |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.
5604 |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.
5605
5606 **CustomTypeSchemeType: **CustomTypeSchemeType defines a collection of custom types that are used in transformations.
5607
5608 Derivation:
5609
5610 //com:AnnotableType// (extension)
5611 //IdentifiableType// (extension)
5612 //NameableType// (extension)
5613 //VersionableType// (restriction)
5614 //MaintainableBaseType// (extension)
5615 //MaintainableType// (extension)
5616 //ItemSchemeType// (extension)
5617 //VtlDefinitionSchemeType// (restriction)
5618 CustomTypeSchemeType
5619
5620 Attributes:
5621
5622 id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion
5623
5624 Content:
5625
5626 com:Annotations?, com:Name+, com:Description*, CustomType*
5627
5628 Attribute Documentation:
5629
5630 |**Name**|**Type**|**Documentation**
5631 |id|com:IDType|The id is the identifier for the object.
5632 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5633 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5634 |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.
5635 |validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
5636 |validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
5637 |agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.
5638 |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.
5639 |isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
5640 |serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
5641 |structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
5642 |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.
5643 |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.
5644
5645 Element Documentation:
5646
5647 |**Name**|**Type**|**Documentation**
5648 |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.
5649 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5650 |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.
5651 |CustomType|CustomTypeType|CustomType details a custom type within a custom type scheme.
5652
5653 **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.
5654
5655 Derivation:
5656
5657 //com:AnnotableType// (extension)
5658 //IdentifiableType// (extension)
5659 //NameableType// (restriction)
5660 //ItemBaseType// (extension)
5661 //ItemType// (restriction)
5662 //UnnestedItemType// (extension)
5663 CustomTypeType
5664
5665 Attributes:
5666
5667 id, urn?, uri?
5668
5669 Content:
5670
5671 com:Annotations?, com:Name+, com:Description*, VtlScalarType, DataType, VtlLiteralFormat?, OutputFormat?, NullValue?
5672
5673 Attribute Documentation:
5674
5675 |**Name**|**Type**|**Documentation**
5676 |id|com:IDType|The id is the identifier for the object.
5677 |urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
5678 |uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
5679
5680 Element Documentation:
5681
5682 |**Name**|**Type**|**Documentation**
5683 |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.
5684 |com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
5685 |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.
5686 |VtlScalarType|xs:string|Identifies the VTL scalar type that is to be converted to an resulting output data type.
5687 |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.
5688 |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.
5689 |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.
5690 |NullValue|xs:string|The value to be produced in the output of the conversion when a component has a null value.
5691
5692 === 2.1.4 Simple Types ===
5693
5694 **UsageStatusType: **UsageStatusType provides a list of enumerated types for indicating whether reporting a given attribute is mandatory or conditional.
5695
5696 Derived by restriction of xs:NMTOKEN .
5697
5698 Enumerations:
5699
5700 |**Value**|**Documentation**
5701 |Mandatory|Reporting the associated attribute is mandatory - a value must be supplied.
5702 |Conditional|Reporting the associated attribute is not mandatory - a value may be supplied, but is not required.
5703
5704 **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.
5705
5706 Derived by restriction of com:SimpleDataType .
5707
5708 Enumerations:
5709
5710 (% style="width:1015.83px" %)
5711 |**Value**|(% style="width:816px" %)**Documentation**
5712 |String|(% style="width:816px" %)A string datatype corresponding to W3C XML Schema's xs:string datatype.
5713 |Alpha|(% style="width:816px" %)A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.
5714 |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.
5715 |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.
5716 |BigInteger|(% style="width:816px" %)An integer datatype corresponding to W3C XML Schema's xs:integer datatype.
5717 |Integer|(% style="width:816px" %)An integer datatype corresponding to W3C XML Schema's xs:int datatype.
5718 |Long|(% style="width:816px" %)A numeric datatype corresponding to W3C XML Schema's xs:long datatype.
5719 |Short|(% style="width:816px" %)A numeric datatype corresponding to W3C XML Schema's xs:short datatype.
5720 |Boolean|(% style="width:816px" %)A datatype corresponding to W3C XML Schema's xs:boolean datatype.
5721 |URI|(% style="width:816px" %)A datatype corresponding to W3C XML Schema's xs:anyURI datatype.
5722 |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".
5723 |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.
5724 |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.
5725 |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.
5726 |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.
5727 |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.
5728 |BasicTimePeriod|(% style="width:816px" %)BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.
5729 |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.
5730 |GregorianYear|(% style="width:816px" %)A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.
5731 |GregorianYearMonth|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.
5732 |GregorianDay|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.
5733 |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.
5734 |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.
5735 |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.
5736 |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.
5737 |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.
5738 |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.
5739 |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.
5740 |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.
5741 |Month|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:gMonth datatype.
5742 |MonthDay|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype.
5743 |Day|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:gDay datatype.
5744 |Duration|(% style="width:816px" %)A time datatype corresponding to W3C XML Schema's xs:duration datatype.
5745
5746 **SimpleCodeDataType: **SimpleCodeDataType restricts SimpleDataType to specify the allowable data types for a simple code. The possible values are simply Alpha, AlphaNumeric, or Numeric.
5747
5748 Derived by restriction of com:SimpleDataType .
5749
5750 Enumerations:
5751
5752 |**Value**|**Documentation**
5753 |Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.
5754 |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.
5755 |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.
5756
5757 **TargetObjectDataType: **TargetObjectDataType restricts DataType to specify the allowable data types for representing a target object value.
5758
5759 Derived by restriction of com:DataType .
5760
5761 Enumerations:
5762
5763 |**Value**|**Documentation**
5764 |KeyValues|This value indicates that the content of the component will be data key (a set of dimension references and values for the dimensions).
5765 |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.
5766 |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.
5767 |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.
5768
5769 **ToValueTypeType: **ToValueTypeType provides an enumeration of available text-equivalents for translation of coded values into textual formats.
5770
5771 Derived by restriction of xs:NMTOKEN .
5772
5773 Enumerations:
5774
5775 |**Value**|**Documentation**
5776 |Value|Code or other tokenized value, as provided in the representation scheme.
5777 |Name|The human-readable name of the Value, as provided in the representation scheme.
5778 |Description|The human-readable description of the Value, as provided in the representation scheme.
5779
5780 **StandardToVtlMappingMethodType: **A simple type enumerating the standard mapping methods when converting from data structures from SDMX to VLT.
5781
5782 Derived by restriction of xs:string .
5783
5784 Enumerations:
5785
5786 |**Value**|**Documentation**
5787 |Basic|The default mapping method. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.1 ("Basic Mapping").
5788 |Pivot|Method for mapping multi-measure data. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.2 ("Pivot Mapping").
5789 |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").
5790 |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").
5791
5792 **ToVtlMappingMethodType: **A simple type that allows for a standard to VTL mapping method enumeration value or a string value for other mapping methods.
5793
5794 Union of:
5795
5796 StandardToVtlMappingMethodType, xs:string.
5797
5798 **StandardFromVtlMappingMethodType: **A simple type enumerating the standard mapping methods when converting from data structures from VTL to SDMX.
5799
5800 Derived by restriction of xs:string .
5801
5802 Enumerations:
5803
5804 |**Value**|**Documentation**
5805 |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").
5806 |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").
5807 |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").
5808
5809 **FromVtlMappingMethodType: **A simple type that allows for standard from VTL mapping method enumeration value or a string value for other mapping methods.
5810
5811 Union of:
5812
5813 StandardFromVtlMappingMethodType, xs:string.
5814
5815 **CustomTypeDataType: **A simple type that allows for a SDMX simple data type enumeration value or a string value for other data types.
5816
5817 Union of:
5818
5819 com:SimpleDataType, xs:string.