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

(% style="width:1042.29px" %)

22

|(% style="width:559px" %) **Namespace** |(% style="width:481px" %) **Prefix**

23

|(% style="width:559px" %) http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|(% style="width:481px" %) common

24

|(% style="width:559px" %) http://www.w3.org/2001/XMLSchema>|(% style="width:481px" %) xs

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

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

200

| Categorisations | CategorisationsType | Categorisations contains a collection of structural object categorisations. This container may contain categorisations for many types of objects. The categorisations may be detailed in full, or referenced from an external structure document or registry service. |

201

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

202

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

203

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

204

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

205

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

206

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

207

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

208

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

209

| Dataflows | DataflowsType | Dataflows contains a collection of data flow descriptions. The data flows may be detailed in full, or referenced from an external structure document or registry service. |

210

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

211

| DataStructures | DataStructuresType | DataStructures contains a collection of data structure definitions. The data structure definitions may be detailed in full, or referenced from an external structure document or registry service. |

212

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

213

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

214

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

215

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

216

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

217

| Metadataflows | MetadataflowsType | Metadataflows contains a collection of metadata flow descriptions. The metadata flows may be detailed in full, or referenced from an external structure document or registry service. |

218

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

219

| MetadataProvisionAgreements | MetadataProvisionAgreementsType | ProvisionAgreements contains a collection of provision agreements. The provision agreements may be detailed in full, or referenced from an external structure document or registry service. |

220

| MetadataStructures | MetadataStructuresType | MetadataStructures contains a collection of metadata structure definition descriptions. The metadata structure definitions may be detailed in full, or referenced from an external structure document or registry service. |

221

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

222

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

223

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

224

| Processes | ProcessesType | Processes contains a collection of process descriptions. The processes may be detailed in full, or referenced from an external structure document or registry service. |

225

| ProvisionAgreements | ProvisionAgreementsType | ProvisionAgreements contains a collection of provision agreements. The provision agreements may be detailed in full, or referenced from an external structure document or registry service. |

226

| ReportingTaxonomies | ReportingTaxonomiesType | ReportingTaxonomies contains a collection of reporting taxonomy descriptions. The reporting taxonomies may be detailed in full, or referenced from an external structure document or registry service. |

227

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

228

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

229

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

230

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

231

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

232

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

233

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

234

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

235

236

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

Content:

`AgencyScheme+`

Element Documentation:

242

243

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

244

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

245

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

246

247

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

253

254

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

255

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

256

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

257

258

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

265

266

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

267

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

268

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

269

270

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

276

277

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

278

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

279

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

280

281

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

287

288

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

289

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

290

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

291

292

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

299

300

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

301

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

302

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

303

304

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

310

311

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

312

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

313

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

314

315

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

322

323

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

324

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

325

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

326

327

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

334

335

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

336

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

337

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

338

339

**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+`

344

345

Element Documentation:

346

347

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

348

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

349

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

350

351

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

358

359

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

360

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

361

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

362

363

**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+`

368

369

Element Documentation:

370

371

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

372

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

373

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

374

375

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

382

383

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

384

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

385

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

386

387

**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+`

392

393

Element Documentation:

394

395

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

396

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

397

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

398

399

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

406

407

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

408

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

409

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

410

411

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

418

419

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

420

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

421

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

422

423

**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+`

428

429

Element Documentation:

430

431

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

432

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

433

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

434

435

**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+`

440

441

Element Documentation:

442

443

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

444

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

445

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

446

447

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

454

455

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

456

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

457

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

458

459

**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+`

464

465

Element Documentation:

466

467

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

468

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

469

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

470

471

**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+`

476

477

Element Documentation:

478

479

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

480

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

481

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

482

483

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

490

491

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

492

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

493

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

494

495

**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+`

500

501

Element Documentation:

502

503

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

504

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

505

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

506

507

**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+`

512

513

Element Documentation:

514

515

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

516

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

517

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

518

519

**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+`

524

525

Element Documentation:

526

527

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

528

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

529

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

530

531

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

538

539

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

540

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

541

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

542

543

**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+`

548

549

Element Documentation:

550

551

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

552

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

553

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

554

555

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

562

563

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

564

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

565

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

566

567

**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+`

572

573

Element Documentation:

574

575

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

576

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

577

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

578

579

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

586

587

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

588

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

589

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

590

591

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

598

599

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

600

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

601

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

602

603

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

610

611

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

612

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

613

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

614

615

**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+`

620

621

Element Documentation:

622

623

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

624

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

625

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

626

627

**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+`

632

633

Element Documentation:

634

635

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

636

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

637

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

638

639

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

646

647

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

648

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

649

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

650

651

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

658

659

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

660

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

661

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

662

663

***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)`

668

*`IdentifiableType`*` (extension)`

669

*`NameableType`*` (extension)`

670

*`VersionableType`*` (restriction)`

671

*`MaintainableBaseType`*` (extension)`

672

*`MaintainableType`*` (extension)`

*`ItemSchemeType`*

Attributes:

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

Content:

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

682

683

Attribute Documentation:

684

685

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

686

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

687

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

688

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

689

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

690

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

691

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

692

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

693

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

694

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

695

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

696

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

697

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

698

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

699

700

Element Documentation:

701

702

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

703

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

704

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

705

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

706

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

707

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

708

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

709

710

***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)`

715

*`IdentifiableType`*` (extension)`

716

*`NameableType`*` (restriction)`

*`ItemBaseType`*

Attributes:

`id, urn?, uri?`

Content:

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

726

727

Attribute Documentation:

728

729

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

730

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

731

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

732

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

733

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

734

735

Element Documentation:

736

737

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

738

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

739

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

740

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

741

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

742

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

743

744

***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)`

749

*`IdentifiableType`*` (extension)`

750

*`NameableType`*` (restriction)`

751

*`ItemBaseType`*` (extension)`

*`ItemType`*

Attributes:

`id, urn?, uri?`

Content:

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

759

760

Attribute Documentation:

761

762

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

763

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

764

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

765

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

766

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

767

768

Element Documentation:

769

770

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

771

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

772

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

773

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

774

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

775

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

776

| Parent | NestedIDType | |

777

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

778

779

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

Derivation:

*`AnnotableType`* `(extension)`

784

*`IdentifiableType`*` (extension)`

785

*`NameableType`* `(restriction)`

786

*`ItemBaseType`*` (extension)`

787

*`ItemType`*` (restriction)`

*`UnnestedItemType`*

Attributes:

`id, urn?, uri?`

Content:

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

796

797

Attribute Documentation:

798

799

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

800

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

801

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

802

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

803

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

804

805

Element Documentation:

806

807

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

808

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

809

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

810

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

811

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

812

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

813

814

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

Derivation:

*`AnnotableType`*` (extension)`

819

*`IdentifiableType`*` (extension)`

820

*`NameableType`*` (extension)`

821

*`VersionableType`*` (restriction)`

822

*`MaintainableBaseType`*` (extension)`

823

*`MaintainableType`*` (extension)`

*`StructureType`*

Attributes:

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

Content:

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

833

834

Attribute Documentation:

835

836

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

837

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

838

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

839

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

840

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

841

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

842

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

843

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

844

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

845

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

846

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

847

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

848

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

849

850

Element Documentation:

851

852

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

853

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

854

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

855

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

856

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

857

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

858

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

859

860

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

867

868

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

869

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

870

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

871

872

***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)`

877

*`IdentifiableType`*` (extension)`

878

*`ComponentListType`*

Attributes:

`id?, urn?, uri?`

Content:

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

887

888

Attribute Documentation:

889

890

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

891

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

892

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

893

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

894

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

895

896

Element Documentation:

897

898

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

899

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

900

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

901

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

902

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

903

904

***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)`

909

*`IdentifiableType`*` (restriction)`

910

*`ComponentBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*`

919

920

Attribute Documentation:

921

922

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

923

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

924

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

925

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

926

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

927

928

Element Documentation:

929

930

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

931

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

932

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

933

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

934

935

***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)`

940

*`IdentifiableType`*` (restriction)`

941

*`ComponentBaseType`*` (extension)`

*`ComponentType`*

Attributes:

`id?, urn?, uri?`

Content:

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

951

952

Attribute Documentation:

953

954

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

955

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

956

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

957

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

958

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

959

960

Element Documentation:

961

962

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

963

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

964

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

965

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

966

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

967

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

968

969

***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)`

974

*`IdentifiableType`*` (extension)`

975

*`NameableType`*` (extension)`

976

*`VersionableType`*` (restriction)`

977

*`MaintainableBaseType`*` (extension)`

978

*`MaintainableType`*` (extension)`

979

*`StructureUsageType`*

Attributes:

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

Content:

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

988

989

Attribute Documentation:

990

991

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

992

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

993

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

994

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

995

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

996

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

997

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

998

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

999

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

1000

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

1001

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

1002

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

1003

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

1004

1005

Element Documentation:

1006

1007

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

1008

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

1009

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

1010

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

1011

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

1012

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

1013

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

1014

1015

***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?))`

1024

1025

Attribute Documentation:

1026

1027

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

1028

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

1029

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

1030

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

1031

1032

Element Documentation:

1033

1034

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

1035

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

1036

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

1037

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

1038

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

1039

1040

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

1051

1052

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

1053

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

1054

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

1055

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

1056

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

1057

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

1058

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

1059

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

1060

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

1061

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

1062

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

1063

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

1064

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

1065

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

1066

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

1067

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

1068

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

1069

1070

Element Documentation:

1071

1072

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

1073

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

1074

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

1075

1076

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

1085

1086

Attribute Documentation:

1087

1088

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

1089

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

1090

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

1091

1092

Element Documentation:

1093

1094

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

1095

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

1096

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

1097

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

1098

1099

**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)`

1104

`BasicComponentTextFormatType`

Attributes:

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

Content:

`SentinelValue*`

Attribute Documentation:

1115

1116

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

1117

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

1118

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

1119

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

1120

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

1121

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

1122

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

1123

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

1124

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

1125

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

1126

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

1127

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

1128

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

1129

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

1130

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

1131

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

1132

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

1133

1134

Element Documentation:

1135

1136

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

1137

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

1138

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

1139

1140

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

Derivation:

`TextFormatType (restriction)`

1145

`BasicComponentTextFormatType (restriction)`

1146

`SimpleComponentTextFormatType`

Attributes:

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

Content:

`SentinelValue*`

Attribute Documentation:

1157

1158

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

1159

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

1160

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

1161

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

1162

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

1163

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

1164

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

1165

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

1166

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

1167

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

1168

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

1169

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

1170

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

1171

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

1172

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

1173

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

1174

1175

Element Documentation:

1176

1177

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

1178

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

1179

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

1180

1181

**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)`

1186

`BasicComponentTextFormatType (restriction)`

1187

`SimpleComponentTextFormatType (restriction)`

1188

`CodedTextFormatType`

Attributes:

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

Content:

`{Empty}`

Attribute Documentation:

1199

1200

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

1201

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

1202

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

1203

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

1204

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

1205

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

1206

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

1207

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

1208

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

1209

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

1210

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

1211

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

1212

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

1213

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

1214

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

1215

1216

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

Derivation:

`TextFormatType (restriction)`

1221

`BasicComponentTextFormatType (restriction)`

1222

`SimpleComponentTextFormatType (restriction)`

1223

`NonFacetedTextFormatType`

Attributes:

`textType?`

Content:

`{Empty}`

Attribute Documentation:

1234

1235

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

1236

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

1237

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

1238

1239

**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)`

1244

`BasicComponentTextFormatType (restriction)`

1245

`SimpleComponentTextFormatType (restriction)`

`TimeTextFormatType`

Attributes:

`textType?, startTime?, endTime?`

Content:

`SentinelValue*`

Attribute Documentation:

1257

1258

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

1259

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

1260

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

1261

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

1262

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

1263

1264

Element Documentation:

1265

1266

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

1267

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

1268

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

1269

1270

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

Derivation:

*`AnnotableType`*` (extension)`

1275

*`IdentifiableType`*` (extension)`

1276

*`NameableType`*` (extension)`

1277

*`VersionableType`*` (restriction)`

1278

*`MaintainableBaseType`*` (extension)`

1279

*`MaintainableType`*` (restriction)`

1280

*`CategorisationBaseType`*

Attributes:

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

Content:

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

1289

1290

Attribute Documentation:

1291

1292

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

1293

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

1294

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

1295

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

1296

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

1297

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

1298

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

1299

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

1300

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

1301

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

1302

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

1303

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

1304

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

1305

1306

Element Documentation:

1307

1308

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

1309

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

1310

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

1311

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

1312

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

1313

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

1314

1315

**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)`

1320

*`IdentifiableType`*` (extension)`

1321

*`NameableType`*` (extension)`

1322

*`VersionableType`*` (restriction)`

1323

*`MaintainableBaseType`*` (extension)`

1324

*`MaintainableType`*` (restriction)`

1325

*`CategorisationBaseType`*` (extension)`

`CategorisationType`

Attributes:

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

Content:

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

1335

1336

Attribute Documentation:

1337

1338

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

1339

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

1340

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

1341

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

1342

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

1343

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

1344

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

1345

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

1346

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

1347

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

1348

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

1349

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

1350

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

1351

1352

Element Documentation:

1353

1354

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

1355

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

1356

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

1357

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

1358

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

1359

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

1360

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

1361

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

1362

1363

**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)`

1368

*`IdentifiableType`*` (extension)`

1369

*`NameableType`*` (extension)`

1370

*`VersionableType`*` (restriction)`

1371

*`MaintainableBaseType`*` (extension)`

1372

*`MaintainableType`*` (restriction)`

1373

*`ItemSchemeType`*` (restriction)`

`CategorySchemeType`

Attributes:

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

Content:

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

1383

1384

Attribute Documentation:

1385

1386

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

1387

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

1388

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

1389

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

1390

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

1391

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

1392

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

1393

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

1394

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

1395

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

1396

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

1397

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

1398

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

1399

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

1400

1401

Element Documentation:

1402

1403

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

1404

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

1405

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

1406

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

1407

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

1408

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

1409

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

1410

1411

**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)`

1416

*`IdentifiableType`*` (extension)`

1417

*`NameableType`*` (restriction)`

1418

*`ItemBaseType`*` (extension)`

1419

*`ItemType`*` (restriction)`

`CategoryType`

Attributes:

`id, urn?, uri?`

Content:

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

1429

1430

Attribute Documentation:

1431

1432

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

1433

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

1434

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

1435

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

1436

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

1437

1438

Element Documentation:

1439

1440

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

1441

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

1442

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

1443

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

1444

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

1445

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

1446

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

1447

1448

***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)`

1453

*`IdentifiableType`*` (extension)`

1454

*`NameableType`*` (extension)`

1455

*`VersionableType`*` (restriction)`

1456

*`MaintainableBaseType`*` (extension)`

1457

*`MaintainableType`*` (restriction)`

1458

*`ItemSchemeType`*` (restriction)`

*`CodelistBaseType`*

Attributes:

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

Content:

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

1468

1469

Attribute Documentation:

1470

1471

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

1472

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

1473

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

1474

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

1475

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

1476

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

1477

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

1478

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

1479

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

1480

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

1481

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

1482

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

1483

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

1484

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

1485

1486

Element Documentation:

1487

1488

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

1489

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

1490

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

1491

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

1492

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

1493

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

1494

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

1501

*`IdentifiableType`*` (extension)`

1502

*`NameableType`*` (extension)`

1503

*`VersionableType`*` (restriction)`

1504

*`MaintainableBaseType`*` (extension)`

1505

*`MaintainableType`*` (restriction)`

1506

*`ItemSchemeType`*` (restriction)`

1507

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

1517

1518

Attribute Documentation:

1519

1520

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

1521

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

1522

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

1523

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

1524

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

1525

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

1526

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

1527

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

1528

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

1529

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

1530

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

1531

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

1532

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

1533

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

1534

1535

Element Documentation:

1536

1537

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

1538

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

1539

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

1540

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

1541

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

1542

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

1543

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

1544

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

1545

1546

**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)`

1551

*`IdentifiableType`*` (extension)`

1552

*`NameableType`*` (restriction)`

1553

*`ItemBaseType`*` (extension)`

1554

*`ItemType`*` (restriction)`

`CodeType`

Attributes:

`id, urn?, uri?`

Content:

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

1564

1565

Attribute Documentation:

1566

1567

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

1568

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

1569

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

1570

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

1571

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

1572

1573

Element Documentation:

1574

1575

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

1576

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

1577

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

1578

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

1579

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

1580

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

1581

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

1582

1583

**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)?`

1592

1593

Attribute Documentation:

1594

1595

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

1596

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

1597

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

1598

1599

Element Documentation:

1600

1601

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

1602

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

1603

| Codelist | CodelistReferenceTyp e | |

1604

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

1605

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

1606

1607

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

Content:

`MemberValue+`

Element Documentation:

1614

1615

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

1616

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

1617

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

1618

1619

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

Derivation:

`xs:anySimpleType (restriction)`

1624

`xs:string (restriction)`

1625

`WildcardedMemberValueType (extension)`

`MemberValueType`

Attributes:

`cascadeValues?`

Content:

Attribute Documentation:

1635

1636

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

1637

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

1638

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

1639

1640

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

Derivation:

*`AnnotableType`*` (extension)`

1645

*`IdentifiableType`*` (extension)`

1646

*`NameableType`*` (extension)`

1647

*`VersionableType`*` (restriction)`

1648

*`MaintainableBaseType`*` (extension)`

1649

*`MaintainableType`*` (restriction)`

1650

*`ItemSchemeType`*` (restriction)`

1651

*`CodelistBaseType`*` (extension)`

1652

`CodelistType (restriction)`

1653

*`GeoCodelistBaseType`*

Attributes:

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

Content:

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

1662

1663

Attribute Documentation:

1664

1665

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

1666

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

1667

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

1668

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

1669

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

1670

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

1671

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

1672

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

1673

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

1674

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

1675

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

1676

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

1677

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

1678

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

1679

1680

Element Documentation:

1681

1682

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

1683

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

1684

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

1685

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

1686

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

1687

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

1688

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

1689

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

1690

1691

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

Derivation:

*`AnnotableType`*` (extension)`

1696

*`IdentifiableType`*` (extension)`

1697

*`NameableType`*` (extension)`

1698

*`VersionableType`*` (restriction)`

1699

*`MaintainableBaseType`*` (extension)`

1700

*`MaintainableType`*` (restriction)`

1701

*`ItemSchemeType`*` (restriction)`

1702

*`CodelistBaseType`*` (extension)`

1703

`CodelistType (restriction)`

1704

*`GeoCodelistBaseType`*` (extension)`

*`GeoCodelistType`*

Attributes:

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

Content:

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

1714

1715

Attribute Documentation:

1716

1717

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

1718

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

1719

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

1720

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

1721

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

1722

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

1723

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

1724

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

1725

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

1726

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

1727

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

1728

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

1729

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

1730

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

1731

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

1732

1733

Element Documentation:

1734

1735

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

1736

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

1737

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

1738

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

1739

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

1740

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

1741

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

1742

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

1743

1744

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

Derivation:

*`AnnotableType`*` (extension)`

1749

*`IdentifiableType`*` (extension)`

1750

*`NameableType`*` (restriction)`

1751

*`ItemBaseType`*` (extension)`

1752

*`ItemType`*` (restriction)`

1753

`CodeType (extension)`

*`GeoRefCodeType`*

Attributes:

`id, urn?, uri?`

Content:

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

1763

1764

Attribute Documentation:

1765

1766

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

1767

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

1768

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

1769

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

1770

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

1771

1772

Element Documentation:

1773

1774

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

1775

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

1776

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

1777

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

1778

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

1779

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

1780

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

1781

1782

**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)`

1787

*`IdentifiableType`*` (extension)`

1788

*`NameableType`*` (extension)`

1789

*`VersionableType`*` (restriction)`

1790

*`MaintainableBaseType`*` (extension)`

1791

*`MaintainableType`*` (restriction)`

1792

*`ItemSchemeType`*` (restriction)`

1793

*`CodelistBaseType`*` (extension)`

1794

`CodelistType (restriction)`

1795

*`GeoCodelistBaseType`*` (extension)`

1796

*`GeoCodelistType`*` (restriction)`

1797

`GeographicCodelistType`

Attributes:

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

Content:

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

1806

1807

Attribute Documentation:

1808

1809

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

1810

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

1811

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

1812

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

1813

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

1814

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

1815

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

1816

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

1817

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

1818

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

1819

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

1820

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

1821

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

1822

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

1823

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

1824

1825

Element Documentation:

1826

1827

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

1828

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

1829

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

1830

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

1831

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

1832

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

1833

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

1834

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

1835

1836

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

Derivation:

*`AnnotableType`*` (extension)`

1841

*`IdentifiableType`*` (extension)`

1842

*`NameableType`*` (restriction)`

1843

*`ItemBaseType`*` (extension)`

1844

*`ItemType`*` (restriction)`

1845

`CodeType (extension)`

1846

*`GeoRefCodeType`*` (extension)`

1847

`GeoFeatureSetCodeType`

Attributes:

`id, urn?, uri?, value`

Content:

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

1856

1857

Attribute Documentation:

1858

1859

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

1860

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

1861

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

1862

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

1863

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

1864

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

1865

1866

Element Documentation:

1867

1868

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

1869

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

1870

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

1871

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

1872

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

1873

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

1874

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

1875

1876

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

Derivation:

*`AnnotableType`*` (extension)`

1881

*`IdentifiableType`*` (extension)`

1882

*`NameableType`*` (extension)`

1883

*`VersionableType`*` (restriction)`

1884

*`MaintainableBaseType`*` (extension)`

1885

*`MaintainableType`*` (restriction)`

1886

*`ItemSchemeType`*` (restriction)`

1887

*`CodelistBaseType`*` (extension)`

1888

`CodelistType (restriction)`

1889

*`GeoCodelistBaseType`*` (extension)`

1890

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

Attributes:

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

Content:

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

1899

1900

Attribute Documentation:

1901

1902

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

1903

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

1904

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

1905

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

1906

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

1907

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

1908

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

1909

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

1910

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

