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-events (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 events operation as an OperationDefinition on Subscription. See the Operation documentation


Generated Narrative: OperationDefinition Subscription-events

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

Parameters

Use Name Scope Cardinality Type Binding Documentation
IN eventsSinceNumber 0..1 integer64

The starting event number, inclusive of this lowest event number to be included in the response (lower bound). bound, inclusive).

IN eventsUntilNumber 0..1 integer64

The ending event number, inclusive of this highest event number to be included in the response (upper bound). bound, inclusive).

IN content 0..1 code Subscription Payload Content (Required)

Requested content style of returned data. Codes from backport-content-value-set (e.g., empty, id-only, full-resource). This is a hint to the server what a client would prefer, and MAY be ignored.

OUT return 1..1 Bundle

The operation returns a valid notification bundle, with the first entry being a SubscriptionStatus resource. The bundle type is "subscription-notification".


 

 

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.