Supported Endpoints & Parameters

This topic is for the single-tenant environment (STE) version of Bulk Data Export. If your implementation is a multi-tenant environment (MTE), see the topics in Bulk Data Export (Multi Tenant).

You can use the following endpoints and search parameters for the 1up Bulk Data Export process.

Supported Endpoints

1up Bulk Data Export includes the following endpoints, each for a different portion of the Bulk Data Export process.

Endpoint

Description

URL

Export

Create the export job and start the export process.

Provides the URL for the Status endpoint.

User ID or client ID:
https://analytics.{baseURL}/bulk-data/r4/$export

Group:
https://analytics.{baseURL}/bulk-data/r4/Group/:groupId/$export

Status

Get the status of the Export operation using the job ID.

Provides the list of exported files.

User ID, client ID, or group:
https://analytics.{baseURL}/bulk-data/r4/$export/job/XXXXX

Download File

Download the exported files. 

https://analytics.{baseURL}/bulk-data/r4/$export/file/xxxxx.ndjson

Search Parameters

You can apply the following search parameters to your request to filter the results by resource type or date.

Parameter

Description

Format

_type

Specify the types of resources to include in the response.

For group-level exports, _type applies only to the Patient and applicable Patient Compartment resources.

Example — _type=Encounter returns only Encounter resources

User ID or client ID:
analytics.{baseURL}/bulk-data/r4/$export?_type=Encounter

User ID example:
analytics.1up.health/bulk-data/r4/$export?_type=Encounter

Group:
analytics.{baseURL}/bulk-data/r4/Group/{id}/$export?_type=Encounter

Group example:
analytics.1up.health/bulk-data/r4/Group/12345/$export?_type=Encounter

_since

Resources are included in the response if their state has changed after the specified date.

Example — Resource.meta.lastUpdated is later than the specified _since value

You can also specify the date and time values for the _since parameter in ISO format.

Example — _since=2023-10-17T18:48:35.81Z

analytics.{baseURL}/bulk-data/r4/Group/{id}/$export?_since=YYYY-MM-DD

Example:
analytics.1up.health/bulk-data/r4/Group/12345/$export?_since=2021-01-01