FHIR 適合性宣言

Cloud Healthcare API 内の FHIR ストアでは、Health レベル 7 インタラクション(HL7)で公開されている Fast Healthcare Interoperability Resource(FHIR)仕様の複数のバージョンがサポートされています。

v1 API では次のバージョンがサポートされています。

FHIR ストアを作成するときは、fhirStores.create メソッドのパラメータとして FHIR バージョンを指定します。ストアの作成後に FHIR のバージョンを変更することはできません。

各ストアへの API インターフェースは、そのストアの FHIR バージョンに準拠しています。たとえば、DSTU2 の conformance インタラクションは STU3 の capabilities インタラクションとは異なりますが、どちらも /fhir/metadata REST パスを共有するため、パスはストアの FHIR バージョンに基づいて異なる回答を返します。

新しいバージョンの FHIR で追加された機能は、互換性の問題がない限り、以前のバージョンの FHIR でもストアで利用できます。たとえば、patch インタラクションは STU3 以降でのみ定義されている DSTU2 ストアでも利用できます。

FHIR バージョンの v1 API でサポートされる機能の詳細

R4

サポートされている一部の仕様は、サーバーの機能ステートメントで示されます。

  • すべてのR4 リソースの保存と取得(拡張要素のサポートを含む。API は、任意のデータ要素の拡張機能を受け入れ、保存し、返します。
  • JSON コンテンツ タイプを使用する RESTful API 内のすべてのメソッドがサポートされています。ただし以下を除きます。
    • 複数のリソースにわたって履歴を取得するタイプレベルおよびシステムレベルの履歴インタラクションはサポートされていません。リソース履歴は、一度に 1 つのリソースに対してのみ取得できます。
    • バッチ/トランザクションインタラクションは、バンドル内の検索またはパッチ オペレーションをサポートしていません。
  • 以下を除くすべての検索機能がサポートされています。

    • 検索パラメータの Group-characteristic-valueLocation-nearBundle-compositionBundle-message はサポートされていません。
    • 拡張要素で定義された検索パラメータはサポートされていません。
    • 音声マッチングを行う検索パラメータはサポートされていません。
    • 検索結果パラメータの _contained_containedType_summary=count_summary=true はサポートされていません。
    • 特別な検索パラメータ _content は、検索パラメータが参照するリソースのすべてのフィールドを検索します。検索できないフィールドは除外されます。明示的な AND(用語は AND と暗黙的に結合されます)や角かっこはサポートされません。
    • 特別な検索パラメータの _query_filter はサポートされていません。
    • _sort パラメータは、繰り返し要素のあるフィールドで使用すると、最初の要素で並べ替えられます。これは仕様とは異なります。サポートされているすべての検索パラメータは、特別な検索パラメータの _contentを除き、_sort の対象となります。
    • トークン検索修飾子の :of-type はサポートされていません。
    • 正規参照検索はサポートされていません。正規参照は通常の参照として扱われます。
    • 複合検索パラメータの次のサブセットがサポートされています。

      • DocumentReference-relationship
      • Observation-code-value-concept
      • Observation-code-value-date
      • Observation-code-value-quantity
      • Observation-code-value-string
      • Observation-combo-code-value-concept
      • Observation-combo-code-value-quantity
      • Observation-component-code-value-concept
      • Observation-component-code-value-quantity

      残りの複合検索パラメータはサポートされていません。

  • HTTP HEAD リクエストはサポートされていません。

  • ExecuteBundle エンドポイントは history バンドルを受け付けません。

サポートされていない地域:

  • ほとんどの拡張オペレーションは実装されていません。
  • プロファイルはサーバーによって検証または適用されません。
  • ユーザー定義の検索パラメータはサポートされていません。
  • XML コンテンツ タイプはサポートされていません。
  • パッチ オペレーションは XML パッチまたは FHIRPath パッチをサポートしていません。

STU3

サポートされている一部の仕様は、サーバーの機能ステートメントで示されます。

  • 拡張要素のサポートを含め、すべてのSTU3 リソースの保存と取得がサポートされています。API は、任意のデータ要素の拡張機能を受け入れ、保存し、返します。
  • JSON コンテンツタイプを使用する RESTful API のすべてのメソッドがサポートされています。

    • 複数のリソースにわたって履歴を取得するタイプレベルおよびシステムレベルの履歴インタラクションはサポートされていません。リソース履歴は、一度に 1 つのリソースに対してのみ取得できます。
    • バッチ/トランザクション インタラクションは、バンドル内の検索オペレーションをサポートしていません。
  • 以下を除くすべての検索機能がサポートされています。

    • 検索パラメータの Group-characteristic-valueSequence-coordinateLocation-nearLocation-near-distanceBundle-compositionBundle-message はサポートされていません。
    • 拡張要素で定義された検索パラメータはサポートされていません。
    • 音声マッチングを行う検索パラメータはサポートされていません。
    • 検索結果パラメータの _contained_containedType_summary=count_summary=true はサポートされていません。
    • 特別な検索パラメータの _contentは、検索パラメータによって参照されるリソースのすべてのフィールドを検索します。検索できないフィールドは除外されます。明示的な AND(条件は暗黙的に AND で結合されます)や角かっこはサポートされていません。
    • 特別な検索パラメータの _query_filter はサポートされていません。
    • _sort パラメータは、繰り返し要素のあるフィールドで使用すると、最初の要素で並べ替えられます。これは仕様とは異なります。サポートされているすべての検索パラメータは、特別な検索パラメータの _contentを除き、_sort の対象となります。

サポートされていない地域:

  • ほとんどの拡張オペレーションは実装されていません。
  • プロファイルはサーバーによって検証または適用されません。
  • ユーザー定義の検索パラメータはサポートされていません。
  • XML コンテンツ タイプはサポートされていません。
  • パッチ オペレーションは、XML パッチまたは FHIRPath パッチをサポートしていません。

DSTU2

サポートされている一部の仕様は、サーバーの適合性宣言で示されます。

  • 拡張要素のサポートを含む、すべての DSTU2 リソースの保存と取得がサポートされています。API は、任意のデータ要素の拡張機能を受け入れ、保存し、返します。
  • JSON コンテンツ タイプを使用する RESTful API 内のすべてのメソッドがサポートされています。ただし以下を除きます。
    • 複数のリソースにわたって履歴を取得するタイプレベルおよびシステムレベルの履歴インタラクションはサポートされていません。リソース履歴は、一度に 1 つのリソースに対してのみ取得できます。
    • バッチ/トランザクション インタラクションは、バンドル内の検索オペレーションをサポートしていません。
  • 以下を除くすべての検索機能がサポートされています。
    • 検索パラメータの Group-characteristic-valueLocation-nearLocation-near-distanceBundle-compositionBundle-messageCoverage-dependentCoverage-sequence はサポートされていません。
    • 拡張要素で定義された検索パラメータはサポートされていません。
    • 音声マッチングを行う検索パラメータはサポートされていません。
    • 検索結果パラメータの _contained_containedType_summary=count_summary=true はサポートされていません。
    • 特別な検索パラメータの _contentは、検索パラメータによって参照されるリソースのすべてのフィールドを検索します。検索できないフィールドは除外されます。明示的な AND(条件は暗黙的に AND で結合されます)や角かっこはサポートされていません。
    • 特別な検索パラメータの _query_filter はサポートされていません。
    • _sort パラメータは、繰り返し要素のあるフィールドで使用すると、最初の要素で並べ替えられます。これは仕様とは異なります。サポートされているすべての検索パラメータは、特別な検索パラメータの _content を除き、_sort の対象となります。

サポートされていない地域:

  • ほとんどの拡張オペレーションは実装されていません。
  • プロファイルはサーバーによって検証または適用されません。
  • ユーザー定義の検索パラメータはサポートされていません。
  • XML コンテンツ タイプはサポートされていません。

公開されている仕様以外の操作の詳細

  • FHIR gRPC API は、gRPCフレームワークを使用して FHIR の RPC インターフェースを提供します。これは標準ではなく開発中であり、すべての FHIR メソッドをサポートしているわけではありません。
  • FHIR ストア構成には、ストア内のリソースに対するすべての変更をユーザー指定の Pub/Sub トピックに通知するオプションが含まれています。この通知メカニズムはすべての Cloud Healthcare API ストアで共通であり、FHIR サブスクリプション(DSTU2STU3R4)の機能に代わるものではありません。
  • Cloud Storage のエクスポート先への FHIR ストア エクスポート オペレーションでは、ストア全体の一括エクスポートのみが可能です。これはFHIR バルクデータのドラフト仕様の実装ではありません。
  • FHIR ストアのインポート オペレーションは仕様で定義されていません。
  • リソースの履歴バージョンを削除する Resource-purge オペレーションは、仕様では定義されていません。この API は、標準プロセスや他の FHIR 実装がこのユースケースの別の API メソッドに集約される場合、将来変更される可能性があります。