We have developed a set of principles to guide our actions.
Make learning easier
Our API documentation will be online, accessible and clear. We will provide hands-on tutorials and sandboxes so you can try things out. We will provide feedback channels so you can tell us what you think.
Make designing and building easier
Our APIs will be internet-facing and simple to use. We will use modern open standards, such as REST, FHIR, OAuth 2.0. We will use clinical information standards such as SNOMED CT, dm+d, ICD, OPCS and UTL. We will use NHS Care Identity Service 2 (NHS CIS2) and NHS login for authentication.
Make testing easier
Our test environments will be self-service and well-documented. We will provide easy-to-use sandboxes for early developer testing.
Make onboarding easier
Our API onboarding process will be as simple as possible, only asking you to do things that are needed. We won't compromise clinical safety, privacy or security.
Make help and support easier
Our API platform will be as self-service as possible. When you do need help, we will provide simple and reliable support.
Make building APIs easier
Building APIs on our platform will be cloud-based and self-service. We will provide support, guidance and lightweight governance to API producer teams. There will be a structured yet agile API delivery process.
We will follow the GDS agile delivery process, doing the hard work to make it simple. We will listen to your feedback and we will measure success.