Outreach Order

Server

Download schema

Submitting and validating outreach orders

Create an outreach order

POST

https://outreach.services.{domain}

/order

Bill Type Field Requirements

The following definitions apply to the Field Requirement column:

Client Bill (order.bill_type = "C") places the responsibility for reimbursement on the Labcorp client.
Patient Bill (order.bill_type = "P") places the responsibility for reimbursement on the patient.
Third Party Bill (order.bill_type = "T") places the responsibility for reimbursement on a third party entity (i.e. Medicare, Medicaid, and Private Insurance).
'A' - This field is always needed for the specified bill type. Failure to provide these fields may require clarification prior to processing the lab.
'D' - This field is desirable but not always needed for the specified bill type.
'N/A' - This field is not applicable for the specified bill type.

Order Field	Description	Client	Patient	Third Party
order.patient.external_id	External Patient ID	A	A	A
order.patient.last_name	Patient Last Name	A	A	A
order.patient.first_name	Patient First Name	A	A	A
order.patient.middle_name	Patient Middle Name	D	D	D
order.patient.date_of_birth	Patient Date of Birth	A	A	A
order.patient.gender	Patient Gender	A	A	A
order.patient.address.street_address	Patient Address (Line 1)	A	A	A
order.patient.address.city	Patient City	A	A	A
order.patient.address.state	Patient State or Province	A	A	A
order.patient.address.postal_code	Patient Zip or Postal Code	A	A	A
order.patient.phone_number	Patient Phone Number	A	A	A
order.patient.email	Communication Address (Patient Email Address)	A	A	A
order.account.number	Account Number	A	A	A
order.bill_type	Bill Type	A	A	A
order.patient.patient_class	Patient Class	A	A	A
order.primary_insurance.id	Insurance Company Identification Number	N/A	N/A	D
order.secondary_insurance.id	Insurance Company Identification Number - Secondary (a.k.a Secondary Insurance Subscriber Number)	N/A	N/A	D
order.primary_insurance.payer_code	Insurance Payer Code	N/A	N/A	D
order.secondary_insurance.payer_code	Insurance Payer Code- Secondary	N/A	N/A	D
order.primary_insurance.name	Insurance Company Name	N/A	N/A	D
order.secondary_insurance.name	Insurance Company Name - Secondary	N/A	N/A	D
order.primary_insurance.address.street_address	Insurance Company Address (Line 1)	N/A	N/A	A
order.secondary_insurance.address.street_address	Insurance Company Address (Line 1) - Secondary	N/A	N/A	A
order.primary_insurance.address.line2	Insurance Company Address (Line 2)	N/A	N/A	D
order.secondary_insurance.address.line2	Insurance Company Address (Line 2) - Secondary	N/A	N/A	D
order.primary_insurance.address.city	Insurance Company City	N/A	N/A	A
order.secondary_insurance.address.city	Insurance Company City - Secondary	N/A	N/A	A
order.primary_insurance.address.state	Insurance Company State	N/A	N/A	A
order.secondary_insurance.address.state	Insurance Company State -Secondary	N/A	N/A	A
order.primary_insurance.address.postal_code	Insurance Company Zip Code	N/A	N/A	A
order.secondary_insurance.address.postal_code	Insurance Company Zip Code - Secondary	N/A	N/A	A
order.primary_insurance.group_number	Group Number of Insured Patient	N/A	N/A	D
order.secondary_insurance.group_number	Group Number of Insured Patient - Secondary	N/A	N/A	D
order.primary_insurance.employer_name	Insured's Group Employer Name	N/A	N/A	D
order.secondary_insurance.employer_name	Insured's Group Employer Name - Secondary	N/A	N/A	D
order.primary_insurance.patient_relationship	Insured's Relationship to Patient	N/A	N/A	A
order.secondary_insurance.patient_relationship	Insured's Relationship to Patient - Secondary	N/A	N/A	A
order.primary_insurance.workers_comp	Type of Agreement (Worker's Compensation Flag)	N/A	N/A	A
order.primary_insurance.policy_number	Policy Number (Insurance Number/Subscriber Number/Member ID)	N/A	N/A	A
order.secondary_insurance.policy_number	Policy Number (Insurance Number/Subscriber Number/Member ID) - Secondary	N/A	N/A	A
order.guarantor.last_name	Guarantor Last Name	A	A	A
order.guarantor.first_name	Guarantor First Name	A	A	A
order.guarantor.address.street_address	Guarantor Address (Line 1)	A	A	A
order.guarantor.address.city	Guarantor City	A	A	A
order.guarantor.address.state	Guarantor State	A	A	A
order.guarantor.address.postal_code	Guarantor Zip Code	A	A	A
order.guarantor.phone_number	Guarantor Phone Number	A	A	A
order.guarantor.patient_relationship	Guarantor Relationship to Patient	A	A	A
order.guarantor.employer_name	Guarantor's Employer Name	N/A	D	D
order.guarantor.charge_adjustment_code	Guarantor Charge Adjustment Code	N/A	N/A	D
order.guarantor.household_annual_income	Guarantor Household Annual Income	D	D	D
order.guarantor.household_size	Guarantor Household Size	D	D	D
order.diagnoses[0].code	Diagnosis Code Identifier	D	D	A
order.diagnoses[0].description	Diagnosis Code Text Description	D	D	D

Create an outreach order › Request Body

IncomingOrder

object · required

Object that contains information about this account.

object · required

The patient

object · required

Information identifying the Guarantor.

sending_application

string · minLength: 1 · maxLength: 15 · required

To identify vendor for routing purposes through LCS. Assigned by Labcorp and used for translation. This field must match the assigned Vendor Mnemonic.

Omission of this field or mismatch of the vendor mnemonic will result in order submission failure.

Maximum field length is 15 alpha-numeric characters with the following exceptions:

No control or whitespace characters except space
ampersands
backslashes (\)
carets (^)
pipes (|)
or any byte value > 0x7d

receiving_application

string · minLength: 1 · maxLength: 15 · required

To identify the Labcorp System receiving the orders. More could be added in the future.

Omission of this field will result in order submission failure.

Maximum field length is 15 alpha-numeric characters with the following exceptions:

No control or whitespace characters except space
ampersands
backslashes (\)
carets (^)
pipes (|)
or any byte value > 0x7d

sending_facility

string · minLength: 1 · maxLength: 10 · required

The sending facility. This field must match the Client Site ID (CSID).

Omission of this field or mismatch of the CSID will result in order submission failure.

Maximum field length is 10 alpha-numeric characters with the following exceptions:

No control or whitespace characters except space
ampersands
backslashes (\)
carets (^)
pipes (|)
or any byte value > 0x7d

receiving_facility

string · minLength: 1 · maxLength: 10 · required

Used for routing through the Labcorp system.

Omission of this field will result in order submission failure.

Maximum field length is 10 alpha-numeric characters with the following exceptions:

No control or whitespace characters except space
ampersands
backslashes (\)
carets (^)
pipes (|)
or any byte value > 0x7d

control_id

string · minLength: 1 · maxLength: 20 · required

The message identifier.

Omission of this field will result in order submission failure.

Maximum field length is 20 alpha-numeric characters with the following exceptions:

No control or whitespace characters except space
ampersands
backslashes (\)
carets (^)
pipes (|)
or any byte value > 0x7d

bill_type

string · enum · required

Used to determine responsible "Bill to" party.

Bill Types:

C - Client
P - Patient
T - Third Party

Enum values:

Specimen[] · minItems: 1 · maxItems: 40 · required

An array of specimens that will be sent to Labcorp for testing.

object

Insurance data with additional worker's comp information.

object

Secondary insurance used for billing.

CourtesyCopy[] · maxItems: 4

Used when a courtesy copy of the report is requested.

Create an outreach order › Responses

This datatype is returned by the /order endpoint

OrderResponse

workflowId

string · maxLength: 32 · required

A server generated unique ID for the order workflow also serves as the ID for the original order.

object · required

A dictionary consisting of unique source order IDs as keys and the corresponding requisition data as values.

ValidationIssue[]

An array of validation issues that were found, but which did not stop processing of the Order.

Notification[]

Optional array of notifications.

POST/order

curl 'https://outreach.services.{domain}/order' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "account": {
    "number": "numberaa",
    "site_name": "site_name",
    "phone_number": "phone_number",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    }
  },
  "patient": {
    "external_id": "external_id",
    "alternate_id": "alternate_id",
    "last_name": "SMITH",
    "first_name": "JAMES",
    "middle_name": "S",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "date_of_birth": "2019-05-17",
    "gender": "M",
    "race": "C",
    "ethnicity": "H",
    "phone_number": "9195552344",
    "email": "PATIENT@EXAMPLE.COM",
    "patient_class": "I",
    "gender_identities": [
      {
        "id": "446151000124109",
        "description": "description"
      }
    ],
    "sexual_orientations": [
      {
        "id": "38628009",
        "description": "description"
      }
    ]
  },
  "guarantor": {
    "last_name": "last_name",
    "first_name": "first_name",
    "middle_initial": "middle_initial",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "phone_number": "9195552344",
    "patient_relationship": "1",
    "employer_name": "employer_name",
    "charge_adjustment_code": "FH000",
    "household_annual_income": 9624,
    "household_size": 4
  },
  "sending_application": "sending_application",
  "receiving_application": "receiving_application",
  "sending_facility": "sending_facility",
  "receiving_facility": "receiving_facility",
  "control_id": "control_id",
  "bill_type": "C",
  "primary_insurance": {
    "id": "id",
    "name": "name",
    "group_number": "group_number",
    "employer_name": "employer_name",
    "patient_relationship": "1",
    "policy_number": "policy_number",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "payer_code": "payer_code",
    "policy_holder": {
      "last_name": "last_name",
      "first_name": "first_name",
      "middle_name": "middle_name",
      "address": {
        "street_address": "street_address",
        "line2": "line2",
        "city": "city",
        "state": "state",
        "postal_code": "123456789"
      }
    },
    "workers_comp": "Y",
    "date_of_injury": "date_of_injury"
  },
  "secondary_insurance": {
    "id": "id",
    "name": "name",
    "group_number": "group_number",
    "employer_name": "employer_name",
    "patient_relationship": "1",
    "policy_number": "policy_number",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "payer_code": "payer_code",
    "policy_holder": {
      "last_name": "last_name",
      "first_name": "first_name",
      "middle_name": "middle_name",
      "address": {
        "street_address": "street_address",
        "line2": "line2",
        "city": "city",
        "state": "state",
        "postal_code": "123456789"
      }
    }
  },
  "courtesy_copy": [
    {
      "type": "A",
      "text": "text",
      "attention_line": "attention_line"
    }
  ],
  "specimens": [
    {
      "alternate_id": "alternate_id",
      "specimen_characteristics": [
        {
          "identifier": "identifier",
          "description": "description",
          "source_id": "source_id",
          "source_site_modifier": [
            {
              "identifier": "identifier"
            }
          ],
          "collection_date": "collection_date"
        }
      ],
      "collected_in_house": true,
      "collection_date": "collection_date",
      "clinical_comments": "clinical_comments",
      "test_codes": [
        {
          "id": "id",
          "name": "name",
          "aoes": [
            {
              "id": "id",
              "text": "text",
              "responses": [
                {
                  "value": "value",
                  "label": "label"
                }
              ],
              "response_time": "response_time"
            }
          ],
          "aoe_code": "DEPRECATED",
          "diagnoses": [
            {
              "code": "code",
              "description": "description"
            }
          ]
        }
      ]
    }
  ]
}'

