Skip to main content
POST
Submits an order form referral

Authorizations

Authorization
string
header
required

Authorization: Bearer <api_token>. Sandbox tokens come from Get API keys and allow 2,000 successful requests or 7 days. Failed 4xx/5xx responses do not consume the allowance. Production tokens are issued from the group's API access tab.

Body

application/json
referral_order
object
required

Response

referral order submitted

id
string<uuid>
required

Unique referral identifier

reference
string
required

Referral reference

status
enum<string>
required

Referral status

Available options:
pending,
completed
visits
object[]
required
referring_provider
string
required

Referring provider name

patient
object
required