SCRAM Nexus API Resource Guide

Drug Tests

When drug test appointment/result is recorded in Nexus probation application, the details are made available immediately to case management system.

Message structure for Drug Test Appointment:

  • Client Identifier
  • Activity
    • Type: “Drug Test Appointment”
    • Identifier
  • Details
    • AppointmentDateTime
    • AppointmentStatus: “Completed/Tampered/Missed/Excused”
    • Location
  • Action
    • Reason: “Created/Updated”
    • OccurredOn
    • UpdatedBy

 

Sample Message:

{

"Client": {

"IntegrationId": "EX123456"

},

"Activity": {

"Type": "Drug Test Appointment",

"Identifier": "00000000-0000-0000-0000-000000000000"

},

"Details": {

"AppointmentDateTime":  "2019-02-15T14:25Z",

"AppointmentStatus": "Tampered",

"Location": "Main Street Office"

},

"Action": {

"Reason": "Created",

"OccurredOn": "2019-02-17T14:52:23.0272547Z",

"UpdatedBy": "officer@county.org"

}

}

Message structure for Drug Test Result:

  • Client Identifier
  • Activity
    • Type: “Drug Test Result”
    • Identifier
  • Details
    • TestDateTime
    • ResultStatus: “Passed/Failed/Tampered”
    • Location
    • DrugTestType
    • DeliberateTamper: “Yes/No”
    • Screened: “Yes/No”
    • SentToLab : “Yes/No”
    • DrugTestId
    • Dilute: “Yes/No”
    • CreatinineLevel
  • Action
    • Reason: “Created/Updated”
    • OccurredOn
    • UpdatedBy

Sample Message:

{

"Client": {

"IntegrationId": "EX123456"

},

"Activity": {

"Type": "Drug Test Result",

"Identifier": "00000000-0000-0000-0000-000000000000"

},

"Details": {

"TestDateTime": "2019-03-28T07:23:53.0272547Z",

"ResultStatus": "Failed",

"Location": "Main Street Office",

"DrugTestType": "iScreenOFD",

"DeliberateTamper": "No",

"Screened": "No",

"SentToLab": "Yes",

"DrugTestId": "5555",

"Dilute": "No",

"CreatinineLevel": null

},

"Action": {

"Reason": "Created",

"OccurredOn": "2019-02-17T14:52:23.0272547Z",

"UpdatedBy": "officer@county.org"

}

}