HL7 FHIR Implementation Guide: Profiles for Transfusion and Vaccination Adverse Event Detection and Reporting, published by Biomedical Research & Regulation WG. This is not an authorized publication; it is the continuous build for version 1.0.1). This version is based on the current content of https://github.com/HL7/fhir-icsr-ae-reporting/ and changes regularly. See the Directory of published versions

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

Resource Profile: ICSR MessageHeader

The fields needed to create a MessageHeader for an ICSR Report.

Usage:

• Use this Resource Profile: ICSR Bundle
• Examples for this Resource Profile: MessageHeader/US-IBM-Transfusion-fad94c04-29e7-5b37-e535-a8aad123cf9a, MessageHeader/US-IBM-Vaccination-fad94c04-29e7-5b37-e535-a8aad123cf9a, MessageHeader/US-IBM-e380bc14-2a03-7b64-c3f5-22daea2aa495 and MessageHeader/beafb541-3eab-eb9e-1bf1-5fa477d56e77

Formal Views of Profile Content

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

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

This structure is derived from USPublicHealthMessageHeader

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	USPublicHealthMessageHeader	US Public Health MessageHeader
destination
receiver	S	0..1	Reference(MessageHeader Organization)	Intended "real-world" recipient for the data
sender		1..1	Reference(MessageHeader Organization)	Real world sender of the message
focus	S	1..1	Reference(ICSR Composition)	The actual content of the message
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	USPublicHealthMessageHeader	US Public Health MessageHeader
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
dataEncrypted	S	0..1	boolean	Indicates whether the data in the content bundle is encrypted or not URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-dataEncrypted
messageProcessingCategory	S	1..1	code	Indicates how messages should be processed URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-messageProcessingCategory Binding: MessageSignificanceCategory (required): The message processing requirements identified by the message
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
event[x]	SΣ	1..1	Coding	Code for the event this message represents or link to event definition Binding: US Public Health Message Types (extensible): Types of messages being sent between systems
destination	SΣ	1..*	BackboneElement	Message destination application(s)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
endpoint	SΣ	1..1	url	Actual destination address or id
receiver	SΣ	0..1	Reference(MessageHeader Organization)	Intended "real-world" recipient for the data
sender	SΣ	1..1	Reference(MessageHeader Organization)	Real world sender of the message
source	SΣ	1..1	BackboneElement	Message source application
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
endpoint	SΣ	1..1	url	Actual message source address or id
reason	SΣ	1..1	CodeableConcept	Cause of event Binding: US Public Health TriggerDefinition NamedEvent (extensible): The named event that gave rise to the message
response	SΣ	0..1	BackboneElement	If this is a reply to prior message
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	SΣ	1..1	Reference(ICSR Composition)	The actual content of the message
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
MessageHeader.event[x]	extensible	USPublicHealthMessageTypes
MessageHeader.reason	extensible	USPublicHealthTriggerDefinitionNamedEvent
MessageHeader.response.code	required	ResponseType

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	USPublicHealthMessageHeader	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		0..*	Extension	Extension Slice: Unordered, Open by value:url
dataEncrypted	S	0..1	boolean	Indicates whether the data in the content bundle is encrypted or not URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-dataEncrypted
messageProcessingCategory	S	1..1	code	Indicates how messages should be processed URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-messageProcessingCategory Binding: MessageSignificanceCategory (required): The message processing requirements identified by the message
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
event[x]	SΣ	1..1	Coding	Code for the event this message represents or link to event definition Binding: US Public Health Message Types (extensible): Types of messages being sent between systems
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	SΣ	0..1	Reference(MessageHeader Organization)	Intended "real-world" recipient for the data
sender	SΣ	1..1	Reference(MessageHeader 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	Cause of event Binding: US Public Health TriggerDefinition NamedEvent (extensible): The named event that gave rise to the message
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	SΣ	1..1	Reference(ICSR Composition)	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
MessageHeader.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
MessageHeader.event[x]	extensible	USPublicHealthMessageTypes
MessageHeader.reason	extensible	USPublicHealthTriggerDefinitionNamedEvent
MessageHeader.response.code	required	ResponseType

This structure is derived from USPublicHealthMessageHeader

Summary

Mandatory: 1 element
Must-Support: 2 elements

Structures

This structure refers to these other structures:

• MessageHeader Organization (http://hl7.org/fhir/us/icsr-ae-reporting/StructureDefinition/icsr-messageorganization)
• ICSR Composition (http://hl7.org/fhir/us/icsr-ae-reporting/StructureDefinition/icsr-composition)

Differential View

This structure is derived from USPublicHealthMessageHeader

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	USPublicHealthMessageHeader	US Public Health MessageHeader
destination
receiver	S	0..1	Reference(MessageHeader Organization)	Intended "real-world" recipient for the data
sender		1..1	Reference(MessageHeader Organization)	Real world sender of the message
focus	S	1..1	Reference(ICSR Composition)	The actual content of the message
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	USPublicHealthMessageHeader	US Public Health MessageHeader
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
dataEncrypted	S	0..1	boolean	Indicates whether the data in the content bundle is encrypted or not URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-dataEncrypted
messageProcessingCategory	S	1..1	code	Indicates how messages should be processed URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-messageProcessingCategory Binding: MessageSignificanceCategory (required): The message processing requirements identified by the message
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
event[x]	SΣ	1..1	Coding	Code for the event this message represents or link to event definition Binding: US Public Health Message Types (extensible): Types of messages being sent between systems
destination	SΣ	1..*	BackboneElement	Message destination application(s)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
endpoint	SΣ	1..1	url	Actual destination address or id
receiver	SΣ	0..1	Reference(MessageHeader Organization)	Intended "real-world" recipient for the data
sender	SΣ	1..1	Reference(MessageHeader Organization)	Real world sender of the message
source	SΣ	1..1	BackboneElement	Message source application
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
endpoint	SΣ	1..1	url	Actual message source address or id
reason	SΣ	1..1	CodeableConcept	Cause of event Binding: US Public Health TriggerDefinition NamedEvent (extensible): The named event that gave rise to the message
response	SΣ	0..1	BackboneElement	If this is a reply to prior message
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	SΣ	1..1	Reference(ICSR Composition)	The actual content of the message
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
MessageHeader.event[x]	extensible	USPublicHealthMessageTypes
MessageHeader.reason	extensible	USPublicHealthTriggerDefinitionNamedEvent
MessageHeader.response.code	required	ResponseType

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	USPublicHealthMessageHeader	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		0..*	Extension	Extension Slice: Unordered, Open by value:url
dataEncrypted	S	0..1	boolean	Indicates whether the data in the content bundle is encrypted or not URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-dataEncrypted
messageProcessingCategory	S	1..1	code	Indicates how messages should be processed URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/ext-messageProcessingCategory Binding: MessageSignificanceCategory (required): The message processing requirements identified by the message
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
event[x]	SΣ	1..1	Coding	Code for the event this message represents or link to event definition Binding: US Public Health Message Types (extensible): Types of messages being sent between systems
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	SΣ	0..1	Reference(MessageHeader Organization)	Intended "real-world" recipient for the data
sender	SΣ	1..1	Reference(MessageHeader 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	Cause of event Binding: US Public Health TriggerDefinition NamedEvent (extensible): The named event that gave rise to the message
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	SΣ	1..1	Reference(ICSR Composition)	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
MessageHeader.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
MessageHeader.event[x]	extensible	USPublicHealthMessageTypes
MessageHeader.reason	extensible	USPublicHealthTriggerDefinitionNamedEvent
MessageHeader.response.code	required	ResponseType

This structure is derived from USPublicHealthMessageHeader

Summary

Mandatory: 1 element
Must-Support: 2 elements

Structures

This structure refers to these other structures:

• MessageHeader Organization (http://hl7.org/fhir/us/icsr-ae-reporting/StructureDefinition/icsr-messageorganization)
• ICSR Composition (http://hl7.org/fhir/us/icsr-ae-reporting/StructureDefinition/icsr-composition)

Other representations of profile: CSV, Excel, Schematron