NHS North West Genomics - Local Development build (v2.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Message Exchange

Reference

1. FHIR Messaging
2. See also Message Exchange for Social Care and Health (MESH) API

Asynchronous Messaging

This is based on Asynchronous Messaging using the RESTful API

sequenceDiagram

participant consumer as Message Consumer
participant esb as Regional Integration Engine

consumer ->> esb: Check Inbox (GET /Bundle?message.receiver:identifier={odsCode})
esb -->> consumer: Messages
alt For each individual Message
    consumer ->> esb: Acknowledge Message (POST /Bundle) 
end

Search - Checking an Inbox

message.receiver:identifier is a mandatory parameter and must match the OAuth2 clientID associated with the ODS code.

Examples

Searching for Messages for NE&Y Genomics after 1st May 2026..

GET [base]/Bundle?message.receiver:identifier=699N0&_lastUpdated=gt2026-05-01
Accept: application/fhir+json
Authorization: Bearer {accessToken}

Search Response

GET [base]/Bundle?message.reciever:identifier=R0A&_lastUpdated=>2025-03-01T02:00:02+01:00
Accept: application/fhir+json
Authorization: Bearer {accessToken}

Bundle 'SearchSet' - Genomics Order

Acknowledge a Message

Acknowledging a Message removes it from the Inbox.

The Bundle is taken from the Check Inbox search, only the MessageHeader resource is required where the source and destination elements are swapped over, and posts it back to the server. E.g.

Original MessageHeader

{
  "resourceType" : "MessageHeader",
  ...
  "destination" : [
    {
      "endpoint" : "http://www.acme.org/endpoint/HIVE",
      "receiver" : {
        "identifier" : {
          "system" : "https://fhir.nhs.uk/Id/ods-organization-code",
          "value" : "R0A"
        },
        "display" : "MANCHESTER UNIVERSITY NHS FOUNDATION TRUST"
      }
    }
  ],
  "sender" : {
    "identifier" : {
      "system" : "https://fhir.nhs.uk/Id/ods-organization-code",
      "value" : "699X0"
    },
    "display" : "NORTH WEST GLH"
  },
  ...
}

Reversed MessageHeader

{
  "resourceType" : "MessageHeader",
  ...
  "destination" : [
    {
      "endpoint" : "http://www.acme.org/endpoint/RIE",
      "receiver" : {
        "identifier" : {
          "system" : "https://fhir.nhs.uk/Id/ods-organization-code",
          "value" : "699X0"
        },
        "display" : "NORTH WEST GLH"
      }
    }
  ],
  "sender" : {
    "identifier" : {
      "system" : "https://fhir.nhs.uk/Id/ods-organization-code",
      "value" : "R0A"
    },
    "display" : "MANCHESTER UNIVERSITY NHS FOUNDATION TRUST"
  },
  ...
}

Examples

Acknowledge a single message.

POST [base]/Bundle
Content-Type: application/fhir+json
Authorization: Bearer {accessToken}

Request