Example Request Body

{
  "account": {
    "number": "numberaa",
    "site_name": "site_name",
    "phone_number": "phone_number",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    }
  },
  "patient": {
    "external_id": "external_id",
    "alternate_id": "alternate_id",
    "last_name": "SMITH",
    "first_name": "JAMES",
    "middle_name": "S",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "date_of_birth": "2019-05-17",
    "gender": "M",
    "race": "C",
    "ethnicity": "H",
    "phone_number": "9195552344",
    "email": "PATIENT@EXAMPLE.COM",
    "patient_class": "I",
    "gender_identities": [
      {
        "id": "446151000124109",
        "description": "description"
      }
    ],
    "sexual_orientations": [
      {
        "id": "38628009",
        "description": "description"
      }
    ]
  },
  "guarantor": {
    "last_name": "last_name",
    "first_name": "first_name",
    "middle_initial": "middle_initial",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "phone_number": "9195552344",
    "patient_relationship": "1",
    "employer_name": "employer_name",
    "charge_adjustment_code": "FH000",
    "household_annual_income": 9624,
    "household_size": 4
  },
  "sending_application": "sending_application",
  "receiving_application": "receiving_application",
  "sending_facility": "sending_facility",
  "receiving_facility": "receiving_facility",
  "control_id": "control_id",
  "bill_type": "C",
  "primary_insurance": {
    "id": "id",
    "name": "name",
    "group_number": "group_number",
    "employer_name": "employer_name",
    "patient_relationship": "1",
    "policy_number": "policy_number",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "payer_code": "payer_code",
    "policy_holder": {
      "last_name": "last_name",
      "first_name": "first_name",
      "middle_name": "middle_name",
      "address": {
        "street_address": "street_address",
        "line2": "line2",
        "city": "city",
        "state": "state",
        "postal_code": "123456789"
      }
    },
    "workers_comp": "Y",
    "date_of_injury": "date_of_injury"
  },
  "secondary_insurance": {
    "id": "id",
    "name": "name",
    "group_number": "group_number",
    "employer_name": "employer_name",
    "patient_relationship": "1",
    "policy_number": "policy_number",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "payer_code": "payer_code",
    "policy_holder": {
      "last_name": "last_name",
      "first_name": "first_name",
      "middle_name": "middle_name",
      "address": {
        "street_address": "street_address",
        "line2": "line2",
        "city": "city",
        "state": "state",
        "postal_code": "123456789"
      }
    }
  },
  "courtesy_copy": [
    {
      "type": "A",
      "text": "text",
      "attention_line": "attention_line"
    }
  ],
  "specimens": [
    {
      "alternate_id": "alternate_id",
      "specimen_characteristics": [
        {
          "identifier": "identifier",
          "description": "description",
          "source_id": "source_id",
          "source_site_modifier": [
            {
              "identifier": "identifier"
            }
          ],
          "collection_date": "collection_date"
        }
      ],
      "collected_in_house": true,
      "collection_date": "collection_date",
      "clinical_comments": "clinical_comments",
      "test_codes": [
        {
          "id": "id",
          "name": "name",
          "aoes": [
            {
              "id": "id",
              "text": "text",
              "responses": [
                {
                  "value": "value",
                  "label": "label"
                }
              ],
              "response_time": "response_time"
            }
          ],
          "aoe_code": "DEPRECATED",
          "diagnoses": [
            {
              "code": "code",
              "description": "description"
            }
          ]
        }
      ]
    }
  ]
}

