Skip to main content

Extended Operations

Overview​

The US Core Bulk Data Export API v1 provides extended operations to support the complete bulk data export workflow. These operations follow the FHIR Bulk Data Access IG specification.

Important: Always verify supported operations by retrieving the CapabilityStatement before implementation. Operation availability and parameters may vary.

Supported Operations​

Note: The following operations are typically supported. Always check the CapabilityStatement for current operation definitions and parameters.

1. Group Export Operation​

Operation: GET /Group/{id}/$export

Request bulk data export for all patients in a specified Group. This initiates the asynchronous export process.

2. Export Poll Status Operation​

Operation: GET /$export-poll-status

Check export status and retrieve file manifest when export is complete. Also supports canceling exports.

3. Binary Access Read Operation​

Operation: GET /Binary/{id}/$binary-access-read

Download exported files directly without FHIR Binary resource wrapper.

Complete Workflow​

# Step 1: Verify capabilities
GET /metadata

# Step 2: Initiate export
GET /Group/{id}/$export
# Returns: Content-Location header with status URL

# Step 3: Poll for completion
GET /$export-poll-status?_id={job-id}
# Returns: File manifest when complete

# Step 4: Download files
GET /Binary/{file-id}/$binary-access-read
# Returns: Raw file content

Error Handling​

For comprehensive error scenarios and troubleshooting guidance, see Common Errors.

Operation Categories​

Server-Level Operations​

  • $export-poll-status - Manages export job status and cancellation

Instance-Level Operations​

  • Group/$export - Initiates bulk data export for a Group
  • Binary/$binary-access-read - Downloads exported files