Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions

Example OperationDefinition/Subscription-status (Narrative)

Maturity Level : N/A
Responsible Owner: FHIR Infrastructure Work Group Standards Status : Informative Compartments : No defined compartments

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

Note that this is the formal definition for the status operation as an OperationDefinition on Subscription. See the Operation documentation

Generated Narrative: OperationDefinition Subscription-status

URL: [base]/Subscription/$status

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

Parameters

Use Name Scope Cardinality Type Binding Documentation
IN 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").

IN 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 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".

 

 

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.