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
Authorize the type-level operation with Subscription search permission and the instance-level operation with Subscription read permission. Grant and request ddfssystem/Subscription.s or ddfssystem/Subscription.r, respectively; issued tokens use the corresponding system/Subscription.s or system/Subscription.r scope. A separate SubscriptionStatus scope is not required. A token without the required Subscription permission receives HTTP 403. Parameterized Subscription scopes continue to restrict the authorized results.
| Operation | Client grant/token request | Issued token's scope claim |
|---|---|---|
Type-level Subscription/$status |
ddfssystem/Subscription.s |
system/Subscription.s |
Instance-level Subscription/{rid}/$status |
ddfssystem/Subscription.r |
system/Subscription.r |
A token without the required Subscription permission receives HTTP 403. A SubscriptionStatus scope alone does not authorize either operation. Parameterized Subscription scopes continue to restrict the authorized results.