Patients

Update a patient

Data: property-value key-pairs, including nested objects for address and insurance information (match the structure from the GET API call)

patch/patients/{patient_id}

Request

  • Base URL: https://clinic-subdomain.md-hq.com/api/v1
  • URL: https://clinic-subdomain.md-hq.com/api/v1/patients/{patient_id}
  • Auth: HTTP basic

Path parameters

patient_idinteger required

ID of the patient to update

Request body

first_namestring
last_namestring
dobstring

YYYY-MM-DD

sexstring

must be 'M', 'F', or '?'

inactivestring

Sets the patient status. Accepts the following values:

ValueResult
"prospective" or "-1"Prospective patient
"0", empty, or omittedActive patient (default)
"inactive" or "1"Inactive patient
"deceased" or "dead" or "2"Deceased patient

Important — GET response behavior:

When reading patient data via GET, the inactive field is cast to a boolean rather than returning the original value. This means:

Stored statusinactive in GETpatient_status_description in GET
Prospective (-1)true"prospective"
Active (0)false"active"
Inactive (1)true"inactive"
Deceased (2)true"deceased"

Because inactive returns true for prospective, inactive, and deceased patients alike, you must use the patient_status_description field to determine the actual status. This is a known legacy serialization issue where the create/update and read representations differ.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.