Search



Versions Compared

Key

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

...

An

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

Field

Data type

Purpose

id

Specref
RefType
(field)
tid

UUID

Specref
RefType
(data type)
tUUID

A 128 bit unsigned Integer

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

Different versions of a reference set member share the same id

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

Specref
RefType
effectiveTime
(field)
teffectiveTime

Time

Specref
RefType
(data type)
tTime

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

Gloss
Spacetrue
treference set member
became the current version.

The current version of this

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

active

Specref
RefType
(field)
tactive

Boolean

Specref
RefType
(data type)
tBoolean

The state of the identified

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

If active

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

moduleId

Specref
RefType
(field)
tmoduleId

SCTID

Specref
RefType
(data type)
tSCTID

Identifies the

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

The value must be a

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

refsetId

Specref
RefType
(field)
trefsetId

SCTID

Specref
RefType
(data type)
tSCTID

Identifies the

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

In this case, set to a

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

Specref
referencedComponentId
RefType(field)
treferencedComponentId

SCTID

Specref
RefType
(data type)
tSCTID

The identifier of a

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

Specref
order
RefType(field)
torder

Integer

Specifies the sort order

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

The value of order

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 linkedToId

Specref
RefType(field)
tlinkedToId
value is not 0, sorting occurs within subgroups that share the same linkedToId
Specref
RefType(field)
tlinkedToId
.

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

Specref
linkedToId
RefType(field)
tlinkedToId

SCTID

Specref
RefType
(data type)
tSCTID

The identifier of a

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

This field either enables

Gloss
Spacetrue
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
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 referencedComponentId
Specref
RefType(field)
and linkedToId
treferencedComponentId
and
Specref
RefType(field)
tlinkedToId
and with order
Specref
RefType(field)
torder
=1.

To link a number of

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

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

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

...

Note: The table above omits the initial four columns of data present in the release file. These follow the standards versioning pattern id

Specref
RefType(field)
, effectiveTime
tid
,
Specref
RefType(field)
, active
teffectiveTime
,
Specref
RefType(field)
, active
tactive
,
Specref
RefType(field)
tactive
. Additionally, to aid understanding, the table above also shows the
Gloss
Spacetrue
tterm
from one of the
Gloss
Spacetrue
tdescriptions
associated with each of the identified
Gloss
tconcept
. The release file only contains the
Gloss
tidentifier
.

...