1911

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

1912

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

1913

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

1914

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

1915

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

1916

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

1917

1918

Element Documentation:

1919

1920

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

1921

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

1922

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

1923

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

1924

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

1925

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

1926

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

1927

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

1928

1929

**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)`

1934

*`IdentifiableType`*` (extension)`

1935

*`NameableType`*` (extension)`

1936

*`VersionableType`*` (restriction)`

1937

*`MaintainableBaseType`*` (extension)`

1938

*`MaintainableType`*` (restriction)`

1939

*`ItemSchemeType`*` (restriction)`

1940

*`CodelistBaseType`*` (extension)`

1941

`CodelistType (restriction)`

1942

*`GeoCodelistBaseType`*` (extension)`

1943

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

1944

`GeoGridCodelistType`

Attributes:

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

Content:

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

1953

1954

Attribute Documentation:

1955

1956

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

1957

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

1958

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

1959

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

1960

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

1961

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

1962

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

1963

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

1964

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

1965

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

1966

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

1967

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

1968

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

1969

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

1970

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

1971

1972

Element Documentation:

1973

1974

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

1975

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

1976

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

1977

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

1978

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

1979

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

1980

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

1981

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

1982

| GridDefinition | xs:string | Contains a regular expression string corresponding to the grid definition for the GeoGrid Codelist. |

1983

1984

**GeoGridCodeType:** GeoGridCodeType defines the structure of a geographic grid cell.

Derivation:

*`AnnotableType`*` (extension)`

1989

*`IdentifiableType`*` (extension)`

1990

*`NameableType`*` (restriction)`

1991

*`ItemBaseType`*` (extension)`

1992

*`ItemType`*` (restriction)`

1993

`CodeType (extension)`

1994

*`GeoRefCodeType`*` (extension)`

`GeoGridCodeType`

Attributes:

`id, urn?, uri?`

Content:

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

2004

2005

Attribute Documentation:

2006

2007

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

2008

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

2009

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

2010

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

2011

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

2012

2013

Element Documentation:

2014

2015

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

2016

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

2017

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

2018

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

2019

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

2020

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

2021

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

2022

| GeoCell | xs:string | The value used to assign the Code to one cell in the grid. |

2023

2024

***ValueListBaseType*:** ValueListBaseType defines the base refinement of the ValueListType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

2029

*`IdentifiableType`*` (extension)`

2030

*`NameableType`*` (extension)`

2031

*`VersionableType`*` (restriction)`

2032

*`MaintainableBaseType`*` (extension)`

2033

*`MaintainableType`*` (restriction)`

2034

*`ValueListBaseType`*

Attributes:

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

Content:

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

2043

2044

Attribute Documentation:

2045

2046

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

2047

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

2048

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

2049

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

2050

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

2051

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

2052

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

2053

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

2054

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

2055

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

2056

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

2057

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

2058

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

2059

2060

Element Documentation:

2061

2062

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

2063

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

2064

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

2065

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

2066

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

2067

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

2068

2069

**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)`

2074

*`IdentifiableType`*` (extension)`

2075

*`NameableType`*` (extension)`

2076

*`VersionableType`*` (restriction)`

2077

*`MaintainableBaseType`*` (extension)`

2078

*`MaintainableType`*` (restriction)`

2079

*`ValueListBaseType`*` (extension)`

`ValueListType`

Attributes:

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

Content:

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

2089

2090

Attribute Documentation:

2091

2092

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

2093

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

2094

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

2095

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

2096

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

2097

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

2098

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

2099

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

2100

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

2101

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

2102

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

2103

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

2104

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

2105

2106

Element Documentation:

2107

2108

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

2109

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

2110

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

2111

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

2112

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

2113

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

2114

| ValueItem | ValueItemType | |

2115

2116

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

2130

2131

Attribute Documentation:

2132

2133

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

2134

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

2135

| id | xs:string | |

2136

2137

Element Documentation:

2138

2139

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

2140

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

2141

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

2142

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

2143

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

2144

2145

**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)`

2150

*`IdentifiableType`*` (extension)`

2151

*`NameableType`*` (extension)`

2152

*`VersionableType`*` (restriction)`

2153

*`MaintainableBaseType`*` (extension)`

2154

*`MaintainableType`*` (restriction)`

2155

*`ItemSchemeType`*` (restriction)`

`ConceptSchemeType`

Attributes:

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

Content:

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

2165

2166

Attribute Documentation:

2167

2168

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

2169

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

2170

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

2171

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

2172

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

2173

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

2174

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

2175

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

2176

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

2177

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

2178

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

2179

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

2180

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

2181

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

2182

2183

Element Documentation:

2184

2185

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

2186

| --- --| --- --| --- --|

2187

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2188

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2189

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2190

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2191

| Concept | ConceptType | Concept describes the details of a concept within a concept scheme. |

2192

2193

***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)`

2198

*`IdentifiableType`*` (extension)`

2199

*`NameableType`*` (restriction)`

2200

*`ItemBaseType`*` (extension)`

2201

*`ItemType`*` (restriction)`

*`ConceptBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Parent?`

2211

2212

Attribute Documentation:

2213

2214

| **Name** | **Type** | **Documentation** |

2215

| --- --| --- --| --- --|

2216

| 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). |

2217

| urn | ConceptUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2218

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2219

2220

Element Documentation:

2221

2222

| **Name** | **Type** | **Documentation** |

2223

| --- --| --- --| --- --|

2224

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2225

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2226

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2227

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2228

| 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. |

2229

2230

**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)`

2235

*`IdentifiableType`*` (extension)`

2236

*`NameableType`*` (restriction)`

2237

*`ItemBaseType`*` (extension)`

2238

*`ItemType`*` (restriction)`

2239

*`ConceptBaseType`*` (extension)`

`ConceptType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Parent?, CoreRepresentation?, ISOConceptReference?`

2249

2250

Attribute Documentation:

2251

2252

| **Name** | **Type** | **Documentation** |

2253

| --- --| --- --| --- --|

2254

| 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). |

2255

| urn | ConceptUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2256

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2257

2258

Element Documentation:

2259

2260

| **Name** | **Type** | **Documentation** |

2261

| --- --| --- --| --- --|

2262

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2263

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2264

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2265

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2266

| 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. |

2267

| CoreRepresentation | ConceptRepresentatio n | |

2268

| ISOConceptReference | ISOConceptReferenceT ype | Provides a reference to an ISO 11179 concept. |

2269

2270

**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)`

2275

`ConceptRepresentation`

Attributes:

`minOccurs?, maxOccurs?`

Content:

`(TextFormat | (Enumeration, EnumerationFormat?))`

2284

2285

Attribute Documentation:

2286

2287

| **Name** | **Type** | **Documentation** |

2288

| --- --| --- --| --- --|

2289

| minOccurs (default: 1) | xs: nonNegativeInteger | The minOccurs attribute indicates the minimum number of value that must be reported for the component. |

2290

| maxOccurs | OccurenceType | The maxOccurs attribute indicates the maximum number of values that can be reported for the component. |

2291

2292

Element Documentation:

2293

2294

| **Name** | **Type** | **Documentation** |

2295

| --- --| --- --| --- --|

2296

| TextFormat | BasicComponentTextFo rmatType | TextFormat describes an uncoded textual format. |

2297

| Enumeration | AnyCodelistReference Type | Enumeration references a codelist which enumerates the possible values that can be used as the representation of this concept. |

2298

| EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |

2299

2300

**ISOConceptReferenceType:** ISOConceptReferenceType provides a reference to and ISO 11179 concept.

Content:

`ConceptAgency, ConceptSchemeID, ConceptID`

2305

2306

Element Documentation:

2307

2308

| **Name** | **Type** | **Documentation** |

2309

| --- --| --- --| --- --|

2310

| ConceptAgency | xs:string | |

2311

| ConceptSchemeID | xs:string | |

2312

| ConceptID | xs:string | |

2313

2314

***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)`

2319

*`IdentifiableType`*` (extension)`

2320

*`NameableType`*` (extension)`

2321

*`VersionableType`*` (restriction)`

2322

*`MaintainableBaseType`*` (extension)`

2323

*`MaintainableType`*` (restriction)`

2324

*`ConstraintBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

2333

2334

Attribute Documentation:

2335

2336

| **Name** | **Type** | **Documentation** |

2337

| --- --| --- --| --- --|

2338

| id | IDType | The id is the identifier for the object. |

2339

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2340

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2341

| 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. |

2342

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

2343

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

2344

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

2345

| 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. |

2346

| 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. |

2347

| 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. |

2348

| 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’. |

2349

2350

Element Documentation:

2351

2352

| **Name** | **Type** | **Documentation** |

2353

| --- --| --- --| --- --|

2354

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2355

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2356

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2357

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2358

2359

***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)`

2364

*`IdentifiableType`*` (extension)`

2365

*`NameableType`*` (extension)`

2366

*`VersionableType`*` (restriction)`

2367

*`MaintainableBaseType`*` (extension)`

2368

*`MaintainableType`*` (restriction)`

2369

*`ConstraintBaseType`*` (extension)`

*`ConstraintType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role`

Content:

`Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?`

2379

2380

Attribute Documentation:

2381

2382

| **Name** | **Type** | **Documentation** |

2383

| --- --| --- --| --- --|

2384

| id | IDType | The id is the identifier for the object. |

2385

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2386

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2387

| 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. |

2388

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

2389

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

2390

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

2391

| 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. |

2392

| 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. |

2393

| 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. |

2394

| 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’. |

2395

| 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. |

2396

2397

Element Documentation:

2398

2399

| **Name** | **Type** | **Documentation** |

2400

| --- --| --- --| --- --|

2401

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2402

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2403

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2404

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2405

| ConstraintAttachment | *ConstraintAttachment Type* | ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. |

2406

| ReleaseCalendar | ReleaseCalendarType | ReleaseCalendar defines dates on which the constrained data is to be made available. |

2407

2408

***DataConstraintBaseType*:** DataConstraintBaseType is an abstract base refinement of ConstraintType. The constraint attachment is restricted to constrainable artefacts related to data.

Derivation:

*`AnnotableType`*` (extension)`

2413

*`IdentifiableType`*` (extension)`

2414

*`NameableType`*` (extension)`

2415

*`VersionableType`*` (restriction)`

2416

*`MaintainableBaseType`*` (extension)`

2417

*`MaintainableType`*` (restriction)`

2418

*`ConstraintBaseType`*` (extension)`

2419

*`ConstraintType`*` (restriction)`

2420

*`DataConstraintBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role`

Content:

`Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?`

2429

2430

Attribute Documentation:

2431

2432

| **Name** | **Type** | **Documentation** |

2433

| --- --| --- --| --- --|

2434

| id | IDType | The id is the identifier for the object. |

2435

| urn | DataConstraintUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2436

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2437

| 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. |

2438

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

2439

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

2440

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

2441

| 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. |

2442

| 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. |

2443

| 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. |

2444

| 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’. |

2445

| 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. |

2446

2447

Element Documentation:

2448

2449

| **Name** | **Type** | **Documentation** |

2450

| --- --| --- --| --- --|

2451

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2452

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2453

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2454

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2455

| ConstraintAttachment | DataConstraintAttach mentType | ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. |

2456

| ReleaseCalendar | ReleaseCalendarType | ReleaseCalendar defines dates on which the constrained data is to be made available. |

2457

2458

**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)`

2463

*`IdentifiableType`*` (extension)`

2464

*`NameableType`*` (extension)`

2465

*`VersionableType`*` (restriction)`

2466

*`MaintainableBaseType`*` (extension)`

2467

*`MaintainableType`*` (restriction)`

2468

*`ConstraintBaseType`*` (extension)`

2469

*`ConstraintType`*` (restriction)`

2470

*`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]`

2480

2481

Attribute Documentation:

2482

2483

| **Name** | **Type** | **Documentation** |

2484

| --- --| --- --| --- --|

2485

| id | IDType | The id is the identifier for the object. |

2486

| urn | DataConstraintUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2487

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2488

| 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. |

2489

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

2490

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

2491

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

2492

| 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. |

2493

| 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. |

2494

| 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. |

2495

| 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’. |

2496

| 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. |

2497

2498

Element Documentation:

2499

2500

| **Name** | **Type** | **Documentation** |

2501

| --- --| --- --| --- --|

2502

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2503

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2504

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2505

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2506

| ConstraintAttachment | DataConstraintAttach mentType | ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. |

2507

| ReleaseCalendar | ReleaseCalendarType | ReleaseCalendar defines dates on which the constrained data is to be made available. |

2508

| DataKeySet | DataKeySetType | DataKeySet defines a full, distinct set of dimension values and the attribute values associated with the key. |

2509

| 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. |

2510

2511

***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)`

2516

*`IdentifiableType`*` (extension)`

2517

*`NameableType`*` (extension)`

2518

*`VersionableType`*` (restriction)`

2519

*`MaintainableBaseType`*` (extension)`

2520

*`MaintainableType`*` (restriction)`

2521

*`ConstraintBaseType`*` (extension)`

2522

*`ConstraintType`*` (restriction)`

2523

*`MetadataConstraintBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role`

Content:

`Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?`

2532

2533

Attribute Documentation:

2534

2535

| **Name** | **Type** | **Documentation** |

2536

| --- --| --- --| --- --|

2537

| id | IDType | The id is the identifier for the object. |

2538

| urn | MetadataConstraintUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2539

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2540

| 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. |

2541

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

2542

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

2543

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

2544

| 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. |

2545

| 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. |

2546

| 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. |

2547

| 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’. |

2548

| 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. |

2549

2550

Element Documentation:

2551

2552

| **Name** | **Type** | **Documentation** |

2553

| --- --| --- --| --- --|

2554

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2555

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2556

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2557

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2558

| ConstraintAttachment | MetadataConstraintAt tachmentType | ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. |

2559

| ReleaseCalendar | ReleaseCalendarType | ReleaseCalendar defines dates on which the constrained data is to be made available. |

2560

2561

**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)`

2566

*`IdentifiableType`*` (extension)`

2567

*`NameableType`*` (extension)`

2568

*`VersionableType`*` (restriction)`

2569

*`MaintainableBaseType`*` (extension)`

2570

*`MaintainableType`*` (restriction)`

2571

*`ConstraintBaseType`*` (extension)`

2572

*`ConstraintType`*` (restriction)`

2573

*`MetadataConstraintBaseType`*` (extension)`

2574

`MetadataConstraintType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, role`

Content:

`Annotations?, Link*, Name+, Description*, ConstraintAttachment?, ReleaseCalendar?, MetadataTargetRegion[0..2]`

2583

2584

Attribute Documentation:

2585

2586

| **Name** | **Type** | **Documentation** |

2587

| --- --| --- --| --- --|

2588

| id | IDType | The id is the identifier for the object. |

2589

| urn | MetadataConstraintUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

2590

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

2591

| 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. |

2592

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

2593

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

2594

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

2595

| 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. |

2596

| 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. |

2597

| 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. |

2598

| 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’. |

2599

| 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. |

2600

2601

Element Documentation:

2602

2603

| **Name** | **Type** | **Documentation** |

2604

| --- --| --- --| --- --|

2605

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2606

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

2607

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

2608

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

2609

| ConstraintAttachment | MetadataConstraintAt tachmentType | ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to. |

2610

| ReleaseCalendar | ReleaseCalendarType | ReleaseCalendar defines dates on which the constrained data is to be made available. |

2611

| MetadataTargetRegion | MetadataTargetRegion Type | MetadataTargetRegion describes the values allowed for metadata attributes. |

2612

2613

**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`

2618

2619

Element Documentation:

2620

2621

| **Name** | **Type** | **Documentation** |

2622

| --- --| --- --| --- --|

2623

| Periodicity | xs:string | Periodicity is the period between releases of the data set. |

2624

| Offset | xs:string | Offset is the interval between January first and the first release of data within the year. |

2625

| Tolerance | xs:string | Tolerance is the period after which the release of data may be deemed late. |

2626

2627

**DataKeySetType:** DataKeySetType defines a collection of full or partial data keys (dimension values).

Attributes:

`isIncluded`

Content:

`Key+`

Attribute Documentation:

2638

2639

| **Name** | **Type** | **Documentation** |

2640

| --- --| --- --| --- --|

2641

| isIncluded | xs:boolean | The isIncluded attribute indicates whether the keys defined in this key set are inclusive or exclusive to the constraint. |

2642

2643

Element Documentation:

2644

2645

| **Name** | **Type** | **Documentation** |

2646

| --- --| --- --| --- --|

2647

| Key | DataKeyType | Key contains a set of dimension values which identify a full set of data. |

2648

2649

***ConstraintAttachmentType*:** ConstraintAttachmentType describes a collection of references to constrainable artefacts.

Content:

Element Documentation:

2656

2657

| **Name** | **Type** | **Documentation** |

2658

| --- --| --- --| --- --|

2659

| 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. |

2660

| 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. |

2661

| 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. |

2662

| SimpleDataSource | xs:anyURI | SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message. |

2663

| 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. |

2664

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2665

| 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. |

2666

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2667

| 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. |

2668

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2669

| 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. |

2670

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2671

| 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. |

2672

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2673

| 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. |

2674

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2675

2676

**DataConstraintAttachmentType:** DataConstraintAttachmentType restricts the base ConstraintAttachmentType to only allow artefacts related to data.

Derivation:

*`ConstraintAttachmentType`*` (restriction)`

2681

`DataConstraintAttachmentType`

Content:

`(DataProvider | SimpleDataSource+ | (DataStructure+, QueryableDataSource*) | (Dataflow+, QueryableDataSource*) | (ProvisionAgreement+, QueryableDataSource*))`

2686

2687

Element Documentation:

2688

2689

| **Name** | **Type** | **Documentation** |

2690

| --- --| --- --| --- --|

2691

| 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. |

2692

| SimpleDataSource | xs:anyURI | SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message. |

2693

| 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. |

2694

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2695

| 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. |

2696

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2697

| 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. |

2698

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2699

2700

**MetadataConstraintAttachmentType:** MetadataConstraintAttachmentType restricts the base ConstraintAttachmentType to only allow artefacts related to metadata.

Derivation:

*`ConstraintAttachmentType`*` (restriction)`

2705

`MetadataConstraintAttachmentType`

Content:

Element Documentation:

2712

2713

| **Name** | **Type** | **Documentation** |

2714

| --- --| --- --| --- --|

2715

| 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. |

2716

| 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. |

2717

| SimpleDataSource | xs:anyURI | SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message. |

2718

| 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. |

2719

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2720

| 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. |

2721

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2722

| 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. |

2723

| QueryableDataSource | QueryableDataSourceT ype | QueryableDataSource describes a queryable data source to which the constraint is attached. |

2724

2725

***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*`

2739

2740

Attribute Documentation:

2741

2742

| **Name** | **Type** | **Documentation** |

2743

| --- --| --- --| --- --|

2744

| 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. |

2745

| validFrom | StandardTimePeriodTy pe | |

2746

| validTo | StandardTimePeriodTy pe | |

2747

2748

Element Documentation:

2749

2750

| **Name** | **Type** | **Documentation** |

2751

| --- --| --- --| --- --|

2752

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2753

| 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. |

2754

| 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. |

2755

2756

***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)?`

2765

2766

Attribute Documentation:

2767

2768

| **Name** | **Type** | **Documentation** |

2769

| --- --| --- --| --- --|

2770

| 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. |

2771

| 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. |

2772

| removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |

2773

| validFrom | StandardTimePeriodTy pe | |

2774

| validTo | StandardTimePeriodTy pe | |

2775

2776

Element Documentation:

2777

2778

| **Name** | **Type** | **Documentation** |

2779

| --- --| --- --| --- --|

2780

| 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. |

2781

| 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). |

2782

2783

**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)`

2788

*`RegionType`* `(restriction)`

`DataKeyType`

Attributes:

`include?, validFrom?, validTo?`

Content:

`Annotations?, KeyValue*, Component*`

2798

2799

Attribute Documentation:

2800

2801

| **Name** | **Type** | **Documentation** |

2802

| --- --| --- --| --- --|

2803

| 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. |

2804

| validFrom | StandardTimePeriodTy pe | |

2805

| validTo | StandardTimePeriodTy pe | |

2806

2807

Element Documentation:

2808

2809

| **Name** | **Type** | **Documentation** |

2810

| --- --| --- --| --- --|

2811

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2812

| 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. |

2813

| 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. |

2814

2815

**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:

2831

2832

| **Name** | **Type** | **Documentation** |

2833

| --- --| --- --| --- --|

2834

| 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. |

2835

| 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. |

2836

| removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |

2837

2838

Element Documentation:

2839

2840

| **Name** | **Type** | **Documentation** |

2841

| --- --| --- --| --- --|

2842

| 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. |

2843

2844

**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)`

2849

`DataComponentValueSetType`

Attributes:

`id, include?, removePrefix?`

Content:

`(Value+ | TimeRange)?`

2858

2859

Attribute Documentation:

2860

2861

| **Name** | **Type** | **Documentation** |

2862

| --- --| --- --| --- --|

2863

| 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. |

2864

| 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. |

2865

| removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |

2866

2867

Element Documentation:

2868

2869

| **Name** | **Type** | **Documentation** |

2870

| --- --| --- --| --- --|

2871

| 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. |

2872

| 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). |

2873

2874

**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)`

2879

*`RegionType`* `(restriction)`

`CubeRegionType`

Attributes:

`include?`

Content:

`Annotations?, KeyValue*, Component*`

2889

2890

Attribute Documentation:

2891

2892

| **Name** | **Type** | **Documentation** |

2893

| --- --| --- --| --- --|

2894

| 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. |

2895

2896

Element Documentation:

2897

2898

| **Name** | **Type** | **Documentation** |

2899

| --- --| --- --| --- --|

2900

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

2901

| 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. |

2902

| 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. |

2903

2904

