Mandatory and Must Support Data Elements

The following data-elements are mandatory (i.e., data MUST be present) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each must have:

1. A logical id
2. A code for the type of event
3. The message source application
4. A reference to the event's focus resource(s) which will be bundled in the message

Each must support:

1. A destination
2. A reference to the sender which will be bundled in the message
3. A reference to author which will be bundled in the message
4. A reference to responsible party which will be bundled in the message

Additional Profile specific implementation guidance:

• The destination.endpoint and source.endpoint can be in any form of url the server understands (usually, https: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point
• The reference attribute is required for MessageHeader.sender, MessageHeader.author, MessageHeader.responsible, and MessageHeader.focus so there is no question how to find the resource inside the bundle - the use of only an identifier attribute (in other words, a logical reference) is not permitted.
• This profile uses the Alternate Reference extension to allow a Device to be a sender or author, because in some automated systems there may be no human provider involved in certain notifications. This pattern aligns with FHIR R5 MessageHeader for these elements. See the Admit Notification Message Bundle 02 for how this is implemented.

Examples

For examples of this profile within a bundle, see these message Bundles examples:

• Admit Notification Intermediate Translate Bundle
• Admit Notification Intermediate Transmit Bundle
• Admit Notification Message Bundle 01
• Transfer Notification Message Bundle

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from MessageHeader

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	A resource that describes a message that is exchanged between systems
id	S	1..1	id	Logical id of this artifact
eventCoding	S	1..1	Coding	Code for the event this message represents or link to event definition Binding: Da Vinci Notification Event ValueSet (extensible)
destination	S	0..1	BackboneElement	Message destination application(s)
endpoint	S	1..1	url	Actual destination address or id
sender	S	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile | HRex Organization Profile) {b}	Real world sender of the message
Slices for extension				Content/Rules for all slices
Device	S	0..1	(Complex)	Device as a sender URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
value[x]	S	1..1	Reference(Device) {b}	Value of extension
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
author	S	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile) {b}	The source of the decision
Slices for extension				Content/Rules for all slices
Device	S	0..1	(Complex)	Device as a author URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
value[x]	S	1..1	Reference(Device) {b}	Value of extension
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
source	S	1..1	BackboneElement	Message source application
responsible	S	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile | HRex Organization Profile) {b}	Final responsibility for event
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
response		0..0
focus	S	1..*	Reference(Resource) {b}	The actual content of the message
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
MessageHeader.eventCoding	extensible	NotificationEventValueSet (a valid code from Da Vinci Event CodeSystem Notification) http://hl7.org/fhir/us/davinci-alerts/ValueSet/notification-event from this IG

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
id	SΣ	1..1	id	Logical id of this artifact
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: Da Vinci Notification Event ValueSet (extensible) ele-1: All FHIR elements must have a @value or children
destination	SΣ	0..1	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	SΣ	1..1	url	Actual destination address or id ele-1: All FHIR elements must have a @value or children
sender	SΣ	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile | HRex Organization Profile) {b}	Real world sender of the message ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
Device	S	0..1	(Complex)	Device as a sender URL: http://hl7.org/fhir/StructureDefinition/alternate-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/alternate-reference"
value[x]	S	1..1	Reference(Device) {b}	Value of extension ele-1: All FHIR elements must have a @value or children
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
author	SΣ	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile) {b}	The source of the decision ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
Device	S	0..1	(Complex)	Device as a author URL: http://hl7.org/fhir/StructureDefinition/alternate-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/alternate-reference"
value[x]	S	1..1	Reference(Device) {b}	Value of extension ele-1: All FHIR elements must have a @value or children
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
source	SΣ	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
responsible	SΣ	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile | HRex Organization Profile) {b}	Final responsibility for event ele-1: All FHIR elements must have a @value or children
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
focus	SΣ	1..*	Reference(Resource) {b}	The actual content of the message ele-1: All FHIR elements must have a @value or children
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL 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	extensible	NotificationEventValueSet (a valid code from Da Vinci Event CodeSystem Notification) http://hl7.org/fhir/us/davinci-alerts/ValueSet/notification-event from this IG
MessageHeader.response.code	required	ResponseType http://hl7.org/fhir/ValueSet/response-code|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MessageHeader	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MessageHeader	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	MessageHeader	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	MessageHeader	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MessageHeader	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	A resource that describes a message that is exchanged between systems
id	SΣ	1..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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: Da Vinci Notification Event ValueSet (extensible)
destination	SΣ	0..1	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	SΣ	1..1	url	Actual destination address or id
receiver	Σ	0..1	Reference(Practitioner | PractitionerRole | Organization)	Intended "real-world" recipient for the data
sender	SΣ	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile | HRex Organization Profile) {b}	Real world sender of the message
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Device	S	0..1	(Complex)	Device as a sender URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/alternate-reference"
value[x]	S	1..1	Reference(Device) {b}	Value of extension
reference	SΣ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	Σ	0..1	Identifier	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	SΣ	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile) {b}	The source of the decision
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Device	S	0..1	(Complex)	Device as a author URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/alternate-reference"
value[x]	S	1..1	Reference(Device) {b}	Value of extension
reference	SΣ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	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
source	SΣ	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	SΣ	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile | HRex Organization Profile) {b}	Final responsibility for event
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	SΣC	1..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	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
reason	Σ	0..1	CodeableConcept	Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.
focus	SΣ	1..*	Reference(Resource) {b}	The actual content 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	SΣC	1..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	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
definition	Σ	0..1	canonical(MessageDefinition)	Link to the definition for this message
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
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	extensible	NotificationEventValueSet (a valid code from Da Vinci Event CodeSystem Notification) http://hl7.org/fhir/us/davinci-alerts/ValueSet/notification-event from this IG
MessageHeader.sender.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
MessageHeader.author.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
MessageHeader.responsible.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
MessageHeader.focus.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MessageHeader	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MessageHeader	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	MessageHeader	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	MessageHeader	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MessageHeader	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from MessageHeader

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	A resource that describes a message that is exchanged between systems
id	S	1..1	id	Logical id of this artifact
eventCoding	S	1..1	Coding	Code for the event this message represents or link to event definition Binding: Da Vinci Notification Event ValueSet (extensible)
destination	S	0..1	BackboneElement	Message destination application(s)
endpoint	S	1..1	url	Actual destination address or id
sender	S	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile | HRex Organization Profile) {b}	Real world sender of the message
Slices for extension				Content/Rules for all slices
Device	S	0..1	(Complex)	Device as a sender URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
value[x]	S	1..1	Reference(Device) {b}	Value of extension
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
author	S	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile) {b}	The source of the decision
Slices for extension				Content/Rules for all slices
Device	S	0..1	(Complex)	Device as a author URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
value[x]	S	1..1	Reference(Device) {b}	Value of extension
reference	S	0..1	string	Literal reference, Relative, internal or absolute URL
source	S	1..1	BackboneElement	Message source application
responsible	S	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile | HRex Organization Profile) {b}	Final responsibility for event
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
response		0..0
focus	S	1..*	Reference(Resource) {b}	The actual content of the message
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
MessageHeader.eventCoding	extensible	NotificationEventValueSet (a valid code from Da Vinci Event CodeSystem Notification) http://hl7.org/fhir/us/davinci-alerts/ValueSet/notification-event from this IG

