Schemas

Download schema

Address

line1

string · required

city

string · required

state

string · required

zip

string · required

line2

string

LocationAddress

line1

string · required

city

string · required

state

string · required

zip

string · required

latitude

number · float · required

longitude

number · float · required

line2

string

timeZone

string

The timezone of the location. Timezone identifiers are defined at https://www.iana.org/time-zones.

Example: America/Kentucky/Louisville

utcOffset

string

The current UTC offset of the location's timezone. The offset is computed by retrieving the current time (as reported by the server clock) and deriving the UTC offset from that value.

Example: -04:00

Location

id

integer

name

string

LocationAddress

object[]

opensAt

string

Optional field that indicates the general opening hour of the location.

Example: 08:00 AM

closesAt

string

Optional field that indicates the general closing hour of the location.

Example: 05:00 PM

lunchStart

string

Optional field that indicates the lunch start at the location.

Example: 12:00 PM

lunchEnd

string

Optional field that indicates the lunch end at the location.

Example: 01:00 PM

ServiceWithHours[]

Service

serviceId

integer

serviceName

string

ServiceWithHours

serviceId

integer

serviceName

string

object[]

Each entry is a group of days that have the same schedule.

LocationSearchResult

id

integer

name

string

LocationAddress

object[]

opensAt

string

Optional field that indicates the general opening hour of the location.

Example: 08:00 AM

closesAt

string

Optional field that indicates the general closing hour of the location.

Example: 05:00 PM

lunchStart

string

Optional field that indicates the lunch start at the location.

Example: 12:00 PM

lunchEnd

string

Optional field that indicates the lunch end at the location.

Example: 01:00 PM

ServiceWithHours[]

distanceFromStartingPoint

number · float

Distance in miles from the starting search point.

Example: 1.2

Patient

firstName

string · required

lastName

string · required

gender

string · enum · required

Enum values:

dateOfBirth

string · pattern: ^\d{4}-\d{2}-\d{2}$ · required

Address · required

email

string

If email is provided during appointment scheduling, Labcorp sends a confirmation email to the patient for the new appointment.

phone

string · pattern: ^\d{10}$

If a mobile phone is provided during appointment scheduling, Labcorp sends a confirmation text to the patient for the new appointment.

deIdentifiedPatient

boolean

Optional flag to indicate if this is a de-identified patient record. Defaults to false if not provided.

Appointment

locationId

integer · required

Patient · required

serviceId

integer · required

appointmentTime

string · pattern: ^\d{4}-\d{2}-\d{2}T\… · required

confirmationNumber

string

Appointment number if this is an existing appointment. Required for appointment updates.

Example: ABC123456

qrCode

string

A base64-encoded PNG image that represents a QR code used by the patient to check in for their appointment at a Labcorp patient service center.

confirmationUrl

string

Labcorp confirmation URL for this appointment.

AppointmentTracking

status

string · enum · required

Last known status of the appointment, where Pending indicates the schedule was started but not completed.

Enum values:

Pending

Scheduled

Cancelled

confirmationNumber

string

AuthorizationError

Authorization error returned from the access gateway.

message

string

CancelAppointment

Cancel appointment request.

firstName

string · required

Patient's first name.

lastName

string · required

Patient's last name.

Error

Generic error message.

statusCode

integer · required

Status code of the response.

error

string · required

Reason phrase of the response.

message

string

Optional descriptive string of the error to provide more context.

ValidationError

Request validation error.

statusCode

integer · required

Status code of the response.

error

string · required

Reason phrase of the response.