Interoperability Basis Platform

= DOCUMENT HISTORY =

6

7

|**Version**|**Date**|**Comment**

8

|1.0|01/03/2021|Initial version.

9

|2.0|24/04/2025|Adapted to SDMX 3.0. Extensions to controlled vocabulary. Clarified text.

= Introduction =

According to the SDMX documentation, the Annotation is a construct that contains user or organisation-specific metadata. The Annotation construct in SDMX is available to most of the SDMX structural metadata artefacts. This facility is essentially a flexible extension mechanism allowing metadata to be added to an SDMX structural artefact. Annotations are often used to store metadata in artefacts when there is no specific place for that information in the SDMX information model. Presentation metadata is a prime example, such as a default presentation for a dataflow.

14

15

Note that whilst the SDMX Annotation has a specific structure (Title, Type, URL, Text) individual organisations are free to use these in any way and any combination they wish. However, an Annotation can only be processed in a meaningful way (i.e. other than viewing it) by systems that understand its semantics.

16

17

The main advantage of the Annotation is its flexibility as all properties can be tailor-made and there is no limit to their number. This can prove very useful for specific applications, such as dissemination tools. The main drawback is poor interoperability as Annotations convey no semantics and are not standardised. This means that organisations that want to exchange Annotations and process them automatically must agree upon, at least, a common naming syntax.

18

19

The aim of this guideline is to improve machine interactions by proposing a controlled vocabulary for the Type property of the SDMX Annotation construct and a recommended usage for the other properties that will greatly improve the interoperability of Annotations between SDMX-compliant organisations.

20

21

The Controlled Vocabulary referred to above will be maintained as a SDMX Concept Scheme stored in the SDMX Global Repository.

22

23

= SDMX Information Model for the Annotation construct =

=== SDMX 2.1 ===

[[image:1768507168026-558.png]]

28

29

All classes derived from the abstract class AnnotableArtefact may have Annotations. The Annotation is used to convey extra information to describe SDMX constructs. This information may be in the form of a URL reference, a non-localised text, and/or multiple localised texts (represented by the one-to-many relationship to LocalisedString).

=== SDMX 3.0 ===

|(((

|(((

)))

)))

[[image:1768507168030-780.png]]

41

42

The URL can be localised which gives the advantage of linking to different resources depending on the language. It also removes the complexity of having to use AnnotationText in SDMX 2.1 to do this.

43

44

= Properties of the Annotation construct =

45

46

