Carebeans aims to support the NHS goal and vision of a people powered health and social care system enabled by the Integrated Digital Care Record. We need an interoperable ecosystem of applications, data and processes to allow the right information to be available to the right user at the right time. The fundamental elements of the vision are:
Principles for Open Standards across government for software interoperability, data and document formats have been directed by the Government Digital Service.
The importance of using an Open API approach and hence the value of the policy is to:
The term Open API refers to all methods of software-to-software interaction including, but not limited to, web interfaces, direct program interfaces, batch/file drops over FTP etc.
Carebeans is a commercial organisation that has, and continues to invest, in the development of its IPR. There are key principles that are fundamental to the health of the company, its customers and data privacy: Carebeans system IPR must not be compromised and will not be shared with competing organisations. It is our customers data and they determine how it can be used and who by. The integrity of the system must be maintained. The privacy of personal data is paramount.
In order to access our API download page, you will first need to fill in our API application form.
We will be constantly adding and updating our available APIs.
Although API’s provide access to the Carebeans system the data does not belong to Carebeans. In this context, Carebeans is the processor. The data controller, the care provider (Carebeans customer) owns the data and will need to provide explicit permission in the form of a change to the processor/controller agreement.
It will be up to the care provider to determine and document consent of any Service users and system users if their data is to be shared.
Partners wanting to consume APIs must go through the below process:
Although the API is free to use it is not open for anyone to access. Security and privacy of our customers data is paramount and there is a process to be followed to allow access. In summary:
The following types of API are in the scope of shared APIs:
The objective, over time, is to make Data held in Carebeans system available via an Open API, consistent with the HM Government Open Data policy.
This will take time and the roadmap will be based on need.
The following APIs are not available for sharing:
This section outlines the specific policy statements and principles for our Open APIs:
API security is concerned with the transfer of data through APIs that are connected to the internet. Broken, exposed, or hacked APIs are behind major data breaches and as such Carebeans applies all the best practices to ensure sensitive data is secured.
The following security is placed for the protection of the integrity of all APIs – both consumed and provided:
Although the API is free to use it is not open for anyone to access. Security and privacy of our customers data is paramount and there is a process to be followed to allow access. In summary:
Please fill in the form shown, giving as much information as you can in relation to your intended use of our APIs.
A member of our team will be in touch with you in due course once your application has been submitted.
If you would prefer to send an email, please do so by clicking here.
Copyright © 2024 Carebeans All Rights Reserved Carebeans
The Innovation Centre, Sci-Tech Daresbury, Keckwick Lane, Daresbury, Cheshire WA4 4FS. Tel. 01925 386800