{
  "answers": [
    {
      "created_at": "2021-03-25T04:33:40Z",
      "deleted_at": "2021-03-26T04:33:40Z",
      "question": "123",
      "test": "140748306251838",
      "value": "Yes"
    }
  ],
  "bill_type": "thirdparty",
  "ccs": "131074",
  "chart_date": "2021-03-25T04:33:40Z",
  "confidential": false,
  "content": {
    "collection_datetime": null,
    "fasting_method": "fasting_random",
    "icd10_codes": [
      {
        "code": "D72.9",
        "description": "Disorder of white blood cells, unspecified"
      }
    ],
    "id": "140754512117861",
    "patient_instructions": "",
    "standing_order_end_date": null,
    "standing_order_frequency": "",
    "stat_method": "LAB_STAT_METHOD_WET_READING_PHONE",
    "test_center_notes": "",
    "tests": [
      {
        "code": "",
        "compendium_id": "3",
        "cpt_codes": 1,
        "created_at": "2020-01-27T16:17:43Z",
        "deleted_at": "2020-01-28T13:11:23Z",
        "id": "140748306251838",
        "lab_vendor_id": "3",
        "name": "TSH",
        "practice_created_id": "42",
        "procedure_class": "123",
        "questions": {
          "answers": [
            {
              "response": "5 cups"
            }
          ],
          "question": "Briefly describe any caffeine use - e.g. how many cups of coffee a day?"
        },
        "test_synonyms": "TSH"
      }
    ]
  },
  "created_at": "2021-03-25T04:33:40Z",
  "document_created_at": "2021-03-25T04:33:40Z",
  "facility": "123456",
  "facility_identifier": {
    "active": true,
    "bidi_connection": {
      "alias": "main-quest-conn",
      "id": "42",
      "priority": 1,
      "protocol": "HL7"
    },
    "compendium": "234900800000002",
    "created_date": "2023-01-01T12:00:00Z",
    "deleted_date": "2023-12-31T12:00:00Z",
    "description": "Main Lab Facility for Quest",
    "id": "123456",
    "lab_connection": "7890",
    "lab_facility": "QST123",
    "practice": "555555",
    "practice_facility": "ACCT98765",
    "practice_secondary_id": "SECID123",
    "user_facing": true,
    "vendor": {
      "display_name": "Quest Diagnostics",
      "id": "1001",
      "name": "quest"
    }
  },
  "follow_up_method": "phone",
  "id": "140754512183329",
  "ordering_physician_id": "140754510217218",
  "patient_id": "140754511659009",
  "practice_id": "140754506678276",
  "requisition_id": "140754512183329",
  "resolution": {
    "created_at": "2021-03-25T04:33:40Z",
    "deleted_at": "2021-03-26T04:33:40Z",
    "document": "140754512183329",
    "id": "140754511659009",
    "note": "Test cancelled due to insurance",
    "resolving_document": "140754512183329",
    "state": "LAB_ORDER_RESOLUTION_STATE_OUTSTANDING"
  },
  "signed_by": "140754510217218",
  "signed_date": "2021-03-25T04:33:40Z",
  "site": {
    "address": {
      "international_address": {
        "city_state_county_or_districts": [],
        "country": null,
        "lines": [],
        "postal_code": null
      },
      "us_address": {
        "city": null,
        "line1": null,
        "line2": null,
        "state": null,
        "zip_code": null
      }
    },
    "fax_number": "415-555-5678",
    "name": "Quest Diagnostics",
    "phone_number": "415-555-1234"
  },
  "special_insurance": {
    "code": "ABC12",
    "name": "Special Insurance Name"
  },
  "specimens": [
    {
      "body_site": {
        "code": "LA",
        "deleted_at": "2021-03-26T04:33:40Z",
        "text": "Left Arm"
      },
      "container_id": "12345",
      "description": "Blood sample",
      "modifiers": [
        {
          "code": "ANT",
          "sequence": 1,
          "text": "Anterior"
        }
      ],
      "test": "140748306251838"
    }
  ],
  "submissions": [
    {
      "state": "submitted",
      "state_metadata": "ERROR: Invalid insurance information",
      "time_acknowledged": "2021-03-25T04:34:00Z",
      "time_submitted": "2021-03-25T04:33:40Z"
    }
  ],
  "tags": [],
  "test_date": "2021-03-25",
  "vendor": "67191701750"
}

