STU3 Candidate

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 . Page versions: R5 R4B R4 R3

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 authored-on date. (expression : lastModified >= authoredOn or lastModified.exists().not() or authoredOn.exists().not(), xpath: f:lastModified >= f:authoredOn or not(exists(f:lastModified)) or not(exists(f:authoredOn)))
Task.identifier
Definition

The business identifier for this task.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Task.definition[x]
Definition

A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.

Control0..1
Typeuri|Reference(ActivityDefinition)
[x] NoteSee Choice of Data Types for further information about how to use [x]
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.basedOn
Definition

BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a DiagnosticRequest, MedicationRequest, ProcedureRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfil. This latter resource is referenced by FocusOn. For example, based on a DiagnosticRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient.

Control0..*
TypeReference(Any)
Summarytrue
Task.groupIdentifier
Definition

An identifier that links together multiple tasks and other requests that were created in the same context.

Control0..1
TypeIdentifier
Requirements

Billing and/or reporting can be linked to whether multiple requests were created as a single unit.

Summarytrue
Task.partOf
Definition

Task that this particular task is part of.

Control0..*
TypeReference(Task)
Requirements

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

Summarytrue
Comments

This should usually be 0..1.

Task.status
Definition

The current status of the task.

Control1..1
Terminology BindingTaskStatus (Required)
Typecode
Requirements

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

Summarytrue
Task.statusReason
Definition

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

Control0..1
TypeCodeableConcept
Summarytrue
Comments

This applies to the current status. Look at the history of the task to see reasons for past statuses.

Task.businessStatus
Definition

Contains business-specific nuances of the business state.

Control0..1
Terminology BindingTaskBusinessStatus:
TypeCodeableConcept
Requirements

There's often a need to track substates of a task - this is often variable by specific workflow implementation.

Summarytrue
Task.intent
Definition

Indicates the "level" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc.

Control1..1
Terminology BindingRequestIntent (Required)
Typecode
Summarytrue
Comments

This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances.

In most cases, Tasks will have an intent of "order".

Task.priority
Definition

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

Control0..1
Terminology BindingRequestPriority (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.code
Definition

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

Control0..1
TypeCodeableConcept
Summarytrue
Comments

The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code.

Task.description
Definition

A free-text description of what is to be performed.

Control0..1
Typestring
Summarytrue
Task.focus
Definition

The request being actioned or the resource being manipulated by this task.

Control0..1
TypeReference(Any)
Requirements

Used to identify the thing to be done.

Summarytrue
Comments

If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).

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). This can also affect access control.

Alternate NamesPatient
Summarytrue
Task.context
Definition

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

Control0..1
TypeReference(Encounter | EpisodeOfCare)
Requirements

For some tasks it may be important to know the link between the task or episode of care the task originated within.

Summarytrue
Task.executionPeriod
Definition

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

Control0..1
TypePeriod
Summarytrue
Task.authoredOn
Definition

The date and time this task was created.

Control0..1
TypedateTime
Requirements

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

Alternate NamesCreated Date
InvariantsAffect this element
inv-1: Last modified date must be greater than or equal to authored-on date. (expression : lastModified >= authoredOn or lastModified.exists().not() or authoredOn.exists().not(), xpath: f:lastModified >= f:authoredOn or not(exists(f:lastModified)) or not(exists(f:authoredOn)))
Task.lastModified
Definition

The date and time of last modification to this task.

Control0..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
InvariantsAffect this element
inv-1: Last modified date must be greater than or equal to authored-on date. (expression : lastModified >= authoredOn or lastModified.exists().not() or authoredOn.exists().not(), xpath: f:lastModified >= f:authoredOn or not(exists(f:lastModified)) or not(exists(f:authoredOn)))
Task.requester
Definition

The creator of the task.

Control0..1
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).

Summarytrue
Task.requester.agent
Definition

The device, practitioner, etc. who initiated the task.

Control1..1
TypeReference(Device | Organization | Patient | Practitioner | RelatedPerson)
Alternate NamesInitiator; Author
Summarytrue
Task.requester.onBehalfOf
Definition

The organization the device or practitioner was acting on behalf of when they initiated the task.

Control0..1
TypeReference(Organization)
Requirements

Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request.

Task.performerType
Definition

The type of participant that can execute the task.

Control0..*
Terminology BindingTaskPerformerType (Preferred)
TypeCodeableConcept
Requirements

Use to distinguish tasks on different activity queues.

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
Summarytrue
Comments

Tasks may be created with an owner not yet identified.

Task.reason
Definition

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

Control0..1
Terminology BindingTaskReason:
TypeCodeableConcept
Comments

This should only be included if there is no focus or if it differs from the reason indicated on the focus.

Task.note
Definition

Free-text information captured about the task as it progresses.

Control0..*
TypeAnnotation
Task.relevantHistory
Definition

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.

Control0..*
TypeReference(Provenance)
Alternate NamesStatus History
Comments

This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.

Task.restriction
Definition

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.

Control0..1
Requirements

Sometimes when fulfillment is sought, you don't want full fulfillment.

Task.restriction.repetitions
Definition

Indicates the number of times the requested action should occur.

Control0..1
TypepositiveInt
Requirements

E.g. order that requests monthly lab tests, fulfillment is sought for 1.

Task.restriction.period
Definition

Over what time-period is fulfillment sought.

Control0..1
TypePeriod
Requirements

E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months.

Task.restriction.recipient
Definition

For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?

Control0..*
TypeReference(Patient | Practitioner | RelatedPerson | Group | Organization)
To DoIs this in the 80%?
Task.input
Definition

Additional information that may be needed in the execution of 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.

Alternate NamesSupporting Information
Task.input.type
Definition

A code or description indicating how the input is intended to be used as part of the task execution.

Control1..1
Terminology BindingTaskInputParameterType:
TypeCodeableConcept
Requirements

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

Alternate NamesName
Comments

If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input.

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]
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.type
Definition

The name of the Output parameter.

Control1..1
Terminology BindingTaskOutputParameterType:
TypeCodeableConcept
Requirements

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

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