Skip to main content

JSON Integration

This section outlines the supported parameters, inbound events, and outbound events for integrating with Rad AI Reporting using JSON file exchange.

Configuration​

  • Output Path: The path to the directory where Rad AI Reporting will watch the files generated by the integrated system.
  • Input Path: The path to the directory where Rad AI Reporting will place the generated files for emitted events.
info

The name of the files should not be used to determine what event will be triggered. The event type is determined by the value of the messageType field inside the file content.

Events​

Output​

Input​

Output Events​

Those are the events that Rad AI Reporting supports.

CloseReport (Output)​

Closes the current Report.

{
  "messageType": "CloseReport"
}
  • messageType: CloseReport

LinkedStudiesChanged (Output)​

Changes the studies associated to the open Report.

{
  "messageType": "LinkedStudiesChanged",
  "accessionNumbers": "RA00020,RA00019"
}
  • messageType: LinkedStudiesChanged
  • accessionNumbers: One or multiple accession numbers, separated by comma

OpenReport (Output)​

Opens a Report for dictating.

{
  "messageType": "OpenReport",
  "accessionNumbers": "RA00021,RA00019",
  "addendum": false
}
  • messageType: OpenReport
  • accessionNumbers: One or multiple accession numbers, separated by comma. If multiple accessions are informed, the Report will be opened with the studies linked.
  • addendum: false for Reports, true for Addendums

Input Events​

Those are the events emitted by Rad AI Reporting.

LinkedStudiesChanged (Input)​

Changes the studies associated to the open Report.

{
  "messageType": "LinkedStudiesChanged",
  "accessionNumbers": "RA00020,RA00019"
}
  • messageType: LinkedStudiesChanged
  • accessionNumbers: One or multiple accession numbers, separated by comma

ReportClosed (Input)​

Closes the current Report.

{
  "messageType": "ReportClosed",
  "accessionNumbers": "RA00021,RA00019",
  "status": "DRAFT",
  "addendum": false
}
  • messageType: ReportClosed
  • accessionNumbers: One or multiple accession numbers, separated by comma.
  • status: Status can be DRAFT, APPROVED or DISCARDED.
  • addendum: false for Reports, true for Addendums

ReportOpened (Input)​

Opens a Report for dictating.

{
  "messageType": "ReportOpened",
  "accessionNumbers": "RA00021,RA00019",
  "status": "DRAFT",
  "addendum": false
}
  • messageType: ReportOpened
  • accessionNumbers: One or multiple accession numbers, separated by comma.
  • status: Status can be DRAFT, APPROVED or DISCARDED.
  • addendum: false for Reports, true for Addendums

UserLoggedIn (Input)​

Logs in a user to the system.

{
  "messageType": "UserLoggedIn",
  "userName": "johndoe@email.com"
}
  • messageType: UserLoggedIn
  • userName: The username of the user logging in.

UserLoggedOff (Input)​

Logs off a user from the system.

{
  "messageType": "UserLoggedOff",
  "userName": "johndoe@email.com"
}
  • messageType: UserLoggedOff
  • userName: The username of the user logging off.