The properties of the Annotation construct are listed below. This information is taken from the [[SDMX official technical documentation>>url:https://sdmx.org/?page_id=5008]].

47

48

|**Property**|**Description**|**Controlled vocabulary context**

49

|**id**|Identifier for the Annotation. It can be used to disambiguate one Annotation from another where there are several Annotations for the same annotated object.|Id is set to @SDMX to identify it as part of the controlled vocabulary

50

|**title**|A title used to identify an Annotation.|A non-localised value for the annotation. Used when localisation is irrelevant.

51

|**type**|(((

52

Specifies how the Annotation is to be processed.

53

54

The **type** is often used as the usage context of the Annotation. The types are not enumerated[[~[1~]>>path:#_ftn1]], as these can be specified by the Annotation creator. The definitions and use of Annotation types should be documented by their creator.

55

)))|Identifies the usage (e.g. images are type IMAGE) of the annotation. The type values are enumerated in the controlled vocabulary table.

56

|**url**|(((

57

A link to external descriptive text.

58

59

The **url** is a URI - typically a URL - which points to a resource. If a specific behaviour is desired, an Annotation type should be defined which specifies the use of this field more exactly.

60

)))|A non-localised URL reference to an external resource. Used when localisation is irrelevant.

61

|**+url**|**SDMX 3.0 and later**. An annotation may have several localised URLs|A localised URL reference to an external resource.

62

|**+text**|(((

63

An International String that provides the multilingual text content of the Annotation.

64

65

**Text** holds a language-specific string containing the text of the Annotation.

66

)))|A localised value for the annotation.

67

68

= Introducing Standard Annotations =

69

70

As stated earlier, a major drawback of the Annotation construct is the fact that they are not standardised for reuse when exchanging structural metadata. Annotations are containers for additional information relating to the object to which they are attached. This means that for an Annotation to be interpreted in the same way by exchange partners, a reference is needed that defines some standard behaviour and implementation.

71

72

This guideline proposes an Annotation controlled vocabulary and guidelines on their (re)use for SDMX implementers.

73

74

A standard Annotation can be defined as an Annotation that has an agreed definition in the SDMX community. Some of them, especially the general and display-related annotations also have a described behaviour. They allow diverse systems to parse the information and perform a specific action in response.

75

76

= How to Identify Standard Annotations? =

77

78

In order to be able to configure their applications to implement actions based upon standard Annotations, systems must know how to identify such Annotations. This is done by setting the Annotation **id** property to “@SDMX” which indicates that the Annotation is part of the controlled vocabulary described in the section List of Standard Annotations, and avoids using “@SDMX” for other usage contexts. For example, ORDER could be the order of codes (as described in this controlled vocabulary) or some kind of order number (a different usage).

79

80

The additional mandatory information to be provided is the **type** property that specifies the type of action to be implemented. There may be other mandatory property values depending on the type of the standard Annotation.

== Examples ==

The green columns in the table below show example usages of standard Annotations. The orange “ORDER” column is not a standard Annotation because the usage context is not the same as the standard Annotation “ORDER”, therefore the **id** should not be “@SDMX”.

**Not @SDMX**

This is a “customer order no.” which is a different use case than the ORDER standard Annotation which is a list order

90

)))

91

|**title**| | | |1934245

|fr :20

~* denotes a mandatory information for standard Annotations

97

98

= The Business value of Standard Annotations =

99

100

The following diagram explains the business value and decision process when deciding whether to use a standard Annotation. As can be seen, if they are used then a maximum reuse is made of the Annotation itself, tools and processes. If they are not used then bespoke Annotations, agreements, tools and processing are required to understand and make use of the information in the Annotation, and it (plus supporting tools, processes, etc.) is harder to reuse.

101

102

[[image:1768507168033-962.png]]

103

104

= List of Standard Annotations =

105

106

This section lists the standard Annotations with their typical usage contexts. This list will be expanded over time as new implementations and needs arise. When references to external standards are made (e.g. skos or xkos specifications), the reader is invited to consult the “References” section for more information.

107

108

The list of standard Annotations will be available from the SDMX Registry as artefact: SDMX:CS_ANNOT(*.*.*). Link: [[https:~~/~~/registry.sdmx.org/ws/public/sdmxapi/rest/conceptscheme/SDMX/CS_ANNOT/latest/?format=sdmx-2.1&detail=full&references=none>>url:https://registry.sdmx.org/ws/public/sdmxapi/rest/conceptscheme/SDMX/CS_ANNOT/latest/?format=sdmx-2.1&detail=full&references=none]]

109

110

**Note:** There are several Annotations that are types of name or label, e.g. FULL_NAME, SHORT_LABEL, ORIGINAL_LABEL. These Annotations have specific use cases that are described in the tables below and should not be used to replace an artefact’s or item scheme item’s Name and Description property.

111

112

== Relationships between Annotation properties ==

113

114

==== Text value defaults and specific locale values ====

115

116

Some use cases may benefit from having a single, default value for all locales/languages but also to set the value for certain locales. An example is ORDER where there may be a default list order for all locales but two locales have a specific order which is different from the default. In order to avoid having to state an order for every locale, the Annotation Title property may be used to state the default value, whereas the text property is used for the localised values.

117

118

Consider this annotation //Example~:// An ORDER annotation type that is attached to a code item ACME. If both the Annotation Text and Annotation Title have values, then the Annotation Text value (e.g. en:10,es:20) is used for the localized values instead of the Annotation Title (e.g. 30) which would only be taken if the locale in the context is not found among the specified ones.

119

120

==== URL value defaults and specific locale values ====

121

122

===== SDMX 2.1 and earlier =====

123

124

In SDMX 2.1, the Annotation’s URL property is a single, non-localised value. There may be cases where different URLs are required for certain locales. In this case, it is recommended to use the Annotation text property and state the language and URL in an HTML fragment, for example:

125

126

fr:<a href=”https:~/~/someLink”>

127

128

When both a URL and text property for the locale exists, the text property overrides (is used instead of) the URL property.

129

130

===== SDMX 3.0 and later =====

131

132

Multiple URL localised properties were introduced in SDMX 3.0. Therefore, the URL work-around in the above paragraph is not recommended. The URL property should be used as shown in the table.

133

134

135

== General and Display-related Annotation types ==

136

137

|Annotation Type|Use Case|Where to attach|(((

+Text

Blue is optional

)))|(((

Title

Blue is optional

)))|(((

SDMX 2.1:URL

SDMX >=3.0:+URL

Blue is optional

)))

|FULL_NAME|Alternative name to be displayed for items in Item Schemes (e.g. Codelists, Concept Schemes, Category Schemes) whenever the item is displayed without its parent. For example, if a code list that has a hierarchy is displayed as a flat list, then this annotation may be used to provide sufficient context for the code. Concatenation of code + heading in NACE Rev.2.1

153

en: A0123 Growing of citrus fruits|Item in an Item Scheme|(((

154

<language>:<content>,

155

156

<language>:<content>,…

//Example~://

en:Labour force (Employment)

)))|<content>|

//Example~://

CUST_BREAKDOWN:CUST_BREAKDOWN_LB

)))|

