Release 5

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

Example OperationDefinition/Subscription-events (Narrative)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: 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

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

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INeventsSinceNumber0..1integer64

The starting event number, inclusive of this event (lower bound).

INeventsUntilNumber0..1integer64

The ending event number, inclusive of this event (upper bound).

INcontent0..1codeSubscription 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.

OUTreturn1..1Bundle

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.