{
  "answers": {
    "created_at": "When the answer was created.",
    "deleted_at": "When the answer was deleted.",
    "question": "The id of the AOE question for which this answer pertains.",
    "test": "The id of the test for which this answer pertains.",
    "value": "The value entered by freetext or chosen by the ordering physician."
  },
  "bill_type": "Who is financially responsible for the order.",
  "ccs": "List of physician ids who should be cc'd on any reports.",
  "chart_date": "Date at which this order was seen in the patient's chart.",
  "confidential": "Whether the provider has marked this order as confidential. Should not be shared with a patient.",
  "content": {
    "collection_datetime": "Date and time when the specimen was collected.",
    "fasting_method": "Indicates whether the patient should be fasting for the test.",
    "icd10_codes": {
      "code": "The code of the ICD-10 diagnosis.",
      "description": "The description of the ICD-10 diagnosis."
    },
    "id": "Unique identifier for the lab order content.",
    "patient_instructions": "Instructions for the patient regarding the lab order.",
    "standing_order_end_date": "End date for a standing order, if applicable.",
    "standing_order_frequency": "Frequency of a standing order, if applicable.",
    "stat_method": "Indicates if the order is marked as stat (urgent).",
    "test_center_notes": "Notes for the test center performing the lab work.",
    "tests": {
      "code": "Code identifier for the test, if available.",
      "compendium_id": "Compendium identifier for the test, if available.",
      "cpt_codes": "List of CPT codes associated with the test.",
      "created_at": "Timestamp when the test was created.",
      "deleted_at": "Timestamp when the test was deleted, if applicable.",
      "id": "Unique identifier for the test.",
      "lab_vendor_id": "Lab vendor identifier for the test, if available.",
      "name": "Name of the test.",
      "practice_created_id": "Practice-specific identifier for the test, if available.",
      "procedure_class": "Procedure class of the test, if applicable.",
      "questions": "List of questions associated with the test.",
      "test_synonyms": "List of alternative names or synonyms for the test."
    }
  },
  "created_at": "Time at which elation created this order.",
  "document_created_at": "Time at which this order was created in whichever system created it. Could be historical or same as the created_at.",
  "facility": "An identifier that represents the facility placing the order.",
  "facility_identifier": {
    "active": "Whether the facility identifier should be used. Should be true in most cases.",
    "bidi_connection": {
      "alias": "Get the alias of the connection.",
      "id": "ID of the connection.",
      "priority": "Priority of the connection (0-65535).",
      "protocol": "Get the protocol of the connection."
    },
    "compendium": "The id of the compendium that will be used when the user selects this facility identifier.",
    "created_date": "Created date, if available.",
    "deleted_date": "Deleted date, if available.",
    "description": "The text that will displayed to users in the lab order dialog.",
    "id": "Unique identifier for the facility identifier.",
    "lab_connection": "Lab connection id, if available.",
    "lab_facility": "The id that represents the lab.",
    "practice": "Practice id.",
    "practice_facility": "The id that represents the practice; often an account number provided by the lab vendor.",
    "practice_secondary_id": "Secondary id for the practice, if available.",
    "user_facing": "Whether this facility identifier will be visible in the lab order dialog. Should be true for most cases.",
    "vendor": {
      "display_name": "Display name of the vendor.",
      "id": "ID of the vendor.",
      "name": "Name of the vendor."
    }
  },
  "follow_up_method": "Freetext field communicating how the patient should receive their results.",
  "id": "The id of the lab order in Elation's systems.",
  "ordering_physician_id": "The id of the physician who created the order.",
  "patient_id": "The id of the patient.",
  "practice_id": "The id of the practice.",
  "requisition_id": "The requisition id of the order. Can be different from the order id if and when the order was created outside of elation.",
  "resolution": {
    "created_at": "The datetime when this resolution state was created.",
    "deleted_at": "The datetime when this resolution was deleted. Should never be null because we're providing the most updated resolution.",
    "document": "Will be the same as the id of the lab order.",
    "id": "Internal id to represent the resolution state.",
    "note": "Any note that was added to represent why an order was cancelled.",
    "resolving_document": "If the order is fulfilled will indicate the document referenced. For lab orders will usually be a report.",
    "state": "The resolution state of the order."
  },
  "signed_by": "The id of the physician who signed off on the order.",
  "signed_date": "The time when the order was signed.",
  "site": {
    "address": {
      "international_address": {
        "city_state_county_or_districts": null,
        "country": null,
        "lines": null,
        "postal_code": null
      },
      "us_address": {
        "city": null,
        "line1": null,
        "line2": null,
        "state": null,
        "zip_code": null
      }
    },
    "fax_number": "The fax number of the lab site.",
    "name": "The name of the site.",
    "phone_number": "The phone number of the lab site."
  },
  "special_insurance": {
    "code": "Special insurance code.",
    "name": "Special insurance name."
  },
  "specimens": {
    "body_site": {
      "code": "The HL7 code representing the body site from which a specimen was collected",
      "deleted_at": "Represents if the body site was removed from the specimen.",
      "text": "A textual description of the body site from which the specimen was collected."
    },
    "container_id": "An identifier representing the container used to store the specimen.",
    "description": "A freetext description of the specimen.",
    "modifiers": {
      "code": "The HL7 code representing the modifier on the body site from which a specimen was collected",
      "sequence": "The cardinal position in which the modifiers should be listed.",
      "text": "A textual description of the modifier of the body site from which the specimen was collected."
    },
    "test": "The lab order test for which the specimen was collected."
  },
  "submissions": {
    "state": "The state of the electronic order submission.",
    "state_metadata": "Useful error information collected as part of the submission. Including ERRORs or ACKs.",
    "time_acknowledged": "The time at which vendor acknowledged any error shown to them about the electronic submission.",
    "time_submitted": "The time the electronic order was submitted to the lab vendor."
  },
  "tags": "Any tags associated with the lab order.",
  "test_date": "The date on which the tests should be performed, or were performed. Can be different than document_date, create_date",
  "vendor": "The id of the lab vendor."
}

