This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Infrastructure And Messaging Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Device, Practitioner |
This is the narrative for the resource. See also the XML or JSON format.
OPERATION: Process Message
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message
This operation accepts a message, processes it according to the definition of the event in the message header, and returns a one or more response messages. This operation is described in detail on the messaging page
URL: [base]/$process-message
Parameters
Use | Name | Cardinality | Type | Binding | Documentation |
IN | content | 1..1 | Bundle | The message to process (or, if using asynchronous messaging, it may be a response message to accept) | |
IN | async | 0..1 | boolean | If 'true' the message is processed using the asynchronous messaging pattern | |
IN | response-url | 0..1 | url | A URL to submit response messages to, if asynchronous messaging is being used, and if the MessageHeader.source.endpoint is not the appropriate place to submit responses | |
OUT | return | 0..1 | Bundle | A response message, if synchronous messaging is being used (mandatory in this case). For asynchronous messaging, there is no return value |
This operation does not use the parameters resource; the parameters "async" and "response-url" always go in the URL, if they are used, and the "content" parameter is always the body of the HTTP message
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.