MessageHeader

Introduction

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

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 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 sender and 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

StructureDefinition

Elements (Simplified)

• MessageHeader [0..*]: - A resource that describes a message that is exchanged between systems
• MessageHeader.event[x] [1..1]: Coding, uri, canonical example:message-events The real world event that triggered this messsage
• MessageHeader.destination [0..*]: BackboneElement Message destination application(s)
• MessageHeader.destination.endpoint[x] [0..1]: url, Reference(Endpoint) Actual destination address or Endpoint resource
• MessageHeader.destination.name [0..1]: string Name of system
• MessageHeader.destination.receiver [0..1]: [Reference(Device](/Reference(Device), Organization, Patient, Practitioner, PractitionerRole, RelatedPerson)) Intended "real-world" recipient for the data
• MessageHeader.source [1..1]: BackboneElement Message source application
• MessageHeader.source.endpoint[x] [0..1]: url, Reference(Endpoint) Actual source address or Endpoint resource
• MessageHeader.source.name [0..1]: string Name of system
• MessageHeader.source.software [0..1]: string Name of software running the system
• MessageHeader.source.version [0..1]: string Version of software running
• MessageHeader.source.contact [0..1]: ContactPoint Human contact for problems
• MessageHeader.source.sender [0..1]: [Reference(Device](/Reference(Device), Organization, Patient, Practitioner, PractitionerRole)) Real world sender of the message
• MessageHeader.reason [0..1]: CodeableConcept example:message-reason-encounter Cause of event
• MessageHeader.response [0..1]: BackboneElement If this is a reply to prior message
• MessageHeader.response.identifier [1..1]: Identifier Bundle.identifier of original message
• MessageHeader.response.code [1..1]: code required:response-code ok | transient-error | fatal-error
• MessageHeader.response.details [0..1]: Reference(OperationOutcome) Specific list of hints/warnings/errors
• MessageHeader.focus [0..*]: Reference(Resource) The actual content of the message
• MessageHeader.definition [0..1]: canonical Link to the definition for this message

Mappings

• MessageHeader Mappings — 39 mapping entries

Implementation Guide

implementationguide-MessageHeader-core.xml

<?xml version="1.0" encoding="UTF-8"?>

<ImplementationGuide xmlns="http://hl7.org/fhir" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hl7.org/fhir ../../publish/ImplementationGuide.xsd">
  <id value="MessageHeader-core"/>
  <name value="CommonExtensionsForMessageHeader"/>
  <title value="Common extensions for message header"/>
  <status value="draft"/>
  <date value="2017-01-24T00:00:00.000"/>
  <publisher value="Health Level Seven, Inc. - InM Work Group"/>
  <description value="Defines "common" extensions for use with the messageheader resource and contained elements"/>
</ImplementationGuide>

Operations

• process-message — Process Message — This operation accepts a message, processes it according to the definition of the event in the message header, and returns one or more response messages.

Full Operations

Resource Packs

list-MessageHeader-packs.xml

<?xml version="1.0" encoding="UTF-8"?>

<List xmlns="http://hl7.org/fhir" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hl7.org/fhir ../../publish/List.xsd">
  <id value="MessageHeader-packs"/>
  <status value="current"/>
  <mode value="working"/>
  <entry>
    <item>
      <reference value="ImplementationGuide/MessageHeader-core"/>
    </item>
  </entry>
</List>

Search Parameters

• 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
• receiver — reference — Intended "real-world" recipient for the data — MessageHeader.destination.receiver
• response-id — token — Id of original message — MessageHeader.response.identifier
• sender — reference — Real world sender of the message — MessageHeader.source.sender
• source — string — Name of system — MessageHeader.source.name

Full Search Parameters

Examples

• 10bb101f-a121-4264-a920-67be9cb82c74 — message-request-link — A request to link two patients
• 1cbdfb97-5859-48a4-8301-d54eab818d68 — messageheader-example — A typical message header
• 3a0707d3-549e-4467-b8b8-5a2ab3800efe — message-response-link — A response to a request to link two patients
• messageheader-example — messageheader-example
• messageheader-examples-header — messageheader-examples-header

Full Examples

Mapping Exceptions

messageheader-event-mapping-exceptions.xml

Divergent Elements

• Event.code → MessageHeader.event[x]
  • missingTypes | reason=Unknown | pattern=CodeableConcept
  • extraTypes | reason=Unknown
  • shortUnmatched | reason=Unknown | pattern=What service was done | resource=The real world event that triggered this messsage
  • definitionUnmatched | reason=Unknown | pattern=A code that identifies the specific service or action that was or is being performed. | resource=Code that identifies the event this message represents and connects it with its definition. Events are defined by codes, or by URIs that identify events, or by reference to EventDefinition or SubscriptionTopic resources that define the event directly. This element is intentionally unbound, and the selection of appropriate event codes is delegated to implementations and implementation guides. For codes, a good set of example codes is found in the V2 event codes.
• Event.reason → MessageHeader.reason
  • missingTypes | reason=Unknown | pattern=CodeableReference(Condition, Observation, DiagnosticReport, DocumentReference)
  • extraTypes | reason=Unknown
  • shortUnmatched | reason=Unknown | pattern=Why was message header performed? | resource=Cause of event
  • definitionUnmatched | reason=Unknown | pattern=Describes why the message header occurred in coded or textual form or Indicates another resource whose existence justifies this message header. | resource=Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
  • commentsUnmatched | reason=Unknown | pattern=Textual reasons can be captured using reasonCode.text.

Unmapped Elements

• Event.partOf — Unknown
• Event.reported — Unknown
• Event.relevantHistory — Unknown
• Event.location — Unknown
• Event.status — Unknown
• Event.subject — Unknown
• Event.statusReason — Unknown
• Event.performer.actor — Unknown
• Event.performer.function — Unknown
• Event.note — Unknown
• Event.category — Unknown
• Event.encounter — Unknown
• Event.recorded — Unknown
• Event.occurrence — Unknown
• Event.product — Unknown
• Event.performer — Unknown
• Event.identifier — Unknown
• Event.basedOn — Unknown
• Event.researchStudy — Unknown

messageheader-fivews-mapping-exceptions.xml

Unmapped Elements

• FiveWs.recorded — Unknown
• FiveWs.author — Unknown
• FiveWs.cause — Unknown
• FiveWs.version — Unknown
• FiveWs.witness — Unknown
• FiveWs.class — Unknown
• FiveWs.where — Unknown
• FiveWs.context — Unknown
• FiveWs.init — Unknown
• FiveWs.identifier — Unknown
• FiveWs.source — source
• FiveWs.who — sender
• FiveWs.grade — Unknown
• FiveWs.status — Unknown
• FiveWs.planned — Unknown
• FiveWs.done — Unknown