View a markdown version of this page

FHIR R4 $ davinci-data-export 操作用于 HealthLake - AWS HealthLake

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

FHIR R4 $ davinci-data-export 操作用于 HealthLake

$davinci-data-export操作是一种异步 FHIR 操作,可用于从中 AWS HealthLake导出医疗保健数据。此操作支持多种导出类型,包括成员归因 (ATR)、PDEx 提供商访问和成员访问 API。 Payer-to-Payer它是标准 FHIR $export 操作的专用版本,旨在满足 DaVinci 实施指南的要求。

主要功能

  • 异步处理:遵循标准的 FHIR 异步请求模式

  • Group-Level 导出:导出特定群组资源内成员的数据

  • 多种导出类型:支持 ATR(成员归因)、PDEx 提供商访问和成员访问 API Payer-to-Payer

  • 全面的配置文件支持:包括美国核心、CARIN Blue Button 和 PDeX 配置文件

  • 灵活筛选:支持按患者、资源类型和时间范围进行筛选

  • NDJSON 输出:以换行符分隔的 JSON 格式提供数据

操作终端节点

GET [base]/Group/[id]/$davinci-data-export POST [base]/Group/[id]/$davinci-data-export

请求参数

参数 基数 说明
patient 0。。 * 要导出其数据的特定成员。如果省略,则导出组中的所有成员。
_type 0.. 1 Comma-delimited 要导出的 FHIR 资源类型列表。省略时,将包括指定导出类型的所有支持的资源类型。对于 ATR 导出,这默认为 8 种归因资源类型。对于PDeX的出口,这包括所有归因资源类型以及来自美国核心、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(非 Basis)配置文件并删除财务数据的ExplanationOfBenefit资源。导出的资源符合相应的 Basis 配置文件,但不会修改数据存储中的原始资源。此参数对已经申报 Basis 配置文件的资源没有影响,因为这些资源始终包含在内,并且会自动删除剩余的财务数据。默认值:false
_security 0。。 * meta.security编码值筛选导出的资源。使用system|code格式(竖线字符必须 URL-encoded 为 as%7C)。当提供多个值时,资源必须匹配所有值(和语义)。使用system|(尾部管道,无代码)匹配给定系统中的任何代码。
_tag 0。。 * meta.tag编码值筛选导出的资源。使用与相同的system|code格式和 AND 语义。_security如果同时指定_security了和,_tag则资源必须与两个过滤器匹配。
过滤_security 和 _tag 的行为

_security_tag过滤器适用于所有导出类型,包括hl7.fhir.us.davinci-atr。这些过滤器还支持以下 FHIR 搜索修饰符::not:missing:text:above、和。:below例如,您可以使用 _tag:not=archived_security:missing=true。该操作会从导出中排除任何与提供的过滤器不匹配的资源。

ExplanationOfBenefit 财务数据

无论资源是申报基数还是财务概况,都会从所有导出的 CARIN BB 2.x ExplanationOfBenefit 资源中删除以下财务数据字段:裁定金额、、、、paymenttotalbenefitPeriodbenefitBalance、以及项目和。net unitPrice这样可以确保财务数据不会在 Da Vinci 提供商访问权限和 Payer-to-Payer 路径上导出。 ExplanationOfBenefit仅声明 PDEx 事先授权配置文件(没有 CARIN BB 2.x 配置文件)的资源将保持不变地导出,并且不会删除任何财务数据。如果资源声明了两个配置文件,则财务数据将被剥离。

支持的资源类型

支持的资源类型取决于您指定的导出类型。对于 ATR 导出,支持以下资源类型:

  • Group

  • Patient

  • Coverage

  • RelatedPerson

  • Practitioner

  • PractitionerRole

  • Organization

  • Location

对于 PDeX 导出(提供者访问权限和成员访问权限),除了上述类型外,还支持所有临床和索赔资源类型。 Payer-to-Payer有关支持的资源类型的完整列表,请参阅《美国核心实施指南》(STU 6.1)、《C ARIN Blue Button 实施指南》和《达芬奇事先授权支持实施指南》。

导出类型

$davinci-data-export操作支持以下导出类型。您可以使用exportType参数指定导出类型。

