接続文字列オプション
接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。
接続を確立する方法について詳しくは、接続の確立を参照してください。
| プロパティ | 説明 |
| AuthScheme | The type of authentication to use when connecting to remote services. |
| ConnectionType | The type of connection to use. |
| User | 認証で使用されるFHIR ユーザーアカウント。 |
| Password | ユーザーの認証で使用されるパスワード。 |
| URL | The Service Base URL of the FHIR server. |
| APIKey | The API key used for accessing your InterSystems IRIS for Health account. For more reference, please check: https://docs.intersystems.com/services/csp/docbook/DocBook.UI.Page.cls?KEY=FAS_intro#FAS_tour_apikey |
| プロパティ | 説明 |
| AWSAccessKey | AWS アカウントのアクセスキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。 |
| AWSSecretKey | AWS アカウントのシークレットキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。 |
| AWSRoleARN | 認証時に使用するロールのAmazon リソースネーム。 |
| AWSRegion | Amazon Web サービスのホスティングリージョン。 |
| CredentialsLocation | MFA クレデンシャルが保存される設定ファイルの場所。 |
| AWSUserPoolId | ユーザープールのID。 |
| AWSUserPoolClientAppId | ユーザープールのアプリクライアントID。 |
| AWSUserPoolClientAppSecret | ユーザープールのアプリクライアントシークレット。(オプション) |
| AWSIdentityPoolId | ID プールのID。 |
| プロパティ | 説明 |
| InitiateOAuth | 接続時にOAuth アクセストークンを取得またはリフレッシュするプロセスを開始するには、このプロパティを設定します。 |
| OAuthVersion | 使われているOAuth のバージョン。 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| OAuthSettingsLocation | InitiateOAuth が GETANDREFRESH 、または REFRESH に設定されているときの設定ファイルの場所。代わりに、'memory://' で始まる値を指定することで、この場所をメモリに保持することができます。 |
| CallbackURL | 認証時にリダイレクトされるOAuth コールバックURL。この値をアプリケーションに指定したコールバックURL と同じ値に設定します。 |
| State | 追加のOAuth ステート情報を表すオプションの値。 |
| OAuthPasswordGrantMode | OAuthGrantType がPassword に設定されている場合のクライアントId とクライアントシークレットの渡し方。 |
| OAuthIncludeCallbackURL | アクセストークンリクエストにコールバックURL を含めるかどうか。 |
| OAuthAuthorizationURL | OAuth サービスの認可URL。 |
| OAuthAccessTokenURL | OAuth アクセストークンを取得するURL。 |
| OAuthRefreshTokenURL | OAuth トークンをリフレッシュするURL。 |
| OAuthRequestTokenURL | サービスがリクエストトークンを取得するために提供するURL。これは、OAuth 1.0 では必須です。 |
| OAuthVerifier | OAuth 認可URL から返された検証コード。 |
| AuthToken | OAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。 |
| AuthKey | OAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。 |
| OAuthParams | OAuth アクセストークンのリクエストでparamname=value の形式でサブミットするその他のパラメータのカンマ区切りのリスト。 |
| プロパティ | 説明 |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
| OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクト。 |
| OAuthJWTIssuer | Java Web Token の発行者。 |
| OAuthJWTSubject | アプリケーションからデリゲートアクセスの要求対象となるユーザーサブジェクト。 |
| プロパティ | 説明 |
| SSLClientCert | SSL クライアント認証(2-way SSL)のためのTLS/SSL クライアント証明書ストア。 |
| SSLClientCertType | TLS/SSL クライアント証明書を格納するキーストアの種類。 |
| SSLClientCertPassword | TLS/SSL クライアント証明書のパスワード。 |
| SSLClientCertSubject | TLS/SSL クライアント証明書のサブジェクト。 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
| プロパティ | 説明 |
| FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
| FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
| FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
| FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
| FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
| プロパティ | 説明 |
| ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
| ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
| ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
| ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
| ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
| ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
| ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
| ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
| プロパティ | 説明 |
| Logfile | ログファイルの名前と場所を指定するファイルパス。 |
| Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
| LogModules | ログファイルに含めるコアモジュール。 |
| MaxLogFileSize | ログファイルの最大バイトサイズ(例えば、10MB)を指定する文字列。 |
| MaxLogFileCount | ログファイルの最大ファイル数を指定する文字列。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
| Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| AutoCache | SELECT クエリの結果を、 CacheLocation 、または CacheConnection と CacheProvider の両方で指定されたキャッシュデータベースに自動的にキャッシュします。 |
| CacheProvider | データのキャッシュに使用されるプロバイダーの名前。 |
| CacheDriver | データのキャッシュに使用されるデータベースドライバー。 |
| CacheConnection | キャッシュデータベースの接続文字列。このプロパティは、常に CacheProvider と一緒に使用します。両プロパティを設定すると、データをキャッシュするための CacheLocation のバリューセットがオーバーライドされます。 |
| CacheLocation | キャッシュデータベースへのパスとファイル名を指定します。 |
| CacheTolerance | AutoCache 使用時のキャッシュ内の失効データに対する許容範囲の秒数。 |
| Offline | オフラインモードを使用して、ライブソースではなくキャッシュからデータを取得します。 |
| CacheMetadata | このプロパティは、テーブルメタデータをファイルストアにキャッシュするかどうかを決定します。 |
| プロパティ | 説明 |
| APIFieldsNameSeparator | Define the separator of compound filed names in your FHIR Server. |
| PaginationLimitName | The PaginationLimitName is used for defining a different name for the limit property in the limit-offset pagination. |
| PaginationMode | The type of pagination implemented by the FHIR server. The default value is NextLink. |
| PaginationOffsetName | Define a different name for offset property in the limit-offset pagination. |
| PaginationSnapshotName | Define the name for the property that identifies the current request snapshot identifier. |
| ContentType | The format used for accessing your FHIR Server data. The available values are: XML or JSON. |
| CustomHeaders | ユーザーが決定したその他のヘッダー(オプション)。 |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
| PageSize | The maximum size of records returned per page. |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| RTK | ライセンス供与で使用されるランタイムキー。 |
| SupportsPostSearchRequests | Indicates whether or not the FHIR Server supports sending URL search params in a POST request body using the 'application/x-www-form-urlencoded' ContentType Header. Note: The InterSystems IRIS for Health does not support search with Post. |
| SupportsServerSideLastUpdatedFilter | Indicates whether or not the FHIR Server supports filtering Server-Side resources by the LastUpdated date. The filter must strictly follow the FHIR Specifications, meaning that the query parameter name is: '_lastUpdated' and the datetime precision is exactly as the server sends on the response. Also, the server must implemet filtering with comparison operators as: =, <, <=, >, >=. Example: [baseUrl]/Observation?_lastUpdated=2022-09-19T11:59:52Z For more information, please refer to: https://build.fhir.org/search.html#_lastUpdated |
| SupportsServerSideSorting | Indicates whether or not the FHIR Server supports sorting operation Server-Side. The sorting must strictly follow the FHIR Specifications, meaning that the query parameter name is: '_sort' and by default the sotring will be ASC. If we would like to sort them DESC, the server must accept a '-' before the parameter name. Example: [baseUrl]/Observation?_sort=status,-date,category For more information, please refer to: http://hl7.org/fhir/search.html#_sort |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |