API v1

Bring secure record handoffs into the workflow you already use.

Health Record Relay API v1 lets authorized healthcare organizations and integration partners initiate secure transfers, request and fulfill records, monitor lifecycle status, and receive signed webhook events without requiring staff to duplicate the workflow in another system.

Integration surface

One API around the record handoff lifecycle.

The API complements EHRs, clinical inboxes, referral platforms, imaging systems, and other healthcare software. It does not replace the source clinical system.

01

Transfers

Create transfers, upload records, apply existing consent controls, send securely, and monitor delivery status.

02

Record requests

Create organization-to-organization record requests and link fulfillment back to the secure transfer workflow.

03

Signed webhooks

Receive HMAC-SHA256 signed lifecycle events for transfers, files, and record requests with retry handling.

Built for integration operations

Predictable behavior for production systems.

API v1 uses scoped bearer credentials, organization isolation, idempotency controls, request correlation IDs, cursor pagination, rate limiting, and consistent JSON errors.

File uploads continue through Health Record Relay's existing scan-gated workflow, and webhook payloads are deliberately minimized so integrations do not receive unnecessary record content.

01
Scoped API keysGrant only the permissions an integration needs.
02
IdempotencySafely retry supported write operations without creating duplicate work.
03
Request IDsCorrelate calls across partner systems and Health Record Relay support.
04
Cursor paginationMove through growing transfer, request, event, and webhook collections.
05
Signed eventsVerify outbound webhook authenticity before processing.
06
Audit visibilityOperational events remain tied to the underlying handoff workflow.
Developer contract

Start from the machine-readable API contract.

The OpenAPI 3.1 document describes endpoints, authentication, scopes, request and response schemas, pagination, error behavior, idempotency, and webhook event envelopes.

Base URLhttps://healthrecordrelay.com/api/v1
AuthenticationBearer API key with organization-scoped permissions.
ContractOpenAPI 3.1 JSON
Integration access

Have an EHR, inbox, referral, imaging, or workflow system you want to connect?

We can work with pilot customers and software partners on a focused integration using API v1 and signed webhooks.

✓ Secure transfers
✓ Record requests
✓ Status tracking
✓ Signed webhooks
✓ Audit events
✓ Scoped credentials