Elation Health Patients API

Patient profile management

Documentation GitHub OpenAPI

Business capability

Patient Registration Management BC-2800.20

Operations 24

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

PUT /patients/:id/ Update a patient via the colon-style legacy path · Update Patient #

Ask an LLM

“Is there an older Elation endpoint written as /patients/:id/ for editing a patient?”

“What does the colon-placeholder patient update route accept?”

Tell an agent

Send a patient update through the legacy /patients/:id/ colon path.

Use the colon-style patient update route to push my edited chart demographics.

GET /patients/{id} Get a patient from the no-trailing-slash path · Get Patient #

Ask an LLM

“Can I fetch a patient from a patients URL that has no trailing slash?”

“Which legacy lookup returns a patient chart when the URL has no ending slash?”

Tell an agent

Get patient {id} from the /patients/{id} path that has no trailing slash.

Look up chart {id} using the slashless legacy patient route.

DELETE /patients/{id}/ Delete a patient via the legacy endpoint · Delete Patient #

Ask an LLM

“How do I remove a patient chart using the older unversioned delete route?”

“Which older unversioned endpoint deletes a single patient by ID?”

Tell an agent destructive · confirm first

Delete patient {id} through the legacy /patients/{id}/ route.

Remove the chart for patient {id} using the unversioned delete call.

PATCH /patients/{id}/ Patch a patient via the legacy endpoint · Update Patient #

Ask an LLM

“Can I patch just part of a patient on the older unversioned PATCH route?”

“Is there a legacy PATCH call for editing one patient without the v2.0 prefix?”

Tell an agent

Patch patient {id} with only the fields I changed, using the legacy PATCH route.

Send a partial legacy edit to chart {id} without resending the full record.

GET /patients/{id}/ Retrieve a patient's details by ID · Retrieve a patient #

Ask an LLM

“How do I pull the details for one specific patient by their ID from the legacy endpoint?”

“What demographic details come back when I retrieve a single patient on the unversioned path?”

Tell an agent

Retrieve the details for patient {id} from the unversioned /patients/{id}/ endpoint.

Show me everything on file for patient ID {id}.

PUT /patients/{id}/ Replace all fields on a patient record · Update a patient #

Ask an LLM

“Can I overwrite every field on a patient record at once, including pronouns and preferred language?”

“Which fields are mandatory when replacing a whole patient on the unversioned path?”

Tell an agent

Replace patient {id} with first name {first_name}, last name {last_name}, DOB {dob} and sex {sex}.

Overwrite patient {id} in full, setting primary physician {primary_physician} and practice {caregiver_practice}.

POST /patients/ Register a new patient via the legacy endpoint · Create Patient #

Ask an LLM

“What is the minimum I need to register a patient through the older unversioned create call?”

“Can I attach insurance when I add a new patient on the legacy route?”

Tell an agent

Register a new patient {first_name} {last_name}, born {dob}, sex {sex}, on the legacy create route.

Add a legacy patient record under physician {primary_physician} at practice {caregiver_practice}.

GET /patients/ Search patients across a practice · Find Patients #

Ask an LLM

“How can I find patients by name and date of birth on the legacy patient search?”

“Can I search patients by insurance member ID or group ID using the older find endpoint?”

Tell an agent

Find patients named {first_name} {last_name} born {dob} with the legacy patient search.

Search the older patient finder for members with insurance member ID {member_id}.

GET /patients/{id}/insurance_cards/ Get a patient's insurance card images · Get Insurance Cards #

Ask an LLM

“How do I see the scanned insurance cards on a patient's chart?”

“Can I get both the front and back images of a patient's insurance card?”

Tell an agent

Get the insurance card images for patient {id}.

Show me the scanned insurance cards on file for chart {id}.

POST /patients/{id}/insurance_cards/ Upload an insurance card image for a patient · Create Insurance Card #

Ask an LLM

“How do I upload a photo of a patient's insurance card?”

“Can I upload the back side of a secondary insurance card separately?”

Tell an agent

Upload insurance card image {image} for patient {id} as side {side} of rank {rank}.

Attach a card scan to patient {id}'s primary insurance, front side {side}.

DELETE /patients/{id}/insurance_cards/ Remove a patient's insurance card image · Delete Insurance Card #

Ask an LLM

“How do I delete an outdated insurance card scan from a patient's chart?”

“Can I archive an insurance card image instead of deleting it outright?”

Tell an agent destructive · confirm first

Delete the {side} side of the rank {rank} insurance card for patient {id}.

Archive patient {id}'s insurance card image for rank {rank}, side {side}, with archive set to {archive}.

GET /patients/{patient_id}/profile_image Get a patient's profile photo (legacy) · Get Patient Photo #

Ask an LLM

“How do I fetch a patient's headshot from the older profile_image route?”

“Does the legacy patient photo endpoint return the image for a patient_id?”

Tell an agent

Get the profile photo for patient {patient_id} from the legacy profile_image route.

