Search

 This Document

 All Library Documents



 Other Documents

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Warning
titleDeprecation 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:

  • 45.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.
    4
  • 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 45.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

Concept
t447258008|Ordered type reference set|
ShowFormatinline
allows a collection of
Gloss
SpacePreSpacetruefalse
tcomponents
to be defined with a specified given a priority ordering. This type of
Gloss
SpacePreSpacetruefalse
treference ret
can also be used to specify ordered associations between different
Gloss
PreSpacefalse
tcomponents
. These can be used to specify several interrelated subsets of components and to define alternative hierarchies for navigation and selection of
Gloss
SpacePreSpacetruefalse
tconcepts
or
Gloss
PreSpacefalse
tdescriptions
.

Data structure

An

Gloss
SpacePreSpacetruefalse
tOrdered reference set
is an Integer
Gloss
SpacePreSpacetruefalse
tComponent
Gloss
SpacePreSpacetruefalse
treference set
is used to represent ordered lists and alternative hierarchies. Its structure is shown in the following table.

...

Field

Data type

Purpose

Specref
RefType(field)
tid

Specref
RefType(data type)
tUUID

A 128 bit unsigned

Specref
RefType(data type)
tInteger
, uniquely identifying this
Gloss
PreSpacefalse
treference set member
.

Different versions of a reference set member share the same

Specref
RefType(field)
tid
but have different
Specref
RefType(field)
teffectiveTime
. This allows a reference set member to be modified or made
Specref
RefType(field)
tactive
(i.e. removed from the active set) at a specified time.

Specref
RefType(field)
teffectiveTime

Specref
RefType(data type)
tTime

The inclusive date or time at which this version of the identified

Gloss
SpacePreSpacetruefalse
treference set member
became the current version.

The current version of this

Gloss
SpacePreSpacetruefalse
treference set member
at time T is the version with the most recent
Specref
RefType(field)
teffectiveTime
prior to or equal to time T .

Specref
RefType(field)
tactive

Specref
RefType(data type)
tBoolean

The state of the identified

Gloss
SpacePreSpacetruefalse
treference set member
as at the specified
Specref
RefType(field)
teffectiveTime
.

If

Specref
RefType(field)
tactive
= 1 (true) the
Gloss
SpacePreSpacetruefalse
treference set member
is part of the current version of the set, if
Specref
RefType(field)
tactive
= 0 (false) the
Gloss
SpacePreSpacetruefalse
treference set member
is not part of the current version of the set.

Specref
RefType(field)
tmoduleId

Specref
RefType(data type)
tSCTID

Identifies the

Gloss
SpacePreSpacetruefalse
tSNOMED CT module
that contains this
Gloss
SpacePreSpacetruefalse
treference set member
as at the specified
Specref
RefType(field)
teffectiveTime
.

The value must be a

Gloss
SpacePreSpacetruefalse
tsubtype
of
Concept
t900000000000443000|Module (core metadata concept)|
ShowFormatinline
within the metadata
Gloss
PreSpacefalse
thierarchy
.

Specref
RefType(field)
trefsetId

Specref
RefType(data type)
tSCTID

Identifies the

Gloss
SpacePreSpacetruefalse
treference set
to which this
Gloss
SpacePreSpacetruefalse
treference set member
belongs.

In this case, set to a

Gloss
SpacePreSpacetruefalse
tsubtype
of
Concept
t447258008|Ordered type reference set|

Specref
RefType(field)
treferencedComponentId

Specref
RefType(data type)
tSCTID

The identifier of a

Gloss
SpacePreSpacetruefalse
tSNOMED CT component
that is included in the ordered list of alternative hierarchy.

Specref
RefType(field)
torder

Integer

Specifies the sort

Specref
RefType(field)
torder
of the list. The list is ordered by applying an ascending sort of the
Specref
RefType(field)
torder
value.

The value of

Specref
RefType(field)
torder
=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)
tlinkedToId
value is not 0, sorting occurs within subgroups that share the same
Specref
RefType(field)
tlinkedToId
.

Note: The name "order" is a reserved word in some database environments. Please consider this when using this column.

Specref
RefType(field)
tlinkedToId

Specref
RefType(data type)
tSCTID

The identifier of a

Gloss
SpacePreSpacetruefalse
tSNOMED CT component
that acts as a grouper or hierarchy node, collecting together a subgroup from within the list.

This field either enables

Gloss
SpacePreSpacetruefalse
treference 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

Gloss
PreSpacefalse
tcomponent
. 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)
treferencedComponentId
and
Specref
RefType(field)
tlinkedToId
and with
Specref
RefType(field)
torder
=1.

To link a number of

Gloss
SpacePreSpacetruefalse
tchildren
Gloss
SpacePreSpacetruefalse
tconcepts
to a single parent
Gloss
PreSpacefalse
tconcept
, one member record should exist per
Gloss
PreSpacefalse
tchild
, with the
Specref
RefType(field)
treferencedComponentId
field referencing the parent and this field referencing the
Gloss
SpacePreSpacetruefalse
tchild
Gloss
PreSpacefalse
tconcept
. The
Specref
RefType(field)
torder
field is then used to
Specref
RefType(field)
torder
the
Gloss
SpacePreSpacetruefalse
tchildren
Gloss
SpacePreSpacetruefalse
tconcepts
under the parent
Gloss
PreSpacefalse
tconcept
.

For ordered lists that do not require grouping or hierarchical arrangement the value of

Specref
RefType(field)
tlinkedToId
should be the digit zero (0).

Metadata

The following metadata in the "Foundation metadata

Gloss
PreSpacefalse
tconcept
"
Gloss
SpacePreSpacetruefalse
thierarchy
supports this
Gloss
PreSpacefalse
treference set

Caption table
Ordered References Sets in the Metadata Hierarchy

...

Excerpt Include
REUSE:Notes on Reference Set Example Tables
REUSE:Notes on Reference Set Example Tables
nopaneltrue

Descriptor Template

The tables below show the descriptor that defines the structure of the

Concept
t447258008|Ordered type reference set|
ShowFormatinline
pattern and an example of descriptor for a 
Gloss
SpacePreSpacetruefalse
treference set
that follows this pattern.

...

refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder

Concept
t900000000000456007|Reference set descriptor|

Concept
t447258008|Ordered type reference set|

Concept
t449608002|Referenced component|

Concept
t900000000000460005|Component type|

0

 

Concept
t900000000000456007|Reference set descriptor|
 

Concept
t447258008|Ordered type reference set|

Concept
t447255006|Priority order reference set attribute|

Concept
t900000000000478000|Unsigned integer|

1

Concept
t900000000000456007|Reference set descriptor|

Concept
t447258008|Ordered type reference set|

Concept
t447257003|"Linked to" reference set attribute|

Concept
t900000000000460005|Component type|

2

Example Data


Caption table
Sample Content for an Ordered Reference Set

...