Interoperability Basis Platform

Various parts of the the documentation refer to stand-alone concepts, which were part of earlier draft releases but ultimately excluded from the final release of the standard.

102

103

**Rectification**

104

105

The documentation has been updated to remove this reference. This documentation includes:

106

107

* Concepts entry for Element Documentation of StructuresType (table beginning line 226).

108

* ConceptsType (line 270).

1. **Problem**

The ComponentMap element in the complex type StructureMapType has a maximum occurrence of 1. Therefore, it is not possible to completely map all components of a structure.

**Rectification**

The documentation of the StructureMapType has been updated to reflect that maximum occurrence of "unbounded" (line 2508).

117

118

= {{id name="__RefHeading___Toc46735778"/}}1Introduction =

119

120

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.

121

122

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.

123

124

= {{id name="__RefHeading___Toc46735779"/}}2Schema Documentation =

125

126

== {{id name="__RefHeading___Toc46735780"/}}2.1Structure Namespace ==

127

128

**http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/structure**

129

130

=== {{id name="__RefHeading___Toc46735781"/}}2.1.1Summary ===

131

132

Referenced Namespaces:

133

134

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

135

||

136

|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com

137

|http:~/~/www.w3.org/2001/XMLSchema|xs

Contents:

47 Global Elements

199 Complex Types

10 Simple Types

=== {{id name="__RefHeading___Toc46735782"/}}2.1.2Global Elements ===

146

147

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

148

149

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

150

151

Substitutions: Category, Code, Concept, //Organisation//, Agency, DataConsumer, DataProvider, OrganisationUnit, ReportingCategory, Transformation, VtlMapping, NamePersonalisation, Ruleset, UserDefinedOperator, CustomType

152

153

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

154

155

Substitutions: DataStructureComponents, MetadataStructureComponents

156

157

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

158

159

Substitutions: AttributeList, DimensionList, Group, MeasureList, MetadataTarget, ReportStructure

160

161

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

162

163

Substitutions: Attribute, ReportingYearStartDay, Dimension, TimeDimension, MeasureDimension, GroupDimension, PrimaryMeasure, KeyDescriptorValuesTarget, DataSetTarget, ConstraintContentTarget, ReportPeriodTarget, IdentifiableObjectTarget, MetadataAttribute

164

165

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

166

167

Substitution For: //Item//

168

169

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

170

171

Substitution For: //Item//

172

173

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

174

175

Substitution For: //Item//

176

177

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

178

179

Substitution For: //Grouping//

180

181

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

182

183

Substitution For: //ComponentList//

184

185

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

186

187

Substitution For: //Component//

188

189

**ReportingYearStartDay (ReportingYearStartDayType): **ReportingYearStartDay is a specialized data attribute which provides important context to the time dimension. If the value of the time dimension is one of the standard reporting periods (see common:ReportingTimePeriodType) then this attribute is used to state the month and day that the reporting year begins. This provides a reference point from which the actual calendar dates covered by these periods can be determined. If this attribute does not occur in a data set, then the reporting year start day will be assumed to be January 1.

190

191

Substitution For: //Component//

192

193

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

194

195

Substitution For: //ComponentList//

196

197

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

198

199

Substitution For: //Component//

200

201

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

202

203

Substitution For: //Component//

204

205

**MeasureDimension (MeasureDimensionType): **MeasureDimension is a special type of dimension which defines multiple measures in a key family. This is represented as any other dimension in a unless it is the observation dimension. It takes it representation from a concept scheme, and this scheme defines the measures and their representations. When data is formatted with this as the observation dimension, these measures can be made explicit or the value of the dimension can be treated as any other dimension. If the measures are explicit, the representation of the observation will be specific to the core representation for each concept in the representation concept scheme. Note that it is necessary that these representations are compliant (the same or derived from) with that of the primary measure.

206

207

Substitution For: //Component//

208

209

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

210

211

Substitution For: //ComponentList//

212

213

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

214

215

Substitution For: //Component//

216

217

**MeasureList (MeasureListType): **MeasureList describes the measure descriptor for a key family. It contains a single metadata concepts that define the primary measures of a data structure.

218

219

Substitution For: //ComponentList//

220

221

**PrimaryMeasure (PrimaryMeasureType): **PrimaryMeasure defines the structure of the primary measure, which is the concept that is the value of the phenomenon to be measured in a data set. Although this may take its semantic from any concept, this is provided a fixed identifier (OBS_VALUE) so that it may be easily distinguished in data messages.

222

223

Substitution For: //Component//

224

225

**MetadataStructureComponents (MetadataStructureComponentsType): **MetadataStructureComponents defines the grouping of the sets of the components that make up the metadata structure definition. All components and component list (target identifiers, identifier components, report structures, and metadata attributes) in the structure definition must have a unique identification.

226

227

Substitution For: //Grouping//

228

229

**MetadataTarget (MetadataTargetType): **MetadataTarget is a collection of target objects which when taken together describe a structure which defines the key of an object type to which metadata may be attached and serve to disambiguate reference metadata set reports.

230

231

Substitution For: //ComponentList//

232

233

**KeyDescriptorValuesTarget (KeyDescriptorValuesTargetType): **KeyDescriptorValuesTarget is target object which references a data key for the purpose of attach reference metadata to portions of data. A data key is a set of dimension references and values for those dimension. This component on its own is not of much use, as the data key only has local references to the dimensions. Therefore it is typical that this is used in combination with some sort of reference to the data (either a data set reference or a reference to the underlying structure, structure usage, or provision agreement of the data.

234

235

Substitution For: //Component//

236

237

**DataSetTarget (DataSetTargetType): **DataSetTarget is target object which references a data set for the purpose of attaching reference metadata data. A data set reference is a full reference to a data provider and an identifier for the data set.

238

239

Substitution For: //Component//

240

241

**ConstraintContentTarget (ConstraintContentTargetType): **ConstraintContentTarget is target object which references an attachment constraint for the purpose of attaching reference metadata data to data key sets or cube regions defined by the constraint.

242

243

Substitution For: //Component//

244

245

**ReportPeriodTarget (ReportPeriodTargetType): **ReportPeriodTarget is target object which specifies a reporting period to which a metadata report applies.

246

247

Substitution For: //Component//

248

249

**IdentifiableObjectTarget (IdentifiableObjectTargetType): **IdentifiableObjectTarget is target object which references an Identifiable object as defined in the SDMX Information Model. The reference must be complete (i.e. a URN or a complete set of reference fields). For an item object, it is possible to define a local representation of an item scheme from which the item must be referenced.

250

251

Substitution For: //Component//

252

253

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

254

255

Substitution For: //ComponentList//

256

257

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

258

259

Substitution For: //Component//

260

261

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

262

263

Substitution For: //Item//

264

265

Substitutions: Agency, DataConsumer, DataProvider, OrganisationUnit

266

267

**Agency (AgencyType): **Agency is an organisation which maintains structural metadata such as statistical classifications, glossaries, key family structural definitions, and metadata structure definitions..

268

269

Substitution For: //Organisation//

270

271

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

272

273

Substitution For: //Organisation//

274

275

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

276

277

Substitution For: //Organisation//

278

279

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

280

281

Substitution For: //Organisation//

282

283

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

284

285

Substitution For: //Item//

286

287

//**ItemAssociation**//** (//ItemAssociationType//): **ItemAssociation is an abstract description of the relation between two items for the purpose of mapping.

288

289

Substitutions: OrganisationMap, CategoryMap, CodeMap, ConceptMap, ReportingCategoryMap

290

291

**OrganisationMap (OrganisationMapType): **OrganisationMap relates a source organisation to a target organisation.

292

293

Substitution For: //ItemAssociation//

294

295

**CategoryMap (CategoryMapType): **CategoryMap defines the structure of a map which identifies relationships between categories in different category schemes.

296

297

Substitution For: //ItemAssociation//

298

299

**CodeMap (CodeMapType): **CodeMap defines the structure of a map which identifies relationships between codes in different codelists.

300

301

Substitution For: //ItemAssociation//

302

303

**ConceptMap (ConceptMapType): **ConceptMap defines the structure of a map which identifies relationships between concepts in different concept schemes.

304

305

Substitution For: //ItemAssociation//

306

307

**ReportingCategoryMap (ReportingCategoryMapType): **ReportingCategoryMap defines the structure of a map which identifies relationships between reporting categories in different reporting taxonomies.

308

309

Substitution For: //ItemAssociation//

310

311

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

312

313

Substitution For: //Item//

314

315

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

316

317

Substitution For: //Item//

318

319

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

320

321

Substitution For: //Item//

322

323

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

324

325

Substitution For: //Item//

326

327

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

328

329

Substitution For: //Item//

330

331

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

332

333

Substitution For: //Item//

334

335

=== {{id name="__RefHeading___Toc46735783"/}}2.1.3Complex Types ===

336

337

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

Content:

OrganisationSchemes?, Dataflows?, Metadataflows?, CategorySchemes?, Categorisations?, Codelists?, HierarchicalCodelists?, Concepts?, MetadataStructures?, DataStructures?, StructureSets?, ReportingTaxonomies?, Processes?, Constraints?, ProvisionAgreements?, CustomTypes?, VtlMappings?, NamePersonalisations?, Rulesets?, Transformations?, UserDefinedOperators?

342

343

Element Documentation:

344

345

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

346

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

347

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

348

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

349

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

350

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

351

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

352

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

353

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

354

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

355

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

356

|StructureSets|StructureSetsType|StructureSets contains a collection of structure set descriptions. The structure sets may be detailed in full, or referenced from an external structure document or registry service.

357

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

358

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

359

|Constraints|ConstraintsType|Constraints contains a collection of constraint descriptions. This container may contain both attachment and content constraints. The constraints may be detailed in full, or referenced from an external structure document or registry service.

360

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

361

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

362

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

363

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

364

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

365

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

366

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

367

368

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

Content:

(AgencyScheme | DataConsumerScheme | DataProviderScheme | OrganisationUnitScheme)+

373

374

Element Documentation:

375

376

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

377

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

378

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

379

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

380

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

381

382

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

389

390

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

391

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

392

393

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

400

401

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

402

|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

403

404

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

411

412

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

413

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

414

415

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

422

423

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

424

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

425

426

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

Content:

Codelist+

Element Documentation:

433

434

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

435

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

436

437

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

Content:

HierarchicalCodelist+

442

443

Element Documentation:

444

445

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

446

|HierarchicalCodelist|HierarchicalCodelist Type|HierarchicalCodelist provides the details of a hierarchical code list, which is defined as an organised collection of codes that may participate in many parent/child relationships with other codes in the list, as defined by one or more hierarchy of the list.

447

448

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

Content:

ConceptScheme*

Element Documentation:

455

456

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

457

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

458

459

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

466

467

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

468

|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 a reference metadata report is derived from this presentational structure.

469

470

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

477

478

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

479

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

480

481

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

Content:

StructureSet+

Element Documentation:

488

489

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

490

|StructureSet|StructureSetType|StructureSet provides the details or a structure set, which allows components in one structure, structure usage, or item scheme to be mapped to components in another structural component of the same type.

491

492

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

499

500

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

501

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

502

503

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

510

511

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

512

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

513

514

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

Content:

(AttachmentConstraint | ContentConstraint)+

519

520

Element Documentation:

521

522

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

523

|AttachmentConstraint|AttachmentConstraint Type|AttachmentConstraint describes sub sets of the content of a data or metadata set in terms of the content regions or in terms of the set of key combinations to which attributes or reference metadata (as defined by structure definitions) may be attached.

524

|ContentConstraint|ContentConstraintTyp e|ContentConstraint specifies a sub set of the definition of the allowable or available content of a data or metadata set in terms of the content or in terms of the set of key combinations.

525

526

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

Element Documentation:

533

534

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

535

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

536

537

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

Content:

CustomTypeScheme+

Element Documentation:

544

545

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

546

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

547

548

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

Content:

VtlMappingScheme+

Element Documentation:

555

556

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

557

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

558

559

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

Content:

NamePersonalisationScheme+

564

565

Element Documentation:

566

567

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

568

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

569

570

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

Content:

RulesetScheme+

Element Documentation:

577

578

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

579

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

580

581

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

Content:

TransformationScheme+

586

587

Element Documentation:

588

589

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

590

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

591

592

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

Content:

UserDefinedOperatorScheme+

597

598

Element Documentation:

599

600

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

601

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

602

603

//**IdentifiableType**//**: **IdentifiableType is an abstract base type for all identifiable objects.

Derivation:

//com:AnnotableType// (extension)

608

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType//

Attributes:

id?, urn?, uri?

Content:

com:Annotations?

Attribute Documentation:

619

620

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

621

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

622

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

623

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

624

625

Element Documentation:

626

627

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

628

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

629

630

//**NameableType**//**: **NameableType is an abstract base type for all nameable objects.

Derivation:

//com:AnnotableType// (extension)

635

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

636

[[image:inherit.gif||height="9" width="9"]] //NameableType//

Attributes:

id?, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*

645

646

Attribute Documentation:

647

648

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

649

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

650

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

651

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

652

653

Element Documentation:

654

655

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

656

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

657

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

658

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

659

660

//**VersionableType**//**: **VersionableType is an abstract base type for all versionable objects.

Derivation:

//com:AnnotableType// (extension)

665

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

666

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

667

[[image:inherit.gif||height="9" width="9"]] //VersionableType//

Attributes:

id?, urn?, uri?, version?, validFrom?, validTo?

Content:

com:Annotations?, com:Name+, com:Description*

676

677

Attribute Documentation:

678

679

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

680

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

681

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

682

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

683

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

684

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

685

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

686

687

Element Documentation:

688

689

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

690

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

691

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

692

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

693

694

//**MaintainableBaseType**//**: **MaintainableBaseType is an abstract type that only serves the purpose of forming the base for the actual MaintainableType. The purpose of this type is to restrict the VersionableType to require the id attribute.

Derivation:

//com:AnnotableType// (extension)

699

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

700

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

701

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

702

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType//

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?

Content:

com:Annotations?, com:Name+, com:Description*

711

712

Attribute Documentation:

713

714

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

715

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

716

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

717

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

718

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

719

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

720

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

721

722

Element Documentation:

723

724

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

725

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

726

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

727

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

728

729

//**MaintainableType**//**: **MaintainableType is an abstract base type for all maintainable objects.

Derivation:

//com:AnnotableType// (extension)

734

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

735

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

736

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

737

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

738

[[image:inherit.gif||height="9" width="9"]] //MaintainableType//

Attributes:

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

Content:

com:Annotations?, com:Name+, com:Description*

747

748

Attribute Documentation:

749

750

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

751

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

752

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

753

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

754

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

755

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

756

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

757

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

758

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

759

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

760

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

761

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

762

763

Element Documentation:

764

765

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

766

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

767

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

768

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

769

770

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

//com:AnnotableType// (extension)

775

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

776

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

777

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

778

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

779

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

780

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType//

Attributes:

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

Content:

com:Annotations?, com:Name+, com:Description*, //Item*//

789

790

Attribute Documentation:

791

792

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

793

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

794

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

795

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

796

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

797

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

798

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

799

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

800

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

801

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

802

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

803

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

804

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

805

806

Element Documentation:

807

808

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

809

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

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

811

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

812

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

813

814

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

//com:AnnotableType// (extension)

819

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

820

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

821

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*

830

831

Attribute Documentation:

832

833

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

834

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

835

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

836

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

837

838

Element Documentation:

839

840

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

841

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

842

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

843

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

844

845

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

//com:AnnotableType// (extension)

850

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

851

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

852

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

853

[[image:inherit.gif||height="9" width="9"]] //ItemType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, (Parent | //Item+//)?

862

863

Attribute Documentation:

864

865

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

866

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

867

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

868

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

869

870

Element Documentation:

871

872

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

873

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

874

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

875

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

876

|Parent|//com: LocalItemReferenceTy pe//|

877

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

878

879

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

Derivation:

//com:AnnotableType// (extension)

884

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

885

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

886

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

887

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

888

[[image:inherit.gif||height="9" width="9"]] //UnnestedItemType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*

897

898

Attribute Documentation:

899

900

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

901

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

902

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

903

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

904

905

Element Documentation:

906

907

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

908

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

909

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

910

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

911

912

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

Derivation:

//com:AnnotableType// (extension)

917

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

918

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

919

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

920

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

921

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

922

[[image:inherit.gif||height="9" width="9"]] //StructureType//

Attributes:

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

Content:

com:Annotations?, com:Name+, com:Description*, //Grouping?//

931

932

Attribute Documentation:

933

934

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

935

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

936

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

937

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

938

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

939

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

940

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

941

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

942

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

943

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

944

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

945

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

946

947

Element Documentation:

948

949

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

950

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

951

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

952

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

953

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

954

955

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

962

963

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

964

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

965

966

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

//com:AnnotableType// (extension)

971

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

972

[[image:inherit.gif||height="9" width="9"]] //ComponentListType//

Attributes:

id?, urn?, uri?

Content:

com:Annotations?, //Component*//

981

982

Attribute Documentation:

983

984

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

985

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

986

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

987

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

988

989

Element Documentation:

990

991

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

992

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

993

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

994

995

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

//com:AnnotableType// (extension)

1000

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

1001

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType//

Attributes:

id?, urn?, uri?

Content:

com:Annotations?

Attribute Documentation:

1012

1013

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

1014

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

1015

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

1016

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

1017

1018

Element Documentation:

1019

1020

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

1021

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

1022

1023

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

//com:AnnotableType// (extension)

1028

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

1029

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

1030

[[image:inherit.gif||height="9" width="9"]] //ComponentType//

Attributes:

id?, urn?, uri?

Content:

com:Annotations?, ConceptIdentity?, LocalRepresentation?

1039

1040

Attribute Documentation:

1041

1042

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

1043

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

1044

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

1045

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

1046

1047

Element Documentation:

1048

1049

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

1050

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

1051

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

1052

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

1053

1054

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

//com:AnnotableType// (extension)

1059

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

1060

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

1061

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

1062

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

1063

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

1064

[[image:inherit.gif||height="9" width="9"]] //StructureUsageType//

Attributes:

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

Content:

com:Annotations?, com:Name+, com:Description*, Structure?

1073

1074

Attribute Documentation:

1075

1076

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

1077

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

1078

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

1079

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

1080

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

1081

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

1082

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

1083

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

1084

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

1085

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

1086

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

1087

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

1088

1089

Element Documentation:

1090

1091

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

1092

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

1093

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

1094

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

1095

|Structure|//com: StructureReferenceBa seType//|Structure references the structure (data structure or metadata structure definition) which the structure usage is based upon. Implementations will have to refine the type to use a concrete structure reference (i.e. either a data structure or metadata structure definition reference).

1096

1097

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

Content:

(TextFormat | (Enumeration, EnumerationFormat?))

1102

1103

Element Documentation:

1104

1105

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

1106

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

1107

|Enumeration|//com: ItemSchemeReferenceB aseType//|Enumeration references an item scheme that enumerates the allowable values for this representation.

1108

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

1109

1110

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

{Empty}

Attribute Documentation:

1121

1122

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

1123

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

1124

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

1125

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

1126

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

1127

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

1128

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

1129

|startTime|com: StandardTimePeriodTy pe|The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.

1130

|endTime|com: StandardTimePeriodTy pe|The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence.

1131

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

1132

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

1133

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

1134

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

1135

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

1136

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

1137

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

1138

1139

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

1144

[[image:inherit.gif||height="9" width="9"]] BasicComponentTextFormatType

Attributes:

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

Content:

{Empty}

Attribute Documentation:

1155

1156

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

1157

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

1158

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

1159

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

1160

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

1161

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

1162

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

1163

|startTime|com: StandardTimePeriodTy pe|The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.

1164

|endTime|com: StandardTimePeriodTy pe|The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence.

1165

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

1166

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

1167

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

1168

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

1169

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

1170

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

1171

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

1172

1173

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

Derivation:

TextFormatType (restriction)

1178

[[image:inherit.gif||height="9" width="9"]] BasicComponentTextFormatType (restriction)

1179

[[image:inherit.gif||height="9" width="9"]] SimpleComponentTextFormatType

Attributes:

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

Content:

{Empty}

Attribute Documentation:

1190

1191

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

1192

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

1193

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

1194

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

1195

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

1196

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

1197

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

1198

|startTime|com: StandardTimePeriodTy pe|The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.

1199

|endTime|com: StandardTimePeriodTy pe|The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence.

1200

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

1201

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

1202

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

1203

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

1204

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

1205

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

1206

1207

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

Derivation:

TextFormatType (restriction)

1212

[[image:inherit.gif||height="9" width="9"]] BasicComponentTextFormatType (restriction)

1213

[[image:inherit.gif||height="9" width="9"]] SimpleComponentTextFormatType (restriction)

1214

[[image:inherit.gif||height="9" width="9"]] CodededTextFormatType

Attributes:

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

Content:

{Empty}

Attribute Documentation:

1225

1226

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

1227

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

1228

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

1229

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

1230

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

1231

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

1232

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

1233

|startTime|com: StandardTimePeriodTy pe|The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.

1234

|endTime|com: StandardTimePeriodTy pe|The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence.

1235

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

1236

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

1237

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

1238

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

1239

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

1240

1241

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

Derivation:

TextFormatType (restriction)

1246

[[image:inherit.gif||height="9" width="9"]] BasicComponentTextFormatType (restriction)

1247

[[image:inherit.gif||height="9" width="9"]] SimpleComponentTextFormatType (restriction)

1248

[[image:inherit.gif||height="9" width="9"]] NonFacetedTextFormatType

Attributes:

textType?

Content:

{Empty}

Attribute Documentation:

1259

1260

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

1261

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

1262

1263

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

1268

[[image:inherit.gif||height="9" width="9"]] BasicComponentTextFormatType (restriction)

1269

[[image:inherit.gif||height="9" width="9"]] SimpleComponentTextFormatType (restriction)

1270

[[image:inherit.gif||height="9" width="9"]] TimeTextFormatType

Attributes:

textType?, startTime?, endTime?

Content:

{Empty}

Attribute Documentation:

1281

1282

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

1283

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

1284

|startTime|com: StandardTimePeriodTy pe|The startTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates the start time of the sequence. This value is mandatory for a time sequence to be expressed.

1285

|endTime|com: StandardTimePeriodTy pe|The endTime attribute is used in conjunction with the isSequence and timeInterval attributes (which must be set in order to use this attribute). This attribute is used for a time sequence, and indicates that ending point (if any) of the sequence.

1286

1287

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

//com:AnnotableType// (extension)

1292

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

1293

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

1294

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

1295

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

1296

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

1297

[[image:inherit.gif||height="9" width="9"]] CategorisationType

Attributes:

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

Content:

com:Annotations?, com:Name+, com:Description*, (Source, Target)?

1306

1307

Attribute Documentation:

1308

1309

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

1310

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

1311

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

1312

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

1313

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

1314

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

1315

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

1316

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

1317

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

1318

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

1319

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

1320

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

1321

1322

Element Documentation:

1323

1324

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

1325

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

1326

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

1327

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

1328

|Source|com: ObjectReferenceType|Source is a reference to an object to be categorized.

1329

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

1330

1331

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

//com:AnnotableType// (extension)

1336

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

1337

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

1338

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

1339

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

1340

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

1341

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)

