Patients
This section covers everything you do with patients through the HealthEx API: getting them into a project, following their progress through the consent and record-retrieval flow, and working with the data they share. Most integrations move through these topics in roughly this order.
Every API call in this section requires an access token. See Authentication first, and Key Concepts for how organizations, projects, and patients relate.
Adding patients to projects
Start here. You can send patients a generic project link, associate your own identifier (such as an MRN) with a patient using a unique link, or add patients programmatically through the API.
- Adding Patients to Projects: overview of the three approaches and when to use each
- Add Patients by Unique Link
- Add Patients by API
Following patient progress
Once patients have been invited, see how far they've gotten and re-engage the ones who haven't finished.
- Nudging Patients: automatic and self-managed reminders for patients who start but don't finish
- Getting Patient Flow Progress: where a patient is in the consent and retrieval flow, and which locations were retrieved or skipped
Working with patient data
After a patient consents and shares their records, retrieve, refresh, and look up their information.
- Accessing Patient Data: push delivery, the MCP server, and the FHIR server
- Updating Patient Data: request fresh data for an individual patient
- Patient Demographics: the demographic details HealthEx has on file
Record Locations
Help patients connect the providers that hold their records, or fill gaps in their history.
- Record Location Search: find providers by name, location, or EHR platform
- Nearby Record Locations: location-based suggestions
- Record Location Recommendations: personalized suggestions for an authenticated patient
- Add a Record Location: let a patient add a provider without a full data refresh
Testing
Build and QA your integration without touching real patient data.
- Test Patients: create and manage simulated patients through the API
- Sample Patients: 125 synthetic patient records, available on request
Prefer a non-technical walkthrough? See User Workflows.