json

Example Responses

{
  "workflowId": "workflowId",
  "validationIssues": [
    {
      "id": "id",
      "field": "field",
      "message": "message",
      "attributes": {},
      "severity": "info"
    }
  ],
  "notifications": [
    {
      "message": "message"
    }
  ],
  "requisitions": {
    "key": {
      "barcode": {
        "barcode1": "barcode1",
        "barcode2": "barcode2",
        "missing_to_be_entered": {
          "aoes": [
            {
              "id": "id",
              "text": "text",
              "responses": [
                {
                  "value": "value",
                  "label": "label"
                }
              ],
              "response_time": "response_time"
            }
          ],
          "medicalDrugMonitoring": {
            "freeText": [
              "FREE TEXT DRUG 1",
              "FREE TEXT DRUG 2"
            ],
            "rxNormCodes": [
              "977436",
              "1000990"
            ]
          },
          "diagnosis_codes": [
            "B94.0",
            "A90",
            "T48.5X2A"
          ],
          "body_sites": [
            {
              "source_id": "source_id",
              "identifier": "identifier",
              "collection_date": "collection_date"
            }
          ]
        }
      },
      "pdf": "pdf",
      "abn": "abn",
      "sourceOrderUid": "sourceOrderUid",
      "sourceOrder": {
        "account": {
          "number": "numberaa",
          "site_name": "site_name",
          "phone_number": "phone_number",
          "address": {
            "street_address": "street_address",
            "line2": "line2",
            "city": "city",
            "state": "state",
            "postal_code": "123456789"
          }
        },
        "patient": {
          "external_id": "external_id",
          "alternate_id": "alternate_id",
          "last_name": "SMITH",
          "first_name": "JAMES",
          "middle_name": "S",
          "address": {
            "street_address": "street_address",
            "line2": "line2",
            "city": "city",
            "state": "state",
            "postal_code": "123456789"
          },
          "date_of_birth": "2019-05-17",
          "gender": "M",
          "race": "C",
          "ethnicity": "H",
          "phone_number": "9195552344",
          "email": "PATIENT@EXAMPLE.COM",
          "patient_class": "I",
          "gender_identities": [
            {
              "id": "446151000124109",
              "description": "description"
            }
          ],
          "sexual_orientations": [
            {
              "id": "38628009",
              "description": "description"
            }
          ]
        },
        "ordering_provider": {
          "ids": {
            "npi": "npiaaaaaaa",
            "upin": "upin",
            "local_id": "local_id",
            "provider_num": "provider_num"
          },
          "last_name": "last_name",
          "first_name": "first_name"
        },
        "authorizing_provider": {
          "ids": {
            "npi": "npiaaaaaaa",
            "upin": "upin",
            "local_id": "local_id",
            "provider_num": "provider_num"
          },
          "last_name": "last_name",
          "first_name": "first_name"
        },
        "next_of_kin": {
          "last_name": "last_name",
          "first_name": "first_name",
          "middle_name": "middle_name",
          "address": {
            "street_address": "street_address",
            "line2": "line2",
            "city": "city",
            "state": "state",
            "postal_code": "123456789"
          },
          "phone_number": "9193233234"
        },
        "guarantor": {
          "last_name": "last_name",
          "first_name": "first_name",
          "middle_initial": "middle_initial",
          "address": {
            "street_address": "street_address",
            "line2": "line2",
            "city": "city",
            "state": "state",
            "postal_code": "123456789"
          },
          "phone_number": "9195552344",
          "patient_relationship": "1",
          "employer_name": "employer_name",
          "charge_adjustment_code": "FH000",
          "household_annual_income": 9624,
          "household_size": 4
        },
        "sending_application": "sending_application",
        "receiving_application": "receiving_application",
        "sending_facility": "sending_facility",
        "receiving_facility": "receiving_facility",
        "control_id": "control_id",
        "bill_type": "C",
        "primary_insurance": {
          "id": "id",
          "name": "name",
          "group_number": "group_number",
          "employer_name": "employer_name",
          "patient_relationship": "1",
          "policy_number": "policy_number",
          "address": {
            "street_address": "street_address",
            "line2": "line2",
            "city": "city",
            "state": "state",
            "postal_code": "123456789"
          },
          "payer_code": "payer_code",
          "policy_holder": {
            "last_name": "last_name",
            "first_name": "first_name",
            "middle_name": "middle_name",
            "address": {
              "street_address": "street_address",
              "line2": "line2",
              "city": "city",
              "state": "state",
              "postal_code": "123456789"
            }
          },
          "workers_comp": "Y",
          "date_of_injury": "date_of_injury"
        },
        "secondary_insurance": {
          "id": "id",
          "name": "name",
          "group_number": "group_number",
          "employer_name": "employer_name",
          "patient_relationship": "1",
          "policy_number": "policy_number",
          "address": {
            "street_address": "street_address",
            "line2": "line2",
            "city": "city",
            "state": "state",
            "postal_code": "123456789"
          },
          "payer_code": "payer_code",
          "policy_holder": {
            "last_name": "last_name",
            "first_name": "first_name",
            "middle_name": "middle_name",
            "address": {
              "street_address": "street_address",
              "line2": "line2",
              "city": "city",
              "state": "state",
              "postal_code": "123456789"
            }
          }
        },
        "courtesy_copy": [
          {
            "type": "A",
            "text": "text",
            "attention_line": "attention_line"
          }
        ],
        "processing_instructions": {
          "priority": "routine"
        },
        "specimen": {
          "alternate_id": "alternate_id",
          "specimen_characteristics": [
            {
              "identifier": "identifier",
              "description": "description",
              "source_id": "source_id",
              "source_site_modifier": [
                {
                  "identifier": "identifier"
                }
              ],
              "collection_date": "collection_date"
            }
          ],
          "collected_in_house": true,
          "collection_date": "collection_date",
          "clinical_comments": "clinical_comments",
          "test_codes": [
            {
              "id": "id",
              "name": "name",
              "aoes": [
                {
                  "id": "id",
                  "text": "text",
                  "responses": [
                    {
                      "value": "value",
                      "label": "label"
                    }
                  ],
                  "response_time": "response_time"
                }
              ],
              "aoe_code": "DEPRECATED",
              "diagnoses": [
                {
                  "code": "code",
                  "description": "description"
                }
              ]
            }
          ]
        }
      }
    }
  }
}

