Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	A resource that describes a message that is exchanged between systems
meta
lastUpdated	S	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	S	1..1	Coding	Code for the event this message represents or link to event definition Binding: hl7VS-eventTypeCode (required)
destination
receiver
identifier	S	1..1	OrganisationCode	Logical reference, when literal reference is not known
sender
identifier	S	1..1	OrganisationCode	Logical reference, when literal reference is not known
response	S	0..1	BackboneElement	Mandatory for message acknowledgements.
identifier	S	1..1	id	Id of original message
code	S	1..1	code	ok | transient-error | fatal-error
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
MessageHeader.event[x]:eventCoding	required	Hl7VSEventTypeCode http://terminology.hl7.org/ValueSet/v2-0003

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	A resource that describes a message that is exchanged between systems dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
meta	Σ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
lastUpdated	SΣ	1..1	instant	When the resource version last changed ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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. ele-1: All FHIR elements must have a @value or children
event[x]:eventCoding	SΣ	1..1	Coding	Code for the event this message represents or link to event definition Binding: hl7VS-eventTypeCode (required) ele-1: All FHIR elements must have a @value or children
destination	Σ	0..*	BackboneElement	Message destination application(s) ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
endpoint	Σ	1..1	url	Actual destination address or id ele-1: All FHIR elements must have a @value or children
receiver	Σ	0..1	Reference(Practitioner | PractitionerRole | Organization)	Intended "real-world" recipient for the data ele-1: All FHIR elements must have a @value or children
identifier	SΣ	1..1	OrganisationCode	Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children
sender	Σ	0..1	Reference(Practitioner | PractitionerRole | Organization)	Real world sender of the message ele-1: All FHIR elements must have a @value or children
identifier	SΣ	1..1	OrganisationCode	Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children
source	Σ	1..1	BackboneElement	Message source application ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
endpoint	Σ	1..1	url	Actual message source address or id ele-1: All FHIR elements must have a @value or children
response	SΣ	0..1	BackboneElement	Mandatory for message acknowledgements. ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	1..1	id	Id of original message ele-1: All FHIR elements must have a @value or children
code	SΣ	1..1	code	ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
MessageHeader.event[x]	example	MessageEvent http://hl7.org/fhir/ValueSet/message-events from the FHIR Standard
MessageHeader.event[x]:eventCoding	required	Hl7VSEventTypeCode http://terminology.hl7.org/ValueSet/v2-0003
MessageHeader.response.code	required	ResponseType http://hl7.org/fhir/ValueSet/response-code|4.0.1 from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
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	SΣ	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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
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	SΣ	1..1	Coding	Code for the event this message represents or link to event definition Binding: hl7VS-eventTypeCode (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	SΣ	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	SΣ	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	SΣ	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	SΣ	1..1	id	Id of original message
code	SΣ	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

Terminology Bindings

Path	Conformance	ValueSet	URI
MessageHeader.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
MessageHeader.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
MessageHeader.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
MessageHeader.event[x]	example	MessageEvent http://hl7.org/fhir/ValueSet/message-events from the FHIR Standard
MessageHeader.event[x]:eventCoding	required	Hl7VSEventTypeCode http://terminology.hl7.org/ValueSet/v2-0003
MessageHeader.destination.receiver.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
MessageHeader.sender.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
MessageHeader.reason	example	ExampleMessageReasonCodes http://hl7.org/fhir/ValueSet/message-reason-encounter from the FHIR Standard
MessageHeader.response.code	required	ResponseType http://hl7.org/fhir/ValueSet/response-code|4.0.1 from the FHIR Standard

Summary

Mandatory: 1 element(3 nested mandatory elements)
Must-Support: 7 elements

Structures

This structure refers to these other structures:

• Organisation Code (https://hl7.mft.nhs.uk/StructureDefinition/OrganisationCode)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of MessageHeader.event[x]

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	A resource that describes a message that is exchanged between systems
meta
lastUpdated	S	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	S	1..1	Coding	Code for the event this message represents or link to event definition Binding: hl7VS-eventTypeCode (required)
destination
receiver
identifier	S	1..1	OrganisationCode	Logical reference, when literal reference is not known
sender
identifier	S	1..1	OrganisationCode	Logical reference, when literal reference is not known
response	S	0..1	BackboneElement	Mandatory for message acknowledgements.
identifier	S	1..1	id	Id of original message
code	S	1..1	code	ok | transient-error | fatal-error
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
MessageHeader.event[x]:eventCoding	required	Hl7VSEventTypeCode http://terminology.hl7.org/ValueSet/v2-0003

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	A resource that describes a message that is exchanged between systems dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
meta	Σ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
lastUpdated	SΣ	1..1	instant	When the resource version last changed ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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. ele-1: All FHIR elements must have a @value or children
event[x]:eventCoding	SΣ	1..1	Coding	Code for the event this message represents or link to event definition Binding: hl7VS-eventTypeCode (required) ele-1: All FHIR elements must have a @value or children
destination	Σ	0..*	BackboneElement	Message destination application(s) ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
endpoint	Σ	1..1	url	Actual destination address or id ele-1: All FHIR elements must have a @value or children
receiver	Σ	0..1	Reference(Practitioner | PractitionerRole | Organization)	Intended "real-world" recipient for the data ele-1: All FHIR elements must have a @value or children
identifier	SΣ	1..1	OrganisationCode	Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children
sender	Σ	0..1	Reference(Practitioner | PractitionerRole | Organization)	Real world sender of the message ele-1: All FHIR elements must have a @value or children
identifier	SΣ	1..1	OrganisationCode	Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children
source	Σ	1..1	BackboneElement	Message source application ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
endpoint	Σ	1..1	url	Actual message source address or id ele-1: All FHIR elements must have a @value or children
response	SΣ	0..1	BackboneElement	Mandatory for message acknowledgements. ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	1..1	id	Id of original message ele-1: All FHIR elements must have a @value or children
code	SΣ	1..1	code	ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
MessageHeader.event[x]	example	MessageEvent http://hl7.org/fhir/ValueSet/message-events from the FHIR Standard
MessageHeader.event[x]:eventCoding	required	Hl7VSEventTypeCode http://terminology.hl7.org/ValueSet/v2-0003
MessageHeader.response.code	required	ResponseType http://hl7.org/fhir/ValueSet/response-code|4.0.1 from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
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	SΣ	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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
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	SΣ	1..1	Coding	Code for the event this message represents or link to event definition Binding: hl7VS-eventTypeCode (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	SΣ	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	SΣ	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	SΣ	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	SΣ	1..1	id	Id of original message
code	SΣ	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

Terminology Bindings

Path	Conformance	ValueSet	URI
MessageHeader.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
MessageHeader.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
MessageHeader.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
MessageHeader.event[x]	example	MessageEvent http://hl7.org/fhir/ValueSet/message-events from the FHIR Standard
MessageHeader.event[x]:eventCoding	required	Hl7VSEventTypeCode http://terminology.hl7.org/ValueSet/v2-0003
MessageHeader.destination.receiver.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
MessageHeader.sender.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
MessageHeader.reason	example	ExampleMessageReasonCodes http://hl7.org/fhir/ValueSet/message-reason-encounter from the FHIR Standard
MessageHeader.response.code	required	ResponseType http://hl7.org/fhir/ValueSet/response-code|4.0.1 from the FHIR Standard

Summary

Mandatory: 1 element(3 nested mandatory elements)
Must-Support: 7 elements

Structures

This structure refers to these other structures:

• Organisation Code (https://hl7.mft.nhs.uk/StructureDefinition/OrganisationCode)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of MessageHeader.event[x]