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 that was notified about a reportable condition.
See Also:
  • Field Details

    • identifier

      Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
    • instantiatesCanonical

      The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
    • instantiatesUri

      The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
    • 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.)
    • inResponseTo

      Prior communication that this communication is in response to.
    • inResponseToTarget

      The actual objects that are the target of the reference (Prior communication that this communication is in response to.)
    • status

      The status of the transmission.
    • statusReason

      Captures the reason for the current state of the Communication.
    • category

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

      Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
    • 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.)
    • topic

      Description of the purpose/content, similar to a subject line in an email.
    • about

      protected List<Reference> about
      Other resources that pertain to this communication and to which this communication should be associated.
    • aboutTarget

      The actual objects that are the target of the reference (Other resources that pertain to this communication and to which this communication should be associated.)
    • encounter

      protected Reference encounter
      The Encounter during which this Communication was created or to which the creation of this record is tightly associated.
    • encounterTarget

      The actual object that is the target of the reference (The Encounter during which this Communication was created or to which the creation of this record is tightly associated.)
    • sent

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

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

      protected List<Reference> recipient
      The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt 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, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).)
    • 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:
    • 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:
    • 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_INSTANTIATES_CANONICAL

      public static final String SP_INSTANTIATES_CANONICAL
      Search parameter: instantiates-canonical

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

      See Also:
    • INSTANTIATES_CANONICAL

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INSTANTIATES_CANONICAL
      Fluent Client search parameter constant for instantiates-canonical

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

    • INCLUDE_INSTANTIATES_CANONICAL

      public static final ca.uhn.fhir.model.api.Include INCLUDE_INSTANTIATES_CANONICAL
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:instantiates-canonical".
    • SP_RECEIVED

      public static final String SP_RECEIVED
      Search parameter: received

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

      See Also:
    • 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:
    • 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:
    • 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 created as part of
      Type: reference
      Path: Communication.encounter

      See Also:
    • ENCOUNTER

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

      Description: Encounter created as part of
      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".
    • SP_SENT

      public static final String SP_SENT
      Search parameter: sent

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

      See Also:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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_INSTANTIATES_URI

      public static final String SP_INSTANTIATES_URI
      Search parameter: instantiates-uri

      Description: Instantiates external protocol or definition
      Type: uri
      Path: Communication.instantiatesUri

      See Also:
    • INSTANTIATES_URI

      public static final ca.uhn.fhir.rest.gclient.UriClientParam INSTANTIATES_URI
      Fluent Client search parameter constant for instantiates-uri

      Description: Instantiates external protocol or definition
      Type: uri
      Path: Communication.instantiatesUri

    • SP_CATEGORY

      public static final String SP_CATEGORY
      Search parameter: category

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

      See Also:
    • 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 | not-done | on-hold | stopped | completed | entered-in-error | unknown
      Type: token
      Path: Communication.status

      See Also:
    • STATUS

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

      Description: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
      Type: token
      Path: Communication.status

  • Constructor Details

  • Method Details