{
  "order_definition_code":  "BFLY-21H1XI",
  "order_id":  "ord_dV7RMiCP1Paz0NyxHFWrpF",
  "patient_id":  "pt_G2d42kA1JrNppciYEE",
  "report_generated_date":  "2023-06-09T14:08:00+00:00",
  "results":  [
    {
      "lab_comments":  "Prediabetes: 5.7 - 6.4\nDiabetes: >6.4",
      "name":  "AST (SGOT)",
      "range":  null,
      "reference_range_high":  null,
      "reference_range_low":  null,
      "result_interpretation":  "High",
      "unit":  "IU/L",
      "value":  null
    }
  ]
}

{
  "order_definition_code":  "Code identifying the type of lab order",
  "order_id":  "ID of the order these results belong to",
  "patient_id":  "ID of the patient these results are for",
  "report_generated_date":  "When these lab results were generated",
  "results":  {
    "lab_comments":  "Additional comments from the lab about this result",
    "name":  "Name of the test result",
    "range":  "The range of the test result (in the given units)",
    "reference_range_high":  "High end of the reference range for this test (in the given units)",
    "reference_range_low":  "Low end of the reference range for this test (in the given units)",
    "result_interpretation":  "Interpretation of the result (e.g., High, Low, Ok)",
    "unit":  "Unit of measurement for the result",
    "value":  "The value of the test result (in the given units)"
  }
}

​
Events

​
Triggering Webhook Types

The following event types are associated with the Lab Results event payload from Butterfly Labs.

  • Butterfly Labs Lab Order Results Update
{
  "order_definition_code":  "BFLY-21H1XI",
  "order_id":  "ord_dV7RMiCP1Paz0NyxHFWrpF",
  "patient_id":  "pt_G2d42kA1JrNppciYEE",
  "report_generated_date":  "2023-06-09T14:08:00+00:00",
  "results":  [
    {
      "lab_comments":  "Prediabetes: 5.7 - 6.4\nDiabetes: >6.4",
      "name":  "AST (SGOT)",
      "range":  null,
      "reference_range_high":  null,
      "reference_range_low":  null,
      "result_interpretation":  "High",
      "unit":  "IU/L",
      "value":  null
    }
  ]
}

{
  "order_definition_code":  "Code identifying the type of lab order",
  "order_id":  "ID of the order these results belong to",
  "patient_id":  "ID of the patient these results are for",
  "report_generated_date":  "When these lab results were generated",
  "results":  {
    "lab_comments":  "Additional comments from the lab about this result",
    "name":  "Name of the test result",
    "range":  "The range of the test result (in the given units)",
    "reference_range_high":  "High end of the reference range for this test (in the given units)",
    "reference_range_low":  "Low end of the reference range for this test (in the given units)",
    "result_interpretation":  "Interpretation of the result (e.g., High, Low, Ok)",
    "unit":  "Unit of measurement for the result",
    "value":  "The value of the test result (in the given units)"
  }
}

​
Payload Field Details

​
Lab Results
Event Payload
​
order_id
string
required

ID of the order these results belong to

CEL
order_id
Example
"ord_dV7RMiCP1Paz0NyxHFWrpF"
​
patient_id
string
required

ID of the patient these results are for

CEL
patient_id
Example
"pt_G2d42kA1JrNppciYEE"
​
order_definition_code
string
required

Code identifying the type of lab order

CEL
order_definition_code
Example
"BFLY-21H1XI"
​
report_generated_date
timing.v1.Timestamp
required

When these lab results were generated

CEL
report_generated_date
Example
"2023-06-09T14:08:00+00:00"
​
results
object
required

Description coming soon

CEL
results
Example
[
{
"lab_comments":  "Prediabetes: 5.7 - 6.4\nDiabetes: >6.4",
"name":  "AST (SGOT)",
"range":  null,
"reference_range_high":  null,
"reference_range_low":  null,
"result_interpretation":  "High",
"unit":  "IU/L",
"value":  null
}
]
​
results.map(x, x.name)
[]string
required

Mapped array of: Name of the test result

CEL
results.map(x, x.name)
Example
[
"AST (SGOT)"
]
​
results.map(x, x.range)
[]any
required

Mapped array of: The range of the test result (in the given units)

CEL
results.map(x, x.range)
Example
[
null
]
​
results.map(x, x.value)
[]any
required

Mapped array of: The value of the test result (in the given units)

CEL
results.map(x, x.value)
Example
[
null
]
​
results.map(x, x.unit)
[]string
required

Mapped array of: Unit of measurement for the result

CEL
results.map(x, x.unit)
Example
[
"IU/L"
]
​
results.map(x, x.lab_comments)
[]string
required

Mapped array of: Additional comments from the lab about this result

CEL
results.map(x, x.lab_comments)
Example
[
"Prediabetes: 5.7 - 6.4\nDiabetes: >6.4"
]
​
results.map(x, x.result_interpretation)
[]string
required

Mapped array of: Interpretation of the result (e.g., High, Low, Ok)

CEL
results.map(x, x.result_interpretation)
Example
[
"High"
]
​
results.map(x, x.reference_range_low)
[]any
required

Mapped array of: Low end of the reference range for this test (in the given units)

CEL
results.map(x, x.reference_range_low)
Example
[
null
]
​
results.map(x, x.reference_range_high)
[]any
required

Mapped array of: High end of the reference range for this test (in the given units)

CEL
results.map(x, x.reference_range_high)
Example
[
null
]