Application Programming Interface (API)
General Information
The
Radreport.org site provides an API to aid developers in accessing structured report templates. The API provides a REST interface, which responds with JSON.
Available Templates
Lists Templates available in the RSNA Reporting Template Library. The values labeled as id can be used as a id input parameter value for the Details query.
The cited URI responds to a HTTP GET request and supports the following parameters...
- specialty (two character value, multiple values supported with , delimiter, no default value)
- organization (alphabetic value, multiple values supported with , delimiter, no default value)
- language (Data to sort on. title, created, language, etc.)
- approved (boolean, default false)
- search (alphabetic value, no default value)
- sort (Data to sort on. title, created, language, etc.)
- order (asc or desc)
- page (numeric value, no default)
- limit (numeric value, default to return all templates)
Examples
Template Details
Responds with the actual template data from the RSNA Reporting Template Library.
The cited URI responds to a HTTP GET request and supports the following parameters...
- id (numeric value. Id's can be found in return of templates query)
- version (time stamp of previous version of template. Version time stamps can be found in return of template details query)
Example
Subspecialty
Lists specialties that have been mapped to individual templates. The values labeled as code can be used as a specialty input parameter value for the Available Templates query.
The cited URI responds to a HTTP GET request Results are ordered by the name field in ASC order and is formatted as JSON.
Organizations
Lists organizations that have been mapped to individual templates. The values labeled as code can be used as a org input parameter value for the Available Templates query.
Results are ordered by the name field in ASC order and is formatted as JSON.
Language
Lists languages in use on individual templates. The values labeled as code can be used as a language input parameter value for the Available Templates query.
The cited URI responds to a HTTP GET request Results are ordered by the lang field in ASC order and is formatted as JSON.