Search



Versions Compared

Key

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

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
t900000000000516008|Annotation type reference set|
allows
Specref
PreSpacefalse
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

...

Specref
RefType(field)
tid

...

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.

...

Specref
RefType(field)
teffectiveTime

PreSpacefalse
tannotation reference set
 is a 
Specref
PreSpacefalse
RefType(

...

data type)
t

...

String
 
Gloss

...

treference set member

...

PreSpacefalse

...

treference set

...

Specref
RefType(field)
teffectiveTime

...

used to apply text
Specref

...

RefType(field)
tactive

...

Specref
RefType(data type)
tBoolean

PreSpacefalse

...

Gloss
treference set member

...

RefType(field)
t

...

If

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

...

Specref
RefType(field)
tmoduleId

...

Specref
RefType(data type)
tSCTID

...

Identifies the

Gloss
tSNOMED CT module
that contains this
Gloss
treference set member
as at the specified
Specref
RefType(field)
teffectiveTime
.

The value must be a

Gloss
tsubtype
of
Concept
t900000000000443000|Module (core metadata concept)|
within the metadata
Gloss
thierarchy
.

...

Specref
RefType(field)
trefsetId

...

Specref
RefType(data type)
tSCTID

...

Identifies the

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

In this case, set to

Concept
t900000000000516008|Annotation type reference set|
.

...

Specref
RefType(field)
treferencedComponentId

...

Specref
RefType(data type)
tSCTID

...

The identifier of the

Gloss
tcomponent
to be annotated.

...

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
.

...

annotation
to selected
Gloss
PreSpacefalse
tSNOMED CT components
.


Caption label
CapIdannotation-reference-set-data-structure
CapTypeTable
Annotation reference set - Data structure



Refset spec table
Sizefs7
RefsetTypeAnnotation Reference Set


...

Metadata

The following metadata in supports this

Gloss
PreSpacefalse
treference set
:

Caption label

...

CapId

...

annotation-

...

references-

...

sets-

...

in-the-metadata-hierarchy
CapTypeTable
Annotation References Sets in the Metadata Hierarchy


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
t900000000000454005|Foundation metadata concept|
ShowFormatinline
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
PreSpacefalse
treference sets
that follow this pattern.


Caption label
CapIddescriptor-template-for-annotation-reference-sets
CapTypeTable
Descriptor Template for Annotation Reference Sets


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
PreSpacefalse
RefType(field)
tattributeType
for the Annotation field can be any
Gloss
PreSpacefalse
tdescendant
of the " string "
Gloss
PreSpacefalse
tconcept
in the metadata
Gloss
PreSpacefalse
thierarchy
. This
Gloss
PreSpacefalse
thierarchy
is described in more detail under the "
Gloss
PreSpacefalse
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
:

Caption label
CapIddescriptor-for-the-associated-image-annotation-reference-set
CapTypeTable
Descriptor for the Associated Image Annotation Reference set


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
PreSpacefalse
tconcept
is a
Gloss
PreSpacefalse
tdescendant
of | string |
Gloss
PreSpacefalse
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 Glosstterm 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.


Caption label
CapIdexample-of-associated-image-annotation-reference-set
CapTypeTable
Example of Associated image Annotation Reference Set


refsetId

referencedComponentId

Annotation

Concept
t900000000000517004|Associated image|

Concept
t80891009|Heart structure|

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

Concept
t900000000000517004|Associated image|

Concept
t86174004|Laparoscope|

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

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

Gloss
PreSpacefalse
tSNOMED CT concepts
with images on the web. It is not recommended that this mechanism be used to annotate
Gloss
PreSpacefalse
tconcepts
with text that may require translation to other
Gloss
PreSpacefalse
tlanguages
. Instead, such text should be included under an appropriate
Gloss
PreSpacefalse
tdescription
type within the
Specref
RefTypePreSpacefile
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
false
RefTypefile
tDescription
Gloss
tidentifier
.