Subscription
Operations to work with FHIR R6 Subscription resources.
- Search Subscription
- Read Subscription
- Read Subscription Version
- Create Subscription
- Update Subscription
- Delete Subscription
- Hard Delete Subscription
- Purge Deleted Subscription
Subscription relationships (R6)
The following diagram shows the relationship among SubscriptionTopic, Subscription, SubscriptionStatus, and notification delivery.

- Clients create, update, and delete
Subscriptionresources.SubscriptionStatusresources are returned by the$statusoperations. - The
$statusoperations return a search-set Bundle containing zero or moreSubscriptionStatusresources. - Multiple Subscriptions can reference the same
SubscriptionTopic.
Primitive extension support
Subscription supports primitive companion elements in underscore form for selected fields:
_content, _contentType, _end, _endpoint, _implicitRules, _language, _name, _reason, and _status.
For JSON usage patterns, see FHIR primitive extensions in JSON.
Successful HTTP Responses
Successful HTTP responses for this resource.
| Endpoint | Method | Successful status code |
|---|---|---|
/api/fhir/r6-ballot4/Subscription |
GET | 200 |
/api/fhir/r6-ballot4/Subscription |
POST | 201 |
/api/fhir/r6-ballot4/Subscription/$purgeDeleted |
POST | 200 |
/api/fhir/r6-ballot4/Subscription/$status |
GET | 200 |
/api/fhir/r6-ballot4/Subscription/{rid} |
DELETE | 204 |
/api/fhir/r6-ballot4/Subscription/{rid} |
GET | 200 |
/api/fhir/r6-ballot4/Subscription/{rid} |
PUT | 200 |
/api/fhir/r6-ballot4/Subscription/{rid}/$hardDelete |
POST | 200 |
/api/fhir/r6-ballot4/Subscription/{rid}/$status |
GET | 200 |
/api/fhir/r6-ballot4/Subscription/{rid}/_history/{vid} |
GET | 200 |
For cross-resource interaction summaries, see FHIR status codes.
See also
- FHIR R6 subscriptions
- Subscription Topic
- Subscription Status
- Subscription OCI Vault secret extension
- For permanent deletion guidance, see Data deletion and purge operations.