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 unsubscribe from a FHIRcast session.
The roles in this transaction are defined in the following table and may be played by the actors shown here:
Table 2:4.152.2-1: Actor Roles
Role | Description | Actor(s) |
---|---|---|
Subscriber | Unsubscribes from a session | Image Display Report Creator Worklist Client Evidence Creator Stateless Evidence Creator Watcher |
Manager | Removes subscriber subscription | Hub |
FHIRcast: Unsubscribe
Figure 2:4.152.4-1: Interaction Diagram
The Subscriber sends a unsubscribe request to the Manager.
The Subscriber shall support sending such messages to more than one Manager. The Manager shall support handling such messages from more than one Subscriber.
The Subscriber no longer wants to receive event notification on a given session from Manager.
This message is a FHIRcast Unsubscribe Request. The Subscriber is the FHIRcast Subscriber. The Manager is the FHIRcast Hub.
The Manager shall receive and validate the message. See Section 2:4.152.4.2.2 for error conditions.
Per FHIRcast, the Manager will remove the Subscriber from all event subscriptions in this session.
The Manager shall terminate the websocket connection and delete the websocket identifier. The Manager shall not reuse the websocket identifier for other future subscriptions.
The Manager sends a response message describing the message outcome to the Subscriber.
The Manager receives a Unsubscribe Session Request message.
This message is a FHIRcast Unsubscribe Response. The Subscriber is the FHIRcast Subscriber. The Manager is the FHIRcast Hub.
If the Manager successfully processed the request, the Manager shall respond with an HTTP 202 “Accepted” response.
The Manager shall return 400
Bad Request error if:
hub.channel.type
is not websocket
hub.topic
is emptyhub.mode
is unsubscribe
and there is no hub.channel.endpoint
or its value is emptyhub.channel.endpoint
does not match the websocket associated to the SubscriberThe Manager may return other applicable HTTP error status codes.
The HTTP body of the response shall consist of a JSON object containing an element name hub.channel.endpoint
and a value for the websocket URL that is associated to the Subscriber.
The Subscriber may check the returned hub.channel.endpoint
in the response and verify that it matches the websocket URL it requested.
If the HTTP response code is 4xx or 5xx, then the Subscriber may adjust the request and retry.
See IRA Security Considerations.
Managers that support the ATNA Profile shall audit this transaction.
This transaction corresponds to a Query Information ATNA Trigger Event.