# Task

Canonical page: https://docs.ovok.com/api/fhir/r4/task

A task to be performed.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/Task/[id]` |
| Vread | `GET` | `/fhir/R4/Task/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/Task/[id]` |
| Patch | `PATCH` | `/fhir/R4/Task/[id]` |
| Delete | `DELETE` | `/fhir/R4/Task/[id]` |
| Create | `POST` | `/fhir/R4/Task` |
| Search | `GET` | `/fhir/R4/Task` |
| History | `GET` | `/fhir/R4/Task/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Task Instance Identifier |
| <span id="element-instantiates-canonical"></span>`instantiatesCanonical` | [canonical](/fhir-elements/primitive/canonical) | `0..1` | Formal definition of task |
| <span id="element-instantiates-uri"></span>`instantiatesUri` | [uri](/fhir-elements/primitive/uri) | `0..1` | Formal definition of task |
| <span id="element-based-on"></span>`basedOn` | [Reference](/fhir-elements/complex/reference) | `0..*` | Request fulfilled by this task |
| <span id="element-group-identifier"></span>`groupIdentifier` | [Identifier](/fhir-elements/complex/identifier) | `0..1` | Requisition or grouper id |
| <span id="element-part-of"></span>`partOf` | [Reference](/fhir-elements/complex/reference) | `0..*` | Composite task |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | draft \| requested \| received \| accepted \| + |
| <span id="element-status-reason"></span>`statusReason` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Reason for current status |
| <span id="element-business-status"></span>`businessStatus` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | E.g. "Specimen collected", "IV prepped" |
| <span id="element-intent"></span>`intent` | [code](/fhir-elements/primitive/code) | `1..1` | unknown \| proposal \| plan \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option |
| <span id="element-priority"></span>`priority` | [code](/fhir-elements/primitive/code) | `0..1` | routine \| urgent \| asap \| stat |
| <span id="element-code"></span>`code` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Task Type |
| <span id="element-description"></span>`description` | [string](/fhir-elements/primitive/string) | `0..1` | Human-readable explanation of task |
| <span id="element-focus"></span>`focus` | [Reference](/fhir-elements/complex/reference) | `0..1` | What task is acting on |
| <span id="element-for"></span>`for` | [Reference](/fhir-elements/complex/reference) | `0..1` | Beneficiary of the Task |
| <span id="element-encounter"></span>`encounter` | [Reference](/fhir-elements/complex/reference) | `0..1` | Healthcare event during which this task originated |
| <span id="element-execution-period"></span>`executionPeriod` | [Period](/fhir-elements/complex/period) | `0..1` | Start and end time of execution |
| <span id="element-authored-on"></span>`authoredOn` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | Task Creation Date |
| <span id="element-last-modified"></span>`lastModified` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | Task Last Modified Date |
| <span id="element-requester"></span>`requester` | [Reference](/fhir-elements/complex/reference) | `0..1` | Who is asking for task to be done |
| <span id="element-performer-type"></span>`performerType` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Requested performer |
| <span id="element-owner"></span>`owner` | [Reference](/fhir-elements/complex/reference) | `0..1` | Responsible individual |
| <span id="element-location"></span>`location` | [Reference](/fhir-elements/complex/reference) | `0..1` | Where task occurs |
| <span id="element-reason-code"></span>`reasonCode` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Why task is needed |
| <span id="element-reason-reference"></span>`reasonReference` | [Reference](/fhir-elements/complex/reference) | `0..1` | Why task is needed |
| <span id="element-insurance"></span>`insurance` | [Reference](/fhir-elements/complex/reference) | `0..*` | Associated insurance coverage |
| <span id="element-note"></span>`note` | [Annotation](/fhir-elements/complex/annotation) | `0..*` | Comments made about the task |
| <span id="element-relevant-history"></span>`relevantHistory` | [Reference](/fhir-elements/complex/reference) | `0..*` | Key events in history of the Task |
| <span id="element-restriction"></span>`restriction` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..1` | Constraints on fulfillment tasks |
| <span id="element-input"></span>`input` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Information used to perform task |
| <span id="element-output"></span>`output` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Information produced as part of task |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `authored-on` | date | Search by creation date |
| `based-on` | reference | Search by requests this task is based on |
| `business-status` | token | Search by business status |
| `code` | token | Search by task code |
| `encounter` | reference | Search by encounter |
| `focus` | reference | Search by task focus |
| `group-identifier` | token | Search by group identifier |
| `identifier` | token | Search for a task instance by its business identifier |
| `intent` | token | Search by task intent |
| `modified` | date | Search by last modification date |
| `owner` | reference | Search by task owner |
| `part-of` | reference | Search by task this task is part of |
| `patient` | reference | Search by patient |
| `performer` | token | Search by recommended type of performer (e.g., Requester, Performer, Scheduler). |
| `period` | date | Search by period Task is/was underway |
| `priority` | token | Search by task priority |
| `requester` | reference | Search by task requester |
| `status` | token | Search by task status |
| `subject` | reference | Search by subject |

## Reference [#reference]

Official FHIR R4 spec: [Task](https://hl7.org/fhir/R4/task.html).  
Maturity: Trial Use 2 (FMM 2).
