This page is part of the electronic Case Reporting (eCR) (v1.0.0: STU 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
SD.4 StructureDefinition-ecr-messageheader
This MessageHeader profile represents metadata to support the eCR messaging paradigm. It requires data elements destination, sender, source, and focus. The focus of an eCR MessageHeader profile is the eCR Task profile.
SD.4.1 Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-messageheader
Published on Wed Jan 29 20:30:08 UTC 2020 as a active by HL7 Public Health Work Group.
This profile builds on MessageHeader
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | 0..* | MessageHeader | ||
event[x] | S | 1..1 | Coding | Binding: eCR MessageHeader Event Value Set (extensible) |
destination | S | 1..1 | BackboneElement | |
sender | S | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | |
source | 1..1 | BackboneElement | ||
name | S | 0..1 | string | |
contact | S | 0..1 | ContactPoint | |
focus | S | 1..1 | Reference(eCR Task) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | I | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
event[x] | SΣI | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: eCR MessageHeader Event Value Set (extensible) |
destination | SΣI | 1..1 | BackboneElement | Message destination application(s) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | ΣI | 0..1 | string | Name of system |
target | ΣI | 0..1 | Reference(Device) | Particular delivery destination within the destination |
endpoint | ΣI | 1..1 | url | Actual destination address or id |
receiver | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data |
sender | SΣI | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message |
enterer | ΣI | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry |
author | ΣI | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision |
source | ΣI | 1..1 | BackboneElement | Message source application |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣI | 0..1 | string | Name of system |
software | ΣI | 0..1 | string | Name of software running the system |
version | ΣI | 0..1 | string | Version of software running |
contact | SΣI | 0..1 | ContactPoint | Human contact for problems |
endpoint | ΣI | 1..1 | url | Actual message source address or id |
responsible | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event |
reason | ΣI | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example) |
response | ΣI | 0..1 | BackboneElement | If this is a reply to prior message |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | ΣI | 1..1 | id | Id of original message |
code | ΣI | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required) |
details | ΣI | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors |
focus | SΣI | 1..1 | Reference(eCR Task) | The actual content of the message |
definition | ΣI | 0..1 | canonical(MessageDefinition) | Link to the definition for this message |
Documentation for this format |
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | 0..* | MessageHeader | ||
event[x] | S | 1..1 | Coding | Binding: eCR MessageHeader Event Value Set (extensible) |
destination | S | 1..1 | BackboneElement | |
sender | S | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | |
source | 1..1 | BackboneElement | ||
name | S | 0..1 | string | |
contact | S | 0..1 | ContactPoint | |
focus | S | 1..1 | Reference(eCR Task) | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | I | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
event[x] | SΣI | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: eCR MessageHeader Event Value Set (extensible) |
destination | SΣI | 1..1 | BackboneElement | Message destination application(s) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | ΣI | 0..1 | string | Name of system |
target | ΣI | 0..1 | Reference(Device) | Particular delivery destination within the destination |
endpoint | ΣI | 1..1 | url | Actual destination address or id |
receiver | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data |
sender | SΣI | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message |
enterer | ΣI | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry |
author | ΣI | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision |
source | ΣI | 1..1 | BackboneElement | Message source application |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣI | 0..1 | string | Name of system |
software | ΣI | 0..1 | string | Name of software running the system |
version | ΣI | 0..1 | string | Version of software running |
contact | SΣI | 0..1 | ContactPoint | Human contact for problems |
endpoint | ΣI | 1..1 | url | Actual message source address or id |
responsible | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event |
reason | ΣI | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example) |
response | ΣI | 0..1 | BackboneElement | If this is a reply to prior message |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | ΣI | 1..1 | id | Id of original message |
code | ΣI | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required) |
details | ΣI | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors |
focus | SΣI | 1..1 | Reference(eCR Task) | The actual content of the message |
definition | ΣI | 0..1 | canonical(MessageDefinition) | Link to the definition for this message |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron