GP2GP Management Information MESH
Provide information to us 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.
This integration is in production, but under review for deprecation. We will contact you before agreeing to a retirement date.
Overview
Use this integration to provide information to us 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.
This integration uses MESH to send and receive messages.
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
This integration 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).
Status
This API is in production, but under review for deprecation.
We plan to deprecate and retire it once its replacement is live. We will contact you before agreeing to a retirement date.
Service level
This integration uses MESH which is a silver service, meaning it is operational 24 hours a day, 365 days a year 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 integration.
Messages are sent and received as CSV files via MESH
For more details, see MESH.
Network access
This integration is available on the internet and on the Health and Social Care Network (HSCN).
For more details see Network access for APIs.
Environments and testing
This integration 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 integration. We call this onboarding. The onboarding process can sometimes be quite long, so it’s worth planning well ahead.
Contact [email protected], to onboard with this integration.
Interactions
This integration uses the following MESH workflow IDs to provide information to us on the progress of the patient migration process between GP practices (GP2GP):
- GP2GP_MI
- GP2GP
For a full list of interactions for this integration, see the Management Information section of the GP2GP 2.2b specification.
Last edited: 21 November 2023 10:58 am