HLS Providers

Reset patient password

Changed on

Send a password reset request to the patient's healthcare portal (e.g., MyChart). This is a provider-agnostic endpoint that works across different EHR systems.

Prerequisites:

  • A patient lookup must be performed first within the same interaction
  • The patient must have a healthcare portal account (e.g., MyChart) configured

Required Epic settings (override Epic's own defaults if set): patient_reset_password_site_id and patient_reset_password_account_id_type.

post/healthcare/patients/{patient_id}/password-reset

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/healthcare/patients/{patient_id}/password-reset
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: hls-patient-password-reset:write

Path parameters

patient_idstring required

The patient identifier in the format required by the upstream system.

Request body

delivery_method'EMAIL' | 'SMS' required

The delivery method for the password reset link.

Response

No Content - Password reset request has been successfully submitted

Changes