Purpose

There are a variety of reasons for inactivating a relationship in an extension, including:

Principles

Inactivating Extension Relationships

Relationships in an extension can be inactivated if required. This is done by creating a new version of the extension relationship with a more recent effectiveTime and the active attribute set to '0' (for 'inactive').

Inactivating Relationships from the International Release

Relationships which belong to the International Edition (or to a module on which the extension depends) should not be inactivated in an extension. When relationships from the International Edition need to be excluded, this can be done by creating a simple reference set of either 'included' or 'excluded' relationships.

The only situations in which an extension producer may inactivate a relationship specified in the international edition (or a module on which the extension depends) are:

In these situations, the relationship from the International Edition (or module on which the extension depends) is inactivated by creating a new version of the relationship in the extension module with a more recent effectiveTime and the active attribute set of '0' (for 'inactive').

Process

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

File TypeProcess

Relationship





A new row representing a new version of the relationship being inactivated is added to the file.

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

  • id is set to the same relationship identifier as the relationship being inactivated
  • effectiveTime is set to the date the extension will be published
  • active is set to 0 to indicate that the relationship will become inactive at the time of publication
  • moduleId is set to identify a module in the extension
  • sourceId, destinationId, typeId, characteristicTypeId, typeId are set as per the previous version of this relationship