API Reference

Execute FHIR Bundle Operation

post
https://{instanceUrl}/fhir-provider//fhir

Executes a FHIR Bundle transaction or batch operation on the specified provider. This allows multiple FHIR resources to be processed in a single request.

The request body should contain a valid FHIR Bundle resource with transaction or batch type.

The request is proxied to the configured FHIR server with appropriate authentication headers.

Path Params
string
required

The ID of the FHIR provider to use. Can be either:

  • A UUID representing the provider ID
  • A provider name (legacy support - will just use the most recently updated provider with this name)
Body Params

FHIR Bundle for transaction or batch processing

string
enum
required

Always "Bundle" for bundle resources

Allowed:
integer
≥ 0

Total number of resources that match the search criteria. Optional field as not all FHIR servers include it (e.g., Medplum).

entry
array of objects
required

Array of bundle entries containing resources or operation results

entry*
Headers
string

Optional header for on-behalf-of authentication. Used when making requests on behalf of another user or entity. Must be in the format: Patient/{uuid} or Practitioner/{uuid}

string

Optional header for FHIR provider authentication. Contains credentials in the format {fhir_provider_id}:{oauth2_token}. Multiple FHIR provider integrations can be provided as comma-separated values.

Responses

Updated 4 months ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago