Questionnaire _search

post/Questionnaire/_search

Page View

This resource contains a list of questions used to gather information from a patient, provider, or other individual during a patient's course of treatment. The questions may be grouped or listed in a particular order, as well as include any instructional text.

Any answers to the questions are provided with the QuestionnaireResponse resource.

You can review or retrieve healthcare questionnaires.

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 patient or provider questionnaire from one organization.

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}/Questionnaire/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode 'date=string' \
6
--data-urlencode 'description=string' \
7
--data-urlencode 'effective=string' \
8
--data-urlencode 'identifier=string' \
9
--data-urlencode 'item-code=string' \
10
--data-urlencode 'name=string' \
11
--data-urlencode 'publisher=string' \
12
--data-urlencode 'questionnaire-code=string' \
13
--data-urlencode 'status=string' \
14
--data-urlencode 'title=string'

Request Body Schema

date
Array of string
The questionnaire publication date
description
Array of string
The description of the questionnaire
effective
Array of string
The effective period of the questionnaire
identifier
Array of string
The identifier of the questionnaire
item-code
Array of string
A code that corresponds to an item in the questionnaire
name
Array of string
The name of the questionnaire
publisher
Array of string
The publisher of the questionnaire
questionnaire-code
Array of string
A code that identifies the questionnaire
status
Array of string
The status of the questionnaire
title
Array of string
The title of the questionnaire

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": "Questionnaire",
9
        "id": "patient-intake-questionnaire",
10
        "identifier": [
11
          {
12
            "use": "official",
13
            "system": "http://example.org/questionnaire-identifier",
14
            "value": "phq-9"
15
          }
16
        ],
17
        "status": "draft",
18
        "date": "2025-03-27T00:00:00Z",
19
        "publisher": "Good Health Clinics",
20
        "subjectType": [
21
          "Patient"
22
        ],
23
        "item": [
24
          {
25
            "linkId": "LittleInterest",
26
            "code": [
27
              {
28
                "system": "http://loinc.org",
29
                "code": "44250-9"
30
              }
31
            ],
32
            "text": "Little interest or pleasure in doing things",
33
            "type": "choice",
34
            "required": true,
35
            "answerValueSet": "http://loinc.org/vs/LL358-3"
36
          },
37
          {
38
            "linkId": "FeelingDown",
39
            "code": [
40
              {
41
                "system": "http://loinc.org",
42
                "code": "44255-8"
43
              }
44
            ],
45
            "text": "Feeling down, depressed, or hopeless",
46
            "type": "choice",
47
            "required": true,
48
            "answerValueSet": "http://loinc.org/vs/LL358-3"
49
          },
50
          {
51
            "linkId": "TroubleSleeping",
52
            "code": [
53
              {
54
                "system": "http://loinc.org",
55
                "code": "44259-0"
56
              }
57
            ],
58
            "text": "Trouble falling or staying asleep",
59
            "type": "choice",
60
            "required": true,
61
            "answerValueSet": "http://loinc.org/vs/LL358-3"
62
          },
63
          {
64
            "linkId": "FeelingTired",
65
            "code": [
66
              {
67
                "system": "http://loinc.org",
68
                "code": "44254-1"
69
              }
70
            ],
71
            "text": "Feeling tired or having little energy",
72
            "type": "choice",
73
            "required": true,
74
            "answerValueSet": "http://loinc.org/vs/LL358-3"
75
          },
76
          {
77
            "linkId": "BadAppetite",
78
            "code": [
79
              {
80
                "system": "http://loinc.org",
81
                "code": "44251-7"
82
              }
83
            ],
84
            "text": "Poor appetite or overeating",
85
            "type": "choice",
86
            "required": true,
87
            "answerValueSet": "http://loinc.org/vs/LL358-3"
88
          },
89
          {
90
            "linkId": "FeelingBadAboutSelf",
91
            "code": [
92
              {
93
                "system": "http://loinc.org",
94
                "code": "44258-2"
95
              }
96
            ],
97
            "text": "Feeling bad about yourself - or that you are a failure or have let yourself or your family down",
98
            "type": "choice",
99
            "required": true,
100
            "answerValueSet": "http://loinc.org/vs/LL358-3"
101
          },
102
          {
103
            "linkId": "TroubleConcentrating",
104
            "code": [
105
              {
106
                "system": "http://loinc.org",
107
                "code": "44252-5"
108
              }
109
            ],
110
            "text": "Trouble concentrating on things, such as reading the newspaper or watching television",
111
            "type": "choice",
112
            "required": true,
113
            "answerValueSet": "http://loinc.org/vs/LL358-3"
114
          },
115
          {
116
            "linkId": "MovingSpeaking",
117
            "code": [
118
              {
119
                "system": "http://loinc.org",
120
                "code": "44253-3"
121
              }
122
            ],
123
            "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",
124
            "type": "choice",
125
            "required": true,
126
            "answerValueSet": "http://loinc.org/vs/LL358-3"
127
          },
128
          {
129
            "linkId": "TotalScore",
130
            "code": [
131
              {
132
                "system": "http://loinc.org",
133
                "code": "44261-6"
134
              }
135
            ],
136
            "text": "Total score",
137
            "type": "integer",
138
            "required": true
139
          },
140
          {
141
            "linkId": "Difficulty",
142
            "code": [
143
              {
144
                "system": "http://loinc.org",
145
                "code": "44256-6"
146
              }
147
            ],
148
            "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",
149
            "type": "choice",
150
            "required": true,
151
            "answerValueSet": "http://loinc.org/vs/LL358-3"
152
          }
153
        ]
154
      },
155
      "search": {
156
        "mode": "match"
157
      }
158
    }
159
  ]
160
}

Response to a Questionnaire 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 Questionnaire 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®.