Subscription Status
Retrieve Subscription Status information for FHIR R6 Subscription resources.
The $status operations return a FHIR search-set Bundle containing SubscriptionStatus resources. The type-level operation accepts optional status and id parameters; repeat id to request multiple logical IDs. A request that matches no current Subscription returns HTTP 200 with an empty search-set Bundle. SubscriptionStatus is an operation result, not a separately managed CRUD resource.
See also
Authorization
Although these operations are invoked on Subscription, authorization requires matching scopes for both SubscriptionStatus and Subscription. For the corresponding resource-server and client scope forms, see Common Scope Configuration Examples.
| Operation | Client grant/token request | Issued token's scope claim |
|---|---|---|
Type-level Subscription/$status |
ddfssystem/SubscriptionStatus.s and ddfssystem/Subscription.s |
system/SubscriptionStatus.s and system/Subscription.s |
Instance-level Subscription/{rid}/$status |
ddfssystem/SubscriptionStatus.r and ddfssystem/Subscription.r |
system/SubscriptionStatus.r and system/Subscription.r |
Both scopes shown for an operation are required. If the token includes the SubscriptionStatus scope but omits the matching Subscription scope, the operation can return HTTP 200 with an empty search-set Bundle instead of HTTP 403 because no Subscription results are authorized.