Class Task
- 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 class
static enum
static class
static class
static enum
static class
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionstatic final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for authored-onprotected DateTimeType
The date and time this task was created.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for based-onBasedOn refers to a higher-level authorization that triggered the creation of the task.The actual objects that are the target of the reference (BasedOn refers to a higher-level authorization that triggered the creation of the task.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for business-statusprotected CodeableConcept
Contains business-specific nuances of the business state.protected CodeableConcept
A name or code (or both) briefly describing what the task involves.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for codeprotected StringType
A free-text description of what is to be performed.protected Reference
The healthcare event (e.g.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 healthcare event (e.g.protected Period
Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).protected Reference
The request being actioned or the resource being manipulated by this task.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for focusprotected Resource
The actual object that is the target of the reference (The request being actioned or the resource being manipulated by this task.)protected Reference
The entity who benefits from the performance of the service specified in the task (e.g., the patient).protected Resource
The actual object that is the target of the reference (The entity who benefits from the performance of the service specified in the task (e.g., the patient).)static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for group-identifierprotected Identifier
An identifier that links together multiple tasks and other requests that were created in the same context.protected List
<Identifier> The business identifier for this task.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
<Task.ParameterComponent> Additional information that may be needed in the execution of the task.protected CanonicalType
The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.protected UriType
The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.The actual objects that are the target of the reference (Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.)protected Enumeration
<Task.TaskIntent> Indicates the "level" of actionability associated with the Task, i.e.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for intentprotected DateTimeType
The date and time of last modification to this task.protected Reference
Principal physical location where the this task is performed.protected Location
The actual object that is the target of the reference (Principal physical location where the this task is performed.)static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for modifiedprotected List
<Annotation> Free-text information captured about the task as it progresses.protected List
<Task.TaskOutputComponent> Outputs produced by the Task.protected Reference
Individual organization or Device currently responsible for task execution.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for ownerprotected Resource
The actual object that is the target of the reference (Individual organization or Device currently responsible for task execution.)static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for part-ofTask that this particular task is part of.The actual objects that are the target of the reference (Task that this particular task is part of.)static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for performerprotected List
<CodeableConcept> The kind of participant that should perform the task.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for periodprotected Enumeration
<Task.TaskPriority> Indicates how quickly the Task should be addressed with respect to other requests.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for priorityprotected CodeableConcept
A description or code indicating why this task needs to be performed.protected Reference
A resource reference indicating why this task needs to be performed.protected Resource
The actual object that is the target of the reference (A resource reference indicating why this task needs to be performed.)Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.protected List
<Provenance> The actual objects that are the target of the reference (Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.)protected Reference
The creator of the task.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 creator of the task.)protected Task.TaskRestrictionComponent
If the Task.focus is a request resource and the task is seeking fulfillment (i.e.static final String
Search parameter: authored-onstatic final String
Search parameter: based-onstatic final String
Search parameter: business-statusstatic final String
Search parameter: codestatic final String
Search parameter: encounterstatic final String
Search parameter: focusstatic final String
Search parameter: group-identifierstatic final String
Search parameter: identifierstatic final String
Search parameter: intentstatic final String
Search parameter: modifiedstatic final String
Search parameter: ownerstatic final String
Search parameter: part-ofstatic final String
Search parameter: patientstatic final String
Search parameter: performerstatic final String
Search parameter: periodstatic final String
Search parameter: prioritystatic final String
Search parameter: requesterstatic final String
Search parameter: statusstatic final String
Search parameter: subjectprotected Enumeration
<Task.TaskStatus> The current status of the task.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected CodeableConcept
An explanation as to why this task is held, failed, was refused, etc.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectFields 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
ConstructorDescriptionTask()
ConstructorTask
(Enumeration<Task.TaskStatus> status, Enumeration<Task.TaskIntent> intent) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddInput()
addNote()
Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadcopy()
void
copyValues
(Task dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
Deprecated.Use Reference#setResource(IBaseResource) insteadgetCode()
getFocus()
getFor()
getInput()
Deprecated.Use Reference#setResource(IBaseResource) insteadgetNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
getOwner()
Deprecated.Use Reference#setResource(IBaseResource) insteadBase[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadString[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
hasCode()
boolean
boolean
boolean
boolean
boolean
hasFocus()
boolean
hasFor()
boolean
boolean
boolean
hasInput()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasNote()
boolean
boolean
hasOwner()
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) setBusinessStatus
(CodeableConcept value) setCode
(CodeableConcept value) setDescription
(String value) setDescriptionElement
(StringType value) setEncounter
(Reference value) setEncounterTarget
(Encounter value) setExecutionPeriod
(Period value) setFocusTarget
(Resource value) setForTarget
(Resource value) setGroupIdentifier
(Identifier value) setIdentifier
(List<Identifier> theIdentifier) setInput
(List<Task.ParameterComponent> theInput) setInstantiatesCanonical
(String value) setInstantiatesUri
(String value) setInstantiatesUriElement
(UriType value) setInsurance
(List<Reference> theInsurance) setIntent
(Task.TaskIntent value) setLastModified
(Date value) setLocation
(Reference value) setLocationTarget
(Location value) setNote
(List<Annotation> theNote) setOutput
(List<Task.TaskOutputComponent> theOutput) setOwnerTarget
(Resource value) setPerformerType
(List<CodeableConcept> thePerformerType) setPriority
(Task.TaskPriority value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setReasonCode
(CodeableConcept value) setReasonReference
(Reference value) setReasonReferenceTarget
(Resource value) setRelevantHistory
(List<Reference> theRelevantHistory) setRequester
(Reference value) setRequesterTarget
(Resource value) setStatus
(Task.TaskStatus value) setStatusReason
(CodeableConcept value) protected Task
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
The business identifier for this task. -
instantiatesCanonical
The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. -
instantiatesUri
The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. -
basedOn
BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient. -
basedOnTarget
The actual objects that are the target of the reference (BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.) -
groupIdentifier
An identifier that links together multiple tasks and other requests that were created in the same context. -
partOf
Task that this particular task is part of. -
partOfTarget
The actual objects that are the target of the reference (Task that this particular task is part of.) -
status
The current status of the task. -
statusReason
An explanation as to why this task is held, failed, was refused, etc. -
businessStatus
Contains business-specific nuances of the business state. -
intent
Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc. -
priority
Indicates how quickly the Task should be addressed with respect to other requests. -
code
A name or code (or both) briefly describing what the task involves. -
description
A free-text description of what is to be performed. -
focus
The request being actioned or the resource being manipulated by this task. -
focusTarget
The actual object that is the target of the reference (The request being actioned or the resource being manipulated by this task.) -
for_
The entity who benefits from the performance of the service specified in the task (e.g., the patient). -
for_Target
The actual object that is the target of the reference (The entity who benefits from the performance of the service specified in the task (e.g., the patient).) -
encounter
The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. -
encounterTarget
The actual object that is the target of the reference (The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.) -
executionPeriod
Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end). -
authoredOn
The date and time this task was created. -
lastModified
The date and time of last modification to this task. -
requester
The creator of the task. -
requesterTarget
The actual object that is the target of the reference (The creator of the task.) -
performerType
The kind of participant that should perform the task. -
owner
Individual organization or Device currently responsible for task execution. -
ownerTarget
The actual object that is the target of the reference (Individual organization or Device currently responsible for task execution.) -
location
Principal physical location where the this task is performed. -
locationTarget
The actual object that is the target of the reference (Principal physical location where the this task is performed.) -
reasonCode
A description or code indicating why this task needs to be performed. -
reasonReference
A resource reference indicating why this task needs to be performed. -
reasonReferenceTarget
The actual object that is the target of the reference (A resource reference indicating why this task needs to be performed.) -
insurance
Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task. -
insuranceTarget
The actual objects that are the target of the reference (Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.) -
note
Free-text information captured about the task as it progresses. -
relevantHistory
Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task. -
relevantHistoryTarget
The actual objects that are the target of the reference (Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.) -
restriction
If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned. -
input
Additional information that may be needed in the execution of the task. -
output
Outputs produced by the Task. -
SP_OWNER
Search parameter: ownerDescription: Search by task owner
Type: reference
Path: Task.owner
- See Also:
-
OWNER
Fluent Client search parameter constant for ownerDescription: Search by task owner
Type: reference
Path: Task.owner
-
INCLUDE_OWNER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:owner". -
SP_REQUESTER
Search parameter: requesterDescription: Search by task requester
Type: reference
Path: Task.requester
- See Also:
-
REQUESTER
Fluent Client search parameter constant for requesterDescription: Search by task requester
Type: reference
Path: Task.requester
-
INCLUDE_REQUESTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:requester". -
SP_IDENTIFIER
Search parameter: identifierDescription: Search for a task instance by its business identifier
Type: token
Path: Task.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Search for a task instance by its business identifier
Type: token
Path: Task.identifier
-
SP_BUSINESS_STATUS
Search parameter: business-statusDescription: Search by business status
Type: token
Path: Task.businessStatus
- See Also:
-
BUSINESS_STATUS
Fluent Client search parameter constant for business-statusDescription: Search by business status
Type: token
Path: Task.businessStatus
-
SP_PERIOD
Search parameter: periodDescription: Search by period Task is/was underway
Type: date
Path: Task.executionPeriod
- See Also:
-
PERIOD
Fluent Client search parameter constant for periodDescription: Search by period Task is/was underway
Type: date
Path: Task.executionPeriod
-
SP_CODE
Search parameter: codeDescription: Search by task code
Type: token
Path: Task.code
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: Search by task code
Type: token
Path: Task.code
-
SP_PERFORMER
Search parameter: performerDescription: Search by recommended type of performer (e.g., Requester, Performer, Scheduler).
Type: token
Path: Task.performerType
- See Also:
-
PERFORMER
Fluent Client search parameter constant for performerDescription: Search by recommended type of performer (e.g., Requester, Performer, Scheduler).
Type: token
Path: Task.performerType
-
SP_SUBJECT
Search parameter: subjectDescription: Search by subject
Type: reference
Path: Task.for
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: Search by subject
Type: reference
Path: Task.for
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:subject". -
SP_FOCUS
Search parameter: focusDescription: Search by task focus
Type: reference
Path: Task.focus
- See Also:
-
FOCUS
Fluent Client search parameter constant for focusDescription: Search by task focus
Type: reference
Path: Task.focus
-
INCLUDE_FOCUS
Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:focus". -
SP_PART_OF
Search parameter: part-ofDescription: Search by task this task is part of
Type: reference
Path: Task.partOf
- See Also:
-
PART_OF
Fluent Client search parameter constant for part-ofDescription: Search by task this task is part of
Type: reference
Path: Task.partOf
-
INCLUDE_PART_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:part-of". -
SP_ENCOUNTER
Search parameter: encounterDescription: Search by encounter
Type: reference
Path: Task.encounter
- See Also:
-
ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Search by encounter
Type: reference
Path: Task.encounter
-
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:encounter". -
SP_PRIORITY
Search parameter: priorityDescription: Search by task priority
Type: token
Path: Task.priority
- See Also:
-
PRIORITY
Fluent Client search parameter constant for priorityDescription: Search by task priority
Type: token
Path: Task.priority
-
SP_AUTHORED_ON
Search parameter: authored-onDescription: Search by creation date
Type: date
Path: Task.authoredOn
- See Also:
-
AUTHORED_ON
Fluent Client search parameter constant for authored-onDescription: Search by creation date
Type: date
Path: Task.authoredOn
-
SP_INTENT
Search parameter: intentDescription: Search by task intent
Type: token
Path: Task.intent
- See Also:
-
INTENT
Fluent Client search parameter constant for intentDescription: Search by task intent
Type: token
Path: Task.intent
-
SP_GROUP_IDENTIFIER
Search parameter: group-identifierDescription: Search by group identifier
Type: token
Path: Task.groupIdentifier
- See Also:
-
GROUP_IDENTIFIER
Fluent Client search parameter constant for group-identifierDescription: Search by group identifier
Type: token
Path: Task.groupIdentifier
-
SP_BASED_ON
Search parameter: based-onDescription: Search by requests this task is based on
Type: reference
Path: Task.basedOn
- See Also:
-
BASED_ON
Fluent Client search parameter constant for based-onDescription: Search by requests this task is based on
Type: reference
Path: Task.basedOn
-
INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:based-on". -
SP_PATIENT
Search parameter: patientDescription: Search by patient
Type: reference
Path: Task.for
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Search by patient
Type: reference
Path: Task.for
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:patient". -
SP_MODIFIED
Search parameter: modifiedDescription: Search by last modification date
Type: date
Path: Task.lastModified
- See Also:
-
MODIFIED
Fluent Client search parameter constant for modifiedDescription: Search by last modification date
Type: date
Path: Task.lastModified
-
SP_STATUS
Search parameter: statusDescription: Search by task status
Type: token
Path: Task.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: Search by task status
Type: token
Path: Task.status
-
-
Constructor Details
-
Task
public Task()Constructor -
Task
Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(The business identifier for this task.)
-
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
-
getInstantiatesCanonicalElement
- Returns:
instantiatesCanonical
(The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.). This is the underlying object with id, value and extensions. The accessor "getInstantiatesCanonical" gives direct access to the value
-
hasInstantiatesCanonicalElement
-
hasInstantiatesCanonical
-
setInstantiatesCanonicalElement
- Parameters:
value
-instantiatesCanonical
(The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.). This is the underlying object with id, value and extensions. The accessor "getInstantiatesCanonical" gives direct access to the value
-
getInstantiatesCanonical
- Returns:
- The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
-
setInstantiatesCanonical
- Parameters:
value
- The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
-
getInstantiatesUriElement
- Returns:
instantiatesUri
(The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.). This is the underlying object with id, value and extensions. The accessor "getInstantiatesUri" gives direct access to the value
-
hasInstantiatesUriElement
-
hasInstantiatesUri
-
setInstantiatesUriElement
- Parameters:
value
-instantiatesUri
(The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.). This is the underlying object with id, value and extensions. The accessor "getInstantiatesUri" gives direct access to the value
-
getInstantiatesUri
- Returns:
- The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
-
setInstantiatesUri
- Parameters:
value
- The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
-
getBasedOn
- Returns:
basedOn
(BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.)
-
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 -
getGroupIdentifier
- Returns:
groupIdentifier
(An identifier that links together multiple tasks and other requests that were created in the same context.)
-
hasGroupIdentifier
-
setGroupIdentifier
- Parameters:
value
-groupIdentifier
(An identifier that links together multiple tasks and other requests that were created in the same context.)
-
getPartOf
- Returns:
partOf
(Task that this particular task is part of.)
-
setPartOf
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPartOf
-
addPartOf
-
addPartOf
-
getPartOfFirstRep
- Returns:
- The first repetition of repeating field
partOf
, creating it if it does not already exist
-
getPartOfTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addPartOfTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getStatusElement
- Returns:
status
(The current status of the task.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
-
hasStatus
-
setStatusElement
- Parameters:
value
-status
(The current status of the task.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- The current status of the task.
-
setStatus
- Parameters:
value
- The current status of the task.
-
getStatusReason
- Returns:
statusReason
(An explanation as to why this task is held, failed, was refused, etc.)
-
hasStatusReason
-
setStatusReason
- Parameters:
value
-statusReason
(An explanation as to why this task is held, failed, was refused, etc.)
-
getBusinessStatus
- Returns:
businessStatus
(Contains business-specific nuances of the business state.)
-
hasBusinessStatus
-
setBusinessStatus
- Parameters:
value
-businessStatus
(Contains business-specific nuances of the business state.)
-
getIntentElement
- Returns:
intent
(Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value
-
hasIntentElement
-
hasIntent
-
setIntentElement
- Parameters:
value
-intent
(Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value
-
getIntent
- Returns:
- Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.
-
setIntent
- Parameters:
value
- Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.
-
getPriorityElement
- Returns:
priority
(Indicates how quickly the Task should be addressed with respect to other requests.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
-
hasPriorityElement
-
hasPriority
-
setPriorityElement
- Parameters:
value
-priority
(Indicates how quickly the Task should be addressed with respect to other requests.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
-
getPriority
- Returns:
- Indicates how quickly the Task should be addressed with respect to other requests.
-
setPriority
- Parameters:
value
- Indicates how quickly the Task should be addressed with respect to other requests.
-
getCode
- Returns:
code
(A name or code (or both) briefly describing what the task involves.)
-
hasCode
-
setCode
- Parameters:
value
-code
(A name or code (or both) briefly describing what the task involves.)
-
getDescriptionElement
- Returns:
description
(A free-text description of what is to be performed.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
-
hasDescription
-
setDescriptionElement
- Parameters:
value
-description
(A free-text description of what is to be performed.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
- Returns:
- A free-text description of what is to be performed.
-
setDescription
- Parameters:
value
- A free-text description of what is to be performed.
-
getFocus
- Returns:
focus
(The request being actioned or the resource being manipulated by this task.)
-
hasFocus
-
setFocus
- Parameters:
value
-focus
(The request being actioned or the resource being manipulated by this task.)
-
getFocusTarget
- Returns:
focus
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 request being actioned or the resource being manipulated by this task.)
-
setFocusTarget
- Parameters:
value
-focus
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 request being actioned or the resource being manipulated by this task.)
-
getFor
- Returns:
for_
(The entity who benefits from the performance of the service specified in the task (e.g., the patient).)
-
hasFor
-
setFor
- Parameters:
value
-for_
(The entity who benefits from the performance of the service specified in the task (e.g., the patient).)
-
getForTarget
- Returns:
for_
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 who benefits from the performance of the service specified in the task (e.g., the patient).)
-
setForTarget
- Parameters:
value
-for_
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 who benefits from the performance of the service specified in the task (e.g., the patient).)
-
getEncounter
- Returns:
encounter
(The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.)
-
hasEncounter
-
setEncounter
- Parameters:
value
-encounter
(The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.)
-
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 healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.)
-
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 healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.)
-
getExecutionPeriod
- Returns:
executionPeriod
(Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).)
-
hasExecutionPeriod
-
setExecutionPeriod
- Parameters:
value
-executionPeriod
(Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).)
-
getAuthoredOnElement
- Returns:
authoredOn
(The date and time this task was created.). 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
(The date and time this task was created.). This is the underlying object with id, value and extensions. The accessor "getAuthoredOn" gives direct access to the value
-
getAuthoredOn
- Returns:
- The date and time this task was created.
-
setAuthoredOn
- Parameters:
value
- The date and time this task was created.
-
getLastModifiedElement
- Returns:
lastModified
(The date and time of last modification to this task.). This is the underlying object with id, value and extensions. The accessor "getLastModified" gives direct access to the value
-
hasLastModifiedElement
-
hasLastModified
-
setLastModifiedElement
- Parameters:
value
-lastModified
(The date and time of last modification to this task.). This is the underlying object with id, value and extensions. The accessor "getLastModified" gives direct access to the value
-
getLastModified
- Returns:
- The date and time of last modification to this task.
-
setLastModified
- Parameters:
value
- The date and time of last modification to this task.
-
getRequester
- Returns:
requester
(The creator of the task.)
-
hasRequester
-
setRequester
- Parameters:
value
-requester
(The creator of the task.)
-
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 creator of the task.)
-
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 creator of the task.)
-
getPerformerType
- Returns:
performerType
(The kind of participant that should perform the task.)
-
setPerformerType
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPerformerType
-
addPerformerType
-
addPerformerType
-
getPerformerTypeFirstRep
- Returns:
- The first repetition of repeating field
performerType
, creating it if it does not already exist
-
getOwner
- Returns:
owner
(Individual organization or Device currently responsible for task execution.)
-
hasOwner
-
setOwner
- Parameters:
value
-owner
(Individual organization or Device currently responsible for task execution.)
-
getOwnerTarget
- Returns:
owner
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. (Individual organization or Device currently responsible for task execution.)
-
setOwnerTarget
- Parameters:
value
-owner
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. (Individual organization or Device currently responsible for task execution.)
-
getLocation
- Returns:
location
(Principal physical location where the this task is performed.)
-
hasLocation
-
setLocation
- Parameters:
value
-location
(Principal physical location where the this task is performed.)
-
getLocationTarget
- Returns:
location
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. (Principal physical location where the this task is performed.)
-
setLocationTarget
- Parameters:
value
-location
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. (Principal physical location where the this task is performed.)
-
getReasonCode
- Returns:
reasonCode
(A description or code indicating why this task needs to be performed.)
-
hasReasonCode
-
setReasonCode
- Parameters:
value
-reasonCode
(A description or code indicating why this task needs to be performed.)
-
getReasonReference
- Returns:
reasonReference
(A resource reference indicating why this task needs to be performed.)
-
hasReasonReference
-
setReasonReference
- Parameters:
value
-reasonReference
(A resource reference indicating why this task needs to be performed.)
-
getReasonReferenceTarget
- Returns:
reasonReference
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. (A resource reference indicating why this task needs to be performed.)
-
setReasonReferenceTarget
- Parameters:
value
-reasonReference
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. (A resource reference indicating why this task needs to be performed.)
-
getInsurance
- Returns:
insurance
(Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.)
-
setInsurance
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInsurance
-
addInsurance
-
addInsurance
-
getInsuranceFirstRep
- Returns:
- The first repetition of repeating field
insurance
, creating it if it does not already exist
-
getInsuranceTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getNote
- Returns:
note
(Free-text information captured about the task as it progresses.)
-
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
-
getRelevantHistory
- Returns:
relevantHistory
(Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.)
-
setRelevantHistory
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRelevantHistory
-
addRelevantHistory
-
addRelevantHistory
-
getRelevantHistoryFirstRep
- Returns:
- The first repetition of repeating field
relevantHistory
, creating it if it does not already exist
-
getRelevantHistoryTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addRelevantHistoryTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getRestriction
- Returns:
restriction
(If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.)
-
hasRestriction
-
setRestriction
- Parameters:
value
-restriction
(If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.)
-
getInput
- Returns:
input
(Additional information that may be needed in the execution of the task.)
-
setInput
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInput
-
addInput
-
addInput
-
getInputFirstRep
- Returns:
- The first repetition of repeating field
input
, creating it if it does not already exist
-
getOutput
- Returns:
output
(Outputs produced by the Task.)
-
setOutput
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasOutput
-
addOutput
-
addOutput
-
getOutputFirstRep
- Returns:
- The first repetition of repeating field
output
, 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
-