Package com.ibm.fhir.model.resource

Class CommunicationRequest

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class CommunicationRequest
extends DomainResource
    A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

    Maturity level: FMM2 (Trial Use)

    • Method Detail

      • getIdentifier

        public List<Identifier> getIdentifier()
        Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getBasedOn

        public List<Reference> getBasedOn()
        A plan or proposal that is fulfilled in whole or in part by this request.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getReplaces

        public List<Reference> getReplaces()
        Completed or terminated request(s) whose function is taken by this new request.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getGroupIdentifier

        public Identifier getGroupIdentifier()
        A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
        Returns:
        An immutable object of type Identifier that may be null.

      • getStatusReason

        public CodeableConcept getStatusReason()
        Captures the reason for the current state of the CommunicationRequest.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getCategory

        public List<CodeableConcept> getCategory()
        The type of message to be sent such as alert, notification, reminder, instruction, etc.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getPriority

        public CommunicationPriority getPriority()
        Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
        Returns:
        An immutable object of type CommunicationPriority that may be null.

      • getDoNotPerform

        public Boolean getDoNotPerform()
        If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.
        Returns:
        An immutable object of type Boolean that may be null.

      • getMedium

        public List<CodeableConcept> getMedium()
        A channel that was used for this communication (e.g. email, fax).
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getSubject

        public Reference getSubject()
        The patient or group that is the focus of this communication request.
        Returns:
        An immutable object of type Reference that may be null.

      • getAbout

        public List<Reference> getAbout()
        Other resources that pertain to this communication request and to which this communication request should be associated.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getEncounter

        public Reference getEncounter()
        The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.
        Returns:
        An immutable object of type Reference that may be null.

      • getOccurrence

        public Element getOccurrence()
        The time when this communication is to occur.
        Returns:
        An immutable object of type Element that may be null.

      • getAuthoredOn

        public DateTime getAuthoredOn()
        For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
        Returns:
        An immutable object of type DateTime that may be null.

      • getRequester

        public Reference getRequester()
        The device, individual, or organization who initiated the request and has responsibility for its activation.
        Returns:
        An immutable object of type Reference that may be null.

      • getRecipient

        public List<Reference> getRecipient()
        The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getSender

        public Reference getSender()
        The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
        Returns:
        An immutable object of type Reference that may be null.

      • getReasonCode

        public List<CodeableConcept> getReasonCode()
        Describes why the request is being made in coded or textual form.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getReasonReference

        public List<Reference> getReasonReference()
        Indicates another resource whose existence justifies this request.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getNote

        public List<Annotation> getNote()
        Comments made about the request by the requester, sender, recipient, subject or other participants.
        Returns:
        An unmodifiable list containing immutable objects of type Annotation that may be empty.

      • accept

        public void accept​(String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object