Passer au contenu
API referenceEncounters

List encounters

Encounters ordered by `(updatedAt, id)`. `updatedSince` gives incremental sync; items updated in the last 10 seconds are held back (settle window).

Cette page n'est pas encore offerte en français; elle est affichée en anglais.
GET
/v1/encounters

Encounters ordered by (updatedAt, id). updatedSince gives incremental sync; items updated in the last 10 seconds are held back (settle window).

Authorization

AuthorizationBearer <token>

OAuth 2.0 client credentials. private_key_jwt (SMART Backend Services asymmetric) is recommended; client secrets need an IP allowlist or mTLS outside the sandbox.

In: header

Scope: encounters:read

Query Parameters

cursor?string

Opaque cursor from nextCursor. Bound to the query's filters and valid for 24 hours.

Match^cur_[A-Za-z0-9_-]{8,2048}$
lifecycle?string

Value in

  • "active"
  • "departed"
  • "cancelled"
  • "closed"
limit?integer

Page size, 1 to 100 (default 25).

Range1 <= value <= 100
site?string

A site's code (its slug), for example kb-main-ed.

Match^[a-z0-9][a-z0-9-]{1,62}$
stage?string

Value in

  • "checked_in"
  • "waiting_to_be_seen"
  • "provider_assigned"
  • "with_care_team"
  • "tests_in_progress"
  • "awaiting_reassessment"
  • "observation"
  • "awaiting_consult"
  • "preparing_discharge"
  • "preparing_transfer"
  • "admitted_waiting_for_bed"
  • "departed"
  • "closed"
updatedSince?string

RFC 3339 timestamp with an explicit offset (Z or ±hh:mm). A timestamp without an offset is refused.

Match^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d{1,9})?(?:Z|[+-]\d{2}:\d{2})$
Formatdate-time
Lengthlength <= 40

Header Parameters

Api-Version?enum

Overrides the app's pinned dated version for this request.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/encounters"
{  "data": [    {      "arrivedAt": "2026-09-14T15:00:11.402Z",      "departedAt": "2026-09-14T15:00:11.402Z",      "departureKind": "home",      "engagement": {        "accessState": "open",        "activatedAt": "2026-09-14T15:00:11.402Z",        "activeDevices": -9007199254740991,        "activeFamilyLinks": -9007199254740991,        "cardIssuedAt": "2026-09-14T15:00:11.402Z"      },      "externalRef": {        "externalId": "string",        "idSystem": "string"      },      "feedStale": true,      "id": "enc_k57a1x2m9q4t8v3w5x1y6z7a8b9c0d1e",      "lastEventAt": "2026-09-14T15:00:11.402Z",      "lifecycle": "active",      "object": "encounter",      "origin": "ehr",      "requests": {        "oldestOpenAt": "2026-09-14T15:00:11.402Z",        "open": -9007199254740991,        "urgentOpen": true      },      "site": "kb-main-ed",      "stage": "checked_in",      "stageEnteredAt": "2026-09-14T15:00:11.402Z",      "tasks": {        "openActions": -9007199254740991,        "toConfirm": -9007199254740991      },      "updatedAt": "2026-09-14T15:00:11.402Z",      "version": -9007199254740991    }  ],  "hasMore": true,  "nextCursor": "string",  "object": "list"}

Cette page vous a-t-elle été utile?

Get an encounter GET

One encounter. `404` for unknown ids, other sites and archived encounters.

Look up an encounter by visit number POST

Resolves an EHR visit number to an encounter without EDFlow storing the number. A miss is `200` with `found: false`. Rate-limited (`lookup`) and audited without the identifier.