//Example~://

REF_AREA:M49_CODE

)))|

|COMPLEMENT|(((

Additional fixed text to be displayed in parenthesis after the code name.

178

179

E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes

180

en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW)

181

en: 01 03 99 wastes not otherwise specified (NHAZW)

182

)))|Item in an Item Scheme|(((

183

<language>:<content>,

184

185

<language>:<content>,…

//Example~://

en:See reference metadata

190

)))|<content>|

191

|ORDER|Explicit indication of a localised order of items in Items Schemes or artefacts (e.g. Codelist, Concept Scheme, Category Scheme, Dataflow, etc.)|(((

Either:

* an artefact, or;

* an item in an Item Scheme

196

)))|(((

197

<language>:<content>,

198

199

<language>:<content>,…

//Example~://

en:10,es:20

)))|(((

)))|

|TOTAL|(((

Code Item that represents a total value. If the attachment is:

211

212

* to a Code, the Annotation Text is optional and may contain an explanatory text;

213

214

to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total

)))|(((

Either:

* a Code Item that represents a total value, or;

219

* a Codelist to specify the code(s) with the total

220

)))|(((

221

<language>:<explanatory text>,

222

223

<language>:<explanatory text>,…

224

)))|(((

225

Attached to Code Item: <blank>

226

227

Attached to Codelist: <code>,<code>,…

228

)))|

229

|DRILLDOWN|Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|(((

Either:

* A Dataflow or DSD

)))| |(((

//Example~://

DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below)

239

)))|

240

|DEPRECATED|(((

241

Indication that an Item in an Item Scheme or an artefact is deprecated.

242

243

For an item scheme item, the annotation value provides a replacement name for the code name.

244

245

For an artefact, the URL points to the replacement artefact. May be used in conjunction with SUPERSEED where the replacement artefact references the replaced artefact.

246

247

Suggestion to use a controlled vocabulary

248

249

url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/CURRENT>>url:http://publications.europa.eu/resource/authority/concept-status/CURRENT]]>

250

url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/DEPRECATED>>url:http://publications.europa.eu/resource/authority/concept-status/DEPRECATED]]>

or

TITLE: true (false)

)))|(((

Either:

* an artefact, or;

* an item in an Item Scheme

260

)))|(((

261

For item scheme item:

262

263

<language>:<content>,

264

265

<language>:<content>,…

//Example~://

en:deprecated,fr:obsolète

)))|<content>|(((

For artefact:

)))

|DEFAULT|(((

Indication that an item in an Item Scheme or artefacts is to be selected by default.

279

280

The Annotation defines a selection so that a pre-defined default subset of data can be processed (e.g. visualised, extracted) instead of the entire dataset

281

)))|(((

282

* Item in ItemScheme, or;

* DSD, or;

* a Dataflow

Note: A DEFAULT Annotation attached to a later level in this list supersedes that attached to an earlier level. E.g., a DEFAULT Annotation attached to individual Codes in Codelists is only to be used when there is no DEFAULT Annotation attached to the Dataflow nor to the DSD, and those of DSDs are only to be used when there is no DEFAULT Annotation attached to the Dataflow.

)))| |(((

Attached to:

- DSD or Dataflow:

**<concept>=<code>+<code>+…,<concept>=<code>+<code>+…**

292

293

//Example~:// FREQ=A+Q,TIME_PERIOD_START=2013-01,TIME_PERIOD_END=2018-12

294

)))|

295

|IMAGE|A visual identity to associate to Item Scheme Items or artefacts|(((

Either:

* an artefact, or;

* an item in an item scheme

300

)))|(((

301

For localised content in SDMX 2.1

302

303

<language>:<HTML containing URL to the resource>,

304

305

<language>:<HTML containing URL to the resource>,…

//Example~://

en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”>

310

)))| |(((

311

See section URL value defaults and specific locale values.

//Example~://

https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg

)))

<concept Id>,<concept Id>,…

Example :

DONOR,RECIPIENT,YEAR,PROJECT_ID,OBS_VALUE,DESCRIPTION,OWNER

