v1

latestOpenAPI 3.1.02026-07-24447622848.7 KB

Patients

Partially Update Patient

Retrieve a single patient

patch/api/2.0/patients/{id}/

Path parameters

idinteger required

Request body

actual_namestring nullable

caregiver_practiceinteger

created_datestring date-time nullable

deleted_datestring date-time nullable

dobstring date

ethnicity'Declined to specify' | 'Hispanic or Latino' | 'No ethnicity specified' | 'Not Hispanic or Latino'

first_namestring

gender_identity'man' | 'nonbinary' | 'option_not_listed' | 'prefer_not_to_say' | 'transgender_man' | 'transgender_woman' | 'two_spirit' | 'unknown' | 'woman'

idinteger

last_modifiedstring date-time

last_namestring

master_patientinteger

merged_into_chartinteger nullable

middle_namestring

mothers_maiden_namestring nullable

notesstring nullable

occupationstring nullable

patient_status'active' | 'inactive'

preferred_languagestring nullable

preferred_service_locationinteger nullable

previous_first_namestring nullable

previous_last_namestring nullable

primary_care_providerinteger

A read-only field that provides the internal Elation id of the collaborator record that is created within your practice to represent your practice's connection with the patient's primary care provider.

primary_care_provider_npistring nullable

Represents the patient's primary care provider. This person may be in a different practice.

primary_physicianinteger

Represents the physician providing care to the patient within your practice. This is a required field. This value must match the id of one of the physicians retrieved via the /physicians/ endpoint.

race'American Indian or Alaska Native' | 'Asian' | 'Black or African American' | 'Declined to specify' | 'Native Hawaiian or Other Pacific Islander' | 'No race specified' | 'White'

sex'Female' | 'Male' | 'Other' | 'Unknown'

sexual_orientation'asexual' | 'bisexual' | 'gay' | 'lesbian' | 'option_not_listed' | 'prefer_not_to_say' | 'queer' | 'straight' | 'unknown'

sms_opt_in_statusboolean nullable

ssnstring nullable

suffixstring

verifiedboolean

vipboolean nullable

Response

actual_namestring nullable

caregiver_practiceinteger required

created_datestring date-time nullable

deleted_datestring date-time nullable

dobstring date required

ethnicity'Declined to specify' | 'Hispanic or Latino' | 'No ethnicity specified' | 'Not Hispanic or Latino'

first_namestring required

gender_identity'man' | 'nonbinary' | 'option_not_listed' | 'prefer_not_to_say' | 'transgender_man' | 'transgender_woman' | 'two_spirit' | 'unknown' | 'woman'

idinteger

last_modifiedstring date-time

last_namestring required

master_patientinteger

merged_into_chartinteger nullable

middle_namestring

mothers_maiden_namestring nullable

notesstring nullable

occupationstring nullable

patient_status'active' | 'inactive'

preferred_languagestring nullable

preferred_service_locationinteger nullable

previous_first_namestring nullable

previous_last_namestring nullable

primary_care_providerinteger

A read-only field that provides the internal Elation id of the collaborator record that is created within your practice to represent your practice's connection with the patient's primary care provider.

primary_care_provider_npistring nullable

Represents the patient's primary care provider. This person may be in a different practice.

primary_physicianinteger required

Represents the physician providing care to the patient within your practice. This is a required field. This value must match the id of one of the physicians retrieved via the /physicians/ endpoint.

race'American Indian or Alaska Native' | 'Asian' | 'Black or African American' | 'Declined to specify' | 'Native Hawaiian or Other Pacific Islander' | 'No race specified' | 'White'

sex'Female' | 'Male' | 'Other' | 'Unknown' required

sexual_orientation'asexual' | 'bisexual' | 'gay' | 'lesbian' | 'option_not_listed' | 'prefer_not_to_say' | 'queer' | 'straight' | 'unknown'

sms_opt_in_statusboolean nullable

ssnstring nullable

suffixstring

verifiedboolean

vipboolean nullable