Search

 This Document

 All Library Documents



 Other Documents
Skip to end of metadata
Go to start of metadata

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:

  • 5.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 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.5 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 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.

Data structure

An Ordered reference set is an Integer Component reference set is used to represent ordered lists and alternative hierarchies. Its structure is shown in the following table.

Table 5.2.20-4: Ordered reference set - Data structure

Field

Data type

Purpose

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 active (i.e. removed from the active set) at a specified time.

effectiveTime

Time

The inclusive date or time at which this version of the identified reference set member became the current version.

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 .

active

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.

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 900000000000443000 |Module (core metadata concept)|within the metadata hierarchy.

refsetId

SCTID

Identifies the reference set to which this reference set member belongs.

In this case, set to a subtype of 447258008 |Ordered type reference set|

referencedComponentId

SCTID

The identifier of a SNOMED CT component that is included in the ordered list of alternative hierarchy.

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.

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).

Metadata

The following metadata in the "Foundation metadata concept" hierarchy supports this reference set

Table 5.2.20-4: Ordered References Sets in the Metadata Hierarchy

Field

Data type

Purpose

Part of Primary Key

id

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.

NOYES (Full /Snapshot)

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) 

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.

YESNO

Identifies the SNOMED CT module that contains this reference set member as at the specified effectiveTime .

The value must be a subtype of 900000000000443000 |Module (core metadata concept)|within the metadata hierarchy.

YESNO

Identifies the reference set to which this reference set member belongs.

In this case, a subtype descendant of: 447258008 |Ordered type reference set|

NONO

A reference to the SNOMED CT component to be included in the reference set. The component that is placed in order by this reference set row.

NONO

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.

YESNO

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).

YESNO

Reference Set Descriptor and Example Data

Notes on the tables used to show descriptors and examples

The reference set example tables on this page have been revised as follows to aid clarity and understanding:

  • The first four columns which are present in all release files are not shown. The omitted columns (ideffectiveTimeactivemoduleId) are used in the same way in all referenced sets to support identification, versioning and packaging. They do not directly affect the specific features of a particular reference set or reference set type.
  • Reference set columns that contain SNOMED CT identifiers are expanded to show details of the concept or description referenced by that identifier. In some cases, the term is shown in the same column using the expression syntax, in other cases an additional column with a name suffix '_term' has been added. In the standard reference set files only the identifier is present in the column and there is no added column for the term. When using reference sets, the term and other details of the component are looked up from the relevant component release files.

Descriptor Template

The tables below show the descriptor that defines the structure of the 447258008 |Ordered type reference set|pattern and an example of descriptor for a reference set that follows this pattern.

Table 5.2.20-4: Refset Descriptor rows for Ordered Reference Set


Example Data

Table 5.2.20-4: Sample Content for an Ordered Reference Set


Feedback