Load ICD-10-CM into Aidbox
Start working with ICD-10-CM terminology in Aidbox
ICD-10-CM is a large medical terminology which can be used in FHIR ValueSet resources. It is distributed under a license which you have to set up with them.
We provide out-of-the box integration with ICD-10-CM through Aidbox Configuration Project. You may start using it after we make sure you have the required ICD-10-CM license.
There is a step-by-step guide below which takes you from our default Aidbox Configuration project to a fully enabled ICD-10-CM terminology.
You need to have an Aidbox Configuration project to load prepackaged ICD-10-CM terminology. One of the easiest way is to start with our Docker Getting started guide.
ICD-10-CM is distributed under a license which means that we can not redistribute it without making sure that other people have this license. You can confirm your eligibility for accessing ICD-10-CM by contacting Aidbox team. See our contacts here.
We distribute ICD-10-CM through a private Github repository. This means that you have to provide us with your public SSH key which we’ll add to the repository’s access list.
You also need to set Aidbox environment variables to use this public key and its corresponding private key. They are required so that Aidbox is able to work with private ICD-10-CM repository.
The required environment variables are listed below:
-----END … -----
Be aware that there’s a newline at the end of
BOX_PROJECT_GIT_PRIVATE__KEY. Make sure that it is present otherwise the key becomes invalid.
zen-package.ednto include ICD-10-CM repository in the dependencies:
You also need to import
icd10cmnamespace in your Aidbox entrypoint file. Assuming you are working with
docker-compose-templatefrom Prerequisites, it is
Set the following environment variable:
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. BOX_FEATURES_FTR_PULL_ENABLE environment variable is just for that. 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.
If you want to customize Aidbox startup behavior when using FTR, read more about FTR environment variables.
One of the options you may want to consider is enabling
BOX_FEATURES_FTR_BUILD__INDEX__ON__STARTUP_SYNC. Setting this environment variable to
truewill make Aidbox startup blocked until ICD-10-CM terminology is fully available for fast and efficient validation.