AWS healthlake: Clarify required SMART scopes for $bulk-member-match
Summary
Rewrites the authorization section of the $bulk-member-match operation to state that HealthLake uses SMART scopes to authorize each resource read/written, converts previously 'conditional' Organization/Practitioner/PractitionerRole/Consent scopes into required scopes, notes that HealthLake validates scopes at job submission and may read resources referenced by Coverage.payor or Consent.performer, and states that only system-level scopes are accepted (patient- and user-level scopes are rejected).
Security assessment
The change documents the authorization model for a bulk PHI operation: it enumerates the exact SMART scopes required, states that scopes are validated at job submission, and explicitly restricts the operation to system-level scopes while rejecting patient- and user-level scopes. This tightens/clarifies least-privilege authorization expectations for accessing Patient, Coverage, Consent, and related resources, but it documents existing behavior rather than fixing a specific vulnerability.
Evidence
+HealthLake accepts only system-level scopes for this operation and rejects patient-level and user-level scopes. For more information about scopes, see [SMART on FHIR OAuth 2.0 scopes supported by HealthLake](./reference-smart-on-fhir-oauth-scopes.html).
Diff
diff --git a/healthlake/latest/devguide/reference-fhir-operations-bulk-member-match.md b/healthlake/latest/devguide/reference-fhir-operations-bulk-member-match.md index fb60e18..af5120d 100644 --- a//healthlake/latest/devguide/reference-fhir-operations-bulk-member-match.md +++ b//healthlake/latest/devguide/reference-fhir-operations-bulk-member-match.md @@ -627 +627 @@ The `$bulk-member-match` operation is designed for high-volume processing and ru -The API uses SMART on FHIR authorization protocol with the following required scopes: +HealthLake uses SMART scopes to authorize each resource that a bulk member match job reads or writes. For a SMART on FHIR enabled data store, your access token must include all of the following scopes: @@ -629 +629 @@ The API uses SMART on FHIR authorization protocol with the following required sc - * `system/Patient.read` — Required to search and match patient resources. + * `system/Patient.read` – Required to search and match patient resources. @@ -631 +631 @@ The API uses SMART on FHIR authorization protocol with the following required sc - * `system/Coverage.read` — Required to validate coverage information. + * `system/Coverage.read` – Required to validate coverage information. @@ -633 +633 @@ The API uses SMART on FHIR authorization protocol with the following required sc - * `system/Group.write` — Required to create result Group resources. + * `system/Group.write` – Required to create result Group resources. @@ -635 +635 @@ The API uses SMART on FHIR authorization protocol with the following required sc - * `system/Organization.read` — Conditional, required if coverage references organizations. + * `system/Organization.read` – Required to read Organization resources referenced from `Coverage.payor` or `Consent.performer`. @@ -637 +637 @@ The API uses SMART on FHIR authorization protocol with the following required sc - * `system/Practitioner.read` — Conditional, required if coverage references practitioners. + * `system/Practitioner.read` – Required to read Practitioner resources referenced from `Coverage.payor` or `Consent.performer`. @@ -639 +639 @@ The API uses SMART on FHIR authorization protocol with the following required sc - * `system/PractitionerRole.read` — Conditional, required if coverage references practitioner roles. + * `system/PractitionerRole.read` – Required to read PractitionerRole resources referenced from `Coverage.payor` or `Consent.performer`. @@ -641 +641 @@ The API uses SMART on FHIR authorization protocol with the following required sc - * `system/Consent.write` — Conditional, required if consent resources are provided. + * `system/Consent.write` – Required to process the Consent resource that the request provides. @@ -645,0 +646,4 @@ The API uses SMART on FHIR authorization protocol with the following required sc +HealthLake validates these scopes when you submit the job. During the job, HealthLake might read the Organization, Practitioner, and PractitionerRole resources that `Coverage.payor` or `Consent.performer` references. + +HealthLake accepts only system-level scopes for this operation and rejects patient-level and user-level scopes. For more information about scopes, see [SMART on FHIR OAuth 2.0 scopes supported by HealthLake](./reference-smart-on-fhir-oauth-scopes.html). +