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 Details

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

      A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.
    • definitionTarget

      The actual objects that are the target of the reference (A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.)
    • basedOn

      protected List<Reference> basedOn
      An order, proposal or plan fulfilled in whole or in part by this Communication.
    • basedOnTarget

      The actual objects that are the target of the reference (An order, proposal or plan fulfilled in whole or in part by this Communication.)
    • partOf

      protected List<Reference> partOf
      Part of this action.
    • partOfTarget

      The actual objects that are the target of the reference (Part of this action.)
    • status

      The status of the transmission.
    • notDone

      protected BooleanType notDone
      If true, indicates that the described communication event did not actually occur.
    • notDoneReason

      Describes why the communication event did not occur in coded and/or textual form.
    • category

      The type of message conveyed such as alert, notification, reminder, instruction, etc.
    • medium

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

      protected Reference subject
      The patient or group that was the focus of this communication.
    • subjectTarget

      The actual object that is the target of the reference (The patient or group that was the focus of this 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

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

      protected List<Reference> topic
      The resources which were responsible for or related to producing this communication.
    • topicTarget

      The actual objects that are the target of the reference (The resources which were responsible for or related to producing this communication.)
    • context

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

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

      protected DateTimeType sent
      The time when this communication was sent.
    • received

      The time when this communication arrived at the destination.
    • sender

      protected Reference sender
      The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
    • 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.)
    • reasonCode

      The reason or justification for the communication.
    • reasonReference

      Indicates another resource whose existence justifies this communication.
    • reasonReferenceTarget

      The actual objects that are the target of the reference (Indicates another resource whose existence justifies this communication.)
    • payload

      Text, attachment(s), or resource(s) that was communicated to the recipient.
    • note

      protected List<Annotation> note
      Additional notes or commentary about the communication by the sender, receiver or other interested parties.
    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: Unique identifier
      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: Unique identifier
      Type: token
      Path: Communication.identifier

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

      Description: Focus of message
      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: 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_RECEIVED

      public static final String SP_RECEIVED
      Search parameter: received

      Description: When received
      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: When received
      Type: date
      Path: Communication.received

    • SP_PART_OF

      public static final String SP_PART_OF
      Search parameter: part-of

      Description: Part of this action
      Type: reference
      Path: Communication.partOf

      See Also:
      Constant Field Values
    • PART_OF

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PART_OF
      Fluent Client search parameter constant for part-of

      Description: Part of this action
      Type: reference
      Path: Communication.partOf

    • INCLUDE_PART_OF

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

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter: encounter

      Description: Encounter leading to message
      Type: reference
      Path: Communication.context

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

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

      public static final String SP_SENT
      Search parameter: sent

      Description: When sent
      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: When sent
      Type: date
      Path: Communication.sent

    • SP_BASED_ON

      public static final String SP_BASED_ON
      Search parameter: based-on

      Description: Request fulfilled by this communication
      Type: reference
      Path: Communication.basedOn

      See Also:
      Constant Field Values
    • BASED_ON

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON
      Fluent Client search parameter constant for based-on

      Description: Request fulfilled by this communication
      Type: reference
      Path: Communication.basedOn

    • INCLUDE_BASED_ON

      public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:based-on".
    • SP_SENDER

      public static final String SP_SENDER
      Search parameter: sender

      Description: Message sender
      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: 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".
    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: Focus of message
      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: 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_RECIPIENT

      public static final String SP_RECIPIENT
      Search parameter: recipient

      Description: Message recipient
      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: 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".
    • SP_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: Encounter or episode leading to message
      Type: reference
      Path: Communication.context

      See Also:
      Constant Field Values
    • CONTEXT

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

      Description: Encounter or episode leading to message
      Type: reference
      Path: Communication.context

    • INCLUDE_CONTEXT

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

      public static final String SP_DEFINITION
      Search parameter: definition

      Description: Instantiates protocol or definition
      Type: reference
      Path: Communication.definition

      See Also:
      Constant Field Values
    • DEFINITION

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

      Description: Instantiates protocol or definition
      Type: reference
      Path: Communication.definition

    • INCLUDE_DEFINITION

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

      public static final String SP_CATEGORY
      Search parameter: category

      Description: Message category
      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: Message category
      Type: token
      Path: Communication.category

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: preparation | in-progress | suspended | aborted | completed | entered-in-error
      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: preparation | in-progress | suspended | aborted | completed | entered-in-error
      Type: token
      Path: Communication.status

  • Constructor Details

  • Method Details