Start Aidbox with US Core IG enabled
Last updated
Was this helpful?
Last updated
Was this helpful?
Currently it is only possible to use FHIR IGs for self-hosted installations. We are working to add support for other distributions.
You need to go through the following steps:
Set up base Aidbox instance
Specify US Core as a dependency
Commit changes to your Aidbox configuration project
Start Aidbox and verify that IGs are enabled
All of them are covered in a greater detail below.
Set up Aidbox instance by following our quick start guide.
Put the following content in project/zen-package.edn:
Go to the main configuration file for your system (project/zrc/system.edn if you followed the quick start guide from above) and add hl7-fhir-us-core namespace to imports. It should look like this:
Commit the changes you just made:
Start Aidbox by running the following command:
It should be available now at http://localhost:8888.
Note that US Core IG takes about 1.5GB in the database. You can significantly reduce this size by disabling the loading of Concepts, ValueSets and CodeSystems. For that you need to set BOX_FEATURES_FTR_PULL_ENABLE=true|false.
By default, Aidbox does not load terminologies into the database in order to save the disk space. This still allows you to use them for validation but terminology server functionality won’t be available. If you do wish to load the terminologies, you need to set BOX_FEATURES_FTR_PULL_ENABLE=true environment variable.
Go to “Profiles” page in the Aidbox UI (http://localhost:8888/ui/zen-ui) and make sure that hl7-fhir-us-core is listed among the namespaces.
You can also verify that validation with US Core IG works. For that you can make the following HTTP requests and check that response statuses are returned as expected.
This request checks that valid values for birthsex field are allowed.
This request checks that invalid values for birthsex field are not allowed.
If you want to learn more about working with IGs in Aidbox, there is a special page dedicated to it.
Commit step is necessary as we are using which is a git repository under the hood.
You’ll still be able to but and as well as GET /Concept, GET /ValueSet and GET /CodeSystem endpoints won’t work. Lookups and expansions without loading into database are currently work in progress