HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/case-reporting/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: US Public Health MessageHeader

This is the MessageHeader Resource profile for the IG.

Usage:

• Derived from this Resource Profile: eCR MessageHeader
• Use this Resource Profile: US Public Health Reporting Bundle

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

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

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	US Public Health MessageHeader 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
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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:dataEncrypted	S	0..1	boolean	US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-data-encrypted-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:messageProcessingCategory	S	1..1	code	US Public Health Message Processing Category Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-message-processing-category-extension Binding: MessageSignificanceCategory (required): MessageSignificanceCategory ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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
event[x]	SΣ	1..1	Coding	Types of messages being sent between systems Binding: US Public Health Message Types ValueSet (extensible): US Public Health Message Types ValueSet ele-1: All FHIR elements must have a @value or children
destination	SΣ	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Σ	1..1	Reference(US Public Health Organization)	Real world sender of the message 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	SΣ	1..1	url	Actual message source address or id ele-1: All FHIR elements must have a @value or children
reason	SΣ	1..1	CodeableConcept	The named event that gave rise to the message Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents ele-1: All FHIR elements must have a @value or children
response	SΣ	0..1	BackboneElement	If this is a reply to prior message 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
details	SΣ	0..1	Reference(OperationOutcome)	Specific list of hints/warnings/errors ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
MessageHeader.event[x]	extensible	USPublicHealthMessageTypesValueSet (a valid code from US Public Health Message Types CodeSystem) http://hl7.org/fhir/us/ecr/ValueSet/us-ph-message-types-valueset from this IG
MessageHeader.reason	extensible	USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition NamedEvents) http://hl7.org/fhir/us/ecr/ValueSet/us-ph-triggerdefinition-namedevent 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()

This structure is derived from MessageHeader

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	US Public Health MessageHeader
Slices for extension				Content/Rules for all slices
extension:dataEncrypted	S	0..1	boolean	US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-data-encrypted-extension
extension:messageProcessingCategory	S	1..1	code	US Public Health Message Processing Category Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-message-processing-category-extension Binding: MessageSignificanceCategory (required): MessageSignificanceCategory
event[x]	S	1..1	Coding	Types of messages being sent between systems Binding: US Public Health Message Types ValueSet (extensible): US Public Health Message Types ValueSet
destination	S	1..*	BackboneElement	Message destination application(s)
endpoint	S	1..1	url	Actual destination address or id
sender	S	1..1	Reference(US Public Health Organization)	Real world sender of the message
source	S	1..1	BackboneElement	Message source application
endpoint	S	1..1	url	Actual message source address or id
reason	S	1..1	CodeableConcept	The named event that gave rise to the message Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
response	S	0..1	BackboneElement	If this is a reply to prior message
identifier	S	1..1	id	Id of original message
code	S	1..1	code	ok | transient-error | fatal-error
details	S	0..1	Reference(OperationOutcome)	Specific list of hints/warnings/errors
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
MessageHeader.event[x]	extensible	USPublicHealthMessageTypesValueSet (a valid code from US Public Health Message Types CodeSystem) http://hl7.org/fhir/us/ecr/ValueSet/us-ph-message-types-valueset from this IG
MessageHeader.reason	extensible	USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition NamedEvents) http://hl7.org/fhir/us/ecr/ValueSet/us-ph-triggerdefinition-namedevent from this IG

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	US Public Health MessageHeader
id	Σ	0..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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dataEncrypted	S	0..1	boolean	US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-data-encrypted-extension
extension:messageProcessingCategory	S	1..1	code	US Public Health Message Processing Category Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-message-processing-category-extension Binding: MessageSignificanceCategory (required): MessageSignificanceCategory
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
event[x]	SΣ	1..1	Coding	Types of messages being sent between systems Binding: US Public Health Message Types ValueSet (extensible): US Public Health Message Types ValueSet
destination	SΣ	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Σ	1..1	Reference(US Public Health Organization)	Real world sender of the message
enterer	Σ	0..1	Reference(Practitioner | PractitionerRole)	The source of the data entry
author	Σ	0..1	Reference(Practitioner | PractitionerRole)	The source of the decision
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	SΣ	1..1	url	Actual message source address or id
responsible	Σ	0..1	Reference(Practitioner | PractitionerRole | Organization)	Final responsibility for event
reason	SΣ	1..1	CodeableConcept	The named event that gave rise to the message Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
response	SΣ	0..1	BackboneElement	If this is a reply to prior message
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	SΣ	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.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
MessageHeader.event[x]	extensible	USPublicHealthMessageTypesValueSet (a valid code from US Public Health Message Types CodeSystem) http://hl7.org/fhir/us/ecr/ValueSet/us-ph-message-types-valueset from this IG
MessageHeader.reason	extensible	USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition NamedEvents) http://hl7.org/fhir/us/ecr/ValueSet/us-ph-triggerdefinition-namedevent 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()

This structure is derived from MessageHeader

Summary

Mandatory: 8 elements(2 nested mandatory elements)
Must-Support: 13 elements

Structures

This structure refers to these other structures:

