Demonstrate technical conformance for the MESH API

Use this API to securely transfer healthcare data between organisations using the Message Exchange for Social Care and Health (MESH) API, which is a component of Spine.

Help and tips for completing this section

The following resources provide more details on how to complete technical conformance for the MESH API:

If you have been approved to use the MESH API, our assurance team will contact you via email with a supplier pack containing the testing requirements you will need to fulfill. You will work alongside this team to get your solution assured.

Apply for a MESH mailbox and TLS certificate for Path to Live integration

Follow the steps to apply for a mailbox.

To complete this process, you'll need:

  • the workflow groups or IDs for the files you plan to send or receive
  • the contact details of the person who will be managing the mailbox in your organisation

Data usage

Q.1

Have you received the details of your MESH mailbox in the Path to Live integration environment?

Q.1.1

Email itoc.supportdesk@nhs.net to request a MESH mailbox in Path to Live integration. You need to provide:

  • name
  • email address
  • telephone number
  • organisation name
  • ODS code

When the mailbox has been created, you will be given the mailbox ID and password.

Q.1.1
Q.1.2

Do you know the details of the workflow group you need associating to your mailbox?

Supporting information
You can enter up to 2000 characters
Q.2

Have you received your Transport Layer Security (TLS) certificate?

The mailbox ID forms part of the naming convention of the subject common name for your TLS certificate.

Generate a Certificate Signing Request (CSR) with the naming convention:

cn=mailboxid.odscode.api.mesh-client.nhs.uk

Email the CSR to the itoc.supportdesk@nhs.net who will generate and send the certificate.

When you receive your TLS certificate, you may need to download the G2 Root and Sub CA certificates.

MESH witness testing

You should have already received a test pack from us. We'll need to assure the content you've created in the integration environment against the test cases within the test pack.

Q.3

Have you submitted test evidence to NHS England for technical assurance?

This needs to include evidence that you can:

  • validate a mailbox (Handshake)
  • send a message
  • download a message
  • acknowledge the successful download of a message, which removes it from your inbox
Q.4

Have any changes been applied to your product after initial witness tests have been completed that may affect this integration?

If you've submitted a request for change (RFC) to NHS England to notify us of those changes, you can tell us more about that here.

You can enter up to 2000 characters