Searches for patient policies with pagination support.

post

https://integrationhub.wellsky.io/commands/v4/patients/policies/search

Sample request:

POST /commands/v4/patients/policies/search
{
    "pageNumber": 0,
    "pageSize": 25,
    "medicalRecordNumber": "MRN001",
    "policyNumber": "POL123"
}

HCSI-4328: Search patient policies endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

api-version

string

The requested API version

Body Params

Search criteria including filters, pagination, and sorting options.

Request model for searching patient policies with pagination.

medicalRecordNumber

string

required

length ≥ 1

Medical record number of the patient. Required.

policyNumber

string | null

Policy number filter. Supports partial matching.

groupNumber

string | null

Group number filter. Supports partial matching.

planName

string | null

Plan name filter. Supports partial matching.

isActive

boolean | null

Gets or sets a value indicating whether to filter by active policy status.
When true, returns only active policies (PolicyStatus_Id = 1).
When false, returns only inactive policies (PolicyStatus_Id = 2).
When null, no policy status filter is applied.

includeRemoved

boolean

Gets or sets a value indicating whether to include removed (soft-deleted) policy records.
Defaults to false to only return active policies.

sort

array of objects | null

sort

pageSize

int32

pageNumber

int32

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

200OK

400Bad Request

500Internal Server Error