​
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.
FieldSourceTypeDescription
oidSystem Generatedstringunique identifier
widSystem GeneratedstringWorkspace ID
psSystem GeneratedstringPersona type (allowed-> [“P”])
c_ateSystem GeneratedintegerCreation timestamp (epoch)
u_ateSystem GeneratedintegerLast update timestamp (epoch)
genUser Input"M" | "F" | "O"Gender (Refer below)
dobUser InputdateDate of birth
fnUser InputstringFirst name (mandatory if fln not provided)
mnUser InputstringMiddle name
lnUser InputstringLast name
flnUser Input.stringFull name (If not provided, derived as fn + mn + ln)
ccdUser InputstringCountry code
mobileUser InputstringMobile number (ccd + mobile -> E.164 format)
emailUser InputstringValid email address
usernameUser InputstringUnique user identifier like (UHID)
sUser InputstringSalutation (Refer below)
bgUser InputstringBlood group (Refer Below)
abhaUser InputstringABHA address
arcSystem UpdatedbooleanIs profile archived
Supported Genders
EnumGender
FFemale
MMale
OOthers
Supported Blood Groups
  • A+
  • A-
  • B+
  • B-
  • AB+
  • AB-
  • O+
  • O-
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: 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.