Skip to main content

Bulk Data Export API (v1)

info

Newer APIs for Providers and Payers are now available which supports the latest ONC/ASTP requirements including Bulk Data Export version 2.0.0.

Overview​

The Netsmart US Core Bulk Data Export API v1 supports backend access to export patient data in bulk. This API enables authorized applications to request and download large datasets of FHIR resources for multiple patients.

Key Use Cases:

  • Population health analytics and reporting
  • Data migration and backup operations
  • Research and quality improvement initiatives
  • Regulatory reporting requirements

Important Note: This API requires proper authentication and authorization. Always retrieve the CapabilityStatement first to understand supported resources and operations.

Base URL​

https://fhir.netsmartcloud.com/uscore/v1/bulk-data

Specification​

The diagram below provides a high-level overview of the Bulk Data Export sequence per the specification.

Source: Bulk Data Access IG 2.0.0

Getting Started​

Step 1: Retrieve CapabilityStatement

Always start by retrieving the CapabilityStatement to understand current API capabilities:

curl -X GET https://fhir.netsmartcloud.com/uscore/v1/bulk-data/metadata \
    -H "Accept: application/fhir+json"

Supported Resources​

The following resources are supported based on the CapabilityStatement. Always verify current capabilities by retrieving the CapabilityStatement before implementation.

ResourceReadSearchCreateUpdateExtended Operations
Binary✅$binary-access-read
CapabilityStatement✅
Group✅$export

Extended Operations​

  • $export-poll-status - Server-level operation to check export status and manage export requests
  • $export - Group-level operation to initiate bulk data export
  • $binary-access-read - Binary-level operation to download exported files

For detailed operation documentation, see Extended Operations.

Error Handling​

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