Schemas
RequisitionRequest
csidreqControlNumaccountNumberAddress
street_addresscitystatepostal_code^[0-9]{5}([0-9]{4})?… · requiredUSPS postal code either 5 digit or 5+4 format using only digits.
line2Account
number^[0-9]+$ · requiredYour Client ID, the eight-digit account number that a Labcorp Salesperson or Account Manager has assigned to your organization.
site_nameThe account name associated with the Order.
phone_numberThe phone number associated with the Order.
The address associated with the Order.
PatientBase
external_idThe client assigned Patient Identifier.
last_name^[a-zA-Z0-9 '-]+$ · requiredThe patient's last name.
first_name^[a-zA-Z0-9 '-]+$ · requiredThe patient's first name.
The patient's address.
date_of_birthThe date of birth for the patient. Format is YYYY-MM-DD.
genderThe patient's gender. Used for certain test procedures that require gender for calculation of result.
M- MaleF- FemaleN- Not Given
raceThe patient's race. Used for state reporting and for certain test procedures.
C- Caucasian / WhiteB- Black or African AmericanI- American Indian / Native American / Alaska NativeA- AsianP- Native Hawaiian or Other Pacific IslanderO- OtherX- Not Indicated
ethnicityThe patient's ethnic group. Used for state reporting and certain test procedures.
H- Hispanic or LatinoN- Not Hispanic or LatinoU- Unknown.
phone_number^([0-9]{10})$ · requiredThe patient's phone number using only digits.
emailThe patient's email address. Required for certain tests which necessitate communication with the patient.
patient_classFor billing purposes.
I- InpatientO- OutpatientN- Not applicable
alternate_idSecondary client assigned Patient Identifier.
middle_name^[a-zA-Z0-9 '-]+$The patient's middle name or initial.
IncomingGenderIdentity
idGender Identity - Required when Patient State is New Jersey.
446151000124109- Male446141000124107- Female407377005- Female-to-Male (FTM)/Transgender Male/Trans Man407376001- Male-to-Female (MTF)/Transgender Female/Trans Woman446131000124102- Genderqueer, neither exclusively male nor femaleOTH- Additional gender category or other, please specifyASKU- Choose not to disclose
descriptionExplanatory text for OTH ID. Field should not be provided for other IDs.
IncomingOrientation
idSexual Orientation - Required when Patient State is New Jersey.
38628009- Lesbian, gay, or homosexual20430005- Straight or heterosexual42035005- BisexualOTH- Something else, please describeUNK- Don’t knowASKU- Choose not to disclose
descriptionExplanatory text for OTH ID. Field should not be provided for other IDs.
IncomingPatient
external_idThe client assigned Patient Identifier.
last_name^[a-zA-Z0-9 '-]+$ · requiredThe patient's last name.
first_name^[a-zA-Z0-9 '-]+$ · requiredThe patient's first name.
The patient's address.
date_of_birthThe date of birth for the patient. Format is YYYY-MM-DD.
genderThe patient's gender. Used for certain test procedures that require gender for calculation of result.
M- MaleF- FemaleN- Not Given
raceThe patient's race. Used for state reporting and for certain test procedures.
C- Caucasian / WhiteB- Black or African AmericanI- American Indian / Native American / Alaska NativeA- AsianP- Native Hawaiian or Other Pacific IslanderO- OtherX- Not Indicated
ethnicityThe patient's ethnic group. Used for state reporting and certain test procedures.
H- Hispanic or LatinoN- Not Hispanic or LatinoU- Unknown.
phone_number^([0-9]{10})$ · requiredThe patient's phone number using only digits.
emailThe patient's email address. Required for certain tests which necessitate communication with the patient.
patient_classFor billing purposes.
I- InpatientO- OutpatientN- Not applicable
alternate_idSecondary client assigned Patient Identifier.
middle_name^[a-zA-Z0-9 '-]+$The patient's middle name or initial.
Provider
This data structure combines the source_table with the provider id in order to explicitly restrict the number and kind of IDs that a provider can have. A provider must provide an npi and may include one or more of the ID types (upin, local_id, provider_num)
last_name^[a-zA-Z0-9 '-]+$ · requiredThe ordering provider's last name.
first_name^[a-zA-Z0-9 '-]+$The ordering provider's first initial or name.
NextOfKin
last_name^[a-zA-Z0-9 '-]+$ · requiredLast name of the Next of Kin
first_name^[a-zA-Z0-9 '-]+$ · requiredFirst name of the Next of Kin
Address for the Next of Kin
phone_number^([0-9]{10})$ · requiredPhone number for the Next of Kin using only digits.
middle_name^[a-zA-Z0-9 '-]+$Middle name or initials of the Next of Kin
Guarantor
last_name^[a-zA-Z0-9 '-]+$ · requiredfirst_name^[a-zA-Z0-9 '-]+$ · requiredphone_number^([0-9]{10})$ · requiredPhone number using only digits.
patient_relationshipUsed to identify the relationship of the patient to the guarantor. For demographic purposes.
1- Self2- Spouse3- Other
middle_initialemployer_nameFor demographic purposes and for Worker's Compensation claims.
charge_adjustment_codeLabcorp assigned Financial Hardship Code
household_annual_incomeCombined annual income of all members of the guarantor's household. Inclusive minimum, exclusive maximum
household_sizeNumber of people living at guarantor's primary residence. Inclusive minimum, exclusive maximum
PolicyHolder
Policy holder's address
last_name^[a-zA-Z0-9 '-]+$Last Name Of Insured (Policy Holder Last Name)
first_name^[a-zA-Z0-9 '-]+$First Name Of Insured (Policy Holder First Name)
middle_name^[a-zA-Z0-9 '-]+$Middle Name Of Insured (Policy Holder Middle Name)
Insurance
nameThe Insurance company name.
patient_relationshipInsured's relationship to patient.
1- Self2- Spouse3- Other
policy_numberPolicy number (Insurance Number / Subscriber Number / Member ID). Entered as displayed on insurance card.
The insurance company's address.
payer_codeLabcorp payer code for the insurance carrier, as listed in the Billing Table. Use 05 only for Original Medicare (Part B, including Railroad Medicare); bill Medicare Advantage plans as private insurance with their own payer code.
idThe client's or vendor's unique identifier used to identify the appropriate insurance company.
group_numberGroup Number of Insured Patient.
employer_nameInsured's Group employer name.
Information pertaining to the policy holder.
InsuranceWithWorkersCompInfo
nameThe Insurance company name.
patient_relationshipInsured's relationship to patient.
1- Self2- Spouse3- Other
policy_numberPolicy number (Insurance Number / Subscriber Number / Member ID). Entered as displayed on insurance card.
The insurance company's address.
payer_codeLabcorp payer code for the insurance carrier, as listed in the Billing Table. Use 05 only for Original Medicare (Part B, including Railroad Medicare); bill Medicare Advantage plans as private insurance with their own payer code.
workers_compFlag used to identify whether or not this is a Worker's Compensation claim.
idThe client's or vendor's unique identifier used to identify the appropriate insurance company.
group_numberGroup Number of Insured Patient.
employer_nameInsured's Group employer name.
Information pertaining to the policy holder.
date_of_injuryWhen this is a worker's compensation claim, the date on which the injury happened. Expected format YYYY-MM-DD.
CourtesyCopy
typeTo identify where the copy will be sent.
Bill Types:
A- Account Number (Delivered to FAX number in account record or if requested to account's primary route)F- FAX NumberP- Patient/Responsible Party (Delivered to Labcorp | Patient™ for registered patients. Otherwise, it will be mailed.)
textUse: To Identify the account number or the FAX number.
- Alpha, Numeric, or Special Characters
- Required for types A and F and should not be supplied for type P
- Do not submit parentheses or dashes in the FAX number.
attention_lineTo Identify the recipient.
- Alpha, Numeric, or Special Characters
- Required for types A and F and should not be supplied for type P
ProcessingInstructions
priorityIdentifies the priority that an Order should be processed with. If a valid priority value is not provided, then the Order will be processed according to routine procedures. Priority Types:
- routine - The Order will be processed normally.
- stat - The Order will be processed according to LabCorp's STAT Order handling procedures. A Phone call to LabCorp customer service is required in order to notify LabCorp of the STAT test.
IncomingOrderBase
Account information of the calling system placing the order.
The patient information for whom the labs are being ordered.
Information identifying the Guarantor.
sending_applicationTo identify vendor for routing purposes through LCS. Assigned by Labcorp and used for translation. This field must match the assigned Vendor Mnemonic.
- No control or whitespace characters except space
- ampersands
- backslashes (\)
- carets (^)
- pipes (|)
- or any byte value > 0x7d
receiving_applicationTo identify the Labcorp System receiving the orders. More could be added in the future.
- No control or whitespace characters except space
- ampersands
- backslashes (\)
- carets (^)
- pipes (|)
- or any byte value > 0x7d
sending_facilityThe sending facility. This field must match the Client Site ID (CSID).
- No control or whitespace characters except space
- ampersands
- backslashes (\)
- carets (^)
- pipes (|)
- or any byte value > 0x7d
receiving_facilityUsed for routing through the Labcorp system.
- No control or whitespace characters except space
- ampersands
- backslashes (\)
- carets (^)
- pipes (|)
- or any byte value > 0x7d
control_idThe message identifier.
- No control or whitespace characters except space
- ampersands
- backslashes (\)
- carets (^)
- pipes (|)
- or any byte value > 0x7d
bill_typeUsed to determine responsible "Bill to" party.
Bill Types:
C- ClientP- PatientT- Third Party
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.
Information about the Next of Kin if the patient is < 17 years old.
Primary insurance to used for billing.
Secondary insurance used for billing.
Used when a courtesy copy of the report is requested.
Used to set the priority of the Order
SourceSiteModifier
identifierProvides an identifier that contains modifying or qualifying description(s) about the specimen source.
SpecimenCharacteristics
identifierUnique identifier for the specimen as referenced by the Placer application, the Filler application or both. The value sent in this field should be the identification value sent on the specimen container.
collection_dateThe date and time when the specimen was acquired from the source. Expected format YYYY-MM-DDTHH:mm.
descriptionDescription about the specimen to be sent.
source_idProvides an identifier to specify the source site from which the specimen was obtained.
AoeResponse
valueThe AOE response value
labelLabel is filled in by the server. A human readable label representing the AOE response.
AOE
idThe identifier for the ask on entry (AOE) question.
textThe Ask on entry question text.
AOE Response.
response_timeFor orders, to identify when the answer was determined, i.e., when the answer to the AOE was acquired. Expected format YYYY-MM-DDTHH:mm. Note: if the timezone portion is not specified, UTC is assumed.
Observation
idFor Orders this is the Labcorp test number that was ordered (normally six characters). Must include exact test code including any leading zeros.
nameName of test ordered.
aoe_codeDiagnosis
codePhysician's indication of patient's diagnosis, which is used by some payors to validate the need for ordering laboratory procedures.
descriptionThe diagnosis description.
ObservationWithDiagnoses
idFor Orders this is the Labcorp test number that was ordered (normally six characters). Must include exact test code including any leading zeros.
nameName of test ordered.
The diagnosis codes for this order.
Required or Third Party Bill. Optional for Client Bill and Patient Bill.
aoe_codeSpecimen
collected_in_houseFlag that denotes whether the sample was collected by the provider.
The test codes (observations) for this specimen.
alternate_idAlternate client specific accessioning or specimen identification number.
If an Order contains a histology Observation, the histology Observation, and any associated SpecimenCharacteristics,
must exist in its own parent Specimen without any other Observation objects.
specimen_characteristics must exist if parent Specimen contains a histology Observation.
specimen_characteristics must not exist if parent Specimen does not contain a histology Observation.
collection_dateRecord of the date and time the specimen was collected. Required if specimen is collected in-house. Format is YYYY-MM-DDTHH:MM.
clinical_commentsClinical comments added by the provider.
Note: The Line Feed character is allowed for this field
IncomingOrder
Account information of the calling system placing the order.
The patient information for whom the labs are being ordered.
Information identifying the Guarantor.
sending_applicationTo identify vendor for routing purposes through LCS. Assigned by Labcorp and used for translation. This field must match the assigned Vendor Mnemonic.
- No control or whitespace characters except space
- ampersands
- backslashes (\)
- carets (^)
- pipes (|)
- or any byte value > 0x7d
receiving_applicationTo identify the Labcorp System receiving the orders. More could be added in the future.
- No control or whitespace characters except space
- ampersands
- backslashes (\)
- carets (^)
- pipes (|)
- or any byte value > 0x7d
sending_facilityThe sending facility. This field must match the Client Site ID (CSID).
- No control or whitespace characters except space
- ampersands
- backslashes (\)
- carets (^)
- pipes (|)
- or any byte value > 0x7d
receiving_facilityUsed for routing through the Labcorp system.
- No control or whitespace characters except space
- ampersands
- backslashes (\)
- carets (^)
- pipes (|)
- or any byte value > 0x7d
control_idThe message identifier.
- No control or whitespace characters except space
- ampersands
- backslashes (\)
- carets (^)
- pipes (|)
- or any byte value > 0x7d
bill_typeUsed to determine responsible "Bill to" party.
Bill Types:
C- ClientP- PatientT- Third Party
An array of specimens that will be sent to Labcorp for testing.
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.
Information about the Next of Kin if the patient is < 17 years old.
Primary insurance to used for billing.
Secondary insurance used for billing.
Used when a courtesy copy of the report is requested.
Used to set the priority of the Order
ValidationIssue
idThe identifier for the validation issue.
fieldThe field that failed validation.
messageMessage that explains why the field failed validation.
severityAn optional severity indication. If a value is not provided, a severity level of warning may be assumed.
info- Unlikely to cause problems with order processing.warning- Will likely cause problems with order processing, up to and including order processing failure. Clients should make a strong effort to prevent all validation issues with severity ofwarning.error- This validation issue has caused an order processing failure.
Notification
messageA human readable message.
Exact message content is subject to change without notice. Not intended to be machine readable.
DO NOT build business logic that relies on the content of this message.
Barcode
barcode1The first barcode string.
barcode2The overflow barcode string.
Data that overflowed the second barcode that needs to be displayed on the requisition form.
Patient
external_idThe client assigned Patient Identifier.
last_name^[a-zA-Z0-9 '-]+$ · requiredThe patient's last name.
first_name^[a-zA-Z0-9 '-]+$ · requiredThe patient's first name.
The patient's address.
date_of_birthThe date of birth for the patient. Format is YYYY-MM-DD.
genderThe patient's gender. Used for certain test procedures that require gender for calculation of result.
M- MaleF- FemaleN- Not Given
raceThe patient's race. Used for state reporting and for certain test procedures.
C- Caucasian / WhiteB- Black or African AmericanI- American Indian / Native American / Alaska NativeA- AsianP- Native Hawaiian or Other Pacific IslanderO- OtherX- Not Indicated
ethnicityThe patient's ethnic group. Used for state reporting and certain test procedures.
H- Hispanic or LatinoN- Not Hispanic or LatinoU- Unknown.
phone_number^([0-9]{10})$ · requiredThe patient's phone number using only digits.
emailThe patient's email address. Required for certain tests which necessitate communication with the patient.
patient_classFor billing purposes.
I- InpatientO- OutpatientN- Not applicable
alternate_idSecondary client assigned Patient Identifier.
middle_name^[a-zA-Z0-9 '-]+$The patient's middle name or initial.
OrderBase
Account information of the calling system placing the order.
The patient information for whom the labs are being ordered.
Information identifying the Guarantor.
sending_applicationTo identify vendor for routing purposes through LCS. Assigned by Labcorp and used for translation. This field must match the assigned Vendor Mnemonic.
receiving_applicationTo identify the Labcorp System receiving the orders. More could be added in the future.
sending_facilityThe sending facility.
receiving_facilityUsed for routing through the Labcorp system.
control_idThe message identifier.
bill_typeUsed to determine responsible "Bill to" party.
Bill Types:
C- ClientP- PatientT- Third Party
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.
Information about the Next of Kin if the patient is < 17 years old.
Primary insurance to used for billing.
Secondary insurance used for billing.
Used when a courtesy copy of the report is requested.
Used to set the priority of the Order
OrderSingleSpecimen
Account information of the calling system placing the order.
The patient information for whom the labs are being ordered.
Information identifying the Guarantor.
sending_applicationTo identify vendor for routing purposes through LCS. Assigned by Labcorp and used for translation. This field must match the assigned Vendor Mnemonic.
receiving_applicationTo identify the Labcorp System receiving the orders. More could be added in the future.
sending_facilityThe sending facility.
receiving_facilityUsed for routing through the Labcorp system.
control_idThe message identifier.
bill_typeUsed to determine responsible "Bill to" party.
Bill Types:
C- ClientP- PatientT- Third Party
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.
Information about the Next of Kin if the patient is < 17 years old.
Primary insurance to used for billing.
Secondary insurance used for billing.
Used when a courtesy copy of the report is requested.
Used to set the priority of the Order
OrderResponse
workflowIdA server generated unique ID for the order workflow also serves as the ID for the original order.
A dictionary consisting of unique source order IDs as keys and the corresponding requisition data as values.
An array of validation issues that were found, but which did not stop processing of the Order.
Optional array of notifications.
ErrorResponse401
messageHuman-readable description of the authorization failure.
requestIdAPI Gateway request identifier, included on gateway-generated responses to correlate with server-side access logs.
ErrorResponse403
messageHuman-readable description of why the request was denied.
requestIdAPI Gateway request identifier, included on gateway-generated (authorizer) responses to correlate with server-side access logs.
ErrorResponseInternal
messageGeneric, non-specific server error message. Internal details are not exposed to clients; use the requestId to correlate with server logs.
requestIdAPI Gateway request identifier, included on gateway-generated responses to correlate with server-side access logs.
Order
Account information of the calling system placing the order.
The patient information for whom the labs are being ordered.
Information identifying the Guarantor.
sending_applicationTo identify vendor for routing purposes through LCS. Assigned by Labcorp and used for translation. This field must match the assigned Vendor Mnemonic.
receiving_applicationTo identify the Labcorp System receiving the orders. More could be added in the future.
sending_facilityThe sending facility.
receiving_facilityUsed for routing through the Labcorp system.
control_idThe message identifier.
bill_typeUsed to determine responsible "Bill to" party.
Bill Types:
C- ClientP- PatientT- Third Party
An array of specimens that will be sent to Labcorp for testing.
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.
Information about the Next of Kin if the patient is < 17 years old.
Primary insurance to used for billing.
Secondary insurance used for billing.
Used when a courtesy copy of the report is requested.
Used to set the priority of the Order
ValidateResponse
The Order that was provided.
An array of validation issues that were found. The array is empty if there are no validation issues found.