Heidi API

Update Patient Profile

update patient profile

patch/api/v2/ml-scribe/open-api/patient-profiles/{patient_profile_id}

Request

  • Base URL
    https://au.api.heidihealth.com
  • Auth
    HTTP bearer

Path parameters

patient_profile_idstring required

Request body

identifiersIdentifier[] nullable(unresolved $ref)
birth_datestring nullable
gender'male' | 'female' | 'other' | 'unknown'

gender that matches FHIR API

first_namestring nullable
last_namestring nullable
phonestring nullable
emailstring nullable
demographic_stringstring nullable
additional_contextstring nullable

Response

Successful Response

Example response

{
  "data": {
    "id": "5eb7cf5a86d9755df3a6c593",
    "managed_by": "5eb7cf5a86d9755df3a6c593"
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.