json

application/json

Validate an outreach order

POST

https://outreach.services.{domain}

/validate

Validate an outreach order › Request Body

Order

Account · required

Account information of the calling system placing the order.

Patient · required

The patient information for whom the labs are being ordered.

Provider · required

Guarantor · required

Information identifying the Guarantor.

sending_application

string · minLength: 1 · maxLength: 15 · required

To identify vendor for routing purposes through LCS. Assigned by Labcorp and used for translation. This field must match the assigned Vendor Mnemonic.

Omission of this field or mismatch of the vendor mnemonic will result in order submission failure.

receiving_application

string · minLength: 1 · maxLength: 15 · required

To identify the Labcorp System receiving the orders. More could be added in the future.

sending_facility

string · minLength: 1 · maxLength: 10 · required

The sending facility.

receiving_facility

string · minLength: 1 · maxLength: 10 · required

Used for routing through the Labcorp system.

control_id

string · minLength: 1 · maxLength: 20 · required

The message identifier.

bill_type

string · enum · required

Used to determine responsible "Bill to" party.

Bill Types:

C - Client
P - Patient
T - Third Party

Enum values:

Specimen[] · minItems: 1 · maxItems: 40 · required

An array of specimens that will be sent to Labcorp for testing.

Provider

The authorizing provider field may be used for, but is not limited to, cases where an ordering provider does not have sufficient authority to submit the order. The authorizing provider must supply an NPI ID and may optionally include the following types of ID: UPIN, Local ID, Provider Number.

