Purpose
A Component Annotation Refset will be created to support annotations on components (concepts, descriptions, relationships, etc) of SNOMED CT.
The SNOMED CT International Release contains Annotations content in two reference sets:
- The Member Annotation String Value reference set, in which annotations are held on members of any reference set(s).
- The Component Annotation String Value reference set, in which annotations are assigned to any SNOMED CT component.
These refsets replace the previous Annotation Type refset, which has now been deprecated: F.1 DEPRECATED: Annotation Reference Set
Data Structure
A Component Annotation String Value reference set is structured as shown in the following table:
Field | Data type | Purpose | Part of Primary Key | |
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: 1292992004 | Component annotation with string value reference set (foundation metadata concept) | | NO | NO | ||
A reference to the SNOMED CT component to be included in the reference set. The component (concept, description, relationship) to which the annotation applies. | NO | NO | ||
Specifies the language of the Annotation text using the two character ISO-639-1 code. Note that this specifies a language level only, not a country code. However, a dialect can also be included by following the standard RFC 5646, although this is an optional inclusion. The new concept 1304275002 |Language or dialect code (foundation metadata concept)| has been added for the metadata for this refset. NOTE: This field should be blank wherever a language code is not applicable, but never NULL. | YES | NO | ||
Any descendant of 1295447006 |Annotation attribute (attribute)| minus 1295449009 |Additional relationship attribute (attribute)| and its descendant in the attribute hierarchy. | NO | NO | ||
String | The Annotation text itself, with a maximum size of 32Kb, represented in UTF-8 encoding. | YES | NO |
RF2 File naming convention
A Component Annotation String Value reference set should be named along the lines of the following convention:
- der2_scsRefset_ComponentAnnotationStringValueSnapshot_[Product]_[date].txt
For example, for an International Release on 1st December 2023:
- der2_scsRefset_ComponentAnnotationStringValueSnapshot_INT_20231201.txt
Descriptor Template and Examples
The reference set example tables on this page have been revised as follows to aid clarity and understanding:
- The first four columns which are present in all release files are not shown. The omitted columns ( id, effectiveTime, active) are used in the same way in all referenced sets to support identification, versioning and packaging. They do not directly affect the specific features of a particular reference set or reference set type.
- Reference set columns that contain SNOMED CT identifiers are expanded to show details of the concept or description referenced by that identifier. In some cases, the term is shown in the same column using the expression syntax, in other cases an additional column with a name suffix '_term' has been added. In the standard reference set files only the identifier is present in the column and there is no added column for the term. When using reference sets, the term and other details of the component are looked up from the relevant component release files.
Descriptor Template
The table below shows the descriptors that define the structure of the 1292992004 | Component annotation with string value reference set (foundation metadata concept) | pattern and examples of the descriptors for specific reference sets that follow this pattern.
Table 4-1: Descriptor templates for Component Annotation String Value reference sets
refsetId | referencedComponentId | attributeDescription | attributeType | attributeOrder |
1292992004 | Component annotation with string value reference set (foundation metadata concept) | | 900000000000460005 |Component type (foundation metadata concept)| excluding the postcoordinated expression and rerfset member type components | 0 | ||
1292992004 | Component annotation with string value reference set (foundation metadata concept) | | 1304275002 |Language or dialect code (foundation metadata concept)| | 900000000000465000 |String (foundation metadata concept)| | 1 | |
1292992004 | Component annotation with string value reference set (foundation metadata concept) | | 1296892000 |Annotation type (foundation metadata concept)| | 900000000000461009 |Concept type component| | 2 | |
1292992004 | Component annotation with string value reference set (foundation metadata concept) | | 900000000000519001 |Annotation value (foundation metadata concept)| | 900000000000465000 |String (foundation metadata concept)| | 3 |
Component Annotation String Value Reference Set Example
Table 4-2: Component Annotation String Value reference set example
id | effectiveTime | active | moduleId | refsetId | referencedComponentId | languageDialectCode | annotationTypeId | Annotation |
00000000-1111-2222-3333-444444444444 | 20240131 | 1 | 1292992004 | Component annotation with string value reference set (foundation metadata concept) | | 784371009 |Huntington disease-like 1 (disorder)| | en | |Attribution (attribute)| | "Inserm Orphanet" | |
00000000-1111-2222-3333-444444444444 | 20240131 | 1 | 1292992004 | Component annotation with string value reference set (foundation metadata concept) | | 103741018 |Radius, NOS| | en | |Inactivation note (attribute)| | "Non-conformance to the description convention for structure concept. The suffix NOS for classification should not be used." | |
00000000-1111-2222-3333-444444444444 | 20240131 | 1 | 1292992004 | Component annotation with string value reference set (foundation metadata concept) | | 425523004 |Entire bone organ of spine (body structure)| | en | |Inactivation note (attribute)| | "No suitable replacement concept identified" | |
00000000-1111-2222-3333-444444444444 | 20240131 | 1 | 1292992004 | Component annotation with string value reference set (foundation metadata concept) | | 370137002 |Extension Namespace {1000000} (namespace concept)| | en | |Namespace owner (attribute)| | NHS Digital (UK) |
Feedback
Overview
Content Tools
Apps