Package org.hl7.fhir.r5.model

Class CommunicationRequest

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.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

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Reference>	about	Other resources that pertain to this communication request and to which this communication request should be associated.
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<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 BooleanType	doNotPerform	If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.
protected Reference	encounter	The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.
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 multiple independent Request instances that were activated/authorized more or less simultaneously by a single author.
protected List<Identifier>	identifier	Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
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_ENCOUNTER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_INFORMATION_PROVIDER	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_SUBJECT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	INFORMATION_PROVIDER	Fluent Client search parameter constant for information-provider
protected List<Reference>	informationProvider	The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
protected Enumeration<Enumerations.RequestIntent>	intent	Indicates the level of authority/intentionality associated with the CommunicationRequest and where the request fits into the workflow chain.
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 DataType	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<Enumerations.RequestPriority>	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<CodeableReference>	reason	Describes why the request is being made in coded or textual form.
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<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 Reference	requester	The device, individual, or organization who asks for the information to be shared.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	REQUESTER	Fluent Client search parameter constant for requester
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_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_INFORMATION_PROVIDER	Search parameter: information-provider
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_STATUS	Search parameter: status
static final String	SP_SUBJECT	Search parameter: subject
protected Enumeration<Enumerations.RequestStatus>	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 CodeableConcept	statusReason	Captures the reason for the current state of the CommunicationRequest.
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

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

contained, extension, modifierExtension, SP_TEXT, text, TEXT

Fields inherited from class org.hl7.fhir.r5.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(Enumerations.RequestStatus status, Enumerations.RequestIntent intent)	Constructor

Method Summary

