Search



Versions Compared

Key

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

Anchor
_31a272ae-db6b-4623-be07-a175294e9037
_31a272ae-db6b-4623-be07-a175294e9037
Purpose

An 900000000000516008 $$ Annotation type reference set $$ allows text strings

Scg expression
ShowPartsid+term
900000000000516008|Annotation type reference set|
allows String (data type) to be associated with components for any specified purpose.

Anchor
_db4e87b5-7d46-4083-9f3b-e9262be15015
_db4e87b5-7d46-4083-9f3b-e9262be15015
Data structure

An annotation reference set String reference set String (data type) used to apply text annotations annotation (field) to selected SNOMED CT components .

integer reference set member effectiveTimes inactive reference set member reference set member reference set member reference set member reference set member SNOMED CT module reference set member subtype of 900000000000443000 $$ Module (core metadata concept) $$ hierarchy reference set reference set member 900000000000516008 $$ Annotation type reference set $$ component component

Anchor
_db4e87b5-7d46-4083-9f3b-e9262be15015__d
_db4e87b5-7d46-4083-9f3b-e9262be15015__d
Table 46. Annotation reference set - Data structure

 

 

Field

Data type

Purpose

id (field)

UUID (data type)

A 128 bit unsigned

Integer (data type), uniquely identifying this

.

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.

The current version of this

at time T is the version with the most recent effectiveTime (field) prior to or equal to time T .

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

Scg expression
ShowPartsid+term
900000000000443000|Module (core metadata concept)|
within the metadata

.

refsetId (field)

SCTID (data type)

Identifies the

to which this

belongs.

In this case, set to

Scg expression
ShowPartsid+term
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) .

Anchor
_6ade4020-50aa-4989-a779-a211ce3dfb46
_6ade4020-50aa-4989-a779-a211ce3dfb46
Metadata

The following metadata in supports this reference set :

  • Anchor
    _6ade4020-50aa-4989-a779-a211ce3dfb46__5
    _6ade4020-50aa-4989-a779-a211ce3dfb46__5
    Anchor
    _6ade4020-50aa-4989-a779-a211ce3dfb46__9
    _6ade4020-50aa-4989-a779-a211ce3dfb46__9
    Scg expression
    900000000000454005 $$ Foundation metadata concept $$
    ShowPartsid+term
    900000000000454005|Foundation metadata concept|
    • Scg expression
      ShowPartsid+term
      900000000000455006|Reference set|
    • 900000000000455006 $$ Reference set $$
      Anchor
      _6ade4020-50aa-4989-a779-a211ce3dfb46__a
      _6ade4020-50aa-4989-a779-a211ce3dfb46__a
      • Scg expression
        900000000000516008 $$ Annotation type $$
        ShowPartsid+term
        900000000000516008|Annotation type|
        Anchor
        _6ade4020-50aa-4989-a779-a211ce3dfb46__7
        _6ade4020-50aa-4989-a779-a211ce3dfb46__7
        • Scg expression
          ShowPartsid+term
          900000000000517004
          $$
          |Associated image
          $$
          |

Figure 15. Annotation References Sets in the Metadata Hierarchy

Anchor
_19143892-2bc9-440f-b711-033f805f1715
_19143892-2bc9-440f-b711-033f805f1715
Descriptor template

The tables below show the descriptors that define the structure of the 900000000000516008 $$ Annotation type reference set $$

Scg expression
ShowPartsid+term
900000000000516008|Annotation type reference set|
pattern and examples of the descriptors for specific reference sets that follow this pattern.

900000000000465000 $$ String $$

Anchor
_19143892-2bc9-440f-b711-033f805f1715__c
_19143892-2bc9-440f-b711-033f805f1715__c
Table 47. Descriptor Template for Annotation Reference Sets

 

 

 

 

refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder

 

900000000000456007 $$ Reference set descriptor $$

900000000000516008 $$ Annotation type $$

900000000000518009 $$ Annotated component $$

