Skip to main content

Installation

Or, if using source:
You can find the package on npm.

Quick Start


Patient Operations

Create Patient

Required Fields

  • oid – Unique identifier
  • wid – Workspace ID
  • gen – Gender (M | F | O)
  • dob – Date of birth (YYYY-MM-DD)
  • At least one name field (fn, mn, ln, or fln)
Other available fields:
You can include any of the following fields while creating a patient profile:
  • s Salutation
  • mobile – Mobile number (digits only)
  • ccd – Country code (e.g., “+91”)
  • email – Email address
  • username – Username
  • bg – Blood group
  • abha – ABHA address
  • is_age - Field to indicate whether dob was derived from age ​

Example Request

Sample Response


Get Patient

Example Request

Sample Response


Update Patient

Updatable Fields:
You can update any of the following fields for a patient profile:
  • fn – First name
  • mn – Middle name
  • ln – Last name
  • fln – Full name
    (At least one name field (fn, mn, ln, or fln) must be present if updating the name)
  • gen – Gender (M | F | O)
  • dob – Date of birth (YYYY-MM-DD)
  • mobile – Mobile number (digits only)
  • ccd – Country code (e.g., “+91”)
  • email – Email address
  • username – Username
  • bg – Blood group
  • abha – ABHA address
  • is_age - Field to indicate whether dob was derived from age
  • s Salutation

Example Request

Sample Response


Delete Patient

Example Request

Sample Response


Bulk Get

Example Request

Sample Response


Search Operations

Get by Username

Example Request

Sample Response

Search by Mobile

Example Request

Sample Response

Example Request

Sample Response


Utility Operations

Remove Fields

Example Request

Sample Response

Validate Patient Data

Example Request

Sample Response


Data Types

Gender

Blood Groups

Patient Interface


Error Handling

Example Request

Sample Error Response