Search loading...


Explore and Make use of Nationally Defined Messaging APIs



Introduction to the GP Connect Foundations capability


The foundations capability cover the basic API requirements and prerequisites to utilise the GP Connect APIs.



You’ll need to be able to provide a verified NHS Number to use an API. This can be achieved using a spine accredited system, a DBS batch-traced record (CSV), or using a Spine Mini Services Provider (HL7v3).


In order to resolve a given GP Practice organisation to their URI you’ll need to be able to do a spine SDS query (LDAP) using the practice’s ODS Code to perform an SDS End Point Lookup.


In order to be a compliant FHIR server, provider systems need to expose a valid FHIR Conformance profile.

Please also refer to Development Guidance - FHIR API Guidance - Common API Guidance for full details on the common FHIR API patterns used throughout all the GP Connect APIs.

Use cases

Spine interactions

The Foundation capability message set includes the following set of spine interactions:

Operation InteractionID
Read Metadata urn:nhs:names:services:gpconnect:fhir:rest:read:metadata

All content is available under the Open Government Licence v3.0, except where otherwise stated