These pages assist with requirements gathering and mapping stages of a FHIR API development process.

The Test section contains descriptions of approaches and suggestions for building APIs.

Page Description
Patterns / Topology Describes access patterns necessary which influence the access, security and use of APIs. Depending on the pattern or topology of the requesting and responding system. The relationship between the requestor and responder influences the choice of access mechanism, security of payload and access finally build of the system
Access The access mechanism and of requesting system is influenced by many factors. This section demonstrates the design decisions to consider
Security The security of the FHIR payload, access and data at rest are all important design decisions while building an API.
Test Data The test data allows the testing of the Care Connect APIs at the individual response level.

Please see or contribute to INTEROPen to support the wider community efforts of providing a completely defined API service.

Providing an API

The following diagram explains the elements of APIs allowing a 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
Tags: overview