MessageHeader
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.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/MessageHeader/[id] |
| Vread | GET | /fhir/R4/MessageHeader/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/MessageHeader/[id] |
| Patch | PATCH | /fhir/R4/MessageHeader/[id] |
| Delete | DELETE | /fhir/R4/MessageHeader/[id] |
| Create | POST | /fhir/R4/MessageHeader |
| Search | GET | /fhir/R4/MessageHeader |
| History | GET | /fhir/R4/MessageHeader/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
event[x] | Coding, uri | 1..1 | Code for the event this message represents or link to event definition |
destination | BackboneElement | 0..* | Message destination application(s) |
sender | Reference | 0..1 | Real world sender of the message |
enterer | Reference | 0..1 | The source of the data entry |
author | Reference | 0..1 | The source of the decision |
source | BackboneElement | 1..1 | Message source application |
responsible | Reference | 0..1 | Final responsibility for event |
reason | CodeableConcept | 0..1 | Cause of event |
response | BackboneElement | 0..1 | If this is a reply to prior message |
focus | Reference | 0..* | The actual content of the message |
definition | canonical | 0..1 | Link to the definition for this message |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
author | reference | The source of the decision |
code | token | ok | transient-error | fatal-error |
destination | string | Name of system |
destination-uri | uri | Actual destination address or id |
enterer | reference | The source of the data entry |
event | token | Code for the event this message represents or link to event definition |
focus | reference | The actual content of the message |
receiver | reference | Intended "real-world" recipient for the data |
response-id | token | Id of original message |
responsible | reference | Final responsibility for event |
sender | reference | Real world sender of the message |
source | string | Name of system |
source-uri | uri | Actual message source address or id |
target | reference | Particular delivery destination within the destination |
Reference
Official FHIR R4 spec: MessageHeader.
Maturity: Trial Use 4 (FMM 4).