February 2024

Purpose: The purpose of this API is to allow integration with remote monitors. The details are shown on the monitor dashboard. The details being sent back from the monitor may include:Date/timeMonitor IDMonitor statusReading e.g. temperature Example User Case: To keep an eye on the temperature in a Service Users house. SWAGGER LINK Documentation ...

Purpose: The purpose of this AP is to integrate with Nurse call systems to avoid the need for rekeying carer and Service Users. The process is as follows:Send a list of carersSend a list of Service UsersReceive one or many nurse call details. Including call and response times Example User Case: Nurse call integration to pass down daily location details and receive back nurse call timings and notes. Download Documentation ...

Purpose: The purpose of this API is to facilitate the creation of carer shifts. In this case the location of the shift is required as well as a start and end date/time. The shift can be a short shift (e.g. a daily shift 8-8) or a long term shift.Example User Case: When creating shift details in an external rostering system. SWAGGER LINK Documentation ...

Purpose: The purpose of this API is to enable a third party application to get details of: A service user A list of all active service users Example User Case: To provide a system with SU details to ensure the ‘one-version of truth’ is managed by one system and avoid re-keying of information. E.g. an e-mar system. SWAGGER LINK ...

Purpose: The purpose of this API is to facilitate the creation of service users in the Carebeans system and amend core details. The Service user can be set up with the following status:Active - care plans are created and the user is ready to be cared forPending: the service user is not yet active, In this case pre-assessment details are created Example User Case: When creating a service user in a CRM system - when they turn from a prospect to a Customer SWAGGER LINK ...