Purpose

The main reasons for modifying a description in an extension are:

Principles

Overview

Making changes to existing descriptions requires careful consideration, because the descriptions may have been used in clinical records to represent the meaning of the associated concept. Changes are, however, permitted, as long as only mutable attributes are modified. Immutable attribute values should not be modified.

The conceptId field, the languageCode field and the typeId field cannot change between different versions of the same description. If a change is required to one of these immutable attributes, then the existing description should be inactivated, and a new description with the required attribute values should will be added.

Extension producers should not modify descriptions, which are part of the International Edition. When issues with international descriptions arise, SNOMED International should be notified so the issue may be addressed in a subsequent release. 

Changing Mutable Description Attributes

Table 5.4.3.2-1 lists the various description attributes and their mutability. The following modifications to the mutable attributes are permitted

Table 5.4.3.2-1: Mutability of description attributes

Changing the Acceptability of Descriptions

An extension producer may also need to change the acceptability of a description. For example, a synonym may change from being acceptable to preferred, or from being preferred to acceptable. This type of change does not require any modifications to the Description file. Instead, the associated member of the relevant language reference set must be modified. For more information, please refer to 5.4.6.2 Modify Members of a Reference Set.

Process

The table below provides a summary of the process to follow when modifying descriptions in an extension.

File TypeProcess
Description

A new row which represents a new version of the description is created.

The attributes of the new version of the description are set as follows:

  • id is set to the descriptionId of the description being modified
  • effectiveTime is set to the date the extension will be published
  • active is set to 1 to indicate that the new version of thedescription will be active at the time of publication
  • moduleId is set to the conceptId of a module that is managed by the extension producer
  • conceptId is set the same as the original version of the description
  • languageCode is set the same as the original version of the description
  • typeId is set the same as the original version of the description
  • term is set to the (possibly updated) string of characters used to describe the given concept. Note: Only limited changes, in accordance with editorial rules, can be made
  • caseSignificanceId is set to indicate the (possibly updated) case significance of the term
Language Reference Set

If no changes to the acceptability of the description are required, then no changes to the associated language reference set members are necessary.

If changes to the acceptability of the description are required, a new version of the relevant language reference set member is added with the required acceptabilityId.