Release Notes
February 2025 edge
edge
Work in progress
January 2025 latest, 2501
latest, 2501
Aidbox is transitioning to the FHIR Schema engine. Existing zen and Entity/Attribute (EA) engines are deprecated and will be obsolete starting August 2025. July 2025 version will become LTS supporting zen and Entity/Attributes for 2 years.
Aidbox
Enhanced UI Resource browser:
Added reference navigation for direct navigation between linked resources
Introduced resizable columns
Implemented pagination
Introduced resizable columns
Added column selection
Added support for specifying Content Security Policy header as an environment variable. By default, Aidbox doesn't set CSP headers.
Supported Bundle batch validation using Bundle/$validate endpoint for Aidbox instances using FHIR Schema validator
Changed default stdout log level and stdout Google log level to
warn
Aidbox Forms
Improved performance for handling large forms.
Added the ability to set colors for tooltips and hover effects using the primary color in the Theme.
Enabled linking a Questionnaire profile directly in the UI Builder.
Updated the Aidbox Forms Smart Launch project with enhancements and fixes.
Added video support to the media section of the item settings .
Minor updates:
2412.2 — Fixed security issues
December 2024 stable, 2412
stable, 2412
Aidbox
Supported SMART App Launch scopes v1 and v2 for Aidbox on FHIR Schema validation engine and reworked SMART on FHIR documentation
Added example of SMART App Launch using Aidbox and Keycloak
Supported enabling OrgBAC (Organization-based hierarchical access control) using an environment variable if an Aidox instance uses FHIR Schema validator
Fixed security issues and bugs
Aidbox Forms
Added the ability to store unstructured data from forms in external file storage systems.
Supported previewing audio, video, and PDF files in the attachment field.
Improved developer experience for FHIR path expressions with syntax highlighting, autocompletion, and error reporting.
Added an option to configure a custom redirect for the back button when embedding the Form Builder as a web component.
Added the ability to associate a link with a question, group, or display item to provide additional information.
Enabled short text for questions, groups, or items to display an alternate label when rendering on smaller devices like mobile phones.
Minor updates:
2412.1 — Fixed minor bugs
November 2024 2411
2411
Aidbox
Introduced Init Bundle as a simple and effective way of configuring Aidbox. The Init Bundle will replace Aidbox (zen) configuration projects.
Added an option to disable terminology bindings validation when using FHIR schema validator
Aidbox Forms
Added named expressions for calculated/enableWhen/populate expressions and a Named Expression tab in the Debug Console.
Enabled custom text definitions for Aidbox Form Builder and Renderer.
Added support for custom error and warning messages in the Form Builder and Renderer.
Added a setting to display sections collapsed for brief overviews.
Introduced a widget to select values from a defined range with a horizontal slider.
Added AI support for translating labels in translation mode.
Released a sample project for custom SMART Apps with Aidbox Forms, supporting SMART on FHIR flows, resource synchronization, and form management.
Implemented the basic form re-population feature.
Minor updates:
2411.2 — Updated dependencies
2410.2 — Updated dependencies
2410.1 — Fixed minor bugs
October 2024 2410, LTS
2410, LTS
Aidbox
Released Aidbox UI home page
Implemented hashing for sensitive elements User, Client and Session records. it is strongly recommended to delete the history tables for these resources to prevent access to the original un-hashed secret values.
Introduced "Authorize Inline Requests" mode, ensuring that users can only retrieve resources they are authorized to view when using
_include
and_revinclude
parameters in search requests.Added Audit Logs for SQL endpoints
Added configurable CORS settings, allowing users to enable CORS and specify allowed origins.
Fixed critical vulnerabilities and bugs
Aidbox Forms
Introduced an Aidbox Forms SMART app sample project with React.js
Verified compliance with accessibility standards
Added an ability to re-populate a form with the latest available data
Added validation checks for Questionnaires directly in the UI Builder console.
Minor updates:
2409.2 — Fixed critical security issues, fixed versioning in logs
2408.2 — Fixed critical security issues, fixed versioning in logs
September 2024 2409
2409
Aidbox
Introduced new MAJOR.MINOR versioning for improved clarity
Added webhook support for Aidbox topic-based subscriptions
Implemented fuzzy search for FHIR packages import
Enabled new Aidbox UI by default
Fixed critical vulnerabilities and bugs
Smartbox | FHIR API for EHRs
Introduced user feedback capability for DSIs (b)(11)
Implemented “service base URLs” in compliance with (g)(10)
Aidbox Forms
Implemented basic conversion of paper and fillable PDF forms to digital forms
Added QuestionnareResponce and extraction outcomes validation in the UI Builder console
Supported default value population in the UI Builder
Optimized performance for handling large forms
August 2024 2408
2408
Aidbox
Introduced dynamic Topic-based subscriptions and supported Kafka (OSS and AWS) as delivery channels
Added an option to connect a self-hosted Aidbox instance to the ViewDefinition builder
Enhanced SQL on FHIR spec coverage
Supported Audit logging using external identity providers
UI builder updates (FHIR Questionnaire-based):
Provided delete, copy form on the Form template grid
Supported cqf-expression to provide prefilling the value in the display field
Add support for user-defined codemaps
July 2024 2407
2407
Aidbox
Introduced support for custom resources using FHIR StructureDefinitions and custom resources using FHIR schemas
Published JavaScript app example demonstrating custom resources with a typical notification flow: requesting a notification, locking it for sending, and sending it (placeholder)
UI builder updates (FHIR Questionnaire-based):
Performance optimization for large forms
Implemented Audit logging
Introduced the ability to override existing conversion rules using the DSL
Supported DICOM section
Improved performance
May 2024 2405
2405
Aidbox development licenses are now available to all users, empowering everyone to explore, develop, and innovate with our comprehensive FHIR-first healthcare platform.
Simplified Aidbox Launch: We've developed a simplified way to launch Aidbox, making it easier than ever to get started.
AidboxID Login: Users can now log in to Aidbox using AidboxID to streamline and secure access.
FHIR schema validation engine (beta). This validation engine is set to replace the existing Zen Schema and JSON Schema validation engines.
Supported multiple sources to load IGs to Aidbox:
Supported multiple interfaces to load IGs to Aidbox:
Aidbox UI (at runtime)
FHIR API (at runtime)
UploadFIG tool (at runtime)
New Aidbox UI (Settings -> New UI):
Enhanced navigation with a double sidebar for improved access to features and resources.
Resource browser
FHIR IG package introspection
Settings (read-only)
DevOps:
Published Helm charts to simplify the process of deploying and managing Aidbox in K8s
UI builder updates (FHIR Questionnaire-based):
Ability to create custom components and reuse them in other forms
Added open choice widget
Improved UI Builder user experience via preview form button, quick search for a field on the form or in the outline, etc
Ability to enable the outline in form preview for form navigation
Ability to show or hide option's scores on the form
Supported Multitenancy in Aidbox Forms
March 2024 2403
2403
SQL on FHIR engine
Enhanced SQL on FHIR® (v2.0) spec test coverage. The SQL on FHIR coverage report is available here.
Validation
Released FHIR schema validation engine (alpha). This validation engine is set to replace the existing Zen Schema and JSON Schema validation engines.
Launched FHIR IGs Repository (alpha). Aidbox now lets you introspect and load FHIR IGs directly from a mirrored version of packages2.fhir.org into your Aidbox instance, either through the UI or configuration files
UI builder updates (FHIR Questionnaire-based):
Ability to change the widget type
Supported markdown renderer for tooltip and label
Expanded enablewhen expression templates
Improve adding widget process - widget can be added in any point of outline
Ability to create the form themes in the UI builder
Ability to add multiple signatures to the form
Added radio button widget with layout orientation
Ability to place multiple widgets on one line
Ability to add placeholder for widget
Improved UI Builder dev experience via warnings and tips
Support of FHIR formatted Bundle
Enhanced references resolving mechanism for
make-doc
andprepare-doc
endpointsMapping fixes, bug fixes
February 2024 2402,LTS
2402,LTS
Security and Access Control
Released beta version of Label-based Access Control to control access to data based on the classification of the data (privacy, sensitivity, etc) and the attributes of the requester.
Data API
Supported FHIR-conformant
_include
and_revinclude
parametersAdded parameter to set the maximum number of import retries for /v2/$import
Questionnaire-based forms updates:
Ability to add help text
Ability to add image for a question
Selecting a code for an item from terminologies
Selecting code for answerOption from terminologies
Ability to create multi-page forms
Ability to amend form using a shared link
Supported attachment item
Ability to add regex validation
Support built-in rule based deduplication
Mapping fixes, bug fixes
Minor UI enhancements
Fixed issues submitted by Aidbox users
January 2024 2401
2401
Data API
Supported ViewDefinition resource structure according to the latest SQL on FHIR specification. These changes don’t affect existing views. Please check this guide to update ViewDefinitions
SDK
Added basic FHIR Profiles support to Python SDK
Security and access control
Added Access policy matcho engine $one-of operator to fetch the list of the available values from the request context
Supported history endpoint within the Organisation-based access control
Documented GitHub as an external identity provider
Published guide on how to use self-signed SSL certificates when deploying Aidbox
Fixed the code_verifier to behave according to the RFC
Fixed minor issue in Multibox that led to many “do nothing” messages in the logs
Improved the C-CDA to FHIR conversion performance by 20%
Administered Medications mapping to/from MedicationAdministration FHIR resource
DevOps
Documented 'How to make Aidbox Docker image work with self-signed SSL certificates'
Released AidboxDB 16.1. Updated the list of the extensions for Postgres. Documented the migration steps from the previous PG versions
Removed apk-tools from our Docker images
Questionnaire-based forms updates:
Form Builder
Added required constraints
Added hidden rules & enable-when conditions
Added scores for questions with coding
Added support for loading Questionnaire from file/text
Added tips for FHIRPath usage
Completed themes support
API
Added Configuration to disable FHIR SDC operations
Extended $populate operation to support Questionnaire root properties
Added operation to generating signed links for form filling
Added $populatelink FHIR SDC operation
Aidbox DSL-based forms updates
Fixed issues with concurrent save/submit UI operations
Fixed conversion of QuestionnaireResponse with included scores
November 2023 2311
2311
Data API
Integrations
Optimized Activity Scheduler Service for Workflow Engine
Added Python templates for HL7 v2 ADT, ORU, ORM to FHIR transformation
Improved performance
Added narrative generation for several sections (see all sections here)
Security and access control
Added group widget in the UI Builder
Added calculate expressions with FHIRPath/AidboxLisp
Added FHIRPath support for enable-when expressions
Add views for Questionnaire and QuestionnaireResponse in the UI Builder
Enabled saving a Form as Questionnaire
Integrated Questionnaire/QuestionnaireResponse in current list of Aidbox Forms
Added $validate-response FHIR operation
Added $process-response FHIR SDC operation
October 2023 2310
2310
New FHIR Schema Validator for Aidbox (Early Alpha)
Terminology
Supported RxNorm terminology load to Aidbox
Data API
Added an environment variable to synchronize managed index when Aidbox starts
Integrations
Added Workflow Engine Connector for FHIR Topic-based subscriptions
Added Workflow Engine clean-up built-in task
Added Workflow Engine run-sql built-in task
Changed logic how section templateId is being selected (resolve “entries required”/”entries optional” ambiguity)
Minor mapping fixes (immunizations, document header)
Added an option to have more than one request per section in Document Definition
Added an option to use Observations with text values for section narratives
Security and access control
Supported Patient API
DevOps
Supported sending traces via OpenTelemetry
Supported Azure Block in $export operation
Improved UI-builder:
Supported enableWhen expressions (exclusive for Aidbox lisp)
Added constraints and validation for datetime, date, time, number fields
Added an option to import UI-built forms to a library
Added preview for Questionnaire and QuestionnaireResponse in UI-builder
Aidbox UI
Introduced new database console sidebar
September 2023 2309
2309
New FHIR Validator public demo stand
SDK
Launched Open Source Telehealth application with end-to-end flow with 3 user roles [Provider, Patient, Admin]
Topic-Based Subscriptions module
Supported the GCP Pub/Sub integration
Added restart on replication channel failure
Added ability to check topic status with Aidbox Console UI
Developed Aidbox monitoring stack integration
Supported Subscription
end
propertyAdded new sample configuration with the Aidbox Project Template
Data API
Delete all matching resources using conditional delete
Ops
Security and access control
Added Audit Log UI on Aidbox Console
Added autocomplete for literals and keywords
Configured Questionnaire converter to accept FHIR Bundle
Added new form template SDOH PRAPARE to Form Library
Released new UI-builder pre-alpha version
August 2023 2308
2308
SQL on FHIR engine early access
Data API
Added _filter for chained search
Optimized GraphQL for revincludes
Added X-max-transaction-level for CRUD
Integrations
Supported FHIR R4B and R5 Topic-based subscriptions
Security and access control
Added Capability Statement endpoint for multitenant API
Added bundle transaction for multitenant API
Added stdout appender for logs in Google format
Added access policy usage in UI console on AccessPolicy page
Added a neat UI to rotate credentials and download certificates on IdentityProvider view page
Supported BALP for CRUD + Search operations. Both basic and patient profiles
Issue 2306-lts
Aidbox user portal
Added the ability to specify a custom configuration project when creating a GCP Aidbox
Aidbox.app UI
Updated the sidebar in the Aidbox UI
DevOps
Add metrics for Aidbox logs. Count of logs per log level
Implemented PG database backup verification tool, improved Grafana dashboards to show backup verification statuses
Added basic Forms Accessibility (Screen Readers, Keyboard Navigation)
Improved mobile devices adaptation (form takes all visual space, buttons aligned in specific positions)
Improved UX of developer tools (inline errors, autocomplete, code folding, bracket matching)
July 2023 2307
2307
Data API
Added multilingual search with _search-language parameter
Added an option to translate concepts with $translate-concepts endpoint
Added _source search parameter
Supported C-CDA to work as a standalone service
Added an option to inspect intermediate conversion tree
Security and access control
Added shared resources in the Organisation-based access control
Supported Azure AD asymmetric authentication
Added security dashboard in the Aidbox UI
Added a form to create an IdentityProvider resource
Supported SCIM v2 User API
Added aidbox.rest.v1/gateway operation pass auth information (user, client, session) to backend service
Aidbox Forms
Supported an option to include question scores in QuestionnaireResponse in the converter
Minor fixes: UI became more stable while loading
June 2023 2306,LTS
2306,LTS
Data API
Added Location.near search parameter
Added index synchronization via the Workflow and Task API
Added _timeout for _include and _revinclude
Supported OperationOutcome for invalid accept format errors
Fixed behavior of the :exact modifier
Fixed jsonpath sort order
Supported modifying and creating new mappings using the Aidbox Configuration Project
Security and access control
Added hierarchical organization-based access control (multi-tenancy on organization-level resources)
Added How to enable hierarchical access control tutorial
Ops
Released new PostgreSQL Aidboxdb images 15.3, 14.8, 13.11
Added PostGis Extension
Enabled the /health endpoint metrics and logs by default
Added How to disable logging tutorial
Aidbox Forms
Optimized Forms for mobile devices
SDK
Released TypeScript SDK module for Workflow Engine
Added a sample project that demonstrates the following flow: remind a patient about upcoming appointment on a specific date, collect information about the patient’s condition with Aidbox Form and store information as FHIR data
May 2023 2305
2305
Released Workflow Engine
Validation and Terminology
Added LOINC terminology
Added support for multiple translations of LOINC terminology
Added support for multiple translations of SNOMED CT terminology
Data API
Supported FHIR R5 chained search parameters
Added support for revinclude in GraphQL when reference from source does not specify type
Added new supported sections:
Functional Status, Health Concerns, Mental Status, Plan of Treatment, Payers, Family History, Nutrition, and Medical Equipment
Security and access control
Introduced AuditEvent viewer
Added integration with Aidbox Workflow Engine: add task to launch form
Added minor features:
support for lisp templates in finalize patch section
support for redirects when embedded as iframe
disable-back-button property to aidbox.sdc/pages widget
support for showing images in a row with another fields
Added minor fixes:
automatic layout generation for subforms
minor styling inconsistencies in UI
Added a quickstart guide demonstrating how to launch a PHR sample app on Aidbox
Added a PHR sample app
Added 3 example apps
April 2023 2304
2304
Validation and Terminology
Supported FHIR R5
Aidbox Notebooks
Added new preview feature: now, users can download their notebooks as HTML files, which can be viewed on any web browser, uploaded to an Aidbox instance, and used as regular noteboooks
Data API
Implemented chained search for parameters defined by Search resource
BREAKING: searchset bundle doesn’t support versionId anymore. Aidbox fills in 0 instead. This field may be removed in the near future. ETag functionality for Search API is removed. ETag functionality for GET/PUT/POST/DELETE operations is not affected.
Integrations
Added new API constructor engine to define custom endpoints and convert arbitrary data into FHIR
C-CDA / FHIR converter
Enhanced /ccda/validate endpoint to behave exactly as HealthIT.gov CDA validator
Security and access control
Supported log filtering via different appenders
Added Authentication with AD FS tutorial
Aidbox user portal
Added option to specify FHIR R5 configuration project
Aidbox Forms
Added new field type for storing attachments
Supported cloud storages: AidboxDB, GCP Storage, AWS S3
Added support for using attachment as a source in media-viewer widget
Optimized layout rules performance
Added minor layout adaptations for small screens
Fixed minor bugs and issues
March 2023 2303
2303
Validation and Terminology
Supported FHIR R4B
Data API
Added $to-format operation without getting transformation metadata
Fixed polymorphic reference targets for FHIR resources
Fixed Bundle conformance for AidboxQuery
Fixed sorting by token when using jsonknife engine
Added a header to lower transaction isolation level
Integrations
Improved $import operation, that allows for more reliable and efficient processing of multiple import requests through the Task API
Released the new version of HL7 v2 parser and mapping engine
C-CDA to FHIR converter
Released FHIR to C-CDA bidirectional converter (beta). Supported sections:
Allergies, Encounters, Immunizations, Problems, Vital Signs, Results, Social History, Procedures, Medications
Security and Access control
Developed access policy dev tool
Added tutorials and guides:
How to implement the ReBAC authorization model in Aidbox within AccessPolicy
Aidbox user portal
Added FHIR R4B zenFHIR package to configuration options
Aidbox Forms
Added an option to select valueset dynamically in the choice field
Showed form rules in human-friendly format:
Added ability to store form properties in DB
Added support for static images
Added wizard like layout
Added support for form help message
February 2023 2302, LTS
2302, LTS
Validation and Terminology
Reduced zen FHIR IGs size
Introduced New FTR extraction engine: creating new ValueSets based on existing FTRs
Data API
Implemented JSONPath Sort (previously there was fallback to jsonknife)
Implemented #>> operation to optimize some query types (enabled via env)
Improved _explain to show SQL even if the query failed with an error
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
Supported Aidbox on path
Improved
__debug=policy
Ops
Devbox images are no longer supported. Please use AidboxOne image with development license
Supported box_web_* configs for Multibox
Introduced Aidbox status page
Aidbox Forms
Added new forms templates, incl. Lifestyle, Medications, Problem List to forms library
Improved Forms UX
Supported tooltip for forms and input fields
Supported Markdown for labels and tooltips
Added Forms styling/branding: logo, button texts, colors, fonts
Added 3 predefined themes (monochrome/HealthSamurai/NHS)
Added customizable redirect-button to Forms
January 2023 2301
2301
Terminology
Added ICD-10 FTR integration
Data API
Zen Index API is now considered stable
Implemented automatic loading of search parameters on extensions from IG
C-CDA to FHIR converter
Added configuration for /ccda/to-fhir endpoint
Added configuration for /ccda/persist endpoint
Added tenant support for /ccda/persist endpoint
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
Introduced Telemetry API for errors and usage stats.
Aidbox Forms
Added new forms templates to forms library
Added metadata properties to forms
Added
redirect-on-sign
parameter
December 2022 2212
2212
MDM (Master Data Management)
Added $match operation
Python API for Aidbox MDM module
Archive/Restore API
Task API allowing to define asynchronous operation called tasks.
Archive/Restore API allowing to archive and restore resources to/from S3 bucket powered by Task API.
Scheduler API allowing to execute tasks by schedule.
Aidbox Configuration Projects
Added a FHIR 4.0.1 compliant Configuration Project (also available on Aidbox User Portal).
Added a guide on passing Touchstone FHIR 4.0.1 basic server test suite on Aidbox User Portal.
Data API
Implemented jsonpath search engine
GraphQL: added warmup cache on startup option
Terminology API
Aidbox Forms
Simplified DSL (brief definition, less layers to describe for basic behavior)
Added layout autogeneration
Added API for generate layers (layout, finalize, finalize-constraints)
C-CDA to FHIR converter
Added a guide on how to persist FHIR resources to a DB after C-CDA to FHIR transformation.
Improved Observation data mapping.
November 2022 2211
2211
Aidbox deployment and maintenance
Released index suggestion API and updated documentation on index management
Updated documentation on highly available Aidbox
Updated documentation on production-ready deployment to Kubernetes
Smartbox
Improved admin UI with configuration of EHR-level logo, email provider and bulk export
Added documentation on deployment to Kubernetes
Added guides on passing Inferno tests and Inferno Visual Inspection and Attestation
Aidbox Configuration Projects
Improved startup time for Aidbox instances configured with zen FHIR IGs
Improved local development workflow
Improved Aidbox support of US Core IG artifacts
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
Confirmed USCDI v1 compliance
Aidbox Forms
Added forms as a configuration project to the Aidbox User Portal
Introduced the form repository with the commonly used templates, such as PHQ-9, vital signs and GAD-7
Published tutorials on how to create and manage forms in Aidbox Forms
Supported tls for SMTP provider
October 2022 2210
2210
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