Events

Triggering Webhook Types

The following event types are associated with the Lab Order event payload from Elation.

Elation Lab Order Outstanding
Elation Lab Order Fulfilled
Elation Lab Order Cancelled
Elation Lab Order Deleted

{
  "answers": [
    {
      "created_at": "2021-03-25T04:33:40Z",
      "deleted_at": "2021-03-26T04:33:40Z",
      "question": "123",
      "test": "140748306251838",
      "value": "Yes"
    }
  ],
  "bill_type": "thirdparty",
  "ccs": "131074",
  "chart_date": "2021-03-25T04:33:40Z",
  "confidential": false,
  "content": {
    "collection_datetime": null,
    "fasting_method": "fasting_random",
    "icd10_codes": [
      {
        "code": "D72.9",
        "description": "Disorder of white blood cells, unspecified"
      }
    ],
    "id": "140754512117861",
    "patient_instructions": "",
    "standing_order_end_date": null,
    "standing_order_frequency": "",
    "stat_method": "LAB_STAT_METHOD_WET_READING_PHONE",
    "test_center_notes": "",
    "tests": [
      {
        "code": "",
        "compendium_id": "3",
        "cpt_codes": 1,
        "created_at": "2020-01-27T16:17:43Z",
        "deleted_at": "2020-01-28T13:11:23Z",
        "id": "140748306251838",
        "lab_vendor_id": "3",
        "name": "TSH",
        "practice_created_id": "42",
        "procedure_class": "123",
        "questions": {
          "answers": [
            {
              "response": "5 cups"
            }
          ],
          "question": "Briefly describe any caffeine use - e.g. how many cups of coffee a day?"
        },
        "test_synonyms": "TSH"
      }
    ]
  },
  "created_at": "2021-03-25T04:33:40Z",
  "document_created_at": "2021-03-25T04:33:40Z",
  "facility": "123456",
  "facility_identifier": {
    "active": true,
    "bidi_connection": {
      "alias": "main-quest-conn",
      "id": "42",
      "priority": 1,
      "protocol": "HL7"
    },
    "compendium": "234900800000002",
    "created_date": "2023-01-01T12:00:00Z",
    "deleted_date": "2023-12-31T12:00:00Z",
    "description": "Main Lab Facility for Quest",
    "id": "123456",
    "lab_connection": "7890",
    "lab_facility": "QST123",
    "practice": "555555",
    "practice_facility": "ACCT98765",
    "practice_secondary_id": "SECID123",
    "user_facing": true,
    "vendor": {
      "display_name": "Quest Diagnostics",
      "id": "1001",
      "name": "quest"
    }
  },
  "follow_up_method": "phone",
  "id": "140754512183329",
  "ordering_physician_id": "140754510217218",
  "patient_id": "140754511659009",
  "practice_id": "140754506678276",
  "requisition_id": "140754512183329",
  "resolution": {
    "created_at": "2021-03-25T04:33:40Z",
    "deleted_at": "2021-03-26T04:33:40Z",
    "document": "140754512183329",
    "id": "140754511659009",
    "note": "Test cancelled due to insurance",
    "resolving_document": "140754512183329",
    "state": "LAB_ORDER_RESOLUTION_STATE_OUTSTANDING"
  },
  "signed_by": "140754510217218",
  "signed_date": "2021-03-25T04:33:40Z",
  "site": {
    "address": {
      "international_address": {
        "city_state_county_or_districts": [],
        "country": null,
        "lines": [],
        "postal_code": null
      },
      "us_address": {
        "city": null,
        "line1": null,
        "line2": null,
        "state": null,
        "zip_code": null
      }
    },
    "fax_number": "415-555-5678",
    "name": "Quest Diagnostics",
    "phone_number": "415-555-1234"
  },
  "special_insurance": {
    "code": "ABC12",
    "name": "Special Insurance Name"
  },
  "specimens": [
    {
      "body_site": {
        "code": "LA",
        "deleted_at": "2021-03-26T04:33:40Z",
        "text": "Left Arm"
      },
      "container_id": "12345",
      "description": "Blood sample",
      "modifiers": [
        {
          "code": "ANT",
          "sequence": 1,
          "text": "Anterior"
        }
      ],
      "test": "140748306251838"
    }
  ],
  "submissions": [
    {
      "state": "submitted",
      "state_metadata": "ERROR: Invalid insurance information",
      "time_acknowledged": "2021-03-25T04:34:00Z",
      "time_submitted": "2021-03-25T04:33:40Z"
    }
  ],
  "tags": [],
  "test_date": "2021-03-25",
  "vendor": "67191701750"
}

