Package org.hl7.fhir.dstu2.model

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

    • Method Detail

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

      • 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".)

      • getEnterer

        public Reference getEnterer()
        Returns:
        enterer (The person or device that performed the data entry leading to this message. Where 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. Where 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. Where 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. Where 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. Where 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. Where 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. Where 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. Where there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.)

      • 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.)

      • 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.)

      • getData

        public List<Reference> getData()
        Returns:
        data (The actual data of the message - a reference to the root/focus class of the event.)

      • hasData

        public boolean hasData()

      • addData

        public Reference addData()
        Returns:
        data (The actual data of the message - a reference to the root/focus class of the event.)

      • getDataTarget

        public List<Resource> getDataTarget()
        Returns:
        data (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. The actual data of the message - a reference to the root/focus class of the event.)

      • isEmpty

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