Getting Started for Developers

Particle has two primary integration paths. Choose the one that matches your use case, or combine both once you are up and running.

Path	What it does
Workbench	Register patients, run queries, and retrieve clinical data on demand in FLAT or CCDA format.
Signal	Subscribe patients to continuous monitoring and receive real-time webhook alerts when care events occur.

Both paths share the same authentication model and patient registration step.

Workbench

1. Authenticate

Auth & Keys

2. Register Patients

Submit patient demographics to generate a particle_patient_id, required for all subsequent calls.

Patients API

3. Run a Query

Initiate a query for a registered patient and monitor status until complete.

4. Retrieve Data

Pull the clinical data returned by your query in FLAT or CCDA format.

Data Retrieval APIs

5. Set Up Webhooks (optional)

Receive query-complete notifications instead of polling for status.

Webhook Event Notifications

Signal

For the full Signal implementation workflow - including patient registration, subscription, webhook configuration, and data retrieval - see the Signal documentation:

1. Authenticate

Auth & Keys

2. Set Up Signal

Covers patient registration, subscription to monitoring, and webhook configuration.

Setting Up Signal

3. Receive and Act on Alerts

Transition Alerts - admissions, discharges, transfers
Discharge Summary Alerts - discharge summary availability
New Encounter Alerts - new clinical documentation

Additional Resources

Postman Collection - pre-configured requests for quick exploration
Test Patient Sandbox - explore clinical data formats without production data
Life of a Query - end-to-end walkthrough of the query lifecycle