Release File Specification

Search

SNOMED CT Document Library

    Loading...

Versions Compared

Old Version 1

changes.mady.by.user Andrew Atkinson

Saved on

compared with

New Version 2

changes.mady.by.user Andrew Atkinson

Saved on

Key

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

Purpose

A Component Annotation Refset will be created to support annotations on components (concepts, descriptions, relationships, etc) of SNOMED CT.

...

Info

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

Mutable

Part of Primary Key

id

UUID

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.

NOYES (Full /Snapshot)

effectiveTime

Time

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) 

active

Boolean

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.

YESNO

moduleId

SCTID

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.

YESNO

refsetId

SCTID

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) |

NONO

referencedComponentId

SCTID

A reference to the SNOMED CT component to be included in the reference set.

The component (concept, description, relationship) to which the annotation applies.

NONO

languageCode

String

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 dialect or country code.

NOTE:  This field should be blank wherever a language code is not applicable, but never NULL.

YES

NO

typeId

SCTID

Any descendant of1295447006 |Annotation attribute (attribute)|  minus 1295449009 |Additional relationship attribute (attribute)| and its descendantin the attribute hierarchy. 

NONO

value

String

The Annotation text itself, with a maximum size of 32Kb, represented in UTF-8 encoding.

YESNO


RF2 File naming convention

A Component Annotation String Value reference set should be named along the lines of the following convention:

...

  • 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. 

...

refsetId

referencedComponentId

attributeDescription

attributeTypeattributeOrder

900000000000456007 | Reference set descriptor|

1292992004 | Component annotation with string value reference set (foundation metadata concept) |

900000000000518009 |Annotated component|

900000000000461009 |Concept type component|

excluding the postcoordinated expression and rerfset member type components

0

900000000000456007 | Reference set descriptor|

1292992004 | Component annotation with string value reference set (foundation metadata concept) |

1296895003 |Language code (foundation metadata concept)|

900000000000465000 |String (foundation metadata concept)|

1

900000000000456007 | Reference set descriptor|

1292992004 | Component annotation with string value reference set (foundation metadata concept) |

1296892000 |Annotation type (foundation metadata concept)|

900000000000461009 |Concept type component|

2

900000000000456007 | Reference set descriptor|

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

...