●REST 3.1 & MCP Protocol Ready

HealOS Developer Platform

Programmatic APIs and autonomous agent toolkits for modern healthcare management. Connect clinical EHR records, real-time telemetry, scheduling engines, and diagnostic workflows.

↓ OpenAPI 3.1 Spec ⚡ MCP Manifest 🔒 Auth Guide

Quickstart in 60 Seconds

Probe the live HealOS gateway or inspect system health directly with cURL:

# 1. Probe the system health endpoint

curl -s https://healos-theta.vercel.app/api/v1/health | jq .

# 2. Query available clinical appointments

curl -s https://healos-theta.vercel.app/api/v1/appointments | jq .

Official Client SDKs

Pre-built typed SDKs for TypeScript, Python, and Go:

Node.js / TypeScriptnpm i @healos/sdk

Full TypeScript definitions, React hooks, and MCP client bindings.

Python (LangChain / CrewAI)pip install healos-sdk

Pydantic models, async telemetry client, and LangChain clinical tools.

Gogo get github.com/Zuhaib-dev/healos-go

High-performance hospital gateway client and WebSocket listener.

Model Context Protocol (MCP) & A2UI Generative UI

HealOS publishes a first-party MCP server at /.well-known/mcp supporting JSON-RPC 2.0 handshake, live SSE telemetry, and A2UI generative UI resources (ui://) for Claude Desktop, Cursor, and autonomous agent runtimes:

// claude_desktop_config.json

{
  "mcpServers": {
    "healos": {
      "url": "https://healos-theta.vercel.app/.well-known/mcp"
    }
  }
}

A2UI (Agent-to-UI) & MCP Apps Support

HealOS exposes in-agent interactive UI cards that agents can present directly to users without leaving the chat interface:

ui://healos/appointment-booking-form — Interactive date picker and clinician selector.
ui://healos/vitals-telemetry-monitor — Real-time continuous ECG, SpO2, and blood pressure graphs.
ui://healos/emergency-triage-board — Live Emergency Department triage board (ESI 1-5).
ui://healos/patient-search-card — Demographic master patient index summary.

OAuth 2.0 Scopes & Security

Granular OAuth permissions enforced across all clinical endpoints:

Scope	Description	Standard Roles
read:patients	Read demographic records and allergies	Doctor, Nurse, Admin
write:patients	Register or update patient profiles	Reception, Admin
read:appointments	Query scheduled consultation slots	All Authenticated
write:appointments	Book or cancel clinic appointments	Patient, Doctor, Reception
read:vitals	Access physiological vitals observations	Nurse, Doctor

⚠️RFC 8594 Sunset & Deprecation Policy

API Deprecation Policy

HealOS adheres strictly to semantic versioning and the IETF RFC 8594 standard. Changes to public REST and MCP contracts are governed by our stability commitments:

Guarantee Window24 Months Minimum Notice

All deprecated endpoints remain functional and supported for at least 24 months after deprecation notice.

Current Stable Versionv1 (Path Prefix: /api/v1)

Includes health, catalog, sandbox, appointments, patients, and vitals APIs.

Scheduled Sunset DateDecember 31, 2027

Responses include Sunset: Fri, 31 Dec 2027 23:59:59 GMT and Deprecation headers.

When an endpoint is marked for deprecation, HealOS automatically includes the standard HTTP Sunset and Link: <https://healos-theta.vercel.app/developers#deprecation>; rel="deprecation" headers.

Migration documentation and version release notes are continuously mirrored at /developers and /openapi.json.

AI Coding Agent Configurations

Official workspace rules and instruction sets for Claude Code, Cursor, and Windsurf are published in our open-source repository:

Claude Code Rules.claude/CLAUDE.md Cursor Rules.cursorrules Windsurf Rules.windsurfrules

📦 Explore Full GitHub Repository: github.com/Zuhaib-dev/HealOS →

Architecture & Engineering

Zuhaib Rashid

Full Stack Developer & Healthcare Systems Architect

Lead architect of HealOS clinical workflows, WebSocket telemetry, and autonomous MCP integration.

🌐 Portfolio ✉️ zuhaibrashid01@gmail.com