Interoperability Basis Platform

= 1 Introduction =

The structure namespace contains the definition of all structural metadata constructs. These constructs are intended to be very tightly coupled with the information model to ease the burden of implementers on translating the information from the XML messages into objects based on the information model.

8

9

The conformance with the information was achieved through derivation by extensions, restrictions, and substitutions. Because of some the limitations of XML Schema in these areas, it was often necessary to create intermediate type which formed the basis of the final types which make up the information that is actually exchanged in SDMX messages. The intermediate types are all abstract, so they are not explicitly used in a message. They do however serve the purpose of creating a strong relation of the schemas to the information model.

10

11

= 2 Schema Documentation =

12

13

== 2.1 Structure Namespace ==

14

15

http://www.sdmx.org/resources/sdmxml/schemas/v3_1/structure

16

17

=== 2.1.1 Summary ===

18

19

Referenced Namespaces:

20

21

| **Namespace** | **Prefix** |

22

| --- --| --- --|

23

| <http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common> | common |

24

| <http://www.w3.org/2001/XMLSchema> | xs |

Contents:

38 Global Elements

235 Complex Types

19 Simple Types

=== 2.1.2 Global Elements ===

32

33

**Structures (StructuresType):** Structures contains constructs for all structural metadata components.

34

35

***Item* (*ItemType*):** Item is an abstract element that serves as a substitution head for all items in an item scheme, including those items nested within other items. Concrete instances of this must use a concrete instance of ItemType.

36

37

Substitutions: `Category, Code, *GeoRefCode*, GeoFeatureSetCode, GeoGridCode, Concept, *Organisation*, Agency, DataConsumer, DataProvider, MetadataProvider, OrganisationUnit, ReportingCategory, Transformation, VtlMapping, NamePersonalisation, Ruleset, UserDefinedOperator, CustomType`

38

39

***Grouping* (*GroupingType*):** Grouping is an abstract element that serves as a substitution head for all structure groupings. Groupings contain a collection of component lists for a structure. Concrete instances of this must use a concrete instance of GroupingType.

40

41

Substitutions: `DataStructureComponents, MetadataStructureComponents`

42

43

***ComponentList* (*ComponentListType*):** ComponentList is an abstract element that serves as a substitution head for all component lists. Concrete instances of this must use a concrete instance of ComponentListType.

44

45

Substitutions: `AttributeList, DimensionList, Group, MeasureList, MetadataAttributeList`

46

47

***Component* (*ComponentType*):** Component is an abstract element that serves as a substitution head for all components. Concrete instances of this must use a concrete instance of ComponentType.

48

49

Substitutions: `Attribute, MetadataAttributeUsage, Dimension, TimeDimension, GroupDimension, Measure, MetadataAttribute`

50

51

**Category (CategoryType):** Category represents a set of nested categories which describe a simple classification hierarchy.

52

53

Substitution For: *`Item`*

54

55

**Code (CodeType):** Code describes a code in a codelist. In addition to the identification and description of the code, basic presentational information is also available. Presentational information not present may be added through the use of annotations.

56

57

Substitution For: *`Item`*

58

59

Substitutions: *`GeoRefCode`*, `GeoFeatureSetCode, GeoGridCode`

60

61

***GeoRefCode* (*GeoRefCodeType*):** GeoRefCode is the abstract base from which specific types of geographic codes will be derived.

62

63

Substitution For: Code

64

65

Substitutions: `GeoFeatureSetCode, GeoGridCode`

66

67

**GeoFeatureSetCode (GeoFeatureSetCodeType):** Is a geographic code in a geographic codelist. It adds a value to a code that folows a pattern to represent a geo feature set.

68

69

Substitution For: *`GeoRefCode`*

70

71

**GeoGridCode (GeoGridCodeType):** GeoGridCode is a code the represents a geographic grid cell that belongs to a specific grid definition.

72

73

Substitution For: *`GeoRefCode`*

74

75

**Concept (ConceptType):** Concept describes the details of a concept within a concept scheme.

76

77

Substitution For: *`Item`*

78

79

**DataStructureComponents (DataStructureComponentsType):** DataStructureComponents defines the grouping of the sets of metadata concepts that have a defined structural role in the data structure definition. Note that for any component or group defined in a data structure definition, its id must be unique. This applies to the identifiers explicitly defined by the components as well as those inherited from the concept identity of a component. For example, if two dimensions take their identity from concepts with same identity (regardless of whether the concepts exist in different schemes) one of the dimensions must be provided a different explicit identifier. Although there are XML schema constraints to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a concept from which a component takes its identity cannot be validated against this constraint. Therefore, systems processing data structure definitions will have to perform this check outside of the XML validation. There are also two reserved identifiers in a data structure definition; TIME\_PERIOD, and REPORTING\_YEAR\_START\_DAY. These identifiers may not be used outside of their respective defintions (TimeDimension and ReportingYearStartDay). This applies to both the explicit identifiers that can be assigned to the components or groups as well as an identifier inherited by a component from its concept identity. For example, if an ordinary dimension (i.e. not the time dimension) takes its concept identity from a concept with the identifier TIME\_PERIOD, that dimension must provide a different explicit identifier.

80

81

Substitution For: *`Grouping`*

82

83

**AttributeList (AttributeListType):** AttributeList describes the attribute descriptor for the data structure definition. It is a collection of metadata concepts that define the attributes of the data structure definition.

84

85

Substitution For: *`ComponentList`*

86

87

**Attribute (AttributeType):** Attribute describes the definition of a data attribute, which is defined as a characteristic of an object or entity.

88

89

Substitution For: *`Component`*

90

91

**MetadataAttributeUsage (MetadataAttributeUsageType):** MetadataAttributeUsage refines the details of how a metadata attribute from the metadata structure referenced from the data structure is used. By default, metadata attributes can be expressed at any level of the data. This allows an attribute relationship to be defined in order restrict the reporing of a metadata attribute to a specific part of the data.

92

93

Substitution For: *`Component`*

94

95

**DimensionList (DimensionListType):** DimensionList describes the key descriptor for the data structure definition. It is an ordered set of metadata concepts that, combined, classify a statistical series, such as a time series, and whose values, when combined (the key) in an instance such as a data set, uniquely identify a specific series.

96

97

Substitution For: *`ComponentList`*

98

99

**Dimension (DimensionType):** Dimension describes the structure of a dimension, which is defined as a statistical concept used (most probably together with other statistical concepts) to identify a statistical series, such as a time series, e.g. a statistical concept indicating certain economic activity or a geographical reference area.

100

101

Substitution For: *`Component`*

102

103

**TimeDimension (TimeDimensionType):** TimeDimension is a special dimension which designates the period in time in which the data identified by the full series key applies.

104

105

Substitution For: *`Component`*

106

107

**Group (GroupType):** Group describes a group descriptor in a data structure definition. It is a set metadata concepts (and possibly their values) that define a partial key derived from the key descriptor in a data structure definition.

108

109

Substitution For: *`ComponentList`*

110

111

**GroupDimension (GroupDimensionType):** GroupDimension is a component which contains only a reference to a dimension in the key descriptor (DimensionList). Although it is conventional to declare dimensions in the same order as they are declared in the ordered key, there is no requirement to do so - the ordering of the values of the key are taken from the order in which the dimensions are declared. Note that the id of a dimension may be inherited from its underlying concept - therefore this reference value may actually be the id of the concept.

112

113

Substitution For: *`Component`*

114

115

**MeasureList (MeasureListType):** MeasureList describes the measure descriptor for a data structure.

116

117

Substitution For: *`ComponentList`*

118

119

**Measure (MeasureType):** Measure defines the structure of a measure, which is the concept that is the value of the phenomenon to be measured in a data set.

120

121

Substitution For: *`Component`*

122

123

**MetadataStructureComponents (MetadataStructureComponentsType):** MetadataStructureComponents defines the grouping of the sets of the components that make up the metadata structure definition.

124

125

Substitution For: *`Grouping`*

126

127

**MetadataAttributeList (MetadataAttributeListType):** MetadataAttributeList defines the set of metadata attributes that can be defined as a hierarchy, for reporting reference metadata about a target object. The identification of metadata attributes must be unique at any given level of the metadata structure. Although there are XML schema constraints to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a concept from which a metadata attribute takes its identity cannot be validated against this constraint. Therefore, systems processing metadata structure definitions will have to perform this check outside of the XML validation.

128

129

Substitution For: *`ComponentList`*

130

131

**MetadataAttribute (MetadataAttributeType):** MetadataAttribute defines the a metadata attribute, which is the value of an attribute, such as the instance of a coded or uncoded attribute in a metadata structure definition.

132

133

Substitution For: *`Component`*

134

135

***Organisation* (*OrganisationType*):** Organisation is an abstract substitution head for a generic organisation.

136

137

Substitution For: *`Item`*

138

139

Substitutions: `Agency, DataConsumer, DataProvider, MetadataProvider, OrganisationUnit`

140

141

**Agency (AgencyType):** Agency is an organisation which maintains structural metadata such as classifications, concepts, data structures, and metadata structures.

142

143

Substitution For: *`Organisation`*

144

145

**DataConsumer (DataConsumerType):** DataConsumer describes an organisation using data as input for further processing.

146

147

Substitution For: *`Organisation`*

148

149

**DataProvider (DataProviderType):** DataProvider describes an organisation that produces data.

150

151

Substitution For: *`Organisation`*

152

153

**MetadataProvider (MetadataProviderType):** MetadataProvider describes an organisation that produces metadata .

154

155

Substitution For: *`Organisation`*

156

157

**OrganisationUnit (OrganisationUnitType):** OrganisationUnit describes a generic organisation, which serves not predefined role in SDMX.

158

159

Substitution For: *`Organisation`*

160

161

**ReportingCategory (ReportingCategoryType):** ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages.

162

163

Substitution For: *`Item`*

164

165

**Transformation (TransformationType):** Transformation describes the details of a single transformation within a transformation scheme.

166

167

Substitution For: *`Item`*

168

169

**VtlMapping (VtlMappingType):** VtlMapping details a mapping between SDMX and VTL transformation.

170

171

Substitution For: *`Item`*

172

173

**NamePersonalisation (NamePersonalisationType):** NamePersonalisation details a name personalisation that is used in a transformation.

174

175

Substitution For: *`Item`*

176

177

**Ruleset (RulesetType):** Ruleset details a ruleset within a ruleset scheme.

178

179

Substitution For: *`Item`*

180

181

**UserDefinedOperator (UserDefinedOperatorType):** UserDefinedOperator details a user defined operators within a user defined operator scheme.

182

183

Substitution For: *`Item`*

184

185

**CustomType (CustomTypeType):** CustomType details a custom type within a custom type scheme.

186

187

Substitution For: *`Item`*

188

189

### 2.1.3 Complex Types##

190

191

**StructuresType:** StructuresType describes the structure of the container for all structural metadata components. The structural components may be explicitly detailed, or referenced from an external structure document or registry service. Best practices dictate that, at a minimum, any structural component that is referenced by another structural component be included by reference.

192

193

Content:

194

`ALL(AgencySchemesCategorisationsCategorySchemeMapsCategorySchemesCodelistsConceptSchemeMapsConceptSchemesCustomTypeSchemesDataConstraintsDataConsumerSchemesDataflowsDataProviderSchemesDataStructuresGeographicCodelistsGeoGridCodelistsHierarchiesHierarchyAssociationsMetadataConstraintsMetadataflowsMetadataProviderSchemesMetadataProvisionAgreementsMetadataStructuresNamePersonalisationSchemesOrganisationSchemeMapsOrganisationUnitSchemesProcessesProvisionAgreementsReportingTaxonomiesReportingTaxonomyMapsRepresentationMapsRulesetSchemesStructureMapsTransformationSchemesUserDefinedOperatorSchemesValueListsVtlMappingSchemes)`

195

196

Element Documentation:

197

198

| **Name** | **Type** | **Documentation** |

199

| --- --| --- --| --- --|

200

| AgencySchemes | AgencySchemesType | AgencySchemes contains a collection of agency scheme descriptions. The agency schemes may be detailed in full, or referenced from an external structure document or registry service. |

201

| 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. |

202

| CategorySchemeMaps | CategorySchemeMapsTy pe | CategorySchemeMaps contains a collection of category scheme map descriptions. The category scheme maps may be detailed in full, or referenced from an external structure document or registry service. |

203

| 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. |

204

| 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. |

205

| ConceptSchemeMaps | ConceptSchemeMapsTyp e | ConceptSchemeMaps contains a collection of concept scheme map descriptions. The concept scheme maps may be detailed in full, or referenced from an external structure document or registry service. |

206

| ConceptSchemes | ConceptSchemesType | ConceptSchemes contains a collection of concept scheme descriptions. The concept schemes described are contained within schemes. The concepts may be detailed in full, or referenced from an external structure document or registry service. |

207

| CustomTypeSchemes | CustomTypeSchemesTyp e | CustomTypeSchemes contains a collection of custom type schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. |

208

| DataConstraints | DataConstraintsType | DataConstraints contains a collection of data constraint descriptions. The constraints may be detailed in full, or referenced from an external structure document or registry service. |

209

| DataConsumerSchemes | DataConsumerSchemesT ype | DataConsumerSchemes contains a collection of data consumer scheme descriptions. The data consumer schemes may be detailed in full, or referenced from an external structure document or registry service. |

210

| 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. |

211

| DataProviderSchemes | DataProviderSchemesT ype | DataProviderSchemes contains a collection of data provider scheme descriptions. The data provider schemes may be detailed in full, or referenced from an external structure document or registry service. |

212

| 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. |

213

| GeographicCodelists | GeographicCodelistsT ype | GeographicCodelists contains a collection of geographi codelist descriptions. The codelists may be detailed in full, or referenced from an external structure document or registry service. |

214

| GeoGridCodelists | GeoGridCodelistsType | GeoGridCodelists contains a collection of geographic grid codelist descriptions. The codelists may be detailed in full, or referenced from an external structure document or registry service. |

215

| Hierarchies | HierarchiesType | Hierarchies contains a collection of hierarchical code list descriptions. The hierarchical code lists may be detailed in full, or referenced from an external structure document or registry service. |

216

| HierarchyAssociation s | HierarchyAssociation sType | HierarchyAssociations contains a collection of hierarchy associations. The associations may be detailed in full, or referenced from an external structure document or registry service. |

217

| MetadataConstraints | MetadataConstraintsT ype | MetadataConstraints contains a collection of metadata constraint descriptions. The constraints may be detailed in full, or referenced from an external structure document or registry service. |

218

| 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. |

219

| MetadataProviderSche mes | MetadataProviderSche mesType | MetadataProviderSchemes contains a collection of metadata provider scheme descriptions. The meatadata provider schemes may be detailed in full, or referenced from an external structure document or registry service. |

220

| MetadataProvisionAgr eements | MetadataProvisionAgr eementsType | 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. |

221

| MetadataStructures | MetadataStructuresTy pe | 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. |

222

| NamePersonalisationS chemes | NamePersonalisationS chemesType | NamePersonalisationSchemes contains a collection of name personalisation schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. |

223

| OrganisationSchemeMa ps | OrganisationSchemeMa psType | OrganisationSchemeMaps contains a collection of organisation scheme map descriptions. The organisation scheme maps may be detailed in full, or referenced from an external structure document or registry service. |

224

| OrganisationUnitSche mes | OrganisationUnitSche mesType | OrganisationUnitSchemes contains a collection of organisation unit scheme descriptions. The organisation unit schemes may be detailed in full, or referenced from an external structure document or registry service. |

225

| 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. |

226

| ProvisionAgreements | ProvisionAgreementsT ype | 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. |

227

| ReportingTaxonomies | ReportingTaxonomiesT ype | 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. |

228

| ReportingTaxonomyMap s | ReportingTaxonomyMap sType | ReportingTaxonomyMaps contains a collection of reporting taxonomy map descriptions. The reporting taxonomy maps may be detailed in full, or referenced from an external structure document or registry service. |

229

| RepresentationMaps | RepresentationMapsTy pe | RepresentationMaps contains a collection of representation map descriptions. The representation maps may be detailed in full, or referenced from an external structure document or registry service. |

230

| RulesetSchemes | RulesetSchemesType | RulesetSchemes contains a collection of ruleset schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. |

231

| StructureMaps | StructureMapsType | StructureMaps contains a collection of structure map descriptions. The structure maps may be detailed in full, or referenced from an external structure document or registry service. |

232

| TransformationScheme s | TransformationScheme sType | TransformationSchemes contains a collection of transformation schemes. The transformation schemes may be detailed in full, or referenced from an external structure document or registry service. |

233

| UserDefinedOperatorS chemes | UserDefinedOperatorS chemesType | UserDefinedOperatorSchemes contains a collection of user defined operator schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. |

234

| ValueLists | ValueListsType | ValueLists contains a collection of value list descriptions. The value lists may be detailed in full, or referenced from an external structure document or registry service. |

235

| VtlMappingSchemes | VtlMappingSchemesTyp e | VtlMappingSchemes contains a collection of VTL mapping schemes. The scheme may be detailed in full, or referenced from an external structure document or registry service. |

236

237

**AgencySchemesType:** AgencySchemesType describes the structure of the agency schemes container. It contains one or more agency scheme, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`AgencyScheme+`

Element Documentation:

243

244

| **Name** | **Type** | **Documentation** |

245

| --- --| --- --| --- --|

246

| AgencyScheme | AgencySchemeType | AgencyScheme provides the details of an agency scheme, in which agencies are described. |

247

248

**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.

Content:

`Categorisation+`

Element Documentation:

254

255

| **Name** | **Type** | **Documentation** |

256

| --- --| --- --| --- --|

257

| 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. |

258

259

**CategorySchemeMapsType:** CategorySchemeMapsType describes the structure of the category scheme maps container. It contains one or more category scheme map, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`CategorySchemeMap+`

Element Documentation:

266

267

| **Name** | **Type** | **Documentation** |

268

| --- --| --- --| --- --|

269

| CategorySchemeMap | CategorySchemeMapTyp e | CategorySchemeMap provides the details of a category scheme map, which descibes mappings between categories in different schemes. |

270

271

**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.

Content:

`CategoryScheme+`

Element Documentation:

277

278

| **Name** | **Type** | **Documentation** |

279

| --- --| --- --| --- --|

280

| 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. |

281

282

**ConceptSchemeMapsType:** ConceptSchemeMapsType describes the structure of the concept scheme maps container. It contains one or more concept scheme map, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`ConceptSchemeMap+`

Element Documentation:

288

289

| **Name** | **Type** | **Documentation** |

290

| --- --| --- --| --- --|

291

| ConceptSchemeMap | ConceptSchemeMapType | ConceptSchemeMap provides the details of a concept scheme map, which descibes mappings between concepts in different schemes. |

292

293

**ConceptSchemesType:** ConceptSchemesType describes the structure of the concept schemes container. It contains one or more concept schemes, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`ConceptScheme*`

Element Documentation:

300

301

| **Name** | **Type** | **Documentation** |

302

| --- --| --- --| --- --|

303

| 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. |

304

305

**CodelistsType:** CodelistsType describes the structure of the codelists container. It contains one or more codelist, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`Codelist+`

Element Documentation:

311

312

| **Name** | **Type** | **Documentation** |

313

| --- --| --- --| --- --|

314

| Codelist | CodelistType | Codelist provides the details of a codelist, which is defined as a list from which some statistical concepts (coded concepts) take their values. |

315

316

**CustomTypeSchemesType:** CustomTypeSchemesType describes the structure of the custom type schemes container. It contains one or more custom type scheme, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`CustomTypeScheme+`

Element Documentation:

323

324

| **Name** | **Type** | **Documentation** |

325

| --- --| --- --| --- --|

326

| CustomTypeScheme | CustomTypeSchemeType | CustomTypeScheme provides the details of a custom type scheme, in which user defined operators are described. |

327

328

**DataConstraintsType:** DataConstraintsType describes the structure of the data constraints container. It contains one or more data constraint, which can be explicitly detailed or referenced from an external structure document or registry service. This container may contain both attachment and content constraints.

Content:

`DataConstraint+`

Element Documentation:

335

336

| **Name** | **Type** | **Documentation** |

337

| --- --| --- --| --- --|

338

| DataConstraint | DataConstraintType | DataConstraint specifies a sub set of the definition of the allowable or available content of a data set in terms of the content or in terms of the set of key combinations. |

339

340

**DataConsumerSchemesType:** DataConsumerSchemesType describes the structure of the data consumer schemes container. It contains one or more data consumer scheme, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`DataConsumerScheme+`

345

346

Element Documentation:

347

348

| **Name** | **Type** | **Documentation** |

349

| --- --| --- --| --- --|

350

| DataConsumerScheme | DataConsumerSchemeTy pe | DataConsumerScheme provides the details of an data consumer scheme, in which data consumers are described. |

351

352

**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.

Content:

`Dataflow+`

Element Documentation:

359

360

| **Name** | **Type** | **Documentation** |

361

| --- --| --- --| --- --|

362

| 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. |

363

364

**DataProviderSchemesType:** DataProviderSchemesType describes the structure of the data provider schemes container. It contains one or more data provider scheme, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`DataProviderScheme+`

369

370

Element Documentation:

371

372

| **Name** | **Type** | **Documentation** |

373

| --- --| --- --| --- --|

374

| DataProviderScheme | DataProviderSchemeTy pe | DataProviderScheme provides the details of an data provider scheme, in which data providers are described. |

375

376

**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.

Content:

`DataStructure+`

Element Documentation:

383

384

| **Name** | **Type** | **Documentation** |

385

| --- --| --- --| --- --|

386

| 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. |

387

388

**GeographicCodelistsType:** GeographicCodelistsType describes the structure of the geographic code lists container. It contains one or more geographic codelist, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`GeographicCodelist+`

393

394

Element Documentation:

395

396

| **Name** | **Type** | **Documentation** |

397

| --- --| --- --| --- --|

398

| GeographicCodelist | GeographicCodelistTy pe | GeographiCodelist provides the details of a geographic codelists container, which comprises a set of GeoFeatureSetCodes, by adding a value in the Code that follows a pattern to represent a geo feature set. |

399

400

**GeoGridCodelistsType:** GeoGridCodelistsType describes the structure of the codelists container. It contains one or more geographic grid codelist, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`GeoGridCodelist+`

Element Documentation:

407

408

| **Name** | **Type** | **Documentation** |

409

| --- --| --- --| --- --|

410

| GeoGridCodelist | GeoGridCodelistType | GeoGridCodelist provides the details of a geographic grid code list, which comprises a set of GridCodes, which are related to the gridDefinition specified in the GeoGridCodelist. |

411

412

**HierarchiesType:** HierarchiesType describes the structure of the hierarchies container. It contains one or more hierarchy, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`Hierarchy+`

Element Documentation:

419

420

| **Name** | **Type** | **Documentation** |

421

| --- --| --- --| --- --|

422

| Hierarchy | HierarchyType | Hierarchy provides the details of a hierarchy, which is defined as an organised collection of codes that may participate in many parent/child relationships with other codes in the list. |

423

424

**HierarchyAssociationsType:** HiearchyAssociationsType describes the structure of the hierarchy assoications container. It contains one or more hiearchy associations, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`HierarchyAssociation+`

429

430

Element Documentation:

431

432

| **Name** | **Type** | **Documentation** |

433

| --- --| --- --| --- --|

434

| HierarchyAssociation | HierarchyAssociation Type | HierarchyAssociation provides the details of a hiearchy assoication, which associates a hiearchy with an identifiable object in the context of another object. |

435

436

**MetadataConstraintsType:** MetadataConstraintsType describes the structure of the metadata constraints container. It contains one or more metadata constraint, which can be explicitly detailed or referenced from an external structure document or registry service. This container may contain both attachment and content constraints.

Content:

`MetadataConstraint+`

441

442

Element Documentation:

443

444

| **Name** | **Type** | **Documentation** |

445

| --- --| --- --| --- --|

446

| MetadataConstraint | MetadataConstraintTy pe | MetadataConstraint specifies a sub set of the definition of the allowable content of a metadata set. |

447

448

**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.

Content:

`Metadataflow+`

Element Documentation:

455

456

| **Name** | **Type** | **Documentation** |

457

| --- --| --- --| --- --|

458

| 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 |

459

460

**MetadataProviderSchemesType:** MetadataProviderSchemesType describes the structure of the metadata provider schemes container. It contains one or more metadata provider scheme, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`MetadataProviderScheme+`

465

466

Element Documentation:

467

468

| **Name** | **Type** | **Documentation** |

469

| --- --| --- --| --- --|

470

| MetadataProviderSche me | MetadataProviderSche meType | MetadataProviderScheme provides the details of an metadata provider scheme, in which metadata providers are described. |

471

472

**MetadataProvisionAgreementsType:** MetadataProvisionAgreementsType describes the structure of the metadata provision agreements container. It contains one or more metadata provision agreement, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`MetadataProvisionAgreement+`

477

478

Element Documentation:

479

480

| **Name** | **Type** | **Documentation** |

481

| --- --| --- --| --- --|

482

| MetadataProvisionAgr eement | MetadataProvisionAgr eementType | MetadataProvisionAgreement provides the details of a metadata provision agreement, which is an agreement for a metadata provider to report reference metadata against a flow. |

483

484

**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.

Content:

`MetadataStructure+`

Element Documentation:

491

492

| **Name** | **Type** | **Documentation** |

493

| --- --| --- --| --- --|

494

| MetadataStructure | MetadataStructureTyp e | MetadataStructure provides the details of a metadata structure definition, which is defined as a collection of metadata concepts, their structure and usage when used to collect or disseminate reference metadata. A metadata structure definition performs several functions: it groups sets of objects into "targets" against which reference metadata may be reported. Targets define the structure of the reference metadata "keys" which identify specific types of reported metadata, and describe the valid values for populating the keys. Also, metadata structure definitions provide a presentational organization of concepts for reporting purposes. The structure of reference metadata is derived from this presentational structure. |

495

496

**NamePersonalisationSchemesType:** NamePersonalisationSchemesType describes the structure of the name personalisation schemes container. It contains one or more name personalisation scheme, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`NamePersonalisationScheme+`

501

502

Element Documentation:

503

504

| **Name** | **Type** | **Documentation** |

505

| --- --| --- --| --- --|

506

| NamePersonalisationS cheme | NamePersonalisationS chemeType | NamePersonalisationScheme provides the details of a name personalisation scheme, in which name personalisations are described. |

507

508

**OrganisationSchemeMapsType:** OrganisationSchemeMapsType describes the structure of the organisation scheme maps container. It contains one or more organisation scheme map, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`OrganisationSchemeMap+`

513

514

Element Documentation:

515

516

| **Name** | **Type** | **Documentation** |

517

| --- --| --- --| --- --|

518

| OrganisationSchemeMa p | OrganisationSchemeMa pType | OrganisationSchemeMap provides the details of a organisation scheme map, which descibes mappings between organisations in different schemes. |

519

520

**OrganisationUnitSchemesType:** OrganisationUnitSchemesType describes the structure of the organisation unit schemes container. It contains one or more organisation unit scheme, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`OrganisationUnitScheme+`

525

526

Element Documentation:

527

528

| **Name** | **Type** | **Documentation** |

529

| --- --| --- --| --- --|

530

| OrganisationUnitSche me | OrganisationUnitSche meType | OrganisationUnitScheme provides the details of an organisation unit scheme, in which organisation units are described. |

531

532

**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.

Content:

`Process+`

Element Documentation:

539

540

| **Name** | **Type** | **Documentation** |

541

| --- --| --- --| --- --|

542

| 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. |

543

544

**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.

Content:

`ProvisionAgreement+`

549

550

Element Documentation:

551

552

| **Name** | **Type** | **Documentation** |

553

| --- --| --- --| --- --|

554

| ProvisionAgreement | ProvisionAgreementTy pe | ProvisionAgreement provides the details of a provision agreement, which is an agreement for a data provider to report data against a flow. |

555

556

**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.

Content:

`ReportingTaxonomy+`

Element Documentation:

563

564

| **Name** | **Type** | **Documentation** |

565

| --- --| --- --| --- --|

566

| ReportingTaxonomy | ReportingTaxonomyTyp e | 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. |

567

568

**ReportingTaxonomyMapsType:** ReportingTaxonomyMapsType describes the structure of the reporting taxonomy maps container. It contains one or reporting taxonomy map, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`ReportingTaxonomyMap+`

573

574

Element Documentation:

575

576

| **Name** | **Type** | **Documentation** |

577

| --- --| --- --| --- --|

578

| ReportingTaxonomyMap | ReportingTaxonomyMap Type | ReportingTaxonomyMap provides the details of a reporting taxonomy map, which descibes mappings between reporting taxonomies. |

579

580

**RepresentationMapsType:** RepresentationMapsType describes the structure of the representation maps container. It contains one or more representation map, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`RepresentationMap+`

Element Documentation:

587

588

| **Name** | **Type** | **Documentation** |

589

| --- --| --- --| --- --|

590

| RepresentationMap | RepresentationMapTyp e | RepresentationMap provides the details of a represenation map, which describes mappings between various component represenations. |

591

592

**RulesetSchemesType:** RulesetSchemesType describes the structure of the ruleset schemes container. It contains one or more ruleset scheme, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`RulesetScheme+`

Element Documentation:

599

600

| **Name** | **Type** | **Documentation** |

601

| --- --| --- --| --- --|

602

| RulesetScheme | RulesetSchemeType | RulesetScheme provides the details of a ruleset scheme, in which rulesets are described. |

603

604

**StructureMapsType:** StructureMapsType describes the structure of the structure maps container. It contains one or more structure maps, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`StructureMap+`

Element Documentation:

611

612

| **Name** | **Type** | **Documentation** |

613

| --- --| --- --| --- --|

614

| StructureMap | StructureMapType | StructureMap provides the details or a structure map, which describes mapping between data structures or dataflows. |

615

616

**TransformationSchemesType:** TransformationSchemesType describes the structure of the transformations container. It contains one or more transformation schemes, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`TransformationScheme+`

621

622

Element Documentation:

623

624

| **Name** | **Type** | **Documentation** |

625

| --- --| --- --| --- --|

626

| TransformationScheme | TransformationScheme Type | TransformationScheme provides the details of a transformation scheme, in which transformations are described. |

627

628

**UserDefinedOperatorSchemesType:** UserDefinedOperatorSchemesType describes the structure of the user defined operator schemes container. It contains one or more user defined operator scheme, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`UserDefinedOperatorScheme+`

633

634

Element Documentation:

635

636

| **Name** | **Type** | **Documentation** |

637

| --- --| --- --| --- --|

638

| UserDefinedOperatorS cheme | UserDefinedOperatorS chemeType | UserDefinedOperatorScheme provides the details of a user defined operator scheme, in which user defined operators are described. |

639

640

**ValueListsType:** ValueListsType describes the structure of the value lists container. It contains one or more value list, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`ValueList+`

Element Documentation:

647

648

| **Name** | **Type** | **Documentation** |

649

| --- --| --- --| --- --|

650

| ValueList | ValueListType | ValueList provides the details of a value list, which is a closed set of values that can occur for a dimension, measure, or attribute. This may be a simple list of values, or a list of values with names and descriptions (similar to a codelist). |

651

652

**VtlMappingSchemesType:** VtlMappingSchemesType describes the structure of the VTL mappings schemes container. It contains one or more VTL mapping schemes, which can be explicitly detailed or referenced from an external structure document or registry service.

Content:

`VtlMappingScheme+`

Element Documentation:

659

660

| **Name** | **Type** | **Documentation** |

661

| --- --| --- --| --- --|

662

| VtlMappingScheme | VtlMappingSchemeType | VtlMappingScheme provides the details of a VTL mapping scheme, in which VTL mappings are described. |

663

664

***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.

Derivation:

*`AnnotableType`*` (extension)`

669

*`IdentifiableType`*` (extension)`

670

*`NameableType`*` (extension)`

671

*`VersionableType`*` (restriction)`

672

*`MaintainableBaseType`*` (extension)`

673

*`MaintainableType`*` (extension)`

*`ItemSchemeType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, `*`Item*`*

683

684

Attribute Documentation:

685

686

| **Name** | **Type** | **Documentation** |

687

| --- --| --- --| --- --|

688

| id | IDType | The id is the identifier for the object. |

689

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

690

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

691

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

692

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

693

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

694

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

695

| 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. |

696

| 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. |

697

| 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. |

698

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

699

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

700

701

Element Documentation:

702

703

| **Name** | **Type** | **Documentation** |

704

| --- --| --- --| --- --|

705

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

706

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

707

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

708

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

709

| *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. |

710

711

***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.

Derivation:

*`AnnotableType`*` (extension)`

716

*`IdentifiableType`*` (extension)`

717

*`NameableType`*` (restriction)`

