Deprecation
The use of this reference set structure is now discouraged as it requires implementers to create a new refset concept for every new annotation type. A new refset format is currently being discussed here: SNOMED CT Annotations and alternate RF2 specifications will be generated in due course.
Purpose
An
| Concept |
|---|
| t | 900000000000516008|Annotation type reference set| |
|---|
|
allows | Specref |
|---|
| PreSpace | false |
|---|
| RefType | (data type) |
|---|
| t | String |
|---|
|
...
An 900000000000516008 $$ Annotation type reference set $$ allows text strings to be associated with components for any specified purpose.
...
...
Data structure
An annotation reference set String reference set used to apply text annotations to selected SNOMED CT components .
...
...
...
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 effectiveTimes. This allows a reference set member to be modified or made inactive (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 900000000000516008 $$ Annotation type reference set $$ .
...
referencedComponentId
...
SCTID
...
The identifier of the component to be annotated.
...
annotation
...
String
...
The text annotation to attach to the component identified by referencedComponentId .
...
| Gloss |
|---|
| PreSpace | false |
|---|
| t | annotation reference set |
|---|
|
is a | Specref |
|---|
| PreSpace | false |
|---|
| RefType | (data type) |
|---|
| t | String |
|---|
|
| Gloss |
|---|
| PreSpace | false |
|---|
| t | reference set |
|---|
|
used to apply text | Specref |
|---|
| PreSpace | false |
|---|
| RefType | (field) |
|---|
| t | annotation |
|---|
|
to selected | Gloss |
|---|
| PreSpace | false |
|---|
| t | SNOMED CT components |
|---|
|
.
| Caption label |
|---|
| CapId | annotation-reference-set-data-structure |
|---|
| CapType | Table |
|---|
|
Annotation reference set - Data structure |
| Refset spec table |
|---|
| Size | fs7 |
|---|
| RefsetType | Annotation Reference Set |
|---|
|
...
Metadata
The following metadata in supports this
| Gloss |
|---|
| PreSpace | false |
|---|
| t | reference set |
|---|
|
:
...
...
...
...
...
Figure 15. Annotation References Sets in the Metadata Hierarchy
...
| in-the-metadata-hierarchy | | CapType | Table |
|---|
|
Annotation References Sets in the Metadata Hierarchy |
| Scg expression |
|---|
|
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 |
|---|
| nopanel | true |
|---|
|
Descriptor Template
...
The tables below show the descriptors that define the structure of the
$$ | |Annotation type reference set |
|
$$ pattern and examples of the descriptors for specific
| Gloss |
|---|
| PreSpace | false |
|---|
| t | reference sets |
|---|
|
that follow this pattern.
...
| Caption label |
|---|
| CapId | descriptor-template-for-annotation-reference-sets |
|---|
| CapType | Table |
|---|
|
Descriptor Template for Annotation Reference Sets |
...
...
...
...
refsetId | referencedComponentId | attributeDescription | attributeType | attributeOrder |
|---|
$$ | |Reference set descriptor |
|
|
$$ $$ $$ $$ $$ $$ $$ $$ | |Reference set descriptor |
|
|
$$ $$ $$ $$ Annotation $$ $$ $$ | The
| Specref |
|---|
| PreSpace | false |
|---|
| RefType | (field) |
|---|
| t | attributeType |
|---|
|
The attributeType for the
Annotation field can be any
of the "
string "
in the metadata
. This
is described in more detail under the "
| Gloss |
|---|
| PreSpace | false |
|---|
| t | Reference set |
|---|
|
descriptor" section.
The table below holds the Descriptor for the "Associated image" annotation reference set, which allows URLs to be associated with concepts :| Caption label |
|---|
| CapId | descriptor-for-the-associated-image-annotation-reference-set |
|---|
| CapType | Table |
|---|
|
Descriptor for the Associated Image Annotation Reference set |
| Anchor |
|---|
_19143892-2bc9-440f-b711-033f805f1715__6 | _19143892-2bc9-440f-b711-033f805f1715__6 | Table 48. Descriptor for 900000000000517004 $$ Associated image reference set $$ | | | | refsetId | referencedComponentId | attributeDescription | attributeType | attributeOrder |
|---|
|
$$ | |Reference set descriptor |
|
|
$$ $$ $$$$ Annotated component $$ | 900000000000461009 $$ | | Concept |
|---|
| t | 900000000000518009|Annotated component| |
|---|
|
| | Concept |
|---|
| t | 900000000000461009|Concept type component |
|---|
|
|
$$ $$ | |Reference set descriptor |
|
|
$$ $$ $$$$ Image $$ | 900000000000469006 $$ URL $$ | | Concept |
|---|
| t | 900000000000520007|Image| |
|---|
|
| | 1 |
Note that in the table above, the $$ URL $$ concept is a descendant
| Concept |
|---|
| t | 900000000000469006|URL| |
|---|
| ShowFormat | inline |
|---|
|
is a of |
string |
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 id, effectiveTime, active, moduleId.
Additionally, to aid understanding, the tables above also show the term from one of the descriptions associated with each of the identified concept. The release file only contains the identifier ....
Annotation Reference Set Example
As no annotation reference sets are included in the International Release, these sample rows are for illustration only.
...
...
...
...
...
| image-annotation-reference-set | | CapType | Table |
|---|
|
Example of Associated image Annotation Reference Set |
...
...
refsetId | referencedComponentId | Annotation |
|---|
|
$$ $$ $$ $$ | http://en.wikipedia.org/wiki/Heart#mediaviewer/File:Wiki_Heart_Antomy_Ties_van_Brussel.jpg |
|
$$ $$ $$ $$ | http://www.educationaldimensions.com/eLearn/endoscope/bigScope.html |
In the above example, the two URLs have been used to annotate two
| Gloss |
|---|
| PreSpace | false |
|---|
| t | SNOMED CT concepts |
|---|
|
with images on the web. It is not recommended that this mechanism be used to annotate
with text that may require translation to other
. Instead, such text should be included under an appropriate
| Gloss |
|---|
| PreSpace | false |
|---|
| t | description |
|---|
|
type within the
Description file . Note: The tables above omit the initial four columns of data present in the release file. These follow the standards versioning pattern id, effectiveTime, active, moduleId. Additionally, to aid understanding, the tables above also show the term from one of the descriptions associated with each of the identified concept. The release file only contains the identifier | Specref |
|---|
| PreSpace | false |
|---|
| RefType | file |
|---|
| t | Description |
|---|
|
.