**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)`

2909

*`RegionType`* `(restriction)`

2910

`MetadataTargetRegionType`

Attributes:

`include?, validFrom?, validTo?`

Content:

`Component*`

Attribute Documentation:

2921

2922

| **Name** | **Type** | **Documentation** |

2923

| --- --| --- --| --- --|

2924

| 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. |

2925

| validFrom | StandardTimePeriodTy pe | |

2926

| validTo | StandardTimePeriodTy pe | |

2927

2928

Element Documentation:

2929

2930

| **Name** | **Type** | **Documentation** |

2931

| --- --| --- --| --- --|

2932

| 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. |

2933

2934

**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)`

2948

2949

Attribute Documentation:

2950

2951

| **Name** | **Type** | **Documentation** |

2952

| --- --| --- --| --- --|

2953

| 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. |

2954

| 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. |

2955

| removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |

2956

| validFrom | StandardTimePeriodTy pe | |

2957

| validTo | StandardTimePeriodTy pe | |

2958

2959

Element Documentation:

2960

2961

| **Name** | **Type** | **Documentation** |

2962

| --- --| --- --| --- --|

2963

| 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. |

2964

| 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). |

2965

2966

**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)`

2971

`ComponentValueSetType`

Attributes:

`id, include?, removePrefix?`

Content:

`(Value+ | TimeRange)?`

2980

2981

Attribute Documentation:

2982

2983

| **Name** | **Type** | **Documentation** |

2984

| --- --| --- --| --- --|

2985

| 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. |

2986

| 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. |

2987

| removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |

2988

2989

Element Documentation:

2990

2991

| **Name** | **Type** | **Documentation** |

2992

| --- --| --- --| --- --|

2993

| 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. |

2994

| 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). |

2995

2996

**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)`

3001

`MetadataAttributeValueSetType`

Attributes:

`id, include?, removePrefix?`

Content:

`(Value+ | TimeRange)?`

3010

3011

Attribute Documentation:

3012

3013

| **Name** | **Type** | **Documentation** |

3014

| --- --| --- --| --- --|

3015

| 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. |

3016

| 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. |

3017

| removePrefix | xs:boolean | The removePrefix attribute indicates whether codes should keep or not the prefix, as defined in the extension of codelist. |

3018

3019

Element Documentation:

3020

3021

| **Name** | **Type** | **Documentation** |

3022

| --- --| --- --| --- --|

3023

| 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. |

3024

| 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). |

3025

3026

**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)` `

3031

`xs:string (extension)`

3032

`SimpleComponentValueType`

Attributes:

`cascadeValues?, xml:lang?, validFrom?, validTo?`

Content:

Attribute Documentation:

3041

3042

| **Name** | **Type** | **Documentation** |

3043

| --- --| --- --| --- --|

3044

| 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. |

3045

| 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. |

3046

| validFrom | StandardTimePeriodTy pe | |

3047

| validTo | StandardTimePeriodTy pe | |

3048

3049

**CubeKeyValueType:** CubeKeyValueType derives from the SimpleValueType, but does not allow for a locale (xml:lang).

Derivation:

``xs:anySimpleType (restriction)` `

3054

`xs:string (extension)`

3055

`SimpleComponentValueType (restriction)`

`CubeKeyValueType`

Attributes:

`cascadeValues?, validFrom?, validTo?`

Content:

Attribute Documentation:

3065

3066

| **Name** | **Type** | **Documentation** |

3067

| --- --| --- --| --- --|

3068

| 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. |

3069

| validFrom | StandardTimePeriodTy pe | |

3070

| validTo | StandardTimePeriodTy pe | |

3071

3072

**DataComponentValueType:** DataComponentValueType derives from the SimpleValueType, but does not allow for validity dates.

Derivation:

``xs:anySimpleType (restriction)` `

3077

`xs:string (extension)`

3078

`SimpleComponentValueType (restriction)`

3079

`DataComponentValueType`

Attributes:

`cascadeValues?, xml:lang?`

Content:

Attribute Documentation:

3088

3089

| **Name** | **Type** | **Documentation** |

3090

| --- --| --- --| --- --|

3091

| 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. |

3092

| 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. |

3093

3094

**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)` `

3099

`xs:string (extension)`

3100

`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))`

3114

3115

Attribute Documentation:

3116

3117

| **Name** | **Type** | **Documentation** |

3118

| --- --| --- --| --- --|

3119

| validFrom | StandardTimePeriodTy pe | |

3120

| validTo | StandardTimePeriodTy pe | |

3121

3122

Element Documentation:

3123

3124

| **Name** | **Type** | **Documentation** |

3125

| --- --| --- --| --- --|

3126

| BeforePeriod | TimePeriodRangeType | BeforePeriod is the period before which the period is meant to cover. This date may be inclusive or exclusive in the range. |

3127

| AfterPeriod | TimePeriodRangeType | AfterPeriod is the period after which the period is meant to cover. This date may be inclusive or exclusive in the range. |

3128

| 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. |

3129

| EndPeriod | TimePeriodRangeType | EndPeriod is the end period of the range. This date may be inclusive or exclusive in the range. |

3130

3131

**TimePeriodRangeType:** TimePeriodRangeType defines a time period, and indicates whether it is inclusive in a range.

Derivation:

`xs:anySimpleType (restriction)`

3136

`ObservationalTimePeriodType (extension)`

3137

`TimePeriodRangeType`

Attributes:

`isInclusive?`

Content:

Attribute Documentation:

3146

3147

| **Name** | **Type** | **Documentation** |

3148

| --- --| --- --| --- --|

3149

| isInclusive (default: true) | xs:boolean | The isInclusive attribute, when true, indicates that the time period specified is included in the range. |

3150

3151

***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)`

3156

*`IdentifiableType`*` (extension)`

3157

*`NameableType`*` (extension)`

3158

*`VersionableType`*` (restriction)`

3159

*`MaintainableBaseType`*` (extension)`

3160

*`MaintainableType`*` (restriction)`

3161

*`StructureType`*` (restriction)`

3162

*`DataStructureBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, DataStructureComponents?`

3171

3172

Attribute Documentation:

3173

3174

| **Name** | **Type** | **Documentation** |

3175

| --- --| --- --| --- --|

3176

| id | IDType | The id is the identifier for the object. |

3177

| urn | DataStructureUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3178

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3179

| 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. |

3180

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

3181

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

3182

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

3183

| 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. |

3184

| 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. |

3185

| 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. |

3186

| 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’. |

3187

3188

Element Documentation:

3189

3190

| **Name** | **Type** | **Documentation** |

3191

| --- --| --- --| --- --|

3192

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3193

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3194

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

3195

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

3196

| 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. |

3197

3198

**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)`

3203

*`IdentifiableType`*` (extension)`

3204

*`NameableType`*` (extension)`

3205

*`VersionableType`*` (restriction)`

3206

*`MaintainableBaseType`*` (extension)`

3207

*`MaintainableType`*` (restriction)`

3208

*`StructureType`*` (restriction)`

3209

*`DataStructureBaseType`*` (extension)`

`DataStructureType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, DataStructureComponents?, Metadata?`

3219

3220

Attribute Documentation:

3221

3222

| **Name** | **Type** | **Documentation** |

3223

| --- --| --- --| --- --|

3224

| id | IDType | The id is the identifier for the object. |

3225

| urn | DataStructureUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3226

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3227

| 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. |

3228

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

3229

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

3230

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

3231

| 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. |

3232

| 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. |

3233

| 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. |

3234

| 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’. |

3235

3236

Element Documentation:

3237

3238

| **Name** | **Type** | **Documentation** |

3239

| --- --| --- --| --- --|

3240

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3241

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3242

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

3243

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

3244

| 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. |

3245

| 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. |

3246

3247

***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)`

3252

*`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)`

3263

*`DataStructureComponentsBaseType`*` (extension)`

3264

`DataStructureComponentsType`

Content:

`DimensionList, Group*, AttributeList?, MeasureList?`

3269

3270

Element Documentation:

3271

3272

| **Name** | **Type** | **Documentation** |

3273

| --- --| --- --| --- --|

3274

| 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. |

3275

| 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. |

3276

| 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. |

3277

| MeasureList | MeasureListType | MeasureList describes the measure descriptor for a data structure. |

3278

3279

***AttributeListBaseType*:** AttributeListBaseType is an abstract base type used as the basis for the AttributeListType.

Derivation:

*`AnnotableType`*` (extension)`

3284

*`IdentifiableType`*` (extension)`

3285

*`ComponentListType`*` (restriction)`

3286

*`AttributeListBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*`

3295

3296

Attribute Documentation:

3297

3298

| **Name** | **Type** | **Documentation** |

3299

| --- --| --- --| --- --|

3300

| id (fixed: AttributeDescriptor) | IDType | The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor. |

3301

| urn | AttributeDescriptorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3302

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3303

3304

Element Documentation:

3305

3306

| **Name** | **Type** | **Documentation** |

3307

| --- --| --- --| --- --|

3308

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3309

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3310

3311

**AttributeListType:** AttributeListType describes the attribute descriptor for the data structure definition.

Derivation:

*`AnnotableType`*` (extension)`

3316

*`IdentifiableType`*` (extension)`

3317

*`ComponentListType`*` (restriction)`

3318

*`AttributeListBaseType`*` (extension)`

`AttributeListType`

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, (Attribute | MetadataAttributeUsage)+`

3328

3329

Attribute Documentation:

3330

3331

| **Name** | **Type** | **Documentation** |

3332

| --- --| --- --| --- --|

3333

| id (fixed: AttributeDescriptor) | IDType | The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor. |

3334

| urn | AttributeDescriptorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3335

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3336

3337

Element Documentation:

3338

3339

| **Name** | **Type** | **Documentation** |

3340

| --- --| --- --| --- --|

3341

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3342

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3343

| Attribute | AttributeType | Attribute describes the definition of a data attribute, which is defined as a characteristic of an object or entity. |

3344

| 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. |

3345

3346

***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)`

3351

*`IdentifiableType`*` (extension)`

3352

*`ComponentBaseType`*` (extension)`

3353

*`ComponentType`*` (restriction)`

3354

*`AttributeBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?`

3363

3364

Attribute Documentation:

3365

3366

| **Name** | **Type** | **Documentation** |

3367

| --- --| --- --| --- --|

3368

| 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). |

3369

| urn | DataAttributeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3370

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3371

3372

Element Documentation:

3373

3374

| **Name** | **Type** | **Documentation** |

3375

| --- --| --- --| --- --|

3376

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3377

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3378

| 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. |

3379

| 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. |

3380

3381

**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)`

3386

*`IdentifiableType`*` (extension)`

3387

*`ComponentBaseType`*` (extension)`

3388

*`ComponentType`*` (restriction)`

3389

*`AttributeBaseType`*` (extension)`

`AttributeType`

Attributes:

`id?, urn?, uri?, usage?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole*, AttributeRelationship, MeasureRelationship?`

3399

3400

Attribute Documentation:

3401

3402

| **Name** | **Type** | **Documentation** |

3403

| --- --| --- --| --- --|

3404

| 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). |

3405

| urn | DataAttributeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3406

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3407

| usage (default: optional) | UsageType | The usage attribute indicates whether an attribute value must be available for any corresponding existing observation. |

3408

3409

Element Documentation:

3410

3411

| **Name** | **Type** | **Documentation** |

3412

| --- --| --- --| --- --|

3413

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3414

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3415

| 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. |

3416

| 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. |

3417

| ConceptRole | ConceptReferenceType | ConceptRole references concepts which define roles which this attribute serves. |

3418

| 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. |

3419

| 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. |

3420

3421

**AttributeRelationshipType:** AttributeRelationshipType defines the structure for stating the relationship between an attribute and other data structure definition components.

Content:

`(Dataflow | Dimension+ | Group | Observation)`

3426

3427

Element Documentation:

3428

3429

| **Name** | **Type** | **Documentation** |

3430

| --- --| --- --| --- --|

3431

| 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. |

3432

| 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. |

3433

| 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. |

3434

| 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. |

3435

3436

**OptionalLocalDimensionReferenceType:**

Derivation:

`xs:anySimpleType (restriction)`

3441

`xs:string (restriction)`

3442

`NestedIDType (restriction)`

3443

`IDType (restriction)`

3444

`NCNameIDType (extension)`

3445

`OptionalLocalDimensionReferenceType`

Attributes:

`optional?`

Content:

Attribute Documentation:

3454

3455

| **Name** | **Type** | **Documentation** |

3456

| --- --| --- --| --- --|

3457

| optional (default: false) | xs:boolean | |

3458

3459

**MeasureRelationshipType:** MeasureRelationshipType allows for the description of an attributes relationship to one or more measures

Content:

`Measure+`

Element Documentation:

3466

3467

| **Name** | **Type** | **Documentation** |

3468

| --- --| --- --| --- --|

3469

| Measure | NCNameIDType | This is a reference to a measure defined in this data structure definition. |

3470

3471

***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)`

3476

*`IdentifiableType`*` (extension)`

3477

*`ComponentBaseType`*` (extension)`

3478

*`ComponentType`*` (restriction)`

3479

*`MetadataAttributeUsageBaseType`*

Attributes:

`urn?, uri?`

Content:

`Annotations?, Link?`

3488

3489

Attribute Documentation:

3490

3491

| **Name** | **Type** | **Documentation** |

3492

| --- --| --- --| --- --|

3493

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3494

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3495

3496

Element Documentation:

3497

3498

| **Name** | **Type** | **Documentation** |

3499

| --- --| --- --| --- --|

3500

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3501

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3502

3503

**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)`

3508

*`IdentifiableType`*` (extension)`

3509

*`ComponentBaseType`*` (extension)`

3510

*`ComponentType`*` (restriction)`

3511

*`MetadataAttributeUsageBaseType`*` (extension)`

3512

`MetadataAttributeUsageType`

Attributes:

`urn?, uri?`

Content:

`Annotations?, Link?, MetadataAttributeReference, AttributeRelationship`

3521

3522

Attribute Documentation:

3523

3524

| **Name** | **Type** | **Documentation** |

3525

| --- --| --- --| --- --|

3526

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3527

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3528

3529

Element Documentation:

3530

3531

| **Name** | **Type** | **Documentation** |

3532

| --- --| --- --| --- --|

3533

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3534

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3535

| MetadataAttributeRef erence | NCNameIDType | MetadataAttributeReference is a local reference to a metadata attribute defined in the metadata structure referenced by this data structure. |

3536

| AttributeRelationshi p | AttributeRelationshi pType | AttributeRelationship defines the relationship between the referenced metadata attribute and the components of the data structure. |

3537

3538

***DimensionListBaseType*:** DimensionListBaseType is an abstract base type used as the basis for the DimensionListType.

Derivation:

*`AnnotableType`*` (extension)`

3543

*`IdentifiableType`*` (extension)`

3544

*`ComponentListType`*` (restriction)`

3545

*`DimensionListBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*`

3554

3555

Attribute Documentation:

3556

3557

| **Name** | **Type** | **Documentation** |

3558

| --- --| --- --| --- --|

3559

| id (fixed: DimensionDescriptor) | IDType | The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor. |

3560

| urn | DimensionDescriptorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3561

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3562

3563

Element Documentation:

3564

3565

| **Name** | **Type** | **Documentation** |

3566

| --- --| --- --| --- --|

3567

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3568

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3569

3570

**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)`

3575

*`IdentifiableType`*` (extension)`

3576

*`ComponentListType`*` (restriction)`

3577

*`DimensionListBaseType`*` (extension)`

`DimensionListType`

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, Dimension+, TimeDimension?`

3587

3588

Attribute Documentation:

3589

3590

| **Name** | **Type** | **Documentation** |

3591

| --- --| --- --| --- --|

3592

| id (fixed: DimensionDescriptor) | IDType | The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor. |

3593

| urn | DimensionDescriptorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3594

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3595

3596

Element Documentation:

3597

3598

| **Name** | **Type** | **Documentation** |

3599

| --- --| --- --| --- --|

3600

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3601

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3602

| 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. |

3603

| TimeDimension | TimeDimensionType | TimeDimension is a special dimension which designates the period in time in which the data identified by the full series key applies. |

3604

3605

***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)`

3610

*`IdentifiableType`*` (extension)`

3611

*`ComponentBaseType`*` (extension)`

3612

*`ComponentType`*` (restriction)`

3613

*`BaseDimensionBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?`

3622

3623

Attribute Documentation:

3624

3625

| **Name** | **Type** | **Documentation** |

3626

| --- --| --- --| --- --|

3627

| 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). |

3628

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3629

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3630

3631

Element Documentation:

3632

3633

| **Name** | **Type** | **Documentation** |

3634

| --- --| --- --| --- --|

3635

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3636

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3637

| 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. |

3638

| 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. |

3639

3640

***BaseDimensionType*:** BaseDimensionType is an abstract base type which defines the basic structure of all dimensions.

Derivation:

*`AnnotableType`*` (extension)`

3645

*`IdentifiableType`*` (extension)`

3646

*`ComponentBaseType`*` (extension)`

3647

*`ComponentType`*` (restriction)`

3648

*`BaseDimensionBaseType`*` (extension)`

3649

*`BaseDimensionType`*

Attributes:

`id?, urn?, uri?, position?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole*`

3658

3659

Attribute Documentation:

3660

3661

| **Name** | **Type** | **Documentation** |

3662

| --- --| --- --| --- --|

3663

| 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). |

3664

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3665

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3666

| 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. |

3667

3668

Element Documentation:

3669

3670

| **Name** | **Type** | **Documentation** |

3671

| --- --| --- --| --- --|

3672

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3673

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3674

| 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. |

3675

| 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. |

3676

| ConceptRole | ConceptReferenceType | ConceptRole references concepts which define roles which this dimension serves. |

3677

3678

**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)`

3683

*`IdentifiableType`*` (extension)`

3684

*`ComponentBaseType`*` (extension)`

3685

*`ComponentType`*` (restriction)`

3686

*`BaseDimensionBaseType`*` (extension)`

3687

*`BaseDimensionType`*` (restriction)`

`DimensionType`

Attributes:

`id?, urn?, uri?, position?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole*`

3697

3698

Attribute Documentation:

3699

3700

| **Name** | **Type** | **Documentation** |

3701

| --- --| --- --| --- --|

3702

| 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). |

3703

| urn | DimensionUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3704

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3705

| 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. |

3706

3707

Element Documentation:

3708

3709

| **Name** | **Type** | **Documentation** |

3710

| --- --| --- --| --- --|

3711

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3712

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3713

| 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. |

3714

| 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. |

3715

| ConceptRole | ConceptReferenceType | ConceptRole references concepts which define roles which this dimension serves. |

3716

3717

**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)`

3722

*`IdentifiableType`*` (extension)`

3723

*`ComponentBaseType`*` (extension)`

3724

*`ComponentType`*` (restriction)`

3725

*`BaseDimensionBaseType`*` (extension)`

3726

*`BaseDimensionType`*` (restriction)`

`TimeDimensionType`

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation`

3736

3737

Attribute Documentation:

3738

3739

| **Name** | **Type** | **Documentation** |

3740

| --- --| --- --| --- --|

3741

| 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). |

3742

| urn | TimeDimensionUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3743

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3744

3745

Element Documentation:

3746

3747

| **Name** | **Type** | **Documentation** |

3748

| --- --| --- --| --- --|

3749

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3750

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3751

| 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. |

3752

| 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. |

3753

3754

***GroupBaseType*:** GroupBaseType is an abstract base type that forms the basis for the GroupType.

Derivation:

*`AnnotableType`*` (extension)`

3759

*`IdentifiableType`*` (extension)`

3760

*`ComponentListType`*` (restriction)`

*`GroupBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?`

Attribute Documentation:

3772

3773

| **Name** | **Type** | **Documentation** |

3774

| --- --| --- --| --- --|

3775

| id | IDType | The id is the identifier for the object. |

3776

| urn | GroupDimensionDescri ptorUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3777

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3778

3779

Element Documentation:

3780

3781

| **Name** | **Type** | **Documentation** |

3782

| --- --| --- --| --- --|

3783

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3784

3785

**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)`

3790

*`IdentifiableType`*` (extension)`

3791

*`ComponentListType`*` (restriction)`

3792

*`GroupBaseType`*` (extension)`

`GroupType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, GroupDimension+`

3802

3803

Attribute Documentation:

3804

3805

| **Name** | **Type** | **Documentation** |

3806

| --- --| --- --| --- --|

3807

| id | IDType | The id is the identifier for the object. |

3808

| urn | GroupDimensionDescri ptorUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3809

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3810

3811

Element Documentation:

3812

3813

| **Name** | **Type** | **Documentation** |

3814

| --- --| --- --| --- --|

3815

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3816

| 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. |

3817

3818

***GroupDimensionBaseType*:** GroupDimensionBaseType is an abstract base type which refines the base ComponentType in order to form the basis for the GroupDimensionType.

Derivation:

*`AnnotableType`*` (extension)`

3823

*`IdentifiableType`*` (extension)`

3824

*`ComponentBaseType`*` (extension)`

3825

*`ComponentType`*` (restriction)`

3826

*`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)`

3837

*`IdentifiableType`*` (extension)`

3838

*`ComponentBaseType`*` (extension)`

3839

*`ComponentType`*` (restriction)`

3840

*`GroupDimensionBaseType`*` (extension)`

`GroupDimensionType`

Content:

`DimensionReference`

Element Documentation:

3848

3849

| **Name** | **Type** | **Documentation** |

3850

| --- --| --- --| --- --|

3851

| 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. |

3852

3853

**MeasureListType:** MeasureListType describes the structure of the measure descriptor for a data structure definition.

Derivation:

*`AnnotableType`*` (extension)`

3858

*`IdentifiableType`*` (extension)`

3859

*`ComponentListType`*` (restriction)`

`MeasureListType`

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, Measure+`

3869

3870

Attribute Documentation:

3871

3872

| **Name** | **Type** | **Documentation** |

3873

| --- --| --- --| --- --|

3874

| id (fixed: MeasureDescriptor) | IDType | The id is the identifier for the object. |

3875

| urn | MeasureDescriptorUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3876

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3877

3878

Element Documentation:

3879

3880

| **Name** | **Type** | **Documentation** |

3881

| --- --| --- --| --- --|

3882

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3883

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3884

| 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. |

3885

3886

