This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

• Content
• Examples
• Detailed Descriptions
• Mappings
• Profiles & Extensions
• Operations

12.8.14 Resource Task - Operations

This resource has 11 operations associated with it:

$reserve	Reserve Task
$start	Start Task
$finish	Finish Task
$fail	Fail Task
$release	Release Task
$suspend	Suspend Task
$resume	Resume Task
$cancel	Cancel Task
$stop	Stop Task
$set-input	Set Task Input
$set-output	Set Task Output

For more information about operations, including how they are invoked, see Operations.

12.8.14.1 Reserve Task

Reserve this task for the specified entity. Makes the specified entity the task owner, and transitions the task to the Ready state. This operation may be used by an entity to claim a task for itself, or to delegate or forward the task to another entity.

Formal Definition (as a OperationDefinition).

URL: [base]/Task/[id]/$reserve

In Parameters:
Name	Cardinality	Type	Binding	Profile	Documentation
owner	1..1	Reference(Device|Organization|Patient|Practitioner|RelatedPerson)			The entity who is to be assigned ownership of this task.

 

12.8.14.2 Start Task

Start this task by the specified entity (or if none specified, by the present task owner). If an owner is specified, that owner is assigned as the task owner. The task is transitioned to the In Progress state.

Formal Definition (as a OperationDefinition).

URL: [base]/Task/[id]/$start

In Parameters:
Name	Cardinality	Type	Binding	Profile	Documentation
owner	0..1	Reference(Device|Organization|Patient|Practitioner|RelatedPerson)			The entity who is to be assigned ownership of this task. If no entity is provided, the ownership of the task remains unchanged.

 

12.8.14.3 Finish Task

Finish this task. The task is transitioned to the completed state.

Formal Definition (as a OperationDefinition).

URL: [base]/Task/[id]/$finish

 

12.8.14.4 Fail Task

Fail this task. The task is transitioned to the failed state.

Formal Definition (as a OperationDefinition).

URL: [base]/Task/[id]/$fail

In Parameters:
Name	Cardinality	Type	Binding	Profile	Documentation
reason	0..1	CodeableConcept			The reason for failure. If present, this is assigned to the failureReason property of the task.

 

12.8.14.5 Release Task

Release a previously reserved task. The task owner is cleared and the task is transitioned to the Ready state.

Formal Definition (as a OperationDefinition).

URL: [base]/Task/[id]/$release

 

12.8.14.6 Suspend Task

Place a hold on any activity for this task until it is subsequently resumed. The task remains in its current state but is marked as being suspended, indicating that no additional activity should b performed. If the task has subtasks, these are also suspended.

Formal Definition (as a OperationDefinition).

URL: [base]/Task/[id]/$suspend

 

12.8.14.7 Resume Task

Indicate that activity on this task can now be resumed. Removes the mark that the task is suspended, and propgates the resume to any child tasks.

Formal Definition (as a OperationDefinition).

URL: [base]/Task/[id]/$resume

 

12.8.14.8 Cancel Task

Cancel the task. Set the status of the task to cancelled.

Formal Definition (as a OperationDefinition).

URL: [base]/Task/[id]/$cancel

 

12.8.14.9 Stop Task

Stop processing the task. The task is returned to the ready state.

Formal Definition (as a OperationDefinition).

URL: [base]/Task/[id]/$stop

 

12.8.14.10 Set Task Input

Set one of the inputs for a task.

Formal Definition (as a OperationDefinition).

URL: [base]/Task/[id]/$set-input

In Parameters:
Name	Cardinality	Type	Binding	Profile	Documentation
input	1..*
input.name	1..1	string			The name of the input to add or update.
input.value[x]	0..1	*			If no value is provided, any current input with that name is removed from the resource.

 

12.8.14.11 Set Task Output

Set one of the outputs of a task.

Formal Definition (as a OperationDefinition).

URL: [base]/Task/[id]/$set-output

Out Parameters:
Name	Cardinality	Type	Binding	Profile	Documentation
output	1..*
output.name	1..1	string			The name of the output to add or update.
output.value[x]	0..1	*			If no value is provided, any current output with that name is removed from the resource.