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

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
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
encounterid integer encounterid
Content-Type string Content type of the payload

❙ Request Body

Expand all
diagnosissnomedcode integer The SNOMED code for diagnosis this order is for.
facilityid integer The athena ID of the facility you want to send the order to. Get a localized list using /chart/configuration/facilities.
facilitynote string A note to send to the facility.
futuresubmitdate string The date the order should be sent. Defaults to today.
highpriority boolean If true, then the order should be sent STAT.
notetopatient string If this referral has a field for 'Notes to Patient' you may fill it in with this parameter. If the referral does not have this field available, this will error.
ordertypeid integer The athena ID of the referral type.
procedurecode string If this referral has a field for 'Procedure Code' you may fill it in with this parameter. If the referral does not have this field available, this will error.
providernote string An internal note for the provider or staff.
reasonforreferral string If this referral has a field for 'Reason for Referral' you may fill it in with this parameter. If the referral does not have this field available, this will error.
startdate string If this referral has a field for 'Start Date' you may fill it in with this parameter. If the referral does not have this field available, this will error.

Output 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
Try in Postman

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