Tasks/Recalls

Search Tasks by certain parameters

get/fhir/v2/Task

Request

  • Base URL
    https://stage.ema-api.com/ema-dev/firm/apiportal/ema
  • URL
    https://stage.ema-api.com/ema-dev/firm/apiportal/ema/fhir/v2/Task
  • Auth
    HTTP bearer and API key in header x-api-key

Query parameters

_countstring

Number of records to use as the page size for paginated search. The maximum page size for this Resource is 50

_lastUpdatedstring date

This is an Optional Date in the format _lastUpdated=gtDATE, _lastUpdated=eqDATE and _lastUpdated=leDATE in the format yyyy-mm-dd. For EMA tasks this searches the task's last-modified date; for PM Recalls it also matches against recall activity timestamps.

authored-onstring date

Search by the date the task was created (Task.authoredOn).

based-onstring

Search by the ServiceRequest (lab order) this task is based on. The ServiceRequest must resolve to a lab request/order belonging to the authenticated firm; if it doesn't, the search returns zero results.

codestring

Selects which task type to search: TASK (default) for general EMA tasks, or PMRECALL for PM Recalls. Does not filter within a type. Any other value returns an OperationOutcome error (400/422) listing the valid values.

encounterstring

Search by the visit (Encounter) associated with the task.

locationstring

Search by the facility (Location) assigned to the task.

modifiedstring date

Search by the task's last-modified timestamp. Distinct from _lastUpdated.

pagestring

Page to be used for paginated search

patientstring

Search by the patient (Task.for).

performerstring

Search by assignee. Accepts either a Practitioner reference (an individual assignee) or a CT-GRP|{id} CareTeam identifier (a staff-group assignee).

periodstring date

Search by the task's due date (Task.executionPeriod.end). This is a single due-date match, not a start/end range.

requesterstring

Search by the staff member who created or last modified the task (Task.requester).

statusstring

ready | received | completed | cancelled

Response

Success

FHIRJSONRESOURCE required

A FHIR resource

Changes

No recorded changes to this operation across all 1 revision of this API.