Release 4 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3 R2

Responsible Owner: Infrastructure And Messaging icon Work Group Maturity Level : 4   Trial Use Normative Security Category : Not Classified Compartments : Device , Practitioner

Detailed Descriptions for the elements in the MessageHeader resource.

0..1 Comments Comments 1..1 MessageHeader.responsible Element Id MessageHeader.responsible
Element Id MessageHeader
Definition

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.

Short Display A resource that describes a message that is exchanged between systems
Cardinality 0..*
Type DomainResource
Requirements

Many implementations are not prepared to use REST and need a messaging based infrastructure.

Summary true false
Element Id MessageHeader.event[x]
Definition

Code that identifies the event this message represents and connects it with its definition. Events are defined as part of by codes, or by URIs that identify events, or by reference to EventDefinition or SubscriptionTopic resources that define the FHIR specification have event directly. This element is intentionally unbound, and the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri selection of appropriate event codes is delegated to implementations and implementation guides. For codes, a good set of example codes is found in the EventDefinition. V2 event codes icon.

Short Display The real world event that triggered this messsage
Cardinality 1..1
Terminology Binding the Event List in the messaging framework MessageEvent ( Example )
Type Coding | uri | canonical ( EventDefinition | SubscriptionTopic )
[x] Note See Choice of Data Types Datatypes for further information about how to use [x]
Requirements

Drives the behavior associated with this message.

Summary true
Comments

The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp .

Element Id MessageHeader.destination
Definition

The destination application which the message is intended for.

Short Display Message destination application(s)
Cardinality 0..*
Requirements

Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient".

Summary true
Comments

There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.

Type Element Id string MessageHeader.destination.endpoint[x]
Requirements Definition

May Indicates where the message should be used for routing of response and/or to support audit. routed.

Summary true MessageHeader.destination.target Element Id MessageHeader.destination.target Definition Short Display Identifies the target end system in situations where the initial message transmission is to an intermediary system. Actual destination address or Endpoint resource
Cardinality 0..1
Type url | Reference ( Device Endpoint )
Requirements Supports multi-hop routing. Summary true MessageHeader.destination.endpoint Element Id MessageHeader.destination.endpoint Definition Indicates where the message should be routed to. Cardinality 1..1 Type [x] Note url See Choice of Datatypes for further information about how to use [x]
Requirements

Identifies where to route the message.

Summary true
Comments

The id url may be a non-resolvable URI for systems that do not use standard network-based addresses.

Element Id MessageHeader.destination.receiver MessageHeader.destination.name
Definition

Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient. Human-readable name for the target system.

Short Display Name of system
Cardinality 0..1
Type Reference ( Practitioner | PractitionerRole | Organization string )
Requirements

Allows May be used for routing beyond just the application level. of response and/or to support audit.

Summary true
Element Id MessageHeader.sender MessageHeader.destination.receiver
Definition

Identifies the sending system Allows data conveyed by a message to be addressed to allow the use of a trust relationship. particular person or department when routing to a specific application isn't sufficient.

Short Display Intended "real-world" recipient for the data
Cardinality 0..1
Type Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | Organization RelatedPerson )
Requirements

Allows routing beyond just the application level.

Summary true
Element Id MessageHeader.enterer MessageHeader.source
Definition

The person or device that performed the data entry leading to source application from which this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions. message originated.

Cardinality Short Display 0..1 Message source application
Type Cardinality Reference ( Practitioner | PractitionerRole ) 1..1
Requirements

Need to know for audit/traceback requirements and possibly for authorization. Allows replies, supports audit.

Summary true
Element Id MessageHeader.author MessageHeader.source.endpoint[x]
Definition

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 Identifies the most proximal routing target to the MessageHeader. Can provide other authors in extensions. send acknowledgements to.

Short Display Actual source address or Endpoint resource
Cardinality 0..1
Type url | Reference ( Practitioner | PractitionerRole Endpoint )
Requirements [x] Note See Choice of Datatypes for further information about how to use [x]
Requirements