325

)))|

326

|NOT_DISPLAYED|Used to hide components or their values in the presentation|(((

327

Either:

328

329

* a Dataflow or DSD, or;

330

* an Item in an Item Scheme

331

)))| |(((

332

Attached to Item in Item Scheme: <blank>

333

334

Attached to Dataflow or DSD:

335

336

<concept Id>,<concept Id>,…

Example :

DD_DIM (to hide drilldown control concept)

341

)))|

342

|LAYOUT_ROW|Dimensions to be presented in rows (concepts on y-axis)|(((

Either:

* an artefact, or;

* a Dimension

)))| |(((

Attached to Dimension: <blank>

349

350

Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,…

//Example~://

REF_AREA,MEASURE

)))|

|LAYOUT_COLUMN|Dimensions to be presented in columns (concepts on x-axis)|(((

Either:

* an artefact, or;

* a Dimension

)))| |(((

Attached to Dimension: <blank>

363

364

Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,…

//Example~://

TIME_PERIOD

)))|

<concept Id>,<concept Id>,...

//Example~://

OBS_STATUS,CONF_STATUS

376

)))|

377

378

<concept Id>,<concept Id>,...

//Example~://

OBS_STATUS,CONF_STATUS

)))|

|(((

METADATA

)))|Links an MSD directly to a DSD. Can be used to overcome the complexities of reference metadata linkage|DSD| |MSD URI, e.g. urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataStructure=OECD:MSD_REF_METADATA(1.0)|

389

|LAYOUT_ROW_SECTION|Dimension to be presented as a break-down concept at a third hierarchical level above columns and rows.|(((

Either:

* an artefact, or;

a Dimension

)))| |(((

Attached to Dimension: <blank>

397

398

Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,…

//Example~://

SEX

)))|

