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

2.50 Resource MessageHeader - Content

Infrastructure And Messaging

Work Group

Maturity Level: 4

Trial Use

Security Category: Not Classified

Compartments: Device, Practitioner

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.

2.50.1 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.

2.50.2 References

No resources refer to this resource directly.

This resource does not implement any patterns.

Structure

Name	Flags	Card.	Type	Description & Constraints
MessageHeader	Σ TU		DomainResource	A resource that describes a message that is exchanged between systems Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
event[x]	Σ	1..1		Code for the event this message represents or link to event definition MessageEvent (Example)
eventCoding			Coding
eventUri			uri
destination	Σ	0..*	BackboneElement	Message destination application(s)
name	Σ	0..1	string	Name of system
target	Σ	0..1	Reference(Device)	Particular delivery destination within the destination
endpoint	Σ	1..1	url	Actual destination address or id
receiver	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Intended "real-world" recipient for the data
sender	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Real world sender of the message
enterer	Σ	0..1	Reference(Practitioner \| PractitionerRole)	The source of the data entry
author	Σ	0..1	Reference(Practitioner \| PractitionerRole)	The source of the decision
source	Σ	1..1	BackboneElement	Message source application
name	Σ	0..1	string	Name of system
software	Σ	0..1	string	Name of software running the system
version	Σ	0..1	string	Version of software running
contact	Σ	0..1	ContactPoint	Human contact for problems
endpoint	Σ	1..1	url	Actual message source address or id
responsible	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Final responsibility for event
reason	Σ	0..1	CodeableConcept	Cause of event Example Message Reason Codes (Example)
response	Σ	0..1	BackboneElement	If this is a reply to prior message
identifier	Σ	1..1	id	Id of original message
code	Σ	1..1	code	ok \| transient-error \| fatal-error ResponseType (Required)
details	Σ	0..1	Reference(OperationOutcome)	Specific list of hints/warnings/errors
focus	Σ	0..*	Reference(Any)	The actual content of the message
definition	Σ	0..1	canonical(MessageDefinition)	Link to the definition for this message
Documentation for this format

UML Diagram (Legend)

XML Template

<MessageHeader xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <event[x]><!-- 1..1 Coding|uri Code for the event this message represents or link to event definition --></event[x]>
 <destination>  <!-- 0..* Message destination application(s) -->
  <name value="[string]"/><!-- 0..1 Name of system -->
  <target><!-- 0..1 Reference(Device) Particular delivery destination within the destination --></target>
  <endpoint value="[url]"/><!-- 1..1 Actual destination address or id -->
  <receiver><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Intended "real-world" recipient for the data --></receiver>
 </destination>
 <sender><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Real world sender of the message --></sender>
 <enterer><!-- 0..1 Reference(Practitioner|PractitionerRole) The source of the data entry --></enterer>
 <author><!-- 0..1 Reference(Practitioner|PractitionerRole) The source of the decision --></author>
 <source>  <!-- 1..1 Message source application -->
  <name value="[string]"/><!-- 0..1 Name of system -->
  <software value="[string]"/><!-- 0..1 Name of software running the system -->
  <version value="[string]"/><!-- 0..1 Version of software running -->
  <contact><!-- 0..1 ContactPoint Human contact for problems --></contact>
  <endpoint value="[url]"/><!-- 1..1 Actual message source address or id -->
 </source>
 <responsible><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Final responsibility for event --></responsible>
 <reason><!-- 0..1 CodeableConcept Cause of event --></reason>
 <response>  <!-- 0..1 If this is a reply to prior message -->
  <identifier value="[id]"/><!-- 1..1 Id of original message -->
  <code value="[code]"/><!-- 1..1 ok | transient-error | fatal-error -->
  <details><!-- 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors --></details>
 </response>
 <focus><!-- 0..* Reference(Any) The actual content of the message --></focus>
 <definition><!-- 0..1 canonical(MessageDefinition) Link to the definition for this message --></definition>
</MessageHeader>

JSON Template

