Aidbox
Aidbox.Dev
Aidbox.Cloud
Aidbox.One
Fhirbase
Search…
Getting started
Getting Started
Installation & Configuration
Features
Licensing and Support
Versioning & Release Notes
FAQ
Aidbox configuration
Aidbox project
API constructor (beta)
Setup SMTP provider
Zen Configuration
API
FHIR API
REST API
CRUD
Aidbox version
Bulk API
Batch Upsert
Batch/Transaction
Cache
ETAG support
Reactive API
Sequence API
Encryption API
Compartments API
GraphQL API
RPC API
Aidbox UI
Profiling and validation
Profiling and validation overview
Profiling with zen-lang
Asynchronous resource validation
Profiling with AidboxProfile
Terminology
Aidbox terminology module overview
Import external (not-present) terminologies
Concept
CodeSystem
ValueSet
$translate on ConceptMap
Terminology Tutorials
FHIR Implementation Guides
🎓
HL7 FHIR Da Vinci PDex Plan Net IG
App development guides
Tutorials
Administration
Receive logs from your app
$matcho
$to-format
Security & Access Control
Overview
Authentication Flows
Access Control
Multitenancy
Storage
Archiving
Database
AWS S3
GCP Cloud Storage
Azure Blob Storage
Core Modules
Entities & Attributes
$json-schema
Monitoring
Logging & Audit
Modules
HL7 v2 Integration
FHIR Resources
Custom Resources
Aidbox Search
First-Class Extensions
Multibox
Multibox box manager API
Plan API
Plan API Overview
Patient Access API
Integrations
Analytics
Audit
Authentication
Tools
Mappings
Aidbox SDK
Contact us
Powered By
GitBook
REST API
This page describes types of Aidbox REST API operations in general
Aidbox provides two REST APIs - FHIR and Aidbox. The main difference is
a format of resources
. Base URL for FHIR API is
/fhir
and for Aidbox
/
Interaction type
​
Format
Instance Level Interactions
​
​
​
read
​
Read the current state of the resource
both
​
vread
​
Read the state of a specific version of the resource
both
​
update
​
Update an existing resource by its id (or create it if it is new)
both
​
patch
​
Update an existing resource by posting a set of changes to it
both
​
delete
​
Delete a resource
both
​
history
​
Retrieve the change history for a particular resource
both
Type Level Interactions
​
​
​
create
​
Create a new resource
both
​
search
​
Search the resource type based on some filter criteria
both
​
history
​
Retrieve the change history for a particular resource type
both
​
$dump
​
Dump all resources of specific type
Aidbox
​
$load
​
Load resources of specific type
both
Whole System Interactions
​
​
​
capabilities
​
Get a capability statement for the system
FHIR
​
batch/transaction
​
Update, create or delete a set of resources in a single interaction
both
​
batch upsert
​
Batch create or update interaction
Aidbox
​
$import
​
Bulk Import async operation
both
​
$load
​
Bulk load ndjson file with resources
both
Previous
Bundle
Next
CRUD
Last modified
1yr ago
Copy link