API docs by Redocly

IHD LabFlow (2.27.2)

Download OpenAPI specification:

Overview

LabFlow is IHD’s diagnostics platform for partner integrations. Use REST with your organization API key in the x-api-key header. This reference documents Partner API v3 (default), Partner API v4 (opt-in), and legacy v1/v2 paths.

In this document

Section Jump
Workflows Kit vs lab
v3 vs v4 Versions
Migration v3 → v4
Auth Authentication
v4 models All v4 models

Partner API v4 models

JSON shapes for Partner API v4 requests, responses, and webhook payloads (FHIR-aligned field names). Each row links to the full schema definition.

Model Reference
Address Address
CodeableConcept CodeableConcept
Coding Coding
Condition Condition
ContactPoint ContactPoint
Coverage Coverage
CreateKitOrderRequest CreateKitOrderRequest
CreateLabOrderRequest CreateLabOrderRequest
CreateWebhookEndpointRequest CreateWebhookEndpointRequest
CreateWebhookEndpointResponse CreateWebhookEndpointResponse
DiagnosticReport DiagnosticReport
DocumentReference DocumentReference
HumanName HumanName
Identifier Identifier
LabWork LabWork
Observation Observation
OrderStatusChangedEventData OrderStatusChangedEventData
PagePagination PagePagination
PartnerEventListResponse PartnerEventListResponse
PartnerEventLogEntry PartnerEventLogEntry
PartnerEventType PartnerEventType
PartnerOrder PartnerOrder
PartnerOrderCancellation PartnerOrderCancellation
PartnerOrderExtension PartnerOrderExtension
PartnerOrderListResponse PartnerOrderListResponse
PartnerOrderSummary PartnerOrderSummary
PatchWebhookEndpointRequest PatchWebhookEndpointRequest
Patient Patient
Practitioner Practitioner
PractitionerListItem PractitionerListItem
PractitionerListResponse PractitionerListResponse
PractitionerQualification PractitionerQualification
ProviderIdentifierRow ProviderIdentifierRow
ProviderOrganizationRole ProviderOrganizationRole
Quantity Quantity
ServiceRequest ServiceRequest
ServiceRequestRequester ServiceRequestRequester
Specimen Specimen
SupplyDelivery SupplyDelivery
SupplyDeliveryExtension SupplyDeliveryExtension
TestWebhookResponse TestWebhookResponse
V3CreateOrderResponse V3CreateOrderResponse
WebhookDelivery WebhookDelivery
WebhookDeliveryListResponse WebhookDeliveryListResponse
WebhookEndpoint WebhookEndpoint
WebhookEndpointListResponse WebhookEndpointListResponse
WebhookEvent WebhookEvent

Partner workflows

Scenario Start here
IHD ships kits to patients Create kit order (v3) or v4 kit create
Partner supplies the kit Create lab order (v3) or v4 lab create
Ordering clinician on lab orders List providers (v3) / Practitioners (v4)

Partner API versions

Version Base path Notifications Recommended for
v3 (default) /v3/... Inbox polling (GET /v3/inbox) plus REST Current production integrations
v4 (opt-in) /v4/partner/... HTTPS webhooks and optional GET /v4/partner/events for replay FHIR-aligned payloads and event-driven delivery

The same x-api-key applies to both versions; organization context is shared. Notification state is not shared—v4 does not read v3 inbox flags. Partner API v4 returns 403 with PARTNER_V4_NOT_ENABLED until IHD enables v4 for your organization.

Use the docs home to open v3, v4, legacy, or the combined reference.

Migrating from v3 inbox to v4 webhooks

Today — v3 (poll)

Step Partner LabFlow
1 GET /v3/inbox Returns order ids that need attention
2 GET /v3/orders/{id} Returns full order payload

Target — v4 (push)

Step Partner LabFlow
1 POST /v4/partner/webhooks/endpoints Register HTTPS URL; receive signingSecret once
2 (listen) Signed HTTPS POST (for example order.resulted)
3 (optional) GET /v4/partner/events Replay or reconcile the same event envelopes

Cutover checklist

Step Action
1 Contact your IHD account team to enable Partner API v4.
2 Implement a webhook receiver (verify HMAC and timestamp skew ≤ 5 minutes).
3 Register endpoint(s) under /v4/partner/webhooks/endpoints.
4 Map v3 order JSON to v4 PartnerOrderSummary (FHIR field names).
5 Run v3 inbox and v4 webhooks in parallel until cutover; use GET /events to reconcile gaps.

Authentication

LabFlow authenticates partners with API keys issued per organization. Send the key on every request in the x-api-key header.

Active partners can manage keys in the IHD admin portal. Contact daas.support@ihdlab.com for portal access or a staging key.

Code samples

Reference implementation:

Common questions

Q: How do I get my API key?

A: During onboarding, IHD provides a one-time token URL. Open it once in a browser or REST client; the response contains your API key. After the token is consumed, the URL returns 404. Use a clean browser profile or a tool such as Postman or Insomnia so extensions do not consume the token unintentionally.

Q: Why do mocked results look different than I expect?

A: Result and rejection payloads depend on your configured test panel. IHD can tailor staging mocks after your kit is configured; until then, generic sample payloads illustrate field names and structure.

apiKey

Security Scheme Type: API Key
Header parameter name: x-api-key

Partner API v4 (detail)

Partner API v4 with HL7 FHIR R4–aligned JSON field names. Available when IHD enables v4 for your organization (same x-api-key as v3). v3 and v4 can run in parallel during migration.

Notifications: Register webhooks for push delivery. GET /events replays the same envelopes from your organization's event log—use for reconciliation, not as a substitute for webhooks in steady state.

Webhook verification: every webhook is a POST with a JSON body (the WebhookEvent envelope) and these headers:

Header Value
X-LabFlow-Event-Id Event id (UUID). The same event can arrive more than once (e.g. after a retry) — use this to de-duplicate.
X-LabFlow-Timestamp Unix time in seconds when this attempt was signed.
X-LabFlow-Signature v1,<hex> where <hex> is HMAC-SHA256 of {X-LabFlow-Timestamp}.{rawBody} keyed with your endpoint's signing secret.
X-LabFlow-Api-Version Partner API version of the payload.

Verify against the raw request body before parsing it, compare signatures in constant time, and reject timestamps far from your clock (e.g. more than 5 minutes) to prevent replay.

Delivery and retries: respond with any 2xx within 30 seconds to acknowledge. Anything else (non-2xx, timeout, connection error) is retried after roughly 5 min, 15 min, 1 h, 4 h, then every 12 h, up to 10 attempts in total, after which the delivery is marked failed. Deliveries to an endpoint that has been disabled or deleted are marked aborted. Track outcomes with GET /webhooks/deliveries; replay missed events with GET /events.

Endpoints: webhook URLs must use https://. If subscribedEvents is omitted on create, the endpoint is subscribed to order.status.changed, order.resulted and order.cancelled.

Published paths are prefixed /v4/partner on the same base URLs as Partner API v3.

Inbox

Poll for order identifiers with new partner-relevant activity (for example, results or status changes).

Integrations typically poll on a regular schedule (for example, every 30–60 minutes) in production.

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
{
}

Clear the Inbox (V3)

Clears all order identifiers from the inbox. Underlying orders are unchanged; use after you have processed pending updates.

Authorizations:
apiKey

Responses

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
{
}

Delete an Inbox Order by ID (V3)

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

Authorizations:
apiKey
path Parameters
id
required
string

Order ID

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 Inbox (V3)

Returns order identifiers currently in your organization's inbox—orders with updates that may require partner action. Pair with GET /v3/order/{id} for full detail.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
[
]

Get Paginated Inbox (V3)

Returns inbox orders with pagination, sorted by dateLastUpdated descending. Defaults to page 1 with page size 100.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1

Page number. Defaults to 1.

pageSize
integer
Default: 100

Number of orders per page. Defaults to 100.

Responses

Response samples

Content type
application/json
{
}

Kit

Kits configured for your organization—catalog metadata, panels, and fulfillment attributes.

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 All Kits (V3)

Lists active kits configured for your organization, including SKU, panel, and fulfillment details.

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 Kit by ID (V3)

Returns a single kit by LabFlow kit identifier.

Authorizations:
apiKey
path Parameters
id
required
string

Unique identifier for a kit

Responses

Response samples

Content type
application/json
{
}

Order

Create and manage kit and lab orders, retrieve status, register specimens, and cancel when supported.

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
{
}

Cancel Order by ID (V3)

Requests cancellation of an order when the workflow and status allow it.

Authorizations:
apiKey
path Parameters
id
required
string

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 Kit Order (V3)

Creates a kit fulfillment order (IHD ships collection materials to the patient or recipient).

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
{
}

Create Lab Order (V3)

Creates a lab order when your organization supplies the kit or specimen workflow. Include ordering provider details where required.

Authorizations:
apiKey
query Parameters
test
string

Instantly populates mock order results when set to true.

Note: Only valid in the staging environment.

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

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

Note: Only valid in the staging environment.

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
{
}

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 Order by ID (V3)

Returns the full order record for a LabFlow order identifier.

Authorizations:
apiKey
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

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
{
}

Get Orders V3

Lists orders for your organization with optional filters and pagination.

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 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. Defaults to 1.

pageSize
integer

Page size. Defaults to 10.

dateCreatedStart
string <date-time>

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

dateCreatedEnd
string <date-time>

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

dateRegisteredStart
string <date-time>

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

dateRegisteredEnd
string <date-time>

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

dateCanceledStart
string <date-time>

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

dateCanceledEnd
string <date-time>

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

dateCollectedStart
string <date-time>

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

dateCollectedEnd
string <date-time>

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

dateResultedStart
string <date-time>

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

dateResultedEnd
string <date-time>

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

dateLastUpdatedStart
string <date-time>

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

dateLastUpdatedEnd
string <date-time>

Returns orders last updated on or before the specified dateLastUpdated. ISO 8601 format: 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
{
}

Register Kit (V3)

Records patient kit registration or specimen receipt and advances eligible orders toward laboratory processing.

Authorizations:
apiKey
query Parameters
override
boolean

Use 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.

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

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

Note: Only valid in the staging environment.

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
{
}

Provider

Ordering clinicians (NPI) linked to your organization and locations. Used to record the ordering provider on lab orders for regulatory and billing compliance.

List Providers (V3)

Lists ordering providers for your organization with optional status filter and pagination.

Authorizations:
apiKey
query Parameters
org_id
string

Filter providers by organization ID. Defaults to the API key's organization.

active_status
string
Enum: "ACTIVE" "INACTIVE" "RETIRED"

Filter by provider active status.

page
integer
Default: 1
limit
integer <= 100
Default: 20

Responses

Response samples

Content type
application/json
{
}

Partner v4 — Events

Organization event log with the same payloads as webhooks. For replay and reconciliation—not a v3-style inbox. Requires webhook-management permission.

Paginated webhook outbox / event log

Same JSON envelopes as webhook POSTs (payload), newest first. Use for reconciliation after outages—not as a substitute for v3 inbox polling. Requires the orders permission on the API key.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1
limit
integer <= 100
Default: 25

Responses

Response samples

Content type
application/json
{
}

Partner v4 — Orders

FHIR-aligned order list, retrieve, and kit/lab create. Same API key as v3; organization must have Partner API v4 enabled.

Create kit fulfillment order

Creates a kit fulfillment order. Response includes { id, success }; call GET /orders/{orderId} for the full PartnerOrder resource.

Authorizations:
apiKey
Request Body schema: application/json
required
required
object (ServiceRequest)

FHIR ServiceRequest (placer order / requisition)

Array of objects (Identifier)
status
string
intent
string
Value: "order"
object (CodeableConcept)
authoredOn
string <date-time>
object (ServiceRequestRequester)
required
object (Patient)

FHIR R4 Patient (partner profile)

Array of objects (Identifier)
Array of objects (HumanName)
Array of objects (ContactPoint)
gender
string
Enum: "male" "female" "unknown" "other"
birthDate
string <date>
Array of objects (Address)
object (Specimen)
Array of objects (Identifier)
object
receivedTime
string <date-time>
object (Identifier)
object (PartnerOrderExtension)
object or null
object

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Create lab order

Creates a lab order. Set the ordering clinician on serviceRequest.requester (NPI and name).

Authorizations:
apiKey
Request Body schema: application/json
required
required
object (ServiceRequest)

FHIR ServiceRequest (placer order / requisition)

Array of objects (Identifier)
status
string
intent
string
Value: "order"
object (CodeableConcept)
authoredOn
string <date-time>
object (ServiceRequestRequester)
required
object (Patient)

FHIR R4 Patient (partner profile)

Array of objects (Identifier)
Array of objects (HumanName)
Array of objects (ContactPoint)
gender
string
Enum: "male" "female" "unknown" "other"
birthDate
string <date>
Array of objects (Address)
object (Specimen)
Array of objects (Identifier)
object
receivedTime
string <date-time>
object (Identifier)
object (PartnerOrderExtension)
object or null
object

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get order

Returns PartnerOrder with PHI slices when expand includes patient/recipient.