NextOfKin

Information about the Next of Kin if the patient is < 17 years old.

InsuranceWithWorkersCompInfo

Primary insurance to used for billing.

Insurance

Secondary insurance used for billing.

CourtesyCopy[] · maxItems: 4

Used when a courtesy copy of the report is requested.

ProcessingInstructions

Used to set the priority of the Order

Validate an outreach order › Responses

Successfully processed order validation request.

This datatype is returned by the /validate endpoint.

ValidateResponse

Order · required

The Order that was provided.

ValidationIssue[] · required

An array of validation issues that were found. The array is empty if there are no validation issues found.

POST/validate

curl 'https://outreach.services.{domain}/validate' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "account": {
    "number": "numberaa",
    "site_name": "site_name",
    "phone_number": "phone_number",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    }
  },
  "patient": {
    "external_id": "external_id",
    "alternate_id": "alternate_id",
    "last_name": "SMITH",
    "first_name": "JAMES",
    "middle_name": "S",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "date_of_birth": "2019-05-17",
    "gender": "M",
    "race": "C",
    "ethnicity": "H",
    "phone_number": "9195552344",
    "email": "PATIENT@EXAMPLE.COM",
    "patient_class": "I",
    "gender_identities": [
      {
        "id": "446151000124109",
        "description": "description"
      }
    ],
    "sexual_orientations": [
      {
        "id": "38628009",
        "description": "description"
      }
    ]
  },
  "ordering_provider": {
    "ids": {
      "npi": "npiaaaaaaa",
      "upin": "upin",
      "local_id": "local_id",
      "provider_num": "provider_num"
    },
    "last_name": "last_name",
    "first_name": "first_name"
  },
  "authorizing_provider": {
    "ids": {
      "npi": "npiaaaaaaa",
      "upin": "upin",
      "local_id": "local_id",
      "provider_num": "provider_num"
    },
    "last_name": "last_name",
    "first_name": "first_name"
  },
  "next_of_kin": {
    "last_name": "last_name",
    "first_name": "first_name",
    "middle_name": "middle_name",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "phone_number": "9193233234"
  },
  "guarantor": {
    "last_name": "last_name",
    "first_name": "first_name",
    "middle_initial": "middle_initial",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "phone_number": "9195552344",
    "patient_relationship": "1",
    "employer_name": "employer_name",
    "charge_adjustment_code": "FH000",
    "household_annual_income": 9624,
    "household_size": 4
  },
  "sending_application": "sending_application",
  "receiving_application": "receiving_application",
  "sending_facility": "sending_facility",
  "receiving_facility": "receiving_facility",
  "control_id": "control_id",
  "bill_type": "C",
  "primary_insurance": {
    "id": "id",
    "name": "name",
    "group_number": "group_number",
    "employer_name": "employer_name",
    "patient_relationship": "1",
    "policy_number": "policy_number",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "payer_code": "payer_code",
    "policy_holder": {
      "last_name": "last_name",
      "first_name": "first_name",
      "middle_name": "middle_name",
      "address": {
        "street_address": "street_address",
        "line2": "line2",
        "city": "city",
        "state": "state",
        "postal_code": "123456789"
      }
    },
    "workers_comp": "Y",
    "date_of_injury": "date_of_injury"
  },
  "secondary_insurance": {
    "id": "id",
    "name": "name",
    "group_number": "group_number",
    "employer_name": "employer_name",
    "patient_relationship": "1",
    "policy_number": "policy_number",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "payer_code": "payer_code",
    "policy_holder": {
      "last_name": "last_name",
      "first_name": "first_name",
      "middle_name": "middle_name",
      "address": {
        "street_address": "street_address",
        "line2": "line2",
        "city": "city",
        "state": "state",
        "postal_code": "123456789"
      }
    }
  },
  "courtesy_copy": [
    {
      "type": "A",
      "text": "text",
      "attention_line": "attention_line"
    }
  ],
  "processing_instructions": {
    "priority": "routine"
  },
  "specimens": [
    {
      "alternate_id": "alternate_id",
      "specimen_characteristics": [
        {
          "identifier": "identifier",
          "description": "description",
          "source_id": "source_id",
          "source_site_modifier": [
            {
              "identifier": "identifier"
            }
          ],
          "collection_date": "collection_date"
        }
      ],
      "collected_in_house": true,
      "collection_date": "collection_date",
      "clinical_comments": "clinical_comments",
      "test_codes": [
        {
          "id": "id",
          "name": "name",
          "aoes": [
            {
              "id": "id",
              "text": "text",
              "responses": [
                {
                  "value": "value",
                  "label": "label"
                }
              ],
              "response_time": "response_time"
            }
          ],
          "aoe_code": "DEPRECATED",
          "diagnoses": [
            {
              "code": "code",
              "description": "description"
            }
          ]
        }
      ]
    }
  ]
}'

