Skip to main content

CRD Discovery FHIR API Specification

Overview

As part of the InterSystems® Payer Services CRD (Coverage Requirements Discovery) APIs, a provider can use the Discovery endpoint to determine information necessary to submit a CRD query, including:

  • The identifier for the appropriate CRD service, which is used to construct the service’s endpoint URL.

  • When in the provider workflow the service should be invoked.

  • The HL7® FHIR® resource data that the service requires in order to respond to a query.

  • Configuration optionsOpens in a new tab for the service, where available.

The CRD 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 these APIs, you will need to know the base URL of the payer server that you will be connecting to. You can also retrieve the capability statement for the CRD APIs.

Workflow

A typical CRD Discovery workflow is as follows:

  • The provider’s system sends an authorized GET request to the discovery endpoint.

  • The payer's system returns a CDS Discovery ResponseOpens in a new tab which contains information about the available CRD services.

  • The provider's system uses the information from the Discovery Response to construct and submit a query to a CRD service at the appropriate point in the workflow.

Endpoint

URL

The URL for this API is:

<BaseURL>/cds-services

Optional Capabilities

None.

Endpoint Prerequisites

None.

Required Header Settings

  • Accept: application/json+fhir

Request Methods

GET <BaseURL>/cds-services

Requests a CDS Discovery ResponseOpens in a new tab from the payer’s system. This response includes an array of JSON objects which describe each CRD service that is currently available on the payer system. The information in a service’s description is used to construct a CRD Service API request to that service.

Query Parameters

None.

Request Body

None.

Success Response

Status code 200

The request succeeded. The body of the response is a CDS Hooks Discovery ResponseOpens in a new tab. If the request succeeded but no CRD services are available, the response body contains an empty services array.

Error Responses

Status code 400 Error

Error when validating the service request.

Status code 401 Unauthorized

The bearer token used for authentication failed validation.

Status code 500 Internal Server Error

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

FeedbackOpens in a new tab