Codelist extensions
The Reference Data tool provides a mechanism that allows code list editors to extend the content of the code list for different purposes in a controlled manner. Currently, around ten extension types are available in the Reference Data tool.
More detailed instructions are available on GitHubOpens in a new window. (in Finnish).
The key parts of the extension mechanism in the Reference Data tool are extension type, extension and member.
Extension type |
|
|---|---|
Extension |
|
Member |
|
The extension types provided by the Reference Data tool can be divided into two categories in terms of their key characteristics.
hierarchy extensions and code extensions. Hierarchy extensions can be used to form hierarchic compilations of codes. Code extensions in turn can be used to add new information fields to codes.
Hierarchy extensions |
|
|---|---|
Code extensions |
|
The extension types supported by the Reference Data tool are presented in this table.
Extension type | Archetype | Description |
|---|---|---|
Definition hierarchy | Hierarchy extension | Enables the creation of an alternative hierarchy of codes. The hierarchy can incorporate codes from one or multiple code sets, and from each code set either the entire set or a selected subset of codes can be included. Each member of the hierarchy can be assigned a descriptive label to clarify its role within the hierarchy. |
Calculation hierarchy | Hierarchy extension | Functionally equivalent to the Definition hierarchy extension, but additionally supports defining aggregation and comparison operators for each member of the hierarchy |
Code map | Hierarchy extension | Enables the creation of one-way linkage between codes. The codes to be linked may come from one or more codelists. |
DPM Metric | Code extension | Adds the fields required by the Metric concept defined in the Data Point Modeling (DPM) methodology to the code’s data structure. This enables representing DPM Metric concepts as codes within the Reference Data tool. |
DPM Explicit Domain | Code extension | Functionally equivalent to the DPM Metric extension but includes the fields required by the DPM Explicit Domain concept. |
DPM Typed Domain | Code extension | Functionally equivalent to the DPM Metric extension, but includes the fields required by the DPM Typed Domain concept. |
DPM Dimension | Code extension | Functionally equivalent to the DPM Metric extension, but includes the fields required by the DPM Dimension concept. |