{
  "answers": {
    "created_at": "When the answer was created.",
    "deleted_at": "When the answer was deleted.",
    "question": "The id of the AOE question for which this answer pertains.",
    "test": "The id of the test for which this answer pertains.",
    "value": "The value entered by freetext or chosen by the ordering physician."
  },
  "bill_type": "Who is financially responsible for the order.",
  "ccs": "List of physician ids who should be cc'd on any reports.",
  "chart_date": "Date at which this order was seen in the patient's chart.",
  "confidential": "Whether the provider has marked this order as confidential. Should not be shared with a patient.",
  "content": {
    "collection_datetime": "Date and time when the specimen was collected.",
    "fasting_method": "Indicates whether the patient should be fasting for the test.",
    "icd10_codes": {
      "code": "The code of the ICD-10 diagnosis.",
      "description": "The description of the ICD-10 diagnosis."
    },
    "id": "Unique identifier for the lab order content.",
    "patient_instructions": "Instructions for the patient regarding the lab order.",
    "standing_order_end_date": "End date for a standing order, if applicable.",
    "standing_order_frequency": "Frequency of a standing order, if applicable.",
    "stat_method": "Indicates if the order is marked as stat (urgent).",
    "test_center_notes": "Notes for the test center performing the lab work.",
    "tests": {
      "code": "Code identifier for the test, if available.",
      "compendium_id": "Compendium identifier for the test, if available.",
      "cpt_codes": "List of CPT codes associated with the test.",
      "created_at": "Timestamp when the test was created.",
      "deleted_at": "Timestamp when the test was deleted, if applicable.",
      "id": "Unique identifier for the test.",
      "lab_vendor_id": "Lab vendor identifier for the test, if available.",
      "name": "Name of the test.",
      "practice_created_id": "Practice-specific identifier for the test, if available.",
      "procedure_class": "Procedure class of the test, if applicable.",
      "questions": "List of questions associated with the test.",
      "test_synonyms": "List of alternative names or synonyms for the test."
    }
  },
  "created_at": "Time at which elation created this order.",
  "document_created_at": "Time at which this order was created in whichever system created it. Could be historical or same as the created_at.",
  "facility": "An identifier that represents the facility placing the order.",
  "facility_identifier": {
    "active": "Whether the facility identifier should be used. Should be true in most cases.",
    "bidi_connection": {
      "alias": "Get the alias of the connection.",
      "id": "ID of the connection.",
      "priority": "Priority of the connection (0-65535).",
      "protocol": "Get the protocol of the connection."
    },
    "compendium": "The id of the compendium that will be used when the user selects this facility identifier.",
    "created_date": "Created date, if available.",
    "deleted_date": "Deleted date, if available.",
    "description": "The text that will displayed to users in the lab order dialog.",
    "id": "Unique identifier for the facility identifier.",
    "lab_connection": "Lab connection id, if available.",
    "lab_facility": "The id that represents the lab.",
    "practice": "Practice id.",
    "practice_facility": "The id that represents the practice; often an account number provided by the lab vendor.",
    "practice_secondary_id": "Secondary id for the practice, if available.",
    "user_facing": "Whether this facility identifier will be visible in the lab order dialog. Should be true for most cases.",
    "vendor": {
      "display_name": "Display name of the vendor.",
      "id": "ID of the vendor.",
      "name": "Name of the vendor."
    }
  },
  "follow_up_method": "Freetext field communicating how the patient should receive their results.",
  "id": "The id of the lab order in Elation's systems.",
  "ordering_physician_id": "The id of the physician who created the order.",
  "patient_id": "The id of the patient.",
  "practice_id": "The id of the practice.",
  "requisition_id": "The requisition id of the order. Can be different from the order id if and when the order was created outside of elation.",
  "resolution": {
    "created_at": "The datetime when this resolution state was created.",
    "deleted_at": "The datetime when this resolution was deleted. Should never be null because we're providing the most updated resolution.",
    "document": "Will be the same as the id of the lab order.",
    "id": "Internal id to represent the resolution state.",
    "note": "Any note that was added to represent why an order was cancelled.",
    "resolving_document": "If the order is fulfilled will indicate the document referenced. For lab orders will usually be a report.",
    "state": "The resolution state of the order."
  },
  "signed_by": "The id of the physician who signed off on the order.",
  "signed_date": "The time when the order was signed.",
  "site": {
    "address": {
      "international_address": {
        "city_state_county_or_districts": null,
        "country": null,
        "lines": null,
        "postal_code": null
      },
      "us_address": {
        "city": null,
        "line1": null,
        "line2": null,
        "state": null,
        "zip_code": null
      }
    },
    "fax_number": "The fax number of the lab site.",
    "name": "The name of the site.",
    "phone_number": "The phone number of the lab site."
  },
  "special_insurance": {
    "code": "Special insurance code.",
    "name": "Special insurance name."
  },
  "specimens": {
    "body_site": {
      "code": "The HL7 code representing the body site from which a specimen was collected",
      "deleted_at": "Represents if the body site was removed from the specimen.",
      "text": "A textual description of the body site from which the specimen was collected."
    },
    "container_id": "An identifier representing the container used to store the specimen.",
    "description": "A freetext description of the specimen.",
    "modifiers": {
      "code": "The HL7 code representing the modifier on the body site from which a specimen was collected",
      "sequence": "The cardinal position in which the modifiers should be listed.",
      "text": "A textual description of the modifier of the body site from which the specimen was collected."
    },
    "test": "The lab order test for which the specimen was collected."
  },
  "submissions": {
    "state": "The state of the electronic order submission.",
    "state_metadata": "Useful error information collected as part of the submission. Including ERRORs or ACKs.",
    "time_acknowledged": "The time at which vendor acknowledged any error shown to them about the electronic submission.",
    "time_submitted": "The time the electronic order was submitted to the lab vendor."
  },
  "tags": "Any tags associated with the lab order.",
  "test_date": "The date on which the tests should be performed, or were performed. Can be different than document_date, create_date",
  "vendor": "The id of the lab vendor."
}

Payload Field Details

Event Payload

Hide fields

string

required

The id of the lab order in Elation’s systems.

CEL

id

Example

"140754512183329"

[]object

required

List of the answers provided for the Ask on Entry (AOE) questions if required by any lab order tests.

CEL

answers

Example

[
{
"created_at": "2021-03-25T04:33:40Z",
"deleted_at": "2021-03-26T04:33:40Z",
"question": "123",
"test": "140748306251838",
"value": "Yes"
}
]

[]string

required

Mapped array of: The id of the test for which this answer pertains.

CEL

answers.map(x, x.test)

Example

[
"140748306251838"
]

[]string

required

Mapped array of: The id of the AOE question for which this answer pertains.

CEL

answers.map(x, x.question)

Example

[
"123"
]

[]string

required

Mapped array of: The value entered by freetext or chosen by the ordering physician.

CEL

answers.map(x, x.value)

Example

[
"Yes"
]

[]timing.v1.Timestamp

required

Mapped array of: When the answer was created.

CEL

answers.map(x, x.created_at)

Example

[
"2021-03-25T04:33:40Z"
]

[]timing.v1.Timestamp

required

Mapped array of: When the answer was deleted.

CEL

answers.map(x, x.deleted_at)

Example

[
"2021-03-26T04:33:40Z"
]

string

Who is financially responsible for the order.

CEL

bill_type

Example

"thirdparty"

[]string

required

List of physician ids who should be cc’d on any reports.

CEL

ccs

Example

"131074"

timing.v1.Timestamp

required

Date at which this order was seen in the patient’s chart.

CEL

chart_date

Example

"2021-03-25T04:33:40Z"

bool

required

Whether the provider has marked this order as confidential. Should not be shared with a patient.

CEL

confidential

Example

false

object

required

Represents the content of the lab order report.

CEL

content

Example

{
"collection_datetime": null,
"fasting_method": "fasting_random",
"icd10_codes": [
{
"code": "D72.9",
"description": "Disorder of white blood cells, unspecified"
}
],
"id": "140754512117861",
"patient_instructions": "",
"standing_order_end_date": null,
"standing_order_frequency": "",
"stat_method": "LAB_STAT_METHOD_WET_READING_PHONE",
"test_center_notes": "",
"tests": [
{
"code": "",
"compendium_id": "3",
"cpt_codes": 1,
"created_at": "2020-01-27T16:17:43Z",
"deleted_at": "2020-01-28T13:11:23Z",
"id": "140748306251838",
"lab_vendor_id": "3",
"name": "TSH",
"practice_created_id": "42",
"procedure_class": "123",
"questions": {
  "answers": [
    {
      "response": "5 cups"
    }
  ],
  "question": "Briefly describe any caffeine use - e.g. how many cups of coffee a day?"
},
"test_synonyms": "TSH"
}
]
}

string

required

ID Unique identifier for the lab order content.

CEL

content.id

Example

"140754512117861"

elation.v1.LabStatMethod

Indicates if the order is marked as stat (urgent).

CEL

content.stat_method

Example

elation.v1.LabStatMethod.LAB_STAT_METHOD_WET_READING_PHONE
elation.v1.LabStatMethod.LAB_STAT_METHOD_WET_READING_FAX
elation.v1.LabStatMethod.LAB_STAT_METHOD_STAT_PHONE
elation.v1.LabStatMethod.LAB_STAT_METHOD_STAT_FAX
elation.v1.LabStatMethod.LAB_STAT_METHOD_STAT_PHONE_FAX

string

Instructions for the patient regarding the lab order.

CEL

content.patient_instructions

Example

""

string

Notes for the test center performing the lab work.

CEL

content.test_center_notes

Example

""

elation.v1.LabFastingMethod

Indicates whether the patient should be fasting for the test.

CEL

content.fasting_method

Example

elation.v1.LabFastingMethod.LAB_FASTING_METHOD_FASTING_12_HOUR
elation.v1.LabFastingMethod.LAB_FASTING_METHOD_FASTING_8_HOUR
elation.v1.LabFastingMethod.LAB_FASTING_METHOD_FASTING_2_HOUR
elation.v1.LabFastingMethod.LAB_FASTING_METHOD_FASTING_NONE
elation.v1.LabFastingMethod.LAB_FASTING_METHOD_FASTING_RANDOM

