Resource type: messageheader

Description

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.

Elements

PathShortDefinitionComments
A resource that describes a message that is exchanged between systemsThe 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 definitionCode 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).
destinationMessage 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.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
destination.extensionAdditional content defined by implementationsMay 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.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay 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.nameName of systemHuman-readable name for the target system.
destination.targetParticular delivery destination within the destinationIdentifies the target end system in situations where the initial message transmission is to an intermediary system.
destination.endpointActual destination address or idIndicates 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.receiverIntended "real-world" recipient for the dataAllows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
senderReal world sender of the messageIdentifies 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.
entererThe source of the data entryThe 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.
authorThe source of the decisionThe 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.
sourceMessage source applicationThe source application from which this message originated.
source.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
source.extensionAdditional content defined by implementationsMay 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.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay 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.nameName of systemHuman-readable name for the source system.
source.softwareName of software running the systemMay include configuration or other information useful in debugging.
source.versionVersion of software runningCan convey versions of multiple systems in situations where a message passes through multiple hands.
source.contactHuman contact for problemsAn e-mail, phone, website or other contact point to use to resolve issues with message communications.
source.endpointActual message source address or idIdentifies 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.
responsibleFinal responsibility for eventThe 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.
reasonCause of eventCoded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
responseIf this is a reply to prior messageInformation about the message that this message is a response to. Only present if this message is a response.
response.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
response.extensionAdditional content defined by implementationsMay 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.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay 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.identifierId of original messageThe MessageHeader.id of the message to which this message is a response.
response.codeok | transient-error | fatal-errorCode 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.detailsSpecific list of hints/warnings/errorsFull 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.
focusThe actual content of the messageThe 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.
definitionLink to the definition for this messagePermanent link to the MessageDefinition for this message.

Scope and Usage

The MessageHeader resource is defined in order to support Messaging using FHIR resources. The principal 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]/MessageHeader), 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.

Notes:

Search Parameters

authorThe source of the decisionMessageHeader.author
codeok | transient-error | fatal-errorMessageHeader.response.code
destinationName of systemMessageHeader.destination.name
destination-uriActual destination address or idMessageHeader.destination.endpoint
entererThe source of the data entryMessageHeader.enterer
eventCode for the event this message represents or link to event definitionMessageHeader.event
focusThe actual content of the messageMessageHeader.focus
receiverIntended "real-world" recipient for the dataMessageHeader.destination.receiver
response-idId of original messageMessageHeader.response.identifier
responsibleFinal responsibility for eventMessageHeader.responsible
senderReal world sender of the messageMessageHeader.sender
sourceName of systemMessageHeader.source.name
source-uriActual message source address or idMessageHeader.source.endpoint
targetParticular delivery destination within the destinationMessageHeader.destination.target

Extension Definitions

These are extension definitions for this resource defined by the spec