翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
HealthLake の FHIR R4 $davinci-data-exportオペレーション
$davinci-data-export オペレーションは、医療データのエクスポートに使用できる非同期 FHIR オペレーションです AWS HealthLake。このオペレーションは、メンバー属性 (ATR)、PDex プロバイダーアクセス、Payer-to-Payer、メンバーアクセス APIs など、複数のエクスポートタイプをサポートしています。これは、DaVinci 実装ガイドの要件を満たすように設計された、標準の FHIR $exportオペレーションの特殊なバージョンです。
主な機能
非同期処理: 標準の FHIR 非同期リクエストパターンに従います
グループレベルのエクスポート: 特定のグループリソース内のメンバーのデータをエクスポートします。
複数のエクスポートタイプ: ATR (メンバー属性)、PDex プロバイダーアクセス、Payer-to-Payer、およびメンバーアクセス APIsをサポート
包括的なプロファイルのサポート: US Core、CARIN Blue ボタン、PDex プロファイルが含まれます
柔軟なフィルタリング: 患者、リソースタイプ、時間範囲によるフィルタリングをサポート
NDJSON 出力: データを改行区切りの JSON 形式で提供します
オペレーションエンドポイント
GET [base]/Group/[id]/$davinci-data-export POST [base]/Group/[id]/$davinci-data-export
リクエストパラメーター
| パラメータ | カーディナリティ | 説明 |
|---|---|---|
patient |
0..* | エクスポートするデータを持つ特定のメンバー。省略すると、グループ内のすべてのメンバーがエクスポートされます。 |
_type |
0..1 | エクスポートする FHIR リソースタイプのカンマ区切りリスト。省略すると、指定されたエクスポートタイプでサポートされているすべてのリソースタイプが含まれます。ATR エクスポートの場合、デフォルトで 8 つの属性リソースタイプになります。PDex エクスポートの場合、これには、すべての属性リソースタイプに加えて、US Core、CARIN Blue Button、および PDex プロファイルからの臨床リソースタイプとクレームリソースタイプが含まれます。 |
_since |
0..1 | この日時以降に更新されたリソースのみを含めます。 |
_until |
0..1 | この日時より前に更新されたリソースのみを含めます。 |
exportType |
0..1 | 実行するエクスポートのタイプ。有効な値: hl7.fhir.us.davinci-atr (ATR)、 hl7.fhir.us.davinci-pdex (プロバイダーアクセス)、 hl7.fhir.us.davinci-pdex#provider-snapshot (プロバイダーアクセススナップショット)、 hl7.fhir.us.davinci-pdex.p2p (Payer-to-Payer)、 hl7.fhir.us.davinci-pdex.member (メンバーアクセス)。デフォルト: hl7.fhir.us.davinci-atr。 |
_includeEOB2xWoFinancial |
0..1 | に設定するとtrue、 には、財務データが取り除かれたエクスポートで CARIN BB 2.x Financial (非ベース) プロファイルを宣言するExplanationOfBenefitリソースが含まれます。エクスポートされたリソースは対応する Basis プロファイルに準拠していますが、データストアの元のリソースは変更されません。このパラメータは、既に Basis プロファイルを宣言しているリソースには影響しません。これらのリソースは常に含まれ、残余財務データは自動的に削除されるためです。デフォルト: false。 |
_security |
0..* | エクスポートされたリソースをmeta.securityコーディング値でフィルタリングします。system|code 形式を使用します (パイプ文字は として URL エンコードされている必要があります%7C)。複数の値を指定する場合、リソースはそれらすべて (AND セマンティクス) と一致する必要があります。system| (証跡パイプ、コードなし) を使用して、特定のシステムのコードに一致させます。 |
_tag |
0..* | エクスポートされたリソースをmeta.tagコーディング値でフィルタリングします。と同じsystem|code形式と AND セマンティクスを使用します_security。_security と の両方を指定する場合、リソース_tagは両方のフィルターと一致する必要があります。 |
_security と _tag のフィルタ動作
_security および _tagフィルターは、 を含むすべてのエクスポートタイプに適用されますhl7.fhir.us.davinci-atr。これらのフィルターは、、:not、:missing、:text、:aboveおよび の FHIR 検索修飾子もサポートしています:below。たとえば、_tag:not=archived または _security:missing=true を使用できます。オペレーションは、指定されたフィルターと一致しないリソースをエクスポートから除外します。
ExplanationOfBenefit 財務データ
次の財務データフィールドは、ExplanationOfBenefitリソースが Basis と財務プロファイルのどちらを宣言するかにかかわらず、エクスポートされたすべての CARIN BB 2.x リソースから削除されます: 判定額、、payment、totalbenefitPeriod、benefitBalance、および項目と net unitPrice。これにより、Da Vinci プロバイダーアクセスパスと Payer-to-Payer パスに財務データがエクスポートされません。PDex 事前認可プロファイルのみを宣言するExplanationOfBenefitリソース (CARIN BB 2.x プロファイルなし) は変更されずにエクスポートされ、財務データは削除されません。リソースが両方のプロファイルを宣言すると、財務データは削除されます。
サポートされているリソースタイプ
サポートされているリソースタイプは、指定したエクスポートタイプによって異なります。ATR エクスポートでは、次のリソースタイプがサポートされています。
GroupPatientCoverageRelatedPersonPractitionerPractitionerRoleOrganizationLocation
PDex エクスポート (プロバイダーアクセス、Payer-to-Payer、メンバーアクセス) では、前述のタイプに加えて、すべての臨床リソースタイプとクレームリソースタイプがサポートされています。サポートされているリソースタイプの詳細なリストについては、US Core Implementation Guide (STU 6.1)
エクスポートタイプ
$davinci-data-export オペレーションでは、次のエクスポートタイプがサポートされています。エクスポートタイプは、 exportTypeパラメータを使用して指定します。
| エクスポートタイプ | 目的 | データスコープ | 一時的な制限 |
|---|---|---|---|
hl7.fhir.us.davinci-atr |
メンバー属性リスト | 属性関連のリソース | なし |
hl7.fhir.us.davinci-pdex |
プロバイダーアクセス API | 属性患者の臨床データとクレームデータ | なし |
hl7.fhir.us.davinci-pdex#provider-snapshot |
プロバイダーアクセス API (スナップショット) | すべての臨床、事前認可、財務以外のクレームと、属性のある患者の遭遇データ | なし |
hl7.fhir.us.davinci-pdex.p2p |
Payer-to-Payer Exchange | 保険移行の履歴メンバーデータ | 5 年 |
hl7.fhir.us.davinci-pdex.member |
メンバーアクセス API | メンバー自身のヘルスデータ | 5 年 |
エクスポートタイプ別の一時的な制限
5 年間の時間制限は、Payer-to-Payer (hl7.fhir.us.davinci-pdex.p2p) およびメンバーアクセス (hl7.fhir.us.davinci-pdex.member) のエクスポートタイプにのみ適用されます。プロバイダーアクセスエクスポートタイプ (hl7.fhir.us.davinci-pdex および hl7.fhir.us.davinci-pdex#provider-snapshot) には一時的な制限はありません。一時的に制限されるエクスポートタイプの場合、5 年の制限は ATR リソースタイプ (Group、Patient、、Coverage、RelatedPerson、Practitioner、PractitionerRole、) Organizationには適用されませんLocation。これらのリソースは、年齢に関係なく常に含まれます。
一時的なフィルタリングベース
一時的な制限と _sinceおよび _untilパラメータは、臨床またはサービスの日付ではなく、各リソースのmeta.lastUpdatedタイムスタンプに対して評価されます。これにより、すべてのリソースタイプで一貫した時間フィルタリングが提供されます。
ATR (hl7.fhir.us.davinci-atr)
ATR エクスポートタイプを使用すると、メンバー属性リストデータをエクスポートできます。このエクスポートタイプを使用して、グループ内のメンバーの属性関連のリソースを取得します。詳細については、「Da Vinci ATR Export Operation
- サポートされているリソースタイプ
Group,Patient,Coverage,RelatedPerson,Practitioner,PractitionerRole,Organization,Location- 一時フィルタリング
一時的なフィルタリングは適用されません。一致するすべてのリソースは、日付に関係なくエクスポートされます。
PDex エクスポートタイプ
すべての PDex エクスポートタイプは、サポートされている同じプロファイルとフィルタリングロジックを共有します。詳細については、「Da Vinci PDex Provider Access API
US Core 3.1.1、6.1.0、および 7.0.0
PDex 事前認可 (メンバーアクセスではサポートされていません)
CARIN BB 2.x Basis プロファイル: 入院患者用、入院患者用、専門のNonClinician、オーラル用、学用用
PDex エクスポートの場合、 グループの患者ごとに臨床リソースとクレームリソースが自動的に検出されます。グループリソースでこれらのリソースを明示的に参照する必要はありません。オペレーションは、属性化された患者に属するすべての患者セグメントリソース (Observation、Condition、CoverageRelatedPerson、MedicationRequest、、 などExplanationOfBenefit) を検索します。Patient、Group、およびnon-patient-compartment ATR タイプ (Practitioner、PractitionerRole、Organization、Location) のみが、 グループで明示的な参照を必要とします。
- プロバイダーアクセス (
hl7.fhir.us.davinci-pdex) ネットワーク内プロバイダーが属性患者の患者データを取得できるようにします。
- プロバイダーアクセス — スナップショット (
hl7.fhir.us.davinci-pdex#provider-snapshot) 属性された患者のすべての臨床、事前認可、非財務クレームと遭遇データの完全なスナップショットを返します。このエクスポートタイプは と同じ動作を
hl7.fhir.us.davinci-pdexし、時間制限の対象にはなりません。- Payer-to-Payer (
hl7.fhir.us.davinci-pdex.p2p) 患者が保険を変更するときに、支払者間のデータ交換を有効にします。
- メンバーアクセス (
hl7.fhir.us.davinci-pdex.member) メンバーが自分のヘルスデータにアクセスできるようにします。
プロファイルのサポートと包含ロジック
PDex エクスポートの場合、 $davinci-data-exportオペレーションは meta.profile要素のプロファイル宣言を使用して、エクスポートに含めるリソースを決定します。
ExplanationOfBenefit リソース処理
ExplanationOfBenefit (EOB) リソースは、meta.profile宣言に基づいて PDex エクスポートに含まれるか除外されます。
CARIN BB 1.x プロファイルを持つ ExplanationOfBenefit リソースはエクスポートから除外されます。
meta.profile設定されていない ExplanationOfBenefit リソースはエクスポートから除外されます。CARIN BB 2.x Basis プロファイルを持つ ExplanationOfBenefit リソースは常に含まれ、リソースが CARIN BB 2.x Non-Financial Basis プロファイルに準拠するように、残余財務データは削除されます。
財務データを含む CARIN BB 2.x プロファイルを持つ ExplanationOfBenefit リソースは、デフォルトで除外されます。
_includeEOB2xWoFinancial=trueが設定されている場合、それらは削除された財務データに含まれ、リソースは対応する Basis プロファイルに変換されます。PDex 事前認可プロファイルを持つ ExplanationOfBenefit リソースは常に含まれます。
財務データストリッピングのプロファイルの優先順位
ExplanationOfBenefit リソースが複数のプロファイルを宣言すると、財務データのストライピングがパススルーよりも優先されます。ベース (または財務) プロファイルと PDex 事前認可プロファイルの両方を宣言するリソースの場合、オペレーションはリソースをエクスポートする前に財務データを削除します。
財務データ変換
を設定すると_includeEOB2xWoFinancial=true、オペレーションは財務データを削除して CARIN BB 2.xC4BB ExplanationOfBenefit Oralリソースは に変換されC4BB ExplanationOfBenefit Oral Basis、FHIR 仕様に従ってレコードから財務データが削除されます。
オペレーションは、次の 2 つのシナリオで財務データ要素を削除します。CARIN BB 2.x Financial リソースを Basis プロファイルに変換する場合 ( を使用_includeEOB2xWoFinancial=true)、および CARIN BB 2.x Basis リソースから残余財務データを削除する場合。
total要素payment要素benefitPeriod要素benefitBalance要素adjudication金額エントリ (amountスライス。benefitpaymentstatusや などの非財務エントリbillingnetworkstatusは保持されます)item.net要素item.unitPrice要素item.adjudication金額エントリ
このオペレーションは、変換中にプロファイルメタデータも更新します。
meta.profileが Basis プロファイルの正規 URL に更新されましたバージョンが CARIN BB 2.x Basis バージョンに更新されました
データストア内の既存のリソースは変更されません
エクスポートされたリソースはデータストアに保持されません
プロファイル検出ルール
オペレーションでは、次のルールを使用してプロファイルを検出および検証します。
バージョン検出は
meta.profile正規 URLsに基づいています宣言されたプロファイルのいずれかがエクスポート基準に一致する場合、リソースが含まれます。
プロファイルの検証はエクスポート処理中に行われます
PDex エクスポートの一時フィルタリング
HealthLake は、Payer-to-Payer (hl7.fhir.us.davinci-pdex.p2p) およびメンバーアクセス (hl7.fhir.us.davinci-pdex.member) のエクスポートタイプに 5 年間の一時フィルターを適用します。フィルターは、リソースが最後に更新された日時に基づきます。プロバイダーアクセスのエクスポートタイプ (hl7.fhir.us.davinci-pdex および hl7.fhir.us.davinci-pdex#provider-snapshot) には時間制限はありません。時間的に制限されたエクスポートタイプの場合、フィルターは、経過時間に関係なく常にエクスポートされる次のコア属性リソースタイプを除くすべてのリソースに適用されます。
PatientCoverageOrganizationPractitionerPractitionerRoleRelatedPersonLocationGroup
これらの管理リソースと属性リソースは、エクスポートされたデータに不可欠なコンテキストを提供するため、除外されます。ATR エクスポートは一時的なフィルタリングの対象ではありません。
リクエスト例
次の例は、さまざまなエクスポートタイプのエクスポートジョブを開始する方法を示しています。
ATR エクスポート
GET https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?_type=Group,Patient,Coverage,Practitioner,Organization&exportType=hl7.fhir.us.davinci-atr POST https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?_type=Group,Patient,Coverage,Practitioner,Organization&exportType=hl7.fhir.us.davinci-atr Content-Type: application/json { "DataAccessRoleArn": "arn:aws:iam::444455556666:role/your-healthlake-service-role", "JobName": "attribution-export-job", "OutputDataConfig": { "S3Configuration": { "S3Uri": "s3://your-export-bucket/EXPORT-JOB", "KmsKeyId": "arn:aws:kms:region:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab" } } }
ExplanationOfBenefit 財務データの削除によるプロバイダーアクセスのエクスポート
GET https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?_type=Patient,Observation,Condition,MedicationRequest,ExplanationOfBenefit&exportType=hl7.fhir.us.davinci-pdex&_includeEOB2xWoFinancial=true
プロバイダーアクセススナップショットのエクスポート
GET https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?exportType=hl7.fhir.us.davinci-pdex%23provider-snapshot
Payer-to-Payer エクスポート
GET https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?_type=Patient,Coverage,ExplanationOfBenefit,Condition,Procedure&exportType=hl7.fhir.us.davinci-pdex.p2p&_includeEOB2xWoFinancial=true
特定の患者のメンバーアクセスエクスポート
GET https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?_type=Patient,Observation,Condition,ExplanationOfBenefit,MedicationRequest&exportType=hl7.fhir.us.davinci-pdex.member&patient=Patient/example-patient-id
レスポンス例
{ "datastoreId": "eaee622d8406b41eb86c0f4741201ff9", "jobStatus": "SUBMITTED", "jobId": "48d7b91dae4a64d00d54b70862f33f61" }
リソース関係
オペレーションは、メンバー属性リスト内の関係に基づいてリソースをエクスポートします。
Group (Attribution List) ├── Patient (Members) ├── Coverage → RelatedPerson (Subscribers) ├── Practitioner (Attributed Providers) ├── PractitionerRole → Location └── Organization (Attributed Providers)
注記
前述のリソース関係図は、ATR エクスポートに適用されます。PDex エクスポートの場合、臨床リソースとクレームリソースは患者検索によって自動的に検出され、グループリソースで明示的な参照は必要ありません。
リソースソース
| [リソース] | ソースの場所 | 説明 |
|---|---|---|
Patient |
Group.member.entity |
属性リストのメンバーである患者 |
Coverage |
Group.member.extension:coverageReference |
患者メンバーシップにつながるカバレッジ |
Organization |
Group.member.extension:attributedProvider |
患者が属する組織 |
Practitioner |
Group.member.extension:attributedProvider |
患者が属する個々の実務者 |
PractitionerRole |
Group.member.extension:attributedProvider |
患者が属するプラクティショナーロール |
RelatedPerson |
Coverage.subscriber |
カバレッジのサブスクライバー |
Location |
PractitionerRole.location |
プラクティショナーロールに関連付けられた場所 |
Group |
入力エンドポイント | 属性リスト自体 |
ジョブ管理
- ジョブのステータスを確認する
GET [base]/export/[job-id]- ジョブをキャンセルする
DELETE [base]/export/[job-id]
ジョブのライフサイクル
SUBMITTED- ジョブが受信およびキューに入れられましたIN_PROGRESS- ジョブはアクティブに処理中ですCOMPLETED- ジョブが正常に終了し、ダウンロード可能なファイルFAILED- ジョブでエラーが発生しました
[Output Format] (出力形式)
ファイル形式: NDJSON (Newline Delimited JSON)
File Organization: リソースタイプごとにファイルを区切ります。
ファイル拡張子: .ndjson
場所: 指定された S3 バケットとパス
エラー処理
オペレーションは、以下の条件で HTTP 400 Bad Request with an OperationOutcome を返します。
- 認可エラー
-
で指定された IAM ロールには、エクスポートオペレーションを実行するための十分なアクセス許可
DataAccessRoleArnがありません。必要な S3 および KMS アクセス許可の完全なリストについては、「エクスポートジョブのアクセス許可の設定」を参照してください。 - パラメータ検証エラー
-
patientパラメータは としてフォーマットされていませんPatient/id,Patient/id,...1 つ以上の患者参照が無効であるか、指定されたグループに属していません
exportTypeパラメータ値がサポートされているエクスポートタイプではありません_typeパラメータには、指定されたエクスポートタイプでサポートされていないリソースタイプが含まれます。_typeパラメータにhl7.fhir.us.davinci-atrエクスポートタイプに必要なリソースタイプ (Group、Patient、Coverage) がありません_includeEOB2xWoFinancialパラメータ値が有効なブール値ではありません
- リソース検証エラー
-
指定されたグループリソースがデータストアに存在しません
指定されたグループリソースにはメンバーがありません
1 人以上のグループメンバーが、データストアに存在しない患者リソースを参照する
セキュリティと認可
$davinci-data-export は、IAM アクセス許可またはシステムレベルの SMART on FHIR (OAuth 2.0) スコープを通じて承認されたバックエンド一括オペレーションです。患者レベルまたはユーザーレベルのスコープを提示するリクエストは拒否されます。オペレーションでは、エクスポートされたデータをフィルタリングまたは制限するための FHIR 同意リソースは評価されません。
標準の FHIR 認可メカニズムが適用されます
データアクセスロールには、S3 および KMS オペレーションに必要な IAM アクセス許可が必要です。必要なアクセス許可の完全なリストについては、「エクスポートジョブのアクセス許可の設定」を参照してください。
ベストプラクティス
リソースタイプの選択: エクスポートサイズと処理時間を最小限に抑えるために必要なリソースタイプのみをリクエストする
時間ベースのフィルタリング: 増分エクスポートに
_sinceパラメータを使用する患者のフィルタリング: 特定のメンバーのデータのみが必要な場合は、
patientパラメータを使用します。ジョブのモニタリング: 大規模なエクスポートのジョブステータスを定期的にチェックする
エラー処理: 失敗したジョブに適切な再試行ロジックを実装する
一時フィルターの認識: Payer-to-Payer およびメンバーアクセスのエクスポートでは、リソースタイプを選択するときに 5 年間の一時フィルターを検討してください。
財務データの削除: 財務情報のないクレームデータ
_includeEOB2xWoFinancial=trueが必要な場合に使用します。プロファイル管理: リソースに適切なプロファイル宣言があることを確認し、取り込み前にターゲットプロファイルと照合して検証し、プロファイルのバージョニングを使用してエクスポート動作を制御します。
制限事項
patientパラメータでは最大 500 人の患者を指定できますエクスポートはグループレベルのオペレーションのみに制限されます
は、エクスポートタイプごとに事前定義されたリソースタイプのセットのみをサポートします。
出力は常に NDJSON 形式です
Payer-to-Payer およびメンバーアクセスのエクスポートは、5 年間の臨床データとクレームデータに制限されます。
財務データ変換は CARIN BB 2.x ExplanationOfBenefit プロファイルにのみ適用されます