string

Frequency of a standing order, if applicable.

CEL

content.standing_order_frequency

Example

""

values.v1.Date

End date for a standing order, if applicable.

CEL

content.standing_order_end_date

Example

null

timing.v1.Timestamp

Date and time when the specimen was collected.

CEL

content.collection_datetime

Example

null

[]object

required

List of ICD-10 diagnosis codes associated with the lab order.

CEL

content.icd10_codes

Example

[
{
"code": "D72.9",
"description": "Disorder of white blood cells, unspecified"
}
]

[]string

required

Mapped array of: The code of the ICD-10 diagnosis.

CEL

content.icd10_codes.map(x, x.code)

Example

[
"D72.9"
]

[]string

required

Mapped array of: The description of the ICD-10 diagnosis.

CEL

content.icd10_codes.map(x, x.description)

Example

[
"Disorder of white blood cells, unspecified"
]

[]object

required

List of tests included in this lab order.

CEL

content.tests

Example

[
{
"code": "",
"compendium_id": "3",
"cpt_codes": 1,
"created_at": "2020-01-27T16:17:43Z",
"deleted_at": "2020-01-28T13:11:23Z",
"id": "140748306251838",
"lab_vendor_id": "3",
"name": "TSH",
"practice_created_id": "42",
"procedure_class": "123",
"questions": {
"answers": [
  {
    "response": "5 cups"
  }
],
"question": "Briefly describe any caffeine use - e.g. how many cups of coffee a day?"
},
"test_synonyms": "TSH"
}
]

[]string

required

ID Mapped array of: Unique identifier for the test.

CEL

content.tests.map(x, x.id)

Example

[
"140748306251838"
]

[]string

required

Mapped array of: Name of the test.

CEL

content.tests.map(x, x.name)

Example

[
"TSH"
]

[]string

required

Mapped array of: Code identifier for the test, if available.

CEL

content.tests.map(x, x.code)

Example

[
""
]

[]string

required

Mapped array of: Procedure class of the test, if applicable.

CEL

content.tests.map(x, x.procedure_class)

Example

[
"123"
]

[]string

required

Mapped array of: Practice-specific identifier for the test, if available.

CEL

content.tests.map(x, x.practice_created_id)

Example

[
"42"
]

[]string

required

Mapped array of: Lab vendor identifier for the test, if available.

CEL

content.tests.map(x, x.lab_vendor_id)

Example

[
"3"
]

[]string

required

Mapped array of: Compendium identifier for the test, if available.

CEL

content.tests.map(x, x.compendium_id)

Example

[
"3"
]

[]bool

required

Mapped array of: List of CPT codes associated with the test.

CEL

content.tests.map(x, x.cpt_codes)

Example

[
1
]

[]bool

required

Mapped array of: List of alternative names or synonyms for the test.

CEL

content.tests.map(x, x.test_synonyms)

Example

[
"TSH"
]

[]bool

required

Mapped array of: List of questions associated with the test.

CEL

content.tests.map(x, x.questions)

Example

[
{
"answers": [
{
  "response": "5 cups"
}
],
"question": "Briefly describe any caffeine use - e.g. how many cups of coffee a day?"
}
]

[]timing.v1.Timestamp

required

Mapped array of: Timestamp when the test was created.

CEL

content.tests.map(x, x.created_at)

Example

[
"2020-01-27T16:17:43Z"
]

[]timing.v1.Timestamp

required

Mapped array of: Timestamp when the test was deleted, if applicable.

CEL

content.tests.map(x, x.deleted_at)

Example

[
"2020-01-28T13:11:23Z"
]

timing.v1.Timestamp

required

Time at which elation created this order.

CEL

created_at

Example

"2021-03-25T04:33:40Z"

timing.v1.Timestamp

required

Time at which this order was created in whichever system created it. Could be historical or same as the created_at.

CEL

document_created_at

Example

"2021-03-25T04:33:40Z"

string

An identifier that represents the facility placing the order.

CEL

facility

Example

"123456"

string

Freetext field communicating how the patient should receive their results.

CEL

follow_up_method

Example

"phone"

string

required

The id of the physician who created the order.

CEL

ordering_physician_id

Example

"140754510217218"

string

required

ID The id of the patient.

CEL

patient_id

Example

"140754511659009"

string

required

The id of the practice.

CEL

practice_id

Example

"140754506678276"

string

required

The requisition id of the order. Can be different from the order id if and when the order was created outside of elation.

CEL

requisition_id

Example

"140754512183329"

object

Information about the resolution state of the order.

CEL

resolution

Example

{
"created_at": "2021-03-25T04:33:40Z",
"deleted_at": "2021-03-26T04:33:40Z",
"document": "140754512183329",
"id": "140754511659009",
"note": "Test cancelled due to insurance",
"resolving_document": "140754512183329",
"state": "LAB_ORDER_RESOLUTION_STATE_OUTSTANDING"
}

