Pan-Canadian eReferral-eConsult (CA:eReC)
DFT - The specification is currently in development and subject to change. For a full list of available versions, see the Directory of published versions
http://hl7.org/fhir/StructureDefinition/MessageHeader
The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
MessageHeader | C | MessageHeader | |
id | S Σ | 1..1 | string |
meta | S Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | C | 0..* | Extension |
versionId | Σ | 0..1 | id |
lastUpdated | Σ | 0..1 | instant |
source | Σ | 0..1 | uri |
profile | S Σ | 0..* | canonical(StructureDefinition) |
security | Σ | 0..* | CodingBinding |
tag | Σ | 0..* | Coding |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | C | 0..* | Extension |
RoutingOptions | C | 0..* | Extension(CodeableConcept) |
modifierExtension | ?! C | 0..* | Extension |
event[x] | S Σ | 1..1 | Binding |
eventCoding | Coding | ||
destination | S Σ | 1..* | BackboneElement |
id | 0..1 | string | |
extension | C | 0..* | Extension |
modifierExtension | Σ ?! C | 0..* | Extension |
name | Σ | 0..1 | string |
target | Σ | 0..1 | Reference(Device) |
endpoint | S Σ | 1..1 | url |
receiver | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) |
id | 0..1 | string | |
extension | C | 0..* | Extension |
reference | S Σ C | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | S Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | C | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | S Σ | 1..1 | uri |
value | S Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
display | Σ | 0..1 | string |
sender | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) |
id | 0..1 | string | |
extension | C | 0..* | Extension |
reference | S Σ C | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | S Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | C | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | S Σ | 1..1 | uri |
value | S Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
display | Σ | 0..1 | string |
enterer | Σ | 0..1 | Reference(PractitionerRole | Practitioner) |
id | 0..1 | string | |
extension | C | 0..* | Extension |
reference | S Σ C | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | S Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | C | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | S Σ | 1..1 | uri |
value | S Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
display | Σ | 0..1 | string |
author | S Σ | 0..1 | Reference(PractitionerRole) |
id | 0..1 | string | |
extension | C | 0..* | Extension |
reference | S Σ C | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | S Σ | 0..1 | Identifier |
id | 0..1 | string | |
extension | C | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | S Σ | 1..1 | uri |
value | S Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
display | Σ | 0..1 | string |
source | S Σ | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | C | 0..* | Extension |
modifierExtension | Σ ?! C | 0..* | Extension |
name | Σ | 0..1 | string |
software | Σ | 0..1 | string |
version | Σ | 0..1 | string |
contact | Σ | 0..1 | ContactPoint |
endpoint | S Σ | 1..1 | url |
responsible | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) |
reason | Σ | 0..1 | CodeableConceptBinding |
response | S Σ | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | C | 0..* | Extension |
modifierExtension | Σ ?! C | 0..* | Extension |
identifier | S Σ | 1..1 | id |
code | S Σ | 1..1 | codeBinding |
details | S Σ | 0..1 | Reference(OperationOutcome) |
focus | S Σ | 1..* | Reference(ServiceRequest | Task | Appointment | Communication) |
definition | Σ | 0..1 | canonical(MessageDefinition) |
MessageHeader | MessageHeader | ||
id | S | 1.. | |
meta | S | ||
profile | S | ||
extension | |||
RoutingOptions | Extension(CodeableConcept) | ||
event[x] | S | Binding | |
eventCoding | Coding | ||
destination | S | 1.. | |
endpoint | S | ||
receiver | Reference(Practitioner | PractitionerRole | Organization) | ||
reference | S | ||
identifier | S | ||
system | S | 1.. | |
value | S | 1.. | |
sender | Reference(Practitioner | PractitionerRole | Organization) | ||
reference | S | ||
identifier | S | ||
system | S | 1.. | |
value | S | 1.. | |
enterer | Reference(PractitionerRole | Practitioner) | ||
reference | S | ||
identifier | S | ||
system | S | 1.. | |
value | S | 1.. | |
author | S | 0.. | Reference(PractitionerRole) |
reference | S | ||
identifier | S | ||
system | S | 1.. | |
value | S | 1.. | |
source | S | ||
endpoint | S | ||
reason | Binding | ||
response | S | ||
identifier | S | ||
code | S | ||
details | S | ||
focus | S | 1.. | Reference(ServiceRequest | Task | Appointment | Communication) |
A MessageHeader resource with a unique id
and appropriate eventCoding
, source.endpoint
, destination.endpoint
and focus
SHALL be the first entry in each message Bundle (CA:eReC).
The MessageHeader is used to convey the purpose of the message (i.e., eventCoding
), to direct the receiver toward the information acted upon (i.e., focus
) and to support message routing.
.id
MessageHeader.id
(this element) SHALL be assigned when the message is createdBundle.id
SHALL be assigned each time the message is sent.eventCoding
.destination
.endpoint
SHALL be populated with either:
.sender
.enterer
.author
.reference
a PractitionerRole resource included in the message as a Bundle.entry
. For more details, see guidance on MessageBundle - Task (CA:eReC)..source.endpoint
.reason
.response
.response.identifier
SHALL be populated with the MessageHeader.id
of the message to which this message is a response.response.code
SHALL be populated with a valid ResponseType.response.details
MAY be provided in a referenced OperationOutcome included in the Bundle.focus
Bundle.entry
focus
to communicate some events