For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Health Swagger (/docs)

Overview
- Introduction
API Reference

Introduction
Health Check
Liveness
Readiness
Create a canonical Pydantic model from field definitions
Validate a patient event and return the generated HL7 message
Get the JSON Schema for PatientEvent
Convert a canonical patient event into an HL7 v2.x ADT message
Convert a patient event into HL7 messages for all supported versions
Build a patient ADT message and send it over URL or TCP/IP
Apply rule_templates to a raw HL7 message
Queue the posted JSON payload for async delivery via Fusion

Health Swagger (/docs)

Readiness

GET

https://host.com/health/ready

GET

/health/ready

$ curl https://host.com/health/ready

Readiness probe for whether the service can handle traffic. Returns 503 when critical dependencies are unavailable.

Response

Successful Response

Was this page helpful?

Create a canonical Pydantic model from field definitions