These are the steps to manage patient information using the Patient Directory API.

1

Search for Patients

This step is used to search for existing patients profiles in a business’ directory. You can use 10 digit mobile number to search for a patient.

Endpoint: GET {{HOST}}/v1/business/patients/search?mobile=

Description: Quickly locate patient records and retrieve relevant details.

2

Add a Patient

This step is used to add new patient records to a business’ directory.

Endpoint: POST {{HOST}}/v1/business/doctor/patient/add

Description: Provide necessary details such as personal information, contact details, and medical history to create a new patient profile.

Right now adding a patient is done in reference to a specific doctor, which automatically adds the patient to the business directory as well. Adding patient directly to a business is WIP and adding via doctor_id will be deprecated.
3

Edit Patient Details (WIP)

This step is used to update existing patient records in a doctor’s directory.

Endpoint: PUT {{HOST}}/v1/business/doctor/patient/edit

Description: Modify personal details, contact information, and other relevant data to ensure that the patient profile remains accurate and current.

​
Overview

The Patient Directory API is designed to manage patient information within a business’ directory. This API allows for searching, adding, and editing patient details in a specific doctor’s directory. It facilitates efficient patient management and ensures that all necessary information is up-to-date and easily accessible.

​
Main Actors

  • Patient: The individual whose information is being managed in the doctor’s directory. This includes personal details, contact information, medical history, and other relevant data.

​
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 doctor in a business. This automatically adds the patient to the business directory and allows searching at the business level.
Before you beginAdd Patient to Directory