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:
    Serialized Form
    • Field Detail

      • event

        protected Coding 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://hl7.org/fhir/message-events".
      • receiver

        protected Reference receiver
        Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
      • receiverTarget

        protected Resource receiverTarget
        The actual object that is the target of the reference (Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.)
      • sender

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

        protected Resource senderTarget
        The actual object that is the target of the reference (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.
      • entererTarget

        protected Practitioner entererTarget
        The actual object that is the target of the reference (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.
      • authorTarget

        protected Practitioner authorTarget
        The actual object that is the target of the reference (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.)
      • responsible

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

        protected Resource responsibleTarget
        The actual object that is the target of the reference (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

        protected CodeableConcept 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.
      • focus

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

        protected List<Resource> focusTarget
        The actual objects that are the target of the reference (The actual data of the message - a reference to the root/focus class of the event.)
      • 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:
        Constant Field Values
      • 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_RECEIVER

        public static final String SP_RECEIVER
        Search parameter: receiver

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

        See Also:
        Constant Field Values
      • 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.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_AUTHOR

        public static final String SP_AUTHOR
        Search parameter: author

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

        See Also:
        Constant Field Values
      • 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".
      • 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_FOCUS

        public static final String SP_FOCUS
        Search parameter: focus

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

        See Also:
        Constant Field Values
      • 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".
      • 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:
        Constant Field Values
      • 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".
      • 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:
        Constant Field Values
      • 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_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:
        Constant Field Values
      • 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_SENDER

        public static final String SP_SENDER
        Search parameter: sender

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

        See Also:
        Constant Field Values
      • 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_RESPONSIBLE

        public static final String SP_RESPONSIBLE
        Search parameter: responsible

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

        See Also:
        Constant Field Values
      • 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_ENTERER

        public static final String SP_ENTERER
        Search parameter: enterer

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

        See Also:
        Constant Field Values
      • 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_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:
        Constant Field Values
      • 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_EVENT

        public static final String SP_EVENT
        Search parameter: event

        Description: Code for the event this message represents
        Type: token
        Path: MessageHeader.event

        See Also:
        Constant Field Values
      • 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
        Type: token
        Path: MessageHeader.event

      • SP_TIMESTAMP

        public static final String SP_TIMESTAMP
        Search parameter: timestamp

        Description: Time that the message was sent
        Type: date
        Path: MessageHeader.timestamp

        See Also:
        Constant Field Values
      • TIMESTAMP

        public static final ca.uhn.fhir.rest.gclient.DateClientParam TIMESTAMP
        Fluent Client search parameter constant for timestamp

        Description: Time that the message was sent
        Type: date
        Path: MessageHeader.timestamp

    • Method Detail

      • getEvent

        public Coding getEvent()
        Returns:
        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://hl7.org/fhir/message-events".)
      • setEvent

        public MessageHeader setEvent​(Coding value)
        Parameters:
        value - 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://hl7.org/fhir/message-events".)
      • getReceiver

        public Reference getReceiver()
        Returns:
        receiver (Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.)
      • setReceiver

        public MessageHeader setReceiver​(Reference value)
        Parameters:
        value - receiver (Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.)
      • getReceiverTarget

        public Resource getReceiverTarget()
        Returns:
        receiver The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.)
      • setReceiverTarget

        public MessageHeader setReceiverTarget​(Resource value)
        Parameters:
        value - receiver The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.)
      • getSender

        public Reference getSender()
        Returns:
        sender (Identifies the sending system to allow the use of a trust relationship.)
      • getSenderTarget

        public Resource getSenderTarget()
        Returns:
        sender The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Identifies the sending system to allow the use of a trust relationship.)
      • setSenderTarget

        public MessageHeader setSenderTarget​(Resource value)
        Parameters:
        value - sender The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Identifies the sending system to allow the use of a trust relationship.)
      • getTimestampElement

        public InstantType getTimestampElement()
        Returns:
        timestamp (The time that the message was sent.). This is the underlying object with id, value and extensions. The accessor "getTimestamp" gives direct access to the value
      • setTimestampElement

        public MessageHeader setTimestampElement​(InstantType value)
        Parameters:
        value - timestamp (The time that the message was sent.). This is the underlying object with id, value and extensions. The accessor "getTimestamp" gives direct access to the value
      • getTimestamp

        public Date getTimestamp()
        Returns:
        The time that the message was sent.
      • getEnterer

        public Reference getEnterer()
        Returns:
        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.)
      • setEnterer

        public MessageHeader setEnterer​(Reference value)
        Parameters:
        value - 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.)
      • getEntererTarget

        public Practitioner getEntererTarget()
        Returns:
        enterer The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (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.)
      • setEntererTarget

        public MessageHeader setEntererTarget​(Practitioner value)
        Parameters:
        value - enterer The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.)
      • getAuthor

        public Reference getAuthor()
        Returns:
        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.)
      • setAuthor

        public MessageHeader setAuthor​(Reference value)
        Parameters:
        value - 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.)
      • getAuthorTarget

        public Practitioner getAuthorTarget()
        Returns:
        author The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (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.)
      • setAuthorTarget

        public MessageHeader setAuthorTarget​(Practitioner value)
        Parameters:
        value - author The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.)
      • getResponsible

        public Reference getResponsible()
        Returns:
        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.)
      • setResponsible

        public MessageHeader setResponsible​(Reference value)
        Parameters:
        value - 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.)
      • getResponsibleTarget

        public Resource getResponsibleTarget()
        Returns:
        responsible The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (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.)
      • setResponsibleTarget

        public MessageHeader setResponsibleTarget​(Resource value)
        Parameters:
        value - responsible The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.)
      • getReason

        public CodeableConcept getReason()
        Returns:
        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.)
      • setReason

        public MessageHeader setReason​(CodeableConcept value)
        Parameters:
        value - 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.)
      • getFocus

        public List<ReferencegetFocus()
        Returns:
        focus (The actual data of the message - a reference to the root/focus class of the event.)
      • getFocusFirstRep

        public Reference getFocusFirstRep()
        Returns:
        The first repetition of repeating field focus, creating it if it does not already exist
      • getProperty

        public Base[] getProperty​(int hash,
                                  String name,
                                  boolean checkValid)
                           throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource