API docs by Redocly

IHD LabFlow — Legacy API (v1/v2) (2.27.2)

Download OpenAPI specification:

Overview

Deprecated partner paths. Use Partner API v3 for new work.

Also: v4 · all · home

Legacy API

v1/v2 partner paths (/inbox, /order, /kit, /v2/orders). Prefer Partner API (v3) for new integrations.

Cancel Order by ID Deprecated

Cancel an order by its order ID

Deprecated: use Partner API v3 (/v3/...) paths instead.

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

Clear the Inbox Deprecated

Clears all order identifiers from the inbox. Does not modify the orders themselves.

Deprecated: use Partner API v3 (/v3/...) paths instead.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
}

Create Kit Order Deprecated

Create an order for a kit

Deprecated: use Partner API v3 (/v3/...) paths instead.

Authorizations:
apiKey
Request Body schema: application/json
required
kitId
required
string [ 1 .. 50 ] characters
required
object
email
string <email>
firstName
string [ 1 .. 50 ] characters
middleName
string <= 50 characters
lastName
string [ 1 .. 50 ] characters
phone
string
object
object
Array of objects

Optional insurance information for the customer

Array
isPrimary
boolean

Indicates if this is the primary insurance

subscriberId
string

Insurance subscriber ID

relationToInsured
string

Relationship to the insured person

effectiveDate
string <date>

Insurance effective date

firstName
string

First name of the insured

lastName
string

Last name of the insured

dob
string <date>

Date of birth of the insured

groupNumber
string

Insurance group number

insuranceId
string

Insurance provider ID

payorName
string

Name of the insurance payor

object

Optional guarantor information for the patient

firstName
string

First name of the guarantor

lastName
string

Last name of the guarantor

relationship
string

Relationship to the patient. Can be either HL7 code or readable name. Valid HL7 codes are ASC, BRO, CGV, CHD, DEP, DOM, EMC, EME, EMR, EXF, FCH, FND, FTH, GCH, GRD, GRP, MGR, MTH, NCH, NON, OAD, OTH, OWN, PAR, SCH, SEL, SIB, SIS, SPO, TRA, UNK, WRD. Readable names include mother, father, spouse, self, sibling, etc.

dob
string <date>

Date of birth of the guarantor

gender
string
Enum: "M" "F"

Gender of the guarantor

phone
string

Phone number of the guarantor

object

Address of the guarantor

Array of objects

Optional diagnosis information for the order

Array
code
string

Diagnosis code (e.g., ICD-10)

description
string

Description of the diagnosis

system
string

Coding system used (e.g., ICD-10-CM)

type
string
Enum: "A" "F" "W"

Diagnosis type. A = Admitting, F = Final, W = Working

diagnosisDate
string <date>

Date of diagnosis

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Create Lab Order Deprecated

Create a lab order directly

Deprecated: use Partner API v3 (/v3/...) paths instead.

Authorizations:
apiKey
query Parameters
test
string

Instantly populates mock order results when set to true Only valid in the staging environment.

Note: Only valid in the staging environment. Will return an error in production.

testType
string
Enum: "RECEIVED" "REJECTED" "RESULTED"

Works when coupled with test; the type of results to populate.

Note: Only valid in the staging environment. Will return an error in production.

Request Body schema: application/json
required
kitId
required
string
externalId
string

An id managed by the partner for this specific object type

dateRegistered
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$
required
object
firstName
string
middleName
string
lastName
string
email
string
phone
string
dob
string <date> ^\d{4}-\d{2}-\d{2}$
gender
string
Enum: "Male" "Female" "Unknown"
object
Array of objects

Optional insurance information for the patient

Array
isPrimary
boolean

Indicates if this is the primary insurance

subscriberId
string

Insurance subscriber ID

relationToInsured
string

Relationship to the insured person

effectiveDate
string <date>

Insurance effective date

firstName
string

First name of the insured

lastName
string

Last name of the insured

dob
string <date>

Date of birth of the insured

groupNumber
string

Insurance group number

insuranceId
string

Insurance provider ID

payorName
string

Name of the insurance payor

object

Optional guarantor information for the patient

firstName
string

First name of the guarantor

lastName
string

Last name of the guarantor

relationship
string

Relationship to the patient. Can be either HL7 code or readable name. Valid HL7 codes are ASC, BRO, CGV, CHD, DEP, DOM, EMC, EME, EMR, EXF, FCH, FND, FTH, GCH, GRD, GRP, MGR, MTH, NCH, NON, OAD, OTH, OWN, PAR, SCH, SEL, SIB, SIS, SPO, TRA, UNK, WRD. Readable names include mother, father, spouse, self, sibling, etc.

