Path | Short | Definition | Comments |
---|
| A resource that describes a message that is exchanged between systems | 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. | |
event[x] | Code for the event this message represents or link to event 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. | The time of the event will be found in the focus resource. The time of the message will be found in [Bundle.timestamp](bundle-definitions.html#Bundle.timestamp). |
destination | Message destination application(s) | The destination application which the message is intended for. | There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system. |
destination.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
destination.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
destination.modifierExtension | Extensions that cannot be ignored even if unrecognized | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
destination.name | Name of system | Human-readable name for the target system. | |
destination.target | Particular delivery destination within the destination | Identifies the target end system in situations where the initial message transmission is to an intermediary system. | |
destination.endpoint | Actual destination address or id | Indicates where the message should be routed to. | The id may be a non-resolvable URI for systems that do not use standard network-based addresses. |
destination.receiver | Intended "real-world" recipient for the data | Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient. | |
sender | Real world sender of the message | Identifies the sending system to allow the use of a trust relationship. | Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone. |
enterer | The source of the data entry | 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. | Usually only for the request but can be used in a response. |
author | The source of the decision | 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. | Usually only for the request but can be used in a response. |
source | Message source application | The source application from which this message originated. | |
source.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
source.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
source.modifierExtension | Extensions that cannot be ignored even if unrecognized | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
source.name | Name of system | Human-readable name for the source system. | |
source.software | Name of software running the system | May include configuration or other information useful in debugging. | |
source.version | Version of software running | Can convey versions of multiple systems in situations where a message passes through multiple hands. | |
source.contact | Human contact for problems | An e-mail, phone, website or other contact point to use to resolve issues with message communications. | |
source.endpoint | Actual message source address or id | Identifies the routing target to send acknowledgements to. | The id may be a non-resolvable URI for systems that do not use standard network-based addresses. |
responsible | Final responsibility for event | 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. | Usually only for the request but can be used in a response. |
reason | Cause of event | Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message. | |
response | If this is a reply to prior message | Information about the message that this message is a response to. Only present if this message is a response. | |
response.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
response.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
response.modifierExtension | Extensions that cannot be ignored even if unrecognized | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
response.identifier | Id of original message | The MessageHeader.id of the message to which this message is a response. | |
response.code | ok | transient-error | fatal-error | 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 is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus. |
response.details | Specific list of hints/warnings/errors | Full details of any issues found in the message. | This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error. |
focus | The actual content of the message | The actual data of the message - a reference to the root/focus class of the event. | 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. |
definition | Link to the definition for this message | Permanent link to the MessageDefinition for this message. | |