GP Connect: Patient Facing APIs

GP Connect: Patient Facing APIs allow patients to use a consumer application (for example, NHS App) to:

• view their GP electronic health record
• request repeat prescriptions 
• retrieve the PFS permissions set by their GP practice 

The API and integration catalogue is for APIs and integrations which are currently available, or in development, from NHS England and associated organisations. Discover the (draft) integration process for each PFS API:

• GP Connect (Patient Facing) Access Record - FHIR API
• GP Connect (Patient Facing) Prescriptions - FHIR API
• GP Connect (Patient Facing) User Permissions API

The PFS API implementation guides (in Simplifier) show you how to design, build and authenticate a conformant GP Connect API interface:

• GP Connect (Patient Facing) Access Record - FHIR API
• GP Connect (Patient Facing) Prescriptions - FHIR API
• GP Connect (Patient Facing) User Permissions API

Access the PFS API specifications in GitHub:

• GP Connect (Patient Facing) Access Record - FHIR API
• GP Connect (Patient Facing) Prescriptions - FHIR API
• GP Connect (Patient Facing) User Permissions API

The NHS England API platform is a ‘front door’ for health and care APIs, primarily for the NHS in England. 

The API producer zone is a Confluence space that contains detailed guidance on building healthcare APIs. You'll need an NHS England Confluence account to access this.

Each PFS API requires integration with NHS login for authentication and authorisation. The PFS Access Record and PFS Prescriptions APIs depend on the PFS User Permissions API for access.

Key:

* NHS login ID token
Granted by NHS login. Used by APIM authorisation service and GP supplier system authorisation service.

† Access token
Granted by by APIM authorisation service. Required by PFS API proxy to authenticate consumer application requests.

‡ Endpoint service access token
Granted by by APIM authorisation service. Used by APIM proxy to access APIM endpoint service.

§ GP supplier system access token
Granted by GP supplier system authorisation service. Used by mediation service to access GP supplier system GP Connect APIs.

** Provider trust URL
Returned from APIM endpoint service. Used by mediation service to access GP supplier system endpoints.

If you have access to the API producer zone (see above), learn how to secure your API.

If you have access to the API producer zone (see above), learn about onboarding a new provider to the PFS APIs. Onboarding is subject to GP Connect approval.

Before you start developing against the PFS API specifications, we recommend you email the GP Connect programme team: [email protected].

You can discuss your goals and use cases with the team.