Subscriptions R5 Backport
1.2.0-ballot - ballot International flag

This page is part of the Subscriptions R5 Backport (v1.2.0-ballot: STU 1.2 Ballot 1) based on FHIR (HL7® FHIR® Standard) v4.3.0. The current version which supersedes this version is 1.1.0. 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.2.0-ballot
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.

URL: [base]/Subscription/$status

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

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
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 subscription status resources, one per Subscription being queried. The Bundle type is "searchset".