Load RxNorm into Aidbox

Setting up Aidbox with RxNorm terminology loaded via FTR

Since the 2405 release, using Aidbox in FHIRSchema mode is recommended, which is incompatible with zen or Entity/Attribute options.

Broken link

RxNorm provides normalized names for clinical drugs and links its names to many of the drug vocabularies commonly used in pharmacy management and drug interaction software, including those of First Databank, Micromedex, Multum, and Gold Standard Drug Database. By providing links between these vocabularies, RxNorm can mediate messages between systems not using the same software and vocabulary. The license is free if you intend to use only the RxNorm codes.

We offer out-of-the-box integration with the most recent version of RxNorm, accessible at any given time, via the Aidbox Configuration project and FTR.

This bundle includes only codes with the Source Abbreviation (SAB) labeled as RXNORM. Codes from vocabularies such as SNOMED, Micromedix, GSDD, etc., are not part of this bundle. If you require these vocabularies, please reach out to us.

How to set up Aidbox with RxNorm terminology

To correctly set up Aidbox, we'll utilize the Aidbox configuration projects. There's an existing guide for this process. Adhere to this guide, but note a variation when you reach the Configure the Aidbox step: instead of using the recommended configuration projects (R4,R4B,R5,etc.) — clone this specific project:

git clone \
  https://github.com/Aidbox/aidbox-project-template-rxnorm.git \
  aidbox-project && \
  cd aidbox-project && \
  rm -rf .git

This project is tailored with specific configurations essential for terminology loading.

Configuration Overview: Key Features and Distinctions

If you already have a configuration project, you can replicate these steps to enable RxNorm terminology in your Aidbox instance.

Added RxNorm dependency to configuration project

zen-package.edn

{:deps {rxnorm "https://github.com/zen-fhir/rxnorm.git"}}

By adding this dependency, we instruct Aidbox to load the zen.fhir ValueSet definition, which is meant to include all codes from RxNorm. This ValueSet definition contains a specific directive detailing the FTR manifest. Aidbox'll use this manifest to input the actual RxNorm concepts into the database.

rxnorm/zrc/rxnorm.edn

{ns rxnorm,
 import #{zen.fhir},
 value-set
 {:zen/tags #{zen.fhir/value-set},
  :zen/desc "Includes all concepts from RxNorm.",
  :zen.fhir/version "0.6.0",
  :fhir/code-systems
  #{{:fhir/url "http://www.nlm.nih.gov/research/umls/rxnorm",
     :zen.fhir/content :bundled}},
  :uri "http://www.nlm.nih.gov/research/umls/rxnorm/valueset",
  :version "10022023",
  :ftr
  {:module "rxnorm",
   :source-url "https://storage.googleapis.com",
   :ftr-path "ftr",
   :source-type :cloud-storage,
   :tag "prod"}}}

Imported RxNorm namespace to configuration project entrypoint

{ns main
 import #{aidbox
          config
          }
 …}

Zen requires importing a namespace into the entrypoint to load the ValueSet definition into the definitions store.

FTR Pull Feature — instruct Aidbox to load concepts into the database

By default, Aidbox does not load terminologies into the database as that can take a lot of disk space. This means that full terminology functionality won’t be available until you enable it manually. When you set it to true, Aidbox will load terminologies into the database on the next startup and start functioning as a fully-featured terminology server.

To achieve that we set ftr.pull.enable to true in features map.

When adding this feature to existing configuration projects, be mindful. If you include dependencies like hl7-fhir-r4-core or hl7-fhir-us-core, Aidbox will load terminologies from these packages, which are sizable. Therefore, loading all the concepts into the database might take a while.

zrc/config.edn

 features
 {:zen/tags #{aidbox.config/features}
  :ftr {:pull {:enable true}}}

What else you can do with configs related to terminology?

Lock Aidbox's start until all concepts are stored in the database

When ftr.pull.enable is set to true, Aidbox loads concepts asynchronously by default. This means that immediately after starting, there might be no concepts available because they are still loading. To address this behavior, set ftr.pull.sync to true.

zrc/config.edn

 features
 {:zen/tags #{aidbox.config/features}
  :ftr {:pull {:enable true
               :sync true}}}

How can you determine if the concepts are still loading or have already loaded? (Usable for async pulls)

Access the Aidbox UI and navigate to Database > Running Queries. Look for a query that includes "_import"; this query is responsible for loading concepts into your database. Once this query disappears from the list, you can check the concepts in the database. Proceed to Database > DB Console and enter the following query:

SELECT count(*) from concept where resource->>'system' = 'http://www.nlm.nih.gov/research/umls/rxnorm'