Integrated Reporting Applications
0.1.1 - ci-build International flag

Integrated Reporting Applications, published by IHE Radiology Technical Committee. This is not an authorized publication; it is the continuous build for version 0.1.1). This version is based on the current content of https://github.com/IHE/RAD.RTC-IMR/ and changes regularly. See the Directory of published versions

2:3.X6 Select Report Content [RAD-X6]

2:3.X6.1 Scope

This transaction is used to identify specific report contents to other subscribers for potential synchronization.

2:3.X6.2 Actors Roles

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

Role Description Actor(s)
Sender Selects report content(s) Content Creator
Manager Manages the selection state of contents Hub

2:3.X6.3 Referenced Standards

FHIRcast: Content Sharing

FHIRcast: DiagnosticReport select Event

2:3.X6.4 Messages

SenderManagerSelect Report Content RequestSelect Report Content Response

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

2:3.X6.4.1 Select Report Content Request Message

The Sender sends an event to the Manager to indicate some report contents are selected. The Sender shall support sending such messages to more than one Manager.

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

2:3.X6.4.1.1 Trigger Events

The Sender determines the selection state of some report contents should be synchronized with other Subscribers. Selections may have occurred automatically or manually by a user.

The Sender determines that the selected content are no longer required and reset the selection.

Note: Prior selected content are automatically reset by the selection of new content. Reset is used when the current selected content should be unselected without selecting new contents. See DiagnosticReport select Event Workflow for details.

2:3.X6.4.1.2 Message Semantics

This message is a FHIRcast Request Context Change request. The Sender is the FHIRcast Subscriber. The Manager is the FHIRcast Hub.

The event.context shall conform to DiagnosticReport select Event.

The event.context.versionId shall be the newest version ID of the report context known to the Sender.

The Sender shall include all selected resources in the event, including resources that were selected previously which should remain selected.

Note: This is necessary because there is an implicit unselect of any previously selected resources for each new DiagnosticReport-select event received. See DiagnosticReport select Event Workflow for details.

If the Sender is retrying this context change request due to not receiving a response from the Manager for a prior request, then the Sender shall use the same event.id. If the Manager received the original request, this allows it to detect that it is a duplicate message.

If the Sender retries the request due to an error response from the Manager, then the Sender shall assign a new event.id to indicate that it is a new request.

2:3.X6.4.1.3 Expected Actions

The Manager shall receive and validate the request. See 2:3.X6.4.2.2 for error conditions.

Per FHIRcast, the Manager will keep track of the selection states of all contents. In particular:

  • All previously selected contents will be unselected
  • All referenced resources in the request will be selected

The Manager shall ignore any selected resources in the request that are not known based on any previous DiagnosticReport-open or DiagnosticReport-update events.

Note: The Manager should continue to process the request and should not return an error due to unknown selected resources.

2:3.X6.4.2 Select Report Content Response Message

2:3.X6.4.2.1 Trigger Events

The Manager finishes processing the Select Report Content request.

2:3.X6.4.2.2 Message Semantics

This message is a FHIRcast Request Context Change response. The Sender is the FHIRcast Subscriber. The Manager is the FHIRcast Hub.

If the Manager ignore unknown resources, then it shall return 206 Partial Content.

The Manager shall return 400 Bad Request error if:

  • If timestamp, id or event are not set
  • If event.context does not include report and select
  • if event.hub.topic is not a known session
  • If context.versionId does not match the latest version ID of the report anchor context

The Manager may return other applicable HTTP error status codes.

2:3.X6.4.2.3 Expected Actions

If the response is an error, then the Sender may consider retrying the request.

2:3.X6.5 Security Considerations

See IRA Security Considerations

Local policy should consider what users and systems have permissions to select report content and configure appropriately.

2:3.X6.5.1 Security Audit Considerations

This transaction is not associated with an ATNA Trigger Event.