Task

The Task resource is a generic representation of a task to be performed.

Overview

See the FHIR documentation for more information about Task resources.

Mapped Concepts in HIEBus

  • CareTask

Supported Interactions

Task resources support the following interactions.

Search Parameters

When searching for Task resources, the following search parameters are supported.

Name Type Prefixes
Modifiers
Can be Chained? Description
_count Special The maximum number of resources to return in a result page.
_elements Special Used to request a specific set of elements be returned as part of a resource.
_id Token Resource id.
_lastUpdated Date lt  le  gt  ge  When the resource last changed.
_source Uri :missing  Where the resource comes from.
_summary Special Used to return only a portion of the resouces. Defaults to 'false', which returns the whole resource.
_total Special Use the value 'estimate' to populate the result bundle's 'total' element with an estimate of the matching number of resources.
authored-on Date ne  lt  le  gt  ge  sa  eb  ap  :missing  Search by creation date.
code Token :not  :in  :notin  :missing  Search by task code.
modified Date ne  lt  le  gt  ge  sa  eb  ap  :missing  Search by last modification date.
owner Reference :missing  yes Search by task owner.
patient Reference :missing  yes The patient the Task is about.
period Date ne  lt  le  gt  ge  sa  eb  ap  :missing  Search by period Task is/was underway.
priority Token :not  :in  :notin  :missing  Search by task priority.
provenance-agent Reference :missing  yes Search by provenance, specified by its author (aka originator) Organization.
status Token :not  :in  :notin  :missing  Search by task status.
subject Reference :missing  yes The patient the Task is about. Functionally identical to the "patient" search parameter.

Sortable Parameters

When searching Task resources, it is possible to sort the returned values by the following search parameters.

  • lastModified
  • _id

Only one sort parameter may be specified.

Supported Includes

When searching Task resources, it is possible to include the resources referenced by the following field names.

  • Owner
  • Patient
  • Provenance Agent
  • Subject

Back to Resources