SCRAM Nexus API Resource Guide

Treatment Appointments

When attendance is recorded for treatment appointment in Treatment Application, the details are made available immediately to case management system.

Message structure for Treatment Appointment:

  • Client Identifier
  • Activity
    • Type: “Treatment Appointment”
    • Identifier
  • Details
    • TreatmentType
    • AppointmentDateTime
    • Status”: “Attended/Missed”,
    • QuestionsAndAnswers
    • Note
  • Action
    • Reason: “Created/Updated”
    • OccurredOn
    • UpdatedBy

Sample Message:

{

"Client": {

"IntegrationId": "EX123456"

},

"Activity": {

"Type": "Treatment Appointment",

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

},

"Details": {

"TreatmentType": "Addiction Counseling - Individual",

"AppointmentDateTime": "2019-02-15T17:23Z",

"Status": "Attended",

"QuestionsAndAnswers": [

{

"Question": "Dressed Appropriately",

"Answer": "Yes"

},

{

"Question": "Participated",

"Answer": "Yes"

},

{

"Question": "Positive Attitude",

"Answer": "Yes"

},

{

"Question": "Homework Completed",

"Answer": "Yes"

},

{

"Question": "Any Urgent or Critical Issues (Threat to Health and Safety)",

"Answer": "No"

}

],

"Notes": "Praesent pretium placerat semper. Ut elit felis, tincidunt et odio ac, laoreet imperdiet arcu. Sed ullamcorper, metus quis ornare tincidunt, tellus velit porta ante, eu placerat est odio quis lectus."

},

"Action": {

"Reason": "Created",

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

"UpdatedBy": "officer@county.org"

}

}