NHS North West Genomics
2.2.5 - ci-build
NHS North West Genomics
2.2.5 - ci-build
NHS North West Genomics - Local Development build (v2.2.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.nwgenomics.nhs.uk/StructureDefinition/MessageHeader | Version: 2.2.5 | ||||
| Draft as of 2026-11-05 | Computable Name: MessageHeader | ||||
Messaging Document Message
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  MessageHeader |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
  meta |
0..1 | Meta | Metadata about the resource | |
   lastUpdated |
1..1 | instant | When the resource version last changed | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 Slices for event[x] |
1..1 | Coding | Code for the event this message represents or link to event definition Slice: Unordered, Closed by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. | |
  event[x]:eventCoding |
1..1 | Coding | Code for the event this message represents or link to event definition Binding: Hl7VSEventCode (3.0.0) (required) | |
| destination |
0..* | BackboneElement | Message destination application(s) | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| endpoint |
1..1 | url | Actual destination address or id | |
 receiver |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | |
 identifier |
1..1 | OrganisationCode | Logical reference, when literal reference is not known | |
| sender |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message | |
| identifier |
1..1 | OrganisationCode | Logical reference, when literal reference is not known | |
| source |
1..1 | BackboneElement | Message source application | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| endpoint |
1..1 | url | Actual message source address or id | |
| response |
0..1 | BackboneElement | Mandatory for message acknowledgements. | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| identifier |
1..1 | id | Id of original message | |
| code |
1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageHeader.event[x] | Base | example | MessageEvent | 📍4.0.1 | FHIR Std. |
| MessageHeader.event[x]:eventCoding | Base | required | hl7VS-eventCode | 📍3.0.0 | THO v7.5 |
| MessageHeader.response.code | Base | required | ResponseType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageHeader |
MessageHeader | |||
 meta |
||||
| lastUpdated |
1..1 | instant | When the resource version last changed | |
| Slices for event[x] |
1..1 | Coding | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this | |
| event[x]:eventCoding |
1..1 | Coding | Code for the event this message represents or link to event definition Binding: Hl7VSEventCode (3.0.0) (required) | |
| destination |
||||
| receiver |
||||
| identifier |
1..1 | OrganisationCode | Logical reference, when literal reference is not known | |
| sender |
||||
| identifier |
1..1 | OrganisationCode | Logical reference, when literal reference is not known | |
| response |
0..1 | BackboneElement | Mandatory for message acknowledgements. | |
| identifier |
1..1 | id | Id of original message | |
| code |
1..1 | code | ok | transient-error | fatal-error | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageHeader.event[x]:eventCoding | Base | required | hl7VS-eventCode | 📍3.0.0 | THO v7.5 |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
1..1 | instant | When the resource version last changed | |||||
| source |
0..1 | uri | Identifies where the resource comes from | |||||
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for event[x] |
1..1 | Coding | Code for the event this message represents or link to event definition Slice: Unordered, Closed by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. | |||||
| event[x]:eventCoding |
1..1 | Coding | Code for the event this message represents or link to event definition Binding: Hl7VSEventCode (3.0.0) (required) | |||||
| destination |
0..* | BackboneElement | Message destination application(s) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| name |
0..1 | string | Name of system | |||||
| target |
0..1 | Reference(Device) | Particular delivery destination within the destination | |||||
| endpoint |
1..1 | url | Actual destination address or id | |||||
| receiver |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
1..1 | OrganisationCode | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| sender |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
1..1 | OrganisationCode | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| enterer |
0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | |||||
| author |
0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | |||||
| source |
1..1 | BackboneElement | Message source application | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| name |
0..1 | string | Name of system | |||||
| software |
0..1 | string | Name of software running the system | |||||
| version |
0..1 | string | Version of software running | |||||
| contact |
0..1 | ContactPoint | Human contact for problems | |||||
| endpoint |
1..1 | url | Actual message source address or id | |||||
| responsible |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | |||||
| reason |
0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | |||||
| response |
0..1 | BackboneElement | Mandatory for message acknowledgements. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| identifier |
1..1 | id | Id of original message | |||||
| code |
1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | |||||
| details |
0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | |||||
| focus |
0..* | Reference(Resource) | The actual content of the message | |||||
| definition |
0..1 | canonical(MessageDefinition) | Link to the definition for this message | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageHeader.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| MessageHeader.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| MessageHeader.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| MessageHeader.event[x] | Base | example | MessageEvent | 📍4.0.1 | FHIR Std. |
| MessageHeader.event[x]:eventCoding | Base | required | hl7VS-eventCode | 📍3.0.0 | THO v7.5 |
| MessageHeader.destination.receiver.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| MessageHeader.sender.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| MessageHeader.reason | Base | example | Example Message Reason Codes | 📍4.0.1 | FHIR Std. |
| MessageHeader.response.code | Base | required | ResponseType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from MessageHeader
Summary
Mandatory: 1 element(3 nested mandatory elements)
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageHeader |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
| meta |
0..1 | Meta | Metadata about the resource | |
| lastUpdated |
1..1 | instant | When the resource version last changed | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| Slices for event[x] |
1..1 | Coding | Code for the event this message represents or link to event definition Slice: Unordered, Closed by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. | |
| event[x]:eventCoding |
1..1 | Coding | Code for the event this message represents or link to event definition Binding: Hl7VSEventCode (3.0.0) (required) | |
| destination |
0..* | BackboneElement | Message destination application(s) | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| endpoint |
1..1 | url | Actual destination address or id | |
| receiver |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | |
| identifier |
1..1 | OrganisationCode | Logical reference, when literal reference is not known | |
| sender |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message | |
| identifier |
1..1 | OrganisationCode | Logical reference, when literal reference is not known | |
| source |
1..1 | BackboneElement | Message source application | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| endpoint |
1..1 | url | Actual message source address or id | |
| response |
0..1 | BackboneElement | Mandatory for message acknowledgements. | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| identifier |
1..1 | id | Id of original message | |
| code |
1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageHeader.event[x] | Base | example | MessageEvent | 📍4.0.1 | FHIR Std. |
| MessageHeader.event[x]:eventCoding | Base | required | hl7VS-eventCode | 📍3.0.0 | THO v7.5 |
| MessageHeader.response.code | Base | required | ResponseType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageHeader |
MessageHeader | |||
| meta |
||||
| lastUpdated |
1..1 | instant | When the resource version last changed | |
| Slices for event[x] |
1..1 | Coding | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this | |
| event[x]:eventCoding |
1..1 | Coding | Code for the event this message represents or link to event definition Binding: Hl7VSEventCode (3.0.0) (required) | |
| destination |
||||
| receiver |
||||
| identifier |
1..1 | OrganisationCode | Logical reference, when literal reference is not known | |
| sender |
||||
| identifier |
1..1 | OrganisationCode | Logical reference, when literal reference is not known | |
| response |
0..1 | BackboneElement | Mandatory for message acknowledgements. | |
| identifier |
1..1 | id | Id of original message | |
| code |
1..1 | code | ok | transient-error | fatal-error | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageHeader.event[x]:eventCoding | Base | required | hl7VS-eventCode | 📍3.0.0 | THO v7.5 |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
1..1 | instant | When the resource version last changed | |||||
| source |
0..1 | uri | Identifies where the resource comes from | |||||
| profile |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| Slices for event[x] |
1..1 | Coding | Code for the event this message represents or link to event definition Slice: Unordered, Closed by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. | |||||
| event[x]:eventCoding |
1..1 | Coding | Code for the event this message represents or link to event definition Binding: Hl7VSEventCode (3.0.0) (required) | |||||
| destination |
0..* | BackboneElement | Message destination application(s) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| name |
0..1 | string | Name of system | |||||
| target |
0..1 | Reference(Device) | Particular delivery destination within the destination | |||||
| endpoint |
1..1 | url | Actual destination address or id | |||||
| receiver |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
1..1 | OrganisationCode | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| sender |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
1..1 | OrganisationCode | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| enterer |
0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | |||||
| author |
0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | |||||
| source |
1..1 | BackboneElement | Message source application | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| name |
0..1 | string | Name of system | |||||
| software |
0..1 | string | Name of software running the system | |||||
| version |
0..1 | string | Version of software running | |||||
| contact |
0..1 | ContactPoint | Human contact for problems | |||||
| endpoint |
1..1 | url | Actual message source address or id | |||||
| responsible |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | |||||
| reason |
0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | |||||
| response |
0..1 | BackboneElement | Mandatory for message acknowledgements. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| identifier |
1..1 | id | Id of original message | |||||
| code |
1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | |||||
| details |
0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | |||||
| focus |
0..* | Reference(Resource) | The actual content of the message | |||||
| definition |
0..1 | canonical(MessageDefinition) | Link to the definition for this message | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageHeader.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| MessageHeader.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| MessageHeader.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| MessageHeader.event[x] | Base | example | MessageEvent | 📍4.0.1 | FHIR Std. |
| MessageHeader.event[x]:eventCoding | Base | required | hl7VS-eventCode | 📍3.0.0 | THO v7.5 |
| MessageHeader.destination.receiver.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| MessageHeader.sender.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| MessageHeader.reason | Base | example | Example Message Reason Codes | 📍4.0.1 | FHIR Std. |
| MessageHeader.response.code | Base | required | ResponseType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from MessageHeader
Summary
Mandatory: 1 element(3 nested mandatory elements)
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron