CAQH Connector リファレンス

CAQH Connector v1.0

リリースノート: CAQH Connector リリースノート

拡張機能のメインクラスは、設定、接続プロバイダー、操作、およびソースを宣言するエントリポイントです。

設定


デフォルト設定

デフォルト設定

パラメーター

名前 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

この設定に指定する接続型。

x

Address (住所)

String (文字列)

x

Version (バージョン)

String (文字列)

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Runtime で期限切れに相当するとみなされます。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。ランタイムによって適切と判断されたときに、インスタンスがパージされます。

接続種別

Connection (接続)

このクラスは、(その名が示すとおり) 接続インスタンスと、それらの接続を切断および検証する機能を提供します。 接続関連のすべてのパラメーター (接続の作成に必要な値) は、接続プロバイダーで宣言されている必要があります。 この具体的な例は、このプロバイダーによって解決される接続がプールされて再利用されることを宣言する PoolingConnectionProvider です。他にも、接続を遅延作成およびキャッシュする CachedConnectionProvider や、要求されるたびに新しい接続が必要な場合のシンプルな ConnectionProvider などの実装があります。

パラメーター
名前 説明 デフォルト値 必須

Username (ユーザー名)

String (文字列)

x

Password (パスワード)

String (文字列)

x

Use Persistent Connections (永続接続を使用)

Boolean (ブール)

false の場合、各接続は最初の要求が完了すると終了します。

true

Max Connections (最大接続数)

Number (数値)

同時に開いた状態にできるアウトバウンド接続の最大数。デフォルトでは、接続数は無制限です。

-1

Connection Idle Timeout (接続アイドルタイムアウト)

Number (数値)

接続が終了するまでのアイドル状態を維持できるミリ秒。この属性の値は、永続接続が有効になっている場合にのみ使用されます。

60000

Stream Response (応答のストリーミング)

Boolean (ブール)

受信応答をストリーミングする必要があるかどうか。つまり、すべてのヘッダーが解析されたらすぐに処理を続行し、本文は到着するとストリーミングされます。設定されたバッファサイズによっては、メモリに収まらず、容量が空くまで処理が停止する可能性があるため、有効になっている場合は徐々に応答を読み取る必要があります。

false

Response Buffer Size (応答バッファサイズ)

Number (数値)

HTTP 応答が保存されるバッファの領域 (バイト)。

-1

Connection Timeout (接続タイムアウト)

Number (数値)

60000

TLS Configuration (TLS 設定)

TLS

通信に使用するプロトコル。有効な値は HTTP と HTTPS です。デフォルト値は HTTP です。HTTPS を使用すると、HTTP 通信が TLS/SSL を使用して保護されます。プロトコルとして HTTPS が設定されている場合、ユーザーはこの listener-config の tls:context 子要素で少なくともキーストアを設定する必要があります。

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

操作

Add Providers - DirectAssure

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

パートナー組織 (PO) は、API へのコールを送信して 1 人以上の提供者を名簿に追加できます。そのため、[Quick Add (クイック追加)] と [Initial Add (初期追加)] で必須項目と省略可能な項目が異なります。名簿への提供者の追加に成功した場合に生成される batch_id を返します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Add To DA Bodies (Add To DA ボディ)

名簿に追加される提供者のリスト。

#[payload]

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • 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>

PO は、API へのコールを送信して 1 人以上の提供者を名簿に追加できます。そのため、[Quick Add (クイック追加)] と [Initial Add (初期追加)] で必須項目と省略可能な項目が異なります。このメソッドは、名簿への提供者の追加に成功した場合に生成される batch_id を返します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Add Request Bodies (Add Request ボディ)

名簿に追加される提供者のリスト。

#[payload]

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • 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>

POST を使用して名簿から 1 人以上の提供者を削除するメソッド。名簿からの提供者の削除に成功した場合に生成される batch_id を返します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Delete Proview Bodies (Delete Proview ボディ)

Proview から削除される提供者のリスト。

#[payload]

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • CAQH:RETRY_EXHAUSTED

  • CAQH:CONNECTIVITY

Delete Providers - DirectAssure (POST)

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

名簿から 1 人以上の提供者を削除するメソッド。名簿からの提供者の削除に成功した場合に生成される batch_id を返します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Delete DA By Post Bodies (Delete DA By Post ボディ)

Proview から削除される提供者のリスト。

#[payload]

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • 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>

名簿から 1 人以上の提供者を削除するメソッド。名簿からの提供者の削除に成功した場合に生成される batch_id を返します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Delete DA By Put Bodies (Delete DA By Put ボディ)

名簿から削除される提供者のリスト。

