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

Operation-subscription-status

FHIR Infrastructure Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: Not linked to any defined compartments

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

Get Current Subscription Status for One or More Subscriptions

OPERATION: Get Current Subscription Status for One or More Subscriptions

The official URL for this operation definition is:

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

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

URL: [base]/Subscription/$status

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

Parameters

Use

Name

Cardinality

Type

Binding

Documentation

IN

ids

0..*

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

return

1..1

Bundle

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.