API Reference

Developer documentation for the ClinicalHIS REST API. Integrate your external systems or build custom clients.

Authentication

The API uses Bearer Token authentication. Include the JWT token returned from the login endpoint in the Authorization header of your requests.

Authorization: Bearer <your_jwt_token>

Base URL

All API requests should be prefixed with:

/api

Endpoints

GET/emr/patients

Retrieve a list of patients. Supports pagination and searching.

Parameters

  • page (number): Page number
  • limit (number): Items per page
  • search (string): Search by name or ID
POST/telemedicine/sessions

Create a new telemedicine session.

Body

{
  "patient_id": "uuid",
  "doctor_id": "uuid",
  "scheduled_at": "ISO-8601 string"
}
GET/patients/:id?format=fhirNew (R5)

Retrieve a patient in HL7 FHIR R5 format.

Example Response

{
  "resourceType": "Patient",
  "id": "123",
  "identifier": [...],
  "name": [{"family": "Doe", "given": ["John"]}]
}
GET/analytics/ai/risk-scoreAI Beta

Calculate real-time clinical risk scores (e.g., Sepsis, Readmission).

Parameters

  • patient_id (uuid): Target patient
  • risk_type (string): 'SEPSIS' | 'READMISSION'