Class Communication

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.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 Details

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter constant for identifier

      Description:
      Type: token
      Path: Communication.identifier

      See Also:
      Constant Field Values
    • IDENTIFIER

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

      Description:
      Type: token
      Path: Communication.identifier

    • SP_CATEGORY

      public static final String SP_CATEGORY
      Search parameter constant for category

      Description:
      Type: token
      Path: Communication.category

      See Also:
      Constant Field Values
    • CATEGORY

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

      Description:
      Type: token
      Path: Communication.category

    • SP_SENDER

      public static final String SP_SENDER
      Search parameter constant for sender

      Description:
      Type: reference
      Path: Communication.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:
      Type: reference
      Path: Communication.sender

    • SP_RECIPIENT

      public static final String SP_RECIPIENT
      Search parameter constant for recipient

      Description:
      Type: reference
      Path: Communication.recipient

      See Also:
      Constant Field Values
    • RECIPIENT

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

      Description:
      Type: reference
      Path: Communication.recipient

    • SP_MEDIUM

      public static final String SP_MEDIUM
      Search parameter constant for medium

      Description:
      Type: token
      Path: Communication.medium

      See Also:
      Constant Field Values
    • MEDIUM

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

      Description:
      Type: token
      Path: Communication.medium

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter constant for status

      Description:
      Type: token
      Path: Communication.status

      See Also:
      Constant Field Values
    • STATUS

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

      Description:
      Type: token
      Path: Communication.status

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter constant for encounter

      Description:
      Type: reference
      Path: Communication.encounter

      See Also:
      Constant Field Values
    • ENCOUNTER

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

      Description:
      Type: reference
      Path: Communication.encounter

    • SP_SENT

      public static final String SP_SENT
      Search parameter constant for sent

      Description:
      Type: date
      Path: Communication.sent

      See Also:
      Constant Field Values
    • SENT

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

      Description:
      Type: date
      Path: Communication.sent

    • SP_RECEIVED

      public static final String SP_RECEIVED
      Search parameter constant for received

      Description:
      Type: date
      Path: Communication.received

      See Also:
      Constant Field Values
    • RECEIVED

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

      Description:
      Type: date
      Path: Communication.received

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter constant for subject

      Description:
      Type: reference
      Path: Communication.subject

      See Also:
      Constant Field Values
    • SUBJECT

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

      Description:
      Type: reference
      Path: Communication.subject

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter constant for patient

      Description:
      Type: reference
      Path: Communication.subject

      See Also:
      Constant Field Values
    • PATIENT

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

      Description:
      Type: reference
      Path: Communication.subject

    • SP_REQUEST

      public static final String SP_REQUEST
      Search parameter constant for request

      Description:
      Type: reference
      Path: Communication.requestDetail

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

  • Method Details

    • 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

      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

      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

      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

      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

      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

      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

      Sets the value(s) for category ()

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

    • 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

      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

      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

      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

      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

      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.

    • setPayload

      Sets the value(s) for payload ()

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

    • addPayload

      Adds and returns a new value for payload ()

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

    • addPayload

      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

      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

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

    • setMedium

      Sets the value(s) for medium ()

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

    • addMedium

      Adds and returns a new value for medium ()

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

    • addMedium

      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

      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<CommunicationStatusEnum> getStatusElement()
      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.

    • setStatus

      public Communication setStatus(ca.uhn.fhir.model.primitive.BoundCodeDt<CommunicationStatusEnum> theValue)
      Sets the value(s) for status ()

      Definition: The status of the transmission.

    • setStatus

      Sets the value(s) for status ()

      Definition: The status of the transmission.

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

    • setEncounter

      Sets the value(s) for encounter ()

      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.

    • setSentWithSecondsPrecision

      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.

    • setReceivedWithSecondsPrecision

      Sets the value for received ()

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

    • getReason

      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.

    • setReason

      Sets the value(s) for reason ()

      Definition: The reason or justification for the communication.

    • addReason

      Adds and returns a new value for reason ()

      Definition: The reason or justification for the communication.

    • addReason

      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

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

      Definition: The reason or justification for the communication.

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

    • setSubject

      Sets the value(s) for subject ()

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

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

    • setRequestDetail

      Sets the value(s) for requestDetail ()

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

    • 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