v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

Patient Registration API

Get patient details by profile id

This API provides functionality to get details of a patient by their Eka profile id, from a business' directory. The patient should have been previously added to the business directory for this API to return the patient's details.

get/dr/v1/patient/{patient_id}

Path parameters

patient_idstring required

Patient's Eka profile id

Headers

authstring required

The auth token of the business. It is used to authenticate the client. This should be fetched from auth API.

Response

patient_idstring

partner_patient_idstring

first_namestring

middle_namestring

last_namestring

gender'M' | 'F' | 'O'

dobstring date

emailstring

mobilestring

tagstring

partner_metaobject

created_atinteger

Example response

{
  "patient_id": "189673451298376",
  "partner_patient_id": "MO1298376",
  "first_name": "Raj",
  "last_name": "Sharma",
  "gender": "M",
  "dob": "1988-11-30",
  "email": "raj.sharma@example.com",
  "mobile": "+919876543210",
  "address": {
    "line1": "B504, Seabreeze Heights,",
    "city": "Mumbai",
    "pincode": "400001"
  },
  "tag": "tag#1",
  "partner_meta": {
    "key1": "value1"
  },
  "created_at": 1732607432,
  "relations": [
    {
      "relation": "Husband",
      "pid": "144051779835569"
    }
  ]
}