Radreport.org 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 Templates query.

GET http://radreport.org/json/

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)
  • radlex (alphanumeric value, multiple values supported with | delimiter, no default value)
  • org (alphabetic value, multiple values supported with | delimiter, no default value)
  • author (alphabetic value, multiple values supported with | delimiter, no default value)
  • lang (two character value, multiple values supported with | delimiter, default value is "en")
  • text (alphabetic value, multiple values supported with | delimiter, no default value)
  • id (numeric value, multiple values supported with | delimiter, no default value)
  • startDate (ISO-8601 formatted date value [example: 2011-06-30] referencing the last modified date for the template, no default value)
  • endDate (ISO-8601 formatted date value [example: 2011-06-30] referencing the last modified date for the template, no default value)
  • type (one of two possible values: "module" or "full", no default value)
  • limit (numeric value, no default value)
  • offset (numeric value, no default value)
Examples
  • http://www.radreport.org/json/?specialty=CT|US
  • http://www.radreport.org/json/?org=Fleischner|acr
  • http://www.radreport.org/json/?radlex=RID28682|RID56
  • http://www.radreport.org/json/?author=kahn|heilbrun
  • http://www.radreport.org/json/?lang=en|es
  • http://www.radreport.org/json/?text=cardiac|ct
  • http://www.radreport.org/json/?id=1|7
  • http://www.radreport.org/json/?startDate=2012-06-30&endDate=2012-07-17
  • http://www.radreport.org/json/?type=full
  • http://www.radreport.org/json/?limit=5&offset=5

Results are ordered by the id field in ASC order and is formatted as JSON.


Template

Responds with the actual template data from the RSNA Reporting Template Library.

GET http://www.radreport.org/json/template/

The cited URI responds to a HTTP GET request and supports the following parameters...

  • id (numeric value)

  • The following parameters are valid currently, but will be discontinued:

    • id: multiple values can be specified with | delimiter)
    • format ("MRRT" [default], "text", or "XML")
    • limit (numeric value, default value of "10")
    • offset (numeric value, no default value)
Example
  • http://www.radreport.org/json/template/?id=20

Results are ordered by the id field in ASC order and is formatted as JSON.

Note: Within the templateData field, the XML format version includes escapes for double quote values and the text format version includes special characters for tabs and line breaks.


Metadata

Responds with template metadata formatted to conform to the Dublin Core standard.

GET http://www.radreport.org/json/metadata/

The cited URI responds to a HTTP GET request and supports the following parameter...

  • id (required, numeric value, no default value)
Example
  • http://www.radreport.org/json/metadata/?id=39

Specialties

Lists specialties that have been mapped to individual templates. The values labeled as specialty can be used as a specialty input parameter value for the Available Templates query.

GET http://www.radreport.org/json/specialty/

The cited URI responds to a HTTP GET request and supports the following parameters...

  • limit (numeric value, no default value)
  • offset (numeric value, no default value)
Example
  • http://www.radreport.org/json/specialty/?limit=5&offset=5

Results are ordered by the specialty field in ASC order and is formatted as JSON.


Organizations

Lists organizations that have been mapped to individual templates. The values labeled as org or orgDescription can be used as a org input parameter value for the Available Templates query.

GET http://www.radreport.org/json/org/

The cited URI responds to a HTTP GET request and supports the following parameters...

  • limit (numeric value, no default value)
  • offset (numeric value, no default value)
Example
  • http://www.radreport.org/json/org/?limit=5&offset=5

Results are ordered by the org field in ASC order and is formatted as JSON.


RadLex

Lists RadLex terms that have been mapped to individual templates. The values labeled as radlex can be used as a radlex input parameter value for the Available Templates query.

GET http://www.radreport.org/json/radlex/

The cited URI responds to a HTTP GET request and supports the following parameters...

  • limit (numeric value, no default value)
  • offset (numeric value, no default value)
Example
  • http://www.radreport.org/json/radlex/?limit=5&offset=5

Results are ordered by the radlexDescription field in ASC order and is formatted as JSON.


Language

Lists languages in use on individual templates. The values labeled as lang can be used as a lang input parameter value for the Available Templates query.

GET http://www.radreport.org/json/lang/

The cited URI responds to a HTTP GET request and supports the following parameters...

  • limit (numeric value, no default value)
  • offset (numeric value, no default value)
Example
  • http://www.radreport.org/json/lang/?limit=3&offset=3

Results are ordered by the lang field in ASC order and is formatted as JSON.