List alerts, or the episodes they were folded into

The dashboard view. Keyset-paged: pass nextCursor back as cursor.

By default this is one row per breach, filtered by tenant, patient and subscriber attachment only — NOT project-scoped, so do not build a per-facility view on it.

?episodes=true answers with episodes instead: one row per clinical event, which opens on the first breaching reading, absorbs the rest, and closes on recovery, on going stale, or by hand. That grain REQUIRES project and is the one a facility-facing feed wants. It defaults to every medical code except out-of-bed (103214-3), whose evaluation and records live in ovok.

Filters belong to one grain or the other: algorithmId to alerts, and codes, since and acknowledged to episodes. Sending one to the wrong grain is a 400, not a filter that silently did nothing. status reads ACTIVE/RESOLVED for alerts and OPEN/CLOSED for episodes.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Return episodes rather than the individual breaches they were folded from.

An episode is one continuous clinical event for a (patient, code) pair: it
opens on the first breaching reading, absorbs the rest, and closes on
recovery, on going stale, or by hand. The default answers one row per
breach, which is the duplication episodes exist to collapse.

Requires project, and changes which of the filters below are accepted.

string

The Medplum project that scopes the read to one facility. Required with
episodes=true and refused without it.

string
length ≤ 200
string
enum

ACTIVE or RESOLVED for alerts; OPEN or CLOSED with episodes=true.

Allowed:
string
length ≤ 64

Only alerts raised from this certified algorithm, by identifier — the same
slug the derivation route is addressed by. Alerts only: an episode is keyed
by observation code, and carries no algorithm of its own.

codes
array of strings
length ≤ 32

Restrict to these LOINC codes. Episodes only.

Defaults to every medical code EXCEPT out-of-bed (103214-3), whose
evaluation and records live in ovok rather than here.

codes
string

Episodes opened at or after this instant. Episodes only.

boolean

Filter on whether the episode has been acknowledged. Episodes only.

number
≥ 1
string
length ≤ 512
Responses

400

A filter was sent to the wrong grain, or episodes=true arrived without project.

401

Missing, malformed or unrecognised Basic credentials.

403

Authenticated, but the client's role does not permit this, or it is not attached to the patient.

409

episodicAlerts is not enabled for this tenant, and episodes were requested.

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json