Codelist
Contents
Overview
An SDMX Codelist is a managed list of classification codes.
| Structure Type | Standard SDMX Structural Metadata Artefact |
| Maintainable | Yes |
| Identifiable | Yes |
| Item Scheme | Yes |
| SDMX Information Model Versions | 1.0, 2.0, 2.1 |
| Concept ID | CODELIST |
SDMX Information Model
Usage
SDMX Codelists are lists of classification codes principally used for defining the set of allowed values for enumerated components in Data Structure Definitions or Metadata Structure Definitions.
Each code is treated as a separated Item so must have an ID and a Name, but can also have an optional Description. While Code IDs are unique within a Codelist, the same Code ID may be safely used in other Codelists. For instance: The code 'A' may be used in a Frequency Codelist to represent 'Annual', but also appear in an Industry Codelist to represent 'Agriculture'.
Conventions
CL_ Codelist ID Prefix
Codelist IDs are given a 'CL_' prefix to distinguish them from other structures. For instance: CL_FREQ, CL_REF_AREA, CL_AGE.
Code ID Conventions
Codes can take any legal SDMX ID. But there are several conventions that should be taken into account when choosing Code IDs:
| Use uppercase for Code IDs | By convention, Code ID's are in uppercase such as 'ABC'. Lower case Codes are valid (for example 'abc'), but care should be taken in their use to avoid confusion. |
| '_Z' Code | The '_Z' code is conventionally used for the Undefined and Unknown classification. |
| 'TOTAL' Code | The 'TOTAL' code represents the total or sum of the dimension. For a 'country' dimension, series with TOTAL would indicate the sum of observation values for all countries. |
Examples
A Simple Frequency Codelist: CL_FREQ
| Code ID | Code Name |
|---|---|
| A | Annual |
| S | Half-yearly, semester |
| Q | Quarterly |
| M | Monthly |
| W | Weekly |
| D | Daily |
| B | Daily - Business Week |
| N | Minutely |
Codes Optional Descriptions: CL_ADJUSTMENT
| K | Calendar component | Synonyms: Calendar effects; calendar factors |
| X | Seasonal component | Synonyms: Seasonal effects; seasonal factors |
| M | Seasonal and calendar components | Synonyms: Seasonal and calendar effects; seasonal and calendar factors |
| I | Irregular component | Synonym: Irregular effects |
| N | Neither seasonally adjusted nor calendar adjusted data | Synonyms: Raw data; unadjusted data |
