
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
public class Task extends DomainResource
A task to be performed.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Task.ParameterComponent
static class
Task.TaskIntent
static class
Task.TaskIntentEnumFactory
static class
Task.TaskOutputComponent
static class
Task.TaskPriority
static class
Task.TaskPriorityEnumFactory
static class
Task.TaskRequesterComponent
static class
Task.TaskRestrictionComponent
static class
Task.TaskStatus
static class
Task.TaskStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.DateClientParam
AUTHORED_ON
Fluent Client search parameter constant for authored-onprotected DateTimeType
authoredOn
The date and time this task was created.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
BASED_ON
Fluent Client search parameter constant for based-onprotected List<Reference>
basedOn
BasedOn refers to a higher-level authorization that triggered the creation of the task.protected List<Resource>
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.static ca.uhn.fhir.rest.gclient.TokenClientParam
BUSINESS_STATUS
Fluent Client search parameter constant for business-statusprotected CodeableConcept
businessStatus
Contains business-specific nuances of the business state.protected CodeableConcept
code
A name or code (or both) briefly describing what the task involves.static ca.uhn.fhir.rest.gclient.TokenClientParam
CODE
Fluent Client search parameter constant for codeprotected Reference
context
The healthcare event (e.g.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
CONTEXT
Fluent Client search parameter constant for contextprotected Resource
contextTarget
The actual object that is the target of the reference (The healthcare event (e.g.protected Type
definition
A reference to a formal or informal definition of the task.protected StringType
description
A free-text description of what is to be performed.protected Period
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).protected Reference
focus
The request being actioned or the resource being manipulated by this task.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
FOCUS
Fluent Client search parameter constant for focusprotected Resource
focusTarget
The actual object that is the target of the reference (The request being actioned or the resource being manipulated by this task.)protected Reference
for_
The entity who benefits from the performance of the service specified in the task (e.g., the patient).protected Resource
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).)static ca.uhn.fhir.rest.gclient.TokenClientParam
GROUP_IDENTIFIER
Fluent Client search parameter constant for group-identifierprotected Identifier
groupIdentifier
An identifier that links together multiple tasks and other requests that were created in the same context.protected List<Identifier>
identifier
The business identifier for this task.static ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.Include
INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_CONTEXT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_FOCUS
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_ORGANIZATION
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_OWNER
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PART_OF
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_REQUESTER
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.protected List<Task.ParameterComponent>
input
Additional information that may be needed in the execution of the task.protected Enumeration<Task.TaskIntent>
intent
Indicates the "level" of actionability associated with the Task.static ca.uhn.fhir.rest.gclient.TokenClientParam
INTENT
Fluent Client search parameter constant for intentprotected DateTimeType
lastModified
The date and time of last modification to this task.static ca.uhn.fhir.rest.gclient.DateClientParam
MODIFIED
Fluent Client search parameter constant for modifiedprotected List<Annotation>
note
Free-text information captured about the task as it progresses.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
ORGANIZATION
Fluent Client search parameter constant for organizationprotected List<Task.TaskOutputComponent>
output
Outputs produced by the Task.protected Reference
owner
Individual organization or Device currently responsible for task execution.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
OWNER
Fluent Client search parameter constant for ownerprotected Resource
ownerTarget
The actual object that is the target of the reference (Individual organization or Device currently responsible for task execution.)static ca.uhn.fhir.rest.gclient.ReferenceClientParam
PART_OF
Fluent Client search parameter constant for part-ofprotected List<Reference>
partOf
Task that this particular task is part of.protected List<Task>
partOfTarget
The actual objects that are the target of the reference (Task that this particular task is part of.)static ca.uhn.fhir.rest.gclient.ReferenceClientParam
PATIENT
Fluent Client search parameter constant for patientstatic ca.uhn.fhir.rest.gclient.TokenClientParam
PERFORMER
Fluent Client search parameter constant for performerprotected List<CodeableConcept>
performerType
The type of participant that can execute the task.static ca.uhn.fhir.rest.gclient.DateClientParam
PERIOD
Fluent Client search parameter constant for periodprotected Enumeration<Task.TaskPriority>
priority
Indicates how quickly the Task should be addressed with respect to other requests.static ca.uhn.fhir.rest.gclient.TokenClientParam
PRIORITY
Fluent Client search parameter constant for priorityprotected CodeableConcept
reason
A description or code indicating why this task needs to be performed.protected List<Reference>
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.protected List<Provenance>
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.)protected Task.TaskRequesterComponent
requester
The creator of the task.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
REQUESTER
Fluent Client search parameter constant for requesterprotected Task.TaskRestrictionComponent
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.static String
SP_AUTHORED_ON
Search parameter: authored-onstatic String
SP_BASED_ON
Search parameter: based-onstatic String
SP_BUSINESS_STATUS
Search parameter: business-statusstatic String
SP_CODE
Search parameter: codestatic String
SP_CONTEXT
Search parameter: contextstatic String
SP_FOCUS
Search parameter: focusstatic String
SP_GROUP_IDENTIFIER
Search parameter: group-identifierstatic String
SP_IDENTIFIER
Search parameter: identifierstatic String
SP_INTENT
Search parameter: intentstatic String
SP_MODIFIED
Search parameter: modifiedstatic String
SP_ORGANIZATION
Search parameter: organizationstatic String
SP_OWNER
Search parameter: ownerstatic String
SP_PART_OF
Search parameter: part-ofstatic String
SP_PATIENT
Search parameter: patientstatic String
SP_PERFORMER
Search parameter: performerstatic String
SP_PERIOD
Search parameter: periodstatic String
SP_PRIORITY
Search parameter: prioritystatic String
SP_REQUESTER
Search parameter: requesterstatic String
SP_STATUS
Search parameter: statusstatic String
SP_SUBJECT
Search parameter: subjectprotected Enumeration<Task.TaskStatus>
status
The current status of the task.static ca.uhn.fhir.rest.gclient.TokenClientParam
STATUS
Fluent Client search parameter constant for statusprotected CodeableConcept
statusReason
An explanation as to why this task is held, failed, was refused, etc.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
SUBJECT
Fluent Client search parameter constant for subject-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Task()
ConstructorTask(Enumeration<Task.TaskStatus> status, Enumeration<Task.TaskIntent> intent)
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
The business identifier for this task.
-
definition
protected Type definition
A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.
-
basedOn
protected List<Reference> basedOn
BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ProcedureRequest, MedicationRequest, ProcedureRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfil. This latter resource is referenced by FocusOn. For example, based on a ProcedureRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient.
-
basedOnTarget
protected List<Resource> 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 ProcedureRequest, MedicationRequest, ProcedureRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfil. This latter resource is referenced by FocusOn. For example, based on a ProcedureRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient.)
-
groupIdentifier
protected Identifier groupIdentifier
An identifier that links together multiple tasks and other requests that were created in the same context.
-
partOfTarget
protected List<Task> partOfTarget
The actual objects that are the target of the reference (Task that this particular task is part of.)
-
status
protected Enumeration<Task.TaskStatus> status
The current status of the task.
-
statusReason
protected CodeableConcept statusReason
An explanation as to why this task is held, failed, was refused, etc.
-
businessStatus
protected CodeableConcept businessStatus
Contains business-specific nuances of the business state.
-
intent
protected Enumeration<Task.TaskIntent> intent
Indicates the "level" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc.
-
priority
protected Enumeration<Task.TaskPriority> priority
Indicates how quickly the Task should be addressed with respect to other requests.
-
code
protected CodeableConcept code
A name or code (or both) briefly describing what the task involves.
-
description
protected StringType description
A free-text description of what is to be performed.
-
focus
protected Reference focus
The request being actioned or the resource being manipulated by this task.
-
focusTarget
protected Resource focusTarget
The actual object that is the target of the reference (The request being actioned or the resource being manipulated by this task.)
-
for_
protected Reference for_
The entity who benefits from the performance of the service specified in the task (e.g., the patient).
-
for_Target
protected Resource 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).)
-
context
protected Reference context
The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
-
contextTarget
protected Resource contextTarget
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
protected Period 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
protected DateTimeType authoredOn
The date and time this task was created.
-
lastModified
protected DateTimeType lastModified
The date and time of last modification to this task.
-
requester
protected Task.TaskRequesterComponent requester
The creator of the task.
-
performerType
protected List<CodeableConcept> performerType
The type of participant that can execute the task.
-
owner
protected Reference owner
Individual organization or Device currently responsible for task execution.
-
ownerTarget
protected Resource ownerTarget
The actual object that is the target of the reference (Individual organization or Device currently responsible for task execution.)
-
reason
protected CodeableConcept reason
A description or code indicating why this task needs to be performed.
-
note
protected List<Annotation> note
Free-text information captured about the task as it progresses.
-
relevantHistory
protected List<Reference> 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
protected List<Provenance> 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
protected Task.TaskRestrictionComponent 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
protected List<Task.ParameterComponent> input
Additional information that may be needed in the execution of the task.
-
output
protected List<Task.TaskOutputComponent> output
Outputs produced by the Task.
-
SP_OWNER
public static final String SP_OWNER
Search parameter: ownerDescription: Search by task owner
Type: reference
Path: Task.owner
- See Also:
- Constant Field Values
-
OWNER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam OWNER
Fluent Client search parameter constant for ownerDescription: Search by task owner
Type: reference
Path: Task.owner
-
INCLUDE_OWNER
public static final ca.uhn.fhir.model.api.Include INCLUDE_OWNER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:owner".
-
SP_REQUESTER
public static final String SP_REQUESTER
Search parameter: requesterDescription: Search by task requester
Type: reference
Path: Task.requester.agent
- See Also:
- Constant Field Values
-
REQUESTER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REQUESTER
Fluent Client search parameter constant for requesterDescription: Search by task requester
Type: reference
Path: Task.requester.agent
-
INCLUDE_REQUESTER
public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUESTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:requester".
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Search for a task instance by its business identifier
Type: token
Path: Task.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
public static final String SP_BUSINESS_STATUS
Search parameter: business-statusDescription: Search by business status
Type: token
Path: Task.businessStatus
- See Also:
- Constant Field Values
-
BUSINESS_STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam BUSINESS_STATUS
Fluent Client search parameter constant for business-statusDescription: Search by business status
Type: token
Path: Task.businessStatus
-
SP_PERIOD
public static final String SP_PERIOD
Search parameter: periodDescription: Search by period Task is/was underway
Type: date
Path: Task.executionPeriod
- See Also:
- Constant Field Values
-
PERIOD
public static final ca.uhn.fhir.rest.gclient.DateClientParam PERIOD
Fluent Client search parameter constant for periodDescription: Search by period Task is/was underway
Type: date
Path: Task.executionPeriod
-
SP_CODE
public static final String SP_CODE
Search parameter: codeDescription: Search by task code
Type: token
Path: Task.code
- See Also:
- Constant Field Values
-
CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
Fluent Client search parameter constant for codeDescription: Search by task code
Type: token
Path: Task.code
-
SP_PERFORMER
public static final String SP_PERFORMER
Search parameter: performerDescription: Search by recommended type of performer (e.g., Requester, Performer, Scheduler).
Type: token
Path: Task.performerType
- See Also:
- Constant Field Values
-
PERFORMER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
public static final String SP_SUBJECT
Search parameter: subjectDescription: Search by subject
Type: reference
Path: Task.for
- See Also:
- Constant Field Values
-
SUBJECT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
Fluent Client search parameter constant for subjectDescription: Search by subject
Type: reference
Path: Task.for
-
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 "Task:subject".
-
SP_FOCUS
public static final String SP_FOCUS
Search parameter: focusDescription: Search by task focus
Type: reference
Path: Task.focus
- See Also:
- Constant Field Values
-
FOCUS
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam FOCUS
Fluent Client search parameter constant for focusDescription: Search by task focus
Type: reference
Path: Task.focus
-
INCLUDE_FOCUS
public static final ca.uhn.fhir.model.api.Include INCLUDE_FOCUS
Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:focus".
-
SP_PART_OF
public static final String SP_PART_OF
Search parameter: part-ofDescription: Search by task this task is part of
Type: reference
Path: Task.partOf
- See Also:
- Constant Field Values
-
PART_OF
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam 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
public static final ca.uhn.fhir.model.api.Include INCLUDE_PART_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:part-of".
-
SP_PRIORITY
public static final String SP_PRIORITY
Search parameter: priorityDescription: Search by task priority
Type: token
Path: Task.priority
- See Also:
- Constant Field Values
-
PRIORITY
public static final ca.uhn.fhir.rest.gclient.TokenClientParam PRIORITY
Fluent Client search parameter constant for priorityDescription: Search by task priority
Type: token
Path: Task.priority
-
SP_AUTHORED_ON
public static final String SP_AUTHORED_ON
Search parameter: authored-onDescription: Search by creation date
Type: date
Path: Task.authoredOn
- See Also:
- Constant Field Values
-
AUTHORED_ON
public static final ca.uhn.fhir.rest.gclient.DateClientParam AUTHORED_ON
Fluent Client search parameter constant for authored-onDescription: Search by creation date
Type: date
Path: Task.authoredOn
-
SP_INTENT
public static final String SP_INTENT
Search parameter: intentDescription: Search by task intent
Type: token
Path: Task.intent
- See Also:
- Constant Field Values
-
INTENT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam INTENT
Fluent Client search parameter constant for intentDescription: Search by task intent
Type: token
Path: Task.intent
-
SP_GROUP_IDENTIFIER
public static final String SP_GROUP_IDENTIFIER
Search parameter: group-identifierDescription: Search by group identifier
Type: token
Path: Task.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-identifierDescription: Search by group identifier
Type: token
Path: Task.groupIdentifier
-
SP_BASED_ON
public static final String SP_BASED_ON
Search parameter: based-onDescription: Search by requests this task is based on
Type: reference
Path: Task.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-onDescription: Search by requests this task is based on
Type: reference
Path: Task.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 "Task:based-on".
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: Search by patient
Type: reference
Path: Task.for
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: Search by patient
Type: reference
Path: Task.for
-
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 "Task:patient".
-
SP_ORGANIZATION
public static final String SP_ORGANIZATION
Search parameter: organizationDescription: Search by responsible organization
Type: reference
Path: Task.requester.onBehalfOf
- See Also:
- Constant Field Values
-
ORGANIZATION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ORGANIZATION
Fluent Client search parameter constant for organizationDescription: Search by responsible organization
Type: reference
Path: Task.requester.onBehalfOf
-
INCLUDE_ORGANIZATION
public static final ca.uhn.fhir.model.api.Include INCLUDE_ORGANIZATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:organization".
-
SP_CONTEXT
public static final String SP_CONTEXT
Search parameter: contextDescription: Search by encounter or episode
Type: reference
Path: Task.context
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONTEXT
Fluent Client search parameter constant for contextDescription: Search by encounter or episode
Type: reference
Path: Task.context
-
INCLUDE_CONTEXT
public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTEXT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:context".
-
SP_MODIFIED
public static final String SP_MODIFIED
Search parameter: modifiedDescription: Search by last modification date
Type: date
Path: Task.lastModified
- See Also:
- Constant Field Values
-
MODIFIED
public static final ca.uhn.fhir.rest.gclient.DateClientParam MODIFIED
Fluent Client search parameter constant for modifiedDescription: Search by last modification date
Type: date
Path: Task.lastModified
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: Search by task status
Type: token
Path: Task.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: Search by task status
Type: token
Path: Task.status
-
-
Constructor Detail
-
Task
public Task()
Constructor
-
Task
public Task(Enumeration<Task.TaskStatus> status, Enumeration<Task.TaskIntent> intent)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier
(The business identifier for this task.)
-
setIdentifier
public Task setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public Task addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getDefinition
public Type getDefinition()
- Returns:
definition
(A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.)
-
getDefinitionUriType
public UriType getDefinitionUriType() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
definition
(A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasDefinitionUriType
public boolean hasDefinitionUriType()
-
getDefinitionReference
public Reference getDefinitionReference() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
definition
(A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasDefinitionReference
public boolean hasDefinitionReference()
-
hasDefinition
public boolean hasDefinition()
-
setDefinition
public Task setDefinition(Type value) throws org.hl7.fhir.exceptions.FHIRFormatError
- Parameters:
value
-definition
(A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
getBasedOn
public List<Reference> 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 ProcedureRequest, MedicationRequest, ProcedureRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfil. This latter resource is referenced by FocusOn. For example, based on a ProcedureRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient.)
-
setBasedOn
public Task setBasedOn(List<Reference> theBasedOn)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasBasedOn
public boolean hasBasedOn()
-
addBasedOn
public Reference addBasedOn()
-
addBasedOn
public Task addBasedOn(Reference t)
-
getBasedOnFirstRep
public Reference getBasedOnFirstRep()
- Returns:
- The first repetition of repeating field
basedOn
, creating it if it does not already exist
-
getBasedOnTarget
@Deprecated public List<Resource> getBasedOnTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getGroupIdentifier
public Identifier getGroupIdentifier()
- Returns:
groupIdentifier
(An identifier that links together multiple tasks and other requests that were created in the same context.)
-
hasGroupIdentifier
public boolean hasGroupIdentifier()
-
setGroupIdentifier
public Task setGroupIdentifier(Identifier value)
- Parameters:
value
-groupIdentifier
(An identifier that links together multiple tasks and other requests that were created in the same context.)
-
getPartOf
public List<Reference> getPartOf()
- Returns:
partOf
(Task that this particular task is part of.)
-
setPartOf
public Task setPartOf(List<Reference> thePartOf)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPartOf
public boolean hasPartOf()
-
getPartOfFirstRep
public Reference getPartOfFirstRep()
- Returns:
- The first repetition of repeating field
partOf
, creating it if it does not already exist
-
getPartOfTarget
@Deprecated public List<Task> getPartOfTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addPartOfTarget
@Deprecated public Task addPartOfTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getStatusElement
public Enumeration<Task.TaskStatus> 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
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public Task setStatusElement(Enumeration<Task.TaskStatus> value)
- 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
public Task.TaskStatus getStatus()
- Returns:
- The current status of the task.
-
setStatus
public Task setStatus(Task.TaskStatus value)
- Parameters:
value
- The current status of the task.
-
getStatusReason
public CodeableConcept getStatusReason()
- Returns:
statusReason
(An explanation as to why this task is held, failed, was refused, etc.)
-
hasStatusReason
public boolean hasStatusReason()
-
setStatusReason
public Task setStatusReason(CodeableConcept value)
- Parameters:
value
-statusReason
(An explanation as to why this task is held, failed, was refused, etc.)
-
getBusinessStatus
public CodeableConcept getBusinessStatus()
- Returns:
businessStatus
(Contains business-specific nuances of the business state.)
-
hasBusinessStatus
public boolean hasBusinessStatus()
-
setBusinessStatus
public Task setBusinessStatus(CodeableConcept value)
- Parameters:
value
-businessStatus
(Contains business-specific nuances of the business state.)
-
getIntentElement
public Enumeration<Task.TaskIntent> getIntentElement()
- Returns:
intent
(Indicates the "level" of actionability associated with the Task. I.e. Is 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
public boolean hasIntentElement()
-
hasIntent
public boolean hasIntent()
-
setIntentElement
public Task setIntentElement(Enumeration<Task.TaskIntent> value)
- Parameters:
value
-intent
(Indicates the "level" of actionability associated with the Task. I.e. Is 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
public Task.TaskIntent getIntent()
- Returns:
- Indicates the "level" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc.
-
setIntent
public Task setIntent(Task.TaskIntent value)
- Parameters:
value
- Indicates the "level" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc.
-
getPriorityElement
public Enumeration<Task.TaskPriority> 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
public boolean hasPriorityElement()
-
hasPriority
public boolean hasPriority()
-
setPriorityElement
public Task setPriorityElement(Enumeration<Task.TaskPriority> value)
- 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
public Task.TaskPriority getPriority()
- Returns:
- Indicates how quickly the Task should be addressed with respect to other requests.
-
setPriority
public Task setPriority(Task.TaskPriority value)
- Parameters:
value
- Indicates how quickly the Task should be addressed with respect to other requests.
-
getCode
public CodeableConcept getCode()
- Returns:
code
(A name or code (or both) briefly describing what the task involves.)
-
hasCode
public boolean hasCode()
-
setCode
public Task setCode(CodeableConcept value)
- Parameters:
value
-code
(A name or code (or both) briefly describing what the task involves.)
-
getDescriptionElement
public StringType 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
public boolean hasDescriptionElement()
-
hasDescription
public boolean hasDescription()
-
setDescriptionElement
public Task setDescriptionElement(StringType value)
- 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
public String getDescription()
- Returns:
- A free-text description of what is to be performed.
-
setDescription
public Task setDescription(String value)
- Parameters:
value
- A free-text description of what is to be performed.
-
getFocus
public Reference getFocus()
- Returns:
focus
(The request being actioned or the resource being manipulated by this task.)
-
hasFocus
public boolean hasFocus()
-
setFocus
public Task setFocus(Reference value)
- Parameters:
value
-focus
(The request being actioned or the resource being manipulated by this task.)
-
getFocusTarget
public Resource 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
public Task setFocusTarget(Resource value)
- 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
public Reference getFor()
- Returns:
for_
(The entity who benefits from the performance of the service specified in the task (e.g., the patient).)
-
hasFor
public boolean hasFor()
-
setFor
public Task setFor(Reference value)
- Parameters:
value
-for_
(The entity who benefits from the performance of the service specified in the task (e.g., the patient).)
-
getForTarget
public Resource 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
public Task setForTarget(Resource value)
- 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).)
-
getContext
public Reference getContext()
- Returns:
context
(The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.)
-
hasContext
public boolean hasContext()
-
setContext
public Task setContext(Reference value)
- Parameters:
value
-context
(The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.)
-
getContextTarget
public Resource getContextTarget()
- Returns:
context
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.)
-
setContextTarget
public Task setContextTarget(Resource value)
- Parameters:
value
-context
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.)
-
getExecutionPeriod
public Period 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
public boolean hasExecutionPeriod()
-
setExecutionPeriod
public Task setExecutionPeriod(Period value)
- 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
public DateTimeType 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
public boolean hasAuthoredOnElement()
-
hasAuthoredOn
public boolean hasAuthoredOn()
-
setAuthoredOnElement
public Task setAuthoredOnElement(DateTimeType value)
- 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
public Date getAuthoredOn()
- Returns:
- The date and time this task was created.
-
setAuthoredOn
public Task setAuthoredOn(Date value)
- Parameters:
value
- The date and time this task was created.
-
getLastModifiedElement
public DateTimeType 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
public boolean hasLastModifiedElement()
-
hasLastModified
public boolean hasLastModified()
-
setLastModifiedElement
public Task setLastModifiedElement(DateTimeType value)
- 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
public Date getLastModified()
- Returns:
- The date and time of last modification to this task.
-
setLastModified
public Task setLastModified(Date value)
- Parameters:
value
- The date and time of last modification to this task.
-
getRequester
public Task.TaskRequesterComponent getRequester()
- Returns:
requester
(The creator of the task.)
-
hasRequester
public boolean hasRequester()
-
setRequester
public Task setRequester(Task.TaskRequesterComponent value)
- Parameters:
value
-requester
(The creator of the task.)
-
getPerformerType
public List<CodeableConcept> getPerformerType()
- Returns:
performerType
(The type of participant that can execute the task.)
-
setPerformerType
public Task setPerformerType(List<CodeableConcept> thePerformerType)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPerformerType
public boolean hasPerformerType()
-
addPerformerType
public CodeableConcept addPerformerType()
-
addPerformerType
public Task addPerformerType(CodeableConcept t)
-
getPerformerTypeFirstRep
public CodeableConcept getPerformerTypeFirstRep()
- Returns:
- The first repetition of repeating field
performerType
, creating it if it does not already exist
-
getOwner
public Reference getOwner()
- Returns:
owner
(Individual organization or Device currently responsible for task execution.)
-
hasOwner
public boolean hasOwner()
-
setOwner
public Task setOwner(Reference value)
- Parameters:
value
-owner
(Individual organization or Device currently responsible for task execution.)
-
getOwnerTarget
public Resource 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
public Task setOwnerTarget(Resource value)
- 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.)
-
getReason
public CodeableConcept getReason()
- Returns:
reason
(A description or code indicating why this task needs to be performed.)
-
hasReason
public boolean hasReason()
-
setReason
public Task setReason(CodeableConcept value)
- Parameters:
value
-reason
(A description or code indicating why this task needs to be performed.)
-
getNote
public List<Annotation> getNote()
- Returns:
note
(Free-text information captured about the task as it progresses.)
-
setNote
public Task setNote(List<Annotation> theNote)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
public boolean hasNote()
-
addNote
public Annotation addNote()
-
addNote
public Task addNote(Annotation t)
-
getNoteFirstRep
public Annotation getNoteFirstRep()
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist
-
getRelevantHistory
public List<Reference> 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
public Task setRelevantHistory(List<Reference> theRelevantHistory)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRelevantHistory
public boolean hasRelevantHistory()
-
addRelevantHistory
public Reference addRelevantHistory()
-
addRelevantHistory
public Task addRelevantHistory(Reference t)
-
getRelevantHistoryFirstRep
public Reference getRelevantHistoryFirstRep()
- Returns:
- The first repetition of repeating field
relevantHistory
, creating it if it does not already exist
-
getRelevantHistoryTarget
@Deprecated public List<Provenance> getRelevantHistoryTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addRelevantHistoryTarget
@Deprecated public Provenance addRelevantHistoryTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getRestriction
public Task.TaskRestrictionComponent 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
public boolean hasRestriction()
-
setRestriction
public Task setRestriction(Task.TaskRestrictionComponent value)
- 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
public List<Task.ParameterComponent> getInput()
- Returns:
input
(Additional information that may be needed in the execution of the task.)
-
setInput
public Task setInput(List<Task.ParameterComponent> theInput)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInput
public boolean hasInput()
-
addInput
public Task.ParameterComponent addInput()
-
addInput
public Task addInput(Task.ParameterComponent t)
-
getInputFirstRep
public Task.ParameterComponent getInputFirstRep()
- Returns:
- The first repetition of repeating field
input
, creating it if it does not already exist
-
getOutput
public List<Task.TaskOutputComponent> getOutput()
- Returns:
output
(Outputs produced by the Task.)
-
setOutput
public Task setOutput(List<Task.TaskOutputComponent> theOutput)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasOutput
public boolean hasOutput()
-
addOutput
public Task.TaskOutputComponent addOutput()
-
addOutput
public Task addOutput(Task.TaskOutputComponent t)
-
getOutputFirstRep
public Task.TaskOutputComponent getOutputFirstRep()
- Returns:
- The first repetition of repeating field
output
, creating it if it does not already exist
-
listChildren
protected void listChildren(List<Property> children)
- 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
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- 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
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
public Task copy()
- Specified by:
copy
in classDomainResource
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceType
in classResource
-
-