Electronic Case Reporting (eCR)
3.0.0-ballot - STU 3 Ballot
Electronic Case Reporting (eCR)
3.0.0-ballot - STU 3 Ballot
Electronic Case Reporting (eCR), published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot 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
| Official URL: http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-messageheader | Version: 3.0.0-ballot | ||||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: ECRMessageHeader | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.46.42.1 | |||||
This MessageHeader profile represents metadata to support the eCR messaging paradigm.
This profile requires data elements destination, sender, source, and focus. The focus of an eCR MessageHeader profile is either an eICR Document Bundle or an RR Document Bundle.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  MessageHeader |
0..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:dataEncrypted |
0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension | |
 extension:messageProcessingCategory |
1..1 | code | US Public Health Message Processing Category Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension Binding: MessageSignificanceCategory (required): MessageSignificanceCategory | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 event[x] |
1..1 | Coding | Types of messages being sent between systems Binding: US Public Health ValueSet - Message Types (extensible): US Public Health Message Types ValueSet | |
| destination |
1..* | BackboneElement | Message destination application(s) | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 endpoint |
1..1 | url | Actual destination address or id | |
 sender |
1..1 | Reference(US Public Health Organization) | Real world sender of the message | |
| source |
1..1 | BackboneElement | Message source application | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| name |
0..1 | string | Name of system | |
| contact |
0..1 | ContactPoint | Human contact for problems | |
| endpoint |
1..1 | url | Actual message source address or id | |
| reason |
1..1 | CodeableConcept | The named event that gave rise to the message Binding: US Public Health ValueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents | |
| response |
0..1 | BackboneElement | If this is a reply to prior message | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| identifier |
1..1 | id | Id of original message | |
| code |
1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | |
| details |
0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | |
| focus |
1..1 | Reference(eICR Document Bundle | RR Document Bundle) | The actual content of the message | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageHeader.event[x] | Base | extensible | US Public Health ValueSet - Message Types | 📦2.0.0-snapshot | US Public Health Profiles Library v2.0 |
| MessageHeader.reason | Base | extensible | US Public Health ValueSet - TriggerDefinition NamedEvent | 📦2.0.0-snapshot | US Public Health Profiles Library v2.0 |
| MessageHeader.response.code | Base | required | ResponseType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 USPublicHealthMessageHeader
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageHeader |
0..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |
 source |
