Skip to main content

​
VitaClinic API

The VitaClinic API is a REST interface for clinics, telehealth brands, and EHR integrations. Use it to run the full patient → intake → order → fulfillment loop from your own front end, and to read your orders, patients, prescriptions, and catalog.
Not building a clinic integration? A pharmacy pushing fulfillment status uses the Pharmacy API; reps referring patients use the Rep → IDN referral guide.

​
Base URL

Every request is made over HTTPS and authenticated with a bearer API key:
There is no separate sandbox host — the same base URL serves both live and test traffic, and the key you send decides which. See Sandbox.

​
What you can do

Write endpoints (POST /patients, POST /intakes, POST /orders) are available to Vita Clinics only: the organization that owns the key must be an active Vita Clinic, and the key must carry the matching :write scope. Other connected organizations can read their own data.
All resource identifiers are UUIDs. The only exception is the sandbox, which returns synthetic identifiers such as sandbox_pat_….

​
The typical flow

1

Create a patient

POST /patients with your own external_patient_id (idempotent).
2

Submit an intake

POST /intakes capturing the patient’s screening responses.
3

Place an order

POST /orders for one or more catalog products, shipped to the patient.
4

Track fulfillment

Poll GET /orders/{id} or receive signed webhooks as the order is paid, shipped, and delivered.

​
Quick example

​
Where to go next

Quickstart

Run the full patient → intake → order loop against a test key in minutes.

Authentication

Bearer keys, scopes, and what a 401 or 403 looks like.

API Keys

How VitaRelay issues your key, what it can do, and how to rotate it.

Sandbox

Isolated testing with vr_test_ keys and a simulated order lifecycle.

REST API

Endpoint-by-endpoint reference with request and response shapes.

Webhooks

Signed order and intake events delivered to your endpoint.