Skip to main content

XML Integration

This section outlines the supported parameters, inbound events, and outbound events for integrating with Rad AI Reporting using XML 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 Type field inside the file content.

Events​

Output​

Input​

Output Events​

Those are the events that Rad AI Reporting supports.

File format: All files should have a root <Message> object and a nested <Type> field with a valid event type.

Show (Output)​

Shows the Rad AI Reporting desktop app.

<Message>
    <Type>Show</Type>
</Message>
  • Type: Show

Hide (Output)​

Hides the Rad AI Reporting desktop app.

<Message>
    <Type>Hide</Type>
</Message>
  • Type: Hide

Exit (Output)​

Closes the Rad AI Reporting desktop app.

<Message>
    <Type>Exit</Type>
</Message>
  • Type: Exit

Close (Output)​

Closes the currently opened Report.

<Message>
    <Type>CloseCurrentReport</Type>
    <Option>Draft</Option>
</Message>
  • Type: CloseCurrentReport
  • Option: Describes the behavior when closing the report. Options: Discard and Draft.

OpenReport (Output)​

Opens a Report for dictating.

<Message>
    <Type>OpenReport</Type>
    <AccessionNumber>RA00021</AccessionNumber>
    <AccessionNumbers>
        <AccessionNumber>RA00021</AccessionNumber>
        <AccessionNumber>RA00019</AccessionNumber>
    </AccessionNumbers>
</Message>
  • Type: OpenReport
  • AccessionNumber: Single accession number; mutually exclusive with AccessionNumbers.
  • AccessionNumbers: List of accession numbers; mutually exclusive with AccessionNumber.

Input Events​

Those are the events emitted by Rad AI Reporting.

File format: All generated files will have a root <Event> object and a nested <Name> field with the name of the event that was emitted.

RadAIReportingLaunched (Input)​

Indicates that Rad AI Reporting has been launched.

<?xml version="1.0"?>
<Event>
  <Name>RadAIReportingLaunched</Name>
</Event>
  • Name: RadAIReportingLaunched

Login (Input)​

Indicates that a user has logged in.

<?xml version="1.0"?>
<Event>
  <Name>Login</Name>
</Event>
  • Name: Logout

Logout (Input)​

Indicates that a user has logged out.

<?xml version="1.0"?>
<Event>
  <Name>Logout</Name>
</Event>
  • Name: Logout

ReportClosed (Input)​

Indicates that a report has been closed.

<?xml version="1.0"?>
<Event>
  <Name>ReportClosed</Name>
  <AccessionNumbers>
    <AccessionNumber>RA00020</AccessionNumber>
  </AccessionNumbers>
  <MedicalRecordNumber>MZ009966</MedicalRecordNumber>
  <StatusChange>Signed</StatusChange>
</Event>
  • Name: ReportClosed
  • AccessionNumbers: The list of accession numbers of the report that was closed.
  • MedicalRecordNumber: MRN.
  • StatusChange: The status the report was in when it was closed. Possible values: Signed, Draft, Discard and Prelim.

ReportOpened (Input)​

Indicates that a report has been opened.

<?xml version="1.0"?>
<Event>
  <Name>ReportOpened</Name>
  <AccessionNumbers>
    <AccessionNumber>RA00020</AccessionNumber>
  </AccessionNumbers>
  <MedicalRecordNumber>MZ009966</MedicalRecordNumber>
</Event>
  • Name: ReportOpened
  • AccessionNumbers: The list of accession numbers of the report that was opened.
  • MedicalRecordNumber: MRN.

ReportStatusChanged (Input)​

Indicates that the status of a report has changed.

<?xml version="1.0"?>
<Event>
  <Name>ReportStatusChanged</Name>
  <AccessionNumbers>
    <AccessionNumber>RA00020</AccessionNumber>
  </AccessionNumbers>
  <MedicalRecordNumber>MZ009966</MedicalRecordNumber>
  <NewState>Signed</NewState>
</Event>
  • Name: ReportStatusChanged
  • AccessionNumbers: The list of accession numbers of the report that had their status changed.
  • MedicalRecordNumber: MRN.
  • NewState: The status the report was updated to.

AccessionAdded (Input)​

Indicates that the informed accession number was associated with the report that is currently being edited.

<?xml version="1.0"?>
<Event>
  <Name>AccessionAdded</Name>
  <AccessionNumber>RA00020</AccessionNumber>
  <MedicalRecordNumber>MZ009966</MedicalRecordNumber>
</Event>
  • Name: AccessionAdded
  • AccessionNumber: The accession number that was associated.
  • MedicalRecordNumber: MRN.

AccessionRemoved (Input)​

Indicates that the informed accession number was dissociated from the report that is currently being edited.

<?xml version="1.0"?>
<Event>
  <Name>AccessionRemoved</Name>
  <AccessionNumber>RA00020</AccessionNumber>
</Event>
  • Name: AccessionRemoved
  • AccessionNumber: The accession number that was dissociated.

Error (Input)​

Indicates that an error has occurred.

<?xml version="1.0"?>
<Event>
  <Name>Error</Name>
  <ErrorString>Error description</ErrorString>
</Event>
  • Name: Error
  • ErrorString: The error description.