Authorizations:
apiKey
path Parameters
orderId
required
string
query Parameters
expand
string

Responses

Response samples

Content type
application/json
{
}

List orders (PartnerOrderSummary)

Paginated orders for the API key's organization. Use expand for optional FHIR slices.

Authorizations:
apiKey
query Parameters
page
integer >= 1
Default: 1
pageSize
integer <= 100
Default: 25
filter[status]
string
expand
string

Comma-separated e.g. patient,recipient,observations,partnerMetadata

Responses

Response samples

Content type
application/json
{
}

Partner v4 — Practitioners

Ordering clinicians (NPI) for your organization, aligned with Partner API v3 provider data.

List ordering providers for the organization

Providers linked to your organization (the API key's org). Any org_id query parameter is ignored. Requires the orders permission on the API key.

Authorizations:
apiKey
query Parameters
page
integer
Default: 1
limit
integer <= 100
Default: 20
active_status
string
Enum: "ACTIVE" "INACTIVE" "RETIRED"
q
string

Responses

Response samples

Content type
application/json
{
}

Partner v4 — Webhooks

Register HTTPS endpoints, rotate signing secrets, and inspect delivery attempts.

Create webhook endpoint

Returns signingSecret once; store it securely.

Authorizations:
apiKey
Request Body schema: application/json
required
url
required
string <uri>

Must start with https://.

description
string
enabled
boolean
Default: true
payloadTier
string
Default: "summary"
Enum: "summary" "standard" "full"

Accepted and stored for future use. Every webhook currently carries the summary payload without patient/recipient details, regardless of this value.

includeSubject
boolean
Default: false

Accepted and stored for future use; not applied to payloads yet.

subscribedEvents
Array of strings (PartnerEventType)
Items Enum: "webhook.test" "order.created" "order.registered" "order.status.changed" "order.shipment.updated" "order.received" "order.rejected" "order.resulted" "order.cancelled" "order.documents.available"

Omit (or send an empty array) to subscribe to the defaults: order.status.changed, order.resulted, order.cancelled.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Get webhook endpoint metadata

Authorizations:
apiKey
path Parameters
endpointId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
}

List deliveries

Delivery attempts for your organization's endpoints, newest first, including the payload that was sent.

Authorizations:
apiKey
query Parameters
endpointId
string <uuid>

Only deliveries to this endpoint.

page
integer >= 1
Default: 1
limit
integer <= 100
Default: 25

Responses

Response samples

Content type
application/json
{
}

List webhook endpoints

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
}

Rotate HMAC signing secret

Authorizations:
apiKey
path Parameters
endpointId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
}

Send webhook.test event

Records a webhook.test event and delivers it to this endpoint only (with the usual retries). Use the returned eventId with GET /webhooks/deliveries to see the outcome.

Authorizations:
apiKey
path Parameters
endpointId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
}

Soft-delete webhook endpoint

Authorizations:
apiKey
path Parameters
endpointId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
}

Update webhook endpoint

Authorizations:
apiKey
path Parameters
endpointId
required
string <uuid>
Request Body schema: application/json
url
string <uri>

Must start with https://.

description
string
enabled
boolean
payloadTier
string
Enum: "summary" "standard" "full"

Accepted and stored for future use. Every webhook currently carries the summary payload without patient/recipient details, regardless of this value.

includeSubject
boolean

Accepted and stored for future use; not applied to payloads yet.

subscribedEvents
Array of strings (PartnerEventType)
Items Enum: "webhook.test" "order.created" "order.registered" "order.status.changed" "order.shipment.updated" "order.received" "order.rejected" "order.resulted" "order.cancelled" "order.documents.available"

Replaces the full subscription list when provided.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Partner v4 — Models

FHIR-aligned JSON shapes for v4 (listed under this group in the sidebar).

Kit

kitId
string

The unique IHD identifier for this kit

panelId
string

IHD's panel identifier used for this kit

externalId
string

An id managed by the partner for this specific object type

name
string

A human-readable kit name in plain text

description
string or null

A description of the kit in plain text

sku
string
stoplight: {"id":"xerfzu4bnq8rc"}
{
}

Kits

Array
kitId
string

The unique IHD identifier for this kit

panelId
string

IHD's panel identifier used for this kit

externalId
string

An id managed by the partner for this specific object type

name
string

A human-readable kit name in plain text

description
string or null

A description of the kit in plain text

sku
string
stoplight: {"id":"xerfzu4bnq8rc"}
[
]

KitV3

kitId
string

The unique IHD identifier for this kit

panelId
string

IHD's panel identifier used for this kit

externalId
string

An id managed by the partner for this specific object type

name
string

A human-readable kit name in plain text

description
string or null

A description of the kit in plain text

sku
string
stoplight: {"id":"xerfzu4bnq8rc"}
orgId
string

The organization ID this kit belongs to

locationId
string

The location ID associated with this kit

showHivConsent
boolean

Whether HIV consent is required for this kit

object

Physical dimensions and weight of the kit parcel

height
string
length
string
weight
string
width
string
isActive
boolean

Whether this kit is currently active

{
}

KitsV3

Array
kitId
string

The unique IHD identifier for this kit

panelId
string

IHD's panel identifier used for this kit

externalId
string

An id managed by the partner for this specific object type

name
string

A human-readable kit name in plain text

description
string or null

A description of the kit in plain text

sku
string
stoplight: {"id":"xerfzu4bnq8rc"}
orgId
string

The organization ID this kit belongs to

locationId
string

The location ID associated with this kit

showHivConsent
boolean

Whether HIV consent is required for this kit

object

Physical dimensions and weight of the kit parcel

isActive
boolean

Whether this kit is currently active

[
]

Order

id
string
status
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"
object
orgId
string
orgName
string
providerNpi
string
location
string
object
kitId
string
panelId
string
registrationCode
string or null

The coded provided on the insert of a kit, which allows a patient to register it before sending to the lab for processing.

externalId
string

An id managed by the partner for this specific object type

object
object
externalId
string

An id managed by the partner for this specific object type

kitBarcode
string
accessionNumber
string
externalAccession
string
pidid
string
object

Ordering provider snapshot captured at order-creation time (immutable)

providerAuthorizedAt
string <date-time>

When the provider authorized the order

notes
string
resultsPdf
string

Lab friendly results PDF. This can be either Base64 encoded PDF or URL of the PDF

patientPdfUrl
string

Patient friendly results PDF URL. This will be presented to Patient

object
Array of objects
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 (HL7 code or readable name)

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

Array of objects

Insurance information for the customer/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

orderNo
integer

Auto-incrementing sequential order number

isRegistered
boolean

