Overview

Data Management

Aidbox provides robust APIs for managing FHIR and custom resources, including creation, validation, history tracking, and bulk operations.

• CRUD

  Create, read, update, and delete FHIR and custom resources using standard RESTful endpoints.

• Validation

  Validate FHIR resources against profiles and constraints before storing or processing them.

• History

  Access the full change history of resources, supporting audit and rollback scenarios.

• Bundle

  Process multiple operations in a single HTTP request using FHIR Bundles for transactional or batch processing.

• Bulk Import

  Import large datasets efficiently into Aidbox using optimized bulk endpoints.

  • $load

    Synchronous API for loading data into Aidbox in ndjson gz format from an external web service or bucket. Data is not validated during the import process.

  • $import

    Asynchronous API for loading data into Aidbox in ndjson gz format from an external web service or bucket. Data is not validated during the import process.

• Other APIs

  Additional endpoints for resource management and system operations.

  • Encryption API

    Encrypt and decrypt sensitive data using Aidbox's built-in encryption services.

  • Sequence API

    Generate unique, sequential values for resource identifiers or other use cases.

  • Batch Upsert

    Insert or update multiple resources in a single request, optimizing for bulk data operations.

Data Querying

Aidbox supports powerful querying capabilities, from standard FHIR search to advanced SQL and GraphQL endpoints.

• FHIR Search

  Query resources using the standard FHIR search API with support for filters, sorting, and pagination.

• Aidbox Search

  Use Aidbox-specific search extensions for advanced filtering and querying.

• SQL-on-FHIR

  Run SQL queries directly against FHIR data for advanced analytics and reporting.

• SQL APIs

  Access low-level SQL endpoints for custom queries and data extraction.

• GraphQL

  Query and manipulate FHIR resources using the flexible GraphQL API.

• $everything

  Retrieve all resources related to a patient or other entity using the $everything operation.

• Other APIs

  Additional endpoints for querying and retrieving data.

  • $document

    Generate and retrieve FHIR Documents for clinical summaries and other use cases.

  • $lastn

    Fetch the most recent N observations or other resources for a patient.

Data Feed And Export

Aidbox provides APIs for real-time data feeds, change tracking, and bulk export of data.

• Subscriptions

  Receive real-time notifications about resource changes using FHIR Subscriptions.

• Changes API

  Track and retrieve changes to resources over time for synchronization and auditing.

• Bulk Export

  Export large volumes of FHIR data for backup, migration, or analytics.

• Dump APIs

  A set of APIs that allow you to export FHIR Data as a stream of records in JSON or CSV format.

  • $dump

    Enables efficient retrieval and processing of a stream of FHIR resources of a specific type.

  • $dump-sql

    Streams the results of SQL query in FHIR format or CSV format.

  • $dump-csv

    Dumps the specific resource type to CSV

• Archive / Restore

  Archive resources for long-term storage and restore them when needed.

Other APIs

Utility and system endpoints for health checks, versioning, and data transformation.

• $to-format

  Transform resources into different formats using the $to-format operation.

• $matcho

  Endpoint for testing the Matcho engine, which is used in AccessPolicies.

• Health check

  Check the health and status of the Aidbox instance.

• Version

  Retrieve the current version and build information of Aidbox