Jump to

• Request
• Response

Get a list of questionnaire responses

get

/QuestionnaireResponse

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Retrieves a list of questionnaire responses that meet the supplied query parameters.

Request

Query Parameters

• _id: string
  The logical resource ID.
• _revinclude: string
  The related Provenance resources to include in the search bundle.

  Allowed Values: [ "Provenance:target" ]
• patient: string
  The subject (patient) of the questionnaire response.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fullUrl":{
                        "type":"string",
                        "format":"uri"
                    },
                    "resource":{
                        "$ref":"#/components/schemas/QuestionnaireResponse"
                    },
                    "search":{
                        "$ref":"#/components/schemas/Search"
                    }
                }
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fullUrl":{
                "type":"string",
                "format":"uri"
            },
            "resource":{
                "$ref":"#/components/schemas/QuestionnaireResponse"
            },
            "search":{
                "$ref":"#/components/schemas/Search"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleLink"
    }
}

Nested Schema : items

Type: object

Show Source

• fullUrl: string (uri)
• resource: object QuestionnaireResponse
• search: object Search

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string",
            "format":"uri"
        },
        "resource":{
            "$ref":"#/components/schemas/QuestionnaireResponse"
        },
        "search":{
            "$ref":"#/components/schemas/Search"
        }
    }
}

Nested Schema : QuestionnaireResponse

Type: object

Show Source

• author: author
  (USCDI) The person who received and recorded the answers.
• authored(required): string (date-time)
  (USCDI) The date when the answers were gathered.
• id(required): string
• identifier: identifier
  The unique ID for this set of answers.
• item: array item
  (USCDI) The groups and questions.
• questionnaire(required): string
  (USCDI) The form being answered.
• resourceType(required): string
  Allowed Values: [ "QuestionnaireResponse" ]
• status(required): string
  (USCDI) The following values are supported:

  • in-progress
  • completed
  • amended
  • entered-in-error
  • stopped
• subject(required): subject
  (USCDI) The subject of the questions.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "questionnaire",
        "status",
        "subject",
        "authored"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "QuestionnaireResponse"
            ]
        },
        "id":{
            "type":"string"
        },
        "identifier":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Identifier"
                }
            ],
            "description":"The unique ID for this set of answers."
        },
        "questionnaire":{
            "type":"string",
            "description":"(USCDI) The form being answered."
        },
        "status":{
            "type":"string",
            "description":"(USCDI) The following values are supported:\n  <ul>\n    <li><code>in-progress</code></li>\n    <li><code>completed</code></li>\n    <li><code>amended</code></li>\n    <li><code>entered-in-error</code></li>\n    <li><code>stopped</code></li>\n  </ul>\n"
        },
        "subject":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The subject of the questions."
        },
        "authored":{
            "type":"string",
            "format":"date-time",
            "description":"(USCDI) The date when the answers were gathered."
        },
        "author":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The person who received and recorded the answers."
        },
        "item":{
            "type":"array",
            "description":"(USCDI) The groups and questions.",
            "items":{
                "$ref":"#/components/schemas/QuestionnaireResponseItem"
            }
        }
    }
}

Nested Schema : Search

Type: object

Show Source

• mode: string

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string"
        }
    }
}

Nested Schema : author

(USCDI) The person who received and recorded the answers.

Match All

(USCDI) The person who received and recorded the answers.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The person who received and recorded the answers."
}

Nested Schema : identifier

The unique ID for this set of answers.

Match All

The unique ID for this set of answers.

Show Source

• object Identifier

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Identifier"
        }
    ],
    "description":"The unique ID for this set of answers."
}

Nested Schema : item

Type: array

(USCDI) The groups and questions.

Show Source

• Array of: object QuestionnaireResponseItem

{
    "type":"array",
    "description":"(USCDI) The groups and questions.",
    "items":{
        "$ref":"#/components/schemas/QuestionnaireResponseItem"
    }
}

Nested Schema : subject

(USCDI) The subject of the questions.

Match All

(USCDI) The subject of the questions.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The subject of the questions."
}

Nested Schema : Reference

Type: object

Show Source

• reference: string
• type: string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : Identifier

Type: object

Show Source

• system(required): string (uri)
• value(required): string

