Get Questionnaire Response

get

https://example.com/priorauth/v1/fhir/2.1/dtr/QuestionnaireResponse/{qr_id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Retrieves a previously submitted QuestionnaireResponse from the configured clearinghouse. No application-level authentication is implemented by this route today.

❗️
CAUTION
Please do not submit PHI or PII data in the TryIt! interface (sandbox environment).

❗️
IMPORTANT
Please note that unlike the previous X12 example, the JSON request requires you to provide all the required field values. Please note that these required values are GREYED out, which are pre-populated example values and can be selected to view their respective canned response. To view the required fields, expand the + symbol highlighted in dark blue in the following figure (also shown in the preceding request example). For more information, please refer to the JSON-to-EDI Content section.

See Parameters and descriptions.
See API Examples Documentation Templates and Rules.
See Test/Try Our APIs.

Path Params

qr_id

string

required

^[A-Za-z0-9\-.]{1,64}$

Logical id of the QuestionnaireResponse to retrieve. Only letters, digits, hyphens, and dots are accepted (max 64 chars) — anything else is rejected before any upstream call is made.

Headers

x-mock-scenario

string | null

Optional scenario name forwarded to the clearinghouse to select a canned response in non-production environments.

x-chng-trace-id

string | null

Optional client-supplied correlation identifier, preferred over x-optum-trace-id when both are present.

x-optum-trace-id

string | null

Optional client-supplied correlation identifier used to trace the request across systems. The resolved trace id (inbound or generated) is echoed back on this same header in the response.

string

enum

Defaults to application/fhir+json

Generated from available response content types

Allowed:

Responses

Get Questionnaire Response

❗️
CAUTION

❗️
IMPORTANT

❗️CAUTION

❗️IMPORTANT

200The clearinghouse returned the requested QuestionnaireResponse. The response body is passed back exactly as received from the clearinghouse; the QuestionnaireResponse schema below describes the expected FHIR shape.

502Returned when the supplied identifier is not in a valid format, or when the clearinghouse could not be reached or timed out. The error body is a simple message rather than a FHIR OperationOutcome resource.

defaultAny other status code returned by the clearinghouse (e.g. 400, 404, 500) is passed back to the caller exactly as received, without modification. The trace id is always included in the response headers.

❗️
CAUTION

❗️
IMPORTANT