Aidbox User Docs Logo
Aidbox User Docs
Run Aidbox locallyRun Aidbox in SandboxTalk to usAsk community
Run Aidbox locallyRun Aidbox in SandboxTalk to usAsk community
CtrlK
CtrlK
Aidbox FHIR platform documentation
FeaturesArchitecture
Getting Started
Run Aidbox in SandboxRun Aidbox locallyUse Aidbox with TypeScriptRun Aidbox on AWSUpload Sample Data
Tutorials
CRUD, Search Tutorials
Delete dataSet up uniqueness in Resource
Search Tutorials
Custom SearchParameter tutorialCreate custom Aidbox Search resourceMultilingual search tutorialMigrate from Aidbox SearchParameter to FHIR SearchParameterChange sort order by locale collation
Bulk API Tutorials
Synthea by Bulk API$dump-sql tutorial
Security and Access Control Tutorials
Allow patients to see their own dataRestrict operations on resource typeRelationship-based access controlCreating user and set up full user accessRestricting Access to Patient DataCreate and test access control
RBAC
Flexible RBAC built-in to AidboxRBAC with JWT containing roleRBAC with ACL
Set-up token introspectionProhibit user to loginManaging Admin Access to the Aidbox UI Using Okta GroupsRun Multibox locallyHow to enable labels-based access controlHow to enable patient data access APIHow to enable SMART on FHIR on Patient Access APIHow to enable hierarchical access controlHow to configure FHIR Audit LogHow is an HTTP request processed in AidboxHow to configure SSO with another Aidbox instance to access Aidbox UIHow to configure SSO with Okta to access Aidbox UIHow to configure sign-in with Apple for access to the Aidbox UIHow to configure Azure AD SSO for access to the Aidbox UIHow to configure Microsoft AD FS for access to the Aidbox UIHow to configure Azure AD SSO with certificate authentication for access to the Aidbox UIHow to configure GitHub SSO for access to Aidbox UIHow to configure Keycloak for access for AidboxUIHow to implement consent-based access control using FHIR Search and Aidbox Access PolicyDebug Access ControlAccessPolicy best practicesHow to configure Basic Auth flowDeprecated Access policy dev toolHow to configure Authorization Code GrantHow to configure Client Credentials GrantHow to configure Implicit GrantHow to configure Token ExchangeHow to configure Resource Owner Grant flowConfiguring Two Factor Authentication in Aidbox Identity ProviderSSO with External OAuth Identity Provider
Terminology Tutorials
Load ICD-10 terminology into AidboxUploading IG terminology content to external FHIR terminology serverLocal Terminlogy
Validation Tutorials
ISiKCarin BBUS CoreDavinci PdexmCode
Integration Toolkit Tutorials
Postmark integration tutorialMailgun integration tutorial
Subscriptions Tutorials
Kafka AidboxTopicDestinationClickHouse AidboxTopicDestinationTutorial: Produce QuestionnaireResponse to Kafka topicGCP Pub/Sub AidboxTopicDestinationWebhook AidboxTopicDestinationAidboxTopicSubscription NATS tutorial
Artifact Registry Tutorials
How to create FHIR npm package
Define Extensions
Extensions using StructureDefinitionExtensions using FHIRSchema
Custom Resources
Custom resources using FHIR SchemaCustom resources using StructureDefinition
Migrate to FHIR Schema
Migrate custom resources defined with Entity and Attributes to FHIR SchemaMigrate custom resources defined with Zen to FHIR Schema
Upload FHIR Implementation Guide
Environment Variable
Aidbox UI
IG Package from Aidbox RegistryPublic URL to IG PackageLocal IG Package
Aidbox FHIR APIUploadFIG Tool
Other Tutorials
Run Aidbox with FHIR R6Migrate from Multibox to AidboxSDC with Custom ResourcesMigrate from legacy licence portal to Aidbox portalSet up Aidbox with PostmanHow to run Aidbox in GCP Cloud RunHow to run Aidbox using different Java
Overview
Licensing and Support
Aidbox User Portal
ProjectsLicensesMembers
Aidbox UI
Aidbox NotebooksREST ConsoleDatabase ConsoleAttrs StatsDB TablesDB Queries
VersioningRelease NotesFAQContact us
Configuration
Recommended environment variablesSettingsConfigure Aidbox and MultiboxInit Bundle
API
API Overview
REST API
CRUD
CreateReadUpdatePatchDelete
FHIR search
SearchParameterInclude and RevincludeChaining
Aidbox SearchBundleHistory$everything on Patient
Other
Aidbox and FHIR formatsCapability Statement$documentObservation/$lastn$validateSQL endpoints$matcho$to-formatAidbox versionHealth check
Bulk API
Configure Access Policies for Bulk API$dump$dump-sql$dump-csv$export$load and /fhir/$load$import and /fhir/$importAidbox.bulk data importBulk import from an S3 bucket
Batch/TransactionGraphQL API
Other APIs
Plan API
Provider Directory API
PractitionerPractitionerRoleOrganizationOrganizationAffiliation
Plan API Overview
Archive/Restore API
Create-archiveRestore-archivePrune-archived-dataDelete-archive
ETAG supportCacheChanges APIRPC APISequence APIEncryption APIBatch Upsert
Access Control
Overview
Identity Management
User ManagementApplication/Client Management
Authentication
Basic HTTP AuthenticationOAuth 2.0Token IntrospectorSSO with External Identity Provider
Authorization
Access Policies
SMART on FHIR
SMART Client Authorization
SMART App LaunchSMART backend services
SMART Client Authentication
SMART: Asymmetric (/"private key JWT") authenticationSMART: Symmetric (/"client secret") authentication
SMART: Scopes for Limiting AccessPass Inferno tests with AidboxExample: SMART app launch using Aidbox and KeycloakExample: SMART app launch using Smartbox and Keycloak
Scoped API
Organization-based hierarchical access controlCompartments APIPatient data access API
Label-based Access Control
Audit and Logging
Artifact Registry
Artifact Registry overviewStructureDefinitionSearchParameter CodeSystemValueSetConceptMap
Terminology Module
Terminology Overview
FHIR Terminology
Coded ValuesProfiles, Binding, and Validation
Aidbox Terminology Module
SetupHybrid ModeCapabilities
Database
Database overviewPostgreSQL RequirementsDatabase schemaPostgreSQL Extensions
AidboxDB
HA AidboxDB
Tutorials
Migrate to AidboxDB 16Working with pgAgent
Modules
Profiling and validation
FHIR Schema Validator
Supported FHIR Implementation Guides (IGs)Setup Aidbox with FHIR Schema validation engine
Skip validation of references in resource using request headerAsynchronous resource validation
Observability
Getting started
Run Aidbox with OpenTelemetry locallyHow to export telemetry to the OTEL collector
Logs
How-to guides
OpenTelemetry logsElastic Logs and Monitoring IntegrationDatadog log management integrationLoki log management integration
Tutorials
Log analysis and visualization tutorialExport logs to Datadog tutorialSet up logs with Aidbox project
Extending Aidbox Logs
Technical reference
Log appendersLog transformationsLog SchemaOTEL logs exporter parameters
Metrics
How-to guides
How to export metrics to the OTEL collectorUse Aidbox Metrics ServerSet-up Grafana integration
Technical reference
OpenTelemetry MetricsOTEL metrics exporter parameters
Traces
How to use tracingOTEL traces exporter parameters
Subscriptions
Aidbox Topic-Based SubscriptionsAidbox SubSubscriptions
Aidbox Forms
Getting startedAidbox Forms Interface
Aidbox UI Builder
UI Builder InterfaceAI Assistant
Form creation
Form SettingsWidgetsComponentsEntry ModeVersioningValidationNestingForm customisation in theme editorForm signature
How-to guides
How to: Populate forms with dataHow to extract data from formsHow to calculate form filling percentageHow to create a form with dynamical answers into questions
Multilingual formsFHIRPath Expressions with Visual EditorData ExtractionPopulation
Import QuestionnaireForm sharing
Printing forms
Template-based PDF generation
FHIR versionsOffline forms
Embedding
Request Interception
ConfigurationForms multitenancyBuilding reports using SQL on FHIRIntegration with external terminology serversExternal Form Renderer in Builder PreviewExternal FHIR servers as a data backendStore attachments in S3-like storages
Aidbox Code Editor (/Deprecated)
Form creationHow to create a dynamic formHow to create a form with calculated fieldsForm CustomisationVersioningForm sharingAidbox Form WorkflowChanging data after form signingFHIR Questionnaire to Aidbox forms and back conversion
Any familiar form editor (docs deprecated)Access control in formsAudit logging in formsAidbox Form Gallery
SQL on FHIR
$run operation$materialize operationDefining flat views with view definitionsMigrate to the spec-compliant ViewDefinition formatQuery data from flat viewsReference
Integration Toolkit
C-CDA / FHIR Converter
List of Supported Templates
Admission Diagnosis Section (/V3)Advance directives section (/entries optional) (/V3)Advance directives section (/entries required) (/V3)Allergies and intolerances section (/entries optional) (/V3)Allergies and intolerances section (/entries required) (/V3)Assessment SectionChief Complaint SectionChief Complaint and Reason for Visit SectionComplications Section (/V3)Course of Care SectionDICOM Object Catalog Section - DCM 121181Default Section RulesDischarge Diagnosis Section (/V3)Document HeaderEncounters section (/entries optional) (/V3)Encounters section (/entries required) (/V3)Family History Section (/V3)Functional Status Section (/V2)General Status SectionGoals SectionHealth Concerns Section (/V2)History of Present Illness SectionHospital Consultations SectionHospital Course SectionHospital Discharge Instructions SectionHospital Discharge Physical SectionHospital Discharge Studies Summary SectionImmunizations section (/entries optional) (/V3)Immunizations section (/entries required) (/V3)Medical (/General) History SectionMedical Equipment Section (/V2)Medications Administered Section (/V2)Medications section (/entries optional) (/V2)Medications section (/entries required) (/V2)Mental Status Section (/V2)NotesNutrition SectionObjective SectionOperative Note Fluids SectionOperative Note Surgical Procedure SectionPast Medical History (/V3)Payers Section (/V3)Plan of Treatment Section (/V2)Postprocedure Diagnosis Section (/V3)Preoperative Diagnosis Section (/V3)Problem section (/entries optional) (/V3)Problem section (/entries required) (/V3)Procedure Description SectionProcedure Disposition SectionProcedure Estimated Blood Loss SectionProcedure Implants SectionProcedure Specimens Taken SectionProcedures section (/entries optional) (/V2)Procedures section (/entries required) (/V2)Reason for Visit SectionResults section (/entries optional) (/V3)Results section (/entries required) (/V3)Review of Systems SectionSocial History Section (/V3)Vital signs section (/entries optional) (/V3)Vital signs section (/entries required) (/V3)
How to deploy the serviceProducing C-CDA documentsHow to customize conversion rules
HL7 v2 integration
HL7 v2 integration with Aidbox projectMappings with lisp/mapping
X12 message converter
Analytics
Power BI
Mappings
Email providers integration
Setup SMTP provider
SMARTbox | FHIR API for EHRs
Get started
Set up Smartbox locallyDeploy Smartbox with Kubernetes
(/G)(/10) Standardized API for patient and population services
The B11 decision support interventions
Source attributesFeedback Sections
How-to Guides
Pass Inferno Tests with SmartboxPerform EHR LaunchPass Inferno Visual Inspection and AttestationRevoke Granted AccessSet up EHR-level CustomizationCheck email templatesSetup email providerRegister UsersSet up SSO with Auth0Publish Terms of Use Link Onto the Documentation PageFind Out What Resources Were Exported During the $export OperationFind Documentation Endpoint
Background Information
Considerations for Testing with Inferno ONCAdding Clients for Inferno TestsMultitenancy ApproachWhat Is TenantEmail Templating
ePrescription
Getting StartedAuthentication with mTLSPharmacies Synchronization
Prescribing
NewRx MessageCancelRx MessageRxRenewal MessageHow to test Callback
Directory
DirectoryDownload MessageGetProviderLocation MessageAddProviderLocation MessageUpdateProviderLocation MessageDisableProviderLocation Message
Medications
FDB
References
Environment VariablesList of Metrics
Frequently Asked Questions
Other Modules
MPI — Master Patient Index
Get started
Deploy MPI with KubernetesConfigure MPI module
Find duplicates: $matchMerging and Unmerging Records: $merge and $unmergeMatching Model ExplanationMathematical Details
MCPAidboxTrigger
HL7v2
Getting StartedFHIR ResourcesDefault MappingsModule LimitationsMessage Lifecycle
File storage
AWS S3GCP Cloud StorageAzure Blob StorageOracle Cloud Storage
Deployment and maintenance
Deploy Aidbox
Run Aidbox on Kubernetes
Deploy Production-ready Aidbox to KubernetesDeploy Aidbox with Helm ChartsHighly Available AidboxSelf-signed SSL Certificates
Run Aidbox on managed PostgreSQLHow to inject env variables into Init Bundle
Backup and Restore
Crunchy Operator (/pgbackrest)pg\_dumppg\_basebackupWAL-G
Indexes
Get Suggested IndexesCreate Indexes Manually
Developer experience
Developer experience overviewAppsUse Aidbox with React
Aidbox SDK
Aidbox JavaScript SDKNodeJs SDKPython SDK
Examples
Reference
Settings Reference
GeneralFHIRSecurity and Access ControlModulesDatabaseWeb ServerObservabilityZen Project
System Resources Reference
IAM Module ResourcesSDC Module ResourcesBase Module ResourcesBulk Module ResourcesAWF Module ResourcesCloud Module ResourcesHL7v2 Module ResourcesSQL on FHIR Module Resources
Environment Variables
Aidbox Required Environment VariablesOptional Environment VariablesAidboxDB Environment Variables
FHIR Schema Reference
Email Providers Reference
Notification Resource ReferenceMailgun Environment VariablesPostmark Environment Variables
Aidbox Forms Reference
FHIR SDC APIAidbox SDC APIGenerating Questionnaire from PDF API
Aidbox SQL FunctionsMatcho DSL Reference
Deprecated
Deprecated
Zen-related
RPC Reference
Aidbox
Mdm
aidbox.mdm/update-mdm-tablesaidbox.mdm/match
FTR
Aidbox Configuration Project
Run Aidbox Locally Using Aidbox Configuraiton ProjectAidbox Configuration Project StructureSet up and Use Configuration ProjectsEnable IGsRepositorySeed ImportManage Indexes in Zen ProjectSeed v2Migrate to Git Aidbox Configuration Projects
Aidbox Configuration Project Reference
Zen ConfigurationAidbox Project RPC Referenceaidbox.config/config
Custom Resources Using Aidbox ProjectFirst-Class Extensions Using ZenZen Indexes
US Core IG
US Core IG Support Reference
Workflow Engine
Task
Aidbox Built-in TasksTask Executor APITask User API
Workflow
Workflow User API
ServicesMonitoring
FHIR Conformance Deprecated Guides
Touchstone FHIR 4.0.1 Basic ServerTouchstone FHIR USCore ClinData
How to Enable US Core IG
Start Aidbox Locally with US Core IG EnabledAdd US Core IG to a Running Aidbox Instance
HL7 FHIR Da Vinci PDex Plan Net IG
Terminology Deprecated Tutorials
Inferno Test-Suite US Core 3.1.1
API Constructor (/Beta)
Zen-Lang Validator
Write a Custom Zen ProfileLoad Zen Profiles into Aidbox
FHIR Topic-Based Subscriptions
Set up SubscriptionTopicTutorial: Subscribe to Topic (/R4B)
R4B API Reference
SubscriptionTopic APISubscription API
FHIR Terminology Repository
FTR Specification
Create an FTR Instance
FTR from CSVFTR from FHIR IGFTR from FTR — Direct DependencyFTR from FTR — Supplement
FTR ManifestLoad SNOMED CT into AidboxLoad LOINC into AidboxLoad ICD-10-CM into AidboxLoad RxNorm into AidboxLoad US VSAC Package to AidboxImport via FTR
Zen Search ParametersAccess Control Lists (/ACL)
Entity / Attribute
Entities and AttributesFirst-Class Extensions Using AttributeCustom Resources Using EntityWorking with ExtensionsAidbox Search Parameters
Forms
Layout DSL (docs deprecased)Document DSL (docs deprecased)Launch DSL (docs deprecased)Lisp (Deprecated)FinalizeConstraints DSL (Deprecated)Finalize DSL (docs deprecased)Form DSL (docs deprecased)Lisp API (docs deprecased)Form API (docs deprecased)Workflow API (docs deprecased)Addendum API (docs deprecased)
Other
Custom SearchSearchQuerySubscribe to New Patient Resource
App Development Deprecated Tutorials
Receive Logs from Your App
X-Audit Header
Patient Encounter Notification Application
Other Deprecated Tutorials
Resource Generation with Map-to-FHIR-Bundle-Task and Subscription TriggersAPM AidboxAutomatically Archive AuditEvent Resources in GCP Storage GuideHL7 v2 Pipeline with Patient MappingHow to Migrate to Apline LinuxHow to Migrate Transaction Id to BigintHow to Fix Broken DatesConfigure Multi-Tenancy
AidboxProfileGCP Pub/Sub
SMART (/Deprecated)
SMART on FHIR
SMART on FHIRSet up SMART on FHIR in AidboxGet a SMART App Launched
SMART on FHIR
Aidbox Terminology Module (deprecated page)
Concept (deprecated)
$translate-concepts (deprecated)Handling hierarchies using ancestors (deprecated)
ValueSet (deprecated)
ValueSet Expansion (deprecated)ValueSet Code Validation (deprecated)Create a ValueSet (deprecated page)
CodeSystem (deprecated)
CodeSystem Concept Lookup (deprecated)CodeSystem subsumption testing (deprecated)CodeSystem Code Composition (deprecated)
Import External Terminologies (deprecated)
Import flat file (/CSV) (deprecated)$import operation (deprecated)Ready-to-use terminologies (deprecated)
$translate on ConceptMap (deprecated)
  1. reference

Email Providers Reference

Mailgun Environment Variables
Postmark Environment Variables
Notification Resource Reference
PreviousAidboxDB Environment Variables
NextNotification Resource Reference

Last updated 2025-08-05T16:21:53Z