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 is the initial trial implementation release of the IRA Implementation Guide. It has been updated based on public comments.
IHE welcomes New Issues from the GitHub community. For those without GitHub access, issues may be submitted to the Radiology Public Comment form.
As issues are submitted they will be managed on the IRA GitHub Issues, where discussion and workarounds may be found. These issues, when critical, will be processed using the normal IHE Change Proposal management and balloting. It is important to note that as soon as a Change Proposal is approved, it carries the same weight as a published Implementation Guide (i.e., it is testable at an IHE Connectathon from the time it is approved, even if it will not be integrated until several months later).
None
Q: Are there any other context sharing use cases related to reporting that are not covered in this profile?
A: No.
This profile covers the following use cases:
Q: Should the Evidence Creator be required to support content sharing and update the context with evidence data it generated?
A: No.
An Evidence Creator here is a consumer of events. It can be grouped with a Content Creator if it can also support content sharing for the output it generates using update events. An Evidence Creator supports creating evidence data such as measurements, annotations, etc. However, it may not support capturing the evidence using FHIR resources and not able to share them back to the reporting session using Update Request Content [RAD-150].
Q: Should SMART-web-messaging be included?
A: No.
SMART-web-messaging currently is limited to web applications running in the same browser only. If there are demand for this integration, a separate profile can be created so that implementations can document what methods they support.
Q: Should this profile specify events other than the DiagnosticReport-*
events?
A: No.
This profile focus on the communication need during a reporting session. Other events such as ImagingStudy-*
are allowed but they are not defined in this profile. Hence the semantics of how these other events are used are up to the implementations. It is important to note that these other events may interfere the current context maintained in the hub for the reporting session. This is because the Hub will set the current context to the last [FHIR resource]-open
event sent without a corresponding [FHIR resource]-close
event. Therefore different events communicating through the same reporting session may unintentionally switch the current context in all connected applications. A separate session may be beneficial although this is out of scope in this profile.
Q: Should Evidence Creator be required to support Open Report Context [RAD-148]?
A: No.
It is not expected that an Evidence Creator will start a new session and drives other applications by changing report context. Often an Evidence Creator is invoked on demand by an Image Display.
Q: Should the Hub be permitted to set/change the current context based on its business logic?
A: No.
Current context is fully dictated by *-open
and *-close
events, and the Hub is not permitted to originate these events.
Q: Should there be a dedicated transaction for report status update and this transaction is required only by the Report Creator?
A: No.
Not a separate dedicated transaction because the Report Creator may want to include other updates in the same DiagnosticReport-update event besides status update. This effectively is the existing Update Report Content transaction. So the requirement is stated in the Report Creator actor description. This keeps the transaction general and reusebale while keeping update report status as a profile actor requirement.
This also implies other content creators may modify the report status, but this needs to be approached carefully.
Q: Should simplified JSON representation of DICOM SR be supported as a payload for content sharing?
A: Out of scope for IRA.
Q: Should Notify Error [RAD-156] be mandatory for all Subscribers?
A: No, it is not mandatory.
Notify Error [RAD-156] is used when a Subscriber initially accepted an event and later returned an error due to processing error. This means technically for a Subscriber that always processes events synchronously, there is no need to support Notify Error. Due to the nature of the expected use cases and the additional complexity in asynchronous processing, not all Subscribers will support it and hence no need to use Notify Error.
Q: Should SMART on FHIR application launch be available as a named option?
A: No.
IRA is not prescribing a specific application launching mechanism. There are many different mechanisms used in deployment today.
Q: Is there a need for the Subscriber to notify the Manager when asynchronous (return 202 Accepted
) processing completed successfully?
A: Cannot identify a need for this.
FHIRcast does not specify a method to notify the Hub about successful processing. Error can be communicated using syncerror.
Q: Should the Report Creator be required to group with the Report Creator in Interactive Multimedia Report (IMR) profile?
A: No.
This grouping is mentioned in Cross-Profile Considerations, but not mandatory.
Q: Can a Subscriber return rich error content using OperationOutcome with a 4xx / 5xx response code?
A: No.
In FHIRcast, the OperationOutcome is only available in SyncError event in case of an asynchronous response. For synchronous response, it can only return a simple HTTP error status in the response.
Q: Should the event include the originating sender?
A: Yes, but FHIRcast does not support this, and we do not have time to address this limitation with the FHIRcast working group.
Having this information enables a Subscriber to make decisions on whether it should process the message and how, based on the originating sender.