Get Current Subscription Status for One or More Subscriptions

$statusoperation

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

TypeInstance

Metadata

URL: http://hl7.org/fhir/OperationDefinition/Subscription-status
ID: Subscription-status
Applies to Resources: Subscription

Input Parameters (2)

id0..*id

At the Instance level, this parameter is ignored. At the Resource level, one or more FHIR ids to Subscription resources 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").

status0..*code

At the Instance level, this parameter is ignored. At the Resource level, a Subscription status code 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").

Binding: requiredhttp://hl7.org/fhir/ValueSet/subscription-status|5.0.0

Output Parameters (1)

return1..1Bundlerequired

The operation returns a bundle containing zero or more SubscriptionStatus resources, one per Subscription in the request that was found. The Bundle type is "searchset".