When SNOMED CT content is promoted from an extension module into a less dependent module (e.g. the international edition) to enable broader use, specific changes occur in the RF2 files of the associated SNOMED CT releases. In this section, we provide examples of how the relevant RF2 release files are changed when a concept is promoted and explain how the resulting files are used.
Distribution Approaches
SNOMED CT is distributed to users using one of two main approaches:
- As a SNOMED CT edition, in which the SNOMED CT extension content is combined together with the files from the International Edition (and any other dependent module)
- As a SNOMED CT extension, which contains only the new content added into the extension. To deploy a SNOMED CT extension, it must be combined with the international versioned edition that it is dependent on (and any other dependent modules), and any conflicts resolved (as explained below).
The diagram below illustrates these two approaches. In each approach, 3 release file types are distributed - the full release, the snapshot release and the delta release. Please refer to 5.6.1.2 Packaging and File Naming for more information.
Please note: Delta files have been removed from the SNOMED International release package, but a Delta Generation Tool is available for those who need it. The Delta Generation Tool allows users to create their own Delta between two fixed release dates - you can find it here: https://github.com/IHTSDO/delta-generator-tool/releases.
Concept Promotion Scenario
In the following sections, we illustrate how each of the Concept files would appear both before and after the promotion of the fictitious concept | Example Concept| from the | Extension module (foundation metadata concept)| to the | SNOMED CT core module (core metadata concept)| .
In these examples, we will assume that the | Example Concept| was:
- Created in the | Extension module (foundation metadata concept)| on 31st September 2018
- Updated in the | Extension module (foundation metadata concept)| on 31st March 2020
- Promoted to the | SNOMED CT core module (core metadata concept)| on the 31st July 2020
We also assume the following dependencies:
- Before promotion: The 31st March 2020 version of the National Extension is dependent on the 31st January 2020 International Edition
- After promotion: The 31st September 2020 version of the National Extension is dependent on the 31st July 2020 International Edition
In the following section, we will first illustrate the changes using the SNOMED CT edition distribution method. And in the subsequent section, we will illustrate these changes using the SNOMED CT extension distribution method. In both cases, we will consider the impact to all three release file types - the full release, the snapshot release and the delta release-
Concept Promotion using Edition Distribution
In this section, we illustrate the changes to the release files when promoting a concept using the edition distribute method.
Please note that the id, module and definitionStatusId fields in the RF2 release files contain only the SNOMED CT identifier of the relevant concept.
In the example tables below, we have included a synonym for each concept for human readability.
Full Release File
Before Promotion
Concept File - Full (National Edition 20200331) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
20180931 | 1 | |||
20200331 | 1 |
After Promotion
Concept File - Full (National Edition 20200931) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
20180931 | 1 | |||
20200331 | 1 | |||
20200731 | 1 |
Snapshot Release File
Before Promotion
Concept File - Snapshot (National Edition 20200331) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
20200331 | 1 |
After Promotion
Concept File - Snapshot (National Edition 20200931) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
20200731 | 1 |
Delta Release File
Before Promotion
Concept File - Delta (National Edition 20200331) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
| Example Concept| | 20200331 | | Extension module| | 1 |
After Promotion
Concept File - Delta (National Edition) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
| Example Concept| | 20200731 | 1 |
Concept Promotion using Extension Distribution
In this section, we illustrate the changes to the release files when promoting a concept using the extension distribute method.
Please note that the id, module and definitionStatusId fields in the RF2 release files contain only the SNOMED CT identifier of the relevant concept.
In the example tables below, we have included a synonym for each concept for human readability.
Full Release File
Before Promotion
Concept File - Full (National Extension 20200331) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
20180931 | 1 | |||
20200331 | 1 |
Concept File - Full (International Edition 20200131) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
No rows in the International Edition reference | Example Concept| |
After Promotion
Concept File - Full (National Extension 20200931) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
20180931 | 1 | |||
20200331 | 1 |
Concept File - Full (International Edition 20200731) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
20200731 | 1 |
Please note that the Full View of the Virtual Edition (for deployment in systems) can be created by simply combining the rows from the files above (ie all three rows).
Snapshot Release File
Before Promotion
Concept File - Snapshot (National Extension 20200331) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
20200331 | 1 |
Concept File - Snapshot (International Edition 20200131) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
No rows in the International Edition reference | Example Concept| |
After Promotion
Concept File - Snapshot (National Extension 20200931) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
20200331 | 1 |
Concept File - Snapshot (International Edition 20200731) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
20200731 | 1 |
Delta Release File
Before Promotion
Concept File - Delta (National Extension 20200331) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
20200331 | 1 |
Concept File - Delta (International Edition 20200131) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
No rows in the International Edition reference | Example Concept| |
After Promotion
Concept File - Delta (National Extension 20200931) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
No rows in the Extension Concept File reference | Example Concept| |
Concept File - Delta (International Edition 20200731) | ||||
id | effectiveTime | module | active | definitionStatusId |
---|---|---|---|---|
20200731 | 1 |
Please note that the Full View of the Virtual Edition (for deployment in systems) can be created by simply combining the rows from the files above (ie one row).
Feedback