Skip to main content

MessageHeader

PropertyValue
Publisher
NameMessageHeader
URLhttp://hl7.org/fhir/StructureDefinition/MessageHeader
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
MessageHeader0..*MessageHeaderThe 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.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
MessageHeader.meta0..1MetaThe 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.
MessageHeader.implicitRules0..1uriA 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.
MessageHeader.language0..1codeThe base language in which the resource is written.
MessageHeader.text0..1NarrativeA 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.
MessageHeader.contained0..*ResourceThese 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.
MessageHeader.extension0..*ExtensionMay 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.
MessageHeader.modifierExtension0..*ExtensionMay 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).
MessageHeader.event[x]1..1CodingCode 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.
MessageHeader.destination0..*BackboneElementThe destination application which the message is intended for.
MessageHeader.destination.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
MessageHeader.destination.extension0..*ExtensionMay 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.
MessageHeader.destination.modifierExtension0..*ExtensionMay 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).
MessageHeader.destination.name0..1stringHuman-readable name for the target system.
MessageHeader.destination.target0..1ReferenceIdentifies the target end system in situations where the initial message transmission is to an intermediary system.
MessageHeader.destination.endpoint1..1urlIndicates where the message should be routed to.
MessageHeader.destination.receiver0..1ReferenceAllows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
MessageHeader.sender0..1ReferenceIdentifies the sending system to allow the use of a trust relationship.
MessageHeader.enterer0..1ReferenceThe 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.
MessageHeader.author0..1ReferenceThe 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.
MessageHeader.source1..1BackboneElementThe source application from which this message originated.
MessageHeader.source.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
MessageHeader.source.extension0..*ExtensionMay 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.
MessageHeader.source.modifierExtension0..*ExtensionMay 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).
MessageHeader.source.name0..1stringHuman-readable name for the source system.
MessageHeader.source.software0..1stringMay include configuration or other information useful in debugging.
MessageHeader.source.version0..1stringCan convey versions of multiple systems in situations where a message passes through multiple hands.
MessageHeader.source.contact0..1ContactPointAn e-mail, phone, website or other contact point to use to resolve issues with message communications.
MessageHeader.source.endpoint1..1urlIdentifies the routing target to send acknowledgements to.
MessageHeader.responsible0..1ReferenceThe 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.
MessageHeader.reason0..1CodeableConceptCoded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
MessageHeader.response0..1BackboneElementInformation about the message that this message is a response to. Only present if this message is a response.
MessageHeader.response.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
MessageHeader.response.extension0..*ExtensionMay 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.
MessageHeader.response.modifierExtension0..*ExtensionMay 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).
MessageHeader.response.identifier1..1idThe MessageHeader.id of the message to which this message is a response.
MessageHeader.response.code1..1codeCode that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.
MessageHeader.response.details0..1ReferenceFull details of any issues found in the message.
MessageHeader.focus0..*ReferenceThe actual data of the message - a reference to the root/focus class of the event.
MessageHeader.definition0..1canonicalPermanent link to the MessageDefinition for this message.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
authorreferenceThe source of the decisionMessageHeader.author
codetokenok / transient-error / fatal-errorMessageHeader.response.code
destinationstringName of systemMessageHeader.destination.name
destination-uriuriActual destination address or idMessageHeader.destination.endpoint
entererreferenceThe source of the data entryMessageHeader.enterer
eventtokenCode for the event this message represents or link to event definitionMessageHeader.event
focusreferenceThe actual content of the messageMessageHeader.focus
receiverreferenceIntended "real-world" recipient for the dataMessageHeader.destination.receiver
response-idtokenId of original messageMessageHeader.response.identifier
responsiblereferenceFinal responsibility for eventMessageHeader.responsible
senderreferenceReal world sender of the messageMessageHeader.sender
sourcestringName of systemMessageHeader.source.name
source-uriuriActual message source address or idMessageHeader.source.endpoint
targetreferenceParticular delivery destination within the destinationMessageHeader.destination.target