Package org.hl7.fhir.dstu3.model

Class CommunicationRequest

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.BaseResource

org.hl7.fhir.dstu3.model.Resource

org.hl7.fhir.dstu3.model.DomainResource

org.hl7.fhir.dstu3.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 enum	CommunicationRequest.CommunicationPriority
static class	CommunicationRequest.CommunicationPriorityEnumFactory
static class	CommunicationRequest.CommunicationRequestPayloadComponent
static class	CommunicationRequest.CommunicationRequestRequesterComponent
static enum	CommunicationRequest.CommunicationRequestStatus
static class	CommunicationRequest.CommunicationRequestStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final ca.uhn.fhir.rest.gclient.DateClientParam	AUTHORED	Fluent Client search parameter constant for authored
protected DateTimeType	authoredOn	For draft requests, indicates the date of initial creation.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	BASED_ON	Fluent Client search parameter constant for based-on
protected List<Reference>	basedOn	A plan or proposal that is fulfilled in whole or in part by this request.
protected List<Resource>	basedOnTarget	The actual objects that are the target of the reference (A plan or proposal that is fulfilled in whole or in part by this request.)
protected List<CodeableConcept>	category	The type of message to be sent such as alert, notification, reminder, instruction, etc.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CATEGORY	Fluent Client search parameter constant for category
protected Reference	context	The encounter or episode of care within which the communication request was created.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	CONTEXT	Fluent Client search parameter constant for context
protected Resource	contextTarget	The actual object that is the target of the reference (The encounter or episode of care within which the communication request was created.)
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENCOUNTER	Fluent Client search parameter constant for encounter
static final ca.uhn.fhir.rest.gclient.TokenClientParam	GROUP_IDENTIFIER	Fluent Client search parameter constant for group-identifier
protected Identifier	groupIdentifier	A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
protected List<Identifier>	identifier	A unique ID of this request for reference purposes.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_BASED_ON	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_CONTEXT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ENCOUNTER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_RECIPIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_REPLACES	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_REQUESTER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SENDER	Constant for fluent queries to be used to add include statements.
static final 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. email, fax).
static final ca.uhn.fhir.rest.gclient.TokenClientParam	MEDIUM	Fluent Client search parameter constant for medium
protected List<Annotation>	note	Comments made about the request by the requester, sender, recipient, subject or other participants.
protected Type	occurrence	The time when this communication is to occur.
static final ca.uhn.fhir.rest.gclient.DateClientParam	OCCURRENCE	Fluent Client search parameter constant for occurrence
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected List<CommunicationRequest.CommunicationRequestPayloadComponent>	payload	Text, attachment(s), or resource(s) to be communicated to the recipient.
protected Enumeration<CommunicationRequest.CommunicationPriority>	priority	Characterizes how quickly the proposed act must be initiated.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	PRIORITY	Fluent Client search parameter constant for priority
protected List<CodeableConcept>	reasonCode	Describes why the request is being made in coded or textual form.
protected List<Reference>	reasonReference	Indicates another resource whose existence justifies this request.
protected List<Resource>	reasonReferenceTarget	The actual objects that are the target of the reference (Indicates another resource whose existence justifies this request.)
protected List<Reference>	recipient	The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
static final 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. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.)
protected List<Reference>	replaces	Completed or terminated request(s) whose function is taken by this new request.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	REPLACES	Fluent Client search parameter constant for replaces
protected List<CommunicationRequest>	replacesTarget	The actual objects that are the target of the reference (Completed or terminated request(s) whose function is taken by this new request.)
protected CommunicationRequest.CommunicationRequestRequesterComponent	requester	The individual who initiated the request and has responsibility for its activation.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	REQUESTER	Fluent Client search parameter constant for requester
protected Reference	sender	The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
static final 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. person, organization, clinical information system, or device) which is to be the source of the communication.)
static final String	SP_AUTHORED	Search parameter: authored
static final String	SP_BASED_ON	Search parameter: based-on
static final String	SP_CATEGORY	Search parameter: category
static final String	SP_CONTEXT	Search parameter: context
static final String	SP_ENCOUNTER	Search parameter: encounter
static final String	SP_GROUP_IDENTIFIER	Search parameter: group-identifier
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_MEDIUM	Search parameter: medium
static final String	SP_OCCURRENCE	Search parameter: occurrence
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_PRIORITY	Search parameter: priority
static final String	SP_RECIPIENT	Search parameter: recipient
static final String	SP_REPLACES	Search parameter: replaces
static final String	SP_REQUESTER	Search parameter: requester
static final String	SP_SENDER	Search parameter: sender
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUBJECT	Search parameter: subject
protected Enumeration<CommunicationRequest.CommunicationRequestStatus>	status	The status of the proposal or order.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected Reference	subject	The patient or group that is the focus of this communication request.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject
protected Resource	subjectTarget	The actual object that is the target of the reference (The patient or group that is the focus of this communication request.)
protected List<Reference>	topic	The resources which were related to producing this communication request.
protected List<Resource>	topicTarget	The actual objects that are the target of the reference (The resources which were related to producing this communication request.)

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

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu3.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()	Constructor
CommunicationRequest(Enumeration<CommunicationRequest.CommunicationRequestStatus> status)	Constructor

