STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

5.33.8 Resource Task - Detailed Descriptions

Detailed Descriptions for the elements in the Task resource.

Task
Definition

A task to be performed.

Control1..1
InvariantsDefined on this element
inv-1: Last modified date must be greater than or equal to created date. (expression: lastModified >= created, xpath: f:lastModified >= f:created)
inv-2: A Failure reason may be present only when a task has failed. (expression: failureReason.empty() or status = 'failed', xpath: not(exists(f:failureReason)) or f:status/@value = 'failed')
Task.identifier
Definition

The business identifier for this task.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Task.type
Definition

A name or code (or both) briefly describing what the task involves.

Control0..1
TypeCodeableConcept
Summarytrue
Task.description
Definition

A description of this task.

Control0..1
Typestring
Summarytrue
Task.performerType
Definition

The type of participant that can execute the task.

Control0..*
BindingTaskPerformerType: The type(s) of task performers allowed (Preferred)
TypeCoding
Requirements

Use to distinguish tasks on different activity queues.

Task.priority
Definition

The priority of the task among other tasks of the same type.

Control0..1
BindingTaskPriority: The task's priority (Required)
Typecode
Meaning if MissingIf missing, this task should be performed with normal priority
Requirements

Used to identify the service level expected while performing a task.

Task.status
Definition

The current status of the task.

Control1..1
BindingTaskStatus: The current status of the task. (Required)
Typecode
Requirements

These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.

Summarytrue
InvariantsAffect this element
inv-2: A Failure reason may be present only when a task has failed. (expression: failureReason.empty() or status = 'failed', xpath: not(exists(f:failureReason)) or f:status/@value = 'failed')
Task.failureReason
Definition

An explaination as to why this task failed.

Control0..1
TypeCodeableConcept
Summarytrue
InvariantsAffect this element
inv-2: A Failure reason may be present only when a task has failed. (expression: failureReason.empty() or status = 'failed', xpath: not(exists(f:failureReason)) or f:status/@value = 'failed')
Task.subject
Definition

The subject of the task.

Control0..1
TypeReference(Any)
Requirements

Used to identify the thing to be done (not the beneficiary -- see for below).

Task.for
Definition

The entity who benefits from the performance of the service specified in the task (e.g., the patient).

Control0..1
TypeReference(Any)
Requirements

Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively).

Summarytrue
Task.definition
Definition

A reference to a formal or informal definition of the task.

Control0..1
Typeuri
Requirements

Enables a formal definition of how he task is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation) to be associated with a task, enabling automation.

Summarytrue
Task.created
Definition

The date and time this task was created.

Control1..1
TypedateTime
Requirements

Most often used along with lastUpdated to track duration of task to supporting monitoring and management.

Alternate NamesCreated Date
Comments

This information duplicates what appear in Provenance but is often needs to be more accessible.

InvariantsAffect this element
inv-1: Last modified date must be greater than or equal to created date. (expression: lastModified >= created, xpath: f:lastModified >= f:created)
Task.lastModified
Definition

The date and time of last modification to this task.

Control1..1
TypedateTime
Requirements

Used along with history to track task activity and time in a particular task state. This enables monitoring and management.

Alternate NamesUpdate Date
Summarytrue
Comments

This information duplicates what appear in Provenance but is often needs to be more accessible.

InvariantsAffect this element
inv-1: Last modified date must be greater than or equal to created date. (expression: lastModified >= created, xpath: f:lastModified >= f:created)
Task.creator
Definition

The creator of the task.

Control1..1
TypeReference(Device | Organization | Patient | Practitioner | RelatedPerson)
Requirements

Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task).

Alternate NamesInitiator; Author
Comments

This information duplicates what appear in Provenance but is often needs to be more accessible.

Task.owner
Definition

The owner of this task. The participant who can execute this task.

Control0..1
TypeReference(Device | Organization | Patient | Practitioner | RelatedPerson)
Requirements

Identifies who is expected to perform this task.

Alternate NamesPerformer; Executer
Comments

This information duplicates what appear in Provenance but is often needs to be more accessible.

Task.parent
Definition

Task that this particular task is part of.

Control0..1
TypeReference(Task)
Requirements

Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task).

Task.input
Definition

Inputs to the task.

Control0..*
Requirements

Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.

Task.input.name
Definition

The name of the input parameter.

Control1..1
Typestring
Requirements

Inputs are named to enable task automation to bind data and pass it from one task to the next.

Task.input.value[x]
Definition

The value of the input parameter as a basic type.

Control1..1
Type*
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

Task inputs can take any form.

Task.output
Definition

Outputs produced by the Task.

Control0..*
Requirements

Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows.

Task.output.name
Definition

The name of the Output parameter.

Control1..1
Typestring
Requirements

Outputs are named to enable task automation to bind data and pass it from one task to the next.

Task.output.value[x]
Definition

The value of the Output parameter as a basic type.

Control1..1
Type*
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

Task outputs can take any form.