Register an Endpoint

Note Only an account administrator can register and publish the endpoints. If you do not have access permissions, contact your account administrator.

Note Before adding your applications and/or endpoints, publish your organization profile.

Before your endpoints can be published, so that vendor applications can send calls to the endpoint, register these endpoints for certification and submit them for review and approval of CAQH/Edifecs. Before you register your endpoint in the CAQH Endpoint Directory, first register CAQH as an application vendor in your OpenID Connect authentication and authorization server that determines your security boundaries, within which you can define your access policies. The CAQH Endpoint Directory acts as a vendor application to test your FHIR endpoints. Once you complete the setup of the test application, you should retrieve the client ID and a secret key from your authorization server.

You, as an administrator, can set up individual test applications for each endpoint and add the test application details for each endpoint after you register a certain endpoint individually. You can also edit the test application details regardless of the endpoint status and even if a certain endpoint has already been published to the Directory.

To set up a test application:

  1. On the My Endpoints page, click Setup Test Application.
  2. In the pane Setup Test Application, in the step 2, enter/update Client ID and Secret Key which you retrieved from your authorization server.
  3. In the step 3, in the fields Auth URL and Access Token URL, enter/update the authorization URL and access token URL that are used by your organization for the endpoints.
  4. In the step 4, next to Test User, click to enter the username and the password of a test user who will be able to access your endpoints.
  5. Click Save.

On the My Endpoints page, you can view the list of all the endpoints created by the users (administrators) of your organization account and the endpoint certification statuses. On this page, you, as an administrator, also can:

  • Create a new endpoint and edit existing endpoints.
  • Submit an endpoint for validation and approval.
  • Delete an existing endpoint.
  • Search for endpoints by the endpoint name.

To register an endpoint:

  1. On the My Endpoints page, click Register Endpoint.
  2. In Register Endpoint, in General Information, provide the following:
    • A name for the endpoint (for example, Patient Access Endpoint) and organization aliases by which your endpoint that belongs to a certain organization can be searched for.
    • A URL to which applications will send the requests (for example, https://fhir.healthplan.com/patient).
    • A Capability Statement URL if required that is an address at which this capability statement is published. The capability statement is a client-facing metadata that describes the capabilities of the endpoint and a set of rules to provide for the resources retrieval.
    • The standard version of the capability statement (DSTU2, DSTU3, R4).
    • Drummond Certificate (optional field). A URL to Drummond Certificate if the endpoint has been certified by Drummond to understand the quality of the endpoint and to view whether this endpoint is interoperable and can ensure automated, reliable interactions and secure exchange of information for electronic healthcare records (EHRs).
    • Organization Aliases. The organization can have several aliases (alternative names) by which your organization can be searched.
    • The organization IDs (mandatory field), such as TIN (mandatory field), TAN, PAN, NPI, and the CAQH organization ID.
    • Line of Business, such as: State Children’s Health Insurance Program, Veterans Affairs Plan, Vision HMO, Commercial, Medicare, Medicaid, and so on.
    • Use Case, such as: Coverage Requirements Discovery, Data Exchange for Quality Measures, Documentation Templates and Coverage Rules, Formulary, Patient Access, Payer-to-Payer Data Exchange, Prior Authorization, Provider Directory.
    • Implementation Guide, such as: Documentation Requirements - Da Vinci Documentation Templates and Rules IG v1.0.0, Formulary - Da Vinci PDex US Drug Formulary IG v1.0.1, Patient Access - US CORE IG v3.2.0, and so on.
    • A brief description for the endpoint (for example, Endpoint to retrieve patient information).
    • Environment: Test, Staging, or Production
    • Status: Draft, Active, Retired, Unknown
    • FHIR version
    • The authorization type the endpoint allows:
    • Basic: To access the endpoint, only user credentials are required.
    • OAuth: The endpoint requires an access token issued by an Authorization server upon successful user authentication.
    • SMART-on-FHIR: The OAuth 2.0-based authorization type that requires additional mandatory claims to be included in the access token (for example, the issuer URL and the list of allowed scopes).
    • Supported resources: the supported resources are automatically populated from the capability statement. You can also manually enter information for each supported resource. To do this, provide the following:
    • The resource name (for example, Patient).
    • Interactions supported by the endpoint.
    • Additional features supported by the endpoint.
    • The policy for handling references
    • Search include
    • Search rev include
    • Search parameters for this resource with a parameter type and description (for example, birthdate - Date/DateTime - The patient's date of birth).

      Note Once added, the supported resources cannot be edited.

  3. In Reference Documents, provide the following:
    • A file with a sample data to be sent in the request body.
    • A file with a sample request string.
    • A file with a sample response returned from the endpoint.
    • A file with instructions containing the information, for example, on scopes that a certain application requests, and other details.
  4. Click Save or Save & Close.

After you have registered the endpoint, the endpoint is required to pass certain test scenarios to be certified by CAQH/Edifecs. You can still submit your endpoint for a review even if the test scenarios have not been added and executed.

After successful validation and approval from the CAQH administrator, your endpoint gets automatically published to the CAQH Endpoint Directory and becomes available for the community.

 

Also, watch the video tutorial available on how to register, validate, and publish your endpoints to the Directory.

 

Discovered Endpoints

The CAQH Endpoint Directory administrators can also create a discovered endpoint. In this case there's no need to submit the endpoint for a review.

All the discovered endpoints are displayed in the Directory on a separate tab Discovered Endpoints.

If a certain discovered endpoint is no longer responding (becomes unvalid), you can remove such an endpoint.