QuestionnaireResponse _search

post/QuestionnaireResponse/_search

Page View

This resource contains a healthcare questionnaire either fully or partially populated with answers. The questionnaire order and groupings are typically defined with a Questionnaire resource.

You can review or retrieve healthcare questionnaire responses.

Supported fields and schema examples

We support any valid FHIR® field. However, we only display fields we’ve defined in our schema, which are usually based on what’s included in the U.S. Core profile. We recommend relying on U.S. Core requirements.

Our schema examples show the shape and possibility of each FHIR® resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. Consider reviewing FHIR® API actions for realistic examples for particular use cases.

_search

Query for a list of questionnaires that are filled, or partially filled.

Flexible FHIR queries, different query parameters

FHIR® queries are a flexible option with parameters to refine your search. The response returns a bundle of resources, known as a searchset bundle type. Learn about bundles and bundle types in our FHIR® glossary.

We only note which query parameters are required if you're querying a FHIR® server directly. Remember that Redox (i.e., data on demand) isn't a FHIR® server, and your connection may not be either.

Query parameters will vary between sites. Work with your connection to find out which query parameters they require for a successful search.

Request parameters and payload

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/QuestionnaireResponse/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode 'author=string' \
6
--data-urlencode 'authored=string' \
7
--data-urlencode 'identifier=string' \
8
--data-urlencode 'item-subject=string' \
9
--data-urlencode 'item-subject.identifier=string' \
10
--data-urlencode 'questionnaire=string' \
11
--data-urlencode 'status=string' \
12
--data-urlencode 'subject=string' \
13
--data-urlencode 'subject.identifier=string'

Request Body Schema

author
Array of string
The author of the questionnaire response
authored
Array of string
When the questionnaire response was last changed
identifier
Array of string
The identifier of the questionnaire
item-subject
Array of string
The subject of the questionnaire response
item-subject.identifier
Array of string
One or more external identifiers for the patient
questionnaire
Array of string
The questionnaire that was answered
status
Array of string
The status of the questionnaire response
subject
Array of string
The subject of the questionnaire response
subject.identifier
Array of string
One or more external identifiers for the patient

Response fields and example

Example payload generated from schema

1
{
2
  "resourceType": "Bundle",
3
  "type": "searchset",
4
  "total": 1,
5
  "entry": [
6
    {
7
      "resource": {
8
        "resourceType": "QuestionnaireResponse",
9
        "id": "redox-questionnaire-response-example",
10
        "questionnaire": "https://fhir.redoxengine.com/Questionnaire/patient-intake-questionnaire",
11
        "status": "completed",
12
        "subject": {
13
          "reference": "Patient/example"
14
        },
15
        "authored": "2025-03-27T10:00:00Z",
16
        "item": [
17
          {
18
            "linkId": "LittleInterest",
19
            "text": "Little interest or pleasure in doing things",
20
            "answer": [
21
              {
22
                "valueCoding": {
23
                  "system": "http://loinc.org",
24
                  "code": "LA6568-5"
25
                }
26
              }
27
            ]
28
          },
29
          {
30
            "linkId": "FeelingDown",
31
            "text": "Feeling down, depressed, or hopeless",
32
            "answer": [
33
              {
34
                "valueCoding": {
35
                  "system": "http://loinc.org",
36
                  "code": "LA6568-5"
37
                }
38
              }
39
            ]
40
          },
41
          {
42
            "linkId": "TroubleSleeping",
43
            "text": "Trouble falling or staying asleep",
44
            "answer": [
45
              {
46
                "valueCoding": {
47
                  "system": "http://loinc.org",
48
                  "code": "LA6570-1"
49
                }
50
              }
51
            ]
52
          },
53
          {
54
            "linkId": "FeelingTired",
55
            "text": "Feeling tired or having little energy",
56
            "answer": [
57
              {
58
                "valueCoding": {
59
                  "system": "http://loinc.org",
60
                  "code": "LA6571-3"
61
                }
62
              }
63
            ]
64
          },
65
          {
66
            "linkId": "BadAppetite",
67
            "text": "Poor appetite or overeating",
68
            "answer": [
69
              {
70
                "valueCoding": {
71
                  "system": "http://loinc.org",
72
                  "code": "LA6568-5"
73
                }
74
              }
75
            ]
76
          },
77
          {
78
            "linkId": "FeelingBadAboutSelf",
79
            "text": "Feeling bad about yourself - or that you are a failure or have let yourself or your family down",
80
            "answer": [
81
              {
82
                "valueCoding": {
83
                  "system": "http://loinc.org",
84
                  "code": "LA6569-3"
85
                }
86
              }
87
            ]
88
          },
89
          {
90
            "linkId": "TroubleConcentrating",
91
            "text": "Trouble concentrating on things, such as reading the newspaper or watching television",
92
            "answer": [
93
              {
94
                "valueCoding": {
95
                  "system": "http://loinc.org",
96
                  "code": "LA6570-1"
97
                }
98
              }
99
            ]
100
          },
101
          {
102
            "linkId": "MovingSpeaking",
103
            "text": "Moving or speaking so slowly that other people could have noticed. Or the opposite - being so fidgety or restless that you have been moving around a lot more than usual",
104
            "answer": [
105
              {
106
                "valueCoding": {
107
                  "system": "http://loinc.org",
108
                  "code": "LA6568-5"
109
                }
110
              }
111
            ]
112
          },
113
          {
114
            "linkId": "TotalScore",
115
            "text": "Total score",
116
            "answer": [
117
              {
118
                "valueInteger": 10
119
              }
120
            ]
121
          },
122
          {
123
            "linkId": "Difficulty",
124
            "text": "If you checked off any problems, how difficult have these problems made it for you to do your work, take care of things at home, or get along with other people",
125
            "answer": [
126
              {
127
                "valueCoding": {
128
                  "system": "http://loinc.org",
129
                  "code": "LA6570-1"
130
                }
131
              }
132
            ]
133
          }
134
        ]
135
      },
136
      "search": {
137
        "mode": "match"
138
      }
139
    }
140
  ]
141
}

Response to a QuestionnaireResponse search operation

resourceType
required, string
Identifies the type of the resource
Value: Bundle
type
required, string
Identifies this bundle as a response to a search
Value: searchset
total
required, number
The total number of matches
entry
Array of QuestionnaireResponse or Other
A resource matching the search criteria or related to a matching resource

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.