导出类型 用途 数据范围 时间限制
hl7.fhir.us.davinci-atr 成员归因列表 Attribution-related 资源
hl7.fhir.us.davinci-pdex 提供商访问权限 API 归因患者的临床和索赔数据
hl7.fhir.us.davinci-pdex#provider-snapshot 提供商访问 API(快照) 归因患者的所有临床、事先授权和非财务索赔和会诊数据
hl7.fhir.us.davinci-pdex.p2p Payer-to-Payer 交易所 保险过渡的成员历史数据 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-pdexhl7.fhir.us.davinci-pdex#provider-snapshot)没有时间限制。对于有时间限制的导出类型,5 年限制不适用于 ATR 资源类型(Group、、、、PatientCoverageRelatedPersonPractitionerPractitionerRoleOrganizationLocation)。无论年龄大小,这些资源始终包括在内。

时间过滤基础

时间限制和_since_until参数是根据每种资源meta.lastUpdated的时间戳而不是临床或服务日期进行评估的。这为所有资源类型提供了一致的时间筛选。

ATR (hl7.fhir.us.davinci-atr)

使用 ATR 导出类型,您可以导出成员归因列表数据。使用此导出类型为群组中的成员检索与归因相关的资源。欲了解更多信息,请参阅达芬奇 ATR 出口业务

支持的资源类型

Group, Patient, Coverage, RelatedPerson, Practitioner, PractitionerRole, Organization, Location

时间过滤

不应用任何时间过滤。无论日期如何,都会导出所有匹配的资源。

PDex 导出类型

所有 PDex 导出类型都使用相同的支持的配置文件和筛选逻辑。欲了解更多信息,请参阅 Da Vinci PDeX 提供商访问 API。支持以下配置文件:

  • 美国核心 3.1.1、6.1.0 和 7.0.0

  • PDex 事先授权(不支持会员访问)

  • CARIN BB 2.x 基本概况:住院机构、门诊机构、专业、口腔 NonClinician、药房

对于PDeX的出口,系统会自动发现集团中每位患者的临床和理赔资源。您无需在组资源中明确引用这些资源。该手术会搜索属于归因患者的所有患者隔间资源(例如ObservationConditionCoverageRelatedPersonMedicationRequest、、、、和ExplanationOfBenefit)。只有PatientGroup、和非患者隔间 ATR 类型(Practitioner、、PractitionerRoleOrganizationLocation)需要在组中明确引用。

提供商访问权限 (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)

允许成员访问自己的健康数据。

个人资料 Support 和包含逻辑

对于 PDex 导出,该$davinci-data-export操作使用meta.profile元素中的配置文件声明来确定要在导出中包含哪些资源。

ExplanationOfBenefit 资源处理

ExplanationOfBenefit(EOB) 资源根据申报被纳入或排除在PDeX出口之外:meta.profile

  • ExplanationOfBenefit 带有 CARIN BB 1.x 配置文件的资源不包括在导出范围内。

  • ExplanationOfBenefit 未meta.profile设置的资源将从导出中排除。

  • ExplanationOfBenefit 始终包括具有 CARIN BB 2.x Basis 配置文件的资源,并删除所有剩余的财务数据,以便资源符合 CARIN BB 2.x Basis 配置文件。 Non-Financial

  • ExplanationOfBenefit 默认情况下,不包括包含财务数据的 CARIN BB 2.x 配置文件的资源。设置后_includeEOB2xWoFinancial=true,它们将包含在去除的财务数据中,并将资源转换为相应的 Basis 配置文件。

  • ExplanationOfBenefit 带有 PDeX 事先授权配置文件的资源始终包括在内。

财务数据剥离的配置文件优先级

当 ExplanationOfBenefit 资源声明多个配置文件时,财务数据剥离优先于直通。对于同时声明 Basis(或财务)配置文件和 PDEx 事先授权配置文件的资源,该操作会在导出资源之前删除财务数据。

财务数据转换

设置后_includeEOB2xWoFinancial=true,该操作会通过删除财务数据将 CARIN BB 2.x ExplanationOfBenefit 资源转换为相应的 Basis 配置文件。例如,将C4BB ExplanationOfBenefit Oral资源转换为C4BB ExplanationOfBenefit Oral Basis,这会根据 FHIR 规范从记录中删除财务数据。

该操作在两种情况下会删除以下财务数据元素:当它将CARIN BB 2.x财务资源转换为其基本配置文件时(使用_includeEOB2xWoFinancial=true),以及从CARIN BB 2.x Basis资源中删除剩余财务数据时:

  • total元素

  • payment元素

  • benefitPeriod元素

  • benefitBalance元素

  • adjudication金额条目(amount分段;保留benefitpaymentstatusbillingnetworkstatus等非财务分录)

  • item.net元素

  • item.unitPrice元素

  • item.adjudication金额条目

