Collect Flat Datasets

get

https://sandbox.particlehealth.com/flat/{id}/collect-data

Returns the Flat datasets for a query. Add dataset names as query parameters (e.g. ?LABS&ENCOUNTERS) to return only those datasets.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Returns the Flat datasets for a query. Add dataset names as query parameters (e.g. ?LABS&ENCOUNTERS) to return only those datasets.

Path Params

string

required

Query ID

Query Params

ALLERGIES

string

Dataset filter. Pass dataset names as bare flags with no value, for example ?ALLERGIES; combine several to select multiple datasets, for example ?ALLERGIES&VITAL_SIGNS. Omit all dataset flags to return every dataset. Valid datasets: ALLERGIES, COVERAGES, DOCUMENT_REFERENCES, ENCOUNTERS, FAMILY_MEMBER_HISTORIES, IMMUNIZATIONS, LABS, LOCATIONS, MEDICATIONS, MED_FILLS, ORGANIZATIONS, PRACTITIONERS, PATIENTS, PROBLEMS, PROCEDURES, SOCIAL_HISTORIES, TRANSITIONS, VITAL_SIGNS, RECORD_SOURCES, SOURCES. Only ALLERGIES is listed as a field here, as an example for the Try It console; every other dataset is passed the same way.

resource_id

string

Filter by specific resource ID. Must be used together with resource_type. When both resource_id and resource_type are given, dataset flags are ignored.

resource_type

string

enum

Filter by resource type. Must be used together with resource_id. When both resource_id and resource_type are given, dataset flags are ignored.

Responses

200OK

202Accepted. The Flat data is not ready yet.

400Bad Request

401Unauthorized

403Forbidden

404Not Found

406Not Acceptable

410Gone. Flat data for the query is no longer available because the query was created more than 90 days ago.

500Internal Server Error