***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)`

3891

*`IdentifiableType`*` (extension)`

3892

*`ComponentBaseType`*` (extension)`

3893

*`ComponentType`*` (restriction)`

*`MeasureBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?`

3903

3904

Attribute Documentation:

3905

3906

| **Name** | **Type** | **Documentation** |

3907

| --- --| --- --| --- --|

3908

| 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). |

3909

| urn | MeasureUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3910

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3911

3912

Element Documentation:

3913

3914

| **Name** | **Type** | **Documentation** |

3915

| --- --| --- --| --- --|

3916

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3917

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3918

| 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. |

3919

| 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. |

3920

3921

**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)`

3926

*`IdentifiableType`*` (extension)`

3927

*`ComponentBaseType`*` (extension)`

3928

*`ComponentType`*` (restriction)`

3929

*`MeasureBaseType`*` (extension)`

`MeasureType`

Attributes:

`id?, urn?, uri?, usage?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?, ConceptRole*`

3939

3940

Attribute Documentation:

3941

3942

| **Name** | **Type** | **Documentation** |

3943

| --- --| --- --| --- --|

3944

| 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). |

3945

| urn | MeasureUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

3946

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

3947

| usage (default: optional) | UsageType | The usage attribute indicates whether a measure value must be available for any corresponding existing observation. |

3948

3949

Element Documentation:

3950

3951

| **Name** | **Type** | **Documentation** |

3952

| --- --| --- --| --- --|

3953

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

3954

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

3955

| 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. |

3956

| 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. |

3957

| ConceptRole | ConceptReferenceType | ConceptRole references concepts which define roles which this measure serves. |

3958

3959

***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)`

3964

*`DataStructureRepresentationType`*

Attributes:

`maxOccurs?`

Content:

`(TextFormat | (Enumeration, EnumerationFormat?))`

3973

3974

Attribute Documentation:

3975

3976

| **Name** | **Type** | **Documentation** |

3977

| --- --| --- --| --- --|

3978

| maxOccurs | OccurenceType | The maxOccurs attribute indicates the maximum number of values that can be reported for the component. |

3979

3980

Element Documentation:

3981

3982

| **Name** | **Type** | **Documentation** |

3983

| --- --| --- --| --- --|

3984

| TextFormat | SimpleComponentTextF ormatType | TextFormat describes an uncoded textual format. |

3985

| Enumeration | AnyCodelistReference Type | Enumeration references an item scheme that enumerates the allowable values for this representation. |

3986

| EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |

3987

3988

**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)`

3993

`AttributeRepresentationType`

Attributes:

`minOccurs?, maxOccurs?`

Content:

`(TextFormat | (Enumeration, EnumerationFormat?))`

4002

4003

Attribute Documentation:

4004

4005

| **Name** | **Type** | **Documentation** |

4006

| --- --| --- --| --- --|

4007

| minOccurs (default: 1) | xs: nonNegativeInteger | The minOccurs attribute indicates the minimum number of value that must be reported for the component. |

4008

| maxOccurs (default: 1) | OccurenceType | The maxOccurs attribute indicates the maximum number of values that can be reported for the component. |

4009

4010

Element Documentation:

4011

4012

| **Name** | **Type** | **Documentation** |

4013

| --- --| --- --| --- --|

4014

| TextFormat | BasicComponentTextFo rmatType | TextFormat describes an uncoded textual format. |

4015

| Enumeration | AnyCodelistReference Type | Enumeration references an item scheme that enumerates the allowable values for this representation. |

4016

| EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |

4017

4018

**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)`

4023

`MeasureRepresentationType`

Attributes:

`minOccurs?, maxOccurs?`

Content:

`(TextFormat | (Enumeration, EnumerationFormat?))`

4032

4033

Attribute Documentation:

4034

4035

| **Name** | **Type** | **Documentation** |

4036

| --- --| --- --| --- --|

4037

| minOccurs (default: 1) | xs: nonNegativeInteger | The minOccurs attribute indicates the minimum number of value that must be reported for the component. |

4038

| maxOccurs (default: 1) | OccurenceType | The maxOccurs attribute indicates the maximum number of values that can be reported for the component. |

4039

4040

Element Documentation:

4041

4042

| **Name** | **Type** | **Documentation** |

4043

| --- --| --- --| --- --|

4044

| TextFormat | BasicComponentTextFo rmatType | TextFormat describes an uncoded textual format. |

4045

| Enumeration | AnyCodelistReference Type | Enumeration references an item scheme that enumerates the allowable values for this representation. |

4046

| EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |

4047

4048

**SimpleDataStructureRepresentationType:** SimpleDataStructureRepresentationType defines the representation for any non-time dimension data structure definition component.

Derivation:

*`RepresentationType`*` (restriction)`

4053

*`DataStructureRepresentationType`*` (restriction)`

4054

`SimpleDataStructureRepresentationType`

Content:

`(TextFormat | (Enumeration, EnumerationFormat?))`

4059

4060

Element Documentation:

4061

4062

| **Name** | **Type** | **Documentation** |

4063

| --- --| --- --| --- --|

4064

| TextFormat | SimpleComponentTextF ormatType | TextFormat describes an uncoded textual format. |

4065

| Enumeration | CodelistReferenceTyp e | Enumeration references an item scheme that enumerates the allowable values for this representation. |

4066

| EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |

4067

4068

**TimeDimensionRepresentationType:** TimeDimensionRepresentationType defines the representation for the time dimension. Enumerated values are not allowed.

Derivation:

*`RepresentationType`*` (restriction)`

4073

*`DataStructureRepresentationType`*` (restriction)`

4074

`SimpleDataStructureRepresentationType (restriction)`

4075

`TimeDimensionRepresentationType`

Content:

`TextFormat`

Element Documentation:

4082

4083

| **Name** | **Type** | **Documentation** |

4084

| --- --| --- --| --- --|

4085

| TextFormat | TimeTextFormatType | TextFormat describes an uncoded textual format. |

4086

4087

**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)`

4092

*`IdentifiableType`*` (extension)`

4093

*`NameableType`*` (extension)`

4094

*`VersionableType`*` (restriction)`

4095

*`MaintainableBaseType`*` (extension)`

4096

*`MaintainableType`*` (restriction)`

4097

*`StructureUsageType`*` (restriction)`

`DataflowType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Structure?`

4107

4108

Attribute Documentation:

4109

4110

| **Name** | **Type** | **Documentation** |

4111

| --- --| --- --| --- --|

4112

| id | IDType | The id is the identifier for the object. |

4113

| urn | DataflowUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4114

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4115

| 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. |

4116

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4117

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4118

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4119

| 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. |

4120

| 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. |

4121

| 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. |

4122

| 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’. |

4123

4124

Element Documentation:

4125

4126

| **Name** | **Type** | **Documentation** |

4127

| --- --| --- --| --- --|

4128

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4129

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4130

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4131

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4132

| Structure | DataStructureReferen ceType | Structure provides a reference to the data structure definition which defines the structure of all data for this flow. |

4133

4134

***HierarchyBaseType*:** HierarchyBaseType is an abstract base class that is the basis for the HierarchyType. It requires that a name be supplied.

Derivation:

*`AnnotableType`*` (extension)`

4139

*`IdentifiableType`*` (extension)`

4140

*`NameableType`*` (extension)`

4141

*`VersionableType`*` (restriction)`

4142

*`MaintainableBaseType`*` (extension)`

4143

*`MaintainableType`*` (restriction)`

4144

*`HierarchyBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

4153

4154

Attribute Documentation:

4155

4156

| **Name** | **Type** | **Documentation** |

4157

| --- --| --- --| --- --|

4158

| id | IDType | The id is the identifier for the object. |

4159

| urn | HierarchyUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4160

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4161

| 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. |

4162

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4163

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4164

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4165

| 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. |

4166

| 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. |

4167

| 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. |

4168

| 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’. |

4169

4170

Element Documentation:

4171

4172

| **Name** | **Type** | **Documentation** |

4173

| --- --| --- --| --- --|

4174

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4175

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4176

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4177

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4178

4179

**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)`

4184

*`IdentifiableType`*` (extension)`

4185

*`NameableType`*` (extension)`

4186

*`VersionableType`*` (restriction)`

4187

*`MaintainableBaseType`*` (extension)`

4188

*`MaintainableType`*` (restriction)`

4189

*`HierarchyBaseType`*` (extension)`

`HierarchyType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, hasFormalLevels`

Content:

`Annotations?, Link*, Name+, Description*, Level?, HierarchicalCode+`

4199

4200

Attribute Documentation:

4201

4202

| **Name** | **Type** | **Documentation** |

4203

| --- --| --- --| --- --|

4204

| id | IDType | The id is the identifier for the object. |

4205

| urn | HierarchyUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4206

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4207

| 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. |

4208

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4209

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4210

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4211

| 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. |

4212

| 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. |

4213

| 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. |

4214

| 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’. |

4215

| 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. |

4216

4217

Element Documentation:

4218

4219

| **Name** | **Type** | **Documentation** |

4220

| --- --| --- --| --- --|

4221

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4222

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4223

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4224

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4225

| 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. |

4226

| HierarchicalCode | HierarchicalCodeType | HierarchicalCode is used to assemble the codes from the codelist(s) referenced into a hierarchy. |

4227

4228

***HierarchicalCodeBaseType*:** HierarchicalCodeBaseType is an abstract base type the creates the basis for the HierarchicalCodeType. It removes the urn and uri.

Derivation:

*`AnnotableType`*` (extension)`

4233

*`IdentifiableType`*` (extension)`

4234

*`HierarchicalCodeBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*`

4243

4244

Attribute Documentation:

4245

4246

| **Name** | **Type** | **Documentation** |

4247

| --- --| --- --| --- --|

4248

| 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. |

4249

| urn | HierarchicalCodeUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4250

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4251

4252

Element Documentation:

4253

4254

| **Name** | **Type** | **Documentation** |

4255

| --- --| --- --| --- --|

4256

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4257

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4258

4259

**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)`

4264

*`IdentifiableType`*` (extension)`

4265

*`HierarchicalCodeBaseType`*` (extension)`

4266

`HierarchicalCodeType`

Attributes:

`id, urn?, uri?, validFrom?, validTo?`

Content:

`Annotations?, Link*, Code, HierarchicalCode*, Level?`

4275

4276

Attribute Documentation:

4277

4278

| **Name** | **Type** | **Documentation** |

4279

| --- --| --- --| --- --|

4280

| 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. |

4281

| urn | HierarchicalCodeUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4282

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4283

| 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. |

4284

| 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. |

4285

4286

Element Documentation:

4287

4288

| **Name** | **Type** | **Documentation** |

4289

| --- --| --- --| --- --|

4290

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4291

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4292

| Code | CodeReferenceType | Code provides a complete, explicit reference to a code through either its URN, or a complete reference to the codelist and code. |

4293

| HierarchicalCode | HierarchicalCodeType | HierarchicalCode is used to nest referenced codes into a value based hierarchy. |

4294

| 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. |

4295

4296

***LevelBaseType*:** LevelBaseType is an abstract base type that makes up the basis for the LevelType. It requires a name and id.

Derivation:

*`AnnotableType`*` (extension)`

4301

*`IdentifiableType`*` (extension)`

4302

*`NameableType`*` (restriction)`

*`LevelBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

4312

4313

Attribute Documentation:

4314

4315

| **Name** | **Type** | **Documentation** |

4316

| --- --| --- --| --- --|

4317

| id | IDType | The id is the identifier for the object. |

4318

| urn | LevelUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4319

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4320

4321

Element Documentation:

4322

4323

| **Name** | **Type** | **Documentation** |

4324

| --- --| --- --| --- --|

4325

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4326

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4327

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4328

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4329

4330

**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)`

4335

*`IdentifiableType`*` (extension)`

4336

*`NameableType`*` (restriction)`

4337

*`LevelBaseType`*` (extension)`

`LevelType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, CodingFormat?, Level?`

4347

4348

Attribute Documentation:

4349

4350

| **Name** | **Type** | **Documentation** |

4351

| --- --| --- --| --- --|

4352

| id | IDType | The id is the identifier for the object. |

4353

| urn | LevelUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4354

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4355

4356

Element Documentation:

4357

4358

| **Name** | **Type** | **Documentation** |

4359

| --- --| --- --| --- --|

4360

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4361

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4362

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4363

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4364

| 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. |

4365

| Level | LevelType | Level describes the next level down in the hierarchy. |

4366

4367

**CodingTextFormatType:**

Derivation:

`TextFormatType (restriction)`

4372

`BasicComponentTextFormatType (restriction)`

4373

`SimpleComponentTextFormatType (restriction)`

4374

`CodingTextFormatType`

Attributes:

`textType?, isSequence?, interval?, startValue?, endValue?, minLength?, maxLength?, minValue?, maxValue?, pattern?`

Content:

`{Empty}`

Attribute Documentation:

4385

4386

| **Name** | **Type** | **Documentation** |

4387

| --- --| --- --| --- --|

4388

| 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. |

4389

| 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. |

4390

| 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. |

4391

| 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. |

4392

| 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. |

4393

| minLength | xs:positiveInteger | The minLength attribute specifies the minimum and length of the value in characters. |

4394

| maxLength | xs:positiveInteger | The maxLength attribute specifies the maximum length of the value in characters. |

4395

| 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. |

4396

| 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. |

4397

| pattern | xs:string | The pattern attribute holds any regular expression permitted in the similar facet in W3C XML Schema. |

4398

4399

***HierarchyAssociationBaseType*:** HierarchyAssociationBaseType defines the base refinement of the HierarchyAssociationType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

4404

*`IdentifiableType`*` (extension)`

4405

*`NameableType`*` (extension)`

4406

*`VersionableType`*` (restriction)`

4407

*`MaintainableBaseType`*` (extension)`

4408

*`MaintainableType`*` (restriction)`

4409

*`HierarchyAssociationBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

4418

4419

Attribute Documentation:

4420

4421

| **Name** | **Type** | **Documentation** |

4422

| --- --| --- --| --- --|

4423

| id | IDType | The id is the identifier for the object. |

4424

| urn | HierarchyAssociation UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4425

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4426

| 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. |

4427

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4428

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4429

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4430

| 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. |

4431

| 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. |

4432

| 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. |

4433

| 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’. |

4434

4435

Element Documentation:

4436

4437

| **Name** | **Type** | **Documentation** |

4438

| --- --| --- --| --- --|

4439

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4440

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4441

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4442

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4443

4444

**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)`

4449

*`IdentifiableType`*` (extension)`

4450

*`NameableType`*` (extension)`

4451

*`VersionableType`*` (restriction)`

4452

*`MaintainableBaseType`*` (extension)`

4453

*`MaintainableType`*` (restriction)`

4454

`HierarchyAssociationType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, LinkedHierarchy, LinkedObject, ContextObject?`

4463

4464

Attribute Documentation:

4465

4466

| **Name** | **Type** | **Documentation** |

4467

| --- --| --- --| --- --|

4468

| id | IDType | The id is the identifier for the object. |

4469

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4470

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4471

| 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. |

4472

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4473

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4474

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4475

| 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. |

4476

| 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. |

4477

| 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. |

4478

| 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’. |

4479

4480

Element Documentation:

4481

4482

| **Name** | **Type** | **Documentation** |

4483

| --- --| --- --| --- --|

4484

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4485

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4486

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4487

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4488

| LinkedHierarchy | HierarchyReferenceTy pe | The associated hierarchy. |

4489

| LinkedObject | UrnReferenceType | Associates the Identifiable Artefact that needs the Hierarchy. |

4490

| ContextObject | UrnReferenceType | The context within which the association is performed. |

4491

4492

***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)`

4497

*`IdentifiableType`*` (extension)`

4498

*`NameableType`*` (extension)`

4499

*`VersionableType`*` (restriction)`

4500

*`MaintainableBaseType`*` (extension)`

4501

*`MaintainableType`*` (restriction)`

4502

*`StructureUsageType`*` (restriction)`

4503

*`MetadataflowBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Structure?`

4512

4513

Attribute Documentation:

4514

4515

| **Name** | **Type** | **Documentation** |

4516

| --- --| --- --| --- --|

4517

| id | IDType | The id is the identifier for the object. |

4518

| urn | MetadataflowUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4519

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4520

| 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. |

4521

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4522

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4523

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4524

| 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. |

4525

| 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. |

4526

| 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. |

4527

| 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’. |

4528

4529

Element Documentation:

4530

4531

| **Name** | **Type** | **Documentation** |

4532

| --- --| --- --| --- --|

4533

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4534

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4535

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4536

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4537

| Structure | MetadataStructureRef erenceType | Structure provides a reference to the metadata structure definition describing the structure of all reference metadata for this flow. |

4538

4539

**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)`

4544

*`IdentifiableType`*` (extension)`

4545

*`NameableType`*` (extension)`

4546

*`VersionableType`*` (restriction)`

4547

*`MaintainableBaseType`*` (extension)`

4548

*`MaintainableType`*` (restriction)`

4549

*`StructureUsageType`*` (restriction)`

4550

*`MetadataflowBaseType`*` (extension)`

`MetadataflowType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Structure?, Target+`

4560

4561

Attribute Documentation:

4562

4563

| **Name** | **Type** | **Documentation** |

4564

| --- --| --- --| --- --|

4565

| id | IDType | The id is the identifier for the object. |

4566

| urn | MetadataflowUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4567

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4568

| 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. |

4569

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4570

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4571

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4572

| 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. |

4573

| 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. |

4574

| 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. |

4575

| 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’. |

4576

4577

Element Documentation:

4578

4579

| **Name** | **Type** | **Documentation** |

4580

| --- --| --- --| --- --|

4581

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4582

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4583

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4584

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4585

| Structure | MetadataStructureRef erenceType | Structure provides a reference to the metadata structure definition describing the structure of all reference metadata for this flow. |

4586

| 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. |

4587

4588

**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)`

4593

*`IdentifiableType`*` (extension)`

4594

*`NameableType`*` (extension)`

4595

*`VersionableType`*` (restriction)`

4596

*`MaintainableBaseType`*` (extension)`

4597

*`MaintainableType`*` (restriction)`

4598

*`StructureType`*` (restriction)`

4599

`MetadataStructureType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, MetadataStructureComponents?`

4608

4609

Attribute Documentation:

4610

4611

| **Name** | **Type** | **Documentation** |

4612

| --- --| --- --| --- --|

4613

| id | IDType | The id is the identifier for the object. |

4614

| urn | MetadataStructureUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4615

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4616

| 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. |

4617

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4618

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4619

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4620

| 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. |

4621

| 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. |

4622

| 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. |

4623

| 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’. |

4624

4625

Element Documentation:

4626

4627

| **Name** | **Type** | **Documentation** |

4628

| --- --| --- --| --- --|

4629

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4630

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4631

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4632

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4633

| MetadataStructureCom ponents | MetadataStructureCom ponentsType | MetadataStructureComponents defines the grouping of the sets of the components that make up the metadata structure definition. |

4634

4635

**MetadataStructureComponentsBaseType:** MetadataStructureComponentsBaseType is an abstract base type that forms the basis for the MetadataStructureComponentsType.

Derivation:

*`GroupingType`*` (restriction)`

4640

`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)`

4651

`MetadataStructureComponentsBaseType (extension)`

4652

`MetadataStructureComponentsType`

Content:

`MetadataAttributeList`

4657

4658

Element Documentation:

4659

4660

| **Name** | **Type** | **Documentation** |

4661

| --- --| --- --| --- --|

4662

| 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. |

4663

4664

**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)`

4669

*`IdentifiableType`*` (extension)`

4670

*`ComponentListType`*` (restriction)`

4671

`MetadataAttributeListType`

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, MetadataAttribute+`

4680

4681

Attribute Documentation:

4682

4683

| **Name** | **Type** | **Documentation** |

4684

| --- --| --- --| --- --|

4685

| id (fixed: MetadataAttributeDescriptor) | IDType | The id attribute is provided in this case for completeness. However, its value is fixed to MetadataAttributeDescriptor. |

4686

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4687

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4688

4689

Element Documentation:

4690

4691

| **Name** | **Type** | **Documentation** |

4692

| --- --| --- --| --- --|

4693

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4694

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4695

| 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. |

4696

4697

***MetadataAttributeBaseType*:** MetadataAttributeBaseType is an abstract base type the serves as the basis for the MetadataAttributeType.

Derivation:

*`AnnotableType`*` (extension)`

4702

*`IdentifiableType`*` (extension)`

4703

*`ComponentBaseType`*` (extension)`

4704

*`ComponentType`*` (restriction)`

4705

*`MetadataAttributeBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?`

4714

4715

Attribute Documentation:

4716

4717

| **Name** | **Type** | **Documentation** |

4718

| --- --| --- --| --- --|

4719

| 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). |

4720

| urn | MetadataAttributeUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4721

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4722

4723

Element Documentation:

4724

4725

| **Name** | **Type** | **Documentation** |

4726

| --- --| --- --| --- --|

4727

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4728

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4729

| 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. |

4730

| 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. |

4731

4732