#[payload]

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • 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>

PUT を使用して名簿から 1 人以上の提供者を削除するメソッド。名簿からの提供者の削除に成功した場合に生成される batch_id を返します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Delete Request Bodies (Delete Request ボディ)

名簿から削除される提供者のリスト。

#[payload]

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • CAQH:RETRY_EXHAUSTED

  • CAQH:CONNECTIVITY

Get Provider Credentials

<caqh:get-provider-credentials>

このメソッドは、参加組織が CAQH ProView のリアルタイム提供者データにアクセスするために使用する信任 API Web サービスで受信した xml 応答を返します。信任 API アクセスを要求する前に、PO には Web サービスをコンシュームおよび使用するためのビジネスケースと既存のアプリケーションが必要になります。信任 API は、一度に 1 つの CAQH 提供者 ID を受け入れて、API コールで提供される他のパラメーターに基づいてその提供者の情報を配布するように設計されています。信任 API サービスは、次のすべての条件を満たした場合にのみ提供者データを返します。

  1. 提供者アプリケーションの状況が [Complete (完了)] になっている。

  2. 参加組織が提供者の情報を参照することを提供者が認証済みで、参加組織の提供者の名簿の状況が [active (アクティブ)] である。データは、参加組織と要求された提供者間の委任/非委任および参加/不参加リレーションに基づいて絞り込まれます。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Caqh Provider Id (CAQH 提供者 ID)

String (文字列)

CAQH によって割り当てられた提供者識別子。

x

Organization Id (組織 ID)

String (文字列)

参加組織の識別子。

x

Attestation Date (認証日)

String (文字列)

提供者が最後に証明された日付。必須 (過去 3 年以内のみ)。

x

Credential Section (信任セクション)

String (文字列)

(省略可能) 指定されていない場合、サービスはすべてのセクションを返します。

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • 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>

このメソッドは、参加組織が提供者の関連資料を取得することを許可する要求の応答として PDF ドキュメントを返します。関連資料は、次の条件を満たす場合にのみ返されます。

  1. 要求ユーザーに関連付けられている PO ID が受信 PO ID と一致するか、受信 PO ID がユーザーに関連付けられている PO ID の子である。

  2. 提供者が参加組織の名簿に含まれている。

  3. 提供者が参加組織に認証を与えている。

  4. 提供者の CAQH ProView データプロファイルが完了状況 ([Initial Profile Complete (初期プロファイル完了)] または [Re-attestation (再認証)]) になっている。これらの条件を満たしていない場合、その CAQH 提供者 ID の関連資料は返されず、該当する応答コードが提供されます。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Caqh Provider_id

String (文字列)

CAQH によって割り当てられた提供者識別子。

x

Organization_id

String (文字列)

参加組織の識別子。

x

Doc_ Type

String (文字列)

1 つの関連資料種別。

x

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Output Encoding (出力エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Binary (バイナリ)

Attributes Type (属性型)

次の設定の場合

スロー

  • 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>

参加組織は、DirectAssure 状況チェック API Web サービスを使用して、CAQH ProView の提供者の状況を表示できます。DirectAssure 状況チェック API アクセスを要求する前に、参加組織には Web サービスをコンシュームおよび使用するためのビジネスケースと既存のアプリケーションが必要になります。DirectAssure 状況チェック API は、一度に 1 人の提供者を受け入れます。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Organization_ Id

String (文字列)

参加組織の識別子。

x

Caqh_ Provider_ Id

String (文字列)

CAQH によって割り当てられた提供者識別子。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Get Provider Status DTO (提供者状況取得 DTO)

Attributes Type (属性型)

次の設定の場合

スロー

  • 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>

参加組織は、ProView 状況チェック API Web サービスを使用して、CAQH ProView の提供者の状況を表示できます。ProView 状況チェック API アクセスを要求する前に、PO には Web サービスをコンシュームおよび使用するためのビジネスケースと既存のアプリケーションが必要になります。ProView 状況チェック API は、一度に 1 人の提供者を受け入れます。このメソッドは、提供者の状況が含まれる JSON 応答を返すか、Provider_Found_Flag = N で提供者が見つからなかったことを示します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Organization_ Id

String (文字列)

参加組織の識別子。

x

Caqh_ Provider_ Id

String (文字列)

CAQH によって割り当てられた提供者識別子。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Get Provider Status DTO (提供者状況取得 DTO)

Attributes Type (属性型)

次の設定の場合

スロー

  • 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>

前の Add to Roster 要求の状況と、要求が完了している場合はその結果を取得するメソッド。例外が原因で提供者を名簿に追加できない場合、Exception_Description 項目に値が含まれ、システムの値ではなく Add to Roster Web サービスで送信された識別項目が返されます。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Batch_id

String (文字列)

システムによって生成される、ADD 要求からの一意のバッチ ID。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Get Add Status DTO (追加状況取得 DTO)

Attributes Type (属性型)

次の設定の場合

スロー

  • 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>

前の Delete from Roster 要求の状況と、要求が完了している場合はその結果を受信する GET 要求。例外が原因で提供者を名簿から削除できない場合、Exception_Description 項目にその例外が含まれます。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Batch_id

String (文字列)

システムによって生成される、UPDATE 要求からの一意のバッチ ID。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Get Delete Result DTO (削除取得結果 DTO)

Attributes Type (属性型)

次の設定の場合

スロー

  • 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>

前の Update on Roster 要求の状況と、要求が完了している場合はその結果を受信する GET 要求。例外が原因で名簿の提供者を更新できない場合、Update_Description 項目にその例外が含まれます。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Batch_id

String (文字列)

システムによって生成される、UPDATE 要求からの一意のバッチ ID。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Get Update Result DTO (更新取得結果 DTO)

Attributes Type (属性型)

次の設定の場合

スロー

  • 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>

名簿の 1 人以上の提供者を更新するメソッド。名簿での提供者の更新に成功した場合に生成される batch_id を返します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Update DA By Post Requests (Update DA By Post 要求)

ProView で更新される提供者のリスト。

#[payload]

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • 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>

名簿の 1 人以上の提供者を更新するメソッド。名簿での提供者の更新に成功した場合に生成される batch_id を返します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Update DA By Put Requests (Update DA By Put 要求)

名簿で更新される提供者のリスト。

#[payload]

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • 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>

POST を使用して名簿の 1 人以上の提供者を更新するメソッド。名簿での提供者の更新に成功した場合に生成される batch_id を返します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Update Proview Details (Proview 更新の詳細)

Proview で更新される提供者のリスト。

#[payload]

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • 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>

PUT を使用して名簿の 1 人以上の提供者を更新するメソッド。名簿での提供者の更新に成功した場合に生成される batch_id を返します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

詳細

名簿で更新される提供者のリスト。

#[payload]

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • 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

TLS

項目 説明 デフォルト値 必須

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

トラストストア

Key Store (キーストア)

Revocation Check (取り消し確認)

トラストストア

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

トラストストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

使用するストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用するアルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true の場合、証明書の検証が実行されず、攻撃に対して接続が脆弱になります。各自の責任で使用してください。

Key Store (キーストア)

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

キーストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Type (型)

String (文字列)

使用するストアの型。

Alias (別名)

String (文字列)

キーストアに多数の非公開キーがある場合、この属性は、使用する鍵の別名を示します。定義しない場合、デフォルトでファイル内の最初の鍵が使用されます。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用するアルゴリズム。

Standard Revocation Check (標準の取り消し確認)

項目 説明 デフォルト値 必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーンの最後の要素のみを確認します。

Prefer CRLs (CRL を優先)

Boolean (ブール)

最初に OCSP ではなく CRL を試みます。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 (以前に選択されていない方法) を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。

Custom OCSP Responder (カスタム OCSP レスポンダー)

項目 説明 デフォルト値 必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。

CRL File (CRL ファイル)

項目 説明 デフォルト値 必須

Path (パス)

String (文字列)

CRL ファイルへのパス。

Reconnection (再接続)

項目 説明 デフォルト値 必須

Fails Deployment (デプロイメントに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Count (数)

Number (数値)

再接続を試みる回数。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Reconnect Forever (繰り返し再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Expiration Policy (有効期限ポリシー)

項目 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位

応答状況

項目 説明 デフォルト値 必須

Headers (ヘッダー)

Object (オブジェクト)

Status Code (状況コード)

Number (数値)

Request To Add Roster PVDTO (名簿追加要求 PVDTO)

項目 説明 デフォルト値 必須

Affiliation Flag (アフィリエーションフラグ)

String (文字列)

Application Type (アプリケーション種別)

String (文字列)

Caqh Provider Id (CAQH 提供者 ID)

String (文字列)

Delegation Flag (委任フラグ)

String (文字列)

Last Recredential Date (前回の再信任日)

String (文字列)

Next Recredential Date (次回の再信任日)

String (文字列)

Organization Id (組織 ID)

String (文字列)

Po Provider Id (PO 提供者 ID)

String (文字列)

プロバイダー

Region Id (リージョン ID)

String (文字列)

Provider DTO (提供者 DTO)

項目 説明 デフォルト値 必須

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 (短い SSN)

String (文字列)

Ssn

String (文字列)

State (状態)

String (文字列)

Tax Id (税金 ID)

String (文字列)

Type (型)

String (文字列)

Upin

String (文字列)

Zip (郵便番号)

String (文字列)

Zip Extn (拡張郵便番号)

String (文字列)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)

項目 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームをコンシュームしてランダムにアクセスするために割り当てられるメモリ量。ストリームのデータ量がこのバッファサイズを超える場合は、bufferSizeIncrement 属性に従って、maxInMemorySize を上限としてバッファが拡張されます。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

これらのすべての属性の単位

Repeatable File Store Stream (反復可能なファイルストアストリーム)

項目 説明 デフォルト値 必須

Max In Memory Size (最大メモリ内サイズ)

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。これを超えると、ディスクへのコンテンツのバッファが開始されます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

Request To Delete Roster (名簿削除要求 DADTO)

項目 説明 デフォルト値 必須

Caqh Provider Id (CAQH 提供者 ID)

String (文字列)

Organization Id (組織 ID)

String (文字列)

Get Provider Status DTO (提供者状況取得 DTO)

項目 説明 デフォルト値 必須

Authorization Flag (認証フラグ)

String (文字列)

Caqh Provider Id (CAQH 提供者 ID)

String (文字列)

Organization Id (組織 ID)

String (文字列)

Po Provider Id (PO 提供者 ID)

String (文字列)

Provider Found Flag (提供者検出フラグ)

String (文字列)

Provider Practice State (提供者の実施状態)

String (文字列)

Provider Status (提供者の状況)

String (文字列)

Provider Status Date (提供者の状況取得日)

String (文字列)

Roster Status (名簿の状況)

String (文字列)

Get Add Status DTO (追加状況取得 DTO)

項目 説明 デフォルト値 必須

Batch Status (バッチの状況)

String (文字列)

Batch Time (バッチ時間)

String (文字列)

Roster Result (名簿の結果)

Roster Response (名簿の応答)

項目 説明 デフォルト値 必須

Affiliation Flag (アフィリエーションフラグ)

String (文字列)

Anniversary Date (記念日)

String (文字列)

Authorization Flag (認証フラグ)

String (文字列)

Caqh Provider Id (CAQH 提供者 ID)

String (文字列)

Delegation Flag (委任フラグ)

String (文字列)

Exception Description (例外の説明)

String (文字列)

Non Responder Flag (非応答者フラグ)

String (文字列)

Organization Id (組織 ID)

String (文字列)

Po Provider Id (PO 提供者 ID)

String (文字列)

プロバイダー

Roster Status (名簿の状況)

String (文字列)

プロバイダー

項目 説明 デフォルト値 必須

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 (削除取得結果 DTO)

項目 説明 デフォルト値 必須

Batch Status (バッチの状況)

String (文字列)

Batch Time (バッチ時間)

String (文字列)

Deroster Result (名簿削除結果)

Deroster Result (名簿削除結果)

項目 説明 デフォルト値 必須

Caqh Provider Id (CAQH 提供者 ID)

String (文字列)

Delete Description (削除の説明)

String (文字列)

Organization Id (組織 ID)

String (文字列)

Get Update Result DTO (更新取得結果 DTO)

項目 説明 デフォルト値 必須

Batch Status (バッチの状況)

String (文字列)

Batch Time (バッチ時間)

String (文字列)

Roster Result (名簿の結果)

Roster Result (名簿の結果)

項目 説明 デフォルト値 必須

Caqh Provider Id (CAQH 提供者 ID)

String (文字列)

Organization Id (組織 ID)

String (文字列)

Update Description (更新の説明)

String (文字列)

Request To Update DADTO (更新要求 DADTO)

項目 説明 デフォルト値 必須

Caqh Provider Id (CAQH 提供者 ID)

String (文字列)

Organization Id (組織 ID)

String (文字列)

Po Provider Id (PO 提供者 ID)

String (文字列)

Request To Update PVDTO (更新要求 PVDTO)

項目 説明 デフォルト値 必須

Affiliation Flag (アフィリエーションフラグ)

String (文字列)

Application Type (アプリケーション種別)

String (文字列)

Caqh Provider Id (CAQH 提供者 ID)

String (文字列)

Delegation Flag (委任フラグ)

String (文字列)

Last Recredential Date (前回の再信任日)

String (文字列)

Next Recredential Date (次回の再信任日)

String (文字列)

Organization Id (組織 ID)

String (文字列)

Po Provider Id (PO 提供者 ID)

String (文字列)