Getting started
Overview
The Patient Directory provides APIs for managing patient profiles in your system.
Patient Profile
A Patient Profile represents the core demographic and identifier data for a patient, used for managing and retrieving patient details across the system.
Profile Details
Profile Details
Field | Source | Type | Description |
---|---|---|---|
oid | System Generated | string | unique identifier |
wid | System Generated | string | Workspace ID |
ps | System Generated | string | Persona type (allowed-> [āPā]) |
c_ate | System Generated | integer | Creation timestamp (epoch) |
u_ate | System Generated | integer | Last update timestamp (epoch) |
gen | User Input | "M" | "F" | "O" | Gender (Refer below) |
dob | User Input | date | Date of birth |
fn | User Input | string | First name |
mn | User Input | string | Middle name |
ln | User Input | string | Last name |
ccd | User Input | string | Country code |
mobile | User Input | string | Mobile number (ccd + mobile -> E.164 format) |
email | User Input | string | Valid email address |
username | User Input | string | Unique user identifier like (UHID) |
s | User Input | string | Salutation (Refer below) |
bg | User Input | string | Blood group (Refer Below) |
abha | User Input | string | ABHA address |
arc | System Updated | boolean | Is profile archived |
Salutation Enums
Salutation Enums
Supported Salutations
- Dr
- Smt
Gender Enums
Gender Enums
Supported Genders
Enum | Gender |
---|---|
F | Female |
M | Male |
O | Others |
It enables seamless CRUD operations (Create, Read, Update, Archive(Delete)) on patient profiles, allowing you to integrate profile management into your applications with ease.
In addition, it offers search APIs to locate patient profiles using:
- Username (a unique patient identifier like UHID)
- Mobile number (without country code)
- Name (prefix-based search)
Search results are limited to a maximum of 100 records to ensure performance.
For detailed usage, refer to the following API documentation:
- Create Patient Profile API
- Retrieve Single Patient Profile API
- List Workspace Patients API
- Update Patient Profile API
- Archive Patient Profile API
- Search Patients API
These APIs are designed to be developer-friendly and quick to adopt. Follow the links above for request/response formats, examples, and error handling guidelines.
Usage Notes
- Ensure that all required fields are provided when adding or editing patient information.
- Use appropriate search criteria to narrow down patient records effectively.
- Handle sensitive patient data with care and comply with relevant privacy regulations.
- Currently, a patient can only be added in reference to a workspace. This automatically adds the patient profile to the workspace directory and allows searching at the workspace level.