This page is part of the FHIR Specification (v1.4.0:
STU
3 Ballot 3). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
|
|
Compartments
|
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.
The MessageHeader resource is defined in order to support Messaging using FHIR resources . The principle 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.
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
Σ | DomainResource |
|
|
|
Σ | 1..1 | instant |
|
|
|
1..1 | Coding |
MessageEvent |
|
|
0..1 | BackboneElement |
|
|
Σ | 1..1 | id |
|
|
|
1..1 | code |
ResponseType |
|
Σ | 0..1 | Reference ( OperationOutcome ) |
|
|
Σ | 1..1 | BackboneElement |
|
|
Σ | 0..1 | string |
|
|
Σ | 0..1 | string |
|
|
Σ | 0..1 | string |
|
|
Σ | 0..1 | ContactPoint |
|
|
Σ | 1..1 | uri |
|
|
Σ | 0..* | BackboneElement |
|
|
Σ | 0..1 | string |
|
|
Σ | 0..1 | Reference ( Device ) |
|
|
Σ | 1..1 | uri |
|
|
Σ | 0..1 | Reference ( Practitioner ) |
|
|
Σ | 0..1 | Reference ( Practitioner ) |
|
|
Σ | 0..1 |
Reference
(
Practitioner
|
|
|
Σ | 0..1 |
Reference
(
Practitioner
|
|
|
Σ | 0..1 | CodeableConcept |
|
|
Σ | 0..* | Reference ( Any ) |
|
Documentation for this format
|
||||
UML
Diagram
UML Diagram
XML
Template
XML Template
<MessageHeader xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <timestamp value="[instant]"/><!-- 1..1 Time that the message was sent --> <event><!-- 1..1 Coding Code for the event this message represents --></event> <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> <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="[uri]"/><!-- 1..1 Actual message source address or id --> </source> <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="[uri]"/><!-- 1..1 Actual destination address or id --> </destination> <enterer><!-- 0..1 Reference(Practitioner) The source of the data entry --></enterer> <author><!-- 0..1 Reference(Practitioner) The source of the decision --></author> <receiver><!-- 0..1 Reference(Practitioner|Organization) Intended "real-world" recipient for the data --></receiver> <responsible><!-- 0..1 Reference(Practitioner|Organization) Final responsibility for event --></responsible> <reason><!-- 0..1 CodeableConcept Cause of event --></reason> <data><!-- 0..* Reference(Any) The actual content of the message --></data> </MessageHeader>
JSON
Template
JSON Template
{
"resourceType" : "MessageHeader",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"timestamp" : "<instant>", // R! Time that the message was sent
"event" : { Coding }, // R! Code for the event this message represents
"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
},
"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" : "<uri>" // R! Actual message source address or id
},
"destination" : [{ // Message Destination Application(s)
"name" : "<string>", // Name of system
"target" : { Reference(Device) }, // Particular delivery destination within the destination
"endpoint" : "<uri>" // R! Actual destination address or id
}],
"enterer" : { Reference(Practitioner) }, // The source of the data entry
"author" : { Reference(Practitioner) }, // The source of the decision
"receiver" : { Reference(Practitioner|Organization) }, // Intended "real-world" recipient for the data
"responsible" : { Reference(Practitioner|Organization) }, // Final responsibility for event
"reason" : { CodeableConcept }, // Cause of event
"data" : [{ Reference(Any) }] // The actual content of the message
}
Structure
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
Σ | DomainResource |
|
|
|
Σ | 1..1 | instant |
|
|
|
1..1 | Coding |
MessageEvent |
|
|
0..1 | BackboneElement |
|
|
Σ | 1..1 | id |
|
|
|
1..1 | code |
ResponseType |
|
Σ | 0..1 | Reference ( OperationOutcome ) |
|
|
Σ | 1..1 | BackboneElement |
|
|
Σ | 0..1 | string |
|
|
Σ | 0..1 | string |
|
|
Σ | 0..1 | string |
|
|
Σ | 0..1 | ContactPoint |
|
|
Σ | 1..1 | uri |
|
|
Σ | 0..* | BackboneElement |
|
|
Σ | 0..1 | string |
|
|
Σ | 0..1 | Reference ( Device ) |
|
|
Σ | 1..1 | uri |
|
|
Σ | 0..1 | Reference ( Practitioner ) |
|
|
Σ | 0..1 | Reference ( Practitioner ) |
|
|
Σ | 0..1 |
Reference
(
Practitioner
|
|
|
Σ | 0..1 |
Reference
(
Practitioner
|
|
|
Σ | 0..1 | CodeableConcept |
|
|
Σ | 0..* | Reference ( Any ) |
|
Documentation for this format
|
||||
XML
Template
XML Template
<MessageHeader xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <timestamp value="[instant]"/><!-- 1..1 Time that the message was sent --> <event><!-- 1..1 Coding Code for the event this message represents --></event> <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> <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="[uri]"/><!-- 1..1 Actual message source address or id --> </source> <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="[uri]"/><!-- 1..1 Actual destination address or id --> </destination> <enterer><!-- 0..1 Reference(Practitioner) The source of the data entry --></enterer> <author><!-- 0..1 Reference(Practitioner) The source of the decision --></author> <receiver><!-- 0..1 Reference(Practitioner|Organization) Intended "real-world" recipient for the data --></receiver> <responsible><!-- 0..1 Reference(Practitioner|Organization) Final responsibility for event --></responsible> <reason><!-- 0..1 CodeableConcept Cause of event --></reason> <data><!-- 0..* Reference(Any) The actual content of the message --></data> </MessageHeader>
JSON
Template
JSON Template
{
"resourceType" : "MessageHeader",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"timestamp" : "<instant>", // R! Time that the message was sent
"event" : { Coding }, // R! Code for the event this message represents
"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
},
"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" : "<uri>" // R! Actual message source address or id
},
"destination" : [{ // Message Destination Application(s)
"name" : "<string>", // Name of system
"target" : { Reference(Device) }, // Particular delivery destination within the destination
"endpoint" : "<uri>" // R! Actual destination address or id
}],
"enterer" : { Reference(Practitioner) }, // The source of the data entry
"author" : { Reference(Practitioner) }, // The source of the decision
"receiver" : { Reference(Practitioner|Organization) }, // Intended "real-world" recipient for the data
"responsible" : { Reference(Practitioner|Organization) }, // Final responsibility for event
"reason" : { CodeableConcept }, // Cause of event
"data" : [{ Reference(Any) }] // The actual content of the message
}
Alternate
definitions:
Alternate definitions:
Schema
/
Schematron
,
Resource
Profile
(
, Resource Profile (
XML
,
,
JSON
),
),
Questionnaire
| Path | Definition | Type | Reference |
|---|---|---|---|
|
|
|
Preferred | http://hl7.org/fhir/valueset/message-events MessageEvent |
|
|
|
Required | ResponseType |
|
|
|
Example |
|
Search parameters for this resource. The
common parameters
also apply. See
Searching
for
more
information
about
searching
in
REST,
messaging,
and
services.
for more information about searching in REST, messaging, and services.
| Name | Type | Description | Paths |
| author | reference |
|
MessageHeader.author
( Practitioner ) |
| code | token |
|
MessageHeader.response.code |
| data | reference |
|
MessageHeader.data
(Any) |
| destination | string |
|
MessageHeader.destination.name |
| destination-uri | uri |
|
MessageHeader.destination.endpoint |
| enterer | reference |
|
MessageHeader.enterer
( Practitioner ) |
| event | token |
|
MessageHeader.event |
| receiver | reference |
|
MessageHeader.receiver
( Organization |
| response-id | token |
|
MessageHeader.response.identifier |
| responsible | reference |
|
MessageHeader.responsible
( Organization |
| source | string |
|
MessageHeader.source.name |
| source-uri | uri |
|
MessageHeader.source.endpoint |
| target | reference |
|
MessageHeader.destination.target
( Device ) |
| timestamp | date |
|
MessageHeader.timestamp |