Skip to content

Patients API Overview

The Patients API provides endpoints to manage patient information, medical records, and patient data.

Available Endpoints

API Reference

GET Endpoints

  • List Patients - GET /apis/v1/patients
  • Retrieve paginated list of patients
  • Supports filtering and search parameters
  • Get Insurance Cards - GET /apis/v1/insurance/cards
  • Retrieve insurance card information for a specific patient
  • Includes payer details, subscriber information, and card status

POST Endpoints

  • Create Patient - POST /apis/v1/patients
  • Create a new patient record

PUT Endpoints

  • Update Patient - PUT /apis/v1/patients/{patient_id}
  • Update existing patient information

DELETE Endpoints

  • Delete Patient - DELETE /apis/v1/patients/{patient_id}
  • Remove patient record

Response Format

All patient API responses follow the standard format:

Success Response

{
  "code": 2000,
  "data": { ... },
  "message": "Success"
}

Error Response

{
  "code": 4001,
  "message": "Error description"
}