Triggered when the report_status changes to signed

Sample Payload

  "eventType": "report_signed",
  "eventDetails": "",
  "projectTemplateId": "12345",
  "requisitionIdentifier": "req-001",
  "sampleIdentifier": "sample-001",
  "patientIdentifier": "",
  "patientMRN": "0010015000",
  "patientFirstName": "",
  "patientLastName": "",
  "patientDateOfBirth": "",
  "patientAddressLine1": "",
  "patientAddressLine2": "",
  "patientCity": "",
  "patientState": "",
  "patientPostalCode": "",
  "patientPhoneNumber": "",
  "patientRace": "",
  "patientEthnicity": "",
  "patientGender": "",
  "patientCustomAttributes": "",
  "sampleGroup": "default",
  "sampleLabel": "sample-label",
  "providerAccountName": "Provider Account Name",
  "providerAccountNumber": "99952255",
  "providerAccountStreetAddress": "",
  "providerAccountStreetAddressLine2": "",
  "providerAccountStreetAddressCity": "",
  "providerAccountStreetAddressState": "",
  "providerAccountStreetAddressPostalCode": "",
  "providerAccountStreetAddressCountry": "",
  "providerAccountPhoneNumber": "",
  "providerNPI": "0000000000",
  "providerFirstName": "",
  "providerLastName": "",
  "reportResult": " 'Detected' | 'Not detected' | 'Inconclusive' ",
  "reportResultDetails": {
    "company_name": "Company XXYY",
    "physician": "Physician Name",
    "panel_name": "panel_name",
    "panel_code": "panel-001"
  "reportType": "default",
  "reportDate": "2022-01-01",
  "reportDateTime": "2022-01-01T20:00:00+00:00",
  "collectionDateTime": "2022-01-01T12:00:00+00:00",
  "receivedDateTime": "2022-01-01T10:00:00+00:00",
  "reportDownloadLink": "https://link_to_download_pdf",
  "signedBy": [{"name": "", "email": "", "signedDateTime": ""}]

Payload description

Key Type Description
eventType string The action performed
eventDetails string Details related to the action performed
projectTemplateId string Internal identifier of the project template
requisitionIdentifier string Requisition identifier
sampleIdentifier string Sample identifier
patientIdentifier string Patient identifier
patientMRN string Patient medical record number
patientFirstName string Patient first name
patientLastName string Patient last name
patientDateOfBirth string Patient date of birth
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
patientCustomAttributes object Key value pairs for all custom attributes associated with the patient
sampleGroup string Sample group name
sampleLabel string Sample Label description
providerAccountName string Provider account name
providerAccountNumber string Provider account number
string Provider account street address line 1 (street address)
string Provider account  street address line 2 (suite/apartment #)
string Provider account city
string Provider account state
string Provider account postal code
string Provider account country
string Provider account phone number
providerNPI string The Provider NPI identifier
providerFirstName string Provider first name
providerLastName string Provider last name
reportResult string The report result (COVID only)
  • Detected or Positive
  • Not Detected or Negative
  • Inconclusive
  • Invalid
reportResultDetails object Contains detailed information about the report result
reportType string Report type
reportDate string Report signed at date
reportDateTime string Report signed at date time in ISO8601 format
collectionDateTime string Sample collection date time in ISO8601 format
receivedDateTime string Sample received date time in ISO8601 format
reportDownloadLink string The link to download the report file
(A GET call to this link with the same Bearer Token header
used in the V3 API calls will allow this report to be downloaded)
signedBy array Contains an array of records for each person who signed the report.
Each record will include:
  • name
  • email
  • signedDateTime
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.