# Search Queries

Search Queries

Endpoint: GET /api/v1/patient-registry/query
Version: V1
Security: bearer

## Header parameters:

  - `ProjectId` (string, required)
    Example: "e6b01018-a333-4732-917e-fe38e91b0fdf"

## Query parameters:

  - `pageNumber` (number)
    Page number to retrieve (1-based index)

  - `pageSize` (number)
    Number of items per page

  - `sortField` (string)
    Field name to sort by
    Enum: "created", "ccdaStatus", "externalSystem"

  - `sortIsDescending` (boolean)
    Whether to sort in descending order

  - `subjectId` (string)
    Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

  - `status` (string)
    Filter applies specifically to property ccdaStatus
    Enum: "delayed", "initiated", "pending", "inProgress", "completed", "exhausted", "error"

  - `createdFrom` (string)
    Include queries created on or after this date (inclusive)
    Example: "2025-05-26T23:30:40.912Z"

  - `createdTo` (string)
    Include queries created before this date (exclusive)
    Example: "2025-05-26T23:30:40.912Z"

## Response default fields (application/json):

  - `totalCount` (number, required)
    Total number of items matching the query

  - `results` (array, required)
    List of results for the current page

  - `results.id` (string, required)

  - `results.subjectId` (string, required)

  - `results.created` (string, required)

  - `results.userId` (string, required)

  - `results.fhirStatus` (string)
    Enum: "delayed", "initiated", "pending", "inProgress", "completed", "exhausted", "error"

  - `results.ccdaStatus` (string)
    Enum: "delayed", "initiated", "pending", "inProgress", "completed", "exhausted", "error"

  - `results.queryAttempts` (array)

  - `results.queryAttempts.queryId` (string, required)

  - `results.queryAttempts.created` (string, required)

  - `results.queryAttempts.fhirResult` (string)
    Enum: "delayed", "initiated", "pending", "inProgress", "completed", "exhausted", "error"

  - `results.queryAttempts.ccdaResult` (string)
    Enum: "delayed", "initiated", "pending", "inProgress", "completed", "exhausted", "error"

  - `results.queryAttempts.message` (string)

  - `pageNumber` (number)
    Page number to retrieve (1-based index)

  - `pageSize` (number)
    Number of items per page

  - `sortField` (string)
    Field name to sort by

  - `sortIsDescending` (boolean)
    Whether to sort in descending order


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 429 fields