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.

Important: The preferred method for sending Online Consultation Reports is the MESH API, this is because the MESH API is more easily integrated into sending systems, and the MESH API Address Lookup function needs to used to identify MESH mailbox IDs for community pharmacies.

The MESH client can be used to send the message, but the MESH API Address Lookup is still required if sending to a community pharmacy.

The Message routing to registered practice can be used if only ever sending to the patient’s registered GP practice.

MESH API Address Lookup

GPCM-SD-OC-159 all messages sent through this use case to non-GP practice care providers MUST use the MESH API Address Lookup function to lookup the MESH mailbox ID of the receiving care provider.

Details of how to use Address Lookup can be found on the MESH API page

Workflow groups and Workflow ID

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

MESH API configuration

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

GPCM-SD-OC-162 Mex-From MUST contain the MESH mailbox ID of the sender of the message – in this case the originating organisation
GPCM-SD-OC-163 Mex-To MUST contain the MESH mailbox ID of the receiver of the message – in this case either the mailbox ID for the patient's registered GP practice, or chosen community pharmacy
GPCM-SD-OC-164 Mex-Subject MUST contain To text in the following format:

Online consultation report for {Patient Name}, NHS Number {NHS Number}, ODS Code {ODS Code}
GPCM-SD-OC-175 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:

GPCM-SD-OC-165 From_DTS MUST contain the MESH mailbox ID of the sender of the message – in this case the originating organisation
GPCM-SD-OC-166 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-OC-167 Subject MUST contain To text in the following format:

Online consultation report for {Patient Name}, NHS Number {NHS Number}, ODS Code {ODS Code}
GPCM-SD-OC-174 LocalID MUST contain the ODS code of the sending organisation

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>Online consultation report for patient Mr Richard Smith , NHS Number 1234567890, GP0001</Subject>
<LocalId>GP0001</LocalId>
<DTSId></DTSId>
<PartnerId></PartnerId>
<Compress>Y</Compress>
<Encrypted>N</Encrypted>
<WorkflowId>GPFED_CONSULT_REPORT</WorkflowId>
<ProcessId></ProcessId>
<DataChecksum></DataChecksum>
<IsCompressed>Y</IsCompressed>
</DTSControl>

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