Subscription-operation-events

Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions

2.12.17.1 Operation $events on Subscription

FHIR Infrastructure icon Work Group Maturity Level: 0 Trial Use Compartments: N/A

This operation is used to search for and return notifications that have been previously triggered by a topic-based Subscription.

The canonical URL for this operation definition is

 http://hl7.org/fhir/OperationDefinition/Subscription-events

Formal Definition (as a OperationDefinition).

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

This is an idempotent operation

In Parameters:

Name Scope Cardinality Type Binding Profile Documentation

eventsSinceNumber 0..1 integer64

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

eventsUntilNumber 0..1 integer64

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

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 Parameters:

Name Scope Cardinality Type Binding Profile Documentation

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

Note: as this is the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource

2.12.17.1.1 Examples

Request: Request specific previous events from Subscription ABC123

GET [base]/Subscription/ABC123/$events?eventsSinceNumber=307&eventsUntilNumber=308

Response: Returned on successful evaluation

HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8" ?>
<Bundle xmlns="http://hl7.org/fhir">
 <id value="e13caf38-c856-461f-8374-6fe71248684c"/>
 <type value="subscription-notification" />
 <timestamp value="2020-04-17T10:24:13.1882432-05:00" />
 <entry>
 <fullUrl value="urn:uuid:2f157087-2af2-48de-9490-609465401b7f"/>
 <resource>
 <SubscriptionStatus xmlns="http://hl7.org/fhir">
 <id value="815477f2-a94c-4197-a82a-9f974155debc"/>
 <status value="active"/>
 <type value="query-event"/>
 <eventsSinceSubscriptionStart value="310"/>
 <notificationEvent>
 <eventNumber value="307"/>
 <focus>
 <reference value="http://example.org/FHIR/R5/Encounter/307"/>
 </focus>
 <additionalContext>
 <reference value="http://example.org/FHIR/R5/Patient/ABC"/>
 </additionalContext>
 </notificationEvent>
 <notificationEvent>
 <eventNumber value="308"/>
 <focus>
 <reference value="http://example.org/FHIR/R5/Encounter/308"/>
 </focus>
 <additionalContext>
 <reference value="http://example.org/FHIR/R5/Patient/ABC"/>
 </additionalContext>
 </notificationEvent>
 <subscription>
 <reference value="http://example.org/FHIR/R5/Subscription/123"/>
 </subscription>
 <topic value="http://example.org/FHIR/R5/SubscriptionTopic/admission"/>
 </SubscriptionStatus>
 </resource>
 </entry>
 <entry>
 <fullUrl value="https://example.org/FHIR/R5/Encounter/307" />
 <resource>
 <Encounter xmlns="http://hl7.org/fhir">
 <id value="307" />
 <meta>
 <versionId value="1" />
 <lastUpdated value="2019-08-07T10:49:22Z" />
 </meta>
 <status value="in-progress" />
 <class>
 <coding>
 <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode" />
 <code value="VR"/>
 <display value="virtual" />
 </coding>
 </class>
 <subject>
 <reference value="Patient/ABC" />
 </subject>
 </Encounter>
 </resource>
 <request>
 <method value="PUT" />
 <url value="Encounter/307" />
 </request>
 <response>
 <status value="201"/>
 </response>
 </entry>
 <entry>
 <fullUrl value="https://example.org/FHIR/R5/Patient/ABC" />
 <resource>
 <Patient xmlns="http://hl7.org/fhir">
 <id value="ABC" />
 <meta>
 <versionId value="1" />
 <lastUpdated value="2019-08-07T10:49:22Z" />
 </meta>
 <name>
 <use value="official"/>
 <family value="Example"/>
 <given value="Patient"/>
 </name>
 </Patient>
 </resource>
 </entry>
 <entry>
 <fullUrl value="https://example.org/FHIR/R5/Encounter/308" />
 <resource>
 <Encounter xmlns="http://hl7.org/fhir">
 <id value="308" />
 <meta>
 <versionId value="1" />
 <lastUpdated value="2019-08-07T10:49:22Z" />
 </meta>
 <status value="in-progress" />
 <class>
 <coding>
 <system value="http://terminology.hl7.org/CodeSystem/v3-ActCode" />
 <code value="VR"/>
 <display value="virtual" />
 </coding>
 </class>
 <subject>
 <reference value="Patient/ABC" />
 </subject>
 </Encounter>
 </resource>
 <request>
 <method value="PUT" />
 <url value="Encounter/308" />
 </request>
 <response>
 <status value="201"/>
 </response>
 </entry>
</Bundle>

For more information about operations, including how they are invoked, see Operations.