Skip to main content

GP2GP - HL7 V3 API

Transfer patients' electronic health records, securely and quickly, between their old and new practices when they change GPs.

Overview

Use this API to transfer patients' electronic health records between old and new practices when they change GPs.

You can:

  • include large records and those with many attachments
  • reduce paper printing when patients leave a practice
  • integrate (file) the electronic health record for returning patients
  • log issues easily with easy-to-understand and more informative error messages
  • monitor in real time the processes to track issues and performance

For more details, see GP2GP.

Legal use

This API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development.

You must do this before you can go live (see ‘Onboarding’ below). 

Related APIs

The following APIs are related to this one:

API status

This API is stable.

Technology

This API is an HL7 V3 API.

For more details, see HL7 V3.

Network access

You can access this API via:

For more details, see Network access for APIs.

Security and authorisation

Authentication

This API is user-restricted, meaning an end user must be present and authenticated to use it.

The end user must be:

  • a healthcare professional
  • strongly authenticated using an NHS smartcard

For more details see user-restricted APIs.

Authorisation

For some activities, the end user must be authorised to perform that activity.

The API itself does not perform any authorisation checks. Rather, the calling system is expected to perform them. The authorisation rules are specified in our national Role Based Access Control (RBAC) database.

For more details see our national Role Based Access Control (RBAC) database on the registration authorities and smartcards page.

Testing

You can test this API using our Path to Live environments.

Onboarding

You must get your software onboarded before it can go live.

As part of onboarding, this API uses the Common Assurance Process (CAP), which is tailored for each NHS service. For more details, contact us.

Interactions

For a full list of interactions for this API, see the GP2GP domain in the Spine Message Implementation Manual (MIM).

For details on the general structure of the interactions, see HL7 V3.

Additional guidance

For more details about requirements and specifications of the record transfer mechanism, see the GP2GP section in the GP IT Futures Capabilities and Standards guidance.

Last edited: 16 December 2020 12:52 pm