test_result_ready

Triggered when a quality check workflow activity is completed and if the workflow has enableTestReadyWebhook enabled

For example:

{
	"activityType":"quality-checks",
	"name":"Reference Sample Review",
	"label":"reference-qpcr-qc",
	"attributes":
		{
			"enableTestReadyWebhook":true
			"status":[ ... ]
		}
}

All timestamps are in UTC.

Sample Payload

{
  "eventType": "test_result_ready",
  "organizationId": 5499,
  "workflowId": 24766,
  "workflowDefinitionId": 116366,
  "workflowName": "reference infectious disease",
  "workflowType": "reference-infectious-disease",
  "sampleTestResults": [
    {
      "overallStatus": "processing",
      "requisitionIdentifier": "REQ-004",
      "requisitionCustomAttributes": {},
      "sampleIdentifier": "REQ-004",
      "sampleCollectionDate": "2023-06-06T07:00:00.000Z",
      "sampleReceivedDate": "2023-06-22T05:39:00.000Z",
      "sampleLabel": "Swab",
      "sampleStatus": "Received",
      "sampleCustomAttributes": {},
      "patientIdentifier": "REQ-004",
      "patientMRN": null,
      "patientFirstName": "ref first name",
      "patientMiddleName": null,
      "patientLastName": "ref last name",
      "patientDateOfBirth": null,
      "patientAddressLine1": null,
      "patientAddressLine2": null,
      "patientCity": null,
      "patientState": null,
      "patientPostalCode": null,
      "patientPhoneNumber": null,
      "patientRace": "",
      "patientEthnicity": "",
      "patientGender": null,
      "patientCustomAttributes": {},
      "providerAccountName": "reference provider account",
      "providerAccountNumber": "1231223",
      "providerAccountStreetAddress": "11020 Northeast 6th Street",
      "providerAccountStreetAddressLine2": null,
      "providerAccountStreetAddressCity": "Bellevue",
      "providerAccountStreetAddressState": "Washington",
      "providerAccountStreetAddressPostalCode": "98004",
      "providerAccountStreetAddressCountry": "United States",
      "providerAccountPhoneNumber": "1231231234",
      "providerNPI": "123456789",
      "providerFirstName": "reference",
      "providerLastName": "provider ",
      "testPanels": [
        "Reference Infectious Disease"
      ],
      "testResults": [
        {
          "targetName": "A. baumannii_Ba04932084_s1",
          "assayName": "Acinetobacter baumannii",
          "result": "Not Detected",
          "computedResult": "Not Detected",
          "displayName": null,
          "inRequestedPanel": true,
          "description": null,
          "isAssayControl": null,
          "infectiousDisease": {
            "load": null,
            "computedLoad": null,
            "unit": null,
            "resistance": null,
            "computedQualitative": "",
            "qualitative": null,
            "computedQuantitative": null,
            "quantitative": null,
            "percentage": null,
            "pathogens": null,
            "organism": "Acinetobacter baumannii",
            "sanfordId": null,
            "antibioticClass": null
          }
        },
        {
          "targetName": "qnrA_Ba04646160_s1",
          "assayName": "QnrA",
          "result": "Not Detected",
          "computedResult": "Not Detected",
          "displayName": null,
          "inRequestedPanel": true,
          "description": "These genes are associated with resistance to Quinolones. Ciprofloxacin, Levofloxacin, Moxifloxacin, Ofloxacin",
          "isAssayControl": null,
          "infectiousDisease": {
            "load": null,
            "computedLoad": null,
            "unit": null,
            "resistance": null,
            "computedQualitative": "",
            "qualitative": null,
            "computedQuantitative": null,
            "quantitative": null,
            "percentage": null,
            "pathogens": [
              "Citrobacter sp.",
              "Escherichia coli, susceptible",
              "Susceptible oxytoca, pneumoniae, variicola"
            ],
            "organism": null,
            "sanfordId": null,
            "antibioticClass": "Quinolones"
          }
        }
      ],
      "organizationTimezone": "America/Los_Angeles",
      "routeWorkflowTypes": [
        "reference-medication"
      ]
    }
  ]
}

