This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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

6.9 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.9.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.9.2 Resource Content

MessageHeader ( Resource ) The identifier of this message identifier : id 1..1 The time that the message was sent timestamp : instant 1..1 Code that identifies the event this message represents and connects it with it's definition. Events defined as part of the FHIR specification have the system value "http://hl7.org/fhir/message-type" (this element modifies the meaning of other elements) event : Coding 1..1 << One of the message events defined as part of FHIR MessageEvent >> The person or device that performed the data entry leading to this message. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions enterer : Resource ( Practitioner ) 0..1 The logical author of the message - the person or device that decided the described event should happen. Where there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions author : Resource ( Practitioner ) 0..1 Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient receiver : Resource ( Practitioner | Organization ) 0..1 The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party responsible : Resource ( Practitioner | Organization ) 0..1 Coded indication of the cause for the event - indicates a reason for the occurance of the event that is a focus of this message reason : CodeableConcept 0..1 << Reason for event occurrence EventReason >> The actual data of the message - a reference to the root/focus class of the event data : Resource ( Any ) 0..* Response The id of the message that this message is a response to identifier : id 1..1 Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not (this element modifies the meaning of other elements) code : code 1..1 << The kind of response to a message ResponseType >> Full details of any issues found in the message details : Resource ( OperationOutcome ) 0..1 MessageSource Human-readable name for the target system name : string 0..1 May include configuration or other information useful in debugging software : string 1..1 Can convey versions of multiple systems in situations where a message passes through multiple hands version : string 0..1 An e-mail, phone, website or other contact point to use to resolve issues with message communications contact : Contact 0..1 Identifies the routing target to send acknowledgements to endpoint : uri 1..1 MessageDestination Human-readable name for the source system name : string 0..1 Identifies the target end system in situations where the initial message transmission is to an intermediary system target : Resource ( Device ) 0..1 Indicates where the message should be routed to endpoint : uri 1..1 Information about the message that this message is a response to. Only present if this message is a response (this element modifies the meaning of other elements) response 0..1 The source application from which this message originated source 1..1 The destination application which the message is intended for destination 0..*
<MessageHeader xmlns="http://hl7.org/fhir"> doco
 <!-- 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

6.9.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/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.9.3 Notes:

6.9.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 language of the resource

comments powered by Disqus