*`ItemBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

727

728

Attribute Documentation:

729

730

| **Name** | **Type** | **Documentation** |

731

| --- --| --- --| --- --|

732

| id | IDType | The id is the identifier for the object. |

733

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

734

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

735

736

Element Documentation:

737

738

| **Name** | **Type** | **Documentation** |

739

| --- --| --- --| --- --|

740

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

741

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

742

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

743

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

744

745

***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.

Derivation:

*`AnnotableType`*` (extension)`

750

*`IdentifiableType`*` (extension)`

751

*`NameableType`*` (restriction)`

752

*`ItemBaseType`*` (extension)`

*`ItemType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, (Parent | `*`Item+`*`)?`

760

761

Attribute Documentation:

762

763

| **Name** | **Type** | **Documentation** |

764

| --- --| --- --| --- --|

765

| id | IDType | The id is the identifier for the object. |

766

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

767

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

768

769

Element Documentation:

770

771

| **Name** | **Type** | **Documentation** |

772

| --- --| --- --| --- --|

773

| Annotations | AnnotationsType | Annotations is a reusable 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

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

775

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

776

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

777

| Parent | NestedIDType | |

778

| *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. |

779

780

***UnnestedItemType*:** UnnestedItemType is an abstract base type for all items with in an item scheme that do not contain nested items.

Derivation:

*`AnnotableType`* `(extension)`

785

*`IdentifiableType`*` (extension)`

786

*`NameableType`* `(restriction)`

787

*`ItemBaseType`*` (extension)`

788

*`ItemType`*` (restriction)`

*`UnnestedItemType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

797

798

Attribute Documentation:

799

800

| **Name** | **Type** | **Documentation** |

801

| --- --| --- --| --- --|

802

| id | IDType | The id is the identifier for the object. |

803

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

804

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

805

806

Element Documentation:

807

808

| **Name** | **Type** | **Documentation** |

809

| --- --| --- --| --- --|

810

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

811

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

812

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

813

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

814

815

***StructureType*:** StructureType is an abstract base type for all structure objects. Concrete instances of this should restrict to a concrete grouping.

Derivation:

*`AnnotableType`*` (extension)`

820

*`IdentifiableType`*` (extension)`

821

*`NameableType`*` (extension)`

822

*`VersionableType`*` (restriction)`

823

*`MaintainableBaseType`*` (extension)`

824

*`MaintainableType`*` (extension)`

*`StructureType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, `*`Grouping?`*

834

835

Attribute Documentation:

836

837

| **Name** | **Type** | **Documentation** |

838

| --- --| --- --| --- --|

839

| id | IDType | The id is the identifier for the object. |

840

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

841

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

842

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

843

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

844

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

845

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

846

| 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. |

847

| 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. |

848

| 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. |

849

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

850

851

Element Documentation:

852

853

| **Name** | **Type** | **Documentation** |

854

| --- --| --- --| --- --|

855

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

856

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

857

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

858

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

859

| *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. |

860

861

***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.

Content:

*`ComponentList*`*

Element Documentation:

868

869

| **Name** | **Type** | **Documentation** |

870

| --- --| --- --| --- --|

871

| *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. |

872

873

***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.

Derivation:

*`AnnotableType`*` (extension)`

878

*`IdentifiableType`*` (extension)`

879

*`ComponentListType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, `*`Component*`*

888

889

Attribute Documentation:

890

891

| **Name** | **Type** | **Documentation** |

892

| --- --| --- --| --- --|

893

| id | IDType | The id is the identifier for the object. |

894

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

895

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

896

897

Element Documentation:

898

899

| **Name** | **Type** | **Documentation** |

900

| --- --| --- --| --- --|

901

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

902

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

903

| *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. |

904

905

***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.

Derivation:

*`AnnotableType`*` (extension)`

910

*`IdentifiableType`*` (restriction)`

911

*`ComponentBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*`

920

921

Attribute Documentation:

922

923

| **Name** | **Type** | **Documentation** |

924

| --- --| --- --| --- --|

925

| id | NCNameIDType | The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

926

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

927

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

928

929

Element Documentation:

930

931

| **Name** | **Type** | **Documentation** |

932

| --- --| --- --| --- --|

933

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

934

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

935

936

***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.

Derivation:

*`AnnotableType`*` (extension)`

941

*`IdentifiableType`*` (restriction)`

942

*`ComponentBaseType`*` (extension)`

*`ComponentType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, ConceptIdentity?, LocalRepresentation?`

952

953

Attribute Documentation:

954

955

| **Name** | **Type** | **Documentation** |

956

| --- --| --- --| --- --|

957

| id | NCNameIDType | The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

958

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

959

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

960

961

Element Documentation:

962

963

| **Name** | **Type** | **Documentation** |

964

| --- --| --- --| --- --|

965

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

966

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

967

| ConceptIdentity | ConceptReferenceType | ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. |

968

| 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. |

969

970

***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.

Derivation:

*`AnnotableType`*` (extension)`

975

*`IdentifiableType`*` (extension)`

976

*`NameableType`*` (extension)`

977

*`VersionableType`*` (restriction)`

978

*`MaintainableBaseType`*` (extension)`

979

*`MaintainableType`*` (extension)`

980

*`StructureUsageType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Structure?`

989

990

Attribute Documentation:

991

992

| **Name** | **Type** | **Documentation** |

993

| --- --| --- --| --- --|

994

| id | IDType | The id is the identifier for the object. |

995

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

996

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

997

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

998

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

999

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

1000

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

1001

| 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. |

1002

| 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. |

1003

| 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. |

1004

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

1005

1006

Element Documentation:

1007

1008

| **Name** | **Type** | **Documentation** |

1009

| --- --| --- --| --- --|

1010

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

1011

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

1012

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

1013

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

1014

| Structure | StructureReferenceTy pe | 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). |

1015

1016

***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.

Attributes:

`minOccurs?, maxOccurs?`

Content:

`(TextFormat | (Enumeration, EnumerationFormat?))`

1025

1026

Attribute Documentation:

1027

1028

| **Name** | **Type** | **Documentation** |

1029

| --- --| --- --| --- --|

1030

| minOccurs (default: 1) | xs: nonNegativeInteger | The minOccurs attribute indicates the minimum number of value that must be reported for the component. |

1031

| maxOccurs | OccurenceType | The maxOccurs attribute indicates the maximum number of values that can be reported for the component. |

1032

1033

Element Documentation:

1034

1035

| **Name** | **Type** | **Documentation** |

1036

| --- --| --- --| --- --|

1037

| TextFormat | TextFormatType | TextFormat describes an uncoded textual format. |

1038

| Enumeration | AnyCodelistReference Type | Enumeration references an item scheme that enumerates the allowable values for this representation. |

1039

| EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |

1040

1041

**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".

Attributes:

`textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?, isMultiLingual?`

Content:

`SentinelValue*`

Attribute Documentation:

1052

1053

| **Name** | **Type** | **Documentation** |

1054

| --- --| --- --| --- --|

1055

| textType (default: String) | DataType | The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets. |

1056

| 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. |

1057

| 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. |

1058

| 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. |

1059

| 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. |

1060

| 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. |

1061

| startTime | 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. |

1062

| endTime | 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. |

1063

| minLength | xs:positiveInteger | The minLength attribute specifies the minimum and length of the value in characters. |

1064

| maxLength | xs:positiveInteger | The maxLength attribute specifies the maximum length of the value in characters. |

1065

| 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. |

1066

| 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. |

1067

| decimals | xs:positiveInteger | The decimals attribute indicates the number of characters allowed after the decimal separator. |

1068

| pattern | xs:string | The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema. |

1069

| 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. |

1070

1071

Element Documentation:

1072

1073

| **Name** | **Type** | **Documentation** |

1074

| --- --| --- --| --- --|

1075

| SentinelValue | SentinelValueType | SentinelValue defines a value that has a special meaning within the text format representation of a component. |

1076

1077

**SentinelValueType:** SentinelValueType defines the structure of a sentinel value. A sentinel is a value that has a special meaning within the text format representation of a component. The value is associated with a multi-lingual name and description.

Attributes:

`value`

Content:

`Name+, Description*`

1086

1087

Attribute Documentation:

1088

1089

| **Name** | **Type** | **Documentation** |

1090

| --- --| --- --| --- --|

1091

| value | xs:anySimpleType | The sentinel value being described. |

1092

1093

Element Documentation:

1094

1095

| **Name** | **Type** | **Documentation** |

1096

| --- --| --- --| --- --|

1097

| Name | TextType | Name is a reusable element, used for providing a human-readable name for an object. |

1098

| Description | TextType | Description is a reusable element, used for providing a longer human-readable description of an object. |

1099

1100

**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.

Derivation:

`TextFormatType (restriction)`

1105

`BasicComponentTextFormatType`

Attributes:

`textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?, isMultiLingual?`

Content:

`SentinelValue*`

Attribute Documentation:

1116

1117

| **Name** | **Type** | **Documentation** |

1118

| --- --| --- --| --- --|

1119

| textType (default: String) | 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. |

1120

| 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. |

1121

| 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. |

1122

| 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. |

1123

| 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. |

1124

| 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. |

1125

| startTime | 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. |

1126

| endTime | 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. |

1127

| minLength | xs:positiveInteger | The minLength attribute specifies the minimum and length of the value in characters. |

1128

| maxLength | xs:positiveInteger | The maxLength attribute specifies the maximum length of the value in characters. |

1129

| 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. |

1130

| 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. |

1131

| decimals | xs:positiveInteger | The decimals attribute indicates the number of characters allowed after the decimal separator. |

1132

| pattern | xs:string | The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema. |

1133

| 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. |

1134

1135

Element Documentation:

1136

1137

| **Name** | **Type** | **Documentation** |

1138

| --- --| --- --| --- --|

1139

| SentinelValue | SentinelValueType | SentinelValue defines a value that has a special meaning within the text format representation of a component. |

1140

1141

**SimpleComponentTextFormatType:** SimpleComponentTextFormatType is a restricted version of the BasicComponentTextFormatType that does not allow for multi-lingual values.

Derivation:

`TextFormatType (restriction)`

1146

`BasicComponentTextFormatType (restriction)`

1147

`SimpleComponentTextFormatType`

Attributes:

`textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, decimals?, pattern?`

Content:

`SentinelValue*`

Attribute Documentation:

1158

1159

| **Name** | **Type** | **Documentation** |

1160

| --- --| --- --| --- --|

1161

| textType (default: String) | SimpleDataType | The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets. |

1162

| 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. |

1163

| 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. |

1164

| 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. |

1165

| 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. |

1166

| 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. |

1167

| startTime | 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. |

1168

| endTime | 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. |

1169

| minLength | xs:positiveInteger | The minLength attribute specifies the minimum and length of the value in characters. |

1170

| maxLength | xs:positiveInteger | The maxLength attribute specifies the maximum length of the value in characters. |

1171

| 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. |

1172

| 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. |

1173

| decimals | xs:positiveInteger | The decimals attribute indicates the number of characters allowed after the decimal separator. |

1174

| pattern | xs:string | The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema. |

1175

1176

Element Documentation:

1177

1178

| **Name** | **Type** | **Documentation** |

1179

| --- --| --- --| --- --|

1180

| SentinelValue | SentinelValueType | SentinelValue defines a value that has a special meaning within the text format representation of a component. |

1181

1182

**CodedTextFormatType:** CodedTextFormatType is a restricted version of the SimpleComponentTextFormatType that only allows factets and text types applicable to codes. Although the time facets permit any value, an actual code identifier does not support the necessary characters for time. Therefore these facets should not contain time in their values.

Derivation:

`TextFormatType (restriction)`

1187

`BasicComponentTextFormatType (restriction)`

1188

`SimpleComponentTextFormatType (restriction)`

1189

`CodedTextFormatType`

Attributes:

`textType?, isSequence?, interval?, startValue?, endValue?, timeInterval?, startTime?, endTime?, minLength?, maxLength?, minValue?, maxValue?, pattern?`

Content:

`{Empty}`

Attribute Documentation:

1200

1201

| **Name** | **Type** | **Documentation** |

1202

| --- --| --- --| --- --|

1203

| 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. |

1204

| 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. |

1205

| 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. |

1206

| 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. |

1207

| 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. |

1208

| 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. |

1209

| startTime | 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. |

1210

| endTime | 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. |

1211

| minLength | xs:positiveInteger | The minLength attribute specifies the minimum and length of the value in characters. |

1212

| maxLength | xs:positiveInteger | The maxLength attribute specifies the maximum length of the value in characters. |

1213

| 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. |

1214

| 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. |

1215

| pattern | xs:string | The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema. |

1216

1217

**NonFacetedTextFormatType:** NonFacetedTextFormatType is a restricted version of the SimpleComponentTextFormatType that does not allow for any facets.

Derivation:

`TextFormatType (restriction)`

1222

`BasicComponentTextFormatType (restriction)`

1223

`SimpleComponentTextFormatType (restriction)`

1224

`NonFacetedTextFormatType`

Attributes:

`textType?`

Content:

`{Empty}`

Attribute Documentation:

1235

1236

| **Name** | **Type** | **Documentation** |

1237

| --- --| --- --| --- --|

1238

| textType | SimpleDataType | The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets. |

1239

1240

**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.

Derivation:

`TextFormatType (restriction)`

1245

`BasicComponentTextFormatType (restriction)`

1246

`SimpleComponentTextFormatType (restriction)`

`TimeTextFormatType`

Attributes:

`textType?, startTime?, endTime?`

Content:

`SentinelValue*`

Attribute Documentation:

1258

1259

| **Name** | **Type** | **Documentation** |

1260

| --- --| --- --| --- --|

1261

| textType (default: ObservationalTimePeriod) | TimeDataType | The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets. |

1262

| startTime | 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. |

1263

| endTime | 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. |

1264

1265

Element Documentation:

1266

1267

| **Name** | **Type** | **Documentation** |

1268

| --- --| --- --| --- --|

1269

| SentinelValue | SentinelValueType | SentinelValue defines a value that has a special meaning within the text format representation of a component. |

1270

1271

***CategorisationBaseType*:** CategorisationBaseType defines the base refinement of the CategorisationType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

1276

*`IdentifiableType`*` (extension)`

1277

*`NameableType`*` (extension)`

1278

*`VersionableType`*` (restriction)`

1279

*`MaintainableBaseType`*` (extension)`

1280

*`MaintainableType`*` (restriction)`

1281

*`CategorisationBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

1290

1291

Attribute Documentation:

1292

1293

| **Name** | **Type** | **Documentation** |

1294

| --- --| --- --| --- --|

1295

| id | IDType | The id is the identifier for the object. |

1296

| urn | CategorisationUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

1297

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

1298

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

1299

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

1300

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

1301

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

1302

| 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. |

1303

| 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. |

1304

| 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. |

1305

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

1306

1307

Element Documentation:

1308

1309

| **Name** | **Type** | **Documentation** |

1310

| --- --| --- --| --- --|

1311

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

1312

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

1313

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

1314

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

1315

1316

**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.

Derivation:

*`AnnotableType`*` (extension)`

1321

*`IdentifiableType`*` (extension)`

1322

*`NameableType`*` (extension)`

1323

*`VersionableType`*` (restriction)`

1324

*`MaintainableBaseType`*` (extension)`

1325

*`MaintainableType`*` (restriction)`

1326

*`CategorisationBaseType`*` (extension)`

`CategorisationType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, (Source, Target)?`

1336

1337

Attribute Documentation:

1338

1339

| **Name** | **Type** | **Documentation** |

1340

| --- --| --- --| --- --|

1341

| id | IDType | The id is the identifier for the object. |

1342

| urn | CategorisationUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

1343

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

1344

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

1345

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

1346

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

1347

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

1348

| 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. |

1349

| 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. |

1350

| 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. |

1351

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

1352

1353

Element Documentation:

1354

1355

| **Name** | **Type** | **Documentation** |

1356

| --- --| --- --| --- --|

1357

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

1358

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

1359

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

1360

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

1361

| Source | UrnReferenceType | Source is a reference to an object to be categorized. |

1362

| Target | CategoryReferenceTyp e | Target is reference to the category that the referenced object is to be mapped to. |

1363

1364

**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.

Derivation:

*`AnnotableType`*` (extension)`

1369

*`IdentifiableType`*` (extension)`

1370

*`NameableType`*` (extension)`

1371

*`VersionableType`*` (restriction)`

1372

*`MaintainableBaseType`*` (extension)`

1373

*`MaintainableType`*` (restriction)`

1374

*`ItemSchemeType`*` (restriction)`

`CategorySchemeType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, Category*`

1384

1385

Attribute Documentation:

1386

1387

| **Name** | **Type** | **Documentation** |

1388

| --- --| --- --| --- --|

1389

| id | NCNameIDType | The id attribute holds the identification of the category scheme. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the category scheme may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

1390

| urn | CategorySchemeUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

1391

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

1392

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

1393

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

1394

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

1395

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

1396

| 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. |

1397

| 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. |

1398

| 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. |

1399

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

1400

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

1401

1402

Element Documentation:

1403

1404

| **Name** | **Type** | **Documentation** |

1405

| --- --| --- --| --- --|

1406

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

1407

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

1408

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

1409

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

1410

| Category | CategoryType | Category represents a set of nested categories which describe a simple classification hierarchy. |

1411

1412

**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.

Derivation:

*`AnnotableType`*` (extension)`

1417

*`IdentifiableType`*` (extension)`

1418

*`NameableType`*` (restriction)`

1419

*`ItemBaseType`*` (extension)`

1420

*`ItemType`*` (restriction)`

`CategoryType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Category\*`

1430

1431

Attribute Documentation:

1432

1433

| **Name** | **Type** | **Documentation** |

1434

| --- --| --- --| --- --|

1435

| id | IDType | The id is the identifier for the object. |

1436

| urn | CategoryUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

1437

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

1438

1439

Element Documentation:

1440

1441

| **Name** | **Type** | **Documentation** |

1442

| --- --| --- --| --- --|

1443

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

1444

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

1445

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

1446

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

1447

| Category | CategoryType | Category represents a set of nested categories which describe a simple classification hierarchy. |

1448

1449

***CodelistBaseType*:** CodelistType defines the structure of a codelist. A codelist is defined as a list from which some statistical concepts (coded concepts) take their values.

Derivation:

*`AnnotableType`*` (extension)`

1454

*`IdentifiableType`*` (extension)`

1455

*`NameableType`*` (extension)`

1456

*`VersionableType`*` (restriction)`

1457

*`MaintainableBaseType`*` (extension)`

1458

*`MaintainableType`*` (restriction)`

1459

*`ItemSchemeType`*` (restriction)`

*`CodelistBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, (Code | GeoFeatureSetCode | GeoGridCode)*`

1469

1470

Attribute Documentation:

1471

1472

| **Name** | **Type** | **Documentation** |

1473

| --- --| --- --| --- --|

1474

| id | NCNameIDType | The id attribute holds the identification of the code list. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the code list may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

1475

| urn | CodelistUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

1476

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

1477

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

1478

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

1479

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

1480

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

1481

| 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. |

1482

| 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. |

1483

| 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. |

1484

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

1485

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

1486

1487

Element Documentation:

1488

1489

| **Name** | **Type** | **Documentation** |

1490

| --- --| --- --| --- --|

1491

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

1492

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

1493

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

1494

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

1495

| 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. |

**CodelistType:**

Derivation:

*`AnnotableType`*` (extension)`

1502

*`IdentifiableType`*` (extension)`

1503

*`NameableType`*` (extension)`

1504

*`VersionableType`*` (restriction)`

1505

*`MaintainableBaseType`*` (extension)`

1506

*`MaintainableType`*` (restriction)`

1507

*`ItemSchemeType`*` (restriction)`

1508

*`CodelistBaseType`*` (extension)`

`CodelistType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, (Code | GeoFeatureSetCode | GeoGridCode)*, CodelistExtension*`

1518

1519

Attribute Documentation:

1520

1521

| **Name** | **Type** | **Documentation** |

1522

| --- --| --- --| --- --|

1523

| id | NCNameIDType | The id attribute holds the identification of the code list. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the code list may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

1524

| urn | CodelistUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

1525

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

1526

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

1527

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

1528

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

1529

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

1530

| 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. |

1531

| 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. |

1532

| 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. |

1533

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

1534

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

1535

1536

Element Documentation:

1537

1538

| **Name** | **Type** | **Documentation** |

1539

| --- --| --- --| --- --|

1540

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

1541

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

1542

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

1543

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

1544

| Code | CodeType | Code describes a code in a codelist. In addition to the identification and description of the code, basic presentational information is also available. Presentational information not present may be added through the use of annotations.**Substitutions:** GeoFeatureSetCode, GeoGridCode |

1545

| CodelistExtension | CodelistExtensionTyp e | CodelistExtension allows for the extension of codelists by referencing the codelists to be extended and providing inclusion/exclusion rules for selecting the codes to extend. The order of these is important as it is indicates the order of precedence of the extended codelists for conflict resolution of codes. However, the prefix property can be used to ensure uniqueness of inherited codes in the extending codelist, in case conflicting codes must be included. |

1546

1547

**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.

Derivation:

*`AnnotableType`*` (extension)`

1552

*`IdentifiableType`*` (extension)`

1553

*`NameableType`*` (restriction)`

1554

*`ItemBaseType`*` (extension)`

1555

*`ItemType`*` (restriction)`

`CodeType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Parent?`

1565

1566

Attribute Documentation:

1567

1568

| **Name** | **Type** | **Documentation** |

1569

| --- --| --- --| --- --|

1570

| id | IDType | The id is the identifier for the object. |

1571

| urn | CodeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

1572

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

1573

1574

Element Documentation:

1575

1576

| **Name** | **Type** | **Documentation** |

1577

| --- --| --- --| --- --|

1578

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

1579

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

1580

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. It may be used in place of a short description. |

1581

| Description | TextType | Description provides a plain text, human-readable description of the code. This may be provided in multiple, parallel language-equivalent forms. |

1582

| Parent | SingleNCNameIDType | Parent provides the ability to describe simple hierarchies within a single codelist, by referencing the id value of another code in the same codelist. |

1583

1584

**CodelistExtensionType:** CodelistExtensionType defines the structure of a codelist to be extended by the codelist defining the extension. It provides a reference to the extended codelist and selection criteria to indicate the codes to be included in the extending codelist.

Attributes:

`prefix?`

Content:

`Codelist, (InclusiveCodeSelection | ExclusiveCodeSelection)?`

1593

1594

Attribute Documentation:

1595

1596

| **Name** | **Type** | **Documentation** |

1597

| --- --| --- --| --- --|

1598

| prefix | xs:string | A reference to a codelist may contain a prefix. If a prefix is provided, this prefix will be applied to all the codes in the codelist before they are imported into the extended codelist. |

1599

1600

Element Documentation:

1601

1602

| **Name** | **Type** | **Documentation** |

1603

| --- --| --- --| --- --|

1604

| Codelist | CodelistReferenceTyp e | |

1605

| InclusiveCodeSelecti on | CodeSelectionType | Selection of codes from the referenced (extended) codelist to be included in the extending codelist. |

1606

| ExclusiveCodeSelecti on | CodeSelectionType | Selection of codes from the referenced (extended) codelist to be excluded in the extending codelist. |

1607

1608

**CodeSelectionType:** CodeSelectionType defines the structure for code selection to be used as inclusive or exclusive extensions.

Content:

`MemberValue+`

Element Documentation:

1615

1616

| **Name** | **Type** | **Documentation** |

1617

| --- --| --- --| --- --|

1618

| MemberValue | MemberValueType | An explicit or wildcard selection of a code(s) from the codelist selected for inclusion/exclusion. If a wildcard expression is used, it is evaluated to determine codes selected for inclusion/exclusion. Otherwise, each member value is a distinct code. If the extended list is hierarchical, this can indicate whether child codes are to be included. |

1619

1620

**MemberValueType:** Allows for a ditinct reference or a wildcard expression for selecting codes from a codelist.

Derivation:

`xs:anySimpleType (restriction)`

1625

`xs:string (restriction)`

1626

`WildcardedMemberValueType (extension)`

`MemberValueType`

Attributes:

`cascadeValues?`

Content:

Attribute Documentation:

1636

1637

| **Name** | **Type** | **Documentation** |

1638

| --- --| --- --| --- --|

1639

| cascadeValues | CascadeSelectionType | Indicates whether child codes should be selected when the codelist is hierarchical. Possible values are true (include the selected and child codes), false (only include the selected code(s)), and excluderoot (include the children but not the selected code(s)). |

1640

1641

***GeoCodelistBaseType*:** GeoCodelistBaseType is an abstract base refinement of a codelist that restricts the cods to be derived from the abstract GeoRefCode.

Derivation:

*`AnnotableType`*` (extension)`

1646

*`IdentifiableType`*` (extension)`

1647

*`NameableType`*` (extension)`

1648

*`VersionableType`*` (restriction)`

1649

*`MaintainableBaseType`*` (extension)`

1650

*`MaintainableType`*` (restriction)`

1651

*`ItemSchemeType`*` (restriction)`

1652

*`CodelistBaseType`*` (extension)`

1653

`CodelistType (restriction)`

1654

*`GeoCodelistBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, `*`GeoRefCode*`*`, CodelistExtension*`

1663

1664

Attribute Documentation:

1665

1666

| **Name** | **Type** | **Documentation** |

1667

| --- --| --- --| --- --|

1668

| id | NCNameIDType | The id attribute holds the identification of the code list. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the code list may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

1669

| urn | CodelistUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

1670

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

1671

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

1672

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

1673

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

1674

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

1675

| 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. |

1676

| 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. |

1677

| 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. |

1678

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

1679

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

1680

1681

Element Documentation:

1682

1683

| **Name** | **Type** | **Documentation** |

1684

| --- --| --- --| --- --|

1685

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

1686

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

1687

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

1688

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

1689

| *GeoRefCode* | *GeoRefCodeType* | GeoRefCode is the abstract base from which specific types of geographic codes will be derived. |

1690

| CodelistExtension | CodelistExtensionTyp e | CodelistExtension allows for the extension of codelists by referencing the codelists to be extended and providing inclusion/exclusion rules for selecting the codes to extend. The order of these is important as it is indicates the order of precedence of the extended codelists for conflict resolution of codes. However, the prefix property can be used to ensure uniqueness of inherited codes in the extending codelist, in case conflicting codes must be included. |

1691

1692

***GeoCodelistType*:** GeoCodelistType is an abstract refinement of a codelist from which specific types of geographic codelists will be derived.

Derivation:

*`AnnotableType`*` (extension)`

1697

*`IdentifiableType`*` (extension)`

1698

*`NameableType`*` (extension)`

1699

*`VersionableType`*` (restriction)`

1700

*`MaintainableBaseType`*` (extension)`

1701

*`MaintainableType`*` (restriction)`

1702

*`ItemSchemeType`*` (restriction)`

1703

*`CodelistBaseType`*` (extension)`

1704

`CodelistType (restriction)`

1705

*`GeoCodelistBaseType`*` (extension)`

*`GeoCodelistType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, geoType`

Content:

`Annotations?, Link*, Name+, Description*, `*`GeoRefCode*`*`, CodelistExtension*`

1715

1716

Attribute Documentation:

1717

1718

| **Name** | **Type** | **Documentation** |

1719

| --- --| --- --| --- --|

1720

| id | NCNameIDType | The id attribute holds the identification of the code list. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the code list may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

1721

| urn | CodelistUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

1722

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

1723

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

1724

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

1725

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

1726

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

1727

| 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. |

1728

| 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. |

1729

| 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. |

1730

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

1731

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

1732

| geoType | GeoCodelistTypeType | The type of geographic codelist. The will be refined and provided a fixed value in the specific geographic codelist type implementations. |

1733

1734

Element Documentation:

1735

1736

| **Name** | **Type** | **Documentation** |

1737

| --- --| --- --| --- --|

1738

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

1739

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

1740

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

1741

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

1742

| *GeoRefCode* | *GeoRefCodeType* | GeoRefCode is the abstract base from which specific types of geographic codes will be derived. |

1743

| CodelistExtension | CodelistExtensionTyp e | CodelistExtension allows for the extension of codelists by referencing the codelists to be extended and providing inclusion/exclusion rules for selecting the codes to extend. The order of these is important as it is indicates the order of precedence of the extended codelists for conflict resolution of codes. However, the prefix property can be used to ensure uniqueness of inherited codes in the extending codelist, in case conflicting codes must be included. |

1744

1745

***GeoRefCodeType*:** GeoRefCodeType is the abstract base type defining the structure of geographic codes.

Derivation:

*`AnnotableType`*` (extension)`

1750

*`IdentifiableType`*` (extension)`

1751

*`NameableType`*` (restriction)`

1752

*`ItemBaseType`*` (extension)`

1753

*`ItemType`*` (restriction)`

1754

`CodeType (extension)`

*`GeoRefCodeType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Parent?`

1764

1765

Attribute Documentation:

1766

1767

| **Name** | **Type** | **Documentation** |

1768

| --- --| --- --| --- --|

1769

| id | IDType | The id is the identifier for the object. |

1770

| urn | CodeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

1771

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

1772

1773

Element Documentation:

1774

1775

| **Name** | **Type** | **Documentation** |

1776

| --- --| --- --| --- --|

1777

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

1778

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

1779

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. It may be used in place of a short description. |

1780

| Description | TextType | Description provides a plain text, human-readable description of the code. This may be provided in multiple, parallel language-equivalent forms. |

1781

| Parent | SingleNCNameIDType | Parent provides the ability to describe simple hierarchies within a single codelist, by referencing the id value of another code in the same codelist. |

1782

1783

**GeographicCodelistType:** GeographicCodelistType defines the sturcture of a geographic codelist. It comprises a set of GeoFeatureSetCodes, by adding a value in the Code that follows a pattern to represent a geo feature set.

Derivation:

*`AnnotableType`*` (extension)`

1788

*`IdentifiableType`*` (extension)`

1789

*`NameableType`*` (extension)`

1790

*`VersionableType`*` (restriction)`

1791

*`MaintainableBaseType`*` (extension)`

1792

*`MaintainableType`*` (restriction)`

1793

*`ItemSchemeType`*` (restriction)`

1794

*`CodelistBaseType`*` (extension)`

1795

`CodelistType (restriction)`

1796

*`GeoCodelistBaseType`*` (extension)`

1797

*`GeoCodelistType`*` (restriction)`

1798

`GeographicCodelistType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, geoType`

Content:

`Annotations?, Link*, Name+, Description*, GeoFeatureSetCode\*, CodelistExtension*`

1807

1808

Attribute Documentation:

1809

1810

| **Name** | **Type** | **Documentation** |

1811

| --- --| --- --| --- --|

1812

| id | NCNameIDType | The id attribute holds the identification of the code list. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the code list may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

1813

| urn | CodelistUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

1814

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

1815

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

1816

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

1817

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

1818

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

1819

| 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. |

1820

| 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. |

1821

| 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. |

1822

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

1823

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

1824

| geoType (fixed: GeographicCodelist) | GeoCodelistTypeType | The type of geographic codelist. The will be refined and provided a fixed value in the specific geographic codelist type implementations. |

1825

1826

Element Documentation:

1827

1828

| **Name** | **Type** | **Documentation** |

1829

| --- --| --- --| --- --|

1830

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

1831

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

1832

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

1833

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

1834

| GeoFeatureSetCode | GeoFeatureSetCodeTyp e | Is a geographic code in a geographic codelist. It adds a value to a code that folows a pattern to represent a geo feature set. |

1835

| CodelistExtension | CodelistExtensionTyp e | CodelistExtension allows for the extension of codelists by referencing the codelists to be extended and providing inclusion/exclusion rules for selecting the codes to extend. The order of these is important as it is indicates the order of precedence of the extended codelists for conflict resolution of codes. However, the prefix property can be used to ensure uniqueness of inherited codes in the extending codelist, in case conflicting codes must be included. |

1836

1837

**GeoFeatureSetCodeType:** GeoFeatureSetCodeType defines the structure of a geogrphic code.

Derivation:

*`AnnotableType`*` (extension)`

1842

*`IdentifiableType`*` (extension)`

1843

*`NameableType`*` (restriction)`

1844

*`ItemBaseType`*` (extension)`

1845

*`ItemType`*` (restriction)`

1846

`CodeType (extension)`

1847

*`GeoRefCodeType`*` (extension)`

1848

`GeoFeatureSetCodeType`

Attributes:

`id, urn?, uri?, value`

Content:

`Annotations?, Link*, Name+, Description*, Parent?`

1857

1858

Attribute Documentation:

1859

1860

| **Name** | **Type** | **Documentation** |

1861

| --- --| --- --| --- --|

1862

| id | IDType | The id is the identifier for the object. |

1863

| urn | CodeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

1864

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

1865

| value | xs:string | The geo feature set of the Code, which represents a set of points defining a feature in a format defined a predefined pattern (see section 6). |

1866

1867

Element Documentation:

1868

1869

| **Name** | **Type** | **Documentation** |

1870

| --- --| --- --| --- --|

1871

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

1872

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

1873

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. It may be used in place of a short description. |

1874

| Description | TextType | Description provides a plain text, human-readable description of the code. This may be provided in multiple, parallel language-equivalent forms. |

1875

| Parent | SingleNCNameIDType | Parent provides the ability to describe simple hierarchies within a single codelist, by referencing the id value of another code in the same codelist. |

1876

1877

***GeoGridCodelistBaseType*:** GeoGridCodelistBaseType is the abstract base refinement for a geographic grid codelist.

Derivation:

*`AnnotableType`*` (extension)`

1882

*`IdentifiableType`*` (extension)`

1883

*`NameableType`*` (extension)`

1884

*`VersionableType`*` (restriction)`

1885

*`MaintainableBaseType`*` (extension)`

1886

*`MaintainableType`*` (restriction)`

1887

*`ItemSchemeType`*` (restriction)`

1888

*`CodelistBaseType`*` (extension)`

1889

`CodelistType (restriction)`

1890

*`GeoCodelistBaseType`*` (extension)`

1891

*`GeoCodelistType`*` (restriction)` *`GeoGridCodelistBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, geoType`

Content:

`Annotations?, Link*, Name+, Description*, GeoGridCode*, CodelistExtension*`

1900

1901

Attribute Documentation:

1902

1903

| **Name** | **Type** | **Documentation** |

1904

| --- --| --- --| --- --|

1905

| id | NCNameIDType | The id attribute holds the identification of the code list. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the code list may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

1906

| urn | CodelistUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

1907

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

1908

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

1909

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

1910

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

1911

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

1912

| 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. |

1913

| 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. |

1914

| 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. |

1915

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

1916

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

1917

| geoType (fixed: GeoGridCodelist) | GeoCodelistTypeType | The type of geographic codelist. The will be refined and provided a fixed value in the specific geographic codelist type implementations. |

1918

1919

Element Documentation:

1920

1921

| **Name** | **Type** | **Documentation** |

1922

| --- --| --- --| --- --|

1923

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

1924

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

1925

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

1926

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

1927

| GeoGridCode | GeoGridCodeType | GeoGridCode is a code the represents a geographic grid cell that belongs to a specific grid definition. |

1928

| CodelistExtension | CodelistExtensionTyp e | CodelistExtension allows for the extension of codelists by referencing the codelists to be extended and providing inclusion/exclusion rules for selecting the codes to extend. The order of these is important as it is indicates the order of precedence of the extended codelists for conflict resolution of codes. However, the prefix property can be used to ensure uniqueness of inherited codes in the extending codelist, in case conflicting codes must be included. |

1929

1930

**GeoGridCodelistType:** GeoGridCodelistType defines the structure of a geographic grid code list. These define a geographical grid composed of cells representing regular squared portions of the Earth.

Derivation:

*`AnnotableType`*` (extension)`

1935

*`IdentifiableType`*` (extension)`

1936

*`NameableType`*` (extension)`

1937

*`VersionableType`*` (restriction)`

1938

*`MaintainableBaseType`*` (extension)`

1939

*`MaintainableType`*` (restriction)`

1940

*`ItemSchemeType`*` (restriction)`

1941

*`CodelistBaseType`*` (extension)`

1942

`CodelistType (restriction)`

1943

*`GeoCodelistBaseType`*` (extension)`

1944

*`GeoCodelistType`*` (restriction)` *`GeoGridCodelistBaseType`*` (extension)`

1945

`GeoGridCodelistType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, geoType`

Content:

`Annotations?, Link*, Name+, Description*, GeoGridCode*, CodelistExtension*, GridDefinition`

1954

1955

Attribute Documentation:

1956

1957

| **Name** | **Type** | **Documentation** |

1958

| --- --| --- --| --- --|

1959

| id | NCNameIDType | The id attribute holds the identification of the code list. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the code list may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

1960

| urn | CodelistUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

1961

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

1962

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

1963

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

1964

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

1965

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

1966

| 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. |

1967

| 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. |

1968

| 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. |

1969

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

1970

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

1971

| geoType (fixed: GeoGridCodelist) | GeoCodelistTypeType | The type of geographic codelist. The will be refined and provided a fixed value in the specific geographic codelist type implementations. |

1972

1973

Element Documentation:

1974

1975

| **Name** | **Type** | **Documentation** |

1976

| --- --| --- --| --- --|

1977

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

1978

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

1979

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

1980

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

1981

| GeoGridCode | GeoGridCodeType | GeoGridCode is a code the represents a geographic grid cell that belongs to a specific grid definition. |

1982

| CodelistExtension | CodelistExtensionTyp e | CodelistExtension allows for the extension of codelists by referencing the codelists to be extended and providing inclusion/exclusion rules for selecting the codes to extend. The order of these is important as it is indicates the order of precedence of the extended codelists for conflict resolution of codes. However, the prefix property can be used to ensure uniqueness of inherited codes in the extending codelist, in case conflicting codes must be included. |

1983

| GridDefinition | xs:string | Contains a regular expression string corresponding to the grid definition for the GeoGrid Codelist. |

1984

1985

**GeoGridCodeType:** GeoGridCodeType defines the structure of a geographic grid cell.

Derivation:

*`AnnotableType`*` (extension)`

1990

*`IdentifiableType`*` (extension)`

1991

*`NameableType`*` (restriction)`

1992

*`ItemBaseType`*` (extension)`

1993

*`ItemType`*` (restriction)`

1994

`CodeType (extension)`

1995

*`GeoRefCodeType`*` (extension)`

`GeoGridCodeType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Parent?, GeoCell`

2005

2006

Attribute Documentation:

2007

2008

| **Name** | **Type** | **Documentation** |

2009

| --- --| --- --| --- --|

2010

| id | IDType | The id is the identifier for the object. |

2011

| urn | CodeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2012

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2013

2014

Element Documentation:

2015

2016

| **Name** | **Type** | **Documentation** |

2017

| --- --| --- --| --- --|

2018

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2019

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2020

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. It may be used in place of a short description. |

2021

| Description | TextType | Description provides a plain text, human-readable description of the code. This may be provided in multiple, parallel language-equivalent forms. |

2022

| Parent | SingleNCNameIDType | Parent provides the ability to describe simple hierarchies within a single codelist, by referencing the id value of another code in the same codelist. |

2023

| GeoCell | xs:string | The value used to assign the Code to one cell in the grid. |

2024

2025

***ValueListBaseType*:** ValueListBaseType defines the base refinement of the ValueListType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

2030

*`IdentifiableType`*` (extension)`

2031

*`NameableType`*` (extension)`

2032

*`VersionableType`*` (restriction)`

2033

*`MaintainableBaseType`*` (extension)`

2034

*`MaintainableType`*` (restriction)`

2035

*`ValueListBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

