Difference between revisions of "Hierarchical Codelist"
(→Conventions) |
|||
| (19 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:SDMX Structures]] | + | __NOTOC__ |
| + | [[Category:SDMX 2.1 Structures]] | ||
=Overview= | =Overview= | ||
| − | Hierarchical Codelists | + | Hierarchical Codelists are used for data discovery by allowing complex hierarchies of codes to be defined, potentially from multiple different code lists. Software tools designed for users to explore and search a catalogue of data sets typically use Hierarchical Codelists to display a tree structure much like Windows File Explorer. |
| + | |||
| + | In SDMX 2.1, Hierarchical Codelists do not explicitly link to any other structures like Dataflows. As such, the result of a user choosing a code is left entirely to the designers of the tools. | ||
| + | |||
| + | The principal features of the '''Hierarchical Codelist''' are: | ||
| + | * A child code can have more than one parent. | ||
| + | * There can be more than one code that has no parent (known as Root codes in the Registry). | ||
| + | * There may be many hierarchies (or “views”) defined, in terms of the associations between the codes. Each hierarchy serves a particular purpose in the reporting, analysis, or dissemination of data. | ||
| + | * The levels in a hierarchy can be explicitly defined or they can be implicit: (i.e., they exist only as parent/child relationships in the coding structure). | ||
| + | |||
==Structure Properties== | ==Structure Properties== | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 8: | Line 18: | ||
|- | |- | ||
! scope=row style="text-align: left;" | Maintainable | ! scope=row style="text-align: left;" | Maintainable | ||
| − | | [[Maintainable|Yes]] | + | | [[Maintainable V10|Yes]] |
|- | |- | ||
! scope=row style="text-align: left;" | Identifiable | ! scope=row style="text-align: left;" | Identifiable | ||
| − | | [[Identifiable|Yes]] | + | | [[Identifiable V10|Yes]] |
|- | |- | ||
! scope=row style="text-align: left;" | Item Scheme | ! scope=row style="text-align: left;" | Item Scheme | ||
| − | | [[ | + | | [[Item_Scheme_V10|Yes]] |
|- | |- | ||
| Line 20: | Line 30: | ||
| 2.0, 2.1 | | 2.0, 2.1 | ||
|- | |- | ||
| − | ! scope=row style="text-align: left;" | URN - | + | ! scope=row style="text-align: left;" | URN - HierarchicalCodelist namespace |
| − | | <nowiki>urn:sdmx:org.sdmx.infomodel. | + | | <nowiki>urn:sdmx:org.sdmx.infomodel.codelist.hierarchicalcodelist </nowiki> |
|- | |- | ||
| − | |||
| − | |||
|} | |} | ||
==Context within the SDMX 2.1 Information Model== | ==Context within the SDMX 2.1 Information Model== | ||
| − | [[File:HCL1.png| | + | [[File:HCL1.png|Hierarchical Codelist|600px]]<br> |
| + | |||
| + | ==Usage== | ||
| + | Codes used in the Hierarchical Codelist are not themselves contained in the list. Instead, they are referenced from the lists and are therefore maintained in one of more Codelists. In the Registry, these are known as Referenced Codelists. | ||
| − | + | A Hierarchical Codelist may contain many hierarchies and is multi-lingual. | |
| − | + | [[Hierarchal_Codelists|Creating and maintaining Hierarchical Codelists]] | |
| − | |||
==Conventions== | ==Conventions== | ||
'''Heirarchial Codelist IDs''' | '''Heirarchial Codelist IDs''' | ||
| − | IDs are conventionally uppercase using underscores '_' as separators if required. | + | IDs are conventionally uppercase using underscores '_' as separators if required. |
| − | + | Note that organisations wishing to be compliant with accepted models for statistical classifications should ensure that the Id is the number associated with the '''Level''', where Levels are numbered consecutively starting with level 1 at the highest Level. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | [[ | + | [[Identifiable V10|You can seem more examples and information on Identities in this article]]. |
Latest revision as of 03:29, 30 March 2024
Overview
Hierarchical Codelists are used for data discovery by allowing complex hierarchies of codes to be defined, potentially from multiple different code lists. Software tools designed for users to explore and search a catalogue of data sets typically use Hierarchical Codelists to display a tree structure much like Windows File Explorer.
In SDMX 2.1, Hierarchical Codelists do not explicitly link to any other structures like Dataflows. As such, the result of a user choosing a code is left entirely to the designers of the tools.
The principal features of the Hierarchical Codelist are:
- A child code can have more than one parent.
- There can be more than one code that has no parent (known as Root codes in the Registry).
- There may be many hierarchies (or “views”) defined, in terms of the associations between the codes. Each hierarchy serves a particular purpose in the reporting, analysis, or dissemination of data.
- The levels in a hierarchy can be explicitly defined or they can be implicit: (i.e., they exist only as parent/child relationships in the coding structure).
Structure Properties
| Structure Type | Standard SDMX Structural Metadata Artefact |
|---|---|
| Maintainable | Yes |
| Identifiable | Yes |
| Item Scheme | Yes |
| SDMX Information Model Versions | 2.0, 2.1 |
| URN - HierarchicalCodelist namespace | urn:sdmx:org.sdmx.infomodel.codelist.hierarchicalcodelist |
Context within the SDMX 2.1 Information Model
Usage
Codes used in the Hierarchical Codelist are not themselves contained in the list. Instead, they are referenced from the lists and are therefore maintained in one of more Codelists. In the Registry, these are known as Referenced Codelists.
A Hierarchical Codelist may contain many hierarchies and is multi-lingual.
Creating and maintaining Hierarchical Codelists
Conventions
Heirarchial Codelist IDs IDs are conventionally uppercase using underscores '_' as separators if required.
Note that organisations wishing to be compliant with accepted models for statistical classifications should ensure that the Id is the number associated with the Level, where Levels are numbered consecutively starting with level 1 at the highest Level.
You can seem more examples and information on Identities in this article.
