Operation-subscription-events - FHIR v5.0.0-ballot

Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Example OperationDefinition/Subscription-events (Narrative)

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.

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

Use

Name

Cardinality

Type

Binding

Documentation

IN

eventsSinceNumber

0..1

integer64

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

IN

eventsUntilNumber

0..1

integer64

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

IN

content

0..1

code

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.