Sign in
latestOpenAPI 3.1.02026-08-0854104180.4 KB

f39a4bfeca8e

Prematch

List Prematch Orders

Get a list of all prematch orders.

get/orders/prematch/all

Headers

version-datavantstring

Version of the Orders API to use with this call

Version of the Orders API to use with this call

Response

Successful Response

uuidstring uuid4 required

Unique identifier for the object.

idstring required

User-provided identifier for the object.

  • Must be between 4 and 32 characters
  • Must contain only upper or lower-case alphanumeric characters, numbers, hyphens and/or underscores.
namestring

User-friendly name for the order.

type'attorney' | 'datavant' | 'disability' | 'continuing_care' | 'copya' | 'copyi' | 'facility' | 'government' | 'insurance' | 'patient' | 'payd' | 'payi' | 'pro' | 'fac' required

An enumeration.

statusstring required

Current status of the order.

created_atstring date-time required

The ISO8601 formatted timestamp for when the object was created.

roster_idstring

Roster ID for the order.

filenamestring

Roster file name.

total_queriesinteger required

Total queries for this order

created_bystring

User who created the order

retrieval_sourcesstring[]

Retrieval sources for the order

match_reasons_documentsobject

Map of match reason document types to their IDs