Search



Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

Anchor
_848bae5e-6edd-43f2-aaa0-f9ea40714de6
_848bae5e-6edd-43f2-aaa0-f9ea40714de6
Purpose

The

Concept
t900000000000456007|Reference set descriptor|
is a
Gloss
treference set
that is used to specify the format of all
Gloss
treference sets
included in a release. The data type and meaning of the referenced component and each additional field within each
Gloss
treference set
is described by this
Gloss
treference set
.

...

  • the data type of its attributes may be validated against the data type declared in the
    Gloss
    treference set
    descriptor;
  • the column order can be checked against the
    Gloss
    treference set
    descriptor.

Anchor
_5c7e8c94-101c-450c-827d-573470153540
_5c7e8c94-101c-450c-827d-573470153540
Data structure

The

Gloss
tReference set descriptor reference set
is a
Gloss
tComponent
-
Gloss
tComponent
- Integer
Gloss
treference set
that specifies the structure of reference sets. Its structure is shown in the following table.

...

Field

...

Data type

...

Purpose

...

Gloss
tMutable
LinkTypesubtle

...

id

...

Specref
RefType(data type)
tUUID

...

A 128 bit unsigned

Specref
RefType(data type)
tInteger
, uniquely identifying this
Gloss
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.

...

NO

...

Specref
RefType(field)
teffectiveTime

...

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
Specref
RefType(field)
teffectiveTime
prior to or equal to time T .

...

YES

...

YES (Full)

Optional (Snapshot) 

...

Specref
RefType(field)
tactive

...

Specref
RefType(data type)
tBoolean

...

The state of the identified

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

If

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

...

YES

...

NO

...

Specref
RefType(field)
tmoduleId

...

Specref
RefType(data type)
tSCTID

...

Identifies the

Gloss
Spacetrue
tSNOMED CT module
that contains this
Gloss
Spacetrue
treference set member
as at the specified
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
.

...

YES

...

NO

...

Specref
RefType(field)
trefsetId

...

Specref
RefType(data type)
tSCTID

...

Identifies the

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

Note: In this case, the refsetId is always

Concept
t900000000000456007|Reference set descriptor|
as there is only one reference set of this type.

...

Specref
RefType(field)
treferencedComponentId

...

Specref
RefType(data type)
tSCTID

...

A reference to the

Gloss
Spacetrue
tSNOMED CT component
to be included in the
Gloss
treference set
.

...

Specref
RefType(field)
tattributeDescription

...

Specref
RefType(data type)
tSCTID

...

Specifies the name of an attribute that is used in the

Gloss
treference set
to which this descriptor applies.

Set to a

Gloss
tdescendant
of
Concept
t900000000000457003|Reference set attribute (foundation metadata concept)|
in the metadata
Gloss
thierarchy
, that describes the additional attribute extending the
Gloss
treference set
.

...

Specref
RefType(field)
tattributeType

...

Specref
RefType(data type)
tSCTID

...

Specifies the data type of this attribute in the

Gloss
treference set
to which this descriptor applies.

Set to a

Gloss
tdescendant
of
Concept
t900000000000459000|attribute type (foundation metadata concept)|
in the metadata
Gloss
thierarchy
, that describes the type of the additional attribute extending the
Gloss
treference set
.

...

Specref
RefType(field)
tattributeOrder

...

Integer

...

Specifies the position of this attribute in the

Gloss
treference set
to which this descriptor applies. A zero value identifies the
Specref
RefType(field)
treferencedComponentId
within the
Gloss
treference set
. Other values specify an additional attributes by its position relative to the
Specref
RefType(field)
treferencedComponentId
. Within a particular descriptor,
Specref
RefType(field)
tattributeOrder
values for a particular
Specref
RefType(field)
treferencedComponentId
must be contiguous.

An unsigned

Specref
RefType(data type)
tInteger
, providing an ordering for the additional attributes extending the
Gloss
treference set
.

...



Refset spec table
Sizefs7
RefsetTypeReference Set Descriptor Reference Set

...


At least one row must exist for each

Gloss
treference set
included in a release. This row must have an
Specref
RefType(field)
tattributeOrder
value of '0' and an
Specref
RefType(field)
tattributeType
of '
Gloss
tcomponent
type' (or one of its
Gloss
tdescendants
). The
Specref
RefType(field)
treferencedComponentId
identifies the
Gloss
treference set
defined by the descriptor.

...

Creation of a

Gloss
tReference set
descriptor is optional when creating a
Gloss
treference set
in another
Gloss
tExtension
. If a descriptor is not created, the descriptor of the closest
Gloss
tancestor
of the
Gloss
treference set
is used when validating
Gloss
treference set
member records.

Metadata

The following metadata in the |Foundation metadata

Gloss
tconcept
|
Gloss
thierarchy
supports the
Gloss
treference set
descriptor
Gloss
treference set
.

...

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

Descriptor Template

The table below shows the descriptor that defines the structure of the

Concept
t900000000000456007|Reference set descriptor|
. Note that this descriptor is itself part of the 
Concept
t900000000000456007|Reference set descriptor|
 that it describes!


refsetId

referencedComponentId (Referenced component)

attributeDescription (Attribute description)

attributeType (Attribute type)

attributeOrder (Attribute order)

Concept
t900000000000456007|Reference set descriptor|

Concept
t900000000000456007|Reference set descriptor|

Concept
t449608002|Referenced component|

Concept
t900000000000461009|Concept type component|

0

Concept
t900000000000456007|Reference set descriptor|

Concept
t900000000000456007|Reference set descriptor|

Concept
t900000000000458008|Attribute description|

Concept
t900000000000461009|Concept type component|

1

Concept
t900000000000456007|Reference set descriptor|

Concept
t900000000000456007|Reference set descriptor|

Concept
t900000000000459000|Attribute type|

Concept
t900000000000461009|Concept type component|

2

Concept
t900000000000456007|Reference set descriptor|

Concept
t900000000000456007|Reference set descriptor|

Concept
t900000000000479008|Attribute order|

Concept
t900000000000478000|Unsigned integer|

3