# ITI-38 XCA document query (POST /documents/query)

Operation ID: `connectors.carequalityQueryDocuments`

ITI-38 XCA document query (POST /documents/query). Returns a list of document metadata dicts. Parse failures return [].

## Public method

`queryDocuments`

Signature: `connectors.carequality.createClient(config).queryDocuments(body)`

Return type: `Promise<CarequalityQueryDocumentsResult>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/carequality/query-documents`

## Path parameters

None.

## Query parameters

None.

## Body parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `body` | [`CarequalityQueryDocumentsRequest`](../models/CarequalityQueryDocumentsRequest.md) | Yes |  |  |  | No |  |

Request model: [`CarequalityQueryDocumentsRequest`](../models/CarequalityQueryDocumentsRequest.md)

## Request example

```json
{
  "api_key": "example-api-key",
  "assigning_authority": "example-api-key",
  "home_community_id": "12345",
  "initiator_url": "https://example.com/resource",
  "mode": "sandbox",
  "patient_id": "12345"
}
```

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`CarequalityQueryDocumentsResponse`](../models/CarequalityQueryDocumentsResponse.md) | application/json | Successful response |

## Success response examples

### 200

```json
[
  {
    "vendorField": "vendor-defined value"
  }
]
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `400` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Connector validation rejected the payload, or a required field was missing or of the wrong type. |
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The HealthCloud bearer token is missing or invalid, or the vendor rejected the supplied connector credentials. |
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The connector failed unexpectedly. |
| `502` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor returned an application or transport-level failure. |
| `504` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor did not respond within the connector timeout. |

## Error examples

### 400 — Invalid request

```json
{
  "error": "Invalid request"
}
```

### 401 — Authorization required

```json
{
  "error": "Authorization required"
}
```

### 500 — Internal error

```json
{
  "error": "Internal error"
}
```

### 502 — Upstream vendor error

```json
{
  "error": "Upstream vendor error"
}
```

### 504 — Upstream timeout

```json
{
  "error": "Upstream timeout"
}
```

## NodeJS / TypeScript implementation

```ts
import { HCSDK } from "@healthcloudai/hc-sdk";
import type { CarequalityQueryDocumentsRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "api_key": "example-api-key",
  "assigning_authority": "example-api-key",
  "home_community_id": "12345",
  "initiator_url": "https://example.com/resource",
  "mode": "sandbox",
  "patient_id": "12345"
};

const result = await connectors.carequality.createClient(config).queryDocuments(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"api_key":"example-api-key","assigning_authority":"example-api-key","home_community_id":"12345","initiator_url":"https://example.com/resource","mode":"sandbox","patient_id":"12345"}' \
  'https://dev-api-connectors.health.cloud/connectors/carequality/query-documents'
```

## Notes

None.

## Prepared Test Console scenario

No canonical scenario is currently associated.

## Real response

No approved real integration response is currently published. Unapproved candidates are never rendered as examples.