Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Operation-subscription-status

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

This is the narrative for the resource. See also the XML, JSON or Turtle format.


status

OPERATION: status

The official URL for this operation definition is:

http://hl7.org/fhir/OperationDefinition/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".


 

 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.