Get Subscription Status for a Subscription
Retrieve FHIR R6 Subscription status information by logical ID.
Endpoint
GET /api/fhir/r6-ballot4/Subscription/{rid}/$status
Base URL: https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r6-ballot4
Parameters
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
rid |
path | true | FHIR logical ID string | Logical id of the Subscription resource. Use the logical id of the resource. |
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/Subscription.r |
| Client grant/token request | ddfssystem/Subscription.r |
Issued token's scope claim |
system/Subscription.r |
This operation requires Subscription read authorization. A separate SubscriptionStatus scope is not required. A token without the required Subscription authorization receives HTTP 403. Parameterized Subscription scopes continue to restrict the authorized results.
Behavior
Invokes the advertised Subscription status operation for a logical id.
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