HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.1 - STU 2.1.1
HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
2.1.1 - STU 2.1.1
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.1 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: 2.1.1 | |||
| Active as of 2023-12-14 | Computable Name: Ecr_MessageHeader | |||
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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USPublicHealthMessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MessageHeader | 0..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |
  source | 1..1 | BackboneElement | Message source application | |
  name | S | 0..1 | string | Name of system |
 contact | S | 0..1 | ContactPoint | Human contact for problems |
 focus | S | 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 |
|---|---|---|---|---|
| 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 | |
 dataEncrypted | S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-data-encrypted-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) |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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 |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | SΣ | 0..1 | string | Name of system |
| contact | SΣ | 0..1 | ContactPoint | Human contact for problems |
| 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 |
| 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(eICR Document Bundle | RR Document Bundle) | The actual content of the message |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MessageHeader.event[x] | extensible | USPublicHealthMessageTypesValueSet (a valid code from US Public Health Message Types CodeSystem) |
| MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition NamedEvents) |
| MessageHeader.response.code | required | ResponseType |
| 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..* | 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| dataEncrypted | S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-data-encrypted-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 | SΣ | 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 | SΣ | 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 | SΣ | 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 | Conformance | ValueSet | ||||
| MessageHeader.language | preferred | CommonLanguages
| ||||
| MessageHeader.event[x] | extensible | USPublicHealthMessageTypesValueSet (a valid code from US Public Health Message Types CodeSystem) | ||||
| MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition NamedEvents) | ||||
| MessageHeader.response.code | required | ResponseType |
| 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 USPublicHealthMessageHeader
Differential View
This structure is derived from USPublicHealthMessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | USPublicHealthMessageHeader | US Public Health MessageHeader | |
| source | 1..1 | BackboneElement | Message source application | |
| name | S | 0..1 | string | Name of system |
| contact | S | 0..1 | ContactPoint | Human contact for problems |
| focus | S | 1..1 | Reference(eICR Document Bundle | RR Document Bundle) | 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 |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| dataEncrypted | S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-data-encrypted-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) |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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 |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | SΣ | 0..1 | string | Name of system |
| contact | SΣ | 0..1 | ContactPoint | Human contact for problems |
| 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 |
| 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(eICR Document Bundle | RR Document Bundle) | The actual content of the message |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MessageHeader.event[x] | extensible | USPublicHealthMessageTypesValueSet (a valid code from US Public Health Message Types CodeSystem) |
| MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition NamedEvents) |
| MessageHeader.response.code | required | ResponseType |
| 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..* | 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| dataEncrypted | S | 0..1 | boolean | US Public Health Data Encrypted Extension URL: http://hl7.org/fhir/us/ecr/StructureDefinition/us-ph-data-encrypted-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 | SΣ | 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 | SΣ | 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 | SΣ | 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 | Conformance | ValueSet | ||||
| MessageHeader.language | preferred | CommonLanguages
| ||||
| MessageHeader.event[x] | extensible | USPublicHealthMessageTypesValueSet (a valid code from US Public Health Message Types CodeSystem) | ||||
| MessageHeader.reason | extensible | USPublicHealthTriggerDefinitionNamedEvent (a valid code from US Public Health TriggerDefinition NamedEvents) | ||||
| MessageHeader.response.code | required | ResponseType |
| 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 USPublicHealthMessageHeader
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Public Health. Package hl7.fhir.us.ecr#2.1.1 based on FHIR 4.0.1. Generated 2023-12-14
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change