Package org.hl7.fhir.dstu2.model

Class CommunicationRequest

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.BaseResource

org.hl7.fhir.dstu2.model.Resource

org.hl7.fhir.dstu2.model.DomainResource

org.hl7.fhir.dstu2.model.CommunicationRequest

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 CommunicationRequest
extends DomainResource

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.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommunicationRequest.CommunicationRequestPayloadComponent
static enum	CommunicationRequest.CommunicationRequestStatus
static class	CommunicationRequest.CommunicationRequestStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeableConcept	category	The type of message to be sent such as alert, notification, reminder, instruction, etc.
protected Reference	encounter	The encounter within which the communication request was created.
protected Encounter	encounterTarget	The actual object that is the target of the reference (The encounter within which the communication request was created.)
protected List<Identifier>	identifier	A unique ID of this request for reference purposes.
protected List<CodeableConcept>	medium	A channel that was used for this communication (e.g. email, fax).
protected List<CommunicationRequest.CommunicationRequestPayloadComponent>	payload	Text, attachment(s), or resource(s) to be communicated to the recipient.
protected CodeableConcept	priority	Characterizes how quickly the proposed act must be initiated.
protected List<CodeableConcept>	reason	The reason or justification for the communication request.
protected List<Reference>	recipient	The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication.
protected List<Resource>	recipientTarget	The actual objects that are the target of the reference (The entity (e.g.
protected DateTimeType	requestedOn	The time when the request was made.
protected Reference	requester	The responsible person who authorizes this order, e.g. physician.
protected Resource	requesterTarget	The actual object that is the target of the reference (The responsible person who authorizes this order, e.g. physician.
protected Type	scheduled	The time when this communication is to occur.
protected Reference	sender	The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
protected Resource	senderTarget	The actual object that is the target of the reference (The entity (e.g.
static final String	SP_CATEGORY
static final String	SP_ENCOUNTER
static final String	SP_IDENTIFIER
static final String	SP_MEDIUM
static final String	SP_PATIENT
static final String	SP_PRIORITY
static final String	SP_RECIPIENT
static final String	SP_REQUESTED
static final String	SP_REQUESTER
static final String	SP_SENDER
static final String	SP_STATUS
static final String	SP_SUBJECT
static final String	SP_TIME
protected Enumeration<CommunicationRequest.CommunicationRequestStatus>	status	The status of the proposal or order.
protected Reference	subject	The patient who is the focus of this communication request.
protected Patient	subjectTarget	The actual object that is the target of the reference (The patient who is the focus of this communication request.)

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
CommunicationRequest()

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Identifier	addIdentifier()
CommunicationRequest	addIdentifier(Identifier t)
CodeableConcept	addMedium()
CommunicationRequest	addMedium(CodeableConcept t)
CommunicationRequest.CommunicationRequestPayloadComponent	addPayload()
CommunicationRequest	addPayload(CommunicationRequest.CommunicationRequestPayloadComponent t)
CodeableConcept	addReason()
CommunicationRequest	addReason(CodeableConcept t)
Reference	addRecipient()
CommunicationRequest	addRecipient(Reference t)
CommunicationRequest	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
CodeableConcept	getCategory()
Reference	getEncounter()
Encounter	getEncounterTarget()
List<Identifier>	getIdentifier()
List<CodeableConcept>	getMedium()
List<CommunicationRequest.CommunicationRequestPayloadComponent>	getPayload()
CodeableConcept	getPriority()
List<CodeableConcept>	getReason()
List<Reference>	getRecipient()
List<Resource>	getRecipientTarget()
Date	getRequestedOn()
DateTimeType	getRequestedOnElement()
Reference	getRequester()
Resource	getRequesterTarget()
ResourceType	getResourceType()
Type	getScheduled()
DateTimeType	getScheduledDateTimeType()
Period	getScheduledPeriod()
Reference	getSender()
Resource	getSenderTarget()
CommunicationRequest.CommunicationRequestStatus	getStatus()
Enumeration<CommunicationRequest.CommunicationRequestStatus>	getStatusElement()
Reference	getSubject()
Patient	getSubjectTarget()
boolean	hasCategory()
boolean	hasEncounter()
boolean	hasIdentifier()
boolean	hasMedium()
boolean	hasPayload()
boolean	hasPriority()
boolean	hasReason()
boolean	hasRecipient()
boolean	hasRequestedOn()
boolean	hasRequestedOnElement()
boolean	hasRequester()
boolean	hasScheduled()
boolean	hasScheduledDateTimeType()
boolean	hasScheduledPeriod()
boolean	hasSender()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
CommunicationRequest	setCategory(CodeableConcept value)
CommunicationRequest	setEncounter(Reference value)
CommunicationRequest	setEncounterTarget(Encounter value)
CommunicationRequest	setPriority(CodeableConcept value)
void	setProperty(String name, Base value)
CommunicationRequest	setRequestedOn(Date value)
CommunicationRequest	setRequestedOnElement(DateTimeType value)
CommunicationRequest	setRequester(Reference value)
CommunicationRequest	setRequesterTarget(Resource value)
CommunicationRequest	setScheduled(Type value)
CommunicationRequest	setSender(Reference value)
CommunicationRequest	setSenderTarget(Resource value)
CommunicationRequest	setStatus(CommunicationRequest.CommunicationRequestStatus value)
CommunicationRequest	setStatusElement(Enumeration<CommunicationRequest.CommunicationRequestStatus> value)
CommunicationRequest	setSubject(Reference value)
CommunicationRequest	setSubjectTarget(Patient value)
protected CommunicationRequest	typedCopy()

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

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.dstu2.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.dstu2.model.BaseResource

getStructureFhirVersionEnum, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

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.

category

protected CodeableConcept category

The type of message to be sent such as alert, notification, reminder, instruction, etc.

sender

protected Reference sender

The entity (e.g. person, organization, clinical information system, or device) which is to be 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 is to be the source of the communication.)

recipient

protected List<Reference> recipient

The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication.

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 is the intended target of the communication.)

payload

protected List<CommunicationRequest.CommunicationRequestPayloadComponent> payload

Text, attachment(s), or resource(s) to be communicated to the recipient.

medium

protected List<CodeableConcept> medium

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

requester

protected Reference requester

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.

requesterTarget

protected Resource requesterTarget

The actual object that is the target of the reference (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.)

status

protected Enumeration<CommunicationRequest.CommunicationRequestStatus> status

The status of the proposal or order.

encounter

protected Reference encounter

The encounter within which the communication request was created.

encounterTarget

protected Encounter encounterTarget

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

scheduled

protected Type scheduled

The time when this communication is to occur.

reason

protected List<CodeableConcept> reason

The reason or justification for the communication request.

requestedOn

protected DateTimeType requestedOn

The time when the request was made.

subject

protected Reference subject

The patient who is the focus of this communication request.

subjectTarget

protected Patient subjectTarget

The actual object that is the target of the reference (The patient who is the focus of this communication request.)

priority

protected CodeableConcept priority

Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.

SP_REQUESTER

public static final String SP_REQUESTER

See Also:

• Constant Field Values

SP_IDENTIFIER

public static final String SP_IDENTIFIER

See Also:

• Constant Field Values

SP_SUBJECT

public static final String SP_SUBJECT

See Also:

• Constant Field Values

SP_MEDIUM

public static final String SP_MEDIUM

See Also:

• Constant Field Values

SP_ENCOUNTER

public static final String SP_ENCOUNTER

See Also:

• Constant Field Values

SP_PRIORITY

public static final String SP_PRIORITY

See Also:

• Constant Field Values

SP_REQUESTED

public static final String SP_REQUESTED

See Also:

• Constant Field Values

SP_SENDER

public static final String SP_SENDER

See Also:

• Constant Field Values

SP_PATIENT

public static final String SP_PATIENT

See Also:

• Constant Field Values

SP_RECIPIENT

public static final String SP_RECIPIENT

See Also:

• Constant Field Values

SP_TIME

public static final String SP_TIME

See Also:

• Constant Field Values

SP_CATEGORY

public static final String SP_CATEGORY

See Also:

• Constant Field Values

SP_STATUS

public static final String SP_STATUS

See Also:

• Constant Field Values

Constructor Details

CommunicationRequest

public CommunicationRequest()

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (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.)

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

Returns:

identifier (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.)

addIdentifier

public CommunicationRequest addIdentifier(Identifier t)

getCategory

public CodeableConcept getCategory()

Returns:

category (The type of message to be sent such as alert, notification, reminder, instruction, etc.)

hasCategory

public boolean hasCategory()

setCategory

public CommunicationRequest setCategory(CodeableConcept value)

Parameters:

value - category (The type of message to be sent 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 is to be the source of the communication.)

hasSender

public boolean hasSender()

setSender

public CommunicationRequest setSender(Reference value)

Parameters:

value - sender (The entity (e.g. person, organization, clinical information system, or device) which is to be 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 is to be the source of the communication.)

setSenderTarget

public CommunicationRequest 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 is to be the source of the communication.)

getRecipient

public List<Reference> getRecipient()

Returns:

recipient (The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication.)

hasRecipient

public boolean hasRecipient()

addRecipient

public Reference addRecipient()

Returns:

recipient (The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication.)

addRecipient

public CommunicationRequest 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 is the intended target of the communication.)

getPayload

public List<CommunicationRequest.CommunicationRequestPayloadComponent> getPayload()

Returns:

payload (Text, attachment(s), or resource(s) to be communicated to the recipient.)

hasPayload

public boolean hasPayload()

addPayload

public CommunicationRequest.CommunicationRequestPayloadComponent addPayload()

Returns:

payload (Text, attachment(s), or resource(s) to be communicated to the recipient.)

addPayload

public CommunicationRequest addPayload(CommunicationRequest.CommunicationRequestPayloadComponent 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 CommunicationRequest addMedium(CodeableConcept t)

getRequester

public Reference getRequester()

Returns:

requester (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.)

hasRequester

public boolean hasRequester()

setRequester

public CommunicationRequest setRequester(Reference value)

Parameters:

value - requester (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.)

getRequesterTarget

public Resource getRequesterTarget()

Returns:

requester 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 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.)

setRequesterTarget

public CommunicationRequest setRequesterTarget(Resource value)

Parameters:

value - requester 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 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.)

