Package org.hl7.fhir.r5.model

Class Task

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.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.TaskInputComponent
static enum	Task.TaskIntent
static class	Task.TaskIntentEnumFactory
static class	Task.TaskOutputComponent
static class	Task.TaskPerformerComponent
static class	Task.TaskRestrictionComponent
static enum	Task.TaskStatus
static class	Task.TaskStatusEnumFactory

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ACTOR	Fluent Client search parameter constant for actor
static final ca.uhn.fhir.rest.gclient.DateClientParam	AUTHORED_ON	Fluent Client search parameter constant for authored-on
protected DateTimeType	authoredOn	The date and time this task was created.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	BASED_ON	Fluent Client search parameter constant for based-on
protected List<Reference>	basedOn	BasedOn refers to a higher-level authorization that triggered the creation of the task.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	BUSINESS_STATUS	Fluent Client search parameter constant for business-status
protected 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 final ca.uhn.fhir.rest.gclient.TokenClientParam	CODE	Fluent Client search parameter constant for code
protected StringType	description	A free-text description of what is to be performed.
protected BooleanType	doNotPerform	If true indicates that the Task is asking for the specified action to *not* occur.
protected Reference	encounter	The healthcare event (e.g.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENCOUNTER	Fluent Client search parameter constant for encounter
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 fulfilled or the resource being manipulated (changed, suspended, etc.) by this task.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	FOCUS	Fluent Client search parameter constant for focus
protected Reference	for_	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	GROUP_IDENTIFIER	Fluent Client search parameter constant for group-identifier
protected Identifier	groupIdentifier	A shared identifier common to multiple independent Task and Request instances that were activated/authorized more or less simultaneously by a single author.
protected List<Identifier>	identifier	The business identifier for this task.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_ACTOR	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_BASED_ON	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ENCOUNTER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_FOCUS	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_OUTPUT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_OWNER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PART_OF	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_REQUESTEDPERFORMER_REFERENCE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_REQUESTER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUBJECT	Constant for fluent queries to be used to add include statements.
protected List<Task.TaskInputComponent>	input	Additional information that may be needed in the execution of the task.
protected CanonicalType	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.
protected UriType	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.
protected List<Reference>	insurance	Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
protected Enumeration<Task.TaskIntent>	intent	Indicates the "level" of actionability associated with the Task, i.e.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	INTENT	Fluent Client search parameter constant for intent
protected DateTimeType	lastModified	The date and time of last modification to this task.
protected Reference	location	Principal physical location where this task is performed.
static final ca.uhn.fhir.rest.gclient.DateClientParam	MODIFIED	Fluent Client search parameter constant for modified
protected List<Annotation>	note	Free-text information captured about the task as it progresses.
protected List<Task.TaskOutputComponent>	output	Outputs produced by the Task.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	OUTPUT	Fluent Client search parameter constant for output
protected Reference	owner	Party responsible for managing task execution.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	OWNER	Fluent Client search parameter constant for owner
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PART_OF	Fluent Client search parameter constant for part-of
protected List<Reference>	partOf	Task that this particular task is part of.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected List<Task.TaskPerformerComponent>	performer	The entity who performed the requested task.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	PERFORMER	Fluent Client search parameter constant for performer
static final ca.uhn.fhir.rest.gclient.DateClientParam	PERIOD	Fluent Client search parameter constant for period
protected Enumeration<Enumerations.RequestPriority>	priority	Indicates how quickly the Task should be addressed with respect to other requests.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	PRIORITY	Fluent Client search parameter constant for priority
protected List<CodeableReference>	reason	A description, code, or reference 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<CodeableReference>	requestedPerformer	The kind of participant or specific participant that should perform the task.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	REQUESTEDPERFORMER_REFERENCE	Fluent Client search parameter constant for requestedperformer-reference
protected Period	requestedPeriod	Indicates the start and/or end of the period of time when completion of the task is desired to take place.
protected Reference	requester	The creator of the task.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	REQUESTER	Fluent Client search parameter constant for requester
protected Task.TaskRestrictionComponent	restriction	If the Task.focus is a request resource and the task is seeking fulfillment (i.e.
static final String	SP_ACTOR	Search parameter: actor
static final String	SP_AUTHORED_ON	Search parameter: authored-on
static final String	SP_BASED_ON	Search parameter: based-on
static final String	SP_BUSINESS_STATUS	Search parameter: business-status
static final String	SP_CODE	Search parameter: code
static final String	SP_ENCOUNTER	Search parameter: encounter
static final String	SP_FOCUS	Search parameter: focus
static final String	SP_GROUP_IDENTIFIER	Search parameter: group-identifier
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_INTENT	Search parameter: intent
static final String	SP_MODIFIED	Search parameter: modified
static final String	SP_OUTPUT	Search parameter: output
static final String	SP_OWNER	Search parameter: owner
static final String	SP_PART_OF	Search parameter: part-of
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_PERFORMER	Search parameter: performer
static final String	SP_PERIOD	Search parameter: period
static final String	SP_PRIORITY	Search parameter: priority
static final String	SP_REQUESTEDPERFORMER_REFERENCE	Search parameter: requestedperformer-reference
static final String	SP_REQUESTER	Search parameter: requester
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUBJECT	Search parameter: subject
protected Enumeration<Task.TaskStatus>	status	The current status of the task.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected CodeableReference	statusReason	An explanation as to why this task is held, failed, was refused, etc.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject

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

contained, extension, modifierExtension, SP_TEXT, text, TEXT

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

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, SP_RES_ID

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Task()	Constructor
Task(Task.TaskStatus status, Task.TaskIntent intent)	Constructor

Method Summary

Modifier and Type	Method	Description
Reference	addBasedOn()
Task	addBasedOn(Reference t)
Base	addChild(String name)
Identifier	addIdentifier()
Task	addIdentifier(Identifier t)
Task.TaskInputComponent	addInput()
Task	addInput(Task.TaskInputComponent t)
Reference	addInsurance()
Task	addInsurance(Reference t)
Annotation	addNote()
Task	addNote(Annotation t)
Task.TaskOutputComponent	addOutput()
Task	addOutput(Task.TaskOutputComponent t)
Reference	addPartOf()
Task	addPartOf(Reference t)
Task.TaskPerformerComponent	addPerformer()
Task	addPerformer(Task.TaskPerformerComponent t)
CodeableReference	addReason()
Task	addReason(CodeableReference t)
Reference	addRelevantHistory()
Task	addRelevantHistory(Reference t)
CodeableReference	addRequestedPerformer()
Task	addRequestedPerformer(CodeableReference t)
Task	copy()
void	copyValues(Task dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Date	getAuthoredOn()
DateTimeType	getAuthoredOnElement()
List<Reference>	getBasedOn()
Reference	getBasedOnFirstRep()
CodeableConcept	getBusinessStatus()
CodeableConcept	getCode()
String	getDescription()
StringType	getDescriptionElement()
boolean	getDoNotPerform()
BooleanType	getDoNotPerformElement()
Reference	getEncounter()
Period	getExecutionPeriod()
Reference	getFocus()
Reference	getFor()
Identifier	getGroupIdentifier()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<Task.TaskInputComponent>	getInput()
Task.TaskInputComponent	getInputFirstRep()
String	getInstantiatesCanonical()
CanonicalType	getInstantiatesCanonicalElement()
String	getInstantiatesUri()
UriType	getInstantiatesUriElement()
List<Reference>	getInsurance()
Reference	getInsuranceFirstRep()
Task.TaskIntent	getIntent()
Enumeration<Task.TaskIntent>	getIntentElement()
Date	getLastModified()
DateTimeType	getLastModifiedElement()
Reference	getLocation()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
List<Task.TaskOutputComponent>	getOutput()
Task.TaskOutputComponent	getOutputFirstRep()
Reference	getOwner()
List<Reference>	getPartOf()
Reference	getPartOfFirstRep()
List<Task.TaskPerformerComponent>	getPerformer()
Task.TaskPerformerComponent	getPerformerFirstRep()
Enumerations.RequestPriority	getPriority()
Enumeration<Enumerations.RequestPriority>	getPriorityElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<CodeableReference>	getReason()
CodeableReference	getReasonFirstRep()
List<Reference>	getRelevantHistory()
Reference	getRelevantHistoryFirstRep()
List<CodeableReference>	getRequestedPerformer()
CodeableReference	getRequestedPerformerFirstRep()
Period	getRequestedPeriod()
Reference	getRequester()
ResourceType	getResourceType()
Task.TaskRestrictionComponent	getRestriction()
Task.TaskStatus	getStatus()
Enumeration<Task.TaskStatus>	getStatusElement()
CodeableReference	getStatusReason()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAuthoredOn()
boolean	hasAuthoredOnElement()
boolean	hasBasedOn()
boolean	hasBusinessStatus()
boolean	hasCode()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasDoNotPerform()
boolean	hasDoNotPerformElement()
boolean	hasEncounter()
boolean	hasExecutionPeriod()
boolean	hasFocus()
boolean	hasFor()
boolean	hasGroupIdentifier()
boolean	hasIdentifier()
boolean	hasInput()
boolean	hasInstantiatesCanonical()
boolean	hasInstantiatesCanonicalElement()
boolean	hasInstantiatesUri()
boolean	hasInstantiatesUriElement()
boolean	hasInsurance()
boolean	hasIntent()
boolean	hasIntentElement()
boolean	hasLastModified()
boolean	hasLastModifiedElement()
boolean	hasLocation()
boolean	hasNote()
boolean	hasOutput()
boolean	hasOwner()
boolean	hasPartOf()
boolean	hasPerformer()
boolean	hasPriority()
boolean	hasPriorityElement()
boolean	hasReason()
boolean	hasRelevantHistory()
boolean	hasRequestedPerformer()
boolean	hasRequestedPeriod()
boolean	hasRequester()
boolean	hasRestriction()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasStatusReason()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
Task	setAuthoredOn(Date value)
Task	setAuthoredOnElement(DateTimeType value)
Task	setBasedOn(List<Reference> theBasedOn)
Task	setBusinessStatus(CodeableConcept value)
Task	setCode(CodeableConcept value)
Task	setDescription(String value)
Task	setDescriptionElement(StringType value)
Task	setDoNotPerform(boolean value)
Task	setDoNotPerformElement(BooleanType value)
Task	setEncounter(Reference value)
Task	setExecutionPeriod(Period value)
Task	setFocus(Reference value)
Task	setFor(Reference value)
Task	setGroupIdentifier(Identifier value)
Task	setIdentifier(List<Identifier> theIdentifier)
Task	setInput(List<Task.TaskInputComponent> theInput)
Task	setInstantiatesCanonical(String value)
Task	setInstantiatesCanonicalElement(CanonicalType value)
Task	setInstantiatesUri(String value)
Task	setInstantiatesUriElement(UriType value)
Task	setInsurance(List<Reference> theInsurance)
Task	setIntent(Task.TaskIntent value)
Task	setIntentElement(Enumeration<Task.TaskIntent> value)
Task	setLastModified(Date value)
Task	setLastModifiedElement(DateTimeType value)
Task	setLocation(Reference value)
Task	setNote(List<Annotation> theNote)
Task	setOutput(List<Task.TaskOutputComponent> theOutput)
Task	setOwner(Reference value)
Task	setPartOf(List<Reference> thePartOf)
Task	setPerformer(List<Task.TaskPerformerComponent> thePerformer)
Task	setPriority(Enumerations.RequestPriority value)
Task	setPriorityElement(Enumeration<Enumerations.RequestPriority> value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Task	setReason(List<CodeableReference> theReason)
Task	setRelevantHistory(List<Reference> theRelevantHistory)
Task	setRequestedPerformer(List<CodeableReference> theRequestedPerformer)
Task	setRequestedPeriod(Period value)
Task	setRequester(Reference value)
Task	setRestriction(Task.TaskRestrictionComponent value)
Task	setStatus(Task.TaskStatus value)
Task	setStatusElement(Enumeration<Task.TaskStatus> value)
Task	setStatusReason(CodeableReference value)
protected Task	typedCopy()

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

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

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

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

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

getStructureFhirVersionEnum, isResource, setId

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

The business identifier for this task.

instantiatesCanonical

protected CanonicalType 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

protected UriType 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

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 ServiceRequest, MedicationRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by focus. For example, based on a CarePlan (= basedOn), a task is created to fulfill a ServiceRequest ( = focus ) to collect a specimen from a patient.

groupIdentifier

protected Identifier groupIdentifier

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

partOf

protected List<Reference> partOf

Task that this particular task is part of.

status

protected Enumeration<Task.TaskStatus> status

The current status of the task.

statusReason

protected CodeableReference 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. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.

priority

protected Enumeration<Enumerations.RequestPriority> priority

Indicates how quickly the Task should be addressed with respect to other requests.

doNotPerform

protected BooleanType doNotPerform

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

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 fulfilled or the resource being manipulated (changed, suspended, etc.) 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).

encounter

protected Reference encounter

The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.

requestedPeriod

protected Period requestedPeriod

Indicates the start and/or end of the period of time when completion of the task is desired to take place.

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 Reference requester

The creator of the task.

requestedPerformer

protected List<CodeableReference> requestedPerformer

The kind of participant or specific participant that should perform the task.

owner

protected Reference owner

Party responsible for managing task execution.

performer

protected List<Task.TaskPerformerComponent> performer

The entity who performed the requested task.

location

protected Reference location

Principal physical location where this task is performed.

reason

protected List<CodeableReference> reason

A description, code, or reference indicating why this task needs to be performed.

insurance

protected List<Reference> insurance

Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.

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.

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.TaskInputComponent> 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_ACTOR

public static final String SP_ACTOR

Search parameter: actor

Description: Search by specific performer.
Type: reference
Path: Task.performer.actor

See Also:

• Constant Field Values

ACTOR

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

Fluent Client search parameter constant for actor

Description: Search by specific performer.
Type: reference
Path: Task.performer.actor

INCLUDE_ACTOR

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

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

SP_AUTHORED_ON

public static final String SP_AUTHORED_ON

Search parameter: authored-on

Description: 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-on

Description: Search by creation date
Type: date
Path: Task.authoredOn

SP_BASED_ON

public static final String SP_BASED_ON

Search parameter: based-on

Description: 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-on

Description: 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_BUSINESS_STATUS

public static final String SP_BUSINESS_STATUS

Search parameter: business-status

Description: 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-status

Description: Search by business status
Type: token
Path: Task.businessStatus

SP_FOCUS

public static final String SP_FOCUS

Search parameter: focus

Description: 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 focus

Description: 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_GROUP_IDENTIFIER

public static final String SP_GROUP_IDENTIFIER

Search parameter: group-identifier

Description: 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-identifier

Description: Search by group identifier
Type: token
Path: Task.groupIdentifier

SP_INTENT

public static final String SP_INTENT

Search parameter: intent

Description: 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 intent

Description: Search by task intent
Type: token
Path: Task.intent

SP_MODIFIED

public static final String SP_MODIFIED

Search parameter: modified

Description: 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 modified

Description: Search by last modification date
Type: date
Path: Task.lastModified

SP_OUTPUT

public static final String SP_OUTPUT

Search parameter: output

Description: Search by task output
Type: reference
Path: Task.output.value.ofType(Reference)

See Also:

• Constant Field Values

OUTPUT

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

Fluent Client search parameter constant for output

Description: Search by task output
Type: reference
Path: Task.output.value.ofType(Reference)

INCLUDE_OUTPUT

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

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

SP_OWNER

public static final String SP_OWNER

Search parameter: owner

Description: 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 owner

Description: 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_PART_OF

public static final String SP_PART_OF

Search parameter: part-of

Description: 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-of

Description: 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_PERFORMER

public static final String SP_PERFORMER

Search parameter: performer

Description: Search by recommended type of performer (e.g., Requester, Performer, Scheduler).
Type: token
Path: Task.requestedPerformer.concept

See Also:

• Constant Field Values

PERFORMER

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

Fluent Client search parameter constant for performer

Description: Search by recommended type of performer (e.g., Requester, Performer, Scheduler).
Type: token
Path: Task.requestedPerformer.concept

SP_PERIOD

public static final String SP_PERIOD

Search parameter: period

Description: 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 period

Description: Search by period Task is/was underway
Type: date
Path: Task.executionPeriod

SP_PRIORITY

public static final String SP_PRIORITY

Search parameter: priority

Description: 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 priority

Description: Search by task priority
Type: token
Path: Task.priority

SP_REQUESTEDPERFORMER_REFERENCE

public static final String SP_REQUESTEDPERFORMER_REFERENCE

Search parameter: requestedperformer-reference

Description: Search by specific requested performer.
Type: reference
Path: Task.requestedPerformer.reference

See Also:

• Constant Field Values

REQUESTEDPERFORMER_REFERENCE

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

Fluent Client search parameter constant for requestedperformer-reference

Description: Search by specific requested performer.
Type: reference
Path: Task.requestedPerformer.reference

INCLUDE_REQUESTEDPERFORMER_REFERENCE

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

Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:requestedperformer-reference".

SP_REQUESTER

public static final String SP_REQUESTER

Search parameter: requester

Description: Search by task requester
Type: reference
Path: Task.requester

See Also:

• Constant Field Values

REQUESTER

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

Fluent Client search parameter constant for requester

Description: Search by task requester
Type: reference
Path: Task.requester

INCLUDE_REQUESTER

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

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

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: 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 status

Description: Search by task status
Type: token
Path: Task.status

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

Description: 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 subject

Description: 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_CODE

public static final String SP_CODE

Search parameter: code

Description: Multiple Resources: [AdverseEvent](adverseevent.html): Event or incident that occurred or was averted [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [AuditEvent](auditevent.html): More specific code for the event [Basic](basic.html): Kind of Resource [ChargeItem](chargeitem.html): A code that identifies the charge, like a billing code [Condition](condition.html): Code for the condition [DetectedIssue](detectedissue.html): Issue Type, e.g. drug-drug, duplicate therapy, etc. [DeviceRequest](devicerequest.html): Code for what is being requested/ordered [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result [FamilyMemberHistory](familymemberhistory.html): A search by a condition code [ImagingSelection](imagingselection.html): The imaging selection status [List](list.html): What the purpose of this list is [Medication](medication.html): Returns medications for a specific code [MedicationAdministration](medicationadministration.html): Return administrations of this medication code [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code [MedicationStatement](medicationstatement.html): Return statements of this medication code [NutritionIntake](nutritionintake.html): Returns statements of this code of NutritionIntake [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure [RequestOrchestration](requestorchestration.html): The code of the request orchestration [Task](task.html): Search by task code
Type: token
Path: AdverseEvent.code | AllergyIntolerance.code | AllergyIntolerance.reaction.substance | AuditEvent.code | Basic.code | ChargeItem.code | Condition.code | DetectedIssue.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | ImagingSelection.status | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationStatement.medication.concept | NutritionIntake.code | Observation.code | Procedure.code | RequestOrchestration.code | Task.code

See Also:

• Constant Field Values

CODE

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

Fluent Client search parameter constant for code

Description: Multiple Resources: [AdverseEvent](adverseevent.html): Event or incident that occurred or was averted [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [AuditEvent](auditevent.html): More specific code for the event [Basic](basic.html): Kind of Resource [ChargeItem](chargeitem.html): A code that identifies the charge, like a billing code [Condition](condition.html): Code for the condition [DetectedIssue](detectedissue.html): Issue Type, e.g. drug-drug, duplicate therapy, etc. [DeviceRequest](devicerequest.html): Code for what is being requested/ordered [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result [FamilyMemberHistory](familymemberhistory.html): A search by a condition code [ImagingSelection](imagingselection.html): The imaging selection status [List](list.html): What the purpose of this list is [Medication](medication.html): Returns medications for a specific code [MedicationAdministration](medicationadministration.html): Return administrations of this medication code [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code [MedicationStatement](medicationstatement.html): Return statements of this medication code [NutritionIntake](nutritionintake.html): Returns statements of this code of NutritionIntake [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure [RequestOrchestration](requestorchestration.html): The code of the request orchestration [Task](task.html): Search by task code
Type: token
Path: AdverseEvent.code | AllergyIntolerance.code | AllergyIntolerance.reaction.substance | AuditEvent.code | Basic.code | ChargeItem.code | Condition.code | DetectedIssue.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | ImagingSelection.status | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationStatement.medication.concept | NutritionIntake.code | Observation.code | Procedure.code | RequestOrchestration.code | Task.code

SP_ENCOUNTER

public static final String SP_ENCOUNTER

Search parameter: encounter

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

See Also:

• Constant Field Values

ENCOUNTER

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

Fluent Client search parameter constant for encounter

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

INCLUDE_ENCOUNTER

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

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

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

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

See Also:

• Constant Field Values

IDENTIFIER

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

Fluent Client search parameter constant for identifier

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

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

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

See Also:

• Constant Field Values

PATIENT

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

Fluent Client search parameter constant for patient

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

INCLUDE_PATIENT

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

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

Constructor Details

Task

public Task()

Constructor

Task

public Task(Task.TaskStatus status,
 Task.TaskIntent intent)

Constructor

Method Details

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

getInstantiatesCanonicalElement

public CanonicalType 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

public boolean hasInstantiatesCanonicalElement()

hasInstantiatesCanonical

public boolean hasInstantiatesCanonical()

setInstantiatesCanonicalElement

public Task setInstantiatesCanonicalElement(CanonicalType value)

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

public String 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

public Task setInstantiatesCanonical(String value)

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

public UriType 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

public boolean hasInstantiatesUriElement()

hasInstantiatesUri

public boolean hasInstantiatesUri()

setInstantiatesUriElement

public Task setInstantiatesUriElement(UriType value)

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

public String 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

public Task setInstantiatesUri(String value)

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

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 ServiceRequest, MedicationRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by focus. For example, based on a CarePlan (= basedOn), a task is created to fulfill a ServiceRequest ( = focus ) 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 {3}

getGroupIdentifier

public Identifier getGroupIdentifier()

Returns:

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

hasGroupIdentifier

public boolean hasGroupIdentifier()

setGroupIdentifier

public Task setGroupIdentifier(Identifier value)

Parameters:

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

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

addPartOf

public Reference addPartOf()

addPartOf

public Task addPartOf(Reference t)

getPartOfFirstRep

public Reference getPartOfFirstRep()

Returns:

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

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 CodeableReference getStatusReason()

Returns:

statusReason (An explanation as to why this task is held, failed, was refused, etc.)

hasStatusReason

public boolean hasStatusReason()

setStatusReason

public Task setStatusReason(CodeableReference 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. 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

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

public Task.TaskIntent 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

public Task setIntent(Task.TaskIntent value)

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

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

Returns:

Indicates how quickly the Task should be addressed with respect to other requests.

setPriority

public Task setPriority(Enumerations.RequestPriority value)

Parameters:

value - Indicates how quickly the Task should be addressed with respect to other requests.

getDoNotPerformElement

public BooleanType getDoNotPerformElement()

Returns:

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

hasDoNotPerformElement

public boolean hasDoNotPerformElement()

hasDoNotPerform

public boolean hasDoNotPerform()

setDoNotPerformElement

public Task setDoNotPerformElement(BooleanType value)

Parameters:

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

getDoNotPerform

public boolean getDoNotPerform()

Returns:

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

setDoNotPerform

public Task setDoNotPerform(boolean value)

Parameters:

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

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 fulfilled or the resource being manipulated (changed, suspended, etc.) by this task.)

hasFocus

public boolean hasFocus()

setFocus

public Task setFocus(Reference value)

Parameters:

value - focus (The request being fulfilled or the resource being manipulated (changed, suspended, etc.) 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).)

getEncounter

public Reference getEncounter()

Returns:

encounter (The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.)

hasEncounter

public boolean hasEncounter()

setEncounter

public Task setEncounter(Reference value)

Parameters:

value - encounter (The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.)

getRequestedPeriod

public Period getRequestedPeriod()

Returns:

requestedPeriod (Indicates the start and/or end of the period of time when completion of the task is desired to take place.)

hasRequestedPeriod

public boolean hasRequestedPeriod()

setRequestedPeriod

public Task setRequestedPeriod(Period value)

Parameters:

value - requestedPeriod (Indicates the start and/or end of the period of time when completion of the task is desired to take place.)

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 Reference getRequester()

Returns:

requester (The creator of the task.)

hasRequester

public boolean hasRequester()

setRequester

public Task setRequester(Reference value)

Parameters:

value - requester (The creator of the task.)

getRequestedPerformer

public List<CodeableReference> getRequestedPerformer()

Returns:

requestedPerformer (The kind of participant or specific participant that should perform the task.)

setRequestedPerformer

public Task setRequestedPerformer(List<CodeableReference> theRequestedPerformer)

Returns:

Returns a reference to this for easy method chaining

hasRequestedPerformer

public boolean hasRequestedPerformer()

addRequestedPerformer

public CodeableReference addRequestedPerformer()

addRequestedPerformer

public Task addRequestedPerformer(CodeableReference t)

getRequestedPerformerFirstRep

public CodeableReference getRequestedPerformerFirstRep()

Returns:

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

getOwner

public Reference getOwner()

Returns:

owner (Party responsible for managing task execution.)

hasOwner

public boolean hasOwner()

setOwner

public Task setOwner(Reference value)

Parameters:

value - owner (Party responsible for managing task execution.)

getPerformer

public List<Task.TaskPerformerComponent> getPerformer()

Returns:

performer (The entity who performed the requested task.)

setPerformer

public Task setPerformer(List<Task.TaskPerformerComponent> thePerformer)

Returns:

Returns a reference to this for easy method chaining

hasPerformer

public boolean hasPerformer()

addPerformer

public Task.TaskPerformerComponent addPerformer()

addPerformer

public Task addPerformer(Task.TaskPerformerComponent t)

getPerformerFirstRep

public Task.TaskPerformerComponent getPerformerFirstRep()

Returns:

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

getLocation

public Reference getLocation()

Returns:

location (Principal physical location where this task is performed.)

hasLocation

public boolean hasLocation()

setLocation

public Task setLocation(Reference value)

Parameters:

value - location (Principal physical location where this task is performed.)

getReason

public List<CodeableReference> getReason()

Returns:

reason (A description, code, or reference indicating why this task needs to be performed.)

setReason

public Task setReason(List<CodeableReference> theReason)

Returns:

Returns a reference to this for easy method chaining

hasReason

public boolean hasReason()

addReason

public CodeableReference addReason()

addReason

public Task addReason(CodeableReference t)

getReasonFirstRep

public CodeableReference getReasonFirstRep()

Returns:

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

getInsurance

public List<Reference> getInsurance()

Returns:

insurance (Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.)

setInsurance

public Task setInsurance(List<Reference> theInsurance)

Returns:

Returns a reference to this for easy method chaining

hasInsurance

public boolean hasInsurance()

addInsurance

public Reference addInsurance()

addInsurance

public Task addInsurance(Reference t)

getInsuranceFirstRep

public Reference getInsuranceFirstRep()

Returns:

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

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

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

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.TaskInputComponent> getInput()

Returns:

input (Additional information that may be needed in the execution of the task.)

setInput

public Task setInput(List<Task.TaskInputComponent> theInput)

Returns:

Returns a reference to this for easy method chaining

hasInput

public boolean hasInput()

addInput

public Task.TaskInputComponent addInput()

addInput

public Task addInput(Task.TaskInputComponent t)

getInputFirstRep

public Task.TaskInputComponent getInputFirstRep()

Returns:

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

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

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

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

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public Task copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(Task dst)

typedCopy

protected Task typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource