Collect Flat Datasets

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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
string
required

Particle Patient ID

Query Params
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.

string
enum

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

string

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

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json