# List a patient's questionnaire responses

Operation ID: `ehr.listQuestionnaireResponses`

List FHIR QuestionnaireResponse resources for a patient, optionally filtered by ?questionnaire_url= to scope to one questionnaire.

## Public method

`listQuestionnaireResponses`

Signature: `ehr.listQuestionnaireResponses(patientId, questionnaireUrl)`

Return type: `Promise<ListQuestionnaireResponsesResponse>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`GET /patients/{patient_id}/questionnaire-responses`

## Path parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `patient_id` | `string` | Yes |  |  |  | No |  |

## Query parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `questionnaire_url` | `string` | No |  |  |  | No | Canonical URL of the Questionnaire |

## Body parameters

None.

Request model: None.

## Request example

None declared in canonical OpenAPI.

## Success responses

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

## Success response examples

### 200

```json
{
  "patient_id": "patient-example-001",
  "questionnaire_responses": [
    {
      "authored": "2026-08-10T10:00:00Z",
      "authored_by_name": "Alex Smith",
      "authored_by_patient": true,
      "encounter_id": "encounter-example-001",
      "fhir_id": "questionnaire-response-example-001",
      "items": [
        {
          "answers": [
            {
              "sub_items": [],
              "value_boolean": null,
              "value_coding": null,
              "value_date": null,
              "value_date_time": null,
              "value_decimal": null,
              "value_integer": null,
              "value_quantity": null,
              "value_string": "Good",
              "value_time": null,
              "value_uri": null
            }
          ],
          "definition": "https://example.com/questionnaires/general-health#general-health",
          "link_id": "general-health",
          "sub_items": [],
          "text": "How would you rate your general health?"
        }
      ],
      "patient_fhir_id": "patient-example-001",
      "questionnaire_fhir_id": "questionnaire-example-001",
      "questionnaire_url": "https://example.com/questionnaires/general-health",
      "response_id": "00000000-0000-4000-8000-000000000306",
      "status": "completed"
    }
  ],
  "total": 1
}
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Internal server error |

## Error examples

### 401 — Missing or invalid access token

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

### 500 — Unexpected service failure (sanitized example)

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

## NodeJS / TypeScript implementation

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

```ts
const patientId = "<PATIENT_ID>";

const questionnaireUrl = "<QUESTIONNAIRE_URL>";

const result = await ehr.listQuestionnaireResponses(patientId, questionnaireUrl);
```

## cURL

```bash
curl -X GET \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  'https://dev-api-ehr.health.cloud/patients/%3CPATIENT_ID%3E/questionnaire-responses?questionnaire_url=%3CQUESTIONNAIRE_URL%3E'
```

## 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.