Class Communication

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class Communication
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR Communication Resource ()

    Definition: An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.

    Requirements:

    Profile Definition: http://hl7.org/fhir/profiles/Communication

    See Also:
    Serialized Form
    • Field Detail

      • IDENTIFIER

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

        Description:
        Type: token
        Path: Communication.identifier

      • CATEGORY

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

        Description:
        Type: token
        Path: Communication.category

      • SENDER

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

        Description:
        Type: reference
        Path: Communication.sender

      • RECIPIENT

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

        Description:
        Type: reference
        Path: Communication.recipient

      • MEDIUM

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

        Description:
        Type: token
        Path: Communication.medium

      • STATUS

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

        Description:
        Type: token
        Path: Communication.status

      • ENCOUNTER

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

        Description:
        Type: reference
        Path: Communication.encounter

      • SENT

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

        Description:
        Type: date
        Path: Communication.sent

      • RECEIVED

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

        Description:
        Type: date
        Path: Communication.received

      • SUBJECT

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

        Description:
        Type: reference
        Path: Communication.subject

      • PATIENT

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

        Description:
        Type: reference
        Path: Communication.subject

      • REQUEST

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

        Description:
        Type: reference
        Path: Communication.requestDetail

      • INCLUDE_ENCOUNTER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:encounter".
      • INCLUDE_PATIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:patient".
      • INCLUDE_RECIPIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_RECIPIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:recipient".
      • INCLUDE_REQUEST

        public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUEST
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:request".
      • 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 "Communication:sender".
      • INCLUDE_SUBJECT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:subject".
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.

        Definition: Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

      • setIdentifier

        public Communication setIdentifier​(List<IdentifierDt> theValue)
        Sets the value(s) for identifier ()

        Definition: Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

      • addIdentifier

        public IdentifierDt addIdentifier()
        Adds and returns a new value for identifier ()

        Definition: Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

      • addIdentifier

        public Communication addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier ()

        Definition: Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

        Parameters:
        theValue - The identifier to add (must not be null)
      • getIdentifierFirstRep

        public IdentifierDt getIdentifierFirstRep()
        Gets the first repetition for identifier (), creating it if it does not already exist.

        Definition: Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

      • getCategory

        public CodeableConceptDt getCategory()
        Gets the value(s) for category (). creating it if it does not exist. Will not return null.

        Definition: The type of message conveyed such as alert, notification, reminder, instruction, etc.

      • setCategory

        public Communication setCategory​(CodeableConceptDt theValue)
        Sets the value(s) for category ()

        Definition: The type of message conveyed such as alert, notification, reminder, instruction, etc.

      • getSender

        public ResourceReferenceDt getSender()
        Gets the value(s) for sender (). creating it if it does not exist. Will not return null.

        Definition: The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.

      • setSender

        public Communication setSender​(ResourceReferenceDt theValue)
        Sets the value(s) for sender ()

        Definition: The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.

      • getRecipient

        public List<ResourceReferenceDtgetRecipient()
        Gets the value(s) for recipient (). creating it if it does not exist. Will not return null.

        Definition: The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient.  Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).

      • setRecipient

        public Communication setRecipient​(List<ResourceReferenceDt> theValue)
        Sets the value(s) for recipient ()

        Definition: The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient.  Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).

      • addRecipient

        public ResourceReferenceDt addRecipient()
        Adds and returns a new value for recipient ()

        Definition: The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient.  Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).

      • getPayload

        public List<Communication.PayloadgetPayload()
        Gets the value(s) for payload (). creating it if it does not exist. Will not return null.

        Definition: Text, attachment(s), or resource(s) that was communicated to the recipient.

      • addPayload

        public Communication.Payload addPayload()
        Adds and returns a new value for payload ()

        Definition: Text, attachment(s), or resource(s) that was communicated to the recipient.

      • addPayload

        public Communication addPayload​(Communication.Payload theValue)
        Adds a given new value for payload ()

        Definition: Text, attachment(s), or resource(s) that was communicated to the recipient.

        Parameters:
        theValue - The payload to add (must not be null)
      • getPayloadFirstRep

        public Communication.Payload getPayloadFirstRep()
        Gets the first repetition for payload (), creating it if it does not already exist.

        Definition: Text, attachment(s), or resource(s) that was communicated to the recipient.

      • getMedium

        public List<CodeableConceptDtgetMedium()
        Gets the value(s) for medium (). creating it if it does not exist. Will not return null.

        Definition: A channel that was used for this communication (e.g. email, fax).

      • addMedium

        public CodeableConceptDt addMedium()
        Adds and returns a new value for medium ()

        Definition: A channel that was used for this communication (e.g. email, fax).

      • addMedium

        public Communication addMedium​(CodeableConceptDt theValue)
        Adds a given new value for medium ()

        Definition: A channel that was used for this communication (e.g. email, fax).

        Parameters:
        theValue - The medium to add (must not be null)
      • getMediumFirstRep

        public CodeableConceptDt getMediumFirstRep()
        Gets the first repetition for medium (), creating it if it does not already exist.

        Definition: A channel that was used for this communication (e.g. email, fax).

      • getStatusElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<CommunicationStatusEnumgetStatusElement()
        Gets the value(s) for status (). creating it if it does not exist. Will not return null.

        Definition: The status of the transmission.

      • getStatus

        public String getStatus()
        Gets the value(s) for status (). creating it if it does not exist. This method may return null.

        Definition: The status of the transmission.

      • getEncounter

        public ResourceReferenceDt getEncounter()
        Gets the value(s) for encounter (). creating it if it does not exist. Will not return null.

        Definition: The encounter within which the communication was sent.

      • getSentElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getSentElement()
        Gets the value(s) for sent (). creating it if it does not exist. Will not return null.

        Definition: The time when this communication was sent.

      • getSent

        public Date getSent()
        Gets the value(s) for sent (). creating it if it does not exist. This method may return null.

        Definition: The time when this communication was sent.

      • setSent

        public Communication setSent​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for sent ()

        Definition: The time when this communication was sent.

      • setSent

        public Communication setSent​(Date theDate,
                                     ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for sent ()

        Definition: The time when this communication was sent.

      • getReceivedElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getReceivedElement()
        Gets the value(s) for received (). creating it if it does not exist. Will not return null.

        Definition: The time when this communication arrived at the destination.

      • getReceived

        public Date getReceived()
        Gets the value(s) for received (). creating it if it does not exist. This method may return null.

        Definition: The time when this communication arrived at the destination.

      • setReceived

        public Communication setReceived​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for received ()

        Definition: The time when this communication arrived at the destination.

      • setReceived

        public Communication setReceived​(Date theDate,
                                         ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for received ()

        Definition: The time when this communication arrived at the destination.

      • getReason

        public List<CodeableConceptDtgetReason()
        Gets the value(s) for reason (). creating it if it does not exist. Will not return null.

        Definition: The reason or justification for the communication.

      • addReason

        public CodeableConceptDt addReason()
        Adds and returns a new value for reason ()

        Definition: The reason or justification for the communication.

      • addReason

        public Communication addReason​(CodeableConceptDt theValue)
        Adds a given new value for reason ()

        Definition: The reason or justification for the communication.

        Parameters:
        theValue - The reason to add (must not be null)
      • getReasonFirstRep

        public CodeableConceptDt getReasonFirstRep()
        Gets the first repetition for reason (), creating it if it does not already exist.

        Definition: The reason or justification for the communication.

      • getSubject

        public ResourceReferenceDt getSubject()
        Gets the value(s) for subject (). creating it if it does not exist. Will not return null.

        Definition: The patient who was the focus of this communication.

      • getRequestDetail

        public ResourceReferenceDt getRequestDetail()
        Gets the value(s) for requestDetail (). creating it if it does not exist. Will not return null.

        Definition: The communication request that was responsible for producing this communication.

      • getResourceName

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource