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). For example:

?ALLERGIES - Filter for allergies only
?ENCOUNTERS - Filter for encounters only
?MEDICATIONS - Filter for medications only

Available domains: ALLERGIES, COMPOSITIONS, COVERAGES, DOCUMENT_REFERENCES, ENCOUNTERS, FAMILY_MEMBER_HISTORIES, IMMUNIZATIONS, LABS, LOCATIONS, MEDICATIONS, ORGANIZATIONS, PRACTITIONERS, PATIENTS, PROBLEMS, PROCEDURES, SOCIAL_HISTORIES, TRANSITIONS, VITAL_SIGNS

By Specific Resource: Use the resource_type and resource_id parameters together (documented below).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

particle_patient_id

string

required

Particle Patient ID

Query Params

_since

string

Filter based on when Particle last queried the network for data (ISO 8601 date format). Returns data that was retrieved from the network after this date, based on query execution date rather than clinical documentation dates.

ALLERGIES

string

Filter by Allergies domain only. Leave empty or omit for no filtering.

COMPOSITIONS

string

Filter by Compositions domain only. Leave empty or omit for no filtering.

COVERAGES

string

Filter by Coverages domain only. Leave empty or omit for no filtering.

DOCUMENT_REFERENCES

string

Filter by Document References domain only. Leave empty or omit for no filtering.

ENCOUNTERS

string

Filter by Encounters domain only. Leave empty or omit for no filtering.

FAMILY_MEMBER_HISTORIES

string

Filter by Family Member Histories domain only. Leave empty or omit for no filtering.

IMMUNIZATIONS

string

Filter by Immunizations domain only. Leave empty or omit for no filtering.

LABS

string

Filter by Labs domain only. Leave empty or omit for no filtering.

LOCATIONS

string

Filter by Locations domain only. Leave empty or omit for no filtering.

MEDICATIONS

string

Filter by Medications domain only. Leave empty or omit for no filtering.

ORGANIZATIONS

string

Filter by Organizations domain only. Leave empty or omit for no filtering.

PRACTITIONERS

string

Filter by Practitioners domain only. Leave empty or omit for no filtering.

PATIENTS

string

Filter by Patients domain only. Leave empty or omit for no filtering.

PROBLEMS

string

Filter by Problems domain only. Leave empty or omit for no filtering.

PROCEDURES

string

Filter by Procedures domain only. Leave empty or omit for no filtering.

SOCIAL_HISTORIES

string

Filter by Social Histories domain only. Leave empty or omit for no filtering.

TRANSITIONS

string

Filter by Transitions domain only. Leave empty or omit for no filtering.

VITAL_SIGNS

string

Filter by Vital Signs domain only. Leave empty or omit for no filtering.

resource_type

string

enum

Filter by resource type. Must be used together with resource_id.

resource_id

string

Filter by specific resource ID. Must be used together with resource_type.

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

406Not Acceptable

500Internal Server Error