MessageHeader constructor

const MessageHeader({ @Default(R5ResourceType.MessageHeader) @JsonKey(unknownEnumValue: R5ResourceType.MessageHeader) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<Resource>? contained, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, Coding? eventCoding, FhirCanonical? eventCanonical, @JsonKey(name: '_eventCanonical') Element? eventCanonicalElement, List<MessageHeaderDestination>? destination, Reference? sender, Reference? author, required MessageHeaderSource source, Reference? responsible, CodeableConcept? reason, MessageHeaderResponse? response, List<Reference>? focus, FhirCanonical? definition, })

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.

resourceType This is a MessageHeader resource

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

meta 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.

implicitRules 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.

implicitRulesElement ("_implicitRules") Extensions for implicitRules

language The base language in which the resource is written.

languageElement ("_language") Extensions for language

text 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.

contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

extension_ ("extension") 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 managable, 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.

modifierExtension 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 managable, 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).

eventCoding Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification are defined by the implementation. Alternatively a canonical uri to the EventDefinition.

eventCanonical Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification are defined by the implementation. Alternatively a canonical uri to the EventDefinition.

eventCanonicalElement ("_eventCanonical") Extensions for eventCanonical

destination The destination application which the message is intended for.

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

author The logical author of the message - the personor 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.

source The source application from which this message originated.

responsible 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.

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

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

focus The actual data of the message - a reference to the root/focus class of the event. This is allowed to be a Parameters resource.

definition Permanent link to the MessageDefinition for this message.

Implementation

const factory MessageHeader({
  /// [resourceType] This is a MessageHeader resource
  @Default(R5ResourceType.MessageHeader)
  @JsonKey(unknownEnumValue: R5ResourceType.MessageHeader)
  R5ResourceType resourceType,
  @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,

  /// [id] The logical id of the resource, as used in the URL for the
  ///  resource. Once assigned, this value never changes.
  @JsonKey(name: 'id') FhirId? fhirId,

  /// [meta] 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.
  FhirMeta? meta,

  /// [implicitRules] 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.
  FhirUri? implicitRules,

  /// [implicitRulesElement] ("_implicitRules") Extensions for implicitRules
  @JsonKey(name: '_implicitRules') Element? implicitRulesElement,

  /// [language] The base language in which the resource is written.
  FhirCode? language,

  /// [languageElement] ("_language") Extensions for language
  @JsonKey(name: '_language') Element? languageElement,

  /// [text] 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.
  Narrative? text,

  /// [contained] These resources do not have an independent existence apart
  ///  from the resource that contains them - they cannot be identified
  ///  independently, nor can they have their own independent transaction
  ///  scope. This is allowed to be a Parameters resource if and only if it
  ///  is referenced by a resource that provides context/meaning.
  List<Resource>? contained,

  /// [extension_] ("extension") 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 managable, 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.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [modifierExtension] 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 managable, 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).
  List<FhirExtension>? modifierExtension,

  /// [eventCoding] Code that identifies the event this message represents
  ///  and connects it with its definition. Events defined as part of the
  ///  FHIR specification are defined by the implementation.  Alternatively a
  ///  canonical uri to the EventDefinition.
  Coding? eventCoding,

  /// [eventCanonical] Code that identifies the event this message represents
  ///  and connects it with its definition. Events defined as part of the
  ///  FHIR specification are defined by the implementation.  Alternatively a
  ///  canonical uri to the EventDefinition.
  FhirCanonical? eventCanonical,

  /// [eventCanonicalElement] ("_eventCanonical") Extensions for
  ///  eventCanonical
  @JsonKey(name: '_eventCanonical') Element? eventCanonicalElement,

  /// [destination] The destination application which the message is intended
  ///  for.
  List<MessageHeaderDestination>? destination,

  /// [sender] Identifies the sending system to allow the use of a trust
  ///  relationship.
  Reference? sender,

  /// [author] The logical author of the message - the personor 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.
  Reference? author,

  /// [source] The source application from which this message originated.
  required MessageHeaderSource source,

  /// [responsible] 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.
  Reference? responsible,

  /// [reason] Coded indication of the cause for the event - indicates  a
  ///  reason for the occurrence of the event that is a focus of this message.
  CodeableConcept? reason,

  /// [response] Information about the message that this message is a
  ///  response to.  Only present if this message is a response.
  MessageHeaderResponse? response,

  /// [focus] The actual data of the message - a reference to the root/focus
  ///  class of the event. This is allowed to be a Parameters resource.
  List<Reference>? focus,

  /// [definition] Permanent link to the MessageDefinition for this message.
  FhirCanonical? definition,
}) = _MessageHeader;