2044

2045

Attribute Documentation:

2046

2047

| **Name** | **Type** | **Documentation** |

2048

| --- --| --- --| --- --|

2049

| id | IDType | The id is the identifier for the object. |

2050

| urn | ValueListUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2051

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2052

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

2053

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

2054

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

2055

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

2056

| 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. |

2057

| 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. |

2058

| 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. |

2059

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

2060

2061

Element Documentation:

2062

2063

| **Name** | **Type** | **Documentation** |

2064

| --- --| --- --| --- --|

2065

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2066

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2067

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2068

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2069

2070

**ValueListType:** ValueListType defines the structure of value list. These represent a closed set of values the can occur for a dimension, measure, or attribute. These may be values, or values with names and descriptions (similar to a codelist).

Derivation:

*`AnnotableType`*` (extension)`

2075

*`IdentifiableType`*` (extension)`

2076

*`NameableType`*` (extension)`

2077

*`VersionableType`*` (restriction)`

2078

*`MaintainableBaseType`*` (extension)`

2079

*`MaintainableType`*` (restriction)`

2080

*`ValueListBaseType`*` (extension)`

`ValueListType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, ValueItem*`

2090

2091

Attribute Documentation:

2092

2093

| **Name** | **Type** | **Documentation** |

2094

| --- --| --- --| --- --|

2095

| id | IDType | The id is the identifier for the object. |

2096

| urn | ValueListUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2097

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2098

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

2099

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

2100

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

2101

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

2102

| 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. |

2103

| 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. |

2104

| 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. |

2105

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

2106

2107

Element Documentation:

2108

2109

| **Name** | **Type** | **Documentation** |

2110

| --- --| --- --| --- --|

2111

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2112

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2113

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2114

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2115

| ValueItem | ValueItemType | |

2116

2117

**ValueItemType:** ValueItemType defines the structure of a value item. A value must be provided, and a longer name and description can be provided to provide additiona meaning to the value (similar to a code in a code list).

Derivation:

*`AnnotableType`*` (extension)`

`ValueItemType`

Attributes:

`id`

Content:

`Annotations?, Name*, Description*`

2131

2132

Attribute Documentation:

2133

2134

| **Name** | **Type** | **Documentation** |

2135

| --- --| --- --| --- --|

2136

| id | xs:string | |

2137

2138

Element Documentation:

2139

2140

| **Name** | **Type** | **Documentation** |

2141

| --- --| --- --| --- --|

2142

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2143

| Name | TextType | Name is a reusable element, used for providing a human-readable name for an object. |

2144

| Description | TextType | Description is a reusable element, used for providing a longer human-readable description of an object. |

2145

2146

**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.

Derivation:

*`AnnotableType`*` (extension)`

2151

*`IdentifiableType`*` (extension)`

2152

*`NameableType`*` (extension)`

2153

*`VersionableType`*` (restriction)`

2154

*`MaintainableBaseType`*` (extension)`

2155

*`MaintainableType`*` (restriction)`

2156

*`ItemSchemeType`*` (restriction)`

`ConceptSchemeType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, Concept*`

2166

2167

Attribute Documentation:

2168

2169

| **Name** | **Type** | **Documentation** |

2170

| --- --| --- --| --- --|

2171

| id | NCNameIDType | The id attribute holds the identification of the concept scheme. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the concept scheme may be used to create simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

2172

| urn | ConceptSchemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2173

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2174

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

2175

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

2176

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

2177

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

2178

| 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. |

2179

| 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. |

2180

| 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. |

2181

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

2182

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

2183

2184

Element Documentation:

2185

2186

| **Name** | **Type** | **Documentation** |

2187

| --- --| --- --| --- --|

2188

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2189

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2190

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2191

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2192

| Concept | ConceptType | Concept describes the details of a concept within a concept scheme. |

2193

2194

***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.

Derivation:

*`AnnotableType`*` (extension)`

2199

*`IdentifiableType`*` (extension)`

2200

*`NameableType`*` (restriction)`

2201

*`ItemBaseType`*` (extension)`

2202

*`ItemType`*` (restriction)`

*`ConceptBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Parent?`

2212

2213

Attribute Documentation:

2214

2215

| **Name** | **Type** | **Documentation** |

2216

| --- --| --- --| --- --|

2217

| id | NCNameIDType | The id attribute holds the identification of the concept. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since concept id may be used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

2218

| urn | ConceptUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2219

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2220

2221

Element Documentation:

2222

2223

| **Name** | **Type** | **Documentation** |

2224

| --- --| --- --| --- --|

2225

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2226

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2227

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2228

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2229

| Parent | SingleNCNameIDType | Parent captures the semantic relationships between concepts which occur within a single concept scheme. This identifies the concept of which the current concept is a qualification (in the ISO 11179 sense) or subclass. |

2230

2231

**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).

Derivation:

*`AnnotableType`*` (extension)`

2236

*`IdentifiableType`*` (extension)`

2237

*`NameableType`*` (restriction)`

2238

*`ItemBaseType`*` (extension)`

2239

*`ItemType`*` (restriction)`

2240

*`ConceptBaseType`*` (extension)`

`ConceptType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Parent?, CoreRepresentation?, ISOConceptReference?`

2250

2251

Attribute Documentation:

2252

2253

| **Name** | **Type** | **Documentation** |

2254

| --- --| --- --| --- --|

2255

| id | NCNameIDType | The id attribute holds the identification of the concept. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since concept id may be used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

2256

| urn | ConceptUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2257

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2258

2259

Element Documentation:

2260

2261

| **Name** | **Type** | **Documentation** |

2262

| --- --| --- --| --- --|

2263

| Annotations | AnnotationsType | Annotations is a reusable 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

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2265

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2266

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2267

| Parent | SingleNCNameIDType | Parent captures the semantic relationships between concepts which occur within a single concept scheme. This identifies the concept of which the current concept is a qualification (in the ISO 11179 sense) or subclass. |

2268

| CoreRepresentation | ConceptRepresentatio n | |

2269

| ISOConceptReference | ISOConceptReferenceT ype | Provides a reference to an ISO 11179 concept. |

2270

2271

**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.

Derivation:

*`RepresentationType`*` (restriction)`

2276

`ConceptRepresentation`

Attributes:

`minOccurs?, maxOccurs?`

Content:

`(TextFormat | (Enumeration, EnumerationFormat?))`

2285

2286

Attribute Documentation:

2287

2288

| **Name** | **Type** | **Documentation** |

2289

| --- --| --- --| --- --|

2290

| minOccurs (default: 1) | xs: nonNegativeInteger | The minOccurs attribute indicates the minimum number of value that must be reported for the component. |

2291

| maxOccurs | OccurenceType | The maxOccurs attribute indicates the maximum number of values that can be reported for the component. |

2292

2293

Element Documentation:

2294

2295

| **Name** | **Type** | **Documentation** |

2296

| --- --| --- --| --- --|

2297

| TextFormat | BasicComponentTextFo rmatType | TextFormat describes an uncoded textual format. |

2298

| Enumeration | AnyCodelistReference Type | Enumeration references a codelist which enumerates the possible values that can be used as the representation of this concept. |

2299

| EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |

2300

2301

**ISOConceptReferenceType:** ISOConceptReferenceType provides a reference to and ISO 11179 concept.

Content:

`ConceptAgency, ConceptSchemeID, ConceptID`

2306

2307

Element Documentation:

2308

2309

| **Name** | **Type** | **Documentation** |

2310

| --- --| --- --| --- --|

2311

| ConceptAgency | xs:string | |

2312

| ConceptSchemeID | xs:string | |

2313

| ConceptID | xs:string | |

2314

2315

***ConstraintBaseType*:** ConstraintBaseType is an abstract base type that forms the basis of the main abstract ConstraintType. It requires that a name be provided.

Derivation:

*`AnnotableType`*` (extension)`

2320

*`IdentifiableType`*` (extension)`

2321

*`NameableType`*` (extension)`

2322

*`VersionableType`*` (restriction)`

2323

*`MaintainableBaseType`*` (extension)`

2324

*`MaintainableType`*` (restriction)`

2325

*`ConstraintBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

2334

2335

Attribute Documentation:

2336

2337

| **Name** | **Type** | **Documentation** |

2338

| --- --| --- --| --- --|

2339

| id | IDType | The id is the identifier for the object. |

2340

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2341

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2342

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

2343

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

2344

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

2345

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

2346

| 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. |

2347

| 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. |

2348

| 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. |

2349

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

2350

2351

Element Documentation:

2352

2353

| **Name** | **Type** | **Documentation** |

2354

| --- --| --- --| --- --|

2355

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2356

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2357

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2358

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2359

2360

***ConstraintType*:** ConstraintType is an abstract base type that specific types of constraints (data and metadata) restrict and extend to describe their details. These constraint types both define a constraint attachment and a release calendar.

Derivation:

*`AnnotableType`*` (extension)`

2365

*`IdentifiableType`*` (extension)`

2366

*`NameableType`*` (extension)`

2367

*`VersionableType`*` (restriction)`

2368

*`MaintainableBaseType`*` (extension)`

2369

*`MaintainableType`*` (restriction)`

2370

*`ConstraintBaseType`*` (extension)`

*`ConstraintType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role`

Content:

`Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?`

2380

2381

Attribute Documentation:

2382

2383

| **Name** | **Type** | **Documentation** |

2384

| --- --| --- --| --- --|

2385

| id | IDType | The id is the identifier for the object. |

2386

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2387

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2388

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

2389

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

2390

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

2391

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

2392

| 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. |

2393

| 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. |

2394

| 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. |

2395

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

2396

| role | ConstraintRoleType | The role attribute indicates whether this constraint states what data is actually present for the constraint attachment, or if it defines what content is allowed. |

2397

2398

Element Documentation:

2399

2400

| **Name** | **Type** | **Documentation** |

2401

| --- --| --- --| --- --|

2402

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2403

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2404

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2405

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2406

| ConstraintAttachment | *ConstraintAttachment Type* | ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. |

2407

| ReleaseCalendar | ReleaseCalendarType | ReleaseCalendar defines dates on which the constrained data is to be made available. |

2408

2409

***DataConstraintBaseType*:** DataConstraintBaseType is an abstract base refinement of ConstraintType. The constraint attachment is restricted to constrainable artefacts related to data.

Derivation:

*`AnnotableType`*` (extension)`

2414

*`IdentifiableType`*` (extension)`

2415

*`NameableType`*` (extension)`

2416

*`VersionableType`*` (restriction)`

2417

*`MaintainableBaseType`*` (extension)`

2418

*`MaintainableType`*` (restriction)`

2419

*`ConstraintBaseType`*` (extension)`

2420

*`ConstraintType`*` (restriction)`

2421

*`DataConstraintBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role`

Content:

`Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?`

2430

2431

Attribute Documentation:

2432

2433

| **Name** | **Type** | **Documentation** |

2434

| --- --| --- --| --- --|

2435

| id | IDType | The id is the identifier for the object. |

2436

| urn | DataConstraintUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2437

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2438

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

2439

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

2440

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

2441

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

2442

| 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. |

2443

| 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. |

2444

| 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. |

2445

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

2446

| role | ConstraintRoleType | The role attribute indicates whether this constraint states what data is actually present for the constraint attachment, or if it defines what content is allowed. |

2447

2448

Element Documentation:

2449

2450

| **Name** | **Type** | **Documentation** |

2451

| --- --| --- --| --- --|

2452

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2453

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2454

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2455

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2456

| ConstraintAttachment | DataConstraintAttach mentType | ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. |

2457

| ReleaseCalendar | ReleaseCalendarType | ReleaseCalendar defines dates on which the constrained data is to be made available. |

2458

2459

**DataConstraintType:** DataConstraintType defines the structure of a data constraint. A data constraint can specify either the available set of keys (DataKeySet) or set of component values (CubeRegion) in a data source, or the allowable keys that can be constructed from a data structure definition. Multiple such constraints may be present for a constrained artefact. For instance, there may be a constraing that specifies the values allowed for the data source (role is "Allowed") which can be used for validation or for constructing a partial code list, whilst another constraing can specify the actual content of a data source (role is "Actual").

Derivation:

*`AnnotableType`*` (extension)`

2464

*`IdentifiableType`*` (extension)`

2465

*`NameableType`*` (extension)`

2466

*`VersionableType`*` (restriction)`

2467

*`MaintainableBaseType`*` (extension)`

2468

*`MaintainableType`*` (restriction)`

2469

*`ConstraintBaseType`*` (extension)`

2470

*`ConstraintType`*` (restriction)`

2471

*`DataConstraintBaseType`*` (extension)`

`DataConstraintType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role`

Content:

`Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?, DataKeySet*, CubeRegion[0..2]`

2481

2482

Attribute Documentation:

2483

2484

| **Name** | **Type** | **Documentation** |

2485

| --- --| --- --| --- --|

2486

| id | IDType | The id is the identifier for the object. |

2487

| urn | DataConstraintUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2488

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2489

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

2490

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

2491

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

2492

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

2493

| 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. |

2494

| 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. |

2495

| 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. |

2496

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

2497

| role | ConstraintRoleType | The role attribute indicates whether this constraint states what data is actually present for the constraint attachment, or if it defines what content is allowed. |

2498

2499

Element Documentation:

2500

2501

| **Name** | **Type** | **Documentation** |

2502

| --- --| --- --| --- --|

2503

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2504

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2505

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2506

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2507

| ConstraintAttachment | DataConstraintAttach mentType | ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. |

2508

| ReleaseCalendar | ReleaseCalendarType | ReleaseCalendar defines dates on which the constrained data is to be made available. |

2509

| DataKeySet | DataKeySetType | DataKeySet defines a full, distinct set of dimension values and the attribute values associated with the key. |

2510

| CubeRegion | CubeRegionType | CubeRegion defines a slice of the data set (dimensions and attribute values) for the constrained artefact. A set of included or excluded regions can be described. |

2511

2512

***MetadataConstraintBaseType*:** MetadataConstraintBaseType is an abstract base refinement of ConstraintType. The constraint attachment is restricted to constrainable artefacts related to metadata, and the only possible role is "Allowed".

Derivation:

*`AnnotableType`*` (extension)`

2517

*`IdentifiableType`*` (extension)`

2518

*`NameableType`*` (extension)`

2519

*`VersionableType`*` (restriction)`

2520

*`MaintainableBaseType`*` (extension)`

2521

*`MaintainableType`*` (restriction)`

2522

*`ConstraintBaseType`*` (extension)`

2523

*`ConstraintType`*` (restriction)`

2524

*`MetadataConstraintBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role`

Content:

`Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?`

2533

2534

Attribute Documentation:

2535

2536

| **Name** | **Type** | **Documentation** |

2537

| --- --| --- --| --- --|

2538

| id | IDType | The id is the identifier for the object. |

2539

| urn | MetadataConstraintUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2540

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2541

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

2542

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

2543

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

2544

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

2545

| 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. |

2546

| 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. |

2547

| 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. |

2548

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

2549

| role (fixed: Allowed) | ConstraintRoleType | The role attribute indicates whether this constraint states what data is actually present for the constraint attachment, or if it defines what content is allowed. |

2550

2551

Element Documentation:

2552

2553

| **Name** | **Type** | **Documentation** |

2554

| --- --| --- --| --- --|

2555

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2556

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2557

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2558

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2559

| ConstraintAttachment | MetadataConstraintAt tachmentType | ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. |

2560

| ReleaseCalendar | ReleaseCalendarType | ReleaseCalendar defines dates on which the constrained data is to be made available. |

2561

2562

**MetadataConstraintType:** MetadataConstraintType defines the structure of a metadata constraint. A metadata constraint can specify allowed attribute values for metadata described by the constrained artefact.

Derivation:

*`AnnotableType`*` (extension)`

2567

*`IdentifiableType`*` (extension)`

2568

*`NameableType`*` (extension)`

2569

*`VersionableType`*` (restriction)`

2570

*`MaintainableBaseType`*` (extension)`

2571

*`MaintainableType`*` (restriction)`

2572

*`ConstraintBaseType`*` (extension)`

2573

*`ConstraintType`*` (restriction)`

2574

*`MetadataConstraintBaseType`*` (extension)`

2575

`MetadataConstraintType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role`

Content:

`Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?, MetadataTargetRegion[0..2]`

2584

2585

Attribute Documentation:

2586

2587

| **Name** | **Type** | **Documentation** |

2588

| --- --| --- --| --- --|

2589

| id | IDType | The id is the identifier for the object. |

2590

| urn | MetadataConstraintUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2591

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2592

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

2593

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

2594

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

2595

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

2596

| 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. |

2597

| 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. |

2598

| 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. |

2599

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

2600

| role (fixed: Allowed) | ConstraintRoleType | The role attribute indicates whether this constraint states what data is actually present for the constraint attachment, or if it defines what content is allowed. |

2601

2602

Element Documentation:

2603

2604

| **Name** | **Type** | **Documentation** |

2605

| --- --| --- --| --- --|

2606

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2607

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2608

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2609

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2610

| ConstraintAttachment | MetadataConstraintAt tachmentType | ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. |

2611

| ReleaseCalendar | ReleaseCalendarType | ReleaseCalendar defines dates on which the constrained data is to be made available. |

2612

| MetadataTargetRegion | MetadataTargetRegion Type | MetadataTargetRegion describes the values allowed for metadata attributes. |

2613

2614

**ReleaseCalendarType:** ReleaseCalendarType describes information about the timing of releases of the constrained data. All of these values use the standard "P7D" - style format.

Content:

`Periodicity, Offset, Tolerance`

2619

2620

Element Documentation:

2621

2622

| **Name** | **Type** | **Documentation** |

2623

| --- --| --- --| --- --|

2624

| Periodicity | xs:string | Periodicity is the period between releases of the data set. |

2625

| Offset | xs:string | Offset is the interval between January first and the first release of data within the year. |

2626

| Tolerance | xs:string | Tolerance is the period after which the release of data may be deemed late. |

2627

2628

**DataKeySetType:** DataKeySetType defines a collection of full or partial data keys (dimension values).

Attributes:

`isIncluded`

Content:

`Key+`

Attribute Documentation:

2639

2640

| **Name** | **Type** | **Documentation** |

2641

| --- --| --- --| --- --|

2642

| isIncluded | xs:boolean | The isIncluded attribute indicates whether the keys defined in this key set are inclusive or exclusive to the constraint. |

2643

2644

Element Documentation:

2645

2646

| **Name** | **Type** | **Documentation** |

2647

| --- --| --- --| --- --|

2648

| Key | DataKeyType | Key contains a set of dimension values which identify a full set of data. |

2649

2650

***ConstraintAttachmentType*:** ConstraintAttachmentType describes a collection of references to constrainable artefacts.

Content:

Element Documentation:

2657

2658

| **Name** | **Type** | **Documentation** |

2659

| --- --| --- --| --- --|

2660

| DataProvider | DataProviderReferenc eType | DataProvider is reference to a data provider to which the constraint is attached. If this is used, then only the release calendar is relevant. The referenced is provided as a URN and/or a full set of reference fields. |

2661

| MetadataProvider | MetadataProviderRefe renceType | MetadataProvider is reference to a metadata provider to which the constraint is attached. If this is used, then only the release calendar is relevant. The referenced is provided as a URN and/or a full set of reference fields. |

2662

| MetadataSet | MetadataSetReference Type | 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. |

2663

| SimpleDataSource | xs:anyURI | SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message. |

2664

| DataStructure | 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. |

2665

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2666

| MetadataStructure | 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. |

2667

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2668

| Dataflow | 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. |

2669

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2670

| Metadataflow | 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. |

2671

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2672

| ProvisionAgreement | 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. |

2673

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2674

| MetadataProvisionAgr eement | MetadataProvisionAgr eementReferenceType | 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. |

2675

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2676

2677

**DataConstraintAttachmentType:** DataConstraintAttachmentType restricts the base ConstraintAttachmentType to only allow artefacts related to data.

Derivation:

*`ConstraintAttachmentType`*` (restriction)`

2682

`DataConstraintAttachmentType`

Content:

`(DataProvider | SimpleDataSource+ | (DataStructure+, QueryableDataSource*) | (Dataflow+, QueryableDataSource*) | (ProvisionAgreement+, QueryableDataSource*))`

2687

2688

Element Documentation:

2689

2690

| **Name** | **Type** | **Documentation** |

2691

| --- --| --- --| --- --|

2692

| DataProvider | DataProviderReferenc eType | DataProvider is reference to a data provider to which the constraint is attached. If this is used, then only the release calendar is relevant. The referenced is provided as a URN and/or a full set of reference fields. |

2693

| SimpleDataSource | xs:anyURI | SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message. |

2694

| DataStructure | 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. |

2695

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2696

| Dataflow | 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. |

2697

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2698

| ProvisionAgreement | 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. |

2699

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2700

2701

**MetadataConstraintAttachmentType:** MetadataConstraintAttachmentType restricts the base ConstraintAttachmentType to only allow artefacts related to metadata.

Derivation:

*`ConstraintAttachmentType`*` (restriction)`

2706

`MetadataConstraintAttachmentType`

Content:

Element Documentation:

2713

2714

| **Name** | **Type** | **Documentation** |

2715

| --- --| --- --| --- --|

2716

| MetadataProvider | MetadataProviderRefe renceType | MetadataProvider is reference to a metadata provider to which the constraint is attached. If this is used, then only the release calendar is relevant. The referenced is provided as a URN and/or a full set of reference fields. |

2717

| MetadataSet | MetadataSetReference Type | 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. |

2718

| SimpleDataSource | xs:anyURI | SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message. |

2719

| MetadataStructure | 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. |

2720

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2721

| Metadataflow | 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. |

2722

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2723

| MetadataProvisionAgr eement | MetadataProvisionAgr eementReferenceType | 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. |

2724

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2725

2726

***RegionType*:** RegionType is an abstract type which defines a generic constraint region. This type can be refined to define regions for data or metadata sets. A region is defined by a collection of key values - each of which a collection of values for a component which disambiguates data (i.e. dimensions of a dataset). For each region, a collection of attribute values can be provided. Taken together, the key values and attributes serve to identify or describe a subset of a data or metadata set. Finally, the region can flagged as being included or excluded, although this flag only makes sense when the region is used in a particular context.

Derivation:

*`AnnotableType`*` (extension)`

*`RegionType`*

Attributes:

`include?, validFrom?, validTo?`

Content:

`Annotations?, KeyValue*, Component*`

2740

2741

Attribute Documentation:

2742

2743

| **Name** | **Type** | **Documentation** |

2744

| --- --| --- --| --- --|

2745

| include (default: true) | xs:boolean | The include attribute indicates that the region is to be included or excluded within the context in which it is defined. For example, if the regions is defined as part of a content constraint, the exclude flag would mean the data identified by the region is not present. |

2746

| validFrom | StandardTimePeriodTy pe | |

2747

| validTo | StandardTimePeriodTy pe | |

2748

2749

Element Documentation:

2750

2751

| **Name** | **Type** | **Documentation** |

2752

| --- --| --- --| --- --|

2753

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2754

| KeyValue | *MemberSelectionType* | KeyValue contains a reference to a component which disambiguates the data (i.e. a dimension) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region. |

2755

| Component | *MemberSelectionType* | Component contains a reference to a component (data attribute, metadata attribute, or measure) and provides a collection of values for the referenced component. This serves to state that for the key which defines the region, the components that are specified here have or do not have (depending on the include attribute of the value set) the values provided. It is possible to provide a component reference without specifying values, for the purpose of stating the component is absent (include = false) or present with an unbounded set of values. As opposed to key components, which are assumed to be wild carded if absent, no assumptions are made about the absence of a component. Only components which are explicitly stated to be present or absent from the region will be know. All unstated components for the set cannot be assumed to absent or present. |

2756

2757

***MemberSelectionType*:** MemberSelectionType is an abstract base type which is used to provide a set of values for a referenced component. Implementations of this type will be based on a particular component type and refine the allowed values to reflect the types of values that are possible for that type of component.

Attributes:

`id, include?, removePrefix?, validFrom?, validTo?`

Content:

`(Value+ | TimeRange)?`

2766

2767

Attribute Documentation:

2768

2769

| **Name** | **Type** | **Documentation** |

2770

| --- --| --- --| --- --|

2771

| id | NestedNCNameIDType | The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate. |

2772

| include (default: true) | xs:boolean | The include attribute indicates whether the values provided for the referenced component are to be included or excluded from the region in which they are defined. |

2773

| removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |

2774

| validFrom | StandardTimePeriodTy pe | |

2775

| validTo | StandardTimePeriodTy pe | |

2776

2777

Element Documentation:

2778

2779

| **Name** | **Type** | **Documentation** |

2780

| --- --| --- --| --- --|

2781

| Value | SimpleComponentValue Type | Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes. |

2782

| TimeRange | TimeRangeValueType | TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive). |

2783

2784

**DataKeyType:** DataKeyType is a region which defines a distinct full or partial data key. The key consists of a set of values, each referencing a dimension and providing a single value for that dimension. The purpose of the key is to define a subset of a data set (i.e. the observed value and data attribute) which have the dimension values provided in this definition. Any dimension not stated explicitly in this key is assumed to be wild carded, thus allowing for the definition of partial data keys.

Derivation:

*`AnnotableType`*` (extension)`

2789

*`RegionType`* `(restriction)`

`DataKeyType`

Attributes:

`include?, validFrom?, validTo?`

Content:

`Annotations?, KeyValue*, Component*`

2799

2800

Attribute Documentation:

2801

2802

| **Name** | **Type** | **Documentation** |

2803

| --- --| --- --| --- --|

2804

| include (fixed: true) | xs:boolean | The include attribute has a fixed value of true for a distinct key, since such a key is always assumed to identify existing data or metadata. |

2805

| validFrom | StandardTimePeriodTy pe | |

2806

| validTo | StandardTimePeriodTy pe | |

2807

2808

Element Documentation:

2809

2810

| **Name** | **Type** | **Documentation** |

2811

| --- --| --- --| --- --|

2812

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2813

| KeyValue | DataKeyValueType | KeyValue contains a reference to a component which disambiguates the data (i.e. a dimension) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region. |

2814

| Component | DataComponentValueSe tType | Component contains a reference to a component (data attribute, metadata attribute, or measure) and provides a collection of values for the referenced component. This serves to state that for the key which defines the region, the components that are specified here have or do not have (depending on the include attribute of the value set) the values provided. It is possible to provide a component reference without specifying values, for the purpose of stating the component is absent (include = false) or present with an unbounded set of values. As opposed to key components, which are assumed to be wild carded if absent, no assumptions are made about the absence of a component. Only components which are explicitly stated to be present or absent from the region will be know. All unstated components for the set cannot be assumed to absent or present. |

2815

2816

**DataKeyValueType:** DataKeyValueType is a type for providing a dimension value for the purpose of defining a distinct data key. Only a single value can be provided for the dimension.

Derivation:

*`MemberSelectionType`*` (restriction)`

`DataKeyValueType`

Attributes:

`id, include?, removePrefix?`

Content:

`Value`

Attribute Documentation:

2832

2833

| **Name** | **Type** | **Documentation** |

2834

| --- --| --- --| --- --|

2835

| id | SingleNCNameIDType | The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate. |

2836

| include (fixed: true) | xs:boolean | The include attribute indicates whether the values provided for the referenced component are to be included or excluded from the region in which they are defined. |

2837

| removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |

2838

2839

Element Documentation:

2840

2841

| **Name** | **Type** | **Documentation** |

2842

| --- --| --- --| --- --|

2843

| Value | SimpleKeyValueType | Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes. |

2844

2845

**DataComponentValueSetType:** DataComponentValueSetType defines the structure for providing values for a data attributes, measures, or metadata attributes. If no values are provided, the component is implied to include/excluded from the region in which it is defined, with no regard to the value of the component. Note that for metadata attributes which occur within other metadata attributes, a nested identifier can be provided. For example, a value of CONTACT.ADDRESS.STREET refers to the metadata attribute with the identifier STREET which exists in the ADDRESS metadata attribute in the CONTACT metadata attribute, which is defined at the root of the report structure.

Derivation:

*`MemberSelectionType`*` (restriction)`

2850

`DataComponentValueSetType`

Attributes:

`id, include?, removePrefix?`

Content:

`(Value+ | TimeRange)?`

2859

2860

Attribute Documentation:

2861

2862

| **Name** | **Type** | **Documentation** |

2863

| --- --| --- --| --- --|

2864

| id | NestedNCNameIDType | The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate. |

2865

| include (default: true) | xs:boolean | The include attribute indicates whether the values provided for the referenced component are to be included or excluded from the region in which they are defined. |

2866

| removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |

2867

2868

Element Documentation:

2869

2870

| **Name** | **Type** | **Documentation** |

2871

| --- --| --- --| --- --|

2872

| Value | DataComponentValueTy pe | Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes. |

2873

| TimeRange | TimeRangeValueType | TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive). |

2874

2875

**CubeRegionType:** CubeRegionType defines the structure of a data cube region. This is based on the abstract RegionType and simply refines the key and attribute values to conform with what is applicable for dimensions and attributes, respectively. See the documentation of the base type for more details on how a region is defined.

Derivation:

*`AnnotableType`*` (extension)`

2880

*`RegionType`* `(restriction)`

`CubeRegionType`

Attributes:

`include?`

Content:

`Annotations?, KeyValue*, Component*`

2890

2891

Attribute Documentation:

2892

2893

| **Name** | **Type** | **Documentation** |

2894

| --- --| --- --| --- --|

2895

| include (default: true) | xs:boolean | The include attribute indicates that the region is to be included or excluded within the context in which it is defined. For example, if the regions is defined as part of a content constraint, the exclude flag would mean the data identified by the region is not present. |

2896

2897

Element Documentation:

2898

2899

| **Name** | **Type** | **Documentation** |

2900

| --- --| --- --| --- --|

2901

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2902

| KeyValue | CubeRegionKeyType | KeyValue contains a reference to a component which disambiguates the data (i.e. a dimension) and provides a collection of values for the component. The collection of values can be flagged as being inclusive or exclusive to the region being defined. Any key component that is not included is assumed to be wild carded, which is to say that the cube includes all possible values for the un-referenced key components. Further, this assumption applies to the values of the components as well. The values for any given component can only be sub-setted in the region by explicit inclusion or exclusion. For example, a dimension X which has the possible values of 1, 2, 3 is assumed to have all of these values if a key value is not defined. If a key value is defined with an inclusion attribute of true and the values of 1 and 2, the only the values of 1 and 2 for dimension X are included in the definition of the region. If the key value is defined with an inclusion attribute of false and the value of 1, then the values of 2 and 3 for dimension X are included in the definition of the region. Note that any given key component must only be referenced once in the region. |

2903

| Component | ComponentValueSetTyp e | Component contains a reference to a component (data attribute, metadata attribute, or measure) and provides a collection of values for the referenced component. This serves to state that for the key which defines the region, the components that are specified here have or do not have (depending on the include attribute of the value set) the values provided. It is possible to provide a component reference without specifying values, for the purpose of stating the component is absent (include = false) or present with an unbounded set of values. As opposed to key components, which are assumed to be wild carded if absent, no assumptions are made about the absence of a component. Only components which are explicitly stated to be present or absent from the region will be know. All unstated components for the set cannot be assumed to absent or present. |

2904

2905

**MetadataTargetRegionType:** MetadataTargetRegionType defines the structure of a metadata target region. A metadata target region must define the report structure and the metadata target from that structure on which the region is based. This type is based on the abstract RegionType and simply refines the key and attribute values to conform with what is applicable for target objects and metadata attributes, respectively. See the documentation of the base type for more details on how a region is defined.

Derivation:

*`AnnotableType`*` (extension)`

2910

*`RegionType`* `(restriction)`

2911

`MetadataTargetRegionType`

Attributes:

`include?, validFrom?, validTo?`

Content:

`Component*`

Attribute Documentation:

2922

2923

| **Name** | **Type** | **Documentation** |

2924

| --- --| --- --| --- --|

2925

| include (default: true) | xs:boolean | The include attribute indicates that the region is to be included or excluded within the context in which it is defined. For example, if the regions is defined as part of a content constraint, the exclude flag would mean the data identified by the region is not present. |

2926

| validFrom | StandardTimePeriodTy pe | |

2927

| validTo | StandardTimePeriodTy pe | |

2928

2929

Element Documentation:

2930

2931

| **Name** | **Type** | **Documentation** |

2932

| --- --| --- --| --- --|

2933

| Component | MetadataAttributeVal ueSetType | Component contains a reference to a component (data attribute, metadata attribute, or measure) and provides a collection of values for the referenced component. This serves to state that for the key which defines the region, the components that are specified here have or do not have (depending on the include attribute of the value set) the values provided. It is possible to provide a component reference without specifying values, for the purpose of stating the component is absent (include = false) or present with an unbounded set of values. As opposed to key components, which are assumed to be wild carded if absent, no assumptions are made about the absence of a component. Only components which are explicitly stated to be present or absent from the region will be know. All unstated components for the set cannot be assumed to absent or present. |

2934

2935

**CubeRegionKeyType:** CubeRegionKeyType is a type for providing a set of values for a dimension for the purpose of defining a data cube region. A set of distinct value can be provided, or if this dimension is represented as time, and time range can be specified.

Derivation:

*`MemberSelectionType`*` (restriction)`

`CubeRegionKeyType`

Attributes:

`id, include?, removePrefix?, validFrom?, validTo?`

Content:

`(Value+ | TimeRange)`

2949

2950

Attribute Documentation:

2951

2952

| **Name** | **Type** | **Documentation** |

2953

| --- --| --- --| --- --|

2954

| id | SingleNCNameIDType | The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate. |

2955

| include (default: true) | xs:boolean | The include attribute indicates whether the values provided for the referenced component are to be included or excluded from the region in which they are defined. |

2956

| removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |

2957

| validFrom | StandardTimePeriodTy pe | |

2958

| validTo | StandardTimePeriodTy pe | |

2959

2960

Element Documentation:

2961

2962

| **Name** | **Type** | **Documentation** |

2963

| --- --| --- --| --- --|

2964

| Value | CubeKeyValueType | Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes. |

2965

| TimeRange | TimeRangeValueType | TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive). |

2966

2967

**ComponentValueSetType:** ComponentValueSetType defines the structure for providing values for a data attributes, measures, or metadata attributes. If no values are provided, the component is implied to include/excluded from the region in which it is defined, with no regard to the value of the component. Note that for metadata attributes which occur within other metadata attributes, a nested identifier can be provided. For example, a value of CONTACT.ADDRESS.STREET refers to the metadata attribute with the identifier STREET which exists in the ADDRESS metadata attribute in the CONTACT metadata attribute, which is defined at the root of the report structure.

Derivation:

*`MemberSelectionType`*` (restriction)`

2972

`ComponentValueSetType`

Attributes:

`id, include?, removePrefix?`

Content:

`(Value+ | TimeRange)?`

2981

2982

Attribute Documentation:

2983

2984

| **Name** | **Type** | **Documentation** |

2985

| --- --| --- --| --- --|

2986

| id | NestedNCNameIDType | The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate. |

2987

| include (default: true) | xs:boolean | The include attribute indicates whether the values provided for the referenced component are to be included or excluded from the region in which they are defined. |

2988

| removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |

2989

2990

Element Documentation:

2991

2992

| **Name** | **Type** | **Documentation** |

2993

| --- --| --- --| --- --|

2994

| Value | SimpleComponentValue Type | Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes. |

2995

| TimeRange | TimeRangeValueType | TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive). |

2996

2997

**MetadataAttributeValueSetType:** MetadataAttributeValueSetType defines the structure for providing values for a metadata attribute. If no values are provided, the attribute is implied to include/excluded from the region in which it is defined, with no regard to the value of the metadata attribute.

Derivation:

*`MemberSelectionType`*` (restriction)`

3002

`MetadataAttributeValueSetType`

Attributes:

`id, include?, removePrefix?`

Content:

`(Value+ | TimeRange)?`

3011

3012

Attribute Documentation:

3013

3014

| **Name** | **Type** | **Documentation** |

3015

| --- --| --- --| --- --|

3016

| id | NestedNCNameIDType | The id attribute provides the identifier for the component for which values are being provided. This base type allows for a nested identifier to be provided, for the purpose of referencing a nested component (i.e. a metadata attribute). However, specific implementations will restrict this representation to only allow single level identifiers where appropriate. |

3017

| include (default: true) | xs:boolean | The include attribute indicates whether the values provided for the referenced component are to be included or excluded from the region in which they are defined. |

3018

| removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |

3019

3020

Element Documentation:

3021

3022

| **Name** | **Type** | **Documentation** |

3023

| --- --| --- --| --- --|

3024

| Value | SimpleComponentValue Type | Value provides a simple value for the component, such as a coded, numeric, or simple text value. This type of component value is applicable for dimensions and attributes. |

3025

| TimeRange | TimeRangeValueType | TimeValue provides a value for a component which has a time representation. This is repeatable to allow for a range to be specified, although a single value can also be provided. An operator is available on this to indicate whether the specified value indicates an exact value or the beginning/end of a range (inclusive or exclusive). |

3026

3027

**SimpleComponentValueType:** SimpleValueType contains a simple value for a component, and if that value is from a code list, the ability to indicate that child codes in a simple hierarchy are part of the value set of the component for the region.

Derivation:

``xs:anySimpleType (restriction)` `

3032

`xs:string (extension)`

3033

`SimpleComponentValueType`

Attributes:

`cascadeValues?, xml:lang?, validFrom?, validTo?`

Content:

Attribute Documentation:

3042

3043

| **Name** | **Type** | **Documentation** |

3044

| --- --| --- --| --- --|

3045

| cascadeValues (default: false) | CascadeSelectionType | The cascadeValues attribute, if true, indicates that if the value is taken from a code all child codes in a simple hierarchy are understood be included in the region. |

3046

| xml:lang | xs:language | The xml:lang attribute specifies a language code for the value. This is used when the component value support multi-lingual values. |

3047

| validFrom | StandardTimePeriodTy pe | |

3048

| validTo | StandardTimePeriodTy pe | |

3049

3050

**CubeKeyValueType:** CubeKeyValueType derives from the SimpleValueType, but does not allow for a locale (xml:lang).

Derivation:

``xs:anySimpleType (restriction)` `

3055

`xs:string (extension)`

3056

`SimpleComponentValueType (restriction)`

`CubeKeyValueType`

Attributes:

`cascadeValues?, validFrom?, validTo?`

Content:

Attribute Documentation:

3066

3067

| **Name** | **Type** | **Documentation** |

3068

| --- --| --- --| --- --|

3069

| cascadeValues (default: false) | CascadeSelectionType | The cascadeValues attribute, if true, indicates that if the value is taken from a code all child codes in a simple hierarchy are understood be included in the region. |

3070

| validFrom | StandardTimePeriodTy pe | |

3071

| validTo | StandardTimePeriodTy pe | |

3072

3073

**DataComponentValueType:** DataComponentValueType derives from the SimpleValueType, but does not allow for validity dates.

Derivation:

``xs:anySimpleType (restriction)` `

3078

`xs:string (extension)`

3079

`SimpleComponentValueType (restriction)`

3080

`DataComponentValueType`

Attributes:

`cascadeValues?, xml:lang?`

Content:

Attribute Documentation:

3089

3090

| **Name** | **Type** | **Documentation** |

3091

| --- --| --- --| --- --|

3092

| cascadeValues (default: false) | CascadeSelectionType | The cascadeValues attribute, if true, indicates that if the value is taken from a code all child codes in a simple hierarchy are understood be included in the region. |

3093

| xml:lang | xs:language | The xml:lang attribute specifies a language code for the value. This is used when the component value support multi-lingual values. |

3094

3095

**SimpleKeyValueType:** SimpleKeyValueType derives from the SimpleValueType, but does not allow for the cascading of value in the hierarchy, as keys are meant to describe a distinct full or partial key.

Derivation:

``xs:anySimpleType (restriction)` `

3100

`xs:string (extension)`

3101

`SimpleComponentValueType (restriction)`

`SimpleKeyValueType`

Content:

**TimeRangeValueType:** TimeRangeValueType allows a time period value to be expressed as a range. It can be expressed as the period before a period, after a period, or between two periods. Each of these properties can specify their inclusion in regards to the range.

Attributes:

`validFrom?, validTo?`

Content:

`(BeforePeriod | AfterPeriod | (StartPeriod, EndPeriod))`

3115

3116

Attribute Documentation:

3117

3118

| **Name** | **Type** | **Documentation** |

3119

| --- --| --- --| --- --|

3120

| validFrom | StandardTimePeriodTy pe | |

3121

| validTo | StandardTimePeriodTy pe | |

3122

3123

Element Documentation:

3124

3125

| **Name** | **Type** | **Documentation** |

3126

| --- --| --- --| --- --|

3127

| BeforePeriod | TimePeriodRangeType | BeforePeriod is the period before which the period is meant to cover. This date may be inclusive or exclusive in the range. |

3128

| AfterPeriod | TimePeriodRangeType | AfterPeriod is the period after which the period is meant to cover. This date may be inclusive or exclusive in the range. |

3129

| StartPeriod | TimePeriodRangeType | StartPeriod is the start date or the range that the queried date must occur within. This date may be inclusive or exclusive in the range. |

3130

| EndPeriod | TimePeriodRangeType | EndPeriod is the end period of the range. This date may be inclusive or exclusive in the range. |

3131

3132

**TimePeriodRangeType:** TimePeriodRangeType defines a time period, and indicates whether it is inclusive in a range.

Derivation:

`xs:anySimpleType (restriction)`

3137

`ObservationalTimePeriodType (extension)`

3138

`TimePeriodRangeType`

Attributes:

`isInclusive?`

Content:

Attribute Documentation:

3147

3148

| **Name** | **Type** | **Documentation** |

3149

| --- --| --- --| --- --|

3150

| isInclusive (default: true) | xs:boolean | The isInclusive attribute, when true, indicates that the time period specified is included in the range. |

3151

3152

***DataStructureBaseType*:** DataStructureBaseType describes base refinement of the StructureType for a data structure definition. A data structure definition is defined as a collection of metadata concepts, their structure and usage when used to collect or disseminate data.

Derivation:

*`AnnotableType`*` (extension)`

3157

*`IdentifiableType`*` (extension)`

3158

*`NameableType`*` (extension)`

3159

*`VersionableType`*` (restriction)`

3160

*`MaintainableBaseType`*` (extension)`

3161

*`MaintainableType`*` (restriction)`

3162

*`StructureType`*` (restriction)`

3163

*`DataStructureBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, DataStructureComponents?`

3172

3173

Attribute Documentation:

3174

3175

| **Name** | **Type** | **Documentation** |

3176

| --- --| --- --| --- --|

3177

| id | IDType | The id is the identifier for the object. |

3178

| urn | DataStructureUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3179

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3180

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

3181

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

3182

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

3183

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

3184

| 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. |

3185

| 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. |

3186

| 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. |

3187

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

3188

3189

Element Documentation:

3190

3191

| **Name** | **Type** | **Documentation** |

3192

| --- --| --- --| --- --|

3193

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3194

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3195

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

3196

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

3197

| DataStructureCompone nts | DataStructureCompone ntsType | DataStructureComponents defines the grouping of the sets of metadata concepts that have a defined structural role in the data structure definition. Note that for any component or group defined in a data structure definition, its id must be unique. This applies to the identifiers explicitly defined by the components as well as those inherited from the concept identity of a component. For example, if two dimensions take their identity from concepts with same identity (regardless of whether the concepts exist in different schemes) one of the dimensions must be provided a different explicit identifier. Although there are XML schema constraints to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a concept from which a component takes its identity cannot be validated against this constraint. Therefore, systems processing data structure definitions will have to perform this check outside of the XML validation. There are also two reserved identifiers in a data structure definition; TIME\_PERIOD, and REPORTING\_YEAR\_START\_DAY. These identifiers may not be used outside of their respective defintions (TimeDimension and ReportingYearStartDay). This applies to both the explicit identifiers that can be assigned to the components or groups as well as an identifier inherited by a component from its concept identity. For example, if an ordinary dimension (i.e. not the time dimension) takes its concept identity from a concept with the identifier TIME\_PERIOD, that dimension must provide a different explicit identifier. |

3198

3199

**DataStructureType:** DataStructureType defines the structure for a data structure definition. A data structure definition is defined as a collection of metadata concepts, their structure and usage when used to collect or disseminate data.

Derivation:

*`AnnotableType`*` (extension)`

3204

*`IdentifiableType`*` (extension)`

3205

*`NameableType`*` (extension)`

3206

*`VersionableType`*` (restriction)`

3207

*`MaintainableBaseType`*` (extension)`

3208

*`MaintainableType`*` (restriction)`

3209

*`StructureType`*` (restriction)`

3210

*`DataStructureBaseType`*` (extension)`

`DataStructureType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, DataStructureComponents?, Metadata?`

3220

3221

Attribute Documentation:

3222

3223

| **Name** | **Type** | **Documentation** |

3224

| --- --| --- --| --- --|

3225

| id | IDType | The id is the identifier for the object. |

3226

| urn | DataStructureUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3227

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3228

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

3229

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

3230

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

3231

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

3232

| 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. |

3233

| 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. |

3234

| 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. |

3235

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

3236

3237

Element Documentation:

3238

3239

| **Name** | **Type** | **Documentation** |

3240

| --- --| --- --| --- --|

3241

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3242

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3243

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

3244

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

3245

| DataStructureCompone nts | DataStructureCompone ntsType | DataStructureComponents defines the grouping of the sets of metadata concepts that have a defined structural role in the data structure definition. Note that for any component or group defined in a data structure definition, its id must be unique. This applies to the identifiers explicitly defined by the components as well as those inherited from the concept identity of a component. For example, if two dimensions take their identity from concepts with same identity (regardless of whether the concepts exist in different schemes) one of the dimensions must be provided a different explicit identifier. Although there are XML schema constraints to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a concept from which a component takes its identity cannot be validated against this constraint. Therefore, systems processing data structure definitions will have to perform this check outside of the XML validation. There are also two reserved identifiers in a data structure definition; TIME\_PERIOD, and REPORTING\_YEAR\_START\_DAY. These identifiers may not be used outside of their respective defintions (TimeDimension and ReportingYearStartDay). This applies to both the explicit identifiers that can be assigned to the components or groups as well as an identifier inherited by a component from its concept identity. For example, if an ordinary dimension (i.e. not the time dimension) takes its concept identity from a concept with the identifier TIME\_PERIOD, that dimension must provide a different explicit identifier. |

3246

| Metadata | MetadataStructureRef erenceType | A data structure definition may be related to a metadata structure definition in order to use its metadata attributes as part of the data. Note that the referenced metadata set cannot contain nested metadata attributes, as these are not supported in the data. By default all metadata attributes can be associated at any level of the data. However, a metadata attribute usage can be used to provide a specific attribute relationshp for a given metadata attribute. |

3247

3248

***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.

Derivation:

*`GroupingType`*` (restriction)`

3253

*`DataStructureComponentsBaseType`*

Content:

`{Empty}`

**DataStructureComponentsType:** DataStructureComponentsType describes the structure of the grouping to the sets of metadata concepts that have a defined structural role in the data structure definition. At a minimum at least one dimension must be defined.

Derivation:

*`GroupingType`*` (restriction)`

3264

*`DataStructureComponentsBaseType`*` (extension)`

3265

`DataStructureComponentsType`

Content:

`DimensionList, Group*, AttributeList?, MeasureList?`

3270

3271

Element Documentation:

3272

3273

| **Name** | **Type** | **Documentation** |

3274

| --- --| --- --| --- --|

3275

| 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. |

3276

| 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. |

3277

| 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. |

3278

| MeasureList | MeasureListType | MeasureList describes the measure descriptor for a data structure. |

3279

3280

***AttributeListBaseType*:** AttributeListBaseType is an abstract base type used as the basis for the AttributeListType.

Derivation:

*`AnnotableType`*` (extension)`

3285

*`IdentifiableType`*` (extension)`

3286

*`ComponentListType`*` (restriction)`

3287

*`AttributeListBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*`

3296

3297

Attribute Documentation:

3298

3299

| **Name** | **Type** | **Documentation** |

3300

| --- --| --- --| --- --|

3301

| id (fixed: AttributeDescriptor) | IDType | The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor. |

3302

| urn | AttributeDescriptorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3303

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3304

3305

Element Documentation:

3306

3307

| **Name** | **Type** | **Documentation** |

3308

| --- --| --- --| --- --|

3309

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3310

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3311

3312

**AttributeListType:** AttributeListType describes the attribute descriptor for the data structure definition.

Derivation:

*`AnnotableType`*` (extension)`

3317

*`IdentifiableType`*` (extension)`

3318

*`ComponentListType`*` (restriction)`

3319

*`AttributeListBaseType`*` (extension)`

`AttributeListType`

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, (Attribute | MetadataAttributeUsage)+`

3329

3330

Attribute Documentation:

3331

3332

| **Name** | **Type** | **Documentation** |

3333

| --- --| --- --| --- --|

3334

| id (fixed: AttributeDescriptor) | IDType | The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor. |

3335

| urn | AttributeDescriptorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3336

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3337

3338

Element Documentation:

3339

3340

| **Name** | **Type** | **Documentation** |

3341

| --- --| --- --| --- --|

3342

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3343

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3344

| Attribute | AttributeType | Attribute describes the definition of a data attribute, which is defined as a characteristic of an object or entity. |

3345

| MetadataAttributeUsa ge | MetadataAttributeUsa geType | MetadataAttributeUsage refines the details of how a metadata attribute from the metadata structure referenced from the data structure is used. By default, metadata attributes can be expressed at any level of the data. This allows an attribute relationship to be defined in order restrict the reporing of a metadata attribute to a specific part of the data. |

3346

3347

***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.

Derivation:

*`AnnotableType`*` (extension)`

3352

*`IdentifiableType`*` (extension)`

3353

*`ComponentBaseType`*` (extension)`

3354

*`ComponentType`*` (restriction)`

3355

*`AttributeBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?`

3364

3365

Attribute Documentation:

3366

3367

| **Name** | **Type** | **Documentation** |

3368

| --- --| --- --| --- --|

3369

| id | NCNameIDType | The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

3370

| urn | DataAttributeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3371

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3372

3373

Element Documentation:

3374

3375

| **Name** | **Type** | **Documentation** |

3376

| --- --| --- --| --- --|

3377

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3378

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3379

| ConceptIdentity | ConceptReferenceType | ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. |

3380

| LocalRepresentation | AttributeRepresentat ionType | LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. |

3381

3382

**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.

Derivation:

*`AnnotableType`*` (extension)`

3387

*`IdentifiableType`*` (extension)`

3388

*`ComponentBaseType`*` (extension)`

3389

*`ComponentType`*` (restriction)`

3390

*`AttributeBaseType`*` (extension)`

`AttributeType`

Attributes:

`id?, urn?, uri?, usage?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole*, AttributeRelationship, MeasureRelationship?`

3400

3401

Attribute Documentation:

3402

3403

| **Name** | **Type** | **Documentation** |

3404

| --- --| --- --| --- --|

3405

| id | NCNameIDType | The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

3406

| urn | DataAttributeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3407

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3408

| usage (default: optional) | UsageType | The usage attribute indicates whether an attribute value must be available for any corresponding existing observation. |

3409

3410

Element Documentation:

3411

3412

| **Name** | **Type** | **Documentation** |

3413

| --- --| --- --| --- --|

3414

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3415

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3416

| ConceptIdentity | ConceptReferenceType | ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. |

3417

| LocalRepresentation | AttributeRepresentat ionType | LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. |

3418

| ConceptRole | ConceptReferenceType | ConceptRole references concepts which define roles which this attribute serves. |

3419

| 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. |

3420

| MeasureRelationship | MeasureRelationshipT ype | MeasureRelationship identifies the measures that the attribute applies to. If this is not used, the attribute is assumed to apply to all measures. |

3421

3422

**AttributeRelationshipType:** AttributeRelationshipType defines the structure for stating the relationship between an attribute and other data structure definition components.

Content:

`(Dataflow | Dimension+ | Group | Observation)`

3427

3428

Element Documentation:

3429

3430

| **Name** | **Type** | **Documentation** |

3431

| --- --| --- --| --- --|

3432

| Dataflow | EmptyType | This means that the value of the attribute varies per dataflow. It is the data modeller's responsibility to design or use non-overlapping dataflows that do not have observations in common, otherwise the integrity of dataflow-specific attribute values is not assured by the model, e.g. when querying those data through its DSD. |

3433

| Dimension | OptionalLocalDimensi onReferenceType | This is used to reference dimensions in the data structure definition on which the value of this attribute depends. An attribute using this relationship can be either a group, series (or section), or observation level attribute. The attachment level of the attribute will be determined by the data format and which dimensions are referenced. |

3434

| Group | IDType | This is used as a convenience to referencing all of the dimension defined by the referenced group. The attribute will also be attached to this group. |

3435

| Observation | EmptyType | This is used to specify that the value of the attribute is dependent upon the observed value. An attribute with this relationship will always be treated as an observation level attribute. |

3436

3437

**OptionalLocalDimensionReferenceType:**

Derivation:

`xs:anySimpleType (restriction)`

3442

`xs:string (restriction)`

3443

`NestedIDType (restriction)`

3444

`IDType (restriction)`

3445

`NCNameIDType (extension)`

3446

`OptionalLocalDimensionReferenceType`

Attributes:

`optional?`

Content:

Attribute Documentation:

3455

3456

| **Name** | **Type** | **Documentation** |

3457

| --- --| --- --| --- --|

3458

| optional (default: false) | xs:boolean | |

3459

3460

**MeasureRelationshipType:** MeasureRelationshipType allows for the description of an attributes relationship to one or more measures

Content:

`Measure+`

Element Documentation:

3467

3468

| **Name** | **Type** | **Documentation** |

3469

| --- --| --- --| --- --|

3470

| Measure | NCNameIDType | This is a reference to a measure defined in this data structure definition. |

3471

3472

***MetadataAttributeUsageBaseType*:** MetadataAttributeUsageBaseType is the abstract base refinement of a metadata attribute usage. Since this is a usage of metadata attribute already defined in metadata structure, the typical id, concept identity, and representation are excluded in place of a local refernce to the metadata attribute being used.

Derivation:

*`AnnotableType`*` (extension)`

3477

*`IdentifiableType`*` (extension)`

3478

*`ComponentBaseType`*` (extension)`

3479

*`ComponentType`*` (restriction)`

3480

*`MetadataAttributeUsageBaseType`*

Attributes:

`urn?, uri?`

Content:

`Annotations?, Link?`

3489

3490

Attribute Documentation:

3491

3492

| **Name** | **Type** | **Documentation** |

3493

| --- --| --- --| --- --|

3494

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3495

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3496

3497

Element Documentation:

3498

3499

| **Name** | **Type** | **Documentation** |

3500

| --- --| --- --| --- --|

3501

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3502

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3503

3504

**MetadataAttributeUsageType:** MetadataAttributeUsageType defines the structure of how a metadata attribute is used in a data structure. This is a local reference to a metadata attribute from the metadata structure referenced by the data structure. An attribute relationship can be defined in order to describe the relationship of the metadata attribute to the data structure components.

Derivation:

*`AnnotableType`*` (extension)`

3509

*`IdentifiableType`*` (extension)`

3510

*`ComponentBaseType`*` (extension)`

3511

*`ComponentType`*` (restriction)`

3512

*`MetadataAttributeUsageBaseType`*` (extension)`

3513

`MetadataAttributeUsageType`

Attributes:

`urn?, uri?`

Content:

`Annotations?, Link?, MetadataAttributeReference, AttributeRelationship`

3522

3523

Attribute Documentation:

3524

3525

| **Name** | **Type** | **Documentation** |

3526

| --- --| --- --| --- --|

3527

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3528

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3529

3530

Element Documentation:

3531

3532

| **Name** | **Type** | **Documentation** |

3533

| --- --| --- --| --- --|

3534

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3535

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3536

| MetadataAttributeRef erence | NCNameIDType | MetadataAttributeReference is a local reference to a metadata attribute defined in the metadata structure referenced by this data structure. |

3537

| AttributeRelationshi p | AttributeRelationshi pType | AttributeRelationship defines the relationship between the referenced metadata attribute and the components of the data structure. |

3538

3539

***DimensionListBaseType*:** DimensionListBaseType is an abstract base type used as the basis for the DimensionListType.

Derivation:

*`AnnotableType`*` (extension)`

3544

*`IdentifiableType`*` (extension)`

3545

*`ComponentListType`*` (restriction)`

3546

*`DimensionListBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*`

3555

3556

Attribute Documentation:

3557

3558

| **Name** | **Type** | **Documentation** |

3559

| --- --| --- --| --- --|

3560

| id (fixed: DimensionDescriptor) | IDType | The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor. |

3561

| urn | DimensionDescriptorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3562

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3563

3564

Element Documentation:

3565

3566

| **Name** | **Type** | **Documentation** |

3567

| --- --| --- --| --- --|

3568

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3569

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3570

3571

**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.

Derivation:

*`AnnotableType`*` (extension)`

3576

*`IdentifiableType`*` (extension)`

3577

*`ComponentListType`*` (restriction)`

3578

*`DimensionListBaseType`*` (extension)`

`DimensionListType`

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, Dimension+, TimeDimension?`

3588

3589

Attribute Documentation:

3590

3591

| **Name** | **Type** | **Documentation** |

3592

| --- --| --- --| --- --|

3593

| id (fixed: DimensionDescriptor) | IDType | The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor. |

3594

| urn | DimensionDescriptorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3595

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3596

3597

Element Documentation:

3598

3599

| **Name** | **Type** | **Documentation** |

3600

| --- --| --- --| --- --|

3601

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3602

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3603

| 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. |

3604

| TimeDimension | TimeDimensionType | TimeDimension is a special dimension which designates the period in time in which the data identified by the full series key applies. |

3605

3606

***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).

Derivation:

*`AnnotableType`*` (extension)`

3611

*`IdentifiableType`*` (extension)`

3612

*`ComponentBaseType`*` (extension)`

3613

*`ComponentType`*` (restriction)`

3614

*`BaseDimensionBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?`

3623

3624

Attribute Documentation:

3625

3626

| **Name** | **Type** | **Documentation** |

3627

| --- --| --- --| --- --|

3628

| id | NCNameIDType | The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

3629

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3630

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3631

3632

Element Documentation:

3633

3634

| **Name** | **Type** | **Documentation** |

3635

| --- --| --- --| --- --|

3636

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3637

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3638

| ConceptIdentity | ConceptReferenceType | ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. |

3639

| 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. |

3640

3641

***BaseDimensionType*:** BaseDimensionType is an abstract base type which defines the basic structure of all dimensions.

Derivation:

*`AnnotableType`*` (extension)`

3646

*`IdentifiableType`*` (extension)`

3647

*`ComponentBaseType`*` (extension)`

3648

*`ComponentType`*` (restriction)`

3649

*`BaseDimensionBaseType`*` (extension)`

3650

*`BaseDimensionType`*

Attributes:

`id?, urn?, uri?, position?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole*`

3659

3660

Attribute Documentation:

3661

3662

| **Name** | **Type** | **Documentation** |

3663

| --- --| --- --| --- --|

3664

| id | NCNameIDType | The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

3665

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3666

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3667

| position | xs:int | The order of the dimensions in the key descriptor (DimensionList element) defines the order of the dimensions in the data structure. This position attribute explicitly specifies the position of the dimension in the data structure. It is optional and if specified must be consistent with the position of the dimension in the key descriptor. |

3668

3669

Element Documentation:

3670

3671

| **Name** | **Type** | **Documentation** |

3672

| --- --| --- --| --- --|

3673

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3674

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3675

| ConceptIdentity | ConceptReferenceType | ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. |

3676

| 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. |

3677

| ConceptRole | ConceptReferenceType | ConceptRole references concepts which define roles which this dimension serves. |

3678

3679

**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.

Derivation:

*`AnnotableType`*` (extension)`

3684

*`IdentifiableType`*` (extension)`

3685

*`ComponentBaseType`*` (extension)`

3686

*`ComponentType`*` (restriction)`

3687

*`BaseDimensionBaseType`*` (extension)`

3688

*`BaseDimensionType`*` (restriction)`

`DimensionType`

Attributes:

`id?, urn?, uri?, position?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole*`

3698

3699

Attribute Documentation:

3700

3701

| **Name** | **Type** | **Documentation** |

3702

| --- --| --- --| --- --|

3703

| id | NCNameIDType | The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

3704

| urn | DimensionUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3705

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3706

| position | xs:int | The order of the dimensions in the key descriptor (DimensionList element) defines the order of the dimensions in the data structure. This position attribute explicitly specifies the position of the dimension in the data structure. It is optional and if specified must be consistent with the position of the dimension in the key descriptor. |

3707

3708

Element Documentation:

3709

3710

| **Name** | **Type** | **Documentation** |

3711

| --- --| --- --| --- --|

3712

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3713

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3714

| ConceptIdentity | ConceptReferenceType | ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. |

3715

| 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. |

3716

| ConceptRole | ConceptReferenceType | ConceptRole references concepts which define roles which this dimension serves. |

3717

3718

**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.

Derivation:

*`AnnotableType`*` (extension)`

3723

*`IdentifiableType`*` (extension)`

3724

*`ComponentBaseType`*` (extension)`

3725

*`ComponentType`*` (restriction)`

3726

*`BaseDimensionBaseType`*` (extension)`

3727

*`BaseDimensionType`*` (restriction)`

`TimeDimensionType`

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation`

