Class Communication

  • 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 Communication
    extends DomainResource
    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.
    See Also:
    Serialized Form
    • Field Detail

      • identifier

        protected List<Identifier> identifier
        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).
      • category

        protected CodeableConcept category
        The type of message conveyed such as alert, notification, reminder, instruction, etc.
      • sender

        protected Reference sender
        The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
      • senderTarget

        protected Resource senderTarget
        The actual object that is the target of the reference (The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.)
      • recipient

        protected List<Reference> recipient
        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).
      • recipientTarget

        protected List<Resource> recipientTarget
        The actual objects that are the target of the reference (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).)
      • encounter

        protected Reference encounter
        The encounter within which the communication was sent.
      • encounterTarget

        protected Encounter encounterTarget
        The actual object that is the target of the reference (The encounter within which the communication was sent.)
      • received

        protected DateTimeType received
        The time when this communication arrived at the destination.
      • subject

        protected Reference subject
        The patient who was the focus of this communication.
      • subjectTarget

        protected Patient subjectTarget
        The actual object that is the target of the reference (The patient who was the focus of this communication.)
      • requestDetail

        protected Reference requestDetail
        The communication request that was responsible for producing this communication.
      • requestDetailTarget

        protected CommunicationRequest requestDetailTarget
        The actual object that is the target of the reference (The communication request that was responsible for producing this communication.)
      • SENDER

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

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

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

        Description: When sent
        Type: date
        Path: Communication.sent

      • CATEGORY

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

        Description: Message category
        Type: token
        Path: Communication.category

      • PATIENT

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

        Description: Focus of message
        Type: reference
        Path: Communication.subject

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

        public static final String SP_STATUS
        Search parameter: status

        Description: in-progress | completed | suspended | rejected | failed
        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: in-progress | completed | suspended | rejected | failed
        Type: token
        Path: Communication.status

      • SUBJECT

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

        Description: Focus of message
        Type: reference
        Path: Communication.subject

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

        public static final String SP_REQUEST
        Search parameter: request

        Description: CommunicationRequest producing this message
        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: CommunicationRequest producing this message
        Type: reference
        Path: Communication.requestDetail

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

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

        Description: When received
        Type: date
        Path: Communication.received

      • SP_ENCOUNTER

        public static final String SP_ENCOUNTER
        Search parameter: encounter

        Description: Encounter leading to message
        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: Encounter leading to message
        Type: reference
        Path: Communication.encounter

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

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

        Description: Unique identifier
        Type: token
        Path: Communication.identifier

      • SP_MEDIUM

        public static final String SP_MEDIUM
        Search parameter: medium

        Description: A channel of communication
        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: A channel of communication
        Type: token
        Path: Communication.medium

      • RECIPIENT

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

        Description: Message recipient
        Type: reference
        Path: Communication.recipient

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