Post Questionnaire Package

post

https://example.com/priorauth/v1/fhir/2.1/dtr/Questionnaire/$questionnaire-package

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Runs the $questionnaire-package operation against the configured clearinghouse to fetch the Questionnaire, CQL Library, and ValueSet resources needed to complete DTR for a coverage or order. 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.

Body Params

FHIR Parameters resource identifying which coverage, order, and/or questionnaire to fetch the package for. At least one coverage or questionnaire parameter is required by application logic (not by the schema itself).

FHIR Parameters resource passed to the $questionnaire-package operation.

resourceType

string

^Parameters$

Defaults to Parameters

parameter

array of objects

required

length ≥ 1

Defaults to [object Object]

Parameter*

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

`coverage` nor a `questionnaire` parameter was supplied in the request; at least one is required to identify what to retrieve.

`parameter`, or an unsupported parameter `name`).

Post Questionnaire Package

❗️
CAUTION

❗️
IMPORTANT

`coverage` nor a `questionnaire` parameter was supplied in the request; at least one is required to identify what to retrieve.

`parameter`, or an unsupported parameter `name`).

❗️CAUTION

❗️IMPORTANT

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

400Returned when neither a coverage nor a questionnaire parameter was supplied in the request; at least one is required to identify what to retrieve.

422The request body is syntactically valid JSON but fails schema validation (e.g. missing parameter, or an unsupported parameter name).

502Returned when the clearinghouse could not be reached or the request timed out.

defaultAny other status code returned by the clearinghouse (e.g. 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

`coverage` nor a `questionnaire` parameter was supplied in the request; at least one is required to identify what to retrieve.

`parameter`, or an unsupported parameter `name`).