How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SMART Health IT Bulk Data API

FHIR Bulk Data $export operations on the reference Bulk Data server.

SMART Health IT Bulk Data API is one of 6 APIs that SMART Health IT publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Bulk Data. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 3 base URLs: https://r4.smarthealthit.org, https://launch.smarthealthit.org/v/r4/fhir, https://bulk-data.smarthealthit.org/fhir.

3 operations 3 paths 1 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://r4.smarthealthit.org
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

SMART Health IT Bulk Data API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (smartOnFhir) using the authorizationCode and clientCredentials flows, exposing 6 scopes. By default, every request must be authenticated, though some operations may also be called without credentials.

  • smartOnFhir — HL7 SMART App Launch OAuth 2.0 profile, used by the launcher's protected FHIR proxy. The open r4.smarthealthit.org sandbox requires no authentication; the Bulk…

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Bulk Data 3

FHIR Bulk Data $export operations on the reference Bulk Data server.

GET
/$export
Start a system-level bulk export (Bulk Data server only)
bulkSystemExport 3 params → 202401
GET
/Patient/$export
Start a patient-level bulk export (Bulk Data server only)
bulkPatientExport 3 params → 202401
GET
/Group/{id}/$export
Start a group-level bulk export (Bulk Data server only)
bulkGroupExport 4 params → 202401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is OperationOutcome (2 properties). Each schema is shown below with its type and property counts.

OperationOutcome
object
A FHIR OperationOutcome describing an error.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

smarthealthit-bulk-data-api-openapi.yml Raw ↑

Other APIs SMART Health IT publishes across the network.

SMART Health Cards Framework
SMART Health IT Clinical Records API
SMART Health IT Conformance API
SMART Health IT Patients API
SMART Health IT SMART App Launch API
Where this information came from

This is an independent, third-party profile of SMART Health IT Bulk Data API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.