Purpose
The main reasons main reasons for adding descriptions in an extension are:
...
Principles
Overview
As depicted in
| Caption reference |
|---|
| CapRefId | descriptions-can-reference-concepts-in-other-extensions-or-editions |
|---|
| CapRefType | Figure |
|---|
|
, a description in an extension may refer to any concept in the same extension (Extension B), any concept in a module upon which the extension modules depend (Extension A), or any concept in the International Edition.
| Caption label |
|---|
| CapId | descriptions-can-reference-concepts-in-other-extensions-or-editions |
|---|
| CapType | Figure |
|---|
|
Descriptions can reference concepts in other modules on which the extension modules depend |
Note that the green and orange triangles pointing to the purple circle represent a situation in which a description is added to an extension that describes an international concept. These extension descriptions supplement the descriptions that are already part of the International Edition.
...
The table below provides a summary of the process to follow when adding new descriptions to an extension.
| File Type | Process |
|---|
| Description
| A new row which represents the new description is added to the description file. |
The attributes of the new description are set as follows: - id is set to a new descriptionId allocated within the extension namespace
- effectiveTime is set to the date the extension will be published
- active is set to 1 to indicate that the new description 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 to the id of the concept to which this description applies
- languageCode is set to the two character code of the language in which this term was authored
- typeId is set to indicate the type of the description
- Values include
| Concept |
|---|
| ShowParts | term |
|---|
| t | 900000000000003001 |Fully specified name| |
|---|
|
or | Concept |
|---|
| ShowParts | term |
|---|
| t | 900000000000013009 |Synonym| |
|---|
|
- term is set to the string of characters used to describe the given concept
- caseSignificanceId is set to indicate the case significance of the term
|
| Language Reference Set | A new row (or member) is added to each relevant language reference set. |
The attributes of the new language reference set member are set as follows: - id is set to a unique automatically-generated UUID
- effectiveTime is set to the date the extension will be published
- active is set to 1 to indicate that the new member will be active at the tiem of publication
- moduleId is set to the conceptId of a module that is managed by the extension producer
- refsetId is set to the conceptId of the language reference set to which the member is added
- referencedComponentId is set to the descriptionId of the new description
- acceptability is set to indicate the acceptability of the new description in the relevant language or dialect
- Value is either
| Concept |
|---|
| ShowParts | term |
|---|
| t | 900000000000548007 |Preferred| |
|---|
|
or | Concept |
|---|
| ShowParts | term |
|---|
| t | 900000000000549004 |Acceptable| |
|---|
|
- Each concept may have only one preferred FSN and one preferred synonym in each language reference set
|