dob
string <date>

Date of birth of the guarantor

gender
string
Enum: "M" "F" "U"

Gender of the guarantor (M=Male, F=Female, U=Unknown)

phone
string

Phone number of the guarantor

object

Address of the guarantor

Array of objects

Optional diagnosis information for the order

Array
code
string

Diagnosis code (e.g., ICD-10)

description
string

Description of the diagnosis

system
string

Coding system used (e.g., ICD-10-CM)

type
string
Enum: "A" "F" "W"

Diagnosis type. A = Admitting, F = Final, W = Working

diagnosisDate
string <date>

Date of diagnosis

object (OrderingProvider)
npi
required
string^[0-9]{10}$

Entity Type 1 NPI

first_name
required
string [ 1 .. 255 ] characters
middle_name
string [ 1 .. 255 ] characters
last_name
required
string [ 1 .. 255 ] characters
suffix
string [ 1 .. 50 ] characters
credential
string [ 1 .. 20 ] characters
external_provider_id
string [ 1 .. 255 ] characters

Partner-network provider ID (e.g. PWN provider ID). Scoped uniqueness per system + org.

provider_authorized_at
string <date-time>

When the provider authorized this order. ISO 8601 with timezone. Must not be more than 7 days in the future. Defaults to order creation time if not provided.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete an Inbox Order by ID Deprecated

Removes one order identifier from the inbox. Does not modify the order.

Deprecated: use Partner API v3 (/v3/...) paths instead.

Authorizations:
apiKey
path Parameters
id
required
string

Order ID

Responses

Response samples

Content type
application/json
{
}

Get All Kits Deprecated

Get all of the active configured kits and their associated details

Deprecated: use Partner API v3 (/v3/...) paths instead.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
[
]

Get Inbox Deprecated

Returns order identifiers in the inbox that may require partner attention.

Deprecated: use Partner API v3 (/v3/...) paths instead.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
[
]

Get Kit by ID Deprecated

Get a specific kit and its details by kit ID

Deprecated: use Partner API v3 (/v3/...) paths instead.

Authorizations:
apiKey
path Parameters
id
required
string

Unique identifier for a kit

Responses

Response samples

Content type
application/json
{
}

Get Order by ID Deprecated

Get a specific order by its order ID

Deprecated: use Partner API v3 (/v3/...) paths instead.

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
Example
{
}

Get Orders Deprecated

Get all orders for the organization

Deprecated: use Partner API v3 (/v3/...) paths instead.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
[
]

Get Orders V2 Deprecated

Get all orders for the organization with support for pagination and query param based filter support

Deprecated: use Partner API v3 (/v3/...) paths instead.

Authorizations:
apiKey
query Parameters
orderNo
string

Returns orders that have the specified Order No.

email
string <email>

Returns orders that have the specified email as customer email within order.

registrationCode
string

Returns orders that have the specified Registration Code.

orderType
string
Enum: "KIT" "LAB"

Returns orders that have the specified Order Type.

orderStatus
string
Enum: "NEW" "PENDING_DELIVERY" "IN_TRANSIT" "OUT_FOR_DELIVERY" "DELIVERED" "DELIVERED_TO_PARTNER" "DELIVERY_FAILED" "DELIVERY_ERROR" "CANCELATION_REQUESTED" "CANCELLED" "REGISTERED" "RECEIVED" "PROCESSING" "RESULTED"

Returns orders that have the specified Order Status.

kitId
string

Returns orders that are created using the specified Kit Id, should follow kit-0c05f7a3-4056-4ce8-a738-b8b19bab619c format

externalId
string

Returns orders that have the specified External Id.

shipmentTrackingCode
string

Returns orders that have the specified Shipment Tracking Code.

returnShipmentTrackingCode
string

Returns orders that have the specified Return Shipment Tracking Code.

sortBy
string
Enum: "dateCreated" "dateLastUpdated"

Sort the responses by a set value.

sortDir
string
Enum: "asc" "desc"

Sets the direction of the sort order.

page
integer

Page number. If not provided defaults to 1.

pageSize
integer

Page size. If not provided defaults to 10.

dateCreatedStart
string <date-time>

Returns orders created on or after the specified dateCreated. Should follow ISO 8601 format as 2023-06-10T00:00:00.000Z

dateCreatedEnd
string <date-time>

Returns orders created on or before the specified dateCreated. Should follow ISO 8601 format as 2023-06-10T00:00:00.000Z

dateRegisteredStart
string <date-time>

Returns orders registered on or after the specified dateRegistered. Should follow ISO 8601 format as 2023-06-10T00:00:00.000Z

dateRegisteredEnd
string <date-time>

Returns orders registered on or before the specified dateRegistered. Should follow ISO 8601 format as 2023-06-10T00:00:00.000Z

dateCanceledStart
string <date-time>

Returns orders canceled on or after the specified dateCanceled. Should follow ISO 8601 format as 2023-06-10T00:00:00.000Z

dateCanceledEnd
string <date-time>

Returns orders canceled on or before the specified dateCanceled. Should follow ISO 8601 format as 2023-06-10T00:00:00.000Z

dateCollectedStart
string <date-time>

Returns orders collected on or after the specified dateCollected. Should follow ISO 8601 format as 2023-06-10T00:00:00.000Z

dateCollectedEnd
string <date-time>

Returns orders collected on or before the specified dateCollected. Should follow ISO 8601 format as 2023-06-10T00:00:00.000Z

dateResultedStart
string <date-time>

Returns orders resulted on or after the specified dateResulted. Should follow ISO 8601 format as 2023-06-10T00:00:00.000Z

dateResultedEnd
string <date-time>

Returns orders resulted on or before the specified dateResulted. Should follow ISO 8601 format as 2023-06-10T00:00:00.000Z

dateLastUpdatedStart
string <date-time>

Returns orders last updated on or after the specified dateLastUpdated. Should follow ISO 8601 format as 2023-06-10T00:00:00.000Z

dateLastUpdatedEnd
string <date-time>

Returns orders last updated on or before the specified dateLastUpdated. Should follow ISO 8601 format as 2023-06-10T00:00:00.000Z

Responses

Response samples

Content type
application/json
{
}

Register Kit Deprecated

Register a kit that has been received by a customer. This will trigger the order to be sent to the lab.

Deprecated: use Partner API v3 (/v3/...) paths instead.

Authorizations:
apiKey
query Parameters
override
boolean

Use this flag as `true`` to override the patient details of already registered orders. This will not update order status.

test
string

Instantly populates mock order results when set to true.

Note: Only valid in the staging environment. Will return an error in production.

testType
string
Enum: "RECEIVED" "REJECTED" "RESULTED"

Works when coupled with test; the type of results to populate.

Note: Only valid in the staging environment. Will return an error in production.

Request Body schema: application/json
required
registrationCode
required
string
required
object
firstName
string
middleName
string
lastName
string
email
string
phone
string
dob
string <date> ^\d{4}-\d{2}-\d{2}$
gender
string
Enum: "Male" "Female" "Unknown"
object
Array of objects

Optional insurance information for the patient

Array
isPrimary
boolean

Indicates if this is the primary insurance

subscriberId
string

Insurance subscriber ID

relationToInsured
string

Relationship to the insured person

effectiveDate
string <date>

Insurance effective date

firstName
string

First name of the insured

lastName
string

Last name of the insured

dob
string <date>

Date of birth of the insured

groupNumber
string

Insurance group number

insuranceId
string

Insurance provider ID

payorName
string

Name of the insurance payor

object

Optional guarantor information for the patient

firstName
string

First name of the guarantor

lastName
string

Last name of the guarantor

relationship
string

Relationship to the patient. Can be either HL7 code or readable name. Valid HL7 codes are ASC, BRO, CGV, CHD, DEP, DOM, EMC, EME, EMR, EXF, FCH, FND, FTH, GCH, GRD, GRP, MGR, MTH, NCH, NON, OAD, OTH, OWN, PAR, SCH, SEL, SIB, SIS, SPO, TRA, UNK, WRD. Readable names include mother, father, spouse, self, sibling, etc.

dob
string <date>

Date of birth of the guarantor

gender
string
Enum: "M" "F" "U"

Gender of the guarantor (M=Male, F=Female, U=Unknown)

phone
string

Phone number of the guarantor

object

Address of the guarantor

Array of objects

Optional diagnosis information for the order

Array
code
string

Diagnosis code (e.g., ICD-10)

description
string

Description of the diagnosis

system
string

Coding system used (e.g., ICD-10-CM)

type
string
Enum: "A" "F" "W"

Diagnosis type. A = Admitting, F = Final, W = Working

diagnosisDate
string <date>

Date of diagnosis

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}