**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)`

4737

*`IdentifiableType`*` (extension)`

4738

*`ComponentBaseType`*` (extension)`

4739

*`ComponentType`*` (restriction)`

4740

*`MetadataAttributeBaseType`*` (extension)`

4741

`MetadataAttributeType`

Attributes:

`id?, urn?, uri?, minOccurs?, maxOccurs?, isPresentational?`

Content:

`Annotations?, Link*, ConceptIdentity, LocalRepresentation?, MetadataAttribute*`

4750

4751

Attribute Documentation:

4752

4753

| **Name** | **Type** | **Documentation** |

4754

| --- --| --- --| --- --|

4755

| 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). |

4756

| urn | MetadataAttributeUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4757

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4758

| minOccurs (default: 1) | xs: nonNegativeInteger | The minOccurs attribute indicates the minimum number of times this metadata attribute must occur within its parent object. |

4759

| maxOccurs (default: 1) | OccurenceType | The maxOccurs attribute indicates the maximum number of times this metadata attribute can occur within its parent object. |

4760

| 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. |

4761

4762

Element Documentation:

4763

4764

| **Name** | **Type** | **Documentation** |

4765

| --- --| --- --| --- --|

4766

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4767

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4768

| 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. |

4769

| 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. |

4770

| 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. |

4771

4772

**MetadataAttributeRepresentationType:** MetadataAttributeRepresentationType defines the possible local representations of a metadata attribute.

Derivation:

*`RepresentationType`*` (restriction)`

4777

`MetadataAttributeRepresentationType`

Content:

`(TextFormat | (Enumeration, EnumerationFormat?))`

4782

4783

Element Documentation:

4784

4785

| **Name** | **Type** | **Documentation** |

4786

| --- --| --- --| --- --|

4787

| TextFormat | BasicComponentTextFo rmatType | TextFormat describes an uncoded textual format. |

4788

| Enumeration | CodelistReferenceTyp e | Enumeration references an item scheme that enumerates the allowable values for this representation. |

4789

| EnumerationFormat | CodedTextFormatType | EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational. |

4790

4791

***OrganisationSchemeBaseType*:** OrganisationSchemeBaseType is an abstract base type for any organisation scheme.

Derivation:

*`AnnotableType`*` (extension)`

4796

*`IdentifiableType`*` (extension)`

4797

*`NameableType`*` (extension)`

4798

*`VersionableType`*` (restriction)`

4799

*`MaintainableBaseType`*` (extension)`

4800

*`MaintainableType`*` (restriction)`

4801

*`ItemSchemeType`*` (restriction)`

4802

*`OrganisationSchemeBaseType`*

Attributes:

`id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*`

4811

4812

Attribute Documentation:

4813

4814

| **Name** | **Type** | **Documentation** |

4815

| --- --| --- --| --- --|

4816

| id | IDType | The id is the identifier for the object. |

4817

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4818

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4819

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4820

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4821

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4822

| 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. |

4823

| 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. |

4824

| 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. |

4825

| 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’. |

4826

| 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. |

4827

4828

Element Documentation:

4829

4830

| **Name** | **Type** | **Documentation** |

4831

| --- --| --- --| --- --|

4832

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4833

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4834

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4835

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4836

4837

***OrganisationSchemeType*:** OrganisationSchemeType describes the structure of an organisation scheme.

Derivation:

*`AnnotableType`*` (extension)`

4842

*`IdentifiableType`*` (extension)`

4843

*`NameableType`*` (extension)`

4844

*`VersionableType`*` (restriction)`

4845

*`MaintainableBaseType`*` (extension)`

4846

*`MaintainableType`*` (restriction)`

4847

*`ItemSchemeType`*` (restriction)`

4848

*`OrganisationSchemeBaseType`*` (extension)`

4849

*`OrganisationSchemeType`*

Attributes:

`id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, `*`Organisation*`*

4858

4859

Attribute Documentation:

4860

4861

| **Name** | **Type** | **Documentation** |

4862

| --- --| --- --| --- --|

4863

| id | IDType | The id is the identifier for the object. |

4864

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4865

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4866

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4867

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4868

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4869

| 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. |

4870

| 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. |

4871

| 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. |

4872

| 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’. |

4873

| 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. |

4874

4875

Element Documentation:

4876

4877

| **Name** | **Type** | **Documentation** |

4878

| --- --| --- --| --- --|

4879

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4880

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4881

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4882

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4883

| *Organisation* | *OrganisationType* | Organisation is an abstract substitution head for a generic organisation. |

4884

4885

***BaseOrganisationType*:** BaseOrganisationType is an abstract base type the forms the basis for the OrganisationType.

Derivation:

*`AnnotableType`*` (extension)`

4890

*`IdentifiableType`*` (extension)`

4891

*`NameableType`*` (restriction)`

4892

*`ItemBaseType`*` (extension)`

4893

*`ItemType`*` (restriction)`

4894

*`BaseOrganisationType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Parent?`

4903

4904

Attribute Documentation:

4905

4906

| **Name** | **Type** | **Documentation** |

4907

| --- --| --- --| --- --|

4908

| id | IDType | The id is the identifier for the object. |

4909

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4910

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4911

4912

Element Documentation:

4913

4914

| **Name** | **Type** | **Documentation** |

4915

| --- --| --- --| --- --|

4916

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4917

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4918

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4919

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4920

| 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. |

4921

4922

***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)`

4927

*`IdentifiableType`*` (extension)`

4928

*`NameableType`*` (restriction)`

4929

*`ItemBaseType`*` (extension)`

4930

*`ItemType`*` (restriction)`

4931

*`BaseOrganisationType`*` (extension)`

*`OrganisationType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Parent?, Contact*`

4941

4942

Attribute Documentation:

4943

4944

| **Name** | **Type** | **Documentation** |

4945

| --- --| --- --| --- --|

4946

| id | IDType | The id is the identifier for the object. |

4947

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4948

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4949

4950

Element Documentation:

4951

4952

| **Name** | **Type** | **Documentation** |

4953

| --- --| --- --| --- --|

4954

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

4955

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

4956

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

4957

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

4958

| 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. |

4959

| Contact | ContactType | Contact describes a contact for the organisation, |

4960

4961

**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)`

4966

*`IdentifiableType`*` (extension)`

4967

*`NameableType`*` (extension)`

4968

*`VersionableType`*` (restriction)`

4969

*`MaintainableBaseType`*` (extension)`

4970

*`MaintainableType`*` (restriction)`

4971

*`ItemSchemeType`*` (restriction)`

4972

*`OrganisationSchemeBaseType`*` (extension)`

4973

*`OrganisationSchemeType`*` (restriction)`

`AgencySchemeType`

Attributes:

`id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, Agency*`

4983

4984

Attribute Documentation:

4985

4986

| **Name** | **Type** | **Documentation** |

4987

| --- --| --- --| --- --|

4988

| id (fixed: AGENCIES) | IDType | The id is the identifier for the object. |

4989

| urn | AgencySchemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

4990

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

4991

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

4992

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

4993

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

4994

| 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. |

4995

| 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. |

4996

| 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. |

4997

| 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’. |

4998

| 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. |

4999

5000

Element Documentation:

5001

5002

| **Name** | **Type** | **Documentation** |

5003

| --- --| --- --| --- --|

5004

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5005

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5006

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5007

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5008

| Agency | AgencyType | Agency is an organisation which maintains structural metadata such as classifications, concepts, data structures, and metadata structures. |

5009

5010

**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)`

5015

*`IdentifiableType`*` (extension)`

5016

*`NameableType`*` (extension)`

5017

*`VersionableType`*` (restriction)`

5018

*`MaintainableBaseType`*` (extension)`

5019

*`MaintainableType`*` (restriction)`

5020

*`ItemSchemeType`*` (restriction)`

5021

*`OrganisationSchemeBaseType`*` (extension)`

5022

*`OrganisationSchemeType`*` (restriction)`

5023

` DataConsumerSchemeType`

Attributes:

`id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, DataConsumer*`

5032

5033

Attribute Documentation:

5034

5035

| **Name** | **Type** | **Documentation** |

5036

| --- --| --- --| --- --|

5037

| id (fixed: DATA\_CONSUMERS) | IDType | The id is the identifier for the object. |

5038

| urn | DataConsumerSchemeUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5039

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5040

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5041

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5042

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5043

| 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. |

5044

| 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. |

5045

| 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. |

5046

| 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’. |

5047

| 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. |

5048

5049

Element Documentation:

5050

5051

| **Name** | **Type** | **Documentation** |

5052

| --- --| --- --| --- --|

5053

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5054

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5055

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5056

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5057

| DataConsumer | DataConsumerType | DataConsumer describes an organisation using data as input for further processing. |

5058

5059

**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)`

5064

*`IdentifiableType`*` (extension)`

5065

*`NameableType`*` (extension)`

5066

*`VersionableType`*` (restriction)`

5067

*`MaintainableBaseType`*` (extension)`

5068

*`MaintainableType`*` (restriction)`

5069

*`ItemSchemeType`*` (restriction)`

5070

*`OrganisationSchemeBaseType`*` (extension)`

5071

*`OrganisationSchemeType`*` (restriction)`

5072

`DataProviderSchemeType`

Attributes:

`id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, DataProvider*`

5081

5082

Attribute Documentation:

5083

5084

| **Name** | **Type** | **Documentation** |

5085

| --- --| --- --| --- --|

5086

| id (fixed: DATA\_PROVIDERS) | IDType | The id is the identifier for the object. |

5087

| urn | DataProviderSchemeUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5088

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5089

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5090

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5091

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5092

| 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. |

5093

| 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. |

5094

| 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. |

5095

| 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’. |

5096

| 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. |

5097

5098

Element Documentation:

5099

5100

| **Name** | **Type** | **Documentation** |

5101

| --- --| --- --| --- --|

5102

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5103

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5104

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5105

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5106

| DataProvider | DataProviderType | DataProvider describes an organisation that produces data. |

5107

5108

**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)`

5113

*`IdentifiableType`*` (extension)`

5114

*`NameableType`*` (extension)`

5115

*`VersionableType`*` (restriction)`

5116

*`MaintainableBaseType`*` (extension)`

5117

*`MaintainableType`*` (restriction)`

5118

*`ItemSchemeType`*` (restriction)`

5119

*`OrganisationSchemeBaseType`*` (extension)`

5120

*`OrganisationSchemeType`*` (restriction)`

5121

`MetadataProviderSchemeType`

Attributes:

`id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, MetadataProvider*`

5130

5131

Attribute Documentation:

5132

5133

| **Name** | **Type** | **Documentation** |

5134

| --- --| --- --| --- --|

5135

| id (fixed: METADATA\_PROVIDERS) | IDType | The id is the identifier for the object. |

5136

| urn | MetadataProviderSche meUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5137

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5138

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5139

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5140

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5141

| 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. |

5142

| 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. |

5143

| 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. |

5144

| 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’. |

5145

| 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. |

5146

5147

Element Documentation:

5148

5149

| **Name** | **Type** | **Documentation** |

5150

| --- --| --- --| --- --|

5151

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5152

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5153

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5154

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5155

| MetadataProvider | MetadataProviderType | MetadataProvider describes an organisation that produces metadata . |

5156

5157

**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)`

5162

*`IdentifiableType`*` (extension)`

5163

*`NameableType`*` (extension)`

5164

*`VersionableType`*` (restriction)`

5165

*`MaintainableBaseType`*` (extension)`

5166

*`MaintainableType`*` (restriction)`

5167

*`ItemSchemeType`*` (restriction)`

5168

*`OrganisationSchemeBaseType`*` (extension)`

5169

*`OrganisationSchemeType`*` (restriction)`

5170

`OrganisationUnitSchemeType`

Attributes:

`id, urn?, uri?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, OrganisationUnit*`

5179

5180

Attribute Documentation:

5181

5182

| **Name** | **Type** | **Documentation** |

5183

| --- --| --- --| --- --|

5184

| id | IDType | The id is the identifier for the object. |

5185

| urn | OrganisationUnitSche meUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5186

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5187

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5188

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5189

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5190

| 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. |

5191

| 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. |

5192

| 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. |

5193

| 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’. |

5194

| isPartial (default: false) | xs:boolean | The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a data structure in the context of a constraint. |

5195

5196

Element Documentation:

5197

5198

| **Name** | **Type** | **Documentation** |

5199

| --- --| --- --| --- --|

5200

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5201

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5202

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5203

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5204

| OrganisationUnit | OrganisationUnitType | OrganisationUnit describes a generic organisation, which serves not predefined role in SDMX. |

5205

5206

**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)`

5211

*`IdentifiableType`*` (extension)`

5212

*`NameableType`*` (restriction)`

5213

*`ItemBaseType`*` (extension)`

5214

*`ItemType`*` (restriction)`

5215

*`BaseOrganisationType`*` (extension)`

5216

*`OrganisationType`*` (restriction)`

`AgencyType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Contact*`

5226

5227

Attribute Documentation:

5228

5229

| **Name** | **Type** | **Documentation** |

5230

| --- --| --- --| --- --|

5231

| 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). |

5232

| urn | AgencyUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5233

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5234

5235

Element Documentation:

5236

5237

| **Name** | **Type** | **Documentation** |

5238

| --- --| --- --| --- --|

5239

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5240

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5241

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5242

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5243

| Contact | ContactType | Contact describes a contact for the organisation, |

5244

5245

**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)`

5250

*`IdentifiableType`*` (extension)`

5251

*`NameableType`*` (restriction)`

5252

*`ItemBaseType`*` (extension)`

5253

*`ItemType`*` (restriction)`

5254

*`BaseOrganisationType`*` (extension)`

5255

*`OrganisationType`*` (restriction)`

`DataConsumerType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Contact*`

5265

5266

Attribute Documentation:

5267

5268

| **Name** | **Type** | **Documentation** |

5269

| --- --| --- --| --- --|

5270

| id | IDType | The id is the identifier for the object. |

5271

| urn | DataConsumerUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5272

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5273

5274

Element Documentation:

5275

5276

| **Name** | **Type** | **Documentation** |

5277

| --- --| --- --| --- --|

5278

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5279

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5280

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5281

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5282

| Contact | ContactType | Contact describes a contact for the organisation, |

5283

5284

**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)`

5289

*`IdentifiableType`*` (extension)`

5290

*`NameableType`*` (restriction)`

5291

*`ItemBaseType`*` (extension)`

5292

*`ItemType`*` (restriction)`

5293

*`BaseOrganisationType`*` (extension)`

5294

*`OrganisationType`*` (restriction)`

`DataProviderType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Contact*`

5304

5305

Attribute Documentation:

5306

5307

| **Name** | **Type** | **Documentation** |

5308

| --- --| --- --| --- --|

5309

| id | IDType | The id is the identifier for the object. |

5310

| urn | DataProviderUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5311

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5312

5313

Element Documentation:

5314

5315

| **Name** | **Type** | **Documentation** |

5316

| --- --| --- --| --- --|

5317

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5318

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5319

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5320

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5321

| Contact | ContactType | Contact describes a contact for the organisation, |

5322

5323

**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)`

5328

*`IdentifiableType`*` (extension)`

5329

*`NameableType`*` (restriction)`

5330

*`ItemBaseType`*` (extension)`

5331

*`ItemType`*` (restriction)`

5332

*`BaseOrganisationType`*` (extension)`

5333

*`OrganisationType`*` (restriction)`

5334

`MetadataProviderType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Contact*`

5343

5344

Attribute Documentation:

5345

5346

| **Name** | **Type** | **Documentation** |

5347

| --- --| --- --| --- --|

5348

| id | IDType | The id is the identifier for the object. |

5349

| urn | MetadataProviderUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5350

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5351

5352

Element Documentation:

5353

5354

| **Name** | **Type** | **Documentation** |

5355

| --- --| --- --| --- --|

5356

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5357

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5358

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5359

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5360

| Contact | ContactType | Contact describes a contact for the organisation, |

5361

5362

**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)`

5367

*`IdentifiableType`*` (extension)`

5368

*`NameableType`*` (restriction)`

5369

*`ItemBaseType`*` (extension)`

5370

*`ItemType`*` (restriction)`

5371

*`BaseOrganisationType`*` (extension)`

5372

*`OrganisationType`*` (restriction)`

5373

`OrganisationUnitType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Parent?, Contact*`

5382

5383

Attribute Documentation:

5384

5385

| **Name** | **Type** | **Documentation** |

5386

| --- --| --- --| --- --|

5387

| id | IDType | The id is the identifier for the object. |

5388

| urn | OrganisationUnitUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5389

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5390

5391

Element Documentation:

5392

5393

| **Name** | **Type** | **Documentation** |

5394

| --- --| --- --| --- --|

5395

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5396

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5397

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5398

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5399

| 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. |

5400

| Contact | ContactType | Contact describes a contact for the organisation, |

5401

5402

**ContactType:** ContactType describes the structure of a contact's details.

Attributes:

`id?`

Content:

`Name*, Department*, Role*, (Telephone | Fax | X400 | URI | Email)*`

5411

5412

Attribute Documentation:

5413

5414

| **Name** | **Type** | **Documentation** |

5415

| --- --| --- --| --- --|

5416

| id | IDType | The id attribute is used to carry user id information for the contact. |

5417

5418

Element Documentation:

5419

5420

| **Name** | **Type** | **Documentation** |

5421

| --- --| --- --| --- --|

5422

| Name | TextType | Name is a reusable element, used for providing a human-readable name for an object. |

5423

| Department | TextType | Department is designation of the organisational structure by a linguistic expression, within which the contact person works. |

5424

| Role | TextType | Role is the responsibility of the contact person with respect to the object for which this person is the contact. |

5425

| Telephone | xs:string | Telephone holds the telephone number for the contact person. |

5426

| Fax | xs:string | Fax holds the fax number for the contact person. |

5427

| X400 | xs:string | X400 holds the X.400 address for the contact person. |

5428

| URI | xs:anyURI | URI holds an information URL for the contact person. |

5429

| Email | xs:string | Email holds the email address for the contact person. |

5430

5431

***ProvisionAgreementBaseType*:** ProvisionAgreementBaseType defines the base refinement of the ProvisionAgreementType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

5436

*`IdentifiableType`*` (extension)`

5437

*`NameableType`*` (extension)`

5438

*`VersionableType`*` (restriction)`

5439

*`MaintainableBaseType`*` (extension)`

5440

*`MaintainableType`*` (restriction)`

5441

*`ProvisionAgreementBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

5450

5451

Attribute Documentation:

5452

5453

| **Name** | **Type** | **Documentation** |

5454

| --- --| --- --| --- --|

5455

| id | IDType | The id is the identifier for the object. |

5456

| urn | ProvisionAgreementUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5457

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5458

| 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. |

5459

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5460

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5461

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5462

| 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. |

5463

| 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. |

5464

| 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. |

5465

| 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’. |

5466

5467

Element Documentation:

5468

5469

| **Name** | **Type** | **Documentation** |

5470

| --- --| --- --| --- --|

5471

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5472

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5473

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5474

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5475

5476

**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)`

5481

*`IdentifiableType`*` (extension)`

5482

*`NameableType`*` (extension)`

5483

*`VersionableType`*` (restriction)`

5484

*`MaintainableBaseType`*` (extension)`

5485

*`MaintainableType`*` (restriction)`

5486

*`ProvisionAgreementBaseType`*` (extension)`

5487

`ProvisionAgreementType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Dataflow, DataProvider`

5496

5497

Attribute Documentation:

5498

5499

| **Name** | **Type** | **Documentation** |

5500

| --- --| --- --| --- --|

5501

| id | IDType | The id is the identifier for the object. |

5502

| urn | ProvisionAgreementUr nType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5503

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5504

| 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. |

5505

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5506

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5507

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5508

| 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. |

5509

| 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. |

5510

| 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. |

5511

| 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’. |

5512

5513

Element Documentation:

5514

5515

| **Name** | **Type** | **Documentation** |

5516

| --- --| --- --| --- --|

5517

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5518

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5519

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5520

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5521

| 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. |

5522

| 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. |

5523

5524

***MetadataProvisionAgreementBaseType*:** MetadataProvisionAgreementBaseType defines the base refinement of the MetadataProvisionAgreementType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

5529

*`IdentifiableType`*` (extension)`

5530

*`NameableType`*` (extension)`

5531

*`VersionableType`*` (restriction)`

5532

*`MaintainableBaseType`*` (extension)`

5533

*`MaintainableType`*` (restriction)`

5534

*`MetadataProvisionAgreementBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

5543

5544

Attribute Documentation:

5545

5546

| **Name** | **Type** | **Documentation** |

5547

| --- --| --- --| --- --|

5548

| id | IDType | The id is the identifier for the object. |

5549

| urn | MetadataProvisionAgr eementUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5550

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5551

| 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. |

5552

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5553

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5554

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5555

| isExternalReference (default: false) | xs:boolean | The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. |

5556

| serviceURL | xs:anyURI | The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. |

5557

| structureURL | xs:anyURI | The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. |

5558

| 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’. |

5559

5560

Element Documentation:

5561

5562

| **Name** | **Type** | **Documentation** |

5563

| --- --| --- --| --- --|

5564

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5565

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5566

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5567

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5568

5569

**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)`

5574

*`IdentifiableType`*` (extension)`

5575

*`NameableType`*` (extension)`

5576

*`VersionableType`*` (restriction)`

5577

*`MaintainableBaseType`*` (extension)`

5578

*`MaintainableType`*` (restriction)`

5579

*`MetadataProvisionAgreementBaseType`*` (extension)`

5580

`MetadataProvisionAgreementType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Metadataflow, MetadataProvider, Target*`

5589

5590

Attribute Documentation:

5591

5592

| **Name** | **Type** | **Documentation** |

5593

| --- --| --- --| --- --|

5594

| id | IDType | The id is the identifier for the object. |

5595

| urn | MetadataProvisionAgr eementUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5596

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5597

| 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. |

5598

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5599

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5600

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5601

| 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. |

5602

| 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. |

5603

| 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. |

5604

| 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’. |

5605

5606

Element Documentation:

5607

5608

| **Name** | **Type** | **Documentation** |

5609

| --- --| --- --| --- --|

5610

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5611

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5612

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5613

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5614

| 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. |

5615

| 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. |

5616

| 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. |

5617

5618

***ProcessBaseType*:** ProcessBaseType defines the base refinement of the ProcessType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

5623

*`IdentifiableType`*` (extension)`

5624

*`NameableType`*` (extension)`

5625

*`VersionableType`*` (restriction)`

5626

*`MaintainableBaseType`*` (extension)`

5627

*`MaintainableType`*` (restriction)`

*`ProcessBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

5637

5638

Attribute Documentation:

5639

5640

| **Name** | **Type** | **Documentation** |

5641

| --- --| --- --| --- --|

5642

| id | IDType | The id is the identifier for the object. |

5643

| urn | ProcessUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5644

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5645

| 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. |

5646

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5647

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5648

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5649

| 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. |

5650

| 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. |

5651

| 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. |

5652

| 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’. |

5653

5654

Element Documentation:

5655

5656

| **Name** | **Type** | **Documentation** |

5657

| --- --| --- --| --- --|

5658

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5659

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5660

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5661

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5662

5663

**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)`

5668

*`IdentifiableType`*` (extension)`

5669

*`NameableType`*` (extension)`

