Difference between revisions of "Structure IDs, Names and Descriptions"
Jump to navigation
Jump to search
m (Glenn moved page Structure IDs, Names and Descriptions - FMR to Structure IDs, Names and Descriptions without leaving a redirect) |
|||
| Line 1: | Line 1: | ||
[[Category:FMR_Concepts_Reference]] | [[Category:FMR_Concepts_Reference]] | ||
| − | + | =Overview= | |
| + | [[Identifiable]] structures are identified by their ID. | ||
| + | [[Maintainable]] and [[Nameable]] structures are also [[Identifiable]] 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: | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! 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. | ||
Revision as of 01:42, 20 January 2021
Overview
Identifiable structures are identified by their ID. Maintainable and Nameable structures are also Identifiable 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.
