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 900000000000516008 | Annotation type reference set| allows String to be associated with components for any specified purpose.
Data structure
An annotation reference set is a String reference set used to apply text annotation to selected SNOMED CT components.
Table 5.2.1.6-1: Annotation reference set - Data structure
Field | Data type | Purpose | Part of Primary Key | |
id | 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 effectiveTime. This allows a reference set member to be modified or made inactive (i.e. removed from the active set) at a specified time.
| NO | YES (Full /Snapshot) | |
The inclusive date or time at which this version of the identified reference set member became the current version. Note: In distribution files the effectiveTime should follow the short ISO date format (YYYYMMDD) and should not include the hours, minutes, seconds or timezone indicator. 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 .
| YES | YES (Full) Optional (Snapshot) | ||
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.
| YES | NO | ||
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.
| YES | NO | ||
Identifies the reference set to which this reference set member belongs.
In this case, a subtype descendant of: 900000000000516008 | Annotation type|
| NO | NO | ||
A reference to the SNOMED CT component to be included in the reference set. The component to which the annotation is being applied.
| NO | NO | ||
The text annotation to attach to the component identified by referencedComponentId . | YES | NO |
Metadata
The following metadata in supports this reference set :
Table 5.2.1.6-2: Annotation References Sets in the Metadata Hierarchy
Notes on the tables used to show descriptors and examples The reference set example tables on this page have been revised as follows to aid clarity and understanding:Reference Set Descriptor and Example Data
Descriptor Template
The tables below show the descriptors that define the structure of the 900000000000516008 | Annotation type reference set| pattern and examples of the descriptors for specific reference sets that follow this pattern.
Table 5.2.1.6-3: Descriptor Template for Annotation Reference Sets
refsetId | referencedComponentId | attributeDescription | attributeType | attributeOrder |
|---|---|---|---|---|
0 | ||||
1 |
The attributeType 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.
Table 5.2.1.6-4: Descriptor for the Associated Image Annotation Reference set
refsetId | referencedComponentId | attributeDescription | attributeType | attributeOrder |
|---|---|---|---|---|
0 | ||||
1 |
Note that in the table above, the 900000000000469006 | URL| concept is a descendant of | string | concept 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.
Table 5.2.1.6-5: 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 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.
Feedback
Overview
Content Tools
Apps