Whether the kit has been registered by the patient

includeInInbox
boolean

Whether this order is currently surfaced in the partner inbox

object
dateCreated
string <date-time>
dateLastUpdated
string <date-time>
dateRegistered
string or null <date-time>
dateCanceled
string or null <date-time>
dateCollected
string or null <date-time>
dateResulted
string or null <date-time>
object
object or null

Shipment from the lab to the customer (outbound kit delivery)

object or null

Return shipment from the customer back to the lab

type
any
Enum: "KIT" "LAB"
stoplight: {"id":"09rmq1fyr812n"}
{
}

Orders

Array
id
string
status
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"
object
object
object
object

Optional guarantor information for the patient

Array of objects

Optional diagnosis information for the order

Array of objects

Insurance information for the customer/patient

orderNo
integer

Auto-incrementing sequential order number

isRegistered
boolean

Whether the kit has been registered by the patient

includeInInbox
boolean

Whether this order is currently surfaced in the partner inbox

object
object
type
any
Enum: "KIT" "LAB"
stoplight: {"id":"09rmq1fyr812n"}
[
]

OrdersV2Response

Array of objects (Order)
Array
id
string
status
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"
object
object
object
object

Optional guarantor information for the patient

Array of objects

Optional diagnosis information for the order

Array of objects

Insurance information for the customer/patient

orderNo
integer

Auto-incrementing sequential order number

isRegistered
boolean

Whether the kit has been registered by the patient

includeInInbox
boolean

Whether this order is currently surfaced in the partner inbox

object
object
type
any
Enum: "KIT" "LAB"
stoplight: {"id":"09rmq1fyr812n"}
object
total
integer

Indicates the total number of orders available for the given query params

currentPage
integer

Indicates the current page number that is being viewed or processed

totalPages
integer

Indicates the total number of pages available based on the total orders and the page size for the given query params

pageSize
integer

Indicates the number of orders displayed per page

{
}

OrderV3

id
string
status
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"
object
orgId
string
orgName
string
providerNpi
string
location
string
object
kitId
string
panelId
string
registrationCode
string or null

The coded provided on the insert of a kit, which allows a patient to register it before sending to the lab for processing.

externalId
string

An id managed by the partner for this specific object type

object
object
externalId
string

An id managed by the partner for this specific object type

kitBarcode
string
accessionNumber
string
externalAccession
string
pidid
string
object

Ordering provider snapshot captured at order-creation time (immutable)

providerAuthorizedAt
string <date-time>

When the provider authorized the order

notes
string
resultsPdf
string

Lab friendly results PDF. This can be either Base64 encoded PDF or URL of the PDF

patientPdfUrl
string

Patient friendly results PDF URL. This will be presented to Patient

object
Array of objects
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 (HL7 code or readable name)

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

Array of objects

Insurance information for the customer/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

orderNo
integer

Auto-incrementing sequential order number

isRegistered
boolean

Whether the kit has been registered by the patient

includeInInbox
boolean

Whether this order is currently surfaced in the partner inbox

object
dateCreated
string <date-time>
dateLastUpdated
string <date-time>
dateRegistered
string or null <date-time>
dateCanceled
string or null <date-time>
dateCollected
string or null <date-time>
dateResulted
string or null <date-time>
object
object or null

Shipment from the lab to the customer (outbound kit delivery)

object or null

Return shipment from the customer back to the lab

type
any
Enum: "KIT" "LAB"
stoplight: {"id":"09rmq1fyr812n"}
wasDuplicate
boolean

Whether this order was detected as a duplicate at creation time

statusReason
string or null

Additional context for the current order status

object

Map of background task names to their most recent execution status

additional property
object
object

Information about the performing lab site

performingSite
string
address1
string
address2
string
city
string
state
string
zipCode
string
labDirector
string
cliaId
string
{
}

OrdersV3

Array
id
string
status
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"
object
object
object
object

Optional guarantor information for the patient

Array of objects

Optional diagnosis information for the order

Array of objects

Insurance information for the customer/patient

orderNo
integer

Auto-incrementing sequential order number

isRegistered
boolean

Whether the kit has been registered by the patient

includeInInbox
boolean

Whether this order is currently surfaced in the partner inbox

object
object
type
any
Enum: "KIT" "LAB"
stoplight: {"id":"09rmq1fyr812n"}
wasDuplicate
boolean

Whether this order was detected as a duplicate at creation time

statusReason
string or null

Additional context for the current order status

object

Map of background task names to their most recent execution status

object

Information about the performing lab site

[
]

OrdersV3Response

Array of objects (OrderV3)
Array
id
string
status
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"
object
object
object
object

Optional guarantor information for the patient

Array of objects

Optional diagnosis information for the order

Array of objects

Insurance information for the customer/patient

orderNo
integer

Auto-incrementing sequential order number

isRegistered
boolean

Whether the kit has been registered by the patient

includeInInbox
boolean

Whether this order is currently surfaced in the partner inbox

object
object
type
any
Enum: "KIT" "LAB"
stoplight: {"id":"09rmq1fyr812n"}
wasDuplicate
boolean

Whether this order was detected as a duplicate at creation time

statusReason
string or null

Additional context for the current order status

object

Map of background task names to their most recent execution status

object

Information about the performing lab site

object
total
integer

Indicates the total number of orders available for the given query params

currentPage
integer

Indicates the current page number that is being viewed or processed

totalPages
integer

Indicates the total number of pages available based on the total orders and the page size for the given query params

pageSize
integer

Indicates the number of orders displayed per page

{
}

CreateKitOrderRequest

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

{
}

RegisterOrderRequest

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

{
}

CreateLabOrderRequest

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.

{
}

SuccessResponse

success
boolean
{
}

CreateSuccessResponse

id
string
success
boolean
error
string
{
}

GetInboxResponse

Array
Array
id
string
status
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"
object
object
object
object

Optional guarantor information for the patient

Array of objects

Optional diagnosis information for the order

Array of objects

Insurance information for the customer/patient

orderNo
integer

Auto-incrementing sequential order number

isRegistered
boolean

Whether the kit has been registered by the patient

includeInInbox
boolean

Whether this order is currently surfaced in the partner inbox

object
object
type
any
Enum: "KIT" "LAB"
stoplight: {"id":"09rmq1fyr812n"}
[
]

ErrorResponse

success
boolean
error
string
{
}

ErrorResponses

Array
success
boolean
error
string
[
]

BadRequestResponse

success
boolean
error
string
Array of objects
Array
field
string
message
string
{
}

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

provider_id
string <uuid>

LabFlow provider identifier

npi
string^[0-9]{10}$

