Shared Managament of Radiation Treatments
0.0.1-current - ci-build International flag

Shared Managament of Radiation Treatments, published by IHE Radiation Oncology Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.0.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/RO.SMRT/ and changes regularly. See the Directory of published versions

2:4.02 Report Planning Artifacts Ready [RO-SMRT-02]

This section corresponds to transaction [RO-YY] of the IHE-RO Technical Framework.

Scope

The TMS notifies the ROIS that a coherent set of planning artifacts for a treatment course is available for retrieval and/or processing.

Actors Roles

The roles in this transaction are defined in the following table and may be played by the actors shown here:

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

Role Description Actor(s)
Sender Report that planning artifacts are ready for retrieval TMS
Receiver TODO ROIS

Referenced Standards

  • FHIR-R4 HL7 FHIR Release 4.0
  • FHIR-R4 Messaging
  • FHIR-R4 MessageHeader Resource
  • FHIR-R4 ImagingStudy Resource
  • DICOM PS3.3

Interactions

SenderReceiverSenderReceiverSenderReceiverSenderReceiverInitiates $process-message operationResponse
Figure X.X.X.X-X: Report Planning Artifacts Ready Interaction Diagram


Report Planning Artifacts Ready Message

Trigger Events

The TMS issues this transaction when a set of planning artifacts becomes available for downstream use.

Message Semantics

The TMS sends a FHIR Message Bundle to notify the ROIS that planning artifacts are available.

The Message Bundle:

  • SHALL have Bundle.type = message
  • SHALL contain a MessageHeader resource as the first entry
  • SHALL contain an event code identifying the planning event
  • SHALL contain references to one or more planning artifacts

The Message Bundle SHALL conform to Notifications Bundle Profile. The MessageHeader SHALL conform to Report Planning Artifacts Ready MessageHeader Profile

The MessageHeader.focus array shall reference the primary planning artifacts associated with the event. When no single focal artifact exists, multiple resources may be included within the focus array.

Each ImagingStudy resource shall represent one or more DICOM SOP Instances associated with the planning artifacts.

Page-1 Rounded Rectangle.1000 Planning Artifacts Notification MessageHeader Planning Artifacts Notification MessageHeader Rounded Rectangle.1001 Organization Organization Dynamic connector.1002 sender sender Dynamic connector.1003 destination.receiver destination.receiver Rounded Rectangle.1004 PlanImagingStudy PlanImagingStudy Dynamic connector.1005 focus focus Dynamic connector.1009 subject subject Rounded Rectangle.1006 Patient Patient Sheet.1029 Rounded Rectangle.1024 Rounded Rectangle.1025 Sheet.1026 Required Required Sheet.1027 Optional Optional Sheet.1028 Sheet.1036 Sheet.1038 Rounded Rectangle.1008 Referenced Resources Referenced Resources Rounded Rectangle.1007 Referenced Resources Referenced Resources Rounded Rectangle.1006 *ImagingStudy *ImagingStudy Rounded Rectangle.1042 SMRT Endpoint SMRT Endpoint Dynamic connector.1043 endpoint endpoint
Figure X.X.X.X-X: Report Planning Artifacts Ready Message Graph


Expected Actions

Upon receipt of the message:

  • The ROIS SHALL validate the message bundle.
  • The ROIS SHALL determine the planning event from the MessageHeader event code.
  • The ROIS SHALL identify the referenced planning artifacts.
  • The ROIS MAY retrieve the DICOM objects referenced by the ImagingStudy resources.
  • The ROIS MAY update its internal workflow state according to local policy.

Protocol Requirements

The Sender shall invoke: `POST [base]/$process-message

Security Considerations

See SMRT Security Considerations

Security Audit Considerations

''TODO: The security audit criteria ''

Client Audit

When grouped with ATNA Secure Application or Secure Node the Actor shall be able to record…

''TODO: the specifics, leveraging BALP''

Server Audit

When grouped with ATNA Secure Application or Secure Node the Actor shall be able to record…

''TODO: the specifics, leveraging BALP''