5670

*`VersionableType`*` (restriction)`

5671

*`MaintainableBaseType`*` (extension)`

5672

*`MaintainableType`*` (restriction)`

5673

*`ProcessBaseType`*` (extension)`

`ProcessType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, ProcessStep*`

5683

5684

Attribute Documentation:

5685

5686

| **Name** | **Type** | **Documentation** |

5687

| --- --| --- --| --- --|

5688

| id | IDType | The id is the identifier for the object. |

5689

| urn | ProcessUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5690

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5691

| 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. |

5692

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5693

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5694

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5695

| 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. |

5696

| 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. |

5697

| 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. |

5698

| 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’. |

5699

5700

Element Documentation:

5701

5702

| **Name** | **Type** | **Documentation** |

5703

| --- --| --- --| --- --|

5704

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5705

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5706

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5707

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5708

| 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. |

5709

5710

***ProcessStepBaseType*:** ProcessStepBaseType is an abstract base type used as the basis for the ProcessStepType.

Derivation:

*`AnnotableType`*` (extension)`

5715

*`IdentifiableType`*` (extension)`

5716

*`NameableType`*` (restriction)`

5717

*`ProcessStepBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

5726

5727

Attribute Documentation:

5728

5729

| **Name** | **Type** | **Documentation** |

5730

| --- --| --- --| --- --|

5731

| id | IDType | The id is the identifier for the object. |

5732

| urn | ProcessStepUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5733

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5734

5735

Element Documentation:

5736

5737

| **Name** | **Type** | **Documentation** |

5738

| --- --| --- --| --- --|

5739

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5740

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5741

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5742

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5743

5744

**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)`

5749

*`IdentifiableType`*` (extension)`

5750

*`NameableType`*` (restriction)`

5751

*`ProcessStepBaseType`*` (extension)`

`ProcessStepType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, Input*, Output*, Computation?, Transition*, ProcessStep*`

5761

5762

Attribute Documentation:

5763

5764

| **Name** | **Type** | **Documentation** |

5765

| --- --| --- --| --- --|

5766

| id | IDType | The id is the identifier for the object. |

5767

| urn | ProcessStepUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5768

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5769

5770

Element Documentation:

5771

5772

| **Name** | **Type** | **Documentation** |

5773

| --- --| --- --| --- --|

5774

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5775

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5776

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5777

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5778

| Input | InputOutputType | Input references an object which is an input to the process step. |

5779

| Output | InputOutputType | Output references an object which is an output form the process step. |

5780

| 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. |

5781

| 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. |

5782

| 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. |

5783

5784

***TransitionBaseType*:** TransitionBaseType defines the base refinement of the TransitionType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

5789

*`IdentifiableType`*` (extension)`

5790

*`TransitionBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*`

5799

5800

Attribute Documentation:

5801

5802

| **Name** | **Type** | **Documentation** |

5803

| --- --| --- --| --- --|

5804

| id | IDType | The id is the identifier for the object. |

5805

| urn | TransitionUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5806

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5807

5808

Element Documentation:

5809

5810

| **Name** | **Type** | **Documentation** |

5811

| --- --| --- --| --- --|

5812

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5813

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5814

5815

**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)`

5820

*`IdentifiableType`*` (extension)`

5821

*`TransitionBaseType`*` (extension)`

`TransitionType`

Attributes:

`id?, urn?, uri?, localID?`

Content:

`Annotations?, Link*, TargetStep, Condition+`

5831

5832

Attribute Documentation:

5833

5834

| **Name** | **Type** | **Documentation** |

5835

| --- --| --- --| --- --|

5836

| id | IDType | The id is the identifier for the object. |

5837

| urn | TransitionUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5838

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5839

| localID | IDType | The localID attribute is an optional identification for the transition within the process. |

5840

5841

Element Documentation:

5842

5843

| **Name** | **Type** | **Documentation** |

5844

| --- --| --- --| --- --|

5845

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5846

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5847

| TargetStep | NestedIDType | TargetStep references a process step within the process that should be transitioned to, should the conditions described be met. |

5848

| 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. |

5849

5850

**ComputationType:** ComputationType describes a computation in a process.

Derivation:

*`AnnotableType`*` (extension)`

`ComputationType`

Attributes:

`localID?, softwarePackage?, softwareLanguage?, softwareVersion?`

Content:

`Annotations?, Description+`

5864

5865

Attribute Documentation:

5866

5867

| **Name** | **Type** | **Documentation** |

5868

| --- --| --- --| --- --|

5869

| localID | IDType | The localID attribute is an optional identification for the computation within the process. |

5870

| softwarePackage | xs:string | The softwarePackage attribute holds the name of the software package that is used to perform the computation. |

5871

| softwareLanguage | xs:string | The softwareLanguage attribute holds the coding language that the software package used to perform the computation is written in. |

5872

| softwareVersion | xs:string | The softwareVersion attribute hold the version of the software package that is used to perform that computation. |

5873

5874

Element Documentation:

5875

5876

| **Name** | **Type** | **Documentation** |

5877

| --- --| --- --| --- --|

5878

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5879

| 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, |

5880

5881

**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`

5895

5896

Attribute Documentation:

5897

5898

| **Name** | **Type** | **Documentation** |

5899

| --- --| --- --| --- --|

5900

| localID | IDType | The localID attribute is an optional identification for the input or output within the process. |

5901

5902

Element Documentation:

5903

5904

| **Name** | **Type** | **Documentation** |

5905

| --- --| --- --| --- --|

5906

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5907

| 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. |

5908

5909

**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)`

5914

*`IdentifiableType`*` (extension)`

5915

*`NameableType`*` (extension)`

5916

*`VersionableType`*` (restriction)`

5917

*`MaintainableBaseType`*` (extension)`

5918

*`MaintainableType`*` (restriction)`

5919

*`ItemSchemeType`*` (restriction)`

5920

`ReportingTaxonomyType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, ReportingCategory*`

5929

5930

Attribute Documentation:

5931

5932

| **Name** | **Type** | **Documentation** |

5933

| --- --| --- --| --- --|

5934

| id | IDType | The id is the identifier for the object. |

5935

| urn | ReportingTaxonomyUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5936

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5937

| 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. |

5938

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

5939

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

5940

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

5941

| 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. |

5942

| 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. |

5943

| 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. |

5944

| 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’. |

5945

| 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. |

5946

5947

Element Documentation:

5948

5949

| **Name** | **Type** | **Documentation** |

5950

| --- --| --- --| --- --|

5951

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5952

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5953

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5954

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5955

| ReportingCategory | ReportingCategoryTyp e | ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages. |

5956

5957

***ReportingCategoryBaseType*:** ReportingCategoryBaseType is an abstract base type that serves as the basis for the ReportingCategoryType.

Derivation:

*`AnnotableType`*` (extension)`

5962

*`IdentifiableType`*` (extension)`

5963

*`NameableType`*` (restriction)`

5964

*`ItemBaseType`*` (extension)`

5965

*`ItemType`*` (restriction)`

5966

*`ReportingCategoryBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, ReportingCategory*`

5975

5976

Attribute Documentation:

5977

5978

| **Name** | **Type** | **Documentation** |

5979

| --- --| --- --| --- --|

5980

| id | IDType | The id is the identifier for the object. |

5981

| urn | ReportingCategoryUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

5982

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

5983

5984

Element Documentation:

5985

5986

| **Name** | **Type** | **Documentation** |

5987

| --- --| --- --| --- --|

5988

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

5989

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

5990

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

5991

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

5992

| ReportingCategory | ReportingCategoryTyp e | ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages. |

5993

5994

**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)`

5999

*`IdentifiableType`*` (extension)`

6000

*`NameableType`*` (restriction)`

6001

*`ItemBaseType`*` (extension)`

6002

*`ItemType`*` (restriction)`

6003

*`ReportingCategoryBaseType`*` (extension)`

6004

`ReportingCategoryType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, ReportingCategory*, (StructuralMetadata* | ProvisioningMetadata*)`

6013

6014

Attribute Documentation:

6015

6016

| **Name** | **Type** | **Documentation** |

6017

| --- --| --- --| --- --|

6018

| id | IDType | The id is the identifier for the object. |

6019

| urn | ReportingCategoryUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6020

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6021

6022

Element Documentation:

6023

6024

| **Name** | **Type** | **Documentation** |

6025

| --- --| --- --| --- --|

6026

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6027

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6028

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6029

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6030

| ReportingCategory | ReportingCategoryTyp e | ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages. |

6031

| 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. |

6032

| 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. |

6033

6034

***ItemSchemeMapBaseType*:** ItemSchemeMapBaseType is an abstract base type which forms the basis for the ItemSchemeMapType.

Derivation:

*`AnnotableType`*` (extension)`

6039

*`IdentifiableType`*` (extension)`

6040

*`NameableType`*` (extension)`

6041

*`VersionableType`*` (restriction)`

6042

*`MaintainableBaseType`*` (extension)`

6043

*`MaintainableType`*` (restriction)`

6044

*`ItemSchemeMapBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

6053

6054

Attribute Documentation:

6055

6056

| **Name** | **Type** | **Documentation** |

6057

| --- --| --- --| --- --|

6058

| id | IDType | The id is the identifier for the object. |

6059

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6060

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6061

| 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. |

6062

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6063

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6064

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6065

| 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. |

6066

| 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. |

6067

| 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. |

6068

| 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’. |

6069

6070

Element Documentation:

6071

6072

| **Name** | **Type** | **Documentation** |

6073

| --- --| --- --| --- --|

6074

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6075

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6076

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6077

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6078

6079

***ItemSchemeMapType*:** ItemSchemeMapType is an abstract base type which forms the basis for mapping items between item schemes of the same type.

Derivation:

*`AnnotableType`*` (extension)`

6084

*`IdentifiableType`*` (extension)`

6085

*`NameableType`*` (extension)`

6086

*`VersionableType`*` (restriction)`

6087

*`MaintainableBaseType`*` (extension)`

6088

*`MaintainableType`*` (restriction)`

6089

*`ItemSchemeMapBaseType`*` (extension)`

6090

*`ItemSchemeMapType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Source, Target, ItemMap*`

6099

6100

Attribute Documentation:

6101

6102

| **Name** | **Type** | **Documentation** |

6103

| --- --| --- --| --- --|

6104

| id | IDType | The id is the identifier for the object. |

6105

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6106

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6107

| 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. |

6108

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6109

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6110

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6111

| 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. |

6112

| 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. |

6113

| 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. |

6114

| 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’. |

6115

6116

Element Documentation:

6117

6118

| **Name** | **Type** | **Documentation** |

6119

| --- --| --- --| --- --|

6120

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6121

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6122

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6123

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6124

| Source | MaintainableUrnRefer enceType | Source provides a reference to the item scheme which items are mapped from. |

6125

| Target | MaintainableUrnRefer enceType | Target provides a reference to the item scheme which items are mapped to. |

6126

| ItemMap | SingleValueMappingTy pe | |

6127

6128

**OrganisationSchemeMapType:** OrganisationSchemeMapType defines the structure of a map which identifies relationships between organisations in different organisation schemes.

Derivation:

*`AnnotableType`*` (extension)`

6133

*`IdentifiableType`*` (extension)`

6134

*`NameableType`*` (extension)`

6135

*`VersionableType`*` (restriction)`

6136

*`MaintainableBaseType`*` (extension)`

6137

*`MaintainableType`*` (restriction)`

6138

*`ItemSchemeMapBaseType`*` (extension)`

6139

*`ItemSchemeMapType`*` (restriction)`

6140

`OrganisationSchemeMapType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Source, Target, ItemMap*`

6149

6150

Attribute Documentation:

6151

6152

| **Name** | **Type** | **Documentation** |

6153

| --- --| --- --| --- --|

6154

| id | IDType | The id is the identifier for the object. |

6155

| urn | OrganisationSchemeMa pUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6156

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6157

| 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. |

6158

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6159

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6160

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6161

| 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. |

6162

| 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. |

6163

| 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. |

6164

| 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’. |

6165

6166

Element Documentation:

6167

6168

| **Name** | **Type** | **Documentation** |

6169

| --- --| --- --| --- --|

6170

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6171

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6172

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6173

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6174

| Source | OrganisationSchemeRe ferenceType | Source provides a reference to the item scheme which items are mapped from. |

6175

| Target | OrganisationSchemeRe ferenceType | Target provides a reference to the item scheme which items are mapped to. |

6176

| ItemMap | SingleValueMappingTy pe | |

6177

6178

**CategorySchemeMapType:** CategorySchemeMapType defines the structure of a map which identifies relationships between categories in different category schemes.

Derivation:

*`AnnotableType`*` (extension)`

6183

*`IdentifiableType`*` (extension)`

6184

*`NameableType`*` (extension)`

6185

*`VersionableType`*` (restriction)`

6186

*`MaintainableBaseType`*` (extension)`

6187

*`MaintainableType`*` (restriction)`

6188

*`ItemSchemeMapBaseType`*` (extension)`

6189

*`ItemSchemeMapType`*` (restriction)`

6190

`CategorySchemeMapType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Source, Target, ItemMap*`

6199

6200

Attribute Documentation:

6201

6202

| **Name** | **Type** | **Documentation** |

6203

| --- --| --- --| --- --|

6204

| id | IDType | The id is the identifier for the object. |

6205

| urn | CategorySchemeMapUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6206

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6207

| 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. |

6208

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6209

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6210

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6211

| 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. |

6212

| 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. |

6213

| 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. |

6214

| 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’. |

6215

6216

Element Documentation:

6217

6218

| **Name** | **Type** | **Documentation** |

6219

| --- --| --- --| --- --|

6220

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6221

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6222

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6223

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6224

| Source | CategorySchemeRefere nceType | Source provides a reference to the item scheme which items are mapped from. |

6225

| Target | CategorySchemeRefere nceType | Target provides a reference to the item scheme which items are mapped to. |

6226

| ItemMap | SingleValueMappingTy pe | |

6227

6228

**ConceptSchemeMapType:** ConceptSchemeMapType defines the structure of a map which identifies relationships between concepts in different concept schemes.

Derivation:

*`AnnotableType`*` (extension)`

6233

*`IdentifiableType`*` (extension)`

6234

*`NameableType`*` (extension)`

6235

*`VersionableType`*` (restriction)`

6236

*`MaintainableBaseType`*` (extension)`

6237

*`MaintainableType`*` (restriction)`

6238

*`ItemSchemeMapBaseType`*` (extension)`

6239

*`ItemSchemeMapType`*` (restriction)`

6240

` ConceptSchemeMapType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Source, Target, ItemMap*`

6249

6250

Attribute Documentation:

6251

6252

| **Name** | **Type** | **Documentation** |

6253

| --- --| --- --| --- --|

6254

| id | IDType | The id is the identifier for the object. |

6255

| urn | ConceptSchemeMapUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6256

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6257

| 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. |

6258

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6259

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6260

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6261

| 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. |

6262

| 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. |

6263

| 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. |

6264

| 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’. |

6265

6266

Element Documentation:

6267

6268

| **Name** | **Type** | **Documentation** |

6269

| --- --| --- --| --- --|

6270

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6271

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6272

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6273

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6274

| Source | ConceptSchemeReferen ceType | Source provides a reference to the item scheme which items are mapped from. |

6275

| Target | ConceptSchemeReferen ceType | Target provides a reference to the item scheme which items are mapped to. |

6276

| ItemMap | SingleValueMappingTy pe | |

6277

6278

**ReportingTaxonomyMapType:** ReportingTaxonomyMapType defines the structure of a map which identifies relationships between reporting categories in different reporting taxonomies.

Derivation:

*`AnnotableType`*` (extension)`

6283

*`IdentifiableType`*` (extension)`

6284

*`NameableType`*` (extension)`

6285

*`VersionableType`*` (restriction)`

6286

*`MaintainableBaseType`*` (extension)`

6287

*`MaintainableType`*` (restriction)`

6288

*`ItemSchemeMapBaseType`*` (extension)`

6289

*`ItemSchemeMapType`*` (restriction)`

6290

`ReportingTaxonomyMapType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, Source, Target, ItemMap*`

6299

6300

Attribute Documentation:

6301

6302

| **Name** | **Type** | **Documentation** |

6303

| --- --| --- --| --- --|

6304

| id | IDType | The id is the identifier for the object. |

6305

| urn | ReportingTaxonomyMap UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6306

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6307

| 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. |

6308

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6309

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6310

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6311

| 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. |

6312

| 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. |

6313

| 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. |

6314

| 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’. |

6315

6316

Element Documentation:

6317

6318

| **Name** | **Type** | **Documentation** |

6319

| --- --| --- --| --- --|

6320

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6321

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6322

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6323

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6324

| Source | ReportingTaxonomyRef erenceType | Source provides a reference to the item scheme which items are mapped from. |

6325

| Target | ReportingTaxonomyRef erenceType | Target provides a reference to the item scheme which items are mapped to. |

6326

| ItemMap | SingleValueMappingTy pe | |

6327

6328

***StructureMapBaseType*:** StructureMapBaseType defines the base refinement of the StructureMapType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

6333

*`IdentifiableType`*` (extension)`

6334

*`NameableType`*` (extension)`

6335

*`VersionableType`*` (restriction)`

6336

*`MaintainableBaseType`*` (extension)`

6337

*`MaintainableType`*` (restriction)`

6338

*`StructureMapBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

6347

6348

Attribute Documentation:

6349

6350

| **Name** | **Type** | **Documentation** |

6351

| --- --| --- --| --- --|

6352

| id | IDType | The id is the identifier for the object. |

6353

| urn | StructureMapUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6354

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6355

| 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. |

6356

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6357

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6358

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6359

| 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. |

6360

| 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. |

6361

| 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. |

6362

| 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’. |

6363

6364

Element Documentation:

6365

6366

| **Name** | **Type** | **Documentation** |

6367

| --- --| --- --| --- --|

6368

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6369

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6370

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6371

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6372

6373

**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)`

6378

*`IdentifiableType`*` (extension)`

6379

*`NameableType`*` (extension)`

6380

*`VersionableType`*` (restriction)`

6381

*`MaintainableBaseType`*` (extension)`

6382

*`MaintainableType`*` (restriction)`

6383

*`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*`

6393

6394

Attribute Documentation:

6395

6396

| **Name** | **Type** | **Documentation** |

6397

| --- --| --- --| --- --|

6398

| id | IDType | The id is the identifier for the object. |

6399

| urn | StructureMapUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6400

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6401

| 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. |

6402

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6403

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6404

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6405

| 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. |

6406

| 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. |

6407

| 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. |

6408

| 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’. |

6409

6410

Element Documentation:

6411

6412

| **Name** | **Type** | **Documentation** |

6413

| --- --| --- --| --- --|

6414

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6415

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6416

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6417

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6418

| 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. |

6419

| 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. |

6420

| 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. |

6421

| DatePatternMap | DatePatternMapType | Provides the ability to map source to target date formats. The source date is described as a pattern (for example MM-YYYY). |

6422

| FrequencyFormatMappi ng | FrequencyFormatMappi ngType | |

6423

| 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. |

6424

| FixedValueMap | FixedValueMapType | FixedValueMap defines a fixed value for a source or target component in the mapping. |

6425

6426

**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*`

6436

6437

Element Documentation:

6438

6439

| **Name** | **Type** | **Documentation** |

6440

| --- --| --- --| --- --|

6441

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6442

| Source | IDType | |

6443

| Target | IDType | |

6444

| Value | xs:string | The fixed value for the component. |

6445

6446

**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?`

6456

6457

Element Documentation:

6458

6459

| **Name** | **Type** | **Documentation** |

6460

| --- --| --- --| --- --|

6461

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6462

| Source | IDType | |

6463

| Target | IDType | |

6464

| RepresentationMap | RepresentationMapRef erenceType | |

6465

6466

***FrequencyFormatMappingBaseType*:** FrequencyFormatMappingBaseType defines the base refinement of the FrequencyFormatMappingType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

6471

*`IdentifiableType`*` (extension)`

6472

*`FrequencyFormatMappingBaseType`*

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*`

6481

6482

Attribute Documentation:

6483

6484

| **Name** | **Type** | **Documentation** |

6485

| --- --| --- --| --- --|

6486

| id | IDType | The id is the identifier for the object. |

6487

| urn | FrequencyFormatMappi ngUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6488

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6489

6490

Element Documentation:

6491

6492

| **Name** | **Type** | **Documentation** |

6493

| --- --| --- --| --- --|

6494

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6495

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6496

6497

**FrequencyFormatMappingType:**

Derivation:

*`AnnotableType`*` (extension)`

6502

*`IdentifiableType`*` (extension)`

6503

*`FrequencyFormatMappingBaseType`*` (extension)`

6504

`FrequencyFormatMappingType`

Attributes:

`id?, urn?, uri?`

Content:

`Annotations?, Link*, FrequencyId, DatePattern`

6513

6514

Attribute Documentation:

6515

6516

| **Name** | **Type** | **Documentation** |

6517

| --- --| --- --| --- --|

6518

| id | IDType | The id is the identifier for the object. |

6519

| urn | FrequencyFormatMappi ngUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6520

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6521

6522

Element Documentation:

6523

6524

| **Name** | **Type** | **Documentation** |

6525

| --- --| --- --| --- --|

6526

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6527

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6528

| FrequencyId | IDType | |

6529

| DatePattern | xs:string | |

***DateMapType*:**

Derivation:

*`AnnotableType`*` (extension)`

6536

*`IdentifiableType`*` (extension)`

*`DateMapType`*

Attributes:

`id?, urn?, uri?, resolvePeriod?`

Content:

`Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*) | TargetFrequencyID)`

6546

6547

Attribute Documentation:

6548

6549

| **Name** | **Type** | **Documentation** |

6550

| --- --| --- --| --- --|

6551

| id | IDType | The id is the identifier for the object. |

6552

| urn | UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6553

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6554

| resolvePeriod | ResolvePeriodType | Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods. |

6555

6556

Element Documentation:

6557

6558

| **Name** | **Type** | **Documentation** |

6559

| --- --| --- --| --- --|

6560

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6561

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6562

| Source | IDType | |

