The order object represents the lifecycle of a real-world diagnostic order from placement to either results becoming ready or cancellation by you or your patient.

The order object

AttributeDescription
address
object
The address to which the kit is shipped and at which the home visit will occur. See the Address section for more details.

If the order is a walk-in visit order, this field is not used.
created_at
datetime
The datetime in UTC when the order was created.
home_visits
object[]
A list of home_visit objects representing home visits associated with this order.
home_visits[n].status
string
Represents the current stage of the lifecycle of the home_visit. Possible values are "ACKNOWLEDGED", "BEING_SCHEDULED", "SCHEDULED", "COMPLETED", or "ERROR".
home_visits[n].visit_datetime
datetime?
The datetime at which the home visit will occur. This value will be populated when home_visit.status is updated to "SCHEDULED".
home_visits[n].outreaches
object[]?
Information about the outreach approach at a given time.
home_visits[n].outreaches[n].date
datetime
The date when the outreach happened.
home_visits[n].outreaches[n].types
string[]
An array that represents the ways the team reached a patient. it could be:

- PHONE_CALL
- VOICEMAIL
- SMS
id
string
The id of the order.
is_stat
boolean
If true, the order is a stat order, and the kit delivery and home visit date are accelerated.
kits
object[]
A list of kit objects representing test kits associated with this order.
kits[n].outbound_carrier
string?
The outbound carrier carrier information of the kit
kits[n].outbound_tracking_id
string?
The outbound tracking id for the shipment of the kit
kits[n].return_carrier
string?
The return carrier information of the kit
kits[n].return_shipping_tracking_url
string?
The tracking link for the return shipment of the kit with the sample to the lab.
kits[n].return_tracking_id
string?
The return tracking id for the shipment of the kit
kits[n].shipping_tracking_url
string?
The tracking link for the shipment of the kit to the patient's address.
kits[n].status
string
Represents the stage of the lifecycle of the kit. Possible values are "ACKNOWLEDGED", "SHIPPED_TO_PATIENT", "ARRIVED_AT_PATIENT", "SHIPPED_TO_LAB" or "RECEIVED_BY_LAB".
order_definition
object
A partial set of the properties of this order's order_definition.
order_definition.code
string
The unique code that is used to reference an order_definition.
order_definition.encounter_type
string
The sample collection type of the order. Possible values are "AT_HOME_TEST_KIT", "HOME_VISIT_WITH_KIT", or "WALK_IN_VISIT".
order_definition.name
string
The display name of the order type.
ordering_physician
object
The details of the ordering physician. If an order was placed without physician information and your account has been approved for using Butterfly Labs ordering physicians, our ordering physician’s information will be listed here.
ordering_physician.first_name
string
The physician’s first name.
ordering_physician.last_name
string
The physician’s last name.
ordering_physician.npi
string
The physician’s national provider identifier.
patient
object
The details of the patient involved in the order.
patient.id
string
The id of the patient.
patient.first_name
string
The patient’s first name.
patient.last_name
string
The patient’s last name.
tests
object[]
If you placed an order with custom tests, a list of ordered tests.
tests[n].id
string
The id of the test.
tests[n].lab_id
string
The id of the lab running the test.
tests[n].lab_test_code
string
The third-party test code assigned by the lab.
tests[n].lab_test_name
string
The third-party test name assigned by the lab.
tests[n].name
string
The name of the test.
tests[n].price_in_cents
string
The test price in cents.
status
string
The status represents the stage of the lifecycle of the order. Possible values are:

ACKNOWLEDGED - you have successfully created the order in our backend, but it has not yet been processed (e.g. shipping a kit, scheduling a home visit, or ordering a walk-in visit).

SAMPLE_BEING_COLLECTED - this status represents the stage from us processing your order to the sample being received by the lab.

SAMPLE_RECEIVED_BY_LAB - the sample, whether collected by patient self-sampling, by a mobile phlebotomist, or at a draw center, has arrived at the lab.

RESULTS_PENDING_REVIEW - the lab has finished running the test and the results are pending review by our team.

RESULTS_READY - results have been reviewed and confirmed by our team. you can view the results through the /orders/:orderId/result endpoint.
updated_at
datetime
The datetime in UTC when the order was updated.
walk_in_visits
object[]
A list of walk_in_visit objects representing walk-in visits associated with this order.
walk_in_visits[n].requisition_pdf_link
string
A temporary short link to the requisition PDF. This will be available in the POST order response.
walk_in_visits[n].status
string
Represents the current stage of the lifecycle of the walk_in_visit. Possible values are "ACKNOWLEDGED", "SCHEDULED", or "COMPLETED".
{
  "address": {
    "address_line_1": "1400 S Grand Ave",
    "address_line_2": "Ste 612",
    "city": "Los Angeles",
    "state": "CA",
    "postal_code": "90015"
  },
  "created_at": "2021-04-23T18:25:43.511Z",
  "home_visits": [
    {
      "error": null,
      "status": "SCHEDULED",
      "visit_datetime": "2021-04-23T17:00:00.000Z"
      "outreaches": [
        {
          "types": [
            "PHONE_CALL"
          ],
          "date": "2022-04-13"
        }
      ]
    }
  ],
  "id": "ord_zAsm5nErojHjPsU7",
    "is_stat": true,
  "kits": [
    {
      "error": null,
      "outbound_carrier": "fedex",
      "outbound_tracking_id": "1Z063AX08777363907";
      "return_carrier": "usps";
      "return_shipping_tracking_url": "https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=92055901755477000460652250",
      "return_tracking_id": "1Z063AX08777363907",
      "shipping_tracking_url": "https://www.ups.com/track?tracknum=1Z063AX08777363907",
      "status": "SHIPPED_TO_PATIENT"
    }
  ],
  "order_definition": {
    "code": "BFLY-F3C9E9",
        "encounter_type": "HOME_VISIT_WITH_KIT",
    "name": "Lifeforce men's initial panel - w/ CRL and mobile phlebotomy",
  },
  "ordering_physician": {
    "first_name": "Benjamin",
        "last_name": "Franklin",
    "npi": "1234567890"
  },
  "patient": {
        "first_name": "Jane",
    "id": "pt_DOPl1KA3XOrx9ih5",
        "last_name": "Doe",
  },
  "status": "SAMPLE_BEING_COLLECTED",
  "updated_at": "2021-04-23T18:25:43.511Z",
  "walk_in_visits": []
}