Release 4 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3

Responsible Owner: Orders and Observations icon Work Group Maturity Level : 2   Trial Use Normative Security Category : Not Classified Compartments : Not linked to any defined compartments Group , Patient

Detailed Descriptions for the elements in the Task resource.

Invariants
Element Id Task
Definition

A task to be performed. performed as a part of a workflow and the related informations like inputs, outputs and execution progress. While very simple workflows can be implemented with Request alone, most workflows would require a Task (explicit or contained) as a means to track the execution progress (i.e. inputs, outputs, status). Please refer to Fulfillment/Execution .

Short Display A task to be performed
Cardinality 0..*
Type DomainResource
Invariants Summary false
Constraints Element Id 0..*
Defined on this element
inv-1 tsk-0 Rule Last modified date must be greater than or equal to authored-on date. lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn
Task.identifier tsk-1 Task.identifier Definition The business identifier for this task. Note Rule This Task.restriction is only allowed if the Task is seeking fulfillment and a business identifier, not a resource identifier (see discussion ) focus is specified. Cardinality restriction.exists() implies (code.coding.where(code='fulfill' and system='http://hl7.org/fhir/CodeSystem/task-code').exists() and focus.exists() and focus.value.ofType(Reference).exists())
Element Id Task.instantiatesCanonical Task.identifier
Definition

The URL pointing to a FHIR -defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by business identifier for this Task. task.

Cardinality 0..1 Type Short Display canonical ( ActivityDefinition ) Task Instance Identifier
Requirements Note Enables a formal definition of how he task This is to be performed, enabling automation. Summary true a business identifier, not a resource identifier (see discussion Task.instantiatesUri Element Id Task.instantiatesUri Definition 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. )
Cardinality 0..1 0..*
Type uri Identifier
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 false
Element Id 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 ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. focus. For example, based on a ServiceRequest CarePlan (= BasedOn), basedOn), a task is created to fulfill a procedureRequest ServiceRequest ( = FocusOn focus ) to collect a specimen from a patient.

Short Display Request fulfilled by this task
Cardinality 0..*
Type Reference ( Any )
Summary true
Comments

Task.basedOn is never the same as Task.focus. Task.basedOn will typically not be present for 'please fulfill' Tasks as a distinct authorization is rarely needed to request fulfillment. If the Task is seeking fulfillment of an order, the order to be fulfilled is always communicated using focus , never basedOn. However, authorization may be needed to perform other types of Task actions. As an example of when both would be present, a Task seeking suspension of a prescription might have a Task.basedOn pointing to the ServiceRequest ordering surgery (which is the driver for suspending the MedicationRequest - which would be the Task.focus).

Element Id Task.groupIdentifier
Definition

An A shared identifier that links together common to multiple tasks independent Task and other requests Request instances that were created in activated/authorized more or less simultaneously by a single author. The presence of the same context. 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.

Short Display Requisition or grouper id
Cardinality 0..1
Type Identifier
Requirements

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

Summary true
Element Id Task.partOf
Definition

Task that this particular task is part of.

Short Display Composite task
Cardinality 0..*
Type Reference ( Task )
Requirements Hierarchy This reference is part of a strict Hierarchy
Requirements

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

Summary true
Comments

This should usually be 0..1.

Element Id Task.status
Definition

The current status of the task.

Short Display draft | requested | received | accepted | +
Cardinality 1..1
Terminology Binding TaskStatus Task Status ( Required )
Type code
Is Modifier true (Reason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)
Requirements

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

Summary true
Element Id Task.statusReason
Definition

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

Short Display Reason for current status
Cardinality 0..1 0..*
Terminology Binding TaskStatusReason : Task Status Reason ( Example )
Type CodeableConcept CodeableReference
Summary true
Comments

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

Element Id Task.businessStatus
Definition

Contains business-specific nuances of the business state.

Short Display E.g. "Specimen collected", "IV prepped"
Cardinality 0..1
Terminology Binding TaskBusinessStatus : Task Business Status ( Example )
Type CodeableConcept
Requirements

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

Summary true
Element Id Task.intent
Definition

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.

Short Display unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Cardinality 1..1
Terminology Binding TaskIntent Task Intent ( Required )
Type code
Summary true
Comments

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

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

Element Id Task.priority
Definition

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

Short Display routine | urgent | asap | stat
Cardinality 0..1
Terminology Binding Request priority RequestPriority ( 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.

Summary false
Element Id Task.doNotPerform
Definition

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

Short Display True if Task is prohibiting action
Cardinality 0..1
Type boolean
Is Modifier true (Reason: If true, this element negates the Task. For example, instead of a request to perform a task, it is a request _not_ to perform a task.)
Summary true
Comments

The attributes provided with the Task qualify what is not to be done. For example, if a requestedPeriod is provided, the 'do not' request only applies within the specified time. If a requestedPerformer is specified then the 'do not' request only applies to performers of that type. Qualifiers include: code, subject, occurrence, requestedPerformer and performer.

In some cases, the Request.code may pre-coordinate prohibition into the requested action. E.g. 'NPO' (nothing by mouth), 'DNR' (do not resuscitate). If this happens, doNotPerform SHALL NOT be set to true. I.e. The resource SHALL NOT have double negation. (E.g. 'Do not DNR').

When Task.focus refers to a Request Resource, it is that Request's doNotPerform Flag that indicates that the action should not be performed. A Task can be used to request that authorized action is not performed by having task.focus point to that request resource and use Task.code as the do not perform indicator.

Note that the use of doNotPerform and negation in Task.code can cause ambiguity and the impact of this should be considered not only for task but also for all related resources.

Element Id Task.code
Definition

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

Short Display Task Type
Cardinality 0..1
Terminology Binding Task Codes ( Example Extensible )
Type CodeableConcept
Summary true
Comments Constraints
Affect this element
tsk-1 The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into Rule Task.restriction is only allowed if the code. Task is seeking fulfillment and a focus is specified. restriction.exists() implies (code.coding.where(code='fulfill' and system='http://hl7.org/fhir/CodeSystem/task-code').exists() and focus.exists() and focus.value.ofType(Reference).exists())
Element Id Task.description
Definition

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

Short Display Human-readable explanation of task
Cardinality 0..1
Type string markdown
Summary true
Element Id Task.focus
Definition

The request being actioned fulfilled or the resource being manipulated (changed, suspended, etc.) by this task.

Cardinality Short Display 0..1 What task is acting on
Type Cardinality Reference ( Any ) 0..*
Requirements

Used to identify the thing to be done.

Summary true
Comments

If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.). Typically a Task should only have one focus. If multiple focuses are provided, then action must be taken on the complete set as a whole (i.e,. all must be accepted, rejected, cancelled, held, completed, etc. as a whole). If there is a possibility to have different statuses for different focuses, then there SHALL be a separate Task instance for each focus.

Constraints
Affect this element
tsk-1 Rule Task.restriction is only allowed if the Task is seeking fulfillment and a focus is specified. restriction.exists() implies (code.coding.where(code='fulfill' and system='http://hl7.org/fhir/CodeSystem/task-code').exists() and focus.exists() and focus.value.ofType(Reference).exists())
Element Id Task.focus.value[x]
Definition

What task is acting on.

Short Display What task is acting on
Cardinality 1..1
Type Reference ( Any )| canonical ( CanonicalResource )
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Element Id Task.for
Definition

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

Short Display Beneficiary of the Task
Cardinality 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). This can also affect access control.

Alternate Names Patient
Summary true
Element Id Task.encounter
Definition

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

Short Display Healthcare event during which this task originated
Cardinality 0..1
Type Reference ( Encounter )
Requirements

For some tasks it may be important to know the link between the encounter the task originated within.

Summary true
Element Id Task.requestedPeriod
Definition

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

Short Display When the task should be performed
Cardinality 0..1
Type Period
Summary true
Comments