该操作还会在转换过程中更新配置文件元数据:

  • meta.profile已更新为 Basis 配置文件规范 URL

  • 版本已更新至 CARIN BB 2.x Basis 版本

  • 数据存储中的现有资源未被修改

  • 导出的资源不会保留回数据存储中

配置文件检测规则

该操作使用以下规则来检测和验证配置文件:

  • 版本检测基于规meta.profile范 URL

  • 如果资源声明的任何配置文件符合导出标准,则包含该资源

  • 配置文件验证是在导出处理过程中进行的

对 PDex 导出的时间过滤

HealthLake 对 Payer-to-Payer (hl7.fhir.us.davinci-pdex.p2p) 和成员访问权限 (hl7.fhir.us.davinci-pdex.member) 导出类型应用 5 年时间过滤器。筛选条件基于资源上次更新的时间。提供者访问权限导出类型(hl7.fhir.us.davinci-pdexhl7.fhir.us.davinci-pdex#provider-snapshot)不受任何时间限制。对于有时间限制的导出类型,筛选条件适用于除以下核心归因资源类型之外的所有资源,这些资源无论使用年限如何,都将始终导出:

  • Patient

  • Coverage

  • Organization

  • Practitioner

  • PractitionerRole

  • RelatedPerson

  • Location

  • Group

这些管理和人口资源是免税的,因为它们为导出的数据提供了基本的背景信息。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 输入端点 归因列表本身

Job 管理

查看 Job 状态

GET [base]/export/[job-id]

取消作业

DELETE [base]/export/[job-id]

作业生命周期

  • SUBMITTED-已接收 Job 并已排队

  • IN_PROGRESS-Job 正在处理中

  • COMPLETED-Job 成功完成,文件可供下载

  • FAILED-Job 遇到了错误

输出格式

  • 文件格式:NDJSON(以换行符分隔的 JSON)

  • 文件组织:每种资源类型都有单独的文件

  • 文件扩展名:.ndjson

  • 位置:指定的 S3 存储桶和路径

错误处理

如果出现以下情况,该操作会返回 HTTP 400 错误请求: OperationOutcome

授权错误

中指定的 IAM 角色DataAccessRoleArn没有足够的权限来执行导出操作。有关所需的 S3 和 KMS 权限的完整列表,请参阅为导出任务设置权限

参数验证错误
  • patient参数的格式未设置为 Patient/id,Patient/id,...

  • 一个或多个患者推荐无效或不属于指定群体

  • exportType参数值不是支持的导出类型

  • _type参数包含指定导出类型不支持的资源类型

  • _type参数缺少hl7.fhir.us.davinci-atr导出类型所需的资源类型 (GroupPatient、、Coverage)

  • _includeEOB2xWoFinancial参数值不是有效的布尔值

资源验证错误
  • 数据存储中不存在指定的组资源

  • 指定的群组资源没有成员

  • 一个或多个小组成员引用了数据存储中不存在的患者资源

安全和授权

$davinci-data-export是通过 IAM 权限或系统级 SMART 在 FHIR (OAuth 2.0) 范围内授权的后端批量操作;呈现患者级或用户级范围的请求将被拒绝。该操作不会评估 FHIR 同意资源来筛选或限制导出的数据。

  • 适用标准的 FHIR 授权机制

  • 数据访问角色必须具有 S3 和 KMS 操作所需的 IAM 权限。有关所需权限的完整列表,请参阅为导出任务设置权限

最佳实践

  • 资源类型选择:仅请求所需的资源类型,以最大限度地减少导出大小和处理时间

  • Time-Based 筛选:使用_since参数进行增量导出

  • 患者筛选:当您只需要特定成员的数据时,请使用该patient参数

  • Job 监控:定期检查大宗出口的任务状态

  • 错误处理:为失败的作业实现正确的重试逻辑

  • 时间过滤器感知:对于 Payer-to-Payer 和成员访问权限的导出,在选择资源类型时请考虑使用 5 年时间过滤器

  • 删除财务数据_includeEOB2xWoFinancial=true当您需要不包含财务信息的索赔数据时使用

  • 配置文件管理:确保资源具有适当的配置文件声明,在摄取之前根据目标配置文件进行验证,并使用配置文件版本控制导出行为

限制

  • patient参数中最多可以指定 500 名患者

  • 导出仅限于 Group-level 操作

  • 仅支持每种导出类型的预定义资源类型集

  • 输出始终采用 NDJSON 格式

  • Payer-to-Payer 而且 Member Access 的导出仅限于 5 年的临床和索赔数据

  • 财务数据转换仅适用于 CARIN BB 2.x 配置文件 ExplanationOfBenefit

其他资源