iCarol integrations

Project 1: Resource Sharing using iCarol Resource API Phase 1: (existing capabilities) Make the iCarol Resource API available to Home App Optional Phase 2: (capabilities not yet available) Create new functionality for resource flagging and suggested changes to be send through the Resource API to the iCarol customer Project 2: Contact sharing for interactions and profiles Phase 1: Home App exports daily contacts to be imported into iCarol. Optional Phase 1.1: (capabilities not yet available) Home App searches iCarol Caller profiles/Helpseekers that match clientele Home App is currently processing Phase 2: iCarol to dispatch/post the original call report, and any related call reports back to Home App when submitted for ongoing updates/outcomes.

Project 1: Resource Sharing using iCarol Resource API [Simple Resource Sharing]: Customer currently uses the HOME App for coordinated housing referrals. They would also like to make more generalized referrals directly to resources listed in their community’s 211 system, already hosted by iCarol.

Phase 1: (existing capabilities) Make the iCarol Resource API available to Home App

1. HOME App searches and requests Customer’s iCarol resources via existing Resource API, providing zip code & requested types of services (via AIRS code or keywords).
2. iCarol existing Resource API responds with a list of service resources that includes name, location and contact info for each service
3. HOME App implements an existing method to request a new Automatic Verification, which sends the record by email to a verifier (usually the service provider) for updating. The email includes a hyperlink to a special page to review and submit change requests. Responses to the verification request go into a queue for the iCarol subscriber/customer to review and accept before it is published, and available in their resource database, and through the Resource API.

• Eric Note: entire resource set syncing from HOME to iCarol would have to be entirely handled by HOME. There is no feature for this in Carol, but the existing resource APIs and Automatic Verification could be coupled to provide the iCarol side of this functionality, with no addition work from iCarol.

Optional Phase 2: (capabilities not yet available) Create new functionality for resource flagging and suggested changes to be send through the Resource API to the iCarol customer HOME App authorized users can then submit resource change requests through the iCarol Resource API. HOME App will also request (http post/put) additions and changes to housing resources within iCarol’s resource database. (Note: The iCarol customer would choose to allow suggestions/changes submitted through the Resource API to either be automatically accepted, or to be added to the queue for review first.)

Project 2: Contact sharing for interactions and profiles [Simple Contact & Profile Sharing]: Customer wants to partner with other local systems in order to create a more complete picture of homelessness/poverty in their community. The partners (211, other local systems) want to create an integrated file of shared clients in order to assess needs, match to available housing and services, track outcomes.

Phase 1: Home App exports daily contacts to be imported into iCarol.

1. Home App CES exports contact details to iCarol on a daily basis to a SFTP.

a. Daily Home App CES will export to an SFTP, in a Comma Separated Values (CSV) (or other) file type, the contact details submitted within the last 24 hours within Home App CES.

b. The exported file will include the following fields: [Need to define the specific fields, please feel free to rename and to provide an example]

1. Client ID

2. Client Name

3. Client Age

4. Client Gender

5. Client Physical Address (Address Line 1, City, County, State, Zip Code)

6. Client Phone

7. Client Phone Extension

8. Client Phone Alternative

9. Client Phone Alternative Extension

10. Contact ID

11. Contact Timestamp Start

12. Contact Timestamp End

13. Contact General Note

14. Referred Resource ID

15. Referred Resource Taxonomy Code for Need

16. [Insert other fields]

17. iCarol will import the exported file, each night into the iCarol Subscribers System, with follow up activities automatically scheduled.

a. Call Reports will be created for each contact. The Call Report will include where available any referrals provided from Home App, with their identified Taxonomy Code Need.

b. Caller Profiles will be created if not already created, and linked to the created Call Reports if available. [Note: We could build in some advanced logic that tries to find a profile already created in the iCarol system if not created, such as a profile with the same phone number if desired.]

c. A Follow-Up Activity will automatically be scheduled with [These can be changed to the iCarol Subscriber’s preference] the following values:

1. Due date "immediate."
2. Assigned to "Anyone Available"
3. Follow Up Type to "Call' [NOTE: We could also use SMS, Email, in-person types if Home App defines a different method]
4. Contact Method to "Phone" [NOTE: see above]
5. Phone to the imported Phone value
6. Name to ask for to the imported Name field
7. Subject to "Follow up from Home APP contact"
8. Follow up Instructions and Notes left blank

d.[Optional] Daily email notification sent to Admins to monitor the status of the import. (Normally, sent to Admin/technical contacts).

Optional Phase 1.1: (capabilities not yet available) Home App searches iCarol Caller profiles/Helpseekers that match clientele Home App is currently processing

1. HOME App searches for iCarol Caller Profile/help seeker that match clientele HOME App is currently processing (using new mechanism).
2. If Caller Profile/help seeker already exists in iCarol, new referral and follow-up information is submitted to iCarol to be appended to that client’s Caller Profile/help seeker record.
3. If Caller Profile/help seeker does not already exist in iCarol, new client and new referral and follow-up information is submitted to iCarol. In other words, new referral clients, referrals, and client follow-up records made in HOME App are shared back to iCarol.

Phase 2: iCarol to dispatch/post the original call report, and any related call reports back to Home App when submitted for ongoing updates/outcomes.

Authenticate with the Home App CES Hosted Application Programming Interface (API).

1. Post a JSON object of the Call Report, Follow Up Activity, Referral, and Needs status using standard and custom properties of the contact record.
2. Queue the posting of Call Reports for delivery upon submission in iCarol.
3. Regularly (every 2 minutes) the queue will be processed, and the Call Report JSON will be posted to the API.
4. Each Call Report will be updated with a confirmation code from the HOME App API. Call Reports submitted with an unsuccessful confirmation code will be reposted, for a maximum of 3 attempts.
5. Anytime a Call Report is resubmitted, the update will be posted to the Home App API, which will be responsible for reconciliation and updating.