v50

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-07-0381351.7 KB
Metadata

Get Message Definition

Returns MessageDefinitions supported by the target endpoint

The Message Definition retrieval is required to inform a Sender on building the payload. A request is made using the Service Identifier and workflow type values, linking to the useContext and event elements, respectively, in the Message Definition resource, returning a list of FHIR resources.

The order of workflow beyond this point is relatively flexible, the only stipulation being responses occurring after requests.

Sender

The request for Message Definition is the next step for a Sender following the metadata acquisition. The sender must request the Message Definition for the Service Identifier obtained previously, along with the type of workflow type e.g. booking-request, servicerequest-request. The Message Definition will contain a list of FHIR resources which the sender must include when making a booking or referral.

Receiver

A receiver dictates what they need from a sender making a request and the MessageDefinition is the mechanism to support this. The Message Definition details what FHIR resources need to be included in the body (payload). The receiver may support multiple services e.g. Out-of-Hours, Clinical Assessment Service under one organisation (on the same system) and consideration should be given to maintaining service identifiers and workflow type against Message Definitions. It's advisable to make this a configurable option which providers can maintain themselves as new services come onboard.

get/MessageDefinition

Query parameters

contextstring required
Example:https%3A%2F%2Ffhir.nhs.uk%2FId%2Fdos-service-id%7C2000099999

The target service identifier. Allowing the ability to filter returned message definitions by the specified service id. In this example a DoS id. The preferred format is system|value however a value should be accepted and honoured as per FHIR guidance.

Response

Success