FHIR R4 $davinci-data-export operation for HealthLake

The $davinci-data-export operation is an asynchronous FHIR operation that you can use to export healthcare data from AWS HealthLake. This operation supports multiple export types, including Member Attribution (ATR), PDex Provider Access, Payer-to-Payer, and Member Access APIs. It is a specialized version of the standard FHIR $export operation, designed to meet the requirements of the DaVinci implementation guides.

Key Features

Operation Endpoint

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

Request Parameters

Supported Resource Types

The supported resource types depend on the export type you specify. For ATR exports, the following resource types are supported:

For PDex exports (Provider Access, Payer-to-Payer, and Member Access), all clinical and claims resource types are supported in addition to the preceding types. For a complete list of supported resource types, see the US Core Implementation Guide (STU 6.1), the CARIN Blue Button Implementation Guide, and the Da Vinci Prior Authorization Support Implementation Guide.

Export Types

The $davinci-data-export operation supports the following export types. You specify the export type by using the exportType parameter.

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

With the ATR export type, you can export Member Attribution List data. Use this export type to retrieve attribution-related resources for members within a Group. For more information, see the Da Vinci ATR Export Operation.

PDex Export Types

All PDex export types share the same supported profiles and filtering logic. For more information, see the Da Vinci PDex Provider Access API. The following profiles are supported:

Profile Support and Inclusion Logic

For PDex exports, the $davinci-data-export operation uses profile declarations in the meta.profile element to determine which resources to include in the export.

ExplanationOfBenefit Resource Handling

ExplanationOfBenefit (EOB) resources are included or excluded from PDex exports based on their meta.profile declarations:

Financial Data Transformation

When you set _includeEOB2xWoFinancial=true, the operation transforms CARIN BB 2.x ExplanationOfBenefit resources to their corresponding Basis profiles by removing financial data. For example, a C4BB ExplanationOfBenefit Oral resource is transformed to C4BB ExplanationOfBenefit Oral Basis, which strips financial data from the record per the FHIR specification.

The following financial data elements are removed during transformation:

The operation also updates profile metadata during transformation:

Profile Detection Rules

The operation uses the following rules to detect and validate profiles:

Five-Year Temporal Filtering for PDex Exports

For all PDex export types, HealthLake applies a 5-year temporal filter based on when the resource was last updated. The temporal filter applies to all resources except the following core attribution resource types, which are always exported regardless of age:

These administrative and demographic resources are exempt because they provide essential context for the exported data. ATR exports are not subject to any temporal filtering.

Sample Requests

The following examples show how to start export jobs for different export types.

ATR export

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"
    }
  }
}

Provider Access export with ExplanationOfBenefit financial data removal

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

Payer-to-Payer export

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

Member Access export for a specific patient

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

Sample Response

{
  "datastoreId": "eaee622d8406b41eb86c0f4741201ff9",
  "jobStatus": "SUBMITTED",
  "jobId": "48d7b91dae4a64d00d54b70862f33f61"
}

Resource Relationships

The operation exports resources based on their relationships within the Member Attribution List:

Group (Attribution List)
├── Patient (Members)
├── Coverage → RelatedPerson (Subscribers)
├── Practitioner (Attributed Providers)
├── PractitionerRole → Location
└── Organization (Attributed Providers)

Resource Sources

Job Management

Job Lifecycle

Output Format

Error Handling

The operation returns HTTP 400 Bad Request with an OperationOutcome for the following conditions:

Security and Authorization

Best Practices

Limitations

Additional Resources