Resources
MessageHeader
Resources
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.
Properties
| Name | Required | Type | Description |
|---|---|---|---|
| event[x] | Yes | Coding, uri | Code for the event this message represents or link to event definition |
| destination | No | MessageHeaderDestination | Message destination application(s) |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - name | No | string | Name of system |
| - target | No | Reference<Device> | Particular delivery destination within the destination |
| - endpoint | Yes | url | Actual destination address or id |
| - receiver | No | Reference<Practitioner / PractitionerRole / Organization> | Intended “real-world” recipient for the data |
| sender | No | Reference<Practitioner / PractitionerRole / Organization> | Real world sender of the message |
| enterer | No | Reference<Practitioner / PractitionerRole> | The source of the data entry |
| author | No | Reference<Practitioner / PractitionerRole> | The source of the decision |
| source | Yes | MessageHeaderSource | Message source application |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - name | No | string | Name of system |
| - software | No | string | Name of software running the system |
| - version | No | string | Version of software running |
| - contact | No | ContactPoint | Human contact for problems |
| - endpoint | Yes | url | Actual message source address or id |
| responsible | No | Reference<Practitioner / PractitionerRole / Organization> | Final responsibility for event |
| reason | No | CodeableConcept | Cause of event |
| response | No | MessageHeaderResponse | If this is a reply to prior message |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - identifier | Yes | id | Id of original message |
| - code | Yes | code | ok / transient-error / fatal-error |
| - details | No | Reference<OperationOutcome> | Specific list of hints/warnings/errors |
| focus | No | Reference<Resource>[] | The actual content of the message |
| definition | No | canonical | Link to the definition for this message |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| author | reference | The source of the decision | MessageHeader.author |
| code | token | ok / transient-error / fatal-error | MessageHeader.response.code |
| destination | string | Name of system | MessageHeader.destination.name |
| destination-uri | uri | Actual destination address or id | MessageHeader.destination.endpoint |
| enterer | reference | The source of the data entry | MessageHeader.enterer |
| event | token | Code for the event this message represents or link to event definition | MessageHeader.event |
| 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 |
| responsible | reference | Final responsibility for event | MessageHeader.responsible |
| sender | reference | Real world sender of the message | MessageHeader.sender |
| source | string | Name of system | MessageHeader.source.name |
| source-uri | uri | Actual message source address or id | MessageHeader.source.endpoint |
| target | reference | Particular delivery destination within the destination | MessageHeader.destination.target |
Inherited Properties
| Name | Required | Type | Description |
|---|---|---|---|
| id | No | string | Logical id of this artifact |
| meta | No | Meta | Metadata about the resource |
| implicitRules | No | uri | A set of rules under which this content was created |
| language | No | code | Language of the resource content |
| text | No | Narrative | Text summary of the resource, for human interpretation |
| contained | No | Resource[] | Contained, inline Resources |
| extension | No | Extension[] | Additional content defined by implementations |
| modifierExtension | No | Extension[] | Extensions that cannot be ignored |
To view the FHIR specification for this resource, see MessageHeader.