Method Summary

Modifier and Type	Method	Description
Reference	addBasedOn()
CommunicationRequest	addBasedOn(Reference t)
CodeableConcept	addCategory()
CommunicationRequest	addCategory(CodeableConcept t)
Base	addChild(String name)
Identifier	addIdentifier()
CommunicationRequest	addIdentifier(Identifier t)
CodeableConcept	addMedium()
CommunicationRequest	addMedium(CodeableConcept t)
Annotation	addNote()
CommunicationRequest	addNote(Annotation t)
CommunicationRequest.CommunicationRequestPayloadComponent	addPayload()
CommunicationRequest	addPayload(CommunicationRequest.CommunicationRequestPayloadComponent t)
CodeableConcept	addReasonCode()
CommunicationRequest	addReasonCode(CodeableConcept t)
Reference	addReasonReference()
CommunicationRequest	addReasonReference(Reference t)
Reference	addRecipient()
CommunicationRequest	addRecipient(Reference t)
Reference	addReplaces()
CommunicationRequest	addReplaces(Reference t)
Reference	addTopic()
CommunicationRequest	addTopic(Reference t)
CommunicationRequest	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Date	getAuthoredOn()
DateTimeType	getAuthoredOnElement()
List<Reference>	getBasedOn()
Reference	getBasedOnFirstRep()
List<CodeableConcept>	getCategory()
CodeableConcept	getCategoryFirstRep()
Reference	getContext()
Resource	getContextTarget()
Identifier	getGroupIdentifier()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<CodeableConcept>	getMedium()
CodeableConcept	getMediumFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
Type	getOccurrence()
DateTimeType	getOccurrenceDateTimeType()
Period	getOccurrencePeriod()
List<CommunicationRequest.CommunicationRequestPayloadComponent>	getPayload()
CommunicationRequest.CommunicationRequestPayloadComponent	getPayloadFirstRep()
CommunicationRequest.CommunicationPriority	getPriority()
Enumeration<CommunicationRequest.CommunicationPriority>	getPriorityElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<CodeableConcept>	getReasonCode()
CodeableConcept	getReasonCodeFirstRep()
List<Reference>	getReasonReference()
Reference	getReasonReferenceFirstRep()
List<Reference>	getRecipient()
Reference	getRecipientFirstRep()
List<Reference>	getReplaces()
Reference	getReplacesFirstRep()
CommunicationRequest.CommunicationRequestRequesterComponent	getRequester()
ResourceType	getResourceType()
Reference	getSender()
Resource	getSenderTarget()
CommunicationRequest.CommunicationRequestStatus	getStatus()
Enumeration<CommunicationRequest.CommunicationRequestStatus>	getStatusElement()
Reference	getSubject()
Resource	getSubjectTarget()
List<Reference>	getTopic()
Reference	getTopicFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAuthoredOn()
boolean	hasAuthoredOnElement()
boolean	hasBasedOn()
boolean	hasCategory()
boolean	hasContext()
boolean	hasGroupIdentifier()
boolean	hasIdentifier()
boolean	hasMedium()
boolean	hasNote()
boolean	hasOccurrence()
boolean	hasOccurrenceDateTimeType()
boolean	hasOccurrencePeriod()
boolean	hasPayload()
boolean	hasPriority()
boolean	hasPriorityElement()
boolean	hasReasonCode()
boolean	hasReasonReference()
boolean	hasRecipient()
boolean	hasReplaces()
boolean	hasRequester()
boolean	hasSender()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	hasTopic()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
CommunicationRequest	setAuthoredOn(Date value)
CommunicationRequest	setAuthoredOnElement(DateTimeType value)
CommunicationRequest	setBasedOn(List<Reference> theBasedOn)
CommunicationRequest	setCategory(List<CodeableConcept> theCategory)
CommunicationRequest	setContext(Reference value)
CommunicationRequest	setContextTarget(Resource value)
CommunicationRequest	setGroupIdentifier(Identifier value)
CommunicationRequest	setIdentifier(List<Identifier> theIdentifier)
CommunicationRequest	setMedium(List<CodeableConcept> theMedium)
CommunicationRequest	setNote(List<Annotation> theNote)
CommunicationRequest	setOccurrence(Type value)
CommunicationRequest	setPayload(List<CommunicationRequest.CommunicationRequestPayloadComponent> thePayload)
CommunicationRequest	setPriority(CommunicationRequest.CommunicationPriority value)
CommunicationRequest	setPriorityElement(Enumeration<CommunicationRequest.CommunicationPriority> value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
CommunicationRequest	setReasonCode(List<CodeableConcept> theReasonCode)
CommunicationRequest	setReasonReference(List<Reference> theReasonReference)
CommunicationRequest	setRecipient(List<Reference> theRecipient)
CommunicationRequest	setReplaces(List<Reference> theReplaces)
CommunicationRequest	setRequester(CommunicationRequest.CommunicationRequestRequesterComponent 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(Resource value)
CommunicationRequest	setTopic(List<Reference> theTopic)
protected CommunicationRequest	typedCopy()

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

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

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

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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.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.

basedOn

protected List<Reference> basedOn

A plan or proposal that is fulfilled in whole or in part by this request.

basedOnTarget

protected List<Resource> basedOnTarget

The actual objects that are the target of the reference (A plan or proposal that is fulfilled in whole or in part by this request.)

replaces

protected List<Reference> replaces

Completed or terminated request(s) whose function is taken by this new request.

replacesTarget

protected List<CommunicationRequest> replacesTarget

The actual objects that are the target of the reference (Completed or terminated request(s) whose function is taken by this new request.)

groupIdentifier

protected Identifier groupIdentifier

A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.

status

protected Enumeration<CommunicationRequest.CommunicationRequestStatus> status

The status of the proposal or order.

category

protected List<CodeableConcept> category

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

priority

protected Enumeration<CommunicationRequest.CommunicationPriority> priority

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

medium

protected List<CodeableConcept> medium

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

subject

protected Reference subject

The patient or group that is the focus of this communication request.

subjectTarget

protected Resource subjectTarget

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

recipient

protected List<Reference> recipient

The entity (e.g. person, organization, clinical information system, device, group, or care team) 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, device, group, or care team) which is the intended target of the communication.)

topic

protected List<Reference> topic

The resources which were related to producing this communication request.

topicTarget

protected List<Resource> topicTarget

The actual objects that are the target of the reference (The resources which were related to producing this communication request.)

context

protected Reference context

The encounter or episode of care within which the communication request was created.

contextTarget

protected Resource contextTarget

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

payload

protected List<CommunicationRequest.CommunicationRequestPayloadComponent> payload

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

occurrence

protected Type occurrence

The time when this communication is to occur.

authoredOn

protected DateTimeType authoredOn

For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.

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

requester

protected CommunicationRequest.CommunicationRequestRequesterComponent requester

The individual who initiated the request and has responsibility for its activation.

reasonCode

protected List<CodeableConcept> reasonCode

Describes why the request is being made in coded or textual form.

reasonReference

protected List<Reference> reasonReference

Indicates another resource whose existence justifies this request.

reasonReferenceTarget

protected List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Indicates another resource whose existence justifies this request.)

note

protected List<Annotation> note

Comments made about the request by the requester, sender, recipient, subject or other participants.

SP_REQUESTER

public static final String SP_REQUESTER

Search parameter: requester

Description: Individual making the request
Type: reference
Path: CommunicationRequest.requester.agent

See Also:

• Constant Field Values

REQUESTER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REQUESTER

