Deprecation Notice
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:
An 447258008 |Ordered type reference set| allows a collection of components to be defined with a specified given a priority ordering. This type of reference ret can also be used to specify ordered associations between different components. These can be used to specify several interrelated subsets of components and to define alternative hierarchies for navigation and selection of concepts or descriptions.
An Ordered Reference Set is an Integer Component Reference Set used to represent ordered lists and alternative hierarchies. Its structure is shown in the following table.
Ordered reference set - Data structure
The following metadata in the "Foundation metadata concept" hierarchy supports this reference set.
Ordered References Sets in the Metadata Hierarchy
The tables below show the descriptor that defines the structure of the pattern and an example of descriptor for a reference set that follows this pattern.
Refset Descriptor rows for Ordered Reference Set
Sample Content for an Ordered Reference Set
Boolean
The state of the identified reference set member as at the specified effectiveTime. If active = 1 (true) the reference set member is part of the current version of the set, if active = 0 (false) the reference set member is not part of the current version of the set.
YES
NO
moduleId
SCTID
Identifies the SNOMED CT module that contains this reference set member as at the specified effectiveTime .
The value must be a subtype of within the metadata hierarchy.
YES
NO
refsetId
SCTID
Identifies the reference set to which this reference set member belongs.
A subtype descendant of:
NO
NO
referencedComponentId
SCTID
A reference to the SNOMED CT component to be included in the reference set.
NO
NO
order
Integer
Specifies the sort order of the list. The list is ordered by applying an ascending sort of the order value.
The value of order =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 linkedToId value is not 0, sorting occurs within subgroups that share the same linkedToId.
Note: The name "order" is a reserved word in some database environments. Please consider this when using this column.
YES
NO
linkedToId
SCTID
The identifier of a SNOMED CT component that acts as a grouper or hierarchy node, collecting together a subgroup from within the list.
This field either enables 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 component. 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 referencedComponentId and linkedToId and with order =1.
To link a number of children concepts to a single parent concept, one member record should exist per child, with the referencedComponentId field referencing the parent and this field referencing the child concept. The order field is then used to order the children concepts under the parent concept.
For ordered lists that do not require grouping or hierarchical arrangement the value of linkedToId should be the digit zero (0).
YES
NO
1
2
2
3
4
5
6
7
8
9
10
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.
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 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
id
UUID
A 128 bit unsigned Integer, uniquely identifying this reference set member.Different versions of a reference set member share the same id but have different effectiveTime. This allows a reference set member to be modified or made inactive (i.e. removed from the active set) at a specified time.
NO
YES (Full/Snapshot)
effectiveTime
Time
The inclusive date or time at which this version of the identified reference set member became the current version.
Note : In distribution files the effectiveTime should follow the short ISO date format (YYYYMM DD) and should not include the hours, minutes, seconds or timezone indicator.The current version of this reference set member at time T is the version with the most recent effectiveTime prior to or equal to time T.
YES
YES (Full) Optional (Snapshot)
1
active
0
An |Ordered component type reference set (foundation metadata concept)| allows a collection of components to be defined with a specified order. This type of reference set is therefore useful for creating ordered lists and to specify groups where the components that belong to the same group share the same order.
An Ordered component reference set (an Integer Component reference set) is used to represent ordered lists and alternative hierarchies. Its structure is shown in the following table.
Ordered component reference set - Data structure
The following metadata in the "Foundation metadata concept" hierarchy supports this reference set:
Ordered Component Reference Sets in the Metadata Hierarchy
The tables below show the descriptor that defines the structure of the Ordered component type reference set pattern and an example of descriptor for a specific reference set that follows this pattern.
Refset Descriptor rows for an ordered reference set
Rational ordering of finger concepts using an ordered component reference set
Boolean
The state of the identified reference set member as at the specified effectiveTime .
If active = 1 (true) the reference set member is part of the current version of the set, if active = 0 (false) the reference set member is not part of the current version of the set.
YES
NO
moduleId
SCTID
Identifies the SNOMED CT module that contains this reference set member as at the specified effectiveTime.
The value must be a subtype of within the metadata hierarchy.
YES
NO
refsetId
SCTID
Identifies the reference set to which this reference set member belongs.
In this case, a subtype descendant of:
NO
NO
referencedComponentId
SCTID
A reference to the SNOMED CT component to be included in the reference set.
NO
NO
order
Integer
Specifies the sort order of the list. The list is ordered by applying an ascending sort of the order value.
The value of order =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.
Note: The name "order" is a reserved word in some database environments. Please consider this when using this column.
YES
NO
1
733619002
|Fingers ordered component reference set|
3
733619002
|Fingers ordered component reference set|
4
733619002
|Fingers ordered component reference set|
5
id
UUID
A 128 bit unsigned Integer, uniquely identifying this reference set member.
Different versions of a reference set member share the same id but have different effectiveTime. This allows a reference set member to be modified or made inactive (i.e. removed from the active set) at a specified time.
NO
YES (Full /Snapshot)
effectiveTime
Time
The inclusive date or time at which this version of the identified reference set member became the current version.
Note: In distribution files the effectiveTime should follow the short ISO date format (YYYYMMDD) and should not include the hours, minutes, seconds or timezone indicator.
The current version of this reference set member at time T is the version with the most recent effectiveTime prior to or equal to time T.
YES
YES (Full)
Optional (Snapshot)
733619002
|Fingers ordered component reference set|
1
733619002
|Fingers ordered component reference set|
active
0
2
An 733618005 | Ordered association type reference set (foundation metadata concept)| can be used to specify ordered associations between different components. These can be used to specify several interrelated subsets of components and to define alternative hierarchies for navigation while searching for an appropriate concept or description.
An Ordered association reference set is a component integer reference set that is used to represent ordered lists of associations and alternative hierarchies. Its structure is shown in the following table.
Ordered association reference set - Data structure
The following metadata in the "Foundation metadata concept" hierarchy supports this reference set:
Ordered Association References Set in the Metadata Hierarchy
The tables below show the descriptor that defines the structure of the pattern and an example of descriptor for a specific reference set that follows this pattern.
Refset Descriptor rows for an ordered association type reference set
can be used to specify and display a customized navigation hierarchy. Alternative hierarchical representations of SNOMED CT can support data entry by satisfying the requirements of a specific use case, and addressing some of the challenges of displaying an unordered polyhierarchy (as defined by SNOMED CT's subtype structure).
The figure below shows the way a navigation hierarchy is represented. The example reference set contains a set of description components used to describe finger structures.
The |All fingers| components is linked to the |Hand|, and the |Thumb| is linked to the |All fingers| component. The |Thumb| is placed first because it has the order value 1. Similarly, the components for |Second finger|, |Third finger|, |Fourth finger| and |Fifth finger| are also linked to the |All finger| component in the order specified by the order value. As shown in the figure the direction of the associations goes from the referenceComponentId to the targetComponentId so the components referenced by the targetComponentId are used to form the groups specified in the hierarchy
Navigation hierarchy example.
Boolean
The state of the identified reference set member as at the specified effectiveTime. If active = 1 (true) the reference set member is part of the current version of the set, if active = 0 (false) the reference set member is not part of the current version of the set.
YES
NO
moduleId
SCTID
Identifies the SNOMED CT module that contains this reference set member as at the specified effectiveTime .
The value must be a subtype of within the metadata hierarchy.
YES
NO
refsetId
SCTID
Identifies the reference set to which this reference set member belongs.
A subtype descendant of:
NO
NO
referencedComponentId
SCTID
A reference to the SNOMED CT component to be included in the reference set.
NO
NO
targetComponentId
SCTID
The identifier of the target component of the association that acts as a grouper or hierarchy node, collecting together a subgroup from within the list.
This field either enables 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 component. 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 referencedComponentId and targetComponentId and with order =1.
To link a number of children concepts to a single parent concept, one member record should exist per child, with the referencedComponentId field referencing the parent and this field referencing the child concept. The order field is then used to order the children concepts under the parent concept.
YES
NO
order
integer
Specifies the sort order of the list. The list is ordered by applying an ascending sort of the order value.
The value of order =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 targetComponentId value is not 0, sorting occurs within subgroups that share the same targetComponentId.
Note: The name "order" is a reserved word in some database environments. Please consider this when using this column.
YES
NO
1
2
…
20160731
1
19999999103
159999999105
Associations as ordered reference set
70327001
All fingers
141819019
Hand
1
id
UUID
A 128 bit unsigned Integer, uniquely identifying this reference set member.Different versions of a reference set member share the same id but have different effectiveTime. This allows a reference set member to be modified or made inactive (i.e. removed from the active set) at a specified time.
NO
YES (Full/Snapshot)
effectiveTime
Time
The inclusive date or time at which this version of the identified reference set member became the current version.
Note : In distribution files the effectiveTime should follow the short ISO date format (YYYYMM DD) and should not include the hours, minutes, seconds or timezone indicator.The current version of this reference set member at time T is the version with the most recent effectiveTime prior to or equal to time T.
YES
YES (Full) Optional (Snapshot)
0
active
…
20160731
1
19999999103
159999999105
Associations as ordered reference set
127053016
Thumb
70327001
All fingers
1
…
20160731
1
19999999103
159999999105
Associations as ordered reference set
138873019
Second finger
70327001
All fingers
2
…
20160731
1
19999999103
159999999105
Associations as ordered reference set
108884010
Third finger
70327001
All fingers
3
…
20160731
1
19999999103
159999999105
Associations as ordered reference set
136021011
Fourth finger
70327001
All fingers
4
…
20160731
1
19999999103
159999999105
Associations as ordered reference set
21356012
Fifth finger
70327001
All fingers
5