Example Request Body

{
  "account": {
    "number": "numberaa",
    "site_name": "site_name",
    "phone_number": "phone_number",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    }
  },
  "patient": {
    "external_id": "external_id",
    "alternate_id": "alternate_id",
    "last_name": "SMITH",
    "first_name": "JAMES",
    "middle_name": "S",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "date_of_birth": "2019-05-17",
    "gender": "M",
    "race": "C",
    "ethnicity": "H",
    "phone_number": "9195552344",
    "email": "PATIENT@EXAMPLE.COM",
    "patient_class": "I",
    "gender_identities": [
      {
        "id": "446151000124109",
        "description": "description"
      }
    ],
    "sexual_orientations": [
      {
        "id": "38628009",
        "description": "description"
      }
    ]
  },
  "ordering_provider": {
    "ids": {
      "npi": "npiaaaaaaa",
      "upin": "upin",
      "local_id": "local_id",
      "provider_num": "provider_num"
    },
    "last_name": "last_name",
    "first_name": "first_name"
  },
  "authorizing_provider": {
    "ids": {
      "npi": "npiaaaaaaa",
      "upin": "upin",
      "local_id": "local_id",
      "provider_num": "provider_num"
    },
    "last_name": "last_name",
    "first_name": "first_name"
  },
  "next_of_kin": {
    "last_name": "last_name",
    "first_name": "first_name",
    "middle_name": "middle_name",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "phone_number": "9193233234"
  },
  "guarantor": {
    "last_name": "last_name",
    "first_name": "first_name",
    "middle_initial": "middle_initial",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "phone_number": "9195552344",
    "patient_relationship": "1",
    "employer_name": "employer_name",
    "charge_adjustment_code": "FH000",
    "household_annual_income": 9624,
    "household_size": 4
  },
  "sending_application": "sending_application",
  "receiving_application": "receiving_application",
  "sending_facility": "sending_facility",
  "receiving_facility": "receiving_facility",
  "control_id": "control_id",
  "bill_type": "C",
  "primary_insurance": {
    "id": "id",
    "name": "name",
    "group_number": "group_number",
    "employer_name": "employer_name",
    "patient_relationship": "1",
    "policy_number": "policy_number",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "payer_code": "payer_code",
    "policy_holder": {
      "last_name": "last_name",
      "first_name": "first_name",
      "middle_name": "middle_name",
      "address": {
        "street_address": "street_address",
        "line2": "line2",
        "city": "city",
        "state": "state",
        "postal_code": "123456789"
      }
    },
    "workers_comp": "Y",
    "date_of_injury": "date_of_injury"
  },
  "secondary_insurance": {
    "id": "id",
    "name": "name",
    "group_number": "group_number",
    "employer_name": "employer_name",
    "patient_relationship": "1",
    "policy_number": "policy_number",
    "address": {
      "street_address": "street_address",
      "line2": "line2",
      "city": "city",
      "state": "state",
      "postal_code": "123456789"
    },
    "payer_code": "payer_code",
    "policy_holder": {
      "last_name": "last_name",
      "first_name": "first_name",
      "middle_name": "middle_name",
      "address": {
        "street_address": "street_address",
        "line2": "line2",
        "city": "city",
        "state": "state",
        "postal_code": "123456789"
      }
    }
  },
  "courtesy_copy": [
    {
      "type": "A",
      "text": "text",
      "attention_line": "attention_line"
    }
  ],
  "processing_instructions": {
    "priority": "routine"
  },
  "specimens": [
    {
      "alternate_id": "alternate_id",
      "specimen_characteristics": [
        {
          "identifier": "identifier",
          "description": "description",
          "source_id": "source_id",
          "source_site_modifier": [
            {
              "identifier": "identifier"
            }
          ],
          "collection_date": "collection_date"
        }
      ],
      "collected_in_house": true,
      "collection_date": "collection_date",
      "clinical_comments": "clinical_comments",
      "test_codes": [
        {
          "id": "id",
          "name": "name",
          "aoes": [
            {
              "id": "id",
              "text": "text",
              "responses": [
                {
                  "value": "value",
                  "label": "label"
                }
              ],
              "response_time": "response_time"
            }
          ],
          "aoe_code": "DEPRECATED",
          "diagnoses": [
            {
              "code": "code",
              "description": "description"
            }
          ]
        }
      ]
    }
  ]
}