6563

| Target | IDType | |

6564

| FrequencyDimension | IDType | |

6565

| MappedFrequencies | IDType | |

6566

| TargetFrequencyID | IDType | |

6567

6568

***EpochMapBaseType*:** EpochMapBaseType defines the base refinement of the EpochMapType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

6573

*`IdentifiableType`*` (extension)`

6574

*`DateMapType`*` (restriction)`

*`EpochMapBaseType`*

Attributes:

`id?, urn?, uri?, resolvePeriod?`

Content:

`Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*) | TargetFrequencyID)`

6584

6585

Attribute Documentation:

6586

6587

| **Name** | **Type** | **Documentation** |

6588

| --- --| --- --| --- --|

6589

| id | IDType | The id is the identifier for the object. |

6590

| urn | EpochMapUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6591

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6592

| resolvePeriod | ResolvePeriodType | Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods. |

6593

6594

Element Documentation:

6595

6596

| **Name** | **Type** | **Documentation** |

6597

| --- --| --- --| --- --|

6598

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6599

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6600

| Source | IDType | |

6601

| Target | IDType | |

6602

| FrequencyDimension | IDType | |

6603

| MappedFrequencies | IDType | |

6604

| TargetFrequencyID | IDType | |

**EpochMapType:**

Derivation:

*`AnnotableType`*` (extension)`

6611

*`IdentifiableType`*` (extension)`

6612

*`DateMapType`*` (restriction)`

6613

*`EpochMapBaseType`*` (extension)`

`EpochMapType`

Attributes:

`id?, urn?, uri?, resolvePeriod?, basePeriod, epochPeriod`

Content:

`Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*) | TargetFrequencyID)`

6623

6624

Attribute Documentation:

6625

6626

| **Name** | **Type** | **Documentation** |

6627

| --- --| --- --| --- --|

6628

| id | IDType | The id is the identifier for the object. |

6629

| urn | EpochMapUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6630

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6631

| resolvePeriod | ResolvePeriodType | Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods. |

6632

| basePeriod | xs:string | |

6633

| epochPeriod | EpochPeriodType | |

6634

6635

Element Documentation:

6636

6637

| **Name** | **Type** | **Documentation** |

6638

| --- --| --- --| --- --|

6639

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6640

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6641

| Source | IDType | |

6642

| Target | IDType | |

6643

| FrequencyDimension | IDType | |

6644

| MappedFrequencies | IDType | |

6645

| TargetFrequencyID | IDType | |

6646

6647

***DatePatternMapBaseType*:** DatePatternMapBaseType defines the base refinement of the DatePatternMapType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

6652

*`IdentifiableType`*` (extension)`

6653

*`DateMapType`*` (restriction)`

6654

*`DatePatternMapBaseType`*

Attributes:

`id?, urn?, uri?, resolvePeriod?`

Content:

`Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*) | TargetFrequencyID)`

6663

6664

Attribute Documentation:

6665

6666

| **Name** | **Type** | **Documentation** |

6667

| --- --| --- --| --- --|

6668

| id | IDType | The id is the identifier for the object. |

6669

| urn | DatePatternMapUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6670

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6671

| resolvePeriod | ResolvePeriodType | Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods. |

6672

6673

Element Documentation:

6674

6675

| **Name** | **Type** | **Documentation** |

6676

| --- --| --- --| --- --|

6677

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6678

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6679

| Source | IDType | |

6680

| Target | IDType | |

6681

| FrequencyDimension | IDType | |

6682

| MappedFrequencies | IDType | |

6683

| TargetFrequencyID | IDType | |

6684

6685

**DatePatternMapType:**

Derivation:

*`AnnotableType`*` (extension)`

6690

*`IdentifiableType`*` (extension)`

6691

*`DateMapType`*` (restriction)`

6692

*`DatePatternMapBaseType`*` (extension)`

`DatePatternMapType`

Attributes:

`id?, urn?, uri?, resolvePeriod?, sourcePattern, locale`

Content:

`Annotations?, Link*, (Source, Target)+, ( (FrequencyDimension, MappedFrequencies*) | TargetFrequencyID)`

6702

6703

Attribute Documentation:

6704

6705

| **Name** | **Type** | **Documentation** |

6706

| --- --| --- --| --- --|

6707

| id | IDType | The id is the identifier for the object. |

6708

| urn | DatePatternMapUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6709

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6710

| resolvePeriod | ResolvePeriodType | Indicates the point in time to resolve to when mapping from low fequency periods to higher frequency periods. |

6711

| sourcePattern | xs:string | Describes the source date using conventions for describing years, months, days, etc. |

6712

| locale | xs:string | The locale on which the input will be parsed according to the pattern. |

6713

6714

Element Documentation:

6715

6716

| **Name** | **Type** | **Documentation** |

6717

| --- --| --- --| --- --|

6718

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6719

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6720

| Source | IDType | |

6721

| Target | IDType | |

6722

| FrequencyDimension | IDType | |

6723

| MappedFrequencies | IDType | |

6724

| TargetFrequencyID | IDType | |

6725

6726

***RepresentationMapBaseType*:** RepresentationMapBaseType defines the base refinement of the RepresentationMapType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

6731

*`IdentifiableType`*` (extension)`

6732

*`NameableType`*` (extension)`

6733

*`VersionableType`*` (restriction)`

6734

*`MaintainableBaseType`*` (extension)`

6735

*`MaintainableType`*` (restriction)`

6736

*`RepresentationMapBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*`

6745

6746

Attribute Documentation:

6747

6748

| **Name** | **Type** | **Documentation** |

6749

| --- --| --- --| --- --|

6750

| id | IDType | The id is the identifier for the object. |

6751

| urn | RepresentationMapUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6752

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6753

| 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. |

6754

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6755

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6756

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6757

| 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. |

6758

| 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. |

6759

| 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. |

6760

| 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’. |

6761

6762

Element Documentation:

6763

6764

| **Name** | **Type** | **Documentation** |

6765

| --- --| --- --| --- --|

6766

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6767

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6768

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6769

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6770

6771

**RepresentationMapType:**

Derivation:

*`AnnotableType`*` (extension)`

6776

*`IdentifiableType`*` (extension)`

6777

*`NameableType`*` (extension)`

6778

*`VersionableType`*` (restriction)`

6779

*`MaintainableBaseType`*` (extension)`

6780

*`MaintainableType`*` (restriction)`

6781

*`RepresentationMapBaseType`*` (extension)`

6782

`RepresentationMapType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?`

Content:

`Annotations?, Link*, Name+, Description*, (SourceCodelist | SourceDataType)+, (TargetCodelist | TargetDataType)+, RepresentationMapping*`

6791

6792

Attribute Documentation:

6793

6794

| **Name** | **Type** | **Documentation** |

6795

| --- --| --- --| --- --|

6796

| id | IDType | The id is the identifier for the object. |

6797

| urn | RepresentationMapUrn Type | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6798

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6799

| 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. |

6800

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6801

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6802

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6803

| 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. |

6804

| 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. |

6805

| 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. |

6806

| 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’. |

6807

6808

Element Documentation:

6809

6810

| **Name** | **Type** | **Documentation** |

6811

| --- --| --- --| --- --|

6812

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6813

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6814

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6815

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6816

| SourceCodelist | AnyCodelistReferenceTyp e | |

6817

| SourceDataType | DataType | |

6818

| TargetCodelist | AnyCodelistReferenceTyp e | |

6819

| TargetDataType | DataType | |

6820

| RepresentationMappin g | ValueMappingType | |

6821

6822

**SingleValueMappingType:** SingleValueMappingType defines a mapping with a single source and optional target.

Derivation:

*`AnnotableType`*` (extension)`

6827

`SingleValueMappingType`

Attributes:

`validFrom?, validTo?`

Content:

`Annotations?, SourceValue, TargetValue?`

6836

6837

Attribute Documentation:

6838

6839

| **Name** | **Type** | **Documentation** |

6840

| --- --| --- --| --- --|

6841

| validFrom | xs:date | |

6842

| validTo | xs:date | |

6843

6844

Element Documentation:

6845

6846

| **Name** | **Type** | **Documentation** |

6847

| --- --| --- --| --- --|

6848

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6849

| 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. |

6850

| 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. |

6851

6852

**ValueMappingType:** ValueMappingType defines a mapping of multiple sources to multiple targets.

Derivation:

*`AnnotableType`*` (extension)`

`ValueMappingType`

Attributes:

`validFrom?, validTo?`

Content:

`Annotations?, SourceValue+, TargetValue*`

6866

6867

Attribute Documentation:

6868

6869

| **Name** | **Type** | **Documentation** |

6870

| --- --| --- --| --- --|

6871

| validFrom | xs:date | |

6872

| validTo | xs:date | |

6873

6874

Element Documentation:

6875

6876

| **Name** | **Type** | **Documentation** |

6877

| --- --| --- --| --- --|

6878

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6879

| 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. |

6880

| 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)`

6887

`xs:string (extension)`

`MappedValueType`

Attributes:

`isRegEx?, startIndex?, endIndex?`

Content:

Attribute Documentation:

6897

6898

| **Name** | **Type** | **Documentation** |

6899

| --- --| --- --| --- --|

6900

| isRegEx | xs:boolean | |

6901

| startIndex | xs:int | |

6902

| endIndex | xs:int | |

6903

6904

***VtlDefinitionSchemeType*:** VtlDefinitionSchemeType is an abstract extension of the ItemSchemeType for VTL schemes.

Derivation:

*`AnnotableType`*` (extension)`

6909

*`IdentifiableType`*` (extension)`

6910

*`NameableType`*` (extension)`

6911

*`VersionableType`*` (restriction)`

6912

*`MaintainableBaseType`*` (extension)`

6913

*`MaintainableType`*` (extension)`

6914

*`ItemSchemeType`*` (extension)`

6915

*`VtlDefinitionSchemeType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`

Content:

`Annotations?, Link*, Name+, Description*, `*`Item*`*

6924

6925

Attribute Documentation:

6926

6927

| **Name** | **Type** | **Documentation** |

6928

| --- --| --- --| --- --|

6929

| id | IDType | The id is the identifier for the object. |

6930

| urn | MaintainableUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6931

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6932

| 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. |

6933

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6934

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6935

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6936

| 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. |

6937

| 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. |

6938

| 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. |

6939

| 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’. |

6940

| 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. |

6941

| 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. |

6942

6943

Element Documentation:

6944

6945

| **Name** | **Type** | **Documentation** |

6946

| --- --| --- --| --- --|

6947

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6948

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6949

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

6950

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

6951

| *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. |

6952

6953

***TransformationSchemeBaseType*:** TransformationSchemeBaseType is an abstract base type for the TransformationSchemeType. It restricts the item types to be only transformations.

Derivation:

*`AnnotableType`*` (extension)`

6958

*`IdentifiableType`*` (extension)`

6959

*`NameableType`*` (extension)`

6960

*`VersionableType`*` (restriction)`

6961

*`MaintainableBaseType`*` (extension)`

6962

*`MaintainableType`*` (extension)`

6963

*`ItemSchemeType`*` (extension)`

6964

*`VtlDefinitionSchemeType`*` (restriction)`

6965

*`TransformationSchemeBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`

Content:

`Annotations?, Link*, Name+, Description*, Transformation*`

6974

6975

Attribute Documentation:

6976

6977

| **Name** | **Type** | **Documentation** |

6978

| --- --| --- --| --- --|

6979

| id | IDType | The id is the identifier for the object. |

6980

| urn | TransformationScheme UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

6981

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

6982

| 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. |

6983

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

6984

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

6985

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

6986

| 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. |

6987

| 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. |

6988

| 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. |

6989

| 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’. |

6990

| 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. |

6991

| 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. |

6992

6993

Element Documentation:

6994

6995

| **Name** | **Type** | **Documentation** |

6996

| --- --| --- --| --- --|

6997

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

6998

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

6999

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7000

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7001

| Transformation | TransformationType | Transformation describes the details of a single transformation within a transformation scheme. |

7002

7003

**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)`

7008

*`IdentifiableType`*` (extension)`

7009

*`NameableType`*` (extension)`

7010

*`VersionableType`*` (restriction)`

7011

*`MaintainableBaseType`*` (extension)`

7012

*`MaintainableType`*` (extension)`

7013

*`ItemSchemeType`*` (extension)`

7014

*`VtlDefinitionSchemeType`*` (restriction)`

7015

*`TransformationSchemeBaseType`*` (extension)`

7016

`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*`

7025

7026

Attribute Documentation:

7027

7028

| **Name** | **Type** | **Documentation** |

7029

| --- --| --- --| --- --|

7030

| id | IDType | The id is the identifier for the object. |

7031

| urn | TransformationScheme UrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7032

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7033

| 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. |

7034

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

7035

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

7036

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

7037

| 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. |

7038

| 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. |

7039

| 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. |

7040

| 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’. |

7041

| 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. |

7042

| 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. |

7043

7044

Element Documentation:

7045

7046

| **Name** | **Type** | **Documentation** |

7047

| --- --| --- --| --- --|

7048

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7049

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7050

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7051

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7052

| Transformation | TransformationType | Transformation describes the details of a single transformation within a transformation scheme. |

7053

| 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. |

7054

| 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. |

7055

| 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. |

7056

| 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. |

7057

| 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. |

7058

7059

***TransformationBaseType*:** TransformationBaseType defines the base refinement of the TransformationType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

7064

*`IdentifiableType`*` (extension)`

7065

*`NameableType`*` (restriction)`

7066

*`ItemBaseType`*` (extension)`

7067

*`ItemType`*` (restriction)`

7068

*`UnnestedItemType`*` (restriction)`

7069

*`TransformationBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

7078

7079

Attribute Documentation:

7080

7081

| **Name** | **Type** | **Documentation** |

7082

| --- --| --- --| --- --|

7083

| id | IDType | The id is the identifier for the object. |

7084

| urn | TransformationUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7085

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7086

7087

Element Documentation:

7088

7089

| **Name** | **Type** | **Documentation** |

7090

| --- --| --- --| --- --|

7091

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7092

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7093

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7094

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7095

7096

**TransformationType:** TransformationType defines the structure of a transformation. A transformation is an assignment of a VTL expression to a specific result.

Derivation:

*`AnnotableType`*` (extension)`

7101

*`IdentifiableType`*` (extension)`

7102

*`NameableType`*` (restriction)`

7103

*`ItemBaseType`*` (extension)`

7104

*`ItemType`*` (restriction)`

7105

*`UnnestedItemType`*` (restriction)`

7106

*`TransformationBaseType`*` (extension)`

`TransformationType`

Attributes:

`id, urn?, uri?, isPersistent`

Content:

`Annotations?, Link*, Name+, Description*, Expression, Result`

7116

7117

Attribute Documentation:

7118

7119

| **Name** | **Type** | **Documentation** |

7120

| --- --| --- --| --- --|

7121

| id | IDType | The id is the identifier for the object. |

7122

| urn | TransformationUrnTyp e | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7123

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7124

| 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. |

7125

7126

Element Documentation:

7127

7128

| **Name** | **Type** | **Documentation** |

7129

| --- --| --- --| --- --|

7130

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7131

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7132

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7133

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7134

| 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"). |

7135

| 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"). |

7136

7137

**VtlMappingSchemeType:** VtlMappingSchemeType defines a set of mappings between SDMX and VTL.

Derivation:

*`AnnotableType`*` (extension)`

7142

*`IdentifiableType`*` (extension)`

7143

*`NameableType`*` (extension)`

7144

*`VersionableType`*` (restriction)`

7145

*`MaintainableBaseType`*` (extension)`

7146

*`MaintainableType`*` (extension)`

7147

*`ItemSchemeType`*` (restriction)`

7148

`VtlMappingSchemeType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?`

Content:

`Annotations?, Link*, Name+, Description*, VtlMapping*`

7157

7158

Attribute Documentation:

7159

7160

| **Name** | **Type** | **Documentation** |

7161

| --- --| --- --| --- --|

7162

| id | IDType | The id is the identifier for the object. |

7163

| urn | VtlMappingSchemeUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7164

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7165

| 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. |

7166

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

7167

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

7168

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

7169

| 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. |

7170

| 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. |

7171

| 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. |

7172

| 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’. |

7173

| 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. |

7174

7175

Element Documentation:

7176

7177

| **Name** | **Type** | **Documentation** |

7178

| --- --| --- --| --- --|

7179

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7180

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7181

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7182

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7183

| VtlMapping | VtlMappingType | VtlMapping details a mapping between SDMX and VTL transformation. |

7184

7185

***VtlMappingBaseType*:** VtlMappingBaseType defines the base refinement of the VtlMappingType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

7190

*`IdentifiableType`*` (extension)`

7191

*`NameableType`*` (restriction)`

7192

*`ItemBaseType`*` (extension)`

7193

*`ItemType`*` (restriction)`

7194

*`UnnestedItemType`*` (restriction)`

7195

*`VtlMappingBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

7204

7205

Attribute Documentation:

7206

7207

| **Name** | **Type** | **Documentation** |

7208

| --- --| --- --| --- --|

7209

| id | IDType | The id is the identifier for the object. |

7210

| urn | VtlMappingUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7211

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7212

7213

Element Documentation:

7214

7215

| **Name** | **Type** | **Documentation** |

7216

| --- --| --- --| --- --|

7217

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7218

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7219

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7220

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7221

7222

**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)`

7227

*`IdentifiableType`*` (extension)`

7228

*`NameableType`*` (restriction)`

7229

*`ItemBaseType`*` (extension)`

7230

*`ItemType`*` (restriction)`

7231

*`UnnestedItemType`*` (restriction)`

7232

*`VtlMappingBaseType`*` (extension)`

`VtlMappingType`

Attributes:

`id, urn?, uri?, alias`

Content:

`Annotations?, Link*, Name+, Description*, ( ( (Dataflow | GenericDataflow), ToVtlMapping?, FromVtlMapping?) | Codelist | Concept)`

7242

7243

Attribute Documentation:

7244

7245

| **Name** | **Type** | **Documentation** |

7246

| --- --| --- --| --- --|

7247

| id | IDType | The id is the identifier for the object. |

7248

| urn | VtlMappingUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7249

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7250

| 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. |

7251

7252

Element Documentation:

7253

7254

| **Name** | **Type** | **Documentation** |

7255

| --- --| --- --| --- --|

7256

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7257

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7258

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7259

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7260

| 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. |

7261

| 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. |

7262

| ToVtlMapping | ToVtlMappingType | Describes the mapping from a SDMX dataflow to a VTL data structure. |

7263

| FromVtlMapping | FromVtlMappingType | Describes the mapping to a SDMX dataflow from a VTL data structure. |

7264

| Codelist | CodelistReferenceTyp e | A reference to the SDMX Codelist that the mapping is defined for. This is used to create a VtlCodelistMapping. |

7265

| Concept | ConceptReferenceType | A reference to the SDMX Concept that the mapping is defined for. This is used to create a VtlConceptMapping. |

7266

7267

**ToVtlMappingType:** ToVtlMappingType defines the mapping method and filter used when mapping from SDMX to VTL.

Attributes:

`method?`

Content:

`ToVtlSubSpace?`

Attribute Documentation:

7278

7279

| **Name** | **Type** | **Documentation** |

7280

| --- --| --- --| --- --|

7281

| 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. |

7282

7283

Element Documentation:

7284

7285

| **Name** | **Type** | **Documentation** |

7286

| --- --| --- --| --- --|

7287

| 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. |

7288

7289

**FromVtlMappingType:** FromVtlMappingType defines the mapping method and filter used when mapping from VTL to SDMX.

Attributes:

`method?`

Content:

`FromVtlSuperSpace?`

Attribute Documentation:

7300

7301

| **Name** | **Type** | **Documentation** |

7302

| --- --| --- --| --- --|

7303

| 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. |

7304

7305

Element Documentation:

7306

7307

| **Name** | **Type** | **Documentation** |

7308

| --- --| --- --| --- --|

7309

| 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. |

7310

7311

**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:

7318

7319

| **Name** | **Type** | **Documentation** |

7320

| --- --| --- --| --- --|

7321

| Key | SingleNCNameIDType | A reference to a dimension by its identifier. |

7322

7323

**NamePersonalisationSchemeType:** NamePersonalisationSchemeType defines a set of personalisations of VTL standard names that are used in a set of transformations.

Derivation:

*`AnnotableType`*` (extension)`

7328

*`IdentifiableType`*` (extension)`

7329

*`NameableType`*` (extension)`

7330

*`VersionableType`*` (restriction)`

7331

*`MaintainableBaseType`*` (extension)`

7332

*`MaintainableType`*` (extension)`

7333

*`ItemSchemeType`*` (extension)`

7334

*`VtlDefinitionSchemeType`*` (restriction)`

7335

`NamePersonalisationSchemeType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`

Content:

`Annotations?, Link*, Name+, Description*, NamePersonalisation*`

7344

7345

Attribute Documentation:

7346

7347

| **Name** | **Type** | **Documentation** |

7348

| --- --| --- --| --- --|

7349

| id | IDType | The id is the identifier for the object. |

7350

| urn | NamePersonalisationS chemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7351

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7352

| 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. |

7353

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

7354

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

7355

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

7356

| 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. |

7357

| 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. |

7358

| 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. |

7359

| 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’. |

7360

| 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. |

7361

| 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. |

7362

7363

Element Documentation:

7364

7365

| **Name** | **Type** | **Documentation** |

7366

| --- --| --- --| --- --|

7367

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7368

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7369

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7370

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7371

| NamePersonalisation | NamePersonalisationT ype | NamePersonalisation details a name personalisation that is used in a transformation. |

7372

7373

***NamePersonalisationBaseType*:** NamePersonalisationBaseType defines the base refinement of the NamePersonalisationType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

7378

*`IdentifiableType`*` (extension)`

7379

*`NameableType`*` (restriction)`

7380

*`ItemBaseType`*` (extension)`

7381

*`ItemType`*` (restriction)`

7382

*`UnnestedItemType`*` (restriction)`

7383

*`NamePersonalisationBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

7392

7393

Attribute Documentation:

7394

7395

| **Name** | **Type** | **Documentation** |

