CAQH Connector Reference | MuleSoft Documentation
# CAQH Connector Reference
CAQH Connector v1.0
Release Notes: CAQH Connector Release Notes
The main class of an extension, is the entry point from which configurations, connection providers, operations and sources are going to be declared.
## Configurations
### Default Configuration
Default configuration
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
Connection | The connection types to provide to this configuration.  
Expiration Policy |  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 its name implies) provides connection instances and the functionality 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  
---|---|---|---|---  
Use Persistent Connections | If false, each connection will be closed after the first request is completed.  
Max Connections | The maximum number of outbound connections that will be kept open at the same time. By default the number of connections is unlimited.  
Connection Idle Timeout | 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.  
Stream Response | 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.  
Response Buffer Size | The space in bytes for the buffer where the HTTP response will be stored.  
Connection Timeout  
TLS Configuration | 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  
## Supported Operations
  * Add Providers - DirectAssure
  * Add Providers - ProView
  * Delete Providers - ProView (POST)
  * Delete Providers - DirectAssure (POST)
  * Delete Providers - DirectAssure (PUT)
  * Delete Providers - ProView (PUT)
  * Get Provider Credentials
  * Get Provider Documents
  * Get Provider Status - DirectAssure
  * Get Provider Status - ProView
  * Get Status - Add to Roster
  * Get Status - Delete from Roster
  * Get Status - Update to Roster
  * Update Providers - DirectAssure (POST)
  * Update Providers - DirectAssure (PUT)
  * Update Providers - ProView (POST)
  * Update Providers - ProView (PUT)


## 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 | The name of the configuration to use.  
Add To DA Bodies |  Array of Request To Add Roster PVDTO | List of providers to be added to roster | `#[payload]`  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Response Status  
---|---  
#### For Configurations
  * Default Configuration


#### 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 | The name of the configuration to use.  
Add Request Bodies |  Array of Request To Add Roster PVDTO | List of providers to be added to Roster. | `#[payload]`  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Response Status  
---|---  
#### For Configurations
  * Default Configuration


#### 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 | The name of the configuration to use.  
Delete Proview Bodies |  Array of Request To Delete Roster DADTO | List of providers to be deleted from Proview. | `#[payload]`  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Response Status  
---|---  
#### For Configurations
  * Default Configuration


#### 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 | The name of the configuration to use.  
Delete DA By Post Bodies |  Array of Request To Delete Roster DADTO | List of providers to be deleted from Proview. | `#[payload]`  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream
| Configure to use repeatable streams.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Response Status  
---|---  
#### For Configurations
  * Default Configuration


#### 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 | The name of the configuration to use.  
Delete DA By Post Bodies |  Array of Request To Delete Roster DADTO | List of providers to be deleted from Proview. | `#[payload]`  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Response Status  
---|---  
#### For Configurations
  * Default Configuration


#### 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 | The name of the configuration to use.  
Delete DA By Put Bodies |  Array of Request To Delete Roster DADTO | List of providers to be deleted from the roster | `#[payload]`  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Response Status  
---|---  
#### For Configurations
  * Default Configuration


#### 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 | The name of the configuration to use.  
Delete Request Bodies |  Array of Request To Delete Roster DADTO | List of providers to be deleted from Roster. | `#[payload]`  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Response Status  
---|---  
#### For Configurations
  * Default Configuration


#### 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 | The name of the configuration to use.  
Caqh Provider Id | CAQH assigned provider Identifier.  
Organization Id | Participating Organization Identifier.  
Attestation Date | Date on which provider was last first attested.Required (Only within the past 3 years).  
Credential Section | (Optional) If not specified, the service will return all sections.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Response Status  
---|---  
#### For Configurations
  * Default Configuration


#### 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.
### 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 | The name of the configuration to use.  
Caqh Provider_id | CAQH assigned provider Identifier.  
Organization_id | Participating Organization Identifier.  
Doc_ Type | Single Supporting Document Type.  
Output Mime Type | The mime type of the payload that this operation outputs.  
Output Encoding | The encoding of the payload that this operation outputs.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Response Status  
---|---  
#### For Configurations
  * Default Configuration


#### 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 | The name of the configuration to use.  
Organization_ Id | Participating organization identifier  
Caqh_ Provider_ Id | CAQH assigned provider identifier  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Get Provider Status DTO  
---  
Attributes Type |  Response Status  
#### For Configurations
  * Default Configuration


#### 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 | The name of the configuration to use.  
Organization_ Id | Participating Organization Identifier.  
Caqh_ Provider_ Id | CAQH assigned provider Identifier.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Get Provider Status DTO  
---  
Attributes Type |  Response Status  
#### For Configurations
  * Default Configuration


#### 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 | The name of the configuration to use.  
Batch_id | System-generated unique Batch ID from ADD request.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Get Add Status DTO  
---  
Attributes Type |  Response Status  
#### For Configurations
  * Default Configuration


#### 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 | The name of the configuration to use.  
Batch_id | System-generated unique Batch ID from UPDATE request.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Get Delete Result DTO  
---  
Attributes Type |  Response Status  
#### For Configurations
  * Default Configuration
### 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 | The name of the configuration to use.  
Batch_id | System-generated unique Batch ID from UPDATE request.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Get Delete Result DTO  
---  
Attributes Type |  Response Status  
#### For Configurations
  * Default Configuration


#### 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 | The name of the configuration to use.  
Batch_id | System-generated unique Batch ID from UPDATE request.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Get Update Result DTO  
---  
Attributes Type |  Response Status  
#### For Configurations
  * Default Configuration


#### 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 | The name of the configuration to use.  
Update DA By Post Requests |  Array of Request To Update DADTO | List of providers to be updated in ProView | `#[payload]`  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Response Status  
---|---  
#### For Configurations
  * Default Configuration


#### 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 | The name of the configuration to use.  
Update DA By Put Requests |  Array of Request To Update DADTO | List of providers to be updated in roster | `#[payload]`  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Response Status  
---|---  
#### For Configurations
  * Default Configuration


#### 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 | The name of the configuration to use.  
Update Proview Details |  Array of Request To Update PVDTO | List of providers to be updated in Proview. | `#[payload]`  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Response Status  
---|---  
#### For Configurations
  * Default Configuration


#### 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
| Configure to use repeatable streams.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Response Status  
---|---  
#### For Configurations
  * Default Configuration


#### 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 | The name of the configuration to use.  
Array of Request To Update PVDTO | List of providers to be updated in Roster. | `#[payload]`  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure to use repeatable streams.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Response Status  
---|---  
#### For Configurations
  * Default Configuration


#### 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
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Enabled Protocols | A comma-separated list of protocols enabled for this context.  
Enabled Cipher Suites | A comma-separated list of cipher suites enabled for this context.  
Trust Store  
Key Store  
Revocation Check | 
  * Standard Revocation Check
  * Custom OCSP Responder

  
### Trust Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.  
Password | The password used to protect the trust store.  
The type of store used.  
Algorithm | The algorithm used by the trust store.  
Insecure | 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  
---|---|---|---|---  
The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.  
The type of store used.  
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 | The password used to protect the private key.  
Password | The password used to protect the key store.  
Algorithm | The algorithm used by the key store.  
### Standard Revocation Check
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Only End Entities | Only verify the last element of the certificate chain.  
Prefer CRLs | Try CRL instead of OCSP first.  
No Fallback | Do not use the secondary checking method (the one not selected before).  
Soft Fail | Avoid verification failure when the revocation server can not be reached or is busy.  
### Custom OCSP Responder
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The URL of the OCSP responder.  
Cert Alias | 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  
---|---|---|---|---  
The path to the CRL file.  
### Reconnection
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Fails Deployment | 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 | 
  *   * Reconnect Forever

| The reconnection strategy to use.  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Frequency | How often in milliseconds to reconnect.  
How many reconnection attempts to make..  
blocking | If false, the reconnection strategy runs in a separate, non-blocking thread.  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Frequency | How often in milliseconds to reconnect.  
blocking | If false, the reconnection strategy runs in a separate, non-blocking thread.  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max Idle Time | 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
| The reconnection strategy to use.  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Frequency | How often in milliseconds to reconnect.  
How many reconnection attempts to make..  
blocking | If false, the reconnection strategy runs in a separate, non-blocking thread.  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Frequency | How often in milliseconds to reconnect.  
blocking | If false, the reconnection strategy runs in a separate, non-blocking thread.  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max Idle Time | 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

| A time unit that qualifies the maxIdleTime attribute  
### Response Status
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Status Code  
### Request To Add Roster PVDTO
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Affiliation Flag  
Application Type  
Caqh Provider Id  
Delegation Flag  
Last Recredential Date  
Next Recredential Date  
Organization Id  
Po Provider Id  
Provider |   
### Provider DTO
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
First Name  
License Number  
License State  
Middle Name  
Name Suffix  
Practice State  
### Repeatable In Memory Stream
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Initial Buffer Size | 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 | 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 | 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: | The unit in which all these attributes are expressed  
### Repeatable File Store Stream
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max In Memory Size | 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: | The unit in which maxInMemorySize is expressed  
### Request To Delete Roster DADTO
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Caqh Provider Id  
Organization Id  
### Get Provider Status DTO
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Authorization Flag  
Caqh Provider Id  
Organization Id  
Po Provider Id  
Provider Found Flag  
Provider Practice State  
Provider Status  
Provider Status Date  
Roster Status  
### Get Add Status DTO
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Batch Status  
Batch Time  
Roster Result |  Array of Roster Response  
### Roster Response
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Affiliation Flag  
Anniversary Date  
Authorization Flag  
Caqh Provider Id  
Delegation Flag  
Exception Description  
Non Responder Flag  
Organization Id  
Po Provider Id  
Roster Status  
### Provider
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Address City  
Address State  
Address Zip  
First Name  
License Number  
License State  
Middle Name  
Practice State  
Status Date  
### Get Delete Result DTO
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Batch Status  
Batch Time  
Deroster Result |  Array of Deroster Result  
### Deroster Result
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Caqh Provider Id  
Delete Description  
Organization Id  
### Get Update Result DTO
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Batch Status  
Batch Time  
Roster Result |  Array of Roster Result  
### Roster Result
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Caqh Provider Id  
Organization Id  
Update Description  
### Request To Update DADTO
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Caqh Provider Id  
Organization Id  
Po Provider Id  
### Request To Update PVDTO
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Affiliation Flag  
Application Type  
Caqh Provider Id  
Delegation Flag  
Last Recredential Date  
Next Recredential Date  
Organization Id  
Po Provider Id  
## See Also
MuleSoft Help Center