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.X4 Close Report Context [RAD-X4]

2:3.X4.1 Scope

This transaction is used to terminate a report context. All synchronizing applications are expected to close their local copy of this context.

Note: This closes the report context used for synchronization / sharing. The report instance being worked on may or may not be complete.

2:3.X4.2 Actors Roles

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

Role Description Actor(s)
Sender Closes a report context Image Display
Report Creator
Worklist Client
Manager Closes report context Hub

2:3.X4.3 Referenced Standards

FHIRcast: Request Context Change

FHIRcast: DiagnosticReport close Event

2:3.X4.4 Messages

SenderManagerClose Report Context RequestClose Report Context Response

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

2:3.X4.4.1 Close Report Context Request Message

The Sender sends an event to the Manager to terminate an existing report context. 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.X4.4.1.1 Trigger Events

The Sender determines no further synchronization required for this report context. The report instance being worked on may or may not be complete.

2:3.X4.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 close Event.

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.X4.4.1.3 Expected Actions

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

If the Manager accepts the request, then

  • Per FHIRcast Section 2.9.2 Get Current Context Response, the Manager will set the current context to the context that was most recently opened by a [FHIR resource]-open event and has not been closed by a corresponding [FHIR resource]-close event. If there is no such context, then the Manager will set the current context to empty.
  • Per FHIRcast, the Manager will remove from the memory the report context of the received DiagnosticReport-close event, as well as all associated context and content.

2:3.X4.4.2 Close Report Context Response Message

2:3.X4.4.2.1 Trigger Events

The Manager finishes processing the Close Report Context request.

2:3.X4.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.

The Manager shall return 400 Bad Request error if:

  • If timestamp, id or event are not set
  • If event.context does not include report
  • If the report context does not include resource.id
  • if event.hub.topic is not a known session

The Manager may return other applicable HTTP error status codes.

2:3.X4.4.2.3 Expected Actions

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

2:3.X4.5 Security Considerations

See IRA Security Considerations.

Local policy should consider what users and systems have permissions to close a report context and configure appropriately.

2:3.X4.5.1 Security Audit Considerations

This transaction is not associated with an ATNA Trigger Event.