The Guide to Getting Started with Aidbox Server for FHIR

In this blog post, we have shared about the AidBox FHIR Server, its features, and a step-by-step guide to getting started with its Docker-based setup. So, if you are looking to get started with the Aidbox server for FHIR, this guide will help you.

What is the AidBox Server for FHIR?

Aidbox is a friendly FHIR server built by Health Samurai. This FHIR-powered platform helps build faster and more secure healthcare apps using FHIR. It is completely packed with technical creative modules such as FHIR storage, Restful FHIR APIs, Smart-on-FHIR, FHIR terminology server, and Auth Server.

• It uses PostgreSQL to store data in a way that’s easy to manage and retrieve.
• There’s a comprehensive API and ways to control who can access the data securely.

The platform offers everything you need to build, manage, and secure healthcare applications using FHIR data standards. It offers:

• Build your system around FHIR data standards.
• Organize data in a way that matches the needs of your healthcare app.
• You can query, join, and work with healthcare data easily in PostgreSQL.
• You can manage who accesses your data and track activities to meet healthcare data security requirements.

Key Features of AidBox FHIR Server

1. FHIR Storage

• Aidbox provides a robust FHIR-native PostgreSQL database.
• It is designed to store healthcare data in JSONB format.
• This ensures secure and efficient management of FHIR resources.
• With features like transactional operations, advanced reporting, and seamless migrations, Aidbox simplifies the complexities of healthcare data storage for organizations prioritizing interoperability and performance.

2. RESTful FHIR API

• Aidbox supports the HL7 FHIR REST API across all versions. 
• It enables smooth interactions with healthcare data.
• This comprehensive API set includes Bulk API for data import/export, SQL-on-FHIR for advanced queries, and validation APIs to ensure compliance.
• These capabilities empower developers to build scalable and interoperable FHIR-first applications.

3. SMART-on-FHIR

• Aidbox integrates SMART-on-FHIR, making developing a secure and scalable healthcare application development easier.
• Developers can leverage OAuth 2.0 and OpenID Connect protocols for authorization while extending functionality using custom resources.
• This will ensure seamless connectivity across applications and platforms.

4. FHIR Terminology Server

• Aidbox offers a powerful FHIR Terminology API that supports pre-built bundles like SNOMED, LOINC, and ICD-10.
• Custom CodeSystems and ValueSets are also supported for tailored implementations of FHIR.
• This feature enhances data consistency across all disparate healthcare systems and semantic interoperability.
• This makes it ideal for advanced healthcare applications requiring precise terminology management.

5. Logs & Monitoring

• Aidbox includes advanced monitoring tools to track system health and activity.
• Healthcare organizations can ensure transparency and compliance with e-PHI-related regulations using the pre-built logs.
• The platform’s robust logging capabilities allow real-time tracking, troubleshooting, and system performance optimization.

6. Auth Server with OAuth 2.0 OpenID Connect

• Aidbox’s built-in authorization server ensures secure access control with OAuth 2.0 and OpenID Connect.
• SMART App Launch and granular access policies (JSON Schema, SQL) further enhance security.
• User and client management capabilities streamline the handling of roles and permissions in complex healthcare environments.

7. Custom Resources/First-class extensions

• Aidbox allows you to create custom resources and first-class extensions for unique use cases.
• This flexibility enables organizations to adapt the platform to their specific workflows.
• Adapting the platform for specific workflow will help to address scenarios where standard FHIR resources might not suffice.
• These features ensure a scalable and tailored healthcare solution.

8. HIPAA Eligible Infrastructure

• Aidbox operates on a HIPAA-eligible infrastructure.
• This is to ensure the safeguarding of sensitive healthcare data.
• Features like Kubernetes-based deployment, automated backups, replicas, and advanced monitoring tools ensure high availability and security.
• This infrastructure supports AWS, GCP, Azure, and on-premises systems deployments.

Step-by-Step Guide to Getting Started with Aidbox FHIR Server Locally Using Docker

Before getting started with Aidbox FHIR Server, make sure you have installed Docker and Docker Compose on your system. These tools are essential for setting up and running Aidbox locally.

Step: 1 Create a Directory for Aidbox

The first step is to set up a directory for the Aidbox project. Open your terminal and run the following command:

mkdir aidbox && cd aidbox

This creates a directory named aidbox and moves you into it, preparing the workspace for the next steps.

Step: 2 Launch Aidbox with Docker

Run the following command to download the Aidbox setup script and launch it using Docker Compose:

curl -JO https://aidbox.app/runme && docker compose up

This script sets up and starts Aidbox by configuring and running a Docker container. Once completed, the Aidbox instance will be running locally on your system.

Step: 3 Access the Aidbox Interface

After launching Aidbox, you can access its user interface through your web browser. Navigate to:

http://localhost:8080/

This URL opens the Aidbox UI, allowing you to interact with the server and explore its features locally.

Step: 4 Activate Your Aidbox Instance

You must activate your Aidbox instance to unlock its features. There are two ways to do this:

• Using AidboxID: Provide your unique AidboxID within the Aidbox ecosystem to complete the activation.
• Using an Aidbox License:

1. Log in to the Aidbox user portal to obtain your license key.
2. Update the .env file in your configuration project with the key:

AIDBOX_LICENSE=YOUR_AIDBOX_LICENSE_KEY

Restart the Docker Compose process to apply the changes and activate your instance.

Step: 5 Configure Aidbox for Advanced Usage (Optional)

For customized configurations, clone the default Aidbox configuration project from GitHub:

git clone \
  --branch=main \
  --depth=1 \
  https://github.com/Aidbox/aidbox-project-template.git \
  aidbox-project && \
  cd aidbox-project && \
  rm -rf .git

This project provides a baseline structure that can be tailored to your requirements.

Add the license key to the .env file, and update other configurations to align with your specific needs. To apply the updated configuration, restart the Aidbox instance:

docker compose up --force-recreate

Step: 6 Explore Aidbox Features with Notebooks

Aidbox includes interactive Notebooks to help you understand its features. Access the Notebooks section within the Aidbox UI and open the Getting Started Notebooks. 

These pre-built tutorials allow you to:

• Run RESTful FHIR and SQL API queries interactively.
• Use built-in editors to execute requests and see results in real time.
• Learn the basics of Aidbox’s capabilities through practical steps.

Additionally, you can create custom Notebooks to suit your specific workflows. These are ideal for learning and experimenting with Aidbox features.