This page is part of the FHIR Specification (v5.0.0-snapshot1: Release 5 Snapshot #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
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.
OPERATION: events
The official URL for this operation definition is:
http://hl7.org/fhir/OperationDefinition/Subscription-events
This operation is used to search for and return notifications that have been previously triggered by a topic-based Subscription.
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.