AWS healthlake: Clarify PDex export scope, temporal limits, and referenced resources
Summary
Rewrites the DaVinci PDex data export documentation to explain which resources are exported (member data, medications, referenced providers for Payer-to-Payer, attributed providers), how _since/_until and temporal limits apply, and how _type filtering affects referenced resources. Also updates the Payer-to-Payer example request to include Practitioner, PractitionerRole, Organization, and Location.
Security assessment
The change is a functional/behavioral clarification of FHIR bulk-export scope and filtering semantics (which resources are included, how _since/_until/_type apply). It does not describe a vulnerability, credential handling, or a security control, so it is not security-related despite touching data-export scope.
Evidence
+For PDex exports, you do not need to reference clinical or claims resources in the Group resource. For Payer-to-Payer exports, you also do not need to reference the provider resources that the member data points to. A PDex export includes resources from the following sources:
Diff
diff --git a/healthlake/latest/devguide/reference-fhir-operations-davinci-data-export.md b/healthlake/latest/devguide/reference-fhir-operations-davinci-data-export.md index 999aa42..4792466 100644 --- a//healthlake/latest/devguide/reference-fhir-operations-davinci-data-export.md +++ b//healthlake/latest/devguide/reference-fhir-operations-davinci-data-export.md @@ -96 +96 @@ Export Type | Purpose | Data Scope | Temporal Limit -The 5-year temporal limit applies only to the Payer-to-Payer (`hl7.fhir.us.davinci-pdex.p2p`) and Member Access (`hl7.fhir.us.davinci-pdex.member`) export types. The Provider Access export types (`hl7.fhir.us.davinci-pdex` and `hl7.fhir.us.davinci-pdex#provider-snapshot`) have no temporal restriction. For the export types that are temporally limited, the 5-year limit does not apply to ATR resource types (`Group`, `Patient`, `Coverage`, `RelatedPerson`, `Practitioner`, `PractitionerRole`, `Organization`, `Location`). These resources are always included regardless of age. +The 5-year temporal limit applies only to the Payer-to-Payer (`hl7.fhir.us.davinci-pdex.p2p`) and Member Access (`hl7.fhir.us.davinci-pdex.member`) export types. The Provider Access export types (`hl7.fhir.us.davinci-pdex` and `hl7.fhir.us.davinci-pdex#provider-snapshot`) have no temporal restriction. For the export types that are temporally limited, the 5-year limit does not apply to ATR resource types (`Group`, `Patient`, `Coverage`, `RelatedPerson`, `Practitioner`, `PractitionerRole`, `Organization`, `Location`). These resources are not limited by age, but the `_since` and `_until` parameters still apply to them. @@ -129 +129,16 @@ All PDex export types share the same supported profiles and filtering logic. For -For PDex exports, clinical and claims resources are automatically discovered for each patient in the Group. You do not need to explicitly reference these resources in the Group resource. The operation searches for all patient-compartment resources (such as `Observation`, `Condition`, `Coverage`, `RelatedPerson`, `MedicationRequest`, and `ExplanationOfBenefit`) that belong to the attributed patients. Only `Patient`, `Group`, and non-patient-compartment ATR types (`Practitioner`, `PractitionerRole`, `Organization`, `Location`) require explicit references in the Group. +For PDex exports, you do not need to reference clinical or claims resources in the Group resource. For Payer-to-Payer exports, you also do not need to reference the provider resources that the member data points to. A PDex export includes resources from the following sources: + + * _Member data_ : For each patient in the Group, the operation searches for all patient-compartment resources (such as `Observation`, `Condition`, `Coverage`, `RelatedPerson`, `MedicationRequest`, and `ExplanationOfBenefit`). + + * _Medications_ : For all PDex export types, a `Medication` that an exported `MedicationRequest` or `MedicationDispense` references is also exported. + + * _Referenced providers (Payer-to-Payer only)_ : The operation also exports the `Practitioner`, `PractitionerRole`, `Organization`, and `Location` resources that the resources exported for the members reference, such as the practitioner on an `Encounter`, the agent on a `Provenance`, or the payer organization on a `Coverage`. It then follows the references in those provider resources, for example from a `PractitionerRole` to its `Practitioner` and from an `Organization` to its parent organization. The operation follows only relative references, such as `Practitioner/123`. It does not follow absolute URLs, references to contained resources, or references to a specific resource version. + + * _Attributed providers_ : For all PDex export types, the attributed providers in the Group (`Group.member.extension:attributedProvider`) are also exported. For Provider Access (`hl7.fhir.us.davinci-pdex` and `hl7.fhir.us.davinci-pdex#provider-snapshot`) and Member Access exports, provider resources come only from the attributed providers in the Group and the locations of attributed practitioner roles. + + + + +Referenced resources are subject to the same `_since`, `_until`, and temporal limits as other resources of their type. If the export finds no resources of a requested type, the output has no file for that type. For the resource types that you can export, see Supported Resource Types. + +When you specify `_type`, a referenced resource is exported only if its type is in `_type`. For example, to export practitioners that are referenced only through a `PractitionerRole` in a Payer-to-Payer export, include both `PractitionerRole` and `Practitioner` in `_type`. Similarly, a `Medication` is exported only if `Medication` and the referencing `MedicationRequest` or `MedicationDispense` type are in `_type`. @@ -288 +303 @@ _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 + GET https://healthlake.{region}.amazonaws.com/datastore/{datastoreId}/r4/Group/example-group/$davinci-data-export?_type=Patient,Coverage,ExplanationOfBenefit,Condition,Procedure,Practitioner,PractitionerRole,Organization,Location&exportType=hl7.fhir.us.davinci-pdex.p2p&_includeEOB2xWoFinancial=true @@ -318 +333 @@ The operation exports resources based on their relationships within the Member A -The preceding resource relationship diagram applies to ATR exports. For PDex exports, clinical and claims resources are automatically discovered through patient search and do not require explicit references in the Group resource. +This diagram applies to ATR exports. For PDex exports, clinical and claims resources are automatically discovered through patient search and do not require explicit references in the Group resource. For Payer-to-Payer exports, `Practitioner`, `PractitionerRole`, `Organization`, and `Location` resources are also exported when the resources exported for the members reference them. For more information about PDex exports, see PDex Export Types. @@ -332,0 +348,2 @@ Resource | Source Location | Description +For Payer-to-Payer exports, `Practitioner`, `PractitionerRole`, `Organization`, and `Location` resources are also exported from references in the exported resources, for example `Encounter.participant.individual`, `ExplanationOfBenefit.provider`, `Patient.generalPractitioner`, and `PractitionerRole.practitioner`. +