Skip to main content
POST
Search the orderable catalog
Catalog searches run asynchronously against the live EMR: a valid request returns immediately with a 202, and an order_catalog.searched webhook is sent with the results when the search completes. Use the item_id values from the results when creating an order via POST /v1/orders. Searching the order catalog is only supported for eClinicalWorks.

Request Parameters

Required Fields

  • type (string, required): Which catalog to search. One of lab, imaging, or procedure.

Optional Fields

  • query (string, optional): Name filter (prefix or substring). Omit to page the full catalog.
  • page (integer, optional): Page number (1-based). Defaults to 1.
  • page_size (integer, optional): Results per page. Defaults to 25.
  • callback_urls (string[], optional): URLs to receive the results webhook, in addition to the account webhook.

Example Request

Example Response

Webhook Notifications

When the search completes, we send an order_catalog.searched webhook to your registered endpoint:

Authorizations

client_id
string
header
required
client_secret
string
header
required
access_token
string
header
required

Body

application/json
type
enum<string>
required

Which orderable catalog to search.

Available options:
lab,
imaging,
procedure
Example:

"lab"

query
string

Name filter (prefix / substring). Omit to page the full catalog.

Example:

"glucose"

page
integer

Page number (1-based). Defaults to 1.

page_size
integer

Results per page. Defaults to 25.

callback_urls
string[]

URLs to receive the results webhook, in addition to the account webhook.

Response

Queued for processing

success
boolean
required
status
string
required
message
string
required
job_id
required