MessageHeader
Description
This entity the message header of a message type Bundle.
Snapshot
QuebecMessageHeader (MessageHeader) | I | MessageHeader | There are no (further) constraints on this element Element idMessageHeader A resource that describes a message that is exchanged between systems DefinitionThe 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.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idMessageHeader.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idMessageHeader.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idMessageHeader.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idMessageHeader.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idMessageHeader.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idMessageHeader.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idMessageHeader.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
event[x] | Σ | 1..1 | Element idMessageHeader.event[x] Code for the event this message represents or link to event definition DefinitionCode that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition. Drives the behavior associated with this message. The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp. Unordered, Open, by $this(Type) BindingOne of the message events defined as part of this version of FHIR.
| |
(All Slices) | There are no (further) constraints on this element | |||
eventUri | uri | There are no (further) constraints on this element Data type | ||
eventCoding | S Σ | 0..1 | Coding | Element idMessageHeader.event[x]:eventCoding Code for the event this message represents or link to event definition DefinitionCode that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition. Drives the behavior associated with this message. The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp. One of the message events defined as part of this version of FHIR.
|
id | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.event[x]:eventCoding.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idMessageHeader.event[x]:eventCoding.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 0..1 | uriPattern | Element idMessageHeader.event[x]:eventCoding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
https://ehealthontario.ca/fhir/CodeSystem/message-event-code
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.event[x]:eventCoding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | Σ | 0..1 | codePattern | Element idMessageHeader.event[x]:eventCoding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
add-service-request
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.event[x]:eventCoding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idMessageHeader.event[x]:eventCoding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
destination | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idMessageHeader.destination Message destination application(s) DefinitionThe destination application which the message is intended for. Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient". There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.
|
id | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.destination.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idMessageHeader.destination.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idMessageHeader.destination.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.destination.name Name of system DefinitionHuman-readable name for the target system. May be used for routing of response and/or to support audit. Note that FHIR strings SHALL NOT exceed 1MB in size
|
target | Σ I | 0..1 | Reference(Device) | There are no (further) constraints on this element Element idMessageHeader.destination.target Particular delivery destination within the destination DefinitionIdentifies the target end system in situations where the initial message transmission is to an intermediary system. Supports multi-hop routing. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
endpoint | Σ | 1..1 | url | There are no (further) constraints on this element Element idMessageHeader.destination.endpoint Actual destination address or id DefinitionIndicates where the message should be routed to. Identifies where to route the message. The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
|
receiver | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element idMessageHeader.destination.receiver Intended "real-world" recipient for the data DefinitionAllows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient. Allows routing beyond just the application level. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Organization) Constraints
|
sender | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element idMessageHeader.sender Real world sender of the message DefinitionIdentifies the sending system to allow the use of a trust relationship. Allows routing beyond just the application level. Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone. Reference(Practitioner | PractitionerRole | Organization) Constraints
|
enterer | Σ I | 0..1 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idMessageHeader.enterer The source of the data entry DefinitionThe person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request but can be used in a response. Reference(Practitioner | PractitionerRole) Constraints
|
author | Σ I | 0..1 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idMessageHeader.author The source of the decision DefinitionThe logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request but can be used in a response. Reference(Practitioner | PractitionerRole) Constraints
|
source | Σ | 1..1 | BackboneElement | There are no (further) constraints on this element Element idMessageHeader.source Message source application DefinitionThe source application from which this message originated. Allows replies, supports audit.
|
id | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.source.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idMessageHeader.source.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idMessageHeader.source.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
name | Σ | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.source.name Name of system DefinitionHuman-readable name for the source system. May be used to support audit. Note that FHIR strings SHALL NOT exceed 1MB in size
|
software | Σ | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.source.software Name of software running the system DefinitionMay include configuration or other information useful in debugging. Supports audit and possibly interface engine behavior. Note that FHIR strings SHALL NOT exceed 1MB in size
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.source.version Version of software running DefinitionCan convey versions of multiple systems in situations where a message passes through multiple hands. Supports audit and possibly interface engine behavior. Note that FHIR strings SHALL NOT exceed 1MB in size
|
contact | Σ I | 0..1 | ContactPoint | There are no (further) constraints on this element Element idMessageHeader.source.contact Human contact for problems DefinitionAn e-mail, phone, website or other contact point to use to resolve issues with message communications. Allows escalation of technical issues.
|
endpoint | Σ | 1..1 | url | There are no (further) constraints on this element Element idMessageHeader.source.endpoint Actual message source address or id DefinitionIdentifies the routing target to send acknowledgements to. Identifies where to send responses, may influence security permissions. The id may be a non-resolvable URI for systems that do not use standard network-based addresses.
|
responsible | Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element idMessageHeader.responsible Final responsibility for event DefinitionThe person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party. Need to know for audit/traceback requirements and possibly for authorization. Usually only for the request but can be used in a response. Reference(Practitioner | PractitionerRole | Organization) Constraints
|
reason | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idMessageHeader.reason Cause of event DefinitionCoded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message. Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Reason for event occurrence.
|
response | Σ | 0..1 | BackboneElement | There are no (further) constraints on this element Element idMessageHeader.response If this is a reply to prior message DefinitionInformation about the message that this message is a response to. Only present if this message is a response.
|
id | 0..1 | string | There are no (further) constraints on this element Element idMessageHeader.response.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idMessageHeader.response.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idMessageHeader.response.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
identifier | Σ | 1..1 | id | There are no (further) constraints on this element Element idMessageHeader.response.identifier Id of original message DefinitionThe MessageHeader.id of the message to which this message is a response. Allows receiver to know what message is being responded to. RFC 4122
|
code | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idMessageHeader.response.code ok | transient-error | fatal-error DefinitionCode that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not. Allows the sender of the acknowledge message to know if the request was successful or if action is needed. This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus. The kind of response to a message.
|
details | Σ I | 0..1 | Reference(OperationOutcome) | There are no (further) constraints on this element Element idMessageHeader.response.details Specific list of hints/warnings/errors DefinitionFull details of any issues found in the message. Allows the sender of the message to determine what the specific issues are. This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.
|
focus | Σ I | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idMessageHeader.focus The actual content of the message DefinitionThe actual data of the message - a reference to the root/focus class of the event. Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources. The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.
|
definition | Σ | 0..1 | canonical(MessageDefinition) | There are no (further) constraints on this element Element idMessageHeader.definition Link to the definition for this message DefinitionPermanent link to the MessageDefinition for this message. Allows sender to define the expected contents of the message.
|
Click here for more information about the base FHIR Bundle specification.