Subscriptions R5 Backport
1.0.0 - Standard for Trial Use International flag

This page is part of the Subscriptions R5 Backport (v1.0.0: STU 1) based on FHIR v4.3.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

OperationDefinition: Subscription Status Operation

Official URL: http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status Version: 1.0.0
Standards status: Trial-use Maturity Level: 0 Computable Name: R5SubscriptionStatus

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

R5SubscriptionStatus

OPERATION: R5SubscriptionStatus

The official URL for this operation definition is: 

http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status

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

URL: [base]/Subscription/$status

URL: [base]/Subscription/[id]/$status

Parameters

UseNameCardinalityTypeBindingDocumentation
INid0..*id

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").

INstatus0..*code

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").

OUTreturn1..1Bundle

The operation returns a bundle containing one or more SubscriptionStatus resources, one per Subscription being queried. The Bundle type is "searchset".