HIhint
Patient

Update Patient

Changed on
patch/provider/patients/{id}

Request

  • Base URL
    https://api.sandbox.hint.com/api
  • URL
    https://api.sandbox.hint.com/api/provider/patients/{id}
  • Auth
    API key in header AUTHORIZATION

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. 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_acceptedboolean
patient_agreement_acceptedboolean

Deprecated. Sets acceptance of the migrated legacy patient contract, not other patient documents.

autopayboolean

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

Successful response

idstring
address_citystring
address_countrystring
address_line1string
address_line2string
address_statestring
address_zipstring
agestring
autopayboolean

Whether the patient is on autopay. 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. Hint does not check this setting when you process a payment through the API.

chosen_first_namestring
chosen_last_namestring
chosen_middle_namestring
chosen_suffixstring
chosen_titlestring
created_atstring date-time
customer_typestring
dobstring date
electronic_communication_consent_acceptedstring
electronic_communication_consent_accepted_atstring
emailstring
email_marketing_authorization'opted_in' | 'opted_out'

Marketing consent recorded for this record's email address: opted_in (explicit opt-in), opted_out (explicit opt-out), or null when none has been recorded. null is not an opt-out — marketing email is permitted unless opted_out. Set it with Set Communication Authorization; it is read-only here.

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

Deprecated. Whether the current version of the practice's migrated legacy patient contract was accepted. This does not reflect acceptance of other patient documents. Returns false if no legacy contract exists.

patient_agreement_accepted_atstring date-time

Deprecated. When the current version of the migrated legacy patient contract was accepted. This does not reflect acceptance of other patient documents.

preferred_languagestring
pronounsstring
provider_web_linkstring
sexstring
suffixstring
terms_acceptedboolean

Deprecated. Whether the current version of the practice's migrated legacy patient contract was accepted. This does not reflect acceptance of other patient documents. Returns false if no legacy contract exists.

terms_accepted_atstring date-time

Deprecated. When the current version of the migrated legacy patient contract was accepted. This does not reflect acceptance of other patient documents.

updated_atstring date-time
uses_tobaccoboolean

Changes

  • c9bda0d2dd87Revision changes
    • warning

      removed the request property /

    • info

      added the new optional request property

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      response property patient_agreement_accepted deprecated

    • info

      response property patient_agreement_accepted_at deprecated

    • info

      response property terms_accepted deprecated

    • info

      response property terms_accepted_at deprecated