Export Bulk Data for the Group

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

After you create your group resources, you can export the bulk data for the members of the group. To export the data, you request a list of files that you can use to retrieve the data. You can then call the endpoint for each file to download the data for the group. You can also apply search parameters to your request to specify the start date for the data and the type of resources to include in the response.

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.

_type applies only to the Patient and applicable Patient Compartment resources.

Example: _type=Encounter returns only Encounter resources

analytics.<baseUrl>/bulk-data/r4/Group/<ID>/$export?_type=Encounter

Example:
analytics.1up.health/bulk-data/r4/Group/<ID>/$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

analytics.1up.health/bulk-data/r4/Group/<ID>/$export?_since=YYYY-MM-DD

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

Get the Download Files List

You can use the Client Header endpoint request to get the list of download files to use to retrieve the bulk export data using the FHIR $export operator. You can then use the download files to get the group bulk data from the export endpoint.

You must use the client header request option to get the list of files. Token-authentication headers are not supported.

curl --location --request GET 'https://analytics.1up.health/bulk-data/r4/Group/<ID>/$export'\
--header 'client_id: xxx' \
--header 'client_secret: yyy' \
--header 'x-oneup-user-id: client'

After you submit your request, the list of download files is returned.

Execute the Group Bulk Export Process

You can use the list of download files you retrieved to connect to the 1upHealth group export endpoint and export the group bulk data for the members you added to your group.

If you change the group resource that includes the patient list (member IDs), you must execute the bulk export operation again to capture the changes in the group.

  1. Call the group export endpoint. Run:

    GET https://analytics.1up.health/bulk-data/r4/Group/<ID>]/$export

  2. Call the endpoint for each file that you want to download.

    Make sure to include any search parameters in your call request.

    You receive a response with the set of links to the Newline Delimited JSON (NDJSON) files for each of the FHIR resource types.

    "output": [
    {
    "type": "AllergyIntolerance",
    "url": "https://analytics.1up.health/bulk-data/r4/$export/AllergyIntolerance/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdGFydCI6ImU0NiIsInRvdGFsIjo0LCJ1c2VySWQiOiIxMjM2NzUwNDkifQ.aOqtYWB9Xaup4R80pGjjl4gyaQV9SXRmZaqmnBHp2oI.ndjson"
    },
    {
    "type": "Condition",
    "url": "https://analytics.1up.health/bulk-data/r4/$export/Condition/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdGFydCI6ImU0NiIsInRvdGFsIjoxMjAxLCJ1c2VySWQiOiIxMjM2NzUwNDkifQ.LcsXvPEnC0vNr1OwIUi4j98qjRxbT-99dr739r7mjrE.ndjson"
    },
    {
    "type": "Procedure",
    "url": "https://analytics.1up.health/bulk-data/r4/$export/Procedure/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdGFydCI6ImU0NiIsInRvdGFsIjoxMywidXNlcklkIjoiMTIzNjc1MDQ5In0.2qEoEMEzMng0ws33jvWzqLfLQnstluA2BbkDAd1605U.ndjson"
    },
    {
    "type": "MedicationOrder",
    "url": "https://analytics.1up.health/bulk-data/r4/$export/MedicationOrder/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdGFydCI6ImU0NiIsInRvdGFsIjo0MSwidXNlcklkIjoiMTIzNjc1MDQ5In0.NdLjPwLte_tvWN5nnaA5YMGw11NrKP_gd6mzXDTeII4.ndjson"
    },
    {
    "type": "MedicationStatement",
    "url": "https://analytics.1up.health/bulk-data/r4/$export/MedicationStatement/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdGFydCI6ImU0NiIsInRvdGFsIjo1MywidXNlcklkIjoiMTIzNjc1MDQ5In0.2M1jLqkjN6uR3L9ISsWsJr5S8aj_rNannoHVC2iiEzU.ndjson"
    },
    {
    "type": "Immunization",
    "url": "https://analytics.1up.health/bulk-data/r4/$export/Immunization/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdGFydCI6ImU0NiIsInRvdGFsIjo0LCJ1c2VySWQiOiIxMjM2NzUwNDkifQ.aOqtYWB9Xaup4R80pGjjl4gyaQV9SXRmZaqmnBHp2oI.ndjson"
    },
    {
    "type": "Observation",
    "url": "https://analytics.1up.health/bulk-data/r4/$export/Observation/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdGFydCI6ImU0NiIsInRvdGFsIjo0MTYsInVzZXJJZCI6IjEyMzY3NTA0OSJ9.9MzsFPH0aWs85fuiFPv7TTSZftbQ2uYqZB1mrvgD_b8.ndjson"
    },
    {
    "type": "DiagnosticReport",
    "url": "https://analytics.1up.health/bulk-data/r4/$export/DiagnosticReport/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdGFydCI6ImU0NiIsInRvdGFsIjozLCJ1c2VySWQiOiIxMjM2NzUwNDkifQ.Fpgzt5vbwdtj8ngj7YuOZ_ngZnwZSr0dQunZIrK05c4.ndjson"
    },
    {
    "type": "Patient",
    "url": "https://analytics.1up.health/bulk-data/r4/$export/Patient/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdGFydCI6ImU0NiIsInRvdGFsIjoxLCJ1c2VySWQiOiIxMjM2NzUwNDkifQ.aiEJoxsOPrr3QMmgVmV2AWUXKIxhREElfFSCHUpRuks.ndjson"
    },
    {
    "type": "RelatedPerson",
    "url": "https://analytics.1up.health/bulk-data/r4/$export/RelatedPerson/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdGFydCI6ImU0NiIsInRvdGFsIjoyLCJ1c2VySWQiOiIxMjM2NzUwNDkifQ.tFsPhGTH_LxHwSY8eE9i_DHU9hrxBcFYMjGi5MsjEuU.ndjson"
    },
    {
    "type": "Encounter",
    "url": "https://analytics.1up.health/bulk-data/r4/$export/Encounter/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdGFydCI6ImU0NiIsInRvdGFsIjo0OCwidXNlcklkIjoiMTIzNjc1MDQ5In0.SlnbTyNdWuT_-k_RGHVn6ytWpDrrucuq71FeYvjQijs.ndjson"
    },
    {
    "type": "DocumentReference",
    "url": "https://analytics.1up.health/bulk-data/r4/$export/DocumentReference/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdGFydCI6ImU0NiIsInRvdGFsIjoyODAsInVzZXJJZCI6IjEyMzY3NTA0OSJ9.txQ-_wmL9ybXMrLMprpQZ3heYbsvKYmhHODJQHbzWlI.ndjson"
    }
    ]
    }