public class CommunicationRequest extends BaseResource implements IResource
Definition: A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
Requirements:
Profile Definition: http://hl7.org/fhir/profiles/CommunicationRequest
| Modifier and Type | Class and Description |
|---|---|
static class |
CommunicationRequest.Payload
Block class for child element: CommunicationRequest.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_REQUESTER
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 TokenClientParam |
PRIORITY
Fluent Client search parameter constant for priority
|
static ReferenceClientParam |
RECIPIENT
Fluent Client search parameter constant for recipient
|
static DateClientParam |
REQUESTED
Fluent Client search parameter constant for requested
|
static ReferenceClientParam |
REQUESTER
Fluent Client search parameter constant for requester
|
static ReferenceClientParam |
SENDER
Fluent Client search parameter constant for sender
|
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_PRIORITY
Search parameter constant for priority
|
static String |
SP_RECIPIENT
Search parameter constant for recipient
|
static String |
SP_REQUESTED
Search parameter constant for requested
|
static String |
SP_REQUESTER
Search parameter constant for requester
|
static String |
SP_SENDER
Search parameter constant for sender
|
static String |
SP_STATUS
Search parameter constant for status
|
static String |
SP_SUBJECT
Search parameter constant for subject
|
static String |
SP_TIME
Search parameter constant for time
|
static TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
static ReferenceClientParam |
SUBJECT
Fluent Client search parameter constant for subject
|
static DateClientParam |
TIME
Fluent Client search parameter constant for time
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
CommunicationRequest() |
| Modifier and Type | Method and Description |
|---|---|
IdentifierDt |
addIdentifier()
Adds and returns a new value for identifier ()
|
CommunicationRequest |
addIdentifier(IdentifierDt theValue)
Adds a given new value for identifier ()
|
CodeableConceptDt |
addMedium()
Adds and returns a new value for medium ()
|
CommunicationRequest |
addMedium(CodeableConceptDt theValue)
Adds a given new value for medium ()
|
CommunicationRequest.Payload |
addPayload()
Adds and returns a new value for payload ()
|
CommunicationRequest |
addPayload(CommunicationRequest.Payload theValue)
Adds a given new value for payload ()
|
CodeableConceptDt |
addReason()
Adds and returns a new value for reason ()
|
CommunicationRequest |
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<CommunicationRequest.Payload> |
getPayload()
Gets the value(s) for payload ().
|
CommunicationRequest.Payload |
getPayloadFirstRep()
Gets the first repetition for payload (),
creating it if it does not already exist.
|
CodeableConceptDt |
getPriority()
Gets the value(s) for priority ().
|
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.
|
List<ResourceReferenceDt> |
getRecipient()
Gets the value(s) for recipient ().
|
Date |
getRequestedOn()
Gets the value(s) for requestedOn ().
|
DateTimeDt |
getRequestedOnElement()
Gets the value(s) for requestedOn ().
|
ResourceReferenceDt |
getRequester()
Gets the value(s) for requester ().
|
String |
getResourceName() |
IDatatype |
getScheduled()
Gets the value(s) for scheduled[x] ().
|
ResourceReferenceDt |
getSender()
Gets the value(s) for sender ().
|
String |
getStatus()
Gets the value(s) for status ().
|
BoundCodeDt<CommunicationRequestStatusEnum> |
getStatusElement()
Gets the value(s) for status ().
|
FhirVersionEnum |
getStructureFhirVersionEnum() |
ResourceReferenceDt |
getSubject()
Gets the value(s) for subject ().
|
boolean |
isEmpty() |
CommunicationRequest |
setCategory(CodeableConceptDt theValue)
Sets the value(s) for category ()
|
CommunicationRequest |
setEncounter(ResourceReferenceDt theValue)
Sets the value(s) for encounter ()
|
CommunicationRequest |
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier ()
|
CommunicationRequest |
setMedium(List<CodeableConceptDt> theValue)
Sets the value(s) for medium ()
|
CommunicationRequest |
setPayload(List<CommunicationRequest.Payload> theValue)
Sets the value(s) for payload ()
|
CommunicationRequest |
setPriority(CodeableConceptDt theValue)
Sets the value(s) for priority ()
|
CommunicationRequest |
setReason(List<CodeableConceptDt> theValue)
Sets the value(s) for reason ()
|
CommunicationRequest |
setRecipient(List<ResourceReferenceDt> theValue)
Sets the value(s) for recipient ()
|
CommunicationRequest |
setRequestedOn(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for requestedOn ()
|
CommunicationRequest |
setRequestedOn(DateTimeDt theValue)
Sets the value(s) for requestedOn ()
|
CommunicationRequest |
setRequestedOnWithSecondsPrecision(Date theDate)
Sets the value for requestedOn ()
|
CommunicationRequest |
setRequester(ResourceReferenceDt theValue)
Sets the value(s) for requester ()
|
CommunicationRequest |
setScheduled(IDatatype theValue)
Sets the value(s) for scheduled[x] ()
|
CommunicationRequest |
setSender(ResourceReferenceDt theValue)
Sets the value(s) for sender ()
|
CommunicationRequest |
setStatus(BoundCodeDt<CommunicationRequestStatusEnum> theValue)
Sets the value(s) for status ()
|
CommunicationRequest |
setStatus(CommunicationRequestStatusEnum theValue)
Sets the value(s) for status ()
|
CommunicationRequest |
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: CommunicationRequest.identifier
public static final TokenClientParam IDENTIFIER
Description:
Type: token
Path: CommunicationRequest.identifier
public static final String SP_CATEGORY
Description:
Type: token
Path: CommunicationRequest.category
public static final TokenClientParam CATEGORY
Description:
Type: token
Path: CommunicationRequest.category
public static final String SP_SENDER
Description:
Type: reference
Path: CommunicationRequest.sender
public static final ReferenceClientParam SENDER
Description:
Type: reference
Path: CommunicationRequest.sender
public static final String SP_RECIPIENT
Description:
Type: reference
Path: CommunicationRequest.recipient
public static final ReferenceClientParam RECIPIENT
Description:
Type: reference
Path: CommunicationRequest.recipient
public static final String SP_MEDIUM
Description:
Type: token
Path: CommunicationRequest.medium
public static final TokenClientParam MEDIUM
Description:
Type: token
Path: CommunicationRequest.medium
public static final String SP_REQUESTER
Description:
Type: reference
Path: CommunicationRequest.requester
public static final ReferenceClientParam REQUESTER
Description:
Type: reference
Path: CommunicationRequest.requester
public static final String SP_STATUS
Description:
Type: token
Path: CommunicationRequest.status
public static final TokenClientParam STATUS
Description:
Type: token
Path: CommunicationRequest.status
public static final String SP_ENCOUNTER
Description:
Type: reference
Path: CommunicationRequest.encounter
public static final ReferenceClientParam ENCOUNTER
Description:
Type: reference
Path: CommunicationRequest.encounter
public static final String SP_TIME
Description:
Type: date
Path: CommunicationRequest.scheduledDateTime
public static final DateClientParam TIME
Description:
Type: date
Path: CommunicationRequest.scheduledDateTime
public static final String SP_REQUESTED
Description:
Type: date
Path: CommunicationRequest.requestedOn
public static final DateClientParam REQUESTED
Description:
Type: date
Path: CommunicationRequest.requestedOn
public static final String SP_SUBJECT
Description:
Type: reference
Path: CommunicationRequest.subject
public static final ReferenceClientParam SUBJECT
Description:
Type: reference
Path: CommunicationRequest.subject
public static final String SP_PRIORITY
Description:
Type: token
Path: CommunicationRequest.priority
public static final TokenClientParam PRIORITY
Description:
Type: token
Path: CommunicationRequest.priority
public static final String SP_PATIENT
Description:
Type: reference
Path: CommunicationRequest.subject
public static final ReferenceClientParam PATIENT
Description:
Type: reference
Path: CommunicationRequest.subject
public static final Include INCLUDE_ENCOUNTER
public static final Include INCLUDE_PATIENT
public static final Include INCLUDE_RECIPIENT
public static final Include INCLUDE_REQUESTER
public static final Include INCLUDE_SENDER
public static final Include INCLUDE_SUBJECT
public CommunicationRequest()
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ICompositeElementpublic List<IdentifierDt> getIdentifier()
null.
Definition: A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.
public CommunicationRequest setIdentifier(List<IdentifierDt> theValue)
Definition: A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.
public IdentifierDt addIdentifier()
Definition: A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.
public CommunicationRequest addIdentifier(IdentifierDt theValue)
Definition: A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.
theValue - The identifier to add (must not be null)public IdentifierDt getIdentifierFirstRep()
Definition: A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.
public CodeableConceptDt getCategory()
null.
Definition: The type of message to be sent such as alert, notification, reminder, instruction, etc.
public CommunicationRequest setCategory(CodeableConceptDt theValue)
Definition: The type of message to be sent such as alert, notification, reminder, instruction, etc.
public ResourceReferenceDt getSender()
null.
Definition: The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication
public CommunicationRequest setSender(ResourceReferenceDt theValue)
Definition: The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication
public List<ResourceReferenceDt> getRecipient()
null.
Definition: The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication
public CommunicationRequest setRecipient(List<ResourceReferenceDt> theValue)
Definition: The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication
public ResourceReferenceDt addRecipient()
Definition: The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication
public List<CommunicationRequest.Payload> getPayload()
null.
Definition: Text, attachment(s), or resource(s) to be communicated to the recipient
public CommunicationRequest setPayload(List<CommunicationRequest.Payload> theValue)
Definition: Text, attachment(s), or resource(s) to be communicated to the recipient
public CommunicationRequest.Payload addPayload()
Definition: Text, attachment(s), or resource(s) to be communicated to the recipient
public CommunicationRequest addPayload(CommunicationRequest.Payload theValue)
Definition: Text, attachment(s), or resource(s) to be communicated to the recipient
theValue - The payload to add (must not be null)public CommunicationRequest.Payload getPayloadFirstRep()
Definition: Text, attachment(s), or resource(s) to be communicated to the recipient
public List<CodeableConceptDt> getMedium()
null.
Definition: A channel that was used for this communication (e.g. email, fax).
public CommunicationRequest 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 CommunicationRequest 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 ResourceReferenceDt getRequester()
null.
Definition: The responsible person who authorizes this order, e.g. physician. This may be different than the author of the order statement, e.g. clerk, who may have entered the statement into the order entry application.
public CommunicationRequest setRequester(ResourceReferenceDt theValue)
Definition: The responsible person who authorizes this order, e.g. physician. This may be different than the author of the order statement, e.g. clerk, who may have entered the statement into the order entry application.
public BoundCodeDt<CommunicationRequestStatusEnum> getStatusElement()
null.
Definition: The status of the proposal or order.
public String getStatus()
null.
Definition: The status of the proposal or order.
public CommunicationRequest setStatus(BoundCodeDt<CommunicationRequestStatusEnum> theValue)
Definition: The status of the proposal or order.
public CommunicationRequest setStatus(CommunicationRequestStatusEnum theValue)
Definition: The status of the proposal or order.
public ResourceReferenceDt getEncounter()
null.
Definition: The encounter within which the communication request was created.
public CommunicationRequest setEncounter(ResourceReferenceDt theValue)
Definition: The encounter within which the communication request was created.
public IDatatype getScheduled()
null.
Definition: The time when this communication is to occur.
public CommunicationRequest setScheduled(IDatatype theValue)
Definition: The time when this communication is to occur.
public List<CodeableConceptDt> getReason()
null.
Definition: The reason or justification for the communication request.
public CommunicationRequest setReason(List<CodeableConceptDt> theValue)
Definition: The reason or justification for the communication request.
public CodeableConceptDt addReason()
Definition: The reason or justification for the communication request.
public CommunicationRequest addReason(CodeableConceptDt theValue)
Definition: The reason or justification for the communication request.
theValue - The reason to add (must not be null)public CodeableConceptDt getReasonFirstRep()
Definition: The reason or justification for the communication request.
public DateTimeDt getRequestedOnElement()
null.
Definition: The time when the request was made.
public Date getRequestedOn()
null.
Definition: The time when the request was made.
public CommunicationRequest setRequestedOn(DateTimeDt theValue)
Definition: The time when the request was made.
public CommunicationRequest setRequestedOn(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: The time when the request was made.
public CommunicationRequest setRequestedOnWithSecondsPrecision(Date theDate)
Definition: The time when the request was made.
public ResourceReferenceDt getSubject()
null.
Definition: The patient who is the focus of this communication request.
public CommunicationRequest setSubject(ResourceReferenceDt theValue)
Definition: The patient who is the focus of this communication request.
public CodeableConceptDt getPriority()
null.
Definition: Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
public CommunicationRequest setPriority(CodeableConceptDt theValue)
Definition: Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
public String getResourceName()
getResourceName in interface IResourcepublic FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum in interface IResourcegetStructureFhirVersionEnum in interface IBaseResourceCopyright © 2014–2016 University Health Network. All rights reserved.