List encounters

GET 
/v1/encounters

Fetch a paginated list of encounters for the authenticated Insurer/HMO.

Request

Query Parameters

enrollee_id integer

Filter encounters by enrollee ID.

status string

Possible values: [all, active, completed, declined]

Filter encounters by status. Use all to disable status filtering.

start_date date

Filter encounters from this encounter_date (inclusive).

end_date date

Filter encounters up to this encounter_date (inclusive). Must be after or equal to start_date.

date_range string

Possible values: [all, 7days, 30days, custom]

Shortcut for date filtering. Use custom together with start_date/end_date.

search string

Search term (e.g., PR code, enrollee fields, provider name depending on server-side implementation).

page integer

Page number (pagination).

per_page integer

Number of records per page (pagination).

Responses

200

Success

application/json

Schema

Schema

current_page integer
per_page integer
total integer
data object[]
Array [
id integer
req_id string
hmo_id integer
provider_id integer
enrollee_id integer
encounter_date date
status string
prescriptions_count integer
enrollee object
id integer
firstname string
lastname string
insurance_no string
provider object
id integer
name string
hmo object
id integer
name string
prescriptions object[]
Present only for prescriptions that have been dispensed (fully or partially), included to support "Dispensed by" display.
Array [
id integer
status string
dispensed_by integernullable
dispensed_by_user objectnullable
id integer
provider objectnullable
id integer
name string
]
]

Example (from schema)

{
  "current_page": 1,
  "per_page": 15,
  "total": 2,
  "data": [
    {
      "id": 123,
      "req_id": "PR-HMOE01",
      "hmo_id": 10,
      "provider_id": 51,
      "enrollee_id": 9001,
      "encounter_date": "2026-02-24",
      "status": "completed",
      "prescriptions_count": 1,
      "enrollee": {
        "id": 0,
        "firstname": "string",
        "lastname": "string",
        "insurance_no": "string"
      },
      "provider": {
        "id": 0,
        "name": "string"
      },
      "hmo": {
        "id": 0,
        "name": "string"
      },
      "prescriptions": [
        {
          "id": 0,
          "status": "dispensed",
          "dispensed_by": 0,
          "dispensed_by_user": {
            "id": 0,
            "provider": {
              "id": 0,
              "name": "string"
            }
          }
        }
      ]
    }
  ]
}

401

Unauthenticated

403

Forbidden (feature not enabled for this Insurer/HMO)

404

Not found

Loading...