1342

[[image:inherit.gif||height="9" width="9"]] CategorySchemeType

Attributes:

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

Content:

com:Annotations?, com:Name+, com:Description*, Category*

1351

1352

Attribute Documentation:

1353

1354

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

1355

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

1356

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

1357

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

1358

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

1359

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

1360

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

1361

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

1362

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

1363

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

1364

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

1365

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

1366

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

1367

1368

Element Documentation:

1369

1370

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

1371

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

1372

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

1373

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

1374

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

1375

1376

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

//com:AnnotableType// (extension)

1381

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

1382

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

1383

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

1384

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

1385

[[image:inherit.gif||height="9" width="9"]] CategoryType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Category*

1394

1395

Attribute Documentation:

1396

1397

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

1398

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

1399

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

1400

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

1401

1402

Element Documentation:

1403

1404

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

1405

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

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

1407

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

1408

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

1409

1410

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

Derivation:

//com:AnnotableType// (extension)

1415

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

1416

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

1417

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

1418

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

1419

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

1420

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)

1421

[[image:inherit.gif||height="9" width="9"]] CodelistType

Attributes:

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

Content:

com:Annotations?, com:Name+, com:Description*, Code*

1430

1431

Attribute Documentation:

1432

1433

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

1434

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

1435

|urn|xs:anyURI|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

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

1438

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

1439

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

1440

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

1441

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

1442

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

1443

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

1444

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

1445

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

1446

1447

Element Documentation:

1448

1449

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

1450

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

1451

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

1452

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

1453

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

1454

1455

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

//com:AnnotableType// (extension)

1460

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

1461

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

1462

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

1463

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

1464

[[image:inherit.gif||height="9" width="9"]] CodeType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Parent?

1473

1474

Attribute Documentation:

1475

1476

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

1477

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

1478

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

1479

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

1480

1481

Element Documentation:

1482

1483

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

1484

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

1485

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

1486

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

1487

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

1488

1489

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

//com:AnnotableType// (extension)

1494

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

1495

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

1496

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

1497

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

1498

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

1499

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)

1500

[[image:inherit.gif||height="9" width="9"]] ConceptSchemeType

Attributes:

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

Content:

com:Annotations?, com:Name+, com:Description*, Concept*

1509

1510

Attribute Documentation:

1511

1512

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

1513

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

1514

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

1515

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

1516

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

1517

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

1518

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

1519

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

1520

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

1521

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

1522

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

1523

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

1524

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

1525

1526

Element Documentation:

1527

1528

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

1529

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

1530

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

1531

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

1532

|Concept|ConceptType|Concept describes the details of a concept within a concept scheme.

1533

1534

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

//com:AnnotableType// (extension)

1539

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

1540

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

1541

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

1542

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

1543

[[image:inherit.gif||height="9" width="9"]] //ConceptBaseType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Parent?

1552

1553

Attribute Documentation:

1554

1555

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

1556

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

1557

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

1558

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

1559

1560

Element Documentation:

1561

1562

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

1563

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

1564

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

1565

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

1566

|Parent|com: LocalConceptReferenc eType|Parent captures the semantic relationships between concepts which occur within a single concept scheme. This identifies the concept of which the current concept is a qualification (in the ISO 11179 sense) or subclass.

1567

1568

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

//com:AnnotableType// (extension)

1573

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

1574

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

1575

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

1576

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

1577

[[image:inherit.gif||height="9" width="9"]] //ConceptBaseType// (extension)

1578

[[image:inherit.gif||height="9" width="9"]] ConceptType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Parent?, CoreRepresentation?, ISOConceptReference?

1587

1588

Attribute Documentation:

1589

1590

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

1591

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

1592

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

1593

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

1594

1595

Element Documentation:

1596

1597

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

1598

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

1599

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

1600

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

1601

|Parent|com: LocalConceptReferenc eType|Parent captures the semantic relationships between concepts which occur within a single concept scheme. This identifies the concept of which the current concept is a qualification (in the ISO 11179 sense) or subclass.

1602

|CoreRepresentation|ConceptRepresentatio n|

1603

|ISOConceptReference|ISOConceptReferenceT ype|Provides a reference to an ISO 11179 concept.

1604

1605

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

1610

[[image:inherit.gif||height="9" width="9"]] ConceptRepresentation

Content:

(TextFormat | (Enumeration, EnumerationFormat?))

1615

1616

Element Documentation:

1617

1618

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

1619

|TextFormat|BasicComponentTextFo rmatType|TextFormat describes an uncoded textual format.

1620

|Enumeration|com: CodelistReferenceTyp e|Enumeration references a codelist which enumerates the possible values that can be used as the representation of this concept.

1621

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

1622

1623

**ISOConceptReferenceType: **ISOConceptReferenceType provides a reference to and ISO 11179 concept.

Content:

ConceptAgency, ConceptSchemeID, ConceptID

1628

1629

Element Documentation:

1630

1631

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

1632

|ConceptAgency|xs:string|

1633

|ConceptSchemeID|xs:string|

1634

|ConceptID|xs:string|

1635

1636

//**ConstraintBaseType**//**: **ConstraintBaseType is an abstract base type that forms the basis of the main abstract ConstraintType. It requires that a name be provided.

Derivation:

//com:AnnotableType// (extension)

1641

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

1642

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

1643

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

1644

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

1645

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)

1646

[[image:inherit.gif||height="9" width="9"]] //ConstraintBaseType//

Attributes:

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

Content:

com:Annotations?, com:Name+, com:Description*

1655

1656

Attribute Documentation:

1657

1658

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

1659

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

1660

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

1661

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

1662

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

1663

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

1664

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

1665

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

1666

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

1667

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

1668

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

1669

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

1670

1671

Element Documentation:

1672

1673

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

1674

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

1675

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

1676

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

1677

1678

//**ConstraintType**//**: **ConstraintType is an abstract base type that specific types of constraints (content and attachment) restrict and extend to describe their details. The inclusion of a key or region in a constraint is determined by first processing the included key sets, and then removing those keys defined in the excluded key sets. If no included key sets are defined, then it is assumed the all possible keys or regions are included, and any excluded key or regions are removed from this complete set.

Derivation:

//com:AnnotableType// (extension)

1683

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

1684

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

1685

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

1686

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

1687

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)

1688

[[image:inherit.gif||height="9" width="9"]] //ConstraintBaseType// (extension)

1689

[[image:inherit.gif||height="9" width="9"]] //ConstraintType//

Attributes:

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

Content:

com:Annotations?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*

1698

1699

Attribute Documentation:

1700

1701

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

1702

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

1703

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

1704

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

1705

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

1706

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

1707

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

1708

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

1709

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

1710

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

1711

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

1712

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

1713

1714

Element Documentation:

1715

1716

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

1717

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

1718

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

1719

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

1720

|ConstraintAttachment|//ConstraintAttachment Type//|ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to.

1721

|DataKeySet|DataKeySetType|

1722

|MetadataKeySet|MetadataKeySetType|

1723

|CubeRegion|com:CubeRegionType|

1724

|MetadataTargetRegion|com: MetadataTargetRegion Type|

1725

1726

**AttachmentConstraintType: **AttachmentConstraintType describes the details of an attachment constraint by defining the data or metadata key sets or component regions that attributes or reference metadata may be attached in the constraint attachment objects.

Derivation:

//com:AnnotableType// (extension)

1731

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

1732

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

1733

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

1734

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

1735

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)

1736

[[image:inherit.gif||height="9" width="9"]] //ConstraintBaseType// (extension)

1737

[[image:inherit.gif||height="9" width="9"]] //ConstraintType// (restriction)

1738

[[image:inherit.gif||height="9" width="9"]] AttachmentConstraintType

Attributes:

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

Content:

com:Annotations?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet)*

1747

1748

Attribute Documentation:

1749

1750

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

1751

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

1752

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

1753

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

1754

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

1755

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

1756

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

1757

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

1758

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

1759

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

1760

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

1761

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

1762

1763

Element Documentation:

1764

1765

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

1766

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

1767

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

1768

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

1769

|ConstraintAttachment|AttachmentConstraint AttachmentType|ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to.

1770

|DataKeySet|DataKeySetType|

1771

|MetadataKeySet|MetadataKeySetType|

1772

1773

//**ContentConstraintBaseType**//**: **ContentConstraintBaseType is an abstract base type that forms the basis for the ContentConstraintType.

Derivation:

//com:AnnotableType// (extension)

1778

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

1779

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

1780

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

1781

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

1782

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)

1783

[[image:inherit.gif||height="9" width="9"]] //ConstraintBaseType// (extension)

1784

[[image:inherit.gif||height="9" width="9"]] //ConstraintType// (restriction)

1785

[[image:inherit.gif||height="9" width="9"]] //ContentConstraintBaseType//

Attributes:

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

Content:

com:Annotations?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*

1794

1795

Attribute Documentation:

1796

1797

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

1798

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

1799

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

1800

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

1801

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

1802

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

1803

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

1804

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

1805

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

1806

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

1807

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

1808

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

1809

1810

Element Documentation:

1811

1812

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

1813

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

1814

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

1815

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

1816

|ConstraintAttachment|ContentConstraintAtt achmentType|ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to.

1817

|DataKeySet|DataKeySetType|DataKeySet defines a collection of full or partial data keys.

1818

|MetadataKeySet|MetadataKeySetType|MetadataKeySet defines a collection of metadata keys.

1819

|CubeRegion|com:CubeRegionType|CubeRegion describes a set of dimension values which define a region and attributes which relate to the region for the purpose of describing a constraint.

1820

|MetadataTargetRegion|com: MetadataTargetRegion Type|MetadataTargetRegion describes a set of target object values for a given report structure which define a region, and the metadata attribute which relate to the target for the purpose of describing a constraint.

1821

1822

**ContentConstraintType: **ContentConstraintType describes the details of a content constraint by defining the content regions, key sets, or release information for the constraint attachment objects. Note that if the constraint is for a data provider, then only release calendar information is relevant, as there is no reliable way of determining which key family is being used to frame constraints in terms of cube regions or key sets.

Derivation:

//com:AnnotableType// (extension)

1827

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

1828

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

1829

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

1830

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

1831

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)

1832

[[image:inherit.gif||height="9" width="9"]] //ConstraintBaseType// (extension)

1833

[[image:inherit.gif||height="9" width="9"]] //ConstraintType// (restriction)

1834

[[image:inherit.gif||height="9" width="9"]] //ContentConstraintBaseType// (extension)

1835

[[image:inherit.gif||height="9" width="9"]] ContentConstraintType

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, type?

Content:

com:Annotations?, com:Name+, com:Description*, ConstraintAttachment?, (DataKeySet | MetadataKeySet | CubeRegion | MetadataTargetRegion)*, ReleaseCalendar?, ReferencePeriod?

1844

1845

Attribute Documentation:

1846

1847

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

1848

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

1849

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

1850

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

1851

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

1852

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

1853

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

1854

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

1855

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

1856

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

1857

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

1858

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

1859

|type (default: Actual)|com: ContentConstraintTyp eCodeType|The type attribute indicates whether this constraint states what data is actually present for the constraint attachment, or if it defines what content is allowed. The default value is "Actual", meaning the data actually present for the constraint attachment.

1860

1861

Element Documentation:

1862

1863

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

1864

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

1865

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

1866

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

1867

|ConstraintAttachment|ContentConstraintAtt achmentType|ConstraintAttachment describes the collection of constrainable artefacts that the constraint is attached to.

1868

|DataKeySet|DataKeySetType|DataKeySet defines a collection of full or partial data keys.

1869

|MetadataKeySet|MetadataKeySetType|MetadataKeySet defines a collection of metadata keys.

1870

|CubeRegion|com:CubeRegionType|CubeRegion describes a set of dimension values which define a region and attributes which relate to the region for the purpose of describing a constraint.

1871

|MetadataTargetRegion|com: MetadataTargetRegion Type|MetadataTargetRegion describes a set of target object values for a given report structure which define a region, and the metadata attribute which relate to the target for the purpose of describing a constraint.

1872

|ReleaseCalendar|ReleaseCalendarType|ReleaseCalendar defines dates on which the constrained data is to be made available.

1873

|ReferencePeriod|com: ReferencePeriodType|ReferencePeriod is used to report start date and end date constraints.

1874

1875

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

1880

1881

Element Documentation:

1882

1883

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

1884

|Periodicity|xs:string|Periodicity is the period between releases of the data set.

1885

|Offset|xs:string|Offset is the interval between January first and the first release of data within the year.

1886

|Tolerance|xs:string|Tolerance is the period after which the release of data may be deemed late.

1887

1888

//**KeySetType**//**: **KeySetType is an abstract base type for defining a collection of keys.

Attributes:

isIncluded

Content:

Key+

Attribute Documentation:

1899

1900

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

1901

|isIncluded|xs:boolean|The isIncluded attribute indicates whether the keys defined in this key set are inclusive or exclusive to the constraint.

1902

1903

Element Documentation:

1904

1905

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

1906

|Key|//com:DistinctKeyType//|Key contains a data or metadata key, which are sets of component values which identify the data or metadata.

1907

1908

**DataKeySetType: **DataKeySetType defines a collection of full or partial data keys (dimension values).

Derivation:

//KeySetType// (restriction)

1913

[[image:inherit.gif||height="9" width="9"]] DataKeySetType

Attributes:

isIncluded

Content:

Key+

Attribute Documentation:

1924

1925

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

1926

|isIncluded|xs:boolean|The isIncluded attribute indicates whether the keys defined in this key set are inclusive or exclusive to the constraint.

1927

1928

Element Documentation:

1929

1930

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

1931

|Key|com:DataKeyType|Key contains a set of dimension values which identify a full set of data.

1932

1933

**MetadataKeySetType: **MetadataKeySetType defines a collection of metadata keys (identifier component values).

Derivation:

//KeySetType// (restriction)

1938

[[image:inherit.gif||height="9" width="9"]] MetadataKeySetType

Attributes:

isIncluded

Content:

Key+

Attribute Documentation:

1949

1950

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

1951

|isIncluded|xs:boolean|The isIncluded attribute indicates whether the keys defined in this key set are inclusive or exclusive to the constraint.

1952

1953

Element Documentation:

1954

1955

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

1956

|Key|com:MetadataKeyType|Key contains a set of target object values for a specified report structure which serve to identify which object reference metadata conforming to the specified report structure is available for.

1957

1958

//**ConstraintAttachmentType**//**: **ConstraintAttachmentType describes a collection of references to constrainable artefacts.

Content:

Element Documentation:

1965

1966

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

1967

|DataProvider|com: DataProviderReferenc eType|DataProvider is reference to a data provider to which the constraint is attached. If this is used, then only the release calendar is relevant. The referenced is provided as a URN and/or a full set of reference fields.

1968

|DataSet|com:SetReferenceType|DataSet is reference to a data set to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields.

1969

|MetadataSet|com:SetReferenceType|MetadataSet is reference to a metadata set to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields.

1970

|SimpleDataSource|xs:anyURI|SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message.

1971

|DataStructure|com: DataStructureReferen ceType|DataStructure is reference to a data structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached.

1972

|QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.

1973

|MetadataStructure|com: MetadataStructureRef erenceType|MetadataStructure is reference to a metadata structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached.

1974

|QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.

1975

|Dataflow|com: DataflowReferenceTyp e|Dataflow is reference to a data flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one dataflow, and the dataflows do not necessarily have to be usages of the same data structure. However, a constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached.

1976

|QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.

1977

|Metadataflow|com: MetadataflowReferenc eType|Metadataflow is reference to a metadata flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one metadataflow, and the metadataflows do not necessarily have to be usages of the same metadata structure. However, a constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached.

1978

|QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.

1979

|ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreementReference is reference to a provision agreement to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one provision aggreement, and the provision agreements do not necessarily have to be references structure usages based on the same structure. However, a constraint which is attached to more than one provision agreement must only express key sets and/or cube/target regions where the identifier of the components are common across all structures to which the constraint is attached.

1980

|QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.

1981

1982

**AttachmentConstraintAttachmentType: **AttachmentConstraintAttachmentType defines the structure for specifying the object to which an attachment constraints applies.

Derivation:

//ConstraintAttachmentType// (restriction)

1987

[[image:inherit.gif||height="9" width="9"]] AttachmentConstraintAttachmentType

Content:

Element Documentation:

1994

1995

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

1996

|DataSet|com:SetReferenceType|DataSet is reference to a data set to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. Multiple instance can only be used if they have the same underlying structure.

1997

|MetadataSet|com:SetReferenceType|MetadataSet is reference to a metadata set to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. Multiple instance can only be used if they have the same underlying structure.

1998

|SimpleDataSource|xs:anyURI|SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message. Multiple instance can only be used if they have the same underlying structure.

1999

|DataStructure|com: DataStructureReferen ceType|DataStructure is reference to a data structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached.

2000

|MetadataStructure|com: MetadataStructureRef erenceType|MetadataStructure is reference to a metadata structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached.

2001

|Dataflow|com: DataflowReferenceTyp e|Dataflow is reference to a data flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one dataflow, and the dataflows do not necessarily have to be usages of the same data structure. However, a constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached.

2002

|Metadataflow|com: MetadataflowReferenc eType|Metadataflow is reference to a metadata flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one metadataflow, and the metadataflows do not necessarily have to be usages of the same metadata structure. However, a constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached.

2003

|ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreementReference is reference to a provision agreement to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one provision aggreement, and the provision agreements do not necessarily have to be references structure usages based on the same structure. However, a constraint which is attached to more than one provision agreement must only express key sets and/or cube/target regions where the identifier of the components are common across all structures to which the constraint is attached.

2004

2005

**ContentConstraintAttachmentType: **ContentConstraintAttachmentType defines the structure for specifying the target object(s) of a content constraint.

Derivation:

//ConstraintAttachmentType// (restriction)

2010

[[image:inherit.gif||height="9" width="9"]] ContentConstraintAttachmentType

Content:

Element Documentation:

2017

2018

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

2019

|DataProvider|com: DataProviderReferenc eType|DataProvider is reference to a data provider to which the constraint is attached. If this is used, then only the release calendar is relevant. The referenced is provided as a URN and/or a full set of reference fields.

2020

|DataSet|com:SetReferenceType|DataSet is reference to a data set to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields.

2021

|MetadataSet|com:SetReferenceType|MetadataSet is reference to a metadata set to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields.

2022

|SimpleDataSource|xs:anyURI|SimpleDataSource describes a simple data source, which is a URL of a SDMX-ML data or metadata message.

2023

|DataStructure|com: DataStructureReferen ceType|DataStructure is reference to a data structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached.

2024

|QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.

2025

|MetadataStructure|com: MetadataStructureRef erenceType|MetadataStructure is reference to a metadata structure definition to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached.

2026

|QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.

2027

|Dataflow|com: DataflowReferenceTyp e|Dataflow is reference to a data flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one dataflow, and the dataflows do not necessarily have to be usages of the same data structure. However, a constraint which is attached to more than one data structure must only express key sets and/or cube regions where the identifiers of the dimensions are common across all structures to which the constraint is attached.

2028

|QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.

2029

|Metadataflow|com: MetadataflowReferenc eType|Metadataflow is reference to a metadata flow to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one metadataflow, and the metadataflows do not necessarily have to be usages of the same metadata structure. However, a constraint which is attached to more than one metadata structure must only express key sets and/or target regions where the identifiers of the target objects are common across all structures to which the constraint is attached.

2030

|QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.

2031

|ProvisionAgreement|com: ProvisionAgreementRe ferenceType|ProvisionAgreementReference is reference to a provision agreement to which the constraint is attached. The referenced is provided as a URN and/or a full set of reference fields. A constraint can be attached to more than one provision aggreement, and the provision agreements do not necessarily have to be references structure usages based on the same structure. However, a constraint which is attached to more than one provision agreement must only express key sets and/or cube/target regions where the identifier of the components are common across all structures to which the constraint is attached.

2032

|QueryableDataSource|com: QueryableDataSourceT ype|QueryableDataSource describes a queryable data source to which the constraint is attached.

2033

2034

**DataStructureType: **DataStructureType describes the structure of a data structure definition. A data structure definition is defined as a collection of metadata concepts, their structure and usage when used to collect or disseminate data.

Derivation:

//com:AnnotableType// (extension)

2039

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

2040

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

2041

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

2042

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

2043

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

2044

[[image:inherit.gif||height="9" width="9"]] //StructureType// (restriction)

2045

[[image:inherit.gif||height="9" width="9"]] DataStructureType

Attributes:

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

Content:

com:Annotations?, com:Name+, com:Description*, DataStructureComponents?

2054

2055

Attribute Documentation:

2056

2057

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

2058

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

2059

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

2060

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

2061

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

2062

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

2063

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

2064

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

2065

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

2066

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

2067

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

2068

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

2069

2070

Element Documentation:

2071

2072

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

2073

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

2074

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

2075

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

2076

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

2077

2078

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

2083

[[image:inherit.gif||height="9" width="9"]] //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 and a primary measure must be defined.

