Skip to Content
Last modified by Artur K. on 2026/05/29 14:28
From version 1.8
edited by Helena K.
on 2026/01/15 23:25
Change comment: There is no comment for this version
To version 1.2
edited by Helena K.
on 2026/01/15 23:02
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -43,7 +43,7 @@
43 43  |**title**|(% style="width:823px" %)A title used to identify an Annotation.|(% style="width:710px" %)A non-localised value for the annotation. Used when localisation is irrelevant.
44 44  |**type**|(% style="width:823px" %)(((
45 45  Specifies how the Annotation is to be processed.
46 -The **type** is often used as the usage context of the Annotation. The types are not enumerated{{footnote}}The technical standard does not enumerate the annotation types, however this guideline provides a recommended enumeration or controlled vocabulary{{/footnote}}, as these can be specified by the Annotation creator. The definitions and use of Annotation types should be documented by their creator.
46 +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.
47 47  )))|(% style="width:710px" %)Identifies the usage (e.g. images are type IMAGE) of the annotation. The type values are enumerated in the controlled vocabulary table.
48 48  |**url**|(% style="width:823px" %)(((
49 49  A link to external descriptive text.
... ... @@ -124,20 +124,23 @@
124 124  
125 125  == General and Display-related Annotation types ==
126 126  
127 -|(% style="width:152px" %)Annotation Type|(% style="width:559px" %)Use Case|Where to attach|(((
127 +|Annotation Type|Use Case|Where to attach|(((
128 128  +Text
129 129  
130 130  Blue is optional
131 131  )))|(((
132 132  Title
133 +
133 133  Blue is optional
134 134  )))|(((
135 135  SDMX 2.1:URL
137 +
136 136  SDMX >=3.0:+URL
139 +
137 137  Blue is optional
138 138  )))
139 -|(% style="width:152px" %)FULL_NAME|(% style="width:559px" %)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 
140 -en: A0123 Growing of citrus fruits|(% style="width:20px" %)Item in an Item Scheme|(% style="width:506px" %)(((
142 +|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 
143 +en: A0123 Growing of citrus fruits|Item in an Item Scheme|(((
141 141  <language>:<content>,
142 142  
143 143  <language>:<content>,…
... ... @@ -145,28 +145,28 @@
145 145  //Example~://
146 146  
147 147  en:Labour force (Employment)
148 -)))|(% style="width:178px" %)<content>|(% style="width:866px" %)
149 -|(% style="width:152px" %)REPLACE_NAME|(% style="width:559px" %)Replace each code name in a component by the value of another component in an observation or series|(% style="width:20px" %)A Dataflow or DSD|(% style="width:506px" %) |(% style="width:178px" %)(((
151 +)))|<content>|
152 +|REPLACE_NAME|Replace each code name in a component by the value of another component in an observation or series|A Dataflow or DSD| |(((
150 150  <component Id to replace name>:<component Id to use name>
151 151  
152 152  //Example~://
153 153  
154 154  CUST_BREAKDOWN:CUST_BREAKDOWN_LB
155 -)))|(% style="width:866px" %)
156 -|(% style="width:152px" %)REPLACE_CONTENT|(% style="width:559px" %)Replace the content in a component by the value of another component in an observation or series|(% style="width:20px" %)A Dataflow or DSD|(% style="width:506px" %) |(% style="width:178px" %)(((
158 +)))|
159 +|REPLACE_CONTENT|Replace the content in a component by the value of another component in an observation or series|A Dataflow or DSD| |(((
157 157  <component Id to replace content>:<component Id to use content>
158 158  
159 159  //Example~://
160 160  
161 161  REF_AREA:M49_CODE
162 -)))|(% style="width:866px" %)
163 -|(% style="width:152px" %)COMPLEMENT|(% style="width:559px" %)(((
165 +)))|
166 +|COMPLEMENT|(((
164 164  Additional fixed text to be displayed in parenthesis after the code name.
165 165  
166 166  E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes
167 167  en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW)
168 168  en: 01 03 99 wastes not otherwise specified (NHAZW)
169 -)))|(% style="width:20px" %)Item in an Item Scheme|(% style="width:506px" %)(((
172 +)))|Item in an Item Scheme|(((
170 170  <language>:<content>,
171 171  
172 172  <language>:<content>,…
... ... @@ -174,13 +174,13 @@
174 174  //Example~://
175 175  
176 176  en:See reference metadata
177 -)))|(% style="width:178px" %)<content>|(% style="width:866px" %)
178 -|(% style="width:152px" %)ORDER|(% style="width:559px" %)Explicit indication of a localised order of items in Items Schemes or artefacts (e.g. Codelist, Concept Scheme, Category Scheme, Dataflow, etc.)|(% style="width:20px" %)(((
180 +)))|<content>|
181 +|ORDER|Explicit indication of a localised order of items in Items Schemes or artefacts (e.g. Codelist, Concept Scheme, Category Scheme, Dataflow, etc.)|(((
179 179  Either:
180 180  
181 181  * an artefact, or;
182 182  * an item in an Item Scheme
183 -)))|(% style="width:506px" %)(((
186 +)))|(((
184 184  <language>:<content>,
185 185  
186 186  <language>:<content>,…
... ... @@ -188,42 +188,43 @@
188 188  //Example~://
189 189  
190 190  en:10,es:20
191 -)))|(% style="width:178px" %)(((
194 +)))|(((
192 192  <content>
193 193  
194 194  
195 -)))|(% style="width:866px" %)
196 -|(% style="width:152px" %)TOTAL|(% style="width:559px" %)(((
198 +)))|
199 +|TOTAL|(((
197 197  Code Item that represents a total value. If the attachment is:
198 198  
199 199  * to a Code, the Annotation Text is optional and may contain an explanatory text;
200 -* to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total
201 -)))|(% style="width:20px" %)(((
203 +
204 +to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total
205 +)))|(((
202 202  Either:
203 203  
204 204  * a Code Item that represents a total value, or;
205 205  * a Codelist to specify the code(s) with the total
206 -)))|(% style="width:506px" %)(((
210 +)))|(((
207 207  <language>:<explanatory text>,
208 208  
209 209  <language>:<explanatory text>,…
210 -)))|(% style="width:178px" %)(((
214 +)))|(((
211 211  Attached to Code Item: <blank>
212 212  
213 213  Attached to Codelist: <code>,<code>,…
214 -)))|(% style="width:866px" %)
215 -|(% style="width:152px" %)DRILLDOWN|(% style="width:559px" %)Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|(% style="width:20px" %)(((
218 +)))|
219 +|DRILLDOWN|Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|(((
216 216  Either:
217 217  
218 218  * A Dataflow or DSD
219 -)))|(% style="width:506px" %) |(% style="width:178px" %)(((
223 +)))| |(((
220 220  <concept Id>
221 221  
222 222  //Example~://
223 223  
224 224  DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below)
225 -)))|(% style="width:866px" %)
226 -|(% style="width:152px" %)DEPRECATED|(% style="width:559px" %)(((
229 +)))|
230 +|DEPRECATED|(((
227 227  Indication that an Item in an Item Scheme or an artefact is deprecated.
228 228  
229 229  For an item scheme item, the annotation value provides a replacement name for the code name.
... ... @@ -238,12 +238,12 @@
238 238  or
239 239  
240 240  TITLE: true (false)
241 -)))|(% style="width:20px" %)(((
245 +)))|(((
242 242  Either:
243 243  
244 244  * an artefact, or;
245 245  * an item in an Item Scheme
246 -)))|(% style="width:506px" %)(((
250 +)))|(((
247 247  For item scheme item:
248 248  
249 249  <language>:<content>,
... ... @@ -253,7 +253,7 @@
253 253  //Example~://
254 254  
255 255  en:deprecated,fr:obsolète
256 -)))|(% style="width:178px" %)<content>|(% style="width:866px" %)(((
260 +)))|<content>|(((
257 257  For artefact:
258 258  
259 259  <see section URL value defaults and specific locale values>
... ... @@ -260,17 +260,17 @@
260 260  
261 261  
262 262  )))
263 -|(% style="width:152px" %)DEFAULT|(% style="width:559px" %)(((
267 +|DEFAULT|(((
264 264  Indication that an item in an Item Scheme or artefacts is to be selected by default.
265 265  
266 266  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
267 -)))|(% style="width:20px" %)(((
271 +)))|(((
268 268  * Item in ItemScheme, or;
269 269  * DSD, or;
270 270  * a Dataflow
271 271  
272 272  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.
273 -)))|(% style="width:506px" %) |(% style="width:178px" %)(((
277 +)))| |(((
274 274  Attached to:
275 275  
276 276  - DSD or Dataflow:
... ... @@ -277,13 +277,13 @@
277 277  **<concept>=<code>+<code>+…,<concept>=<code>+<code>+…**
278 278  
279 279  //Example~:// FREQ=A+Q,TIME_PERIOD_START=2013-01,TIME_PERIOD_END=2018-12
280 -)))|(% style="width:866px" %)
281 -|(% style="width:152px" %)IMAGE|(% style="width:559px" %)A visual identity to associate to Item Scheme Items or artefacts|(% style="width:20px" %)(((
284 +)))|
285 +|IMAGE|A visual identity to associate to Item Scheme Items or artefacts|(((
282 282  Either:
283 283  
284 284  * an artefact, or;
285 285  * an item in an item scheme
286 -)))|(% style="width:506px" %)(((
290 +)))|(((
287 287  For localised content in SDMX 2.1
288 288  
289 289  <language>:<HTML containing URL to the resource>,
... ... @@ -293,7 +293,7 @@
293 293  //Example~://
294 294  
295 295  en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”>
296 -)))|(% style="width:178px" %) |(% style="width:866px" %)(((
300 +)))| |(((
297 297  See section URL value defaults and specific locale values.
298 298  
299 299  //Example~://
... ... @@ -302,19 +302,19 @@
302 302  
303 303  
304 304  )))
305 -|(% style="width:152px" %)DRILLDOWN_CONCEPTS|(% style="width:559px" %)Concepts to be displayed in a drilldown operation|(% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %) |(% style="width:178px" %)(((
309 +|DRILLDOWN_CONCEPTS|Concepts to be displayed in a drilldown operation|Dataflow or DSD| |(((
306 306  <concept Id>,<concept Id>,…
307 307  
308 308  Example :
309 309  
310 310  DONOR,RECIPIENT,YEAR,PROJECT_ID,OBS_VALUE,DESCRIPTION,OWNER
311 -)))|(% style="width:866px" %)
312 -|(% style="width:152px" %)NOT_DISPLAYED|(% style="width:559px" %)Used to hide components or their values in the presentation|(% style="width:20px" %)(((
315 +)))|
316 +|NOT_DISPLAYED|Used to hide components or their values in the presentation|(((
313 313  Either:
314 314  
315 315  * a Dataflow or DSD, or;
316 316  * an Item in an Item Scheme
317 -)))|(% style="width:506px" %) |(% style="width:178px" %)(((
321 +)))| |(((
318 318  Attached to Item in Item Scheme: <blank>
319 319  
320 320  Attached to Dataflow or DSD:
... ... @@ -324,13 +324,13 @@
324 324  Example :
325 325  
326 326  DD_DIM (to hide drilldown control concept)
327 -)))|(% style="width:866px" %)
328 -|(% style="width:152px" %)LAYOUT_ROW|(% style="width:559px" %)Dimensions to be presented in rows (concepts on y-axis)|(% style="width:20px" %)(((
331 +)))|
332 +|LAYOUT_ROW|Dimensions to be presented in rows (concepts on y-axis)|(((
329 329  Either:
330 330  
331 331  * an artefact, or;
332 332  * a Dimension
333 -)))|(% style="width:506px" %) |(% style="width:178px" %)(((
337 +)))| |(((
334 334  Attached to Dimension: <blank>
335 335  
336 336  Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,…
... ... @@ -338,13 +338,13 @@
338 338  //Example~://
339 339  
340 340  REF_AREA,MEASURE
341 -)))|(% style="width:866px" %)
342 -|(% style="width:152px" %)LAYOUT_COLUMN|(% style="width:559px" %)Dimensions to be presented in columns (concepts on x-axis)|(% style="width:20px" %)(((
345 +)))|
346 +|LAYOUT_COLUMN|Dimensions to be presented in columns (concepts on x-axis)|(((
343 343  Either:
344 344  
345 345  * an artefact, or;
346 346  * a Dimension
347 -)))|(% style="width:506px" %) |(% style="width:178px" %)(((
351 +)))| |(((
348 348  Attached to Dimension: <blank>
349 349  
350 350  Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,…
... ... @@ -352,33 +352,33 @@
352 352  //Example~://
353 353  
354 354  TIME_PERIOD
355 -)))|(% style="width:866px" %)
356 -|(% style="width:152px" %)LAYOUT_FLAG|(% style="width:559px" %)Indication that an attribute and its attribute value should be presented as a flag|(% style="width:20px" %)Dataflow|(% style="width:506px" %) |(% style="width:178px" %)(((
359 +)))|
360 +|LAYOUT_FLAG|Indication that an attribute and its attribute value should be presented as a flag|Dataflow| |(((
357 357  <concept Id>,<concept Id>,...
358 358  
359 359  //Example~://
360 360  
361 361  OBS_STATUS,CONF_STATUS
362 -)))|(% style="width:866px" %)
363 -|(% style="width:152px" %)LAYOUT_NOTE|(% style="width:559px" %)Indication that an attribute and its attribute value should be presented as a note|(% style="width:20px" %)Dataflow|(% style="width:506px" %) |(% style="width:178px" %)(((
366 +)))|
367 +|LAYOUT_NOTE|Indication that an attribute and its attribute value should be presented as a note|Dataflow| |(((
364 364  <concept Id>,<concept Id>,...
365 365  
366 366  //Example~://
367 367  
368 368  OBS_STATUS,CONF_STATUS
369 -)))|(% style="width:866px" %)
370 -|(% style="width:152px" %)(((
373 +)))|
374 +|(((
371 371  METADATA
372 372  
373 373  
374 -)))|(% style="width:559px" %)Links an MSD directly to a DSD. Can be used to overcome the complexities of reference metadata linkage|(% style="width:20px" %)DSD|(% style="width:506px" %) |(% style="width:178px" %)MSD URI, e.g. urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataStructure=OECD:MSD_REF_METADATA(1.0)|(% style="width:866px" %)
375 -|(% style="width:152px" %)LAYOUT_ROW_SECTION|(% style="width:559px" %)Dimension to be presented as a break-down concept at a third hierarchical level above columns and rows.|(% style="width:20px" %)(((
378 +)))|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)|
379 +|LAYOUT_ROW_SECTION|Dimension to be presented as a break-down concept at a third hierarchical level above columns and rows.|(((
376 376  Either:
377 377  
378 378  * an artefact, or;
379 379  
380 380  a Dimension
381 -)))|(% style="width:506px" %) |(% style="width:178px" %)(((
385 +)))| |(((
382 382  Attached to Dimension: <blank>
383 383  
384 384  Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,…
... ... @@ -386,12 +386,12 @@
386 386  //Example~://
387 387  
388 388  SEX
389 -)))|(% style="width:866px" %)
390 -|(% style="width:152px" %)EXT_RESOURCE|(% style="width:559px" %)(((
393 +)))|
394 +|EXT_RESOURCE|(((
391 391  A localised link to an external resource associated to the annotated artefact. For example, an ontology item
392 392  
393 393  //a methodology// en:<a href:"[[https:~~/~~/ec.europa.eu/eurostat/web/waste/methodology>>url:https://ec.europa.eu/eurostat/web/waste/methodology]]">
394 -)))|(% style="width:20px" %)Any SDMX object|(% style="width:506px" %)(((
398 +)))|Any SDMX object|(((
395 395  For localised content in SDMX 2.1
396 396  
397 397   <language>:<HTML containing URL to the resource>,
... ... @@ -401,7 +401,7 @@
401 401  //Example~://
402 402  
403 403  en:<a href=”[[http:~~/~~/rdf-vocabulary.ddialliance.org/xkos#depth>>url:http://rdf-vocabulary.ddialliance.org/xkos#depth]]”>
404 -)))|(% style="width:178px" %) |(% style="width:866px" %)(((
408 +)))| |(((
405 405  See section URL value defaults and specific locale values.
406 406  
407 407  //Example~://
... ... @@ -408,29 +408,29 @@
408 408  
409 409  http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth
410 410  )))
411 -|(% style="width:152px" %)COMBINED_CONCEPTS|(% style="width:559px" %)(((
415 +|COMBINED_CONCEPTS|(((
412 412  Comma-separated list of concept IDs to show as a concatenated label.
413 413  
414 414  The listed concepts’ item contents may be concatenated to generate the target concept.
415 415  
416 416  Multiple target concept combinations can be defined by separating the target concepts by ;
417 -)))|(% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %)(((
421 +)))|Dataflow or DSD|(((
418 418  <language>:<display name>,
419 419  
420 420  <language>:<display name>
421 421  
422 422  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}
423 -)))|(% style="width:178px" %) |(% style="width:866px" %)
424 -|(% style="width:152px" %)(deprecated) UNIT_MEASURE_CONCEPTS|(% style="width:559px" %)(((
427 +)))| |
428 +|(deprecated) UNIT_MEASURE_CONCEPTS|(((
425 425  Comma-separated list of concept IDs that is used to define the full unit of measure. The concepts must be in the DSD.
426 426  
427 427  The listed concepts’ item contents may be concatenated to generate the unit of measure label (unless the UNIT_MEASURE_LABEL annotation is present).
428 -)))|(% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %) |(% style="width:178px" %)(((
432 +)))|Dataflow or DSD| |(((
429 429  <concept Id>,<concept Id>,…
430 430  
431 431  //Example~:// UNIT_MEASURE,UNIT_MULT,TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed]
432 -)))|(% style="width:866px" %)
433 -|(% style="width:152px" %)(deprecated) UNIT_MEASURE_LABEL|(% style="width:559px" %)(((
436 +)))|
437 +|(deprecated) UNIT_MEASURE_LABEL|(((
434 434  Indicates the concept that enumerates the full unit of measure labels.
435 435  
436 436  The concept must be in the DSD. UNIT_MEASURE_LABEL overrides the UNIT_MEASURE_CONCEPTS if both are provided.
... ... @@ -440,7 +440,7 @@
440 440  Text en:Gram
441 441   fr: Gramme
442 442  url:** **[[**http:~~/~~/data.europa.eu/gzn/su/G**>>url:http://data.europa.eu/gzn/su/G]]
443 -)))|(% style="width:20px" %)Dataflow or DSD, Item in an Item Scheme|(% style="width:506px" %)(((
447 +)))|Dataflow or DSD, Item in an Item Scheme|(((
444 444  This is optional, used if a freetext label is required.
445 445  
446 446  <language>:<content>,
... ... @@ -452,7 +452,7 @@
452 452  en:USD, thousands
453 453  
454 454  fr:USD, milliers
455 -)))|(% style="width:178px" %)(((
459 +)))|(((
456 456  This is optional, used if an enumerated list is required.
457 457  
458 458  <concept Id>
... ... @@ -465,21 +465,21 @@
465 465  * USD, thousands
466 466  
467 467  Index, based on National Currency]
468 -)))|(% style="width:866px" %)
469 -|(% style="width:152px" %)(((
472 +)))|
473 +|(((
470 470  LAYOUT_TIME_PERIOD_DESC
471 471  
472 472  
473 -)))|(% style="width:559px" %)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.|(% style="width:20px" %)Dataflow, DSD|(% style="width:506px" %) |(% style="width:178px" %)(((
477 +)))|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| |(((
474 474  //Example~://
475 475  
476 476  LAYOUT_TIME_PERIOD_DESC
477 -)))|(% style="width:866px" %)
478 -|(% style="width:152px" %)(((
481 +)))|
482 +|(((
479 479  LAYOUT_CELL_ALIGN
480 480  
481 481  
482 -)))|(% style="width:559px" %)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.|(% style="width:20px" %)Dataflow, DSD, Dimension|(% style="width:506px" %)(((
486 +)))|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|(((
483 483  <language>:<content>,
484 484  
485 485  <language>:<content>,…
... ... @@ -486,171 +486,300 @@
486 486  
487 487  
488 488  <content> values:RIGHT or LEFT
489 -)))|(% style="width:178px" %)Content values:RIGHT or LEFT|(% style="width:866px" %)
490 -|(% style="width:152px" %)(((
493 +)))|Content values:RIGHT or LEFT|
494 +|(((
491 491  MAX_TABLE_DATA
492 492  
493 493  
494 -)))|(% style="width:559px" %)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|(% style="width:20px" %)Dataflow|(% style="width:506px" %) |(% style="width:178px" %)(((
498 +)))|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| |(((
495 495  <integer>
496 496  
497 497  //Example~://
498 498  
499 499  15000
500 -)))|(% style="width:866px" %)
501 -|(% style="width:152px" %)(((
504 +)))|
505 +|(((
502 502  MAXTEXTATTRIBUTELENGTH
503 503  
504 504  
505 -)))|(% style="width:559px" %)Increase the maximum length for textual attribute values|(% style="width:20px" %)DSD|(% style="width:506px" %) |(% style="width:178px" %)(((
509 +)))|Increase the maximum length for textual attribute values|DSD| |(((
506 506  <integer>
507 507  
508 508  //Example~://
509 509  
510 510  500
511 -)))|(% style="width:866px" %)
512 -|(% style="width:152px" %)SEARCH_WEIGHT|(% style="width:559px" %)Indication of localised boosted dataflows in the search results when ordered by relevance|(% style="width:20px" %)Dataflow|(% style="width:506px" %)(((
515 +)))|
516 +|SEARCH_WEIGHT|Indication of localised boosted dataflows in the search results when ordered by relevance|Dataflow|(((
513 513  <language>:<integer>,...
514 514  
515 515  //Example~://
516 516  
517 517  "en":"3","es":"4","fr":"5"
518 -)))|(% style="width:178px" %)(((
522 +)))|(((
519 519  <integer>
520 520  
521 521  //Example~://
522 522  
523 523  10
524 -)))|(% style="width:866px" %)
528 +)))|
525 525  
526 526  == Codelist and Statistical Classification-specific Annotations ==
527 527  
528 -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{{footnote}}International Standard Industrial Classification of All Economic Activities{{/footnote}} and CPC{{footnote}}Central Product Classification{{/footnote}}.
532 +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]].
529 529  
534 +|Annotation Type|Use Case|Where to attach|(((
535 ++Text
530 530  
531 -|**Annotation Type**|(% style="width:524px" %)**Use Case**|(% style="width:198px" %)**Where to attach**|(% style="width:237px" %)(((
532 -**+Text
533 -(% style="background-color:transparent" %)Blue is optional(%%)**
534 -)))|(% style="width:320px" %)(((
535 -**Title
536 -(% style="background-color:transparent" %)Blue is optional(%%)**
537 -)))|(% style="width:203px" %)(((
538 -**SDMX 2.1:URL
537 +Blue is optional
538 +)))|(((
539 +Title
540 +
541 +Blue is optional
542 +)))|(((
543 +SDMX 2.1:URL
544 +
539 539  SDMX >=3.0:+URL
540 -(% style="background-color:transparent" %)Blue is optional(%%)**
546 +
547 +Blue is optional
541 541  )))
542 -|FULL_NAME|(% style="width:524px" %)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 
543 -en: A0123 Growing of citrus fruits|(% style="width:198px" %)Item in an Item Scheme|(% style="width:237px" %)(((
544 -<language>:<content>,<language>:<content>,…
549 +|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| |(((
550 +<original code>
551 +
552 +//Examples~://
553 +
554 +* 0105.13 [Harmonized System]
555 +* 11.2.0.9 [COICOP classification]
556 +)))|
557 +|HIER_CONTEXT|(((
558 +In SDMX 2.1, a reference between a usage context and a hierarchy (that may be contained in a Hierarchical Codelist (HCL)).
559 +
560 +In SDMX 3.0, use the HierarchyAssociation artefact
561 +)))|DSD or Dataflow| |(((
562 +<component Id>:<HCL Id>.<hierarchy Id>
563 +
545 545  //Example~://
546 -(% style="background-color:transparent" %)en:Labour force (Employment)
547 -)))|(% style="width:320px" %)<content>|(% style="width:203px" %)
548 -|REPLACE_NAME|(% style="width:524px" %)Replace each code name in a component by the value of another component in an observation or series|(% style="width:198px" %)A Dataflow or DSD|(% style="width:237px" %) |(% style="width:320px" %)(((
549 -<component Id to replace name>:<component Id to use name>
565 +
566 +REF_AREA:OECD.EDU:HCL_REF_AREA(1.0).REF_AREA provides the link to the  reference area hierarchy for OECD education data
567 +)))|
568 +|HIER_LEVEL|(((
569 +Explicit specification of the hierarchical level of a code item
570 +
571 +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]]
572 +
573 +text en:sections
574 +)))|Code item| |(((
575 +<hierarchical level>
576 +
550 550  //Example~://
551 -(% style="background-color:transparent" %)CUST_BREAKDOWN:CUST_BREAKDOWN_LB
552 -)))|(% style="width:203px" %)
553 -|REPLACE_CONTENT|(% style="width:524px" %)Replace the content in a component by the value of another component in an observation or series|(% style="width:198px" %)A Dataflow or DSD|(% style="width:237px" %) |(% style="width:320px" %)(((
554 -<component Id to replace content>:<component Id to use content>
578 +
579 +1
580 +)))|
581 +|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|(((
582 +<language>:<content>,
583 +
584 +<language>:<content>,…
585 +)))|(((
555 555  //Example~://
556 -(% style="background-color:transparent" %)REF_AREA:M49_CODE
557 -)))|(% style="width:203px" %)
558 -|COMPLEMENT|(% style="width:524px" %)(((
559 -Additional fixed text to be displayed in parenthesis after the code name.
560 -(% style="background-color:transparent" %)E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes(%%)
561 -(% style="background-color:transparent" %)en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW)(%%)
562 -(% style="background-color:transparent" %)en: 01 03 99 wastes not otherwise specified (NHAZW)
563 -)))|(% style="width:198px" %)Item in an Item Scheme|(% style="width:237px" %)(((
564 -<language>:<content>,<language>:<content>,…
565 565  
588 +[Official French label “Transformation et conservation de la viande de boucherie” is shortened to] fr:Transf. & conserv. viande de boucherie
589 +
590 +
591 +In Codelist=IMF:CL_AREA(1.13)
592 +Code 4J837 European Union Intellectual Property Office has a Short_Label
593 +
594 +EN:EUIPO
595 +)))|
596 +|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|(((
597 +<language>:<content>,
598 +
599 +<language>:<content>,…
600 +)))|(((
566 566  //Example~://
567 -(% style="background-color:transparent" %)en:See reference metadata
568 -)))|(% style="width:320px" %)<content>|(% style="width:203px" %)
569 -|ORDER|(% style="width:524px" %)Explicit indication of a localised order of items in Items Schemes or artefacts (e.g. Codelist, Concept Scheme, Category Scheme, Dataflow, etc.)|(% style="width:198px" %)(((
570 -Either:
571 571  
572 -* an artefact, or;
573 -* an item in an Item Scheme
574 -)))|(% style="width:237px" %)(((
575 -<language>:<content>,<language>:<content>,…
603 +[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
604 +)))|
605 +|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|(((
606 +<language>:<content>,
576 576  
608 +<language>:<content>,…
609 +)))|(((
610 +Example (from the US NAICS classification):
611 +
612 +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.
613 +)))|
614 +|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|(((
615 +<language>:<content>,
616 +
617 +<language>:<content>,…
618 +)))|(((
619 +Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):
620 +
621 +en: This class includes:
622 +
623 +* manufacture of heavy weapons (artillery, mobile guns, rocket launchers, torpedo tubes, heavy machine guns)
624 +* manufacture of small arms (revolvers, shotguns, light machine guns)
625 +* manufacture of air or gas guns and pistols
626 +* manufacture of war ammunition
627 +)))|
628 +|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|(((
629 +<language>:<content>,
630 +
631 +<language>:<content>,…
632 +
633 +Example (from NACE Rev. 2 caselaw to code 01.62):
634 +
635 +en:Automated egg hatching for poultry - Operation of livestock management systems]
636 +)))| |
637 +|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|(((
638 +<language>:<content>,
639 +
640 +<language>:<content>,…
641 +)))|(((
642 +Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):
643 +
644 +en:This class also includes:
645 +
646 +* manufacture of hunting, sporting or protective firearms and ammunition
647 +* manufacture of explosive devices such as bombs, mines and torpedoes
648 +)))|
649 +|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|(((
650 +Item in an Item Scheme
651 +
652 +
653 +)))|(((
654 +<language>:<content>,
655 +
656 +<language>:<content>,…
657 +)))|(((
658 +Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):
659 +
660 +en:This class excludes:
661 +
662 +* manufacture of percussion caps, detonators or signalling flares, see 2029
663 +* manufacture of cutlasses, swords, bayonets etc., see 2593
664 +)))|
665 +|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|(((
666 +See section URL value defaults and specific locale values.
667 +
668 +
669 +)))
670 +|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| |(((
671 +<content>
672 +
577 577  //Example~://
578 -(% style="background-color:transparent" %)en:10,es:20
579 -)))|(% style="width:320px" %)<content>|(% style="width:203px" %)
580 -|TOTAL|(% style="width:524px" %)(((
581 -Code Item that represents a total value. If the attachment is:
582 582  
583 -* to a Code, the Annotation Text is optional and may contain an explanatory text;
584 -* to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total
585 -)))|(% style="width:198px" %)(((
586 -Either:
675 +A1+A2
676 +)))|
677 +|FOLLOWS|(((
678 +A reference used to express the succession in time of Item Schemes.
587 587  
588 -* a Code Item that represents a total value, or;
589 -* a Codelist to specify the code(s) with the total
590 -)))|(% style="width:237px" %)(((
591 -<language>:<explanatory text>, 
592 -(% style="background-color:transparent" %)<language>:<explanatory text>,…
593 -)))|(% style="width:320px" %)(((
594 -Attached to Code Item: <blank>
595 -(% style="background-color:transparent" %)Attached to Codelist: <code>,<code>,…
596 -)))|(% style="width:203px" %)
597 -|DRILLDOWN|(% style="width:524px" %)Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|(% style="width:198px" %)(((
598 -Either:
680 +For example, NACE Rev. 2 is the successor of NACE Rev. 1.1
599 599  
600 -* A Dataflow or DSD
601 -)))|(% style="width:237px" %) |(% style="width:320px" %)(((
602 -<concept Id>
682 +Reference to external standard: skos:ConceptScheme - property: xkos:follows
683 +)))|Codelist or Item Scheme| | |(((
684 +See section URL value defaults and specific locale values.
685 +
603 603  //Example~://
604 -(% style="background-color:transparent" %)DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below)
605 -)))|(% style="width:203px" %)
606 -|DEPRECATED|(% style="width:524px" %)(((
607 -Indication that an Item in an Item Scheme or an artefact is deprecated.
608 -For an item scheme item, the annotation value provides a replacement name for the code name.
609 -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.
610 -Suggestion to use a controlled vocabulary
611 -url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/CURRENT>>url:http://publications.europa.eu/resource/authority/concept-status/CURRENT]]>
612 -url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/DEPRECATED>>url:http://publications.europa.eu/resource/authority/concept-status/DEPRECATED]]>
613 -or
614 -(% style="background-color:transparent" %)TITLE: true (false)
615 -)))|(% style="width:198px" %)(((
616 -Either:
617 617  
618 -* an artefact, or;
619 -* an item in an Item Scheme
620 -)))|(% style="width:237px" %)(((
621 -For item scheme item:
688 +(CL_REGIONAL 3.1.1 follows CL_REGIONAL 3.1):
622 622  
623 -<language>:<content>,<language>:<content>,…
690 +[[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]]
691 +)))
692 +|HAS_VARIANT|(((
693 +A reference used to express the relation between an Item Scheme and its variant(s).
624 624  
695 +Reference to external standard: skos:ConceptScheme - property: xkos:variant
696 +
697 +
698 +For //Example~:// CL_AREA has a variant CL_GEO
699 +)))|Codelist or Item Scheme| | |(((
700 +See section URL value defaults and specific locale values.
701 +
702 +
703 +)))
704 +|SUPERSEED|(((
705 +A reference to a previous version, if the current version obsoleted the previous one.
706 +
707 +May be used in conjunction with DEPRECATED.
708 +
709 +Reference to external standard: skos:ConceptScheme - property: xkos:supersedes
710 +)))|Codelist or Item Scheme, or an artefact| | |(((
711 +See section URL value defaults and specific locale values.
712 +
713 +
714 +)))
715 +|FAMILY_LABEL|(((
716 +Label of the Classification Family (e.g. NACE, ISIC)
717 +
718 +Reference to external standard: skos:ConceptScheme - property: xkos:belongsTo
719 +
720 +label of the classification
721 +)))|Codelist or Item Scheme|(((
722 +<language>:<content>,
723 +
724 +<language>:<content>,…
725 +
625 625  //Example~://
626 -(% style="background-color:transparent" %)en:deprecated,fr:obsolète
627 -)))|(% style="width:320px" %)<content>|(% style="width:203px" %)(((
628 -For artefact:
629 -<see section URL value defaults and specific locale values>
727 +
728 +en:NACE
729 +)))| |(((
730 +See section URL value defaults and specific locale values.
731 +
732 +
630 630  )))
631 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
632 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
633 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
634 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
635 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
636 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
637 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
638 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
639 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
640 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
641 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
734 +|COVERAGE_LABEL|(((
735 +Label(s) of the item scheme’s coverage (e.g. National Accounts, Products, Activities, Occupations)
642 642  
737 +Reference to external standard: skos:ConceptScheme - property: xkos:covers
738 +
739 +//Examples~://
740 +
741 +URL <http:~/~/eurovoc.europa.eu/56> (National accounts)
742 +
743 +URL <http:~/~/publications.europa.eu/resource/authority/data-theme/REGI> (Regions and Cities)
744 +)))|Codelist or Item Scheme|(((
745 +<language>:<content>,
746 +
747 +<language>:<content>,…
748 +
749 +//Example~://
750 +
751 +En:national accounts
752 +)))| |(((
753 +See section URL value defaults and specific locale values.
754 +
755 +
756 +)))
757 +|GEO_FEATURE_SET|(((
758 +In Codelists, transmits GeoFeature values.
759 +
760 +Example for NUTS ID BE23
761 +url:[[http:~~/~~/data.europa.eu/nuts/geometry/2xr1qiv9>>url:http://data.europa.eu/nuts/geometry/2xr1qiv9]]
762 +)))|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.|
763 +|GEO_TYPE_GEOGRAPHIC|Indicates that a codelist contains GeoFeature values via the GEO_FEATURE_SET annotation.|Codelist| | |
764 +|LEGAL_BASIS|(((
765 +Indicates that the Legislation on which the codelist/nomenclature is based.
766 +
767 +Example for NACE Rev.2.1
768 +
769 +url: [[http:~~/~~/data.europa.eu/eli/reg_del/2023/137/oj>>url:http://data.europa.eu/eli/reg_del/2023/137/oj]]
770 +)))|Codelist| | |http:~/~/data.europa.eu/eli/reg_del/2023/137/oj
771 +
772 +
773 +
774 +
775 +
643 643  = Concept Scheme SDMX:CS_ANNOT =
644 644  
645 645  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.
646 646  
647 -|**Property**|(% style="width:309px" %)**Representation in Concept**|(% style="width:1173px" %)**Description**
648 -|**Code**|(% style="width:309px" %)Concept Id|(% style="width:1173px" %)The Annotation Type column, e.g. NOT_DISPLAYED, EXCLUDES
649 -|**Name**|(% style="width:309px" %)Concept Name|(% style="width:1173px" %)Short description of the standard Annotation derived from the “Use case” column
650 -|**Representation**|(% style="width:309px" %)Concept Core Representation|(% style="width:1173px" %)Allowable type or format for the Annotation
651 -|**Description**|(% style="width:309px" %)Concept Description|(% style="width:1173px" %)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
652 -|**Artefact(s)**|(% style="width:309px" %)Annotation Type: Artefact(s)|(% style="width:1173px" %)The information in the “Where to attach” column
653 -|**URL**|(% style="width:309px" %)Annotation Type: URL|(% style="width:1173px" %)The Annotation URL column. The value is in URL
780 +|**Property**|**Representation in Concept**|**Description**
781 +|**Code**|Concept Id|The Annotation Type column, e.g. NOT_DISPLAYED, EXCLUDES
782 +|**Name**|Concept Name|Short description of the standard Annotation derived from the “Use case” column
783 +|**Representation**|Concept Core Representation|Allowable type or format for the Annotation
784 +|**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
785 +|**Artefact(s)**|Annotation Type: Artefact(s)|The information in the “Where to attach” column
786 +|**URL**|Annotation Type: URL|The Annotation URL column. The value is in URL
654 654  
655 655  == Example of a Concept ==
656 656  
... ... @@ -660,6 +660,8 @@
660 660  |**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
661 661  |**Concept: Annotation: Type: Artefact(s)**|Either a Dataflow or DSD, or an item in an item scheme
662 662  
796 +=== ===
797 +
663 663  === SDMX-ML of the Example ===
664 664  
665 665  <str:Concept id="NOT_DISPLAYED">
... ... @@ -687,4 +687,8 @@
687 687  
688 688  ----
689 689  
690 -{{putFootnotes/}}
825 +[[~[1~]>>path:#_ftnref1]] The technical standard does not enumerate the annotation types, however this guideline provides a recommended enumeration or controlled vocabulary
826 +
827 +[[~[2~]>>path:#_ftnref2]] International Standard Industrial Classification of All Economic Activities
828 +
829 +[[~[3~]>>path:#_ftnref3]] Central Product Classification
© Semantic R&D Group, 2026