Purpose
The foundations capability cover the basic API requirements and prerequisites to utilise the GP Connect APIs.
Prerequisites
PDS
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).
SDS / ODS
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.
FHIR
In order to be a compliant FHIR server, provider systems need to expose a valid FHIR CapabilityStatement 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.
Scenarios
- Search for a patient by
NHS Number
. - Search for an organisation by
ODS Code
. - Search for a practitioner by
SDS UserID
.
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-1 |
Read Patient | urn:nhs:names:services:gpconnect:fhir:rest:read:patient-1 |
Patient Search | urn:nhs:names:services:gpconnect:fhir:rest:search:patient-1 |
Read Practitioner | urn:nhs:names:services:gpconnect:fhir:rest:read:practitioner-1 |
Practitioner Search | urn:nhs:names:services:gpconnect:fhir:rest:search:practitioner-1 |
Read Organisation | urn:nhs:names:services:gpconnect:fhir:rest:read:organization-1 |
Organisation Search | urn:nhs:names:services:gpconnect:fhir:rest:search:organization-1 |
Read Location | urn:nhs:names:services:gpconnect:fhir:rest:read:location-1 |
The Register Patient API Use Case, which is included in the Foundations capabilty has a seperate “Register Patient” message set:
Operation | InteractionID |
---|---|
Register Patient | urn:nhs:names:services:gpconnect:fhir:operation:gpc.registerpatient-1 |