This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). 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
Operation Definition
{
"resourceType": "OperationDefinition",
"id": "MessageHeader-process-message",
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message",
"name": "Process Message",
"status": "draft",
"kind": "operation",
"date": "2016-03-31T08:01:25+11:00",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "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](messaging.html#process)",
"code": "process-message",
"comment": "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 message parameter is always the body of the HTTP message",
"system": true,
"instance": false,
"parameter": [
{
"name": "content",
"use": "in",
"min": 1,
"max": "1",
"documentation": "The message to process (or, if using asynchronous messaging, it may be a response message to accept)",
"type": "Bundle"
},
{
"name": "async",
"use": "in",
"min": 0,
"max": "1",
"documentation": "If 'true' the message is processed using the asynchronous messaging pattern",
"type": "boolean"
},
{
"name": "response-url",
"use": "in",
"min": 0,
"max": "1",
"documentation": "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",
"type": "uri"
},
{
"name": "return",
"use": "out",
"min": 0,
"max": "1",
"documentation": "A response message, if synchronous messaging is being used (mandatory in this case). For asynchronous messaging, there is no return value",
"type": "Bundle"
}
]
}
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.