Derivation:

//GroupingType// (restriction)

2094

[[image:inherit.gif||height="9" width="9"]] //DataStructureComponentsBaseType// (extension)

2095

[[image:inherit.gif||height="9" width="9"]] DataStructureComponentsType

Content:

DimensionList, Group*, AttributeList?, MeasureList

2100

2101

Element Documentation:

2102

2103

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

2104

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

2105

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

2106

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

2107

|MeasureList|MeasureListType|MeasureList describes the measure descriptor for a key family. It contains a single metadata concepts that define the primary measures of a data structure.

2108

2109

//**AttributeListBaseType**//**: **AttributeListBaseType is an abstract base type used as the basis for the AttributeListType.

Derivation:

//com:AnnotableType// (extension)

2114

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

2115

[[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)

2116

[[image:inherit.gif||height="9" width="9"]] //AttributeListBaseType//

Attributes:

id?, urn?, uri?

Content:

com:Annotations?

Attribute Documentation:

2127

2128

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

2129

|id (fixed: AttributeDescriptor)|com:IDType|The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor.

2130

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

2131

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

2132

2133

Element Documentation:

2134

2135

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

2136

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

2137

2138

**AttributeListType: **AttributeListType describes the attribute descriptor for the data structure definition.

Derivation:

//com:AnnotableType// (extension)

2143

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

2144

[[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)

2145

[[image:inherit.gif||height="9" width="9"]] //AttributeListBaseType// (extension)

2146

[[image:inherit.gif||height="9" width="9"]] AttributeListType

Attributes:

id?, urn?, uri?

Content:

com:Annotations?, (Attribute | ReportingYearStartDay)+

2155

2156

Attribute Documentation:

2157

2158

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

2159

|id (fixed: AttributeDescriptor)|com:IDType|The id attribute is provided in this case for completeness. However, its value is fixed to AttributeDescriptor.

2160

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

2161

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

2162

2163

Element Documentation:

2164

2165

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

2166

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

2167

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

2168

|ReportingYearStartDa y|ReportingYearStartDa yType|ReportingYearStartDay is a specialized data attribute which provides important context to the time dimension. If the value of the time dimension is one of the standard reporting periods (see common:ReportingTimePeriodType) then this attribute is used to state the month and day that the reporting year begins. This provides a reference point from which the actual calendar dates covered by these periods can be determined. If this attribute does not occur in a data set, then the reporting year start day will be assumed to be January 1.

2169

2170

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

//com:AnnotableType// (extension)

2175

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

2176

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

2177

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)

2178

[[image:inherit.gif||height="9" width="9"]] //AttributeBaseType//

Attributes:

id?, urn?, uri?

Content:

com:Annotations?, ConceptIdentity, LocalRepresentation?

2187

2188

Attribute Documentation:

2189

2190

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

2191

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

2192

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

2193

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

2194

2195

Element Documentation:

2196

2197

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

2198

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

2199

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

2200

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

2201

2202

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

//com:AnnotableType// (extension)

2207

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

2208

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

2209

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)

2210

[[image:inherit.gif||height="9" width="9"]] //AttributeBaseType// (extension)

2211

[[image:inherit.gif||height="9" width="9"]] AttributeType

Attributes:

id?, urn?, uri?, assignmentStatus

Content:

com:Annotations?, ConceptIdentity, LocalRepresentation?, ConceptRole*, AttributeRelationship

2220

2221

Attribute Documentation:

2222

2223

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

2224

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

2225

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

2226

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

2227

|assignmentStatus|UsageStatusType|The assignmentStatus attribute indicates whether a value must be provided for the attribute when sending documentation along with the data.

2228

2229

Element Documentation:

2230

2231

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

2232

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

2233

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

2234

|LocalRepresentation|SimpleDataStructureR epresentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.

2235

|ConceptRole|com: ConceptReferenceType|ConceptRole references concepts which define roles which this attribute serves. If the concept from which the attribute takes its identity also defines a role the concept serves, then the isConceptRole indicator can be set to true on the concept identity rather than repeating the reference here.

2236

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

2237

2238

**AttributeRelationshipType: **AttributeRelationshipType defines the structure for stating the relationship between an attribute and other data structure definition components.

Content:

(None | (Dimension+, AttachmentGroup*) | Group | PrimaryMeasure)

2243

2244

Element Documentation:

2245

2246

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

2247

|None|com:EmptyType|This means that value of the attribute will not vary with any of the other key family components. This will always be treated as a data set level attribute.

2248

|Dimension|com: LocalDimensionRefere nceType|This is used to reference dimensions in the data structure definition on which the value of this attribute depends. An attribute using this relationship can be either a group, series (or section), or observation level attribute. The attachment level of the attribute will be determined by the data format and which dimensions are referenced.

2249

|AttachmentGroup|com: LocalGroupKeyDescrip torReferenceType|This is used to specify that the attribute should always be attached to the groups referenced here. Note that if one of the referenced dimensions is the time dimension, the groups referenced here will be ignored.

2250

|Group|com: LocalGroupKeyDescrip torReferenceType|This is used as a convenience to referencing all of the dimension defined by the referenced group. The attribute will also be attached to this group.

2251

|PrimaryMeasure|com: LocalPrimaryMeasureR eferenceType|This is used to specify that the value of the attribute is dependent upon the observed value. An attribute with this relationship will always be treated as an observation level attribute.

2252

2253

**ReportingYearStartDayType: **ReportingYearStartDayType defines the structure of the reporting year start day attribute. The reporting year start day attribute takes its semantic from its concept identity (usually the REPORTING_YEAR_START_DAY concept), yet is always has a fixed identifier (REPORTING_YEAR_START_DAY). The reporting year start day attribute always has a fixed text format, which specifies that the format of its value is always a day and month in the ISO 8601 format of '~-~-MM-DD'. As with any other attribute, an attribute relationship must be specified. this relationship should be carefully selected as it will determin what type of data the data structure definition will allow. For example, if an attribute relationship of none is specified, this will mean the data sets conforming to this data structure definition can only contain data with standard reporting periods where the all reporting periods have the same start day. In this case, data reported as standard reporting periods from two entities with different fiscal year start days could not be contained in the same data set.

Derivation:

//com:AnnotableType// (extension)

2258

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

2259

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

2260

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)

2261

[[image:inherit.gif||height="9" width="9"]] //AttributeBaseType// (extension)

2262

[[image:inherit.gif||height="9" width="9"]] AttributeType (restriction)

2263

[[image:inherit.gif||height="9" width="9"]] ReportingYearStartDayType

Attributes:

id?, urn?, uri?, assignmentStatus

Content:

com:Annotations?, ConceptIdentity, LocalRepresentation, AttributeRelationship

2272

2273

Attribute Documentation:

2274

2275

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

2276

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

2277

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

2278

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

2279

|assignmentStatus|UsageStatusType|The assignmentStatus attribute indicates whether a value must be provided for the attribute when sending documentation along with the data.

2280

2281

Element Documentation:

2282

2283

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

2284

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

2285

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

2286

|LocalRepresentation|ReportingYearStartDa yRepresentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.

2287

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

2288

2289

**ReportingYearStartDayRepresentationType: **ReportingYearStartDayRepresentationType defines the representation for the reporting year start day attribute. Enumerated values are not allowed and the text format is fixed to be a day and month in the ISO 8601 format of '~-~-MM-DD'.

Derivation:

//RepresentationType// (restriction)

2294

[[image:inherit.gif||height="9" width="9"]] //DataStructureRepresentationType// (restriction)

2295

[[image:inherit.gif||height="9" width="9"]] SimpleDataStructureRepresentationType (restriction)

2296

[[image:inherit.gif||height="9" width="9"]] ReportingYearStartDayRepresentationType

Content:

TextFormat

Element Documentation:

2303

2304

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

2305

|TextFormat|ReportingYearStartDa yTextFormatType|TextFormat describes an uncoded textual format.

2306

2307

**ReportingYearStartDayTextFormatType: **ReportingYearStartDayTextFormatType is a restricted version of the NonFacetedTextFormatType that fixes the value of the text type to be DayMonth. This type exists solely for the purpose of fixing the representation of the reporting year start day attribute.

Derivation:

TextFormatType (restriction)

2312

[[image:inherit.gif||height="9" width="9"]] BasicComponentTextFormatType (restriction)

2313

[[image:inherit.gif||height="9" width="9"]] SimpleComponentTextFormatType (restriction)

2314

[[image:inherit.gif||height="9" width="9"]] NonFacetedTextFormatType (restriction)

2315

[[image:inherit.gif||height="9" width="9"]] ReportingYearStartDayTextFormatType

Attributes:

textType?

Content:

{Empty}

Attribute Documentation:

2326

2327

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

2328

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

2329

2330

//**DimensionListBaseType**//**: **DimensionListBaseType is an abstract base type used as the basis for the DimensionListType.

Derivation:

//com:AnnotableType// (extension)

2335

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

2336

[[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)

2337

[[image:inherit.gif||height="9" width="9"]] //DimensionListBaseType//

Attributes:

id?, urn?, uri?

Content:

com:Annotations?

Attribute Documentation:

2348

2349

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

2350

|id (fixed: DimensionDescriptor)|com:IDType|The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor.

2351

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

2352

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

2353

2354

Element Documentation:

2355

2356

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

2357

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

2358

2359

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

//com:AnnotableType// (extension)

2364

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

2365

[[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)

2366

[[image:inherit.gif||height="9" width="9"]] //DimensionListBaseType// (extension)

2367

[[image:inherit.gif||height="9" width="9"]] DimensionListType

Attributes:

id?, urn?, uri?

Content:

com:Annotations?, (Dimension | MeasureDimension | TimeDimension)+

2376

2377

Attribute Documentation:

2378

2379

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

2380

|id (fixed: DimensionDescriptor)|com:IDType|The id attribute is provided in this case for completeness. However, its value is fixed to DimensionDescriptor.

2381

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

2382

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

2383

2384

Element Documentation:

2385

2386

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

2387

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

2388

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

2389

|MeasureDimension|MeasureDimensionType|MeasureDimension is a special type of dimension which defines multiple measures in a key family. This is represented as any other dimension in a unless it is the observation dimension. It takes it representation from a concept scheme, and this scheme defines the measures and their representations. When data is formatted with this as the observation dimension, these measures can be made explicit or the value of the dimension can be treated as any other dimension. If the measures are explicit, the representation of the observation will be specific to the core representation for each concept in the representation concept scheme. Note that it is necessary that these representations are compliant (the same or derived from) with that of the primary measure.

2390

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

2391

2392

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

//com:AnnotableType// (extension)

2397

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

2398

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

2399

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)

2400

[[image:inherit.gif||height="9" width="9"]] //BaseDimensionBaseType//

Attributes:

id?, urn?, uri?

Content:

com:Annotations?, ConceptIdentity, LocalRepresentation?

2409

2410

Attribute Documentation:

2411

2412

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

2413

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

2414

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

2415

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

2416

2417

Element Documentation:

2418

2419

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

2420

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

2421

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

2422

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

2423

2424

//**BaseDimensionType**//**: **BaseDimensionType is an abstract base type which defines the basic structure of all dimensions.

Derivation:

//com:AnnotableType// (extension)

2429

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

2430

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

2431

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)

2432

[[image:inherit.gif||height="9" width="9"]] //BaseDimensionBaseType// (extension)

2433

[[image:inherit.gif||height="9" width="9"]] //BaseDimensionType//

Attributes:

id?, urn?, uri?, position?, type?

Content:

com:Annotations?, ConceptIdentity, LocalRepresentation?, ConceptRole*

2442

2443

Attribute Documentation:

2444

2445

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

2446

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

2447

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

2448

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

2449

|position|xs:int|The position attribute specifies the position of the dimension in the data structure definition. It is optional an the position of the dimension in the key descriptor (DimensionList element) always takes precedence over the value supplied here. This is strictly for informational purposes only.

2450

|type|com: DimensionTypeType|The type attribute identifies whether then dimension is a measure dimension, the time dimension, or a regular dimension. Although these are all apparent by the element names, this attribute allows for each dimension to be processed independent of its element as well as maintaining the restriction of only one measure and time dimension while still allowing dimension to occur in any order.

2451

2452

Element Documentation:

2453

2454

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

2455

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

2456

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

2457

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

2458

|ConceptRole|com: ConceptReferenceType|ConceptRole references concepts which define roles which this dimension serves. If the concept from which the attribute takes its identity also defines a role the concept serves, then the isConceptRole indicator can be set to true on the concept identity rather than repeating the reference here.

2459

2460

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

//com:AnnotableType// (extension)

2465

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

2466

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

2467

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)

2468

[[image:inherit.gif||height="9" width="9"]] //BaseDimensionBaseType// (extension)

2469

[[image:inherit.gif||height="9" width="9"]] //BaseDimensionType// (restriction)

2470

[[image:inherit.gif||height="9" width="9"]] DimensionType

Attributes:

id?, urn?, uri?, position?, type?

Content:

com:Annotations?, ConceptIdentity, LocalRepresentation?, ConceptRole*

2479

2480

Attribute Documentation:

2481

2482

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

2483

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

2484

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

2485

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

2486

|position|xs:int|The position attribute specifies the position of the dimension in the data structure definition. It is optional an the position of the dimension in the key descriptor (DimensionList element) always takes precedence over the value supplied here. This is strictly for informational purposes only.

2487

|type (fixed: Dimension)|com: DimensionTypeType|The type attribute identifies whether then dimension is a measure dimension, the time dimension, or a regular dimension. Although these are all apparent by the element names, this attribute allows for each dimension to be processed independent of its element as well as maintaining the restriction of only one measure and time dimension while still allowing dimension to occur in any order.

2488

2489

Element Documentation:

2490

2491

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

2492

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

2493

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

2494

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

2495

|ConceptRole|com: ConceptReferenceType|ConceptRole references concepts which define roles which this dimension serves. If the concept from which the attribute takes its identity also defines a role the concept serves, then the isConceptRole indicator can be set to true on the concept identity rather than repeating the reference here.

2496

2497

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

//com:AnnotableType// (extension)

2502

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

2503

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

2504

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)

2505

[[image:inherit.gif||height="9" width="9"]] //BaseDimensionBaseType// (extension)

2506

[[image:inherit.gif||height="9" width="9"]] //BaseDimensionType// (restriction)

2507

[[image:inherit.gif||height="9" width="9"]] TimeDimensionType

Attributes:

id?, urn?, uri?, position?, type?

Content:

com:Annotations?, ConceptIdentity, LocalRepresentation

2516

2517

Attribute Documentation:

2518

2519

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

2520

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

2521

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

2522

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

2523

|position|xs:int|The position attribute specifies the position of the dimension in the data structure definition. It is optional an the position of the dimension in the key descriptor (DimensionList element) always takes precedence over the value supplied here. This is strictly for informational purposes only.

2524

|type (fixed: TimeDimension)|com: DimensionTypeType|The type attribute identifies whether then dimension is a measure dimension, the time dimension, or a regular dimension. Although these are all apparent by the element names, this attribute allows for each dimension to be processed independent of its element as well as maintaining the restriction of only one measure and time dimension while still allowing dimension to occur in any order.

2525

2526

Element Documentation:

2527

2528

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

2529

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

2530

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

2531

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

2532

2533

**MeasureDimensionType: **MeasureDimensionType defines the structure of the measure dimension. It is derived from the base dimension structure, but requires that a coded representation taken from a concept scheme is given.

Derivation:

//com:AnnotableType// (extension)

2538

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

2539

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

2540

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)

2541

[[image:inherit.gif||height="9" width="9"]] //BaseDimensionBaseType// (extension)

2542

[[image:inherit.gif||height="9" width="9"]] //BaseDimensionType// (restriction)

2543

[[image:inherit.gif||height="9" width="9"]] MeasureDimensionType

Attributes:

id?, urn?, uri?, position?, type?

Content:

com:Annotations?, ConceptIdentity, LocalRepresentation, ConceptRole*

2552

2553

Attribute Documentation:

2554

2555

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

2556

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

2557

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

2558

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

2559

|position|xs:int|The position attribute specifies the position of the dimension in the data structure definition. It is optional an the position of the dimension in the key descriptor (DimensionList element) always takes precedence over the value supplied here. This is strictly for informational purposes only.

2560

|type (fixed: MeasureDimension)|com: DimensionTypeType|The type attribute identifies whether then dimension is a measure dimension, the time dimension, or a regular dimension. Although these are all apparent by the element names, this attribute allows for each dimension to be processed independent of its element as well as maintaining the restriction of only one measure and time dimension while still allowing dimension to occur in any order.

2561

2562

Element Documentation:

2563

2564

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

2565

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

2566

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

2567

|LocalRepresentation|MeasureDimensionRepr esentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.

2568

|ConceptRole|com: ConceptReferenceType|ConceptRole references concepts which define roles which this dimension serves. If the concept from which the attribute takes its identity also defines a role the concept serves, then the isConceptRole indicator can be set to true on the concept identity rather than repeating the reference here.

2569

2570

//**GroupBaseType**//**: **GroupBaseType is an abstract base type that forms the basis for the GroupType.

Derivation:

//com:AnnotableType// (extension)

2575

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

2576

[[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)

2577

[[image:inherit.gif||height="9" width="9"]] //GroupBaseType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?

Attribute Documentation:

2588

2589

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

2590

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

2591

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

2592

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

2593

2594

Element Documentation:

2595

2596

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

2597

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

2598

2599

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

//com:AnnotableType// (extension)

2604

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

2605

[[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)

2606

[[image:inherit.gif||height="9" width="9"]] //GroupBaseType// (extension)

2607

[[image:inherit.gif||height="9" width="9"]] GroupType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, (GroupDimension+ | AttachmentConstraint)

2616

2617

Attribute Documentation:

2618

2619

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

2620

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

2621

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

2622

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

2623

2624

Element Documentation:

2625

2626

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

2627

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

2628

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

2629

|AttachmentConstraint|com: AttachmentConstraint ReferenceType|AttachmentConstraint references an attachment constraint that defines the key sets and/or cube regions that attributes may be attached to. This is an alternative to referencing the dimensions, and allows attributes to be attached to data for given values of dimensions.

2630

2631

//**GroupDimensionBaseType**//**: **GroupDimensionBaseType is an abstract base type which refines the base ComponentType in order to form the basis for the GroupDimensionType.

Derivation:

//com:AnnotableType// (extension)

2636

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

2637

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

2638

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)

2639

[[image:inherit.gif||height="9" width="9"]] //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:

//com:AnnotableType// (extension)

2650

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

2651

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

2652

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)

2653

[[image:inherit.gif||height="9" width="9"]] //GroupDimensionBaseType// (extension)

2654

[[image:inherit.gif||height="9" width="9"]] GroupDimensionType

Content:

DimensionReference

Element Documentation:

2661

2662

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

2663

|DimensionReference|com: LocalDimensionRefere nceType|DimensionReference provides a reference to a dimension defined in the key descriptor of the data structure definition in which this group key descriptor is defined.

2664

2665

**MeasureListType: **MeasureListType describes the structure of the measure descriptor for a data structure definition. Only a primary may be defined.

Derivation:

//com:AnnotableType// (extension)

2670

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

2671

[[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)

2672

[[image:inherit.gif||height="9" width="9"]] MeasureListType

Attributes:

id?, urn?, uri?

Content:

com:Annotations?, PrimaryMeasure

2681

2682

Attribute Documentation:

2683

2684

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

2685

|id (fixed: MeasureDescriptor)|com:IDType|The id is the identifier for the object.

2686

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

2687

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

2688

2689

Element Documentation:

2690

2691

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

2692

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

2693

|PrimaryMeasure|PrimaryMeasureType|PrimaryMeasure defines the structure of the primary measure, which is the concept that is the value of the phenomenon to be measured in a data set. Although this may take its semantic from any concept, this is provided a fixed identifier (OBS_VALUE) so that it may be easily distinguished in data messages.

2694

2695

**PrimaryMeasureType: **PrimaryMeasureType describes the structure of the primary measure. It describes the observation values for all presentations of the data. The primary measure takes its semantic, and in some cases it representation, from its concept identity (conventionally the OBS_VALUE concept). The primary measure can be coded by referencing a code list from its coded local representation. It can also specify its text format, which is used as the representation of the primary measure if a coded representation is not defined. Neither the coded or uncoded representation are necessary, since the primary measure may take these from the referenced concept. Note that if the data structure declares a measure dimension, the representation of this must be a superset of all possible measure concept representations.

Derivation:

//com:AnnotableType// (extension)

2700

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

2701

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

2702

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)

2703

[[image:inherit.gif||height="9" width="9"]] PrimaryMeasureType

Attributes:

id?, urn?, uri?

Content:

com:Annotations?, ConceptIdentity, LocalRepresentation?

2712

2713

Attribute Documentation:

2714

2715

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

2716

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

2717

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

2718

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

2719

2720

Element Documentation:

2721

2722

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

2723

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

2724

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

2725

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

2726

2727

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

2732

[[image:inherit.gif||height="9" width="9"]] //DataStructureRepresentationType//

Content:

(TextFormat | (Enumeration, EnumerationFormat?))

2737

2738

Element Documentation:

2739

2740

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

2741

|TextFormat|SimpleComponentTextF ormatType|TextFormat describes an uncoded textual format.

2742

|Enumeration|//com: ItemSchemeReferenceB aseType//|Enumeration references an item scheme that enumerates the allowable values for this representation.

2743

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

2744

2745

**SimpleDataStructureRepresentationType: **SimpleDataStructureRepresentationType defines the representation for any non-measure and non-time dimension data structure definition component.

Derivation:

//RepresentationType// (restriction)

2750

[[image:inherit.gif||height="9" width="9"]] //DataStructureRepresentationType// (restriction)

2751

[[image:inherit.gif||height="9" width="9"]] SimpleDataStructureRepresentationType

Content:

(TextFormat | (Enumeration, EnumerationFormat?))

2756

2757

Element Documentation:

2758

2759

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

2760

|TextFormat|SimpleComponentTextF ormatType|TextFormat describes an uncoded textual format.

2761

|Enumeration|com: CodelistReferenceTyp e|Enumeration references an item scheme that enumerates the allowable values for this representation.

