Class 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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
static class
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionOther resources that pertain to this communication request and to which this communication request should be associated.The actual objects that are the target of the reference (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
Fluent Client search parameter constant for authoredprotected DateTimeType
For draft requests, indicates the date of initial creation.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for based-onA plan or proposal that is fulfilled in whole or in part by this request.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> The type of message to be sent such as alert, notification, reminder, instruction, etc.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for categoryprotected BooleanType
If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.protected Reference
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
Fluent Client search parameter constant for encounterprotected Encounter
The actual object that is the target of the reference (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.TokenClientParam
Fluent Client search parameter constant for group-identifierprotected Identifier
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> 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
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected List
<CodeableConcept> A channel that was used for this communication (e.g.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for mediumprotected List
<Annotation> Comments made about the request by the requester, sender, recipient, subject or other participants.protected Type
The time when this communication is to occur.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for occurrencestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientText, attachment(s), or resource(s) to be communicated to the recipient.Characterizes how quickly the proposed act must be initiated.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for priorityprotected List
<CodeableConcept> Describes why the request is being made in coded or textual form.Indicates another resource whose existence justifies this request.The actual objects that are the target of the reference (Indicates another resource whose existence justifies this request.)The entity (e.g.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for recipientThe actual objects that are the target of the reference (The entity (e.g.Completed or terminated request(s) whose function is taken by this new request.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for replacesprotected List
<CommunicationRequest> The actual objects that are the target of the reference (Completed or terminated request(s) whose function is taken by this new request.)protected Reference
The device, individual, or organization who initiated the request and has responsibility for its activation.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for requesterprotected Resource
The actual object that is the target of the reference (The device, individual, or organization who initiated the request and has responsibility for its activation.)protected Reference
The entity (e.g.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for senderprotected Resource
The actual object that is the target of the reference (The entity (e.g.static final String
Search parameter: authoredstatic final String
Search parameter: based-onstatic final String
Search parameter: categorystatic final String
Search parameter: encounterstatic final String
Search parameter: group-identifierstatic final String
Search parameter: identifierstatic final String
Search parameter: mediumstatic final String
Search parameter: occurrencestatic final String
Search parameter: patientstatic final String
Search parameter: prioritystatic final String
Search parameter: recipientstatic final String
Search parameter: replacesstatic final String
Search parameter: requesterstatic final String
Search parameter: senderstatic final String
Search parameter: statusstatic final String
Search parameter: subjectThe status of the proposal or order.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected CodeableConcept
Captures the reason for the current state of the CommunicationRequest.protected Reference
The patient or group that is the focus of this communication request.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectprotected Resource
The actual object that is the target of the reference (The patient or group that is the focus of this communication request.)Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.r4.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
ConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptionaddAbout()
addNote()
Deprecated.Use Reference#setResource(IBaseResource) insteadcopy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getAbout()
Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadboolean
getNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
Base[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadString[]
getTypesForProperty
(int hash, String name) boolean
hasAbout()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAuthoredOn
(Date value) setAuthoredOnElement
(DateTimeType value) setBasedOn
(List<Reference> theBasedOn) setCategory
(List<CodeableConcept> theCategory) setDoNotPerform
(boolean value) setEncounter
(Reference value) setEncounterTarget
(Encounter value) setGroupIdentifier
(Identifier value) setIdentifier
(List<Identifier> theIdentifier) setMedium
(List<CodeableConcept> theMedium) setNote
(List<Annotation> theNote) setOccurrence
(Type value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setReasonCode
(List<CodeableConcept> theReasonCode) setReasonReference
(List<Reference> theReasonReference) setRecipient
(List<Reference> theRecipient) setReplaces
(List<Reference> theReplaces) setRequester
(Reference value) setRequesterTarget
(Resource value) setSenderTarget
(Resource value) setStatusReason
(CodeableConcept value) setSubject
(Reference value) setSubjectTarget
(Resource value) protected CommunicationRequest
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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
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
A plan or proposal that is fulfilled in whole or in part by this request. -
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
Completed or terminated request(s) whose function is taken by this new request. -
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
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
The status of the proposal or order. -
statusReason
Captures the reason for the current state of the CommunicationRequest. -
category
The type of message to be sent such as alert, notification, reminder, instruction, etc. -
priority
Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine. -
doNotPerform
If true indicates that the CommunicationRequest is asking for the specified action to *not* occur. -
medium
A channel that was used for this communication (e.g. email, fax). -
subject
The patient or group that is the focus of this communication request. -
subjectTarget
The actual object that is the target of the reference (The patient or group that is the focus of this communication request.) -
about
Other resources that pertain to this communication request and to which this communication request should be associated. -
aboutTarget
The actual objects that are the target of the reference (Other resources that pertain to this communication request and to which this communication request should be associated.) -
encounter
The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated. -
encounterTarget
The actual object that is the target of the reference (The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.) -
payload
Text, attachment(s), or resource(s) to be communicated to the recipient. -
occurrence
The time when this communication is to occur. -
authoredOn
For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation. -
requester
The device, individual, or organization who initiated the request and has responsibility for its activation. -
requesterTarget
The actual object that is the target of the reference (The device, individual, or organization who initiated the request and has responsibility for its activation.) -
recipient
The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication. -
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.) -
sender
The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication. -
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.) -
reasonCode
Describes why the request is being made in coded or textual form. -
reasonReference
Indicates another resource whose existence justifies this request. -
reasonReferenceTarget
The actual objects that are the target of the reference (Indicates another resource whose existence justifies this request.) -
note
Comments made about the request by the requester, sender, recipient, subject or other participants. -
SP_REQUESTER
Search parameter: requesterDescription: Who/what is requesting service
Type: reference
Path: CommunicationRequest.requester
- See Also:
-
REQUESTER
Fluent Client search parameter constant for requesterDescription: Who/what is requesting service
Type: reference
Path: CommunicationRequest.requester
-
INCLUDE_REQUESTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "CommunicationRequest:requester". -
SP_AUTHORED
Search parameter: authoredDescription: When request transitioned to being actionable
Type: date
Path: CommunicationRequest.authoredOn
- See Also:
-
AUTHORED
Fluent Client search parameter constant for authoredDescription: When request transitioned to being actionable
Type: date
Path: CommunicationRequest.authoredOn
-
SP_IDENTIFIER
Search parameter: identifierDescription: Unique identifier
Type: token
Path: CommunicationRequest.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Unique identifier
Type: token
Path: CommunicationRequest.identifier
-
SP_SUBJECT
Search parameter: subjectDescription: Focus of message
Type: reference
Path: CommunicationRequest.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: Focus of message
Type: reference
Path: CommunicationRequest.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "CommunicationRequest:subject". -
SP_REPLACES
Search parameter: replacesDescription: Request(s) replaced by this request
Type: reference
Path: CommunicationRequest.replaces
- See Also:
-
REPLACES
Fluent Client search parameter constant for replacesDescription: Request(s) replaced by this request
Type: reference
Path: CommunicationRequest.replaces
-
INCLUDE_REPLACES
Constant for fluent queries to be used to add include statements. Specifies the path value of "CommunicationRequest:replaces". -
SP_MEDIUM
Search parameter: mediumDescription: A channel of communication
Type: token
Path: CommunicationRequest.medium
- See Also:
-
MEDIUM
Fluent Client search parameter constant for mediumDescription: A channel of communication
Type: token
Path: CommunicationRequest.medium
-
SP_ENCOUNTER
Search parameter: encounterDescription: Encounter created as part of
Type: reference
Path: CommunicationRequest.encounter
- See Also:
-
ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Encounter created as part of
Type: reference
Path: CommunicationRequest.encounter
-
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "CommunicationRequest:encounter". -
SP_OCCURRENCE
Search parameter: occurrenceDescription: When scheduled
Type: date
Path: CommunicationRequest.occurrenceDateTime
- See Also:
-
OCCURRENCE
Fluent Client search parameter constant for occurrenceDescription: When scheduled
Type: date
Path: CommunicationRequest.occurrenceDateTime
-
SP_PRIORITY
Search parameter: priorityDescription: routine | urgent | asap | stat
Type: token
Path: CommunicationRequest.priority
- See Also:
-
PRIORITY
Fluent Client search parameter constant for priorityDescription: routine | urgent | asap | stat
Type: token
Path: CommunicationRequest.priority
-
SP_GROUP_IDENTIFIER
Search parameter: group-identifierDescription: Composite request this is part of
Type: token
Path: CommunicationRequest.groupIdentifier
- See Also:
-
GROUP_IDENTIFIER
Fluent Client search parameter constant for group-identifierDescription: Composite request this is part of
Type: token
Path: CommunicationRequest.groupIdentifier
-
SP_BASED_ON
Search parameter: based-onDescription: Fulfills plan or proposal
Type: reference
Path: CommunicationRequest.basedOn
- See Also:
-
BASED_ON
Fluent Client search parameter constant for based-onDescription: Fulfills plan or proposal
Type: reference
Path: CommunicationRequest.basedOn
-
INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "CommunicationRequest:based-on". -
SP_SENDER
Search parameter: senderDescription: Message sender
Type: reference
Path: CommunicationRequest.sender
- See Also:
-
SENDER
Fluent Client search parameter constant for senderDescription: Message sender
Type: reference
Path: CommunicationRequest.sender
-
INCLUDE_SENDER
Constant for fluent queries to be used to add include statements. Specifies the path value of "CommunicationRequest:sender". -
SP_PATIENT
Search parameter: patientDescription: Focus of message
Type: reference
Path: CommunicationRequest.subject
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Focus of message
Type: reference
Path: CommunicationRequest.subject
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "CommunicationRequest:patient". -
SP_RECIPIENT
Search parameter: recipientDescription: Message recipient
Type: reference
Path: CommunicationRequest.recipient
- See Also:
-
RECIPIENT
Fluent Client search parameter constant for recipientDescription: Message recipient
Type: reference
Path: CommunicationRequest.recipient
-
INCLUDE_RECIPIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "CommunicationRequest:recipient". -
SP_CATEGORY
Search parameter: categoryDescription: Message category
Type: token
Path: CommunicationRequest.category
- See Also:
-
CATEGORY
Fluent Client search parameter constant for categoryDescription: Message category
Type: token
Path: CommunicationRequest.category
-
SP_STATUS
Search parameter: statusDescription: draft | active | on-hold | revoked | completed | entered-in-error | unknown
Type: token
Path: CommunicationRequest.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: draft | active | on-hold | revoked | completed | entered-in-error | unknown
Type: token
Path: CommunicationRequest.status
-
-
Constructor Details
-
CommunicationRequest
public CommunicationRequest()Constructor -
CommunicationRequest
Constructor
-
-
Method Details
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getBasedOn
- Returns:
basedOn
(A plan or proposal that is fulfilled in whole or in part by this request.)
-
setBasedOn
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasBasedOn
-
addBasedOn
-
addBasedOn
-
getBasedOnFirstRep
- Returns:
- The first repetition of repeating field
basedOn
, creating it if it does not already exist
-
getBasedOnTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getReplaces
- Returns:
replaces
(Completed or terminated request(s) whose function is taken by this new request.)
-
setReplaces
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReplaces
-
addReplaces
-
addReplaces
-
getReplacesFirstRep
- Returns:
- The first repetition of repeating field
replaces
, creating it if it does not already exist
-
getReplacesTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addReplacesTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
-
setGroupIdentifier
- 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
- 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
-
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
- Returns:
- The status of the proposal or order.
-
setStatus
- Parameters:
value
- The status of the proposal or order.
-
getStatusReason
- Returns:
statusReason
(Captures the reason for the current state of the CommunicationRequest.)
-
hasStatusReason
-
setStatusReason
- Parameters:
value
-statusReason
(Captures the reason for the current state of the CommunicationRequest.)
-
getCategory
- Returns:
category
(The type of message to be sent such as alert, notification, reminder, instruction, etc.)
-
setCategory
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCategory
-
addCategory
-
addCategory
-
getCategoryFirstRep
- Returns:
- The first repetition of repeating field
category
, creating it if it does not already exist
-
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
-
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
- Returns:
- Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
-
setPriority
- Parameters:
value
- Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
-
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
-
hasDoNotPerform
-
setDoNotPerformElement
- 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
- Returns:
- If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.
-
setDoNotPerform
- Parameters:
value
- If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.
-
getMedium
- Returns:
medium
(A channel that was used for this communication (e.g. email, fax).)
-
setMedium
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasMedium
-
addMedium
-
addMedium
-
getMediumFirstRep
- Returns:
- The first repetition of repeating field
medium
, creating it if it does not already exist
-
getSubject
- Returns:
subject
(The patient or group that is the focus of this communication request.)
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(The patient or group that is the focus of this communication request.)
-
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
- 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.)
-
getAbout
- Returns:
about
(Other resources that pertain to this communication request and to which this communication request should be associated.)
-
setAbout
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAbout
-
addAbout
-
addAbout
-
getAboutFirstRep
- Returns:
- The first repetition of repeating field
about
, creating it if it does not already exist
-
getAboutTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getEncounter
- Returns:
encounter
(The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.)
-
hasEncounter
-
setEncounter
- Parameters:
value
-encounter
(The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.)
-
getEncounterTarget
- Returns:
encounter
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.)
-
setEncounterTarget
- Parameters:
value
-encounter
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.)
-
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
-
addPayload
-
addPayload
-
getPayloadFirstRep
- Returns:
- The first repetition of repeating field
payload
, creating it if it does not already exist
-
getOccurrence
- Returns:
occurrence
(The time when this communication is to occur.)
-
getOccurrenceDateTimeType
- Returns:
occurrence
(The time when this communication is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrenceDateTimeType
-
getOccurrencePeriod
- Returns:
occurrence
(The time when this communication is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrencePeriod
-
hasOccurrence
-
setOccurrence
- Parameters:
value
-occurrence
(The time when this communication is to occur.)
-
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
-
hasAuthoredOn
-
setAuthoredOnElement
- 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
- Returns:
- For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
-
setAuthoredOn
- Parameters:
value
- For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
-
getRequester
- Returns:
requester
(The device, individual, or organization who initiated the request and has responsibility for its activation.)
-
hasRequester
-
setRequester
- Parameters:
value
-requester
(The device, individual, or organization who initiated the request and has responsibility for its activation.)
-
getRequesterTarget
- Returns:
requester
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The device, individual, or organization who initiated the request and has responsibility for its activation.)
-
setRequesterTarget
- Parameters:
value
-requester
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The device, individual, or organization who initiated the request and has responsibility for its activation.)
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRecipient
-
addRecipient
-
addRecipient
-
getRecipientFirstRep
- Returns:
- The first repetition of repeating field
recipient
, creating it if it does not already exist
-
getRecipientTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getSender
- Returns:
sender
(The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.)
-
hasSender
-
setSender
- Parameters:
value
-sender
(The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.)
-
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
- 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.)
-
getReasonCode
- Returns:
reasonCode
(Describes why the request is being made in coded or textual form.)
-
setReasonCode
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReasonCode
-
addReasonCode
-
addReasonCode
-
getReasonCodeFirstRep
- Returns:
- The first repetition of repeating field
reasonCode
, creating it if it does not already exist
-
getReasonReference
- Returns:
reasonReference
(Indicates another resource whose existence justifies this request.)
-
setReasonReference
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReasonReference
-
addReasonReference
-
addReasonReference
-
getReasonReferenceFirstRep
- Returns:
- The first repetition of repeating field
reasonReference
, creating it if it does not already exist
-
getReasonReferenceTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getNote
- Returns:
note
(Comments made about the request by the requester, sender, recipient, subject or other participants.)
-
setNote
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
-
addNote
-
addNote
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-