This is typically used when the Task is not seeking fulfillment of a focus Request, as in that case the period would be specified on the Request and/or in the Task.restriction.period. Instead, it is used for stand-alone tasks.

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

Short Display Start and end time of execution
Cardinality 0..1
Type Period
Summary true
Element Id Task.authoredOn
Definition

The date and time this task was created.

Short Display Task Creation Date
Cardinality 0..1
Type dateTime
Requirements

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

Alternate Names Created Date
Invariants Affect this element inv-1 Rule Summary Last modified date must be greater than or equal to authored-on date. lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn false
Element Id Task.lastModified
Definition

The date and time of last modification to this task.

Short Display Task Last Modified Date
Cardinality 0..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
Element Id Task.requester
Definition

The creator of the task.

Short Display Who is asking for task to be done
Cardinality 0..1
Type Reference ( Device | Group | Organization | Patient | Practitioner | PractitionerRole | 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).

Summary true
Comments

Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.

Element Id Task.performerType Task.requestedPerformer
Definition

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

Short Display Who should perform the Task
Cardinality 0..*
Terminology Binding Procedure Performer Role Codes ( Preferred )
Type CodeableConcept CodeableReference ( Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson | Group )
Requirements

Use to distinguish tasks on different activity queues.

Summary false
Comments

Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.

Element Id Task.owner
Definition

Individual organization or Device currently Party responsible for managing task execution.

Short Display Responsible individual
Cardinality 0..1
Type Reference ( Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson | Group )
Requirements

Identifies who is expected to perform this task.

Alternate Names Performer; Executer
Summary true
Comments

Tasks may be created with an owner not yet identified. Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.

Element Id Task.location Task.performer
Definition

Principal physical location where The entity who performed the this task is performed. requested task.

Short Display Who or what performed the task
Cardinality 0..*
0..1 Summary true
Element Id Task.performer.function
Definition

A code or description of the performer of the task.

Short Display Type of performance
Cardinality 0..1
Reference Terminology Binding Task Performer Function Code ( Location Example )
Requirements Type CodeableConcept
Summary true
Element Id Task.performer.actor
Definition

Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside The actor or outside a dedicated healthcare setting). entity who performed the task.

Short Display Who performed the task
Cardinality 1..1
Type Reference ( Practitioner | Device | Organization | PractitionerRole | CareTeam | Patient | RelatedPerson | Group )
Summary true
Comments

Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.

Element Id Task.reasonCode Task.location
Definition

A description or code indicating why Principal physical location where this task needs to be is performed.

Short Display Where task occurs
Cardinality 0..1
Terminology Binding Type TaskReason : Reference ( Location )
Requirements Type

Provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).

CodeableConcept Summary true
Comments

This should only be included if there is no focus specified when the Task to be/being performed happens or if it differs from is expected to happen primarily within the reason indicated bounds of a single Location. Other locations (e.g. source, destination, etc.) would either be reflected on the focus. 'basedOn' Request or be conveyed as distinct Task.input values.

Element Id Task.reasonReference Task.reason
Definition

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

Short Display Why task is needed
Cardinality 0..*
0..1 Terminology Binding Task Reason ( Example )
Type Reference CodeableReference ( Any )
Comments Summary false
Comments

Tasks might This will typically not be justified based present for Tasks with a code of 'please fulfill' as, for those, the reason for action is conveyed on an Observation, the Request pointed to by Task.focus. Some types of tasks will not need a Condition, 'reason'. E.g. a past or planned procedure, etc. This should only request to discharge a patient can be included if there is no focus or if it differs from inferred to be 'because the patient is ready' and this would not need a reason indicated to be stated on the focus. Use the CodeableConcept text element in Task.reasonCode if the data is free (uncoded) text. Task.

Element Id Task.insurance
Definition

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

Short Display Associated insurance coverage
Cardinality 0..*
Type Reference ( Coverage | ClaimResponse )
Summary false
Element Id Task.note
Definition

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

Short Display Comments made about the task
Cardinality 0..*
Type Annotation
Summary false
Element Id 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.

Short Display Key events in history of the Task
Cardinality 0..*
Type Reference ( Provenance )
Alternate Names Status History
Comments Summary false
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.

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

Short Display Constraints on fulfillment tasks
Cardinality 0..1
Requirements

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

Summary false
Comments

This element should only be used when the Task is seeking fulfillment of a request resource that authorizes a broader set of subjects, repetitions and/or time-period than the Task itself is seeking execution against. It is not used otherwise.

Constraints
Affect this element
tsk-1 Rule Task.restriction is only allowed if the Task is seeking fulfillment and a focus is specified. restriction.exists() implies (code.coding.where(code='fulfill' and system='http://hl7.org/fhir/CodeSystem/task-code').exists() and focus.exists() and focus.value.ofType(Reference).exists())
Element Id Task.restriction.repetitions
Definition

Indicates the number of times the requested action should occur.

Short Display How many times to repeat
Cardinality 0..1
Type positiveInt
Requirements

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

Summary false
Element Id Task.restriction.period
Definition

Over what The time-period is for which fulfillment is sought. This must fall within the overall time period authorized in the referenced request. E.g. ServiceRequest.occurance[x].

Short Display When fulfillment is sought
Cardinality 0..1
Type Period
Requirements

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

Comments Summary false
Comments

This is distinct from Task.executionPeriod. ExecutionPeriod indicates when the task needs to be initiated, while Task.restriction.period specifies the subset of the overall authorization that this period covers. For example, a MedicationRequest with an overall effective period of 1 year might have a Task whose restriction.period is 2 months (i.e. satisfy 2 months of medication therapy), while the execution period might be 'between now and 5 days from now' - i.e. If you say yes to this, then you're agreeing to supply medication for that 2 month period within the next 5 days.

Note that period.high is the due date representing the time by which the task should be completed.

Element Id Task.restriction.recipient
Definition

For requests that are targeted to more than on directed at multiple potential recipient/target, for whom recipients or targets, this is used to specify the individual or entity from whom fulfillment sought? is being sought.

Short Display Individual or entity from whom fulfillment is being sought
Cardinality 0..*
Type Reference ( Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization | Device )
Summary false
Comments

If seeking fulfillment of a ServiceRequest where the ServiceRequest.subject was a Group of devices, but the Task was only seeking execution against a single device. If just creating a Task that is to manipulate a device in the absence of a broader order, there's no need for restriction.recipient. The Device to be manipulated would be the Task.focus (and potentially the Task.for - if the action wasn't for the benefit of a Patient or some other record).

Element Id Task.input
Definition

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

Short Display Information used to perform task
Cardinality 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.

Alternate Names Supporting Information
Summary false
Element Id Task.input.type
Definition

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

Short Display Label for the input
Cardinality 1..1
Terminology Binding TaskInputParameterType : Task Input/Output Parameter Type ( Example )
Type CodeableConcept
Requirements

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

Alternate Names Name
Comments Summary false
Comments

The type of the input may affect how it is used in the task. 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.

Element Id Task.input.value[x]
Definition

The value of the input parameter as a basic type.

Short Display Content to use in performing the task
Cardinality 1..1
Type *
[x] Note See Choice of Data Types Datatypes for further information about how to use [x]
Summary false
Element Id Task.output
Definition

Outputs produced by the Task.

Short Display Information produced as part of task
Cardinality 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.

Summary false
Element Id Task.output.type
Definition

The name of the Output parameter. A code or description to distinguish between outputs.

Short Display Label for output
Cardinality 1..1
Terminology Binding TaskOutputParameterType : Task Input/Output Parameter Type ( Example )
Type CodeableConcept
Requirements

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

Alternate Names Name
Summary false
Element Id Task.output.value[x]
Definition

The value of the Output parameter as a basic type.

Short Display Result of output
Cardinality 1..1
Type *
[x] Note See Choice of Data Types Datatypes for further information about how to use [x]
Requirements

Task outputs can take any form.

Summary false