Order - Referral
The Order - Referral feature allows the user to create an order for a specific procedure or surgery. The Order - Referral Types Reference allows the user to review and view the types of referrals configured in the system.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Endpoints
- Primary
- Reference
Create new referral request
POST
/v1/{practiceid}/chart/encounter/{encounterid}/orders/referral
Creates a new referral request record
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
encounterid
integer
encounterid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput Parameters
Expand all
documentid
integer
The ID of the document created.
errormessage
string
If the operation failed, this will contain any error messages.
success
string
Whether the operation was successful.
Example Code
Get list of referral order-types
GET
/v1/{practiceid}/reference/order/referral
Retrieves a list of referrals types configured in the system
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
searchvalue
string
A term to search for. Must be at least 2 characters
Output Parameters
Expand all
name
string
The name of the order
ordertypeid
integer
The athena ID of the type of order
Example Code