Skip to main content

DTR $log-questionnaire-errors FHIR API Specification

Service Overview

InterSystems DTR (Documentation Template and Rules) FHIR APIs are designed in compliance with the CMS-0057-F regulationsOpens in a new tab.

Refer to the Getting Started section for information on connectivity, authentication and how to get help. To use the FHIR APIs, you will need to know the base URL of the FHIR server you will be connecting to. You can also retrieve the DTR capability statement for the service.

As part of the DTR APIs, a client application can use the $log-questionnaire-errors API to report issues or errors to the originating payer. These issues may arise when working with payer-provided DTR artifacts, such as questionnaires or Clinical Quality Language (CQL) logic.

Workflow

A typical workflow involving the $log-questionnaire-errors operation might be:

  • A provider's electronic health record (EHR) system is configured for DTR application connectivity.

  • The EHR, via the DTR app, uses pre-defined payer information to send a documentation request to the payer.

  • The payer organization returns a bundle of one or more questionnaires.

  • The client application encounters an issue when working with the provided artifacts, such as a Not Found error.

  • The client application uses the $log-questionnaire-errors API to submit the error to the originating payer.

Prerequisites

None.

Endpoint: $log-questionnaire-errors

URL

The URL for this API is either :

<BaseURL>/csp/healthshare/<namespace-identifier>/dtr-v<IG version>/Questionnaire/$log-questionnaire-errors

where <BaseURL> and <namespace-identifier> have been provided to you by the payer organization you are connecting with, and <IG version> is the version number of the DTR Implementation Guide you are working with. For example, this could be version 2.0.1 or version 2.1.0.

Optional Capabilities

None.

Endpoint Prerequisites

None.

Required Header Settings

  • Content-Type: application/fhir+json

  • Accept: application/fhir+json

Request Methods

POST <BaseURL>/csp/healthshare/<namespace-identifier>/dtr-v<IG version>/Questionnaire/$log-questionnaire-errors

Invokes $log-questionnaire-errors for a specified questionnaire in the request body.

Query Parameters

None.

Request Body

The request body should follow the $log-questionnaire-errors Input Parameters exampleOpens in a new tab (version 2.1.0 link) resource profile. It should include a Questionnaire resource and an OperationOutcome resource that documents the errors encountered. For example:

{
  "resourceType": "Parameters",
  "id": "LogQuestionnaireErrorsInputParamsExample",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/us/davinci-dtr/StructureDefinition/dtr-log-errors-input-parameters"
    ]
  },
  "parameter": [
    {
      "name": "questionnaire",
      "valueCanonical": "http://hl7.org/fhir/us/davinci-dtr/Questionnaire/home-o2-std-questionnaire"
    },
    {
      "name": "operationOutcome",
      "resource": {
        "resourceType": "OperationOutcome",
        "id": "OperationOutcomeExample",
        "issue": [
          {
            "severity": "error",
            "code": "not-found"
          }
        ]
      }
    }
  ]
}

Success Responses

Status code 200

The request succeeded. There is no response body.

Error Responses

The following response error codes are possible when using the $log-questionnaire-errors operation:

Status code 400 Bad Request

Possible causes include:

  • Request body is empty.

  • Invalid JSON structure.

Status code 401 Unauthorized

The bearer token used for authentication failed validation. Possible causes include

  • Token expired.

Status code 403 Forbidden

Possible causes include:

  • Token does not include required OAuth scopes.

Status code 404 Not Found

Possible causes include:

  • Request was sent to an incorrect API endpoint URL.

Status code 406 Not Acceptable

Possible causes include:

  • Accept header does not include application/fhir+json.

Status code 415 Unsupported Media Type

Possible causes include:

  • Content-Type header is not application/fhir+json.

Status code 500 Internal Server Error

A generic error message, returned when no more specific message is suitable.

Status code 503 Service unavailable

Possible causes include:

  • The endpoint is not properly set or does not return a response.

Status code 504 Gateway Timeout

Possible causes include:

  • Downstream processing exceeded the configured timeout.

FeedbackOpens in a new tab