{
    "type":"object",
    "required":[
        "system",
        "value"
    ],
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : QuestionnaireResponseItem

Type: object

Show Source

• answer: array answer
  The responses to the question.
• item: array item
  The nested questionnaire response items.
• linkId(required): string
  (USCDI) The pointer to a specific item from the questionnaire.
• text: string
  The name for the group or question text.

{
    "type":"object",
    "required":[
        "linkId"
    ],
    "properties":{
        "linkId":{
            "type":"string",
            "description":"(USCDI) The pointer to a specific item from the questionnaire."
        },
        "text":{
            "type":"string",
            "description":"The name for the group or question text."
        },
        "answer":{
            "type":"array",
            "description":"The responses to the question.",
            "items":{
                "$ref":"#/components/schemas/QuestionnaireResponseAnswer"
            }
        },
        "item":{
            "type":"array",
            "description":"The nested questionnaire response items.",
            "items":{
                "$ref":"#/components/schemas/QuestionnaireResponseItem"
            }
        }
    }
}

Nested Schema : answer

Type: array

The responses to the question.

Show Source

• Array of: object QuestionnaireResponseAnswer

{
    "type":"array",
    "description":"The responses to the question.",
    "items":{
        "$ref":"#/components/schemas/QuestionnaireResponseAnswer"
    }
}

Nested Schema : item

Type: array

The nested questionnaire response items.

Show Source

• Array of: object QuestionnaireResponseItem

{
    "type":"array",
    "description":"The nested questionnaire response items.",
    "items":{
        "$ref":"#/components/schemas/QuestionnaireResponseItem"
    }
}

Nested Schema : QuestionnaireResponseAnswer

Type: object

Show Source

• item: array item
  The nested groups and questions.
• valueBoolean: boolean
  (USCDI) The single-valued answer to the question.
• valueCoding: valueCoding
  (USCDI) The single-valued answer to the question.
• valueDate: string (date)
  (USCDI) The single-valued answer to the question.
• valueDateTime: string (date-time)
  (USCDI) The single-valued answer to the question.
• valueDecimal: number
  (USCDI) The single-valued answer to the question.
• valueInteger: integer
  (USCDI) The single-valued answer to the question.
• valueReference: valueReference
  (USCDI) The single-valued answer to the question.
• valueString: string
  (USCDI) The single-valued answer to the question.
• valueTime: string
  (USCDI) The single-valued answer to the question.
• valueUri: string (uri)
  (USCDI) The single-valued answer to the question.

{
    "type":"object",
    "properties":{
        "valueBoolean":{
            "type":"boolean",
            "description":"(USCDI) The single-valued answer to the question."
        },
        "valueDate":{
            "type":"string",
            "format":"date",
            "description":"(USCDI) The single-valued answer to the question."
        },
        "valueDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"(USCDI) The single-valued answer to the question."
        },
        "valueTime":{
            "type":"string",
            "description":"(USCDI) The single-valued answer to the question."
        },
        "valueDecimal":{
            "type":"number",
            "description":"(USCDI) The single-valued answer to the question."
        },
        "valueInteger":{
            "type":"integer",
            "description":"(USCDI) The single-valued answer to the question."
        },
        "valueString":{
            "type":"string",
            "description":"(USCDI) The single-valued answer to the question."
        },
        "valueCoding":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Coding"
                }
            ],
            "description":"(USCDI) The single-valued answer to the question."
        },
        "valueUri":{
            "type":"string",
            "format":"uri",
            "description":"(USCDI) The single-valued answer to the question."
        },
        "valueReference":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The single-valued answer to the question."
        },
        "item":{
            "type":"array",
            "description":"The nested groups and questions.",
            "items":{
                "$ref":"#/components/schemas/QuestionnaireResponseItem"
            }
        }
    }
}

Nested Schema : item

Type: array

The nested groups and questions.

Show Source

• Array of: object QuestionnaireResponseItem

{
    "type":"array",
    "description":"The nested groups and questions.",
    "items":{
        "$ref":"#/components/schemas/QuestionnaireResponseItem"
    }
}

Nested Schema : valueCoding

(USCDI) The single-valued answer to the question.

Match All

(USCDI) The single-valued answer to the question.

Show Source

• object Coding

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Coding"
        }
    ],
    "description":"(USCDI) The single-valued answer to the question."
}

Nested Schema : valueReference

(USCDI) The single-valued answer to the question.

Match All

(USCDI) The single-valued answer to the question.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The single-valued answer to the question."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string (uri)

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]
• url: string (uri)

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ]
        },
        "url":{
            "type":"string",
            "format":"uri"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

Show Source

• issue(required): array issue
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top