$status

R5SubscriptionStatus

activeSubscriptions R5 Backport1.1.0operation2 inputs1 output

This operation is used to return the current status information about one or more topic-based Subscriptions in R4.

Metadata

Canonical URL: http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status
Code: $status
Kind: operation
Affects State: No
Publisher: HL7 FHIR Infrastructure WG

Can be invoked at:

Type LevelInstance Level

Target Resources:

Affects State:No

Name	Type	Card.	Description
`id`	id	0..*	At the Instance level, this parameter is ignored. At the Resource level, one or more parameters containing a FHIR id for a Subscription to get status information for. In the absence of any specified ids, the server returns the status for all Subscriptions available to the caller. Multiple values are joined via OR (e.g., "id1" OR "id2").
`status`	code	0..*	At the Instance level, this parameter is ignored. At the Resource level, a Subscription status to filter by (e.g., "active"). In the absence of any specified status values, the server does not filter contents based on the status. Multiple values are joined via OR (e.g., "error" OR "off").

Name	Type	Card.	Description
`return`	Bundle	1..1	The operation returns a bundle containing one or more subscription status resources, one per Subscription being queried. The Bundle type is "searchset".