900000000000461009 $$ Concept type component $$

0

 

Scg expression
ShowPartsid+term
900000000000456007|Reference set descriptor|

Scg expression
ShowPartsid+term
900000000000516008|Annotation type|

Scg expression
ShowPartsid+term
900000000000518009|Annotated component|

Scg expression
ShowPartsid+term
900000000000461009|Concept type component|

0

 

Scg expression
ShowPartsid+term
900000000000456007|Reference set descriptor|

Scg expression
ShowPartsid+term
900000000000516008|Annotation type|

Scg expression
ShowPartsid+term
900000000000519001|Annotation|

Scg expression
ShowPartsid+term
900000000000465000|String|

900000000000456007 $$ Reference set descriptor $$

900000000000516008 $$ Annotation type $$

900000000000519001 $$ Annotation $$

1

 

The attributeType (field) for the Annotation field can be any descendant of the " string " concept in the metadata hierarchy . This hierarchy is described in more detail under the " Reference set descriptor" section.

The table below holds the Descriptor for the "Associated image" annotation reference set(field) , which allows URLs to be associated with concepts :

900000000000517004 $$ Associated image reference set $$ 900000000000469006 $$ URL $$

Anchor
_19143892-2bc9-440f-b711-033f805f1715__6
_19143892-2bc9-440f-b711-033f805f1715__6
Table 48. Descriptor for

Scg expression
ShowPartsid+term
900000000000517004|Associated image reference set|

 

 

 

 

refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder

900000000000456007 $$ Reference set descriptor $$

900000000000517004 $$ Associated image $$

$$ Annotated component $$

900000000000461009 $$ Concept type component $$

0

Scg expression
ShowPartsid+term
900000000000456007|Reference set descriptor|

Scg expression
ShowPartsid+term
900000000000517004|Associated image|

Scg expression
ShowPartsterm
900000000000518009|Annotated component|

Scg expression
ShowPartsid+term
900000000000461009|Concept type component|

0

Scg expression
ShowPartsid+term
900000000000456007|Reference set descriptor|

Scg expression
ShowPartsid+term
900000000000517004|Associated image|

Scg expression
ShowPartsterm
900000000000520007|Image|

Scg expression
ShowPartsid+term
900000000000469006|URL|

900000000000456007 $$ Reference set descriptor $$

900000000000517004 $$ Associated image $$

$$ Image $$

1

Note that in the table above, the $$ URL $$ concept

Scg expression
ShowPartsterm
900000000000469006|URL|
is a descendant of | string | concept 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 , moduleId(field), active (field). 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 .

Anchor
_619af0e2-cfc0-4eec-882b-3d4702ff543f
_619af0e2-cfc0-4eec-882b-3d4702ff543f
Annotation reference set example

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

80891009 $$ Heart structure $$ 86174004 $$ Laparoscope $$

Anchor
_619af0e2-cfc0-4eec-882b-3d4702ff543f__8
_619af0e2-cfc0-4eec-882b-3d4702ff543f__8
Table 49. Example of "Associated image" Annotation Reference Set

 

 

refsetId

referencedComponentId

Annotation

Scg expression

900000000000517004 $$ Associated image $$

ShowPartsid+term
900000000000517004|Associated image|

Scg expression
ShowPartsid+term
80891009|Heart structure|

http://en.wikipedia.org/wiki/Heart#mediaviewer/File:Wiki_Heart_Antomy_Ties_van_Brussel.jpg

900000000000517004 $$ Associated image $$

Scg expression
ShowPartsid+term
900000000000517004|Associated image|

Scg expression
ShowPartsid+term
86174004|Laparoscope|

http://www.educationaldimensions.com/eLearn/endoscope/bigScope.html

In the above example, the two URLs have been used to annotate two SNOMED CT concepts with images on the web. It is not recommended that this mechanism be used to annotate concepts with text that may require translation to other languages . Instead, such text should be included under an appropriate 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 , moduleId(field), active (field). 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 .