We have detected that you are using Internet Explorer to visit this website. Internet Explorer is now being phased out by Microsoft. As a result, NHS Digital no longer supports any version of Internet Explorer for our web-based products, as it involves considerable extra effort and expense, which cannot be justified from public funds. Some features on this site will not work. You should use a modern browser such as Edge, Chrome, Firefox, or Safari. If you have difficulty installing or accessing a different browser, contact your IT support team.
GP Connect Send Document - FHIR API
Send a PDF consultation summary to a registered GP practice.
Page contents
Overview
Use this API to send a PDF consultation summary to a registered GP practice - using GP Connect Messaging.
You can:
- create messages to send using MESH
- use the HL7 FHIR STU3 interoperability standard to define the message structure
- include FHIR messaging information as defined by the ITK3 message distribution standard v2.5.0
For example, to send a document containing a patient's consultation notes to their GP practice when a patient is seen:
- at another GP practice than their own
- by an out of hours service
- by a district nurse at home
Each message sent using this API uses the GP Connect Messaging components, MESH, and ITK3, to deliver the message.
Each message sent is a FHIR Message, defined as a FHIR composition, constructed to meet the ITK3 standard with a specific payload structure.
For more details, see the GP Connect specifications for developers.
API status
This API (v1.3.0) is in beta.
Technology
This API is a FHIR API.
For more details, see FHIR.
Interactions
For a full list of interactions for this API, see Send Document.
For details on the general structure of the interactions, see FHIR.