Communication (HAPI FHIR Structures - DSTU2.1 (2016May) 3.3.0 API)

java.lang.Object
- org.hl7.fhir.dstu2016may.model.Base
- - org.hl7.fhir.dstu2016may.model.BaseResource
  - - org.hl7.fhir.dstu2016may.model.Resource
    - - org.hl7.fhir.dstu2016may.model.DomainResource
      - org.hl7.fhir.dstu2016may.model.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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Communication.CommunicationPayloadComponent`
`static class`	`Communication.CommunicationStatus`
`static class`	`Communication.CommunicationStatusEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`protected CodeableConcept`	`category` The type of message conveyed such as alert, notification, reminder, instruction, etc.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`CATEGORY` Fluent Client search parameter constant for category
`protected Reference`	`encounter` The encounter within which the communication was sent.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ENCOUNTER` Fluent Client search parameter constant for encounter
`protected Encounter`	`encounterTarget` The actual object that is the target of the reference (The encounter within which the communication was sent.)
`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.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ENCOUNTER` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_RECIPIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_REQUEST` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SENDER` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`protected List<CodeableConcept>`	`medium` A channel that was used for this communication (e.g.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`MEDIUM` Fluent Client search parameter constant for medium
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`protected List<Communication.CommunicationPayloadComponent>`	`payload` Text, attachment(s), or resource(s) that was communicated to the recipient.
`protected List<CodeableConcept>`	`reason` The reason or justification for the communication.
`protected DateTimeType`	`received` The time when this communication arrived at the destination.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`RECEIVED` Fluent Client search parameter constant for received
`protected List<Reference>`	`recipient` The entity (e.g.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`RECIPIENT` Fluent Client search parameter constant for recipient
`protected List<Resource>`	`recipientTarget` The actual objects that are the target of the reference (The entity (e.g.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`REQUEST` Fluent Client search parameter constant for request
`protected Reference`	`requestDetail` The communication request that was responsible for producing this communication.
`protected CommunicationRequest`	`requestDetailTarget` The actual object that is the target of the reference (The communication request that was responsible for producing this communication.)
`protected Reference`	`sender` The entity (e.g.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SENDER` Fluent Client search parameter constant for sender
`protected Resource`	`senderTarget` The actual object that is the target of the reference (The entity (e.g.
`protected DateTimeType`	`sent` The time when this communication was sent.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`SENT` Fluent Client search parameter constant for sent
`static String`	`SP_CATEGORY` Search parameter: category
`static String`	`SP_ENCOUNTER` Search parameter: encounter
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_MEDIUM` Search parameter: medium
`static String`	`SP_PATIENT` Search parameter: patient
`static String`	`SP_RECEIVED` Search parameter: received
`static String`	`SP_RECIPIENT` Search parameter: recipient
`static String`	`SP_REQUEST` Search parameter: request
`static String`	`SP_SENDER` Search parameter: sender
`static String`	`SP_SENT` Search parameter: sent
`static String`	`SP_STATUS` Search parameter: status
`static String`	`SP_SUBJECT` Search parameter: subject
`protected Enumeration<Communication.CommunicationStatus>`	`status` The status of the transmission.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`protected Reference`	`subject` The patient who was the focus of this communication.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`protected Patient`	`subjectTarget` The actual object that is the target of the reference (The patient who was the focus of this communication.)

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

Communication()
Constructor

Constructors
Constructor and Description
`Communication()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Identifier`	`addIdentifier()`
`Communication`	`addIdentifier(Identifier t)`
`CodeableConcept`	`addMedium()`
`Communication`	`addMedium(CodeableConcept t)`
`Communication.CommunicationPayloadComponent`	`addPayload()`
`Communication`	`addPayload(Communication.CommunicationPayloadComponent t)`
`CodeableConcept`	`addReason()`
`Communication`	`addReason(CodeableConcept t)`
`Reference`	`addRecipient()`
`Communication`	`addRecipient(Reference t)`
`Communication`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`CodeableConcept`	`getCategory()`
`Reference`	`getEncounter()`
`Encounter`	`getEncounterTarget()`
`List<Identifier>`	`getIdentifier()`
`List<CodeableConcept>`	`getMedium()`
`List<Communication.CommunicationPayloadComponent>`	`getPayload()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<CodeableConcept>`	`getReason()`
`Date`	`getReceived()`
`DateTimeType`	`getReceivedElement()`
`List<Reference>`	`getRecipient()`
`List<Resource>`	`getRecipientTarget()`
`Reference`	`getRequestDetail()`
`CommunicationRequest`	`getRequestDetailTarget()`
`ResourceType`	`getResourceType()`
`Reference`	`getSender()`
`Resource`	`getSenderTarget()`
`Date`	`getSent()`
`DateTimeType`	`getSentElement()`
`Communication.CommunicationStatus`	`getStatus()`
`Enumeration<Communication.CommunicationStatus>`	`getStatusElement()`
`Reference`	`getSubject()`
`Patient`	`getSubjectTarget()`
`boolean`	`hasCategory()`
`boolean`	`hasEncounter()`
`boolean`	`hasIdentifier()`
`boolean`	`hasMedium()`
`boolean`	`hasPayload()`
`boolean`	`hasReason()`
`boolean`	`hasReceived()`
`boolean`	`hasReceivedElement()`
`boolean`	`hasRecipient()`
`boolean`	`hasRequestDetail()`
`boolean`	`hasSender()`
`boolean`	`hasSent()`
`boolean`	`hasSentElement()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasSubject()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`Communication`	`setCategory(CodeableConcept value)`
`Communication`	`setEncounter(Reference value)`
`Communication`	`setEncounterTarget(Encounter value)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base value)`
`Communication`	`setReceived(Date value)`
`Communication`	`setReceivedElement(DateTimeType value)`
`Communication`	`setRequestDetail(Reference value)`
`Communication`	`setRequestDetailTarget(CommunicationRequest value)`
`Communication`	`setSender(Reference value)`
`Communication`	`setSenderTarget(Resource value)`
`Communication`	`setSent(Date value)`
`Communication`	`setSentElement(DateTimeType value)`
`Communication`	`setStatus(Communication.CommunicationStatus value)`
`Communication`	`setStatusElement(Enumeration<Communication.CommunicationStatus> value)`
`Communication`	`setSubject(Reference value)`
`Communication`	`setSubjectTarget(Patient value)`
`protected Communication`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource
getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- 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).)
  - payload