• US Public Health Organization (http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-organization)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-data-encrypted-extension
• http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-message-processing-category-extension

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	US Public Health MessageHeader 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
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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:dataEncrypted	S	0..1	boolean	US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-data-encrypted-extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:messageProcessingCategory	S	1..1	code	US Public Health Message Processing Category Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-message-processing-category-extension Binding: MessageSignificanceCategory (required): MessageSignificanceCategory ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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
event[x]	SΣ	1..1	Coding	Types of messages being sent between systems Binding: US Public Health Message Types ValueSet (extensible): US Public Health Message Types ValueSet ele-1: All FHIR elements must have a @value or children
destination	SΣ	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Σ	1..1	Reference(US Public Health Organization)	Real world sender of the message 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	SΣ	1..1	url	Actual message source address or id ele-1: All FHIR elements must have a @value or children
reason	SΣ	1..1	CodeableConcept	The named event that gave rise to the message Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents ele-1: All FHIR elements must have a @value or children
response	SΣ	0..1	BackboneElement	If this is a reply to prior message 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
details	SΣ	0..1	Reference(OperationOutcome)	Specific list of hints/warnings/errors ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
MessageHeader.event[x]	extensible	USPublicHealthMessageTypesValueSet (a valid code from US Public Health Message Types CodeSystem) http://hl7.org/fhir/us/ecr/ValueSet/us-ph-message-types-valueset from this IG
MessageHeader.reason	extensible	USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition NamedEvents) http://hl7.org/fhir/us/ecr/ValueSet/us-ph-triggerdefinition-namedevent 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()

Differential View

This structure is derived from MessageHeader

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	US Public Health MessageHeader
Slices for extension				Content/Rules for all slices
extension:dataEncrypted	S	0..1	boolean	US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-data-encrypted-extension
extension:messageProcessingCategory	S	1..1	code	US Public Health Message Processing Category Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-message-processing-category-extension Binding: MessageSignificanceCategory (required): MessageSignificanceCategory
event[x]	S	1..1	Coding	Types of messages being sent between systems Binding: US Public Health Message Types ValueSet (extensible): US Public Health Message Types ValueSet
destination	S	1..*	BackboneElement	Message destination application(s)
endpoint	S	1..1	url	Actual destination address or id
sender	S	1..1	Reference(US Public Health Organization)	Real world sender of the message
source	S	1..1	BackboneElement	Message source application
endpoint	S	1..1	url	Actual message source address or id
reason	S	1..1	CodeableConcept	The named event that gave rise to the message Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
response	S	0..1	BackboneElement	If this is a reply to prior message
identifier	S	1..1	id	Id of original message
code	S	1..1	code	ok | transient-error | fatal-error
details	S	0..1	Reference(OperationOutcome)	Specific list of hints/warnings/errors
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
MessageHeader.event[x]	extensible	USPublicHealthMessageTypesValueSet (a valid code from US Public Health Message Types CodeSystem) http://hl7.org/fhir/us/ecr/ValueSet/us-ph-message-types-valueset from this IG
MessageHeader.reason	extensible	USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition NamedEvents) http://hl7.org/fhir/us/ecr/ValueSet/us-ph-triggerdefinition-namedevent from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	US Public Health MessageHeader
id	Σ	0..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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dataEncrypted	S	0..1	boolean	US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-data-encrypted-extension
extension:messageProcessingCategory	S	1..1	code	US Public Health Message Processing Category Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-message-processing-category-extension Binding: MessageSignificanceCategory (required): MessageSignificanceCategory
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
event[x]	SΣ	1..1	Coding	Types of messages being sent between systems Binding: US Public Health Message Types ValueSet (extensible): US Public Health Message Types ValueSet
destination	SΣ	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Σ	1..1	Reference(US Public Health Organization)	Real world sender of the message
enterer	Σ	0..1	Reference(Practitioner | PractitionerRole)	The source of the data entry
author	Σ	0..1	Reference(Practitioner | PractitionerRole)	The source of the decision
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	SΣ	1..1	url	Actual message source address or id
responsible	Σ	0..1	Reference(Practitioner | PractitionerRole | Organization)	Final responsibility for event
reason	SΣ	1..1	CodeableConcept	The named event that gave rise to the message Binding: US Public Health TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents
response	SΣ	0..1	BackboneElement	If this is a reply to prior message
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	SΣ	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.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
MessageHeader.event[x]	extensible	USPublicHealthMessageTypesValueSet (a valid code from US Public Health Message Types CodeSystem) http://hl7.org/fhir/us/ecr/ValueSet/us-ph-message-types-valueset from this IG
MessageHeader.reason	extensible	USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition NamedEvents) http://hl7.org/fhir/us/ecr/ValueSet/us-ph-triggerdefinition-namedevent 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()

This structure is derived from MessageHeader

Summary

Mandatory: 8 elements(2 nested mandatory elements)
Must-Support: 13 elements

Structures

This structure refers to these other structures:

• US Public Health Organization (http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-organization)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-data-encrypted-extension
• http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-message-processing-category-extension

Other representations of profile: CSV, Excel, Schematron