Maintenance Alert - This service will be undergoing planned maintenance from Tuesday 23 April 2024, 07:00UTC until Tuesday 23 April 2024, 09:00UTC. During this time the service will be unavailable.

Search



Versions Compared

Key

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

...

Purpose

An

Concept
t900000000000516008|Annotation type reference set|
allows
Specref
RefType(data type)
tString
to be associated with components for any specified purpose.

...

...

Data structure

An

Gloss
tannotation reference set
Specref
RefType(data type)
tString
Gloss
treference set
used to apply text
Specref
RefType(field)
tannotation
to selected
Gloss
tSNOMED CT components
.



Field

Data type

Purpose

Gloss
t

specref

Mutable

RefType

LinkType

(field)t

subtle

Part of Primary Key

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

YES (Full/Snapshot) 

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.

In this case, set to

Concept
t900000000000516008|Annotation type reference set|
.

as subtype descendant of: ??

NONO

Specref
RefType(field)
treferencedComponentId

Specref
RefType(data type)
tSCTID

The identifier of

A reference to the

Gloss
Spacetrue
tSNOMED CT component
to be

annotated.

included in the

Gloss
treference set
.

NONO

Specref
RefType(field)
tannotation

Specref
RefType(data type)
tString

The text

Specref
RefType(field)
tannotation
to attach to the
Gloss
tcomponent
identified by
Specref
RefType(field)
treferencedComponentId
.

...

YESNO

...

Metadata

The following metadata in supports this

Gloss
treference set
:

...

Concept
t900000000000454005|Foundation metadata concept|
ShowFormatinline


Scg expression
Borderridge

  900000000000454005 |Foundation metadata concept|
		900000000000455006 |Reference set|
				900000000000516008 |Annotation type|
						900000000000517004 |Associated image|


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


Descriptor Template

Concept
t900000000000455006|Reference set|

...

Concept
t900000000000516008|Annotation type|

...

  • Concept
    t900000000000517004|Associated image|

...

The tables below show the descriptors that define the structure of the

Concept
t900000000000516008|Annotation type reference set|
pattern and examples of the descriptors for specific
Gloss
treference sets
that follow this pattern.

...

refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder 

Concept
t900000000000456007|Reference set descriptor|

Concept
t900000000000516008|Annotation type|

Concept
t900000000000518009|Annotated component|

Concept
t900000000000461009|Concept type component|

0

 

Concept
t900000000000456007|Reference set descriptor|

Concept
t900000000000516008|Annotation type|

Concept
t900000000000519001|Annotation|

Concept
t900000000000465000|String|

1

 

The

Specref
RefType(field)
tattributeType
for the Annotation field can be any
Gloss
tdescendant
of the " string "
Gloss
tconcept
in the metadata
Gloss
thierarchy
. This
Gloss
thierarchy
is described in more detail under the "
Gloss
tReference set
descriptor" section.The table below holds the Descriptor for the "Associated image"
Specref
RefType(field)
tannotation
Gloss
treference set
, which allows URLs to be associated with Gloss
tconcepts
:


refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder

Concept
t900000000000456007|Reference set descriptor|

Concept
t900000000000517004|Associated image|

Concept
t900000000000518009|Annotated component|

Concept
t900000000000461009|Concept type component|

0

Concept
t900000000000456007|Reference set descriptor|

Concept
t900000000000517004|Associated image|

Concept
t900000000000520007|Image|

Concept
t900000000000469006|URL|

1

Note that in the table above, the

Concept
t900000000000469006|URL|
ShowFormatinline
Gloss
tconcept
is a
Gloss
tdescendant
of | string |
Gloss
tconcept
in the metadata.

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

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

...

Annotation Reference Set Example

As no annotation reference sets are included in the International Release, these sample rows are for illustration only.

...

In the above example, the two URLs have been used to annotate two

Gloss
tSNOMED CT concepts
with images on the web. It is not recommended that this mechanism be used to annotate
Gloss
tconcepts
with text that may require translation to other
Gloss
tlanguages
. Instead, such text should be included under an appropriate
Gloss
tdescription
type within the
Specref
RefTypefile
tDescription
. Note: The tables above omit the initial four columns of data present in the release file. These follow the standards versioning pattern
Specref
RefType(field)
tid
,
Specref
RefType(field)
teffectiveTime
,
Specref
RefType(field)
tactive
,
Specref
RefType(field)
tactive
. Additionally, to aid understanding, the tables above also show the
Gloss
tterm
from one of the
Gloss
tdescriptions
associated with each of the identified
Gloss
tconcept
. The release file only contains the
Gloss
tidentifier
.