```
protected List<Communication.CommunicationPayloadComponent> payload
```
    Text, attachment(s), or resource(s) that was communicated to the recipient.
  - medium
```
protected List<CodeableConcept> medium
```
    A channel that was used for this communication (e.g. email, fax).
  - status
```
protected Enumeration<Communication.CommunicationStatus> status
```
    The status of the transmission.
  - 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.)
  - sent
```
protected DateTimeType sent
```
    The time when this communication was sent.
  - received
```
protected DateTimeType received
```
    The time when this communication arrived at the destination.
  - reason
```
protected List<CodeableConcept> reason
```
    The reason or justification for the communication.
  - 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.)
  - 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_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_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_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_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
  - 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_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".
  - 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_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".
  - 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_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_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".
- Constructor Detail
  - Communication
```
public Communication()
```
    Constructor
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    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).)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    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).)
  - addIdentifier
```
public Communication addIdentifier(Identifier t)
```
  - getCategory
```
public CodeableConcept getCategory()
```
    Returns:
    
    category (The type of message conveyed such as alert, notification, reminder, instruction, etc.)
  - hasCategory
```
public boolean hasCategory()
```
  - setCategory
```
public Communication setCategory(CodeableConcept value)
```
    Parameters:
    
    value - category (The type of message conveyed such as alert, notification, reminder, instruction, etc.)
  - getSender
```
public Reference getSender()
```
    Returns:
    
    sender (The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.)
  - hasSender
```
public boolean hasSender()
```
  - setSender
```
public Communication setSender(Reference value)
```
    Parameters:
    
    value - sender (The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.)
  - getSenderTarget
```
public Resource getSenderTarget()
```
    Returns:
    
    sender The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.)
  - setSenderTarget
```
public Communication setSenderTarget(Resource value)
```
    Parameters:
    
    value - sender The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.)
  - getRecipient
```
public List<Reference> getRecipient()
```
    Returns:
    
    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).)
  - hasRecipient
```
public boolean hasRecipient()
```
  - addRecipient
```
public Reference addRecipient()
```
    Returns:
    
    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).)
  - addRecipient
```
public Communication addRecipient(Reference t)
```
  - getRecipientTarget
```
public List<Resource> getRecipientTarget()
```
    Returns:
    
    recipient (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. 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.CommunicationPayloadComponent> getPayload()
```
    Returns:
    
    payload (Text, attachment(s), or resource(s) that was communicated to the recipient.)
  - hasPayload
```
public boolean hasPayload()
```
  - addPayload
```
public Communication.CommunicationPayloadComponent addPayload()
```
    Returns:
    
    payload (Text, attachment(s), or resource(s) that was communicated to the recipient.)
  - addPayload
```
public Communication addPayload(Communication.CommunicationPayloadComponent t)
```
  - getMedium
```
public List<CodeableConcept> getMedium()
```
    Returns:
    
    medium (A channel that was used for this communication (e.g. email, fax).)
  - hasMedium
```
public boolean hasMedium()
```
  - addMedium
```
public CodeableConcept addMedium()
```
    Returns:
    
    medium (A channel that was used for this communication (e.g. email, fax).)
  - addMedium
```
public Communication addMedium(CodeableConcept t)
```
  - getStatusElement
```
public Enumeration<Communication.CommunicationStatus> getStatusElement()
```
    Returns:
    
    status (The status of the transmission.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - setStatusElement
```
public Communication setStatusElement(Enumeration<Communication.CommunicationStatus> value)
```
    Parameters:
    
    value - status (The status of the transmission.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public Communication.CommunicationStatus getStatus()
```
    Returns:
    
    The status of the transmission.
  - setStatus
```
public Communication setStatus(Communication.CommunicationStatus value)
```
    Parameters:
    
    value - The status of the transmission.
  - getEncounter
```
public Reference getEncounter()
```
    Returns:
    
    encounter (The encounter within which the communication was sent.)
  - hasEncounter
```
public boolean hasEncounter()
```
  - setEncounter
```
public Communication setEncounter(Reference value)
```
    Parameters:
    
    value - encounter (The encounter within which the communication was sent.)
  - getEncounterTarget
```
public Encounter getEncounterTarget()
```
    Returns:
    
    encounter The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The encounter within which the communication was sent.)
  - setEncounterTarget