Key Elements View

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
id	SΣ	1..1	id	Logical id of this artifact
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: Da Vinci Notification Event ValueSet (extensible) ele-1: All FHIR elements must have a @value or children
destination	SΣ	0..1	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	SΣ	1..1	url	Actual destination address or id ele-1: All FHIR elements must have a @value or children
sender	SΣ	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile | HRex Organization Profile) {b}	Real world sender of the message ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
Device	S	0..1	(Complex)	Device as a sender URL: http://hl7.org/fhir/StructureDefinition/alternate-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/alternate-reference"
value[x]	S	1..1	Reference(Device) {b}	Value of extension ele-1: All FHIR elements must have a @value or children
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
author	SΣ	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile) {b}	The source of the decision ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
Device	S	0..1	(Complex)	Device as a author URL: http://hl7.org/fhir/StructureDefinition/alternate-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/alternate-reference"
value[x]	S	1..1	Reference(Device) {b}	Value of extension ele-1: All FHIR elements must have a @value or children
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
source	SΣ	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
responsible	SΣ	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile | HRex Organization Profile) {b}	Final responsibility for event ele-1: All FHIR elements must have a @value or children
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
focus	SΣ	1..*	Reference(Resource) {b}	The actual content of the message ele-1: All FHIR elements must have a @value or children
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL 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	extensible	NotificationEventValueSet (a valid code from Da Vinci Event CodeSystem Notification) http://hl7.org/fhir/us/davinci-alerts/ValueSet/notification-event from this IG
MessageHeader.response.code	required	ResponseType http://hl7.org/fhir/ValueSet/response-code|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MessageHeader	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MessageHeader	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	MessageHeader	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	MessageHeader	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MessageHeader	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	A resource that describes a message that is exchanged between systems
id	SΣ	1..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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: Da Vinci Notification Event ValueSet (extensible)
destination	SΣ	0..1	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	SΣ	1..1	url	Actual destination address or id
receiver	Σ	0..1	Reference(Practitioner | PractitionerRole | Organization)	Intended "real-world" recipient for the data
sender	SΣ	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile | HRex Organization Profile) {b}	Real world sender of the message
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Device	S	0..1	(Complex)	Device as a sender URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/alternate-reference"
value[x]	S	1..1	Reference(Device) {b}	Value of extension
reference	SΣ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	Σ	0..1	Identifier	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	SΣ	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile) {b}	The source of the decision
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Device	S	0..1	(Complex)	Device as a author URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/alternate-reference"
value[x]	S	1..1	Reference(Device) {b}	Value of extension
reference	SΣ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	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
source	SΣ	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	SΣ	0..1	Reference(US Core Practitioner Profile(3.1.1) | US Core Practitioner Profile(6.1.0) | US Core Practitioner Profile(7.0.0) | HRex PractitionerRole Profile | HRex Organization Profile) {b}	Final responsibility for event
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	SΣC	1..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	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
reason	Σ	0..1	CodeableConcept	Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.
focus	SΣ	1..*	Reference(Resource) {b}	The actual content 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	SΣC	1..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	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
definition	Σ	0..1	canonical(MessageDefinition)	Link to the definition for this message
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
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	extensible	NotificationEventValueSet (a valid code from Da Vinci Event CodeSystem Notification) http://hl7.org/fhir/us/davinci-alerts/ValueSet/notification-event from this IG
MessageHeader.sender.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
MessageHeader.author.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
MessageHeader.responsible.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
MessageHeader.focus.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MessageHeader	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MessageHeader	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	MessageHeader	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	MessageHeader	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MessageHeader	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from MessageHeader

Summary

Mandatory: 4 elements(4 nested mandatory elements)
Must-Support: 17 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

• US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|3.1.1)
• US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|6.1.0)
• US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner|7.0.0)
• HRex PractitionerRole Profile (http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-practitionerrole)
• HRex Organization Profile (http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-organization)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/alternate-reference

Maturity: 2