Skip to Content

Wiki source code of Part III. Structure

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