public class Communication extends BaseResource implements IResource
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
| Modifier and Type | Class and Description |
|---|---|
static class |
Communication.Payload
Block class for child element: Communication.payload ()
|
| Modifier and Type | Field and Description |
|---|---|
static TokenClientParam |
CATEGORY
Fluent Client search parameter constant for category
|
static ReferenceClientParam |
ENCOUNTER
Fluent Client search parameter constant for encounter
|
static TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static Include |
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_RECIPIENT
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_REQUEST
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_SENDER
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.
|
static TokenClientParam |
MEDIUM
Fluent Client search parameter constant for medium
|
static ReferenceClientParam |
PATIENT
Fluent Client search parameter constant for patient
|
static DateClientParam |
RECEIVED
Fluent Client search parameter constant for received
|
static ReferenceClientParam |
RECIPIENT
Fluent Client search parameter constant for recipient
|
static ReferenceClientParam |
REQUEST
Fluent Client search parameter constant for request
|
static ReferenceClientParam |
SENDER
Fluent Client search parameter constant for sender
|
static DateClientParam |
SENT
Fluent Client search parameter constant for sent
|
static String |
SP_CATEGORY
Search parameter constant for category
|
static String |
SP_ENCOUNTER
Search parameter constant for encounter
|
static String |
SP_IDENTIFIER
Search parameter constant for identifier
|
static String |
SP_MEDIUM
Search parameter constant for medium
|
static String |
SP_PATIENT
Search parameter constant for patient
|
static String |
SP_RECEIVED
Search parameter constant for received
|
static String |
SP_RECIPIENT
Search parameter constant for recipient
|
static String |
SP_REQUEST
Search parameter constant for request
|
static String |
SP_SENDER
Search parameter constant for sender
|
static String |
SP_SENT
Search parameter constant for sent
|
static String |
SP_STATUS
Search parameter constant for status
|
static String |
SP_SUBJECT
Search parameter constant for subject
|
static TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
static ReferenceClientParam |
SUBJECT
Fluent Client search parameter constant for subject
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
Communication() |
| Modifier and Type | Method and Description |
|---|---|
IdentifierDt |
addIdentifier()
Adds and returns a new value for identifier ()
|
Communication |
addIdentifier(IdentifierDt theValue)
Adds a given new value for identifier ()
|
CodeableConceptDt |
addMedium()
Adds and returns a new value for medium ()
|
Communication |
addMedium(CodeableConceptDt theValue)
Adds a given new value for medium ()
|
Communication.Payload |
addPayload()
Adds and returns a new value for payload ()
|
Communication |
addPayload(Communication.Payload theValue)
Adds a given new value for payload ()
|
CodeableConceptDt |
addReason()
Adds and returns a new value for reason ()
|
Communication |
addReason(CodeableConceptDt theValue)
Adds a given new value for reason ()
|
ResourceReferenceDt |
addRecipient()
Adds and returns a new value for recipient ()
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
CodeableConceptDt |
getCategory()
Gets the value(s) for category ().
|
ResourceReferenceDt |
getEncounter()
Gets the value(s) for encounter ().
|
List<IdentifierDt> |
getIdentifier()
Gets the value(s) for identifier ().
|
IdentifierDt |
getIdentifierFirstRep()
Gets the first repetition for identifier (),
creating it if it does not already exist.
|
List<CodeableConceptDt> |
getMedium()
Gets the value(s) for medium ().
|
CodeableConceptDt |
getMediumFirstRep()
Gets the first repetition for medium (),
creating it if it does not already exist.
|
List<Communication.Payload> |
getPayload()
Gets the value(s) for payload ().
|
Communication.Payload |
getPayloadFirstRep()
Gets the first repetition for payload (),
creating it if it does not already exist.
|
List<CodeableConceptDt> |
getReason()
Gets the value(s) for reason ().
|
CodeableConceptDt |
getReasonFirstRep()
Gets the first repetition for reason (),
creating it if it does not already exist.
|
Date |
getReceived()
Gets the value(s) for received ().
|
DateTimeDt |
getReceivedElement()
Gets the value(s) for received ().
|
List<ResourceReferenceDt> |
getRecipient()
Gets the value(s) for recipient ().
|
ResourceReferenceDt |
getRequestDetail()
Gets the value(s) for requestDetail ().
|
String |
getResourceName() |
ResourceReferenceDt |
getSender()
Gets the value(s) for sender ().
|
Date |
getSent()
Gets the value(s) for sent ().
|
DateTimeDt |
getSentElement()
Gets the value(s) for sent ().
|
String |
getStatus()
Gets the value(s) for status ().
|
BoundCodeDt<CommunicationStatusEnum> |
getStatusElement()
Gets the value(s) for status ().
|
FhirVersionEnum |
getStructureFhirVersionEnum() |
ResourceReferenceDt |
getSubject()
Gets the value(s) for subject ().
|
boolean |
isEmpty() |
Communication |
setCategory(CodeableConceptDt theValue)
Sets the value(s) for category ()
|
Communication |
setEncounter(ResourceReferenceDt theValue)
Sets the value(s) for encounter ()
|
Communication |
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier ()
|
Communication |
setMedium(List<CodeableConceptDt> theValue)
Sets the value(s) for medium ()
|
Communication |
setPayload(List<Communication.Payload> theValue)
Sets the value(s) for payload ()
|
Communication |
setReason(List<CodeableConceptDt> theValue)
Sets the value(s) for reason ()
|
Communication |
setReceived(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for received ()
|
Communication |
setReceived(DateTimeDt theValue)
Sets the value(s) for received ()
|
Communication |
setReceivedWithSecondsPrecision(Date theDate)
Sets the value for received ()
|
Communication |
setRecipient(List<ResourceReferenceDt> theValue)
Sets the value(s) for recipient ()
|
Communication |
setRequestDetail(ResourceReferenceDt theValue)
Sets the value(s) for requestDetail ()
|
Communication |
setSender(ResourceReferenceDt theValue)
Sets the value(s) for sender ()
|
Communication |
setSent(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for sent ()
|
Communication |
setSent(DateTimeDt theValue)
Sets the value(s) for sent ()
|
Communication |
setSentWithSecondsPrecision(Date theDate)
Sets the value for sent ()
|
Communication |
setStatus(BoundCodeDt<CommunicationStatusEnum> theValue)
Sets the value(s) for status ()
|
Communication |
setStatus(CommunicationStatusEnum theValue)
Sets the value(s) for status ()
|
Communication |
setSubject(ResourceReferenceDt theValue)
Sets the value(s) for subject ()
|
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatagetIdElement, setId, setIdpublic static final String SP_IDENTIFIER
Description:
Type: token
Path: Communication.identifier
public static final TokenClientParam IDENTIFIER
Description:
Type: token
Path: Communication.identifier
public static final String SP_CATEGORY
Description:
Type: token
Path: Communication.category
public static final TokenClientParam CATEGORY
Description:
Type: token
Path: Communication.category
public static final String SP_SENDER
Description:
Type: reference
Path: Communication.sender
public static final ReferenceClientParam SENDER
Description:
Type: reference
Path: Communication.sender
public static final String SP_RECIPIENT
Description:
Type: reference
Path: Communication.recipient
public static final ReferenceClientParam RECIPIENT
Description:
Type: reference
Path: Communication.recipient
public static final String SP_MEDIUM
Description:
Type: token
Path: Communication.medium
public static final TokenClientParam MEDIUM
Description:
Type: token
Path: Communication.medium
public static final String SP_STATUS
Description:
Type: token
Path: Communication.status
public static final TokenClientParam STATUS
Description:
Type: token
Path: Communication.status
public static final String SP_ENCOUNTER
Description:
Type: reference
Path: Communication.encounter
public static final ReferenceClientParam ENCOUNTER
Description:
Type: reference
Path: Communication.encounter
public static final String SP_SENT
Description:
Type: date
Path: Communication.sent
public static final DateClientParam SENT
Description:
Type: date
Path: Communication.sent
public static final String SP_RECEIVED
Description:
Type: date
Path: Communication.received
public static final DateClientParam RECEIVED
Description:
Type: date
Path: Communication.received
public static final String SP_SUBJECT
Description:
Type: reference
Path: Communication.subject
public static final ReferenceClientParam SUBJECT
Description:
Type: reference
Path: Communication.subject
public static final String SP_PATIENT
Description:
Type: reference
Path: Communication.subject
public static final ReferenceClientParam PATIENT
Description:
Type: reference
Path: Communication.subject
public static final String SP_REQUEST
Description:
Type: reference
Path: Communication.requestDetail
public static final ReferenceClientParam REQUEST
Description:
Type: reference
Path: Communication.requestDetail
public static final Include INCLUDE_ENCOUNTER
public static final Include INCLUDE_PATIENT
public static final Include INCLUDE_RECIPIENT
public static final Include INCLUDE_REQUEST
public static final Include INCLUDE_SENDER
public static final Include INCLUDE_SUBJECT
public Communication()
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ICompositeElementpublic List<IdentifierDt> getIdentifier()
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).
public Communication setIdentifier(List<IdentifierDt> theValue)
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).
public IdentifierDt addIdentifier()
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).
public Communication addIdentifier(IdentifierDt theValue)
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).
theValue - The identifier to add (must not be null)public IdentifierDt getIdentifierFirstRep()
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).
public CodeableConceptDt getCategory()
null.
Definition: The type of message conveyed such as alert, notification, reminder, instruction, etc.
public Communication setCategory(CodeableConceptDt theValue)
Definition: The type of message conveyed such as alert, notification, reminder, instruction, etc.
public ResourceReferenceDt getSender()
null.
Definition: The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
public Communication setSender(ResourceReferenceDt theValue)
Definition: The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
public List<ResourceReferenceDt> getRecipient()
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).
public Communication setRecipient(List<ResourceReferenceDt> theValue)
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).
public ResourceReferenceDt addRecipient()
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).
public List<Communication.Payload> getPayload()
null.
Definition: Text, attachment(s), or resource(s) that was communicated to the recipient.
public Communication setPayload(List<Communication.Payload> theValue)
Definition: Text, attachment(s), or resource(s) that was communicated to the recipient.
public Communication.Payload addPayload()
Definition: Text, attachment(s), or resource(s) that was communicated to the recipient.
public Communication addPayload(Communication.Payload theValue)
Definition: Text, attachment(s), or resource(s) that was communicated to the recipient.
theValue - The payload to add (must not be null)public Communication.Payload getPayloadFirstRep()
Definition: Text, attachment(s), or resource(s) that was communicated to the recipient.
public List<CodeableConceptDt> getMedium()
null.
Definition: A channel that was used for this communication (e.g. email, fax).
public Communication setMedium(List<CodeableConceptDt> theValue)
Definition: A channel that was used for this communication (e.g. email, fax).
public CodeableConceptDt addMedium()
Definition: A channel that was used for this communication (e.g. email, fax).
public Communication addMedium(CodeableConceptDt theValue)
Definition: A channel that was used for this communication (e.g. email, fax).
theValue - The medium to add (must not be null)public CodeableConceptDt getMediumFirstRep()
Definition: A channel that was used for this communication (e.g. email, fax).
public BoundCodeDt<CommunicationStatusEnum> getStatusElement()
null.
Definition: The status of the transmission.
public String getStatus()
null.
Definition: The status of the transmission.
public Communication setStatus(BoundCodeDt<CommunicationStatusEnum> theValue)
Definition: The status of the transmission.
public Communication setStatus(CommunicationStatusEnum theValue)
Definition: The status of the transmission.
public ResourceReferenceDt getEncounter()
null.
Definition: The encounter within which the communication was sent.
public Communication setEncounter(ResourceReferenceDt theValue)
Definition: The encounter within which the communication was sent.
public DateTimeDt getSentElement()
null.
Definition: The time when this communication was sent.
public Date getSent()
null.
Definition: The time when this communication was sent.
public Communication setSent(DateTimeDt theValue)
Definition: The time when this communication was sent.
public Communication setSent(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: The time when this communication was sent.
public Communication setSentWithSecondsPrecision(Date theDate)
Definition: The time when this communication was sent.
public DateTimeDt getReceivedElement()
null.
Definition: The time when this communication arrived at the destination.
public Date getReceived()
null.
Definition: The time when this communication arrived at the destination.
public Communication setReceived(DateTimeDt theValue)
Definition: The time when this communication arrived at the destination.
public Communication setReceived(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: The time when this communication arrived at the destination.
public Communication setReceivedWithSecondsPrecision(Date theDate)
Definition: The time when this communication arrived at the destination.
public List<CodeableConceptDt> getReason()
null.
Definition: The reason or justification for the communication.
public Communication setReason(List<CodeableConceptDt> theValue)
Definition: The reason or justification for the communication.
public CodeableConceptDt addReason()
Definition: The reason or justification for the communication.
public Communication addReason(CodeableConceptDt theValue)
Definition: The reason or justification for the communication.
theValue - The reason to add (must not be null)public CodeableConceptDt getReasonFirstRep()
Definition: The reason or justification for the communication.
public ResourceReferenceDt getSubject()
null.
Definition: The patient who was the focus of this communication.
public Communication setSubject(ResourceReferenceDt theValue)
Definition: The patient who was the focus of this communication.
public ResourceReferenceDt getRequestDetail()
null.
Definition: The communication request that was responsible for producing this communication.
public Communication setRequestDetail(ResourceReferenceDt theValue)
Definition: The communication request that was responsible for producing this communication.
public String getResourceName()
getResourceName in interface IResourcepublic FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum in interface IResourcegetStructureFhirVersionEnum in interface IBaseResourceCopyright © 2014–2016 University Health Network. All rights reserved.