Integrated Reporting Applications
1.0.0 - Trial-Implementation
This page is part of the Integrated Reporting Applications (v1.0.0: Publication) based on FHIR v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions
This transaction is used to distribute notification events to subscribers. This allows a Subscriber to synchronize to changes initiated by other Subscribers to a session.
Table 2:4.154.2-1: Actor Roles
Role | Description | Actor(s) |
---|---|---|
Manager | Distributes notification event to Subscribers | Hub |
Subscriber | Receives notification events | Image Display Report Creator Worklist Client Evidence Creator Stateless Evidence Creator Watcher |
FHIRcast: Event Notification
Websocket: IETF RFC 6455
FHIRcast: Sync error Event
Figure 2:4.154.4-1: Interaction Diagram
The Manager sends the received notification events to Subscribers that listed this event type in their subscription.
The Manager shall support sending such messages to more than one Subscriber. The Subscriber shall support handling such messages from more than one Manager.
The Manager shall send a separate Notification message to each Subscriber.
The Manager accepts a notification event request (e.g. context events, syncerror events or other infrastructure events such as heartbeat events) and this Subscriber has listed this event type in its subscription.
This message is a FHIRcast Event Notification Request request. The Manager is the FHIRcast Hub. The Subscriber is the FHIRcast Subscriber.
The Manager shall support the additional requirements regarding version id
defined in FHIRcast content sharing.
The Subscriber may validate the received event according to its business logic. If the Subscriber rejects the event, then it shall notify the Manager about the error.
The Subscriber shall handle events [FHIR resource]-open
| update
| select
| close
that it supports. Handling requirements for some general types of events are described below. Profile specific event handling requirements are defined in the Actor Description for each actor per profile.
The Subscriber shall support content sharing.
Note: The Subscriber may handle the event synchronously. The Subscriber may also handle the event asynchronously by accepting the event initially (i.e., returning
202
Accepted) and processing it later.
Upon receiving a [FHIR resource]-open
event, the Subscriber will open the corresponding event.context
according to its business logic. The semantics of the open event may be further described in the corresponding ‘open request’ transaction.
Note:
[FHIR resource]-open
events occur when a context is initially created and when it is re-opened. Subscriber event handling may differ for these two cases.
The Subscriber shall keep track of the context.versionId
in the local context.
Upon receiving a [FHIR resource]-update
event, the Subscriber:
context.priorVersionId
in the event matches the current version ID in the local context.
context.versionId
from the event, even if its business logic requires no specific processing.[FHIR resource]-update
event and referenced by a relative path, the Subscriber shall retrieve the content based on the entry.fullurl
.updates
context key according to its business logic.
Upon receiving a [FHIR resource]-select
event, the Subscriber:
Upon receiving a [FHIR resource]-close
event, the Subscriber shall close the referenced context and all associated contents. This typically involves deleting it from its local context.
The Subscriber processes the Notification Message.
The message is a FHIRcast Event Notification Response request. The Subscriber is a FHIRcast Subscriber. The Manager is a FHIRcast Hub.
The Subscriber shall send a confirmation message back to the Manager using the established websocket connection.
If the Manager receives an error confirmation message (i.e., status
4xx
or 5xx
) from at least one of the Subscribers, then the Manager shall send a syncerror
event using the Generate SyncError Event (RAD-155) transaction to all subscribers that subscribed to the syncerror
event.
The Manager shall not change the current context in the session even if it receives an error confirmation message.
Note: The Manager sets the current context as a result of processing a
[FHIR resource]-open
event. Whether or not one or more of the Subscribers failed to apply the context change does not affect the context managed by the Manager.
See IRA Security Considerations.
This transaction is not associated with an ATNA Trigger Event.