Guidance for API platform case studies

We want our APIs to be used as much as possible, by as many organisations as possible. The more integration, the better the chance that healthcare workers and patients have the information they need, whenever and wherever they need it. 

In order to encourage more organisations to integrate with our APIs, we want to build up a portfolio of real-world examples of what it’s like to integrate with our APIs. 

The idea is to showcase these case studies from our developer and integration hub, so that organisations looking at the hub can find them and read them. It might also potentially give your product a little extra publicity. 

So, if you have integrated with one of our APIs recently and would be interested in co-authoring a case study with us, read on. 

From our perspective, the purpose of the case studies is a sales pitch for integration and APIs. 

From your perspective, it’s also an opportunity to talk about your healthcare software. But we have a responsibility to be fair and unbiased, so we cannot include your case study if it is an overt sales pitch for your software. You need to keep it factual and objective. 

Here’s a suggested structure: 

• a brief summary of your organisation 

• a brief summary of your product 

• details of which of our APIs you have integrated with, and what you use them for 

• details of your integration experience, possibly including: 

• how easy it was to understand the API documentation 

• how easy the technical integration was 

• in particular, for FHIR APIs, whether it was any easier because the API uses FHIR 

• how easy testing was 

• how easy onboarding for production access was 

• how easy it was to get help and support when you needed it

For some examples, see Case studies and Health care case studies.

You can: 

• publish it on your own website, in which case we will link to it 

• ask us to publish it on our website 

Either way, we'll review your content to make sure we’re happy with it before publishing or linking to it. 

If it’s on your website: 

• you cannot use the NHS Digital logo 

• you cannot say or imply that your product is endorsed or approved by NHS Digital, unless you are part of a programme or framework that includes specific endorsements or approvals 

When you’re ready to publish, or to discuss your ideas with us, contact us.