Skip to main content

GP2GP Management Information MESH API

Provide information to NHS Digital on the progress of the patient migration process between GP practices (GP2GP).

If you are developing a new integration, consider using its replacement, the GP Registrations Management Information API instead. 

We plan to deprecate and retire this API once its replacement is live.


Overview

Use this API to provide information to us at NHS Digital on the progress of the patient migration process between GP practices (GP2GP).

This involves recording patient registration activity in the GP systems at specific stages in the patient migration process.

For details, see NPFIT-PC-BLD-0173.01 GP2GP UC 2 Harvest and Prepare Management Information which describes the high level use case for reporting capability required by GP2GP 2.2b.


Who can use this API

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, by contacting us.

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



API status

This API is stable.

We plan to deprecate and retire it once its replacement is live.


Service level

This API uses MESH which is a silver service, meaning it is operational 24 x 7 x 365 but only supported during business hours (8am to 6pm), Monday to Friday excluding bank holidays.

For more details, see service levels.


Technology

This is an asynchronous messaging API.

Messages are sent and received as CSV files via MESH

For more details, see MESH.


Network access

This API is available on the internet and on the Health and Social Care Network (HSCN).

For more details see Network access for APIs.


Security and authorisation

This API uses MESH which is an application-restricted API.

This API does not perform any end user authentication or authorisation checks. Rather, the calling system is expected to perform them. 


Environments and testing

This API uses MESH.

As a developer, you are most likely to want to connect to MESH using either the MESH client or the MESH API.

For more details about using the MESH client, see MESH client.

For the MESH API, there are several independent, externally accessible instances of MESH you can use for testing. For full details, see MESH API - Environments and testing.


Onboarding

You need to get your software approved by us before it can go live with this API. We call this onboarding. The onboarding process can sometimes be quite long, so it’s worth planning well ahead.

Contact gp-registrations-data@nhs.net, to onboard with this API.


Interactions

For a full list of interactions for this API, see the Management Information section of the GP2GP 2.2b specification.

Last edited: 29 April 2022 7:51 am