Contact Free trial Login

CAQH Connector Reference

The main class of an extension, is the entry point from which configurations, connection providers, operations and sources are going to be declared.

Configurations


Config

Default configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Address

String

x

Version

String

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when it sees fit.

Connection Types

Connection

This class (as it's name implies) provides connection instances and the funcionality to disconnect and validate those connections. All connection related parameters (values required to create a connection) must be declared in the connection providers. This particular example is a PoolingConnectionProvider which declares that connections resolved by this provider will be pooled and reused. There are other implementations like CachedConnectionProvider which lazily creates and caches connections or simply ConnectionProvider if you want a new connection each time something requires one.

Parameters
Name Type Description Default Value Required

Username

String

x

Password

String

x

Use Persistent Connections

Boolean

If false, each connection will be closed after the first request is completed.

true

Max Connections

Number

The maximum number of outbound connections that will be kept open at the same time. By default the number of connections is unlimited.

-1

Connection Idle Timeout

Number

The number of milliseconds that a connection can remain idle before it is closed. The value of this attribute is only used when persistent connections are enabled.

60000

Stream Response

Boolean

Whether or not received responses should be streamed, meaning processing will continue as soon as all headers are parsed and the body streamed as it arrives. When enabled, the response MUST be eventually read since depending on the configured buffer size it may not fit into memory and processing will stop until space is available.

false

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response will be stored.

-1

Connection Timeout

Number

60000

TLS Configuration

TLS

Protocol to use for communication. Valid values are HTTP and HTTPS. Default value is HTTP. When using HTTPS the HTTP communication is going to be secured using TLS / SSL. If HTTPS was configured as protocol then the user needs to configure at least the keystore in the tls:context child element of this listener-config.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn't pass after exhausting the associated reconnection strategy

Operations

Add Providers - DirectAssure

<caqh:add-to-roster-request-da>

A partner organization (PO) can add one or more providers to the roster by submitting a call to the API. For this there are different required and optional fields for the Quick Add verses the Initial Add. Returns the batch_id that is generated on successful addition of providers on the roster.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Add To DA Bodies

List of providers to be added to roster

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CAQH:METHOD_NOT_ALLOWED

  • CAQH:INTERNAL_SERVER_ERROR

  • CAQH:NOT_ACCEPTABLE

  • CAQH:REQUEST_TIMEOUT

  • CAQH:GENERIC_EXCEPTION

  • CAQH:BAD_GATEWAY

  • CAQH:NOT_IMPLEMENTED

  • CAQH:RETRY_EXHAUSTED

  • CAQH:EMPTY_HEAD_COUNT

  • CAQH:CONFLICT

  • CAQH:SERVICE_UNAVAILABLE

  • CAQH:DEAD_TOKEN

  • CAQH:BAD_REQUEST

  • CAQH:FORBIDDEN

  • CAQH:UNAUTHORIZED

  • CAQH:NOT_FOUND

  • CAQH:CONNECTIVITY

Add Providers - ProView

<caqh:add-to-roster-request-pv>

A PO can add one or more providers to the roster by submitting a call to the API. For this there are different required and optional fields for the Quick Add verses the Initial Add. This method returns the batch_id that is generated on successful addition of Providers on roster.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Add Request Bodies

List of providers to be added to Roster.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CAQH:METHOD_NOT_ALLOWED

  • CAQH:INTERNAL_SERVER_ERROR

  • CAQH:NOT_ACCEPTABLE

  • CAQH:REQUEST_TIMEOUT

  • CAQH:GENERIC_EXCEPTION

  • CAQH:BAD_GATEWAY

  • CAQH:NOT_IMPLEMENTED

  • CAQH:RETRY_EXHAUSTED

  • CAQH:EMPTY_HEAD_COUNT

  • CAQH:CONFLICT

  • CAQH:SERVICE_UNAVAILABLE

  • CAQH:DEAD_TOKEN

  • CAQH:BAD_REQUEST

  • CAQH:FORBIDDEN

  • CAQH:UNAUTHORIZED

  • CAQH:NOT_FOUND

  • CAQH:CONNECTIVITY

Delete Providers - ProView (POST)

<caqh:delete-from-proview-api>

Method to delete one or more providers from the roster using POST. Returns the batch_id that is generated on successful deletion of Providers from roster.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Delete Proview Bodies

List of providers to be deleted from Proview.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CAQH:RETRY_EXHAUSTED

  • CAQH:CONNECTIVITY

Delete Providers - DirectAssure (POST)

<caqh:delete-from-proview-api-da>

Method to delete one or more providers from the roster. Returns the batch_id that is generated on successful deletion of Providers from roster.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Delete DA By Post Bodies

List of providers to be deleted from Proview.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CAQH:METHOD_NOT_ALLOWED

  • CAQH:INTERNAL_SERVER_ERROR

  • CAQH:NOT_ACCEPTABLE

  • CAQH:REQUEST_TIMEOUT

  • CAQH:GENERIC_EXCEPTION

  • CAQH:BAD_GATEWAY

  • CAQH:NOT_IMPLEMENTED

  • CAQH:RETRY_EXHAUSTED

  • CAQH:EMPTY_HEAD_COUNT

  • CAQH:CONFLICT

  • CAQH:SERVICE_UNAVAILABLE

  • CAQH:DEAD_TOKEN

  • CAQH:BAD_REQUEST

  • CAQH:FORBIDDEN

  • CAQH:UNAUTHORIZED

  • CAQH:NOT_FOUND

  • CAQH:CONNECTIVITY

Delete Providers - DirectAssure (PUT)

<caqh:delete-from-roster-request-da-by-put-request>

Method to delete one or more providers from the roster. Returns the batch_id that is generated on successful deletion of Providers from roster.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Delete DA By Put Bodies

List of providers to be deleted from the roster

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CAQH:METHOD_NOT_ALLOWED

  • CAQH:INTERNAL_SERVER_ERROR

  • CAQH:NOT_ACCEPTABLE

  • CAQH:REQUEST_TIMEOUT

  • CAQH:GENERIC_EXCEPTION

  • CAQH:BAD_GATEWAY

  • CAQH:NOT_IMPLEMENTED

  • CAQH:RETRY_EXHAUSTED

  • CAQH:EMPTY_HEAD_COUNT

  • CAQH:CONFLICT

  • CAQH:SERVICE_UNAVAILABLE

  • CAQH:DEAD_TOKEN

  • CAQH:BAD_REQUEST

  • CAQH:FORBIDDEN

  • CAQH:UNAUTHORIZED

  • CAQH:NOT_FOUND

  • CAQH:CONNECTIVITY

Delete Providers - ProView (PUT)

<caqh:delete-from-roster-request-pv>

Method to delete one or more providers from the roster using PUT. Returns the batch_id that is generated on successful deletion of Providers from roster.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Delete Request Bodies

List of providers to be deleted from Roster.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CAQH:RETRY_EXHAUSTED

  • CAQH:CONNECTIVITY

Get Provider Credentials

<caqh:get-provider-credentials>

This method returns the xml response received by Credentialing API web service which is used by Participating Organizations to access real-time provider data from CAQH ProView. Before requesting the Credentialing API access, POs should have a business case and an existing application with which to consume and use the web service. The credentialing API is designed to accept one CAQH Provider ID at a time and disseminate information for that provider based on other parameters provided in the API call. The Credentialing API service will return provider data only if it satisfies all of the following criteria:

  1. Provider application status is Complete.

  2. Provider has Authorized the Participating Organization to see their information. participating organization roster status of the provider is active. Data will be filtered based on Delegated/Non-Delegated and Participating/Non-Participating relationships between the participating organization and the requested provider.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Caqh Provider Id

String

CAQH assigned provider Identifier.

x

Organization Id

String

Participating Organization Identifier.

x

Attestation Date

String

Date on which provider was last first attested.Required (Only within the past 3 years).

x

Credential Section

String

(Optional) If not specified, the service will return all sections.

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CAQH:METHOD_NOT_ALLOWED

  • CAQH:INTERNAL_SERVER_ERROR

  • CAQH:NOT_ACCEPTABLE

  • CAQH:REQUEST_TIMEOUT

  • CAQH:GENERIC_EXCEPTION

  • CAQH:BAD_GATEWAY

  • CAQH:NOT_IMPLEMENTED

  • CAQH:RETRY_EXHAUSTED

  • CAQH:EMPTY_HEAD_COUNT

  • CAQH:CONFLICT

  • CAQH:SERVICE_UNAVAILABLE

  • CAQH:DEAD_TOKEN

  • CAQH:BAD_REQUEST

  • CAQH:FORBIDDEN

  • CAQH:UNAUTHORIZED

  • CAQH:NOT_FOUND

  • CAQH:CONNECTIVITY

Get Provider Documents

<caqh:get-provider-document>

This method returns the PDF document in response to request that allows a participating organization to retrieve a provider’s supporting document The supporting documents will be returned only if the following are true:

  1. The requesting user’s associated PO ID matches with the incoming PO ID, or if the incoming is the child of the user’s associated PO ID.

  2. The provider is on the participating organization’s roster.

  3. The provider has given authorization to the participating organization.

  4. The provider’s CAQH ProView data profile is in a complete status, e.g. Initial Profile Complete or Re-attestation. If these criteria are not satisfied then the supporting document for that CAQH Provider ID is not be returned and the appropriate response code is be supplied.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Caqh Provider_id

String

CAQH assigned provider Identifier.

x

Organization_id

String

Participating Organization Identifier.

x

Doc_ Type

String

Single Supporting Document Type.

x

Output Mime Type

String

The mime type of the payload that this operation outputs.

Output Encoding

String

The encoding of the payload that this operation outputs.

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

For Configurations

Throws

  • CAQH:METHOD_NOT_ALLOWED

  • CAQH:INTERNAL_SERVER_ERROR

  • CAQH:NOT_ACCEPTABLE

  • CAQH:REQUEST_TIMEOUT

  • CAQH:GENERIC_EXCEPTION

  • CAQH:BAD_GATEWAY

  • CAQH:NOT_IMPLEMENTED

  • CAQH:RETRY_EXHAUSTED

  • CAQH:EMPTY_HEAD_COUNT

  • CAQH:CONFLICT

  • CAQH:SERVICE_UNAVAILABLE

  • CAQH:DEAD_TOKEN

  • CAQH:BAD_REQUEST

  • CAQH:FORBIDDEN

  • CAQH:UNAUTHORIZED

  • CAQH:NOT_FOUND

  • CAQH:CONNECTIVITY

Get Provider Status - DirectAssure

<caqh:get-provider-status-da>

The DirectAssure Status Check API web service can be used by Participating Organizations to view the status of providers in CAQH ProView. Before requesting DirectAssure Status Check API access, partner organizations should have a business case and an existing application with which to consume and use the web service. The DirectAssure Status Check API accepts one provider at a time.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Organization_ Id

String

Participating organization identifier

x

Caqh_ Provider_ Id

String

CAQH assigned provider identifier

x

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Get Provider Status DTO

Attributes Type

For Configurations

Throws

  • CAQH:METHOD_NOT_ALLOWED

  • CAQH:INTERNAL_SERVER_ERROR

  • CAQH:NOT_ACCEPTABLE

  • CAQH:REQUEST_TIMEOUT

  • CAQH:GENERIC_EXCEPTION

  • CAQH:BAD_GATEWAY

  • CAQH:NOT_IMPLEMENTED

  • CAQH:RETRY_EXHAUSTED

  • CAQH:EMPTY_HEAD_COUNT

  • CAQH:CONFLICT

  • CAQH:SERVICE_UNAVAILABLE

  • CAQH:DEAD_TOKEN

  • CAQH:BAD_REQUEST

  • CAQH:FORBIDDEN

  • CAQH:UNAUTHORIZED

  • CAQH:NOT_FOUND

  • CAQH:CONNECTIVITY

Get Provider Status - ProView

<caqh:get-provider-status-proview>

The ProView Status Check API web service can be used by Participating Organizations to view the status of providers in CAQH ProView. Before requesting ProView Status Check API access, POs should have a business case and an existing application with which to consume and use the web service. The ProView Status Check API accepts one provider at a time. This method returns a JSON response with the status of provider or indicate that a provider could not be found with Provider_Found_Flag equal to N.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Organization_ Id

String

Participating Organization Identifier.

x

Caqh_ Provider_ Id

String

CAQH assigned provider Identifier.

x

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Get Provider Status DTO

Attributes Type

For Configurations

Throws

  • CAQH:METHOD_NOT_ALLOWED

  • CAQH:INTERNAL_SERVER_ERROR

  • CAQH:NOT_ACCEPTABLE

  • CAQH:REQUEST_TIMEOUT

  • CAQH:GENERIC_EXCEPTION

  • CAQH:BAD_GATEWAY

  • CAQH:NOT_IMPLEMENTED

  • CAQH:RETRY_EXHAUSTED

  • CAQH:EMPTY_HEAD_COUNT

  • CAQH:CONFLICT

  • CAQH:SERVICE_UNAVAILABLE

  • CAQH:DEAD_TOKEN

  • CAQH:BAD_REQUEST

  • CAQH:FORBIDDEN

  • CAQH:UNAUTHORIZED

  • CAQH:NOT_FOUND

  • CAQH:CONNECTIVITY

Get Status - Add to Roster

<caqh:get-result-of-add-request>

Method to get the status of a previous Add to Roster request, and the results if the request is complete. If a provider is unable to be added to the roster due to an Exception, then the Exception_Description field contains a value and the identifying fields submitted in the Add to Roster Web Service is returned instead of the values from the system.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Batch_id

String

System-generated unique Batch ID from ADD request.

x

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Get Add Status DTO

Attributes Type

For Configurations

Throws

  • CAQH:METHOD_NOT_ALLOWED

  • CAQH:INTERNAL_SERVER_ERROR

  • CAQH:NOT_ACCEPTABLE

  • CAQH:REQUEST_TIMEOUT

  • CAQH:GENERIC_EXCEPTION

  • CAQH:BAD_GATEWAY

  • CAQH:NOT_IMPLEMENTED

  • CAQH:RETRY_EXHAUSTED

  • CAQH:EMPTY_HEAD_COUNT

  • CAQH:CONFLICT

  • CAQH:SERVICE_UNAVAILABLE

  • CAQH:DEAD_TOKEN

  • CAQH:BAD_REQUEST

  • CAQH:FORBIDDEN

  • CAQH:UNAUTHORIZED

  • CAQH:NOT_FOUND

  • CAQH:CONNECTIVITY

Get Status - Delete from Roster

<caqh:get-result-of-delete-request>

GET request to receive the status of a previous Delete from Roster request, and the results if the request is complete. If a provider is unable to be deleted from the roster due to an exception, then the Delete_Description field contains the exception.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Batch_id

String

System-generated unique Batch ID from UPDATE request.

x

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Get Delete Result DTO

Attributes Type

For Configurations

Throws

  • CAQH:METHOD_NOT_ALLOWED

  • CAQH:INTERNAL_SERVER_ERROR

  • CAQH:NOT_ACCEPTABLE

  • CAQH:REQUEST_TIMEOUT

  • CAQH:GENERIC_EXCEPTION

  • CAQH:BAD_GATEWAY

  • CAQH:NOT_IMPLEMENTED

  • CAQH:RETRY_EXHAUSTED

  • CAQH:EMPTY_HEAD_COUNT

  • CAQH:CONFLICT

  • CAQH:SERVICE_UNAVAILABLE

  • CAQH:DEAD_TOKEN

  • CAQH:BAD_REQUEST

  • CAQH:FORBIDDEN

  • CAQH:UNAUTHORIZED

  • CAQH:NOT_FOUND

  • CAQH:CONNECTIVITY

Get Status - Update to Roster

<caqh:get-result-of-update-request>

GET request to receive the status of a previous Update on Roster request, and the results if the request is complete. If a provider is unable to be updated on the roster due to an exception, then the Update_Description field contains the exception.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Batch_id

String

System-generated unique Batch ID from UPDATE request.

x

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Get Update Result DTO

Attributes Type

For Configurations

Throws

  • CAQH:METHOD_NOT_ALLOWED

  • CAQH:INTERNAL_SERVER_ERROR

  • CAQH:NOT_ACCEPTABLE

  • CAQH:REQUEST_TIMEOUT

  • CAQH:GENERIC_EXCEPTION

  • CAQH:BAD_GATEWAY

  • CAQH:NOT_IMPLEMENTED

  • CAQH:RETRY_EXHAUSTED

  • CAQH:EMPTY_HEAD_COUNT

  • CAQH:CONFLICT

  • CAQH:SERVICE_UNAVAILABLE

  • CAQH:DEAD_TOKEN

  • CAQH:BAD_REQUEST

  • CAQH:FORBIDDEN

  • CAQH:UNAUTHORIZED

  • CAQH:NOT_FOUND

  • CAQH:CONNECTIVITY

Update Providers - DirectAssure (POST)

<caqh:update-to-proview-api-da>

Method to update one or more providers existing on roster. Returns the batch_id that is generated on successful update of providers on the roster.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Update DA By Post Requests

List of providers to be updated in ProView

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CAQH:METHOD_NOT_ALLOWED

  • CAQH:INTERNAL_SERVER_ERROR

  • CAQH:NOT_ACCEPTABLE

  • CAQH:REQUEST_TIMEOUT

  • CAQH:GENERIC_EXCEPTION

  • CAQH:BAD_GATEWAY

  • CAQH:NOT_IMPLEMENTED

  • CAQH:RETRY_EXHAUSTED

  • CAQH:EMPTY_HEAD_COUNT

  • CAQH:CONFLICT

  • CAQH:SERVICE_UNAVAILABLE

  • CAQH:DEAD_TOKEN

  • CAQH:BAD_REQUEST

  • CAQH:FORBIDDEN

  • CAQH:UNAUTHORIZED

  • CAQH:NOT_FOUND

  • CAQH:CONNECTIVITY

Update Providers - DirectAssure (PUT)

<caqh:update-to-roster-request-da-by-put-request>

Method to update one or more providers existing on roster. Returns the batch_id that is generated on successful update of providers on the roster.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Update DA By Put Requests

List of providers to be updated in roster

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CAQH:METHOD_NOT_ALLOWED

  • CAQH:INTERNAL_SERVER_ERROR

  • CAQH:NOT_ACCEPTABLE

  • CAQH:REQUEST_TIMEOUT

  • CAQH:GENERIC_EXCEPTION

  • CAQH:BAD_GATEWAY

  • CAQH:NOT_IMPLEMENTED

  • CAQH:RETRY_EXHAUSTED

  • CAQH:EMPTY_HEAD_COUNT

  • CAQH:CONFLICT

  • CAQH:SERVICE_UNAVAILABLE

  • CAQH:DEAD_TOKEN

  • CAQH:BAD_REQUEST

  • CAQH:FORBIDDEN

  • CAQH:UNAUTHORIZED

  • CAQH:NOT_FOUND

  • CAQH:CONNECTIVITY

Update Providers - ProView (POST)

<caqh:update-to-roster-request-pv>

Method to update one or more providers existing on roster using POST. Returns the batch_id that is generated on successful update of Providers on roster.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Update Proview Details

List of providers to be updated in Proview.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CAQH:METHOD_NOT_ALLOWED

  • CAQH:INTERNAL_SERVER_ERROR

  • CAQH:NOT_ACCEPTABLE

  • CAQH:REQUEST_TIMEOUT

  • CAQH:GENERIC_EXCEPTION

  • CAQH:BAD_GATEWAY

  • CAQH:NOT_IMPLEMENTED

  • CAQH:RETRY_EXHAUSTED

  • CAQH:EMPTY_HEAD_COUNT

  • CAQH:CONFLICT

  • CAQH:SERVICE_UNAVAILABLE

  • CAQH:DEAD_TOKEN

  • CAQH:BAD_REQUEST

  • CAQH:FORBIDDEN

  • CAQH:UNAUTHORIZED

  • CAQH:NOT_FOUND

  • CAQH:CONNECTIVITY

Update Providers - ProView (PUT)

<caqh:update-to-roster-request-pv-by-put-request>

Method to update one or more providers existing on roster using PUT. Returns the batch_id that is generated on successful update of Providers on roster.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Details

List of providers to be updated in Roster.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation's output.

Target Value

String

An expression to evaluate against the operation's output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • CAQH:METHOD_NOT_ALLOWED

  • CAQH:INTERNAL_SERVER_ERROR

  • CAQH:NOT_ACCEPTABLE

  • CAQH:REQUEST_TIMEOUT

  • CAQH:GENERIC_EXCEPTION

  • CAQH:BAD_GATEWAY

  • CAQH:NOT_IMPLEMENTED

  • CAQH:RETRY_EXHAUSTED

  • CAQH:EMPTY_HEAD_COUNT

  • CAQH:CONFLICT

  • CAQH:SERVICE_UNAVAILABLE

  • CAQH:DEAD_TOKEN

  • CAQH:BAD_REQUEST

  • CAQH:FORBIDDEN

  • CAQH:UNAUTHORIZED

  • CAQH:NOT_FOUND

  • CAQH:CONNECTIVITY

Types

TLS

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer CRLs

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom OCSP Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

CRL File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Count

Number

How many reconnection attempts to make..

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Response Status

Field Type Description Default Value Required

Headers

Object

Status Code

Number

Request To Add Roster PVDTO

Field Type Description Default Value Required

Affiliation Flag

String

Application Type

String

Caqh Provider Id

String

Delegation Flag

String

Last Recredential Date

String

Next Recredential Date

String

Organization Id

String

Po Provider Id

String

Provider

Region Id

String

Provider DTO

Field Type Description Default Value Required

Address1

String

Address2

String

Birthdate

String

City

String

Dea

String

Email

String

Fax

String

First Name

String

Gender

String

Last Name

String

License Number

String

License State

String

Middle Name

String

Name Suffix

String

Npi

String

Phone

String

Practice State

String

Short Ssn

String

Ssn

String

State

String

Tax Id

String

Type

String

Upin

String

Zip

String

Zip Extn

String

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

Max In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Request To Delete Roster DADTO

Field Type Description Default Value Required

Caqh Provider Id

String

Organization Id

String

Get Provider Status DTO

Field Type Description Default Value Required

Authorization Flag

String

Caqh Provider Id

String

Organization Id

String

Po Provider Id

String

Provider Found Flag

String

Provider Practice State

String

Provider Status

String

Provider Status Date

String

Roster Status

String

Get Add Status DTO

Field Type Description Default Value Required

Batch Status

String

Batch Time

String

Roster Result

Array of Roster Response

Roster Response

Field Type Description Default Value Required

Affiliation Flag

String

Anniversary Date

String

Authorization Flag

String

Caqh Provider Id

String

Delegation Flag

String

Exception Description

String

Non Responder Flag

String

Organization Id

String

Po Provider Id

String

Provider

Roster Status

String

Provider

Field Type Description Default Value Required

Address1

String

Address2

String

Address City

String

Address State

String

Address Zip

String

Birthdate

String

Dea

String

First Name

String

Last Name

String

License Number

String

License State

String

Middle Name

String

Npi

String

Practice State

String

Status

String

Status Date

String

Type

String

Upin

String

Get Delete Result DTO

Field Type Description Default Value Required

Batch Status

String

Batch Time

String

Deroster Result

Array of Deroster Result

Deroster Result

Field Type Description Default Value Required

Caqh Provider Id

String

Delete Description

String

Organization Id

String

Get Update Result DTO

Field Type Description Default Value Required

Batch Status

String

Batch Time

String

Roster Result

Array of Roster Result

Roster Result

Field Type Description Default Value Required

Caqh Provider Id

String

Organization Id

String

Update Description

String

Request To Update DADTO

Field Type Description Default Value Required

Caqh Provider Id

String

Organization Id

String

Po Provider Id

String

Request To Update PVDTO

Field Type Description Default Value Required

Affiliation Flag

String

Application Type

String

Caqh Provider Id

String

Delegation Flag

String

Last Recredential Date

String

Next Recredential Date

String

Organization Id

String

Po Provider Id

String

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.