Lab Network iframe

facilityType

One of the facility types available for ordering.

Identifies the type of the order.

patient

Patient JSON.

Defines the patient for the order.

callbackUrl

The callback URL.

It is required to use https scheme for security reasons

Determines where the response will be sent to.
Read more about the response.

You can include some additional parameters to that URL. Any you need to pass to the callback.

state

Any string. Optional.

A value used by the client to maintain state between the request and callback.
Recommended to prevent XSRF attacks.
If specified then the value will be included to the callback invocation. See Chapter 3.2. Place Order Callback

tz-offset

Optional.

Timezone offset as minutes from UTC

id2

Optional

MRN in your system or External ID

className

Required

Will always be "com.informedika.common.shared.vo.PatientVO"

firstName

Any string.
Required

The given name of the patient.

middleName

Any string.
Optional

The middle name of the patient.

lastName

Any string.
Required.

The surname of the patient.

title

One of the following constants:

• mr
• ms
  Optional

The desired patient’s title.

gender

One of the following constants:

• male
• female
  Required

The gender of the guarantor.

dateOfBirth

Local Date JSON
Required.

The date of birth of the patient.

address

JSON Address
Optional

Patient address.

license

Optional string

License ID

ssn

Optional string

Social Security Number

maritalStatus

One of the following constants:

• married
• single
• divorced
• widowed
• separated
• domesticPartner
• livingTogether
• unknown
  Optional

The marital status of the patient.

language

One of the following constants:

• en
• es
• pt
• zh
• ru
• fr
• de
• it
• jp
• un
• dc
  Optional

Language preference

needTranslator

True or False
Optional

Determines if patient needs a translator services

races

One or several of the following constants:

• indian
• asian
• black
• hawaiian
• white
• unknown
• declined
  Optional

The list of races of the patient.

ethnicity

One of the following constants:

• hispanicLatino
• notHispanicLatino
• unknown
• declined
  Optional

homePhone

A phone number.
Optional

Home phone number.

mobilePhone

A phone number.
Optional

Mobile phone number.

workPhone

A phone number.
Optional

Work phone number.

workPhoneExt

Any digits.
Optional

Work phone extension

email

An email address.
Optional

The valid email address.

contactMethod

One of the following constants:

• email
• phone
• mail
  Optional

Prefered contact method.

primaryInsurance

An insurance JSON
Optional

Primary insurance.

secondaryInsurance

An insurance JSON
Optional

Secondary insurance.

tertiaryInsurance

An insurance JSON
Optional

Tertiary insurance.

provider

Any string.
Required

The name of the insurance provider.

policyId

Any string.
Required

Policy number/id

groupNumber

Any string.
Optional

Policy group number if available

providerInfo

A provider JSON
Required

Describes the payer for the given insurance plan.

insured

A guarantor JSON
Required

Defines the guarantor.

name

Any string.
Required.

The name of the insurer.

phone

A phone number.

A valid US phone number.

address

JSON Address

The claims address of the insurance provider.

firstName

Any string.
Mandatory.

Given name of the guarantor.

lastName

Any string.
Mandatory.

Last name of the guarantor.

gender

One of the following constants:

• male
• female
  Required

Gender of the guarantor.

dateOfBirth

Local Date JSON
Required

Date of birth of the guarantor.

employer

Any string.
Optional

Company name where the guarantor works if available.

relationship

One of the following constants:

• self
• spouse
• parent
• other
  Mandatory.

Identifies the relationship between the patient and the guarantor.

phone

A phone number.
Required

Valid US phone number.

address

JSON Address
Required

Guarantor’s mailing address.

address1

Any string
Required

Address 1

address2

Any string
Optional

Address 2

city

Any string
Required

City name.

state

A state code
Required

Two-letters state code.

zip

5-digit ZIP code.
Required

Postal ZIP code.

country

USA
Required

Country code. A predefined constant.

year

1900
Required
Mandatory

Year.

month

1 - 12
Required
Mandatory

Month number.

day

1 - 31
Required
Mandatory

Day of the month.

responseCode

The result of Place New Order Wizard. Possible values are:

• success -- a new order has been successfully placed;
• canceled-- the process has been canceled by the user;
• error-- an error has occurred during the process.

responseMessage

