Skip to main content
Table of contents

Message Exchange for Social Care and Health (MESH) API

Overview

Use this API to securely transfer healthcare data between organisations using the Message Exchange for Social Care and Health (MESH), which is a component of Spine. You interact with MESH via a virtual mailbox, only accessible to your organisation, by making calls to this API from your application. You can:

check the number of messages in your inbox

get the messageIds of messages in your inbox that are ready for download

download a message, or a larger message which was sent to you as a series of chunks

acknowledge the successful download of a message, which removes it from your inbox

look up the mailbox of an organisation you want to send data to

send a message, or a larger message as series of chunks

track the status of messages that you sent from your outbox

validate your mailbox every 24 hours to let Spine know it's still active

Messages must have a:

sender mailbox ID

receiver mailbox ID

workflow ID provided by MESH, that identifies what type of data the message contains, so the receiving organisation knows how to process it. For example, the receiver might process X-ray image data differently from blood test results.

You can also interact with MESH via a Java-based MESH client or a web-based MESH User Interface.

Documentation

Message Exchange for Social Care and Health (MESH) API documentation

Endpoint

https://digital.nhs.uk/developer/api-catalogue/message-exchange-for-social-care-and-health-api

Contact

https://digital.nhs.uk/developer/help-and-support