Update Referral Order

These endpoints allow the user to close or reopen a referral order. When reopening a referral order, the status will be returned to SUBMIT.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Closes a referral order

PUT
/v1/{practiceid}/patients/{patientid}/documents/orders/referral/{referraldocumentid}/close
Closes a referral order
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

referraldocumentid integer referraldocumentid
practiceid integer practiceid
patientid integer patientid
Content-Type string Content type of the payload

❙ Request Body

Expand all
actionreasonid integer ID of the document action reason.

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code

Reopens a closed referral order

PUT
/v1/{practiceid}/patients/{patientid}/documents/orders/referral/{referraldocumentid}/reopen
Reopens a closed referral order
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

referraldocumentid integer referraldocumentid
practiceid integer practiceid
patientid integer patientid
Content-Type string Content type of the payload

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code