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 their ID.
+
[[Identifiable]] structures are identified by an ID.<br>
[[Maintainable]] and [[Nameable]] structures are also [[Identifiable]] 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=

Revision as of 02:43, 20 January 2021

Overview

Identifiable structures are identified by an 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 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:

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

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.