FHIR Artifacts > Structure Definition: MessageHeader Profile
Structure Definition: MessageHeader Profile
Canonical URL:http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-MessageHeader
Simplifier project page: MessageHeader
Derived from: Message Header (CA:eReC)
Base FHIR: MessageHeader (R4)
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work
Differential View
| EReferralMessageHeader (MessageHeader) | http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-MessageHeader | ||
| meta | S | 1.. | |
| profile | S | 1.. | |
| routingOptions | S | Extension(CodeableConcept) | |
| url | Fixed Value | ||
| contentType | S | Extension(code) | |
| url | Fixed Value | ||
| event[x] | |||
| eventCoding | Binding | ||
| system | S | ||
| code | S | ||
| display | S | ||
| destination | 1.. | ||
| name | |||
| target | |||
| endpoint | |||
| HTTPHeaderDestination | Extension(string) | ||
| receiver | Reference(EReferralPractitionerRole) | ||
| author | Reference(EReferralPractitionerRole) | ||
| source | |||
| name | |||
| software | |||
| version | |||
| contact | |||
| system | |||
| value | |||
| use | |||
| rank | |||
| endpoint | |||
| HTTPHeaderSource | Extension(string) | ||
| reason | |||
| coding | |||
| system | S | 1.. | |
| code | S | 1.. | |
| display | S | 1.. | |
| text | S | ||
| focus | Reference(EReferralAppointment | EReferralCommunication | EReferralServiceRequest | EReferralTask) |
Hybrid View
| EReferralMessageHeader (MessageHeader) | http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-MessageHeader | ||
| meta | S | 1.. | |
| profile | S | 1.. | |
| routingOptions | S | Extension(CodeableConcept) | |
| url | Fixed Value | ||
| contentType | S | Extension(code) | |
| url | Fixed Value | ||
| event[x] | |||
| eventCoding | Binding | ||
| system | S | ||
| code | S | ||
| display | S | ||
| destination | 1.. | ||
| name | |||
| target | |||
| endpoint | |||
| HTTPHeaderDestination | Extension(string) | ||
| receiver | Reference(EReferralPractitionerRole) | ||
| author | Reference(EReferralPractitionerRole) | ||
| source | |||
| name | |||
| software | |||
| version | |||
| contact | |||
| system | |||
| value | |||
| use | |||
| rank | |||
| endpoint | |||
| HTTPHeaderSource | Extension(string) | ||
| reason | |||
| coding | |||
| system | S | 1.. | |
| code | S | 1.. | |
| display | S | 1.. | |
| text | S | ||
| focus | Reference(EReferralAppointment | EReferralCommunication | EReferralServiceRequest | EReferralTask) |
Snapshot View
| EReferralMessageHeader (MessageHeader) | http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-MessageHeader | ||
| meta | S | 1.. | |
| profile | S | 1.. | |
| routingOptions | S | Extension(CodeableConcept) | |
| url | Fixed Value | ||
| contentType | S | Extension(code) | |
| url | Fixed Value | ||
| event[x] | |||
| eventCoding | Binding | ||
| system | S | ||
| code | S | ||
| display | S | ||
| destination | 1.. | ||
| name | |||
| target | |||
| endpoint | |||
| HTTPHeaderDestination | Extension(string) | ||
| receiver | Reference(EReferralPractitionerRole) | ||
| author | Reference(EReferralPractitionerRole) | ||
| source | |||
| name | |||
| software | |||
| version | |||
| contact | |||
| system | |||
| value | |||
| use | |||
| rank | |||
| endpoint | |||
| HTTPHeaderSource | Extension(string) | ||
| reason | |||
| coding | |||
| system | S | 1.. | |
| code | S | 1.. | |
| display | S | 1.. | |
| text | S | ||
| focus | Reference(EReferralAppointment | EReferralCommunication | EReferralServiceRequest | EReferralTask) |
Table View
| MessageHeader | .. | |
| MessageHeader.meta | 1.. | |
| MessageHeader.meta.profile | 1.. | |
| MessageHeader.extension:routingOptions | Extension | .. |
| MessageHeader.extension:routingOptions.url | .. | |
| MessageHeader.extension:contentType | Extension | .. |
| MessageHeader.extension:contentType.url | .. | |
| MessageHeader.event[x] | .. | |
| MessageHeader.event[x]:eventCoding | .. | |
| MessageHeader.event[x]:eventCoding.system | .. | |
| MessageHeader.event[x]:eventCoding.code | .. | |
| MessageHeader.event[x]:eventCoding.display | .. | |
| MessageHeader.destination | 1.. | |
| MessageHeader.destination.name | .. | |
| MessageHeader.destination.target | .. | |
| MessageHeader.destination.endpoint | .. | |
| MessageHeader.destination.endpoint.extension:HTTPHeaderDestination | Extension | .. |
| MessageHeader.destination.receiver | Reference(EReferralPractitionerRole) | .. |
| MessageHeader.author | Reference(EReferralPractitionerRole) | .. |
| MessageHeader.source | .. | |
| MessageHeader.source.name | .. | |
| MessageHeader.source.software | .. | |
| MessageHeader.source.version | .. | |
| MessageHeader.source.contact | .. | |
| MessageHeader.source.contact.system | .. | |
| MessageHeader.source.contact.value | .. | |
| MessageHeader.source.contact.use | .. | |
| MessageHeader.source.contact.rank | .. | |
| MessageHeader.source.endpoint | .. | |
| MessageHeader.source.endpoint.extension:HTTPHeaderSource | Extension | .. |
| MessageHeader.reason | .. | |
| MessageHeader.reason.coding | .. | |
| MessageHeader.reason.coding.system | 1.. | |
| MessageHeader.reason.coding.code | 1.. | |
| MessageHeader.reason.coding.display | 1.. | |
| MessageHeader.reason.text | .. | |
| MessageHeader.focus | Reference(EReferralAppointment | EReferralCommunication | EReferralServiceRequest | EReferralTask) | .. |
JSON View
{
"description": "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.\nTo enable sending system insert its own identifiers into API submitted eReferral, and have that returned with subsequent messages, an extension is created on the MessageHeader.identifier element for referral id.",
"baseDefinition": "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-MessageHeader",
{
},
{
"comment": "#### **_` FOR eREFERRAL USAGE: The meta.profile = http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-MessageHeader|1.2.0 `_**\n\nIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
},
{
{
"http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/Routing-Options-EXT"
]
}
],
},
{
},
{
{
"http://ehealthontario.ca/fhir/StructureDefinition/ext-content-type"
]
}
],
},
{
},
{
}
},
{
}
},
{
},
{
},
{
},
{
},
{
},
{
},
{
{
"http://ehealthontario.ca/fhir/StructureDefinition/ext-http-header-destination"
]
}
],
},
{
{
"http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-PractitionerRole"
],
"referenced"
]
}
],
},
{
{
"http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-PractitionerRole"
]
}
]
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
},
{
{
"http://ehealthontario.ca/fhir/StructureDefinition/ext-http-header-source"
]
}
],
},
{
},
{
},
{
},
{
},
{
},
{
{
"http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-ServiceRequest",
"http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Task",
"http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Appointment",
"http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Communication"
],
"referenced"
]
}
]
}
]
}
}
Usage
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.
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.
Notes
.id
- used to uniquely identify a message
- populate this element with a UUID each time a message is created
- note: a FHIR message contains two identifiers that are unique within the message stream, rules:
- a
MessageHeader.id(this element) SHALL be assigned when the message is created - a
Bundle.idSHALL be assigned each time the message is sent
- a
.meta.profile
- used to declare conformance to this profile
- populate with the fixed value:
http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-MessageHeader|1.2.0
.extension:RoutingOptions
- used to communicate referral source type information to support referral processes with automated referral processing rules
- for "add-servicerequest" messsages, this element SHALL be populated with the same value as
ServiceRequest.extension:RoutingOptionsif present - see requisition for more informaiton
.extension:ContentType
- used to distinguish between messages used for clinical purposes, and messages used for analytics
- MAY be populated with a code of
ClinicalorAnalytical - Message Bundles not containing this extension SHALL be considered clinical
.eventCoding
- used to convey the business event that triggered the message
- SHALL be populated with a
codefrom MessageEventCode and codingsystem
.destination.endpoint
- used to enable message routing through an intermediary
- SHALL be populated with either:
- a literal URL that identifies the addresses to which the message should be delivered, or
- a logical URI (i.e. non-dereferenceable) known to the intermediary.
.destination.receiver
- used to reference the receiver (PractitionerRole) of the request referral or consult
.author
- identifies the person who initiated the event
- SHALL be populated with a reference to a StructureDefinition: PractitionerRole Profile resource included as a message
Bundle.entry
.source.endpoint
- used to enable message routing of responses through an intermediary
- SHALL be populated with either:
- a literal URL that identifies the addresses to which the message should be delivered, or
- a logical URI (i.e. non-dereferenceable) known to the intermediary.
.response
- indicates that a message is a response to a request message (with status)
- if used:
.response.identifierSHALL be populated with theMessageHeader.idof the message to which this message is a response.response.codeSHALL be populated with a valid ResponseType.response.detailsMAY be provided in a referenced OperationOutcome included in the Bundle
.focus
- identifies the information acted upon when the message was triggered
- SHALL include a reference to a ServiceRequest,
Task,
Appointment,
Communication that:
- appropriately corresponds to the
eventCoding.code(see: Constructing Messages - is included as a message
Bundle.entry
- appropriately corresponds to the
- a MessageHeader SHALL include only a single instance of focus on messages used to transmit event information between and RMS Source and RMS Target (either direction)
- a MessageHeader SHALL include multiple instances of focus when needed to transmit a full snapshot of referral information including Appointment information.