Get Subscription Status
Retrieve FHIR R6 Subscription status information.
Endpoint
GET /api/fhir/r6-ballot4/Subscription/$status
Base URL: https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r6-ballot4
Parameters
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id |
query | false | id | Filters by Subscription logical id. Repeat the parameter to request more than one Subscription. Use a valid FHIR search value for this parameter type. |
status |
query | false | code | Filters by the current Subscription status. Use a valid FHIR search value for this parameter type. |
Authorization
The supported authorization model uses OAuth 2.0 scopes issued by OCI Identity Domains. Send the access token as a bearer token. Resource-server definitions and issued access-token claims use canonical system/... scopes. Client grants and token requests use the corresponding ddfssystem/... form. For examples, see Reference: Authentication and Scopes.
| Context | Scope form |
|---|---|
| Resource-server definition | system/SubscriptionStatus.s and system/Subscription.s |
| Client grant/token request | ddfssystem/SubscriptionStatus.s and ddfssystem/Subscription.s |
Issued token's scope claim |
system/SubscriptionStatus.s and system/Subscription.s |
Although this operation is invoked on Subscription, authorize it with both SubscriptionStatus search authority and Subscription search authority. Both listed scopes are required. If the token includes the SubscriptionStatus scope but omits the Subscription scope, the operation can return HTTP 200 with an empty search-set Bundle instead of HTTP 403 because no Subscription results are authorized.
Behavior
Invokes the advertised type-level Subscription status operation.
FHIR Definition
Canonical: https://hl7.org/fhir/6.0.0-ballot4/subscription.html
Operation definition: https://hl7.org/fhir/6.0.0-ballot4/subscription-operation-status.html