Type 1 NPI — unique per provider

first_name
string
middle_name
string or null
last_name
string
suffix
string or null
credential
string or null
active_status
string
Enum: "ACTIVE" "INACTIVE" "RETIRED"
created_date
string <date-time>
updated_date
string <date-time>
Array of objects

External ID mappings for partner networks

Array
identifier_id
string <uuid>
system
string
external_provider_id
string
org_id
string
Array of objects (ProviderOrganizationAssignment)

Organization assignments with roles and effective dates

Array
provider_org_id
string <uuid>

Internal assignment ID (returned in responses)

provider_id
string <uuid>
org_id
required
string
role
required
string
Enum: "ORDERING" "RENDERING" "SUPERVISING"
is_default_for_org
boolean
Default: false

Whether this provider is the default ordering provider for the organization

effective_from
string or null <date-time>
effective_to
string or null <date-time>
active_status
boolean
Default: true
created_date
string <date-time>
Array of objects (ProviderLocationAssignment)

Location assignments with roles and effective dates

Array
provider_location_id
string <uuid>

Internal assignment ID (returned in responses)

provider_id
string <uuid>
location_id
required
integer
org_id
string or null
role_at_location
required
string
Enum: "ORDERING" "SPECIMEN_RECEIVE"
is_default_location
boolean
Default: false

Whether this is the provider's default location

effective_from
string or null <date-time>
effective_to
string or null <date-time>
active_status
boolean
Default: true
created_date
string <date-time>
{
}

ProviderOrganizationAssignment

provider_org_id
string <uuid>

Internal assignment ID (returned in responses)

provider_id
string <uuid>
org_id
required
string
role
required
string
Enum: "ORDERING" "RENDERING" "SUPERVISING"
is_default_for_org
boolean
Default: false

Whether this provider is the default ordering provider for the organization

effective_from
string or null <date-time>
effective_to
string or null <date-time>
active_status
boolean
Default: true
created_date
string <date-time>
{
}

ProviderLocationAssignment

provider_location_id
string <uuid>

Internal assignment ID (returned in responses)

provider_id
string <uuid>
location_id
required
integer
org_id
string or null
role_at_location
required
string
Enum: "ORDERING" "SPECIMEN_RECEIVE"
is_default_location
boolean
Default: false

Whether this is the provider's default location

effective_from
string or null <date-time>
effective_to
string or null <date-time>
active_status
boolean
Default: true
created_date
string <date-time>
{
}

Identifier

system
required
string <uri>
value
required
string
use
string
Enum: "usual" "official" "temp"
{}

HumanName

use
string
Enum: "official" "usual" "nickname"
family
string
given
Array of strings
suffix
Array of strings
text
string
{
}

Address

use
string
Enum: "home" "work" "temp" "billing" "shipping"
line
Array of strings
city
string
state
string
postalCode
string
country
string
{
}

ContactPoint

system
string
Enum: "phone" "email" "url"
value
string
use
string
Enum: "home" "work" "mobile"
{
}

Patient

Array of objects (Identifier)
Array
system
required
string <uri>
value
required
string
use
string
Enum: "usual" "official" "temp"
Array of objects (HumanName)
Array
use
string
Enum: "official" "usual" "nickname"
family
string
given
Array of strings
suffix
Array of strings
text
string
Array of objects (ContactPoint)
Array
system
string
Enum: "phone" "email" "url"
value
string
use
string
Enum: "home" "work" "mobile"
gender
string
Enum: "male" "female" "unknown" "other"
birthDate
string <date>
Array of objects (Address)
Array
use
string
Enum: "home" "work" "temp" "billing" "shipping"
line
Array of strings
city
string
state
string
postalCode
string
country
string
{
}

Coding

system
string
code
string
display
string
{
}

CodeableConcept

Array of objects (Coding)
Array
system
string
code
string
display
string
text
string
{
}

Quantity

value
number
unit
string
system
string
{
}

PractitionerQualification

object (CodeableConcept)
Array of objects (Coding)
text
string
{
}

Practitioner

Array of objects (Identifier)
Array
system
required
string <uri>
value
required
string
use
string
Enum: "usual" "official" "temp"
Array of objects (HumanName)
Array
use
string
Enum: "official" "usual" "nickname"
family
string
given
Array of strings
suffix
Array of strings
text
string
Array of objects (PractitionerQualification)
Array
object (CodeableConcept)
{
}

ServiceRequestRequester

Array of objects (Identifier)
Array
system
required
string <uri>
value
required
string
use
string
Enum: "usual" "official" "temp"
Array of objects (HumanName)
Array
use
string
Enum: "official" "usual" "nickname"
family
string
given
Array of strings
suffix
Array of strings
text
string
Array of objects (PractitionerQualification)
Array
object (CodeableConcept)
{
}

ServiceRequest

Array of objects (Identifier)
Array
system
required
string <uri>
value
required
string
use
string
Enum: "usual" "official" "temp"
status
string
intent
string
Value: "order"
object (CodeableConcept)
Array of objects (Coding)
text
string
authoredOn
string <date-time>
object (ServiceRequestRequester)
Array of objects (Identifier)
Array of objects (HumanName)
Array of objects (PractitionerQualification)
{
}

Specimen

Array of objects (Identifier)
Array
system
required
string <uri>
value
required
string
use
string
Enum: "usual" "official" "temp"
object
collectedDateTime
string <date-time>
receivedTime
string <date-time>
object (Identifier)
system
required
string <uri>
value
required
string
use
string
Enum: "usual" "official" "temp"
{
}

Observation

status
string
Enum: "final" "preliminary" "cancelled" "registered"
object (CodeableConcept)
Array of objects (Coding)
text
string
valueString
string
object (Quantity)
value
number
unit
string
system
string
Array of objects
Array
text
string
Array of objects
Array
Array of objects (Coding)
{
}

DocumentReference

status
string
Value: "current"
object (CodeableConcept)
Array of objects (Coding)
text
string
url
string <uri>
expiration
string <date-time>
{
}

DiagnosticReport

Array of objects (Identifier)
Array
system
required
string <uri>
value
required
string
use
string
Enum: "usual" "official" "temp"
status
string
Enum: "registered" "partial" "final" "amended" "cancelled"
effectiveDateTime
string <date-time>
issued
string <date-time>
conclusion
string
Array of objects (Observation)
Array
status
string
Enum: "final" "preliminary" "cancelled" "registered"
object (CodeableConcept)
valueString
string
object (Quantity)
Array of objects
Array of objects
Array of objects (DocumentReference)
Array
status
string
Value: "current"
object (CodeableConcept)
url
string <uri>
expiration
string <date-time>
{
}

