Subscription-operation-status

Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions

2.12.17.2 Operation $status on Subscription

FHIR Infrastructure icon

Work Group

Maturity Level: 2

Trial Use

Compartments: N/A

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

The canonical 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:

Name

Scope

Cardinality

Type

Binding

Profile

Documentation

id

type

0..*

id

At the Instance level, this parameter is ignored. At the Resource level, one or more FHIR ids to Subscription resources 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").

status

type

0..*

code

Subscription Status (Required)

At the Instance level, this parameter is ignored. At the Resource level, a Subscription status code 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").

Out Parameters:

Name

Scope

Cardinality

Type

Binding

Profile

Documentation

return

1..1

Bundle

The operation returns a bundle containing zero or more SubscriptionStatus resources, one per Subscription in the request that was found. 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

2.12.17.2.1 Examples

Request: Request the current status of Subscription ABC123

GET [base]/Subscription/ABC123/$status

Response: Returned on successful evaluation

HTTP/1.1 200 OK

<?xml version="1.0" encoding="UTF-8" ?>

<Bundle xmlns="http://hl7.org/fhir">
  <id value="e13caf38-c856-461f-8374-6fe71248684c"/>
  <type value="searchset" />
  <timestamp value="2020-04-17T10:24:13.1882432-05:00" />
  <entry>
    <fullUrl value="urn:uuid:815477f2-a94c-4197-a82a-9f974155debc"/>
    <resource>
      <SubscriptionStatus xmlns="http://hl7.org/fhir">
        <id value="815477f2-a94c-4197-a82a-9f974155debc"/>
        <status value="active"/>
        <type value="query-status"/>
        <eventsSinceSubscriptionStart value="310"/>
        <!-- <eventsInNotification value="0"/> -->
        <subscription>
          <reference value="http://example.org/FHIR/R5/Subscription/123"/>
        </subscription>
        <topic value="http://example.org/FHIR/R5/SubscriptionTopic/admission"/>
      </SubscriptionStatus>
    </resource>
    <search>
      <mode value="match"/>
    </search>
  </entry>
</Bundle>

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