3737

3738

Attribute Documentation:

3739

3740

| **Name** | **Type** | **Documentation** |

3741

| --- --| --- --| --- --|

3742

| id (fixed: TIME\_PERIOD) | NCNameIDType | The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

3743

| urn | TimeDimensionUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3744

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3745

3746

Element Documentation:

3747

3748

| **Name** | **Type** | **Documentation** |

3749

| --- --| --- --| --- --|

3750

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3751

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3752

| ConceptIdentity | ConceptReferenceType | ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. |

3753

| 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. |

3754

3755

***GroupBaseType*:** GroupBaseType is an abstract base type that forms the basis for the GroupType.

Derivation:

*`AnnotableType`*` (extension)`

3760

*`IdentifiableType`*` (extension)`

3761

*`ComponentListType`*` (restriction)`

*`GroupBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?`

Attribute Documentation:

3773

3774

| **Name** | **Type** | **Documentation** |

3775

| --- --| --- --| --- --|

3776

| id | IDType | The id is the identifier for the object. |

3777

| urn | GroupDimensionDescri ptorUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3778

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3779

3780

Element Documentation:

3781

3782

| **Name** | **Type** | **Documentation** |

3783

| --- --| --- --| --- --|

3784

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3785

3786

**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.

Derivation:

*`AnnotableType`*` (extension)`

3791

*`IdentifiableType`*` (extension)`

3792

*`ComponentListType`*` (restriction)`

3793

*`GroupBaseType`*` (extension)`

`GroupType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, GroupDimension+`

3803

3804

Attribute Documentation:

3805

3806

| **Name** | **Type** | **Documentation** |

3807

| --- --| --- --| --- --|

3808

| id | IDType | The id is the identifier for the object. |

3809

| urn | GroupDimensionDescri ptorUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3810

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3811

3812

Element Documentation:

3813

3814

| **Name** | **Type** | **Documentation** |

3815

| --- --| --- --| --- --|

3816

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3817

| 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. |

3818

3819

***GroupDimensionBaseType*:** GroupDimensionBaseType is an abstract base type which refines the base ComponentType in order to form the basis for the GroupDimensionType.

Derivation:

*`AnnotableType`*` (extension)`

3824

*`IdentifiableType`*` (extension)`

3825

*`ComponentBaseType`*` (extension)`

3826

*`ComponentType`*` (restriction)`

3827

*`GroupDimensionBaseType`*

Content:

`{Empty}`

**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.

Derivation:

*`AnnotableType`*` (extension)`

3838

*`IdentifiableType`*` (extension)`

3839

*`ComponentBaseType`*` (extension)`

3840

*`ComponentType`*` (restriction)`

3841

*`GroupDimensionBaseType`*` (extension)`

`GroupDimensionType`

Content:

`DimensionReference`

Element Documentation:

3849

3850

| **Name** | **Type** | **Documentation** |

3851

| --- --| --- --| --- --|

3852

| DimensionReference | NCNameIDType | DimensionReference provides a reference to a dimension defined in the key descriptor of the data structure definition in which this group key descriptor is defined. |

3853

3854

**MeasureListType:** MeasureListType describes the structure of the measure descriptor for a data structure definition.

Derivation:

*`AnnotableType`*` (extension)`

3859

*`IdentifiableType`*` (extension)`

3860

*`ComponentListType`*` (restriction)`

`MeasureListType`

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, Measure+`

3870

3871

Attribute Documentation:

3872

3873

| **Name** | **Type** | **Documentation** |

3874

| --- --| --- --| --- --|

3875

| id (fixed: MeasureDescriptor) | IDType | The id is the identifier for the object. |

3876

| urn | MeasureDescriptorUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3877

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3878

3879

Element Documentation:

3880

3881

| **Name** | **Type** | **Documentation** |

3882

| --- --| --- --| --- --|

3883

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3884

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3885

| Measure | MeasureType | Measure defines the structure of a measure, which is the concept that is the value of the phenomenon to be measured in a data set. |

3886

3887

***MeasureBaseType*:** MeasureBaseType is an abstract base type that refines ComponentType to rerstrict the represenations to those which are applicable for a measure.

Derivation:

*`AnnotableType`*` (extension)`

3892

*`IdentifiableType`*` (extension)`

3893

*`ComponentBaseType`*` (extension)`

3894

*`ComponentType`*` (restriction)`

*`MeasureBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?`

3904

3905

Attribute Documentation:

3906

3907

| **Name** | **Type** | **Documentation** |

3908

| --- --| --- --| --- --|

3909

| id | NCNameIDType | The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

3910

| urn | MeasureUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3911

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3912

3913

Element Documentation:

3914

3915

| **Name** | **Type** | **Documentation** |

3916

| --- --| --- --| --- --|

3917

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3918

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3919

| ConceptIdentity | ConceptReferenceType | ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. |

3920

| LocalRepresentation | MeasureRepresentatio nType | LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. |

3921

3922

**MeasureType:** MeasureType defines the structure of a measure descriptor. In addition to the identifying concept and representation, a usage status and max occurs can be defined.

Derivation:

*`AnnotableType`*` (extension)`

3927

*`IdentifiableType`*` (extension)`

3928

*`ComponentBaseType`*` (extension)`

3929

*`ComponentType`*` (restriction)`

3930

*`MeasureBaseType`*` (extension)`

`MeasureType`

Attributes:

`id?, urn?, uri?, usage?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole*`

3940

3941

Attribute Documentation:

3942

3943

| **Name** | **Type** | **Documentation** |

3944

| --- --| --- --| --- --|

3945

| id | NCNameIDType | The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

3946

| urn | MeasureUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3947

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3948

| usage (default: optional) | UsageType | The usage attribute indicates whether a measure value must be available for any corresponding existing observation. |

3949

3950

Element Documentation:

3951

3952

| **Name** | **Type** | **Documentation** |

3953

| --- --| --- --| --- --|

3954

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3955

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3956

| ConceptIdentity | ConceptReferenceType | ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. |

3957

| LocalRepresentation | MeasureRepresentatio nType | LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used. |

3958

| ConceptRole | ConceptReferenceType | ConceptRole references concepts which define roles which this measure serves. |

3959

3960

***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.

Derivation:

*`RepresentationType`*` (restriction)`

3965

*`DataStructureRepresentationType`*

Attributes:

`maxOccurs?`

Content:

`(TextFormat | (Enumeration, EnumerationFormat?))`

3974

3975

Attribute Documentation:

3976

3977

| **Name** | **Type** | **Documentation** |

3978

| --- --| --- --| --- --|

3979

| maxOccurs | OccurenceType | The maxOccurs attribute indicates the maximum number of values that can be reported for the component. |

3980

3981

Element Documentation:

3982

3983

| **Name** | **Type** | **Documentation** |

3984

| --- --| --- --| --- --|

3985

| TextFormat | SimpleComponentTextF ormatType | TextFormat describes an uncoded textual format. |

3986

| Enumeration | AnyCodelistReference Type | Enumeration references an item scheme that enumerates the allowable values for this representation. |

3987

| EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |

3988

3989

**AttributeRepresentationType:** AttributeRepresentationType defines the representation for a data attribute. A data attribute can be text (including XHTML and multi-lingual values), a simple value, or an enumerated value.

Derivation:

*`RepresentationType`*` (restriction)`

3994

`AttributeRepresentationType`

Attributes:

`minOccurs?, maxOccurs?`

Content:

`(TextFormat | (Enumeration, EnumerationFormat?))`

4003

4004

Attribute Documentation:

4005

4006

| **Name** | **Type** | **Documentation** |

4007

| --- --| --- --| --- --|

4008

| minOccurs (default: 1) | xs: nonNegativeInteger | The minOccurs attribute indicates the minimum number of value that must be reported for the component. |

4009

| maxOccurs (default: 1) | OccurenceType | The maxOccurs attribute indicates the maximum number of values that can be reported for the component. |

4010

4011

Element Documentation:

4012

4013

| **Name** | **Type** | **Documentation** |

4014

| --- --| --- --| --- --|

4015

| TextFormat | BasicComponentTextFo rmatType | TextFormat describes an uncoded textual format. |

4016

| Enumeration | AnyCodelistReference Type | Enumeration references an item scheme that enumerates the allowable values for this representation. |

4017

| EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |

4018

4019

**MeasureRepresentationType:** MeasureRepresentationType defines the representation for a measure. A measure can be text (including XHTML and multi-lingual values), a simple value, or an enumerated value.

Derivation:

*`RepresentationType`*` (restriction)`

4024

`MeasureRepresentationType`

Attributes:

`minOccurs?, maxOccurs?`

Content:

`(TextFormat | (Enumeration, EnumerationFormat?))`

4033

4034

Attribute Documentation:

4035

4036

| **Name** | **Type** | **Documentation** |

4037

| --- --| --- --| --- --|

4038

| minOccurs (default: 1) | xs: nonNegativeInteger | The minOccurs attribute indicates the minimum number of value that must be reported for the component. |

4039

| maxOccurs (default: 1) | OccurenceType | The maxOccurs attribute indicates the maximum number of values that can be reported for the component. |

4040

4041

Element Documentation:

4042

4043

| **Name** | **Type** | **Documentation** |

4044

| --- --| --- --| --- --|

4045

| TextFormat | BasicComponentTextFo rmatType | TextFormat describes an uncoded textual format. |

4046

| Enumeration | AnyCodelistReference Type | Enumeration references an item scheme that enumerates the allowable values for this representation. |

4047

| EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |

4048

4049

**SimpleDataStructureRepresentationType:** SimpleDataStructureRepresentationType defines the representation for any non-time dimension data structure definition component.

Derivation:

*`RepresentationType`*` (restriction)`

4054

*`DataStructureRepresentationType`*` (restriction)`

4055

`SimpleDataStructureRepresentationType`

Content:

`(TextFormat | (Enumeration, EnumerationFormat?))`

4060

4061

Element Documentation:

4062

4063

| **Name** | **Type** | **Documentation** |

4064

| --- --| --- --| --- --|

4065

| TextFormat | SimpleComponentTextF ormatType | TextFormat describes an uncoded textual format. |

4066

| Enumeration | CodelistReferenceTyp e | Enumeration references an item scheme that enumerates the allowable values for this representation. |

4067

| EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |

4068

4069

**TimeDimensionRepresentationType:** TimeDimensionRepresentationType defines the representation for the time dimension. Enumerated values are not allowed.

Derivation:

*`RepresentationType`*` (restriction)`

4074

*`DataStructureRepresentationType`*` (restriction)`

4075

`SimpleDataStructureRepresentationType (restriction)`

4076

`TimeDimensionRepresentationType`

Content:

`TextFormat`

Element Documentation:

4083

4084

| **Name** | **Type** | **Documentation** |

4085

| --- --| --- --| --- --|

4086

| TextFormat | TimeTextFormatType | TextFormat describes an uncoded textual format. |

4087

4088

**DataflowType:** DataflowType describes the structure of a data flow. A data flow is defined as the structure of data that will provided for different reference periods. If this type is not referenced externally, then a reference to a data structure must be provided.

Derivation:

*`AnnotableType`*` (extension)`

4093

*`IdentifiableType`*` (extension)`

4094

*`NameableType`*` (extension)`

4095

*`VersionableType`*` (restriction)`

4096

*`MaintainableBaseType`*` (extension)`

4097

*`MaintainableType`*` (restriction)`

4098

*`StructureUsageType`*` (restriction)`

`DataflowType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Structure?`

4108

4109

Attribute Documentation:

4110

4111

| **Name** | **Type** | **Documentation** |

4112

| --- --| --- --| --- --|

4113

| id | IDType | The id is the identifier for the object. |

4114

| urn | DataflowUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4115

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4116

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

4117

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4118

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4119

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4120

| 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. |

4121

| 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. |

4122

| 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. |

4123

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

4124

4125

Element Documentation:

4126

4127

| **Name** | **Type** | **Documentation** |

4128

| --- --| --- --| --- --|

4129

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4130

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4131

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4132

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4133

| Structure | DataStructureReferen ceType | Structure provides a reference to the data structure definition which defines the structure of all data for this flow. |

4134

4135

***HierarchyBaseType*:** HierarchyBaseType is an abstract base class that is the basis for the HierarchyType. It requires that a name be supplied.

Derivation:

*`AnnotableType`*` (extension)`

4140

*`IdentifiableType`*` (extension)`

4141

*`NameableType`*` (extension)`

4142

*`VersionableType`*` (restriction)`

4143

*`MaintainableBaseType`*` (extension)`

4144

*`MaintainableType`*` (restriction)`

4145

*`HierarchyBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

4154

4155

Attribute Documentation:

4156

4157

| **Name** | **Type** | **Documentation** |

4158

| --- --| --- --| --- --|

4159

| id | IDType | The id is the identifier for the object. |

4160

| urn | HierarchyUrnType | 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 | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

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 | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4166

| 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. |

4167

| 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. |

4168

| 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. |

4169

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

4170

4171

Element Documentation:

4172

4173

| **Name** | **Type** | **Documentation** |

4174

| --- --| --- --| --- --|

4175

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4176

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4177

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4178

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4179

4180

**HierarchyType:** HierarchyType describes the structure of a hierarchical codelist. A hierarchical code list is defined as an organised collection of codes that may participate in many parent/child relationships with other codes in the list.

Derivation:

*`AnnotableType`*` (extension)`

4185

*`IdentifiableType`*` (extension)`

4186

*`NameableType`*` (extension)`

4187

*`VersionableType`*` (restriction)`

4188

*`MaintainableBaseType`*` (extension)`

4189

*`MaintainableType`*` (restriction)`

4190

*`HierarchyBaseType`*` (extension)`

`HierarchyType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, hasFormalLevels`

Content:

`Annotations?, Link*, Name+, Description*, Level?, HierarchicalCode+`

4200

4201

Attribute Documentation:

4202

4203

| **Name** | **Type** | **Documentation** |

4204

| --- --| --- --| --- --|

4205

| id | IDType | The id is the identifier for the object. |

4206

| urn | HierarchyUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4207

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4208

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

4209

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4210

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4211

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4212

| 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. |

4213

| 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. |

4214

| 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. |

4215

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

4216

| hasFormalLevels | xs:boolean | If “true”, this indicates a hierarchy where the structure is arranged in levels of detail from the broadest to the most detailed level. If “false”, this indicates a hierarchy structure where the items in the hierarchy have no formal level structure. |

4217

4218

Element Documentation:

4219

4220

| **Name** | **Type** | **Documentation** |

4221

| --- --| --- --| --- --|

4222

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4223

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4224

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4225

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4226

| 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. |

4227

| HierarchicalCode | HierarchicalCodeType | HierarchicalCode is used to assemble the codes from the codelist(s) referenced into a hierarchy. |

4228

4229

***HierarchicalCodeBaseType*:** HierarchicalCodeBaseType is an abstract base type the creates the basis for the HierarchicalCodeType. It removes the urn and uri.

Derivation:

*`AnnotableType`*` (extension)`

4234

*`IdentifiableType`*` (extension)`

4235

*`HierarchicalCodeBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*`

4244

4245

Attribute Documentation:

4246

4247

| **Name** | **Type** | **Documentation** |

4248

| --- --| --- --| --- --|

4249

| id | IDType | The id attribute allows for an id to be assigned to the use of the particular code at that specific point in the hierarchy. This value is unique within the hierarchy being created, and is used to map the hierarchy against external structures. |

4250

| urn | HierarchicalCodeUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4251

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4252

4253

Element Documentation:

4254

4255

| **Name** | **Type** | **Documentation** |

4256

| --- --| --- --| --- --|

4257

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4258

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4259

4260

**HierarchicalCodeType:** HierarchicalCodeType describes the structure of a hierarchical code. A hierarchical code provides for a reference to a code that is referenced within the hierarchical code list via either a complete reference to a code through either a URN or full set of reference fields. Codes are arranged in a hierarchy by this reference. Note that it is possible to reference a single code such that it has multiple parents within the hierarchy. Further, the hierarchy may or may not be a leveled one.

Derivation:

*`AnnotableType`*` (extension)`

4265

*`IdentifiableType`*` (extension)`

4266

*`HierarchicalCodeBaseType`*` (extension)`

4267

`HierarchicalCodeType`

Attributes:

`id, urn?, uri?, validFrom?, validTo?`

Content:

`Annotations?, Link*, Code, HierarchicalCode*, Level?`

4276

4277

Attribute Documentation:

4278

4279

| **Name** | **Type** | **Documentation** |

4280

| --- --| --- --| --- --|

4281

| id | IDType | The id attribute allows for an id to be assigned to the use of the particular code at that specific point in the hierarchy. This value is unique within the hierarchy being created, and is used to map the hierarchy against external structures. |

4282

| urn | HierarchicalCodeUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4283

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4284

| 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. |

4285

| 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. |

4286

4287

Element Documentation:

4288

4289

| **Name** | **Type** | **Documentation** |

4290

| --- --| --- --| --- --|

4291

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4292

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4293

| Code | CodeReferenceType | Code provides a complete, explicit reference to a code through either its URN, or a complete reference to the codelist and code. |

4294

| HierarchicalCode | HierarchicalCodeType | HierarchicalCode is used to nest referenced codes into a value based hierarchy. |

4295

| Level | IDType | Level references a formal level defined within the hierarchy which defines this hierarchical code. This is only necessary if the nesting depth of the hierarchical code does not correspond to the nesting depth of the level to which it belongs (i.e. the hieararchical code is to skip down a level). Otherwise, the code is assumed to exist at the level in which the nesting depth of the level matches the nesting depth of the code. |

4296

4297

***LevelBaseType*:** LevelBaseType is an abstract base type that makes up the basis for the LevelType. It requires a name and id.

Derivation:

*`AnnotableType`*` (extension)`

4302

*`IdentifiableType`*` (extension)`

4303

*`NameableType`*` (restriction)`

*`LevelBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

4313

4314

Attribute Documentation:

4315

4316

| **Name** | **Type** | **Documentation** |

4317

| --- --| --- --| --- --|

4318

| id | IDType | The id is the identifier for the object. |

4319

| urn | LevelUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4320

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4321

4322

Element Documentation:

4323

4324

| **Name** | **Type** | **Documentation** |

4325

| --- --| --- --| --- --|

4326

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4327

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4328

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4329

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4330

4331

**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.

Derivation:

*`AnnotableType`*` (extension)`

4336

*`IdentifiableType`*` (extension)`

4337

*`NameableType`*` (restriction)`

4338

*`LevelBaseType`*` (extension)`

`LevelType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, CodingFormat?, Level?`

4348

4349

Attribute Documentation:

4350

4351

| **Name** | **Type** | **Documentation** |

4352

| --- --| --- --| --- --|

4353

| id | IDType | The id is the identifier for the object. |

4354

| urn | LevelUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4355

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4356

4357

Element Documentation:

4358

4359

| **Name** | **Type** | **Documentation** |

4360

| --- --| --- --| --- --|

4361

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4362

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4363

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4364

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4365

| 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. |

4366

| Level | LevelType | Level describes the next level down in the hierarchy. |

4367

4368

**CodingTextFormatType:**

Derivation:

`TextFormatType (restriction)`

4373

`BasicComponentTextFormatType (restriction)`

4374

`SimpleComponentTextFormatType (restriction)`

4375

`CodingTextFormatType`

Attributes:

`textType?, isSequence?, interval?, startValue?, endValue?, minLength?, maxLength?, minValue?, maxValue?, pattern?`

Content:

`{Empty}`

Attribute Documentation:

4386

4387

| **Name** | **Type** | **Documentation** |

4388

| --- --| --- --| --- --|

4389

| 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. |

4390

| 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. |

4391

| 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. |

4392

| 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. |

4393

| 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. |

4394

| minLength | xs:positiveInteger | The minLength attribute specifies the minimum and length of the value in characters. |

4395

| maxLength | xs:positiveInteger | The maxLength attribute specifies the maximum length of the value in characters. |

4396

| 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. |

4397

| 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. |

4398

| pattern | xs:string | The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema. |

4399

4400

***HierarchyAssociationBaseType*:** HierarchyAssociationBaseType defines the base refinement of the HierarchyAssociationType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

4405

*`IdentifiableType`*` (extension)`

4406

*`NameableType`*` (extension)`

4407

*`VersionableType`*` (restriction)`

4408

*`MaintainableBaseType`*` (extension)`

4409

*`MaintainableType`*` (restriction)`

4410

*`HierarchyAssociationBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

4419

4420

Attribute Documentation:

4421

4422

| **Name** | **Type** | **Documentation** |

4423

| --- --| --- --| --- --|

4424

| id | IDType | The id is the identifier for the object. |

4425

| urn | HierarchyAssociation UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4426

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4427

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

4428

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4429

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4430

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4431

| 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. |

4432

| 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. |

4433

| 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. |

4434

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

4435

4436

Element Documentation:

4437

4438

| **Name** | **Type** | **Documentation** |

4439

| --- --| --- --| --- --|

4440

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4441

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4442

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4443

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4444

4445

**HierarchyAssociationType:** HierarchyAssociationType defines the structure of a hiearchy association, which links a hierarchy with and identifiable object in the context of another object (e.g. a dimension within the context of a dataflow).

Derivation:

*`AnnotableType`*` (extension)`

4450

*`IdentifiableType`*` (extension)`

4451

*`NameableType`*` (extension)`

4452

*`VersionableType`*` (restriction)`

4453

*`MaintainableBaseType`*` (extension)`

4454

*`MaintainableType`*` (restriction)`

4455

`HierarchyAssociationType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, LinkedHierarchy, LinkedObject, ContextObject?`

4464

4465

Attribute Documentation:

4466

4467

| **Name** | **Type** | **Documentation** |

4468

| --- --| --- --| --- --|

4469

| id | IDType | The id is the identifier for the object. |

4470

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4471

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4472

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

4473

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4474

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4475

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4476

| 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. |

4477

| 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. |

4478

| 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. |

4479

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

4480

4481

Element Documentation:

4482

4483

| **Name** | **Type** | **Documentation** |

4484

| --- --| --- --| --- --|

4485

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4486

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4487

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4488

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4489

| LinkedHierarchy | HierarchyReferenceTy pe | The associated hierarchy. |

4490

| LinkedObject | UrnReferenceType | Associates the Identifiable Artefact that needs the Hierarchy. |

4491

| ContextObject | UrnReferenceType | The context within which the association is performed. |

4492

4493

***MetadataflowBaseType*:** MetadataflowBaseType is an abstract base type that serves as the basis for the MetadataflowType. It restricts the structure to reference a metadata structure definition.

Derivation:

*`AnnotableType`*` (extension)`

4498

*`IdentifiableType`*` (extension)`

4499

*`NameableType`*` (extension)`

4500

*`VersionableType`*` (restriction)`

4501

*`MaintainableBaseType`*` (extension)`

4502

*`MaintainableType`*` (restriction)`

4503

*`StructureUsageType`*` (restriction)`

4504

*`MetadataflowBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Structure?`

4513

4514

Attribute Documentation:

4515

4516

| **Name** | **Type** | **Documentation** |

4517

| --- --| --- --| --- --|

4518

| id | IDType | The id is the identifier for the object. |

4519

| urn | MetadataflowUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4520

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4521

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

4522

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4523

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4524

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4525

| 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. |

4526

| 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. |

4527

| 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. |

4528

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

4529

4530

Element Documentation:

4531

4532

| **Name** | **Type** | **Documentation** |

4533

| --- --| --- --| --- --|

4534

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4535

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4536

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4537

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4538

| Structure | MetadataStructureRef erenceType | Structure provides a reference to the metadata structure definition describing the structure of all reference metadata for this flow. |

4539

4540

**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

Derivation:

*`AnnotableType`*` (extension)`

4545

*`IdentifiableType`*` (extension)`

4546

*`NameableType`*` (extension)`

4547

*`VersionableType`*` (restriction)`

4548

*`MaintainableBaseType`*` (extension)`

4549

*`MaintainableType`*` (restriction)`

4550

*`StructureUsageType`*` (restriction)`

4551

*`MetadataflowBaseType`*` (extension)`

`MetadataflowType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Structure?, Target+`

4561

4562

Attribute Documentation:

4563

4564

| **Name** | **Type** | **Documentation** |

4565

| --- --| --- --| --- --|

4566

| id | IDType | The id is the identifier for the object. |

4567

| urn | MetadataflowUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4568

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4569

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

4570

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4571

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4572

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4573

| 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. |

4574

| 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. |

4575

| 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. |

4576

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

4577

4578

Element Documentation:

4579

4580

| **Name** | **Type** | **Documentation** |

4581

| --- --| --- --| --- --|

4582

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4583

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4584

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4585

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4586

| Structure | MetadataStructureRef erenceType | Structure provides a reference to the metadata structure definition describing the structure of all reference metadata for this flow. |

4587

| Target | WildcardUrnType | References identifiable structures to which the refernece metadata described by the referenced metadata structure should be restricted to. These references may include wildcards for parts of the reference. |

4588

4589

**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.

Derivation:

*`AnnotableType`*` (extension)`

4594

*`IdentifiableType`*` (extension)`

4595

*`NameableType`*` (extension)`

4596

*`VersionableType`*` (restriction)`

4597

*`MaintainableBaseType`*` (extension)`

4598

*`MaintainableType`*` (restriction)`

4599

*`StructureType`*` (restriction)`

4600

`MetadataStructureType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, MetadataStructureComponents?`

4609

4610

Attribute Documentation:

4611

4612

| **Name** | **Type** | **Documentation** |

4613

| --- --| --- --| --- --|

4614

| id | IDType | The id is the identifier for the object. |

4615

| urn | MetadataStructureUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4616

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4617

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

4618

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4619

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4620

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4621

| 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. |

4622

| 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. |

4623

| 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. |

4624

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

4625

4626

Element Documentation:

4627

4628

| **Name** | **Type** | **Documentation** |

4629

| --- --| --- --| --- --|

4630

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4631

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4632

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4633

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4634

| MetadataStructureCom ponents | MetadataStructureCom ponentsType | MetadataStructureComponents defines the grouping of the sets of the components that make up the metadata structure definition. |

4635

4636

**MetadataStructureComponentsBaseType:** MetadataStructureComponentsBaseType is an abstract base type that forms the basis for the MetadataStructureComponentsType.

Derivation:

*`GroupingType`*` (restriction)`

4641

`MetadataStructureComponentsBaseType`

Content:

`{Empty}`

**MetadataStructureComponentsType:** MetadataStructureComponentsType describes the structure of the grouping of the sets of the components that make up the metadata structure definition.

Derivation:

*`GroupingType`*` (restriction)`

4652

`MetadataStructureComponentsBaseType (extension)`

4653

`MetadataStructureComponentsType`

Content:

`MetadataAttributeList`

4658

4659

Element Documentation:

4660

4661

| **Name** | **Type** | **Documentation** |

4662

| --- --| --- --| --- --|

4663

| MetadataAttributeLis t | MetadataAttributeLis tType | MetadataAttributeList defines the set of metadata attributes that can be defined as a hierarchy, for reporting reference metadata about a target object. The identification of metadata attributes must be unique at any given level of the metadata structure. Although there are XML schema constraints to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a concept from which a metadata attribute takes its identity cannot be validated against this constraint. Therefore, systems processing metadata structure definitions will have to perform this check outside of the XML validation. |

4664

4665

**MetadataAttributeListType:** MetadataAttributeListType describes the structure of a meta data attribute list. It comprises a set of metadata attributes that can be defined as a hierarchy.

Derivation:

*`AnnotableType`*` (extension)`

4670

*`IdentifiableType`*` (extension)`

4671

*`ComponentListType`*` (restriction)`

4672