getStatusElement

public Enumeration<CommunicationRequest.CommunicationRequestStatus> getStatusElement()

Returns:

status (The status of the proposal or order.). 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 CommunicationRequest setStatusElement(Enumeration<CommunicationRequest.CommunicationRequestStatus> value)

Parameters:

value - status (The status of the proposal or order.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public CommunicationRequest.CommunicationRequestStatus getStatus()

Returns:

The status of the proposal or order.

setStatus

public CommunicationRequest setStatus(CommunicationRequest.CommunicationRequestStatus value)

Parameters:

value - The status of the proposal or order.

getEncounter

public Reference getEncounter()

Returns:

encounter (The encounter within which the communication request was created.)

hasEncounter

public boolean hasEncounter()

setEncounter

public CommunicationRequest setEncounter(Reference value)

Parameters:

value - encounter (The encounter within which the communication request was created.)

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 request was created.)

setEncounterTarget

public CommunicationRequest 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 request was created.)

getScheduled

public Type getScheduled()

Returns:

scheduled (The time when this communication is to occur.)

getScheduledDateTimeType

public DateTimeType getScheduledDateTimeType()
                                      throws org.hl7.fhir.exceptions.FHIRException

Returns:

scheduled (The time when this communication is to occur.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasScheduledDateTimeType

public boolean hasScheduledDateTimeType()

getScheduledPeriod

public Period getScheduledPeriod()
                          throws org.hl7.fhir.exceptions.FHIRException

Returns:

scheduled (The time when this communication is to occur.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasScheduledPeriod

public boolean hasScheduledPeriod()

hasScheduled

public boolean hasScheduled()

setScheduled

public CommunicationRequest setScheduled(Type value)

Parameters:

value - scheduled (The time when this communication is to occur.)

getReason

public List<CodeableConcept> getReason()

Returns:

reason (The reason or justification for the communication request.)

hasReason

public boolean hasReason()

addReason

public CodeableConcept addReason()

Returns:

reason (The reason or justification for the communication request.)

addReason

public CommunicationRequest addReason(CodeableConcept t)

getRequestedOnElement

public DateTimeType getRequestedOnElement()

Returns:

requestedOn (The time when the request was made.). This is the underlying object with id, value and extensions. The accessor "getRequestedOn" gives direct access to the value

hasRequestedOnElement

public boolean hasRequestedOnElement()

hasRequestedOn

public boolean hasRequestedOn()

setRequestedOnElement

public CommunicationRequest setRequestedOnElement(DateTimeType value)

Parameters:

value - requestedOn (The time when the request was made.). This is the underlying object with id, value and extensions. The accessor "getRequestedOn" gives direct access to the value

getRequestedOn

public Date getRequestedOn()

Returns:

The time when the request was made.

setRequestedOn

public CommunicationRequest setRequestedOn(Date value)

Parameters:

value - The time when the request was made.

getSubject

public Reference getSubject()

Returns:

subject (The patient who is the focus of this communication request.)

hasSubject

public boolean hasSubject()

setSubject

public CommunicationRequest setSubject(Reference value)

Parameters:

value - subject (The patient who is the focus of this communication request.)

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 is the focus of this communication request.)

setSubjectTarget

public CommunicationRequest 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 is the focus of this communication request.)

getPriority

public CodeableConcept getPriority()

Returns:

priority (Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.)

hasPriority

public boolean hasPriority()

setPriority

public CommunicationRequest setPriority(CodeableConcept value)

Parameters:

value - priority (Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

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

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()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public CommunicationRequest copy()

Specified by:

copy in class DomainResource

typedCopy

protected CommunicationRequest 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