A description may be created in an extension as part of the process of adding a new concept, or adding a translation or alternative synonyms to an existing concept. Extension descriptions are distributed in a description file, which follows the standard RF2 release file format. For more details on the principles and processes for authoring descriptions in an extension, please refer to 5.4.3 Authoring Descriptions.
In addition to the four common attributes, descriptions also have a conceptId, languageCode, typeId, term and caseSignificanceId.
The conceptId attribute links the description to the concept that it describes. The conceptId may refer to a concept in the same extension module or to a concept in a module on which the extension module depends.
The languageCode is a two-character string, which specifies the language of the description using the ISO 639-1 standard (e.g. 'EN', 'ES'). Please note that the languageCode specifies only the language of the description (e.g. English or Spanish) and does not indicate the dialect (e.g. US English or GB English). Dialect preferences are represented by language reference sets. Extensions may use a languageCode not used by the International Edition.
The typeId is a SCTID that specifies the type of the description. The value of this attribute must be a descendant of |Description type|. Possible values include |Fully specified name|, |Synonym|, and |Definition|. Note that |Definition| is used for text definitions, which are not included in the main description distribution files. Instead, descriptions of type |Definition| are distributed in a separate text definitions file.
The term attribute is a text string that describes the given concept. The term is represented using UTF-8, which allows non-English character sets to be used, such as the accented characters used in Nordic languages, Hindi characters and Chinese characters. The maximum length of a fully specified name or synonym is defined in the |Description format reference set| as 255 characters. Longer terms can be used for text definitions, which may be up to 4096 characters in length.
The caseSignificanceId attribute is a SCTID which specifies how the case of the characters in the term may be changed when using the term. The values of this attribute always refer to descendants of the concept |Case significance|, and at the time of this publication, the three possible values are |Entire term case insensitive|, |Entire term case sensitive|,or |Only initial character case insensitive|.
Figure 126.96.36.199-1: A row from the description table in the 20170901 US EditionPlease note the following:
In figure 188.8.131.52-0 below, a row is presented from the descriptions table of the 20170430 Canadian edition. Note that this description is associated with a concept from the International Edition.
Figure 184.108.40.206-2: A row from the description table of the 20170401 French Canadian extensionPlease note the following: