Provides an overview and background to the Reference Implementation and where this fits into the overall Care Connect API journey.

Care Connect Reference Implementation

The Reference Implementation allows developers to interact with Care Connect API profiles through server calls and an interactive website overlay. The Reference Implementation profiles exposed match the Care Connect profiles. The Reference Implementation shows how these profiles can be completed with synthetic Reference Implementation data. The use of the Reference Implementation is to aid the process of designing and building Care Connect APIs by:

  • providing a code base as a Reference Implementation for a Care Connect FHIR API;
  • exposing the Care Connect API – in order that calls can be made;
  • providing clinically sensible search results (test data), based on predefined search parameters;
  • providing a Care Connect API interface, that in its response includes Care Connect defined value sets; and
  • providing valid responses and report codes where appropriate.

Created for DEVELOPERS

The reference implementation has been designed for DEVELOPERS to interact, use and help in building Care Connect APIs.


The Reference Implementation sits alongside a wider API delivery that INTEROPen (including NHS Digital and other supporting members) aims to produce and popularise. The Reference Implementation specified in this document sits in the following wider process.

Therefore the Reference Implementation is seen as a key way of enabling the successful and consistent use of Care Connect API profiles across all care settings. The Reference Implementation is also a key transition between the theory of the Care Connect FHIR APIs and the practicality of implementing and demonstrating the API profiles in live systems.


For feedback and comments on the Reference Implementation please message the team on INTEROPen Ryver CareConnect API, or get in touch with

For an issues with the Reference Implementation please see Use of RI.

Providing an API

The following diagram explains the elements of APIs allowing the development of APIs:

provide_api Local decision Explained Provided Key: API Security Transform Traffic Management Versioning Engage API Docs Report & Monitor Patterns / Topology Access Endpoint

NHS Digital is contributing to progressing the profile development (see Overview section). Invitations are open for the INTEROPen community to get involved and progress the wider developer ecosystem as defined above.


This site is structured around Care Connect stakeholders including API users, developers and architects. Please get involved in the journey.

guide Engage Clinical scenarios User stories Case Studies Benefits Clinical inspiration Explore Impl Guide Resource Profiles API definitions Search parameters Value sets Design & Build Build APIs Search Ex. Code examples Validation tools Security examples Test Test data Security tests Reference servers Secure store Example data Assure Automated tests Test Reports Test Evidence Conformance reports Assurance checklist Deploy (Pilot) API harness Warranted environment IG / IS Spine comms Record locator Deploy (Live) Registry Monitor Support Conformance statement Extensions