Release File Specification

Search

SNOMED CT Document Library

    Loading...

Versions Compared

Old Version 5

changes.mady.by.user David Markwell

Saved on

compared with

New Version Current

changes.mady.by.user Peter G. Williams

Saved on

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

...

Gloss
tMutable
LinkTypesubtle

...

id

PreSpacefalse
tannotation reference set
 is a 
Specref
PreSpacefalse

...

RefType(data type)
t

...

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

...

String
 
Gloss
PreSpacefalse
treference set
used to apply text
Specref
PreSpacefalse

RefType(field)
t

...

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) 

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
CapIdannotation-references-sets-in-the-metadata-hierarchy
CapTypeTable
Annotation References Sets in the Metadata Hierarchy

...
 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 as subtype descendant of: ??
...
 Specref
RefType(field)
treferencedComponentId
...
 Specref
RefType(data type)
tSCTID
...
A reference to the 
 Gloss
Spacetrue
tSNOMED CT component
to be included in the 
 Gloss
treference set
.
...
 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
 .
...
Metadata
The following metadata in supports this 
 Gloss
treference set
 :
 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
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.
 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.
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
PreSpacefalse
RefTypefile
tDescription
.