LabWork

id
string
accessionNumber
string or null
externalAccession
string or null
status
string
object or null (Practitioner)
Array of objects (Identifier)
Array of objects (HumanName)
Array of objects (PractitionerQualification)
{
}

SupplyDeliveryExtension

direction
string
Enum: "outbound" "return"
carrier
string or null
serviceLevel
string or null
trackingUrl
string or null <uri>
{
}

SupplyDelivery

id
string
status
string
Enum: "in-progress" "completed" "aborted"
object
Array of objects (Identifier)
occurrenceDateTime
string <date-time>
object (SupplyDeliveryExtension)
direction
string
Enum: "outbound" "return"
carrier
string or null
serviceLevel
string or null
trackingUrl
string or null <uri>
{
}

Coverage

Array of objects (Identifier)
Array
system
required
string <uri>
value
required
string
use
string
Enum: "usual" "official" "temp"
status
string
Enum: "active" "cancelled"
subscriberId
string or null
object (HumanName)
use
string
Enum: "official" "usual" "nickname"
family
string
given
Array of strings
suffix
Array of strings
text
string
Array of objects
Array
display
string
Array of objects
Array
value
string
{
}

Condition

object (CodeableConcept)
Array of objects (Coding)
text
string
onsetDateTime
string <date-time>
{
}

PartnerOrderExtension

object or null
property name*
additional property
any
object
carrier
string
serviceLevel
string
{
}

PartnerOrderSummary

apiVersion
required
string
required
Array of objects (Identifier)
Array
system
required
string <uri>
value
required
string
use
string
Enum: "usual" "official" "temp"
orgId
required
string
kind
required
string
Enum: "kit" "lab"
status
required
string
statusReason
string or null
registrationState
required
string
Enum: "registered" "unregistered"
object or null (ServiceRequest)

FHIR ServiceRequest (placer order / requisition)

Array of objects (Identifier)
status
string
intent
string
Value: "order"
object (CodeableConcept)
authoredOn
string <date-time>
object (ServiceRequestRequester)
object or null (Specimen)
Array of objects (Identifier)
object
receivedTime
string <date-time>
object (Identifier)
object or null (DiagnosticReport)
Array of objects (Identifier)
status
string
Enum: "registered" "partial" "final" "amended" "cancelled"
effectiveDateTime
string <date-time>
issued
string <date-time>
conclusion
string
Array of objects (Observation)
Array of objects (DocumentReference)
object or null (LabWork)
id
string
accessionNumber
string or null
externalAccession
string or null
status
string
object or null (Practitioner)
object or null (Patient)

FHIR R4 Patient (partner profile)

Array of objects (Identifier)
Array of objects (HumanName)
Array of objects (ContactPoint)
gender
string
Enum: "male" "female" "unknown" "other"
birthDate
string <date>
Array of objects (Address)
object or null (Patient)

FHIR R4 Patient (partner profile)

Array of objects (Identifier)
Array of objects (HumanName)
Array of objects (ContactPoint)
gender
string
Enum: "male" "female" "unknown" "other"
birthDate
string <date>
Array of objects (Address)
Array of objects (SupplyDelivery)
Array
id
string
status
string
Enum: "in-progress" "completed" "aborted"
object
occurrenceDateTime
string <date-time>
object (SupplyDeliveryExtension)
object (PartnerOrderExtension)
object or null
object
{
}

PartnerOrderCancellation

reason
string
recorded
string <date-time>
note
string or null
{
}

PartnerOrder

apiVersion
required
string
required
Array of objects (Identifier)
Array
system
required
string <uri>
value
required
string
use
string
Enum: "usual" "official" "temp"
orgId
required
string
kind
required
string
Enum: "kit" "lab"
status
required
string
statusReason
string or null
registrationState
required
string
Enum: "registered" "unregistered"
object or null (ServiceRequest)

FHIR ServiceRequest (placer order / requisition)

Array of objects (Identifier)
status
string
intent
string
Value: "order"
object (CodeableConcept)
authoredOn
string <date-time>
object (ServiceRequestRequester)
object or null (Specimen)
Array of objects (Identifier)
object
receivedTime
string <date-time>
object (Identifier)
object or null (DiagnosticReport)
Array of objects (Identifier)
status
string
Enum: "registered" "partial" "final" "amended" "cancelled"
effectiveDateTime
string <date-time>
issued
string <date-time>
conclusion
string
Array of objects (Observation)
Array of objects (DocumentReference)
object or null (LabWork)
id
string
accessionNumber
string or null
externalAccession
string or null
status
string
object or null (Practitioner)
object or null (Patient)

FHIR R4 Patient (partner profile)

Array of objects (Identifier)
Array of objects (HumanName)
Array of objects (ContactPoint)
gender
string
Enum: "male" "female" "unknown" "other"
birthDate
string <date>
Array of objects (Address)
object or null (Patient)

FHIR R4 Patient (partner profile)

Array of objects (Identifier)
Array of objects (HumanName)
Array of objects (ContactPoint)
gender
string
Enum: "male" "female" "unknown" "other"
birthDate
string <date>
Array of objects (Address)
Array of objects (SupplyDelivery)
Array
id
string
status
string
Enum: "in-progress" "completed" "aborted"
object
occurrenceDateTime
string <date-time>
object (SupplyDeliveryExtension)
object (PartnerOrderExtension)
object or null
object
Array of objects or null (Coverage)
Array
Array of objects (Identifier)
status
string
Enum: "active" "cancelled"
subscriberId
string or null
object (HumanName)
Array of objects
Array of objects
Array of objects or null (Condition)
Array
object (CodeableConcept)
onsetDateTime
string <date-time>
object or null (PartnerOrderCancellation)
reason
string
recorded
string <date-time>
note
string or null
{
}

PartnerOrderListResponse

Array of objects (PartnerOrderSummary)
Array
apiVersion
required
string
required
Array of objects (Identifier)
orgId
required
string
kind
required
string
Enum: "kit" "lab"
status
required
string
statusReason
string or null
registrationState
required
string
Enum: "registered" "unregistered"
object or null (ServiceRequest)

FHIR ServiceRequest (placer order / requisition)

object or null (Specimen)
object or null (DiagnosticReport)
object or null (LabWork)
object or null (Patient)

FHIR R4 Patient (partner profile)

object or null (Patient)

FHIR R4 Patient (partner profile)

Array of objects (SupplyDelivery)
object (PartnerOrderExtension)
object
currentPage
integer
pageSize
integer
total
integer
totalPages
integer
{
}

CreateKitOrderRequest

required
object (ServiceRequest)

FHIR ServiceRequest (placer order / requisition)

Array of objects (Identifier)
status
string
intent
string
Value: "order"
object (CodeableConcept)
authoredOn
string <date-time>
object (ServiceRequestRequester)
required
object (Patient)

FHIR R4 Patient (partner profile)

Array of objects (Identifier)
Array of objects (HumanName)
Array of objects (ContactPoint)
gender
string
Enum: "male" "female" "unknown" "other"
birthDate
string <date>
Array of objects (Address)
object (Specimen)
Array of objects (Identifier)
object
receivedTime
string <date-time>
object (Identifier)
object (PartnerOrderExtension)
object or null
object
{
}

CreateLabOrderRequest

required
object (ServiceRequest)

FHIR ServiceRequest (placer order / requisition)

Array of objects (Identifier)
status
string
intent
string
Value: "order"
object (CodeableConcept)
authoredOn
string <date-time>
object (ServiceRequestRequester)
required
object (Patient)

FHIR R4 Patient (partner profile)

Array of objects (Identifier)
Array of objects (HumanName)
Array of objects (ContactPoint)
gender
string
Enum: "male" "female" "unknown" "other"
birthDate
string <date>
Array of objects (Address)
object (Specimen)
Array of objects (Identifier)
object
receivedTime
string <date-time>
object (Identifier)
object (PartnerOrderExtension)
object or null
object
{
}

V3CreateOrderResponse

id
string
success
boolean
{
}

PartnerEventType

string (PartnerEventType)
Enum: "webhook.test" "order.created" "order.registered" "order.status.changed" "order.shipment.updated" "order.received" "order.rejected" "order.resulted" "order.cancelled" "order.documents.available"

order.documents.available is reserved and not emitted yet. webhook.test is only sent by POST /webhooks/endpoints/{endpointId}/test.

"webhook.test"

OrderStatusChangedEventData

object (PartnerOrderSummary)
apiVersion
required
string
required
Array of objects (Identifier)
orgId
required
string
kind
required
string
Enum: "kit" "lab"
status
required
string
statusReason
string or null
registrationState
required
string
Enum: "registered" "unregistered"
object or null (ServiceRequest)

FHIR ServiceRequest (placer order / requisition)

object or null (Specimen)
object or null (DiagnosticReport)
object or null (LabWork)
object or null (Patient)

FHIR R4 Patient (partner profile)

object or null (Patient)

FHIR R4 Patient (partner profile)

Array of objects (SupplyDelivery)
object (PartnerOrderExtension)
previousStatus
string
currentStatus
string
changedFields
Array of strings
{
}

WebhookEvent

apiVersion
string
id
string
type
string (PartnerEventType)
Enum: "webhook.test" "order.created" "order.registered" "order.status.changed" "order.shipment.updated" "order.received" "order.rejected" "order.resulted" "order.cancelled" "order.documents.available"

order.documents.available is reserved and not emitted yet. webhook.test is only sent by POST /webhooks/endpoints/{endpointId}/test.

createdAt
string <date-time>
orgId
string
object (OrderStatusChangedEventData)
object (PartnerOrderSummary)
previousStatus
string
currentStatus
string
changedFields
Array of strings
{
}

WebhookEndpoint

id
string <uuid>
url
string <uri>
enabled
boolean
description
string or null
payloadTier
string
Enum: "summary" "standard" "full"

Accepted and stored for future use. Every webhook currently carries the summary payload without patient/recipient details, regardless of this value.

includeSubject
boolean

Accepted and stored for future use; not applied to payloads yet.

subscribedEvents
Array of strings (PartnerEventType)
Items Enum: "webhook.test" "order.created" "order.registered" "order.status.changed" "order.shipment.updated" "order.received" "order.rejected" "order.resulted" "order.cancelled" "order.documents.available"
createdAt
string <date-time>
updatedAt
string <date-time>
deleted
boolean

True once the endpoint has been deleted.

deletedAt
string or null <date-time>
{
}

WebhookEndpointListResponse

Array of objects (WebhookEndpoint)
Array
id
string <uuid>
url
string <uri>
enabled
boolean
description
string or null
payloadTier
string
Enum: "summary" "standard" "full"

Accepted and stored for future use. Every webhook currently carries the summary payload without patient/recipient details, regardless of this value.

includeSubject
boolean

Accepted and stored for future use; not applied to payloads yet.

subscribedEvents
Array of strings (PartnerEventType)
Items Enum: "webhook.test" "order.created" "order.registered" "order.status.changed" "order.shipment.updated" "order.received" "order.rejected" "order.resulted" "order.cancelled" "order.documents.available"
createdAt
string <date-time>
updatedAt
string <date-time>
deleted
boolean

True once the endpoint has been deleted.

deletedAt
string or null <date-time>
{
}

CreateWebhookEndpointRequest

url
required
string <uri>

Must start with https://.

description
string
enabled
boolean
Default: true
payloadTier
string
Default: "summary"
Enum: "summary" "standard" "full"

Accepted and stored for future use. Every webhook currently carries the summary payload without patient/recipient details, regardless of this value.

includeSubject
boolean
Default: false

Accepted and stored for future use; not applied to payloads yet.

subscribedEvents
Array of strings (PartnerEventType)
Items Enum: "webhook.test" "order.created" "order.registered" "order.status.changed" "order.shipment.updated" "order.received" "order.rejected" "order.resulted" "order.cancelled" "order.documents.available"

Omit (or send an empty array) to subscribe to the defaults: order.status.changed, order.resulted, order.cancelled.

{
}

CreateWebhookEndpointResponse

id
string <uuid>
signingSecret
string
subscribedEvents
Array of strings (PartnerEventType)
Items Enum: "webhook.test" "order.created" "order.registered" "order.status.changed" "order.shipment.updated" "order.received" "order.rejected" "order.resulted" "order.cancelled" "order.documents.available"
{
}

PatchWebhookEndpointRequest

url
string <uri>

Must start with https://.

description
string
enabled
boolean
payloadTier
string
Enum: "summary" "standard" "full"

Accepted and stored for future use. Every webhook currently carries the summary payload without patient/recipient details, regardless of this value.

includeSubject
boolean

Accepted and stored for future use; not applied to payloads yet.

subscribedEvents
Array of strings (PartnerEventType)
Items Enum: "webhook.test" "order.created" "order.registered" "order.status.changed" "order.shipment.updated" "order.received" "order.rejected" "order.resulted" "order.cancelled" "order.documents.available"

Replaces the full subscription list when provided.

{
}

PagePagination

page
integer
limit
integer
total
integer
{
}

WebhookDelivery

id
string <uuid>
eventId
string <uuid>