Modifier and Type	Method	Description
Reference	addAbout()
CommunicationRequest	addAbout(Reference t)
Reference	addBasedOn()
CommunicationRequest	addBasedOn(Reference t)
CodeableConcept	addCategory()
CommunicationRequest	addCategory(CodeableConcept t)
Base	addChild(String name)
Identifier	addIdentifier()
CommunicationRequest	addIdentifier(Identifier t)
Reference	addInformationProvider()
CommunicationRequest	addInformationProvider(Reference t)
CodeableConcept	addMedium()
CommunicationRequest	addMedium(CodeableConcept t)
Annotation	addNote()
CommunicationRequest	addNote(Annotation t)
CommunicationRequest.CommunicationRequestPayloadComponent	addPayload()
CommunicationRequest	addPayload(CommunicationRequest.CommunicationRequestPayloadComponent t)
CodeableReference	addReason()
CommunicationRequest	addReason(CodeableReference t)
Reference	addRecipient()
CommunicationRequest	addRecipient(Reference t)
Reference	addReplaces()
CommunicationRequest	addReplaces(Reference t)
CommunicationRequest	copy()
void	copyValues(CommunicationRequest dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<Reference>	getAbout()
Reference	getAboutFirstRep()
Date	getAuthoredOn()
DateTimeType	getAuthoredOnElement()
List<Reference>	getBasedOn()
Reference	getBasedOnFirstRep()
List<CodeableConcept>	getCategory()
CodeableConcept	getCategoryFirstRep()
boolean	getDoNotPerform()
BooleanType	getDoNotPerformElement()
Reference	getEncounter()
Identifier	getGroupIdentifier()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<Reference>	getInformationProvider()
Reference	getInformationProviderFirstRep()
Enumerations.RequestIntent	getIntent()
Enumeration<Enumerations.RequestIntent>	getIntentElement()
List<CodeableConcept>	getMedium()
CodeableConcept	getMediumFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
DataType	getOccurrence()
DateTimeType	getOccurrenceDateTimeType()
Period	getOccurrencePeriod()
List<CommunicationRequest.CommunicationRequestPayloadComponent>	getPayload()
CommunicationRequest.CommunicationRequestPayloadComponent	getPayloadFirstRep()
Enumerations.RequestPriority	getPriority()
Enumeration<Enumerations.RequestPriority>	getPriorityElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<CodeableReference>	getReason()
CodeableReference	getReasonFirstRep()
List<Reference>	getRecipient()
Reference	getRecipientFirstRep()
List<Reference>	getReplaces()
Reference	getReplacesFirstRep()
Reference	getRequester()
ResourceType	getResourceType()
Enumerations.RequestStatus	getStatus()
Enumeration<Enumerations.RequestStatus>	getStatusElement()
CodeableConcept	getStatusReason()
Reference	getSubject()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAbout()
boolean	hasAuthoredOn()
boolean	hasAuthoredOnElement()
boolean	hasBasedOn()
boolean	hasCategory()
boolean	hasDoNotPerform()
boolean	hasDoNotPerformElement()
boolean	hasEncounter()
boolean	hasGroupIdentifier()
boolean	hasIdentifier()
boolean	hasInformationProvider()
boolean	hasIntent()
boolean	hasIntentElement()
boolean	hasMedium()
boolean	hasNote()
boolean	hasOccurrence()
boolean	hasOccurrenceDateTimeType()
boolean	hasOccurrencePeriod()
boolean	hasPayload()
boolean	hasPriority()
boolean	hasPriorityElement()
boolean	hasReason()
boolean	hasRecipient()
boolean	hasReplaces()
boolean	hasRequester()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasStatusReason()
boolean	hasSubject()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
CommunicationRequest	setAbout(List<Reference> theAbout)
CommunicationRequest	setAuthoredOn(Date value)
CommunicationRequest	setAuthoredOnElement(DateTimeType value)
CommunicationRequest	setBasedOn(List<Reference> theBasedOn)
CommunicationRequest	setCategory(List<CodeableConcept> theCategory)
CommunicationRequest	setDoNotPerform(boolean value)
CommunicationRequest	setDoNotPerformElement(BooleanType value)
CommunicationRequest	setEncounter(Reference value)
CommunicationRequest	setGroupIdentifier(Identifier value)
CommunicationRequest	setIdentifier(List<Identifier> theIdentifier)
CommunicationRequest	setInformationProvider(List<Reference> theInformationProvider)
CommunicationRequest	setIntent(Enumerations.RequestIntent value)
CommunicationRequest	setIntentElement(Enumeration<Enumerations.RequestIntent> value)
CommunicationRequest	setMedium(List<CodeableConcept> theMedium)
CommunicationRequest	setNote(List<Annotation> theNote)
CommunicationRequest	setOccurrence(DataType value)
CommunicationRequest	setPayload(List<CommunicationRequest.CommunicationRequestPayloadComponent> thePayload)
CommunicationRequest	setPriority(Enumerations.RequestPriority value)
CommunicationRequest	setPriorityElement(Enumeration<Enumerations.RequestPriority> value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
CommunicationRequest	setReason(List<CodeableReference> theReason)
CommunicationRequest	setRecipient(List<Reference> theRecipient)
CommunicationRequest	setReplaces(List<Reference> theReplaces)
CommunicationRequest	setRequester(Reference value)
CommunicationRequest	setStatus(Enumerations.RequestStatus value)
CommunicationRequest	setStatusElement(Enumeration<Enumerations.RequestStatus> value)
CommunicationRequest	setStatusReason(CodeableConcept value)
CommunicationRequest	setSubject(Reference value)
protected CommunicationRequest	typedCopy()

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

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

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

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

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

getStructureFhirVersionEnum, isResource, setId

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtml

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

Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

basedOn

protected List<Reference> basedOn

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.

groupIdentifier

protected Identifier groupIdentifier

A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.

status

protected Enumeration<Enumerations.RequestStatus> status

The status of the proposal or order.

statusReason

protected CodeableConcept statusReason

Captures the reason for the current state of the CommunicationRequest.

intent

protected Enumeration<Enumerations.RequestIntent> intent

Indicates the level of authority/intentionality associated with the CommunicationRequest and where the request fits into the workflow chain.

category

protected List<CodeableConcept> category

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

priority

protected Enumeration<Enumerations.RequestPriority> priority

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

doNotPerform

protected BooleanType doNotPerform

If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.

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.

about

protected List<Reference> about

Other resources that pertain to this communication request and to which this communication request should be associated.

encounter

protected Reference encounter

The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.

payload

protected List<CommunicationRequest.CommunicationRequestPayloadComponent> payload

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

occurrence

protected DataType 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.

requester

protected Reference requester

The device, individual, or organization who asks for the information to be shared.

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.

informationProvider

protected List<Reference> informationProvider

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

reason

protected List<CodeableReference> reason

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

note

protected List<Annotation> note

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

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_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_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_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_INFORMATION_PROVIDER

public static final String SP_INFORMATION_PROVIDER

Search parameter: information-provider

Description: Who should share the information
Type: reference
Path: CommunicationRequest.informationProvider

See Also:

• Constant Field Values

INFORMATION_PROVIDER

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

Fluent Client search parameter constant for information-provider

Description: Who should share the information
Type: reference
Path: CommunicationRequest.informationProvider

INCLUDE_INFORMATION_PROVIDER

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

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

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.occurrence.ofType(dateTime) | CommunicationRequest.occurrence.ofType(Period)

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.occurrence.ofType(dateTime) | CommunicationRequest.occurrence.ofType(Period)

SP_PRIORITY

public static final String SP_PRIORITY

Search parameter: priority

Description: routine | urgent | asap | stat
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: routine | urgent | asap | stat
Type: token
Path: CommunicationRequest.priority

SP_RECIPIENT

public static final String SP_RECIPIENT

Search parameter: recipient

Description: Who to share the information with
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: Who to share the information with
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_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_REQUESTER

public static final String SP_REQUESTER

Search parameter: requester

Description: Who asks for the information to be shared
Type: reference
Path: CommunicationRequest.requester

See Also:

• Constant Field Values

REQUESTER

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

Fluent Client search parameter constant for requester

Description: Who asks for the information to be shared
Type: reference
Path: CommunicationRequest.requester

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_STATUS

public static final String SP_STATUS

Search parameter: status

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

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_ENCOUNTER

public static final String SP_ENCOUNTER

Search parameter: encounter

Description: Multiple Resources: [AuditEvent](auditevent.html): Encounter related to the activity recorded in the AuditEvent [CarePlan](careplan.html): The Encounter during which this CarePlan was created [ChargeItem](chargeitem.html): Encounter associated with event [Claim](claim.html): Encounters associated with a billed line item [ClinicalImpression](clinicalimpression.html): The Encounter during which this ClinicalImpression was created [Communication](communication.html): The Encounter during which this Communication was created [CommunicationRequest](communicationrequest.html): The Encounter during which this CommunicationRequest was created [Composition](composition.html): Context of the Composition [Condition](condition.html): The Encounter during which this Condition was created [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [EncounterHistory](encounterhistory.html): The Encounter associated with this set of history values [ExplanationOfBenefit](explanationofbenefit.html): Encounters associated with a billed line item [Flag](flag.html): Alert relevant during encounter [ImagingStudy](imagingstudy.html): The context of the study [List](list.html): Context in which list created [MedicationDispense](medicationdispense.html): Returns dispenses with a specific encounter [MedicationStatement](medicationstatement.html): Returns statements for a specific encounter [NutritionIntake](nutritionintake.html): Returns statements for a specific encounter [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [Provenance](provenance.html): Encounter related to the Provenance [QuestionnaireResponse](questionnaireresponse.html): Encounter associated with the questionnaire response [RequestOrchestration](requestorchestration.html): The encounter the request orchestration applies to [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [Task](task.html): Search by encounter [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
Type: reference
Path: AuditEvent.encounter | CarePlan.encounter | ChargeItem.encounter | Claim.item.encounter | ClinicalImpression.encounter | Communication.encounter | CommunicationRequest.encounter | Composition.encounter | Condition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | EncounterHistory.encounter | ExplanationOfBenefit.item.encounter | Flag.encounter | ImagingStudy.encounter | List.encounter | MedicationDispense.encounter | MedicationStatement.encounter | NutritionIntake.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | Provenance.encounter | QuestionnaireResponse.encounter | RequestOrchestration.encounter | RiskAssessment.encounter | ServiceRequest.encounter | Task.encounter | VisionPrescription.encounter

See Also:

• Constant Field Values

ENCOUNTER

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

Fluent Client search parameter constant for encounter

Description: Multiple Resources: [AuditEvent](auditevent.html): Encounter related to the activity recorded in the AuditEvent [CarePlan](careplan.html): The Encounter during which this CarePlan was created [ChargeItem](chargeitem.html): Encounter associated with event [Claim](claim.html): Encounters associated with a billed line item [ClinicalImpression](clinicalimpression.html): The Encounter during which this ClinicalImpression was created [Communication](communication.html): The Encounter during which this Communication was created [CommunicationRequest](communicationrequest.html): The Encounter during which this CommunicationRequest was created [Composition](composition.html): Context of the Composition [Condition](condition.html): The Encounter during which this Condition was created [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [EncounterHistory](encounterhistory.html): The Encounter associated with this set of history values [ExplanationOfBenefit](explanationofbenefit.html): Encounters associated with a billed line item [Flag](flag.html): Alert relevant during encounter [ImagingStudy](imagingstudy.html): The context of the study [List](list.html): Context in which list created [MedicationDispense](medicationdispense.html): Returns dispenses with a specific encounter [MedicationStatement](medicationstatement.html): Returns statements for a specific encounter [NutritionIntake](nutritionintake.html): Returns statements for a specific encounter [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [Provenance](provenance.html): Encounter related to the Provenance [QuestionnaireResponse](questionnaireresponse.html): Encounter associated with the questionnaire response [RequestOrchestration](requestorchestration.html): The encounter the request orchestration applies to [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [Task](task.html): Search by encounter [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
Type: reference
Path: AuditEvent.encounter | CarePlan.encounter | ChargeItem.encounter | Claim.item.encounter | ClinicalImpression.encounter | Communication.encounter | CommunicationRequest.encounter | Composition.encounter | Condition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | EncounterHistory.encounter | ExplanationOfBenefit.item.encounter | Flag.encounter | ImagingStudy.encounter | List.encounter | MedicationDispense.encounter | MedicationStatement.encounter | NutritionIntake.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | Provenance.encounter | QuestionnaireResponse.encounter | RequestOrchestration.encounter | RiskAssessment.encounter | ServiceRequest.encounter | Task.encounter | VisionPrescription.encounter

INCLUDE_ENCOUNTER

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

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

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.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: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.identifier

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.patient

See Also:

• Constant Field Values

PATIENT

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

Fluent Client search parameter constant for patient

Description: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.patient

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

Constructor Details

CommunicationRequest

public CommunicationRequest()

Constructor

CommunicationRequest

public CommunicationRequest(Enumerations.RequestStatus status,
 Enumerations.RequestIntent intent)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.)

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 {3}

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 {3}

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 {3}

getGroupIdentifier

public Identifier getGroupIdentifier()

Returns:

groupIdentifier (A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.)

hasGroupIdentifier

public boolean hasGroupIdentifier()

setGroupIdentifier

public CommunicationRequest setGroupIdentifier(Identifier value)

Parameters:

value - groupIdentifier (A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.)

getStatusElement

public Enumeration<Enumerations.RequestStatus> 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<Enumerations.RequestStatus> 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 Enumerations.RequestStatus getStatus()

Returns:

The status of the proposal or order.

setStatus

public CommunicationRequest setStatus(Enumerations.RequestStatus value)

Parameters:

value - The status of the proposal or order.

getStatusReason

public CodeableConcept getStatusReason()

Returns:

statusReason (Captures the reason for the current state of the CommunicationRequest.)

hasStatusReason

public boolean hasStatusReason()

setStatusReason

public CommunicationRequest setStatusReason(CodeableConcept value)

Parameters:

value - statusReason (Captures the reason for the current state of the CommunicationRequest.)

getIntentElement

public Enumeration<Enumerations.RequestIntent> getIntentElement()

Returns:

intent (Indicates the level of authority/intentionality associated with the CommunicationRequest and where the request fits into the workflow chain.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value

hasIntentElement

public boolean hasIntentElement()

hasIntent

public boolean hasIntent()

setIntentElement

public CommunicationRequest setIntentElement(Enumeration<Enumerations.RequestIntent> value)

Parameters:

value - intent (Indicates the level of authority/intentionality associated with the CommunicationRequest and where the request fits into the workflow chain.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value

getIntent

public Enumerations.RequestIntent getIntent()

Returns:

Indicates the level of authority/intentionality associated with the CommunicationRequest and where the request fits into the workflow chain.

setIntent

public CommunicationRequest setIntent(Enumerations.RequestIntent value)

Parameters:

value - Indicates the level of authority/intentionality associated with the CommunicationRequest and where the request fits into the workflow chain.

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 {3}

getPriorityElement

public Enumeration<Enumerations.RequestPriority> 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<Enumerations.RequestPriority> 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 Enumerations.RequestPriority getPriority()

Returns:

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

setPriority

public CommunicationRequest setPriority(Enumerations.RequestPriority value)

Parameters:

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

getDoNotPerformElement

public BooleanType getDoNotPerformElement()

Returns:

doNotPerform (If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.). This is the underlying object with id, value and extensions. The accessor "getDoNotPerform" gives direct access to the value

hasDoNotPerformElement

public boolean hasDoNotPerformElement()

hasDoNotPerform

public boolean hasDoNotPerform()

setDoNotPerformElement

public CommunicationRequest setDoNotPerformElement(BooleanType value)

Parameters:

value - doNotPerform (If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.). This is the underlying object with id, value and extensions. The accessor "getDoNotPerform" gives direct access to the value

getDoNotPerform

public boolean getDoNotPerform()

Returns:

If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.

setDoNotPerform

public CommunicationRequest setDoNotPerform(boolean value)

Parameters:

value - If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.

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 {3}

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

getAbout

public List<Reference> getAbout()

Returns:

about (Other resources that pertain to this communication request and to which this communication request should be associated.)

setAbout

public CommunicationRequest setAbout(List<Reference> theAbout)

Returns:

Returns a reference to this for easy method chaining

hasAbout

public boolean hasAbout()

addAbout

public Reference addAbout()

addAbout

public CommunicationRequest addAbout(Reference t)

getAboutFirstRep

public Reference getAboutFirstRep()

Returns:

The first repetition of repeating field about, creating it if it does not already exist {3}

getEncounter

public Reference getEncounter()

Returns:

encounter (The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.)

hasEncounter

public boolean hasEncounter()

setEncounter

public CommunicationRequest setEncounter(Reference value)

Parameters:

value - encounter (The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.)

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 {3}

getOccurrence

public DataType 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(DataType value)

Parameters:

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

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.

getRequester

public Reference getRequester()

Returns:

requester (The device, individual, or organization who asks for the information to be shared.)

hasRequester

public boolean hasRequester()

setRequester

public CommunicationRequest setRequester(Reference value)

Parameters:

value - requester (The device, individual, or organization who asks for the information to be shared.)

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 {3}

getInformationProvider

public List<Reference> getInformationProvider()

Returns:

informationProvider (The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.)

setInformationProvider

public CommunicationRequest setInformationProvider(List<Reference> theInformationProvider)

Returns:

Returns a reference to this for easy method chaining

hasInformationProvider

public boolean hasInformationProvider()

addInformationProvider

public Reference addInformationProvider()

addInformationProvider

public CommunicationRequest addInformationProvider(Reference t)

getInformationProviderFirstRep

public Reference getInformationProviderFirstRep()

Returns:

The first repetition of repeating field informationProvider, creating it if it does not already exist {3}

getReason

public List<CodeableReference> getReason()

Returns:

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

setReason

public CommunicationRequest setReason(List<CodeableReference> theReason)

Returns:

Returns a reference to this for easy method chaining

hasReason

public boolean hasReason()

addReason

public CodeableReference addReason()

addReason

public CommunicationRequest addReason(CodeableReference t)

getReasonFirstRep

public CodeableReference getReasonFirstRep()

Returns:

The first repetition of repeating field reason, creating it if it does not already exist {3}

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 {3}

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

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild 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

Returns:

the FHIR type name of the instance (not the java class name)

copy

public CommunicationRequest copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(CommunicationRequest dst)

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