Release Notes
- Validation and Terminology
- Data API
- Implemented handling of unique errors: it is now possible to enforce uniqueness on some combination of fields
- Improved conformance of conditional queries
- MDM (Master Data Management)
- Fixed bugs with Python integration
- C-CDA to FHIR converter
- Introduced FHIR to CCD transformation (alpha)
- Security and Access Control
- Ops
- Aidbox Forms
- Improved Forms UX
- Supported tooltip for forms and input fields
- Supported Markdown for labels and tooltips
- Terminology
- Data API
- Implemented automatic loading of search parameters on extensions from IG
- C-CDA to FHIR converter
- Security and Access Control
- Supported passing any launch context parameters on SMART on FHIR 2.0 app launch flow with fhirContext parameter
- Ops
- Add GraphQL request body in gq/resp log event
- Changed container OS to Alpine and reduced total container size
- Aidbox Forms
- MDM (Master Data Management)
- Archive/Restore API
- Archive/Restore API allowing to archive and restore resources to/from S3 bucket powered by Task API.
- Aidbox Configuration Projects
- Data API
- Terminology API
- Aidbox Forms
- Added layout autogeneration
- C-CDA to FHIR converter
- Improved Observation data mapping.
- Aidbox deployment and maintenance
- Smartbox
- Aidbox Configuration Projects
- Added configuration of Aidbox features via zen-lang instead of envs
- Aidbox User Portal
- Added support of setting multiple Aidbox Configuration Projects and zen FHIR IGs for Sandbox instances
- C-CDA to FHIR converter
- Aidbox Forms
- Introduced the form repository with the commonly used templates, such as PHQ-9, vital signs and GAD-7
- Terminology
- Introduced FHIR Terminology repositories (alpha) to store any terminology elements (code systems, value sets, concepts) in an effective way and distribute them among Aidbox instances
- C-CDA to FHIR converter
- Supported Diagnostic Imaging Report sections:
- DICOM
- Findings
- History
- Indications for procedure
- Supported conversion of different sections of C-CDA documents to ClinicalImpression resources:
- Consultation notes
- Discharge notes
- Procedure history notes
- Nursing notes
- Supported Care Team section mapping
- Search API
- FHIR API for EHRs
- Aidbox forms
- Supported rules, text type and display type conversion on FHIR Questionnaire -> SDCDocument converter
- Aidbox user portal
- Introduced CI/CD licenses on the Aidbox user portal. You can get this license to run multiple instances of Aidbox and Multibox in parallel for 72 hours. Both development and CI/CD licenses are available for existing customers at no cost
- Added an option to configure Aidbox instances hosted in Aidbox Cloud with FHIR IGs for data validation
- Logging and audit
- Fixed incorrect calculation of request duration for resources in transaction bundles
- Updated documentation
- Added an option to filter Aidbox stdout logs by severity. By default Aidbox sends only
error
severity level logs to stdout. - Fixed issues submitted by Aidbox users and fixed minor bugs.
- Aidbox FHIR API module (SMARTbox) is officially certified by ICSA Labs to comply with the ONC’s 2015 Edition Cures Update requirements / 170.315(g)(10).
- Added an option to get Aidbox hosted on AWS directly from the Aidbox user portal. Aidbox FHIR platform is available on AWS marketplace.
- Added env to automatically create a User resource on auth via TokenIntrospector. This allows to use both TokenIntrospector and IdentityProvider auth for the same User in Aidbox.
- Added FHIR Bundle transaction conditional CRUD with
urn:uuid
support
- Published multiple versions of zen FHIR IGs to provide an option to use a specific version of an implementation guide.
- Improved GraphQL API performance.
- Improved validation with zen-lang performance.
- Added an option to start Aidbox with an invalid Aidbox project in dev-mode to improve the debugging experience. By default, Aidbox doesn't start with invalid Aidbox projects.
- Added
BOX_FEATURES_TERMINOLOGY_IMPORT_SYNC
environment variable to enable sync terminology bundle file load. - Added configurable
refresh_token_expiration
parameter. If not defined refresh token doesn't expire. - Fixed issues submitted by Aidbox users and fixed minor bugs.
- Added Aidbox projects terminology bundle load cache. Aidbox doesn't load a terminology bundle into its database if the bundle has no changes.
- Improved chained search parameters performance.
- Fixed issues submitted by Aidbox users and fixed minor bugs.
- Changed auth layer 400/401/403 errors response body to OperationOutcome resource.
- Released Infrabox preview. Infrabox is a simple and efficient tool to deploy and manage production-ready Aidbox infrastructure on k8s.
- Released
seed service
for Aidbox project. Declare a set of resources in Aidbox project and get them loaded in one or many Aidboxes on start. - Added
content-type: application/json
as default ifcontent-type
andaccept
headers are missing. - Enhanced GraphQL with ConceptMap.group property support
- Released a February 2022 - v:2202
LTS
. __ The Aidbox team will backport security and critical bug fixes to it throughout a one-year support window.
February 2022 - v:2202 is available as a long-term support version. End of life is April 2023.
- Added Access Control debug option: su header. It allows doing a request on behalf of a certain user.
- Added Grafana dashboard RPC API that allows to get Aidbox metrics dashboards and import it to your Grafana.
- Improved logging for RPC and GraphQL calls.
- Fixed Aidbox UI pretty view display.
- Deprecated APM and JMX in default build. Please reach out to us if you're using it.
Starting from January 2022 we're switching to a new release cycle. We added
:latest and LTS
(long-term support) versions. Check the updated release cycle.- Added FHIR R4 search parameters to zen FHIR packages (alpha) as a part of our roadmap to run Aidbox on managed PostgreSQL databases.
- Released load-from-bucket import operation for huge imports that allows loading terabytes of data from an AWS bucket directly to the Aidbox database with maximum performance.
- Added Aidbox UI new tools: DB Tables and DB Queries to improve database administration and introspection.
- Added new env
box_compatibility_validation_json__schema_regex="#{:fhir-datetime}
to enable strict date time validation in JSON schema validation engine per FHIR spec.
- Added new community notebooks that demonstrate Aidbox functionality including Bulk export API, Aidbox terminology, Custom resources, etc.
- Fixed bugs submitted by Aidbox users and updated the documentation.
- Implemented the
$translate
operation. So now you can translate code from one value set to another, based on the existing value set and concept maps resources, and/or other additional knowledge available to Aidbox. - Released FHIR bulk data export. Using $export you can export patient-level, group level or system-level data to GCP, AWS storage in ndjson format.
- Released metrics server as an Aidbox component that implements the new metrics API for PostgreSQL, HikariCP and JVM metrics.
- Added zen FHIR packages version check. Aidbox won't start if you use an outdated zen FHIR package.
- Extended
AuthConfig
resource withforgotPasswordUrl
attribute. - Added Aidbox, Multibox, Devbox and Aidboxdb multi-arch Images (ARM64 and AMD64) to resolve Apple Silicon M1 processors performance issues.
- Fixed bugs submitted by Aidbox users and updated the documentation.
- Released new API for Bulk Data import. Using Aidbox.bulk you will be able to import data in both Aidbox and FHIR formats, validate uploaded resources and references asynchronously.
- Added zen FHIR packages that can be used to configure Aidboxes and validate resources against zen FHIR profiles. You can use your custom profiles, convert FHIR profiles to zen FHIR profiles or use zen FHIR packages released by our team:
- FHIR R4
hl7-fhir-us-core
- US Corehl7-fhir-us-davinci-pdex
- Payer Data Exchange (PDex)hl7-fhir-us-davinci-pdex-plan-net
- PDEX Payer Networkhl7-fhir-us-davinci-hrex
- The Da Vinci Payer Health Record exchange (HRex)hl7-fhir-us-davinci-drug-formulary
- DaVinci Payer Data Exchange US Drug Formularyhl7-fhir-us-carin-bb
- CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®)hl7-fhir-us-mcode
- mCODE™ (short for Minimal Common Oncology Data Elements)
- FHIR STU 3
nictiz-fhir-nl-stu3-zib2017
- Nictiz NL, including MedMij and HL7 NL
- Added
AIDBOX_DEV_MODE
env that enables_debug=policy
for access policy debugging. We'll add more functionality that will be available for development purposes and can be disabled on production. - Fixed bugs submitted by Aidbox users and updated documentation.
- Added Aidbox projects that can be used to configure Aidboxes and validate data. Basically, Aidbox project is a directory with zen-lang edn files that describe Aidbox configuration.
- Added Datadog integration URL configuration. So now you can specify in configuration if you want to use one of the following domains
datadoghq.com, us3.datadoghq.com, datadoghq.eu, ddog-gov.com
. - Supported SMART Application Launch Framework Implementation Guide: Patient Portal Launch, Patient Standalone Launch, Provider EHR Launch, Provider Standalone Launch. Check the sample.
- Released Aidbox Notebooks. Interactive notebooks for REST, SQL, RPC and Markdown. So now you can create your own notebooks or import community notebooks.

