Release 5 Preview #3

This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

2.47.16.1 Operation $status on Subscription

FHIR Infrastructure Work Group Maturity Level: 0Trial Use Compartments: N/A

This operation is used to return the current SubscriptionStatus information about one or more Subscriptions.

The official URL for this operation definition is

 http://hl7.org/fhir/OperationDefinition/Subscription-status

Formal Definition (as a OperationDefinition).

URL: [base]/Subscription/$status

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

This is an idempotent operation

In Parameters:
NameCardinalityTypeBindingProfileDocumentation
ids0..*id

At the Resource level, one or more parameters containing one or more comma-delimited FHIR ids of Subscriptions to get status information for. In the absense of any specified ids, the server returns the status for all Subscriptions available to the caller. At the Instance level, this parameter is ignored.

Out Parameters:
NameCardinalityTypeBindingProfileDocumentation
return1..1Bundle

The bundle type is "searchset"

Note: as this is the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource

 

For more information about operations, including how they are invoked, see Operations.