Questionnaire Responses
The Questionnaire Responses API allows you to submit form data against questionnaire templates, and retrieve or update existing responses.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /questionnaire-responses | List responses |
GET | /questionnaire-responses/{id} | Retrieve a response |
POST | /questionnaire-responses | Create a response |
PATCH | /questionnaire-responses/{id} | Update a response |
The Response Object
{
"id": "qr_123e4567-e89b-12d3-a456-426614174000",
"questionnaire_id": "qt_456e7890-e89b-12d3-a456-426614174111",
"patient_id": "pat_789a0123-e89b-12d3-a456-426614174222",
"appointment_id": null,
"episode_id": null,
"responses": {
"chief_complaint": "Persistent headache",
"duration": "2 weeks",
"severity": 7
},
"submitted_at": "2025-01-15T10:30:00Z",
"submitted_by_patient": false,
"is_pre_booking": false,
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T10:30:00Z"
}List Responses
GET /questionnaire-responsesQuery Parameters
| Parameter | Type | Description |
|---|---|---|
limit / offset | integer | Pagination (default 20) |
patient_id | string | Filter by patient |
questionnaire_id | string | Filter by questionnaire template |
episode_id | string | Filter by episode |
appointment_id | string | Filter by appointment |
is_pre_booking | string | Filter pre-booking responses |
created_at_gte / created_at_lte | string | Date range filter |
Create a Response
POST /questionnaire-responsesRequired Fields
| Field | Type | Description |
|---|---|---|
questionnaire_id | string | Template ID (must exist for your organisation or be a system template) |
responses | object | Key-value pairs of form answers (must be a JSON object, not array) |
Optional Fields
| Field | Type | Description |
|---|---|---|
patient_id | string | Patient ID |
appointment_id | string | Linked appointment |
episode_id | string | Linked episode |
API-created responses have submitted_by_patient: false automatically. The questionnaire_id must match a template visible to your organisation.
Update a Response
PATCH /questionnaire-responses/{id}Updatable Fields
responses, patient_id, appointment_id, episode_id
Related Resources
- Questionnaire Templates - Form definitions
- Episodes - Clinical workflow episodes
- Patients - Patient records