GP Connect - Update Record (ITK3)

Part of the GP Connect product family
A newer version of this specification is available (v1.1.1-public-beta).
An issue was identified with the FHIR package supplied with this version of the specification, which has been rectified.
Please click here to view the patched v1.1.1-public-beta specification with the updated FHIR package.

How to configure MESH

This section assumes you are already familiar with MESH and contains information about how to populate the MESH configuration.

If you'd like to find out more about MESH, please see the NHS England documentation for MESH below:

https://digital.nhs.uk/services/message-exchange-for-social-care-and-health-mesh.

MESH message routing

  • all messages sent through to a GP practice MUST use MESH automated message routing to ensure that the message is routed correctly to the registered practice of the patient

Workflow groups and ID

  • all documents MUST use the MESH workflow ID: GPCONNECT_UPDATE_RECORD
  • an acknowledgement message generated because of receipt of a document MUST include the following Workflow ID in the MESH message metadata: GPCONNECT_UPDATE_RECORD_ACK

MESH API configuration

When using the MESH API the Send Message API call will be used by a practice API client to send a message to the MESH server. MESH metadata items are defined in HTTP header fields as described below:

More information can be found in the MESH documentation.

  • mex-from MUST contain the MESH mailbox ID of the sender of the message – for example, the originating organisation

  • mex-to MUST contain the NHS Number, DOB and Surname of the patient delimited by the underscore character _. This enables automatic routing of the message to the registered GP MESH mailbox

  • mex-subject MUST contain a string based on the following format: [payload-title] for [patient-name], NHS Number: [nhs-number], seen at [practice-name], ODS code: [ods-code], version [version]

  • mex-localid MUST contain the ODS code of the sending organisation

  • mex-workflowid MUST contain the string GPCONNECT_UPDATE_RECORD

  • mex-localid MUST contain the ODS code of the sending organisation

MESH client configuration

When using the MESH client to send a message to the MESH server, the .CTL file will contain the following metadata about the message:

  • Version MUST be the version of the document that is being sent - for example, the initial version will be 1, and subsequent versions of updated / replaced documents will increment by 1

  • From_DTS MUST contain the MESH mailbox ID of the sender of the message – for example, the originating organisation

  • To_DTS MUST contain the NHS Number, DOB and Surname of the patient delimited by the underscore character _. This enables automatic routing of the message to the registered GP MESH mailbox

  • Subject MUST contain a string based on the following format: [document-title] for [patient-name], NHS Number: [nhs-number], seen at [location-name], [ods-code], Version: [version-number]

  • LocalID MUST contain the ODS code of the sending organisation

Example

<DTSControl>
    <Version>1</Version>
    <AddressType>DTS</AddressType>
    <MessageType>Data</MessageType>
    <From_DTS>GP0001</From_DTS>
    <To_DTS>GPPROVIDER_4857773456_09011955_Mowers</To_DTS>
    <Subject>[payload-title] for [patient-name], NHS Number: [nhs-number], seen at [practice-name], ODS code: [ods-code], version [version]</Subject>
    <LocalId>GP0001</LocalId>
    <DTSId></DTSId>
    <PartnerId></PartnerId>
    <Compress>Y</Compress>
    <Encrypted>N</Encrypted>
    <WorkflowId>GPCONNECT_UPDATE_RECORD</WorkflowId>
    <ProcessId></ProcessId>
    <DataChecksum></DataChecksum>
    <IsCompressed>Y</IsCompressed>
</DTSControl>
back to top