Skip to main content
This guide is for employers and benefit teams. You authenticate as your employer group. Patients you create are scoped to that group — you only ever see your own. Before using this guide you need a sandbox and an access token. Request keys from Get API keys. How to send Authorization is in Authentication. Use synthetic data only on the initial sandbox. Listing imaging centers, searching or creating practices or law firms, and submitting an order-form-only referral may be off until Scan enables them for your account.

​
Submit

There are no employer-specific fields on POST /api/v2/referrals today. Create the patient and referral with Submit a medical referral.
  • Occupational injury — use the workers’ compensation payload in Workers’ compensation and payers (order_type: workers_comp, payer, claim_number).
  • Benefit / non-occupational imaging — use the default referral body in Submit a medical referral until a dedicated health-plan create schema exists.
Optional add-ons: Submit medical questions and Submit preferred times. Full intake: Submit for scheduling.

​
What you get back

GET /api/v2/referrals/{referral_id} returns line_of_business derived from how the referral was created (workers_comp for occupational injury). There is no separate employer line-of-business value.

​
Status changes

Every status, what it means, and how changes reach you are on Track referral status. Occupational referrals may wait on authorization before they book, the same as workers’ compensation, so expect pending_auth on the way to booked.