Import via Aidbox Configuration project
Aidbox Configuration project is used to configure Aidbox with various features. One of the things it’s used for is providing Aidbox with external terminologies.
FHIR Terminology Repository, or FTR, is an efficient way to store and handle terminologies. It is the recommended way to work with CodeSystem and ValueSet resources in Aidbox. You can start using it by providing Aidbox Configuration project set up with FTR.
This approach is deprecated. Its support may end in the near future.
Specify path or url to zen terminology bundle in
AIDBOX_ZEN_PATHSenvironment variable. Source is either
urlis used to download Aidbox project from a remote location;
pathis used to load Aidbox project from the filesystem. Aidbox imports terminology bundles found in zen paths. Bundles are just
.ndjson.gzfiles with filenames matching
*terminology-bundle.ndjson.gzwildcard. By default, the import is done asynchronously and you can track the progress. In some cases (e.g CI/CD pipeline) you might want to override such behavior. Setting
BOX_FEATURES_TERMINOLOGY_IMPORT_SYNCenvironment variable will change the import mode to synchronous.
Aidbox reads files from Aidbox projects on startup and imports files whose names end with
For example, path to terminology bundle GZIP fie is:
To load the terminology bundle into Aidbox set the following environment variables:
You can read more about AIDBOX_ZEN_PATHS and BOX_FEATURES_FTR_PULL_ENABLE in our configuration reference.
Zip-archive your terminology bundle that is my-terminology-budnle.ndjson.gz file in my-terminology.zip file.
Upload your my-terminology.zip to a remote server e.g. https://example.com/terminologies/my-terminology.zip
Aidbox will import terminology from the specified path on start.
Aidbox offers an RPC method to track the async import progress. The response shows bundles in the import queue, failed imports and currently importing bundle.