Need Identifies where to know for audit/traceback requirements and possibly for authorization. send responses, may influence security permissions.

Summary true
Comments

Usually only for the request but can The url may be used in a response. non-resolvable URI for systems that do not use standard network-based addresses.

Element Id MessageHeader.source.name
Definition

Human-readable name for the source system.

Short Display Name of system
Cardinality 0..1
Type string
Requirements

May be used to support audit.

Summary true
Element Id MessageHeader.source.software
Definition

May include configuration or other information useful in debugging.

Short Display Name of software running the system
Cardinality 0..1
Type string
Requirements

Supports audit and possibly interface engine behavior.

Summary true
Element Id MessageHeader.source.version
Definition

Can convey versions of multiple systems in situations where a message passes through multiple hands.

Note Short Display Version of software running
Note This is a business versionId, not a resource version id (see discussion )
Cardinality 0..1
Type string
Requirements

Supports audit and possibly interface engine behavior.

Summary true
Element Id MessageHeader.source.contact
Definition

An e-mail, phone, website or other contact point to use to resolve issues with message communications.

Short Display Human contact for problems
Cardinality 0..1
Type ContactPoint
Requirements

Allows escalation of technical issues.

Summary true
Type Element Id url MessageHeader.source.sender
Requirements Definition

Identifies where the sending entity to send responses, may influence security permissions. Summary true Comments The id may be a non-resolvable URI for systems that do not allow the use standard network-based addresses. of a trust relationship.

Definition Short Display The person or organization that accepts overall responsibility for the contents Real world sender of the message. The implication is that the message event happened under the policies of the responsible party.
Cardinality 0..1
Type Reference ( Device | Organization | Patient | Practitioner | PractitionerRole | Organization )
Requirements

Need to know for audit/traceback requirements and possibly for authorization. Allows routing beyond just the application level.

Summary true
Comments

Usually only Use case is for the request but can be used in where a response. (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone. Proposing to remove and rely on Task to convey this information.

Element Id MessageHeader.reason
Definition

Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.

Short Display Cause of event
Cardinality 0..1
Terminology Binding Example Message Reason Codes ( Example )
Type CodeableConcept
Requirements

Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.

Summary true
Element Id MessageHeader.response
Definition

Information about the message that this message is a response to. Only present if this message is a response.

Short Display If this is a reply to prior message
Cardinality 0..1
Summary true
Element Id MessageHeader.response.identifier
Definition

The MessageHeader.id Bundle.identifier of the message to which this message is a response.

Note Short Display Bundle.identifier of original message
Note This is a business identifier, not a resource identifier (see discussion )
Cardinality 1..1
Type id Identifier
Requirements

Allows receiver to know what message is being responded to.

Summary true
Element Id MessageHeader.response.code
Definition

Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.

Short Display ok | transient-error | fatal-error
Cardinality 1..1
Terminology Binding ResponseType Response Type ( Required )
Type code
Requirements

Allows the sender of the acknowledge message to know if the request was successful or if action is needed.

Summary true
Comments

This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus.

Element Id MessageHeader.response.details
Definition

Full details of any issues found in the message.

Short Display Specific list of hints/warnings/errors
Cardinality 0..1
Type Reference ( OperationOutcome )
Requirements

Allows the sender of the message to determine what the specific issues are.

Summary true
Comments

This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.

Element Id MessageHeader.focus
Definition

The actual data of the message - a reference to the root/focus class of the event. This is allowed to be a Parameters resource.

Short Display The actual content of the message
Cardinality 0..*
Type Reference ( Any )
Requirements

Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources.

Summary true
Comments

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.

Element Id MessageHeader.definition
Definition

Permanent link to the MessageDefinition for this message.

Short Display Link to the definition for this message
Cardinality 0..1
Type canonical ( MessageDefinition )
Requirements

Allows sender to define the expected contents of the message.

Summary true