2762

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

2763

2764

**MeasureDimensionRepresentationType: **BaseDimensionRepresentationType is an abstract base which defines the representation for a measure dimension.

Derivation:

//RepresentationType// (restriction)

2769

[[image:inherit.gif||height="9" width="9"]] //DataStructureRepresentationType// (restriction)

2770

[[image:inherit.gif||height="9" width="9"]] MeasureDimensionRepresentationType

Content:

Enumeration

Element Documentation:

2777

2778

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

2779

|Enumeration|com: ConceptSchemeReferen ceType|Enumeration references an item scheme that enumerates the allowable values for this representation.

2780

2781

**TimeDimensionRepresentationType: **TimeDimensionRepresentationType defines the representation for the time dimension. Enumerated values are not allowed.

Derivation:

//RepresentationType// (restriction)

2786

[[image:inherit.gif||height="9" width="9"]] //DataStructureRepresentationType// (restriction)

2787

[[image:inherit.gif||height="9" width="9"]] SimpleDataStructureRepresentationType (restriction)

2788

[[image:inherit.gif||height="9" width="9"]] TimeDimensionRepresentationType

Content:

TextFormat

Element Documentation:

2795

2796

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

2797

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

2798

2799

**DataflowType: **DataflowType describes the structure of a data flow. A data flow is defined as the structure of data that will provided for different reference periods. If this type is not referenced externally, then a reference to a key family definition must be provided.

Derivation:

//com:AnnotableType// (extension)

2804

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

2805

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

2806

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

2807

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

2808

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

2809

[[image:inherit.gif||height="9" width="9"]] //StructureUsageType// (restriction)

2810

[[image:inherit.gif||height="9" width="9"]] DataflowType

Attributes:

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

Content:

com:Annotations?, com:Name+, com:Description*, Structure?

2819

2820

Attribute Documentation:

2821

2822

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

2823

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

2824

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

2825

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

2826

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

2827

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

2828

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

2829

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

2830

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

2831

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

2832

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

2833

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

2834

2835

Element Documentation:

2836

2837

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

2838

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

2839

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

2840

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

2841

|Structure|com: DataStructureReferen ceType|Structure provides a reference to the data structure definition which defines the structure of all data for this flow.

2842

2843

//**HierarchicalCodelistBaseType**//**: **HierarchicalCodelistBaseType is an abstract base class that is the basis for the HierarchicalCodelistType. It requires that a name be supplied.

Derivation:

//com:AnnotableType// (extension)

2848

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

2849

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

2850

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

2851

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

2852

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)

2853

[[image:inherit.gif||height="9" width="9"]] //HierarchicalCodelistBaseType//

Attributes:

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

Content:

com:Annotations?, com:Name+, com:Description*

2862

2863

Attribute Documentation:

2864

2865

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

2866

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

2867

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

2868

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

2869

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

2870

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

2871

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

2872

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

2873

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

2874

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

2875

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

2876

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

2877

2878

Element Documentation:

2879

2880

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

2881

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

2882

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

2883

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

2884

2885

**HierarchicalCodelistType: **HierarchicalCodelistType describes the structure of a hierarchical codelist. A hierarchical code list is defined as an organised collection of codes that may participate in many parent/child relationships with other codes in the list, as defined by one or more hierarchy of the list.

Derivation:

//com:AnnotableType// (extension)

2890

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

2891

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

2892

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

2893

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

2894

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)

2895

[[image:inherit.gif||height="9" width="9"]] //HierarchicalCodelistBaseType// (extension)

2896

[[image:inherit.gif||height="9" width="9"]] HierarchicalCodelistType

Attributes:

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

Content:

com:Annotations?, com:Name+, com:Description*, IncludedCodelist*, Hierarchy*

2905

2906

Attribute Documentation:

2907

2908

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

2909

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

2910

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

2911

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

2912

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

2913

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

2914

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

2915

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

2916

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

2917

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

2918

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

2919

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

2920

2921

Element Documentation:

2922

2923

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

2924

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

2925

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

2926

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

2927

|IncludedCodelist|IncludedCodelistRefe renceType|IndludedCodelist provides a collection of references to the code lists whose codes are arranged in this hierarchical code list.

2928

|Hierarchy|HierarchyType|Hierarchy describes a classification structure arranged in levels of detail from the broadest to the most detailed level. These levels can be formal or informal, and are not necessary to describe. If the hierarchy does contain levels, then each hierarchical code is assumed to exist in the level where the depths of nesting match.

2929

2930

//**HierarchyBaseType**//**: **HierarchyBaseType is an abstract base type that serves as the basis for the HierarchyType. It requires a name and id be provided.

Derivation:

//com:AnnotableType// (extension)

2935

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

2936

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

2937

[[image:inherit.gif||height="9" width="9"]] //HierarchyBaseType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*

2946

2947

Attribute Documentation:

2948

2949

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

2950

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

2951

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

2952

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

2953

2954

Element Documentation:

2955

2956

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

2957

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

2958

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

2959

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

2960

2961

**HierarchyType: **The Hierarchy is an abstract type that provides for a classification structure of referenced codes arranged in levels of detail from the broadest to the most detailed level. The levels in which the code exist can be formal or informal.

Derivation:

//com:AnnotableType// (extension)

2966

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

2967

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

2968

[[image:inherit.gif||height="9" width="9"]] //HierarchyBaseType// (extension)

2969

[[image:inherit.gif||height="9" width="9"]] HierarchyType

Attributes:

id, urn?, uri?, leveled?

Content:

com:Annotations?, com:Name+, com:Description*, HierarchicalCode+, Level?

2978

2979

Attribute Documentation:

2980

2981

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

2982

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

2983

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

2984

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

2985

|leveled (default: false)|xs:boolean|The leveled attribute indicates that the hierarchy has formal levels. In this case, every code should have a level associated with it.

2986

2987

Element Documentation:

2988

2989

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

2990

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

2991

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

2992

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

2993

|HierarchicalCode|HierarchicalCodeType|HierarchicalCode is used to assemble the codes from the codelist(s) referenced into a hierarchy.

2994

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

2995

2996

//**HierarchicalCodeBaseType**//**: **HierarchicalCodeBaseType is an abstract base type the creates the basis for the HierarchicalCodeType. It removes the urn and uri.

Derivation:

//com:AnnotableType// (extension)

3001

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

3002

[[image:inherit.gif||height="9" width="9"]] //HierarchicalCodeBaseType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?

Attribute Documentation:

3013

3014

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

3015

|id|com:IDType|The id attribute allows for an id to be assigned to the use of the particular code at that specific point in the hierarchy. This value is unique within the hierarchy being created, and is used to map the hierarchy against external structures.

3016

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

3017

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

3018

3019

Element Documentation:

3020

3021

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

3022

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

3023

3024

**HierarchicalCodeType: **HierarchicalCodeType describes the structure of a hierarchical code. A hierarchical code provides for a reference to a code that is referenced within the hierarchical code list via either a complete reference to a code through either a URN or full set of reference fields, or a local reference which utilizes the included codelist reference alias and the identification of a code from the list. Codes are arranged in a hierarchy by this reference. Note that it is possible to reference a single code such that it has multiple parents within the hierarchy. Further, the hierarchy may or may not be a leveled one.

Derivation:

//com:AnnotableType// (extension)

3029

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

3030

[[image:inherit.gif||height="9" width="9"]] //HierarchicalCodeBaseType// (extension)

3031

[[image:inherit.gif||height="9" width="9"]] HierarchicalCodeType

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?

Content:

com:Annotations?, (Code | (CodelistAliasRef, CodeID)), HierarchicalCode*, Level?

3040

3041

Attribute Documentation:

3042

3043

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

3044

|id|com:IDType|The id attribute allows for an id to be assigned to the use of the particular code at that specific point in the hierarchy. This value is unique within the hierarchy being created, and is used to map the hierarchy against external structures.

3045

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

3046

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

3047

|version|com:VersionType|The version attriubte contains a version number for the hierarchical code. A hierarchical code is not formally versionable, therefore each code must have a unique identifier. The version supplied here is for informational purposes only and is not used to uniquely identity the code.

3048

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

3049

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

3050

3051

Element Documentation:

3052

3053

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

3054

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

3055

|Code|com: CodeReferenceType|Code provides a complete, explicit reference to a code through either its URN, or a complete reference to the codelist and code.

3056

|CodelistAliasRef|com:IDType|CodelistAliasRef references an alias assigned in a IncludedCodelistReference element in the containing hierarchical codelist. This is used in conjunction with the CodeID element to reference a code from one of the included codelists.

3057

|CodeID|com: LocalCodeReferenceTy pe|CodeID references the id of a code from the codelist that is referenced through the CodelistAliaRef element.

3058

|HierarchicalCode|HierarchicalCodeType|HierarchicalCode is used to nest referenced codes into a value based hierarchy.

3059

|Level|com: LocalLevelReferenceT ype|Level references a formal level defined within the hierarchy which defines this hierarchical code. This is only necessary if the nesting depth of the hierarchical code does not correspond to the nesting depth of the level to which it belongs (i.e. the hieararchical code is to skip down a level). Otherwise, the code is assumed to exist at the level in which the nesting depth of the level matches the nesting depth of the code.

3060

3061

//**LevelBaseType**//**: **LevelBaseType is an abstract base type that makes up the basis for the LevelType. It requires a name and id.

Derivation:

//com:AnnotableType// (extension)

3066

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

3067

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

3068

[[image:inherit.gif||height="9" width="9"]] //LevelBaseType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*

3077

3078

Attribute Documentation:

3079

3080

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

3081

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

3082

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

3083

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

3084

3085

Element Documentation:

3086

3087

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

3088

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

3089

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

3090

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

3091

3092

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

//com:AnnotableType// (extension)

3097

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

3098

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

3099

[[image:inherit.gif||height="9" width="9"]] //LevelBaseType// (extension)

3100

[[image:inherit.gif||height="9" width="9"]] LevelType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, CodingFormat?, Level?

3109

3110

Attribute Documentation:

3111

3112

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

3113

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

3114

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

3115

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

3116

3117

Element Documentation:

3118

3119

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

3120

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

3121

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

3122

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

3123

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

3124

|Level|LevelType|Level describes the next level down in the hierarchy.

3125

3126

**IncludedCodelistReferenceType: **IncludedCodelistReferenceType provides the structure for a referencing a codelist and optionally providing a local alias identification for this reference.

Derivation:

//com:ReferenceType// (restriction)

3131

[[image:inherit.gif||height="9" width="9"]] //com:MaintainableReferenceBaseType// (restriction)

3132

[[image:inherit.gif||height="9" width="9"]] //com:ItemSchemeReferenceBaseType// (restriction)

3133

[[image:inherit.gif||height="9" width="9"]] com:CodelistReferenceType (extension)

3134

[[image:inherit.gif||height="9" width="9"]] IncludedCodelistReferenceType

Attributes:

alias?

Content:

( (Ref, URN?) | URN)

Attribute Documentation:

3145

3146

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

3147

|alias|com:IDType|The alias attribute is used to carry the identifier for the referenced codelist, so that codes from that list can be easily referenced by the hierarchical codes contained in the parent hierarchy, without having to repeat the reference to the codelist itself. The alias attribute must be unique within the parent hierarchical codelist.

3148

3149

Element Documentation:

3150

3151

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

3152

|Ref|com:CodelistRefType|Ref is used to provide a complete set of reference fields. Derived reference types will restrict the RefType so that the content of the Ref element requires exactly what is needed for a complete reference.

3153

|URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.

3154

|URN|xs:anyURI|URN is used to hold the URN of the referenced object. This must be the same URN that would be constructed from the individual fields in the Ref element.

3155

3156

**CodingTextFormatType:**

Derivation:

TextFormatType (restriction)

3161

[[image:inherit.gif||height="9" width="9"]] BasicComponentTextFormatType (restriction)

3162

[[image:inherit.gif||height="9" width="9"]] SimpleComponentTextFormatType (restriction)

3163

[[image:inherit.gif||height="9" width="9"]] CodingTextFormatType

Attributes:

textType?, isSequence?, interval?, startValue?, endValue?, minLength?, maxLength?, minValue?, maxValue?, pattern?

Content:

{Empty}

Attribute Documentation:

3174

3175

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

3176

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

3177

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

3178

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

3179

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

3180

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

3181

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

3182

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

3183

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

3184

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

3185

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

3186

3187

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

//com:AnnotableType// (extension)

3192

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

3193

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

3194

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

3195

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

3196

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

3197

[[image:inherit.gif||height="9" width="9"]] //StructureUsageType// (restriction)

3198

[[image:inherit.gif||height="9" width="9"]] MetadataflowType

Attributes:

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

Content:

com:Annotations?, com:Name+, com:Description*, Structure?

3207

3208

Attribute Documentation:

3209

3210

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

3211

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

3212

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

3213

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

3214

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

3215

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

3216

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

3217

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

3218

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

3219

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

3220

|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.

3221

|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.

3222

3223

Element Documentation:

3224

3225

|**Name**|**Type**|**Documentation**

3226

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

3227

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

3228

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

3229

|Structure|com: MetadataStructureRef erenceType|Structure provides a reference to the metadata structure definition describing the structure of all reference metadata for this flow.

3230

3231

**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:

//com:AnnotableType// (extension)

3236

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

3237

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

3238

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

3239

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

3240

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

3241

[[image:inherit.gif||height="9" width="9"]] //StructureType// (restriction)

3242

[[image:inherit.gif||height="9" width="9"]] MetadataStructureType

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?

Content:

com:Annotations?, com:Name+, com:Description*, MetadataStructureComponents?

3251

3252

Attribute Documentation:

3253

3254

|**Name**|**Type**|**Documentation**

3255

|id|com:IDType|The id is the identifier for the object.

3256

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

3257

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

3258

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

3259

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

3260

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

3261

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

3262

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

3263

|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.

3264

|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.

3265

|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.

3266

3267

Element Documentation:

3268

3269

|**Name**|**Type**|**Documentation**

3270

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

3271

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

3272

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

3273

|MetadataStructureCom ponents|MetadataStructureCom ponentsType|MetadataStructureComponents defines the grouping of the sets of the components that make up the metadata structure definition. All components and component list (target identifiers, identifier components, report structures, and metadata attributes) in the structure definition must have a unique identification.

3274

3275

**MetadataStructureComponentsBaseType: **MetadataStructureComponentsBaseType is an abstract base type that forms the basis for the MetadataStructureComponentsType.

Derivation:

//GroupingType// (restriction)

3280

[[image:inherit.gif||height="9" width="9"]] MetadataStructureComponentsBaseType

Content:

{Empty}

**MetadataStructureComponentsType: **MetadataStructureComponentsType describes the structure of the grouping of the sets of the components that make up the metadata structure definition. At a minimum, a full target identifier and at least one report structure must be defined.

Derivation:

//GroupingType// (restriction)

3291

[[image:inherit.gif||height="9" width="9"]] MetadataStructureComponentsBaseType (extension)

3292

[[image:inherit.gif||height="9" width="9"]] MetadataStructureComponentsType

Content:

MetadataTarget+, ReportStructure+

3297

3298

Element Documentation:

3299

3300

|**Name**|**Type**|**Documentation**

3301

|MetadataTarget|MetadataTargetType|MetadataTarget is a collection of target objects which when taken together describe a structure which defines the key of an object type to which metadata may be attached and serve to disambiguate reference metadata set reports.

3302

|ReportStructure|ReportStructureType|ReportStructure defines a report structure, which comprises a set of metadata attributes that can be defined as a hierarchy, for reporting reference metadata about a target object. The identification of metadata attributes must be unique at any given level of the report structure. Although there are XML schema constraints to help enforce this, these only apply to explicitly assigned identifiers. Identifiers inherited from a concept from which a metadata attribute takes its identity cannot be validated against this constraint. Therefore, systems processing metadata structure definitions will have to perform this check outside of the XML validation.

3303

3304

//**MetadataTargetBaseType**//**: **MetadataTargetBaseType is an abstract base type which forms the basis for the MetadataTargetType.

Derivation:

//com:AnnotableType// (extension)

3309

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

3310

[[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)

3311

[[image:inherit.gif||height="9" width="9"]] //MetadataTargetBaseType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?

Attribute Documentation:

3322

3323

|**Name**|**Type**|**Documentation**

3324

|id|com:IDType|The id is the identifier for the object.

3325

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

3326

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

3327

3328

Element Documentation:

3329

3330

|**Name**|**Type**|**Documentation**

3331

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

3332

3333

**MetadataTargetType:**

Derivation:

//com:AnnotableType// (extension)

3338

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

3339

[[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)

3340

[[image:inherit.gif||height="9" width="9"]] //MetadataTargetBaseType// (extension)

3341

[[image:inherit.gif||height="9" width="9"]] MetadataTargetType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, (KeyDescriptorValuesTarget | DataSetTarget | ConstraintContentTarget | ReportPeriodTarget | IdentifiableObjectTarget)+

3350

3351

Attribute Documentation:

3352

3353

|**Name**|**Type**|**Documentation**

3354

|id|com:IDType|The id is the identifier for the object.

3355

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

3356

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

3357

3358

Element Documentation:

3359

3360

|**Name**|**Type**|**Documentation**

3361

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

3362

|KeyDescriptorValuesT arget|KeyDescriptorValuesT argetType|KeyDescriptorValuesTarget is target object which references a data key for the purpose of attach reference metadata to portions of data. A data key is a set of dimension references and values for those dimension. This component on its own is not of much use, as the data key only has local references to the dimensions. Therefore it is typical that this is used in combination with some sort of reference to the data (either a data set reference or a reference to the underlying structure, structure usage, or provision agreement of the data.

3363

|DataSetTarget|DataSetTargetType|DataSetTarget is target object which references a data set for the purpose of attaching reference metadata data. A data set reference is a full reference to a data provider and an identifier for the data set.

3364

|ConstraintContentTar get|ConstraintContentTar getType|ConstraintContentTarget is target object which references an attachment constraint for the purpose of attaching reference metadata data to data key sets or cube regions defined by the constraint.

3365

|ReportPeriodTarget|ReportPeriodTargetTy pe|ReportPeriodTarget is target object which specifies a reporting period to which a metadata report applies.

3366

|IdentifiableObjectTa rget|IdentifiableObjectTa rgetType|IdentifiableObjectTarget is target object which references an Identifiable object as defined in the SDMX Information Model. The reference must be complete (i.e. a URN or a complete set of reference fields). For an item object, it is possible to define a local representation of an item scheme from which the item must be referenced.

3367

3368

//**TargetObject**//**: **TargetObject is an abstract base type from which all target objects of a metadata target are derived. It is based on a component. Implementations of this will refined the local representation so that the allowed values accurately reflect the representation of the target object reference.

Derivation:

//com:AnnotableType// (extension)

3373

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

3374

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

3375

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (extension)

3376

[[image:inherit.gif||height="9" width="9"]] //TargetObject//

Attributes:

id?, urn?, uri?

Content:

com:Annotations?, ConceptIdentity?, LocalRepresentation?

3385

3386

Attribute Documentation:

3387

3388

|**Name**|**Type**|**Documentation**

3389

|id|com:NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).

3390

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

3391

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

3392

3393

Element Documentation:

3394

3395

|**Name**|**Type**|**Documentation**

3396

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

3397

|ConceptIdentity|com: ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.

3398

|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.

3399

3400

**KeyDescriptorValuesTargetType: **KeyDescriptorValuesTargetType defines the structure of a key descriptor values target object. The key descriptor values target object has a fixed representation and identifier.

Derivation:

//com:AnnotableType// (extension)

3405

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

3406

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

3407

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (extension)

3408

[[image:inherit.gif||height="9" width="9"]] //TargetObject// (restriction)

3409

[[image:inherit.gif||height="9" width="9"]] KeyDescriptorValuesTargetType

Attributes:

id?, urn?, uri?

Content:

com:Annotations?, LocalRepresentation

3418

3419

Attribute Documentation:

3420

3421

|**Name**|**Type**|**Documentation**

3422

|id (fixed: DIMENSION_DESCRIPTOR_VALUES_TARGET)|com:NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).

3423

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

3424

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

3425

3426

Element Documentation:

3427

3428

|**Name**|**Type**|**Documentation**

3429

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

3430

|LocalRepresentation|KeyDescriptorValuesR epresentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.

3431

3432

**DataSetTargetType: **DataSetTargetType defines the structure of a data set target object. The data set target object has a fixed representation and identifier.

Derivation:

//com:AnnotableType// (extension)

3437

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

3438

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

3439

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (extension)

3440

[[image:inherit.gif||height="9" width="9"]] //TargetObject// (restriction)

3441

[[image:inherit.gif||height="9" width="9"]] DataSetTargetType

Attributes:

id?, urn?, uri?

Content:

com:Annotations?, LocalRepresentation

3450

3451

Attribute Documentation:

3452

3453

|**Name**|**Type**|**Documentation**

3454

|id (fixed: DATA_SET_TARGET)|com:NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).

3455

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

3456

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

3457

3458

Element Documentation:

3459

3460

|**Name**|**Type**|**Documentation**

3461

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

3462

|LocalRepresentation|DataSetRepresentatio nType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.

3463

3464

**ConstraintContentTargetType: **ConstraintTargetType defines the structure of a constraint target object. The constraint target object has a fixed representation and identifier.

Derivation:

//com:AnnotableType// (extension)

3469

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

3470

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

3471

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (extension)

3472

[[image:inherit.gif||height="9" width="9"]] //TargetObject// (restriction)

3473

[[image:inherit.gif||height="9" width="9"]] ConstraintContentTargetType

Attributes:

id?, urn?, uri?

Content:

com:Annotations?, LocalRepresentation

3482

3483

Attribute Documentation:

3484

3485

|**Name**|**Type**|**Documentation**

3486

|id (fixed: CONSTRAINT_CONTENT_TARGET)|com:NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).

3487

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

3488

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

3489

3490

Element Documentation:

3491

3492

|**Name**|**Type**|**Documentation**

3493

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

3494

|LocalRepresentation|ConstraintRepresenta tionType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.

3495

3496

