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
Detailed Descriptions for the elements in the Task resource.
Task | |
Definition | A task to be performed. |
Control | 1..1 |
Invariants | Defined 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. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Task.type | |
Definition | A name or code (or both) briefly describing what the task involves. |
Control | 0..1 |
Type | CodeableConcept |
Summary | true |
Task.description | |
Definition | A description of this task. |
Control | 0..1 |
Type | string |
Summary | true |
Task.performerType | |
Definition | The type of participant that can execute the task. |
Control | 0..* |
Binding | TaskPerformerType: The type(s) of task performers allowed (Preferred) |
Type | Coding |
Requirements | Use to distinguish tasks on different activity queues. |
Task.priority | |
Definition | The priority of the task among other tasks of the same type. |
Control | 0..1 |
Binding | TaskPriority: The task's priority (Required) |
Type | code |
Meaning if Missing | If 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. |
Control | 1..1 |
Binding | TaskStatus: The current status of the task. (Required) |
Type | code |
Requirements | These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks. |
Summary | true |
Invariants | Affect 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. |
Control | 0..1 |
Type | CodeableConcept |
Summary | true |
Invariants | Affect 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. |
Control | 0..1 |
Type | Reference(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). |
Control | 0..1 |
Type | Reference(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). |
Summary | true |
Task.definition | |
Definition | A reference to a formal or informal definition of the task. |
Control | 0..1 |
Type | uri |
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. |
Summary | true |
Task.created | |
Definition | The date and time this task was created. |
Control | 1..1 |
Type | dateTime |
Requirements | Most often used along with lastUpdated to track duration of task to supporting monitoring and management. |
Alternate Names | Created Date |
Comments | This information duplicates what appear in Provenance but is often needs to be more accessible. |
Invariants | Affect 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. |
Control | 1..1 |
Type | dateTime |
Requirements | Used along with history to track task activity and time in a particular task state. This enables monitoring and management. |
Alternate Names | Update Date |
Summary | true |
Comments | This information duplicates what appear in Provenance but is often needs to be more accessible. |
Invariants | Affect 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. |
Control | 1..1 |
Type | Reference(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 Names | Initiator; 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. |
Control | 0..1 |
Type | Reference(Device | Organization | Patient | Practitioner | RelatedPerson) |
Requirements | Identifies who is expected to perform this task. |
Alternate Names | Performer; 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. |
Control | 0..1 |
Type | Reference(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. |
Control | 0..* |
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. |
Control | 1..1 |
Type | string |
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. |
Control | 1..1 |
Type | * |
[x] Note | See 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. |
Control | 0..* |
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. |
Control | 1..1 |
Type | string |
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. |
Control | 1..1 |
Type | * |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Task outputs can take any form. |