Skip to main content
POST
Create lab requisition

Authorizations

Authorization
string
header
required

Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.

Scopes

laboratories:write
serviceToken
laboratories:write
userToken

Headers

Idempotency-Key
string

Recommended. A UUID your client generates once per intended order and reuses on every retry of that order. A retry under the same key for the same patient returns the original order with 201 instead of placing a second one. A key is not compared against the request body, so never reuse a key for a different order, and never drop the key on a retry: a request without a key does not match one sent with a key. Leading and trailing whitespace is trimmed. A key that is then empty, or longer than 200 characters, is not rejected: it is ignored, and the request is handled as if no key were sent.

Body

application/json
patient_id
string
required

The id of a patient in your organization, as returned by POST /v0.1/patients or GET /v0.1/patients. A patient outside your organization returns 404.

Required string length: 1 - 64
lab_test_ids
string<uuid>[]

1 to 20 lab test ids (UUIDs), provided by your OLH implementation contact for each environment. Always send this field: when it is omitted the order falls back to an environment default that is not specific to your organization, and where no default is configured the request returns 400.

Required array length: 1 - 20 elements
collection_method
enum<string> | null

How the sample is collected: walk_in_test (patient visits a lab draw site), testkit (kit mailed to the patient), at_home_phlebotomy, or on_site_collection. Optional: null, an empty string, or omitting the field all mean no collection method is sent with the order. Leave it out for tests that have a single collection method: the lab network uses that method, and rejects the order if one is sent. Send it only for tests that support more than one method; if the lab network rejects it, the request returns 400 with the order-rejected message.

Available options:
testkit,
walk_in_test,
at_home_phlebotomy,
on_site_collection,
null
passthrough
string | null

Optional correlation string of your own, up to 256 characters, stored with the order at the lab network. It is not returned in the response. Do not put patient information in it.

Maximum string length: 256
activate_by
string

Optional date (YYYY-MM-DD) on which the order should be activated, to schedule an order ahead of time. Omit it to activate the order immediately.

Pattern: ^\d{4}-\d{2}-\d{2}$

Response

Created

data
object
required
request_id
string
required