Skip to main content
The HMIS API is versioned under /api/v1 and currently exposes 66 operations: 42 staff and integration operations, plus 24 patient-mobile operations. Protected operations use Laravel Sanctum bearer tokens. Select an endpoint to inspect its request and response schema, generate code examples, or try it against your configured HMIS API origin.
The playground targets the HMIS staging API. Never use real clinical data or paste a production token into a shared browser session.

​
Authentication

Staff and machine integrations use dedicated tokens created from the super-admin Integration API tokens page. The patient app receives a device token after completing phone-number OTP verification. Each protected endpoint requires the specific Sanctum ability shown in its reference. Tokens entered interactively in the playground are not stored in this documentation.

​
Reference sections

  • Staff workflows covers patient registration, appointments, outpatient visits, and clinical workspaces.
  • Patient mobile covers OTP access, the patient’s own profile, appointments, records, diagnostics, coverages, bills, and payments.
  • Foundation and integrations covers organization discovery and laboratory and radiology integrations.
Inpatient workflows remain part of the planned architecture but are not exposed in this phase.
Do not expose a production HMIS API directly to the public internet for playground testing. Use a protected staging or demo environment with sanitized data and HTTPS.