Skip to Content
Last modified by Artur K. on 2026/05/29 14:28
From version 1.9
edited by Helena K.
on 2026/01/15 23:27
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,45 +124,52 @@
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>,
145 +
142 142  <language>:<content>,…
147 +
143 143  //Example~://
149 +
144 144  en:Labour force (Employment)
145 -)))|(% style="width:178px" %)<content>|(% style="width:866px" %)
146 -|(% 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| |(((
147 147  <component Id to replace name>:<component Id to use name>
148 148  
149 149  //Example~://
156 +
150 150  CUST_BREAKDOWN:CUST_BREAKDOWN_LB
151 -)))|(% style="width:866px" %)
152 -|(% 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| |(((
153 153  <component Id to replace content>:<component Id to use content>
154 154  
155 155  //Example~://
156 156  
157 157  REF_AREA:M49_CODE
158 -)))|(% style="width:866px" %)
159 -|(% style="width:152px" %)COMPLEMENT|(% style="width:559px" %)(((
165 +)))|
166 +|COMPLEMENT|(((
160 160  Additional fixed text to be displayed in parenthesis after the code name.
161 161  
162 162  E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes
163 163  en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW)
164 164  en: 01 03 99 wastes not otherwise specified (NHAZW)
165 -)))|(% style="width:20px" %)Item in an Item Scheme|(% style="width:506px" %)(((
172 +)))|Item in an Item Scheme|(((
166 166  <language>:<content>,
167 167  
168 168  <language>:<content>,…
... ... @@ -170,13 +170,13 @@
170 170  //Example~://
171 171  
172 172  en:See reference metadata
173 -)))|(% style="width:178px" %)<content>|(% style="width:866px" %)
174 -|(% 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.)|(((
175 175  Either:
176 176  
177 177  * an artefact, or;
178 178  * an item in an Item Scheme
179 -)))|(% style="width:506px" %)(((
186 +)))|(((
180 180  <language>:<content>,
181 181  
182 182  <language>:<content>,…
... ... @@ -184,42 +184,43 @@
184 184  //Example~://
185 185  
186 186  en:10,es:20
187 -)))|(% style="width:178px" %)(((
194 +)))|(((
188 188  <content>
189 189  
190 190  
191 -)))|(% style="width:866px" %)
192 -|(% style="width:152px" %)TOTAL|(% style="width:559px" %)(((
198 +)))|
199 +|TOTAL|(((
193 193  Code Item that represents a total value. If the attachment is:
194 194  
195 195  * to a Code, the Annotation Text is optional and may contain an explanatory text;
196 -* to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total
197 -)))|(% style="width:20px" %)(((
203 +
204 +to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total
205 +)))|(((
198 198  Either:
199 199  
200 200  * a Code Item that represents a total value, or;
201 201  * a Codelist to specify the code(s) with the total
202 -)))|(% style="width:506px" %)(((
210 +)))|(((
203 203  <language>:<explanatory text>,
204 204  
205 205  <language>:<explanatory text>,…
206 -)))|(% style="width:178px" %)(((
214 +)))|(((
207 207  Attached to Code Item: <blank>
208 208  
209 209  Attached to Codelist: <code>,<code>,…
210 -)))|(% style="width:866px" %)
211 -|(% 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.|(((
212 212  Either:
213 213  
214 214  * A Dataflow or DSD
215 -)))|(% style="width:506px" %) |(% style="width:178px" %)(((
223 +)))| |(((
216 216  <concept Id>
217 217  
218 218  //Example~://
219 219  
220 220  DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below)
221 -)))|(% style="width:866px" %)
222 -|(% style="width:152px" %)DEPRECATED|(% style="width:559px" %)(((
229 +)))|
230 +|DEPRECATED|(((
223 223  Indication that an Item in an Item Scheme or an artefact is deprecated.
224 224  
225 225  For an item scheme item, the annotation value provides a replacement name for the code name.
... ... @@ -234,12 +234,12 @@
234 234  or
235 235  
236 236  TITLE: true (false)
237 -)))|(% style="width:20px" %)(((
245 +)))|(((
238 238  Either:
239 239  
240 240  * an artefact, or;
241 241  * an item in an Item Scheme
242 -)))|(% style="width:506px" %)(((
250 +)))|(((
243 243  For item scheme item:
244 244  
245 245  <language>:<content>,
... ... @@ -249,7 +249,7 @@
249 249  //Example~://
250 250  
251 251  en:deprecated,fr:obsolète
252 -)))|(% style="width:178px" %)<content>|(% style="width:866px" %)(((
260 +)))|<content>|(((
253 253  For artefact:
254 254  
255 255  <see section URL value defaults and specific locale values>
... ... @@ -256,17 +256,17 @@
256 256  
257 257  
258 258  )))
259 -|(% style="width:152px" %)DEFAULT|(% style="width:559px" %)(((
267 +|DEFAULT|(((
260 260  Indication that an item in an Item Scheme or artefacts is to be selected by default.
261 261  
262 262  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
263 -)))|(% style="width:20px" %)(((
271 +)))|(((
264 264  * Item in ItemScheme, or;
265 265  * DSD, or;
266 266  * a Dataflow
267 267  
268 268  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.
269 -)))|(% style="width:506px" %) |(% style="width:178px" %)(((
277 +)))| |(((
270 270  Attached to:
271 271  
272 272  - DSD or Dataflow:
... ... @@ -273,13 +273,13 @@
273 273  **<concept>=<code>+<code>+…,<concept>=<code>+<code>+…**
274 274  
275 275  //Example~:// FREQ=A+Q,TIME_PERIOD_START=2013-01,TIME_PERIOD_END=2018-12
276 -)))|(% style="width:866px" %)
277 -|(% 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|(((
278 278  Either:
279 279  
280 280  * an artefact, or;
281 281  * an item in an item scheme
282 -)))|(% style="width:506px" %)(((
290 +)))|(((
283 283  For localised content in SDMX 2.1
284 284  
285 285  <language>:<HTML containing URL to the resource>,
... ... @@ -289,26 +289,28 @@
289 289  //Example~://
290 290  
291 291  en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”>
292 -)))|(% style="width:178px" %) |(% style="width:866px" %)(((
300 +)))| |(((
293 293  See section URL value defaults and specific locale values.
294 294  
295 295  //Example~://
304 +
296 296  https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg
306 +
297 297  
298 298  )))
299 -|(% 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| |(((
300 300  <concept Id>,<concept Id>,…
301 301  
302 302  Example :
303 303  
304 304  DONOR,RECIPIENT,YEAR,PROJECT_ID,OBS_VALUE,DESCRIPTION,OWNER
305 -)))|(% style="width:866px" %)
306 -|(% 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|(((
307 307  Either:
308 308  
309 309  * a Dataflow or DSD, or;
310 310  * an Item in an Item Scheme
311 -)))|(% style="width:506px" %) |(% style="width:178px" %)(((
321 +)))| |(((
312 312  Attached to Item in Item Scheme: <blank>
313 313  
314 314  Attached to Dataflow or DSD:
... ... @@ -318,13 +318,13 @@
318 318  Example :
319 319  
320 320  DD_DIM (to hide drilldown control concept)
321 -)))|(% style="width:866px" %)
322 -|(% 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)|(((
323 323  Either:
324 324  
325 325  * an artefact, or;
326 326  * a Dimension
327 -)))|(% style="width:506px" %) |(% style="width:178px" %)(((
337 +)))| |(((
328 328  Attached to Dimension: <blank>
329 329  
330 330  Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,…
... ... @@ -332,13 +332,13 @@
332 332  //Example~://
333 333  
334 334  REF_AREA,MEASURE
335 -)))|(% style="width:866px" %)
336 -|(% 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)|(((
337 337  Either:
338 338  
339 339  * an artefact, or;
340 340  * a Dimension
341 -)))|(% style="width:506px" %) |(% style="width:178px" %)(((
351 +)))| |(((
342 342  Attached to Dimension: <blank>
343 343  
344 344  Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,…
... ... @@ -346,33 +346,33 @@
346 346  //Example~://
347 347  
348 348  TIME_PERIOD
349 -)))|(% style="width:866px" %)
350 -|(% 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| |(((
351 351  <concept Id>,<concept Id>,...
352 352  
353 353  //Example~://
354 354  
355 355  OBS_STATUS,CONF_STATUS
356 -)))|(% style="width:866px" %)
357 -|(% 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| |(((
358 358  <concept Id>,<concept Id>,...
359 359  
360 360  //Example~://
361 361  
362 362  OBS_STATUS,CONF_STATUS
363 -)))|(% style="width:866px" %)
364 -|(% style="width:152px" %)(((
373 +)))|
374 +|(((
365 365  METADATA
366 366  
367 367  
368 -)))|(% 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" %)
369 -|(% 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.|(((
370 370  Either:
371 371  
372 372  * an artefact, or;
373 373  
374 374  a Dimension
375 -)))|(% style="width:506px" %) |(% style="width:178px" %)(((
385 +)))| |(((
376 376  Attached to Dimension: <blank>
377 377  
378 378  Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,…
... ... @@ -380,12 +380,12 @@
380 380  //Example~://
381 381  
382 382  SEX
383 -)))|(% style="width:866px" %)
384 -|(% style="width:152px" %)EXT_RESOURCE|(% style="width:559px" %)(((
393 +)))|
394 +|EXT_RESOURCE|(((
385 385  A localised link to an external resource associated to the annotated artefact. For example, an ontology item
386 386  
387 387  //a methodology// en:<a href:"[[https:~~/~~/ec.europa.eu/eurostat/web/waste/methodology>>url:https://ec.europa.eu/eurostat/web/waste/methodology]]">
388 -)))|(% style="width:20px" %)Any SDMX object|(% style="width:506px" %)(((
398 +)))|Any SDMX object|(((
389 389  For localised content in SDMX 2.1
390 390  
391 391   <language>:<HTML containing URL to the resource>,
... ... @@ -395,7 +395,7 @@
395 395  //Example~://
396 396  
397 397  en:<a href=”[[http:~~/~~/rdf-vocabulary.ddialliance.org/xkos#depth>>url:http://rdf-vocabulary.ddialliance.org/xkos#depth]]”>
398 -)))|(% style="width:178px" %) |(% style="width:866px" %)(((
408 +)))| |(((
399 399  See section URL value defaults and specific locale values.
400 400  
401 401  //Example~://
... ... @@ -402,29 +402,29 @@
402 402  
403 403  http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth
404 404  )))
405 -|(% style="width:152px" %)COMBINED_CONCEPTS|(% style="width:559px" %)(((
415 +|COMBINED_CONCEPTS|(((
406 406  Comma-separated list of concept IDs to show as a concatenated label.
407 407  
408 408  The listed concepts’ item contents may be concatenated to generate the target concept.
409 409  
410 410  Multiple target concept combinations can be defined by separating the target concepts by ;
411 -)))|(% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %)(((
421 +)))|Dataflow or DSD|(((
412 412  <language>:<display name>,
413 413  
414 414  <language>:<display name>
415 415  
416 416  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}
417 -)))|(% style="width:178px" %) |(% style="width:866px" %)
418 -|(% style="width:152px" %)(deprecated) UNIT_MEASURE_CONCEPTS|(% style="width:559px" %)(((
427 +)))| |
428 +|(deprecated) UNIT_MEASURE_CONCEPTS|(((
419 419  Comma-separated list of concept IDs that is used to define the full unit of measure. The concepts must be in the DSD.
420 420  
421 421  The listed concepts’ item contents may be concatenated to generate the unit of measure label (unless the UNIT_MEASURE_LABEL annotation is present).
422 -)))|(% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %) |(% style="width:178px" %)(((
432 +)))|Dataflow or DSD| |(((
423 423  <concept Id>,<concept Id>,…
424 424  
425 425  //Example~:// UNIT_MEASURE,UNIT_MULT,TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed]
426 -)))|(% style="width:866px" %)
427 -|(% style="width:152px" %)(deprecated) UNIT_MEASURE_LABEL|(% style="width:559px" %)(((
436 +)))|
437 +|(deprecated) UNIT_MEASURE_LABEL|(((
428 428  Indicates the concept that enumerates the full unit of measure labels.
429 429  
430 430  The concept must be in the DSD. UNIT_MEASURE_LABEL overrides the UNIT_MEASURE_CONCEPTS if both are provided.
... ... @@ -434,7 +434,7 @@
434 434  Text en:Gram
435 435   fr: Gramme
436 436  url:** **[[**http:~~/~~/data.europa.eu/gzn/su/G**>>url:http://data.europa.eu/gzn/su/G]]
437 -)))|(% style="width:20px" %)Dataflow or DSD, Item in an Item Scheme|(% style="width:506px" %)(((
447 +)))|Dataflow or DSD, Item in an Item Scheme|(((
438 438  This is optional, used if a freetext label is required.
439 439  
440 440  <language>:<content>,
... ... @@ -446,7 +446,7 @@
446 446  en:USD, thousands
447 447  
448 448  fr:USD, milliers
449 -)))|(% style="width:178px" %)(((
459 +)))|(((
450 450  This is optional, used if an enumerated list is required.
451 451  
452 452  <concept Id>
... ... @@ -459,21 +459,21 @@
459 459  * USD, thousands
460 460  
461 461  Index, based on National Currency]
462 -)))|(% style="width:866px" %)
463 -|(% style="width:152px" %)(((
472 +)))|
473 +|(((
464 464  LAYOUT_TIME_PERIOD_DESC
465 465  
466 466  
467 -)))|(% 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| |(((
468 468  //Example~://
469 469  
470 470  LAYOUT_TIME_PERIOD_DESC
471 -)))|(% style="width:866px" %)
472 -|(% style="width:152px" %)(((
481 +)))|
482 +|(((
473 473  LAYOUT_CELL_ALIGN
474 474  
475 475  
476 -)))|(% 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|(((
477 477  <language>:<content>,
478 478  
479 479  <language>:<content>,…
... ... @@ -480,168 +480,300 @@
480 480  
481 481  
482 482  <content> values:RIGHT or LEFT
483 -)))|(% style="width:178px" %)Content values:RIGHT or LEFT|(% style="width:866px" %)
484 -|(% style="width:152px" %)(((
493 +)))|Content values:RIGHT or LEFT|
494 +|(((
485 485  MAX_TABLE_DATA
486 486  
487 487  
488 -)))|(% 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| |(((
489 489  <integer>
490 490  
491 491  //Example~://
492 492  
493 493  15000
494 -)))|(% style="width:866px" %)
495 -|(% style="width:152px" %)(((
504 +)))|
505 +|(((
496 496  MAXTEXTATTRIBUTELENGTH
497 497  
498 498  
499 -)))|(% 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| |(((
500 500  <integer>
501 501  
502 502  //Example~://
503 503  
504 504  500
505 -)))|(% style="width:866px" %)
506 -|(% 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|(((
507 507  <language>:<integer>,...
518 +
508 508  //Example~://
520 +
509 509  "en":"3","es":"4","fr":"5"
510 -)))|(% style="width:178px" %)(((
522 +)))|(((
511 511  <integer>
512 512  
513 513  //Example~://
514 514  
515 515  10
516 -)))|(% style="width:866px" %)
528 +)))|
517 517  
518 518  == Codelist and Statistical Classification-specific Annotations ==
519 519  
520 -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]].
521 521  
522 -|**Annotation Type**|(% style="width:524px" %)**Use Case**|(% style="width:198px" %)**Where to attach**|(% style="width:237px" %)(((
523 -**+Text
524 -(% style="background-color:transparent" %)Blue is optional(%%)**
525 -)))|(% style="width:320px" %)(((
526 -**Title
527 -(% style="background-color:transparent" %)Blue is optional(%%)**
528 -)))|(% style="width:203px" %)(((
529 -**SDMX 2.1:URL
534 +|Annotation Type|Use Case|Where to attach|(((
535 ++Text
536 +
537 +Blue is optional
538 +)))|(((
539 +Title
540 +
541 +Blue is optional
542 +)))|(((
543 +SDMX 2.1:URL
544 +
530 530  SDMX >=3.0:+URL
531 -(% style="background-color:transparent" %)Blue is optional(%%)**
546 +
547 +Blue is optional
532 532  )))
533 -|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 
534 -en: A0123 Growing of citrus fruits|(% style="width:198px" %)Item in an Item Scheme|(% style="width:237px" %)(((
535 -<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 +
536 536  //Example~://
537 -(% style="background-color:transparent" %)en:Labour force (Employment)
538 -)))|(% style="width:320px" %)<content>|(% style="width:203px" %)
539 -|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" %)(((
540 -<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 +
541 541  //Example~://
542 -(% style="background-color:transparent" %)CUST_BREAKDOWN:CUST_BREAKDOWN_LB
543 -)))|(% style="width:203px" %)
544 -|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" %)(((
545 -<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 +)))|(((
546 546  //Example~://
547 -(% style="background-color:transparent" %)REF_AREA:M49_CODE
548 -)))|(% style="width:203px" %)
549 -|COMPLEMENT|(% style="width:524px" %)(((
550 -Additional fixed text to be displayed in parenthesis after the code name.
551 -(% style="background-color:transparent" %)E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes(%%)
552 -(% style="background-color:transparent" %)en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW)(%%)
553 -(% style="background-color:transparent" %)en: 01 03 99 wastes not otherwise specified (NHAZW)
554 -)))|(% style="width:198px" %)Item in an Item Scheme|(% style="width:237px" %)(((
555 -<language>:<content>,<language>:<content>,…
556 556  
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 +)))|(((
557 557  //Example~://
558 -(% style="background-color:transparent" %)en:See reference metadata
559 -)))|(% style="width:320px" %)<content>|(% style="width:203px" %)
560 -|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" %)(((
561 -Either:
562 562  
563 -* an artefact, or;
564 -* an item in an Item Scheme
565 -)))|(% style="width:237px" %)(((
566 -<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>,
567 567  
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 +
568 568  //Example~://
569 -(% style="background-color:transparent" %)en:10,es:20
570 -)))|(% style="width:320px" %)<content>|(% style="width:203px" %)
571 -|TOTAL|(% style="width:524px" %)(((
572 -Code Item that represents a total value. If the attachment is:
573 573  
574 -* to a Code, the Annotation Text is optional and may contain an explanatory text;
575 -* to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total
576 -)))|(% style="width:198px" %)(((
577 -Either:
675 +A1+A2
676 +)))|
677 +|FOLLOWS|(((
678 +A reference used to express the succession in time of Item Schemes.
578 578  
579 -* a Code Item that represents a total value, or;
580 -* a Codelist to specify the code(s) with the total
581 -)))|(% style="width:237px" %)(((
582 -<language>:<explanatory text>, 
583 -(% style="background-color:transparent" %)<language>:<explanatory text>,…
584 -)))|(% style="width:320px" %)(((
585 -Attached to Code Item: <blank>
586 -(% style="background-color:transparent" %)Attached to Codelist: <code>,<code>,…
587 -)))|(% style="width:203px" %)
588 -|DRILLDOWN|(% style="width:524px" %)Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|(% style="width:198px" %)(((
589 -Either:
680 +For example, NACE Rev. 2 is the successor of NACE Rev. 1.1
590 590  
591 -* A Dataflow or DSD
592 -)))|(% style="width:237px" %) |(% style="width:320px" %)(((
593 -<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 +
594 594  //Example~://
595 -(% style="background-color:transparent" %)DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below)
596 -)))|(% style="width:203px" %)
597 -|DEPRECATED|(% style="width:524px" %)(((
598 -Indication that an Item in an Item Scheme or an artefact is deprecated.
599 -For an item scheme item, the annotation value provides a replacement name for the code name.
600 -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.
601 -Suggestion to use a controlled vocabulary
602 -url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/CURRENT>>url:http://publications.europa.eu/resource/authority/concept-status/CURRENT]]>
603 -url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/DEPRECATED>>url:http://publications.europa.eu/resource/authority/concept-status/DEPRECATED]]>
604 -or
605 -(% style="background-color:transparent" %)TITLE: true (false)
606 -)))|(% style="width:198px" %)(((
607 -Either:
608 608  
609 -* an artefact, or;
610 -* an item in an Item Scheme
611 -)))|(% style="width:237px" %)(((
612 -For item scheme item:
688 +(CL_REGIONAL 3.1.1 follows CL_REGIONAL 3.1):
613 613  
614 -<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).
615 615  
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 +
616 616  //Example~://
617 -(% style="background-color:transparent" %)en:deprecated,fr:obsolète
618 -)))|(% style="width:320px" %)<content>|(% style="width:203px" %)(((
619 -For artefact:
620 -<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 +
621 621  )))
622 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
623 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
624 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
625 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
626 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
627 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
628 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
629 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
630 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
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" %)
734 +|COVERAGE_LABEL|(((
735 +Label(s) of the item scheme’s coverage (e.g. National Accounts, Products, Activities, Occupations)
633 633  
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 +
634 634  = Concept Scheme SDMX:CS_ANNOT =
635 635  
636 636  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.
637 637  
638 -|**Property**|(% style="width:309px" %)**Representation in Concept**|(% style="width:1173px" %)**Description**
639 -|**Code**|(% style="width:309px" %)Concept Id|(% style="width:1173px" %)The Annotation Type column, e.g. NOT_DISPLAYED, EXCLUDES
640 -|**Name**|(% style="width:309px" %)Concept Name|(% style="width:1173px" %)Short description of the standard Annotation derived from the “Use case” column
641 -|**Representation**|(% style="width:309px" %)Concept Core Representation|(% style="width:1173px" %)Allowable type or format for the Annotation
642 -|**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
643 -|**Artefact(s)**|(% style="width:309px" %)Annotation Type: Artefact(s)|(% style="width:1173px" %)The information in the “Where to attach” column
644 -|**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
645 645  
646 646  == Example of a Concept ==
647 647  
... ... @@ -651,6 +651,8 @@
651 651  |**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
652 652  |**Concept: Annotation: Type: Artefact(s)**|Either a Dataflow or DSD, or an item in an item scheme
653 653  
796 +=== ===
797 +
654 654  === SDMX-ML of the Example ===
655 655  
656 656  <str:Concept id="NOT_DISPLAYED">
... ... @@ -678,4 +678,8 @@
678 678  
679 679  ----
680 680  
681 -{{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