You refer; an IDN doctor evaluates and prescribes. You never prescribe. Referrals require your org to be IDN-activated by VitaRelay, and a VitaClinic API key carrying the
rx:read / rx:write scopes.The flow
1
Add the patient
Add the patient you’re referring with
POST /patients — patients are
routed under the Internal Doctor Network automatically. (There is no
“practice” to create; that model is retired.)2
Send an intake
Send an intake link the patient completes. Referral is blocked until they submit it.
Live keys create real intakes and referrals; test keys run in sandbox.
3
Refer to the IDN
Push the patient to the IDN. An IDN doctor evaluates the intake and prescribes.
4
Track the request
Poll the patient’s Rx requests, or cancel a pending one.
Is this a separate API?
No. The referral endpoints (/rx/...) are part of the VitaClinic API — same base URL, same key. There are only two public APIs, depending on who prescribes:
Referring to the IDN uses the VitaClinic API — one key, one base URL (
https://vitarelay.com/api/public/v1). The /rx/... endpoints are just the referral part of that API.Access & scopes
Both also require your org to be IDN-activated. If it isn’t, endpoints return
403 idn_not_joined. Joining the IDN is arranged with VitaRelay — the API reports status but does not self-join.
Base URL
https://vitarelay.com/api/public/v1. See the API Reference in this section for every endpoint, request, and response.