Download patient {patient_id}'s headshot using the older photo lookup.

POST /patients/{patient_id}/profile_image Upload a patient profile photo (legacy) · Create Patient Photo #

Ask an LLM

“How do I set a patient's headshot by sending a base64 image on the older route?”

“What does the legacy photo upload need besides the image data?”

Tell an agent

Upload base64 image {base_64} named {original_filename} as patient {patient_id}'s headshot via the legacy route.

Set the legacy profile picture for patient {patient_id} in practice {practice}.

DELETE /patients/{patient_id}/profile_image/ Delete a patient's profile photo (legacy) · Delete Patient Photo #

Ask an LLM

“How do I clear a patient's headshot using the older profile_image delete?”

“Can I remove a wrong profile picture from a chart on the legacy route?”

Tell an agent destructive · confirm first

Delete the legacy profile photo for patient {patient_id}.

Clear patient {patient_id}'s headshot through the older delete route.

POST /patients/{id}/incoming_files File incoming documents to a patient chart · File Incoming Files to Patient Chart #

Ask an LLM

“How do I file faxed or uploaded documents into a patient's chart?”

“Can I mark a filed document urgent and assign a reviewer?”

Tell an agent

File incoming files {files} to patient {id}'s chart as document type {document_type}.

File documents {files} into chart {id} titled {custom_title} and route them to reviewer {reviewer_user}.

POST /patients/{patient_id}/patient_provider_team Create a provider team for a patient · Create a Provider Team for a given Patient #

Ask an LLM

“Can I set up a care team for a patient who doesn't have one yet?”

“How do I assemble a new provider team around a patient?”

Tell an agent

Create a provider team for patient {patient_id}.

Set up a new care team record around patient {patient_id}.

GET /patients/{patient_id}/patient_provider_team List a patient's care team members · List the Team Members for a given Patient #

Ask an LLM

“Who is on a patient's provider care team?”

“How can I see which clinicians are assigned to a patient's team?”

Tell an agent

List the care team members for patient {patient_id}.

Show me who belongs to patient {patient_id}'s provider team.

POST /patients/{id}/outstanding_balance/ Update a patient's outstanding balance · Updating Outstanding Balance #

Ask an LLM

“How do I record what a patient still owes the practice?”

“Can I push an updated outstanding balance from my billing system to a patient?”

Tell an agent

Set patient {id}'s outstanding balance to {balance}.

Update the amount owed on chart {id} to {balance}.

GET /api/2.0/patients/ List patients with filters and paging · List Patients #

Ask an LLM

“How do I page through all patients with limit and offset in the v2.0 API?”

“Can I look up a patient by phone number?”

Tell an agent

List v2.0 patients with phone number {phone_number}.

Page through patients {limit} at a time starting at offset {offset}, ordered by {order_by}.

POST /api/2.0/patients/ Create a patient with full demographics · Create Patient #

Ask an LLM

“Can I create a patient in the v2.0 API with emergency contact, employer and guarantor?”

“What fields does the v2.0 create-patient call require?”

Tell an agent

Create v2.0 patient {first_name} {last_name}, DOB {dob}, sex {sex}, with emergency contact {emergency_contact}.

Enroll a new patient with physician {primary_physician}, practice {caregiver_practice} and timezone {timezone}.

DELETE /api/2.0/patients/{id}/ Delete a patient in the v2.0 API · Delete Patient #

Ask an LLM

“How do I delete a patient using the /api/2.0 endpoint?”

“What happens to a chart when I call the v2.0 patient delete?”

Tell an agent destructive · confirm first

Delete v2.0 patient {id}.

Remove patient {id} via the /api/2.0 delete call.

GET /api/2.0/patients/{id}/ Retrieve a patient from the v2.0 API · Retrieve Patient #

Ask an LLM

“How do I get a single patient record from the v2.0 API?”

“Does the v2.0 patient lookup include consents and guarantor details?”

Tell an agent

Fetch v2.0 patient {id}.

Pull the /api/2.0 record for patient {id}, including consents and preferences.

PATCH /api/2.0/patients/{id}/ Partially update a patient in the v2.0 API · Partially Update Patient #

Ask an LLM

“Can I change only a patient's preferred language or pronouns in the v2.0 API?”

“How do I mark a patient VIP without resending the whole v2.0 record?”

Tell an agent

Set preferred language {preferred_language} on v2.0 patient {id}.

Flag patient {id} as VIP {vip} and set patient status {patient_status}.

PUT /api/2.0/patients/{id}/ Replace a patient record in the v2.0 API · Update Patient #

Ask an LLM

“How do I fully replace a patient in the v2.0 API, including previous names and address?”

“What must I resend when doing a full v2.0 patient replace?”

Tell an agent

Replace v2.0 patient {id} with previous last name {previous_last_name} and occupation {occupation}.

Do a full /api/2.0 replace of patient {id} keeping DOB {dob} and SMS opt-in {sms_opt_in_status}.

Elation Health Patients API

Operations 24

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification