Lab Testing
Cancel Order
POST
/v3/order/{order_id}/cancel
x-vital-api-key*
Parameters
order_idRequired
string
Your Order ID.
Response
messageRequired
string
Message
statusRequired
string
Status
orderRequired
object
ClientFacingOrder
eventsRequired
array
statusRequired
string
An enumeration.
Available options:
received.walk_in_test.requisition_created
, completed.walk_in_test.order_completed
, failed.walk_in_test.sample_error
, received.testkit.ordered
, received.testkit.requisition_created
, collecting_sample.testkit.transit_customer
, collecting_sample.testkit.out_for_delivery
, collecting_sample.testkit.with_customer
, collecting_sample.testkit.transit_lab
, sample_with_lab.testkit.delivered_to_lab
, completed.testkit.completed
, failed.testkit.failure_to_deliver_to_customer
, failed.testkit.failure_to_deliver_to_lab
, failed.testkit.sample_error
, failed.testkit.lost
, cancelled.testkit.cancelled
, cancelled.testkit.do_not_process
created_atRequired
string
Created At
idRequired
integer
Id
updated_atRequired
string
When your order was last updated
created_atRequired
string
When your order was created
detailsRequired
Details
lab_testRequired
The Vital Test associated with the order
patient_addressRequired
Patient Address
patient_detailsRequired
Patient Details
team_idRequired
string
Your team id.
idRequired
string
The Vital Order ID
user_idRequired
string
User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api.
user_key
string
User key returned by vital create user key request. This key should be stored in your database against the user and used for all interactions with the vital api.
sample_id
string
Sample ID
notes
string
Notes associated with the order
status
string
An enumeration.
Available options:
received
, collecting_sample
, sample_with_lab
, completed
, cancelled
, failed
wheel_consult_id
string
Wheel Consult Id
physician
object
PhysicianClientFacing
npiRequired
string
Npi
last_nameRequired
string
Last Name
first_nameRequired
string
First Name