GP Connect Access Record: Structured - FHIR API

Overview

 

Use this API to access structured information from a patient’s registered GP practice record. Structured information is patient data in a coded format that a consuming system can import and process.

The API accesses GP principal supplier systems, provides a consistent interface and data model, and is brokered through Spine. 

You can retrieve data from GP practice records for the following areas:

medications

allergies

Data is available for the following clinical areas:

immunizations

consultations

problems

investigations

outbound referrals

diary entries

uncategorised data (other clinically coded items that are present in the record)

These clinical areas are still in development; there is enough data to test, but it is subject to change as GP systems suppliers go through the development process.

It does not include:

extended demographics information - for example, about carers

flags and alerts

templates

test requests

Common use cases include:

access GP medications on admission to secondary care, reducing transcription errors

active checking of a patient's prescription in unscheduled care

out-of-hours GP accesses patient's medications, allergies and problems

midwife views patient record before visiting a patient

community cardiac nurse accesses GP record before visiting a patient

For more details, see the GP Connect Access Record: Structured specification.

You cannot currently use this API to:

create patient-facing views of a medical record

create reports for secondary use, such as care planning

write back to the GP record

Retrieving documents

To retrieve documents from a patient’s registered GP practice, use GP Connect Access Document - FHIR API. After you've found the relevant document references within Access Record returns, use GP Connect Access Document to retrieve the documents. All documents can be requested separately.

Start your development work within 6 months of use case approval. If you miss this date, a review or new submission of the use case will be required. Changes or additional development will also require a review or new use case submission. For full details of the technical conformance process, see GP Connect Consumer Supplier Test Assurance for achieving Technical Conformance (PDF).

Clinical assurance process

We are here to support you to develop clinically safe systems in line with your responsibility to achieve the relevant DCB0129 or DCB0160 clinical safety standards. 

We host a series of meetings to help you develop clinically safe systems:

initial meeting

clinical safety process readiness review meeting

clinical evaluation of readiness for deployment meeting

For more information, see Clinical assurance process details.

Documentation

GP Connect Access Record: Structured - FHIR API documentation

Endpoint

https://digital.nhs.uk/developer/api-catalogue/gp-connect-access-record-structured-fhir

Contact

https://digital.nhs.uk/developer/help-and-support