Fluent Client search parameter constant for requester

Description: Individual making the request
Type: reference
Path: CommunicationRequest.requester.agent

INCLUDE_REQUESTER

public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUESTER

Constant for fluent queries to be used to add include statements. Specifies the path value of "CommunicationRequest:requester".

SP_AUTHORED

public static final String SP_AUTHORED

Search parameter: authored

Description: When request transitioned to being actionable
Type: date
Path: CommunicationRequest.authoredOn

See Also:

• Constant Field Values

AUTHORED

public static final ca.uhn.fhir.rest.gclient.DateClientParam AUTHORED

Fluent Client search parameter constant for authored

Description: When request transitioned to being actionable
Type: date
Path: CommunicationRequest.authoredOn

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Unique identifier
Type: token
Path: CommunicationRequest.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: CommunicationRequest.identifier

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

Description: Focus of message
Type: reference
Path: CommunicationRequest.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: CommunicationRequest.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 "CommunicationRequest:subject".

SP_REPLACES

public static final String SP_REPLACES

Search parameter: replaces

Description: Request(s) replaced by this request
Type: reference
Path: CommunicationRequest.replaces

See Also:

• Constant Field Values

REPLACES

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REPLACES

Fluent Client search parameter constant for replaces

Description: Request(s) replaced by this request
Type: reference
Path: CommunicationRequest.replaces

INCLUDE_REPLACES

public static final ca.uhn.fhir.model.api.Include INCLUDE_REPLACES

Constant for fluent queries to be used to add include statements. Specifies the path value of "CommunicationRequest:replaces".

SP_MEDIUM

public static final String SP_MEDIUM

Search parameter: medium

Description: A channel of communication
Type: token
Path: CommunicationRequest.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: CommunicationRequest.medium

SP_OCCURRENCE

public static final String SP_OCCURRENCE

Search parameter: occurrence

Description: When scheduled
Type: date
Path: CommunicationRequest.occurrenceDateTime

See Also:

• Constant Field Values

OCCURRENCE

public static final ca.uhn.fhir.rest.gclient.DateClientParam OCCURRENCE

Fluent Client search parameter constant for occurrence

Description: When scheduled
Type: date
Path: CommunicationRequest.occurrenceDateTime

SP_ENCOUNTER

public static final String SP_ENCOUNTER

Search parameter: encounter

Description: Encounter leading to message
Type: reference
Path: CommunicationRequest.context

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: CommunicationRequest.context

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 "CommunicationRequest:encounter".

SP_PRIORITY

public static final String SP_PRIORITY

Search parameter: priority

Description: Message urgency
Type: token
Path: CommunicationRequest.priority

See Also:

• Constant Field Values

PRIORITY

public static final ca.uhn.fhir.rest.gclient.TokenClientParam PRIORITY

Fluent Client search parameter constant for priority

Description: Message urgency
Type: token
Path: CommunicationRequest.priority

SP_GROUP_IDENTIFIER

public static final String SP_GROUP_IDENTIFIER

Search parameter: group-identifier

Description: Composite request this is part of
Type: token
Path: CommunicationRequest.groupIdentifier

See Also:

• Constant Field Values

GROUP_IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam GROUP_IDENTIFIER

Fluent Client search parameter constant for group-identifier