Same value as the X-LabFlow-Event-Id header.

endpointId
string <uuid>
status
string
Enum: "pending" "delivered" "failed" "aborted"

pending: not yet delivered, a retry is scheduled. delivered: your endpoint returned 2xx. failed: gave up after the maximum number of attempts. aborted: the endpoint was disabled or deleted before delivery.

attempt
integer
httpStatus
integer or null

HTTP status your endpoint returned on the last attempt.

error
string or null

Last error (network error or HTTP <status>: <first 500 chars of body>).

createdAt
string <date-time>
orgId
string
type
string (PartnerEventType)
Enum: "webhook.test" "order.created" "order.registered" "order.status.changed" "order.shipment.updated" "order.received" "order.rejected" "order.resulted" "order.cancelled" "order.documents.available"

order.documents.available is reserved and not emitted yet. webhook.test is only sent by POST /webhooks/endpoints/{endpointId}/test.

object (WebhookEvent)
apiVersion
string
id
string
type
string (PartnerEventType)
Enum: "webhook.test" "order.created" "order.registered" "order.status.changed" "order.shipment.updated" "order.received" "order.rejected" "order.resulted" "order.cancelled" "order.documents.available"

order.documents.available is reserved and not emitted yet. webhook.test is only sent by POST /webhooks/endpoints/{endpointId}/test.

createdAt
string <date-time>
orgId
string
object (OrderStatusChangedEventData)
apiVersion
string
occurredAt
string <date-time>
{
}

WebhookDeliveryListResponse

Array of objects (WebhookDelivery)
Array
id
string <uuid>
eventId
string <uuid>

Same value as the X-LabFlow-Event-Id header.

endpointId
string <uuid>
status
string
Enum: "pending" "delivered" "failed" "aborted"

pending: not yet delivered, a retry is scheduled. delivered: your endpoint returned 2xx. failed: gave up after the maximum number of attempts. aborted: the endpoint was disabled or deleted before delivery.

attempt
integer
httpStatus
integer or null

HTTP status your endpoint returned on the last attempt.

error
string or null

Last error (network error or HTTP <status>: <first 500 chars of body>).

createdAt
string <date-time>
orgId
string
type
string (PartnerEventType)
Enum: "webhook.test" "order.created" "order.registered" "order.status.changed" "order.shipment.updated" "order.received" "order.rejected" "order.resulted" "order.cancelled" "order.documents.available"

order.documents.available is reserved and not emitted yet. webhook.test is only sent by POST /webhooks/endpoints/{endpointId}/test.

object (WebhookEvent)
apiVersion
string
occurredAt
string <date-time>
object (PagePagination)
page
integer
limit
integer
total
integer
{
}

PartnerEventLogEntry

id
string <uuid>

Same value as the X-LabFlow-Event-Id header.

type
string (PartnerEventType)
Enum: "webhook.test" "order.created" "order.registered" "order.status.changed" "order.shipment.updated" "order.received" "order.rejected" "order.resulted" "order.cancelled" "order.documents.available"

order.documents.available is reserved and not emitted yet. webhook.test is only sent by POST /webhooks/endpoints/{endpointId}/test.

resourceType
string or null
resourceId
string or null

Order id for order events.

apiVersion
string
occurredAt
string <date-time>
object (WebhookEvent)
apiVersion
string
id
string
type
string (PartnerEventType)
Enum: "webhook.test" "order.created" "order.registered" "order.status.changed" "order.shipment.updated" "order.received" "order.rejected" "order.resulted" "order.cancelled" "order.documents.available"

order.documents.available is reserved and not emitted yet. webhook.test is only sent by POST /webhooks/endpoints/{endpointId}/test.

createdAt
string <date-time>
orgId
string
object (OrderStatusChangedEventData)
{
}

PartnerEventListResponse

Array of objects (PartnerEventLogEntry)
Array
id
string <uuid>

Same value as the X-LabFlow-Event-Id header.

type
string (PartnerEventType)
Enum: "webhook.test" "order.created" "order.registered" "order.status.changed" "order.shipment.updated" "order.received" "order.rejected" "order.resulted" "order.cancelled" "order.documents.available"

order.documents.available is reserved and not emitted yet. webhook.test is only sent by POST /webhooks/endpoints/{endpointId}/test.

resourceType
string or null
resourceId
string or null

Order id for order events.

apiVersion
string
occurredAt
string <date-time>
object (WebhookEvent)
object (PagePagination)
page
integer
limit
integer
total
integer
{
}

TestWebhookResponse

success
boolean
eventId
string <uuid>

Look this up in GET /webhooks/deliveries to see the outcome.

{
}

ProviderIdentifierRow

identifier_id
string <uuid>
provider_id
string <uuid>
system
string
external_provider_id
string
org_id
string
created_date
string <date-time>
{
}

ProviderOrganizationRole

provider_org_id
string <uuid>
provider_id
string <uuid>
org_id
string
role
string
is_default_for_org
boolean
effective_from
string or null <date-time>
effective_to
string or null <date-time>
active_status
boolean
created_date
string <date-time>
{
}

PractitionerListItem

provider_id
string <uuid>
npi
string
first_name
string
middle_name
string or null
last_name
string
suffix
string or null
credential
string or null
active_status
string
Enum: "ACTIVE" "INACTIVE" "RETIRED"
created_date
string <date-time>
updated_date
string <date-time>
Array of objects (ProviderIdentifierRow)
Array
identifier_id
string <uuid>
provider_id
string <uuid>
system
string
external_provider_id
string
org_id
string
created_date
string <date-time>
Array of objects (ProviderOrganizationRole)

Only your organization's roles are included.

Array
provider_org_id
string <uuid>
provider_id
string <uuid>
org_id
string
role
string
is_default_for_org
boolean
effective_from
string or null <date-time>
effective_to
string or null <date-time>
active_status
boolean
created_date
string <date-time>
location_roles
Array of objects
{
}

PractitionerListResponse

Array of objects (PractitionerListItem)
Array
provider_id
string <uuid>
npi
string
first_name
string
middle_name
string or null
last_name
string
suffix
string or null
credential
string or null
active_status
string
Enum: "ACTIVE" "INACTIVE" "RETIRED"
created_date
string <date-time>
updated_date
string <date-time>
Array of objects (ProviderIdentifierRow)
Array of objects (ProviderOrganizationRole)

Only your organization's roles are included.

location_roles
Array of objects
total
integer
page
integer
limit
integer
{
}

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
{
}

System

Health checks (no API key required on some environments).

Check Labflow API Health

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
}

Check Labflow API Health (V3)

Returns platform health and dependency status for monitoring and readiness checks.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
}