# MessageHeader

Canonical page: https://docs.ovok.com/api/fhir/r4/message-header

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 [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-event-x"></span>`event[x]` | [Coding](/fhir-elements/complex/coding), [uri](/fhir-elements/primitive/uri) | `1..1` | Code for the event this message represents or link to event definition |
| <span id="element-destination"></span>`destination` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Message destination application(s) |
| <span id="element-sender"></span>`sender` | [Reference](/fhir-elements/complex/reference) | `0..1` | Real world sender of the message |
| <span id="element-enterer"></span>`enterer` | [Reference](/fhir-elements/complex/reference) | `0..1` | The source of the data entry |
| <span id="element-author"></span>`author` | [Reference](/fhir-elements/complex/reference) | `0..1` | The source of the decision |
| <span id="element-source"></span>`source` | [BackboneElement](/fhir-elements/complex/backbone-element) | `1..1` | Message source application |
| <span id="element-responsible"></span>`responsible` | [Reference](/fhir-elements/complex/reference) | `0..1` | Final responsibility for event |
| <span id="element-reason"></span>`reason` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Cause of event |
| <span id="element-response"></span>`response` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..1` | If this is a reply to prior message |
| <span id="element-focus"></span>`focus` | [Reference](/fhir-elements/complex/reference) | `0..*` | The actual content of the message |
| <span id="element-definition"></span>`definition` | [canonical](/fhir-elements/primitive/canonical) | `0..1` | Link to the definition for this message |

## Resource-specific search parameters [#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 [#reference]

Official FHIR R4 spec: [MessageHeader](https://hl7.org/fhir/R4/messageheader.html).  
Maturity: Trial Use 4 (FMM 4).