Payload description

Test Result Ready Object

Key	Type	Description
eventType	string	The action performed
organizationId	integer	ID of the organization
workflowId	integer	ID of the workflow sending the test results
workflowDefinitionId	integer	ID of the workflow definition used by workflow
workflowName	string	Name of workflow creating the test results
workflowType	string	The type of workflow
sampleTestResults	object array	Array of test results object

Sample Test Result Object

Key	Type	Description

Key	Type	Description
sampleId	integer	ID of the sample
sampleIdentifier	string	Sample Identifier
sampleCollectionDate	string	DateTime sample was collected in UTC
sampleReceivedDate	string	DateTime sample was received in UTC
sampleLabel	string	Sample label
sampleStatus	string	Sample status
patientIdentifier	string	Patient Identifier
patientMRN	string	Patient MRN
patientFirstName	string	Patient first name
patientMiddleName	string	Patient middle name
patientLastName	string	Patient last name
patientDateOfBirth	string	Patient DOB
patientAddressLine1	string	Patient address line 1 (street address)
patientAddressLine2	string	Patient address line 2 (suite/apartment #)
patientCity	string	Patient city
patientState	string	Patient state
patientPostalCode	string	Patient postal code
patientPhoneNumber	string	Patient phone number
patientRace	string	Patient race White Asian American Indian / Alaska Native Black / African American Native Hawaiian / Pacific Islander Undisclosed
patientEthnicity	string	Patient ethnicity Hispanic or Latino Not Hispanic or Latino Undisclosed
patientGender	string	Patient gender male female undisclosed
providerAccountName	string	Provider account name
providerAccountNumber	string	Provider account number
providerAccountStreetAddress	string	Provider account street address line 1 (street address)
providerAccountStreetAddressLine2	string	Provider account street address line 2 (suite/apartment #)
providerAccountStreetAddressCity	string	Provider account city
providerAccountStreetAddressState	string	Provider account state
providerAccountStreetAddressPostalCode	string	Provider account postal code
providerAccountStreetAddressCountry	string	Provider account country
providerAccountPhoneNumber	string	Provider account phone number
providerNPI	string	Provider NPI
providerFirstName	string	Provider first name
providerLastName	string	Provider last name
testResults	object array	Array of test results
timestamp	integer	Epoch timestamp of when payload was generated
organizationTimezone	string	Timezone configured for organization. All time stamps in payload will be sent in UTC ex: "America/Los_Angeles"
routeWorkflowTypes	string Array	Array of the next workflow types.This should be used to determine the “workflowType” in the medication upload API

Test Results Object

Key	Type	Description

Key	Type	Description
targetName	string	The name of the target or organism
assayName	string	The assay name of the target or organism
result	string	Detected Not Detected
computedResult	string	Detected Not Detected
displayName	string	The display name for this target or organism
inRequestedPanel	boolean	If this target was requested in the requisition
description	string	description of the test
isAssayControl	boolean	Is a control
infectiousDisease	Infection Disease Object	Object for Infectious disease specific results

Infectious Disease Object

Key	Type	Description

Key	Type	Description
load	string	The viral load (ie 1 x 10^2 copies/ul)
computedLoad	string	The computed detected load
resistance	string	The resistance names
qualitative	string	The qualitative analysis (ie “Low”, “Medium”, “High”)
computedQualitative	string	The computed qualitative analysis
quantitative	string	The quantitative analysis
computedQuantitative	string	The computed quantitative analysis
percentage	double	The percentage
pathogen	string Array	A list of related pathogens
organism	string	The organism name
sanfordId	string	The Sandford ID reference
antibioticClass	string	The name of the antibiotic class