Description: Composite request this is part of
Type: token
Path: CommunicationRequest.groupIdentifier

SP_BASED_ON

public static final String SP_BASED_ON

Search parameter: based-on

Description: Fulfills plan or proposal
Type: reference
Path: CommunicationRequest.basedOn

See Also:

• Constant Field Values

BASED_ON

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON

Fluent Client search parameter constant for based-on

Description: Fulfills plan or proposal
Type: reference
Path: CommunicationRequest.basedOn

INCLUDE_BASED_ON

public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON

Constant for fluent queries to be used to add include statements. Specifies the path value of "CommunicationRequest:based-on".

SP_SENDER

public static final String SP_SENDER

Search parameter: sender

Description: Message sender
Type: reference
Path: CommunicationRequest.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: CommunicationRequest.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 "CommunicationRequest:sender".

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: Focus of message
Type: reference
Path: CommunicationRequest.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: CommunicationRequest.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 "CommunicationRequest:patient".

SP_RECIPIENT

public static final String SP_RECIPIENT

Search parameter: recipient

Description: Message recipient
Type: reference
Path: CommunicationRequest.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: CommunicationRequest.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 "CommunicationRequest:recipient".

SP_CONTEXT

public static final String SP_CONTEXT

Search parameter: context

Description: Encounter or episode leading to message
Type: reference
Path: CommunicationRequest.context

See Also:

• Constant Field Values

CONTEXT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONTEXT

Fluent Client search parameter constant for context

Description: Encounter or episode leading to message
Type: reference
Path: CommunicationRequest.context

INCLUDE_CONTEXT

public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTEXT

Constant for fluent queries to be used to add include statements. Specifies the path value of "CommunicationRequest:context".

SP_CATEGORY

public static final String SP_CATEGORY

Search parameter: category

Description: Message category
Type: token
Path: CommunicationRequest.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: CommunicationRequest.category

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: draft | active | suspended | cancelled | completed | entered-in-error | unknown
Type: token
Path: CommunicationRequest.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: draft | active | suspended | cancelled | completed | entered-in-error | unknown
Type: token
Path: CommunicationRequest.status

Constructor Details

CommunicationRequest

public CommunicationRequest()

Constructor

CommunicationRequest

public CommunicationRequest(Enumeration<CommunicationRequest.CommunicationRequestStatus> status)

Constructor

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

setIdentifier

public CommunicationRequest setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public CommunicationRequest addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

getBasedOn

public List<Reference> getBasedOn()

Returns:

basedOn (A plan or proposal that is fulfilled in whole or in part by this request.)

setBasedOn

public CommunicationRequest setBasedOn(List<Reference> theBasedOn)

Returns:

Returns a reference to this for easy method chaining

hasBasedOn

public boolean hasBasedOn()

addBasedOn

public Reference addBasedOn()

addBasedOn

public CommunicationRequest addBasedOn(Reference t)

getBasedOnFirstRep

public Reference getBasedOnFirstRep()

Returns:

The first repetition of repeating field basedOn, creating it if it does not already exist

getReplaces

public List<Reference> getReplaces()

Returns:

replaces (Completed or terminated request(s) whose function is taken by this new request.)

setReplaces

public CommunicationRequest setReplaces(List<Reference> theReplaces)

Returns:

Returns a reference to this for easy method chaining

hasReplaces

public boolean hasReplaces()

addReplaces

public Reference addReplaces()

addReplaces

public CommunicationRequest addReplaces(Reference t)

getReplacesFirstRep

public Reference getReplacesFirstRep()

Returns:

The first repetition of repeating field replaces, creating it if it does not already exist

getGroupIdentifier

public Identifier getGroupIdentifier()

Returns:

groupIdentifier (A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.)

hasGroupIdentifier

public boolean hasGroupIdentifier()

setGroupIdentifier

public CommunicationRequest setGroupIdentifier(Identifier value)

Parameters:

value - groupIdentifier (A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.)

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.

getCategory

public List<CodeableConcept> getCategory()

Returns:

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

setCategory