||||
| name |
0..1 | string | Name of system | |
| contact |
0..1 | ContactPoint | Human contact for problems | |
| focus |
1..1 | Reference(eICR Document Bundle | RR Document Bundle) | The actual content of the message | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:dataEncrypted |
0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension | |||||
| extension:messageProcessingCategory |
1..1 | code | US Public Health Message Processing Category Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension Binding: MessageSignificanceCategory (required): MessageSignificanceCategory | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| event[x] |
1..1 | Coding | Types of messages being sent between systems Binding: US Public Health ValueSet - Message Types (extensible): US Public Health Message Types ValueSet | |||||
| destination |
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 |
1..1 | url | Actual destination address or id | |||||
| receiver |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | |||||
| sender |
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 |
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 |
1..1 | CodeableConcept | The named event that gave rise to the message Binding: US Public Health ValueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents | |||||
| response |
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 |
1..1 | id | Id of original message | |||||
| code |
1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | |||||
| details |
0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | |||||
| focus |
1..1 | Reference(eICR Document Bundle | RR Document Bundle) | The actual content of the message | |||||
| definition |
0..1 | canonical(MessageDefinition) | Link to the definition for this message | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageHeader.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| MessageHeader.event[x] | Base | extensible | US Public Health ValueSet - Message Types | 📦2.0.0-snapshot | US Public Health Profiles Library v2.0 |
| MessageHeader.reason | Base | extensible | US Public Health ValueSet - TriggerDefinition NamedEvent | 📦2.0.0-snapshot | US Public Health Profiles Library v2.0 |
| MessageHeader.response.code | Base | required | ResponseType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 USPublicHealthMessageHeader
Summary
Mandatory: 1 element
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageHeader |
0..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:dataEncrypted |
0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension | |
| extension:messageProcessingCategory |
1..1 | code | US Public Health Message Processing Category Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension Binding: MessageSignificanceCategory (required): MessageSignificanceCategory | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| event[x] |
1..1 | Coding | Types of messages being sent between systems Binding: US Public Health ValueSet - Message Types (extensible): US Public Health Message Types ValueSet | |
| destination |
1..* | BackboneElement | Message destination application(s) | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| endpoint |
1..1 | url | Actual destination address or id | |
| sender |
1..1 | Reference(US Public Health Organization) | Real world sender of the message | |
| source |
1..1 | BackboneElement | Message source application | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| name |
0..1 | string | Name of system | |
| contact |
0..1 | ContactPoint | Human contact for problems | |
| endpoint |
1..1 | url | Actual message source address or id | |
| reason |
1..1 | CodeableConcept | The named event that gave rise to the message Binding: US Public Health ValueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents | |
| response |
0..1 | BackboneElement | If this is a reply to prior message | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| identifier |
1..1 | id | Id of original message | |
| code |
1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | |
| details |
0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | |
| focus |
1..1 | Reference(eICR Document Bundle | RR Document Bundle) | The actual content of the message | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageHeader.event[x] | Base | extensible | US Public Health ValueSet - Message Types | 📦2.0.0-snapshot | US Public Health Profiles Library v2.0 |
| MessageHeader.reason | Base | extensible | US Public Health ValueSet - TriggerDefinition NamedEvent | 📦2.0.0-snapshot | US Public Health Profiles Library v2.0 |
| MessageHeader.response.code | Base | required | ResponseType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 USPublicHealthMessageHeader
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageHeader |
0..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |
| source |
||||
| name |
0..1 | string | Name of system | |
| contact |
0..1 | ContactPoint | Human contact for problems | |
| focus |
1..1 | Reference(eICR Document Bundle | RR Document Bundle) | The actual content of the message | |
| Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:dataEncrypted |
0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension | |||||
| extension:messageProcessingCategory |
1..1 | code | US Public Health Message Processing Category Extension URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-message-processing-category-extension Binding: MessageSignificanceCategory (required): MessageSignificanceCategory | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| event[x] |
1..1 | Coding | Types of messages being sent between systems Binding: US Public Health ValueSet - Message Types (extensible): US Public Health Message Types ValueSet | |||||
| destination |
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 |
1..1 | url | Actual destination address or id | |||||
| receiver |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | |||||
| sender |
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 |
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 |
1..1 | CodeableConcept | The named event that gave rise to the message Binding: US Public Health ValueSet - TriggerDefinition NamedEvent (extensible): US Public Health TriggerDefinition NamedEvents | |||||
| response |
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 |
1..1 | id | Id of original message | |||||
| code |
1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | |||||
| details |
0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | |||||
| focus |
1..1 | Reference(eICR Document Bundle | RR Document Bundle) | The actual content of the message | |||||
| definition |
0..1 | canonical(MessageDefinition) | Link to the definition for this message | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageHeader.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| MessageHeader.event[x] | Base | extensible | US Public Health ValueSet - Message Types | 📦2.0.0-snapshot | US Public Health Profiles Library v2.0 |
| MessageHeader.reason | Base | extensible | US Public Health ValueSet - TriggerDefinition NamedEvent | 📦2.0.0-snapshot | US Public Health Profiles Library v2.0 |
| MessageHeader.response.code | Base | required | ResponseType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 USPublicHealthMessageHeader
Summary
Mandatory: 1 element
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 International / Public Health.
Package hl7.fhir.us.ecr#3.0.0-ballot based on FHIR 4.0.1.
Generated
2026-10-28
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change