v1

latestOpenAPI 3.1.0Private2026-07-24196240439.2 KB
Patient

Update Patient

patch/provider/patients/{id}

Path parameters

idstring required

Unique Patient ID

Request body

first_namestring required

This should be the patients legal first name.

last_namestring required

This should be the patients legal last name.

middle_namestring

This should be the patients legal middle name.

titlestring
suffixstring
chosen_first_namestring
chosen_last_namestring
chosen_middle_namestring
chosen_titlestring
chosen_suffixstring
pronounsstring

May be one of He/Him/His, She/Her/Hers or They/Them/Theirs. Other values sent will be stored as free text.

emailstring
sexstring

May send male, female, or intersex.

genderstring

This field will be deprecated on March 31st 2021.

gender_identitystring

May send man, woman, trans man, trans woman, nonbinary, or not listed. If you send not listed, please include a description in the gender_other field.

gender_otherstring

Used to specify gender identity, when not listed.

dobstring date

Date must be formatted as YYYY-MM-DD.

health_insurance_group_idstring
health_insurance_member_idstring
health_insurance_payer_namestring
health_insurance_payer_idstring
address_line1string
address_line2string
address_citystring
address_statestring
address_zipstring
address_countrystring
import_idstring

(deprecated)

import_sourcestring

(deprecated)

external_link_idstring

(deprecated)

integration_record_idstring
integration_error_messagestring
integration_web_linkstring
last_engagement_datestring date

Date must be formatted as YYYY-MM-DD.

electronic_communication_consent_acceptedboolean
patient_agreement_acceptedboolean

Response

Successful response

idstring
address_citystring
address_countrystring
address_line1string
address_line2string
address_statestring
address_zipstring
agestring
chosen_first_namestring
chosen_last_namestring
chosen_middle_namestring
chosen_suffixstring
chosen_titlestring
created_atstring date-time
dobstring date
electronic_communication_consent_acceptedstring
electronic_communication_consent_accepted_atstring
emailstring
engagedboolean
external_link_idstring
first_namestring
genderstring
gender_identitystring
gender_otherstring
health_insurance_group_idstring
health_insurance_member_idstring
health_insurance_payer_idstring
health_insurance_payer_namestring
hipaa_authorization_acceptedboolean
hipaa_authorization_accepted_atstring date-time
import_idstring
import_sourcestring
joined_practice_datestring date
last_engagement_datestring date
last_namestring
lead_source_otherstring
master_record_sponsorstring
membership_statusstring
middle_namestring
namestring
patient_agreement_acceptedboolean
patient_agreement_accepted_atstring date-time
preferred_languagestring
pronounsstring
provider_web_linkstring
sexstring
suffixstring
terms_acceptedboolean
terms_accepted_atstring date-time
updated_atstring date-time
uses_tobaccoboolean