Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

MESH message configuration

Consultation - MESH configuration

Please refer to Integration to MESH for an introduction to the use of MESH for GP Connect Messaging use cases.

MESH message routing

GPCM-SD-056 all messages sent through this use case MUST use MESH automated message routing in order to ensure that the message is routed correctly to the registered practice of the patient

Please refer to Message routing to registered practice for details of how to use this facility.

Workflow groups and Workflow ID

GPCM-SD-057 each instance of a Send Consultation Report message MUST include the following MESH Workflow ID in the MESH message metadata: GPFED_CONSULT_REPORT
GPCM-SD-058 each instance of an acknowledgement message generated as a result of receipt of a Send Consultation Report message MUST include the following Workflow ID in the MESH message metadata: GPFED_CONSULT_REPORT_ACK

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:

GPCM-SD-059 From_DTS MUST contain the MESH mailbox ID of the sender of the message – in this case the originating GP practice
GPCM-SD-060 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
GPCM-SD-061 Subject MUST contain To text in the following format:

Consultation report for {Patient Name} , NHS Number {NHS Number}, seen at {Practice Name}, ODS Code {ODS Code}

An example .CTL file is given below for a Consultation Report message regarding a consultation which took place for a fictional patient: Mr Richard Smith, NHS Number 1234567890, Date of birth 9th January 1955.

<DTSControl>
<Version>1.0</Version>
<AddressType>DTS</AddressType>
<MessageType>Data</MessageType>
<From_DTS>GP0001</From_DTS>
<To_DTS>GPPROVIDER_1234567890_09011955_Smith</To_DTS>
<Subject>GP consultation report for patient Mr Richard Smith , NHS Number 1234567890, with details of encounter which at practice GP0001</Subject>
<LocalId></LocalId>
<DTSId></DTSId>
<PartnerId></PartnerId>
<Compress>Y</Compress>
<Encrypted>N</Encrypted>
<WorkflowId>GPFED_CONSULT_REPORT</WorkflowId>
<ProcessId></ProcessId>
<DataChecksum></DataChecksum>
<IsCompressed>Y</IsCompressed>
</DTSControl>

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:

GPCM-SD-062 Mex-From MUST contain the MESH mailbox ID of the sender of the message – in this case the originating GP practice
GPCM-SD-063 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
GPCM-SD-064 Mex-Subject MUST contain To text in the following format:

Consultation report for {Patient Name} , NHS Number {NHS Number}, seen at {Practice Name}, ODS Code {ODS Code}
Tags: mesh

All content is available under the Open Government Licence v3.0, except where otherwise stated