MessageHeader - FHIR v0.0.82

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.6 Resource MessageHeader - Formal Definitions

Formal definitions for the elements in the MessageHeader resource.

MessageHeader
Definition	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.
Control	1..1
Requirements	Many implementations are not prepared to use REST and need a messaging based infrastructure.
MessageHeader.identifier
Definition	The identifier of this message.
Control	1..1
Type	id
Comments	This SHALL be unique within the scope of this stream of messages.
MessageHeader.timestamp
Definition	The time that the message was sent.
Control	1..1
Type	instant
Requirements	Allows limited detection of out-of-order and delayed transmission. Also supports audit.
MessageHeader.event
Definition	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".
Control	1..1
Binding	MessageEvent: the Event List in the messaging framework
Type	Coding
Is Modifier	true
Requirements	Drives the behavior associated with this message.
MessageHeader.response
Definition	Information about the message that this message is a response to. Only present if this message is a response.
Control	0..1
Is Modifier	true
MessageHeader.response.identifier
Definition	The id of the message that this message is a response to.
Control	1..1
Type	id
Requirements	Allows receiver to know what message is being responded to.
MessageHeader.response.code
Definition	Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.
Control	1..1
Binding	ResponseType: The kind of response to a message (see http://hl7.org/fhir/response-code for values)
Type	code
Is Modifier	true
Requirements	Allows the sender of the acknowledge message to know if the request was successful or if action is needed.
Comments	This is a generic response to the request message. Specific data for the response will be found in MessageHeader.data.
MessageHeader.response.details
Definition	Full details of any issues found in the message.
Control	0..1
Type	Resource(OperationOutcome)
Requirements	Allows the sender of the message to determine what the specific issues are.
Comments	This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.
MessageHeader.source
Definition	The source application from which this message originated.
Control	1..1
Requirements	Allows replies, supports audit.
MessageHeader.source.name
Definition	Human-readable name for the target system.
Control	0..1
Type	string
Requirements	May be used to support audit.
MessageHeader.source.software
Definition	May include configuration or other information useful in debugging.
Control	1..1
Type	string
Requirements	Supports audit and possibly interface engine behavior.
MessageHeader.source.version
Definition	Can convey versions of multiple systems in situations where a message passes through multiple hands.
Control	0..1
Type	string
Requirements	Supports audit and possibly interface engine behavior.
MessageHeader.source.contact
Definition	An e-mail, phone, website or other contact point to use to resolve issues with message communications.
Control	0..1
Type	Contact
Requirements	Allows escalation of technical issues.
MessageHeader.source.endpoint
Definition	Identifies the routing target to send acknowledgements to.
Control	1..1
Type	uri
Requirements	Identifies where to send responses, may influence security permissions.
Comments	The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
MessageHeader.destination
Definition	The destination application which the message is intended for.
Control	0..*
Requirements	Indicates where message is to be sent to for routing purposes. Allows verification of "am I the intended recipient".
Comments	there SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.
MessageHeader.destination.name
Definition	Human-readable name for the source system.
Control	0..1
Type	string
Requirements	May be used for routing of response and/or to support audit.
MessageHeader.destination.target
Definition	Identifies the target end system in situations where the initial message transmission is to an intermediary system.
Control	0..1
Type	Resource(Device)
Requirements	Supports multi-hop routing.
MessageHeader.destination.endpoint
Definition	Indicates where the message should be routed to.
Control	1..1
Type	uri
Requirements	Identifies where to route the message.
Comments	The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
MessageHeader.enterer
Definition	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.
Control	0..1
Type	Resource(Practitioner)
Requirements	Need to know for audit/traceback requirements and possibly for authorization.
Comments	Usually only for the request, but can be used in a response.
MessageHeader.author
Definition	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.
Control	0..1
Type	Resource(Practitioner)
Requirements	Need to know for audit/traceback requirements and possibly for authorization.
Comments	Usually only for the request, but can be used in a response.
MessageHeader.receiver
Definition	Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
Control	0..1
Type	Resource(Practitioner \| Organization)
Requirements	Allows routing beyond just the application level.
MessageHeader.responsible
Definition	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.
Control	0..1
Type	Resource(Practitioner \| Organization)
Requirements	Need to know for audit/traceback requirements and possibly for authorization.
Comments	Usually only for the request, but can be used in a response.
MessageHeader.reason
Definition	Coded indication of the cause for the event - indicates a reason for the occurance of the event that is a focus of this message.
Control	0..1
Binding	EventReason: (See http://hl7.org/fhir/vs/message-reason-encounter)
Type	CodeableConcept
Requirements	Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.
MessageHeader.data
Definition	The actual data of the message - a reference to the root/focus class of the event.
Control	0..*
Type	Resource(Any)
Requirements	Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources.
Comments	The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.