Skip to main content

Task

A task to be performed.

Properties

NameRequiredTypeDescription
identifierIdentifier[]

Task Instance Identifier

Details

The business identifier for this task.

instantiatesCanonicalcanonical

Formal definition of task

Details

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

instantiatesUriuri

Formal definition of task

Details

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.

basedOnReference<Resource>[]

Request fulfilled by this task

Details

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. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.

groupIdentifierIdentifier

Requisition or grouper id

Details

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

partOfReference<Task>[]

Composite task

Details

Task that this particular task is part of.

This should usually be 0..1.

statuscode

draft | requested | received | accepted | +

Details

The current status of the task.

statusReasonCodeableConcept

Reason for current status

Details

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

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

businessStatusCodeableConcept

E.g. "Specimen collected", "IV prepped"

Details

Contains business-specific nuances of the business state.

intentcode

unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option

Details

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.

This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. In most cases, Tasks will have an intent of "order".

prioritycode

routine | urgent | asap | stat

Details

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

codeCodeableConcept

Task Type

Details

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

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

descriptionstring

Human-readable explanation of task

Details

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

focusReference<Resource>

What task is acting on

Details

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

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

forReference<Resource>

Beneficiary of the Task

Details

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

encounterReference<Encounter>

Healthcare event during which this task originated

Details

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

executionPeriodPeriod

Start and end time of execution

Details

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

authoredOndateTime

Task Creation Date

Details

The date and time this task was created.

lastModifieddateTime

Task Last Modified Date

Details

The date and time of last modification to this task.

requesterReference< Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson >

Who is asking for task to be done

Details

The creator of the task.

performerTypeCodeableConcept[]

Requested performer

Details

The kind of participant that should perform the task.

ownerReference< Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson >

Responsible individual

Details

Individual organization or Device currently responsible for task execution.

Tasks may be created with an owner not yet identified.

locationReference<Location>

Where task occurs

Details

Principal physical location where the this task is performed.

reasonCodeCodeableConcept

Why task is needed

Details

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

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

reasonReferenceReference<Resource>

Why task is needed

Details

A resource reference indicating why this task needs to be performed.

Tasks might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in `Task.reasonCode` if the data is free (uncoded) text.

insuranceReference<Coverage | ClaimResponse>[]

Associated insurance coverage

Details

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

noteAnnotation[]

Comments made about the task

Details

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

relevantHistoryReference<Provenance>[]

Key events in history of the Task

Details

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.

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.

restrictionTaskRestriction

Constraints on fulfillment tasks

Details

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.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

repetitionspositiveInt

How many times to repeat

Details

Indicates the number of times the requested action should occur.

periodPeriod

When fulfillment sought

Details

Over what time-period is fulfillment sought.

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

recipientReference< Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization >[]

For whom is fulfillment sought?

Details

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

inputTaskInput[]

Information used to perform task

Details

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

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

typeCodeableConcept

Label for the input

Details

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

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.

value[x]base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference<>, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta

Content to use in performing the task

Details

The value of the input parameter as a basic type.

outputTaskOutput[]

Information produced as part of task

Details

Outputs produced by the Task.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

typeCodeableConcept

Label for output

Details

The name of the Output parameter.

value[x]base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference<>, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta

Result of output

Details

The value of the Output parameter as a basic type.

Search Parameters

NameTypeDescriptionExpression
authored-ondateSearch by creation dateTask.authoredOn
based-onreferenceSearch by requests this task is based onTask.basedOn
business-statustokenSearch by business statusTask.businessStatus
codetokenSearch by task codeTask.code
encounterreferenceSearch by encounterTask.encounter
focusreferenceSearch by task focusTask.focus
group-identifiertokenSearch by group identifierTask.groupIdentifier
identifiertokenSearch for a task instance by its business identifierTask.identifier
intenttokenSearch by task intentTask.intent
modifieddateSearch by last modification dateTask.lastModified
ownerreferenceSearch by task ownerTask.owner
part-ofreferenceSearch by task this task is part ofTask.partOf
patientreferenceSearch by patientTask.for
performertokenSearch by recommended type of performer (e.g., Requester, Performer, Scheduler).Task.performerType
perioddateSearch by period Task is/was underwayTask.executionPeriod
prioritytokenSearch by task priorityTask.priority
requesterreferenceSearch by task requesterTask.requester
statustokenSearch by task statusTask.status
subjectreferenceSearch by subjectTask.for

Inherited Properties

NameRequiredTypeDescription
idstring

Logical id of this artifact

Details

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

metaMeta

Metadata about the resource

Details

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesuri

A set of rules under which this content was created

Details

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

languagecode

Language of the resource content

Details

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

textNarrative

Text summary of the resource, for human interpretation

Details

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

containedResource[]

Contained, inline Resources

Details

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

modifierExtensionExtension[]

Extensions that cannot be ignored

Details

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.