Search Tasks by certain parameters

get

https://stage.ema-api.com/ema-dev/firm/apiportal/ema/fhir/v2/Task

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Use Authentication Endpoint page to get token

Query Params

_count

string

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

_lastUpdated

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-on

date

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

based-on

string

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.

code

string

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.

encounter

string

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

location

string

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

modified

date

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

page

string

Page to be used for paginated search

patient

string

Search by the patient (Task.for).

performer

string

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

period

date

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

requester

string

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

status

string

ready | received | completed | cancelled

Headers

string

enum

Defaults to application/fhir+json

Generated from available response content types

Allowed:

Responses

400

BAD REQUEST - The request was bad, often due to a missing required parameter

401

NOT AUTHORIZED - Authentication error; this token is not allowed access to the API

403

FORBIDDEN

404

NOT FOUND

422

UNPROCESSABLE ENTITY - Request could not be processed; typically a validation error

429

TOO MANY REQUESTS - Request was rate limited (1000 calls/min default); please retry

500

SERVER ERROR - Internal Server Error

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/fhir+json

200Success