Uploading IG terminology content to external FHIR terminology server

In this tutorial, we will guide you through the steps to populate an external FHIR terminology server with IG terminology content, including ValueSets, CodeSystems, and more.

1. Install UploadFIG utility

To get started with the UploadFIG, you'll first need to install Dotnet and download uploadfig. Follow the commands below or refer to the original UploadFIG Installation guide:

$ brew install dotnet
$ dotnet tool install uploadfig --global
$ export PATH="$PATH:/Users/<USER_NAME>/.dotnet/tools"

After installation, verify that the is correctly installed:

UploadFIG --version

These steps ensure that you have the necessary tools installed and configured to use the UploadFIG effectively.

2. Upload IG Terminology Content Using UploadFIG

To upload IG terminology content, execute the following command:

UploadFIG -pid <package-id> \
-pv <package-version> \
-r ValueSet \
-r CodeSystem \
-d <fhir-server-url> \
--verbose \
--includeReferencedDependencies

Command Breakdown:

  • -pid β€” The package ID (e.g., hl7.fhir.r4.core, hl7.fhir.us.core, hl7.fhir.us.mcode, etc.).

  • -pv β€” The package version (e.g., 4.0.1, 6.1.0, 3.0.0-ballot, etc.).

  • -r β€” The resource types to load. For IG terminology, specify ValueSet and CodeSystem.

  • -d β€” The FHIR server URL.

  • --verbose β€” Enables verbose output.

  • --includeReferencedDependencies β€” Loads any referenced CodeSystem or ValueSet from other packages.

If your IG is located on a file system, you can use the -s option with the path to your IG instead of the -pid option.

Examples

Uploading US Core Terminologies by Package ID:

UploadFIG -pid hl7.fhir.us.core \
-pv 6.1.0 \
-r ValueSet \
-r CodeSystem \ 
-d https://r4.ontoserver.csiro.au/fhir \
--verbose \
--includeReferencedDependencies

Uploading mCode Terminologies from a Local File System:

First, download mCode version 3.0.0 to your machine:

curl -sLo mcode.tgz https://packages2.fhir.org/packages/hl7.fhir.us.mcode/3.0.0

Then, upload the terminologies:

UploadFIG -s mcode.tgz \
-r ValueSet \
-r CodeSystem \
-d https://r4.ontoserver.csiro.au/fhir \
--verbose \
--includeReferencedDependencies

Last updated