R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). 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.15 Resource MessageHeader - Content

Infrastructure And Messaging icon

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.15.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.15.2 References to this Resource

Implements: Event

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		Event code or link to EventDefinition Binding: MessageEvent (Example)
eventCoding			Coding
eventCanonical			canonical(EventDefinition)
destination	Σ	0..*	BackboneElement	Message destination application(s)
endpoint[x]	Σ	0..1		Actual destination address or Endpoint resource
endpointUrl			url
endpointReference			Reference(Endpoint)
name	Σ	0..1	string	Name of system
target	Σ	0..1	Reference(Device)	Particular delivery destination within the destination
receiver	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Intended "real-world" recipient for the data
sender	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Device \| Organization)	Real world sender of the message
author	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Device \| Organization)	The source of the decision
source	Σ	1..1	BackboneElement	Message source application
endpoint[x]	Σ	0..1		Actual source address or Endpoint resource
endpointUrl			url
endpointReference			Reference(Endpoint)
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
responsible	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Final responsibility for event
reason	Σ	0..1	CodeableConcept	Cause of event Binding: Example Message Reason Codes (Example)
response	Σ	0..1	BackboneElement	If this is a reply to prior message
identifier	Σ	1..1	Identifier	Bundle.identifier of original message
code	Σ	1..1	code	ok \| transient-error \| fatal-error Binding: Response Type (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

See the Extensions for this resource

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|canonical(EventDefinition) Event code or link to EventDefinition --></event[x]>
 <destination>  <!-- 0..* Message destination application(s) -->
  <endpoint[x]><!-- 0..1 url|Reference(Endpoint) Actual destination address or Endpoint resource --></endpoint[x]>
  <name value="[string]"/><!-- 0..1 Name of system -->
  <target><!-- 0..1 Reference(Device) Particular delivery destination within the destination --></target>
  <receiver><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Intended "real-world" recipient for the data --></receiver>
 </destination>
 <sender><!-- 0..1 Reference(Device|Organization|Practitioner|PractitionerRole) Real world sender of the message --></sender>
 <author><!-- 0..1 Reference(Device|Organization|Practitioner|PractitionerRole) The source of the decision --></author>
 <source>  <!-- 1..1 Message source application -->
  <endpoint[x]><!-- 0..1 url|Reference(Endpoint) Actual source address or Endpoint resource --></endpoint[x]>
  <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>
 </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><!-- 1..1 Identifier Bundle.identifier of original message --></identifier>
  <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]: Event code or link to EventDefinition. One of these 2:
  "eventCoding" : { Coding },
  "eventCanonical" : "<canonical(EventDefinition)>",
  "destination" : [{ // Message destination application(s)
    // endpoint[x]: Actual destination address or Endpoint resource. One of these 2:
    "endpointUrl" : "<url>",
    "endpointReference" : { Reference(Endpoint) },
    "name" : "<string>", // Name of system
    "target" : { Reference(Device) }, // Particular delivery destination within the destination
    "receiver" : { Reference(Organization|Practitioner|PractitionerRole) } // Intended "real-world" recipient for the data
  }],
  "sender" : { Reference(Device|Organization|Practitioner|PractitionerRole) }, // Real world sender of the message
  "author" : { Reference(Device|Organization|Practitioner|PractitionerRole) }, // The source of the decision
  "source" : { // R!  Message source application
    // endpoint[x]: Actual source address or Endpoint resource. One of these 2:
    "endpointUrl" : "<url>",
    "endpointReference" : { Reference(Endpoint) },
    "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
  },
  "responsible" : { Reference(Organization|Practitioner|PractitionerRole) }, // Final responsibility for event
  "reason" : { CodeableConcept }, // Cause of event
  "response" : { // If this is a reply to prior message
    "identifier" : { Identifier }, // R!  Bundle.identifier 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
  # event[x] : 1..1 Event code or link to EventDefinition. One of these 2
    fhir:event [  a fhir:Coding ; Coding ]
    fhir:event [  a fhir:canonical ; canonical(EventDefinition) ]
  fhir:destination ( [ # 0..* Message destination application(s)
    # endpoint[x] : 0..1 Actual destination address or Endpoint resource. One of these 2
      fhir:endpoint [  a fhir:url ; url ]
      fhir:endpoint [  a fhir:Reference ; Reference(Endpoint) ]
    fhir:name [ string ] ; # 0..1 Name of system
    fhir:target [ Reference(Device) ] ; # 0..1 Particular delivery destination within the destination
    fhir:receiver [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 Intended "real-world" recipient for the data
  ] ... ) ;
  fhir:sender [ Reference(Device|Organization|Practitioner|PractitionerRole) ] ; # 0..1 Real world sender of the message
  fhir:author [ Reference(Device|Organization|Practitioner|PractitionerRole) ] ; # 0..1 The source of the decision
  fhir:source [ # 1..1 Message source application
    # endpoint[x] : 0..1 Actual source address or Endpoint resource. One of these 2
      fhir:endpoint [  a fhir:url ; url ]
      fhir:endpoint [  a fhir:Reference ; Reference(Endpoint) ]
    fhir:name [ string ] ; # 0..1 Name of system
    fhir:software [ string ] ; # 0..1 Name of software running the system
    fhir:version [ string ] ; # 0..1 Version of software running
    fhir:contact [ ContactPoint ] ; # 0..1 Human contact for problems
  ] ;
  fhir:responsible [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 Final responsibility for event
  fhir:reason [ CodeableConcept ] ; # 0..1 Cause of event
  fhir:response [ # 0..1 If this is a reply to prior message
    fhir:identifier [ Identifier ] ; # 1..1 Bundle.identifier of original message
    fhir:code [ code ] ; # 1..1 ok | transient-error | fatal-error
    fhir:details [ Reference(OperationOutcome) ] ; # 0..1 Specific list of hints/warnings/errors
  ] ;
  fhir:focus  ( [ Reference(Any) ] ... ) ; # 0..* The actual content of the message
  fhir:definition [ canonical(MessageDefinition) ] ; # 0..1 Link to the definition for this message
]

Changes since R4

MessageHeader

MessageHeader.event[x]

Add Type canonical(EventDefinition)
Remove Type uri

MessageHeader.destination.endpoint[x]

Added Element

MessageHeader.sender

Type Reference: Added Target Type Device

MessageHeader.author

Type Reference: Added Target Types Device, Organization

MessageHeader.source.endpoint[x]

Added Element

MessageHeader.response.identifier

Type changed from id to Identifier

MessageHeader.destination.endpoint

deleted

MessageHeader.enterer

deleted

MessageHeader.source.endpoint

deleted

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		Event code or link to EventDefinition Binding: MessageEvent (Example)
eventCoding			Coding
eventCanonical			canonical(EventDefinition)
destination	Σ	0..*	BackboneElement	Message destination application(s)
endpoint[x]	Σ	0..1		Actual destination address or Endpoint resource
endpointUrl			url
endpointReference			Reference(Endpoint)
name	Σ	0..1	string	Name of system
target	Σ	0..1	Reference(Device)	Particular delivery destination within the destination
receiver	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Intended "real-world" recipient for the data
sender	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Device \| Organization)	Real world sender of the message
author	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Device \| Organization)	The source of the decision
source	Σ	1..1	BackboneElement	Message source application
endpoint[x]	Σ	0..1		Actual source address or Endpoint resource
endpointUrl			url
endpointReference			Reference(Endpoint)
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
responsible	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization)	Final responsibility for event
reason	Σ	0..1	CodeableConcept	Cause of event Binding: Example Message Reason Codes (Example)
response	Σ	0..1	BackboneElement	If this is a reply to prior message
identifier	Σ	1..1	Identifier	Bundle.identifier of original message
code	Σ	1..1	code	ok \| transient-error \| fatal-error Binding: Response Type (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

See the Extensions for this resource

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|canonical(EventDefinition) Event code or link to EventDefinition --></event[x]>
 <destination>  <!-- 0..* Message destination application(s) -->
  <endpoint[x]><!-- 0..1 url|Reference(Endpoint) Actual destination address or Endpoint resource --></endpoint[x]>
  <name value="[string]"/><!-- 0..1 Name of system -->
  <target><!-- 0..1 Reference(Device) Particular delivery destination within the destination --></target>
  <receiver><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Intended "real-world" recipient for the data --></receiver>
 </destination>
 <sender><!-- 0..1 Reference(Device|Organization|Practitioner|PractitionerRole) Real world sender of the message --></sender>
 <author><!-- 0..1 Reference(Device|Organization|Practitioner|PractitionerRole) The source of the decision --></author>
 <source>  <!-- 1..1 Message source application -->
  <endpoint[x]><!-- 0..1 url|Reference(Endpoint) Actual source address or Endpoint resource --></endpoint[x]>
  <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>
 </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><!-- 1..1 Identifier Bundle.identifier of original message --></identifier>
  <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]: Event code or link to EventDefinition. One of these 2:
  "eventCoding" : { Coding },
  "eventCanonical" : "<canonical(EventDefinition)>",
  "destination" : [{ // Message destination application(s)
    // endpoint[x]: Actual destination address or Endpoint resource. One of these 2:
    "endpointUrl" : "<url>",
    "endpointReference" : { Reference(Endpoint) },
    "name" : "<string>", // Name of system
    "target" : { Reference(Device) }, // Particular delivery destination within the destination
    "receiver" : { Reference(Organization|Practitioner|PractitionerRole) } // Intended "real-world" recipient for the data
  }],
  "sender" : { Reference(Device|Organization|Practitioner|PractitionerRole) }, // Real world sender of the message
  "author" : { Reference(Device|Organization|Practitioner|PractitionerRole) }, // The source of the decision
  "source" : { // R!  Message source application
    // endpoint[x]: Actual source address or Endpoint resource. One of these 2:
    "endpointUrl" : "<url>",
    "endpointReference" : { Reference(Endpoint) },
    "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
  },
  "responsible" : { Reference(Organization|Practitioner|PractitionerRole) }, // Final responsibility for event
  "reason" : { CodeableConcept }, // Cause of event
  "response" : { // If this is a reply to prior message
    "identifier" : { Identifier }, // R!  Bundle.identifier 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
  # event[x] : 1..1 Event code or link to EventDefinition. One of these 2
    fhir:event [  a fhir:Coding ; Coding ]
    fhir:event [  a fhir:canonical ; canonical(EventDefinition) ]
  fhir:destination ( [ # 0..* Message destination application(s)
    # endpoint[x] : 0..1 Actual destination address or Endpoint resource. One of these 2
      fhir:endpoint [  a fhir:url ; url ]
      fhir:endpoint [  a fhir:Reference ; Reference(Endpoint) ]
    fhir:name [ string ] ; # 0..1 Name of system
    fhir:target [ Reference(Device) ] ; # 0..1 Particular delivery destination within the destination
    fhir:receiver [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 Intended "real-world" recipient for the data
  ] ... ) ;
  fhir:sender [ Reference(Device|Organization|Practitioner|PractitionerRole) ] ; # 0..1 Real world sender of the message
  fhir:author [ Reference(Device|Organization|Practitioner|PractitionerRole) ] ; # 0..1 The source of the decision
  fhir:source [ # 1..1 Message source application
    # endpoint[x] : 0..1 Actual source address or Endpoint resource. One of these 2
      fhir:endpoint [  a fhir:url ; url ]
      fhir:endpoint [  a fhir:Reference ; Reference(Endpoint) ]
    fhir:name [ string ] ; # 0..1 Name of system
    fhir:software [ string ] ; # 0..1 Name of software running the system
    fhir:version [ string ] ; # 0..1 Version of software running
    fhir:contact [ ContactPoint ] ; # 0..1 Human contact for problems
  ] ;
  fhir:responsible [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 Final responsibility for event
  fhir:reason [ CodeableConcept ] ; # 0..1 Cause of event
  fhir:response [ # 0..1 If this is a reply to prior message
    fhir:identifier [ Identifier ] ; # 1..1 Bundle.identifier of original message
    fhir:code [ code ] ; # 1..1 ok | transient-error | fatal-error
    fhir:details [ Reference(OperationOutcome) ] ; # 0..1 Specific list of hints/warnings/errors
  ] ;
  fhir:focus  ( [ Reference(Any) ] ... ) ; # 0..* The actual content of the message
  fhir:definition [ canonical(MessageDefinition) ] ; # 0..1 Link to the definition for this message
]

Changes since Release 4

MessageHeader

MessageHeader.event[x]

Add Type canonical(EventDefinition)
Remove Type uri

MessageHeader.destination.endpoint[x]

Added Element

MessageHeader.sender

Type Reference: Added Target Type Device

MessageHeader.author

Type Reference: Added Target Types Device, Organization

MessageHeader.source.endpoint[x]

Added Element

MessageHeader.response.identifier

Type changed from id to Identifier

MessageHeader.destination.endpoint

deleted

MessageHeader.enterer

deleted

MessageHeader.source.endpoint

deleted

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

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

2.15.3.1 Terminology Bindings

Path	ValueSet	Type	Documentation
MessageHeader.event[x]	??	Example
MessageHeader.reason	ExampleMessageReasonCodes	Example	Example Message Reasons. These are the set of codes that might be used an updating an encounter using admin-update.
MessageHeader.response.code	ResponseType	Required	The kind of response to a message.

Path

ValueSet

Type

Documentation

MessageHeader.event[x]

??

Example

MessageHeader.reason

ExampleMessageReasonCodes

Example

Example Message Reasons. These are the set of codes that might be used an updating an encounter using admin-update.

MessageHeader.response.code

ResponseType

Required

The kind of response to a message.

2.15.4 Notes:

There is no persistent identifier on MessageHeader that identifies the specific triggering event for the message - any such identity must be determined from the payload of the message.
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.15.5 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to 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, Organization, Device, PractitionerRole)
code	token	ok \| transient-error \| fatal-error	MessageHeader.response.code
destination	string	Name of system	MessageHeader.destination.name
event	token	Code for the event this message represents or link to event definition	MessageHeader.event.ofType(Coding) \| MessageHeader.event.ofType(canonical)
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	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, Device, PractitionerRole)
source	string	Name of system	MessageHeader.source.name
target	reference	Particular delivery destination within the destination	MessageHeader.destination.target (Device)