Update Patient

patch

https://api.sandbox.hint.com/api/provider/patients/{id}

Path Params

string

required

Unique Patient ID

Body Params

first_name

string

required

This should be the patients legal first name.

last_name

string

required

This should be the patients legal last name.

middle_name

string

This should be the patients legal middle name.

title

string

suffix

string

chosen_first_name

string

chosen_last_name

string

chosen_middle_name

string

chosen_title

string

chosen_suffix

string

pronouns

string

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

string

sex

string

May send male, female, or intersex.

gender

string

This field will be deprecated on March 31st 2021.

gender_identity

string

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_other

string

Used to specify gender identity, when not listed.

dob

date

Date must be formatted as YYYY-MM-DD.

lead_source

object

practitioner

object

location

object

emergency_contact

object

phones

array of objects

phones

ssn

object

health_insurance_group_id

string

health_insurance_member_id

string

health_insurance_payer_name

string

health_insurance_payer_id

string

address_line1

string

address_line2

string

address_city

string

address_state

string

address_zip

string

address_country

string

import_id

string

(deprecated)

import_source

string

(deprecated)

external_link_id

string

(deprecated)

integration_record_id

string

integration_error_message

string

integration_web_link

string

last_engagement_date

date

Date must be formatted as YYYY-MM-DD. A date earlier than the patient's current last_engagement_date is rejected with a 422, and so is a null date once the patient has one; resending the current date is a no-op.

electronic_communication_consent_accepted

boolean

patient_agreement_accepted

boolean

autopay

boolean

When true, Hint automatically schedules and collects payment for membership invoices billed to this patient. For a dependent, the paying account holder's autopay governs their invoices. Changing it to true also schedules payment on outstanding invoices billed to this patient and dated after today. Changing it to false cancels the scheduled payments on those invoices.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response