All messages broadcast from Nexus Transmit follow a similar structure of providing Client Identifying Information, Activity Information, Activity Details, and Action details.
Client Identifying Information has the Integration ID that was set when the client was added to Nexus from the Case Management System.
Activity information includes a unique identifier for the activity and the type of activity.
The Activity Details change depending on the type of event being broadcast. This could include details from an office visit, a note, visited locations from a field visit, or client profile sections updated. If the message is on an activity, then the details will include the activity date (or date and time) and the activity status.
Action Details are specific to the change that caused the message to be broadcast. This will be the reason the message was broadcast such as an Activity completed or updated. Activity Details also includes the date/time of the change and the email address of the user that made the change.
Example of a General Note that is created:
{
"Client": {
"IntegrationId": "EX123456"
},
"Activity": {
"Type": "Note",
"Identifier": "00000000-0000-0000-0000-000000000000"
},
"Details": {
"NoteText": "Lorem ipsum dolor sit amet, consectetur adipiscing elit",
"CreatedDate": "2019-02-15T14:25Z",
"NoteAuthor": "officer@county.org"
},
"Action": {
"Reason": "Created",
"OccurredOn": "2019-02-15T14:52:23.0272547Z",
"UpdatedBy": "officer@county.org"
}
}
Example of an Office Visit that is updated:
{
"Client": {
"IntegrationId": "EX123456"
},
"Activity": {
"Type": "OfficeVisit",
"Identifier": "00000000-0000-0000-0000-000000000000"
},
"Details": {
"DateTime": "2019-02-15T14:25Z",
"Status": "Attended",
"Notes": "Ut maximus aliquet nibh, nec mattis nulla.",
"Location": "Main Street Office",
"OnTime": "Yes"
},
"Action": {
"Reason": "Updated",
"OccurredOn": "2019-02-17T14:52:23.0272547Z",
"UpdatedBy": "officer@county.org"
}
}Example of an updated Client Profile:
{
"Client": {
"IntegrationId": "EX123456"
},
"Activity": {
"Identifier": "00000000-0000-0000-0000-000000000000",
"Type": "ClientProfile"
},
"Details": {
"FirstName": "Johnathan",
"LastName": "Farmer",
"DateOfBirth": "1980-05-28",
"TimeZone": "Mountain Standard Time",
"Gender": "Male",
"Ethinicity": "Caucasian",
"StaticRiskChecking": "High - Violence",
"NeedsClassification": "High - Mental Health"
},
"Action": {
"Reason": "Personal Details Updated",
"OccurredOn": "2019-02-15T14:52:23.0272547Z",
"UpdatedBy": "officer@county.org"
}
}