Update Patient
Updates an existing patient. The update process differs based on the current status of the patient.
id in the URL path. The {id} parameter should be the Cobalt patient ID returned from API responses or GET endpoints, not the MRN or EHR ID.1. Updating Pending or Failed Patients
For patients with a status of ‘pending’ or ‘failed’, the patient does not yet exist in the EHR. You can update any attribute, and the new values will be used the next time the patient creation runs.2. Updating Active Patients
For patients with a status of ‘active’ (already created in the EHR), you can update the patient’s contact information, address, and provider assignments. The change is queued and applied to the EHR asynchronously; the patient’s status will move to ‘pending_update’ while the update is in flight and back to ‘active’ once the EHR write completes.Contact & Address Fields
Provider Fields (eClinicalWorks Only)
Demographics & Contact Preference Fields (eClinicalWorks Only)
voice_enabled or text_enabled is set, the notification language in eCW follows the patient’s language (using the new value if language is included in the same request, otherwise the patient’s current language): Spanish when language contains “spanish” (case-insensitive), otherwise English. These are the only two options eCW exposes for communication notifications.failed_fields array on the patient.updated webhook, along with a human-readable message. If no fields could be applied, the request fails and a patient.update_failed webhook is sent instead. Use referring_provider_id or pcp_id instead of names when possible, as ID-based resolution is more reliable.Example Request for Updating a Pending/Failed Patient
Example Request for Updating an Active Patient’s Contact Info
Example Request for Updating an Active Patient’s Address
save_previous_address: false:
Example Request for Updating an Active Patient’s Providers
Example Request for Updating an Active Patient’s Demographics & Contact Preferences
Example Response
Authorizations
Path Parameters
The patient's ID
Body
- Option 1
- Option 2
Updates for pending/failed patients. Any allowed attribute can be updated; values are used the next time patient creation runs against the EHR.
Address line 2 (apartment, suite, unit, etc.)
Patient email address
primary, secondary, tertiary The ehr_id of the provider this patient is being referred to (rendering provider). Use the ehr_id from GET /v1/providers
First name of the referring provider
Last name of the referring provider
The id of a referring provider from GET /v1/referring-providers (UUID without dashes). Can be used instead of referring_provider_first_name and referring_provider_last_name. Currently only supported for eClinicalWorks.
male, female, unknown