```
public Communication setEncounterTarget(Encounter value)
```
    Parameters:
    
    value - encounter The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The encounter within which the communication was sent.)
  - getSentElement
```
public DateTimeType getSentElement()
```
    Returns:
    
    sent (The time when this communication was sent.). This is the underlying object with id, value and extensions. The accessor "getSent" gives direct access to the value
  - hasSentElement
```
public boolean hasSentElement()
```
  - hasSent
```
public boolean hasSent()
```
  - setSentElement
```
public Communication setSentElement(DateTimeType value)
```
    Parameters:
    
    value - sent (The time when this communication was sent.). This is the underlying object with id, value and extensions. The accessor "getSent" gives direct access to the value
  - getSent
```
public Date getSent()
```
    Returns:
    
    The time when this communication was sent.
  - setSent
```
public Communication setSent(Date value)
```
    Parameters:
    
    value - The time when this communication was sent.
  - getReceivedElement
```
public DateTimeType getReceivedElement()
```
    Returns:
    
    received (The time when this communication arrived at the destination.). This is the underlying object with id, value and extensions. The accessor "getReceived" gives direct access to the value
  - hasReceivedElement
```
public boolean hasReceivedElement()
```
  - hasReceived
```
public boolean hasReceived()
```
  - setReceivedElement
```
public Communication setReceivedElement(DateTimeType value)
```
    Parameters:
    
    value - received (The time when this communication arrived at the destination.). This is the underlying object with id, value and extensions. The accessor "getReceived" gives direct access to the value
  - getReceived
```
public Date getReceived()
```
    Returns:
    
    The time when this communication arrived at the destination.
  - setReceived
```
public Communication setReceived(Date value)
```
    Parameters:
    
    value - The time when this communication arrived at the destination.
  - getReason
```
public List<CodeableConcept> getReason()
```
    Returns:
    
    reason (The reason or justification for the communication.)
  - hasReason
```
public boolean hasReason()
```
  - addReason
```
public CodeableConcept addReason()
```
    Returns:
    
    reason (The reason or justification for the communication.)
  - addReason
```
public Communication addReason(CodeableConcept t)
```
  - getSubject
```
public Reference getSubject()
```
    Returns:
    
    subject (The patient who was the focus of this communication.)
  - hasSubject
```
public boolean hasSubject()
```
  - setSubject
```
public Communication setSubject(Reference value)
```
    Parameters:
    
    value - subject (The patient who was the focus of this communication.)
  - getSubjectTarget
```
public Patient getSubjectTarget()
```
    Returns:
    
    subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The patient who was the focus of this communication.)
  - setSubjectTarget
```
public Communication setSubjectTarget(Patient value)
```
    Parameters:
    
    value - subject The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The patient who was the focus of this communication.)
  - getRequestDetail
```
public Reference getRequestDetail()
```
    Returns:
    
    requestDetail (The communication request that was responsible for producing this communication.)
  - hasRequestDetail
```
public boolean hasRequestDetail()
```
  - setRequestDetail
```
public Communication setRequestDetail(Reference value)
```
    Parameters:
    
    value - requestDetail (The communication request that was responsible for producing this communication.)
  - getRequestDetailTarget
```
public CommunicationRequest getRequestDetailTarget()
```
    Returns:
    
    requestDetail The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The communication request that was responsible for producing this communication.)
  - setRequestDetailTarget
```
public Communication setRequestDetailTarget(CommunicationRequest value)
```
    Parameters:
    
    value - requestDetail The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The communication request that was responsible for producing this communication.)
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Communication copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected Communication typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class Communication

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Field Detail

identifier

category

sender

senderTarget

recipient

recipientTarget

payload

medium

status

encounter

encounterTarget

sent

received

reason

subject

subjectTarget

requestDetail

requestDetailTarget

SP_SENDER

SENDER

INCLUDE_SENDER

SP_SENT

SENT

SP_CATEGORY

CATEGORY

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_STATUS

STATUS

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_REQUEST

REQUEST

INCLUDE_REQUEST

SP_RECEIVED

RECEIVED

SP_ENCOUNTER

ENCOUNTER

INCLUDE_ENCOUNTER

SP_IDENTIFIER

IDENTIFIER

SP_MEDIUM

MEDIUM

SP_RECIPIENT

RECIPIENT

INCLUDE_RECIPIENT

Constructor Detail

Communication

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getCategory

hasCategory

setCategory

getSender

hasSender

setSender

getSenderTarget