`MetadataAttributeListType`

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, MetadataAttribute+`

4681

4682

Attribute Documentation:

4683

4684

| **Name** | **Type** | **Documentation** |

4685

| --- --| --- --| --- --|

4686

| id (fixed: MetadataAttributeDescriptor) | IDType | The id attribute is provided in this case for completeness. However, its value is fixed to MetadataAttributeDescriptor. |

4687

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4688

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4689

4690

Element Documentation:

4691

4692

| **Name** | **Type** | **Documentation** |

4693

| --- --| --- --| --- --|

4694

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4695

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4696

| 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. |

4697

4698

***MetadataAttributeBaseType*:** MetadataAttributeBaseType is an abstract base type the serves as the basis for the MetadataAttributeType.

Derivation:

*`AnnotableType`*` (extension)`

4703

*`IdentifiableType`*` (extension)`

4704

*`ComponentBaseType`*` (extension)`

4705

*`ComponentType`*` (restriction)`

4706

*`MetadataAttributeBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?`

4715

4716

Attribute Documentation:

4717

4718

| **Name** | **Type** | **Documentation** |

4719

| --- --| --- --| --- --|

4720

| id | NCNameIDType | The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

4721

| urn | MetadataAttributeUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4722

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4723

4724

Element Documentation:

4725

4726

| **Name** | **Type** | **Documentation** |

4727

| --- --| --- --| --- --|

4728

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4729

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4730

| ConceptIdentity | ConceptReferenceType | ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. |

4731

| 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. |

4732

4733

**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.

Derivation:

*`AnnotableType`*` (extension)`

4738

*`IdentifiableType`*` (extension)`

4739

*`ComponentBaseType`*` (extension)`

4740

*`ComponentType`*` (restriction)`

4741

*`MetadataAttributeBaseType`*` (extension)`

4742

`MetadataAttributeType`

Attributes:

`id?, urn?, uri?, minOccurs?, maxOccurs?, isPresentational?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?, MetadataAttribute*`

4751

4752

Attribute Documentation:

4753

4754

| **Name** | **Type** | **Documentation** |

4755

| --- --| --- --| --- --|

4756

| id | NCNameIDType | The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

4757

| urn | MetadataAttributeUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4758

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4759

| minOccurs (default: 1) | xs: nonNegativeInteger | The minOccurs attribute indicates the minimum number of times this metadata attribute must occur within its parent object. |

4760

| maxOccurs (default: 1) | OccurenceType | The maxOccurs attribute indicates the maximum number of times this metadata attribute can occur within its parent object. |

4761

| 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. |

4762

4763

Element Documentation:

4764

4765

| **Name** | **Type** | **Documentation** |

4766

| --- --| --- --| --- --|

4767

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4768

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4769

| ConceptIdentity | ConceptReferenceType | ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component. |

4770

| 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. |

4771

| 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. |

4772

4773

**MetadataAttributeRepresentationType:** MetadataAttributeRepresentationType defines the possible local representations of a metadata attribute.

Derivation:

*`RepresentationType`*` (restriction)`

4778

`MetadataAttributeRepresentationType`

Content:

`(TextFormat | (Enumeration, EnumerationFormat?))`

4783

4784

Element Documentation:

4785

4786

| **Name** | **Type** | **Documentation** |

4787

| --- --| --- --| --- --|

4788

| TextFormat | BasicComponentTextFo rmatType | TextFormat describes an uncoded textual format. |

4789

| Enumeration | CodelistReferenceTyp e | Enumeration references an item scheme that enumerates the allowable values for this representation. |

4790

| EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |

4791

4792

***OrganisationSchemeBaseType*:** OrganisationSchemeBaseType is an abstract base type for any organisation scheme.

Derivation:

*`AnnotableType`*` (extension)`

4797

*`IdentifiableType`*` (extension)`

4798

*`NameableType`*` (extension)`

4799

*`VersionableType`*` (restriction)`

4800

*`MaintainableBaseType`*` (extension)`

4801

*`MaintainableType`*` (restriction)`

4802

*`ItemSchemeType`*` (restriction)`

4803

*`OrganisationSchemeBaseType`*

Attributes:

`id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*`

4812

4813

Attribute Documentation:

4814

4815

| **Name** | **Type** | **Documentation** |

4816

| --- --| --- --| --- --|

4817

| id | IDType | The id is the identifier for the object. |

4818

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4819

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4820

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4821

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4822

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4823

| 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. |

4824

| 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. |

4825

| 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. |

4826

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

4827

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

4828

4829

Element Documentation:

4830

4831

| **Name** | **Type** | **Documentation** |

4832

| --- --| --- --| --- --|

4833

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4834

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4835

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4836

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4837

4838

***OrganisationSchemeType*:** OrganisationSchemeType describes the structure of an organisation scheme.

Derivation:

*`AnnotableType`*` (extension)`

4843

*`IdentifiableType`*` (extension)`

4844

*`NameableType`*` (extension)`

4845

*`VersionableType`*` (restriction)`

4846

*`MaintainableBaseType`*` (extension)`

4847

*`MaintainableType`*` (restriction)`

4848

*`ItemSchemeType`*` (restriction)`

4849

*`OrganisationSchemeBaseType`*` (extension)`

4850

*`OrganisationSchemeType`*

Attributes:

`id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, `*`Organisation*`*

4859

4860

Attribute Documentation:

4861

4862

| **Name** | **Type** | **Documentation** |

4863

| --- --| --- --| --- --|

4864

| id | IDType | The id is the identifier for the object. |

4865

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4866

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4867

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4868

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4869

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4870

| 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. |

4871

| 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. |

4872

| 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. |

4873

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

4874

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

4875

4876

Element Documentation:

4877

4878

| **Name** | **Type** | **Documentation** |

4879

| --- --| --- --| --- --|

4880

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4881

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4882

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4883

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4884

| *Organisation* | *OrganisationType* | Organisation is an abstract substitution head for a generic organisation. |

4885

4886

***BaseOrganisationType*:** BaseOrganisationType is an abstract base type the forms the basis for the OrganisationType.

Derivation:

*`AnnotableType`*` (extension)`

4891

*`IdentifiableType`*` (extension)`

4892

*`NameableType`*` (restriction)`

4893

*`ItemBaseType`*` (extension)`

4894

*`ItemType`*` (restriction)`

4895

*`BaseOrganisationType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Parent?`

4904

4905

Attribute Documentation:

4906

4907

| **Name** | **Type** | **Documentation** |

4908

| --- --| --- --| --- --|

4909

| id | IDType | The id is the identifier for the object. |

4910

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4911

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4912

4913

Element Documentation:

4914

4915

| **Name** | **Type** | **Documentation** |

4916

| --- --| --- --| --- --|

4917

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4918

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4919

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4920

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4921

| Parent | IDType | If the particular organisation scheme allows, an organisation may reference a parent organisation defined in the same scheme. This does not affect the identification of the organisation, but rather only serves to state the relationship. |

4922

4923

***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.

Derivation:

*`AnnotableType`*` (extension)`

4928

*`IdentifiableType`*` (extension)`

4929

*`NameableType`*` (restriction)`

4930

*`ItemBaseType`*` (extension)`

4931

*`ItemType`*` (restriction)`

4932

*`BaseOrganisationType`*` (extension)`

*`OrganisationType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Parent?, Contact*`

4942

4943

Attribute Documentation:

4944

4945

| **Name** | **Type** | **Documentation** |

4946

| --- --| --- --| --- --|

4947

| id | IDType | The id is the identifier for the object. |

4948

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4949

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4950

4951

Element Documentation:

4952

4953

| **Name** | **Type** | **Documentation** |

4954

| --- --| --- --| --- --|

4955

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4956

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4957

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4958

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4959

| Parent | IDType | If the particular organisation scheme allows, an organisation may reference a parent organisation defined in the same scheme. This does not affect the identification of the organisation, but rather only serves to state the relationship. |

4960

| Contact | ContactType | Contact describes a contact for the organisation, |

4961

4962

**AgencySchemeType:** AgencySchemeType defines a specific type of organisation scheme which contains only maintenance agencies. The agency scheme maintained by a particular maintenance agency is always provided a fixed identifier and is never versioned. Therefore, agencies can be added or removed without have to version the scheme. Agencies schemes have no hierarchy, meaning that no agency may define a relationship with another agency in the scheme. In fact, the actual parent agency for an agency in a scheme is the agency which defines the scheme.

Derivation:

*`AnnotableType`*` (extension)`

4967

*`IdentifiableType`*` (extension)`

4968

*`NameableType`*` (extension)`

4969

*`VersionableType`*` (restriction)`

4970

*`MaintainableBaseType`*` (extension)`

4971

*`MaintainableType`*` (restriction)`

4972

*`ItemSchemeType`*` (restriction)`

4973

*`OrganisationSchemeBaseType`*` (extension)`

4974

*`OrganisationSchemeType`*` (restriction)`

`AgencySchemeType`

Attributes:

`id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, Agency*`

4984

4985

Attribute Documentation:

4986

4987

| **Name** | **Type** | **Documentation** |

4988

| --- --| --- --| --- --|

4989

| id (fixed: AGENCIES) | IDType | The id is the identifier for the object. |

4990

| urn | AgencySchemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4991

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4992

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4993

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4994

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4995

| 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. |

4996

| 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. |

4997

| 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. |

4998

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

4999

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

5000

5001

Element Documentation:

5002

5003

| **Name** | **Type** | **Documentation** |

5004

| --- --| --- --| --- --|

5005

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5006

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5007

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5008

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5009

| Agency | AgencyType | Agency is an organisation which maintains structural metadata such as classifications, concepts, data structures, and metadata structures. |

5010

5011

**DataConsumerSchemeType:** DataConsumerSchemeType defines a type of organisation scheme which contains only data consumers. The data consumer scheme maintained by a particular maintenance agency is always provided a fixed identifier and is never versioned. Therefore, consumers can be added or removed without have to version the scheme. This scheme has no hierarchy, meaning that no organisation may define a relationship with another organisation in the scheme.

Derivation:

*`AnnotableType`*` (extension)`

5016

*`IdentifiableType`*` (extension)`

5017

*`NameableType`*` (extension)`

5018

*`VersionableType`*` (restriction)`

5019

*`MaintainableBaseType`*` (extension)`

5020

*`MaintainableType`*` (restriction)`

5021

*`ItemSchemeType`*` (restriction)`

5022

*`OrganisationSchemeBaseType`*` (extension)`

5023

*`OrganisationSchemeType`*` (restriction)`

5024

` DataConsumerSchemeType`

Attributes:

`id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, DataConsumer*`

5033

5034

Attribute Documentation:

5035

5036

| **Name** | **Type** | **Documentation** |

5037

| --- --| --- --| --- --|

5038

| id (fixed: DATA\_CONSUMERS) | IDType | The id is the identifier for the object. |

5039

| urn | DataConsumerSchemeUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5040

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5041

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5042

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5043

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5044

| isExternalReference (default: false) | xs:boolean | The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. |

5045

| serviceURL | xs:anyURI | The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. |

5046

| structureURL | xs:anyURI | The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. |

5047

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

5048

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

5049

5050

Element Documentation:

5051

5052

| **Name** | **Type** | **Documentation** |

5053

| --- --| --- --| --- --|

5054

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5055

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5056

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5057

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5058

| DataConsumer | DataConsumerType | DataConsumer describes an organisation using data as input for further processing. |

5059

5060

**DataProviderSchemeType:** DataProviderSchemeType defines a type of organisation scheme which contains only data providers. The data provider scheme maintained by a particular maintenance agency is always provided a fixed identifier and is never versioned. Therefore, providers can be added or removed without have to version the scheme. This scheme has no hierarchy, meaning that no organisation may define a relationship with another organisation in the scheme

Derivation:

*`AnnotableType`*` (extension)`

5065

*`IdentifiableType`*` (extension)`

5066

*`NameableType`*` (extension)`

5067

*`VersionableType`*` (restriction)`

5068

*`MaintainableBaseType`*` (extension)`

5069

*`MaintainableType`*` (restriction)`

5070

*`ItemSchemeType`*` (restriction)`

5071

*`OrganisationSchemeBaseType`*` (extension)`

5072

*`OrganisationSchemeType`*` (restriction)`

5073

`DataProviderSchemeType`

Attributes:

`id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, DataProvider*`

5082

5083

Attribute Documentation:

5084

5085

| **Name** | **Type** | **Documentation** |

5086

| --- --| --- --| --- --|

5087

| id (fixed: DATA\_PROVIDERS) | IDType | The id is the identifier for the object. |

5088

| urn | DataProviderSchemeUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5089

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5090

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5091

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5092

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5093

| 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. |

5094

| 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. |

5095

| 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. |

5096

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

5097

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

5098

5099

Element Documentation:

5100

5101

| **Name** | **Type** | **Documentation** |

5102

| --- --| --- --| --- --|

5103

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5104

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5105

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5106

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5107

| DataProvider | DataProviderType | DataProvider describes an organisation that produces data. |

5108

5109

**MetadataProviderSchemeType:** MetadataProviderSchemeType defines a type of organisation scheme which contains only metadata providers. The metadata provider scheme maintained by a particular maintenance agency is always provided a fixed identifier and is never versioned. Therefore, providers can be added or removed without have to version the scheme. This scheme has no hierarchy, meaning that no organisation may define a relationship with another organisation in the scheme

Derivation:

*`AnnotableType`*` (extension)`

5114

*`IdentifiableType`*` (extension)`

5115

*`NameableType`*` (extension)`

5116

*`VersionableType`*` (restriction)`

5117

*`MaintainableBaseType`*` (extension)`

5118

*`MaintainableType`*` (restriction)`

5119

*`ItemSchemeType`*` (restriction)`

5120

*`OrganisationSchemeBaseType`*` (extension)`

5121

*`OrganisationSchemeType`*` (restriction)`

5122

`MetadataProviderSchemeType`

Attributes:

`id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, MetadataProvider*`

5131

5132

Attribute Documentation:

5133

5134

| **Name** | **Type** | **Documentation** |

5135

| --- --| --- --| --- --|

5136

| id (fixed: METADATA\_PROVIDERS) | IDType | The id is the identifier for the object. |

5137

| urn | MetadataProviderSche meUrnType | 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

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5140

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5141

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5142

| 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. |

5143

| 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. |

5144

| 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. |

5145

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

5146

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

5147

5148

Element Documentation:

5149

5150

| **Name** | **Type** | **Documentation** |

5151

| --- --| --- --| --- --|

5152

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5153

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5154

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5155

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5156

| MetadataProvider | MetadataProviderType | MetadataProvider describes an organisation that produces metadata . |

5157

5158

**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.

Derivation:

*`AnnotableType`*` (extension)`

5163

*`IdentifiableType`*` (extension)`

5164

*`NameableType`*` (extension)`

5165

*`VersionableType`*` (restriction)`

5166

*`MaintainableBaseType`*` (extension)`

5167

*`MaintainableType`*` (restriction)`

5168

*`ItemSchemeType`*` (restriction)`

5169

*`OrganisationSchemeBaseType`*` (extension)`

5170

*`OrganisationSchemeType`*` (restriction)`

5171

`OrganisationUnitSchemeType`

Attributes:

`id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, OrganisationUnit*`

5180

5181

Attribute Documentation:

5182

5183

| **Name** | **Type** | **Documentation** |

5184

| --- --| --- --| --- --|

5185

| id | IDType | The id is the identifier for the object. |

5186

| urn | OrganisationUnitSche meUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5187

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5188

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5189

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5190

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

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

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

5195

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

5196

5197

Element Documentation:

5198

5199

| **Name** | **Type** | **Documentation** |

5200

| --- --| --- --| --- --|

5201

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5202

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5203

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5204

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5205

| OrganisationUnit | OrganisationUnitType | OrganisationUnit describes a generic organisation, which serves not predefined role in SDMX. |

5206

5207

**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.

Derivation:

*`AnnotableType`*` (extension)`

5212

*`IdentifiableType`*` (extension)`

5213

*`NameableType`*` (restriction)`

5214

*`ItemBaseType`*` (extension)`

5215

*`ItemType`*` (restriction)`

5216

*`BaseOrganisationType`*` (extension)`

5217

*`OrganisationType`*` (restriction)`

`AgencyType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Contact*`

5227

5228

Attribute Documentation:

5229

5230

| **Name** | **Type** | **Documentation** |

5231

| --- --| --- --| --- --|

5232

| id | NCNameIDType | The id attribute holds the identification of the agency. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the agency identifier will be used as part of the name for simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details). |

5233

| urn | AgencyUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5234

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5235

5236

Element Documentation:

5237

5238

| **Name** | **Type** | **Documentation** |

5239

| --- --| --- --| --- --|

5240

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5241

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5242

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5243

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5244

| Contact | ContactType | Contact describes a contact for the organisation, |

5245

5246

**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.

Derivation:

*`AnnotableType`*` (extension)`

5251

*`IdentifiableType`*` (extension)`

5252

*`NameableType`*` (restriction)`

5253

*`ItemBaseType`*` (extension)`

5254

*`ItemType`*` (restriction)`

5255

*`BaseOrganisationType`*` (extension)`

5256

*`OrganisationType`*` (restriction)`

`DataConsumerType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Contact*`

5266

5267

Attribute Documentation:

5268

5269

| **Name** | **Type** | **Documentation** |

5270

| --- --| --- --| --- --|

5271

| id | IDType | The id is the identifier for the object. |

5272

| urn | DataConsumerUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5273

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5274

5275

Element Documentation:

5276

5277

| **Name** | **Type** | **Documentation** |

5278

| --- --| --- --| --- --|

5279

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5280

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5281

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5282

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5283

| Contact | ContactType | Contact describes a contact for the organisation, |

5284

5285

**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.

Derivation:

*`AnnotableType`*` (extension)`

5290

*`IdentifiableType`*` (extension)`

5291

*`NameableType`*` (restriction)`

5292

*`ItemBaseType`*` (extension)`

5293

*`ItemType`*` (restriction)`

5294

*`BaseOrganisationType`*` (extension)`

5295

*`OrganisationType`*` (restriction)`

`DataProviderType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Contact*`

5305

5306

Attribute Documentation:

5307

5308

| **Name** | **Type** | **Documentation** |

5309

| --- --| --- --| --- --|

5310

| id | IDType | The id is the identifier for the object. |

5311

| urn | DataProviderUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5312

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5313

5314

Element Documentation:

5315

5316

| **Name** | **Type** | **Documentation** |

5317

| --- --| --- --| --- --|

5318

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5319

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5320

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5321

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5322

| Contact | ContactType | Contact describes a contact for the organisation, |

5323

5324

**MetadataProviderType:** MetadataProviderType defines the structure of a metadata provider description. The contacts defined for the organisation are specific to the metadata provider role the organisation is serving.

Derivation:

*`AnnotableType`*` (extension)`

5329

*`IdentifiableType`*` (extension)`

5330

*`NameableType`*` (restriction)`

5331

*`ItemBaseType`*` (extension)`

5332

*`ItemType`*` (restriction)`

5333

*`BaseOrganisationType`*` (extension)`

5334

*`OrganisationType`*` (restriction)`

5335

`MetadataProviderType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Contact*`

5344

5345

Attribute Documentation:

5346

5347

| **Name** | **Type** | **Documentation** |

5348

| --- --| --- --| --- --|

5349

| id | IDType | The id is the identifier for the object. |

5350

| urn | MetadataProviderUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5351

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5352

5353

Element Documentation:

5354

5355

| **Name** | **Type** | **Documentation** |

5356

| --- --| --- --| --- --|

5357

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5358

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5359

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5360

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5361

| Contact | ContactType | Contact describes a contact for the organisation, |

5362

5363

**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.

Derivation:

*`AnnotableType`*` (extension)`

5368

*`IdentifiableType`*` (extension)`

5369

*`NameableType`*` (restriction)`

5370

*`ItemBaseType`*` (extension)`

5371

*`ItemType`*` (restriction)`

5372

*`BaseOrganisationType`*` (extension)`

5373

*`OrganisationType`*` (restriction)`

5374

`OrganisationUnitType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Parent?, Contact*`

5383

5384

Attribute Documentation:

5385

5386

| **Name** | **Type** | **Documentation** |

5387

| --- --| --- --| --- --|

5388

| id | IDType | The id is the identifier for the object. |

5389

| urn | OrganisationUnitUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5390

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5391

5392

Element Documentation:

5393

5394

| **Name** | **Type** | **Documentation** |

5395

| --- --| --- --| --- --|

5396

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5397

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5398

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5399

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5400

| Parent | IDType | If the particular organisation scheme allows, an organisation may reference a parent organisation defined in the same scheme. This does not affect the identification of the organisation, but rather only serves to state the relationship. |

5401

| Contact | ContactType | Contact describes a contact for the organisation, |

5402

5403

**ContactType:** ContactType describes the structure of a contact's details.

Attributes:

`id?`

Content:

`Name*, Department*, Role*, (Telephone | Fax | X400 | URI | Email)*`

5412

5413

Attribute Documentation:

5414

5415

| **Name** | **Type** | **Documentation** |

5416

| --- --| --- --| --- --|

5417

| id | IDType | The id attribute is used to carry user id information for the contact. |

5418

5419

Element Documentation:

5420

5421

| **Name** | **Type** | **Documentation** |

5422

| --- --| --- --| --- --|

5423

| Name | TextType | Name is a reusable element, used for providing a human-readable name for an object. |

5424

| Department | TextType | Department is designation of the organisational structure by a linguistic expression, within which the contact person works. |

5425

| Role | TextType | Role is the responsibility of the contact person with respect to the object for which this person is the contact. |

5426

| Telephone | xs:string | Telephone holds the telephone number for the contact person. |

5427

| Fax | xs:string | Fax holds the fax number for the contact person. |

5428

| X400 | xs:string | X400 holds the X.400 address for the contact person. |

5429

| URI | xs:anyURI | URI holds an information URL for the contact person. |

5430

| Email | xs:string | Email holds the email address for the contact person. |

5431

5432

***ProvisionAgreementBaseType*:** ProvisionAgreementBaseType defines the base refinement of the ProvisionAgreementType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

5437

*`IdentifiableType`*` (extension)`

5438

*`NameableType`*` (extension)`

5439

*`VersionableType`*` (restriction)`

5440

*`MaintainableBaseType`*` (extension)`

5441

*`MaintainableType`*` (restriction)`

5442

*`ProvisionAgreementBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

5451

5452

Attribute Documentation:

5453

5454

| **Name** | **Type** | **Documentation** |

5455

| --- --| --- --| --- --|

5456

| id | IDType | The id is the identifier for the object. |

5457

| urn | ProvisionAgreementUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5458

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5459

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

5460

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5461

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5462

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5463

| 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. |

5464

| 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. |

5465

| 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. |

5466

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

5467

5468

Element Documentation:

5469

5470

| **Name** | **Type** | **Documentation** |

5471

| --- --| --- --| --- --|

5472

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5473

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5474

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5475

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5476

5477

**ProvisionAgreementType:** ProvisionAgreementType describes the structure of a provision agreement. A provision agreement defines an agreement for a data provider to report data against a dataflow. Attributes which describe how the registry must behave when data or metadata is registered against this provision agreement are supplied.

Derivation:

*`AnnotableType`*` (extension)`

5482

*`IdentifiableType`*` (extension)`

5483

*`NameableType`*` (extension)`

5484

*`VersionableType`*` (restriction)`

5485

*`MaintainableBaseType`*` (extension)`

5486

*`MaintainableType`*` (restriction)`

5487

*`ProvisionAgreementBaseType`*` (extension)`

5488

`ProvisionAgreementType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Dataflow, DataProvider`

5497

5498

Attribute Documentation:

5499

5500

| **Name** | **Type** | **Documentation** |

5501

| --- --| --- --| --- --|

5502

| id | IDType | The id is the identifier for the object. |

5503

| urn | ProvisionAgreementUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5504

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5505

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

5506

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5507

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5508

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5509

| 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. |

5510

| 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. |

5511

| 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. |

5512

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

5513

5514

Element Documentation:

5515

5516

| **Name** | **Type** | **Documentation** |

5517

| --- --| --- --| --- --|

5518

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5519

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5520

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5521

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5522

| Dataflow | DataflowReferenceTyp e | Dataflow provides a reference to a pre-existing dataflow in the registry. The reference is provided via a URN and/or a full set of reference fields. |

5523

| DataProvider | DataProviderReferenc eType | DataProvider provides a reference to a pre-existing data provider in the registry. The reference is provided via a URN and/or a full set of reference fields. |

5524

5525

***MetadataProvisionAgreementBaseType*:** MetadataProvisionAgreementBaseType defines the base refinement of the MetadataProvisionAgreementType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

5530

*`IdentifiableType`*` (extension)`

5531

*`NameableType`*` (extension)`

5532

*`VersionableType`*` (restriction)`

5533

*`MaintainableBaseType`*` (extension)`

5534

*`MaintainableType`*` (restriction)`

5535

*`MetadataProvisionAgreementBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

5544

5545

Attribute Documentation:

5546

5547

| **Name** | **Type** | **Documentation** |

5548

| --- --| --- --| --- --|

5549

| id | IDType | The id is the identifier for the object. |

5550

| urn | MetadataProvisionAgr eementUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5551

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5552

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

5553

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5554

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5555

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5556

| 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. |

5557

| 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. |

5558

| 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. |

5559

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

5560

5561

Element Documentation:

5562

5563

| **Name** | **Type** | **Documentation** |

5564

| --- --| --- --| --- --|

5565

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5566

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5567

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5568

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5569

5570

**MetadataProvisionAgreementType:** ProvisionAgreementType describes the structure of a provision agreement. A provision agreement defines an agreement for a data provider to report data or reference metadata against a flow. Attributes which describe how the registry must behave when data or metadata is registered against this provision agreement are supplied.

Derivation:

*`AnnotableType`*` (extension)`

5575

*`IdentifiableType`*` (extension)`

5576

*`NameableType`*` (extension)`

5577

*`VersionableType`*` (restriction)`

5578

*`MaintainableBaseType`*` (extension)`

5579

*`MaintainableType`*` (restriction)`

5580

*`MetadataProvisionAgreementBaseType`*` (extension)`

5581

`MetadataProvisionAgreementType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Metadataflow, MetadataProvider, Target*`

5590

5591

Attribute Documentation:

5592

5593

| **Name** | **Type** | **Documentation** |

5594

| --- --| --- --| --- --|

5595

| id | IDType | The id is the identifier for the object. |

5596

| urn | MetadataProvisionAgr eementUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5597

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5598

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

5599

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5600

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5601

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5602

| 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. |

5603

| 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. |

5604

| 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. |

5605

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

5606

5607

Element Documentation:

5608

5609

| **Name** | **Type** | **Documentation** |

5610

| --- --| --- --| --- --|

5611

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5612

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5613

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5614

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5615

| Metadataflow | MetadataflowReferenc eType | Metadataflow provides a reference to a pre-existing metadataflow in the registry. The reference is provided via a URN and/or a full set of reference fields. |

5616

| MetadataProvider | MetadataProviderRefe renceType | MetadataProvider provides a reference to a pre-existing metadata provider in the registry. The reference is provided via a URN and/or a full set of reference fields. |

5617

| Target | WildcardUrnType | References identifiable structures to which the refernece metadata described by the metadata structure used by the metadaflow should be restricted to. These references may include wildcards for parts of the reference. |

5618

5619

***ProcessBaseType*:** ProcessBaseType defines the base refinement of the ProcessType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

5624

*`IdentifiableType`*` (extension)`

5625

*`NameableType`*` (extension)`

5626

*`VersionableType`*` (restriction)`

5627

*`MaintainableBaseType`*` (extension)`

5628

*`MaintainableType`*` (restriction)`

*`ProcessBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

5638

5639

Attribute Documentation:

5640

5641

| **Name** | **Type** | **Documentation** |

5642

| --- --| --- --| --- --|

5643

| id | IDType | The id is the identifier for the object. |

5644

| urn | ProcessUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5645

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5646

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

5647

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5648

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5649

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5650

| 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. |

5651

| 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. |

5652

| 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. |

5653

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

5654

5655

Element Documentation:

5656

5657

| **Name** | **Type** | **Documentation** |

5658

| --- --| --- --| --- --|

5659

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5660

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5661

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5662

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5663

5664

**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.

Derivation:

*`AnnotableType`*` (extension)`

5669

*`IdentifiableType`*` (extension)`

5670

*`NameableType`*` (extension)`

5671

*`VersionableType`*` (restriction)`

5672

*`MaintainableBaseType`*` (extension)`

5673

*`MaintainableType`*` (restriction)`

5674

*`ProcessBaseType`*` (extension)`

`ProcessType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, ProcessStep*`

5684

5685

Attribute Documentation:

5686

5687

| **Name** | **Type** | **Documentation** |

5688

| --- --| --- --| --- --|

5689

| id | IDType | The id is the identifier for the object. |

5690

| urn | ProcessUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5691

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5692

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

5693

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5694

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5695

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5696

| 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. |

5697

| 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. |

5698

| 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. |

5699

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

5700

5701

Element Documentation:

5702

5703

| **Name** | **Type** | **Documentation** |

5704

| --- --| --- --| --- --|

5705

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5706

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5707

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5708

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5709

| 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. |

5710

5711

***ProcessStepBaseType*:** ProcessStepBaseType is an abstract base type used as the basis for the ProcessStepType.

Derivation:

*`AnnotableType`*` (extension)`

5716

*`IdentifiableType`*` (extension)`

5717

*`NameableType`*` (restriction)`

5718

*`ProcessStepBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

5727

5728

Attribute Documentation:

5729

5730

| **Name** | **Type** | **Documentation** |

5731

| --- --| --- --| --- --|

5732

| id | IDType | The id is the identifier for the object. |

5733

| urn | ProcessStepUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5734

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5735

5736

Element Documentation:

5737

5738

| **Name** | **Type** | **Documentation** |

5739

| --- --| --- --| --- --|

5740

| Annotations | AnnotationsType | Annotations is a reusable 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

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5742

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5743

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5744

5745

**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.

Derivation:

*`AnnotableType`*` (extension)`

5750

*`IdentifiableType`*` (extension)`

5751

*`NameableType`*` (restriction)`

5752

*`ProcessStepBaseType`*` (extension)`

`ProcessStepType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Input*, Output*, Computation?, Transition*, ProcessStep*`

5762

5763

Attribute Documentation:

5764

5765

| **Name** | **Type** | **Documentation** |

5766

| --- --| --- --| --- --|

5767

| id | IDType | The id is the identifier for the object. |

5768

| urn | ProcessStepUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5769

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5770

5771

Element Documentation:

5772

5773

| **Name** | **Type** | **Documentation** |

5774

| --- --| --- --| --- --|

5775

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5776

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5777

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5778

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5779

| Input | InputOutputType | Input references an object which is an input to the process step. |

5780

| Output | InputOutputType | Output references an object which is an output form the process step. |

5781

| 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. |

5782

| 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. |

5783

| 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. |

5784

5785

***TransitionBaseType*:** TransitionBaseType defines the base refinement of the TransitionType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

5790

*`IdentifiableType`*` (extension)`

5791

*`TransitionBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*`

5800

5801

Attribute Documentation:

5802

5803

| **Name** | **Type** | **Documentation** |

5804

| --- --| --- --| --- --|

5805

| id | IDType | The id is the identifier for the object. |

5806

| urn | TransitionUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5807

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5808

5809

Element Documentation:

5810

5811

| **Name** | **Type** | **Documentation** |

5812

| --- --| --- --| --- --|

5813

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5814

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5815

5816

**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.

Derivation:

*`AnnotableType`*` (extension)`

5821

*`IdentifiableType`*` (extension)`

5822

*`TransitionBaseType`*` (extension)`

`TransitionType`

Attributes:

`id?, urn?, uri?, localID?`

Content:

`Annotations?, Link*, TargetStep, Condition+`

5832

5833

Attribute Documentation:

5834

5835

| **Name** | **Type** | **Documentation** |

5836

| --- --| --- --| --- --|

5837

| id | IDType | The id is the identifier for the object. |

5838

| urn | TransitionUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5839

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5840

| localID | IDType | The localID attribute is an optional identification for the transition within the process. |

5841

5842

Element Documentation:

5843

5844

| **Name** | **Type** | **Documentation** |

5845

| --- --| --- --| --- --|

5846

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5847

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5848

| TargetStep | NestedIDType | TargetStep references a process step within the process that should be transitioned to, should the conditions described be met. |

5849

| Condition | TextType | Condition is a textual description of the conditions to be met in order for the target step to be proceeded to. It is informational only (not machine-actionable), and may be supplied in multiple, parallel-language form. |

5850

5851

**ComputationType:** ComputationType describes a computation in a process.

Derivation:

*`AnnotableType`*` (extension)`

`ComputationType`

Attributes:

`localID?, softwarePackage?, softwareLanguage?, softwareVersion?`

Content:

`Annotations?, Description+`

5865

5866

Attribute Documentation:

5867

5868

| **Name** | **Type** | **Documentation** |

5869

| --- --| --- --| --- --|

5870

| localID | IDType | The localID attribute is an optional identification for the computation within the process. |

5871

| softwarePackage | xs:string | The softwarePackage attribute holds the name of the software package that is used to perform the computation. |

5872

| softwareLanguage | xs:string | The softwareLanguage attribute holds the coding language that the software package used to perform the computation is written in. |

5873

| softwareVersion | xs:string | The softwareVersion attribute hold the version of the software package that is used to perform that computation. |

5874

5875

Element Documentation:

5876

5877

| **Name** | **Type** | **Documentation** |

5878

| --- --| --- --| --- --|

5879

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5880

| Description | TextType | Description describe the computation in any form desired by the user (these are informational rather than machine-actionable), and so may be supplied in multiple, parallel-language versions, |

5881

5882

**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.

Derivation:

*`AnnotableType`*` (extension)`

`InputOutputType`

Attributes:

`localID?`

Content:

`Annotations?, ObjectReference`

5896

5897

Attribute Documentation:

5898

5899

| **Name** | **Type** | **Documentation** |

5900

| --- --| --- --| --- --|

5901

| localID | IDType | The localID attribute is an optional identification for the input or output within the process. |

5902

5903

Element Documentation:

5904

5905

| **Name** | **Type** | **Documentation** |

5906

| --- --| --- --| --- --|

5907

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5908

| ObjectReference | UrnReferenceType | ObjectReference is an abstract substitution head that references the object that is an input or output. It is substituted with a concrete reference to an explicit object type. |

5909

5910

**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.

Derivation:

*`AnnotableType`*` (extension)`

5915

*`IdentifiableType`*` (extension)`

5916

*`NameableType`*` (extension)`

5917

*`VersionableType`*` (restriction)`

5918

*`MaintainableBaseType`*` (extension)`

5919

*`MaintainableType`*` (restriction)`

5920

*`ItemSchemeType`*` (restriction)`

5921

`ReportingTaxonomyType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, ReportingCategory*`

5930

5931

Attribute Documentation:

5932

5933

| **Name** | **Type** | **Documentation** |

5934

| --- --| --- --| --- --|

5935

| id | IDType | The id is the identifier for the object. |

5936

| urn | ReportingTaxonomyUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5937

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5938

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

5939

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5940

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5941

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5942

| 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. |

5943

| 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. |

5944

| 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. |

5945

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

5946

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

5947

5948

Element Documentation:

5949

5950

| **Name** | **Type** | **Documentation** |

5951

| --- --| --- --| --- --|

5952

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5953

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5954

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5955

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5956

| ReportingCategory | ReportingCategoryTyp e | ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages. |

5957

5958

***ReportingCategoryBaseType*:** ReportingCategoryBaseType is an abstract base type that serves as the basis for the ReportingCategoryType.

Derivation:

*`AnnotableType`*` (extension)`

5963

*`IdentifiableType`*` (extension)`

5964

*`NameableType`*` (restriction)`

5965

*`ItemBaseType`*` (extension)`

5966

*`ItemType`*` (restriction)`

5967

*`ReportingCategoryBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, ReportingCategory*`

5976

5977

Attribute Documentation:

5978

5979

| **Name** | **Type** | **Documentation** |

5980

| --- --| --- --| --- --|

5981

| id | IDType | The id is the identifier for the object. |

5982

| urn | ReportingCategoryUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5983

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5984

5985

Element Documentation:

5986

5987

| **Name** | **Type** | **Documentation** |

5988

| --- --| --- --| --- --|

5989

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5990

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5991

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5992

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5993

| ReportingCategory | ReportingCategoryTyp e | ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages. |

5994

5995

**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.

Derivation:

*`AnnotableType`*` (extension)`

6000

*`IdentifiableType`*` (extension)`

6001

*`NameableType`*` (restriction)`

6002

*`ItemBaseType`*` (extension)`

6003

*`ItemType`*` (restriction)`

6004

*`ReportingCategoryBaseType`*` (extension)`

6005

`ReportingCategoryType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, ReportingCategory*, (StructuralMetadata* | ProvisioningMetadata*)`

6014

6015

Attribute Documentation:

6016

6017

| **Name** | **Type** | **Documentation** |

6018

| --- --| --- --| --- --|

6019

| id | IDType | The id is the identifier for the object. |

6020

| urn | ReportingCategoryUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6021

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6022

6023

Element Documentation:

6024

6025

| **Name** | **Type** | **Documentation** |

6026

| --- --| --- --| --- --|

6027

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6028

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6029

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6030

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6031

| ReportingCategory | ReportingCategoryTyp e | ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages. |

6032

| StructuralMetadata | StructureReferenceTy pe | StructuralMetadata provides a reference for data structure definition and metadata structure definition references which are grouped in the reporting category. It is assumed that all structural metadata objects referenced from a category will be of the same type. |

6033

| ProvisioningMetadata | StructureUsageRefere nceType | ProvisioningMetadata provides a reference for dataflow and metadataflow references which are grouped in the reporting category. It is assumed that all provisioning metadata objects referenced from a category will be of the same type. |

6034

6035

***ItemSchemeMapBaseType*:** ItemSchemeMapBaseType is an abstract base type which forms the basis for the ItemSchemeMapType.

Derivation:

*`AnnotableType`*` (extension)`

6040

*`IdentifiableType`*` (extension)`

6041

*`NameableType`*` (extension)`

6042

*`VersionableType`*` (restriction)`

6043

*`MaintainableBaseType`*` (extension)`

6044

*`MaintainableType`*` (restriction)`

6045

*`ItemSchemeMapBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

6054

6055

Attribute Documentation:

6056

6057

| **Name** | **Type** | **Documentation** |

6058

| --- --| --- --| --- --|

6059

| id | IDType | The id is the identifier for the object. |

6060

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6061

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6062

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

6063

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6064

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6065

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6066

| 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. |

6067

| 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. |

6068

| 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. |

6069

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

6070

6071

Element Documentation:

6072

6073

| **Name** | **Type** | **Documentation** |

6074

| --- --| --- --| --- --|

6075

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6076

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6077

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6078

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6079

6080

***ItemSchemeMapType*:** ItemSchemeMapType is an abstract base type which forms the basis for mapping items between item schemes of the same type.

Derivation:

*`AnnotableType`*` (extension)`

6085

*`IdentifiableType`*` (extension)`

6086

*`NameableType`*` (extension)`

6087

*`VersionableType`*` (restriction)`

6088

*`MaintainableBaseType`*` (extension)`

6089

*`MaintainableType`*` (restriction)`

6090

*`ItemSchemeMapBaseType`*` (extension)`

6091

*`ItemSchemeMapType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Source, Target, ItemMap*`

6100

6101

Attribute Documentation:

6102

6103

| **Name** | **Type** | **Documentation** |

6104

| --- --| --- --| --- --|

6105

| id | IDType | The id is the identifier for the object. |

6106

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6107

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6108

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

6109

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6110

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6111

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6112

| 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. |

6113

| 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. |

6114

| 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. |

6115

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

6116

6117

Element Documentation:

6118

6119

| **Name** | **Type** | **Documentation** |

6120

| --- --| --- --| --- --|

6121

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6122

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6123

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6124

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6125

| Source | MaintainableUrnRefer enceType | Source provides a reference to the item scheme which items are mapped from. |

6126

| Target | MaintainableUrnRefer enceType | Target provides a reference to the item scheme which items are mapped to. |

6127

| ItemMap | SingleValueMappingTy pe | |

6128

6129

**OrganisationSchemeMapType:** OrganisationSchemeMapType defines the structure of a map which identifies relationships between organisations in different organisation schemes.

Derivation:

*`AnnotableType`*` (extension)`

6134

*`IdentifiableType`*` (extension)`

6135

*`NameableType`*` (extension)`

6136

*`VersionableType`*` (restriction)`

6137

*`MaintainableBaseType`*` (extension)`

6138

*`MaintainableType`*` (restriction)`

6139

*`ItemSchemeMapBaseType`*` (extension)`

6140

*`ItemSchemeMapType`*` (restriction)`

6141

`OrganisationSchemeMapType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Source, Target, ItemMap*`

6150

6151

Attribute Documentation:

6152

6153

| **Name** | **Type** | **Documentation** |

6154

| --- --| --- --| --- --|

6155

| id | IDType | The id is the identifier for the object. |

6156

| urn | OrganisationSchemeMa pUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6157

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6158

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

6159

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6160

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6161

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6162

| 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. |

6163

| 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. |

6164

| 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. |

6165

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

6166

6167

Element Documentation:

6168

6169

| **Name** | **Type** | **Documentation** |

6170

| --- --| --- --| --- --|

6171

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6172

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6173

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6174

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6175

| Source | OrganisationSchemeRe ferenceType | Source provides a reference to the item scheme which items are mapped from. |

6176

| Target | OrganisationSchemeRe ferenceType | Target provides a reference to the item scheme which items are mapped to. |

6177

| ItemMap | SingleValueMappingTy pe | |

6178

6179

**CategorySchemeMapType:** CategorySchemeMapType defines the structure of a map which identifies relationships between categories in different category schemes.

Derivation:

*`AnnotableType`*` (extension)`

6184

*`IdentifiableType`*` (extension)`

6185

*`NameableType`*` (extension)`

6186

*`VersionableType`*` (restriction)`

6187

*`MaintainableBaseType`*` (extension)`

6188

*`MaintainableType`*` (restriction)`

6189

*`ItemSchemeMapBaseType`*` (extension)`

6190

*`ItemSchemeMapType`*` (restriction)`

6191

`CategorySchemeMapType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Source, Target, ItemMap*`

6200

6201

Attribute Documentation:

6202

6203

| **Name** | **Type** | **Documentation** |

6204

| --- --| --- --| --- --|

6205

| id | IDType | The id is the identifier for the object. |

6206

| urn | CategorySchemeMapUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6207

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6208

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

6209

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6210

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6211

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6212

| 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. |

6213

| 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. |

6214

| 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. |

6215

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

6216

6217

Element Documentation:

6218

6219

| **Name** | **Type** | **Documentation** |

6220

| --- --| --- --| --- --|

6221

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6222

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6223

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6224

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6225

| Source | CategorySchemeRefere nceType | Source provides a reference to the item scheme which items are mapped from. |

6226

| Target | CategorySchemeRefere nceType | Target provides a reference to the item scheme which items are mapped to. |

6227

| ItemMap | SingleValueMappingTy pe | |

6228

6229

**ConceptSchemeMapType:** ConceptSchemeMapType defines the structure of a map which identifies relationships between concepts in different concept schemes.

Derivation:

*`AnnotableType`*` (extension)`

6234

*`IdentifiableType`*` (extension)`

6235

*`NameableType`*` (extension)`

6236

*`VersionableType`*` (restriction)`

6237

*`MaintainableBaseType`*` (extension)`

6238

*`MaintainableType`*` (restriction)`

6239

*`ItemSchemeMapBaseType`*` (extension)`

6240

*`ItemSchemeMapType`*` (restriction)`

6241

` ConceptSchemeMapType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Source, Target, ItemMap*`

6250

6251

Attribute Documentation:

6252

6253

| **Name** | **Type** | **Documentation** |

6254

| --- --| --- --| --- --|

6255

| id | IDType | The id is the identifier for the object. |

6256

| urn | ConceptSchemeMapUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6257

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6258

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

6259

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6260

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6261

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6262

| 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. |

6263

| 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. |

6264

| 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. |

6265

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

6266

6267

Element Documentation:

6268

6269

| **Name** | **Type** | **Documentation** |

6270

| --- --| --- --| --- --|

6271

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6272

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6273

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6274

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6275

| Source | ConceptSchemeReferen ceType | Source provides a reference to the item scheme which items are mapped from. |

6276

| Target | ConceptSchemeReferen ceType | Target provides a reference to the item scheme which items are mapped to. |

6277

| ItemMap | SingleValueMappingTy pe | |

6278

6279

**ReportingTaxonomyMapType:** ReportingTaxonomyMapType defines the structure of a map which identifies relationships between reporting categories in different reporting taxonomies.

Derivation:

*`AnnotableType`*` (extension)`

6284

*`IdentifiableType`*` (extension)`

6285

*`NameableType`*` (extension)`

6286

*`VersionableType`*` (restriction)`

6287

*`MaintainableBaseType`*` (extension)`

6288

*`MaintainableType`*` (restriction)`

6289

*`ItemSchemeMapBaseType`*` (extension)`

6290

*`ItemSchemeMapType`*` (restriction)`

6291

`ReportingTaxonomyMapType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Source, Target, ItemMap*`

6300

6301

Attribute Documentation:

6302

6303

| **Name** | **Type** | **Documentation** |

6304

| --- --| --- --| --- --|

6305

| id | IDType | The id is the identifier for the object. |

6306

| urn | ReportingTaxonomyMap UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6307

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6308

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

6309

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6310

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6311

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6312

| 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. |

6313

| 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. |

6314

| 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. |

6315

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

6316

6317

Element Documentation:

6318

6319

| **Name** | **Type** | **Documentation** |

6320

| --- --| --- --| --- --|

6321

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6322

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6323

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6324

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6325

| Source | ReportingTaxonomyRef erenceType | Source provides a reference to the item scheme which items are mapped from. |

6326

| Target | ReportingTaxonomyRef erenceType | Target provides a reference to the item scheme which items are mapped to. |

6327

| ItemMap | SingleValueMappingTy pe | |

6328

6329

***StructureMapBaseType*:** StructureMapBaseType defines the base refinement of the StructureMapType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

6334

*`IdentifiableType`*` (extension)`

6335

*`NameableType`*` (extension)`

6336

*`VersionableType`*` (restriction)`

6337

*`MaintainableBaseType`*` (extension)`

6338

*`MaintainableType`*` (restriction)`

6339

*`StructureMapBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

6348

6349

Attribute Documentation:

6350

6351

| **Name** | **Type** | **Documentation** |

6352

| --- --| --- --| --- --|

6353

| id | IDType | The id is the identifier for the object. |

6354

| urn | StructureMapUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6355

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6356

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

6357

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6358

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6359

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6360

| 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. |

6361

| 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. |

6362

| 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. |

6363

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

6364

6365

Element Documentation:

6366

6367

| **Name** | **Type** | **Documentation** |

6368

| --- --| --- --| --- --|

6369

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6370

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6371

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6372

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6373

6374

**StructureMapType:** StructureMapType defines the structure for mapping components of one structure to components of another structure. A structure may be referenced directly meaning the map applies wherever the structure is used, or it may be a reference via a structure usage meaning the map only applies within the context of that usage. Using the related structures, one can make extrapolations between maps. For example, if key families, A, B, and C, are all grouped in a related structures container, then a map from data structure A to C and a map from data structure B to C could be used to infer a relation between data structure A to C.

Derivation:

*`AnnotableType`*` (extension)`

6379

*`IdentifiableType`*` (extension)`

6380

*`NameableType`*` (extension)`

6381

*`VersionableType`*` (restriction)`

6382

*`MaintainableBaseType`*` (extension)`

6383

*`MaintainableType`*` (restriction)`

6384

*`StructureMapBaseType`*` (extension)`

`StructureMapType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Source, Target, EpochMap*, DatePatternMap*, FrequencyFormatMapping*, ComponentMap*, FixedValueMap*`

6394

6395

Attribute Documentation:

6396

6397

| **Name** | **Type** | **Documentation** |

6398

| --- --| --- --| --- --|

6399

| id | IDType | The id is the identifier for the object. |

6400

| urn | StructureMapUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6401

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6402

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

6403

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6404

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6405

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6406

| 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. |

6407

| 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. |

6408

| 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. |

6409

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

6410

6411

Element Documentation:

6412

6413

| **Name** | **Type** | **Documentation** |

6414

| --- --| --- --| --- --|

6415

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6416

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6417

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6418

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6419

| Source | StructureOrUsageRefe renceType | Source provides a reference to a structure (data or metadata) or a structure usage (dataflow or metadataflow) from which components defined by the actual structure are to mapped. |

6420

| Target | StructureOrUsageRefe renceType | Target provides a reference to a structure (data or metadata) or a structure usage (dataflow or metadataflow) to which components from the source are to mapped. |

6421

| EpochMap | EpochMapType | Provides the ability to map source to target date formats. The source date is described as the number of epochs since a point in time, where the duration of each epoch is defined, e.g. number of milliseconds since 1970. |

6422

| DatePatternMap | DatePatternMapType | Provides the ability to map source to target date formats. The source date is described as a pattern (for example MM-YYYY). |

6423

| FrequencyFormatMappi ng | FrequencyFormatMappi ngType | |

6424

| 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. |

6425

| FixedValueMap | FixedValueMapType | FixedValueMap defines a fixed value for a source or target component in the mapping. |

6426

6427

**FixedValueMapType:** FixedValueMapType defines the structure for providing a fixed value for a source or target component.

Derivation:

*`AnnotableType`*` (extension)`

`FixedValueMapType`

Content:

`Annotations?, (Source | Target), Value*`

6437

6438

Element Documentation:

6439

6440

| **Name** | **Type** | **Documentation** |

6441

| --- --| --- --| --- --|

6442

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6443

| Source | IDType | |

6444

| Target | IDType | |

6445

| Value | xs:string | The fixed value for the component. |

6446

6447

**ComponentMapType:** ComponentMapType defines the structure for relating a component in a source structure to a component in a target structure.

Derivation:

*`AnnotableType`*` (extension)`

`ComponentMapType`

Content:

`Annotations?, Source+, Target+, RepresentationMap?`

6457

6458

Element Documentation:

6459

6460

| **Name** | **Type** | **Documentation** |

6461

| --- --| --- --| --- --|

6462

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6463

| Source | IDType | |

6464

| Target | IDType | |

6465

| RepresentationMap | RepresentationMapRef erenceType | |

6466

6467

***FrequencyFormatMappingBaseType*:** FrequencyFormatMappingBaseType defines the base refinement of the FrequencyFormatMappingType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

6472

*`IdentifiableType`*` (extension)`

6473

*`FrequencyFormatMappingBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*`

6482

6483

Attribute Documentation:

6484

6485

| **Name** | **Type** | **Documentation** |

6486

| --- --| --- --| --- --|

6487

| id | IDType | The id is the identifier for the object. |

6488

| urn | FrequencyFormatMappi ngUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6489

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6490

6491

Element Documentation:

6492

6493

| **Name** | **Type** | **Documentation** |

6494

| --- --| --- --| --- --|

6495

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6496

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6497

6498

**FrequencyFormatMappingType:**

Derivation:

*`AnnotableType`*` (extension)`

6503

*`IdentifiableType`*` (extension)`

6504

*`FrequencyFormatMappingBaseType`*` (extension)`

6505

`FrequencyFormatMappingType`

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, FrequencyId, DatePattern`

6514

6515

Attribute Documentation:

6516

6517

| **Name** | **Type** | **Documentation** |

6518

| --- --| --- --| --- --|

6519

| id | IDType | The id is the identifier for the object. |

6520

| urn | FrequencyFormatMappi ngUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6521

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6522

6523

Element Documentation:

6524

6525

| **Name** | **Type** | **Documentation** |

6526

| --- --| --- --| --- --|

6527

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6528

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6529

| FrequencyId | IDType | |

6530

| DatePattern | xs:string | |

***DateMapType*:**

Derivation:

*`AnnotableType`*` (extension)`

6537

*`IdentifiableType`*` (extension)`

*`DateMapType`*

Attributes:

`id?, urn?, uri?, resolvePeriod?`

Content:

`Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*) | TargetFrequencyID)`

6547

6548

Attribute Documentation:

6549

6550

| **Name** | **Type** | **Documentation** |

6551

| --- --| --- --| --- --|

6552

| id | IDType | The id is the identifier for the object. |

6553

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6554

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6555

| resolvePeriod | ResolvePeriodType | Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods. |

6556

6557

Element Documentation:

6558

6559

| **Name** | **Type** | **Documentation** |

6560

| --- --| --- --| --- --|

6561

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6562

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6563

| Source | IDType | |

6564

| Target | IDType | |

6565

| FrequencyDimension | IDType | |

6566

| MappedFrequencies | IDType | |

6567

| TargetFrequencyID | IDType | |

6568

6569

***EpochMapBaseType*:** EpochMapBaseType defines the base refinement of the EpochMapType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

6574

*`IdentifiableType`*` (extension)`

6575

*`DateMapType`*` (restriction)`

*`EpochMapBaseType`*

Attributes:

`id?, urn?, uri?, resolvePeriod?`

Content:

`Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*) | TargetFrequencyID)`

6585

6586

Attribute Documentation:

6587

6588

| **Name** | **Type** | **Documentation** |

6589

| --- --| --- --| --- --|

6590

| id | IDType | The id is the identifier for the object. |

6591

| urn | EpochMapUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6592

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6593

| resolvePeriod | ResolvePeriodType | Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods. |

6594

6595

Element Documentation:

6596

6597

| **Name** | **Type** | **Documentation** |

6598

| --- --| --- --| --- --|

6599

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6600

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6601

| Source | IDType | |

6602

| Target | IDType | |

6603

| FrequencyDimension | IDType | |

6604

| MappedFrequencies | IDType | |

6605

| TargetFrequencyID | IDType | |

**EpochMapType:**

Derivation:

*`AnnotableType`*` (extension)`

6612

*`IdentifiableType`*` (extension)`

6613

*`DateMapType`*` (restriction)`

6614

*`EpochMapBaseType`*` (extension)`

`EpochMapType`

Attributes:

`id?, urn?, uri?, resolvePeriod?, basePeriod, epochPeriod`

Content:

`Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*) | TargetFrequencyID)`

6624

6625

Attribute Documentation:

6626

6627

| **Name** | **Type** | **Documentation** |

6628

| --- --| --- --| --- --|

6629

| id | IDType | The id is the identifier for the object. |

6630

| urn | EpochMapUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6631

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6632

| resolvePeriod | ResolvePeriodType | Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods. |

6633

| basePeriod | xs:string | |

6634

| epochPeriod | EpochPeriodType | |

6635

6636

Element Documentation:

6637

6638

| **Name** | **Type** | **Documentation** |

6639

| --- --| --- --| --- --|

6640

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6641

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6642

| Source | IDType | |

6643

| Target | IDType | |

6644

| FrequencyDimension | IDType | |

6645

| MappedFrequencies | IDType | |

6646

| TargetFrequencyID | IDType | |

6647

6648

***DatePatternMapBaseType*:** DatePatternMapBaseType defines the base refinement of the DatePatternMapType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

6653

*`IdentifiableType`*` (extension)`

6654

*`DateMapType`*` (restriction)`

6655

*`DatePatternMapBaseType`*

Attributes:

`id?, urn?, uri?, resolvePeriod?`

Content:

`Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*) | TargetFrequencyID)`

6664

6665

Attribute Documentation:

6666

6667

| **Name** | **Type** | **Documentation** |

6668

| --- --| --- --| --- --|

6669

| id | IDType | The id is the identifier for the object. |

6670

| urn | DatePatternMapUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6671

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6672

| resolvePeriod | ResolvePeriodType | Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods. |

6673

6674

Element Documentation:

6675

6676

| **Name** | **Type** | **Documentation** |

6677

| --- --| --- --| --- --|

6678

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6679

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6680

| Source | IDType | |

6681

| Target | IDType | |

6682

| FrequencyDimension | IDType | |

6683

| MappedFrequencies | IDType | |

6684

| TargetFrequencyID | IDType | |

6685

6686

**DatePatternMapType:**

Derivation:

*`AnnotableType`*` (extension)`

6691

*`IdentifiableType`*` (extension)`

6692

*`DateMapType`*` (restriction)`

6693

*`DatePatternMapBaseType`*` (extension)`

`DatePatternMapType`

Attributes:

`id?, urn?, uri?, resolvePeriod?, sourcePattern, locale`

Content:

`Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*) | TargetFrequencyID)`

6703

6704

Attribute Documentation:

6705

6706

| **Name** | **Type** | **Documentation** |

6707

| --- --| --- --| --- --|

6708

| id | IDType | The id is the identifier for the object. |

6709

| urn | DatePatternMapUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6710

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6711

| resolvePeriod | ResolvePeriodType | Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods. |

6712

| sourcePattern | xs:string | Describes the source date using conventions for describing years, months, days, etc. |

6713

| locale | xs:string | The locale on which the input will be parsed according to the pattern. |

6714

6715

Element Documentation:

6716

6717

| **Name** | **Type** | **Documentation** |

6718

| --- --| --- --| --- --|

6719

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6720

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6721

| Source | IDType | |

6722

| Target | IDType | |

6723

| FrequencyDimension | IDType | |

6724

| MappedFrequencies | IDType | |

6725

| TargetFrequencyID | IDType | |

6726

6727

***RepresentationMapBaseType*:** RepresentationMapBaseType defines the base refinement of the RepresentationMapType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

6732

*`IdentifiableType`*` (extension)`

6733

*`NameableType`*` (extension)`

6734

*`VersionableType`*` (restriction)`

6735

*`MaintainableBaseType`*` (extension)`

6736

*`MaintainableType`*` (restriction)`

6737

*`RepresentationMapBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

6746

6747

Attribute Documentation:

6748

6749

| **Name** | **Type** | **Documentation** |

6750

| --- --| --- --| --- --|

6751

| id | IDType | The id is the identifier for the object. |

6752

| urn | RepresentationMapUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6753

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6754

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

6755

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6756

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6757

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6758

| 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. |

6759

| 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. |

6760

| 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. |

6761

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

6762

6763

Element Documentation:

6764

6765

| **Name** | **Type** | **Documentation** |

6766

| --- --| --- --| --- --|

6767

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6768

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6769

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6770

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6771

6772

**RepresentationMapType:**

Derivation:

*`AnnotableType`*` (extension)`

6777

*`IdentifiableType`*` (extension)`

6778

*`NameableType`*` (extension)`

6779

*`VersionableType`*` (restriction)`

6780

*`MaintainableBaseType`*` (extension)`

6781

*`MaintainableType`*` (restriction)`

6782

*`RepresentationMapBaseType`*` (extension)`

6783

`RepresentationMapType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, (SourceCodelist | SourceDataType)+, (TargetCodelist | TargetDataType)+, RepresentationMapping*`

6792

6793

Attribute Documentation:

6794

6795

| **Name** | **Type** | **Documentation** |

6796

| --- --| --- --| --- --|

6797

| id | IDType | The id is the identifier for the object. |

6798

| urn | RepresentationMapUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6799

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6800

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

6801

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6802

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6803

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6804

| 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. |

6805

| 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. |

6806

| 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. |

6807

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

6808

6809

Element Documentation:

6810

6811

| **Name** | **Type** | **Documentation** |

6812

| --- --| --- --| --- --|

6813

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6814

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6815

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6816

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6817

| SourceCodelist | AnyCodelistReferenceTyp e | |

6818

| SourceDataType | DataType | |

6819

| TargetCodelist | AnyCodelistReferenceTyp e | |

6820

| TargetDataType | DataType | |

6821

| RepresentationMappin g | ValueMappingType | |

6822

6823

**SingleValueMappingType:** SingleValueMappingType defines a mapping with a single source and optional target.

Derivation:

*`AnnotableType`*` (extension)`

6828

`SingleValueMappingType`

Attributes:

`validFrom?, validTo?`

Content:

`Annotations?, SourceValue, TargetValue?`

6837

6838

Attribute Documentation:

6839

6840

| **Name** | **Type** | **Documentation** |

6841

| --- --| --- --| --- --|

6842

| validFrom | xs:date | |

6843

| validTo | xs:date | |

6844

6845

Element Documentation:

6846

6847

| **Name** | **Type** | **Documentation** |

6848

| --- --| --- --| --- --|

6849

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6850

| SourceValue | MappedValueType | There should be a source value for each source represention (e.g. codelist, data type). Source values can be pattern matched by using regular expression or substrings using start/end indexes. |

6851

| TargetValue | xs:string | The target value(s) is always an absolute string. However, if source value is a regular expression, the target value can output the capture group from the source. |

6852

6853

**ValueMappingType:** ValueMappingType defines a mapping of multiple sources to multiple targets.

Derivation:

*`AnnotableType`*` (extension)`

`ValueMappingType`

Attributes:

`validFrom?, validTo?`

Content:

`Annotations?, SourceValue+, TargetValue*`

6867

6868

Attribute Documentation:

6869

6870

| **Name** | **Type** | **Documentation** |

6871

| --- --| --- --| --- --|

6872

| validFrom | xs:date | |

6873

| validTo | xs:date | |

6874

6875

Element Documentation:

6876

6877

| **Name** | **Type** | **Documentation** |

6878

| --- --| --- --| --- --|

6879

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6880

| SourceValue | MappedValueType | There should be a source value for each source represention (e.g. codelist, data type). Source values can be pattern matched by using regular expression or substrings using start/end indexes. |

6881

| TargetValue | xs:string | The target value(s) is always an absolute string. However, if source value is a regular expression, the target value can output the capture group from the source. |

**MappedValueType:**

Derivation:

`xs:anySimpleType (restriction)`

6888

`xs:string (extension)`

`MappedValueType`

Attributes:

`isRegEx?, startIndex?, endIndex?`

Content:

Attribute Documentation:

6898

6899

| **Name** | **Type** | **Documentation** |

6900

| --- --| --- --| --- --|

6901

| isRegEx | xs:boolean | |

6902

| startIndex | xs:int | |

6903

| endIndex | xs:int | |

6904

6905

***VtlDefinitionSchemeType*:** VtlDefinitionSchemeType is an abstract extension of the ItemSchemeType for VTL schemes.

Derivation:

*`AnnotableType`*` (extension)`

6910

*`IdentifiableType`*` (extension)`

6911

*`NameableType`*` (extension)`

6912

*`VersionableType`*` (restriction)`

6913

*`MaintainableBaseType`*` (extension)`

6914

*`MaintainableType`*` (extension)`

6915

*`ItemSchemeType`*` (extension)`

6916

*`VtlDefinitionSchemeType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`

Content:

`Annotations?, Link*, Name+, Description*, `*`Item*`*

6925

6926

Attribute Documentation:

6927

6928

| **Name** | **Type** | **Documentation** |

6929

| --- --| --- --| --- --|

6930

| id | IDType | The id is the identifier for the object. |

6931

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6932

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6933

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

6934

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6935

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6936

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6937

| 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. |

6938

| 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. |

6939

| 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. |

6940

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

6941

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

6942

| 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. |

6943

6944

Element Documentation:

6945

6946

| **Name** | **Type** | **Documentation** |

6947

| --- --| --- --| --- --|

6948

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6949

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6950

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6951

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6952

| *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. |

6953

6954

***TransformationSchemeBaseType*:** TransformationSchemeBaseType is an abstract base type for the TransformationSchemeType. It restricts the item types to be only transformations.

Derivation:

*`AnnotableType`*` (extension)`

6959

*`IdentifiableType`*` (extension)`

6960

*`NameableType`*` (extension)`

6961

*`VersionableType`*` (restriction)`

6962

*`MaintainableBaseType`*` (extension)`

6963

*`MaintainableType`*` (extension)`

6964

*`ItemSchemeType`*` (extension)`

6965

*`VtlDefinitionSchemeType`*` (restriction)`

6966

*`TransformationSchemeBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`

Content:

`Annotations?, Link*, Name+, Description*, Transformation*`

6975

6976

Attribute Documentation:

6977

6978

| **Name** | **Type** | **Documentation** |

6979

| --- --| --- --| --- --|

6980

| id | IDType | The id is the identifier for the object. |

6981

| urn | TransformationScheme UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6982

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6983

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

6984

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6985

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6986

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6987

| 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. |

6988

| 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. |

6989

| 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. |

6990

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

6991

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

6992

| 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. |

6993

6994

Element Documentation:

6995

6996

| **Name** | **Type** | **Documentation** |

6997

| --- --| --- --| --- --|

6998

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6999

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7000

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7001

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7002

| Transformation | TransformationType | Transformation describes the details of a single transformation within a transformation scheme. |

7003

7004

**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.

Derivation:

*`AnnotableType`*` (extension)`

7009

*`IdentifiableType`*` (extension)`

7010

*`NameableType`*` (extension)`

7011

*`VersionableType`*` (restriction)`

7012

*`MaintainableBaseType`*` (extension)`

7013

*`MaintainableType`*` (extension)`

7014

*`ItemSchemeType`*` (extension)`

7015

*`VtlDefinitionSchemeType`*` (restriction)`

7016

*`TransformationSchemeBaseType`*` (extension)`

7017

`TransformationSchemeType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`

Content:

`Annotations?, Link*, Name+, Description*, Transformation*, VtlMappingScheme?, NamePersonalisationScheme?, CustomTypeScheme?, RulesetScheme*, UserDefinedOperatorScheme*`

7026

7027

Attribute Documentation:

7028

7029

| **Name** | **Type** | **Documentation** |

7030

| --- --| --- --| --- --|

7031

| id | IDType | The id is the identifier for the object. |

7032

| urn | TransformationScheme UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7033

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7034

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

7035

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

7036

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

7037

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

7038

| 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. |

7039

| 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. |

7040

| 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. |

7041

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

7042

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

7043

| 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. |

7044

7045

Element Documentation:

7046

7047

| **Name** | **Type** | **Documentation** |

7048

| --- --| --- --| --- --|

7049

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7050

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7051

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7052

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7053

| Transformation | TransformationType | Transformation describes the details of a single transformation within a transformation scheme. |

7054

| VtlMappingScheme | VtlMappingSchemeRefe renceType | References a VTL mapping scheme which defines aliases for given SDMX artefacts that are used in the transformations as well as the mapping methods used when converting between SDMX and VTL data structures. All aliases must be defined in the referenced scheme. This also must be used if the basic mapping methods are not used. |

7055

| NamePersonalisationS cheme | NamePersonalisationS chemeReferenceType | References a name personalisation scheme, which defines the overriding of some standard VTL names (to be assigned to some measures and/or attributes of the data structure) with some corresponding personalised names. This must be used if transformations within a transformation scheme personalise standard names. All personalisations must be defined in the referenced scheme. |

7056

| CustomTypeScheme | CustomTypeSchemeRefe renceType | References a custom type scheme which defines custom conversions of VTL scalar types to SDMX data types. This must be used if custom type conversions are used in the transformations defined in a transformation scheme. All custom conversions must be defined in the referenced scheme. |

7057

| RulesetScheme | RulesetSchemeReferen ceType | References a ruleset scheme that defines one or more previously defined rulesets which can be invoked by VTL operators. If a transformation defined in a transformation scheme refers to a ruleset, the scheme in which the ruleset is defined must be referenced here. |

7058

| UserDefinedOperatorS cheme | UserDefinedOperatorS chemeReferenceType | References a user defined operator scheme that defines one or more user defined operators used by the transformations defined in a transformation scheme. If a transformation in a transformation scheme refers to a user defined operator, the scheme in which the user defined operator is defined must be referenced here. |

7059

7060

***TransformationBaseType*:** TransformationBaseType defines the base refinement of the TransformationType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

7065

*`IdentifiableType`*` (extension)`

7066

*`NameableType`*` (restriction)`

7067

*`ItemBaseType`*` (extension)`

7068

*`ItemType`*` (restriction)`

7069

*`UnnestedItemType`*` (restriction)`

7070

*`TransformationBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

7079

7080

Attribute Documentation:

7081

7082

| **Name** | **Type** | **Documentation** |

7083

| --- --| --- --| --- --|

7084

| id | IDType | The id is the identifier for the object. |

7085

| urn | TransformationUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7086

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7087

7088

Element Documentation:

7089

7090

| **Name** | **Type** | **Documentation** |

7091

| --- --| --- --| --- --|

7092

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7093

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7094

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7095

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7096

7097

**TransformationType:** TransformationType defines the structure of a transformation. A transformation is an assignment of a VTL expression to a specific result.

Derivation:

*`AnnotableType`*` (extension)`

7102

*`IdentifiableType`*` (extension)`

7103

*`NameableType`*` (restriction)`

7104

*`ItemBaseType`*` (extension)`

7105

*`ItemType`*` (restriction)`

7106

*`UnnestedItemType`*` (restriction)`

7107

*`TransformationBaseType`*` (extension)`

`TransformationType`

Attributes:

`id, urn?, uri?, isPersistent`

Content:

`Annotations?, Link*, Name+, Description*, Expression, Result`

7117

7118

Attribute Documentation:

7119

7120

| **Name** | **Type** | **Documentation** |

7121

| --- --| --- --| --- --|

7122

| id | IDType | The id is the identifier for the object. |

7123

| urn | TransformationUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7124

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7125

| 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. |

7126

7127

Element Documentation:

7128

7129

| **Name** | **Type** | **Documentation** |

7130

| --- --| --- --| --- --|

7131

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7132

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7133

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7134

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7135

| 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"). |

7136

| 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"). |

7137

7138

**VtlMappingSchemeType:** VtlMappingSchemeType defines a set of mappings between SDMX and VTL.

Derivation:

*`AnnotableType`*` (extension)`

7143

*`IdentifiableType`*` (extension)`

7144

*`NameableType`*` (extension)`

7145

*`VersionableType`*` (restriction)`

7146

*`MaintainableBaseType`*` (extension)`

7147

