HIhint
Allergy

Update an existing allergy record.

Changed on
patch/provider/partner-invisible/patients/{patient_id}/allergies/{id}

Request

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

Path parameters

patient_idstring required

Unique Patient ID

idstring required

Unique Allergy ID

Request body

namestring

Name of the allergen

descriptionstring

Additional details about the allergy

severity'mild' | 'moderate' | 'severe'

Severity level

start_datestring date

Date the allergy began

end_datestring date

Date the allergy resolved

activeboolean

Whether the allergy is currently active

icd10_codestring

ICD-10 code (e.g. "Z88.0"). Resolved to a structured code when known; otherwise noted in the description.

integration_record_idstring
integration_error_messagestring
integration_web_linkstring

Response

Successful response

idstring
activeboolean
created_atstring date-time
descriptionstring
end_datestring date
icd10_codestring
icd10_descriptionstring
namestring
patientobject
severitystring
start_datestring date
updated_atstring date-time
warningsstring

Changes