6.11 Resource MessageHeader - Content
The header for a message exchange that is either requesting or responding to an action. The resource(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
## 6.11.1 Scope and Usage
The MessageHeader resource is defined in order to support Messaging using FHIR resources.
The principle usage of the MessageHeader resource is when messages are exchanged. However, as a
resource that can be used with the RESTful framework, the MessageHeader
resource has the normal resource end-point ([base-url]/Message), which is
used to manage a set of static messages resources. This could be used to
make an archive of past messages available. Creating or updating Message resources
in this fashion does not represent the actual occurrence of any event, nor can it trigger
any logic associated with the actual event. It is just for managing a set of message resources.
6.11.2
Resource Content
Structure
Name | Card. | Type | Description & Constraints |
---|---|---|---|
MessageHeader | Resource | A resource that describes a message that is exchanged between systems | |
identifier | 1..1 | id | Id of this message |
timestamp | 1..1 | instant | Time that the message was sent |
event | 1..1 | Coding | Code for the event this message represents MessageEvent (Incomplete) |
response | Element | If this is a reply to prior message | |
identifier | 1..1 | id | Id of original message |
code | 1..1 | code | ok | transient-error | fatal-error ResponseType (Required) |
details | 0..1 | OperationOutcome | Specific list of hints/warnings/errors |
source | Element | Message Source Application | |
name | 0..1 | string | Name of system |
software | 1..1 | string | Name of software running the system |
version | 0..1 | string | Version of software running |
contact | 0..1 | Contact | Human contact for problems |
endpoint | 1..1 | uri | Actual message source address or id |
destination | Element | Message Destination Application(s) | |
name | 0..1 | string | Name of system |
target | 0..1 | Device | Particular delivery destination within the destination |
endpoint | 1..1 | uri | Actual destination address or id |
enterer | 0..1 | Practitioner | The source of the data entry |
author | 0..1 | Practitioner | The source of the decision |
receiver | 0..1 | Practitioner | Organization | Intended "real-world" recipient for the data |
responsible | 0..1 | Practitioner | Organization | Final responsibility for event |
reason | 0..1 | CodeableConcept | Cause of event EventReason (Example) |
data | 0..* | Any | The actual content of the message |
XML Template
<MessageHeader xmlns="http://hl7.org/fhir">
<!– from Resource: extension, modifierExtension, language, text, and contained –>
<identifier value="[id]"/><!– 1..1 Id of this message –>
<timestamp value="[instant]"/><!– 1..1 Time that the message was sent –>
<event><!– 1..1 Coding Code for the event this message represents –></event>
<response> <!– 0..1 If this is a reply to prior message –>
<identifier value="[id]"/><!– 1..1 Id of original message –>
<code value="[code]"/><!– 1..1 ok | transient-error | fatal-error –>
<details><!– 0..1 Resource(OperationOutcome) Specific list of hints/warnings/errors –></details>
</response>
<source> <!– 1..1 Message Source Application –>
<name value="[string]"/><!– 0..1 Name of system –>
<software value="[string]"/><!– 1..1 Name of software running the system –>
<version value="[string]"/><!– 0..1 Version of software running –>
<contact><!– 0..1 Contact Human contact for problems –></contact>
<endpoint value="[uri]"/><!– 1..1 Actual message source address or id –>
</source>
<destination> <!– 0..* Message Destination Application(s) –>
<name value="[string]"/><!– 0..1 Name of system –>
<target><!– 0..1 Resource(Device) Particular delivery destination within the destination –></target>
<endpoint value="[uri]"/><!– 1..1 Actual destination address or id –>
</destination>
<enterer><!– 0..1 Resource(Practitioner) The source of the data entry –></enterer>
<author><!– 0..1 Resource(Practitioner) The source of the decision –></author>
<receiver><!– 0..1 Resource(Practitioner|Organization)
Intended "real-world" recipient for the data –></receiver>
<responsible><!– 0..1 Resource(Practitioner|Organization)
Final responsibility for event –></responsible>
<reason><!– 0..1 CodeableConcept Cause of event –></reason>
<data><!– 0..* Resource(Any) The actual content of the message –></data>
</MessageHeader>
Alternate definitions: Schema/Schematron,
Resource Profile (XML, JSON)
6.11.2.1
Terminology Bindings
Path | Definition | Type | Reference |
---|---|---|---|
MessageHeader.event | One of the message events defined as part of FHIR | Incomplete | http://hl7.org/fhir/valueset/message-events |
MessageHeader.response.code | The kind of response to a message | Fixed | http://hl7.org/fhir/response-code |
MessageHeader.reason | Reason for event occurrence | Example | http://hl7.org/fhir/vs/message-reason-encounter |
6.11.3
Notes:
- The resources referenced by the enterer, author and responsible elements may all be included in the message bundle or left out on the basis that the recipient (and any intermediaries) are able to locate/resolve the resources
independently. The former would be suitable for loosely coupled systems, and the latter for tightly coupled systems. The messaging conformance statement for an application may reference a profile that describes how the bundling occurs - The actual content of the data resource is specified for each message event (see the list on the messaging page). Any resources referenced in the data element are always included in the bundle
- If MessageHeader.source.endpoint and MessageHeader.destination.endpoint, are literal URLs, then they SHOULD identify
the addresses to which messages can be be delivered. If they are logical URIs (i.e. non-dereferenceable), message delivery intermediaries must know how to deliver the message to the destination application.* The author and the receiver are not the actual technical systems - these are the human or organizations that make use of the technical systems - A receiver is not obligated to reject messages which do not explicitly identify it as receiver (e.g. a tracker will get messages that are destined for some other system)
6.11.4 Search Parameters
Search parameters for this resource. The standard parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths |
_id | token | The logical resource id associated with the resource (must be supported by all servers) | |
_language | token | The stated language of the resource |
</div> <!-- /inner-wrapper -->
</div> <!-- /row -->
</div> <!-- /container -->
</div> <!-- /segment-content -->
<div id="segment-footer" class="segment"> <!-- segment-footer -->
<div class="container"> <!-- container -->
<div class="inner-wrapper">
© HL7.org 2011 - 2014. FHIR DSTU (v0.2.1-2606) generated on Wed, Jul 2, 2014 16:28+0800. <!-- [QA Report](qa.html) --> <!-- achive note -->
<span style="color: #FFFF77">
Links: [What's a DSTU?](dstu.html) |
[Version History](history.html) |
[Compare to DSTU](http://services.w3.org/htmldiff?doc1=http%3A%2F%2Fhl7.org%2Fimplement%2Fstandards%2Ffhir%2Fmessageheader.html&doc2=http%3A%2F%2Fhl7.org%2Fimplement%2Fstandards%2FFHIR-Develop%2Fmessageheader.html) |
[License](license.html) |
[Propose a change](http://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemAdd&tracker_id=677)
</span>