Get Patient
Retrieve a single patient record by patient ID.
Endpoint
GET /apis/v1/patient/{id}
Path Parameters
| Parameter |
Type |
Required |
Description |
id |
integer |
Yes |
The patient_id of the patient to retrieve |
Request
curl --location '{base_url}/apis/v1/patient/10234' \
--header 'Authorization: Bearer JWT_TOKEN'
Response
Success Response
Code: 200 OK
{
"code": 2000,
"data": {
"patient_id": 10234,
"name": "Jane Smith",
"first_name": "Jane",
"middle_name": "Marie",
"last_name": "Smith",
"suffix": "",
"alias": "Janey",
"date_of_birth": "1985-03-15",
"sex": "FEMALE",
"mobile": "5551234567",
"secondary_contact": "5559876543",
"photo_url": null,
"email_address": "jane.smith@example.com",
"height": null,
"weight": null,
"address": {
"line1": "123 Main St",
"line2": "Apt 4B",
"landmark": "",
"city": "Springfield",
"state": "IL",
"postal_code": "62701",
"latitude": null,
"longitude": null,
"gps_link": null,
"country": null,
"plus_code": null,
"place_id": null
},
"relation": null,
"user": {
"user_id": 58001,
"username": "USR1234567890123456",
"name": "Jane Smith",
"email": "jane.smith@example.com",
"mobile": "5551234567",
"organisation_id": 74
},
"poc_status": null,
"status": "ACTIVE",
"comorbidities": [],
"external_ref_id": null,
"speciality_list": [],
"organisation_id": 74,
"preferred_language": "ENGLISH",
"legacy_patient": null,
"total_visits": 12,
"payment_mode": null,
"emergency_contacts": null,
"last_appointment_id": 98765,
"source_system": null
},
"message": "Success"
}
Response Fields
| Field |
Type |
Description |
patient_id |
integer |
Unique patient identifier |
name |
string |
Full name (concatenated) |
first_name |
string |
Patient's first name |
middle_name |
string |
Patient's middle name |
last_name |
string |
Patient's last name |
suffix |
string |
Name suffix |
alias |
string |
Known name or alias |
date_of_birth |
string (date) |
Date of birth (YYYY-MM-DD) |
sex |
string |
MALE, FEMALE, OTHER, OTHERS, or UNDEFINED |
mobile |
string |
Primary phone number |
secondary_contact |
string |
Secondary phone number |
photo_url |
string |
URL of patient photo |
email_address |
string |
Email address |
height |
string |
Height |
weight |
string |
Weight |
address |
object |
Patient's address (see Address Object) |
relation |
string |
Relationship context (used for dependents) |
user |
object |
Linked system user account (see User Object) |
poc_status |
string |
Point-of-care status |
status |
string |
CREATED, ACTIVE, INACTIVE, DELETED, LEAD, or DISCHARGED |
comorbidities |
array |
List of comorbidity entries |
external_ref_id |
string |
External reference ID from source system |
speciality_list |
array |
Specialities associated with the patient |
organisation_id |
integer |
Organisation the patient belongs to |
preferred_language |
string |
Patient's preferred language |
legacy_patient |
object |
Legacy migration data, if applicable |
total_visits |
integer |
Total number of completed visits |
payment_mode |
string |
Payment mode |
emergency_contacts |
array |
Emergency contact records |
last_appointment_id |
integer |
ID of the patient's most recent appointment |
source_system |
string |
Source system identifier for migrated records |
Address Object
| Field |
Type |
Description |
line1 |
string |
Street address line 1 |
line2 |
string |
Street address line 2 |
landmark |
string |
Nearby landmark |
city |
string |
City |
state |
string |
2-letter state code |
postal_code |
string |
ZIP / postal code |
latitude |
number |
GPS latitude |
longitude |
number |
GPS longitude |
gps_link |
string |
GPS map link |
country |
string |
Country |
plus_code |
string |
Google Plus Code |
place_id |
string |
Google Place ID |
User Object
| Field |
Type |
Description |
user_id |
integer |
Linked user account ID |
username |
string |
System-generated username |
name |
string |
User display name |
email |
string |
User email |
mobile |
string |
User mobile |
organisation_id |
integer |
Organisation ID |
Error Response
Code: 200 OK
{
"code": 2302,
"message": "Patient not found"
}
Notes
- The HTTP status is always
200. Check the code field in the response body — 2000 is success, 2302 means no patient was found for the given ID.