CodeSystem Change Set Exchange
1.0.0 - International flag

CodeSystem Change Set Exchange, published by HL7 International / Terminology Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/termchangeset-ig/ and changes regularly. See the Directory of published versions

Change Set Exchange

Page standards status: Informative

Contents:

A use case scenarios for FHIR-based CodeSystem Change Set Exchange is described below and illustrated in a sequence diagram.

CodeSystem Change Set Exchange Use Case

In this example, a terminology publishing organization is making an incremental change to its extension of SNOMED CT by adding a new concept. To enable data exchange with a close trading partner that makes use of this extended concept, this publishing organization shares a CodeSystem Change Set with a the trading partner (the Terminology Consumer identified in the steps below).

  1. Authoring Environment: Terminologist creates a new concept to extend SNOMED CT, exports it as a CodeSystem Change Set, and posts it to the FHIR server
  2. Terminology Consumer: Requests the CodeSystem Change Set from the FHIR server
  3. FHIR Server: Delivers the FHIR Resource Bundle requested
  4. Terminology Consumer: Updates the Local Terminology Database with the contents of the CodeSystem Change Set retrieved
Change Set Interaction Diagram

Scenario 1: Change Set of SNOMED CT Data

Key Objective : Modifying existing SNOMED CT concepts, including changes to their defining semantics, can be exported from one source and imported to another system.

Precondition:
  1. Users have access to an integrated knowledge representation (IKM) platform to view and edit SNOMED CT data
  2. SNOMED CT release files have been installed.
  3. The system supports FHIR generation and/or ingest capability based on the SNOMED Change Set CodeSystem profile.
Step 1 - Modify the semantics for existing SNOMED CT concepts.
Actions:
  1. Search/navigate for SNOMED CT Concepts.
  2. Edit SNOMED CT concepts
Step 2 - Post change set to FHIR server
Actions:
  1. Export and post the change set including underlying semantics as CodeSystem and Provenance resources on a FHIR server
Step 3 - Consuming system retrieves and ingests change set from FHIR server
Actions:
  1. Retrieve CodeSystem and Provenance resources from FHIR server
  2. Ingest to local terminology representation complete change set inclding underlying
Scenario Success Criteria:
  • Consuming system can ingest change set without error
  • Post-ingestion, changes included in change set are visible within the consuming system

Scenario 2: Change Set of new terminology concepts

Key Objective : Authoring net new concepts, including changes to their defining semantics, can be exported from one source and imported to another system.

Precondition:
  1. Users have access to an integrated knowledge representation (IKM) platform to view and edit SNOMED CT data
  2. SNOMED CT release files have been installed.
  3. The system supports FHIR generation and/or ingest capability based on the SNOMED Change Set CodeSystem profile.
Step 1 - Author net new concept
Actions:
  1. Author new concept with appropriate defining semantics
Step 2 - Post change set to FHIR server
Actions:
  1. Export and post the change set including underlying smenaitcs as CodeSystem and Provenance resources on a FHIR server
Step 3 - Consuming system retrieves and ingests change set from FHIR server
Actions:
  1. Retrieve CodeSystem and Provenance resources from FHIR server
  2. Ingest to local terminology representation complete change set inclding underlying
Scenario Success Criteria:
  • Consuming system can ingest change set without error
  • Post-ingestion, changes included in change set are visible within the consuming system