**ReportPeriodTargetType: **ReportPeriodTargetType defines the structure of a report period target object. The report period target object has a fixed representation and identifier.

Derivation:

//com:AnnotableType// (extension)

3501

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

3502

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

3503

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (extension)

3504

[[image:inherit.gif||height="9" width="9"]] //TargetObject// (restriction)

3505

[[image:inherit.gif||height="9" width="9"]] ReportPeriodTargetType

Attributes:

id?, urn?, uri?

Content:

com:Annotations?, LocalRepresentation

3514

3515

Attribute Documentation:

3516

3517

|**Name**|**Type**|**Documentation**

3518

|id (fixed: REPORT_PERIOD_TARGET)|com:NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).

3519

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

3520

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

3521

3522

Element Documentation:

3523

3524

|**Name**|**Type**|**Documentation**

3525

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

3526

|LocalRepresentation|ReportPeriodRepresen tationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.

3527

3528

//**IdentifiableObjectTargetBaseType**//**: **IdentifiableObjectTargetBaseType is an abstract base type which forms the basis for the IdentifiableObjectTargetType.

Derivation:

//com:AnnotableType// (extension)

3533

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

3534

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

3535

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (extension)

3536

[[image:inherit.gif||height="9" width="9"]] //TargetObject// (restriction)

3537

[[image:inherit.gif||height="9" width="9"]] //IdentifiableObjectTargetBaseType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?, LocalRepresentation

3546

3547

Attribute Documentation:

3548

3549

|**Name**|**Type**|**Documentation**

3550

|id|com:NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).

3551

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

3552

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

3553

3554

Element Documentation:

3555

3556

|**Name**|**Type**|**Documentation**

3557

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

3558

|LocalRepresentation|IdentifiableObjectRe presentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.

3559

3560

**IdentifiableObjectTargetType: **IdentifiableObjectTargetType defines the structure of an identifiable target object. The identifiable target object has a fixed representation of a reference and can specify a local representation of any item scheme for the purpose of restricting which items may be referenced. The identifiable object target must specify the object type which the target object is meant to reference.

Derivation:

//com:AnnotableType// (extension)

3565

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

3566

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

3567

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (extension)

3568

[[image:inherit.gif||height="9" width="9"]] //TargetObject// (restriction)

3569

[[image:inherit.gif||height="9" width="9"]] //IdentifiableObjectTargetBaseType// (extension)

3570

[[image:inherit.gif||height="9" width="9"]] IdentifiableObjectTargetType

Attributes:

id, urn?, uri?, objectType

Content:

com:Annotations?, LocalRepresentation

3579

3580

Attribute Documentation:

3581

3582

|**Name**|**Type**|**Documentation**

3583

|id|com:NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).

3584

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

3585

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

3586

|objectType|com: ObjectTypeCodelistTy pe|

3587

3588

Element Documentation:

3589

3590

|**Name**|**Type**|**Documentation**

3591

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

3592

|LocalRepresentation|IdentifiableObjectRe presentationType|LocalRepresentation references item schemes that may be used to create the representation of a component. The type of this must be refined such that a concrete item scheme reference is used.

3593

3594

//**ReportStructureBaseType**//**: **ReportStructureBaseType is an abstract base type that serves as the basis for the ReportStructureType.

Derivation:

//com:AnnotableType// (extension)

3599

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

3600

[[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)

3601

[[image:inherit.gif||height="9" width="9"]] //ReportStructureBaseType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?, MetadataAttribute+

3610

3611

Attribute Documentation:

3612

3613

|**Name**|**Type**|**Documentation**

3614

|id|com:IDType|The id is the identifier for the object.

3615

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

3616

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

3617

3618

Element Documentation:

3619

3620

|**Name**|**Type**|**Documentation**

3621

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

3622

|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.

3623

3624

**ReportStructureType: **ReportStructureType describes the structure of a report structure. It comprises a set of metadata attributes that can be defined as a hierarchy, and identifies the potential attachment of these attributes to an object by referencing a target identifier.

Derivation:

//com:AnnotableType// (extension)

3629

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

3630

[[image:inherit.gif||height="9" width="9"]] //ComponentListType// (restriction)

3631

[[image:inherit.gif||height="9" width="9"]] //ReportStructureBaseType// (extension)

3632

[[image:inherit.gif||height="9" width="9"]] ReportStructureType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, MetadataAttribute+, MetadataTarget+

3641

3642

Attribute Documentation:

3643

3644

|**Name**|**Type**|**Documentation**

3645

|id|com:IDType|The id is the identifier for the object.

3646

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

3647

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

3648

3649

Element Documentation:

3650

3651

|**Name**|**Type**|**Documentation**

3652

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

3653

|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.

3654

|MetadataTarget|com: LocalMetadataTargetR eferenceType|MetadataTarget references a metadata target defined in the metadata structure definition. A report structure can reference multiple metadata targets which allows a report structure to be reused for attaching metadata to different types of targets.

3655

3656

//**MetadataAttributeBaseType**//**: **MetadataAttributeBaseType is an abstract base type the serves as the basis for the MetadataAttributeType.

Derivation:

//com:AnnotableType// (extension)

3661

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

3662

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

3663

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)

3664

[[image:inherit.gif||height="9" width="9"]] //MetadataAttributeBaseType//

Attributes:

id?, urn?, uri?

Content:

com:Annotations?, ConceptIdentity, LocalRepresentation?

3673

3674

Attribute Documentation:

3675

3676

|**Name**|**Type**|**Documentation**

3677

|id|com:NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).

3678

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

3679

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

3680

3681

Element Documentation:

3682

3683

|**Name**|**Type**|**Documentation**

3684

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

3685

|ConceptIdentity|com: ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.

3686

|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.

3687

3688

**MetadataAttributeType: **MetadataAttributeType describes the structure of a metadata attribute. The metadata attribute takes its semantic, and in some cases it representation, from its concept identity. A metadata attribute may be coded (via the local representation), uncoded (via the text format), or take no value. In addition to this value, the metadata attribute may also specify subordinate metadata attributes. If a metadata attribute only serves the purpose of containing subordinate metadata attributes, then the isPresentational attribute should be used. Otherwise, it is assumed to also take a value. If the metadata attribute does take a value, and a representation is not defined, it will be inherited from the concept it takes its semantic from. The optional id on the metadata attribute uniquely identifies it within the metadata structured definition. If this id is not supplied, its value is assumed to be that of the concept referenced from the concept identity. Note that a metadata attribute (as identified by the id attribute) definition must be unique across the entire metadata structure definition (including target identifier, identifier component, and report structure ids). A metadata attribute may be used in multiple report structures and at different levels, but the content (value and/or child metadata attributes and their cardinality) of the metadata attribute cannot change.

Derivation:

//com:AnnotableType// (extension)

3693

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (restriction)

3694

[[image:inherit.gif||height="9" width="9"]] //ComponentBaseType// (extension)

3695

[[image:inherit.gif||height="9" width="9"]] //ComponentType// (restriction)

3696

[[image:inherit.gif||height="9" width="9"]] //MetadataAttributeBaseType// (extension)

3697

[[image:inherit.gif||height="9" width="9"]] MetadataAttributeType

Attributes:

id?, urn?, uri?, minOccurs?, maxOccurs?, isPresentational?

Content:

com:Annotations?, ConceptIdentity, LocalRepresentation?, MetadataAttribute*

3706

3707

Attribute Documentation:

3708

3709

|**Name**|**Type**|**Documentation**

3710

|id|com:NCNameIDType|The id attribute holds an explicit identification of the component. If this identifier is not supplied, then it is assumed to be the same as the identifier of the concept referenced from the concept identity. Because structures require that every component be given a unique identifier, it may be necessary to assign an explicit identifier when more than one component in a structure reference concepts with same identifier. It is important to note that this applies strictly to the identifier of concept and not the URN. Therefore if two concepts with the same identifier from different concept schemes are referenced in the same structure, one of the components will have to provide a unique explicit identifier. The type of this identifier is restricted to the common:NCNameIDType. This is necessary, since component identifiers are used to create XML elements and attributes in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).

3711

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

3712

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

3713

|minOccurs (default: 1)|xs: nonNegativeInteger|The minOccurs attribute indicates the minimum number of times this metadata attribute can occur within its parent object.

3714

|maxOccurs (default: 1)|com:OccurenceType|The maxOccurs attribute indicates the maximum number of times this metadata attribute can occur within its parent object.

3715

|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.

3716

3717

Element Documentation:

3718

3719

|**Name**|**Type**|**Documentation**

3720

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

3721

|ConceptIdentity|com: ConceptReferenceType|ConceptIdentity allows for the referencing of a concept in a concept scheme. The component takes its semantic from this concept, and if an id is not specified, it takes its identification as well. If a representation (LocalRepresentation) is not supplied, then the representation of the component is also inherited from the concept. Note that in the case of the component representation being inherited from the concept, the allowable representations for the component still apply. Therefore, if a component references a concept with a core representation that is not allowed for the concept, that representation must be locally overridden. For components which can specify a concept role, it is implied that the concept which is referenced also identifies a role for the component.

3722

|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.

3723

|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.

3724

3725

**KeyDescriptorValuesRepresentationType: **KeyDescriptorValuesRepresentationType defines the possible local representations of a key descriptor values target object. The representation is fixed to always be a data key (KeyValues).

Derivation:

//RepresentationType// (restriction)

3730

[[image:inherit.gif||height="9" width="9"]] KeyDescriptorValuesRepresentationType

Content:

TextFormat

Element Documentation:

3737

3738

|**Name**|**Type**|**Documentation**

3739

|TextFormat|KeyDescriptorValuesT extFormatType|TextFormat describes an uncoded textual format.

3740

3741

**DataSetRepresentationType: **DataSetRepresentationType defines the possible local representations of a data set reference target object. The representation is fixed to always be a data set reference.

Derivation:

//RepresentationType// (restriction)

3746

[[image:inherit.gif||height="9" width="9"]] DataSetRepresentationType

Content:

TextFormat

Element Documentation:

3753

3754

|**Name**|**Type**|**Documentation**

3755

|TextFormat|DataSetTextFormatTyp e|TextFormat describes an uncoded textual format.

3756

3757

**ConstraintRepresentationType: **ConstraintRepresentationType defines the possible local representations of a constraint reference target object. The representation is fixed to always be an attachment constraint reference.

Derivation:

//RepresentationType// (restriction)

3762

[[image:inherit.gif||height="9" width="9"]] ConstraintRepresentationType

Content:

TextFormat

Element Documentation:

3769

3770

|**Name**|**Type**|**Documentation**

3771

|TextFormat|ConstraintTextFormat Type|TextFormat describes an uncoded textual format.

3772

3773

**ReportPeriodRepresentationType: **ReportPeriodRepresentationType defines the possible local representations of a report period target object. The reprentation must be a time period or a subset of this representation.

Derivation:

//RepresentationType// (restriction)

3778

[[image:inherit.gif||height="9" width="9"]] ReportPeriodRepresentationType

Content:

TextFormat

Element Documentation:

3785

3786

|**Name**|**Type**|**Documentation**

3787

|TextFormat|TimeTextFormatType|TextFormat describes an uncoded textual format.

3788

3789

**IdentifiableObjectRepresentationType: **IdentifiableObjectRepresentationType defines the possible local representations of an identifiable object target object.

Derivation:

//RepresentationType// (restriction)

3794

[[image:inherit.gif||height="9" width="9"]] IdentifiableObjectRepresentationType

Content:

(TextFormat | Enumeration)

3799

3800

Element Documentation:

3801

3802

|**Name**|**Type**|**Documentation**

3803

|TextFormat|IdentifiableObjectTe xtFormatType|TextFormat describes an uncoded textual format.

3804

|Enumeration|com: ItemSchemeReferenceT ype|Enumeration is only permissible if the object type of the identifiable object target is an item in an item scheme. This enumeration is meant to limit the referencable objects to the items defined in the referenced item scheme.

3805

3806

**MetadataAttributeRepresentationType: **MetadataAttributeRepresentationType defines the possible local representations of a metadata attribute.

Derivation:

//RepresentationType// (restriction)

3811

[[image:inherit.gif||height="9" width="9"]] MetadataAttributeRepresentationType

Content:

(TextFormat | (Enumeration, EnumerationFormat?))

3816

3817

Element Documentation:

3818

3819

|**Name**|**Type**|**Documentation**

3820

|TextFormat|BasicComponentTextFo rmatType|TextFormat describes an uncoded textual format.

3821

|Enumeration|com: CodelistReferenceTyp e|Enumeration references an item scheme that enumerates the allowable values for this representation.

3822

|EnumerationFormat|CodededTextFormatTyp e|EnumerationFormat describes the facets of the item scheme enumeration. This is for the most part, informational.

3823

3824

**TargetObjectTextFormatType: **TargetObjectTextFormatType is a restricted version of the TextFormatType that does not allow for any facets and only allows the text types for target objects.

Derivation:

TextFormatType (restriction)

3829

[[image:inherit.gif||height="9" width="9"]] TargetObjectTextFormatType

Attributes:

textType?

Content:

{Empty}

Attribute Documentation:

3840

3841

|**Name**|**Type**|**Documentation**

3842

|textType|TargetObjectDataType|The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets.

3843

3844

**KeyDescriptorValuesTextFormatType: **KeyDescriptorValuesTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed KeyValues representation.

Derivation:

TextFormatType (restriction)

3849

[[image:inherit.gif||height="9" width="9"]] TargetObjectTextFormatType (restriction)

3850

[[image:inherit.gif||height="9" width="9"]] KeyDescriptorValuesTextFormatType

Attributes:

textType?

Content:

{Empty}

Attribute Documentation:

3861

3862

|**Name**|**Type**|**Documentation**

3863

|textType (fixed: KeyValues)|TargetObjectDataType|The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets.

3864

3865

**DataSetTextFormatType: **DataSetTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed DataSetReference representation.

Derivation:

TextFormatType (restriction)

3870

[[image:inherit.gif||height="9" width="9"]] TargetObjectTextFormatType (restriction)

3871

[[image:inherit.gif||height="9" width="9"]] DataSetTextFormatType

Attributes:

textType?

Content:

{Empty}

Attribute Documentation:

3882

3883

|**Name**|**Type**|**Documentation**

3884

|textType (fixed: DataSetReference)|TargetObjectDataType|The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets.

3885

3886

**ConstraintTextFormatType: **ConstraintTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed AttachmentConstraintReference representation.

Derivation:

TextFormatType (restriction)

3891

[[image:inherit.gif||height="9" width="9"]] TargetObjectTextFormatType (restriction)

3892

[[image:inherit.gif||height="9" width="9"]] ConstraintTextFormatType

Attributes:

textType?

Content:

{Empty}

Attribute Documentation:

3903

3904

|**Name**|**Type**|**Documentation**

3905

|textType (fixed: AttachmentConstraintReference)|TargetObjectDataType|The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets.

3906

3907

**IdentifiableObjectTextFormatType: **IdentifiableObjectTextFormatType is a restricted version of the NonFacetedTextFormatType that specifies a fixed IdentifiableReference representation.

Derivation:

TextFormatType (restriction)

3912

[[image:inherit.gif||height="9" width="9"]] TargetObjectTextFormatType (restriction)

3913

[[image:inherit.gif||height="9" width="9"]] IdentifiableObjectTextFormatType

Attributes:

textType?

Content:

{Empty}

Attribute Documentation:

3924

3925

|**Name**|**Type**|**Documentation**

3926

|textType (fixed: IdentifiableReference)|TargetObjectDataType|The textType attribute provides a description of the datatype. If it is not specified, any valid characters may be included in the text field (it corresponds to the xs:string datatype of W3C XML Schema) within the constraints of the facets.

3927

3928

//**OrganisationSchemeBaseType**//**: **OrganisationSchemeBaseType is an abstract base type for any organisation scheme.

Derivation:

//com:AnnotableType// (extension)

3933

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

3934

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

3935

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

3936

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

3937

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

3938

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)

3939

