API Reference

Submit a lab order

post
https://labs-api.zapehr.com/v1/submit

Submit a lab order. Oystehr's Submit Lab feature allows users to submit an order consisting of one or more well-configured ServiceRequests to an external lab. In order to successfully submit an order, a Route to and Organization representing that lab must exist. If the lab requires its own requisition document (eReq) or an Advance Beneficiary Notice (ABN), the appropriate DocumentReferences will be included in the response.

Access Policy Requirements:
Action: Lab:SubmitOrder
Access Policy Resource: Lab:Order

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Provided by the lab, indicates a financial relationship between the lab and the customer.

required

Reference to a valid ServiceRequest FHIR resource representing an order. See Submit Lab for more details.

string
length ≤ 20

A client-provided string used to identify all tests in an order. See Submit Lab for more details.

boolean
Defaults to false

Flag to indicate which patient ID to transmit on the lab order. Defaults to false, instead using the Patient resource's UUID. If set to true but no friendly ID is found, throws a 400 error. See Friendly Patient ID for more information on the friendly ID. See Submit Lab for more information on submitting using the friendly ID.

Responses

Updated 10 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago