Skip to main content
POST
Create Referral Order

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
auth_number
string | null
required
Maximum string length: 20
consultant_name
string | null
required
Maximum string length: 1024
date_for_reEval
string<date> | null
required
patient
integer<int64>
required
practice
integer<int64>
required
short_consultant_name
string | null
required
Maximum string length: 1024
specialty
object
required
authorization_for
enum<string> | null
Available options:
Consult (One Visit Only),
Procedure / Testing Only,
Referral For Treatment, includes Consult Visit
authorization_for_short
string | null
icd10_codes
object[]
resolution
object

Response

201 - application/json
auth_number
string | null
required
Maximum string length: 20
consultant_name
string | null
required
Maximum string length: 1024
date_for_reEval
string<date> | null
required
patient
integer<int64>
required
practice
integer<int64>
required
short_consultant_name
string | null
required
Maximum string length: 1024
specialty
object
required
authorization_for
enum<string> | null
Available options:
Consult (One Visit Only),
Procedure / Testing Only,
Referral For Treatment, includes Consult Visit
authorization_for_short
string | null
icd10_codes
object[]
id
integer
read-only
letter
integer<int64>
deprecated
read-only

The letter associated with this referral order. Use referral_letter for the full nested letter object.

referral_letter
object

Nested letter object with full details.

resolution
object
sign_date
string<date-time> | null
read-only

The datetime when this referral order was signed.

signed_by
integer
read-only

The ID of the user who signed this referral order.