[[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeBaseType//

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?

Content:

com:Annotations?, com:Name+, com:Description*

3948

3949

Attribute Documentation:

3950

3951

|**Name**|**Type**|**Documentation**

3952

|id|com:IDType|The id is the identifier for the object.

3953

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

3954

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

3955

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

3956

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

3957

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

3958

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

3959

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

3960

|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.

3961

|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.

3962

|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.

3963

|isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint.

3964

3965

Element Documentation:

3966

3967

|**Name**|**Type**|**Documentation**

3968

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

3969

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

3970

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

3971

3972

//**OrganisationSchemeType**//**: **OrganisationSchemeType describes the structure of an organisation scheme.

Derivation:

//com:AnnotableType// (extension)

3977

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

3978

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

3979

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

3980

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

3981

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

3982

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)

3983

[[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeBaseType// (extension)

3984

[[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeType//

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?

Content:

com:Annotations?, com:Name+, com:Description*, //Organisation*//

3993

3994

Attribute Documentation:

3995

3996

|**Name**|**Type**|**Documentation**

3997

|id|com:IDType|The id is the identifier for the object.

3998

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

3999

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4000

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

4001

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

4002

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

4003

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

4004

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

4005

|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.

4006

|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.

4007

|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.

4008

|isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint.

4009

4010

Element Documentation:

4011

4012

|**Name**|**Type**|**Documentation**

4013

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4014

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4015

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4016

|//Organisation//|//OrganisationType//|Organisation is an abstract substitution head for a generic organisation.

4017

4018

//**BaseOrganisationType**//**: **BaseOrganisationType is an abstract base type the forms the basis for the OrganisationType.

Derivation:

//com:AnnotableType// (extension)

4023

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4024

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

4025

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

4026

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

4027

[[image:inherit.gif||height="9" width="9"]] //BaseOrganisationType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Parent?

4036

4037

Attribute Documentation:

4038

4039

|**Name**|**Type**|**Documentation**

4040

|id|com:IDType|The id is the identifier for the object.

4041

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4042

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4043

4044

Element Documentation:

4045

4046

|**Name**|**Type**|**Documentation**

4047

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4048

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4049

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4050

|Parent|//com: LocalOrganisationRef erenceBaseType//|If the particular organisation scheme allows, an organisation may reference a parent organisation defined in the same scheme. This does not affect the identification of the organisation, but rather only serves to state the relationship.

4051

4052

//**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:

//com:AnnotableType// (extension)

4057

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4058

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

4059

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

4060

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

4061

[[image:inherit.gif||height="9" width="9"]] //BaseOrganisationType// (extension)

4062

[[image:inherit.gif||height="9" width="9"]] //OrganisationType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Parent?, Contact*

4071

4072

Attribute Documentation:

4073

4074

|**Name**|**Type**|**Documentation**

4075

|id|com:IDType|The id is the identifier for the object.

4076

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4077

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4078

4079

Element Documentation:

4080

4081

|**Name**|**Type**|**Documentation**

4082

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4083

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4084

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4085

|Parent|//com: LocalOrganisationRef erenceBaseType//|If the particular organisation scheme allows, an organisation may reference a parent organisation defined in the same scheme. This does not affect the identification of the organisation, but rather only serves to state the relationship.

4086

|Contact|ContactType|Contact describes a contact for the organisation,

4087

4088

**AgencySchemeType: **AgencySchemeType defines a specific type of organisation scheme which contains only maintenance agencies. The agency scheme maintained by a particular maintenance agency is always provided a fixed identifier and version, and is never final. Therefore, agencies can be added or removed without have to version the scheme. Agencies schemes have no hierarchy, meaning that no agency may define a relationship with another agency in the scheme. In fact, the actual parent agency for an agency in a scheme is the agency which defines the scheme.

Derivation:

//com:AnnotableType// (extension)

4093

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4094

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

4095

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

4096

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

4097

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

4098

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)

4099

[[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeBaseType// (extension)

4100

[[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeType// (restriction)

4101

[[image:inherit.gif||height="9" width="9"]] AgencySchemeType

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?

Content:

com:Annotations?, com:Name+, com:Description*, Agency*

4110

4111

Attribute Documentation:

4112

4113

|**Name**|**Type**|**Documentation**

4114

|id (fixed: AGENCIES)|com:IDType|The id is the identifier for the object.

4115

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4116

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4117

|version (fixed: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

4118

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

4119

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

4120

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

4121

|isFinal (fixed: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

4122

|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.

4123

|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.

4124

|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.

4125

|isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint.

4126

4127

Element Documentation:

4128

4129

|**Name**|**Type**|**Documentation**

4130

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4131

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4132

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4133

|Agency|AgencyType|Agency is an organisation which maintains structural metadata such as statistical classifications, glossaries, key family structural definitions, and metadata structure definitions..

4134

4135

**DataConsumerSchemeType: **DataConsumerSchemeType defines a type of organisation scheme which contains only data consumers. The data consumer scheme maintained by a particular maintenance agency is always provided a fixed identifier and version, and is never final. Therefore, consumers can be added or removed without have to version the scheme. This scheme has no hierarchy, meaning that no organisation may define a relationship with another organisation in the scheme.

Derivation:

//com:AnnotableType// (extension)

4140

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4141

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

4142

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

4143

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

4144

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

4145

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)

4146

[[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeBaseType// (extension)

4147

[[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeType// (restriction)

4148

[[image:inherit.gif||height="9" width="9"]] DataConsumerSchemeType

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?

Content:

com:Annotations?, com:Name+, com:Description*, DataConsumer*

4157

4158

Attribute Documentation:

4159

4160

|**Name**|**Type**|**Documentation**

4161

|id (fixed: DATA_CONSUMERS)|com:IDType|The id is the identifier for the object.

4162

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4163

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4164

|version (fixed: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

4165

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

4166

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

4167

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

4168

|isFinal (fixed: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

4169

|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.

4170

|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.

4171

|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.

4172

|isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint.

4173

4174

Element Documentation:

4175

4176

|**Name**|**Type**|**Documentation**

4177

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4178

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4179

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4180

|DataConsumer|DataConsumerType|DataConsumer describes an organisation using data as input for further processing.

4181

4182

**DataProviderSchemeType: **DataProviderSchemeType defines a type of organisation scheme which contains only data providers. The data provider scheme maintained by a particular maintenance agency is always provided a fixed identifier and version, and is never final. Therefore, providers can be added or removed without have to version the scheme. This scheme has no hierarchy, meaning that no organisation may define a relationship with another organisation in the scheme

Derivation:

//com:AnnotableType// (extension)

4187

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4188

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

4189

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

4190

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

4191

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

4192

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)

4193

[[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeBaseType// (extension)

4194

[[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeType// (restriction)

4195

[[image:inherit.gif||height="9" width="9"]] DataProviderSchemeType

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?

Content:

com:Annotations?, com:Name+, com:Description*, DataProvider*

4204

4205

Attribute Documentation:

4206

4207

|**Name**|**Type**|**Documentation**

4208

|id (fixed: DATA_PROVIDERS)|com:IDType|The id is the identifier for the object.

4209

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4210

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4211

|version (fixed: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

4212

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

4213

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

4214

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

4215

|isFinal (fixed: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

4216

|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.

4217

|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.

4218

|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.

4219

|isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint.

4220

4221

Element Documentation:

4222

4223

|**Name**|**Type**|**Documentation**

4224

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4225

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4226

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4227

|DataProvider|DataProviderType|DataProvider describes an organisation that produces data or reference metadata.

4228

4229

**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:

//com:AnnotableType// (extension)

4234

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4235

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

4236

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

4237

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

4238

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

4239

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)

4240

[[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeBaseType// (extension)

4241

[[image:inherit.gif||height="9" width="9"]] //OrganisationSchemeType// (restriction)

4242

[[image:inherit.gif||height="9" width="9"]] OrganisationUnitSchemeType

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?

Content:

com:Annotations?, com:Name+, com:Description*, OrganisationUnit*

4251

4252

Attribute Documentation:

4253

4254

|**Name**|**Type**|**Documentation**

4255

|id|com:IDType|The id is the identifier for the object.

4256

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4257

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4258

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

4259

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

4260

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

4261

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

4262

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

4263

|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.

4264

|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.

4265

|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.

4266

|isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint.

4267

4268

Element Documentation:

4269

4270

|**Name**|**Type**|**Documentation**

4271

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4272

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4273

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4274

|OrganisationUnit|OrganisationUnitType|OrganisationUnit describes a generic organisation, which serves not predefined role in SDMX.

4275

4276

**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:

//com:AnnotableType// (extension)

4281

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4282

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

4283

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

4284

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

4285

[[image:inherit.gif||height="9" width="9"]] //BaseOrganisationType// (extension)

4286

[[image:inherit.gif||height="9" width="9"]] //OrganisationType// (restriction)

4287

[[image:inherit.gif||height="9" width="9"]] AgencyType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Contact*

4296

4297

Attribute Documentation:

4298

4299

|**Name**|**Type**|**Documentation**

4300

|id|com:NCNameIDType|The id attribute holds the identification of the agency. The type of this id is restricted to the common:NCNNameIDType. This is necessary, since the agency identifier will be used as part of the name for simple types in data and metadata structure specific schemas and therefore must be compliant with the NCName type in XML Schema (see common:NCNameIDType for further details).

4301

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4302

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4303

4304

Element Documentation:

4305

4306

|**Name**|**Type**|**Documentation**

4307

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4308

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4309

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4310

|Contact|ContactType|Contact describes a contact for the organisation,

4311

4312

**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:

//com:AnnotableType// (extension)

4317

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4318

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

4319

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

4320

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

4321

[[image:inherit.gif||height="9" width="9"]] //BaseOrganisationType// (extension)

4322

[[image:inherit.gif||height="9" width="9"]] //OrganisationType// (restriction)

4323

[[image:inherit.gif||height="9" width="9"]] DataConsumerType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Contact*

4332

4333

Attribute Documentation:

4334

4335

|**Name**|**Type**|**Documentation**

4336

|id|com:IDType|The id is the identifier for the object.

4337

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4338

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4339

4340

Element Documentation:

4341

4342

|**Name**|**Type**|**Documentation**

4343

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4344

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4345

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4346

|Contact|ContactType|Contact describes a contact for the organisation,

4347

4348

**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:

//com:AnnotableType// (extension)

4353

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4354

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

4355

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

4356

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

4357

[[image:inherit.gif||height="9" width="9"]] //BaseOrganisationType// (extension)

4358

[[image:inherit.gif||height="9" width="9"]] //OrganisationType// (restriction)

4359

[[image:inherit.gif||height="9" width="9"]] DataProviderType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Contact*

4368

4369

Attribute Documentation:

4370

4371

|**Name**|**Type**|**Documentation**

4372

|id|com:IDType|The id is the identifier for the object.

4373

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4374

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4375

4376

Element Documentation:

4377

4378

|**Name**|**Type**|**Documentation**

4379

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4380

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4381

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4382

|Contact|ContactType|Contact describes a contact for the organisation,

4383

4384

**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:

//com:AnnotableType// (extension)

4389

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4390

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

4391

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

4392

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

4393

[[image:inherit.gif||height="9" width="9"]] //BaseOrganisationType// (extension)

4394

[[image:inherit.gif||height="9" width="9"]] //OrganisationType// (restriction)

4395

[[image:inherit.gif||height="9" width="9"]] OrganisationUnitType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Parent?, Contact*

4404

4405

Attribute Documentation:

4406

4407

|**Name**|**Type**|**Documentation**

4408

|id|com:IDType|The id is the identifier for the object.

4409

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4410

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4411

4412

Element Documentation:

4413

4414

|**Name**|**Type**|**Documentation**

4415

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4416

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4417

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4418

|Parent|com: LocalOrganisationUni tReferenceType|If the particular organisation scheme allows, an organisation may reference a parent organisation defined in the same scheme. This does not affect the identification of the organisation, but rather only serves to state the relationship.

4419

|Contact|ContactType|Contact describes a contact for the organisation,

4420

4421

**ContactType: **ContactType describes the structure of a contact's details.

Attributes:

id?

Content:

com:Name*, Department*, Role*, (Telephone | Fax | X400 | URI | Email)*

4430

4431

Attribute Documentation:

4432

4433

|**Name**|**Type**|**Documentation**

4434

|id|com:IDType|The id attribute is used to carry user id information for the contact.

4435

4436

Element Documentation:

4437

4438

|**Name**|**Type**|**Documentation**

4439

|com:Name|com:TextType|Name is a reusable element, used for providing a human-readable name for an object.

4440

|Department|com:TextType|Department is designation of the organisational structure by a linguistic expression, within which the contact person works.

4441

|Role|com:TextType|Role is the responsibility of the contact person with respect to the object for which this person is the contact.

4442

|Telephone|xs:string|Telephone holds the telephone number for the contact person.

4443

|Fax|xs:string|Fax holds the fax number for the contact person.

4444

|X400|xs:string|X400 holds the X.400 address for the contact person.

4445

|URI|xs:anyURI|URI holds an information URL for the contact person.

4446

|Email|xs:string|Email holds the email address for the contact person.

4447

4448

**ProvisionAgreementType: **ProvisionAgreementType describes the structure of a provision agreement. A provision agreement defines an agreement for a data provider to report data or reference metadata against a flow. Attributes which describe how the registry must behave when data or metadata is registered against this provision agreement are supplied.

Derivation:

//com:AnnotableType// (extension)

4453

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4454

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

4455

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

4456

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

4457

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

4458

[[image:inherit.gif||height="9" width="9"]] ProvisionAgreementType

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?

Content:

com:Annotations?, com:Name+, com:Description*, StructureUsage, DataProvider

4467

4468

Attribute Documentation:

4469

4470

|**Name**|**Type**|**Documentation**

4471

|id|com:IDType|The id is the identifier for the object.

4472

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4473

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4474

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

4475

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

4476

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

4477

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

4478

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

4479

|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.

4480

|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.

4481

|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.

4482

4483

Element Documentation:

4484

4485

|**Name**|**Type**|**Documentation**

4486

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4487

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4488

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4489

|StructureUsage|com: StructureUsageRefere nceType|DataflowReference provides a reference to a pre-existing structure usage (i.e. a dataflow or metadataflow) in the registry. The reference is provided via a URN and/or a full set of reference fields.

4490

|DataProvider|com: DataProviderReferenc eType|DataProvider provides a reference to a pre-existing data (or metadata) provider in the registry. The reference is provided via a URN and/or a full set of reference fields.

4491

4492

**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:

//com:AnnotableType// (extension)

4497

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4498

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

4499

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

4500

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

4501

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

4502

[[image:inherit.gif||height="9" width="9"]] ProcessType

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?

Content:

com:Annotations?, com:Name+, com:Description*, ProcessStep*

4511

4512

Attribute Documentation:

4513

4514

|**Name**|**Type**|**Documentation**

4515

|id|com:IDType|The id is the identifier for the object.

4516

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4517

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4518

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

4519

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

4520

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

4521

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

4522

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

4523

|isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.

4524

|serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.

4525

|structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.

4526

4527

Element Documentation:

4528

4529

|**Name**|**Type**|**Documentation**

4530

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4531

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4532

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4533

|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.

4534

4535

//**ProcessStepBaseType**//**: **ProcessStepBaseType is an abstract base type used as the basis for the ProcessStepType.

Derivation:

//com:AnnotableType// (extension)

4540

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4541

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

4542

[[image:inherit.gif||height="9" width="9"]] //ProcessStepBaseType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*

4551

4552

Attribute Documentation:

4553

4554

|**Name**|**Type**|**Documentation**

4555

|id|com:IDType|The id is the identifier for the object.

4556

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4557

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4558

4559

Element Documentation:

4560

4561

|**Name**|**Type**|**Documentation**

4562

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4563

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4564

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4565

4566

**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:

//com:AnnotableType// (extension)

4571

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4572

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

4573

[[image:inherit.gif||height="9" width="9"]] //ProcessStepBaseType// (extension)

4574

[[image:inherit.gif||height="9" width="9"]] ProcessStepType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Input*, Output*, Computation?, Transition*, ProcessStep*

4583

4584

Attribute Documentation:

4585

4586

|**Name**|**Type**|**Documentation**

4587

|id|com:IDType|The id is the identifier for the object.

4588

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4589

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4590

4591

Element Documentation:

4592

4593

|**Name**|**Type**|**Documentation**

4594

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4595

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4596

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4597

|Input|InputOutputType|Input references an object which is an input to the process step.

4598

|Output|InputOutputType|Output references an object which is an output form the process step.

4599

|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.

4600

|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.

4601

|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.

4602

4603

**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:

//com:AnnotableType// (extension)

4608

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4609

[[image:inherit.gif||height="9" width="9"]] TransitionType

Attributes:

id?, urn?, uri?, localID?

Content:

com:Annotations?, TargetStep, Condition+

4618

4619

Attribute Documentation:

4620

4621

|**Name**|**Type**|**Documentation**

4622

|id|com:IDType|The id is the identifier for the object.

4623

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4624

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4625

|localID|com:IDType|The localID attribute is an optional identification for the transition within the process.

4626

4627

Element Documentation:

4628

4629

|**Name**|**Type**|**Documentation**

4630

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4631

|TargetStep|com: LocalProcessStepRefe renceType|TargetStep references a process step within the process that should be transitioned to, should the conditions described be met.

4632

|Condition|com:TextType|Condition is a textual description of the conditions to be met in order for the target step to be proceeded to. It is informational only (not machine-actionable), and may be supplied in multiple, parallel-language form.

4633

4634

**ComputationType: **ComputationType describes a computation in a process.

Derivation:

//com:AnnotableType// (extension)

4639

[[image:inherit.gif||height="9" width="9"]] ComputationType

Attributes:

localID?, softwarePackage?, softwareLanguage?, softwareVersion?

Content:

com:Annotations?, com:Description+

4648

4649

Attribute Documentation:

4650

4651

|**Name**|**Type**|**Documentation**

4652

|localID|com:IDType|The localID attribute is an optional identification for the computation within the process.

4653

|softwarePackage|xs:string|The softwarePackage attribute holds the name of the software package that is used to perform the computation.

4654

|softwareLanguage|xs:string|The softwareLanguage attribute holds the coding language that the software package used to perform the computation is written in.

4655

|softwareVersion|xs:string|The softwareVersion attribute hold the version of the software package that is used to perform that computation.

4656

4657

Element Documentation:

4658

4659

|**Name**|**Type**|**Documentation**

4660

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4661

|com:Description|com:TextType|Description describe the computation in any form desired by the user (these are informational rather than machine-actionable), and so may be supplied in multiple, parallel-language versions,

4662

4663

**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:

//com:AnnotableType// (extension)

4668

[[image:inherit.gif||height="9" width="9"]] InputOutputType

Attributes:

localID?

Content:

com:Annotations?, ObjectReference

4677

4678

Attribute Documentation:

4679

4680

|**Name**|**Type**|**Documentation**

4681

|localID|com:IDType|The localID attribute is an optional identification for the input or output within the process.

4682

4683

Element Documentation:

4684

4685

|**Name**|**Type**|**Documentation**

4686

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4687

|ObjectReference|com: ObjectReferenceType|ObjectReference is an abstract substitution head that references the object that is an input or output. It is substituted with a concrete reference to an explicit object type.

4688

4689

**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:

//com:AnnotableType// (extension)

4694

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4695

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

4696

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

4697

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

4698

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

4699

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)

4700

[[image:inherit.gif||height="9" width="9"]] ReportingTaxonomyType

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?

Content:

com:Annotations?, com:Name+, com:Description*, ReportingCategory*

4709

4710

Attribute Documentation:

4711

4712

|**Name**|**Type**|**Documentation**

4713

|id|com:IDType|The id is the identifier for the object.

4714

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4715

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4716

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

4717

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

4718

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

4719

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

4720

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

4721

|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.

4722

|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.

4723

|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.

4724

|isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint.

4725

4726

Element Documentation:

4727

4728

|**Name**|**Type**|**Documentation**

4729

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4730

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4731

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4732

|ReportingCategory|ReportingCategoryTyp e|ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages.

4733

4734

//**ReportingCategoryBaseType**//**: **ReportingCategoryBaseType is an abstract base type that serves as the basis for the ReportingCategoryType.

Derivation:

//com:AnnotableType// (extension)

4739

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4740

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

4741

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

4742

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

4743

[[image:inherit.gif||height="9" width="9"]] //ReportingCategoryBaseType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, ReportingCategory*

4752

4753

Attribute Documentation:

4754

4755

|**Name**|**Type**|**Documentation**

4756

|id|com:IDType|The id is the identifier for the object.

4757

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4758

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4759

4760

Element Documentation:

4761

4762

|**Name**|**Type**|**Documentation**

4763

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4764

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4765

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4766

|ReportingCategory|ReportingCategoryTyp e|ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages.

4767

4768

**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:

//com:AnnotableType// (extension)

4773

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4774

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

4775

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

4776

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

4777

[[image:inherit.gif||height="9" width="9"]] //ReportingCategoryBaseType// (extension)

4778

[[image:inherit.gif||height="9" width="9"]] ReportingCategoryType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, ReportingCategory*, (StructuralMetadata* | ProvisioningMetadata*)

4787

4788

Attribute Documentation:

4789

4790

|**Name**|**Type**|**Documentation**

4791

|id|com:IDType|The id is the identifier for the object.

4792

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4793

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4794

4795

Element Documentation:

4796

4797

|**Name**|**Type**|**Documentation**

4798

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4799

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4800

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4801

|ReportingCategory|ReportingCategoryTyp e|ReportingCateogry defines a reporting category, which is used to group structure usages into useful sub-packages.

4802

|StructuralMetadata|com: StructureReferenceTy pe|StructuralMetadata provides a reference for data structure definition and metadata structure definition references which are grouped in the reporting category. It is assumed that all structural metadata objects referenced from a category will be of the same type.

4803

|ProvisioningMetadata|com: StructureUsageRefere nceType|ProvisioningMetadata provides a reference for dataflow and metadataflow references which are grouped in the reporting category. It is assumed that all provisioning metadata objects referenced from a category will be of the same type.

4804

4805

//**StructureSetBaseType**//**: **StructureSetBaseType is an abstract base type that forms the basis for the StructureSetType.

Derivation:

//com:AnnotableType// (extension)

4810

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4811

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

4812

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

4813

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

4814

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)

4815

[[image:inherit.gif||height="9" width="9"]] //StructureSetBaseType//

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?

Content:

com:Annotations?, com:Name+, com:Description*

4824

4825

Attribute Documentation:

4826

4827

|**Name**|**Type**|**Documentation**

4828

|id|com:IDType|The id is the identifier for the object.

4829

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4830

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4831

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

4832

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

4833

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

4834

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

4835

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

4836

|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.

4837

|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.

4838

|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.

4839

4840

Element Documentation:

4841

4842

|**Name**|**Type**|**Documentation**

4843

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4844

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4845

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4846

4847

**StructureSetType: **StructureSetType describes the structure of a structure set. It allows components in one structure, structure usage, or item scheme to be mapped to components in another structural component of the same type.

Derivation:

//com:AnnotableType// (extension)

4852

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4853

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

4854

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

4855

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

4856

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (restriction)

4857

[[image:inherit.gif||height="9" width="9"]] //StructureSetBaseType// (extension)

4858

[[image:inherit.gif||height="9" width="9"]] StructureSetType

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?

Content:

Attribute Documentation:

4869

4870

|**Name**|**Type**|**Documentation**

4871

|id|com:IDType|The id is the identifier for the object.

4872

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4873

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4874

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

4875

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

4876

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

4877

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

4878

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

4879

|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.

4880

|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.

4881

|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.

4882

4883

Element Documentation:

4884

4885

|**Name**|**Type**|**Documentation**

4886

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4887

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4888

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4889

|RelatedStructure|com: StructureOrUsageRefe renceType|RelatedStructures contains references to structures (key families and metadata structure definitions) and structure usages (data flows and metadata flows) to indicate that a semantic relationship exist between them. The details of these relationships can be found in the structure maps.

4890

|OrganisationSchemeMa p|OrganisationSchemeMa pType|OrganisationSchemeMap links a source and target organisations from different schemes where there is a semantic equivalence between them. Organisations are mapped without regard to role.

4891

|CategorySchemeMap|CategorySchemeMapTyp e|CategorySchemeMap links a source and target categories from different schemes where there is a semantic equivalence between them.

4892

|CodelistMap|CodelistMapType|CodelistMap links a source and target codes from different lists where there is a semantic equivalence between them.

4893

|ConceptSchemeMap|ConceptSchemeMapType|ConceptSchemeMap links a source and target concepts from different schemes where there is a semantic equivalence between them.

4894

|ReportingTaxonomyMap|ReportingTaxonomyMap Type|ReportingTaxonomyMap links a source and target reporting categories from different taxonomies where there is a semantic equivalence between them.

4895

|HybridCodelistMap|HybridCodelistMapTyp e|HybridCodelistMap links a source and target codes from different codelists, which may be hierarchical or flat, where there is a semantic equivalence between them.

4896

|StructureMap|StructureMapType|StructureMap maps components from one structure to components to another structure, and can describe how the value of the components are related.

4897

4898

//**ItemSchemeMapBaseType**//**: **ItemSchemeMapBaseType is an abstract base type which forms the basis for the ItemSchemeMapType.

Derivation:

//com:AnnotableType// (extension)

4903

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4904

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

4905

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapBaseType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*

4914

4915

Attribute Documentation:

4916

4917

|**Name**|**Type**|**Documentation**

4918

|id|com:IDType|The id is the identifier for the object.

4919

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4920

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4921

4922

Element Documentation:

4923

4924

|**Name**|**Type**|**Documentation**

4925

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4926

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4927

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4928

4929

//**ItemSchemeMapType**//**: **ItemSchemeMapType is an abstract base type which forms the basis for mapping items between item schemes of the same type.

Derivation:

//com:AnnotableType// (extension)

4934

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4935

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

4936

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapBaseType// (extension)

4937

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Source, Target, //ItemAssociation+//

4946

4947

Attribute Documentation:

4948

4949

|**Name**|**Type**|**Documentation**

4950

|id|com:IDType|The id is the identifier for the object.

4951

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

4952

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

4953

4954

Element Documentation:

4955

4956

|**Name**|**Type**|**Documentation**

4957

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4958

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

4959

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

4960

|Source|//com: ItemSchemeReferenceB aseType//|Source provides a reference to the item scheme which items are mapped from.

4961

|Target|//com: ItemSchemeReferenceB aseType//|Target provides a reference to the item scheme which items are mapped to.

4962

|//ItemAssociation//|//ItemAssociationType//|ItemAssociation is an abstract description of the relation between two items for the purpose of mapping.

4963

4964

//**ItemAssociationType**//**: **ItemAssociationType is an abstract type which defines the relationship between two items from the source and target item schemes of an item scheme map.

Derivation:

//com:AnnotableType// (extension)

4969

[[image:inherit.gif||height="9" width="9"]] //ItemAssociationType//

Content:

com:Annotations?, Source, Target

4974

4975

Element Documentation:

4976

4977

|**Name**|**Type**|**Documentation**

4978

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

4979

|Source|//com: LocalItemReferenceTy pe//|Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item.

4980

|Target|//com: LocalItemReferenceTy pe//|Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item.

4981

4982

**OrganisationSchemeMapType: **OrganisationSchemeMapType defines the structure of a map which identifies relationships between organisations in different organisation schemes.

Derivation:

//com:AnnotableType// (extension)

4987

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

4988

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

4989

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapBaseType// (extension)

4990

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapType// (restriction)

4991

[[image:inherit.gif||height="9" width="9"]] OrganisationSchemeMapType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Source, Target, OrganisationMap+

5000

5001

Attribute Documentation:

5002

5003

|**Name**|**Type**|**Documentation**

5004

|id|com:IDType|The id is the identifier for the object.

5005

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5006

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5007

5008

Element Documentation:

5009

5010

|**Name**|**Type**|**Documentation**

5011

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5012

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5013

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5014

|Source|com: OrganisationSchemeRe ferenceType|Source provides a reference to the item scheme which items are mapped from.

5015

|Target|com: OrganisationSchemeRe ferenceType|Target provides a reference to the item scheme which items are mapped to.

5016

|OrganisationMap|OrganisationMapType|OrganisationMap relates a source organisation to a target organisation.

5017

5018

**OrganisationMapType: **OrganisationMapType defines the structure for mapping two organisations. A local reference is provided both the source and target organisation.

Derivation:

//com:AnnotableType// (extension)

5023

[[image:inherit.gif||height="9" width="9"]] //ItemAssociationType// (restriction)

5024

[[image:inherit.gif||height="9" width="9"]] OrganisationMapType

Content:

com:Annotations?, Source, Target

5029

5030

Element Documentation:

5031

5032

|**Name**|**Type**|**Documentation**

5033

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5034

|Source|com: LocalOrganisationRef erenceType|Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item.

5035

|Target|com: LocalOrganisationRef erenceType|Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item.

5036

5037

**CategorySchemeMapType: **CategorySchemeMapType defines the structure of a map which identifies relationships between categories in different category schemes.

Derivation:

//com:AnnotableType// (extension)

5042

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5043

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

5044

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapBaseType// (extension)

5045

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapType// (restriction)

5046

[[image:inherit.gif||height="9" width="9"]] CategorySchemeMapType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Source, Target, CategoryMap+

5055

5056

Attribute Documentation:

5057

5058

|**Name**|**Type**|**Documentation**

5059

|id|com:IDType|The id is the identifier for the object.

5060

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5061

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5062

5063

Element Documentation:

5064

5065

|**Name**|**Type**|**Documentation**

5066

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5067

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5068

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5069

|Source|com: CategorySchemeRefere nceType|Source provides a reference to the item scheme which items are mapped from.

5070

|Target|com: CategorySchemeRefere nceType|Target provides a reference to the item scheme which items are mapped to.

5071

|CategoryMap|CategoryMapType|CategoryMap defines the structure of a map which identifies relationships between categories in different category schemes.

5072

5073

**CategoryMapType: **CategoryMapType defines the structure for mapping two categories. A local reference is provided both the source and target category.

Derivation:

//com:AnnotableType// (extension)

5078

[[image:inherit.gif||height="9" width="9"]] //ItemAssociationType// (restriction)

5079

[[image:inherit.gif||height="9" width="9"]] CategoryMapType

Content:

com:Annotations?, Source, Target

5084

5085

Element Documentation:

5086

5087

|**Name**|**Type**|**Documentation**

5088

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5089

|Source|com: LocalCategoryReferen ceType|Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item.

5090

|Target|com: LocalCategoryReferen ceType|Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item.

5091

5092

**CodelistMapType: **CodelistMapType defines the structure of a map which identifies relationships between codes in different codelists.

Derivation:

//com:AnnotableType// (extension)

5097

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5098

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

5099

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapBaseType// (extension)

5100

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapType// (restriction)

5101

[[image:inherit.gif||height="9" width="9"]] CodelistMapType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Source, Target, CodeMap+

5110

5111

Attribute Documentation:

5112

5113

|**Name**|**Type**|**Documentation**

5114

|id|com:IDType|The id is the identifier for the object.

5115

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5116

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5117

5118

Element Documentation:

5119

5120

|**Name**|**Type**|**Documentation**

5121

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5122

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5123

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5124

|Source|com: CodelistReferenceTyp e|Source provides a reference to the item scheme which items are mapped from.

5125

|Target|com: CodelistReferenceTyp e|Target provides a reference to the item scheme which items are mapped to.

5126

|CodeMap|CodeMapType|CodeMap defines the structure of a map which identifies relationships between codes in different codelists.

5127

5128

**CodeMapType: **CodeMapType defines the structure for mapping two codes. A local reference is provided both the source and target code.

Derivation:

//com:AnnotableType// (extension)

5133

[[image:inherit.gif||height="9" width="9"]] //ItemAssociationType// (restriction)

5134

[[image:inherit.gif||height="9" width="9"]] CodeMapType

Content:

com:Annotations?, Source, Target

5139

5140

Element Documentation:

5141

5142

|**Name**|**Type**|**Documentation**

5143

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5144

|Source|com: LocalCodeReferenceTy pe|Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item.

5145

|Target|com: LocalCodeReferenceTy pe|Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item.

5146

5147

**ConceptSchemeMapType: **ConceptSchemeMapType defines the structure of a map which identifies relationships between concepts in different concept schemes.

Derivation:

//com:AnnotableType// (extension)

5152

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5153

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

5154

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapBaseType// (extension)

5155

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapType// (restriction)

5156

[[image:inherit.gif||height="9" width="9"]] ConceptSchemeMapType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Source, Target, ConceptMap+

5165

5166

Attribute Documentation:

5167

5168

|**Name**|**Type**|**Documentation**

5169

|id|com:IDType|The id is the identifier for the object.

5170

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5171

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5172

5173

Element Documentation:

5174

5175

|**Name**|**Type**|**Documentation**

5176

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5177

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5178

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5179

|Source|com: ConceptSchemeReferen ceType|Source provides a reference to the item scheme which items are mapped from.

5180

|Target|com: ConceptSchemeReferen ceType|Target provides a reference to the item scheme which items are mapped to.

5181

|ConceptMap|ConceptMapType|ConceptMap defines the structure of a map which identifies relationships between concepts in different concept schemes.

5182

5183

**ConceptMapType: **ConceptMapType defines the structure for mapping two concepts. A local reference is provided both the source and target concept.

Derivation:

//com:AnnotableType// (extension)

5188

[[image:inherit.gif||height="9" width="9"]] //ItemAssociationType// (restriction)

5189

[[image:inherit.gif||height="9" width="9"]] ConceptMapType

Content:

com:Annotations?, Source, Target

5194

5195

Element Documentation:

5196

5197

|**Name**|**Type**|**Documentation**

5198

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5199

|Source|com: LocalConceptReferenc eType|Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item.

5200

|Target|com: LocalConceptReferenc eType|Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item.

5201

5202

**ReportingTaxonomyMapType: **ReportingTaxonomyMapType defines the structure of a map which identifies relationships between reporting categories in different reporting taxonomies.

Derivation:

//com:AnnotableType// (extension)

5207

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5208

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

5209

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapBaseType// (extension)

5210

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeMapType// (restriction)

5211

[[image:inherit.gif||height="9" width="9"]] ReportingTaxonomyMapType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Source, Target, ReportingCategoryMap+

5220

5221

Attribute Documentation:

5222

5223

|**Name**|**Type**|**Documentation**

5224

|id|com:IDType|The id is the identifier for the object.

5225

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5226

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5227

5228

Element Documentation:

5229

5230

|**Name**|**Type**|**Documentation**

5231

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5232

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5233

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5234

|Source|com: ReportingTaxonomyRef erenceType|Source provides a reference to the item scheme which items are mapped from.

5235

|Target|com: ReportingTaxonomyRef erenceType|Target provides a reference to the item scheme which items are mapped to.

5236

|ReportingCategoryMap|ReportingCategoryMap Type|ReportingCategoryMap defines the structure of a map which identifies relationships between reporting categories in different reporting taxonomies.

5237

5238

**ReportingCategoryMapType: **ReportingCategoryMapType defines the structure for mapping two reporting categories. A local reference is provided both the source and target category.

Derivation:

//com:AnnotableType// (extension)

5243

[[image:inherit.gif||height="9" width="9"]] //ItemAssociationType// (restriction)

5244

[[image:inherit.gif||height="9" width="9"]] ReportingCategoryMapType

Content:

com:Annotations?, Source, Target

5249

5250

Element Documentation:

5251

5252

|**Name**|**Type**|**Documentation**

5253

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5254

|Source|com: LocalReportingCatego ryReferenceType|Source provides a local reference (id only) to an item from the source item scheme in the item scheme map which is being mapped to another item.

5255

|Target|com: LocalReportingCatego ryReferenceType|Target provides a local reference (id only) to an item from the target item scheme in the item scheme map which is being mapped from another item.

5256

5257

//**HybridCodelistMapBaseType**//**: **HybridCodelistMapBaseType is an abstract base type which forms the basis for the HybridCodelistMapType.

Derivation:

//com:AnnotableType// (extension)

5262

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5263

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

5264

[[image:inherit.gif||height="9" width="9"]] //HybridCodelistMapBaseType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*

5273

5274

Attribute Documentation:

5275

5276

|**Name**|**Type**|**Documentation**

5277

|id|com:IDType|The id is the identifier for the object.

5278

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5279

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5280

5281

Element Documentation:

5282

5283

|**Name**|**Type**|**Documentation**

5284

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5285

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5286

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5287

5288

**HybridCodelistMapType: **HybridCodelistMapType defines the structure of a map which relates codes (possibly hierarchical) from different code lists.

Derivation:

//com:AnnotableType// (extension)

5293

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5294

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

5295

[[image:inherit.gif||height="9" width="9"]] //HybridCodelistMapBaseType// (extension)

5296

[[image:inherit.gif||height="9" width="9"]] HybridCodelistMapType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, Source, Target, HybridCodeMap+

5305

5306

Attribute Documentation:

5307

5308

|**Name**|**Type**|**Documentation**

5309

|id|com:IDType|The id is the identifier for the object.

5310

|urn|xs:anyURI|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

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5317

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5318

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5319

|Source|com: AnyCodelistReference Type|Source provides a reference to either a codelist or a hierarchical codelist, from which the codes are to be mapped.

5320

|Target|com: AnyCodelistReference Type|Target provides a reference to either a codelist or a hierarchical codelist, to which the source codes are to be mapped.

5321

|HybridCodeMap|HybridCodeMapType|HybridCodeMap defines the relationship of a code in the source list to code in the target list.

5322

5323

**HybridCodeMapType: **CodeMapType defines the structure for associating a code from a source codelist to a code in a target codelist. Note that either of these may come from a hierarchical codelist.

Derivation:

//com:AnnotableType// (extension)

5328

[[image:inherit.gif||height="9" width="9"]] HybridCodeMapType

Content:

com:Annotations?, Source, Target

5333

5334

Element Documentation:

5335

5336

|**Name**|**Type**|**Documentation**

5337

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5338

|Source|com: AnyLocalCodeReferenc eType|Source provides a local reference to the code which is to be mapped. If this code is from a hierarchical codelist, a reference to the hierarchy in which it is defined must also be provided.

5339

|Target|com: AnyLocalCodeReferenc eType|Target provides a local reference to the code to which the source code is mapped. If this code is from a hierarchical codelist, a reference to the hierarchy in which it is defined must also be provided.

5340

5341

//**StructureMapBaseType**//**: **StructureMapBaseType is an abstract base type which forms the basis for the StructureMapType.

Derivation:

//com:AnnotableType// (extension)

5346

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5347

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

5348

[[image:inherit.gif||height="9" width="9"]] //StructureMapBaseType//

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*

5357

5358

Attribute Documentation:

5359

5360

|**Name**|**Type**|**Documentation**

5361

|id|com:IDType|The id is the identifier for the object.

5362

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5363

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5364

5365

Element Documentation:

5366

5367

|**Name**|**Type**|**Documentation**

5368

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5369

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5370

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5371

5372

**StructureMapType: **StructureMapType defines the structure for mapping components of one structure to components of another structure. A structure may be referenced directly meaning the map applies wherever the structure is used, or it may be a reference via a structure usage meaning the map only applies within the context of that usage. Using the related structures, one can make extrapolations between maps. For example, if key families, A, B, and C, are all grouped in a related structures container, then a map from key family A to C and a map from key family B to C could be used to infer a relation between key family A to C.

Derivation:

//com:AnnotableType// (extension)

5377

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5378

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

5379

[[image:inherit.gif||height="9" width="9"]] //StructureMapBaseType// (extension)

5380

[[image:inherit.gif||height="9" width="9"]] StructureMapType

Attributes:

id, urn?, uri?, isExtension?

Content:

com:Annotations?, com:Name+, com:Description*, Source, Target, ComponentMap+

5389

5390

Attribute Documentation:

5391

5392

|**Name**|**Type**|**Documentation**

5393

|id|com:IDType|The id is the identifier for the object.

5394

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5395

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5396

|isExtension (default: false)|xs:boolean|The isExtension attribute, when true, indicates that the target structure definition inherits all properties of the referenced structure definition, and may have additional components. Note that this attribute may only be set to true if the structure map has a source structure and a target structure of either two key families or two metadata structure definitions. It is not possible inherit the underlying concepts of components between the two type of structures using this mechanism.

5397

5398

Element Documentation:

5399

5400

|**Name**|**Type**|**Documentation**

5401

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5402

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5403

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5404

|Source|com: StructureOrUsageRefe renceType|Source provides a reference to a structure (data or metadata) or a structure usage (dataflow or metadataflow) from which components defined by the actual structure are to mapped.

5405

|Target|com: StructureOrUsageRefe renceType|Target provides a reference to a structure (data or metadata) or a structure usage (dataflow or metadataflow) to which components from the source are to mapped.

5406

|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.

5407

5408

**ComponentMapType: **ComponentMapType defines the structure for relating a component in a source structure to a component in a target structure.

Derivation:

//com:AnnotableType// (extension)

5413

[[image:inherit.gif||height="9" width="9"]] ComponentMapType

Content:

com:Annotations?, Source, Target, RepresentationMapping?

5418

5419

Element Documentation:

5420

5421

|**Name**|**Type**|**Documentation**

5422

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5423

|Source|com: LocalComponentListCo mponentReferenceType|

5424

|Target|com: LocalComponentListCo mponentReferenceType|

5425

|RepresentationMappin g|RepresentationMapTyp e|RepresentationMapping describes the mapping rules to map the value of the source component to the target component. Note that is a representation mapping is not supplied, then the value of the source component is mapped directly to the value of the target component without any manipulation.

5426

5427

**RepresentationMapType: **RepresentationMapType describes the structure of the mapping of the value of a source to component to a target component. Either a reference to another map defined within the containing structure set or a description of the source and target text formats must be provided. Note that for key family components, only a reference to a codelist map is relevant, since that is the only type of coded representation allowed in a key family.

Content:

(CodelistMap | (ToTextFormat, ToValueType) | ValueMap)

5432

5433

Element Documentation:

5434

5435

|**Name**|**Type**|**Documentation**

5436

|CodelistMap|com: LocalCodelistMapRefe renceType|CodelistMap references a codelist map defined in the same structure set which maps the enumeration of the representation of the source component to the enumeration of the representation of the target component.

5437

|ToTextFormat|TextFormatType|ToTextFormat describes the un-coded representation of the target to which the value of the referenced component should be transformed.

5438

|ToValueType|ToValueTypeType|ToValueType notes whether the value, name, or description of the source value should be used in the target value.

5439

|ValueMap|ValueMapType|ValueMap provides for a simple mapping of a source value to a target value without having to define a codelist map. This is available to allow mappings in situations such as the source or target is not being formally coded, or the source and/or target being a measure dimension in which case its representation is not mappable from a codelist map.

5440

5441

**ValueMapType: **ValueMapType contains a collection of value mappings, which give a source and target value.

Content:

ValueMapping+

Element Documentation:

5448

5449

|**Name**|**Type**|**Documentation**

5450

|ValueMapping|ValueMappingType|ValueMapping provides a source and target value for the purpose of mapping.

5451

5452

**ValueMappingType: **ValueMappingType specifies the relationship between two values as a source and target.

Attributes:

source, target

Content:

{Empty}

Attribute Documentation:

5463

5464

|**Name**|**Type**|**Documentation**

|source|xs:string|

|target|xs:string|

//**VtlDefinitionSchemeType**//**: **VtlDefinitionSchemeType is an abstract extension of the ItemSchemeType for VTL schemes.

Derivation:

//com:AnnotableType// (extension)

5473

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5474

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

5475

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

5476

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

5477

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

5478

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)

5479

[[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType//

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion

Content:

com:Annotations?, com:Name+, com:Description*, //Item*//

5488

5489

Attribute Documentation:

5490

5491

|**Name**|**Type**|**Documentation**

5492

|id|com:IDType|The id is the identifier for the object.

5493

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5494

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5495

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

5496

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

5497

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

5498

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

5499

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

5500

|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.

5501

|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.

5502

|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.

5503

|isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint.

5504

|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.

5505

5506

Element Documentation:

5507

5508

|**Name**|**Type**|**Documentation**

5509

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5510

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5511

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5512

|//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.

5513

5514

//**TransformationSchemeBaseType**//**: **TransformationSchemeBaseType is an abstract base type for the TransformationSchemeType. It restricts the item types to be only transformations.

Derivation:

//com:AnnotableType// (extension)

5519

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5520

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

5521

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

5522

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

5523

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

5524

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)

5525

[[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)

5526

[[image:inherit.gif||height="9" width="9"]] //TransformationSchemeBaseType//

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion

Content:

com:Annotations?, com:Name+, com:Description*, Transformation*

5535

5536

Attribute Documentation:

5537

5538

|**Name**|**Type**|**Documentation**

5539

|id|com:IDType|The id is the identifier for the object.

5540

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5541

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5542

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

5543

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

5544

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

5545

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

5546

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

5547

|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.

5548

|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.

5549

|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.

5550

|isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint.

5551

|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.

5552

5553

Element Documentation:

5554

5555

|**Name**|**Type**|**Documentation**

5556

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5557

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5558

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5559

|Transformation|TransformationType|Transformation describes the details of a single transformation within a transformation scheme.

5560

5561

**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:

//com:AnnotableType// (extension)

5566

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5567

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

5568

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

5569

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

5570

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

5571

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)

5572

[[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)

5573

[[image:inherit.gif||height="9" width="9"]] //TransformationSchemeBaseType// (extension)

5574

[[image:inherit.gif||height="9" width="9"]] TransformationSchemeType

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion

Content:

com:Annotations?, com:Name+, com:Description*, Transformation*, VtlMappingScheme?, NamePersonalisationScheme?, CustomTypeScheme?, RulesetScheme*, UserDefinedOperatorScheme*

5583

5584

Attribute Documentation:

5585

5586

|**Name**|**Type**|**Documentation**

5587

|id|com:IDType|The id is the identifier for the object.

5588

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5589

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5590

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

5591

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

5592

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

5593

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

5594

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

5595

|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.

5596

|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.

5597

|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.

5598

|isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint.

5599

|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.

5600

5601

Element Documentation:

5602

5603

|**Name**|**Type**|**Documentation**

5604

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5605

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5606

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5607

|Transformation|TransformationType|Transformation describes the details of a single transformation within a transformation scheme.

5608

|VtlMappingScheme|com: VtlMappingSchemeRefe renceType|References a VTL mapping scheme which defines aliases for given SDMX artefacts that are used in the transformations as well as the mapping methods used when converting between SDMX and VTL data structures. All aliases must be defined in the referenced scheme. This also must be used if the basic mapping methods are not used.

5609

|NamePersonalisationS cheme|com: NamePersonalisationS chemeReferenceType|References a name personalisation scheme, which defines the overriding of some standard VTL names (to be assigned to some measures and/or attributes of the data structure) with some corresponding personalised names. This must be used if transformations within a transformation scheme personalise standard names. All personalisations must be defined in the referenced scheme.

5610

|CustomTypeScheme|com: CustomTypeSchemeRefe renceType|References a custom type scheme which defines custom conversions of VTL scalar types to SDMX data types. This must be used if custom type conversions are used in the transformations defined in a transformation scheme. All custom conversions must be defined in the referenced scheme.

5611

|RulesetScheme|com: RulesetSchemeReferen ceType|References a ruleset scheme that defines one or more previously defined rulesets which can be invoked by VTL operators. If a transformation defined in a transformation scheme refers to a ruleset, the scheme in which the ruleset is defined must be referenced here.

5612

|UserDefinedOperatorS cheme|com: UserDefinedOperatorS chemeReferenceType|References a user defined operator scheme that defines one or more user defined operators used by the transformations defined in a transformation scheme. If a transformation in a transformation scheme refers to a user defined operator, the scheme in which the user defined operator is defined must be referenced here.

5613

5614

**TransformationType: **TransformationType defines the structure of a transformation. A transformation is an assignment of a VTL expression to a specific result.

Derivation:

//com:AnnotableType// (extension)

5619

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5620

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

5621

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

5622

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

5623

[[image:inherit.gif||height="9" width="9"]] //UnnestedItemType// (extension)

5624

[[image:inherit.gif||height="9" width="9"]] TransformationType

Attributes:

id, urn?, uri?, isPersistent

Content:

com:Annotations?, com:Name+, com:Description*, Expression, Result

5633

5634

Attribute Documentation:

5635

5636

|**Name**|**Type**|**Documentation**

5637

|id|com:IDType|The id is the identifier for the object.

5638

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5639

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5640

|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.

5641

5642

Element Documentation:

5643

5644

|**Name**|**Type**|**Documentation**

5645

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5646

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5647

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5648

|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").

5649

|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").

5650

5651

**VtlMappingSchemeType: **VtlMappingSchemeType defines a set of mappings between SDMX and VTL.

Derivation:

//com:AnnotableType// (extension)

5656

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5657

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

5658

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

5659

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

5660

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

5661

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (restriction)

5662

[[image:inherit.gif||height="9" width="9"]] VtlMappingSchemeType

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?

Content:

com:Annotations?, com:Name+, com:Description*, VtlMapping*

5671

5672

Attribute Documentation:

5673

5674

|**Name**|**Type**|**Documentation**

5675

|id|com:IDType|The id is the identifier for the object.

5676

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5677

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5678

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

5679

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

5680

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

5681

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

5682

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

5683

|isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.

5684

|serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.

5685

|structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.

5686

|isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint.

5687

5688

Element Documentation:

5689

5690

|**Name**|**Type**|**Documentation**

5691

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5692

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5693

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5694

|VtlMapping|VtlMappingType|VtlMapping details a mapping between SDMX and VTL transformation.

5695

5696

**VtlMappingType: **VtlMappingType defines the structure of a single mapping between the reference to a SDMX artefact made from VTL transformations, rulesets, user defined operators and the corresponding SDMX structure identifier. These are used to assign an alternative names to SDMX Dataflows, Codelists, Concept Schemes, or Concepts. Although are distinct sub-classes in the Information Model, this structure serves to express them all. The references SDMX artefact serves to distinguish which type of sub-class (VtlDatflowMapping, VtlCodelistMapping, or VtlConceptSchemeMapping) is being described. When this is used to assign an alias for a SDMX Dataflow, this can also be used to indicate the methods used to convert the data structure from SDMX to VTL and vice-versa. Finally, this can be used to override the deault Basic mapping methods used for Dataflows by utilizing the GenericDataflow element in place of a reference to a specific Dataflow.

Derivation:

//com:AnnotableType// (extension)

5701

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5702

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

5703

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

5704

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

5705

[[image:inherit.gif||height="9" width="9"]] //UnnestedItemType// (extension)

5706

[[image:inherit.gif||height="9" width="9"]] VtlMappingType

Attributes:

id, urn?, uri?, alias

Content:

com:Annotations?, com:Name+, com:Description*, ( ( (Dataflow | GenericDataflow), ToVtlMapping?, FromVtlMapping?) | Codelist | ConceptScheme | Concept)

5715

5716

Attribute Documentation:

5717

5718

|**Name**|**Type**|**Documentation**

5719

|id|com:IDType|The id is the identifier for the object.

5720

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5721

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5722

|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.

5723

5724

Element Documentation:

5725

5726

|**Name**|**Type**|**Documentation**

5727

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5728

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5729

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5730

|Dataflow|com: DataflowReferenceTyp e|A reference to the SDMX Dataflow that the mapping is defined for. This is used to create a VtlDataflowMapping. In this case, it is possible to specify the mapping details to and from VTL.

5731

|GenericDataflow|com:EmptyType|Indicates that the ToVtlMapping and FromVtlMapping are the default mapping methods to be applied, overriding the Basic methods if necessary. The mapping methods in this case would be applied to any dataflows that are not explicitly defined in other VtlMappings.

5732

|ToVtlMapping|ToVtlMappingType|Describes the mapping from a SDMX dataflow to a VTL data structure.

5733

|FromVtlMapping|FromVtlMappingType|Describes the mapping to a SDMX dataflow from a VTL data structure.

5734

|Codelist|com: CodelistReferenceTyp e|A reference to the SDMX Codelist that the mapping is defined for. This is used to create a VtlCodelistMapping.

5735

|ConceptScheme|com: ConceptSchemeReferen ceType|A reference to the SDMX Concept Scheme that the mapping is defined for. This is used to create a VtlConceptSchemeMapping.

5736

|Concept|com: ConceptReferenceType|A reference to the SDMX Concept that the mapping is defined for. This is used to create a VtlConceptMapping.

5737

5738

**ToVtlMappingType: **ToVtlMappingType defines the mapping method and filter used when mapping from SDMX to VTL.

Attributes:

method?

Content:

ToVtlSubSpace?

Attribute Documentation:

5749

5750

|**Name**|**Type**|**Documentation**

5751

|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.

5752

5753

Element Documentation:

5754

5755

|**Name**|**Type**|**Documentation**

5756

|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.

5757

5758

**FromVtlMappingType: **FromVtlMappingType defines the mapping method and filter used when mapping from VTL to SDMX.

Attributes:

method?

Content:

FromVtlSuperSpace?

Attribute Documentation:

5769

5770

|**Name**|**Type**|**Documentation**

5771

|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.

5772

5773

Element Documentation:

5774

5775

|**Name**|**Type**|**Documentation**

5776

|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.

5777

5778

**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:

5785

5786

|**Name**|**Type**|**Documentation**

5787

|Key|com: SingleNCNameIDType|A reference to a dimension by its identifier.

5788

5789

**NamePersonalisationSchemeType: **NamePersonalisationSchemeType defines a set of personalisations of VTL standard names that are used in a set of transformations.

Derivation:

//com:AnnotableType// (extension)

5794

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5795

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

5796

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

5797

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

5798

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

5799

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)

5800

[[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)

5801

[[image:inherit.gif||height="9" width="9"]] NamePersonalisationSchemeType

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion

Content:

com:Annotations?, com:Name+, com:Description*, NamePersonalisation*

5810

5811

Attribute Documentation:

5812

5813

|**Name**|**Type**|**Documentation**

5814

|id|com:IDType|The id is the identifier for the object.

5815

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5816

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5817

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

5818

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

5819

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

5820

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

5821

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

5822

|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.

5823

|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.

5824

|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.

5825

|isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint.

5826

|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.

5827

5828

Element Documentation:

5829

5830

|**Name**|**Type**|**Documentation**

5831

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5832

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5833

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5834

|NamePersonalisation|NamePersonalisationT ype|NamePersonalisation details a name personalisation that is used in a transformation.

5835

5836

**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:

//com:AnnotableType// (extension)

5841

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5842

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

5843

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

5844

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

5845

[[image:inherit.gif||height="9" width="9"]] //UnnestedItemType// (extension)

5846

[[image:inherit.gif||height="9" width="9"]] NamePersonalisationType

Attributes:

id, urn?, uri?, vtlArtefact

Content:

com:Annotations?, com:Name+, com:Description*, VtlDefaultName, PersonalisedName

5855

5856

Attribute Documentation:

5857

5858

|**Name**|**Type**|**Documentation**

5859

|id|com:IDType|The id is the identifier for the object.

5860

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5861

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5862

|vtlArtefact|xs:string|Identifies the type of VTL model artefact that is being personalised. In VTL 2.0, this is valuedomain or variable.

5863

5864

Element Documentation:

5865

5866

|**Name**|**Type**|**Documentation**

5867

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5868

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5869

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5870

|VtlDefaultName|xs:string|Provides the VTL standard name that is being personalised.

5871

|PersonalisedName|xs:string|Provides the personalised name that is used in place of the VTL standard name in the transformation expressions.

5872

5873

//**RulesetSchemeBaseType**//**: **RulesetSchemeBaseType is an abstract base type for the RulesetSchemeType. It restricts the item types to be only rulesets.

Derivation:

//com:AnnotableType// (extension)

5878

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5879

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

5880

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

5881

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

5882

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

5883

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)

5884

[[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)

5885

[[image:inherit.gif||height="9" width="9"]] //RulesetSchemeBaseType//

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion

Content:

com:Annotations?, com:Name+, com:Description*, Ruleset*

5894

5895

Attribute Documentation:

5896

5897

|**Name**|**Type**|**Documentation**

5898

|id|com:IDType|The id is the identifier for the object.

5899

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5900

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5901

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

5902

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

5903

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

5904

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

5905

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

5906

|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.

5907

|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.

5908

|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.

5909

|isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint.

5910

|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.

5911

5912

Element Documentation:

5913

5914

|**Name**|**Type**|**Documentation**

5915

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5916

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5917

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5918

|Ruleset|RulesetType|Ruleset details a ruleset within a ruleset scheme.

5919

5920

**RulesetSchemeType: **RulesetSchemeType defines a collection of rulesets that are used in transformations.

Derivation:

//com:AnnotableType// (extension)

5925

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5926

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

5927

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

5928

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

5929

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

5930

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)

5931

[[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)

5932

[[image:inherit.gif||height="9" width="9"]] //RulesetSchemeBaseType// (extension)

5933

[[image:inherit.gif||height="9" width="9"]] RulesetSchemeType

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion

Content:

com:Annotations?, com:Name+, com:Description*, Ruleset*, VtlMappingScheme?

5942

5943

Attribute Documentation:

5944

5945

|**Name**|**Type**|**Documentation**

5946

|id|com:IDType|The id is the identifier for the object.

5947

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5948

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5949

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

5950

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

5951

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

5952

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

5953

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

5954

|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.

5955

|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.

5956

|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.

5957

|isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint.

5958

|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.

5959

5960

Element Documentation:

5961

5962

|**Name**|**Type**|**Documentation**

5963

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

5964

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

5965

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

5966

|Ruleset|RulesetType|Ruleset details a ruleset within a ruleset scheme.

5967

|VtlMappingScheme|com: VtlMappingSchemeRefe renceType|References a VTL mapping scheme which defines aliases for given SDMX artefacts that are used in the rulesets. Rulesets defined on value domains reference Codelists or Concept Schemes (the latter in VTL are considered as the Value Domains of the variables corresponding to the SDMX Measure Dimensions). The rulesets defined on variables reference Concepts (for which a definite representation is assumed). Therefore, a ruleset should only refer to Codelists, Concept Schemes, and Concepts.

5968

5969

**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:

//com:AnnotableType// (extension)

5974

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

5975

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

5976

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

5977

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

5978

[[image:inherit.gif||height="9" width="9"]] //UnnestedItemType// (extension)

5979

[[image:inherit.gif||height="9" width="9"]] RulesetType

Attributes:

id, urn?, uri?, rulesetType, rulesetScope

Content:

com:Annotations?, com:Name+, com:Description*, RulesetDefinition

5988

5989

Attribute Documentation:

5990

5991

|**Name**|**Type**|**Documentation**

5992

|id|com:IDType|The id is the identifier for the object.

5993

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

5994

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

5995

|rulesetType|xs:string|The VTL type of the ruleset. In VTL 2.0, this is datapoint or hierarchical

5996

|rulesetScope|xs:string|This model artefact on which the ruleset is defined. In VTL 2.0, this is value domain or variable.

5997

5998

Element Documentation:

5999

6000

|**Name**|**Type**|**Documentation**

6001

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

6002

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

6003

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

6004

|RulesetDefinition|xs:string|A VTL statement for the definition of a ruleset. This must conform to the syntax of the VTL definition language.

6005

6006

//**UserDefinedOperatorSchemeBaseType**//**: **UserDefinedOperatorSchemeBaseType is an abstract base type for the UserDefinedOperatorSchemeType. It restricts the item types to be only user defined operators.

Derivation:

//com:AnnotableType// (extension)

6011

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

6012

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

6013

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

6014

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

6015

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

6016

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)

6017

[[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)

6018

[[image:inherit.gif||height="9" width="9"]] //UserDefinedOperatorSchemeBaseType//

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion

Content:

com:Annotations?, com:Name+, com:Description*, UserDefinedOperator*

6027

6028

Attribute Documentation:

6029

6030

|**Name**|**Type**|**Documentation**

6031

|id|com:IDType|The id is the identifier for the object.

6032

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

6033

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

6034

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

6035

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

6036

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

6037

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

6038

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

6039

|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.

6040

|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.

6041

|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.

6042

|isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint.

6043

|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.

6044

6045

Element Documentation:

6046

6047

|**Name**|**Type**|**Documentation**

6048

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

6049

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

6050

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

6051

|UserDefinedOperator|UserDefinedOperatorT ype|UserDefinedOperator details a user defined operators within a user defined operator scheme.

6052

6053

**UserDefinedOperatorSchemeType: **UserDefinedOperatorSchemeType defines a collection of user defined operators that are used in transformations.

Derivation:

//com:AnnotableType// (extension)

6058

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

6059

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

6060

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

6061

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

6062

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

6063

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)

6064

[[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)

6065

[[image:inherit.gif||height="9" width="9"]] //UserDefinedOperatorSchemeBaseType// (extension)

6066

[[image:inherit.gif||height="9" width="9"]] UserDefinedOperatorSchemeType

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion

Content:

com:Annotations?, com:Name+, com:Description*, UserDefinedOperator*, VtlMappingScheme?, RulesetScheme*

6075

6076

Attribute Documentation:

6077

6078

|**Name**|**Type**|**Documentation**

6079

|id|com:IDType|The id is the identifier for the object.

6080

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

6081

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

6082

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

6083

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

6084

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

6085

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

6086

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

6087

|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.

6088

|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.

6089

|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.

6090

|isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint.

6091

|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.

6092

6093

Element Documentation:

6094

6095

|**Name**|**Type**|**Documentation**

6096

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

6097

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

6098

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

6099

|UserDefinedOperator|UserDefinedOperatorT ype|UserDefinedOperator details a user defined operators within a user defined operator scheme.

6100

|VtlMappingScheme|com: VtlMappingSchemeRefe renceType|References a VTL mapping scheme which defines aliases for given SDMX artefacts that are used in the user defined operators. Although the VTL user defined operators are conceived to be defined on generic operands, so that the specific artefacts to be manipulated are passed as parameters at the invocation, it is also possible that they reference specific SDMX artefacts like Dataflows, Codelists and ConceptSchemes. In this case, the mapping schemes referenced here define the mappings to those artefacts.

6101

|RulesetScheme|com: RulesetSchemeReferen ceType|References a ruleset scheme defining rulesets utilized in the user defined operators.

6102

6103

**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:

//com:AnnotableType// (extension)

6108

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

6109

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

6110

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

6111

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

6112

[[image:inherit.gif||height="9" width="9"]] //UnnestedItemType// (extension)

6113

[[image:inherit.gif||height="9" width="9"]] UserDefinedOperatorType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, OperatorDefinition

6122

6123

Attribute Documentation:

6124

6125

|**Name**|**Type**|**Documentation**

6126

|id|com:IDType|The id is the identifier for the object.

6127

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

6128

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

6129

6130

Element Documentation:

6131

6132

|**Name**|**Type**|**Documentation**

6133

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

6134

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

6135

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

6136

|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.

6137

6138

**CustomTypeSchemeType: **CustomTypeSchemeType defines a collection of custom types that are used in transformations.

Derivation:

//com:AnnotableType// (extension)

6143

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

6144

[[image:inherit.gif||height="9" width="9"]] //NameableType// (extension)

6145

[[image:inherit.gif||height="9" width="9"]] //VersionableType// (restriction)

6146

[[image:inherit.gif||height="9" width="9"]] //MaintainableBaseType// (extension)

6147

[[image:inherit.gif||height="9" width="9"]] //MaintainableType// (extension)

6148

[[image:inherit.gif||height="9" width="9"]] //ItemSchemeType// (extension)

6149

[[image:inherit.gif||height="9" width="9"]] //VtlDefinitionSchemeType// (restriction)

6150

[[image:inherit.gif||height="9" width="9"]] CustomTypeSchemeType

Attributes:

id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isFinal?, isExternalReference?, serviceURL?, structureURL?, isPartial?, vtlVersion

Content:

com:Annotations?, com:Name+, com:Description*, CustomType*

6159

6160

Attribute Documentation:

6161

6162

|**Name**|**Type**|**Documentation**

6163

|id|com:IDType|The id is the identifier for the object.

6164

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

6165

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

6166

|version (default: 1.0)|com:VersionType|This version attribute holds a version number in the format of #[.#]+ (see common:VersionType definition for details). If not supplied, the version number is defaulted to 1.0.

6167

|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.

6168

|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.

6169

|agencyID|com: NestedNCNameIDType|The agencyID must be provided, and identifies the maintenance agency of the object.

6170

|isFinal (default: false)|xs:boolean|The isFinal attribute indicates whether the object is unchangeable without versioning. If the value is true, the object must be versioned upon change. If the final attribute is not supplied, then the object is assumed not to be final. Note that all production objects must be final.

6171

|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.

6172

|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.

6173

|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.

6174

|isPartial (default: false)|xs:boolean|The isPartial, if true, indicates that only the relevant portion of the item scheme is being communicated. This is used in cases where a codelist is returned for a key family in the context of a constraint.

6175

|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.

6176

6177

Element Documentation:

6178

6179

|**Name**|**Type**|**Documentation**

6180

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

6181

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

6182

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

6183

|CustomType|CustomTypeType|CustomType details a custom type within a custom type scheme.

6184

6185

**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:

//com:AnnotableType// (extension)

6190

[[image:inherit.gif||height="9" width="9"]] //IdentifiableType// (extension)

6191

[[image:inherit.gif||height="9" width="9"]] //NameableType// (restriction)

6192

[[image:inherit.gif||height="9" width="9"]] //ItemBaseType// (extension)

6193

[[image:inherit.gif||height="9" width="9"]] //ItemType// (restriction)

6194

[[image:inherit.gif||height="9" width="9"]] //UnnestedItemType// (extension)

6195

[[image:inherit.gif||height="9" width="9"]] CustomTypeType

Attributes:

id, urn?, uri?

Content:

com:Annotations?, com:Name+, com:Description*, VtlScalarType, DataType, VtlLiteralFormat?, OutputFormat?, NullValue?

6204

6205

Attribute Documentation:

6206

6207

|**Name**|**Type**|**Documentation**

6208

|id|com:IDType|The id is the identifier for the object.

6209

|urn|xs:anyURI|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).

6210

|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.

6211

6212

Element Documentation:

6213

6214

|**Name**|**Type**|**Documentation**

6215

|com:Annotations|com:AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.

6216

|com:Name|com:TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.

6217

|com:Description|com:TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.

6218

|VtlScalarType|xs:string|Identifies the VTL scalar type that is to be converted to an resulting output data type.

6219

|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.

6220

|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.

6221

|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.

6222

|NullValue|xs:string|The value to be produced in the output of the conversion when a component has a null value.

6223

6224

=== {{id name="__RefHeading___Toc46735784"/}}2.1.4Simple Types ===

6225

6226

**UsageStatusType: **UsageStatusType provides a list of enumerated types for indicating whether reporting a given attribute is mandatory or conditional.

6227

6228

Derived by restriction of xs:NMTOKEN .

Enumerations:

|**Value**|**Documentation**

6233

|Mandatory|Reporting the associated attribute is mandatory - a value must be supplied.

6234

|Conditional|Reporting the associated attribute is not mandatory - a value may be supplied, but is not required.

6235

6236

**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.

6237

6238

Derived by restriction of com:SimpleDataType .

Enumerations:

|**Value**|**Documentation**

6243

|String|A string datatype corresponding to W3C XML Schema's xs:string datatype.

6244

|Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.

6245

|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.

6246

|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.

6247

|BigInteger|An integer datatype corresponding to W3C XML Schema's xs:integer datatype.

6248

|Integer|An integer datatype corresponding to W3C XML Schema's xs:int datatype.

6249

|Long|A numeric datatype corresponding to W3C XML Schema's xs:long datatype.

6250

|Short|A numeric datatype corresponding to W3C XML Schema's xs:short datatype.

6251

|Boolean|A datatype corresponding to W3C XML Schema's xs:boolean datatype.

6252

|URI|A datatype corresponding to W3C XML Schema's xs:anyURI datatype.

6253

|Count|A simple incrementing Integer type. The isSequence facet must be set to true, and the interval facet must be set to "1".

6254

|InclusiveValueRange|This value indicates that the startValue and endValue attributes provide the inclusive boundaries of a numeric range of type xs:decimal.

6255

|ExclusiveValueRange|This value indicates that the startValue and endValue attributes provide the exclusive boundaries of a numeric range, of type xs:decimal.

6256

|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.

6257

|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.

6258

|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.

6259

|BasicTimePeriod|BasicTimePeriod time periods is a superset of the Gregorian time periods and a date time.

6260

|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.

6261

|GregorianYear|A Gregorian time period corresponding to W3C XML Schema's xs:gYear datatype, which is based on ISO-8601.

6262

|GregorianYearMonth|A time datatype corresponding to W3C XML Schema's xs:gYearMonth datatype, which is based on ISO-8601.

6263

|GregorianDay|A time datatype corresponding to W3C XML Schema's xs:date datatype, which is based on ISO-8601.

6264

|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.

6265

|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.

6266

|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.

6267

|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.

6268

|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.

6269

|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.

6270

|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.

6271

|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.

6272

|Month|A time datatype corresponding to W3C XML Schema's xs:gMonth datatype.

6273

|MonthDay|A time datatype corresponding to W3C XML Schema's xs:gMonthDay datatype.

6274

|Day|A time datatype corresponding to W3C XML Schema's xs:gDay datatype.

6275

|Duration|A time datatype corresponding to W3C XML Schema's xs:duration datatype.

6276

6277

**SimpleCodeDataType: **SimpleCodeDataType restricts SimpleDataType to specify the allowable data types for a simple code. The possible values are simply Alpha, AlphaNumeric, or Numeric.

6278

6279

Derived by restriction of com:SimpleDataType .

Enumerations:

|**Value**|**Documentation**

6284

|Alpha|A string datatype which only allows for the simple aplhabetic charcter set of A-Z, a-z.

6285

|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.

6286

|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.

6287

6288

**TargetObjectDataType: **TargetObjectDataType restricts DataType to specify the allowable data types for representing a target object value.

6289

6290

Derived by restriction of com:DataType .

Enumerations:

|**Value**|**Documentation**

6295

|KeyValues|This value indicates that the content of the component will be data key (a set of dimension references and values for the dimensions).

6296

|IdentifiableReference|This value indicates that the content of the component will be complete reference (either URN or full set of reference fields) to an Identifiable object in the SDMX Information Model.

6297

|DataSetReference|This value indicates that the content of the component will be reference to a data provider, which is actually a formal reference to a data provider and a data set identifier value.

6298

|AttachmentConstraintReference|This value indicates that the content of the component will be reference to an attachment constraint, which is actually a combination of a collection of full or partial key values and a reference to a data set or data structure, usage, or provision agreement.

6299

6300

**ToValueTypeType: **ToValueTypeType provides an enumeration of available text-equivalents for translation of coded values into textual formats.

6301

6302

Derived by restriction of xs:NMTOKEN .

Enumerations:

|**Value**|**Documentation**

6307

|Value|Code or other tokenized value, as provided in the representation scheme.

6308

|Name|The human-readable name of the Value, as provided in the representation scheme.

6309

|Description|The human-readable description of the Value, as provided in the representation scheme.

6310

6311

**StandardToVtlMappingMethodType: **A simple type enumerating the standard mapping methods when converting from data structures from SDMX to VLT.

6312

6313

Derived by restriction of xs:string .

Enumerations:

|**Value**|**Documentation**

6318

|Basic|The default mapping method. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.1 ("Basic Mapping").

6319

|Pivot|Method for mapping multi-measure data. See Section 6 SDMX Standards ("SDMX Technical Notes"), 10.3.3.2 ("Pivot Mapping").

6320

|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").

6321

|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").

6322

6323

**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.

6328

6329

**StandardFromVtlMappingMethodType: **A simple type enumerating the standard mapping methods when converting from data structures from VTL to SDMX.

6330

6331

Derived by restriction of xs:string .

Enumerations:

|**Value**|**Documentation**

6336

|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").

6337

|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").

6338

|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").

6339

6340

**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.

6345

6346

**CustomTypeDataType: **A simple type that allows for a SDMX simple data type enumeration value or a string value for other data types.

6347

6348

Union of: