Purpose

There are various reasons for inactivating descriptions in an extension, including:

Principles

Excluding Extension Descriptions

Descriptions created in an extension can be inactivated if necessary. This is done by inactivating both the description itself and the associated member(s) of the relevant language reference set(s). It is recommended that the reason for inactivation is specified in the Description inactivation indicator attribute value reference set see 5.2.3.1 Component Inactivation Reference Sets.

Excluding International Descriptions

Descriptions which belong to the International Edition (or another module on which the extension depends) should not be inactivated in the extension. If there is a requirement to remove international descriptions from an extension, this should be accomplished by excluding the given description identifiers from the relevant language reference set(s). Two possible approaches for this are described below.

Copy and Adapt Language Reference Set

This approach involves creating a copy of one of the language reference sets distributed with the International Edition, and adding or removing members as required. All members of the new language reference set must be assigned to a module in the extension. When using this approach, the extension producer is responsible for maintaining the new language reference set. If the extension producer wants their new language reference set to incorporate future changes made to the international language reference set, they are responsible for maintaining these changes. 

Adopt and Adapt Language Reference Set

An extension producer may choose not to create a new copy of an international language reference set. Instead, they may use the international language reference set directly, and exclude any members of this reference set by inactivating the relevant members in their extension module. To exclude a description from an international language reference set, a new version of the reference set member is created with the following attributes:

Please note that if a new version of the reference set member is published in the International Edition, this will become the current version of that member. It may, therefore be necessary to create a new inactive version in the extension with a more recent effectiveTime.

Process

This table describes the process of excluding descriptions in an extension.

File TypeProcess
Description

To exclude descriptions in an extension, a new inactive version of the description is added to the description file.

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

  • id is set to the descriptionId of the description being inactivated
  • effectiveTime is set to the date the extension will be published
  • active is set to '0' to indicate that the description is being inactivated
  • moduleId is set to identify a module in the extension

The remaining attributes are set to the same value as in the previous version of the description.

Language Reference Set

A new row, which references the description to be excluded, with the following attribute values:

  • id is set to the same value as the reference set member being excluded
  • effectiveTime is set to the date the extension will be published
  • active is set to '0' to indicate that the reference set member is being inactivated
  • moduleId is set to identify a module in the extension

The remaining attributes are set to the same value as in the previous version of the reference set member.

Description inactivation indicator reference set

The represents the reason that each inactive description was inactivated.

When inactivating a description, it is good practice to specify the reason for inactivation in this reference set.

The allows extension consumers to understand the reason that each description was inactivated. Please visit 3.2.6.3. Managing Component Inactivation for further information.