Aidbox
Search…
⌃K

Aidbox configuration project

Aidbox configuration project refers to a set of configuration files used to set up an Aidbox instance
Aidbox configuration project is a directory which contains configuration files written in Zen language. Don’t worry if you are not yet familiar with Zen — we’ll explain all the necessary details along the way. For now you can think of it as a simple syntax well-suited for specifying all sorts of configs.
With Aidbox configuration project you can configure all things you need to have a functioning Aidbox instance including API endpoints, authorization flows, FHIR IGs and more.
Once you set up your project for one Aidbox instance you can reuse it across multiple instances — they all will be configured in exactly the same way. This feature is especially useful for testing purposes. By providing a single directory you can be sure that your CI pipeline has the same setup as your deployed instance.
Aidbox configuration project is sometimes referred to as Aidbox Project or just project. It should not be confused with Aidbox User Portal projects containing licenses.

Features supported by configuration projects

Use Aidbox configuration project

Aidbox configuration project is simply a directory with files. In order to use it in Aidbox you just need to tell where it is located and how it can be accessed.
Currently Aidbox configuration projects are supported for self-hosted instances and for Aidbox User Portal Sandbox instances. Support for AWS Marketplace installations is coming soon.
Configuration projects can be provided either as a git repository url or as a local path. We recommend to keep your project in git as the source control allows you to easily track changes, revert them or switch between branches.

Set up a configuration project

Setting up a self-hosted project is done by providing access to a project files.

Production installation

Production installation is the same as a regular installation. Exception can be the case when your production environment has no access to a git repo containing your project. For these cases Aidbox supports other methods of providing configuration projects.

Configuration projects for Sandbox instances on Aidbox user portal

  1. 1.
    Proceed to creating a new license
  2. 2.
    Select either a Standard or Development license type and Sandbox hosting
  3. 3.
    Choose which projects to enable in FHIR Server Configuration section.
Currently available projects include various FHIR IG zen packages and Aidbox SDC forms.
FHIR terminologies from IG packages are not loaded into the Sandbox database. This means they won’t be available for introspection. You can still use them for validation.
If you want to have them in the database, you need to configure projects for a local instance.

Configuration projects in AWS Marketplace Aidbox SaaS

Aidbox configuration projects will be supported on AWS Marketplace in upcoming releases.

Configuration projects in self-hosted instances

Examples

Common errors

Entrypoint 'smartbox.portal' not loaded.
​
{:message "No file for ns 'smartbox.portal", :missing-ns smartbox.portal, :ns smartbox.portal}
Meaning: Wrong zen source files path
​
Cloning into '/tmp/aidbox-project-git'...
​
remote: Repository not found.
​
fatal: repository 'https://github.com/Aidfdfdfbox/aidbox-project-samples.git/' not found
Meaning: Incorrect git repo url
​
error: pathspec 'git-project-unexist' did not match any file(s) known to git
Meaning: Incorrect checkout branch/commit