{
  "resourceType" : "MessageHeader",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  // event[x]: Code for the event this message represents or link to event definition. One of these 2:
  "eventCoding" : { Coding },
  "eventUri" : "<uri>",
  "destination" : [{ // Message destination application(s)
    "name" : "<string>", // Name of system
    "target" : { Reference(Device) }, // Particular delivery destination within the destination
    "endpoint" : "<url>", // R!  Actual destination address or id
    "receiver" : { Reference(Organization|Practitioner|PractitionerRole) } // Intended "real-world" recipient for the data
  }],
  "sender" : { Reference(Organization|Practitioner|PractitionerRole) }, // Real world sender of the message
  "enterer" : { Reference(Practitioner|PractitionerRole) }, // The source of the data entry
  "author" : { Reference(Practitioner|PractitionerRole) }, // The source of the decision
  "source" : { // R!  Message source application
    "name" : "<string>", // Name of system
    "software" : "<string>", // Name of software running the system
    "version" : "<string>", // Version of software running
    "contact" : { ContactPoint }, // Human contact for problems
    "endpoint" : "<url>" // R!  Actual message source address or id
  },
  "responsible" : { Reference(Organization|Practitioner|PractitionerRole) }, // Final responsibility for event
  "reason" : { CodeableConcept }, // Cause of event
  "response" : { // If this is a reply to prior message
    "identifier" : "<id>", // R!  Id of original message
    "code" : "<code>", // R!  ok | transient-error | fatal-error
    "details" : { Reference(OperationOutcome) } // Specific list of hints/warnings/errors
  },
  "focus" : [{ Reference(Any) }], // The actual content of the message
  "definition" : { canonical(MessageDefinition) } // Link to the definition for this message
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:MessageHeader;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  # MessageHeader.event[x] : 1..1 Code for the event this message represents or link to event definition. One of these 2
    fhir:MessageHeader.eventCoding [ Coding ]
    fhir:MessageHeader.eventUri [ uri ]
  fhir:MessageHeader.destination [ # 0..* Message destination application(s)
    fhir:MessageHeader.destination.name [ string ]; # 0..1 Name of system
    fhir:MessageHeader.destination.target [ Reference(Device) ]; # 0..1 Particular delivery destination within the destination
    fhir:MessageHeader.destination.endpoint [ url ]; # 1..1 Actual destination address or id
    fhir:MessageHeader.destination.receiver [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 Intended "real-world" recipient for the data
  ], ...;
  fhir:MessageHeader.sender [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 Real world sender of the message
  fhir:MessageHeader.enterer [ Reference(Practitioner|PractitionerRole) ]; # 0..1 The source of the data entry
  fhir:MessageHeader.author [ Reference(Practitioner|PractitionerRole) ]; # 0..1 The source of the decision
  fhir:MessageHeader.source [ # 1..1 Message source application
    fhir:MessageHeader.source.name [ string ]; # 0..1 Name of system
    fhir:MessageHeader.source.software [ string ]; # 0..1 Name of software running the system
    fhir:MessageHeader.source.version [ string ]; # 0..1 Version of software running
    fhir:MessageHeader.source.contact [ ContactPoint ]; # 0..1 Human contact for problems
    fhir:MessageHeader.source.endpoint [ url ]; # 1..1 Actual message source address or id
  ];
  fhir:MessageHeader.responsible [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 Final responsibility for event
  fhir:MessageHeader.reason [ CodeableConcept ]; # 0..1 Cause of event
  fhir:MessageHeader.response [ # 0..1 If this is a reply to prior message
    fhir:MessageHeader.response.identifier [ id ]; # 1..1 Id of original message
    fhir:MessageHeader.response.code [ code ]; # 1..1 ok | transient-error | fatal-error
    fhir:MessageHeader.response.details [ Reference(OperationOutcome) ]; # 0..1 Specific list of hints/warnings/errors
  ];
  fhir:MessageHeader.focus [ Reference(Any) ], ... ; # 0..* The actual content of the message
  fhir:MessageHeader.definition [ canonical(MessageDefinition) ]; # 0..1 Link to the definition for this message
]

Changes since R3

MessageHeader

MessageHeader.response.code

Change value set from http://hl7.org/fhir/ValueSet/response-code|4.0.0 to http://hl7.org/fhir/ValueSet/response-code|4.4.0

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors).)

Structure

Name	Flags	Card.	Type	Description & Constraints
MessageHeader	Σ TU		DomainResource	A resource that describes a message that is exchanged between systems Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
event[x]	Σ	1..1		Code for the event this message represents or link to event definition MessageEvent (Example)
eventCoding			Coding
eventUri			uri
destination	Σ	0..*	BackboneElement	Message destination application(s)
name	Σ	0..1	string	Name of system
target	Σ	0..1	Reference(Device)	Particular delivery destination within the destination
endpoint	Σ	1..1	url	Actual destination address or id
receiver	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Intended "real-world" recipient for the data
sender	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Real world sender of the message
enterer	Σ	0..1	Reference(Practitioner \| PractitionerRole)	The source of the data entry
author	Σ	0..1	Reference(Practitioner \| PractitionerRole)	The source of the decision
source	Σ	1..1	BackboneElement	Message source application
name	Σ	0..1	string	Name of system
software	Σ	0..1	string	Name of software running the system
version	Σ	0..1	string	Version of software running
contact	Σ	0..1	ContactPoint	Human contact for problems
endpoint	Σ	1..1	url	Actual message source address or id
responsible	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Final responsibility for event
reason	Σ	0..1	CodeableConcept	Cause of event Example Message Reason Codes (Example)
response	Σ	0..1	BackboneElement	If this is a reply to prior message
identifier	Σ	1..1	id	Id of original message
code	Σ	1..1	code	ok \| transient-error \| fatal-error ResponseType (Required)
details	Σ	0..1	Reference(OperationOutcome)	Specific list of hints/warnings/errors
focus	Σ	0..*	Reference(Any)	The actual content of the message
definition	Σ	0..1	canonical(MessageDefinition)	Link to the definition for this message
Documentation for this format

UML Diagram (Legend)

XML Template

<MessageHeader xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <event[x]><!-- 1..1 Coding|uri Code for the event this message represents or link to event definition --></event[x]>
 <destination>  <!-- 0..* Message destination application(s) -->
  <name value="[string]"/><!-- 0..1 Name of system -->
  <target><!-- 0..1 Reference(Device) Particular delivery destination within the destination --></target>
  <endpoint value="[url]"/><!-- 1..1 Actual destination address or id -->
  <receiver><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Intended "real-world" recipient for the data --></receiver>
 </destination>
 <sender><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Real world sender of the message --></sender>
 <enterer><!-- 0..1 Reference(Practitioner|PractitionerRole) The source of the data entry --></enterer>
 <author><!-- 0..1 Reference(Practitioner|PractitionerRole) The source of the decision --></author>
 <source>  <!-- 1..1 Message source application -->
  <name value="[string]"/><!-- 0..1 Name of system -->
  <software value="[string]"/><!-- 0..1 Name of software running the system -->
  <version value="[string]"/><!-- 0..1 Version of software running -->
  <contact><!-- 0..1 ContactPoint Human contact for problems --></contact>
  <endpoint value="[url]"/><!-- 1..1 Actual message source address or id -->
 </source>
 <responsible><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Final responsibility for event --></responsible>
 <reason><!-- 0..1 CodeableConcept Cause of event --></reason>
 <response>  <!-- 0..1 If this is a reply to prior message -->
  <identifier value="[id]"/><!-- 1..1 Id of original message -->
  <code value="[code]"/><!-- 1..1 ok | transient-error | fatal-error -->
  <details><!-- 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors --></details>
 </response>
 <focus><!-- 0..* Reference(Any) The actual content of the message --></focus>
 <definition><!-- 0..1 canonical(MessageDefinition) Link to the definition for this message --></definition>
</MessageHeader>

JSON Template

{
  "resourceType" : "MessageHeader",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  // event[x]: Code for the event this message represents or link to event definition. One of these 2:
  "eventCoding" : { Coding },
  "eventUri" : "<uri>",
  "destination" : [{ // Message destination application(s)
    "name" : "<string>", // Name of system
    "target" : { Reference(Device) }, // Particular delivery destination within the destination
    "endpoint" : "<url>", // R!  Actual destination address or id
    "receiver" : { Reference(Organization|Practitioner|PractitionerRole) } // Intended "real-world" recipient for the data
  }],
  "sender" : { Reference(Organization|Practitioner|PractitionerRole) }, // Real world sender of the message
  "enterer" : { Reference(Practitioner|PractitionerRole) }, // The source of the data entry
  "author" : { Reference(Practitioner|PractitionerRole) }, // The source of the decision
  "source" : { // R!  Message source application
    "name" : "<string>", // Name of system
    "software" : "<string>", // Name of software running the system
    "version" : "<string>", // Version of software running
    "contact" : { ContactPoint }, // Human contact for problems
    "endpoint" : "<url>" // R!  Actual message source address or id
  },
  "responsible" : { Reference(Organization|Practitioner|PractitionerRole) }, // Final responsibility for event
  "reason" : { CodeableConcept }, // Cause of event
  "response" : { // If this is a reply to prior message
    "identifier" : "<id>", // R!  Id of original message
    "code" : "<code>", // R!  ok | transient-error | fatal-error
    "details" : { Reference(OperationOutcome) } // Specific list of hints/warnings/errors
  },
  "focus" : [{ Reference(Any) }], // The actual content of the message
  "definition" : { canonical(MessageDefinition) } // Link to the definition for this message
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:MessageHeader;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  # MessageHeader.event[x] : 1..1 Code for the event this message represents or link to event definition. One of these 2
    fhir:MessageHeader.eventCoding [ Coding ]
    fhir:MessageHeader.eventUri [ uri ]
  fhir:MessageHeader.destination [ # 0..* Message destination application(s)
    fhir:MessageHeader.destination.name [ string ]; # 0..1 Name of system
    fhir:MessageHeader.destination.target [ Reference(Device) ]; # 0..1 Particular delivery destination within the destination
    fhir:MessageHeader.destination.endpoint [ url ]; # 1..1 Actual destination address or id
    fhir:MessageHeader.destination.receiver [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 Intended "real-world" recipient for the data
  ], ...;
  fhir:MessageHeader.sender [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 Real world sender of the message
  fhir:MessageHeader.enterer [ Reference(Practitioner|PractitionerRole) ]; # 0..1 The source of the data entry
  fhir:MessageHeader.author [ Reference(Practitioner|PractitionerRole) ]; # 0..1 The source of the decision
  fhir:MessageHeader.source [ # 1..1 Message source application
    fhir:MessageHeader.source.name [ string ]; # 0..1 Name of system
    fhir:MessageHeader.source.software [ string ]; # 0..1 Name of software running the system
    fhir:MessageHeader.source.version [ string ]; # 0..1 Version of software running
    fhir:MessageHeader.source.contact [ ContactPoint ]; # 0..1 Human contact for problems
    fhir:MessageHeader.source.endpoint [ url ]; # 1..1 Actual message source address or id
  ];
  fhir:MessageHeader.responsible [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 Final responsibility for event
  fhir:MessageHeader.reason [ CodeableConcept ]; # 0..1 Cause of event
  fhir:MessageHeader.response [ # 0..1 If this is a reply to prior message
    fhir:MessageHeader.response.identifier [ id ]; # 1..1 Id of original message
    fhir:MessageHeader.response.code [ code ]; # 1..1 ok | transient-error | fatal-error
    fhir:MessageHeader.response.details [ Reference(OperationOutcome) ]; # 0..1 Specific list of hints/warnings/errors
  ];
  fhir:MessageHeader.focus [ Reference(Any) ], ... ; # 0..* The actual content of the message
  fhir:MessageHeader.definition [ canonical(MessageDefinition) ]; # 0..1 Link to the definition for this message
]

Changes since Release 3

MessageHeader

MessageHeader.response.code

Change value set from http://hl7.org/fhir/ValueSet/response-code|4.0.0 to http://hl7.org/fhir/ValueSet/response-code|4.4.0

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 1 test that all execute ok. All tests pass round-trip testing and 1 r3 resources are invalid (0 errors).)

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a

2.50.3.1 Terminology Bindings

Path	Definition	Type	Reference
MessageHeader.event[x]	One of the message events defined as part of this version of FHIR.	Example	Message Events
MessageHeader.reason	Reason for event occurrence.	Example	ExampleMessageReasonCodes
MessageHeader.response.code	The kind of response to a message.	Required	ResponseType

Path

Definition

Type

Reference

MessageHeader.event[x]

One of the message events defined as part of this version of FHIR.

Example

Message Events

MessageHeader.reason

Reason for event occurrence.

Example

ExampleMessageReasonCodes

MessageHeader.response.code

The kind of response to a message.

Required

ResponseType

2.50.4 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 Capability statement for an application may reference a Structure Definition that describes how the bundling occurs
The actual content of the focus resource is specified for each message event (see the list on the messaging page). Any resources referenced in the focus 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 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 time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp
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)
The value set MessageEvent is populated by the authors of the resources declaring the events

2.50.5 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name	Type	Description	Expression	In Common
author	reference	The source of the decision	MessageHeader.author (Practitioner, PractitionerRole)
code N	token	ok \| transient-error \| fatal-error	MessageHeader.response.code
destination N	string	Name of system	MessageHeader.destination.name
destination-uri N	uri	Actual destination address or id	MessageHeader.destination.endpoint
enterer	reference	The source of the data entry	MessageHeader.enterer (Practitioner, PractitionerRole)
event	token	Code for the event this message represents or link to event definition	MessageHeader.event
focus	reference	The actual content of the message	MessageHeader.focus (Any)
receiver	reference	Intended "real-world" recipient for the data	MessageHeader.destination.receiver (Practitioner, Organization, PractitionerRole)
response-id N	token	Id of original message	MessageHeader.response.identifier
responsible	reference	Final responsibility for event	MessageHeader.responsible (Practitioner, Organization, PractitionerRole)
sender	reference	Real world sender of the message	MessageHeader.sender (Practitioner, Organization, PractitionerRole)
source N	string	Name of system	MessageHeader.source.name
source-uri N	uri	Actual message source address or id	MessageHeader.source.endpoint
target	reference	Particular delivery destination within the destination	MessageHeader.destination.target (Device)