string

ID Internal id to represent the resolution state.

CEL

resolution.id

Example

"140754511659009"

string

Will be the same as the id of the lab order.

CEL

resolution.document

Example

"140754512183329"

string

If the order is fulfilled will indicate the document referenced. For lab orders will usually be a report.

CEL

resolution.resolving_document

Example

"140754512183329"

elation.v1.LabOrderResolutionState

The resolution state of the order.

CEL

resolution.state

Example

elation.v1.LabOrderResolutionState.LAB_ORDER_RESOLUTION_STATE_OUTSTANDING
elation.v1.LabOrderResolutionState.LAB_ORDER_RESOLUTION_STATE_FULFILLED
elation.v1.LabOrderResolutionState.LAB_ORDER_RESOLUTION_STATE_CANCELLED

string

Any note that was added to represent why an order was cancelled.

CEL

resolution.note

Example

"Test cancelled due to insurance"

timing.v1.Timestamp

The datetime when this resolution state was created.

CEL

resolution.created_at

Example

"2021-03-25T04:33:40Z"

timing.v1.Timestamp

The datetime when this resolution was deleted. Should never be null because we’re providing the most updated resolution.

CEL

resolution.deleted_at

Example

"2021-03-26T04:33:40Z"

string

required

The id of the physician who signed off on the order.

CEL

signed_by

Example

"140754510217218"

timing.v1.Timestamp

required

The time when the order was signed.

CEL

signed_date

Example

"2021-03-25T04:33:40Z"

object

The location where the patient will have the lab performed. Sites are specific to their lab vendor.

CEL

site

Example

{
"address": {
"international_address": {
"city_state_county_or_districts": [],
"country": null,
"lines": [],
"postal_code": null
},
"us_address": {
"city": null,
"line1": null,
"line2": null,
"state": null,
"zip_code": null
}
},
"fax_number": "415-555-5678",
"name": "Quest Diagnostics",
"phone_number": "415-555-1234"
}

string

The name of the site.

CEL

site.name

Example

"Quest Diagnostics"

object

The address of the lab site.

CEL

site.address

Example

{
"international_address": {
"city_state_county_or_districts": [],
"country": null,
"lines": [],
"postal_code": null
},
"us_address": {
"city": null,
"line1": null,
"line2": null,
"state": null,
"zip_code": null
}
}

object

Description coming soon

CEL

site.address.us_address

Example

{
"city": null,
"line1": null,
"line2": null,
"state": null,
"zip_code": null
}

string

Description coming soon

CEL

site.address.us_address.line1

Example

null

string

Description coming soon

CEL

site.address.us_address.line2

Example

null

string

Description coming soon

CEL

site.address.us_address.city

Example

null

string

Description coming soon

CEL

site.address.us_address.state

Example

null

string

Description coming soon

CEL

site.address.us_address.zip_code

Example

null

object

Description coming soon

CEL

site.address.international_address

Example

{
"city_state_county_or_districts": [],
"country": null,
"lines": [],
"postal_code": null
}

[]string

Description coming soon

CEL

site.address.international_address.lines

Example

[]

[]string

Description coming soon

CEL

site.address.international_address.city_state_county_or_districts

Example

[]

string

Description coming soon

CEL

site.address.international_address.postal_code

Example

null

string

Description coming soon

CEL

site.address.international_address.country

Example

null

string

The phone number of the lab site.

CEL

site.phone_number

Example

"415-555-1234"

string

The fax number of the lab site.

CEL

site.fax_number

Example

"415-555-5678"

object

Used primarily to support specific electronic lab order integrations.

CEL

special_insurance

Example

{
"code": "ABC12",
"name": "Special Insurance Name"
}

string

Special insurance code.

CEL

special_insurance.code

Example

"ABC12"

string

Special insurance name.

CEL

special_insurance.name

Example

"Special Insurance Name"

[]object

required

Record of the attempts to submit the electronic order.

CEL

submissions

Example

[
{
"state": "submitted",
"state_metadata": "ERROR: Invalid insurance information",
"time_acknowledged": "2021-03-25T04:34:00Z",
"time_submitted": "2021-03-25T04:33:40Z"
}
]

[]string

required

Mapped array of: The state of the electronic order submission.

CEL

submissions.map(x, x.state)

Example

[
"submitted"
]

[]timing.v1.Timestamp

required

Mapped array of: The time the electronic order was submitted to the lab vendor.

CEL

submissions.map(x, x.time_submitted)

Example

[
"2021-03-25T04:33:40Z"
]

[]timing.v1.Timestamp

required

Mapped array of: The time at which vendor acknowledged any error shown to them about the electronic submission.

CEL

submissions.map(x, x.time_acknowledged)

Example

[
"2021-03-25T04:34:00Z"
]

[]string

required

Mapped array of: Useful error information collected as part of the submission. Including ERRORs or ACKs.

CEL

submissions.map(x, x.state_metadata)

Example

[
"ERROR: Invalid insurance information"
]

[]object

required