public CommunicationRequest setCategory(List<CodeableConcept> theCategory)

Returns:

Returns a reference to this for easy method chaining

hasCategory

public boolean hasCategory()

addCategory

public CodeableConcept addCategory()

addCategory

public CommunicationRequest addCategory(CodeableConcept t)

getCategoryFirstRep

public CodeableConcept getCategoryFirstRep()

Returns:

The first repetition of repeating field category, creating it if it does not already exist

getPriorityElement

public Enumeration<CommunicationRequest.CommunicationPriority> getPriorityElement()

Returns:

priority (Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value

hasPriorityElement

public boolean hasPriorityElement()

hasPriority

public boolean hasPriority()

setPriorityElement

public CommunicationRequest setPriorityElement(Enumeration<CommunicationRequest.CommunicationPriority> value)

Parameters:

value - priority (Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value

getPriority

public CommunicationRequest.CommunicationPriority getPriority()

Returns:

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

setPriority

public CommunicationRequest setPriority(CommunicationRequest.CommunicationPriority value)

Parameters:

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

getMedium

public List<CodeableConcept> getMedium()

Returns:

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

setMedium

public CommunicationRequest setMedium(List<CodeableConcept> theMedium)

Returns:

Returns a reference to this for easy method chaining

hasMedium

public boolean hasMedium()

addMedium

public CodeableConcept addMedium()

addMedium

public CommunicationRequest addMedium(CodeableConcept t)

getMediumFirstRep

public CodeableConcept getMediumFirstRep()

Returns:

The first repetition of repeating field medium, creating it if it does not already exist

getSubject

public Reference getSubject()

Returns:

subject (The patient or group that is the focus of this communication request.)

hasSubject

public boolean hasSubject()

setSubject

public CommunicationRequest setSubject(Reference value)

Parameters:

value - subject (The patient or group that is the focus of this communication request.)

getSubjectTarget

public Resource 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 or group that is the focus of this communication request.)

setSubjectTarget

public CommunicationRequest setSubjectTarget(Resource 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 or group that is the focus of this communication request.)

getRecipient

public List<Reference> getRecipient()

Returns:

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

setRecipient

public CommunicationRequest setRecipient(List<Reference> theRecipient)

Returns:

Returns a reference to this for easy method chaining

hasRecipient

public boolean hasRecipient()

addRecipient

public Reference addRecipient()

addRecipient

public CommunicationRequest addRecipient(Reference t)

getRecipientFirstRep

public Reference getRecipientFirstRep()

Returns:

The first repetition of repeating field recipient, creating it if it does not already exist

getTopic

public List<Reference> getTopic()

Returns:

topic (The resources which were related to producing this communication request.)

setTopic

public CommunicationRequest setTopic(List<Reference> theTopic)

Returns:

Returns a reference to this for easy method chaining

hasTopic

public boolean hasTopic()

addTopic

public Reference addTopic()

addTopic

public CommunicationRequest addTopic(Reference t)

getTopicFirstRep

public Reference getTopicFirstRep()

Returns:

The first repetition of repeating field topic, creating it if it does not already exist

getContext

public Reference getContext()

Returns:

context (The encounter or episode of care within which the communication request was created.)

hasContext

public boolean hasContext()

setContext

public CommunicationRequest setContext(Reference value)

Parameters:

value - context (The encounter or episode of care within which the communication request was created.)

getContextTarget

public Resource getContextTarget()

Returns:

context 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 or episode of care within which the communication request was created.)

setContextTarget

public CommunicationRequest setContextTarget(Resource value)

Parameters:

value - context 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 or episode of care within which the communication request was created.)

getPayload

public List<CommunicationRequest.CommunicationRequestPayloadComponent> getPayload()

Returns:

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

setPayload

public CommunicationRequest setPayload(List<CommunicationRequest.CommunicationRequestPayloadComponent> thePayload)

Returns:

Returns a reference to this for easy method chaining

hasPayload

public boolean hasPayload()

addPayload

public CommunicationRequest.CommunicationRequestPayloadComponent addPayload()

addPayload

