HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
1.1.0 - STU 2 Ballot
HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR) - US Realm
1.1.0 - STU 2 Ballot
This page is part of the electronic Case Reporting (eCR) (v1.1.0: STU 2 on FHIR R4 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-messageheader |
| Version: | 1.1.0 |
| Name: | Ecr_MessageHeader |
| Title: | eCR MessageHeader |
| Status: | Active as of 2020-12-16T19:27:50+00:00 |
| Definition: | This MessageHeader profile represents metadata to support the eCR messaging paradigm. |
| Publisher: | HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm) |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-messageheader
It requires data elements destination, sender, source, and focus. The focus of an eCR MessageHeader profile is the eCR Task profile.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MessageHeader
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
  event[x] | S | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: eCR MessageHeader Event Value Set (extensible) |
 destination | S | 1..1 | BackboneElement | Message destination application(s) |
| sender | S | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message |
 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(eCR Task) | The actual content of the message |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
 id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| event[x] | SΣ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: eCR MessageHeader Event Value Set (extensible) |
| destination | SΣ | 1..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 | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | 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 | 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 | Σ | 1..1 | url | Actual message source address or id |
| responsible | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event |
| reason | Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. |
| 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 | SΣ | 1..1 | Reference(eCR Task) | The actual content of the message |
| definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
| event[x] | Σ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: eCR MessageHeader Event Value Set (extensible) |
| destination | Σ | 1..1 | BackboneElement | Message destination application(s) |
| sender | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message |
| source | Σ | 1..1 | BackboneElement | Message source application |
| name | Σ | 0..1 | string | Name of system |
| contact | Σ | 0..1 | ContactPoint | Human contact for problems |
| focus | Σ | 1..1 | Reference(eCR Task) | The actual content of the message |
| Documentation for this format | ||||
This structure is derived from MessageHeader
Differential View
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
| event[x] | S | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: eCR MessageHeader Event Value Set (extensible) |
| destination | S | 1..1 | BackboneElement | Message destination application(s) |
| sender | S | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message |
| 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(eCR Task) | The actual content of the message |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| event[x] | SΣ | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: eCR MessageHeader Event Value Set (extensible) |
| destination | SΣ | 1..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 | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | 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 | 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 | Σ | 1..1 | url | Actual message source address or id |
| responsible | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event |
| reason | Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. |
| 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 | SΣ | 1..1 | Reference(eCR Task) | The actual content of the message |
| definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet |
| MessageHeader.language | preferred | CommonLanguages Max Binding: AllLanguages |
| MessageHeader.event[x] | extensible | ValueSet_Ecr_MessageHeader_Event |
| MessageHeader.reason | example | ExampleMessageReasonCodes |
| MessageHeader.response.code | required | ResponseType |
| Id | Path | Details | Requirements |
| dom-2 | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | 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 | 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 | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | MessageHeader.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.event[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.destination | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.destination.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.destination.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.destination.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.destination.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.destination.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.destination.target | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.destination.endpoint | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.destination.receiver | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.sender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.enterer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.source.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.source.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.source.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.source.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source.software | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.source.endpoint | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.responsible | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.reason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.response | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.response.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.response.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.response.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | MessageHeader.response.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | MessageHeader.response.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.response.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.response.details | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.focus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | MessageHeader.definition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm). Package hl7.fhir.us.ecr#1.1.0 based on FHIR 4.0.1. Generated 2020-12-16
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change