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 Content Examples Formal Definitions Mappings Profiles 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..* < <!-- from --> < < <</event> < < < <</details> </response> < < < < <</contact> < </source> < < <</target> < </destination> <</enterer> <</author> < Intended "real-world" recipient for the data</receiver> < Final responsibility for event</responsible> <</reason> <</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: 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.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 © HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:09+1000. Links: What's a DSTU? | Version History | | Propose a change var disqus_shortname = 'fhirdstu';(function() {var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq); })(); Please enable JavaScript to view the comments powered by Disqus. comments powered by Disqus var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-676355-1']); _gaq.push(['_setDomainName', '.hl7.org']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })();