DTR API Endpoint

Accepts a FHIR DTR request and returns a FHIR response.

Use the stage query parameter to select the workflow step. If stage is omitted, the default is questionnaire-package.

Recommended call sequence:

  1. documentation-requirements - Check whether documentation is required for the submitted coverage and order(s).
  2. questionnaire-package - Retrieve PackageBundle containing Questionnare and QuestionnaireResponse.
  3. next-question - Submit an in-progress QuestionnaireResponse to get the next question(s). Repeat until status is completed.
  4. generate-guidance - Submit one or more completed QuestionnaireResponse resources to produce final documentation/guidance.
Query Params
string
enum
Defaults to questionnaire-package

Execution stage. Selects which of the four DTR operations is executed and determines the expected request/response payload shape (see the operation description and the request examples for each stage). This is Optional - when it is not provided, the backend defaults to questionnaire-package.

Allowed:
Body Params

FHIR DTR request payload

FHIR payload, sent as raw JSON text. Shape depends on the stage query parameter: a FHIR Parameters resource (containing coverage + order, coverage + context, or coverage + questionnaire canonical entries) for documentation-requirements and questionnaire-package, a FHIR QuestionnaireResponse resource for next-question, and a FHIR Parameters resource containing one or more questionnaireResponse entries for generate-guidance. Server-side, this is received and passed through as a raw JSON string without deserialization into a typed object.

Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/fhir+json