public CommunicationRequest addPayload(CommunicationRequest.CommunicationRequestPayloadComponent t)

getPayloadFirstRep

public CommunicationRequest.CommunicationRequestPayloadComponent getPayloadFirstRep()

Returns:

The first repetition of repeating field payload, creating it if it does not already exist

getOccurrence

public Type getOccurrence()

Returns:

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

getOccurrenceDateTimeType

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

Returns:

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

Throws:

org.hl7.fhir.exceptions.FHIRException

hasOccurrenceDateTimeType

public boolean hasOccurrenceDateTimeType()

getOccurrencePeriod

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

Returns:

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

Throws:

org.hl7.fhir.exceptions.FHIRException

hasOccurrencePeriod

public boolean hasOccurrencePeriod()

hasOccurrence

public boolean hasOccurrence()

setOccurrence

public CommunicationRequest setOccurrence(Type value)
                                   throws org.hl7.fhir.exceptions.FHIRFormatError

Parameters:

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

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

getAuthoredOnElement

public DateTimeType getAuthoredOnElement()

Returns:

authoredOn (For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.). This is the underlying object with id, value and extensions. The accessor "getAuthoredOn" gives direct access to the value

hasAuthoredOnElement

public boolean hasAuthoredOnElement()

hasAuthoredOn

public boolean hasAuthoredOn()

setAuthoredOnElement

public CommunicationRequest setAuthoredOnElement(DateTimeType value)

Parameters:

value - authoredOn (For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.). This is the underlying object with id, value and extensions. The accessor "getAuthoredOn" gives direct access to the value

getAuthoredOn

public Date getAuthoredOn()

Returns:

For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.

setAuthoredOn

public CommunicationRequest setAuthoredOn(Date value)

Parameters:

value - For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.

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

getRequester

public CommunicationRequest.CommunicationRequestRequesterComponent getRequester()

Returns:

requester (The individual who initiated the request and has responsibility for its activation.)

hasRequester

public boolean hasRequester()

setRequester

public CommunicationRequest setRequester(CommunicationRequest.CommunicationRequestRequesterComponent value)

Parameters:

value - requester (The individual who initiated the request and has responsibility for its activation.)

getReasonCode

public List<CodeableConcept> getReasonCode()

Returns:

reasonCode (Describes why the request is being made in coded or textual form.)

setReasonCode

public CommunicationRequest setReasonCode(List<CodeableConcept> theReasonCode)

Returns:

Returns a reference to this for easy method chaining

hasReasonCode

public boolean hasReasonCode()

addReasonCode

public CodeableConcept addReasonCode()

addReasonCode

public CommunicationRequest addReasonCode(CodeableConcept t)

getReasonCodeFirstRep

public CodeableConcept getReasonCodeFirstRep()

Returns:

The first repetition of repeating field reasonCode, creating it if it does not already exist

getReasonReference

public List<Reference> getReasonReference()

Returns:

reasonReference (Indicates another resource whose existence justifies this request.)

setReasonReference

public CommunicationRequest setReasonReference(List<Reference> theReasonReference)

Returns:

Returns a reference to this for easy method chaining

hasReasonReference

public boolean hasReasonReference()

addReasonReference

public Reference addReasonReference()

addReasonReference

public CommunicationRequest addReasonReference(Reference t)

getReasonReferenceFirstRep

public Reference getReasonReferenceFirstRep()

Returns:

The first repetition of repeating field reasonReference, creating it if it does not already exist

getNote

public List<Annotation> getNote()

Returns:

note (Comments made about the request by the requester, sender, recipient, subject or other participants.)

setNote

public CommunicationRequest setNote(List<Annotation> theNote)

Returns:

Returns a reference to this for easy method chaining

hasNote

public boolean hasNote()

addNote

public Annotation addNote()

addNote

public CommunicationRequest addNote(Annotation t)

getNoteFirstRep

public Annotation getNoteFirstRep()

Returns:

The first repetition of repeating field note, creating it if it does not already exist

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

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 Base 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 Base 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

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty 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