...
| Warning |
|---|
|
The Ordered Reference Set pattern is now deprecated as it has been replaced with two reference set types each of which is specific to one of the two distinct use cases supported by the Ordered Reference set pattern. The recommended Reference sets to address the purposes identified below are now: - 54.2.2. Ordered Component Reference Set
- This allows an ordered or prioritized list of components to be represented.
- It omits the linkedToId field in the pattern shown below as this is not required to address this use case.
- 5.2.6 1.5 Ordered Association Reference Set
- This enables representation of alternative navigation hierarchies (in which child concepts are ordered) and also also supports representation of groups of ordered components.
- The linkedToId field in the pattern shown below is replaced by the targetComponentId (this name is used to align with the 5.2.1.5 4 Association Reference Set (used from unordered associations).
Deprecation does not prevent continued use of an existing reference set pattern. However it does indicate that a different solution is now specified and recommended to meet the requirements for this pattern |
Purpose
An
| Concept |
|---|
| t | 447258008|Ordered type reference set| |
|---|
| ShowFormat | inline |
|---|
|
allows a collection of
to be defined with a specified given a priority ordering. This type of
| Gloss |
|---|
| PreSpace | false |
|---|
| t | reference ret |
|---|
|
can also be used to specify ordered associations between different
. These can be used to specify several interrelated subsets of components and to define alternative hierarchies for navigation and selection of
or
| Gloss |
|---|
| PreSpace | false |
|---|
| t | descriptions |
|---|
|
.
Data structure
An
| Gloss |
|---|
| PreSpace | false |
|---|
| t | Ordered reference set |
|---|
|
is an
Integer | Gloss |
|---|
| PreSpace | false |
|---|
| t | reference set |
|---|
|
is used to represent ordered lists and alternative hierarchies. Its structure is shown in the following table.
...
Field | Data type | Purpose |
|---|
| | A 128 bit unsigned | Specref |
|---|
| RefType | (data type) |
|---|
| t | Integer |
|---|
|
, uniquely identifying this | Gloss |
|---|
| PreSpace | false |
|---|
| t | reference set member |
|---|
|
. Different versions of a reference set member share the same but have different | Specref |
|---|
| RefType | (field) |
|---|
| t | effectiveTime |
|---|
|
. This allows a reference set member to be modified or made (i.e. removed from the active set) at a specified time. |
| Specref |
|---|
| RefType | (field) |
|---|
| t | effectiveTime |
|---|
|
| | The inclusive date or time at which this version of the identified | Gloss |
|---|
| PreSpace | false |
|---|
| t | reference set member |
|---|
|
became the current version. The current version of this | Gloss |
|---|
| PreSpace | false |
|---|
| t | reference set member |
|---|
|
at time T is the version with the most recent | Specref |
|---|
| RefType | (field) |
|---|
| t | effectiveTime |
|---|
|
prior to or equal to time T . |
| | Specref |
|---|
| RefType | (data type) |
|---|
| t | Boolean |
|---|
|
| The state of the identified | Gloss |
|---|
| PreSpace | false |
|---|
| t | reference set member |
|---|
|
as at the specified | Specref |
|---|
| RefType | (field) |
|---|
| t | effectiveTime |
|---|
|
. If = 1 (true) the | Gloss |
|---|
| PreSpace | false |
|---|
| t | reference set member |
|---|
|
is part of the current version of the set, if = 0 (false) the | Gloss |
|---|
| PreSpace | false |
|---|
| t | reference set member |
|---|
|
is not part of the current version of the set. |
| | Identifies the | Gloss |
|---|
| PreSpace | false |
|---|
| t | SNOMED CT module |
|---|
|
that contains this | Gloss |
|---|
| PreSpace | false |
|---|
| t | reference set member |
|---|
|
as at the specified | Specref |
|---|
| RefType | (field) |
|---|
| t | effectiveTime |
|---|
|
. The value must be a of | Concept |
|---|
| t | 900000000000443000|Module (core metadata concept)| |
|---|
| ShowFormat | inline |
|---|
|
within the metadata . |
| | Identifies the | Gloss |
|---|
| PreSpace | false |
|---|
| t | reference set |
|---|
|
to which this | Gloss |
|---|
| PreSpace | false |
|---|
| t | reference set member |
|---|
|
belongs. In this case, set to a of | Concept |
|---|
| t | 447258008|Ordered type reference set| |
|---|
|
|
| Specref |
|---|
| RefType | (field) |
|---|
| t | referencedComponentId |
|---|
|
| | The identifier of a | Gloss |
|---|
| PreSpace | false |
|---|
| t | SNOMED CT component |
|---|
|
that is included in the ordered list of alternative hierarchy. |
| Integer | Specifies the sort of the list. The list is ordered by applying an ascending sort of the value.The value of =1 represents the highest priority. A value of '0' is not allowed. Duplicate values are permitted and the sort order between two members with the same order value is not defined.If the | Specref |
|---|
| RefType | (field) |
|---|
| t | linkedToId |
|---|
|
value is not 0, sorting occurs within subgroups that share the same | Specref |
|---|
| RefType | (field) |
|---|
| t | linkedToId |
|---|
|
.Note: The name "order" is a reserved word in some database environments. Please consider this when using this column. |
| Specref |
|---|
| RefType | (field) |
|---|
| t | linkedToId |
|---|
|
| | The identifier of a | Gloss |
|---|
| PreSpace | false |
|---|
| t | SNOMED CT component |
|---|
|
that acts as a grouper or hierarchy node, collecting together a subgroup from within the list. This field either enables | Gloss |
|---|
| PreSpace | false |
|---|
| t | reference set member |
|---|
|
linked into a number of subgroups. These subgroups can be nested allowing representation of alternative hierarchies. To link members into a subgroup, all components in the same subgroup should reference the same . This can either be a component that represents the name of that subgroup or the first member of the subgroup. In the latter case, the first row of each subgroup will contain the same identifier in | Specref |
|---|
| RefType | (field) |
|---|
| t | referencedComponentId |
|---|
|
and | Specref |
|---|
| RefType | (field) |
|---|
| t | linkedToId |
|---|
|
and with =1. To link a number of to a single parent , one member record should exist per , with the | Specref |
|---|
| RefType | (field) |
|---|
| t | referencedComponentId |
|---|
|
field referencing the parent and this field referencing the . The field is then used to the under the parent . For ordered lists that do not require grouping or hierarchical arrangement the value of | Specref |
|---|
| RefType | (field) |
|---|
| t | linkedToId |
|---|
|
should be the digit zero (0). |
The following metadata in the "Foundation metadata
"
supports this
| Gloss |
|---|
| PreSpace | false |
|---|
| t | reference set |
|---|
|
...
| Excerpt Include |
|---|
| REUSE:Notes on Reference Set Example Tables |
|---|
| REUSE:Notes on Reference Set Example Tables |
|---|
| nopanel | true |
|---|
|
Descriptor Template
The tables below show the descriptor that defines the structure of the
| Concept |
|---|
| t | 447258008|Ordered type reference set| |
|---|
| ShowFormat | inline |
|---|
|
pattern and an example of descriptor for a
| Gloss |
|---|
| PreSpace | false |
|---|
| t | reference set |
|---|
|
that follows this pattern.
...
refsetId | referencedComponentId | attributeDescription | attributeType | attributeOrder |
|---|
| Concept |
|---|
| t | 900000000000456007|Reference set descriptor| |
|---|
|
| | Concept |
|---|
| t | 447258008|Ordered type reference set| |
|---|
|
| | Concept |
|---|
| t | 449608002|Referenced component| |
|---|
|
| | Concept |
|---|
| t | 900000000000460005|Component type| |
|---|
|
| 0 |
| Concept |
|---|
| t | 900000000000456007|Reference set descriptor| |
|---|
|
| | Concept |
|---|
| t | 447258008|Ordered type reference set| |
|---|
|
| | Concept |
|---|
| t | 447255006|Priority order reference set attribute| |
|---|
|
| | Concept |
|---|
| t | 900000000000478000|Unsigned integer| |
|---|
|
| 1 |
|---|
| Concept |
|---|
| t | 900000000000456007|Reference set descriptor| |
|---|
|
| | Concept |
|---|
| t | 447258008|Ordered type reference set| |
|---|
|
| | Concept |
|---|
| t | 447257003|"Linked to" reference set attribute| |
|---|
|
| | Concept |
|---|
| t | 900000000000460005|Component type| |
|---|
|
| 2 |
Example Data
| Caption label |
|---|
| CapId | sample-content-for-an-ordered-reference-set |
|---|
| CapType | Table |
|---|
|
Sample Content for an Ordered Reference Set |
...