Difference between revisions of "Structure IDs, Names and Descriptions"

From FMR Knowledge Base
Jump to navigation Jump to search
Line 1: Line 1:
 
[[Category:FMR_Concepts_Reference]]
 
[[Category:FMR_Concepts_Reference]]
 
=Overview=
 
=Overview=
[[Identifiable]] structures are identified by an ID.<br>
+
[[Identifiable]] structures are identified by a unique ID.<br>
[[Maintainable]] and [[Nameable]] structures are also [[Identifiable]] and therefore must have an ID but in addition have a Name, and an optional Description.
+
[[Maintainable]] and [[Nameable]] structures are also [[Identifiable]] and therefore must have an ID, but in addition have a Name, and an optional Description.
  
 
=ID=
 
=ID=
An ID is mandatory for Identifiable structures and serves as a unique reference as part of each structure's [[URN]].
+
An ID is a string that is mandatory for Identifiable structures and serves as a unique reference as part of each structure's [[URN]].
  
The ID given to an Identifiable is restricted to a range of allowble characters:
 
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
Line 22: Line 20:
 
|}
 
|}
  
The [[URN]] is derived from properties of the structure, such as the type of structure, the Agency Id, Id, and Version.  As such the [[URN]] is not user supplied, but system generated.
+
By covention, IDs are uppercase, but lowercase characters can also be used.
 +
 
 +
ID Examples:
 +
{| class="wikitable"
 +
|-
 +
! Header text !! Header text
 +
|-
 +
| Agency || SDMX
 +
|-
 +
| Agency || IMF
 +
|-
 +
| Concept Scheme || CROSS_DOMAIN_CONCEPTS
 +
|-
 +
| Codelist | CL_REF_AREA
 +
|-
 +
| Data Structure Definition | ECOFIN_DSD
 +
|-
 +
| Dataflow | WDI_HEALTH
 +
|}

Revision as of 03:11, 20 January 2021

Overview

Identifiable structures are identified by a unique ID.
Maintainable and Nameable structures are also Identifiable and therefore must have an ID, but in addition have a Name, and an optional Description.

ID

An ID is a string that is mandatory for Identifiable structures and serves as a unique reference as part of each structure's URN.

Allowable Content Example
Alpha Numeric A-Z a-z 0-9
Dollar $
Hyphen -
Underscore _

By covention, IDs are uppercase, but lowercase characters can also be used.

ID Examples:

Header text Header text
Agency SDMX
Agency IMF
Concept Scheme CROSS_DOMAIN_CONCEPTS
CL_REF_AREA
ECOFIN_DSD
WDI_HEALTH