Integrated Reporting Applications
1.0.0-comment - ballot International flag

This page is part of the Integrated Reporting Applications (v1.0.0-comment: Releases Ballot 1) 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

2:3.X10 Generate SyncError Event [RAD-X10]

2:3.X10.1 Scope

This transaction is used to distribute notification events to subscribers about synchronization errors detected by the Manager.

2:3.X10.2 Actors Roles

Table 2:3.X10.2-1: Actor Roles

Role Description Actor(s)
Subscriber Receives and responses to error event Image Display
Report Creator
Worklist Client
Evidence Creator
Watcher
Manager Generates error event and notifies Subscribers Hub

2:3.X10.3 Referenced Standards

FHIRcast: Event Notification Errors

FHIRcast: Hub Generated syncerror Events

FHIRcast: Sync error Event

2:3.X10.4 Messages

ManagerSubscriberError NotificationError Notification Response

Figure 2:3.X10.4-1: Interaction Diagram

2:3.X10.4.1 Error Notification Message

The Manager sends an error event to Subscribers indicating that it detected an error. Manager shall support sending such messages to more than one Subscribers.

The Subscriber shall support handling such messages from more than one Manager.

2:3.X10.4.1.1 Trigger Events

A Manager uses this transaction when:

  • It receives a 4xx or 5xx error response from a Subscriber when executing the Send Context Event [RAD-X9](rad-x9.html) transaction.
  • It does not receive a 2xx response within a predetermined time frame from a Subscriber after the Manager sent a context event.
  • It initially responded with a 202 Accepted when received a context or content change, but later rejects the request associated with the session.
  • It detects a websocket connection issue with a Subscriber.
2:3.X10.4.1.2 Message Semantics

This message is a FHIRcast Event Notification Request request. The Manager is the FHIRcast Hub. The Subscriber is the FHIRcast Subscriber.

The event.context shall conform to SyncError Context.

Per FHIRcast, the issue[0].severity of the operationoutcome context will be set to information.

The Manager shall set the operationoutcome issue[0].details as follow:

  • issue[0].details.coding[0].code shall be the event.id of the event that triggered the error, or a generated ID for non-event triggered errors
  • issue[0].details.coding[1].code shall be the event.hub.event of the event that triggered the error, or syncerror for non-event triggered errors
  • issue[0].details.coding[2].code shall be the subscriber.name of the Subscriber that originated either the syncerror, or the event that triggered the error.

If the syncerror event was triggered by the Manager initially accepting the context or content change request (i.e. responded with a 202 Accepted respond) but later rejecting the request, then the Manager shall send the syncerror event only to the original requesting Subscriber.

2:3.X10.4.1.3 Expected Actions

The Subscriber will handle the error according to its business logic. For example, display an error message to the user, retry the original request, or close the context.

2:3.X10.4.2 Error Notification Response Message

2:3.X10.4.2.1 Trigger Events

The Subscriber processes the error notification received.

2:3.X10.4.2.2 Message Semantics

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.

2:3.X10.4.2.3 Expected Actions

The Manager may resend the error notification if it does not receive a response from a Subscriber within a timeframe.

2:3.X10.5 Security Considerations

See IRA Security Considerations.

2:3.X10.5.1 Security Audit Considerations

This transaction is not associated with an ATNA Trigger Event.