# Create a FHIR Questionnaire

Operation ID: `patient.createQuestionnaire`

Create a FHIR Questionnaire from a name, optional title/status, and an ordered list of items. Requires a Bearer JWT (any authenticated pool type).

## Public method

`createQuestionnaire`

Signature: `patient.createQuestionnaire(request)`

Return type: `Promise<FhirIdResponse>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /questionnaires`

## Path parameters

None.

## Query parameters

None.

## Body parameters

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

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

## Request example

```json
{
  "items": [
    {
      "link_id": "sdk-q1",
      "text": "SDK test question?",
      "type": "string"
    }
  ],
  "name": "sdk-questionnaire-20260811-013559",
  "status": "active",
  "title": "SDK Test Questionnaire"
}
```

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `201` | [`CreateQuestionnaireResponse`](../models/CreateQuestionnaireResponse.md) | application/json | Questionnaire created |

## Success response examples

### 201

```json
{
  "fhir_id": "de0d8a19-265c-44b7-82cd-41fc67389d46"
}
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `400` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The request body failed validation |
| `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |

## Error examples

### 400 — The questionnaire body is invalid

```json
{
  "error": "name is required"
}
```

### 401 — Missing or invalid access token

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

## NodeJS / TypeScript implementation

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

```ts
const request = {
  "items": [
    {
      "link_id": "sdk-q1",
      "text": "SDK test question?",
      "type": "string"
    }
  ],
  "name": "sdk-questionnaire-20260811-013559",
  "status": "active",
  "title": "SDK Test Questionnaire"
};

const result = await patient.createQuestionnaire(request);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"items":[{"link_id":"sdk-q1","text":"SDK test question?","type":"string"}],"name":"sdk-questionnaire-20260811-013559","status":"active","title":"SDK Test Questionnaire"}' \
  'https://dev-api-patient.health.cloud/questionnaires'
```

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