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
String | Specref |
|---|
| PreSpace | false |
|---|
| RefType | (data type) |
|---|
| t | String |
|---|
|
to be associated with components for any specified purpose.
...
Data structure
...
An
| Gloss |
|---|
| t | annotation reference set |
|---|
|
String (data type) |
gloss | | t | annotation reference set |
|---|
|
used to apply text annotation (field) to selected . ...
Field
...
Data type
...
Purpose
...
id (field)
is a
...
...
...
Different versions of a reference set member share the same id (field) but have different effectiveTime (field). This allows a reference set member to be modified or made active (field) (i.e. removed from the active set) at a specified time.
...
effectiveTime (field)
...
Time (data type)
The inclusive date or time at which this version of the identified
became the current version. ...
...
active (field)
...
Boolean (data type)
...
The state of the identified
as at the specified effectiveTime (field) . If active (field) = 1 (true) the
is part of the current version of the set, if active (field) = 0 (false) the is not part of the current version of the set. ...
moduleId (field)
...
SCTID (data type)
...
Identifies the
that contains this as at the specified effectiveTime (field) . The value must be a
of | Concept |
|---|
| t | 900000000000443000|Module (core metadata concept)| |
|---|
|
within the metadata . ...
refsetId (field)
...
SCTID (data type)
...
Identifies the
to which this belongs. In this case, set to
| Concept |
|---|
| t | 900000000000516008|Annotation type reference set| |
|---|
|
. ...
referencedComponentId (field)
...
SCTID (data type)
...
The identifier of the
to be annotated. ...
annotation (field)
...
String (data type)
...
The text annotation (field) to attach to the
identified by referencedComponentId (field) . ...
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 |
|---|
|
:
...
...
...
...
...
| 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
...
| Concept |
|---|
| t | 900000000000454005|Foundation metadata concept| |
|---|
| ShowFormat | inline |
|---|
|
| Concept |
|---|
| t | 900000000000455006|Reference set| |
|---|
|
...
| Concept |
|---|
| t | 900000000000516008|Annotation type| |
|---|
|
...
| Concept |
|---|
| t | 900000000000517004|Associated image| |
|---|
|
...
The tables below show the descriptors that define the structure of the
| Concept |
|---|
| t | 900000000000516008|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 |
|---|
| | Concept |
|---|
| t | 900000000000456007|Reference set descriptor| |
|---|
|
| | Concept |
|---|
| t | 900000000000516008|Annotation type| |
|---|
|
| | Concept |
|---|
| t | 900000000000518009|Annotated component| |
|---|
|
| | Concept |
|---|
| t | 900000000000461009|Concept type component| |
|---|
|
| 0 |
| | Concept |
|---|
| t | 900000000000456007|Reference set descriptor| |
|---|
|
| | Concept |
|---|
| t | 900000000000516008|Annotation type| |
|---|
|
| | Concept |
|---|
| t | 900000000000519001|Annotation| |
|---|
|
| | Concept |
|---|
| t | 900000000000465000|String| |
|---|
|
| 1 |
| The 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 (field)
, which allows URLs to be associated with : | Caption label |
|---|
| CapId | descriptor-for-the-associated-image-annotation-reference-set |
|---|
| CapType | Table |
|---|
|
Descriptor for the Associated Image Annotation Reference set |
refsetId | referencedComponentId | attributeDescription | attributeType | attributeOrder |
|---|
| Concept |
|---|
| t | 900000000000456007|Reference set descriptor| |
|---|
|
| | Concept |
|---|
| t | 900000000000517004|Associated image| |
|---|
|
| | Concept |
|---|
| t | 900000000000518009|Annotated component| |
|---|
|
| | Concept |
|---|
| t | 900000000000461009|Concept type component| |
|---|
|
| 0 |
| Concept |
|---|
| t | 900000000000456007|Reference set descriptor| |
|---|
|
| | Concept |
|---|
| t | 900000000000517004|Associated image| |
|---|
|
| | Concept |
|---|
| t | 900000000000520007|Image| |
|---|
|
| | 1 |
Note that in the table above, the
| 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 (field), effectiveTime (field), active (field), active (field). Additionally, to aid understanding, the tables above also show the
from one of the associated with each of the identified . The release file only contains the . ...
Annotation Reference Set Example
As no annotation reference sets are included in the International Release, these sample rows are for illustration only.
| Caption label |
|---|
| CapId | example-of-associated-image-annotation-reference-set |
|---|
| CapType | Table |
|---|
|
Example of Associated image Annotation Reference Set |
refsetId | referencedComponentId | Annotation |
|---|
| Concept |
|---|
| t | 900000000000517004|Associated image| |
|---|
|
| | Concept |
|---|
| t | 80891009|Heart structure| |
|---|
|
| http://en.wikipedia.org/wiki/Heart#mediaviewer/File:Wiki_Heart_Antomy_Ties_van_Brussel.jpg |
| Concept |
|---|
| t | 900000000000517004|Associated image| |
|---|
|
| | 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 (field), effectiveTime (field), active (field), active (field). Additionally, to aid understanding, the tables above also show the from one of the associated with each of the identified . The release file only contains the | Specref |
|---|
| PreSpace | false |
|---|
| RefType | file |
|---|
| t | Description |
|---|
|
| Gloss |
|---|
|
.