Record of any specimens collected when creating the order.

CEL

specimens

Example

[
{
"body_site": {
"code": "LA",
"deleted_at": "2021-03-26T04:33:40Z",
"text": "Left Arm"
},
"container_id": "12345",
"description": "Blood sample",
"modifiers": [
{
  "code": "ANT",
  "sequence": 1,
  "text": "Anterior"
}
],
"test": "140748306251838"
}
]

[]string

required

Mapped array of: The lab order test for which the specimen was collected.

CEL

specimens.map(x, x.test)

Example

[
"140748306251838"
]

[]bool

required

Mapped array of: Information about the body site where the specimen was collected.

CEL

specimens.map(x, x.body_site)

Example

[
{
"code": "LA",
"deleted_at": "2021-03-26T04:33:40Z",
"text": "Left Arm"
}
]

[]string

required

Mapped array of: A freetext description of the specimen.

CEL

specimens.map(x, x.description)

Example

[
"Blood sample"
]

[]string

required

Mapped array of: An identifier representing the container used to store the specimen.

CEL

specimens.map(x, x.container_id)

Example

[
"12345"
]

[]bool

required

Mapped array of: Coded Modifiers indicating more information about the body site from which the specimen was collected.

CEL

specimens.map(x, x.modifiers)

Example

[
[
{
"code": "ANT",
"sequence": 1,
"text": "Anterior"
}
]
]

[]string

required

Any tags associated with the lab order.

CEL

tags

Example

[]

values.v1.Date

The date on which the tests should be performed, or were performed. Can be different than document_date, create_date

CEL

test_date

Example

"2021-03-25"

string

required

The id of the lab vendor.

CEL

vendor

Example

"67191701750"

object

Information about the facility placing the order.

CEL

facility_identifier

Example

{
"active": true,
"bidi_connection": {
"alias": "main-quest-conn",
"id": "42",
"priority": 1,
"protocol": "HL7"
},
"compendium": "234900800000002",
"created_date": "2023-01-01T12:00:00Z",
"deleted_date": "2023-12-31T12:00:00Z",
"description": "Main Lab Facility for Quest",
"id": "123456",
"lab_connection": "7890",
"lab_facility": "QST123",
"practice": "555555",
"practice_facility": "ACCT98765",
"practice_secondary_id": "SECID123",
"user_facing": true,
"vendor": {
"display_name": "Quest Diagnostics",
"id": "1001",
"name": "quest"
}
}

bool

Whether the facility identifier should be used. Should be true in most cases.

CEL

facility_identifier.active

Example

true

object

Bi-directional lab connection info, if available.

CEL

facility_identifier.bidi_connection

Example

{
"alias": "main-quest-conn",
"id": "42",
"priority": 1,
"protocol": "HL7"
}

string

Get the alias of the connection.

CEL

facility_identifier.bidi_connection.alias

Example

"main-quest-conn"

string

ID of the connection.

CEL

facility_identifier.bidi_connection.id

Example

"42"

int64

Priority of the connection (0-65535).

CEL

facility_identifier.bidi_connection.priority

Example

string

Get the protocol of the connection.

CEL

facility_identifier.bidi_connection.protocol

Example

"HL7"

string

The id of the compendium that will be used when the user selects this facility identifier.

CEL

facility_identifier.compendium

Example

"234900800000002"

timing.v1.Timestamp

Created date, if available.

CEL

facility_identifier.created_date

Example

"2023-01-01T12:00:00Z"

timing.v1.Timestamp

Deleted date, if available.

CEL

facility_identifier.deleted_date

Example

"2023-12-31T12:00:00Z"

string

The text that will displayed to users in the lab order dialog.

CEL

facility_identifier.description

Example

"Main Lab Facility for Quest"

string

Unique identifier for the facility identifier.

CEL

facility_identifier.id

Example

"123456"

string

Lab connection id, if available.

CEL

facility_identifier.lab_connection

Example

"7890"

string

The id that represents the lab.

CEL

facility_identifier.lab_facility

Example

"QST123"

string

Practice id.

CEL

facility_identifier.practice

Example

"555555"

string

The id that represents the practice; often an account number provided by the lab vendor.

CEL

facility_identifier.practice_facility

Example

"ACCT98765"

string

Secondary id for the practice, if available.

CEL

facility_identifier.practice_secondary_id

Example

"SECID123"

bool

Whether this facility identifier will be visible in the lab order dialog. Should be true for most cases.

CEL

facility_identifier.user_facing

Example

true

object

Vendor information.

CEL

facility_identifier.vendor

Example

{
"display_name": "Quest Diagnostics",
"id": "1001",
"name": "quest"
}

string

Display name of the vendor.

CEL

facility_identifier.vendor.display_name

Example

"Quest Diagnostics"

string

ID of the vendor.

CEL

facility_identifier.vendor.id

Example

"1001"

string

Name of the vendor.

CEL

facility_identifier.vendor.name

Example

"quest"

⌘I

​Events

​Triggering Webhook Types

​Payload Field Details

Events

Triggering Webhook Types

Payload Field Details