This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). 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
Infrastructure And Messaging Work Group | Maturity Level: 4 | Trial Use | Security Category: Not Classified | Compartments: Device, Practitioner |
Detailed Descriptions for the elements in the MessageHeader resource.
MessageHeader | |
Element Id | MessageHeader |
Definition | The header for a message exchange that is either requesting or responding to an action. The reference(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. |
Cardinality | 0..* |
Type | DomainResource |
Requirements | Many implementations are not prepared to use REST and need a messaging based infrastructure. |
Summary | true |
MessageHeader.event[x] | |
Element Id | MessageHeader.event[x] |
Definition | Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition. |
Cardinality | 1..1 |
Terminology Binding | the Event List in the messaging framework |
Type | Coding|uri |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Drives the behavior associated with this message. |
Summary | true |
Comments | The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp. |
MessageHeader.destination | |
Element Id | MessageHeader.destination |
Definition | The destination application which the message is intended for. |
Cardinality | 0..* |
Requirements | Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient". |
Summary | true |
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 | |
Element Id | MessageHeader.destination.name |
Definition | Human-readable name for the target system. |
Cardinality | 0..1 |
Type | string |
Requirements | May be used for routing of response and/or to support audit. |
Summary | true |
MessageHeader.destination.target | |
Element Id | MessageHeader.destination.target |
Definition | Identifies the target end system in situations where the initial message transmission is to an intermediary system. |
Cardinality | 0..1 |
Type | Reference(Device) |
Requirements | Supports multi-hop routing. |
Summary | true |
MessageHeader.destination.endpoint | |
Element Id | MessageHeader.destination.endpoint |
Definition | Indicates where the message should be routed to. |
Cardinality | 1..1 |
Type | url |
Requirements | Identifies where to route the message. |
Summary | true |
Comments | The id may be a non-resolvable URI for systems that do not use standard network-based addresses. |
MessageHeader.destination.receiver | |
Element Id | MessageHeader.destination.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. |
Cardinality | 0..1 |
Type | Reference(Practitioner | PractitionerRole | Organization) |
Patterns | Reference(Practitioner,PractitionerRole,Organization): Common patterns = Participant |
Requirements | Allows routing beyond just the application level. |
Summary | true |
MessageHeader.sender | |
Element Id | MessageHeader.sender |
Definition | Identifies the sending system to allow the use of a trust relationship. |
Cardinality | 0..1 |
Type | Reference(Practitioner | PractitionerRole | Organization) |
Patterns | Reference(Practitioner,PractitionerRole,Organization): Common patterns = Participant |
Requirements | Allows routing beyond just the application level. |
Summary | true |
Comments | Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone. |
MessageHeader.enterer | |
Element Id | MessageHeader.enterer |
Definition | The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions. |
Cardinality | 0..1 |
Type | Reference(Practitioner | PractitionerRole) |
Patterns | Reference(Practitioner,PractitionerRole): Common patterns = Participant |
Requirements | Need to know for audit/traceback requirements and possibly for authorization. |
Summary | true |
Comments | Usually only for the request but can be used in a response. |
MessageHeader.author | |
Element Id | MessageHeader.author |
Definition | The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions. |
Cardinality | 0..1 |
Type | Reference(Practitioner | PractitionerRole) |
Patterns | Reference(Practitioner,PractitionerRole): Common patterns = Participant |
Requirements | Need to know for audit/traceback requirements and possibly for authorization. |
Summary | true |
Comments | Usually only for the request but can be used in a response. |
MessageHeader.source | |
Element Id | MessageHeader.source |
Definition | The source application from which this message originated. |
Cardinality | 1..1 |
Requirements | Allows replies, supports audit. |
Summary | true |
MessageHeader.source.name | |
Element Id | MessageHeader.source.name |
Definition | Human-readable name for the source system. |
Cardinality | 0..1 |
Type | string |
Requirements | May be used to support audit. |
Summary | true |
MessageHeader.source.software | |
Element Id | MessageHeader.source.software |
Definition | May include configuration or other information useful in debugging. |
Cardinality | 0..1 |
Type | string |
Requirements | Supports audit and possibly interface engine behavior. |
Summary | true |
MessageHeader.source.version | |
Element Id | MessageHeader.source.version |
Definition | Can convey versions of multiple systems in situations where a message passes through multiple hands. |
Note | This is a business versionId, not a resource version id (see discussion) |
Cardinality | 0..1 |
Type | string |
Requirements | Supports audit and possibly interface engine behavior. |
Summary | true |
MessageHeader.source.contact | |
Element Id | MessageHeader.source.contact |
Definition | An e-mail, phone, website or other contact point to use to resolve issues with message communications. |
Cardinality | 0..1 |
Type | ContactPoint |
Requirements | Allows escalation of technical issues. |
Summary | true |
MessageHeader.source.endpoint | |
Element Id | MessageHeader.source.endpoint |
Definition | Identifies the routing target to send acknowledgements to. |
Cardinality | 1..1 |
Type | url |
Requirements | Identifies where to send responses, may influence security permissions. |
Summary | true |
Comments | The id may be a non-resolvable URI for systems that do not use standard network-based addresses. |
MessageHeader.responsible | |
Element Id | 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. |
Cardinality | 0..1 |
Type | Reference(Practitioner | PractitionerRole | Organization) |
Patterns | Reference(Practitioner,PractitionerRole,Organization): Common patterns = Participant |
Requirements | Need to know for audit/traceback requirements and possibly for authorization. |
Summary | true |
Comments | Usually only for the request but can be used in a response. |
MessageHeader.reason | |
Element Id | MessageHeader.reason |
Definition | Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message. |
Cardinality | 0..1 |
Terminology Binding | Example Message Reason Codes (Example) |
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. |
Summary | true |
MessageHeader.response | |
Element Id | MessageHeader.response |
Definition | Information about the message that this message is a response to. Only present if this message is a response. |
Cardinality | 0..1 |
Summary | true |
MessageHeader.response.identifier | |
Element Id | MessageHeader.response.identifier |
Definition | The MessageHeader.id of the message to which this message is a response. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 1..1 |
Type | id |
Requirements | Allows receiver to know what message is being responded to. |
Summary | true |
MessageHeader.response.code | |
Element Id | 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. |
Cardinality | 1..1 |
Terminology Binding | ResponseType (Required) |
Type | code |
Requirements | Allows the sender of the acknowledge message to know if the request was successful or if action is needed. |
Summary | true |
Comments | This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus. |
MessageHeader.response.details | |
Element Id | MessageHeader.response.details |
Definition | Full details of any issues found in the message. |
Cardinality | 0..1 |
Type | Reference(OperationOutcome) |
Requirements | Allows the sender of the message to determine what the specific issues are. |
Summary | true |
Comments | This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error. |
MessageHeader.focus | |
Element Id | MessageHeader.focus |
Definition | The actual data of the message - a reference to the root/focus class of the event. |
Cardinality | 0..* |
Type | Reference(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. |
Summary | true |
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. |
MessageHeader.definition | |
Element Id | MessageHeader.definition |
Definition | Permanent link to the MessageDefinition for this message. |
Cardinality | 0..1 |
Type | canonical(MessageDefinition) |
Requirements | Allows sender to define the expected contents of the message. |
Summary | true |