Class MessageHeader

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class MessageHeader extends DomainResource
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.
See Also:
  • Field Details

    • event

      protected DataType event
      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.
    • destination

      The destination application which the message is intended for.
    • sender

      protected Reference sender
      Identifies the sending system to allow the use of a trust relationship.
    • enterer

      protected Reference enterer
      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.
    • author

      protected Reference author
      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.
    • 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

      protected List<Reference> focus
      The actual data of the message - a reference to the root/focus class of the event.
    • definition

      Permanent link to the MessageDefinition for this message.
    • SP_AUTHOR

      public static final String SP_AUTHOR
      Search parameter: author

      Description: The source of the decision
      Type: reference
      Path: MessageHeader.author

      See Also:
    • AUTHOR

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHOR
      Fluent Client search parameter constant for author

      Description: The source of the decision
      Type: reference
      Path: MessageHeader.author

    • INCLUDE_AUTHOR

      public static final ca.uhn.fhir.model.api.Include INCLUDE_AUTHOR
      Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:author".
    • SP_CODE

      public static final String SP_CODE
      Search parameter: code

      Description: ok | transient-error | fatal-error
      Type: token
      Path: MessageHeader.response.code

      See Also:
    • CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
      Fluent Client search parameter constant for code

      Description: ok | transient-error | fatal-error
      Type: token
      Path: MessageHeader.response.code

    • SP_DESTINATION_URI

      public static final String SP_DESTINATION_URI
      Search parameter: destination-uri

      Description: Actual destination address or id
      Type: uri
      Path: MessageHeader.destination.endpoint

      See Also:
    • DESTINATION_URI

      public static final ca.uhn.fhir.rest.gclient.UriClientParam DESTINATION_URI
      Fluent Client search parameter constant for destination-uri

      Description: Actual destination address or id
      Type: uri
      Path: MessageHeader.destination.endpoint

    • SP_DESTINATION

      public static final String SP_DESTINATION
      Search parameter: destination

      Description: Name of system
      Type: string
      Path: MessageHeader.destination.name

      See Also:
    • DESTINATION

      public static final ca.uhn.fhir.rest.gclient.StringClientParam DESTINATION
      Fluent Client search parameter constant for destination

      Description: Name of system
      Type: string
      Path: MessageHeader.destination.name

    • SP_ENTERER

      public static final String SP_ENTERER
      Search parameter: enterer

      Description: The source of the data entry
      Type: reference
      Path: MessageHeader.enterer

      See Also:
    • ENTERER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENTERER
      Fluent Client search parameter constant for enterer

      Description: The source of the data entry
      Type: reference
      Path: MessageHeader.enterer

    • INCLUDE_ENTERER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ENTERER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:enterer".
    • SP_EVENT

      public static final String SP_EVENT
      Search parameter: event

      Description: Code for the event this message represents or link to event definition
      Type: token
      Path: MessageHeader.event

      See Also:
    • EVENT

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam EVENT
      Fluent Client search parameter constant for event

      Description: Code for the event this message represents or link to event definition
      Type: token
      Path: MessageHeader.event

    • SP_FOCUS

      public static final String SP_FOCUS
      Search parameter: focus

      Description: The actual content of the message
      Type: reference
      Path: MessageHeader.focus

      See Also:
    • FOCUS

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam FOCUS
      Fluent Client search parameter constant for focus

      Description: The actual content of the message
      Type: reference
      Path: MessageHeader.focus

    • INCLUDE_FOCUS

      public static final ca.uhn.fhir.model.api.Include INCLUDE_FOCUS
      Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:focus".
    • SP_RECEIVER

      public static final String SP_RECEIVER
      Search parameter: receiver

      Description: Intended "real-world" recipient for the data
      Type: reference
      Path: MessageHeader.destination.receiver

      See Also:
    • RECEIVER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RECEIVER
      Fluent Client search parameter constant for receiver

      Description: Intended "real-world" recipient for the data
      Type: reference
      Path: MessageHeader.destination.receiver

    • INCLUDE_RECEIVER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_RECEIVER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:receiver".
    • SP_RESPONSE_ID

      public static final String SP_RESPONSE_ID
      Search parameter: response-id

      Description: Id of original message
      Type: token
      Path: MessageHeader.response.identifier

      See Also:
    • RESPONSE_ID

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam RESPONSE_ID
      Fluent Client search parameter constant for response-id

      Description: Id of original message
      Type: token
      Path: MessageHeader.response.identifier

    • SP_RESPONSIBLE

      public static final String SP_RESPONSIBLE
      Search parameter: responsible

      Description: Final responsibility for event
      Type: reference
      Path: MessageHeader.responsible

      See Also:
    • RESPONSIBLE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RESPONSIBLE
      Fluent Client search parameter constant for responsible

      Description: Final responsibility for event
      Type: reference
      Path: MessageHeader.responsible

    • INCLUDE_RESPONSIBLE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_RESPONSIBLE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:responsible".
    • SP_SENDER

      public static final String SP_SENDER
      Search parameter: sender

      Description: Real world sender of the message
      Type: reference
      Path: MessageHeader.sender

      See Also:
    • SENDER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SENDER
      Fluent Client search parameter constant for sender

      Description: Real world sender of the message
      Type: reference
      Path: MessageHeader.sender

    • INCLUDE_SENDER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SENDER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:sender".
    • SP_SOURCE_URI

      public static final String SP_SOURCE_URI
      Search parameter: source-uri

      Description: Actual message source address or id
      Type: uri
      Path: MessageHeader.source.endpoint

      See Also:
    • SOURCE_URI

      public static final ca.uhn.fhir.rest.gclient.UriClientParam SOURCE_URI
      Fluent Client search parameter constant for source-uri

      Description: Actual message source address or id
      Type: uri
      Path: MessageHeader.source.endpoint

    • SP_SOURCE

      public static final String SP_SOURCE
      Search parameter: source

      Description: Name of system
      Type: string
      Path: MessageHeader.source.name

      See Also:
    • SOURCE

      public static final ca.uhn.fhir.rest.gclient.StringClientParam SOURCE
      Fluent Client search parameter constant for source

      Description: Name of system
      Type: string
      Path: MessageHeader.source.name

    • SP_TARGET

      public static final String SP_TARGET
      Search parameter: target

      Description: Particular delivery destination within the destination
      Type: reference
      Path: MessageHeader.destination.target

      See Also:
    • TARGET

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam TARGET
      Fluent Client search parameter constant for target

      Description: Particular delivery destination within the destination
      Type: reference
      Path: MessageHeader.destination.target

    • INCLUDE_TARGET

      public static final ca.uhn.fhir.model.api.Include INCLUDE_TARGET
      Constant for fluent queries to be used to add include statements. Specifies the path value of "MessageHeader:target".
  • Constructor Details

  • Method Details