Collect Flat Datasets

get

https://sandbox.particlehealth.com/api/v2/patients/{particle_patient_id}/flat

Filter Options:

By Domain: Add the domain name directly as a query parameter (no value needed). You can combine multiple domains. For example:

?ALLERGIES - Filter for allergies only
?ENCOUNTERS&MEDICATIONS - Filter for encounters and medications
Available domains: AI_CITATIONS, AI_OUTPUTS, ALLERGIES, COVERAGES, DOCUMENT_REFERENCES, ENCOUNTERS, FAMILY_MEMBER_HISTORIES, IMMUNIZATIONS, LABS, LOCATIONS, MED_FILLS, MEDICATIONS, ORGANIZATIONS, PATIENTS, PRACTITIONERS, PROBLEMS, PROCEDURES, RECORD_SOURCES, SOCIAL_HISTORIES, SOURCES, TRANSITIONS, VITAL_SIGNS

By Specific Resource: Use the resource_type and resource_id query parameters together to retrieve a single resource by ID (documented below).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Filter Options:

By Domain: Add the domain name directly as a query parameter (no value needed). You can combine multiple domains.
- Example: ?ENCOUNTERS or ?ENCOUNTERS&MEDICATIONS
- Available domains: AI_CITATIONS, AI_OUTPUTS, ALLERGIES, COVERAGES, DOCUMENT_REFERENCES, ENCOUNTERS, FAMILY_MEMBER_HISTORIES, IMMUNIZATIONS, LABS, LOCATIONS, MED_FILLS, MEDICATIONS, ORGANIZATIONS, PATIENTS, PRACTITIONERS, PROBLEMS, PROCEDURES, RECORD_SOURCES, SOCIAL_HISTORIES, SOURCES, TRANSITIONS, VITAL_SIGNS
By Specific Resource: Use resource_type and resource_id together to retrieve a single resource by ID (e.g., ?resource_type=ENCOUNTERS&resource_id={encounter_id})

License Requirements

AI_OUTPUTS and AI_CITATIONS domains require a Particle Snapshot license.

MED_FILLS domain requires a Surescripts license.

Contact [email protected] to enable access.

Path Params

particle_patient_id

string

required

Particle Patient 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, AI_OUTPUTS, AI_CITATIONS, 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.

_since

string

Return only data that Particle created or updated at or after this time, rather than filtering on clinical documentation dates. Accepts an ISO 8601 timestamp or date (e.g. 2024-01-01), or lastQuery to return data since the patient's latest completed query.

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.

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.

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

406Not Acceptable

410Gone

500Internal Server Error