Terminology Change Set Exchange
1.0.0 - STU1 International flag

Terminology 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

Plain Language Summary goes here

Home

Official URL: http://hl7.org/fhir/uv/termchangeset/ImplementationGuide/hl7.fhir.uv.termchangeset Version: 1.0.0
IG Standards status: Draft Maturity Level: 0 Computable Name: TermChangeSet

Contents:

Introduction

Custodians of standardized terminologies have developed rich semantic frameworks that can be used to interact with individual concepts in an elegant fashion, utilizing the relationships between terms to dynamically adjust user interfaces or derive clinical patterns. Today, these frameworks are distributed via proprietary formats and are tailored to the specific source terminology. As a result, any system looking to utilize the full semantic power of the terminology must build customized data pipelines to process those formats.

This Implementation Guide (IG) provides profiles and implementation guidance on utilizing the CodeSystem resource for exchanging terminology change sets that include full semantic detail from the source terminology. A CodeSystem change set is a collection of concepts intended to be added to an existing published version as a temporary solution until the code system publisher provides an official update. Change sets should be a distribution format used for a specific version of a specific terminology, and not used to support operational transactions on a Terminology Server. The expected result of ingesting a change set is that the Terminology Server should be prepared to make content from the new version of the terminology available. This IG also addresses exchanging terminology change sets containing concepts not yet incorporated into published source terminology versions, such as those requiring rapid distribution during a pandemic-response context. Analysis of semantic detail to include in a change set is informed by the Tinkar Standardized Terminology Knowledgebase Reference Model, and mappings from that architecture are included on CodeSystem profiles.

Technical Overview

The design for Terminology Change Sets is primarily a robust utilization of the CodeSystem resource's modelling for CodeSystem.concept and CodeSystem.property to convey not just the concept identifiers and descriptions, but the full semantic design for each concept. Additionally, a Provenance instance is used to provide insight into the creation of the Terminology Change Set, particularly using Provenance.what to reference the baseline Terminology from which the change set was derived.

Terminology Change Set Design

The main sections of this IG are:

  • Guidance - this page provides best practices and considerations for implementation of Terminology Change Sets.
  • Background - these pages provide background on how incremental releases of Terminologies are currently handled, the need for a standardized Terminology Change Set format in FHIR, and an inventory of known FHIR limitations related to the inclusion of full semantic detail for terminology concepts.
  • FHIR Artifacts - this page provides the central source for all Profiles, Extensions, ValueSets, and Examples used in this IG.
  • Tinkar Reference Model - these pages provide context and background for the Tinkar Reference Model, which informed the analysis and design for Terminology Change Set profiles.
  • Downloads - this page provides links to downloadable artifacts.
  • Change Log - this page documents the changes across the versions of the Terminology Change Set IG.

Credits

This implementation guide was made possible by the thoughtful contributions of the following people and organizations:

  • Keith Campbell MD PhD, US Food and Drug Administration (FDA)
  • Marti Velezis, Sonrisa Consulting
  • Russell Ott, Deloitte Consulting LLP
  • Samuel Wescott, Deloitte Consulting LLP
  • Matthew Deitz, Deloitte Consulting LLP
  • Bimla Siwakoti, Deloitte Consulting LLP
  • Jess Bota, Apelon
  • Andrea Pitkus PhD MLS(ASCP)CM FAMIA, University of Wisconsin School of Medicine and Public Health
  • Carol Macumber, Clinical Architecture

Cross Version Analysis

This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B} systems. Packages for both R4 (hl7.fhir.uv.termchangeset.r4) and R4B (hl7.fhir.uv.termchangeset.r4b) are available.

Dependency Table

IGPackageFHIRComment
.. Terminology Change Set Exchangehl7.fhir.uv.termchangeset#1.0.0R4
... HL7 Terminology (THO)hl7.terminology.r4#6.4.0R4Automatically added as a dependency - all IGs depend on HL7 Terminology
.... FHIR Extensions Packhl7.fhir.uv.extensions.r4#5.2.0R4

Package hl7.fhir.uv.extensions.r4#5.2.0

This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Mon, Feb 10, 2025 21:45+1100+11:00)

Globals Statements

There are no Global profiles defined

IP Statements

This publication includes IP covered under the following statements.