Query

A specified, approved request for patient records across the network (e.g., via Carequality/TEFCA to support treatment activities, via TEFCA for IAS queries) with an associated status (e.g., “completed”).

Operations

Search Queries

Request

Search Queries

Security

bearer

Query

pageNumbernumber

Page number to retrieve (1-based index)

Default:1

pageSizenumber

Number of items per page

Default:50

sortFieldstring

Field name to sort by

Default:"created"

Enum:"created""ccdaStatus""externalSystem"

sortIsDescendingboolean

Whether to sort in descending order

Default:false

subjectIdstring, (uuid)

Example:subjectId=3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring

Filter applies specifically to property ccdaStatus

Enum:"delayed""initiated""pending""inProgress""completed""exhausted""error"

createdFromstring, (ISO 8601)

Include queries created on or after this date (inclusive)

Example:createdFrom=2025-05-26T23:30:40.912Z

createdTostring, (ISO 8601)

Include queries created before this date (exclusive)

Example:createdTo=2025-05-26T23:30:40.912Z

ProjectIdstring, (uuid)required

Example:e6b01018-a333-4732-917e-fe38e91b0fdf

GET

/api/v1/patient-registry/query

curl -i -X GET \
  'https://partner.xcures.com/api/v1/patient-registry/query?pageNumber=1&pageSize=50&sortField=created&sortIsDescending=false&subjectId=3fa85f64-5717-4562-b3fc-2c963f66afa6&status=delayed&createdFrom=2025-05-26T23%3A30%3A40.912Z&createdTo=2025-05-26T23%3A30%3A40.912Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'ProjectId: e6b01018-a333-4732-917e-fe38e91b0fdf'

Responses

Response

No content

Query

Search Queries

Request

Query

Headers

Responses

Was this helpful?