7396

| --- --| --- --| --- --|

7397

| id | IDType | The id is the identifier for the object. |

7398

| urn | NamePersonalisationU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7399

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7400

7401

Element Documentation:

7402

7403

| **Name** | **Type** | **Documentation** |

7404

| --- --| --- --| --- --|

7405

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7406

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7407

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7408

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7409

7410

**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)`

7415

*`IdentifiableType`*` (extension)`

7416

*`NameableType`*` (restriction)`

7417

*`ItemBaseType`*` (extension)`

7418

*`ItemType`*` (restriction)`

7419

*`UnnestedItemType`*` (restriction)`

7420

*`NamePersonalisationBaseType`*` (extension)`

7421

`NamePersonalisationType`

Attributes:

`id, urn?, uri?, vtlArtefact`

Content:

`Annotations?, Link*, Name+, Description*, VtlDefaultName, PersonalisedName`

7430

7431

Attribute Documentation:

7432

7433

| **Name** | **Type** | **Documentation** |

7434

| --- --| --- --| --- --|

7435

| id | IDType | The id is the identifier for the object. |

7436

| urn | NamePersonalisationU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7437

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7438

| vtlArtefact | xs:string | Identifies the type of VTL model artefact that is being personalised. In VTL 2.0, this is valuedomain or variable. |

7439

7440

Element Documentation:

7441

7442

| **Name** | **Type** | **Documentation** |

7443

| --- --| --- --| --- --|

7444

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7445

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7446

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7447

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7448

| VtlDefaultName | xs:string | Provides the VTL standard name that is being personalised. |

7449

| PersonalisedName | xs:string | Provides the personalised name that is used in place of the VTL standard name in the transformation expressions. |

7450

7451

***RulesetSchemeBaseType*:** RulesetSchemeBaseType is an abstract base type for the RulesetSchemeType. It restricts the item types to be only rulesets.

Derivation:

*`AnnotableType`*` (extension)`

7456

*`IdentifiableType`*` (extension)`

7457

*`NameableType`*` (extension)`

7458

*`VersionableType`*` (restriction)`

7459

*`MaintainableBaseType`*` (extension)`

7460

*`MaintainableType`*` (extension)`

7461

*`ItemSchemeType`*` (extension)`

7462

*`VtlDefinitionSchemeType`*` (restriction)`

7463

*`RulesetSchemeBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`

Content:

`Annotations?, Link*, Name+, Description*, Ruleset*`

7472

7473

Attribute Documentation:

7474

7475

| **Name** | **Type** | **Documentation** |

7476

| --- --| --- --| --- --|

7477

| id | IDType | The id is the identifier for the object. |

7478

| urn | RulesetSchemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7479

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7480

| 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. |

7481

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

7482

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

7483

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

7484

| 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. |

7485

| 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. |

7486

| 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. |

7487

| 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’. |

7488

| 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. |

7489

| 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. |

7490

7491

Element Documentation:

7492

7493

| **Name** | **Type** | **Documentation** |

7494

| --- --| --- --| --- --|

7495

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7496

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7497

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7498

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7499

| Ruleset | RulesetType | Ruleset details a ruleset within a ruleset scheme. |

7500

7501

**RulesetSchemeType:** RulesetSchemeType defines a collection of rulesets that are used in transformations.

Derivation:

*`AnnotableType`*` (extension)`

7506

*`IdentifiableType`*` (extension)`

7507

*`NameableType`*` (extension)`

7508

*`VersionableType`*` (restriction)`

7509

*`MaintainableBaseType`*` (extension)`

7510

*`MaintainableType`*` (extension)`

7511

*`ItemSchemeType`*` (extension)`

7512

*`VtlDefinitionSchemeType`*` (restriction)`

7513

*`RulesetSchemeBaseType`*` (extension)`

`RulesetSchemeType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`

Content:

`Annotations?, Link*, Name+, Description*, Ruleset*, VtlMappingScheme?`

7523

7524

Attribute Documentation:

7525

7526

| **Name** | **Type** | **Documentation** |

7527

| --- --| --- --| --- --|

7528

| id | IDType | The id is the identifier for the object. |

7529

| urn | RulesetSchemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7530

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7531

| 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. |

7532

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

7533

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

7534

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

7535

| 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. |

7536

| 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. |

7537

| 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. |

7538

| 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’. |

7539

| 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. |

7540

| 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. |

7541

7542

Element Documentation:

7543

7544

| **Name** | **Type** | **Documentation** |

7545

| --- --| --- --| --- --|

7546

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7547

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7548

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7549

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7550

| Ruleset | RulesetType | Ruleset details a ruleset within a ruleset scheme. |

7551

| 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. |

7552

7553

***RulesetBaseType*:** RulesetBaseType defines the base refinement of the RulesetType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

7558

*`IdentifiableType`*` (extension)`

7559

*`NameableType`*` (restriction)`

7560

*`ItemBaseType`*` (extension)`

7561

*`ItemType`*` (restriction)`

7562

*`UnnestedItemType`*` (restriction)`

*`RulesetBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

7572

7573

Attribute Documentation:

7574

7575

| **Name** | **Type** | **Documentation** |

7576

| --- --| --- --| --- --|

7577

| id | IDType | The id is the identifier for the object. |

7578

| urn | RulesetUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7579

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7580

7581

Element Documentation:

7582

7583

| **Name** | **Type** | **Documentation** |

7584

| --- --| --- --| --- --|

7585

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7586

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7587

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7588

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7589

7590

**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)`

7595

*`IdentifiableType`*` (extension)`

7596

*`NameableType`*` (restriction)`

7597

*`ItemBaseType`*` (extension)`

7598

*`ItemType`*` (restriction)`

7599

*`UnnestedItemType`*` (restriction)`

7600

*`RulesetBaseType`*` (extension)`

`RulesetType`

Attributes:

`id, urn?, uri?, rulesetType, rulesetScope`

Content:

`Annotations?, Link*, Name+, Description*, RulesetDefinition`

7610

7611

Attribute Documentation:

7612

7613

| **Name** | **Type** | **Documentation** |

7614

| --- --| --- --| --- --|

7615

| id | IDType | The id is the identifier for the object. |

7616

| urn | RulesetUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7617

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7618

| rulesetType | xs:string | The VTL type of the ruleset. In VTL 2.0, this is datapoint or hierarchical |

7619

| rulesetScope | xs:string | This model artefact on which the ruleset is defined. In VTL 2.0, this is value domain or variable. |

7620

7621

Element Documentation:

7622

7623

| **Name** | **Type** | **Documentation** |

7624

| --- --| --- --| --- --|

7625

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7626

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7627

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7628

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7629

| RulesetDefinition | xs:string | A VTL statement for the definition of a ruleset. This must conform to the syntax of the VTL definition language. |

7630

7631

***UserDefinedOperatorSchemeBaseType*:** UserDefinedOperatorSchemeBaseType is an abstract base type for the UserDefinedOperatorSchemeType. It restricts the item types to be only user defined operators.

Derivation:

*`AnnotableType`*` (extension)`

7636

*`IdentifiableType`*` (extension)`

7637

*`NameableType`*` (extension)`

7638

*`VersionableType`*` (restriction)`

7639

*`MaintainableBaseType`*` (extension)`

7640

*`MaintainableType`*` (extension)`

7641

*`ItemSchemeType`*` (extension)`

7642

*`VtlDefinitionSchemeType`*` (restriction)`

7643

*`UserDefinedOperatorSchemeBaseType`*

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`

Content:

`Annotations?, Link*, Name+, Description*, UserDefinedOperator*`

7652

7653

Attribute Documentation:

7654

7655

| **Name** | **Type** | **Documentation** |

7656

| --- --| --- --| --- --|

7657

| id | IDType | The id is the identifier for the object. |

7658

| urn | UserDefinedOperatorS chemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7659

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7660

| 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. |

7661

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

7662

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

7663

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

7664

| 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. |

7665

| 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. |

7666

| 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. |

7667

| 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’. |

7668

| 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. |

7669

| 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. |

7670

7671

Element Documentation:

7672

7673

| **Name** | **Type** | **Documentation** |

7674

| --- --| --- --| --- --|

7675

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7676

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7677

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7678

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7679

| UserDefinedOperator | UserDefinedOperatorT ype | UserDefinedOperator details a user defined operators within a user defined operator scheme. |

7680

7681

**UserDefinedOperatorSchemeType:** UserDefinedOperatorSchemeType defines a collection of user defined operators that are used in transformations.

Derivation:

*`AnnotableType`*` (extension)`

7686

*`IdentifiableType`*` (extension)`

7687

*`NameableType`*` (extension)`

7688

*`VersionableType`*` (restriction)`

7689

*`MaintainableBaseType`*` (extension)`

7690

*`MaintainableType`*` (extension)`

7691

*`ItemSchemeType`*` (extension)`

7692

*`VtlDefinitionSchemeType`*` (restriction)`

7693

*`UserDefinedOperatorSchemeBaseType`*` (extension)`

7694

`UserDefinedOperatorSchemeType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`

Content:

`Annotations?, Link*, Name+, Description*, UserDefinedOperator*, VtlMappingScheme?, RulesetScheme*`

7703

7704

Attribute Documentation:

7705

7706

| **Name** | **Type** | **Documentation** |

7707

| --- --| --- --| --- --|

7708

| id | IDType | The id is the identifier for the object. |

7709

| urn | UserDefinedOperatorS chemeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7710

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7711

| 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. |

7712

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

7713

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

7714

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

7715

| 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. |

7716

| 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. |

7717

| 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. |

7718

| 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’. |

7719

| 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. |

7720

| 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. |

7721

7722

Element Documentation:

7723

7724

| **Name** | **Type** | **Documentation** |

7725

| --- --| --- --| --- --|

7726

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7727

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7728

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7729

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7730

| UserDefinedOperator | UserDefinedOperatorT ype | UserDefinedOperator details a user defined operators within a user defined operator scheme. |

7731

| 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. |

7732

| RulesetScheme | RulesetSchemeReferen ceType | References a ruleset scheme defining rulesets utilized in the user defined operators. |

7733

7734

***UserDefinedOperatorBaseType*:** UserDefinedOperatorBaseType defines the base refinement of the UserDefinedOperatorType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

7739

*`IdentifiableType`*` (extension)`

7740

*`NameableType`*` (restriction)`

7741

*`ItemBaseType`*` (extension)`

7742

*`ItemType`*` (restriction)`

7743

*`UnnestedItemType`*` (restriction)`

7744

*`UserDefinedOperatorBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

7753

7754

Attribute Documentation:

7755

7756

| **Name** | **Type** | **Documentation** |

7757

| --- --| --- --| --- --|

7758

| id | IDType | The id is the identifier for the object. |

7759

| urn | UserDefinedOperatorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7760

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7761

7762

Element Documentation:

7763

7764

| **Name** | **Type** | **Documentation** |

7765

| --- --| --- --| --- --|

7766

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7767

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7768

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7769

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7770

7771

**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)`

7776

*`IdentifiableType`*` (extension)`

7777

*`NameableType`*` (restriction)`

7778

*`ItemBaseType`*` (extension)`

7779

*`ItemType`*` (restriction)`

7780

*`UnnestedItemType`*` (restriction)`

7781

*`UserDefinedOperatorBaseType`*` (extension)`

7782

`UserDefinedOperatorType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, OperatorDefinition`

7791

7792

Attribute Documentation:

7793

7794

| **Name** | **Type** | **Documentation** |

7795

| --- --| --- --| --- --|

7796

| id | IDType | The id is the identifier for the object. |

7797

| urn | UserDefinedOperatorU rnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7798

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7799

7800

Element Documentation:

7801

7802

| **Name** | **Type** | **Documentation** |

7803

| --- --| --- --| --- --|

7804

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7805

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7806

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7807

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7808

| 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. |

7809

7810

**CustomTypeSchemeType:** CustomTypeSchemeType defines a collection of custom types that are used in transformations.

Derivation:

*`AnnotableType`*` (extension)`

7815

*`IdentifiableType`*` (extension)`

7816

*`NameableType`*` (extension)`

7817

*`VersionableType`*` (restriction)`

7818

*`MaintainableBaseType`*` (extension)`

7819

*`MaintainableType`*` (extension)`

7820

*`ItemSchemeType`*` (extension)`

7821

*`VtlDefinitionSchemeType`*` (restriction)`

7822

`CustomTypeSchemeType`

Attributes:

`id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion`

Content:

`Annotations?, Link*, Name+, Description*, CustomType*`

7831

7832

Attribute Documentation:

7833

7834

| **Name** | **Type** | **Documentation** |

7835

| --- --| --- --| --- --|

7836

| id | IDType | The id is the identifier for the object. |

7837

| urn | CustomTypeSchemeUrnT ype | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7838

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7839

| 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. |

7840

| validFrom | xs:dateTime | The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. |

7841

| validTo | xs:dateTime | The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. |

7842

| agencyID | NestedNCNameIDType | The agencyID must be provided, and identifies the maintenance agency of the object. |

7843

| 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. |

7844

| 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. |

7845

| 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. |

7846

| 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’. |

7847

| 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. |

7848

| 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. |

7849

7850

Element Documentation:

7851

7852

| **Name** | **Type** | **Documentation** |

7853

| --- --| --- --| --- --|

7854

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7855

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7856

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7857

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7858

| CustomType | CustomTypeType | CustomType details a custom type within a custom type scheme. |

7859

7860

***CustomTypeBaseType*:** CustomTypeBaseType defines the base refinement of the CustomTypeType. Its purpose is to retrict the urn attribute.

Derivation:

*`AnnotableType`*` (extension)`

7865

*`IdentifiableType`*` (extension)`

7866

*`NameableType`*` (restriction)`

7867

*`ItemBaseType`*` (extension)`

7868

*`ItemType`*` (restriction)`

7869

*`UnnestedItemType`*` (restriction)`

7870

*`CustomTypeBaseType`*

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*`

7879

7880

Attribute Documentation:

7881

7882

| **Name** | **Type** | **Documentation** |

7883

| --- --| --- --| --- --|

7884

| id | IDType | The id is the identifier for the object. |

7885

| urn | CustomTypeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7886

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7887

7888

Element Documentation:

7889

7890

| **Name** | **Type** | **Documentation** |

7891

| --- --| --- --| --- --|

7892

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7893

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7894

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7895

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7896

7897

**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)`

7902

*`IdentifiableType`*` (extension)`

7903

*`NameableType`*` (restriction)`

7904

*`ItemBaseType`*` (extension)`

7905

*`ItemType`*` (restriction)`

7906

*`UnnestedItemType`*` (restriction)`

7907

*`CustomTypeBaseType`*` (extension)`

`CustomTypeType`

Attributes:

`id, urn?, uri?`

Content:

`Annotations?, Link*, Name+, Description*, VtlScalarType, DataType, VtlLiteralFormat?, OutputFormat?, NullValue?`

7917

7918

Attribute Documentation:

7919

7920

| **Name** | **Type** | **Documentation** |

7921

| --- --| --- --| --- --|

7922

| id | IDType | The id is the identifier for the object. |

7923

| urn | CustomTypeUrnType | The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). |

7924

| uri | xs:anyURI | The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. |

7925

7926

Element Documentation:

7927

7928

| **Name** | **Type** | **Documentation** |

7929

| --- --| --- --| --- --|

7930

| Annotations | AnnotationsType | Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. |

7931

| Link | LinkType | Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the meatadata report can be dynamically inserted in the structure metadata. |

7932

| Name | TextType | Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. |

7933

| Description | TextType | Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. |

7934

| VtlScalarType | xs:string | Identifies the VTL scalar type that is to be converted to an resulting output data type. |

7935

| 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. |

7936

| 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. |

7937

| 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. |

7938

| NullValue | xs:string | The value to be produced in the output of the conversion when a component has a null value. |

7939

7940

### 2.1.4 Simple Types##

7941

7942

**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.

7943

7944

Derived by restriction of `SimpleDataType`.

Enumerations:

| **Value** | **Documentation** |

7949

| --- --| --- --|

7950

| String | A string datatype corresponding to W3C XML Schema's xs:string datatype. |

7951

| Alpha | A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z. |

7952

| 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. |

7953

| 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. |

7954

| BigInteger | An integer datatype corresponding to W3C XML Schema's xs:integer datatype. |

7955

| Integer | An integer datatype corresponding to W3C XML Schema's xs:int datatype. |

7956

| Long | A numeric datatype corresponding to W3C XML Schema's xs:long datatype. |

7957

| Short | A numeric datatype corresponding to W3C XML Schema's xs:short datatype. |

7958

| Boolean | A datatype corresponding to W3C XML Schema's xs:boolean datatype. |

7959

| URI | A datatype corresponding to W3C XML Schema's xs:anyURI datatype. |

7960

| Count | A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1". |

7961

| InclusiveValueRange | This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal. |

7962

| ExclusiveValueRange | This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal. |

7963

| 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. |

7964

| 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. |

7965

| 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. |

7966

| BasicTimePeriod | BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time. |

7967

| 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. |

7968

| GregorianYear | A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601. |

7969

| GregorianYearMonth | A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601. |

7970

| GregorianDay | A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601. |

7971

| 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. |

7972

| 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. |

7973

| 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. |

7974

| 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. |

7975

| 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. |

7976

| 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. |

7977

| 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. |

7978

| 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. |

7979

| Month | A time datatype corresponding to W3C XML Schema's xs:gMonth datatype. |

7980

| MonthDay | A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype. |

7981

| Day | A time datatype corresponding to W3C XML Schema's xs:gDay datatype. |

7982

| Duration | A time datatype corresponding to W3C XML Schema's xs:duration datatype. |

7983

7984

**WildcardedMemberValueType:** WildcardedMemberValueType allows for an optional wildcard characters ('%') in an identifier.

7985

7986

Derived by restriction of `xs:string`.

7987

Regular Expression Pattern: `[A-Za-z0-9_@$-%]+`

7988

7989

**GeoCodelistTypeType:** GeoCodelistTypeType defines an enumeration of the speicfic types of geographic codelists.

7990

7991

Derived by restriction of `xs:string`.

Enumerations:

| **Value** | **Documentation** |

7996

| --- --| --- --|

7997

| GeographicCodelist | |

7998

| GeoGridCodelist | |

7999

8000

**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.

8001

8002

Derived by restriction of `xs:string`.

Enumerations:

| **Value** | **Documentation** |

8007

| --- --| --- --|

8008

| Allowed | The constraint contains the allowed values for attachable object. |

8009

| Actual | The constraints contains the actual data present for the attachable object. |

8010

8011

**SimpleOperatorType:** SimpleOperatorType provides an enumeration of simple operators to be applied to any value.

8012

8013

Derived by restriction of `xs:string`.

Enumerations:

| **Value** | **Documentation** |

8018

| --- --| --- --|

8019

| notEqual | (|=) - value must not be equal to the value supplied. |

8020

| equal | (=) - value must be exactly equal to the value supplied. |

8021

8022

**RangeOperatorType:** RangeOperatorType provides an enumeration of range operators to be applied to an ordered value.

8023

8024

Derived by restriction of `xs:string`.

Enumerations:

| **Value** | **Documentation** |

8029

| --- --| --- --|

8030

| greaterThanOrEqual | (>=) - value must be greater than or equal to the value supplied. |

8031

| lessThanOrEqual | (<=) - value must be less than or equal to the value supplied. |

8032

| greaterThan | (>) - value must be greater than the value supplied. |

8033

| lessThan | (<) - value must be less than the value supplied. |

8034

8035

**TextSearchOperatorType:** TextSearchOperatorType provides an enumeration of text search operators.

8036

8037

Derived by restriction of `xs:string`.

Enumerations:

| **Value** | **Documentation** |

8042

| --- --| --- --|

8043

| contains | The text being searched must contain the supplied text. |

8044

| startsWith | The text being searched must start with the supplied text. |

8045

| endsWith | The text being searched must end with the supplied text. |

8046

| doesNotContain | The text being searched cannot contain the supplied text. |

8047

| doesNotStartWith | The text being searched cannot start with the supplied text. |

8048

| doesNotEndWith | The text being searched cannot end with the supplied text. |

8049

8050

**OrderedOperatorType:** OrderedOperatorType combines the SimpleOperatorType and the RangeOperatorType to provide a full range or operators for any ordered value.

Union of:

`SimpleOperatorType, RangeOperatorType`.

8055

8056

**TextOperatorType:**

Union of:

`SimpleOperatorType, TextSearchOperatorType`.

8061

8062

**TimeOperatorType:** TimeOperatorType derives from the OrderedOperatorType to remove the notEqual operator.

8063

8064

Derived by restriction of `OrderedOperatorType`.

Enumerations:

| **Value** | **Documentation** |

8069

| --- --| --- --|

8070

| equal | |

8071

| greaterThanOrEqual | |

8072

| lessThanOrEqual | |

| greaterThan | |

| lessThan | |

**UsageType:** An enumeration of optional | mandatory to indicate the usage of an attribute or measure.

8077

8078

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.

8088

8089

Derived by restriction of `SimpleDataType`.

Enumerations:

| **Value** | **Documentation** |

8094

| --- --| --- --|

8095

| Alpha | A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z. |

8096

| 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. |

8097

| 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. |

8098

8099

**EpochPeriodType:** EpochPeriodType defines an enumeration of epoch period types.

8100

8101

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.

8114

8115

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.

8126

8127

Derived by restriction of `xs:string`.

Enumerations:

| **Value** | **Documentation** |

8132

| --- --| --- --|

8133

| Basic | The default mapping method. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.1 ("Basic Mapping"). |

8134

| Pivot | Method for mapping multi-measure data. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.2 ("Pivot Mapping"). |

8135

| 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"). |

8136

| 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"). |

8137

8138

**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`.

8143

8144

**StandardFromVtlMappingMethodType:** A simple type enumerating the standard mapping methods when converting from data structures from VTL to SDMX.

8145

8146

Derived by restriction of `xs:string`.

Enumerations:

| **Value** | **Documentation** |

8151

| --- --| --- --|

8152

| 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"). |

8153

| 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"). |

8154

| 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"). |

8155

8156

**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`.

8161

8162

**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