Aidbox notebooks
- Released a beta version of zen profiling. Advanced profiling with zen-lang to configure Aidboxes and validate data.
- Supported conditional patch (e.g.:
PATCH /Patient?name=foo
) - Added empty query params remove #238. Please pay attention when using json-schema access policy engine: Fields with empty values, such as
[], {}, "", null
, are removed before passing request into access policy processing. Make sure to addrequire
check of the fields that are validated by a json schema
- We've released a major Aidbox UI upgrade

New Aidbox UI
- Explicit request headers
content-type, accept
etc - Show raw response
- Added syntax highlight
- Upgrade Aidbox Java version to 16.
- Improved logging.
- Add w_r - templated request URL for better aggregation. For example, requests like
GET /Patient/pt-1
will becomeGET /Patient/?
thus allowing aggregate all read requests for monitoring. - Log additional DB metrics from Aidbox.Dev.
- Added ELK, Kibana, and Grafana to Aidbox image. So now you can start exploring and analyzing logs from scratch. Check our tutorial on exploring and visualizing logs here.
- We added a new auth mechanism for authorization Aidbox.Cloud and Aidbox.Multibox users by JWT.
- Added Intercom so you can get help directly from your Aidbox.Dev or Aidbox.Cloud.
- Added support for Bulk API export in CSV. You can use /[resourceType]/$dump-csv endpoint to generate CSV file in which JSON resource structure is flattened into comma-separated format. Such an option for data export is useful for integrations with external EHR systems.
- Added support for If-Match header in DELETE operation of FHIR REST API. If-Match is most often used to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource (i.e., to prevent the "lost update" problem).
- Added support for additional mime types according to the FHIR specification Accept: application/fhir+json, Accept: application/json+fhir. When one of the headers is specified for your request, the same Content-Type header is returned by Aidbox.
- Implemented integration with Datadog. Datadog offers cloud-based monitoring and analytics platform which integrates and automates infrastructure monitoring, application performance monitoring, and log management for real-time observability of customers. You can configure it as storage for Aidbox logs. The detailed guide on how to use Datadog monitoring capabilities in your Aidbox-based system you can find here. This is an easy way to leverage HIPAA-compliant log management SaaS platform to unify logs, metrics, and traces in a single view.
- Logs that are published on Aidbox startup are cleaned up from useless data.
- SSL connection between Aidbox and PostgreSQL is now supported. Please, read the configuration instructions for more details.
- Fixed a bug with race condition occurring during CRUD operations with If-Match header. Transaction rollback is implemented for the case when concurrent change happens to the resource.
- Fixed a bug in the user management module when a second registration for a deleted user resulted in an error.
- Change release name format from
DDMMYYYY
toYYYYMMDD
- FHIR format conversion
- gzip compression
_since
parameter for filtering bycreatedAt
date
- And other various bug fixes.
- Aidbox now supports deployment on top of Azure PostgreSQL.
- Improvements of $changes API: FHIR support, pagination, upper version limit. $changes is now available at the resource level.
- Enhancement of Transaction Bundle API that allows to populate both resource and history tables in one transaction.
- During transaction bundle processing attributes of url type that store relative references are now interpreted as Reference type. See the FHIR spec on Attachment data type for details.
- Enhancement of Search resource that for token search allows fallback to default modifier implementation; (last example in the linked article)
- Fixed issue with $dump and $dump-sql not allowing CORS requests
Last modified 12d ago