Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
Patient

Update patient profile details

Payload for updating patient profile.

Name Field Requirement:

  • Either fln must be provided, or at least fn must be included (optionally with mn and ln).
  • If you do not want to change the name, omit all name fields.
patch/profiles/v1/patient/{oid}

Path parameters

oidstring required

Headers

client-idstring required
Example:EC_1431

Request body

dobstring date
gen'M' | 'F' | 'O'

Gender

mobilestring

Mobile number of the patient

fnstring

First name (will be converted and stored in lowercase)

mnstring

Middle name (will be converted and stored in lowercase)

lnstring

Last name (will be converted and stored in lowercase)

flnstring

Full name (will be converted and stored in lowercase)

bloodgroup'A+' | 'A-' | 'B+' | 'B-' | 'AB+' | 'AB-' | 'O+' | 'O-'

Blood group of the patient

sstring

Salutation (will be converted and stored in lowercase)

emailstring email

Email address of the patient (will be converted and stored in lowercase)

abhastring

ABHA address of the patient

usernamestring

Unique UHID| partner id | username for the patient. Note: username must be unique within a workspace. Please refrain from sending it unless it has changed.

extrasobject

Additional arbitrary data as a JSON object

Example request

{
  "dob": "2000-01-02",
  "gen": "M",
  "mobile": "+916000000000",
  "fn": "eka",
  "mn": "eka",
  "ln": "user",
  "fln": "eka user",
  "bloodgroup": "A+",
  "s": "Dr",
  "email": "testuser@eka.care",
  "abha": "xyz@abdm",
  "username": "UH0001",
  "extras": {
    "dummyKey": "Dummy Value"
  }
}

Response

Update Patient profile

messagestring

Example response

{
  "message": "Profile updated successfully"
}