Optional. Can provide error description in case when responseCode = error

state

The state parameter, if it was included to the initial request.

orderId

Optional. Placed order ID in case when responseCode = success for use in Get Order Request. See Chapter 3.3. Get Order Request

orderIds

Optional. Contains joined string (separated by ‘|’) of placed orders IDs in case if order was splitted during placement

orderId

String. Mandatory

Internal HealthGorilla order identifier.

labReferenceId

Number. Mandatory

Order number for reference by facility performing order. Has label ‘Lab Reference ID’ on the requisition form.

status

One of the following constants:

• submitted
• submitFailed
• sent
• scheduled
  Mandatory

Order status

electronicOrdering

Boolean. Mandatory

Electronic submission flag. True indicates that the order was electronically transferred to the vendor.

destination

One of the following constants:

• psc
• lab
  Mandatory

Type of order destination. If specimen was not collected then destination will be ‘psc’ that stands of Patient Service Center. Otherwise ‘lab’

executionDateFormatted

String. Optional

Date test to be performed if applicable.

executionLength

Number. Optional

Length of surgery (for Surgical Centers only)

collectionDate

Date. Optional

Specimen collection date/time if applicable

submissionDate

Date. Mandatory

Order submission / creation date/time

facilityName

String. Mandatory

vender / facility name that will be performing an order

clientNumber

String. Optional

Clinic account number given if applicable. Has label ‘Client #’ at requisition form.

senderName

String. Mandatory

Order creator full name

senderPracticeName

String. Mandatory

Order creator practice name

senderPracticeAddressFormatted

String. Mandatory

Order creator practice address formatted as: Field",
, "h-1", "Values ,

senderPracticePhone

String. Optional

Order’s creator practice phone

senderPracticeFax

String. Optional

Order’s creator practice fax

refPhysicianProviderName

String. Mandatory

Order’s referring physician full name.

refPhysicianProviderNPI

String. Optional

Order’s referring physician NPI number

refPhysicianProviderAccountNumber

String. Optional

Order’s referring physician personal account number given by order vendor if applicable

billTo

One of the following constants:

• self
• patient
• guarantor
• thirdParty
  Optional

Order billing type, determines who is the payer for an order. ‘Self’ means ordering practice.

orderNote

String. Optional

Order note specified by order creator

highPriority

Boolean. Optional

High priority/STAT order flag

patient

PatientSnapshot object

Order’s patient information

diagnoses

List of DiagnosisSnapshot object

List of patient diagnoses specified in order

orderTests

List of OrderTestSnapshot objects

List of order test items

guarantor

GuarantorSnapshot object

Patient guarantor info if order’s ‘billTo’ has ‘guarantor’ value

insurances

List of InsuranceSnapshot

List of insurances available for patient in case order ‘billTo’ has ‘thirdParty’ value.
Maximum 3 insurances

orderAoes

List of AoeSnapshot

List of Ask-on-Entry questions (order level) required for some order tests

altId

Number.

Human readable ID of patient for future reference. Has ‘Pat ID #’ label on the requisition form

fullname

Patient’s full name

dobFormatted

Patient’s Date-of-Birth formatted as MM/DD/YYYY

gender

One of the following values:

• male
• female
  Mandatory

Patient’s gender

addressFormatted

String. Optional

Patient’s address formatted as:
"h-0, "Fiel, ,
" zip

phone

String. Optional

Patient’s phone

code

String. Mandatory

Order test code

name

String. Mandatory

Order test name

note

String. Optional

Short comment specified for ordered test

priority

One of the following values:

• STAT
• Unscheduled
  Optional

Order test priority flag

aoes

List of AoeSnapshot objects. Optional

List of ask at order entry questions and answers (test level)

name

String

Guarantor’s fullname

addressFormatted

String

Guarantor’s address formatted as: "h-0":, Field", "h- zip

phone

String

Guarantor’s contact phone

relationship

One of the following values:

• self
• spouse
• parent
• other
  Mandatory

relationship of guarantor to patient

primacy

One of the following value:

• primary
• secondary
• tertiary
  Mandatory

Insurance primacy constant

insured

GuarantorSnapshot

Information about insurance holder

insurer

String. Mandatory

Insurance provider name

insuranceNumber

String. Mandatory

Insurance policy number