Skip to main content

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. If the element is present, it must have either a @value, an @id, or extensions

type MessageHeader implements Resource {
  eventCoding: Coding
  eventUri: Uri
  destination: [MessageHeaderDestination]
  sender: Reference
  enterer: Reference
  author: Reference
  source: MessageHeaderSource
  responsible: Reference
  reason: CodeableConcept
  response: MessageHeaderResponse
  focus: [Reference]
  definition: Uri
  text: Narrative
  contained: [Resource]
  extension: [Extension]
  modifierExtension: [Extension]
  id: String
  meta: Meta
  implicitRules: Uri
  language: String
}

Fields​

MessageHeader.eventCoding ● Coding object​

Code 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. (choose any one of event*, but only one)

MessageHeader.eventUri ● Uri scalar​

Code 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. (choose any one of event*, but only one)

MessageHeader.destination ● [MessageHeaderDestination] list object​

The destination application which the message is intended for.

MessageHeader.sender ● Reference object​

Identifies the sending system to allow the use of a trust relationship.

MessageHeader.enterer ● Reference object​

The 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.author ● Reference object​

The 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.source ● MessageHeaderSource object​

The source application from which this message originated.

MessageHeader.responsible ● Reference object​

The 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.reason ● CodeableConcept object​

Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.

MessageHeader.response ● MessageHeaderResponse object​

Information about the message that this message is a response to. Only present if this message is a response.

MessageHeader.focus ● [Reference] list object​

The actual data of the message - a reference to the root/focus class of the event.

MessageHeader.definition ● Uri scalar​

Permanent link to the MessageDefinition for this message.

MessageHeader.text ● Narrative object​

A 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.contained ● [Resource] list interface​

These 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.extension ● [Extension] list object​

May 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.modifierExtension ● [Extension] list object​

May 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.id ● String scalar​

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

MessageHeader.meta ● Meta object​

The 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.implicitRules ● Uri scalar​

A 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.language ● String scalar​

The base language in which the resource is written.

Interfaces​

Resource interface​

This is the base resource type for everything.

Returned By​

MessageHeader query ● MessageHeaderCreate mutation ● MessageHeaderList query ● MessageHeaderUpdate mutation