Patient Registration API
Add Patient to Directory
This functionality enables the addition of new patient records to a business’ directory. Users can provide necessary details such as personal information, contact details, and medical history to create a new patient profile.
In case the patient is already registered with Eka care, then passing the patient eka id will be enough
Right now adding a patient is done wrt to a specific doctor, which automatically adds the patient to the business directory as well. This will be
deprecated
soon by adding patient directly to a business (WIP). Request Parameters
Parameter
Param | Type | Expected Values | Description | Required/Optional/Not Required |
---|---|---|---|---|
patient_id | string | In case Eka patient_id already exists use this - no need for profile metadata | ||
designation | string | Mr./Miss/Mrs. | Patient Designation | Optional |
first_name | string | Rahul | First Name | Required |
middle_name | string | Kumar | Middle Name | Optional |
last_name | string | Sharma | Last Name | Optional |
dob | Date | 1987-01-06 | Patient DOB | Required |
age | string | 36 | Patient Age | Optional |
mobile | string | +919876543210 | Mobile Number with country code | Required |
gender | string | M/F/O | Patient Gender | Required |
string | rahul.sharma@example.com | Patient Email Address | Optional | |
address | object | Address Object | Optional | |
address.city | string | Mumbai | City | Optional |
address.line1 | string | 123, Shanti Nagar | Address Line 1 | Optional |
address.line2 | string | Near City Hospital | Address Line 2 | Optional |
address.pincode | int | 400001 | Pincode | Optional |
address.state | string | Maharashtra | State | Optional |
address.country | string | India | Country | Optional |
metadata | object | Metadata Object (Set of key-value pairs) | Optional | |
metadata.blood_group | string | B+ | Blood Group | Optional |
metadata.aadhar_number | string | 123456789012 | Aadhar Number | Optional |
metadata.UHID | string | MH2024001 | Unique Health ID | Optional |
doctor_id (to_be_deprecated) | string | DOC12345 | doctor_id | Required |
Response Parameters
Parameter | Type | Expected Values | Description |
---|---|---|---|
response | object | Response Object | |
response.patient_id | string | 1234567890 | Generated Patient ID |
response.profile | object | Profile Object | |
response.profile.id | string | 1234567890 | Profile ID |
response.profile.created_at | datetime | 2024-06-12T21:55:51.593Z | Profile Creation Timestamp |
response.profile.updated_at | datetime | 2024-06-17T09:52:55.257Z | Profile Update Timestamp |
Status Codes
• 200: Success
• 404: Patient data missing
• 500: Something went wrong
POST
/
dr
/
v1
/
business
/
doctor
/
patient
/
add
Headers
auth
string
requiredThe auth token of business_id. It is used to authenticate the business. The token can be fetched from the auth api.
Body
application/json · string
The body is of type string
.
Response
200 - application/json
data
object
required