json

Example Responses

{
  "order": {
    "account": {
      "number": "numberaa",
      "site_name": "site_name",
      "phone_number": "phone_number",
      "address": {
        "street_address": "street_address",
        "line2": "line2",
        "city": "city",
        "state": "state",
        "postal_code": "123456789"
      }
    },
    "patient": {
      "external_id": "external_id",
      "alternate_id": "alternate_id",
      "last_name": "SMITH",
      "first_name": "JAMES",
      "middle_name": "S",
      "address": {
        "street_address": "street_address",
        "line2": "line2",
        "city": "city",
        "state": "state",
        "postal_code": "123456789"
      },
      "date_of_birth": "2019-05-17",
      "gender": "M",
      "race": "C",
      "ethnicity": "H",
      "phone_number": "9195552344",
      "email": "PATIENT@EXAMPLE.COM",
      "patient_class": "I",
      "gender_identities": [
        {
          "id": "446151000124109",
          "description": "description"
        }
      ],
      "sexual_orientations": [
        {
          "id": "38628009",
          "description": "description"
        }
      ]
    },
    "ordering_provider": {
      "ids": {
        "npi": "npiaaaaaaa",
        "upin": "upin",
        "local_id": "local_id",
        "provider_num": "provider_num"
      },
      "last_name": "last_name",
      "first_name": "first_name"
    },
    "authorizing_provider": {
      "ids": {
        "npi": "npiaaaaaaa",
        "upin": "upin",
        "local_id": "local_id",
        "provider_num": "provider_num"
      },
      "last_name": "last_name",
      "first_name": "first_name"
    },
    "next_of_kin": {
      "last_name": "last_name",
      "first_name": "first_name",
      "middle_name": "middle_name",
      "address": {
        "street_address": "street_address",
        "line2": "line2",
        "city": "city",
        "state": "state",
        "postal_code": "123456789"
      },
      "phone_number": "9193233234"
    },
    "guarantor": {
      "last_name": "last_name",
      "first_name": "first_name",
      "middle_initial": "middle_initial",
      "address": {
        "street_address": "street_address",
        "line2": "line2",
        "city": "city",
        "state": "state",
        "postal_code": "123456789"
      },
      "phone_number": "9195552344",
      "patient_relationship": "1",
      "employer_name": "employer_name",
      "charge_adjustment_code": "FH000",
      "household_annual_income": 9624,
      "household_size": 4
    },
    "sending_application": "sending_application",
    "receiving_application": "receiving_application",
    "sending_facility": "sending_facility",
    "receiving_facility": "receiving_facility",
    "control_id": "control_id",
    "bill_type": "C",
    "primary_insurance": {
      "id": "id",
      "name": "name",
      "group_number": "group_number",
      "employer_name": "employer_name",
      "patient_relationship": "1",
      "policy_number": "policy_number",
      "address": {
        "street_address": "street_address",
        "line2": "line2",
        "city": "city",
        "state": "state",
        "postal_code": "123456789"
      },
      "payer_code": "payer_code",
      "policy_holder": {
        "last_name": "last_name",
        "first_name": "first_name",
        "middle_name": "middle_name",
        "address": {
          "street_address": "street_address",
          "line2": "line2",
          "city": "city",
          "state": "state",
          "postal_code": "123456789"
        }
      },
      "workers_comp": "Y",
      "date_of_injury": "date_of_injury"
    },
    "secondary_insurance": {
      "id": "id",
      "name": "name",
      "group_number": "group_number",
      "employer_name": "employer_name",
      "patient_relationship": "1",
      "policy_number": "policy_number",
      "address": {
        "street_address": "street_address",
        "line2": "line2",
        "city": "city",
        "state": "state",
        "postal_code": "123456789"
      },
      "payer_code": "payer_code",
      "policy_holder": {
        "last_name": "last_name",
        "first_name": "first_name",
        "middle_name": "middle_name",
        "address": {
          "street_address": "street_address",
          "line2": "line2",
          "city": "city",
          "state": "state",
          "postal_code": "123456789"
        }
      }
    },
    "courtesy_copy": [
      {
        "type": "A",
        "text": "text",
        "attention_line": "attention_line"
      }
    ],
    "processing_instructions": {
      "priority": "routine"
    },
    "specimens": [
      {
        "alternate_id": "alternate_id",
        "specimen_characteristics": [
          {
            "identifier": "identifier",
            "description": "description",
            "source_id": "source_id",
            "source_site_modifier": [
              {
                "identifier": "identifier"
              }
            ],
            "collection_date": "collection_date"
          }
        ],
        "collected_in_house": true,
        "collection_date": "collection_date",
        "clinical_comments": "clinical_comments",
        "test_codes": [
          {
            "id": "id",
            "name": "name",
            "aoes": [
              {
                "id": "id",
                "text": "text",
                "responses": [
                  {
                    "value": "value",
                    "label": "label"
                  }
                ],
                "response_time": "response_time"
              }
            ],
            "aoe_code": "DEPRECATED",
            "diagnoses": [
              {
                "code": "code",
                "description": "description"
              }
            ]
          }
        ]
      }
    ]
  },
  "validationIssues": [
    {
      "id": "id",
      "field": "field",
      "message": "message",
      "attributes": {},
      "severity": "info"
    }
  ]
}

json

application/json

Overview