*`MaintainableType`*` (extension)`

7148

*`ItemSchemeType`*` (restriction)`

7149

`VtlMappingSchemeType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, VtlMapping*`

7158

7159

Attribute Documentation:

7160

7161

| **Name** | **Type** | **Documentation** |

7162

| --- --| --- --| --- --|

7163

| id | IDType | The id is the identifier for the object. |

7164

| urn | VtlMappingSchemeUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7165

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7166

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

7167

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

7168

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

7169

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

7170

| 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. |

7171

| 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. |

7172

| 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. |

7173

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

7174

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

7175

7176

Element Documentation:

7177

7178

| **Name** | **Type** | **Documentation** |

7179

| --- --| --- --| --- --|

7180

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7181

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7182

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7183

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7184

| VtlMapping | VtlMappingType | VtlMapping details a mapping between SDMX and VTL transformation. |

7185

7186

***VtlMappingBaseType*:** VtlMappingBaseType defines the base refinement of the VtlMappingType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

7191

*`IdentifiableType`*` (extension)`

7192

*`NameableType`*` (restriction)`

7193

*`ItemBaseType`*` (extension)`

7194

*`ItemType`*` (restriction)`

7195

*`UnnestedItemType`*` (restriction)`

7196

*`VtlMappingBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

7205

7206

Attribute Documentation:

7207

7208

| **Name** | **Type** | **Documentation** |

7209

| --- --| --- --| --- --|

7210

| id | IDType | The id is the identifier for the object. |

7211

| urn | VtlMappingUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7212

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7213

7214

Element Documentation:

7215

7216

| **Name** | **Type** | **Documentation** |

7217

| --- --| --- --| --- --|

7218

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7219

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7220

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7221

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7222

7223

**VtlMappingType:** VtlMappingType defines the structure of a single mapping between the reference to a SDMX artefact made from VTL transformations, rulesets, user defined operators and the corresponding SDMX structure identifier. These are used to assign an alternative names to SDMX Dataflows, Codelists, Concept Schemes, or Concepts. Although are distinct sub-classes in the Information Model, this structure serves to express them all. The references SDMX artefact serves to distinguish which type of sub-class (VtlDatflowMapping or VtlCodelistMapping, or VtlConceptMapping) is being described. When this is used to assign an alias for a SDMX Dataflow, this can also be used to indicate the methods used to convert the data structure from SDMX to VTL and vice-versa. Finally, this can be used to override the deault Basic mapping methods used for Dataflows by utilizing the GenericDataflow element in place of a reference to a specific Dataflow.

Derivation:

*`AnnotableType`*` (extension)`

7228

*`IdentifiableType`*` (extension)`

7229

*`NameableType`*` (restriction)`

7230

*`ItemBaseType`*` (extension)`

7231

*`ItemType`*` (restriction)`

7232

*`UnnestedItemType`*` (restriction)`

7233

*`VtlMappingBaseType`*` (extension)`

`VtlMappingType`

Attributes:

`id, urn?, uri?, alias`

Content:

`Annotations?, Link*, Name+, Description*, ( ( (Dataflow | GenericDataflow), ToVtlMapping?, FromVtlMapping?) | Codelist | Concept)`

7243

7244

Attribute Documentation:

7245

7246

| **Name** | **Type** | **Documentation** |

7247

| --- --| --- --| --- --|

7248

| id | IDType | The id is the identifier for the object. |

7249

| urn | VtlMappingUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7250

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7251

| 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. |

7252

7253

Element Documentation:

7254

7255

| **Name** | **Type** | **Documentation** |

7256

| --- --| --- --| --- --|

7257

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7258

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7259

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7260

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7261

| Dataflow | DataflowReferenceTyp e | A reference to the SDMX Dataflow that the mapping is defined for. This is used to create a VtlDataflowMapping. In this case, it is possible to specify the mapping details to and from VTL. |

7262

| GenericDataflow | EmptyType | Indicates that the ToVtlMapping and FromVtlMapping are the default mapping methods to be applied, overriding the Basic methods if necessary. The mapping methods in this case would be applied to any dataflows that are not explicitly defined in other VtlMappings. |

7263

| ToVtlMapping | ToVtlMappingType | Describes the mapping from a SDMX dataflow to a VTL data structure. |

7264

| FromVtlMapping | FromVtlMappingType | Describes the mapping to a SDMX dataflow from a VTL data structure. |

7265

| Codelist | CodelistReferenceTyp e | A reference to the SDMX Codelist that the mapping is defined for. This is used to create a VtlCodelistMapping. |

7266

| Concept | ConceptReferenceType | A reference to the SDMX Concept that the mapping is defined for. This is used to create a VtlConceptMapping. |

7267

7268

**ToVtlMappingType:** ToVtlMappingType defines the mapping method and filter used when mapping from SDMX to VTL.

Attributes:

`method?`

Content:

`ToVtlSubSpace?`

Attribute Documentation:

7279

7280

| **Name** | **Type** | **Documentation** |

7281

| --- --| --- --| --- --|

7282

| 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. |

7283

7284

Element Documentation:

7285

7286

| **Name** | **Type** | **Documentation** |

7287

| --- --| --- --| --- --|

7288

| 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. |

7289

7290

**FromVtlMappingType:** FromVtlMappingType defines the mapping method and filter used when mapping from VTL to SDMX.

Attributes:

`method?`

Content:

`FromVtlSuperSpace?`

Attribute Documentation:

7301

7302

| **Name** | **Type** | **Documentation** |

7303

| --- --| --- --| --- --|

7304

| 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. |

7305

7306

Element Documentation:

7307

7308

| **Name** | **Type** | **Documentation** |

7309

| --- --| --- --| --- --|

7310

| 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. |

7311

7312

**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.

Content:

`Key+`

Element Documentation:

7319

7320

| **Name** | **Type** | **Documentation** |

7321

| --- --| --- --| --- --|

7322

| Key | SingleNCNameIDType | A reference to a dimension by its identifier. |

7323

7324

**NamePersonalisationSchemeType:** NamePersonalisationSchemeType defines a set of personalisations of VTL standard names that are used in a set of transformations.

Derivation:

*`AnnotableType`*` (extension)`

7329

*`IdentifiableType`*` (extension)`

7330

*`NameableType`*` (extension)`

7331

*`VersionableType`*` (restriction)`

7332

*`MaintainableBaseType`*` (extension)`

7333

*`MaintainableType`*` (extension)`

7334

*`ItemSchemeType`*` (extension)`

7335

*`VtlDefinitionSchemeType`*` (restriction)`

7336

`NamePersonalisationSchemeType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`

Content:

`Annotations?, Link*, Name+, Description*, NamePersonalisation*`

7345

7346

Attribute Documentation:

7347

7348

| **Name** | **Type** | **Documentation** |

7349

| --- --| --- --| --- --|

7350

| id | IDType | The id is the identifier for the object. |

7351

| urn | NamePersonalisationS chemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7352

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7353

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

7354

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

7355

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

7356

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

7357

| 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. |

7358

| 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. |

7359

| 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. |

7360

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

7361

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

7362

| 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. |

7363

7364

Element Documentation:

7365

7366

| **Name** | **Type** | **Documentation** |

7367

| --- --| --- --| --- --|

7368

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7369

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7370

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7371

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7372

| NamePersonalisation | NamePersonalisationT ype | NamePersonalisation details a name personalisation that is used in a transformation. |

7373

7374

***NamePersonalisationBaseType*:** NamePersonalisationBaseType defines the base refinement of the NamePersonalisationType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

7379

*`IdentifiableType`*` (extension)`

7380

*`NameableType`*` (restriction)`

7381

*`ItemBaseType`*` (extension)`

7382

*`ItemType`*` (restriction)`

7383

*`UnnestedItemType`*` (restriction)`

7384

*`NamePersonalisationBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

7393

7394

Attribute Documentation:

7395

7396

| **Name** | **Type** | **Documentation** |

7397

| --- --| --- --| --- --|

7398

| id | IDType | The id is the identifier for the object. |

7399

| urn | NamePersonalisationU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7400

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7401

7402

Element Documentation:

7403

7404

| **Name** | **Type** | **Documentation** |

7405

| --- --| --- --| --- --|

7406

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7407

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7408

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7409

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7410

7411

**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.

Derivation:

*`AnnotableType`*` (extension)`

7416

*`IdentifiableType`*` (extension)`

7417

*`NameableType`*` (restriction)`

7418

*`ItemBaseType`*` (extension)`

7419

*`ItemType`*` (restriction)`

7420

*`UnnestedItemType`*` (restriction)`

7421

*`NamePersonalisationBaseType`*` (extension)`

7422

`NamePersonalisationType`

Attributes:

`id, urn?, uri?, vtlArtefact`

Content:

`Annotations?, Link*, Name+, Description*, VtlDefaultName, PersonalisedName`

7431

7432

Attribute Documentation:

7433

7434

| **Name** | **Type** | **Documentation** |

7435

| --- --| --- --| --- --|

7436

| id | IDType | The id is the identifier for the object. |

7437

| urn | NamePersonalisationU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7438

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7439

| vtlArtefact | xs:string | Identifies the type of VTL model artefact that is being personalised. In VTL 2.0, this is valuedomain or variable. |

7440

7441

Element Documentation:

7442

7443

| **Name** | **Type** | **Documentation** |

7444

| --- --| --- --| --- --|

7445

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7446

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7447

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7448

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7449

| VtlDefaultName | xs:string | Provides the VTL standard name that is being personalised. |

7450

| PersonalisedName | xs:string | Provides the personalised name that is used in place of the VTL standard name in the transformation expressions. |

7451

7452

***RulesetSchemeBaseType*:** RulesetSchemeBaseType is an abstract base type for the RulesetSchemeType. It restricts the item types to be only rulesets.

Derivation:

*`AnnotableType`*` (extension)`

7457

*`IdentifiableType`*` (extension)`

7458

*`NameableType`*` (extension)`

7459

*`VersionableType`*` (restriction)`

7460

*`MaintainableBaseType`*` (extension)`

7461

*`MaintainableType`*` (extension)`

7462

*`ItemSchemeType`*` (extension)`

7463

*`VtlDefinitionSchemeType`*` (restriction)`

7464

*`RulesetSchemeBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`

Content:

`Annotations?, Link*, Name+, Description*, Ruleset*`

7473

7474

Attribute Documentation:

7475

7476

| **Name** | **Type** | **Documentation** |

7477

| --- --| --- --| --- --|

7478

| id | IDType | The id is the identifier for the object. |

7479

| urn | RulesetSchemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7480

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7481

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

7482

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

7483

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

7484

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

7485

| 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. |

7486

| 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. |

7487

| 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. |

7488

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

7489

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

7490

| 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. |

7491

7492

Element Documentation:

7493

7494

| **Name** | **Type** | **Documentation** |

7495

| --- --| --- --| --- --|

7496

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7497

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7498

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7499

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7500

| Ruleset | RulesetType | Ruleset details a ruleset within a ruleset scheme. |

7501

7502

**RulesetSchemeType:** RulesetSchemeType defines a collection of rulesets that are used in transformations.

Derivation:

*`AnnotableType`*` (extension)`

7507

*`IdentifiableType`*` (extension)`

7508

*`NameableType`*` (extension)`

7509

*`VersionableType`*` (restriction)`

7510

*`MaintainableBaseType`*` (extension)`

7511

*`MaintainableType`*` (extension)`

7512

*`ItemSchemeType`*` (extension)`

7513

*`VtlDefinitionSchemeType`*` (restriction)`

7514

*`RulesetSchemeBaseType`*` (extension)`

`RulesetSchemeType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`

Content:

`Annotations?, Link*, Name+, Description*, Ruleset*, VtlMappingScheme?`

7524

7525

Attribute Documentation:

7526

7527

| **Name** | **Type** | **Documentation** |

7528

| --- --| --- --| --- --|

7529

| id | IDType | The id is the identifier for the object. |

7530

| urn | RulesetSchemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7531

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7532

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

7533

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

7534

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

7535

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

7536

| 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. |

7537

| 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. |

7538

| 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. |

7539

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

7540

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

7541

| 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. |

7542

7543

Element Documentation:

7544

7545

| **Name** | **Type** | **Documentation** |

7546

| --- --| --- --| --- --|

7547

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7548

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7549

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7550

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7551

| Ruleset | RulesetType | Ruleset details a ruleset within a ruleset scheme. |

7552

| VtlMappingScheme | VtlMappingSchemeRefe renceType | References a VTL mapping scheme which defines aliases for given SDMX artefacts that are used in the rulesets. Rulesets defined on value domains reference Codelists or Concept Schemes (the latter in VTL are considered as the Value Domains of the variables corresponding to the SDMX Measure Dimensions). The rulesets defined on variables reference Concepts (for which a definite representation is assumed). Therefore, a ruleset should only refer to Codelists, Concept Schemes, and Concepts. |

7553

7554

***RulesetBaseType*:** RulesetBaseType defines the base refinement of the RulesetType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

7559

*`IdentifiableType`*` (extension)`

7560

*`NameableType`*` (restriction)`

7561

*`ItemBaseType`*` (extension)`

7562

*`ItemType`*` (restriction)`

7563

*`UnnestedItemType`*` (restriction)`

*`RulesetBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

7573

7574

Attribute Documentation:

7575

7576

| **Name** | **Type** | **Documentation** |

7577

| --- --| --- --| --- --|

7578

| id | IDType | The id is the identifier for the object. |

7579

| urn | RulesetUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7580

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7581

7582

Element Documentation:

7583

7584

| **Name** | **Type** | **Documentation** |

7585

| --- --| --- --| --- --|

7586

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7587

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7588

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7589

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7590

7591

**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.

Derivation:

*`AnnotableType`*` (extension)`

7596

*`IdentifiableType`*` (extension)`

7597

*`NameableType`*` (restriction)`

7598

*`ItemBaseType`*` (extension)`

7599

*`ItemType`*` (restriction)`

7600

*`UnnestedItemType`*` (restriction)`

7601

*`RulesetBaseType`*` (extension)`

`RulesetType`

Attributes:

`id, urn?, uri?, rulesetType, rulesetScope`

Content:

`Annotations?, Link*, Name+, Description*, RulesetDefinition`

7611

7612

Attribute Documentation:

7613

7614

| **Name** | **Type** | **Documentation** |

7615

| --- --| --- --| --- --|

7616

| id | IDType | The id is the identifier for the object. |

7617

| urn | RulesetUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7618

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7619

| rulesetType | xs:string | The VTL type of the ruleset. In VTL 2.0, this is datapoint or hierarchical |

7620

| rulesetScope | xs:string | This model artefact on which the ruleset is defined. In VTL 2.0, this is value domain or variable. |

7621

7622

Element Documentation:

7623

7624

| **Name** | **Type** | **Documentation** |

7625

| --- --| --- --| --- --|

7626

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7627

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7628

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7629

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7630

| RulesetDefinition | xs:string | A VTL statement for the definition of a ruleset. This must conform to the syntax of the VTL definition language. |

7631

7632

***UserDefinedOperatorSchemeBaseType*:** UserDefinedOperatorSchemeBaseType is an abstract base type for the UserDefinedOperatorSchemeType. It restricts the item types to be only user defined operators.

Derivation:

*`AnnotableType`*` (extension)`

7637

*`IdentifiableType`*` (extension)`

7638

*`NameableType`*` (extension)`

7639

*`VersionableType`*` (restriction)`

7640

*`MaintainableBaseType`*` (extension)`

7641

*`MaintainableType`*` (extension)`

7642

*`ItemSchemeType`*` (extension)`

7643

*`VtlDefinitionSchemeType`*` (restriction)`

7644

*`UserDefinedOperatorSchemeBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`

Content:

`Annotations?, Link*, Name+, Description*, UserDefinedOperator*`

7653

7654

Attribute Documentation:

7655

7656

| **Name** | **Type** | **Documentation** |

7657

| --- --| --- --| --- --|

7658

| id | IDType | The id is the identifier for the object. |

7659

| urn | UserDefinedOperatorS chemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7660

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7661

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

7662

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

7663

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

7664

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

7665

| 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. |

7666

| 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. |

7667

| 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. |

7668

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

7669

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

7670

| 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. |

7671

7672

Element Documentation:

7673

7674

| **Name** | **Type** | **Documentation** |

7675

| --- --| --- --| --- --|

7676

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7677

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7678

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7679

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7680

| UserDefinedOperator | UserDefinedOperatorT ype | UserDefinedOperator details a user defined operators within a user defined operator scheme. |

7681

7682

**UserDefinedOperatorSchemeType:** UserDefinedOperatorSchemeType defines a collection of user defined operators that are used in transformations.

Derivation:

*`AnnotableType`*` (extension)`

7687

*`IdentifiableType`*` (extension)`

7688

*`NameableType`*` (extension)`

7689

*`VersionableType`*` (restriction)`

7690

*`MaintainableBaseType`*` (extension)`

7691

*`MaintainableType`*` (extension)`

7692

*`ItemSchemeType`*` (extension)`

7693

*`VtlDefinitionSchemeType`*` (restriction)`

7694

*`UserDefinedOperatorSchemeBaseType`*` (extension)`

7695

`UserDefinedOperatorSchemeType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`

Content:

`Annotations?, Link*, Name+, Description*, UserDefinedOperator*, VtlMappingScheme?, RulesetScheme*`

7704

7705

Attribute Documentation:

7706

7707

| **Name** | **Type** | **Documentation** |

7708

| --- --| --- --| --- --|

7709

| id | IDType | The id is the identifier for the object. |

7710

| urn | UserDefinedOperatorS chemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7711

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7712

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

7713

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

7714

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

7715

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

7716

| 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. |

7717

| 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. |

7718

| 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. |

7719

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

7720

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

7721

| 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. |

7722

7723

Element Documentation:

7724

7725

| **Name** | **Type** | **Documentation** |

7726

| --- --| --- --| --- --|

7727

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7728

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7729

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7730

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7731

| UserDefinedOperator | UserDefinedOperatorT ype | UserDefinedOperator details a user defined operators within a user defined operator scheme. |

7732

| VtlMappingScheme | VtlMappingSchemeRefe renceType | References a VTL mapping scheme which defines aliases for given SDMX artefacts that are used in the user defined operators. Although the VTL user defined operators are conceived to be defined on generic operands, so that the specific artefacts to be manipulated are passed as parameters at the invocation, it is also possible that they reference specific SDMX artefacts like Dataflows, Codelists and ConceptSchemes. In this case, the mapping schemes referenced here define the mappings to those artefacts. |

7733

| RulesetScheme | RulesetSchemeReferen ceType | References a ruleset scheme defining rulesets utilized in the user defined operators. |

7734

7735

***UserDefinedOperatorBaseType*:** UserDefinedOperatorBaseType defines the base refinement of the UserDefinedOperatorType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

7740

*`IdentifiableType`*` (extension)`

7741

*`NameableType`*` (restriction)`

7742

*`ItemBaseType`*` (extension)`

7743

*`ItemType`*` (restriction)`

7744

*`UnnestedItemType`*` (restriction)`

7745

*`UserDefinedOperatorBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

7754

7755

Attribute Documentation:

7756

7757

| **Name** | **Type** | **Documentation** |

7758

| --- --| --- --| --- --|

7759

| id | IDType | The id is the identifier for the object. |

7760

| urn | UserDefinedOperatorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7761

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7762

7763

Element Documentation:

7764

7765

| **Name** | **Type** | **Documentation** |

7766

| --- --| --- --| --- --|

7767

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7768

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7769

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7770

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7771

7772

**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.

Derivation:

*`AnnotableType`*` (extension)`

7777

*`IdentifiableType`*` (extension)`

7778

*`NameableType`*` (restriction)`

7779

*`ItemBaseType`*` (extension)`

7780

*`ItemType`*` (restriction)`

7781

*`UnnestedItemType`*` (restriction)`

7782

*`UserDefinedOperatorBaseType`*` (extension)`

7783

`UserDefinedOperatorType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, OperatorDefinition`

7792

7793

Attribute Documentation:

7794

7795

| **Name** | **Type** | **Documentation** |

7796

| --- --| --- --| --- --|

7797

| id | IDType | The id is the identifier for the object. |

7798

| urn | UserDefinedOperatorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7799

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7800

7801

Element Documentation:

7802

7803

| **Name** | **Type** | **Documentation** |

7804

| --- --| --- --| --- --|

7805

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7806

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7807

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7808

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7809

| 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. |

7810

7811

**CustomTypeSchemeType:** CustomTypeSchemeType defines a collection of custom types that are used in transformations.

Derivation:

*`AnnotableType`*` (extension)`

7816

*`IdentifiableType`*` (extension)`

7817

*`NameableType`*` (extension)`

7818

*`VersionableType`*` (restriction)`

7819

*`MaintainableBaseType`*` (extension)`

7820

*`MaintainableType`*` (extension)`

7821

*`ItemSchemeType`*` (extension)`

7822

*`VtlDefinitionSchemeType`*` (restriction)`

7823

`CustomTypeSchemeType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`

Content:

`Annotations?, Link*, Name+, Description*, CustomType*`

7832

7833

Attribute Documentation:

7834

7835

| **Name** | **Type** | **Documentation** |

7836

| --- --| --- --| --- --|

7837

| id | IDType | The id is the identifier for the object. |

7838

| urn | CustomTypeSchemeUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7839

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7840

| version | VersionType | This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. |

7841

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

7842

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

7843

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

7844

| 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. |

7845

| 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. |

7846

| 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. |

7847

| isPartialLanguage (default: false) | xs:boolean | The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header ‘Accept-Language’. |

7848

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

7849

| 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. |

7850

7851

Element Documentation:

7852

7853

| **Name** | **Type** | **Documentation** |

7854

| --- --| --- --| --- --|

7855

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7856

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7857

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7858

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7859

| CustomType | CustomTypeType | CustomType details a custom type within a custom type scheme. |

7860

7861

***CustomTypeBaseType*:** CustomTypeBaseType defines the base refinement of the CustomTypeType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

7866

*`IdentifiableType`*` (extension)`

7867

*`NameableType`*` (restriction)`

7868

*`ItemBaseType`*` (extension)`

7869

*`ItemType`*` (restriction)`

7870

*`UnnestedItemType`*` (restriction)`

7871

*`CustomTypeBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

7880

7881

Attribute Documentation:

7882

7883

| **Name** | **Type** | **Documentation** |

7884

| --- --| --- --| --- --|

7885

| id | IDType | The id is the identifier for the object. |

7886

| urn | CustomTypeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7887

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7888

7889

Element Documentation:

7890

7891

| **Name** | **Type** | **Documentation** |

7892

| --- --| --- --| --- --|

7893

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7894

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7895

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7896

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7897

7898

**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.

Derivation:

*`AnnotableType`*` (extension)`

7903

*`IdentifiableType`*` (extension)`

7904

*`NameableType`*` (restriction)`

7905

*`ItemBaseType`*` (extension)`

7906

*`ItemType`*` (restriction)`

7907

*`UnnestedItemType`*` (restriction)`

7908

*`CustomTypeBaseType`*` (extension)`

`CustomTypeType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, VtlScalarType, DataType, VtlLiteralFormat?, OutputFormat?, NullValue?`

7918

7919

Attribute Documentation:

7920

7921

| **Name** | **Type** | **Documentation** |

7922

| --- --| --- --| --- --|

7923

| id | IDType | The id is the identifier for the object. |

7924

| urn | CustomTypeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7925

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7926

7927

Element Documentation:

7928

7929

| **Name** | **Type** | **Documentation** |

7930

| --- --| --- --| --- --|

7931

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7932

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7933

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7934

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7935

| VtlScalarType | xs:string | Identifies the VTL scalar type that is to be converted to an resulting output data type. |

7936

| 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. |

7937

| 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. |

7938

| 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. |

7939

| NullValue | xs:string | The value to be produced in the output of the conversion when a component has a null value. |

7940

7941

### 2.1.4 Simple Types##

7942

7943

**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.

7944

7945

Derived by restriction of `SimpleDataType`.

Enumerations:

| **Value** | **Documentation** |

7950

| --- --| --- --|

7951

| String | A string datatype corresponding to W3C XML Schema's xs:string datatype. |

7952

| Alpha | A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z. |

7953

| 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. |

7954

| 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. |

7955

| BigInteger | An integer datatype corresponding to W3C XML Schema's xs:integer datatype. |

7956

| Integer | An integer datatype corresponding to W3C XML Schema's xs:int datatype. |

7957

| Long | A numeric datatype corresponding to W3C XML Schema's xs:long datatype. |

7958

| Short | A numeric datatype corresponding to W3C XML Schema's xs:short datatype. |

7959

| Boolean | A datatype corresponding to W3C XML Schema's xs:boolean datatype. |

7960

| URI | A datatype corresponding to W3C XML Schema's xs:anyURI datatype. |

7961

| Count | A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1". |

7962

| InclusiveValueRange | This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal. |

7963

| ExclusiveValueRange | This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal. |

7964

| Incremental | This value indicates that the value increments according to the value provided in the interval facet, and has a true value for the isSequence facet. |

7965

| ObservationalTimePeriod | Observational time periods are the superset of all time periods in SDMX. It is the union of the standard time periods (i.e. Gregorian time periods, the reporting time periods, and date time) and a time range. |

7966

| StandardTimePeriod | Standard time periods is a superset of distinct time period in SDMX. It is the union of the basic time periods (i.e. the Gregorian time periods and date time) and the reporting time periods. |

7967

| BasicTimePeriod | BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time. |

7968

| GregorianTimePeriod | Gregorian time periods correspond to calendar periods and are represented in ISO-8601 formats. This is the union of the year, year month, and date formats. |

7969

| GregorianYear | A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601. |

7970

| GregorianYearMonth | A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601. |

7971

| GregorianDay | A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601. |

7972

| ReportingTimePeriod | Reporting time periods represent periods of a standard length within a reporting year, where to start of the year (defined as a month and day) must be defined elsewhere or it is assumed to be January 1. This is the union of the reporting year, semester, trimester, quarter, month, week, and day. |

7973

| ReportingYear | A reporting year represents a period of 1 year (P1Y) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingYearType. |

7974

| ReportingSemester | A reporting semester represents a period of 6 months (P6M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingSemesterType. |

7975

| ReportingTrimester | A reporting trimester represents a period of 4 months (P4M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingTrimesterType. |

7976

| ReportingQuarter | A reporting quarter represents a period of 3 months (P3M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingQuarterType. |

7977

| ReportingMonth | A reporting month represents a period of 1 month (P1M) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingMonthType. |

7978

| ReportingWeek | A reporting week represents a period of 7 days (P7D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingWeekType. |

7979

| ReportingDay | A reporting day represents a period of 1 day (P1D) from the start date of the reporting year. This is expressed as using the SDMX specific ReportingDayType. |

7980

| Month | A time datatype corresponding to W3C XML Schema's xs:gMonth datatype. |

7981

| MonthDay | A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype. |

7982

| Day | A time datatype corresponding to W3C XML Schema's xs:gDay datatype. |

7983

| Duration | A time datatype corresponding to W3C XML Schema's xs:duration datatype. |

7984

7985

**WildcardedMemberValueType:** WildcardedMemberValueType allows for an optional wildcard characters ('%') in an identifier.

7986

7987

Derived by restriction of `xs:string`.

7988

Regular Expression Pattern: `[A-Za-z0-9_@$-%]+`

7989

7990

**GeoCodelistTypeType:** GeoCodelistTypeType defines an enumeration of the speicfic types of geographic codelists.

7991

7992

Derived by restriction of `xs:string`.

Enumerations:

| **Value** | **Documentation** |

7997

| --- --| --- --|

7998

| GeographicCodelist | |

7999

| GeoGridCodelist | |

8000

8001

**ConstraintRoleType:** ConstraintRoleType defines a list of roles for a content constraint. A constraint can state which data is present or which content is allowed for the constraint attachment.

8002

8003

Derived by restriction of `xs:string`.

Enumerations:

| **Value** | **Documentation** |

8008

| --- --| --- --|

8009

| Allowed | The constraint contains the allowed values for attachable object. |

8010

| Actual | The constraints contains the actual data present for the attachable object. |

8011

8012

**SimpleOperatorType:** SimpleOperatorType provides an enumeration of simple operators to be applied to any value.

8013

8014

Derived by restriction of `xs:string`.

Enumerations:

| **Value** | **Documentation** |

8019

| --- --| --- --|

8020

| notEqual | (|=) - value must not be equal to the value supplied. |

8021

| equal | (=) - value must be exactly equal to the value supplied. |

8022

8023

**RangeOperatorType:** RangeOperatorType provides an enumeration of range operators to be applied to an ordered value.

8024

8025

Derived by restriction of `xs:string`.

Enumerations:

| **Value** | **Documentation** |

8030

| --- --| --- --|

8031

| greaterThanOrEqual | (>=) - value must be greater than or equal to the value supplied. |

8032

| lessThanOrEqual | (<=) - value must be less than or equal to the value supplied. |

8033

| greaterThan | (>) - value must be greater than the value supplied. |

8034

| lessThan | (<) - value must be less than the value supplied. |

8035

8036

**TextSearchOperatorType:** TextSearchOperatorType provides an enumeration of text search operators.

8037

8038

Derived by restriction of `xs:string`.

Enumerations:

| **Value** | **Documentation** |

8043

| --- --| --- --|

8044

| contains | The text being searched must contain the supplied text. |

8045

| startsWith | The text being searched must start with the supplied text. |

8046

| endsWith | The text being searched must end with the supplied text. |

8047

| doesNotContain | The text being searched cannot contain the supplied text. |

8048

| doesNotStartWith | The text being searched cannot start with the supplied text. |

8049

| doesNotEndWith | The text being searched cannot end with the supplied text. |

8050

8051

**OrderedOperatorType:** OrderedOperatorType combines the SimpleOperatorType and the RangeOperatorType to provide a full range or operators for any ordered value.

Union of:

`SimpleOperatorType, RangeOperatorType`.

8056

8057

**TextOperatorType:**

Union of:

`SimpleOperatorType, TextSearchOperatorType`.

8062

8063

**TimeOperatorType:** TimeOperatorType derives from the OrderedOperatorType to remove the notEqual operator.

8064

8065

Derived by restriction of `OrderedOperatorType`.

Enumerations:

| **Value** | **Documentation** |

8070

| --- --| --- --|

8071

| equal | |

8072

| greaterThanOrEqual | |

8073

| lessThanOrEqual | |

| greaterThan | |

| lessThan | |

**UsageType:** An enumeration of optional | mandatory to indicate the usage of an attribute or measure.

8078

8079

Derived by restriction of `xs:string`.

Enumerations:

| **Value** | **Documentation** |

| --- --| --- --|

| mandatory | |

| optional | |

**SimpleCodeDataType:** SimpleCodeDataType restricts SimpleDataType to specify the allowable data types for a simple code. The possible values are simply Alpha, AlphaNumeric, or Numeric.

8089

8090

Derived by restriction of `SimpleDataType`.

Enumerations:

| **Value** | **Documentation** |

8095

| --- --| --- --|

8096

| Alpha | A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z. |

8097

| 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. |

8098

| 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. |

8099

8100

**EpochPeriodType:** EpochPeriodType defines an enumeration of epoch period types.

8101

8102

Derived by restriction of `xs:string`.

Enumerations:

| **Value** | **Documentation** |

| --- --| --- --|

| nanosecond | |

| millisecond | |

| microsecond | |

| second | |

| day | |

**ResolvePeriodType:** ResolvePeriodType defines an enumeration of how date periods should be resolved.

8115

8116

Derived by restriction of `xs:string`.

Enumerations:

| **Value** | **Documentation** |

| --- --| --- --|

| startOfPeriod | |

| endOfPeriod | |

| midPeriod | |

**StandardToVtlMappingMethodType:** A simple type enumerating the standard mapping methods when converting from data structures from SDMX to VLT.

8127

8128

Derived by restriction of `xs:string`.

Enumerations:

| **Value** | **Documentation** |

8133

| --- --| --- --|

8134

| Basic | The default mapping method. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.1 ("Basic Mapping"). |

8135

| Pivot | Method for mapping multi-measure data. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.2 ("Pivot Mapping"). |

8136

| 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"). |

8137

| 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"). |

8138

8139

**ToVtlMappingMethodType:** A simple type that allows for a standard to VTL mapping method enumeration value or a string value for other mapping methods.

Union of:

`StandardToVtlMappingMethodType, xs:string`.

8144

8145

**StandardFromVtlMappingMethodType:** A simple type enumerating the standard mapping methods when converting from data structures from VTL to SDMX.

8146

8147

Derived by restriction of `xs:string`.

Enumerations:

| **Value** | **Documentation** |

8152

| --- --| --- --|

8153

| 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"). |

8154

| 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"). |

8155

| 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"). |

8156

8157

**FromVtlMappingMethodType:** A simple type that allows for standard from VTL mapping method enumeration value or a string value for other mapping methods.

Union of:

`StandardFromVtlMappingMethodType, xs:string`.

8162

8163

**CustomTypeDataType:** A simple type that allows for a SDMX simple data type enumeration value or a string value for other data types.

Union of:

`SimpleDataType, xs:string`.

Wiki source code of Part III. Structure