|EXT_RESOURCE|(((

A localised link to an external resource associated to the annotated artefact. For example, an ontology item

406

407

//a methodology// en:<a href:"[[https:~~/~~/ec.europa.eu/eurostat/web/waste/methodology>>url:https://ec.europa.eu/eurostat/web/waste/methodology]]">

408

)))|Any SDMX object|(((

409

For localised content in SDMX 2.1

410

411

<language>:<HTML containing URL to the resource>,

412

413

<language>:<HTML containing URL to the resource>,…

//Example~://

en:<a href=”[[http:~~/~~/rdf-vocabulary.ddialliance.org/xkos#depth>>url:http://rdf-vocabulary.ddialliance.org/xkos#depth]]”>

418

)))| |(((

419

See section URL value defaults and specific locale values.

//Example~://

http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth

424

)))

425

|COMBINED_CONCEPTS|(((

426

Comma-separated list of concept IDs to show as a concatenated label.

427

428

The listed concepts’ item contents may be concatenated to generate the target concept.

429

430

Multiple target concept combinations can be defined by separating the target concepts by ;

431

)))|Dataflow or DSD|(((

432

<language>:<display name>,

e.g. COMBINED_UNIT_MEASURE:PRICE_BASE,UNIT_MEASURE;COMBINED_MEASURE:MEASURE,REF_SECTOR{(en):Combined unit of measure;Combined measure}{(fr):Unité de mesure combinée;Mesure combinée}

437

)))| |

438

|(deprecated) UNIT_MEASURE_CONCEPTS|(((

439

Comma-separated list of concept IDs that is used to define the full unit of measure. The concepts must be in the DSD.

440

441

The listed concepts’ item contents may be concatenated to generate the unit of measure label (unless the UNIT_MEASURE_LABEL annotation is present).

442

)))|Dataflow or DSD| |(((

443

<concept Id>,<concept Id>,…

444

445

//Example~:// UNIT_MEASURE,UNIT_MULT,TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed]

446

)))|

447

|(deprecated) UNIT_MEASURE_LABEL|(((

448

Indicates the concept that enumerates the full unit of measure labels.

449

450

The concept must be in the DSD. UNIT_MEASURE_LABEL overrides the UNIT_MEASURE_CONCEPTS if both are provided.

451

452

Also can be attached to items in item scheme, e.g.

Text en:Gram

fr: Gramme

url:** **[[**http:~~/~~/data.europa.eu/gzn/su/G**>>url:http://data.europa.eu/gzn/su/G]]

457

)))|Dataflow or DSD, Item in an Item Scheme|(((

458

This is optional, used if a freetext label is required.

459

460

<language>:<content>,

461

462

<language>:<content>,…

//Example~://

en:USD, thousands

fr:USD, milliers

)))|(((

This is optional, used if an enumerated list is required.

//Example~://

UOM_ATTRIBUTE [This concept may contain the following items as units of measure:

477

478

* National Currency, thousands

479

* USD, thousands

480

481

Index, based on National Currency]

482

)))|

483

|(((

484

LAYOUT_TIME_PERIOD_DESC

485

486

487

)))|Indication that the display of the TIME_PERIOD dimension for a dataflow, or all dataflows of the same DSD, is to be done in descending sort order.|Dataflow, DSD| |(((

488

//Example~://

489

490

LAYOUT_TIME_PERIOD_DESC

)))|

|(((

LAYOUT_CELL_ALIGN

)))|Indication to force the data cell alignment to the left or to the right. This can be defined generically for all locales or per locale.|Dataflow, DSD, Dimension|(((

497

<language>:<content>,

498

499

<language>:<content>,…

500

501

502

<content> values:RIGHT or LEFT

503

)))|Content values:RIGHT or LEFT|

|(((

MAX_TABLE_DATA

)))|Increase the maximum preview table size above default maximum limits for the number of observations retrieved from the SDMX web service and for the number of table cells|Dataflow| |(((

//Example~://

15000

)))|

|(((

MAXTEXTATTRIBUTELENGTH

517

518

519

)))|Increase the maximum length for textual attribute values|DSD| |(((

//Example~://

500

)))|

|SEARCH_WEIGHT|Indication of localised boosted dataflows in the search results when ordered by relevance|Dataflow|(((

527

<language>:<integer>,...

//Example~://

"en":"3","es":"4","fr":"5"

)))|(((

//Example~://

10

)))|

== Codelist and Statistical Classification-specific Annotations ==

541

542

The categories below are used widely, for example by the European Statistical System (ESS), and the United Nations Statistics Division for its central framework classifications ISIC4[[~[2~]>>path:#_ftn2]] and CPC[[~[3~]>>path:#_ftn3]].

543

544

|Annotation Type|Use Case|Where to attach|(((

+Text

Blue is optional

)))|(((

Title

Blue is optional

)))|(((

SDMX 2.1:URL

SDMX >=3.0:+URL

Blue is optional

)))

|ORIGINAL_CODE|Code as displayed in other representations, such as official or original documentation (i.e. possibly containing dots, spaces, etc.). Reference to external standard: skos:notation|Item in an Item Scheme| |(((

//Examples~://

* 0105.13 [Harmonized System]

565

* 11.2.0.9 [COICOP classification]

566

)))|

567

|HIER_CONTEXT|(((

568

In SDMX 2.1, a reference between a usage context and a hierarchy (that may be contained in a Hierarchical Codelist (HCL)).

569

570

In SDMX 3.0, use the HierarchyAssociation artefact

571

)))|DSD or Dataflow| |(((

//Example~://

REF_AREA:OECD.EDU:HCL_REF_AREA(1.0).REF_AREA provides the link to the reference area hierarchy for OECD education data

577

)))|

578

|HIER_LEVEL|(((

579

Explicit specification of the hierarchical level of a code item

580

581

Reference to external standard: xkos:ClassificationLevel - property: xkos:xdepth url: [[http:~~/~~/data.europa.eu/ux2/nace2.1/sections>>url:http://data.europa.eu/ux2/nace2.1/sections]]

text en:sections

)))|Code item| |(((

//Example~://

1

)))|

|SHORT_LABEL|A short label, typically for dissemination purposes where long labels are sometimes not appropriate for presentation in tables where space is an important parameter (generally less than 40 or 50 characters)|Artefact, or Concept, or Item in an Item Scheme|(((

592

<language>:<content>,

593

594

<language>:<content>,…

)))|(((

//Example~://

[Official French label “Transformation et conservation de la viande de boucherie” is shortened to] fr:Transf. & conserv. viande de boucherie

599

600

601

In Codelist=IMF:CL_AREA(1.13)

602

Code 4J837 European Union Intellectual Property Office has a Short_Label

EN:EUIPO

)))|

|EXPLAN_LABEL|An explanatory text that specifies “other” and similar categories. An example is the Combined Nomenclature classification where the many codes labelled “other” are complemented by a verbose text describing in detail the content of the code item|Item in an Item Scheme, mapping to Representation Maps|(((

607

<language>:<content>,

608

609

<language>:<content>,…

)))|(((

//Example~://

[EU Combined Nomenclature official label for code 3824 99 57 reads “Other”, which is not very informative for the user; instead the EXPLAN_LABEL reads] en:Cartridges and refills, filled, for electronic cigarettes, and preparations for use in the cartridges and refills, not containing nicotine or its salts, ethers, esters or other derivatives thereof

614

)))|

615

|EXPLAN_CONSOL|Explanatory notes. An explanatory text to be used when objects included in and excluded from a classification position are consolidated, i.e. are presented together. Reference to external standard: skos:scopeNote|Item in an Item Scheme, mapping to Representation Maps|(((

616

<language>:<content>,

617

618

<language>:<content>,…

619

)))|(((

620

Example (from the US NAICS classification):

621

622

en:Industries in the Food Manufacturing subsector transform livestock and agricultural products into products for intermediate or final consumption. […] The food products manufactured in these establishments are typically sold to wholesalers or retailers for distribution to consumers, but establishments primarily engaged in retailing bakery and candy products made on the premises not for immediate consumption are included. Establishments primarily engaged in manufacturing beverages are classified in Subsector 312, Beverage and Tobacco Product Manufacturing.

623

)))|

624

|EXPLAN_INCLUDES|Explanatory notes. Description of those things known specifically to be included in the concept. Synonyms Typical labels for such explanatory notes: "This class includes", "This category includes", "This position includes", "Includes", etc. Reference to external standard: xkos:inclusionNote or xkos:coreContentNote (if EXPLAN_INCLUDES_ALSO available)|Item in an Item Scheme, mapping to Representation Maps|(((

625

<language>:<content>,

626

627

<language>:<content>,…

628

)))|(((

629

Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):

630

631

en: This class includes:

632

633

* manufacture of heavy weapons (artillery, mobile guns, rocket launchers, torpedo tubes, heavy machine guns)

634

* manufacture of small arms (revolvers, shotguns, light machine guns)

635

* manufacture of air or gas guns and pistols

636

* manufacture of war ammunition

637

)))|

638

|EXPLAN_CASELAW|Explanatory notes. Indication that a decision on the classification has been made by the ad hoc Committee (concept generally described as “ruling”, “classification opinion”, classification decision; caselaw). : Reference to external standardxkos:caseLaw. The difference between caselaws and traditional explanatory notes is that caselaws are adopted during the time period between two official versions of a specific classification and have thus a slightly different status (e.g. from a legal viewpoint)|Item in an Item Scheme|(((

639

<language>:<content>,

640

641

<language>:<content>,…

642

643

Example (from NACE Rev. 2 caselaw to code 01.62):

644

645

en:Automated egg hatching for poultry - Operation of livestock management systems]

646

)))| |

647

|EXPLAN_INCLUDES_ALSO|Explanatory notes. Description of those things which can be considered as borderline cases and are generally based on consensus rather than strict methodological principles (e.g. classifying wooden shoes as handicraft rather than shoes). Typical labels for such explanatory notes: "This class includes also", "This category includes also", "This position includes also ", "Includes also", etc. Reference to external standard: xkos:additionalContentNote|Item in an Item Scheme|(((

648

<language>:<content>,

649

650

<language>:<content>,…

651

)))|(((

652

Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):

653

654

en:This class also includes:

655

656

* manufacture of hunting, sporting or protective firearms and ammunition

657

* manufacture of explosive devices such as bombs, mines and torpedoes

658

)))|

659

|EXPLAN_EXCLUDES|Explanatory notes. Description of those things which are explicitly excluded from a category. Typical labels for such explanatory notes: "This class excludes", "This category excludes", "This position excludes", "Excludes", etc. Reference to external standards: xkos:exclusionNote|(((

660

Item in an Item Scheme

)))|(((

<language>:<content>,

665

666

<language>:<content>,…

667

)))|(((

668

Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):

669

670

en:This class excludes:

671

672

* manufacture of percussion caps, detonators or signalling flares, see 2029

673

* manufacture of cutlasses, swords, bayonets etc., see 2593

674

)))|

675

|MAP_REFER|A reference to a classification mapping or transformation, e.g. an SDMX Structure Map. Reference to external standard: skos:mappingRelation (skos:broadMatch, skos:narrowMatch, skos:closeMatch, skos:exactMatch or skos:relatedMatch)|Codelist, Concept Scheme, or another Item Scheme| |Id of an ItemSchemeMap returned by the Annotation URL|(((

676

See section URL value defaults and specific locale values.

)))

|COMP_RULE|Code item composition rule. For example, for code A the composition rule may be “A1+A2” where A1 and A2 are other codes in the same Codelist|An Item in an Item Scheme| |(((

//Example~://

A1+A2

)))|

|FOLLOWS|(((

A reference used to express the succession in time of Item Schemes.

689

690

For example, NACE Rev. 2 is the successor of NACE Rev. 1.1

691

692

Reference to external standard: skos:ConceptScheme - property: xkos:follows

693

)))|Codelist or Item Scheme| | |(((

694

See section URL value defaults and specific locale values.

//Example~://

(CL_REGIONAL 3.1.1 follows CL_REGIONAL 3.1):

699

700

[[https:~~/~~/registry.sdmx.org/ws/public/sdmxapi/rest/codelist/ESTAT/CL_REGIONAL/3.1>>url:https://registry.sdmx.org/ws/public/sdmxapi/rest/codelist/ESTAT/CL_REGIONAL/3.1]]

701

)))

702

|HAS_VARIANT|(((

703

A reference used to express the relation between an Item Scheme and its variant(s).

704

705

Reference to external standard: skos:ConceptScheme - property: xkos:variant

706

707

708

For //Example~:// CL_AREA has a variant CL_GEO

709

)))|Codelist or Item Scheme| | |(((

710

See section URL value defaults and specific locale values.

)))

|SUPERSEED|(((

A reference to a previous version, if the current version obsoleted the previous one.

716

717

May be used in conjunction with DEPRECATED.

718

719

Reference to external standard: skos:ConceptScheme - property: xkos:supersedes

720

)))|Codelist or Item Scheme, or an artefact| | |(((

721

See section URL value defaults and specific locale values.

)))

|FAMILY_LABEL|(((

Label of the Classification Family (e.g. NACE, ISIC)

727

728

Reference to external standard: skos:ConceptScheme - property: xkos:belongsTo

729

730

label of the classification

731

)))|Codelist or Item Scheme|(((

732

<language>:<content>,

733

734

<language>:<content>,…

//Example~://

en:NACE

)))| |(((

See section URL value defaults and specific locale values.

)))

|COVERAGE_LABEL|(((

Label(s) of the item scheme’s coverage (e.g. National Accounts, Products, Activities, Occupations)

746

747

Reference to external standard: skos:ConceptScheme - property: xkos:covers

//Examples~://

URL <http:~/~/eurovoc.europa.eu/56> (National accounts)

752

753

URL <http:~/~/publications.europa.eu/resource/authority/data-theme/REGI> (Regions and Cities)

754

)))|Codelist or Item Scheme|(((

755

<language>:<content>,

756

757

<language>:<content>,…

//Example~://

En:national accounts

)))| |(((

See section URL value defaults and specific locale values.

)))

|GEO_FEATURE_SET|(((

In Codelists, transmits GeoFeature values.

769

770

Example for NUTS ID BE23

771

url:[[http:~~/~~/data.europa.eu/nuts/geometry/2xr1qiv9>>url:http://data.europa.eu/nuts/geometry/2xr1qiv9]]

772

)))|Code in a Codelist. The Codelist must have an annotation attached with AnnotationType=GEO_TYPE_GEOGRAPHIC| |A set of points defining a feature following the 1363 ISO/IEC 13249-3:2016 standard to conform Well-known Text (WKT) for the 1364 representation of geometries. See SDMX STANDARDS: SECTION 6 for further information on the format.|

773

774

|LEGAL_BASIS|(((

775

Indicates that the Legislation on which the codelist/nomenclature is based.

776

777

Example for NACE Rev.2.1

778

779

url: [[http:~~/~~/data.europa.eu/eli/reg_del/2023/137/oj>>url:http://data.europa.eu/eli/reg_del/2023/137/oj]]

780

)))|Codelist| | |http:~/~/data.europa.eu/eli/reg_del/2023/137/oj

= Concept Scheme SDMX:CS_ANNOT =

787

788

The Concept Scheme for standard Annotations will have the Maintenance Agency SDMX and will describe the following properties for each Annotation. For the information represented by Annotations, the value is in AnnotationTitle apart from the URL property where it is in AnnotationURL.

789

790

|**Property**|**Representation in Concept**|**Description**

791

|**Code**|Concept Id|The Annotation Type column, e.g. NOT_DISPLAYED, EXCLUDES

792

|**Name**|Concept Name|Short description of the standard Annotation derived from the “Use case” column

793

|**Representation**|Concept Core Representation|Allowable type or format for the Annotation

794

|**Description**|Concept Description|The information in the “Use case” column. Possible to add more contextual information. Specific details can be described here, such as if the value should be in AnnotationText or AnnotationTitle

795

|**Artefact(s)**|Annotation Type: Artefact(s)|The information in the “Where to attach” column

796

|**URL**|Annotation Type: URL|The Annotation URL column. The value is in URL

797

798

== Example of a Concept ==

799

800

|**Concept Id**|NOT_DISPLAYED

801

|**Concept Name**|Used to hide components or their values in the presentation

802

|**Concept Core Representation**|/TextFormat@textType="String"

803

|**Concept Description**|To hide dimensions and attributes in a display (e.g. a table). For example, if they have only one allowed, available or selected value

804

|**Concept: Annotation: Type: Artefact(s)**|Either a Dataflow or DSD, or an item in an item scheme

=== ===

=== SDMX-ML of the Example ===

809

810

<str:Concept id="NOT_DISPLAYED">

811

<com:Annotations>

812

<com:Annotation>

813

<com:AnnotationTitle>Either a Dataflow or DSD, or an item in an item scheme</com:AnnotationTitle>

814

<com:AnnotationType>Artefact(s)</com:AnnotationType>

815

</com:Annotation>

816

</com:Annotations>

817

<com:Name xml:lang="en">Used to hide components or their values in the presentation</com:Name>

818

<com:Description xml:lang="en">To hide dimensions and attributes in a display (e.g. a table). For example, if they have only one allowed, available or selected value</com:Description>

819

<str:CoreRepresentation>

820

<str:TextFormat textType="String"/>

821

</str:CoreRepresentation>

</str:Concept>

= References =

* [[Formalization of the Structure and Content of Statistical Classifications>>url:https://urldefense.com/v3/__https:/eur02.safelinks.protection.outlook.com/?url=https*3A*2F*2Furldefense.com*2Fv3*2F__https*3A*2Feur02.safelinks.protection.outlook.com*2F*3Furl*3Dhttps*3A*2F*2Fec.europa.eu*2Feurostat*2Framon*2Fmiscellaneous*2Fgen_intro_classif_files*2FStructure_and_content_of_classifications_version_1_0_October_2019.docx*26data*3D02*7C01*7CDavid.BARRACLOUGH*40oecd.org*7Cf9cb429291334e5170cb08d80c883aeb*7Cac41c7d41f61460db0f4fc925a2b471c*7C0*7C1*7C637273126543303645*26sdata*3Dl01*2BEX3SNWREH*2FElV3r9Ld*2BG49l7ouvFi7pqAGYg2Ss*3D*26reserved*3D0__*3BJSUlJSUlJSUlJSUlJSUlJSUlJSU!!DOxrgLBm!Q_cL04DGMBYhHfuPQVRMMCKao1C3QuaoJxBTxO4_mSKNMGfLjmV2UTCtAhTDvbMAZtNzrTZ3*24&data=02*7C01*7CDavid.BARRACLOUGH*40oecd.org*7Ca70a73c696814b06406408d80d1d9336*7Cac41c7d41f61460db0f4fc925a2b471c*7C0*7C1*7C637273768055440921&sdata=r4CVvCdYBIU39XMN0qNmt*2FC9FIS7AnXrzYcjuzDe0Dc*3D&reserved=0__;JSUlJSUlJSUlJSoqKioqKioqJSUqKioqKioqKiUlKioqKiUlJSUlJSUlJSUlJSUl!!DOxrgLBm!RCGOp-FMBfmiP7CvEwdSAhL4XCil-vey-z32n6uxoCDXVTN7rXWXG442IZgqwpmM4wKQq908$]]

827

* [[SDMX Global Registry>>url:https://registry.sdmx.org/overview.html]]

828

* [[SDMX Glossary 2.1>>url:https://sdmx.org/wp-content/uploads/SDMX_Glossary_version_2_1-Final-2.docx]]

829

* SDMX Standards, “[[Information Model: UML Conceptual Design>>url:https://sdmx.org/wp-content/uploads/SDMX_2_0_SECTION_02_InformationModel.pdf]]”, version 2.1

830

* [[SKOS Specification>>url:https://www.w3.org/TR/2009/REC-skos-reference-20090818/]]

831

* [[XKOS Specification>>url:https://ddialliance.org/Specification/XKOS/1.2/OWL/xkos.html]]

----

[[~[1~]>>path:#_ftnref1]] The technical standard does not enumerate the annotation types, however this guideline provides a recommended enumeration or controlled vocabulary

836

837

[[~[2~]>>path:#_ftnref2]] International Standard Industrial Classification of All Economic Activities

838

839

[[~[3~]>>path:#_ftnref3]] Central Product Classification

Wiki source code of Guidelines on Using SDMX Annotations