v3 Services Public API
Table of contents
- Introduction
- Global information
- Error handling
- Filters
- Fields
- Pagination
- Sorting
- Bundled calls
- Permissions
- Schedules
- Account settings
- Study AI questions
- Namespace AI questions
- Session commands
- User commands
- Study commands
- /study/add
- /study/set
- /study/delete
- /study/list
- /study/count
- /study/cfind
- /study/get
- /study/permissions
- /study/exists
- /study/push
- /study/push/hl7
- /study/pdf/hl7
- /study/fax/hl7
- /study/cmove
- /study/node/can/remove
- /study/share/who
- /study/share
- /study/share/stop
- /study/share/list
- /study/approve
- /study/reject
- /study/audit
- /study/star
- /study/report/detail
- /study/report/series
- /study/viewer/settings
- /study/viewer3/settings
- /study/status/set
- /study/status/locks
- /study/status/history
- /study/move
- /study/duplicate
- /study/split
- /study/freeze
- /study/manual/route
- /study/find/order
- /study/archive
- /study/retrieve
- /study/comment/add
- /study/comment/delete
- /study/comment/get
- /study/validate
- /study/attach/customfields
- /study/external/viewer
- /study/question
- /study/dicomdata/load
- /study/timing/event
- /study/timing/log
- /study/sync
- /study/take
- /study/request/add
- /study/request/get
- /study/request/match
- Tag commands
- Annotation commands
- Keyimage commands
- Study validation commands
- Study DICOM data commands
- Radiology reports commands
- /radreport/add
- /radreport/set
- /radreport/get
- /radreport/audit
- /radreport/delete
- /radreport/description
- /radreport/user/list
- /radreportmacro/list
- /radreportmacro/add
- /radreportmacro/set
- /radreportmacro/get
- /radreportmacro/delete
- /radreport/pdf
- /radreport/fax
- /radreport/email
- /radreport/template/list
- /radreport/template/add
- /radreport/template/set
- /radreport/template/get
- /radreport/template/get/type
- /radreport/template/delete
- /radreport/template/activate
- Custom code commands
- Case commands
- Patient commands
- Order commands
- HL7 commands
- /hl7/list
- /hl7/add
- /hl7/get
- /hl7/delete
- /hl7/study/report
- /hl7/extract/report
- /hl7/template/list
- /hl7/template/add
- /hl7/template/set
- /hl7/template/get
- /hl7/template/render
- /hl7/template/delete
- /hl7/transform/list
- /hl7/transform/add
- /hl7/transform/set
- /hl7/transform/get
- /hl7/transform/delete
- /hl7/transform/test
- /hl7/parse/fields
- Settings commands
- Node commands
- /node/list
- /node/public
- /node/connect
- /node/approve
- /node/add
- /node/set
- /node/get
- /node/ping
- /node/ping/ack
- /node/deliver
- /node/retrieve
- /node/webhook
- /node/configuration
- /node/delete
- /node/study/queued
- /node/found
- /node/found/mwl
- /node/event
- /node/log
- /node/metric
- /node/performance/set
- /node/performance/get
- /node/progress/add
- /node/progress/list
- /node/progress/get
- Destination commands
- Route commands
- Account commands
- /account/list
- /account/set
- /account/get
- /account/delete
- /account/user/add
- /account/user/set
- /account/user/get
- /account/user/delete
- /account/user/list
- /account/user/report/login
- /account/can/share
- /account/can/share/stop
- /account/can/share/list
- /account/css
- /account/settings
- /account/settings/validate
- /account/connect
- /account/md5/counter
- /account/list/requestable
- Location commands
- Group commands
- Role commands
- Activity commands
- Audit commands
- Namespace commands
- /namespace/permissions
- /namespace/settings
- /namespace/share_code
- /namespace/share/pricing
- /namespace/share/price
- /namespace/anonymize
- /namespace/coverpage
- /namespace/validate/customfields
- /namespace/event/defaults
- /namespace/study/defaults
- /namespace/engine/fqdn
- /namespace/removed/user/report
- /namespace/question
- /namespace/audit
- Help commands
- Terminology commands
- Analytics commands
- Filter commands
- Custom field commands
- Webhook commands
- Purge commands
- Link commands
- Message commands
- Dictionary commands
- Report commands
- Meeting commands
- Appointment commands
- Training commands
- RSNA commands
- NPI commands
Introduction
The API is implemented as a REST like interface. A call is made to a URL using either a POST or a GET. The URL will return either a HTTP error code or a JSON data structure.Global information
- Italic words represent field's names
- UPPER CASE words represent input data or error tokens
- Every returned data structure has a status field that holds either OK or ERROR
- Date and time stamps are in UTC
- Fields are required unless noted as optional
- Flags are numeric fields with a 1 or 0 value for true or false
Error handling
Errors are flagged by an HTTP error code as follows:- 401 Authorization required - The call needs a valid, logged in session id (sid), valid basic authentication user name and password or an OAuth token
- 405 Method not allowed - The call must be a POST not a GET
- 412 Precondition failed - The returned json data structure will have the status flag set to ERROR. The error_type and the optional error_subtype fields will hold tokens that describe the error. The optional error_data field can hold additional error data.
Filter clauses
Filters can typically be applied to list commands- A filter is one or more parameters of the format filter.FIELD.CONDITION
- The following conditions are supported
- equals - an exact match e.g.
filter.name.equals=jack
- Name field is equal to 'jack' - equals_or_null - an exact match plus any null values
- not_equals - Not equals an exact match e.g.
filter.name.not_equals=jack
- Name field is not equal to 'jack' - not_equals_or_null - Not equals an exact match or is null e.g.
filter.name.not_equals_or_null=jack
- Name field is not equal to 'jack' or is null - like - a wildcard match e.g.
filter.last.like=jack%
- Last name is like 'jack%' - gt - a greater than match e.g.
filter.date.gt=2001-10-10
- Date is greater than 2001-10-10 - ge - a greater than or equal to match e.g.
filter.date.ge=2001-10-10
- Date is greater than or equal to 2001-10-10 - lt - a less than match e.g.
filter.date.lt=2001-10-10
- Date is less than 2001-10-10 - le - a less than or equal to match e.g.
filter.date.le=2001-10-10
- Date is less than or equal to 2001-10-10 - in - match one of the items in the JSON array e.g.
filter.study_status.in=["stage1","stage2"]
- Study status is either stage1 or stage2 - in_or_null - match one of the items in the JSON array or the null value
- equals - an exact match e.g.
- Multiple filters are AND'ed together
- Custom fields can be filtered by specifying the field as customfield-CUSTOMFIELD_UUID
- A timezone offset in numeric format can be passed in the filter.tz and will be applied to any dates in the filter e.g.
filter.tz=-4:00
- A timezone name from Olson database can be passed in the filter.tz. Deprecated timezones will apply as UTC.
- Supported date and datetime formats are: YYYY-MM-DD, YYYYMMDD, YYYY-MM-DD hh:mm:ss[.uuuuuu][(+|-)ZZ[:ZZ]]. Timezone offsets are ignored. Server-side timestamps are truncated to seconds before comparison when a filter lacks microseconds part.
- Timezones apply in this order: current user's time zone, filter.tz parameter, UTC by default.
- A filter can be applied on a secondary table by putting the table names into the parameter e.g. filter.TABLE.FIELD.CONDITION
- Invalid filters will return the following error messages
- INVALID_FIELD • The field is not valid for this object. The error_subtype will hold the filter expression this applies to
- INVALID_CONDITION • The condition is not support. The error_subtype will hold the filter expression this applies to
- FILTER_NOT_FOUND • The filter can not be found. The error_subtype will hold the filter UUID
- INVALID_FIELD • The field is not valid for this object. The error_subtype will hold the filter expression this applies to
- Filters can be saved and manipulated by the Filter commands.
- A saved filter can be applied by passing the filter UUID as a filter_id parameter rather than the filter expression.
- To create an OR type of search specify multiple saved filters in the configuration of a saved search as per the /filter/add notes
Fields
- The returned fields for an object can be limited by passing a fields.OBJECT_NAME parameter that contains a JSON array of the fields to return e.g.
fields.account=["uuid","name"]
- All the top level returned fields except
status
can be filter via the special fields._top parameter. e.g.fields._top=["session_expire"]
Pagination
If pagination is applied to the list command the following parameters control pagination:- page.rows = Number of rows to return. The default is 100 or 1000 depending on the object type and the maximum is 5000
- page.number = Which page number to display. The default is 1
The command will return a hash called page with the following parameters in it.
- more - flag if there are more records
- rows - The maximum number of rows in the page
- number - The page number
Sorting
If a list can be sorted it will support the sort_by parameter in the call. The value of the sort_by parameter is a comma delimited list of fields with the direction of ordering (ascending or descending) appended to the field(s).
For example
sort_by=name-asc,date-desc
will sort the results by name in ascending order and then date in descending order.
Invalid sort_by values will return the following error messages
INVALID_SORT_FIELD • The field is not valid for this object. The error_subtype will hold the field name this applies to
INVALID_SORT_ORDER • The sort order for the field is invalid. The error_subtype will hold the field name this applies to
Bundled calls
You can bundle a series of calls into a single call to the server. To do this, POST to /bundle a textual representation of a JSON array of hashes. Each hash must contain the URL key with the value the
API entry point, the rest of the keys should be the parameters for the call. The server will process all the calls in order and return a JSON array of the responses in the same order. For example to get
the account detail and the user's permissions for the account in a single call send
POST /bundle [
{"URL":"/account/get", "sid":"XYZ", "uuid":"ABC"},
{"URL":"/session/permissions", "sid":"XYZ", "account_id":"ABC"}
]
and you will get back an array with two hashes the containing the results of the call. If the POST is malformed the server will return an HTTP_BAD_REQUEST error code. The returned hashes have an additional
HTTP_STATUS_CODE field with the result code for the request. Each call will return a hash even if it is an error hash so you can mix successful and unsuccessful calls and parse the results.
Within a bundled call you can use values from previous calls using templated values. If the value is of the form {{TOKEN}} the value will be substituted if TOKEN was returned by any of the previous calls.
Here is an example of the usage
POST /bundle [
{"URL":"/session/login", "login":"a@b.com", "password":"XYZ"},
{"URL":"/study/list", "sid":"{{sid}}"},
{"URL":"/study/get", "sid":"{{sid}}", "uuid":"{{studies.[0].uuid}}"}
]
The templated values can use dot notation to recurse into the arrays and hashes in the returned data structure as per the last line on the previous example.
Here is an example of how to run a bundled session from your desktop
- Create a text file called data.json with the following text in it
[ {"URL":"/session/login", "login":"a@b.com", "password":"XYZ"}, {"URL":"/study/list", "sid":"{{sid}}"}, {"URL":"/study/get", "sid":"{{sid}}", "uuid":"{{studies.[0].uuid}}"} ]
- Run it using curl
curl -H "Content-Type: application/json" -X POST -d @data.json https://uat.dicomgrid.com/api/v3/bundle
Permissions
A role has the following permission flags. The default roles are Admin, User, PHR and Anonymous and have the following settings.
Flag | Admin Value |
User Value |
PHR Value |
Anonymous Value |
Description |
---|---|---|---|---|---|
account_edit | 1 | 0 | 0 | 0 | Can they add and edit the account |
account_view | 1 | 0 | 0 | 0 | Can they view account information |
account_user_view | 1 | 0 | 0 | 0 | Can they view or list the users in the account |
account_user_edit | 1 | 0 | 0 | 0 | Can they add, edit and remove users from an account |
account_user_invite | 1 | 0 | 0 | 0 | Can they invite users to an account |
user_edit | 0 | 0 | 0 | 0 | Can they create and edit users on the grid |
destination_view | 1 | 0 | 0 | 0 | Can they view or list the destinations in the account |
destination_edit | 1 | 0 | 0 | 0 | Can they add, edit and remove destinations from an account |
destination_search | 0 | 0 | 0 | 0 | Can they search a destination |
destination_search_mwl | 0 | 0 | 0 | 0 | Can they run a modality worklist search on a destination |
group_view | 1 | 0 | 0 | 0 | Can they view or list the groups in the account |
group_edit | 1 | 0 | 0 | 0 | Can they add, edit and remove groups from an account |
group_clone | 1 | 0 | 0 | 0 | Can they clone groups in the account |
location_view | 1 | 0 | 0 | 0 | Can they view or list the locations in the account |
location_edit | 1 | 0 | 0 | 0 | Can they add, edit and remove locations from an account |
location_clone | 1 | 0 | 0 | 0 | Can they clone locations in the account |
role_view | 1 | 0 | 0 | 0 | Can they view or list the roles in the account |
role_edit | 1 | 0 | 0 | 0 | Can they add, edit and remove roles from an account |
route_view | 1 | 0 | 0 | 0 | Can they view or list the routes in the account |
route_edit | 1 | 0 | 0 | 0 | Can they add, edit and remove routes from an account |
node_view | 1 | 0 | 0 | 0 | Can they view or list the nodes in the account |
node_edit | 1 | 0 | 0 | 0 | Can they add, edit and remove nodes from an account |
node_edit_own | 0 | 0 | 0 | 0 | Can they add, edit and remove their own nodes from an account |
node_connect | 1 | 0 | 0 | 0 | Can they view and connect to public nodes |
node_approve_connect | 1 | 0 | 0 | 0 | Can they approve connect to theirs public nodes |
study_approve | 1 | 0 | 1 | 0 | Can they approve or reject shared studies in the account, group, location |
study_view | 1 | 1 | 1 | 1 | Can they view the studies in the account, group, location |
study_edit | 1 | 0 | 1 | 0 | Can they edit the PHI of the study |
↳ study_edit_approved | 1 | 1 | 1 | 0 | Can they edit the PHI of an approved study |
↳ study_edit_unapproved | 1 | 1 | 1 | 0 | Can they edit the PHI of an unapproved study |
study_star | 1 | 1 | 0 | 0 | Can they star studies |
study_tag | 1 | 1 | 0 | 0 | Can they tag studies |
study_upload | 1 | 0 | 0 | 0 | Can they upload a study to the account, group, location |
study_upload_validate | 0 | 0 | 0 | 0 | An upload requires session validation |
study_report_detail | 1 | 0 | 1 | 0 | Can they get the detail report for studies in the account, group, location |
study_download | 1 | 0 | 1 | 0 | Can they download the study |
study_download_viewer | 1 | 0 | 1 | 0 | Can they download the local study viewer |
study_download_iso | 1 | 0 | 1 | 0 | Can they download the study ISO |
study_browse | 1 | 1 | 1 | 1 | Can they view studies in the web viewer |
study_push | 1 | 0 | 0 | 0 | Can they push the study to a destination |
study_share | 1 | 0 | 1 | 0 | Can they share the study |
↳ study_share_email | 0 | 0 | 1 | 0 | Can they share the study via email |
↳ study_share_share_code | 1 | 1 | 1 | 0 | Can they share the study via a share code |
↳ study_share_account | 1 | 1 | 1 | 0 | Can they share the study with accounts |
↳ study_share_location | 1 | 1 | 1 | 0 | Can they share the study with locations |
↳ study_share_group | 1 | 1 | 1 | 0 | Can they share the study with groups |
↳ study_share_user | 1 | 1 | 1 | 0 | Can they share the study with users |
↳ study_share_rsna | 0 | 0 | 0 | 0 | Can they share the study with the RSNA network |
↳ study_share_npi | 0 | 0 | 0 | 0 | Can they share the study with a NPI number |
↳ study_share_request | 0 | 0 | 0 | 0 | Can they share the study by a study request |
study_delete | 0 | 0 | 1 | 0 | Can they delete a study |
study_delete_image | 0 | 0 | 0 | 0 | Can they delete images and series within a study |
study_thin | 0 | 0 | 0 | 0 | Can they create a thin study |
study_report_view | 1 | 1 | 1 | 1 | Can they view attached reports for a study |
study_report_view_approved | 1 | 1 | 1 | 1 | Can they view attached reports for an approved study |
study_report_view_unapproved | 0 | 0 | 0 | 0 | Can they view attached reports for an unapproved study |
study_report_view_only_own | 0 | 0 | 0 | 0 | Can they only view reports they attached to the study |
study_timing_view | 0 | 0 | 0 | 0 | Can they view the timing log for a study |
study_report_hl7_view | 1 | 1 | 1 | 1 | Can they view HL7 reports for a study |
study_report_hl7_view_approved | 1 | 1 | 1 | 1 | Can they view HL7 reports for an approved study |
study_report_hl7_view_unapproved | 0 | 0 | 0 | 0 | Can they view HL7 reports for an unapproved study |
study_report_upload | 1 | 0 | 1 | 0 | Can they upload a report to a study |
study_report_upload_approved | 1 | 1 | 1 | 0 | Can they upload a report to an approved study |
study_report_upload_unapproved | 0 | 0 | 0 | 0 | Can they upload a report to an unapproved study |
study_report_delete | 1 | 0 | 1 | 0 | Can they delete a report from a study |
study_report_delete_approved | 1 | 1 | 1 | 0 | Can they delete a report from an approved study |
study_report_delete_unapproved | 0 | 0 | 0 | 0 | Can they delete a report from an unapproved study |
study_send_status_view | 1 | 1 | 1 | 1 | Can they view study push statuses when enabled |
study_sync | 0 | 0 | 0 | 0 | Can they force a study to sync against storage and re-run routing rules |
study_status_view | 0 | 0 | 0 | 0 | Can they view the status of the study |
study_status_edit | 0 | 0 | 0 | 0 | Can they edit the status of the study |
study_status_manual_edit | 1 | 1 | 1 | 1 | Can they manually edit the status of the study if study_status_edit is enabled |
study_comment_view | 0 | 0 | 0 | 0 | Can they view the comments for the study |
study_comment_edit | 0 | 0 | 0 | 0 | Can they edit comments for the study |
study_audio_record | 0 | 0 | 0 | 0 | Can they record an audio report for the study |
study_audio_play | 0 | 0 | 0 | 0 | Can they playback audio reports for the study |
study_move | 0 | 0 | 0 | 0 | Can they move the study to another PHI namespace |
study_freeze | 0 | 0 | 0 | 0 | Can they freeze or thaw the study |
study_duplicate | 0 | 0 | 0 | 0 | Can they duplicate studies to another namespace |
study_duplicate_request | 0 | 0 | 0 | 0 | Can they duplicate studies by a study requests |
study_manual_route | 0 | 0 | 0 | 0 | Can they manually route a study |
study_split | 0 | 0 | 0 | 0 | Can they split a study |
study_merge | 0 | 0 | 0 | 0 | Can they merge studies together |
study_take | 0 | 0 | 0 | 0 | Can they take a study into namespace with /study/take |
study_request_edit | 0 | 0 | 0 | 0 | Can they create study requests |
study_request_view | 0 | 0 | 0 | 0 | Can they view outgoing study requests |
study_request_view_only_own | 0 | 0 | 0 | 0 | Can they only view their own study requests |
study_request_view_inbound | 0 | 0 | 0 | 0 | Can they view incoming study requests |
study_field_patient_name study_field_patientid study_field_study_description study_field_accession_number study_field_modality study_field_referring_physician study_field_patient_sex study_field_study_date study_field_patient_birth_date study_field_customfield_UUID |
F | F | F | F | Permission for study fields. Customfields contain the UUID of the customfield. Valid values are.
|
audit_view | 1 | 0 | 1 | 0 | Can they view audit information |
analytics_view | 1 | 0 | 1 | 0 | Can they view analytics information |
study_search_require_patient_name | 0 | 0 | 0 | 0 | Patient name is required for a study search |
study_search_require_patient_sex | 0 | 0 | 0 | 0 | Patient gender is required for a study search |
study_search_require_accession_number | 0 | 0 | 0 | 0 | Accession number is required for a study search |
study_search_require_patient_birth_date | 0 | 0 | 0 | 0 | Patient birth date is required for a study search |
study_search_require_patientid | 0 | 0 | 0 | 0 | MRN is required for a study search |
filter_share | 1 | 0 | 1 | 0 | Can they share filters |
customfield_view | 1 | 0 | 0 | 0 | Can they view or list the customfields in the account |
customfield_edit | 1 | 0 | 0 | 0 | Can they add, edit and remove customfields from an account |
case_view | 0 | 0 | 0 | 0 | Can they view or list the cases in the account |
case_view_only_own | 0 | 0 | 0 | 0 | Can they only view or list their own cases in the account (when assigned as medical user) |
case_edit | 0 | 0 | 0 | 0 | Can they add, edit and remove cases from an account |
case_edit_only_own | 0 | 0 | 0 | 0 | Can they only edit and remove their own cases from an account (when assigned as medical user) |
case_delete | 0 | 0 | 0 | 0 | Can they delete cases |
customcode_view | 0 | 0 | 0 | 0 | Can they view or list the code in the account |
customcode_edit | 0 | 0 | 0 | 0 | Can they add, edit and remove code from an account |
customcode_deploy | 0 | 0 | 0 | 0 | Can they deploy code for a namespace |
patient_view | 0 | 0 | 0 | 0 | Can they view or list the patients in the account |
patient_edit | 0 | 0 | 0 | 0 | Can they add, edit and remove patients from an account |
order_view | 0 | 0 | 0 | 0 | Can they view or list the orders in the account |
order_edit | 0 | 0 | 0 | 0 | Can they add, edit and remove orders from an account |
webhook_view | 0 | 0 | 0 | 0 | Can they view or list the webhooks in the account |
webhook_edit | 0 | 0 | 0 | 0 | Can they add, edit and remove webhooks from an account |
can_proxy_login | 0 | 0 | 0 | 0 | Can they proxy login for "owned" users in an account |
radreport_view | 0 | 0 | 0 | 0 | Can they view or list the radreports in the account |
radreport_view_only_own | 0 | 0 | 0 | 0 | Can they view only their radreports |
radreport_edit | 0 | 0 | 0 | 0 | Can they add, edit and remove radreports from an account |
radreport_html_format | 0 | 0 | 0 | 0 | Can they use HTML formatting in radreports |
dictionary_view | 0 | 0 | 0 | 0 | Can they view or list the dictionaries in the account |
dictionary_edit | 0 | 0 | 0 | 0 | Can they add, edit and remove dictionaries from an account |
hl7_message_view | 0 | 0 | 0 | 0 | Can they view or list the HL7 messages in the account |
hl7_message_delete | 0 | 0 | 0 | 0 | Can they delete the HL7 messages in the account |
hl7_template_view | 0 | 0 | 0 | 0 | Can they view or list the HL7 templates in the account |
hl7_template_edit | 0 | 0 | 0 | 0 | Can they add, edit and remove HL7 templates from an account |
hl7_transform_view | 0 | 0 | 0 | 0 | Can they view or list the HL7 transformations in the account |
hl7_transform_edit | 0 | 0 | 0 | 0 | Can they add, edit and remove HL7 transformations from an account |
annotation_view | 1 | 1 | 1 | 1 | Can they view annotations on a study |
annotation_view_only_own | 0 | 0 | 0 | 0 | Can they view only their annotations on a study |
annotation_edit | 1 | 1 | 1 | 0 | Can edit annotations on a study |
meeting_view | 1 | 1 | 1 | 1 | Can they view meetings for a study |
meeting_edit | 0 | 0 | 0 | 0 | Can create and edit meetings for a study |
appointment_view | 0 | 0 | 0 | 0 | Can they view or list the appointments in the account |
appointment_view_only_own | 0 | 0 | 0 | 0 | Can they view only their appointments |
appointment_edit | 0 | 0 | 0 | 0 | Can they add, edit and remove appointments from an account |
keyimage_view | 1 | 1 | 1 | 1 | Can they view key images on a study |
keyimage_edit | 1 | 1 | 1 | 0 | Can edit key images on a study |
validate_view | 0 | 0 | 0 | 0 | Can they view or list the validation rules in the account |
validate_edit | 0 | 0 | 0 | 0 | Can they add, edit and remove validation rules from an account |
dicomdata_view | 0 | 0 | 0 | 0 | Can they view the DICOM data for a study |
dicomdata_edit | 0 | 0 | 0 | 0 | Can they edit the DICOM data for a study |
purge_view | 0 | 0 | 0 | 0 | Can they view or list the purge rules in the account |
purge_edit | 0 | 0 | 0 | 0 | Can they add, edit and remove purge rules from an account |
link_direct | 1 | 1 | 0 | 0 | Can they view and copy the direct link to the study |
link_view | 0 | 0 | 0 | 0 | Can they view or list the links in the account |
link_edit | 0 | 0 | 0 | 0 | Can they add, edit and remove links from an account |
link_edit_pin | 0 | 0 | 0 | 0 | Can they generate a one-time pin for a link |
link_edit_upload | 0 | 0 | 0 | 0 | Can they add, edit and remove study upload links from an account |
message_view | 1 | 1 | 1 | 0 | Can they view messages in the namespace |
message_edit | 1 | 0 | 1 | 0 | Can they send messages to the namespace |
user_modify_sharecode | 1 | 1 | 1 | 0 | Can they modify their personal share code |
user_modify_defaults | 1 | 1 | 1 | 0 | Can they modify their personal defaults |
user_modify_notifications | 1 | 1 | 1 | 0 | Can they modify their notifications |
user_view_others_notifications | 1 | 1 | 1 | 0 | Can they view other user's notifications |
user_modify_others_notifications | 1 | 1 | 1 | 0 | Can they modify other user's notifications |
user_request_access | 1 | 1 | 1 | 0 | Can they request access to an org |
channel_activity | 1 | 1 | 1 | 0 | Can they subscribe to an activity channel |
channel_study | 1 | 1 | 1 | 1 | Can they subscribe to a job channel |
viewer_config | JSON viewer configuration for the role. Optionally pass in the UUID of a user and that user's viewer configuration will be copied into the role | ||||
viewer3_config | JSON hash for the viewer3 configuration for the role. | ||||
ui_json | JSON structure to control the application UI | ||||
namespace_question | 1 | 0 | 0 | 0 | Can they ask AI questions for a namespace |
job_view | 1 | 1 | 1 | 1 | Can they view asynchronous job statuses |
Schedules
Objects with schedules support a JSON hash with the following fields
- start - The daily start time in 24hr HH:MM format
- stop - The daily stop time in 24hr HH:MM format
- mon - Flag if the start and end time should be applied on this day
- tue - Flag if the start and end time should be applied on this day
- wed - Flag if the start and end time should be applied on this day
- thu - Flag if the start and end time should be applied on this day
- fri - Flag if the start and end time should be applied on this day
- sat - Flag if the start and end time should be applied on this day
- sun - Flag if the start and end time should be applied on this day
- tz - The timezone for the schedule. The currently support values for this are.
- US/Eastern
- US/Central
- US/Mountain
- US/Arizona
- US/Pacific
- US/Alaska
- Brazil/East
- Brazil/West
- Africa/Johannesburg
- Europe/London
- Asia/Shanghai
- invert - A flag which means run the schedule outside the scheduled times rather than during it. This is useful for setting a "reverse" schedule. i.e. during business hours do "A", the rest of the time do "B".
Account settings
Account setting control the application workflow and UI for an account. The following settings are available.Name | Type | Default | Un-authenticated access allowed |
User override allowed |
Namespace override allowed |
Node override allowed |
Role override allowed |
Description |
---|---|---|---|---|---|---|---|---|
show_hl7_report_physician_alias_regexp | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Show the hl7_report_physician_alias_regexp option for the routing rules in the UI |
update_study_source_on_notify | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Update the study source for every notification |
allow_phr_upload | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Allow study upload into the PHR namespaces for users associated with this account |
enable_credit_card_processor | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable credit card processing for the account |
paypal_account | Text | 0 | 0 | 0 | 0 | 0 | The paypal account email for credit card processing | |
request_join_on_vanity_registration | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Automatically submit a join request if a user registers under a vanity domain |
vanity_registration_customfields | Text | 0 | 0 | 0 | 0 | 0 | 0 | Comma-delimited list of customfield uuids to show on vanity registration page |
login_json | Text | 1 | 0 | 0 | 0 | 0 | JSON structure to control the login page HTML | |
ui_json | Text | 0 | 1 | 1 | 0 | 0 | JSON structure to control the application UI:
|
|
baa_text | Text | 1 | 0 | 0 | 0 | 0 | The HTML to display next to a BAA checkbox that must be accepted for registration | |
training_text | Text | 1 | 0 | 0 | 0 | 0 | The HTML to display for the training manual link | |
faq_text | Text | 1 | 0 | 0 | 0 | 0 | The HTML to display for the FAQ link | |
other_manual_text | Text | 1 | 0 | 0 | 0 | 0 | The HTML to display for the "other" manual link | |
pin_auth_text | Text | 1 | 0 | 0 | 0 | 0 | The HTML to display for a failed pin_auth for /link/session | |
homepage_links | Text | 1 | 0 | 0 | 0 | 0 | A JSON hash of the links to display on the home page | |
enable_dicom_wrapping | Flag | 0 | 0 | 0 | 1 | 0 | 0 | Enable dicom wrapping support on uploading |
auto_enable_dicom_wrapping | Flag | 0 | 0 | 0 | 1 | 0 | 0 | Enable dicom wrapping support on uploading if no DICOM is detected |
single_file_dicom_wrapping | Flag | 0 | 0 | 0 | 1 | 0 | 0 | Limit DICOM wrapping on upload to a single file |
disable_mobile_dicom_wrapping | Flag | 0 | 0 | 0 | 1 | 0 | 0 | Disable dicom wrapping support on uploading for mobile devices |
enable_multipart_uploader | Flag | 1 | 0 | 0 | 1 | 0 | 0 | Enable multipart uploading |
allow_drag_and_drop_in_study_uploader | Flag | 0 | 0 | 0 | 1 | 0 | 0 | Allow Drag-n-Drop in the web uploader |
enable_dicom_deidentification | Flag | 0 | 0 | 0 | 1 | 0 | 0 | Enable the dicom de-identification tool on uploading |
dicom_deidentification_at_ingress | Flag | 1 | 0 | 0 | 0 | 0 | 0 | De-identify at ingress |
enable_dicomdir_scan | Flag | 1 | 0 | 0 | 0 | 0 | 0 | Enable dicomdir scanning on uploading |
from_email_address | Text | 0 | 0 | 0 | 0 | 0 | Use this email address as the from address for email sent from the account. This will be validated as an email address | |
from_email_name | Text | 0 | 0 | 0 | 0 | 0 | Use this display name in emails for email sent from the account. | |
enable_v2_viewer | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Use the version 2 viewer for this account |
enable_v3_viewer | Flag | 0 | 0 | 1 | 0 | 0 | 0 | Use the version 3 proviewer for this account |
auto_create_patient | Flag | 0 | 0 | 0 | 1 | 0 | 0 | Auto create patients from approved studies |
auto_update_patient_studies | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Update the patient's studies when the patient's information changes |
patient_unique_email_phone | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Require that the patient primary phone and email address be unique |
anonymize_at_ingress | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Should anonymization rules be applied at ingress by the uploader or gateway |
limit_query_retrieve_to_input_gateway | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Limit the HL7 driven query retrieve to the gateway that received the HL7 message |
include_mapped_custom_fields_from_storage_ns | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Include DICOM mapped custom fields from the storage namespace when updating the PHI in storage |
include_mapped_custom_fields_from_last_share | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Include DICOM mapped custom fields from the last share namespace when updating the PHI in storage |
update_phi_hl7 | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Update the PHI from ADT HL7 messages |
update_phi_hl7_namespaces | Text | 0 | 0 | 0 | 0 | A CSV list of PHI namespaces to limit the update_phi_hl7 feature too. e.g. f6b013b3-71be-40c6-b26c-5db6a4a2eada,4fcb78c2-ea21-4975-a318-cf5fc1bdf085 {"37b607eb-083e-497f-9923-48119076f62e":"A08","b6465cd6-d39b-4012-ba44-92e4ece81144":"A34"} |
||
update_accession_from_orm | Text | 0 | 0 | 0 | 0 | Using a field in the HL7 ORM find the studies that match and update their accession number to the HL7 accession number. Configure this via a JSON hash with the following keys
| ||
update_phi_syngo_match | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Update the PHI from Syngo patient match ORM messages |
upload_event_on_study_sync | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Fire the upload event notification when the /study/sync webhook is run |
logo_action | Text | 0 | 0 | 0 | 0 | 0 | What action to take when the logo is clicked | |
viewer3_config | Text | 0 | 0 | 0 | 0 | 0 | JSON hash of the viewer3 settings | |
viewer_show_reports | Flag | 1 | 0 | 1 | 1 | 0 | 0 | Show reports in the viewer |
enable_viewer_print | Flag | 1 | 0 | 1 | 0 | 0 | 0 | Enable the print feature on the viewer |
enable_viewer_export | Flag | 1 | 0 | 1 | 0 | 0 | 0 | Enable the export feature on the viewer |
viewer_diagnostic_quality | Flag | 0 | 0 | 1 | 0 | 0 | 0 | Diagnostic quality viewing |
viewer_diagnostic_quality_always | Flag | 0 | 0 | 1 | 0 | 0 | 0 | Diagnostic quality viewing in all modes including tools |
viewer_preload_diagnostic_images | Flag | 0 | 0 | 1 | 0 | 0 | 0 | Preload diagnostic images in the viewer |
viewer_enable_mpr | Flag | 0 | 0 | 1 | 0 | 0 | 0 | Flag to enable multi planar reconstruction in the viewer |
viewer_store_extra_annotation_data | Number | 0 | 0 | 1 | 0 | 0 | 0 | Capture extra annotation information |
viewer_default_drop_shape_width | Number | 0 | 0 | 1 | 0 | 0 | 0 | Customize the default size of circle and square drop shapes |
viewer_link_series | Flag | 0 | 0 | 1 | 0 | 0 | 0 | Link the series |
viewer_single_instance_series | Flag | 0 | 0 | 1 | 0 | 0 | 0 | Flag to enable viewing each image as a series |
viewer_multiframe_split_method | Number | 0 | 0 | 1 | 1 | 0 | 0 | Method to use when splitting multiframes out of their original series |
viewer_study_page_link_visible | Flag | 1 | 0 | 1 | 0 | 0 | 0 | Should the "Go to Study Page" link display in the viewer |
viewer_study_page_link_url | Text | 0 | 1 | 0 | 0 | 0 | Optional URL for the "Go to Study Page" link in the viewer | |
viewer_setting_not_diagnostic | Flag | 0 | 0 | 1 | 0 | 0 | 0 | Show a dialog explaining diagnostic usage when opening the viewer |
viewer_show_priors_worklist_only | Flag | 0 | 0 | 1 | 0 | 0 | 0 | Only priors currently in the worklist will be displayed as thumbnails in the viewer |
probe_for_accelerator | Flag | 0 | 0 | 1 | 0 | 0 | 0 | Have the viewer look for available accelerators |
enable_viewer_toggle_annotations | Flag | 1 | 0 | 0 | 0 | 0 | 0 | Enable the toggle annotations button for the viewer |
viewer_default_mouse_tool | Text | Scroll | 0 | 1 | 0 | 0 | 0 | The default mouse tool in the viewer |
auto_transcode | Flag | 0 | 0 | 0 | 0 | 0 | Enable pre-caching of all transcoded images during upload | |
auto_transcode_modalities | Text | 0 | 0 | 0 | 0 | 0 | Comma separated list of modalities to preemptively transcode data for | |
case_status_tags | Text | 0 | 0 | 0 | 0 | 0 | Comma separated list of case status tags | |
case_notify_submitted | Text | 0 | 0 | 0 | 0 | 0 | Comma separated list of email addresses to send a case_submitted email when a case is submitted. The special values user assigned_admin and assigned_medical will be replaced by the appropriate email address for the case.
| |
case_notify_completed | Text | 0 | 0 | 0 | 0 | 0 | Comma separated list of email addresses to send a case_completed email when a case is completed. The special values user assigned_admin and assigned_medical will be replaced by the appropriate email address for the case.
| |
study_status_tags | Text | 0 | 0 | 0 | 0 | 0 | Comma separated list of study status tags | |
study_status_mutex_tags | Text | 0 | 0 | 0 | 0 | 0 | Comma separated list of study status tags that lock the study to the user when set | |
study_status_singleton_tags | Text | 0 | 0 | 0 | 0 | 0 | Comma separated list of study status tags that allow the user to have only one locked study in the stage | |
study_status_role_tags | Text | 0 | 0 | 0 | 0 | 0 | A JSON hash. The keys are study status tags and the values are a list of the role uuids that can change to the status | |
study_status_tags_attributes | Text | 0 | 0 | 0 | 0 | 0 | A JSON hash. The keys are study status tags and the values are a list of the attributes attached to the tag | |
study_status_timer_suspensive_tags | Text | 0 | 0 | 0 | 0 | 0 | Comma separated list of study status tags that stop the study status timer. This setting is of lower priority than study_status_timer_starting_tags | |
study_status_timer_starting_tags | Text | 0 | 0 | 0 | 0 | 0 | Comma separated list of study status tags that start the study status timer. This setting is of higher priority than study_status_timer_suspensive_tags | |
study_status_timer_visible_at_last_status | Flag | 0 | 0 | 0 | 0 | 0 | 0 | When a study is at its final status show current timer value. Othervise -1 will be returned |
study_share_use_account_template | Flag | 0 | 0 | 0 | 0 | 0 | 0 | When sharing a study from the account or attaching a new report use the account mail template instead of the destination template |
study_share_email_confirm | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Require double entry of the share email address to confirm it |
logout_url | Text | 0 | 0 | 0 | 0 | 0 | URL to take the user to on logout | |
consolidate_wrapped_jpegs | Flag | 0 | 1 | 0 | 0 | 0 | 0 | Consolidate JPEGS when wrapping them |
enable_masshiway | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable Mass Hiway integration |
default_list_view | Text | 0 | 0 | 0 | 0 | 0 | The default list view. Accepts: namespace ids, 'USER_NAMESPACE' and 'FILTER-*' (* for a filter ID) | |
enable_dicom_tag_customfields | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable storage of any DICOM tag in the study customfield |
patients_from_hl7 | Text | 0 | 0 | 0 | 0 | 0 | Generate patients from HL7 ORM messages using the email address in the HL7 field specified in this setting. Use the notation specified in /hl7/transform/add e.g. PID_13_4 . Optionally you can pass a JSON hash formatted as per the patients_from_hl7_adt setting |
|
patients_from_hl7_conditions | Text | 0 | 0 | 0 | 0 | 0 | A condition to generate patients from HL7 ORM messages. Use the notation specified for conditions in /hl7/transform/add | |
patients_from_hl7_adt | Text | 0 | 0 | 0 | 0 | 0 | Generate patients from HL7 ADT messages. The value for this setting is a JSON hash that maps the Patient fields to corresponding HL7 fields. Customfields and Text::Template expressions are supported e.g. {"birth_date":"PID_7","last":"PID_5_1","email":"PID_13_4","first":"PID_5_2","mobile_phone":"PID_13_1","sex":"PID_8", "customfield-UUID":"{$PV1_35_2} to {$PV1_35_4}"} |
|
patients_from_hl7_adt_conditions | Text | 0 | 0 | 0 | 0 | 0 | A condition to generate patients from HL7 ADT messages. Use the notation specified for conditions in /hl7/transform/add | |
patients_from_hl7_siu | Text | 0 | 0 | 0 | 0 | Generate patients from HL7 SIU S12 messages. The setting is formatted as per the patients_from_hl7_adt setting. | ||
patients_from_hl7_siu_conditions | Text | 0 | 0 | 0 | 0 | A condition to generate patients from HL7 SIU S12 messages. Use the notation specified for conditions in /hl7/transform/add | ||
update_patients_from_hl7 | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Update patients from the hl7 messages |
appointments_from_hl7_adt | Text | 0 | 0 | 0 | 0 | 0 | Generate appointments from HL7 ADT messages. The value for this setting is a JSON hash that maps the appointment fields to corresponding HL7 fields. Customfields and Text::Template expressions are supported e.g. {"start_time":"PV1_33","end_time":"PV1_34","customfield-UUID":"{$PV1_35_2} to {$PV1_35_4}" . In addition if the map has a referring_physician key a PHYSICIAN_ALIAS lookup is performed using the value to find the matching user in the account.
| |
appointments_from_hl7_siu | Text | 0 | 0 | 0 | 0 | 0 | Generate appointments from HL7 SIU messages. The format is the same as for appointments_from_hl7_adt setting. | |
users_from_hl7_mfn | Text | 0 | 0 | 0 | 0 | 0 | Manage users from HL7 MFN messsages. The value for this setting is a JSON hash with the following fields
|
|
orders_from_hl7 | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Generate orders from HL7 ORM messages |
update_order_status_from_hl7 | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Update orders from HL7 ORM messages. orders_from_hl7 is also required |
orders_from_hl7_adt | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Generate orders from HL7 ADT messages |
reload_hl7_customfields_on_phi_update | Flag | 0 | 0 | 0 | 0 | 0 | Re-load custom fields when study is edited | |
allow_multiple_use_of_orders | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Allow an order to be applied to multiple studies |
link_first_study_only | Flag | 0 | 0 | 0 | 0 | 0 | 0 | When using the filter feature in the /link/* API return only the first study created if multiple studies match the filter |
enable_order_lookup_in_approval | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable look of HL7 orders to override PHI in the approval process |
study_push_status | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable tracking and display of the study push status for the account |
show_study_copy_push_status | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable display of the study push status for the account when they push to a destination node in a different namespace |
show_study_same_uid_push_status | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable display of the study push status from all study versions with the same UID in the account |
reverse_patient_name | Flag | 0 | 0 | 0 | 1 | 0 | 0 | Define patient name as last^first instead of first^last |
enable_click_to_filter | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable the click to filter feature in the UI |
customfields_last_on_search | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Show the customfields last on the study search dialog |
auto_wrap_images | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Auto wrap the images in storage |
reencode_dicom_mp4 | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Re-encode MP4 DICOM |
render_wrapped_pdf | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Convert PDF to viewer format |
render_wrapped_avi | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Convert AVI to viewer format |
render_wrapped_video | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Convert video to viewer format |
sr_render_css | Text | 0 | 0 | 0 | 0 | 0 | CSS for SR rendering> | |
upload_one_study | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Only allow one study to be selected and uploaded |
send_oru_instead_of_orm | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Send the study ORU with an embedded link instead of the ORM for the destination_hl7_orm routing action and the /study/send/hl7 action |
radreport_branding_from_phi_namespace | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Get the radreport branding from the PHI namespace instead of the storage namespace |
viewer_anon_annotations_clear | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Clear out the annotations created by an anonymous viewer |
viewer_enable_tap_navigation | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable tap to scroll on the viewer |
viewer_hide_thumbnails | Flag | 0 | 0 | 1 | 0 | 0 | 0 | Hide the viewer thumbnails by default |
viewer_hide_thumbnails_datetime | Flag | 0 | 0 | 1 | 0 | 0 | 0 | Hide the viewer datetime on the thumbnails by default |
viewer_hide_ruler | Flag | 0 | 0 | 1 | 0 | 0 | 0 | Hide the viewer annotation ruler |
viewer_hide_active_measurement_info | Flag | 0 | 0 | 1 | 0 | 0 | 0 | Hide the viewer thumbnails by default |
viewer_show_std_dev | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Show the standard deviation calculation |
other_ingress_tags | Text | 0 | 0 | 0 | 0 | 0 | A JSON list of DICOM tags to be used for the OTHER_INGRESS_TAGS anonymization metafield | |
use_other_ingress_tags_server_side | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Use the other ingress tags for server side anonymization as well as client side anonymization |
login_location | Text | 0 | 0 | 0 | 0 | 0 | A JSON hash of location names and session_expire values for the account | |
sso_share_phr_workflow | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable the PHR sharing workflow of the account |
sso_share_phr_workflow_options | Text | 0 | 0 | 0 | 0 | 0 | JSON hash to configure the SSO PHR sharing workflow. The hash can contain the following keys
|
|
sso_second_opinion_workflow | Text | 0 | 0 | 0 | 0 | 0 | JSON hash to configure the SSO second opinion workflow. The hash must contain a key called namespace_id with the value the UUID of the second opinion namespace. An optional key called data_map contains a hash of field names and the SAML attribute to lookup for the field name, this information will be passed to the UI to populate the second opinion form. e.g. {"data_map":{"customfield-83873415-38ab-4100-9a83-235664771cd3":"validated","date_of_birth":"dob"},"namespace_id":"2433468e-96e5-452d-b1e1-b91551425dd8"} |
|
add_oru_report_to_study | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Add the report for ORU HL7 messages to the study if the account has an hl7_template |
create_thin_study_from_oru | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Create a thin study from the ORU if the ORU does not match any existing studies |
create_thin_study_from_orm | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Create a thin study from the ORM if the ORM does not match any existing studies |
create_thin_study_from_oru_study_uid | Text | 0 | 0 | 0 | 0 | 0 | Get the study uid for the create_thin_study_from_oru or create_thin_study_from_orm feature from this hl7 field .e.g. OBX_5_1 |
|
create_thin_study_from_hl7_data_map | Text | 0 | 0 | 0 | 0 | 0 | A JSON hash that has field names for the /study/add command as the keys and the values are the HL7 field specification to get the value from e.g. {"referring_physician":"OBX_5_1"} . This map will be applied to thin studies created via the create_thin_study_from_oru or create_thin_study_from_orm settings to futher populate the thin study with values from the HL7
| |
accession_number_for_study_uid | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Allow the study_uid to be set to the accession number when a study is added and then update with the real study_uid on study acquisition |
ignore_blank_accession_number | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Ignore a blank or empty accession number from storage |
study_stat_filter | Text | 0 | 0 | 0 | 0 | 0 | A JSON array to specify the "stat" studies filter for the account. The first element is a customfield UUID and the second element is the "stat" value | |
refresh_data_on_reshare | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Refresh the integration key and customfields on a re-share of a study |
study_status_timer | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable the study status timer feature |
max_link_studies | Text | 100 | 0 | 0 | 0 | 0 | 0 | Maximum number of studies allowed in an anonymous link or link integration |
update_study_status_in_all_versions | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Update the study status in all versions of the study |
athena_subscribe_orders | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Subscribe to orders from Athena healthcare. In addition to this switch the account needs the following named customfields created and populated.
|
athena_unsolicited_namespace | Text | 0 | 0 | 0 | 0 | 0 | The UUID of the namespace that will invoke the Athena unsolicited orders workflow. This extends the /study/find/order API to search for the patient in Athena for studies in the namespace. The patient_name for the search must have both a first and last name and the study birth date must match the birth date in Athena. It has the same customfield requirements as the athena_subscribe_orders setting. | |
athena_orders_filter | Text | 0 | 0 | 0 | 0 | 0 | A JSON hash of order field names and the regular expression it must match to be processed as an order .e.g. {"description":"/XRAY/"}
|
|
allow_user_password_for_account_login | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Authenticate against both the account_password and user password when logging in using an account_alias |
welcome_password_reset_token_ttl | Number | 0 | 0 | 0 | 0 | 0 | 0 | Reset tokens generated for welcome messages are valid for so many seconds |
ip_whitelist | Text | 0 | 1 | 0 | 0 | 1 | Restrict logins to the specified network or IP address e.g. 195.114.80/24,38.32.26.106/32 A CSV list can be used to specify multiple networks. This is only applied to users who solely belong to the account | |
link_external_whitelist | Text | 0 | 0 | 0 | 0 | 0 | Restrict external links access to the specified network or IP address. Further documentations is in the External links page. | |
load_ack_as_hl7 | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Load the ACK from a delivered study HL7 message back into the system as an incoming HL7 message |
add_on_invite | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Modify the /user/invite behavior to automatically add the user to the account if they are already on the system |
invite_ttl | Number | 0 | 0 | 0 | 0 | 0 | 0 | Account user invites are valid for so many seconds |
duplicate_study_check | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Check for a duplicate study on upload |
disable_duplicate_study_upload | Flag | 0 | 0 | 0 | 1 | 0 | 0 | Disable upload of a duplicate study by uid across account |
must_approve_duplicate_study_uid | Flag | 0 | 0 | 0 | 1 | 0 | 0 | Require approval of a study if the same study_uid already exists in the namespace |
force_new_study_on_upload | Flag | 0 | 0 | 0 | 1 | 0 | 0 | On upload create a new UID for the study if it already exists in the namespace |
save_original_to_pre_anon_cf | Flag | 0 | 0 | 0 | 1 | 0 | 0 | For client side anonymization save the original values to any pre_anon_* customfields |
add_patientid_to_hl7_query_retrieve | Flag | 0 | 0 | 0 | 0 | 1 | 0 | Add the MRN to the query retrieve triggered via a HL7 message |
max_match_study_hl7 | Number | 100 | 0 | 0 | 0 | 0 | 0 | Maximum number of studies to match against an HL7 message |
include_adt_in_study_find_order | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Include ADT messages when search for orders in /study/find/order |
include_manual_orders_in_study_find_order | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Include orders created in Ambra through the API when search for orders in /study/find/order |
use_namespace_name_on_upload_request | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Use the upload namespace name instead of the requestors name and email for upload requests |
confirm_before_upload | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Require the user confirm that they are authorized to upload the study |
study_status_timer_attributes | Text | 0 | 0 | 0 | 0 | 0 | The JSON for color coding studies based on a timer | |
enable_patient_portal | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable the patient portal feature |
expose_patient_portal | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Make a patient portal publicly visible |
require_mrn_for_patient_portal | Flag | 0 | 1 | 0 | 0 | 0 | 0 | Require a MRN when searching for patients in the portal |
enable_thin_retrieve_in_patient_portal | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Allow retrieving of thin studies in the patient portal |
ignore_mrn_on_thin_retrieve | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Ignore MRN on thin retrieve |
allow_portal_pin_to_dup_addresses | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Allow the patient portal pin to be send to duplicate patient emails or phone numbers |
hide_patient_portal_email_regex | Text | 0 | 0 | 0 | 0 | 0 | A regular expression to hide matching email addresses from the patient portal access screen | |
use_link_on_patient_portal_share | Text | 0 | 0 | 0 | 0 | 0 | The uuid of a link that will be duplicated and emailed when a patient shares a study via email. The link must be a STUDY_VIEW link and have a study_id which will be replaced by the shared study id | |
suppress_new_patient_share_event | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Suppress the emails for the share of existing studies when a new patient is created |
suppress_all_patient_emails | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Suppress all emails to the patients |
suppress_new_report_event_in_phr_for_patients | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Make sure a patient will not get twin new_report emails as a patient and as a PHR namespace user |
study_search_modifiers | Text | 0 | 0 | 0 | 0 | 0 | The JSON hash to change to default study searching behavior
e.g. {"patientid":"equals"} will make the MRN an exact match,
{"accession_number":"like"} will make accession number a partial match |
|
study_edit_reason | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Require a reason for a PHI update |
radreport_sign | Text | 0 | 0 | 0 | 0 | 0 | A JSON hash holding the information for signing a radreport | |
passwdqc | Text | 0 | 0 | 0 | 0 | 0 | The specification string for a passwdqc check against proposed passwords for account users | |
passwd_regexp | Text | 0 | 0 | 0 | 0 | 0 | A JSON list of regular expressions to match against the proposed password for account users. All regular expression must match to allow the password to be used. | |
include_patientid_in_hl7_match | Flag | 1 | 0 | 0 | 0 | 1 | 0 | Match HL7 message to studies by both the accession number and the MRN (patientid - (0010,0020)) |
include_patientid_other_in_hl7_match | Flag | 0 | 0 | 0 | 0 | 1 | 0 | Match HL7 message to studies by both the accession number and the patientid_other value (0010,1000) |
mwl_search_is_cfind | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Use a cfind instead of a MWL query for the MWL searching workflow |
mwl_filter_if_matching_study | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Exclude orders with a matching study for /order/sps/find MWL queries |
force_download_of_attachments | Flag | 0 | 0 | 0 | 0 | 0 | 0 | All attachments must be downloaded before they can be opened |
show_radreport_in_all_namespaces | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Show radreports on all versions of the study |
enable_radreport_attestation | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Require electronic signing of radreport |
disable_csrf_on_links | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Disable the CSRF cookie for /link/redirect |
disable_link_session | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Disable the /link/session API call for the account |
report_view_phr_delay | Text | 0 | 0 | 0 | 0 | 0 | A setting to delay a study report exposure in patient's portal. A delay can be expressed in a number of minutes to delay or a number of work hours with suffix 'wh', possible setting's formats:
| |
account_time_zone | Text | 0 | 0 | 0 | 0 | 0 | 0 | A timezone for the account. Used for date and time calculations. |
work_hour_matrix | Text | 0 | 0 | 0 | 0 | 0 | 0 | A JSON list of lists which makes up a matrix 7 by 24 of work hours for the account. 1s mark work hours, 0s mark non-work hours, tailing zeroes are optional. The first index is for day of week (0 means monday), the second is for day hour (0 means 00:00-01:00am). |
study_view_phr_delay | Text | 0 | 0 | 0 | 0 | 0 | A setting to delay studies visibility in patient's portal. See format description for report_view_phr_delay | |
link_defaults | Text | 0 | 0 | 0 | 1 | 0 | A JSON hash of the default link add values for the UI | |
upload_settings | Text | 0 | 0 | 0 | 1 | 0 | A JSON hash of the upload settings | |
hl7_fetch_filter | Text | 0 | 0 | 0 | 0 | 0 | A transform condition expression (see /transform/add for format) to match against the HL7 message. Only fire a query retrieve if the message matches the condition | |
account_hl7_map | Text | 0 | 0 | 0 | 0 | 0 | A JSON hash mapping the value in MSH_3 or MSH_5 to another account uuid. The hash key is an HL7 message field, the value can be an account uuid or a hash with acount_id and node_id(optional) keys. The HL7 message will be attached to the mapped account and a node will be replaced with the given one. The special hash key _HL7_FIELD_ can be used to set a different place to get the value .e.g. MSH_6_1 This can only be set by a sysadmin or support user |
|
report_csv_download_concat | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Export all CSV rad reports into one CSV file |
update_all_studies | Text | 0 | 0 | 0 | 0 | 0 | JSON array of the field names that should be synced across all copies of the study in the account e.g. ["patient_name","patientid","customfield-UUID"] |
|
batch_encode_cine | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Use slower batched rendering for producing cine files from series; use only if older OS/browser combination prevents viewing regular cine files |
encapsulate_wrapped_pdf | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Storage setting for DICOM encapsulated PDF's |
compress_audio_recordings | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Compress audio recordings in the browser before sending them to storage |
upload_hold | Number | 0 | 0 | 0 | 0 | 0 | 0 | Upload hold time in storage. This is used if the namespace doesn't have an explicit hold time |
namespace_child_study_defaults | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Propagate study default values for parent child namespace setups |
compress_audio_recordings | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Compress audio in the browser before uploading |
study_search_require_regexp | Text | 0 | 0 | 0 | 0 | 0 | A JSON hash of regexp to apply to the study_search_require_* field checks. The keys are the field names and the values are the regexp e.g. {"patient_name":"/^\\\w{3}/"}
| |
query_retrieve_require_regexp | Text | 0 | 0 | 0 | 0 | 0 | A JSON hash of regexp to apply to the /destination/search and /destination/search/mwl calls. The keys are the field names and the values are the regexp e.g. {"patient_name":"/^\\\w{3}/"}
| |
query_retrieve_require_regexp_mwl | Text | 0 | 0 | 0 | 0 | 0 | A JSON hash of regexp to apply to the /destination/search/mwl calls instead of the query_retrieve_require_regexp. The keys are the field names and the values are the regexp e.g. {"patient_name":"/^\\\w{3}/"}
| |
query_retrieve_require_criteria_min | Number | 0 | 0 | 0 | 0 | 0 | Minimal number of search criteria for /destination/search Default is 1 | |
enable_drchrono | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable the drchrono integration |
exclude_load_dicom_tag | Flag | 1 | 0 | 0 | 0 | 0 | 0 | Do not sync customfields with the load_dicom_tag flag enabled back to the storage DICOM |
auto_fill_patient_in_activity | Flag | 1 | 0 | 0 | 0 | 0 | 0 | Auto fill the patient name when using the MWL or Find Orders features in the Activities queue |
report_from_hl7 | Text | 0 | 0 | 0 | 1 | 0 | A JSON hash that specifies the message type as the key and the hl7 field/subfield as the value. The base64 encoded report will be extracted from message as per these specs and be attached as a report to the associated studies e.g. {"ORU":"OBX-12_5_5"} |
|
upload_select_none | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Require selecting studies to upload when multiple studies are added |
link_external_referer | Text | 0 | 0 | 0 | 0 | 0 | Limit access to /link/external to the specific referer. The referer can be a regexp to match multiple referers | |
link_external_whitelist | Text | 0 | 0 | 0 | 0 | 0 | IP address whitelist to apply to the /link/external call. Further documentation here | |
link_external_whitelist_all_links | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Flag to apply the link_external_whitelist setting to all links |
link_sticky_anon_users | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Stick anonymous users to links via the email_address so they can edit annotations etc. over multiple sessions |
audit_failed_logins | Number | 0 | 0 | 0 | 0 | 0 | 0 | The maximum number of failed logins against the account vanity(s) to hold for up to 30 days. The information on the failed logins is available via the /audit/failedlogins end point. |
radreport_attestation_signature | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Attach the users signature to the radreport |
hide_help_tool | Flag | 0 | 1 | 0 | 0 | 0 | 0 | Hide the help icon from the UI |
mwl_sending_facility_filter | Text | 0 | 0 | 0 | 1 | 0 | A JSON list of sending_facility values to limit node queries for /order/sps/find too. | |
mwl_filter_expression | Text | 0 | 0 | 0 | 1 | 0 | A filter expression to limit node queries for /order/sps/find e.g. filter.order_sps.modality.equals=MR
| |
mrn_qr | Text | 0 | 0 | 0 | 0 | 0 |
A JSON hash to configure a MRN query retrieve and PHI fixup workflow. The keys and values in the hash are as follows:
|
|
search_qr | Text | 0 | 0 | 0 | 0 | 0 |
A JSON hash to configure a search, retrieve and PHI fixup workflow. The keys and values in the hash are as follows:
|
|
hl7_delay_route | Text | 0 | 0 | 0 | 0 | 0 |
A JSON hash to configure a routing delay for an HL7 message. The keys and values in the hash are as follows:
|
|
saml_sync_on_create_only | Flag | 0 | 1 | 0 | 0 | 0 | 0 | Sync up the SAML roles and assignments when the user is provisioned. Do not sync up on subsequent logins and the SAML role attribute is not required |
external_viewer | Text | 0 | 0 | 0 | 0 | 0 |
A JSON hash to configure an external viewer for the account. The keys and values in the hash are as follows:
|
|
disable_external_viewer_for_links | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Do not use the external viewer for studies viewed via a link by an anonymous user |
limit_oru_by_storage_namespace | Text | 0 | 0 | 0 | 0 | 0 |
A JSON hash of storage namespaces that ORU messages can be attached to studies in. The hash keys should be the storage namespace uuid and the hash value should be 1. e.g. {"2b14215c-44a8-4aa6-af70-f7b14d5e32ed":1,"587d5b83-917c-4d95-89a8-f537debaf9de":1}
|
|
epic_patient_lookup_info | Text | 0 | 0 | 0 | 0 | 0 |
A JSON hash to with the information needed for the Epic patient lookup workflow. If the lookup does not return a unique patient the study will be routed to the activity queue for approvals. This setting can also be set at the brand level if multiple Epic integrations are needed into an account. The keys and values in the hash are as follows:
|
|
epic_name_format | Text | 0 | 0 | 0 | 0 | 0 |
By default the patient name is formatted as LAST^MIDDLE^FIRST, change it via this setting e.g. LAST^FIRST^MIDDLE
|
|
enable_epic_patient_lookup | Flag | 0 | 0 | 0 | 1 | 0 | 0 | Enable the Epic patient lookup for the account or namespace |
epic_prompt_for_anonymize | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable the prompt_for_anonymize feature for uploads via the Epic integration |
epic_upload_match | Text | 0 | 0 | 0 | 0 | 0 |
Enable the upload_match feature on links to restrict studies can that be uploaded. This field should be in the same format as the upload_match link field. The regular expressions can contain the special tags _LAST_,_FIRST_,_DOB_, _MRN_ or _SEX_ which will be replaced with the data from Epic. For example to restrict uploads to studies that match the patients last name and date of birth use the following setting {"(0010,0030)":"/^_DOB_$/","(0010,0010)":"/_LAST_/"}
|
|
cerner_patient_lookup_info | Text | 0 | 0 | 0 | 0 | 0 |
A JSON hash to with the information needed for the Cerner patient lookup workflow. The keys and values in the hash are as follows:
|
|
enable_link_charging | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable charging for accessing a link |
ai_attach_scanned_docs_as_pdf | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
ai_anonymize_study_images | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
ai_anonymize_study_hl7 | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
anonymize_study_images_google_dlp | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
anonymize_study_images_aws_rekognition | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
anonymize_study_images_aws_textract | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
anonymize_study_images_tensorflow_east | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
detect_phi_in_study_images_google_dlp | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
ai_study_manual_route | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
ai_search_and_replace_study_tags | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
ai_delete_duplicate_images | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
ai_delete_scanned_docs | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
ai_anonymize_attached_pdf | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
ai_anonymize_attached_pdf_google_dlp | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
ai_lookup_billing_code | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
ai_run_custom_code_scripts | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
ai_bodypart_abdomen_chest_pelvis | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
ai_ocr_study_images_google_vision | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
ai_anonymize_study_hl7_dwf | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
ai_classify_contrast_in_study_series | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
ai_categorize_phi_in_study_images_google_vision_then_dlp | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
ai_run_custom_code_namespace_scripts | Text | 0 | 0 | 1 | 0 | 0 | Settings for the AI question | |
enable_namespace_ai_questions | Text | 0 | 0 | 1 | 0 | 0 | A JSON list of enabled namespace AI questions | |
apply_settings_to_owned_phr | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Apply account settings to studies in owned PHR accounts |
cloud_storage_config | Text | 0 | 0 | 1 | 0 | 0 | Configuration for the cloud storage provider | |
enable_doximity_auth | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable Doximity login for the account vanity(s) |
enable_google_auth | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable Google login for the account vanity(s) |
enable_recaptcha | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Enable recaptcha on join for the account vanity(s) |
suppress_hl7_eom_sep | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Supress the FS separator at the end of HL7 template messages |
no_default_study_date_time | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Do not set a default date and time if the study does not have one |
include_date_in_smart_search | Flag | 0 | 0 | 0 | 0 | 0 | 0 | In a smart search try parse the value as a DOB |
only_this_account_in_vanity | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Only show this account if accessing it via a vanity URL |
sync_user_login_to_account_login | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Sync the user credentials on account_login and account_password when they are added to an account. If they change their password under an account vanity only update the account_password |
include_in_global_purge | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Include this account in global purging rules |
helpscout_beacon_id | Text | 1 | 0 | 0 | 0 | 0 | Account override for the helpscout beacon id | |
sendgrid_key | Text | 0 | 0 | 0 | 0 | 0 | Account Sendgrid API key. This is setting is never displayed after it is set | |
pixel_anonymize_color | Text | 0 | 0 | 1 | 0 | 0 | Set the background color for pixel anonymization | |
priority_notifications | Flag | 0 | 0 | 0 | 1 | 0 | 0 | Prioritize notifications on the storage queue for the account or namespace |
disable_user_days | Number | 0 | 0 | 0 | 0 | 0 | User accounts will be disabled after this number of days | |
see_all_destination_search_in_activity | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Allow users to see all the available destination searches in the activity queue |
multiple_sso_connections | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Support multiple Pingone connections for the account |
mpi_config | Text | 0 | 0 | 0 | 0 | 0 | A JSON hash to with the information needed for the MPI (master patient index) ORM triggered workflow. Each key is the facility code and the value is a configuration hash with the following KV pairs:
|
|
mpi_allowed | Text | 0 | 0 | 0 | 0 | 0 | UUID of the account that is allowed to perform MPI queries into this account | |
study_download_no_reports | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Remove reports from study downloads |
group_local_pushes_by | Text | 0 | 0 | 0 | 0 | 0 | JSON array of fields to form a group by key for local pushes' statuses. The only allowed value for now is "destination_address" | |
set_phantom_on_reload | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Set the study to phantom state on a re-upload |
bundle_notify_destination_search | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Condense email notifications for destination searhes initiated from a bundle |
disable_sticky_phi | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Do not make the PHI information sticky so that if the study data changes it is reflected in the UI |
enable_messages_by_study_uid | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Show messages tied to studies with the same UID in the same account |
duplicate_oru_with_study | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Flag to duplicate Hl7 ORU messages when they duplicate a study between accounts |
enable_take_study_feature | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Flag to enable study take feature |
take_study_number_to_take_at_a_time | Number | 1 | 0 | 0 | 0 | 0 | 0 | Number of studies to take by /study/take |
take_study_source_namespace | Text | 0 | 0 | 0 | 0 | 0 | A namespace UUID from which studies will be taken by /study/take | |
take_study_dedup_by_field | Text | study_uid | 0 | 0 | 0 | 0 | 0 | Ordinary study field name or a 'customfield-UUID' used to guarantee study uniqueness in /study/take destination namespace |
enable_orders_in_worklist | Flag | 0 | 0 | 0 | 0 | 0 | 0 | Flag to show linked studies in orders tab and linked orders in worklist |
study_requestable_accounts | Text | 0 | 0 | 0 | 0 | 0 | A JSON list of account UUIDs that are allowed to request studies from. This can only be set by a sysadmin | |
study_requestable_namespaces | Text | 0 | 0 | 0 | 0 | A comma separated list of namespace UUIDs that the requested account is allowed to share/duplicate studies from by request. |
Study AI questions
AI questions can be run for a study against the AI neural network stack via the /study/question call. The following questions are available:Question | Description | Account setting |
---|---|---|
which_body_part | Which body part is the study showing | |
has_scanned_docs | Does the study have any scanned documents in it | |
delete_scanned_docs | Delete the scanned documents | ai_delete_scanned_docs |
attach_scanned_docs_as_pdf | Deletes AI identified scanned images within the study | ai_attach_scanned_docs_as_pdf |
anonymize_study_images | Anonymize the study images | ai_anonymize_study_images |
anonymize_study_images_google_dlp | Anonymize the study images using Google DLP | ai_anonymize_study_images_google_dlp |
anonymize_study_images_tensorflow_east | Anonymize the study images using Tensorflow EAST | ai_anonymize_study_images_tensorflow_east |
detect_phi_in_study_images_google_dlp | Detect PHI presence in the study images using Google DLP | ai_detect_phi_in_study_images_google_dlp |
anonymize_study_images_aws_rekognition | Anonymize the study images using AWS Rekognition | ai_anonymize_study_images_aws_rekognition |
anonymize_study_images_aws_textract | Anonymize the study images using AWS Textract | ai_anonymize_study_images_aws_textract |
anonymize_study_hl7 | Anonymize the study HL7 | ai_anonymize_study_hl7 |
qureai_detect_brain_bleeds | Detect brain bleeds | |
qureai_detect_chestxray | Read chest xray | |
study_manual_route | Runs routing rules | ai_study_manual_route |
search_and_replace_study_tags | Performs search and replace rules on all images in the study | ai_search_and_replace_study_tags |
delete_duplicate_images | Deletes images which values are identical to specified DICOM tages | ai_delete_duplicate_images |
analyze_study_hl7 | Takes hl7 report and analyzes it | |
anonymize_attached_pdf | Takes all pdf attachments from a study and removes all PHI from them | ai_anonymize_attached_pdf |
anonymize_attached_pdf_google_dlp | Takes all pdf attachments from a study and removes all PHI from them | ai_anonymize_attached_pdf_google_dlp |
lookup_billing_code | Takes study description and populates billing code mapping | ai_lookup_billing_code |
run_custom_code_scripts | Implements ability to run custom code. | ai_run_custom_code_scripts |
bodypart_abdomen_chest_pelvis | Detects if the study image(s) contain(s) abdomen, chest and/or pelvis | ai_bodypart_abdomen_chest_pelvis |
ocr_study_images_google_vision | Performs OCR using Google Vision API and returns detected text | ai_ocr_study_images_google_vision |
ai_anonymize_study_hl7_dwf | Detects if text contains PHI and replaces it with asterisk chars | anonymize_study_hl7_dwf |
classify_contrast_in_study_series | Detects the presence of contrast in a series of study images | ai_classify_contrast_in_study_series |
categorize_phi_in_study_images_google_vision_then_dlp | Detects the presence of phi in study images and assigns categories to results | ai_categorize_phi_in_study_images_google_vision_then_dlp |
Namespace AI questions
AI questions can be run for a namespace against the AI neural network stack via the /namespace/question call. The following questions are available:Question | Description | Account setting |
---|---|---|
run_custom_code_namespace_scripts | Implements ability to run custom code. | ai_run_custom_code_namespace_scripts |
Session commands
Description | Log in a session |
---|---|
URL | /session/login |
Parameters |
email || account_name && account_login • The users email address or the account name and account_login (DEPRECIATED - Use login and vanity) login • The user account_login or email address vanity • The account vanity name. (optional) password • The password new_password • Change the password or account password to this. (optional) validate_session • If you would like to validate an existing session rather than create a new one pass in the sid of the session to valid in this parameter. It will check if the session is still valid and the credentials are for the session. (optional) location • Login location. (optional) remember_device • Remember the device as trusted. (optional) |
Returns |
status • OK sid • The session id uuid • The users uuid name • The users name training_todo • Flag if the user is required to do training pin_required • Flag if a PIN is required to validate this session pin_via • How was the PIN sent, the options are TOKEN,EMAIL or SMS terms_md5 • MD5 of the accepted terms of service privacy_md5 • MD5 of the accepted privacy policy indicator_md5 • MD5 of the accepted indications of use patientid • The primary patientid this session is for (optional) is_proxy • Flag if this is a proxy login |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_CREDENTIALS • Invalid user name or password. LOCKOUT • Too many failed attempts BAD_PASSWORD • The new_password does not meet the password requirements PASSWORD_RESET • The password needs to be changed VALIDATION_FAILED • The session validation failed WHITELIST_LOCKOUT • Login blocked by the account whitelist BLOCKED • The user is blocked from the system DISABLED • The user is disabled and needs to be /user/enabled to allow access BRAND_NOT_ALLOWED • The user is limited to some brands to login with allowed_login_brands setting SSO_ONLY • The user can only login via SSO |
Notes |
|
Description | Get the user information for the session owner |
---|---|
URL | /session/user |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) settings • A JSON list of user settings set via /setting/set to return (optional) |
Returns |
status • OK namespaces • An array of the namespaces the user can access. Each namespace holds the following fields. * uuid • Id of the namespace * name • Description of the namespace sid_md5 • The md5 of the sid accelerator_used • Flag if the session is running through an accelerator session_expire • The session expiration value in minutes settings • JSON hash of the requested settings (optional) The rest of the fields are the same as /user/get |
Errors | |
Notes |
Description | Get the permissions information for the session owner |
---|---|
URL | /session/permissions |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (account_id|namespace_id) • Either the account or namespaces to get the users permissions for |
Returns |
status • OK The permissions for the user in this account |
Errors | |
Notes |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account_id or namespace_id was not found |
Description | Log out a session |
---|---|
URL | /session/logout |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) |
Returns |
status • OK logout_url • URL to take to use to. Optional and driven by the account setting |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The sid was not found |
Notes |
Description | Enable cross site request forgery checking for the session |
---|---|
URL | /session/csrf/enable |
Parameters |
sid • The session id redirect_uri • The URL to redirect to |
Returns | A redirect to the passed URL which sets an httponly CSFR token cookie |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_URL • The URL must be a relative URL |
Notes | The client must not store the sid in a cookie for CSRF checking to work |
Description | Get a uuid from the server |
---|---|
URL | /session/uuid |
Parameters | |
Returns |
status • OK uuid • A uuid |
Errors | |
Notes |
Description | Redirect to the brands OAuth provider |
---|---|
URL | /session/oauth/start |
Parameters | |
Returns | A redirect to the brand OAuth provider |
Errors |
NO_OAUTH • OAuth is not setup for the associated brand |
Notes |
Description | Register and login with oauth |
---|---|
URL | /session/oauth |
Parameters |
code • The OAuth code vendor • The OAuth vendor (doximity|google|brand) redirect_uri • The redirect_uri used to get the code parameter |
Returns |
status • OK sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The users uuid name • The users name new_user • Flag if they are a new user |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_CODE • Invalid code INVALID_VENDOR • Invalid vendor OTHER_OAUTH • The user is already setup to OAuth via another vendor MISSING_INFORMATION • The response from the OAuth provider is missing either the email, first_name or last_name fields NO_OAUTH • OAuth is not setup for the associated brand AUTH_FAILED • OAuth failed or a user id was not returned |
Notes |
Description | Get an OAuth token to access other API calls |
---|---|
URL | /session/oauth/token |
Parameters |
grant_type • The grant type, set to client_credentials client_id • The users email address client_secret • The users password duration • The number of seconds the token is valid for (optional and defaults to 3600 with a maximum value of 86400) |
Returns |
status • OK access_token • The access token created_at • Timestamp when the token was created expires_in • Number of seconds before the token expires token_type • The token type bearer |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields LOCKOUT • Too many failed attempts AUTH_FAILED • Authentication failed |
Notes |
|
Description | Validate the PIN for the session |
---|---|
URL | /session/pin |
Parameters |
sid • The session id pin • The PIN |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_SID • Invalid sid INVALID_PIN • Invalid PIN PIN_EXPIRED • The PIN has expired |
Notes |
|
Description | Return the TTL for the sid |
---|---|
URL | /session/ttl |
Parameters |
sid • The session id |
Returns |
status • OK ttl • Number of minutes the session has to live |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields EXPIRED • Expired |
Notes |
User commands
Description | Join the system |
---|---|
URL | /user/join |
Parameters |
first • First name last • Last name password • Password email • Email share_code • Share code they are joining from (optional) captcha_response • Response from captcha (optional) customfield-(CUSTOMFIELD_UUID) • Custom field(s) defined in the vanity_registration_customfields account setting (optional) |
Returns |
status • OK uuid • uuid of the user |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields DUPLICATE_EMAIL• The email is already used LOCKOUT • Too many joins attempt BAD_PASSWORD • Password needs to be at least 8 characters long, contain at least two numbers, contain at least two characters and can't be one of your last three passwords CAPTCHA_FAILED • Verifying the captcha failed |
Notes |
|
Description | Add a user |
---|---|
URL | /user/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • Account id to check for the user_edit permission first • First name last • Last name password • Password email • Email mobile_phone • SMS phone number |
Returns |
status • OK uuid • uuid of the user namespace_id • The association namespace uuid |
Permission | user_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields DUPLICATE_EMAIL• The email is already used BAD_PASSWORD • Password needs to be at least 8 characters long, contain at least two numbers, contain at least two characters and can't be one of your last three passwords NOT_PERMITTED • You are not permitted to do this |
Notes |
|
Description | Get the information for a user |
---|---|
URL | /user/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The users uuid (optional). Uses the session user if not passed account_id • Account id if you are trying to get a user other than yourself (optional) |
Returns |
status • OK uuid • The user uuid name • The user name first • First name last • Last name email • Email mobile_phone • SMS phone number namespace_id • Namespace for the user sysadmin • Is the user a sysadmin support • Is the user a support user is_anonymous • Is this an anonymous user event_share • Notify the user on a share into the users namespace event_approve • Notify the user on a approval needed into the users namespace event_upload • Notify the user on an upload into the users namespace event_upload_fail • Notify the user on a failed upload into the users namespace event_harvest • Notify the user on a harvest into the users namespace event_new_report • Notify the user when a report is attached in the users namespace event_report_remove • Notify the user when a report is removed in the users namespace event_study_comment • Notify the user when a comment is attached to a study in the users namespace event_status_change • Notify the user when the status of a study is changed event_message • Notify the user when a message is sent to the users namespace event_link • Notify the user when an anonymous link is hit in the namespace event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails event_case_assignment • Notify the user when they are assigned a case as a medical or admin user share_code • The share code of the user share_description • The share description of the user time_zone • The users time zone abbreviation pin_required • Flag to require a PIN for every login allowed_login_brands • A comma separated list of Brand UUIDs that the user is allowed to use when logging in npi • NPI number terms_md5 • MD5 of the accepted terms of service privacy_md5 • MD5 of the accepted privacy policy indicator_md5 • MD5 of the accepted indications of use last_login • Timestamp of the last login event_incoming_study_request • Notify the user when they get an incoming study request ui_json • JSON for UI settings. Possible options:
|
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The user can not be found NOT_PERMITTED • You are not permitted to access this user record |
Notes |
Description | Set the information for a user |
---|---|
URL | /user/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The users uuid (optional). Uses the session user if not passed first • First name (optional) last • Last name (optional) email • Email (optional) mobile_phone • SMS phone number (optional) password • User password (optional) old_password • Previous user password (optional) share_code • The share code of the user (optional) share_description • The share description of the user (optional) account_id • Account id if you are trying to set a user other than yourself (optional) cc_token • The credit card token to attach to the users account (optional) time_zone • The users time zone name as per https://www.postgresql.org/docs/9.1/static/view-pg-timezone-names.html (optional) pin_required • Flag to require a PIN for every login (optional) allowed_login_brands • A comma separated list of Brand UUIDs that the user is allowed to use when logging in (optional) terms_md5 • MD5 of the accepted terms of service privacy_md5 • MD5 of the accepted privacy policy indicator_md5 • MD5 of the accepted indications of use ui_json • JSON for UI settings (optional) possible options: |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The user can not be found NOT_PERMITTED • You are not permitted to edit this user record. The error_subtype will hold the specific reason permission was denied. DUPLICATE_EMAIL • The email is already used BAD_PASSWORD • Password needs to be at least 8 characters long, contain at least two numbers, contain at least two characters and can't be one of your last three passwords INVALID_TOKEN • The cc_token is invalid INVALID_PASSWORD • The old_password does not match the current password INVALID_TIME_ZONE • The time zone is invalid |
Notes |
|
Description | Delete yourself from the system |
---|---|
URL | /user/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
Notes |
Description | A lost password request |
---|---|
URL | /user/password/lost |
Parameters |
email • The email |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields LOCKOUT • Too many failed attempts |
Notes | An email with a link to reset the password will be mailed to the user |
Description | Reset the users password |
---|---|
URL | /user/password/reset |
Parameters |
token • The reset token password • The new password |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_TOKEN • The token is invalid BAD_PASSWORD • Password needs to be at least 8 characters long, contain at least two numbers, contain at least two characters and can't be one of your last three passwords |
Notes |
Description | Send a welcome message to the user |
---|---|
URL | /user/welcome |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) email • The email of the user to welcome account_id • Id of the account to welcome them to link • URL to reset the password at. The reset token will be appended to the link |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The user can not be found INVALID_LINK • The link needs to be a https link within the site domain |
Notes |
|
Description | Get a list of the accounts the user can join |
---|---|
URL | /user/join/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK accounts • An array of the accounts. Each account holds the following fields. * uuid • Id of the account * name • Name of the account |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
Notes | This will only return accounts the user is not a member of |
Description | Request to join an account |
---|---|
URL | /user/join/request |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • Id of the account to request to join |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to join this account ALREADY_MEMBER • The user is already a member of the account |
Notes |
Description | Invite a user to join an account |
---|---|
URL | /user/invite |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account to invite the person too role_id • The role to give the user (optional) email • Email address of the person to invite link • URL to accept the invitation at. The invitation id will be appended to the link link_already • URL to accept the invitation at for an existing user on the system. The invitation id will be appended to the link (optional) groups • A JSON hash with the keys the group uuids to add the user to and the values the role uuid for the group (optional) locations • A JSON hash with the keys the location uuids to add the user to and the values the role uuid for the location (optional) |
Returns |
status • OK uuid • Id of the invitation |
Permission | account_user_invite |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account or role can not be found. The error_subtype holds the uuid of the not found item NOT_PERMITTED • You are not permitted to invite users to this account INVALID_EMAIL • Enter a valid email address ALREADY_EXISTS • They are already in this account INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field NOT_HASH • The field is not a JSON hash. The error_subtype holds the name of the field INVALID_LINK • The link needs to be a https link within the site domain |
Notes |
|
Description | Accept an invitation |
---|---|
URL | /user/invite/accept |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the invitation |
Returns |
status • OK |
Errors |
NOT_FOUND • The invitation was not found ACCEPTED • The invitation was already accepted ALREADY_EXISTS • They are already in this account |
Notes | The user will be added to the account and the invitor will be emailed a notification. |
Description | Get the namespace the user has access to |
---|---|
URL | /user/namespace/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • Only return the namespaces for this account (optional) plus_phr • Flag to include the PHR account as well if account_id was specified (optional) filter.* Filters (optional) |
Returns |
status • OK namespaces • An array of the namespaces. Each namespace holds the following fields. * uuid • Id of the namespace * name • Description of the namespace * type • Type of object the namespace is linked to (account_id|group_id|location_id|user_id) * type_uuid • Id of the object the namespace is linked to * permissions • The users permissions in the namespace * settings • The namespace settings * destinations • An array of the destinations the users can push to. Each object in the array has the same fields as the /destination/get command. * events • A hash of the event flags for the namespace. * share_code • The share code of the namespace. * study_count • The total number of approved, non-phantom studies in the namespace * thin_study_count • The total number of thin studies in the namespace * search_threshold • The total number of studies that should trigger a switch over to a search rather than a list UI |
Errors | |
Notes |
Description | Get the users event flags for a namespace |
---|---|
URL | /user/event |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) namespace_id • Id of the namespace to set the flags on uuid • Return event flags for this user, not current user (optional) |
Returns |
status • OK event_share • Notify the user on a share into the namespace (optional) event_approve • Notify the user on a approval needed into the namespace (optional) event_upload • Notify the user on an upload into the namespace (optional) event_upload_fail • Notify the user on a failed upload into the namespace (optional) event_harvest • Notify the user on a harvest into the namespace (optional) event_new_report • Notify the user when a report is attached in the namespace (optional) event_report_remove • Notify the user when a report is removed in the namespace (optional) event_study_comment • Notify the user when a comment is attached to a study in the namespace (optional) event_status_change • Notify the user when the status of a study is changed (optional) event_message • Notify the user when a message is sent to the namespace (optional) event_node • Notify the user when an account node sends an event (optional) event_link • Notify the user when an anonymous link is hit in the namespace (optional) event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace (optional) event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds (optional) event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails (optional) event_case_assignment • Notify the user when they are assigned a case as a medical or admin user (optional) event_incoming_study_request • Notify the user when they get an incoming study request (optional) |
Errors |
NOT_FOUND • The namespace or user can not be found NOT_MEMBER • The user is not a member of this namespace NOT_PERMITTED • You are not allowed to get user's event flags INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag |
Notes |
|
Description | Set the users event flags for a namespace |
---|---|
URL | /user/event/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) namespace_id • Id of the namespace to set the flags on uuid • Return event flags for this user, not current user (optional) event_share • Notify the user on a share into the namespace (optional) event_approve • Notify the user on a approval needed into the namespace (optional) event_upload • Notify the user on an upload into the namespace (optional) event_upload_fail • Notify the user on a failed upload into the namespace (optional) event_harvest • Notify the user on a harvest into the namespace (optional) event_new_report • Notify the user when a report is attached in the namespace (optional) event_report_remove • Notify the user when a report is removed in the namespace (optional) event_study_comment • Notify the user when a comment is attached to a study in the namespace (optional) event_status_change • Notify the user when the status of a study is changed (optional) event_message • Notify the user when a message is sent to the namespace (optional) event_link • Notify the user when an anonymous link is hit in the namespace (optional) event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace (optional) event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds (optional) event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails (optional) event_case_assignment • Notify the user when they are assigned a case as a medical or admin user (optional) event_incoming_study_request • Notify the user when they get an incoming study request (optional) |
Returns |
status • OK |
Errors |
NOT_FOUND • The namespace or user can not be found NOT_MEMBER • The user is not a member of this namespace NOT_PERMITTED • You are not allowed to set user's event flags INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag |
Notes |
|
Description | Set and get the shared secret for a token authenticator |
---|---|
URL | /user/token |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) generate • Flag to generate the shared secret for a token authenticator and enable TOKEN PIN authentication delete • Flag to delete the shared secret and disable TOKEN PIN authentication |
Returns |
status • OK enabled • Flag if token authentication is enabled secret • The base32 encoded shared secret for the authenticator (only returned if the generate flag is passed) |
Errors |
NOT_PERMITTED • You are not permitted to do this ALREADY_DONE • A shared secret was already generated |
Notes |
Description | Forget all trusted (remembered) devices for the user |
---|---|
URL | /user/device/clear |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) |
Returns |
status • OK |
Errors | |
Notes |
Description | Set and get the users signature |
---|---|
URL | /user/signature |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) signature • Set the users signature to this base64 encoded image |
Returns |
status • OK signature • The users signature as a base64 encoded image |
Errors | |
Notes |
Description | Enable a disabled user |
---|---|
URL | /user/enable |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • User uuid disable • A flag indicating whether to disable the user (optional) |
Returns |
status • OK |
Errors |
NOT_FOUND • The user can not be found NOT_PERMITTED • You are not permitted to enable this user NOT_DISABLED • The user is not disabled |
Notes |
|
Study commands
Description | Add a study from a node |
---|---|
URL | /study/add |
Parameters |
(sid || uuid && serial_no) • Either the sid or the node id and serial number (study_uid || study_uid && storage_namespace && phi_namespace) • The study uid if node authentication or the storage triplet if sid authentication thin • Flag to add this as a thin study patient_name • DICOM tag (0010,0010)(optional) patientid • DICOM tag (0010,0020) (optional) patient_sex • DICOM tag (0010,0040) (optional) patient_birth_date • DICOM tag (0010,0030) (optional) patient_birth_time • DICOM tag (0010,0032) (optional) patient_age • DICOM tag (0010,1010) (optional) patient_weight • DICOM tag (0010,1030) (optional) patient_address • DICOM tag (0010,1040) (optional) patient_size • DICOM tag (0010,1020) (optional) patientid_other • DICOM tag (0010,1000) (optional) patient_name_other • DICOM tag (0010,1001) (optional) patient_phone • DICOM tag (0010,2154) (optional) patient_phone • DICOM tag (0010,2154) (optional) patient_additional_history • DICOM tag (0010,21B0) (optional) study_description • DICOM tag (0008,1030) (optional) accession_number • DICOM tag (0008,0050) (optional) patient_birthname • DICOM tag (0010,1005) (optional) patient_mother_birthname • DICOM tag (0010,1060) (optional) medical_record_locator • DICOM tag (0010,1090) (optional) patient_religious_preference • DICOM tag (0010,21F0) (optional) patient_religious_preference • DICOM tag (0010,21F0) (optional) patient_comments • DICOM tag (0010,4000) (optional) patient_current_location • DICOM tag (0038,0300) (optional) patient_institution_residence • DICOM tag (0038,0400) (optional) patient_ethnic_group • DICOM tag (0010,2160) (optional) patient_ethnic_group • DICOM tag (0010,2160) (optional) patient_occupation • DICOM tag (0010,2180) (optional) study_date • DICOM tag (0008,0020) (optional) study_time • DICOM tag (0008,0030) (optional) modality • DICOM tag (0008,0060) (optional) referring_physician • DICOM tag (0008,0090) (optional) image_count • Images in the study (optional) attachment_count • Attachment count (optional) integration_key • Integration key for the study (optional) destination_ae_title • The destination aetitle (optional) source_ae_title • The source aetitle (optional) node_id • If this is a thin study the gateway UUID to retrieve it from can be specified (optional) message • An upload message (optional) customfield-(CUSTOMFIELD_UUID|DICOM_TAG) • Custom field(s), see notes in /study/add (optional) |
Returns |
status • OK uuid • The study uuid engine_fqdn • The FQDN of the engine to store the study on |
Permission |
study_upload or study_thin |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_CREDENTIALS • The sid or node credentials are invalid ALREADY_EXISTS • The study already exists. The error_subtype holds the uuid of the study and error_data holds the data from the /study/get call INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details NOT_PERMITTED • You are not permitted to do this NAMESPACE_NOT_FOUND • The namespace was not found NOT_FOUND • The error_subtype holds the name of the key for the object that can not be found |
Notes |
|
Description | Update a study |
---|---|
URL | /study/set |
Parameters |
(sid|uuid&serial_no) • Either the sid or the node id and serial number (study_id|study_uid|study_uid && storage_namespace && phi_namespace) The uuid of the study if sid authentication or the study_uid if node authentication or the storage triplet if you want a future set patient_name • DICOM tag (0010,0010) (optional) patientid • DICOM tag (0010,0020) (optional) patient_sex • DICOM tag (0010,0040) (optional) patient_birth_date • DICOM tag (0010,0030) (optional) patient_birth_time • DICOM tag (0010,0032) (optional) patient_age • DICOM tag (0010,1010) (optional) patient_weight • DICOM tag (0010,1030) (optional) patient_address • DICOM tag (0010,1040) (optional) patient_size • DICOM tag (0010,1020) (optional) patientid_other • DICOM tag (0010,1000) (optional) patient_name_other • DICOM tag (0010,1001) (optional) patient_phone • DICOM tag (0010,2154) (optional) patient_phone • DICOM tag (0010,2154) (optional) patient_additional_history • DICOM tag (0010,21B0) (optional) study_description • DICOM tag (0008,1030) (optional) accession_number • DICOM tag (0008,0050) (optional) patient_birthname • DICOM tag (0010,1005) (optional) patient_mother_birthname • DICOM tag (0010,1060) (optional) medical_record_locator • DICOM tag (0010,1090) (optional) patient_religious_preference • DICOM tag (0010,21F0) (optional) patient_religious_preference • DICOM tag (0010,21F0) (optional) patient_comments • DICOM tag (0010,4000) (optional) patient_current_location • DICOM tag (0038,0300) (optional) patient_institution_residence • DICOM tag (0038,0400) (optional) patient_ethnic_group • DICOM tag (0010,2160) (optional) patient_ethnic_group • DICOM tag (0010,2160) (optional) patient_occupation • DICOM tag (0010,2180) (optional) study_date • DICOM tag (0008,0020) (optional) study_time • DICOM tag (0008,0030) (optional) modality • DICOM tag (0008,0060) (optional) referring_physician • DICOM tag (0008,0090) (optional) image_count • Images in the study (optional) attachment_count • Attachment count (optional) integration_key • Integration key for the study (optional) destination_ae_title • The destination aetitle (optional) source_ae_title • The source aetitle (optional) node_id • If this is a thin study the gateway UUID to retrieve it from can be specified (optional) customfield-(CUSTOMFIELD_UUID|DICOM_TAG) • Custom field(s), see notes in /study/add (optional) use_upload_permission • Flag to use the upload permissions for the permissions check (optional) find_order_uuid • UUID of the search record used to modify the study (optional) |
Returns |
status • OK uuid • The study uuid |
Permission |
study_edit or study_thin or study_upload if the study was previously uploaded and the use_upload_permission flag was set |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_CREDENTIALS • The sid or node credentials are invalid NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to edit this study INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details PENDING_MUST_MATCH • The study is pending a must match approval from storage and can not be edited in this state |
Notes |
|
Description | Delete a study |
---|---|
URL | /study/delete |
Parameters |
(sid|node_id&serial_no) • Either the sid or the node id and serial number (uuid || study_uid && storage_namespace && phi_namespace) • The study uuid or the storage triplet |
Returns |
status • OK |
Permission | study_delete |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to delete this study |
Notes |
Description | Get a list of the studies the user can see |
---|---|
URL | /study/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) template • A JSON hash with name, account_id and language of the template to return (optional) extra • Flag to return extra data as detailed in /study/get (optional) customfield_h • Flag to return a customfield hash as detailed in /study/get (optional) permissions_diff • Flag to return only the permissions that differ from the namespace permissions (optional) fields • A JSON list of the study fields to return (optional) limit.hl7 • Limit the length of Hl7 list to return. Zero means no limit (optional) |
Returns |
status • OK page • The pagination status hash studies • An array of the studies the user has. Each object holds the following same fields as the /study/get call template • The template HTML if a template was requested |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_TEMPLATE • The template is invalid the error_subtype holds the detail |
Notes |
|
Description | Get a count of the studies the user can see |
---|---|
URL | /study/count |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) filter.* Filters (optional) |
Returns |
status • OK count • The study count |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
Notes |
|
Description | Get a list of the studies the node can see |
---|---|
URL | /study/cfind |
Parameters |
uuid • The node id serial_no • The serial number of the node entire_account • Flag to search the entire account rather than just the nodes namespace. (optional) is_available • Flag to limit search to studies that are ready for viewing. (optional) filter.* Filters (optional) page.* Pagination (optional) |
Returns |
status • OK page • The pagination status hash studies • An array of the studies the user has. Each object holds the following same fields as the /study/get call |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found RUNNING • This cfind is currently in process |
Notes | The list is sorted by creation order from most recent to oldest |
Description | Get a study |
---|---|
URL | /study/get |
Parameters |
(sid || node_id && serial_no) • Either the sid or the node uuid and serial number (uuid || study_uid && storage_namespace && phi_namespace) • The study uuid or the storage triplet full_hl7 • Flag to return the full hl7 record instead of just the uuid (optional) limit.hl7 • Limit the length of Hl7 list to return. Zero means no limit (optional) permissions_diff • Flag to return only the permissions that differ from the namespace permissions (optional) extra • Flag to return extra data as detailed below (optional) customfield_h • Flag to return a customfield hash as detailed below (optional) fields • A JSON list of the study fields to return (optional) |
Returns |
status • OK uuid • Study uuid star • The study star flag study_uid • Study uid in storage phi_namespace • PHI namespace phi_namespace_name • PHI namespace description storage_namespace • Storage namespace engine_fqdn • The FQDN of the storage engine the study is stored on source • Source of the study (upload|harvest|share|copy) source_ae_title • The source aetitle for the harvesting destination_ae_title • The destination aetitle for the harvesting must_approve • A flag that the study must be approved or rejected before it is generally visible in the namespace share_message • If this study was shared this field will exist and hold any share message phantom • Is this a phantom study, a phantom study is one that is loading into storage thin • Is this a thin study, a thin study is not in storage and needs to be query retrieved to be loaded into storage patient_name • DICOM tag (0010,0010) patientid • DICOM tag (0010,0020) patient_sex • DICOM tag (0010,0040) patient_birth_date • DICOM tag (0010,0030) patient_birth_time • DICOM tag (0010,0032) patient_age • DICOM tag (0010,1010) patient_weight • DICOM tag (0010,1030) patient_address • DICOM tag (0010,1040) patient_size • DICOM tag (0010,1020) patientid_other • DICOM tag (0010,1000) patient_name_other • DICOM tag (0010,1001) patient_phone • DICOM tag (0010,2154) patient_phone • DICOM tag (0010,2154) patient_additional_history • DICOM tag (0010,21B0) study_description • DICOM tag (0008,1030) accession_number • DICOM tag (0008,0050) patient_birthname • DICOM tag (0010,1005) patient_mother_birthname • DICOM tag (0010,1060) medical_record_locator • DICOM tag (0010,1090) patient_religious_preference • DICOM tag (0010,21F0) patient_religious_preference • DICOM tag (0010,21F0) patient_comments • DICOM tag (0010,4000) patient_current_location • DICOM tag (0038,0300) patient_institution_residence • DICOM tag (0038,0400) patient_ethnic_group • DICOM tag (0010,2160) patient_ethnic_group • DICOM tag (0010,2160) patient_occupation • DICOM tag (0010,2180) study_date • DICOM tag (0008,0020) study_time • DICOM tag (0008,0030) modality • DICOM tag (0008,0060) referring_physician • DICOM tag (0008,0090) image_count • Images in the study attachment_count • Attachment count size • Size of the study in bytes compressed_size • Compressed size of the study in bytes integration_key • Integration key for the study permissions • A hash of the study_* type permissions for this study patient_id • If the user has patient_view permissions in the account this field will exist and hold the patient uuid created • Created datetime stamp of the study updated • Updated datetime stamp of the study study_status • The study status study_status_tags • The available study status tags. (This is only returned if they have study_status_edit permissions on the study and the study is not locked by another user) study_status_timer • The study status timer value in seconds. A value of -1 means the timer has completed and this is only returned if the study_status_timer account flag is on. is_dicom_wrapped • Is the study a wrapped DICOM is_locked • Is the study locked by another user is_frozen • Is the study frozen is_being_retrieved • Is this a thin study in the process of being retrieved has_external_viewer • A flag if the study has an external viewer option viewer_link • Link to the study viewer. If the account has SAML SSO the link will be to the SSO entry point, if not it will be a direct link. hl7 • An array of the hl7 objects associated with this study. Each object has the following fields or is the complete record from /hl7/get if the full_hl7 flag is passed * uuid • Id of the object tags • An array of user tags associated with this object (This is only returned if the object has tags) customfields • An array of the custom fields associated with this study. Each object has the following fields (This is only returned if the study has custom fields) customfields_DICOM • An array of the DICOM tag custom fields associated with this study. Each object has the following fields (This is only returned if the study has DICOM tag custom fields) * tag • DICOM tag * value • Value of the custom field radreports • An array of the radreports associated with this study. Each object has the fields in the /radreport/description call routes • An array of the manual routes that the user can run against this study. Each object has the following fields (This is only returned if manual routes are available) * uuid • Route id * name • Route name * capture_email • Does an email need to be captured to run this rule - flag meetings • An array of the meetings the user can join. Each object has the fields in /meeting/get call (This is only returned if meetings are available) comments • An array of the study comments, order from most recent too earliest. This is only returned if the user has the study_comment_view permissions. Each object has the fields in the /study/comment/get call. study_push_status • An array of the study push status. This is only returned if the study_push_status account setting is enabled. Each object has the following fields. * destination_uuid • Destination Id * destination_name • Destination Name * status • The status, either 'I'n process, pe'N'ding, 'S'uccessful, 'P'artial or 'F'ailed * status_reason • Additional detail for the status * image_count • The image count for the push * updated • Date and time the status was last updated * created • Date and time the push was created * group_key • The string key used to group push statuses. Statuses that group: local pushes (by destination address), copy statuses, same UID statuses * is_local • The flag indicating if the corresponding push was local --- The following fields are only returned if the extra flag is specified --- created_at • Date and time the record was created account_name • Name of the account the study is in created_by_name • Name of the user who created the study created_by_email • Email of the user who created the study created_by_mobile_phone • Mobile phone number of the user who created the study hipaa_name • HIPAA compliant version of the patient name first_name • Patient first name last_name • Patient last name study_status • Study status value message_count • Number of messages associated with this study --- The following field is only returned if the customfield_h flag is specified --- customfield_h • A JSON hash of the customfield values keyed by the UUID --- The following field is only returned if the enable_orders_in_worklist account setting is enabled --- order_count • Number of orders linked with this study (having the same accession_number). This field is filterable. |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to access this study |
Notes |
Description | Get the users permissions on the study |
---|---|
URL | /study/permissions |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid |
Returns |
status • OK study_edit • The permission flag setting ↳ study_edit_approved • The permission flag setting ↳ study_edit_unapproved • The permission flag setting study_download • The permission flag setting study_browse • The permission flag setting study_share • The permission flag setting ↳ study_share_email • The permission flag setting ↳ study_share_share_code • The permission flag setting ↳ study_share_account • The permission flag setting ↳ study_share_location • The permission flag setting ↳ study_share_group • The permission flag setting ↳ study_share_user • The permission flag setting ↳ study_share_rsna • The permission flag setting ↳ study_share_npi • The permission flag setting ↳ study_share_request • The permission flag setting study_push • The permission flag setting study_delete • The permission flag setting study_approve • The permission flag setting study_view • The permission flag setting study_upload • The permission flag setting study_report_view • The permission flag setting study_report_view_only_own • The permission flag setting study_report_hl7_view • The permission flag setting study_report_upload • The permission flag setting study_report_delete • The permission flag setting study_sync • The permission flag setting radreport_edit • The permission flag setting radreport_view • The permission flag setting radreport_view_only_own • The permission flag setting meeting_edit • The permission flag setting meeting_view • The permission flag setting link_direct • The permission flag setting link_edit • The permission flag setting link_edit_pin • The permission flag setting link_view • The permission flag setting reports • A JSON array of the report ids they can view. This is not returned if they can view all reports |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to access this study |
Notes |
Description | Check if a study exists in a namespace |
---|---|
URL | /study/exists |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (uuid || study_uid && storage_namespace && phi_namespace || study_uid && account_id) • The study uuid, the storage triplet, or the study uid and account id |
Returns |
status • OK exists • Flag if the study exists |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
Notes |
Description | Push a study to a destination |
---|---|
URL | /study/push |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid destination_id • The destination to push it to batch_no • The batch number if pushing to a CD burner ping • Flag to send the ping job back in this call |
Returns |
status • OK (uuid|ping) • Id of the push job or the ping job if the ping flag was sent |
Permission | study_push |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or destination can not be found NOT_PERMITTED • You are not permitted to push this study PENDING • There is already a pending push job NOT_READY • The study is not ready for pushing |
Notes |
Description | Push a study HL7 message to a destination |
---|---|
URL | /study/push/hl7 |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid destination_id • The destination to push it to hl7_template_id • The HL7 template to use (optional) hl7_id • HL7 message to use in the template (optional) once • Flag that this message should only be sent a maximum of one time (optional) |
Returns |
status • OK uuid • Id of the push job |
Permission | study_push |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study, destination, template or hl7 message can not be found NOT_PERMITTED • You are not permitted to push this study NO_HL7_SUPPORT • The destination doesn't support HL7 |
Notes |
|
Description | Returns a PDF report for the study HL7 message |
---|---|
URL | /study/pdf/hl7 |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid hl7_id • HL7 message to create the PDF report for |
Returns | Streams back the PDF report |
Permission | study_report_hl7_view |
Errors | 404 not found |
Notes |
Description | Fax a PDF report for the study's HL7 message |
---|---|
URL | /study/fax/hl7 |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid hl7_id • HL7 message to create the PDF report for number • The fax number to send the PDF report to |
Returns |
status • OK |
Permission | study_report_hl7_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or HL7 message can not be found INVALID_PHONE • The fax number is invalid PDF_FAILED • The PDF report failed to generate |
Notes |
Description | Request a cmove of a study |
---|---|
URL | /study/cmove |
Parameters |
uuid • The node id serial_no • The serial number of the node study_uid • The study uid aetitle • The aetitle to send to detail • Additional detail to send on the /node/ping (optional) ping • Flag to send the ping job back in this call |
Returns |
status • OK (uuid|ping) • Id of the push job or the ping job if the ping flag was sent |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found STUDY_NOT_FOUND • The study can not be found DESTINATION_NOT_FOUND • The destination can not be found PENDING • There is already a pending push job NOT_READY • The study is not ready for pushing RETRIEVE • A thin study retrieval error. The error_subtype holds further detail |
Notes |
|
Description | Can a node remove a study from local disk cache |
---|---|
URL | /study/node/can/remove |
Parameters |
uuid • The node id serial_no • The serial number of the node study_uid • The study uid |
Returns |
status • OK can_remove • Flag if the node can remove the study from local cache |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found STUDY_NOT_FOUND • The study can not be found |
Notes |
Description | Who can they share a study |
---|---|
URL | /study/share/who |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid type • Type of objects you want (account|location|group|user) |
Returns |
status • OK shares • An array of the objects they can share this study with. Each object in the array will have the following fields * uuid • Id of the object * name • Name of the object |
Permission | study_share |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or share object can not be found. The error_subtype holds a the name of the key that can not be found NOT_PERMITTED • You are not permitted to share this study |
Notes |
Description | Share a study |
---|---|
URL | /study/share |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (uuid || study_uid && storage_namespace && phi_namespace) • The study uuid or the storage triplet if you want a future share (account_id|location_id|group_id|user_id|share_code|email|masshiway|rsna|npi|study_request_id) • uuid of the account, location, group, user, study request or share code, email address(es), RSNA, NPI or masshiway recipient to share this study with message • Message to the recipient (optional) integration_key • Integration key to tag the share with (optional) charge_authorized • Flag that the sender authorized charging for this share (optional) charge_modality • Modality of the study the charge was authorized for (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) to apply to the shared study (optional) |
Returns |
status • OK |
Permission | study_share |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or share object can not be found. The error_subtype holds a the name of the key that can not be found NOT_PERMITTED • You are not permitted to share this study NOT_MATCHED • This study does not match the study request criteria REQUEST_CLOSED • The study request is closed INVALID_PARAMETERS • Only pass a account_id or a location_id or a group_id or a user_id or a share code or an email INVALID_EMAIL • An invalid email was passed for an email share INVALID_NPI • An invalid NPI was passed for a NPI share PHANTOM • This is a phantom study INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field NOT_HASH • The field is not a JSON hash. The error_subtype holds the name of the field SHARE_FAILED • The share failed. The error_subtype holds one of the following conditions.
|
Notes |
|
Description | Stop sharing a study |
---|---|
URL | /study/share/stop |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid (account_id|location_id|group_id|user_id|user_invite_share_id) • uuid of the account, location, group, user or user invitation to stop sharing this study with |
Returns |
status • OK |
Permission | study_share |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or share object can not be found. The error_subtype holds a the name of the key that can not be found NOT_PERMITTED • You are not permitted to stop sharing this study INVALID_PARAMETERS • Only pass a account_id or a location_id or a group_id or a user_id |
Notes |
Description | Get the study shares |
---|---|
URL | /study/share/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid name • Flag to return a hash with both the uuid and name of the object (optional) |
Returns |
status • OK account_id • A list of the account_ids the study is shared with location_id • A list of the location_ids the study is shared with group_id • A list of the group_ids the study is shared with user_id • A list of the user_ids the study is shared with user_invite_share_id • A list of the user invitations the study is shared with |
Permission | study_share |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to view this list |
Notes |
Description | Approve a study |
---|---|
URL | /study/approve |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid delay • Number of seconds to delay showing the study as approved and running routing and events on it (optional) must_match • A JSON hash of study field names and values that must match before showing the study as approved and running routing and events on it (optional) |
Returns |
status • OK |
Permission | study_approve |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to approve this study DELAY_OR_MATCH • You can either delay or match, not both INVALID_DELAY • A delay must be between 0 and 600 seconds INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field INVALID_FIELD • An invalid must match field was passed. The error_subtype holds the name of the field |
Notes |
Description | Reject a study |
---|---|
URL | /study/reject |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid message • Message to send to the person who shared the study (optional) |
Returns |
status • OK |
Permission | study_approve |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to approve this study |
Notes |
|
Description | Attach an audit action to a study |
---|---|
URL | /study/audit |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The id of the study (optional if study_uid and storage_namespace are passed) study_uid • The v3 storage uid of the study (optional if uuid is passed) storage_namespace • The storage namespace of the study (optional if uuid is passed) phi_namespace • The phi namespace of the study (optional) action • The audit action (STUDY_VIEW|STUDY_EDIT|STUDY_ANONYMIZE|REPORT_UPLOAD|REPORT_REMOVE|REPORT_VIEW|IMAGE_ADDED|IMAGE_UPDATED|STUDY_DOWNLOAD|ACCEPTED_NOT_DIAGNOSTIC|CANCELED_NOT_DIAGNOSTIC|AI_ACTION|VIEWER_ACTION) detail • Additional information |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found INVALID_ACTION • An invalid action was passed |
Notes |
Description | Set the star flag on a study for the user |
---|---|
URL | /study/star |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The id of the study star • Star flag set on or off (1|0) |
Returns |
status • OK |
Permission | study_star |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to star this study NOT_FOUND • The study can not be found INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag |
Notes |
Description | Build a study detailed report |
---|---|
URL | /study/report/detail |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • Limit to studies in the passed account filter.* Filters (optional) sort_by • Sorting (optional) limit • Maximum size of the report. The default is 30,000 rows. If the report will be bigger than this an error will be returned (optional) |
Returns |
status • OK report_id • The report id |
Permission | study_report_detail |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields REPORT_ERROR • Unable to start the report |
Notes | This call will kick off the building of the report. Poll for the report status with /report/status command and download it with the /report/zip command. |
Description | Build a series detail report for recently acquired studies |
---|---|
URL | /study/report/series |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) namespace_id • Namespace to run the report on hours • Report on studies acquired within the last number of hours limit • Maximum size of the report. The default is 30,000 studies. If the report will be bigger than this an error will be returned (optional) email • Send the report to this email address(es) when it is done |
Returns |
status • OK report_id • The report id |
Permission | study_report_detail |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields REPORT_ERROR • Unable to start the report |
Notes |
|
Description | Get the viewer settings for the study |
---|---|
URL | /study/viewer/settings |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (study_id|study_uid && storage_namespace && phi_namespace) • Either the study uuid or the storage triplet |
Returns |
status • OK enable_v2_viewer • Value for the account flag enable_v3_viewer • Value for the account flag enable_viewer_print • Value for the account flag viewer_show_reports • Value for the account flag enable_viewer_export • Value for the account flag viewer_diagnostic_quality • Value for the account flag viewer_diagnostic_quality_always • Value for the account flag viewer_preload_diagnostic_images • Value for the account flag viewer_enable_mpr • Value for the account flag viewer_single_instance_series • Value for the account flag viewer_multiframe_split_method • Value for the account flag viewer_study_page_link_visible • Value for the account flag viewer_study_page_link_url • Value for the account flag viewer_setting_not_diagnostic • Value for the account flag auto_transcode • Value for the account flag auto_transcode_modalities • Value for the account flag viewer_default_mouse_tool • Value for the account flag viewer_link_series • Value for the account flag enable_viewer_toggle_annotations • Value for the account flag enable_dicom_tag_customfields • Value for the account flag radreport_branding_from_phi_namespace • Value for the account flag viewer_anon_annotations_clear • Value for the account flag accession_number_for_study_uid • Value for the account flag no_edit_dicom_tags • If enable_dicom_tag_customfields is on this is a JSON list of the DICOM tags that can not be edited accelerators • A JSON list of accelerator FQDN to check and redirect to if available viewer_config • The viewer configuration JSON |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found |
Notes |
Description | Get the viewer3 settings for the study |
---|---|
URL | /study/viewer3/settings |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (study_id|study_uid && storage_namespace && phi_namespace) • Either the study uuid or the storage triplet settings • A JSON list of user settings set via /setting/set to return (optional) |
Returns |
status • OK account_config • The account viewer3_config setting role_config • The role viewer3_config settings user_config • The user viewer3_confing settings accelerators • A JSON list of accelerator FQDN to check and redirect to if available (optional) settings • JSON hash of the requested settings (optional) The rest of the fields are the same as /user/get |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found |
Notes |
Description | Set the status of a study |
---|---|
URL | /study/status/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) study_id • Study uuid old • The old study status value new • The new study status value |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to set the status for this study STALE • The study status you have is stale INVALID_TAG • The study status new value is not a valid value LOCKED • Another user has locked this study SINGLETON • The stage is a singleton stage and the user already has a locked study |
Notes |
Description | Returns a list of the studies the user has locked in the order they were locked |
---|---|
URL | /study/status/locks |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) page.* Pagination (optional) |
Returns |
status • OK page • The pagination status hash studies • An array of the locked studies. Each object holds the following same fields as the /study/get call |
Errors | |
Notes |
Description | Returns the history of the study status changes for the study |
---|---|
URL | /study/status/history |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) study_id • Study uuid |
Returns |
status • OK history • An array of the status changes for the study. Each record has the following fields * date • Date and time of the change * old • The old status value * new • The new status value * seconds • The number of seconds the study was in the old status |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to view the status for this study |
Notes |
Description | Move the study to another PHI namespace |
---|---|
URL | /study/move |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id namespace_id • The namespace id |
Returns |
status • OK |
Permission | study_move |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or namespace was not found. NOT_PERMITTED • You are not permitted to move the study to this namespace ALREADY_EXISTS • The study already exists in the destination namespace |
Notes | The user must have share permissions on the namespace they are trying to move the study too. |
Description | Duplicate a study to another namespace |
---|---|
URL | /study/duplicate |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id (namespace_id|study_request_id) • The namespace or study request id to duplicate it to include_attachments • Also duplicate attachments overwrite • Flag if you want to overwrite an existing study in the destination namespace |
Returns |
status • OK |
Permission | study_duplicate for the study and study_upload for the destination namespace. study_duplicate_request is required additionally when duplicating by request |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or namespace was not found. NOT_PERMITTED • You are not permitted to duplicate the study to this namespace ALREADY_EXISTS • The study already exists in the destination namespace FAILED • The storage call failed to run NOT_MATCHED • This study does not match the study request criteria REQUEST_CLOSED • The study request is closed NO_DESTINATION • The study can't be duplicated to a deleted object's namespace |
Notes | This creates a full copy of the study as if it was uploaded into the namespace |
Description | Split a study into multiple studies, one per series |
---|---|
URL | /study/split |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id namespace_id • The namespace id to split it into no_split • Do not split on the series just create a new study with a study UID |
Returns |
status • OK |
Permission | study_split for the study and study_upload for the destination namespace |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or namespace was not found. NOT_AVAILABLE • The study is not available. NOT_PERMITTED • You are not permitted to split the study to this namespace RECENT_NAMESPACE_SPLIT • The study was the result of a split in this namespace within the last 24 hours RUNNING • The split job is currently running |
Notes |
Description | Freeze or thaw a study |
---|---|
URL | /study/freeze |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id thaw • Flag to thaw a frozen study |
Returns |
status • OK |
Permission | study_freeze |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study NOT_AVAILABLE • The study is not available. NOT_PERMITTED • You are not permitted to freeze or thaw the study ALREADY • The study is already frozen or thawed |
Notes |
|
Description | Run a manual routing rule on a study |
---|---|
URL | /study/manual/route |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id route_id • The routing rule id email • The email to share with if the rule has a share_email action with the USER_ENTRY token (optional) message • The share message for the email share (optional) |
Returns |
status • OK |
Permission | study_manual_route |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or routing rule was not found. NOT_PERMITTED • You are not permitted to manually route the study ROUTE_NOT_MATCHED • The study does not match the route criteria INVALID_EMAIL • An invalid email address was passed |
Notes |
Description | Find matching HL7 orders for the study |
---|---|
URL | /study/find/order |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id (accession_number|patientid|patient_name) • The full or partial accession number, MRN or patient name to search by. If none are passed the studies accession number will be used (optional) page.* Pagination (optional) |
Returns |
status • OK page • The pagination status hash orders • An array of the orders. Each order has the following fields * find_order_uuid • UUID of the search record * accession_number • Accession number * patientid • Patient MRN * patient_name • Patient name * patient_sex • Patient sex * patient_phone • Patient phone * patient_birth_date • Patient birth date * order_datetime • Date and time of the order * study_description • Study description * ordering_provider • Ordering provider |
Permission | study_approve |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to find orders for this study |
Notes |
|
Description | Archive a study |
---|---|
URL | /study/archive |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id |
Returns |
status • OK |
Permission | study_delete and the study needs to be either the last copy or primary copy |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to do this ALREADY_THIN • This is already a thin study NO_FRESH_ARCHIVE • A fresh archive copy of the study does not exist |
Notes |
Description | Request that a thin study be retrieved and loaded into storage |
---|---|
URL | /study/retrieve |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to do this NOT_THIN • This is not a thin study MISSING_INFO • The study needs a study_uid and an accession number NO_QUERY_DESTINATION • No query retrieve destination for a node that creates phantoms is available |
Notes |
Description | Add a comment to the study |
---|---|
URL | /study/comment/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) study_id • The study id body • The comment body |
Returns |
status • OK uuid • The comment uuid |
Permission | study_comment_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to do this |
Notes |
Description | Delete a study comment |
---|---|
URL | /study/comment/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The comment id |
Returns |
status • OK |
Permission | study_comment_edit and you must be the creator of the comment |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The comment was not found. NOT_PERMITTED • You are not permitted to do this |
Notes |
Description | Get a study comment |
---|---|
URL | /study/comment/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The comment id |
Returns |
status • OK uuid • Comment id study_id • Id of the study the comment is associated with user_id • Id of the user who created the comment user_name • Name of the user who created the comment body • The comment body created • Created datetime stamp of the comment is_mine • Flag if I created this comment |
Permission | study_comment_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The comment was not found. NOT_PERMITTED • You are not permitted to do this |
Notes |
Description | Run a validation rule against the study |
---|---|
URL | /study/validate |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id validate_id • The validation id series • Only validate the specified series (optional) |
Returns |
status • OK score • The validation score. The score is the number of conditions that failed conditions • An array of the conditions that failed |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or validation was not found. NOT_PERMITTED • You are not permitted to do this UNABLE_TO_VALIDATE • The study is not available or did not return the data needed to validate |
Notes |
|
Description | Attach a customfield report to the study |
---|---|
URL | /study/attach/customfields |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id report_name • The report name (optional defaults to customfields.txt) |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to do this NOT_AVAILABLE • The study is available |
Notes | A text report with the names and values of the customfields for the study will be attached to the study |
Description | Return the link to the external viewer for the study |
---|---|
URL | /study/external/viewer |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id redirect • A flag to return an HTTP redirect to the viewer URL rather than the JSON structure |
Returns |
status • OK url • The url for the external viewer |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to do this NOT_AVAILABLE • The study is not available UNABLE_TO_GENERATE • The link could not be successfully generated |
Notes |
Description | Ask an AI question for the study |
---|---|
URL | /study/question |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id question • The question to ask or a JSON array of questions to ask detail • Optional detail to pass through to the AI stack |
Returns |
status • OK |
Permission | study_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or question was not found. NOT_PERMITTED • You are not permitted to do this NOT_ENABLED • The account does not have the ai_QUESTION customfield NODE_NOT_SETUP • A node needs to be attached to the study namespace for this question IN_PROCESS • The question is currently in process |
Notes |
|
Description | Load the DICOM data for a study |
---|---|
URL | /study/dicomdata/load |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id |
Returns |
status • OK |
Permission | study_view and dicomdata_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or question was not found. NOT_PERMITTED • You are not permitted to do this NOT_AVAILABLE • The study is not available in storage RUNNING • A load job is already running |
Notes |
Description | Record a timing event for the study |
---|---|
URL | /study/timing/event |
Parameters |
(sid || node_id && serial_no) • Either the sid or the node uuid and serial number study_uid • The study uid storage_namespace • The storage namespace event • The event size • The number of bytes associated with the event (optional) |
Returns |
status • OK |
Permission | study_upload for sid authentication |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to do this |
Notes |
Description | Get the timing log for the study |
---|---|
URL | /study/timing/log |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK events • An array of the events. Each object has the following fields ** created • The time stamp for the event ** event • The description of the event ** size • The number of bytes associated with the event ** node_id • UUID of the associated node ** node_name • Name of the associated node |
Permission | study_timing_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to do this |
Notes |
Description | Sync the study against the storage data and re-run routing rules |
---|---|
URL | /study/sync |
Parameters |
(sid || node_id && serial_no) • Either the sid or the node id and serial number (study_id || study_uid && storage_namespace && phi_namespace) • The study id or the study_uid/storage_namespace/phi_namespace triplet image_count • Update the study image count and then sync (optional) |
Returns |
status • OK |
Permission |
sysadmin or study_sync permissions or if image_count is passed then study_upload or phr namespace is required |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to sync this study BLOCKED • This is a repeat sync which is not allowed |
Notes |
|
Description | Take studies from take_study_source_namespace namespace. Studies will be shared. |
---|---|
URL | /study/take |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) namespace_id • The namespace id to take a study into |
Returns |
status • OK |
Permission | study_take |
Errors |
NOTHING_TO_TAKE • There is no unshared studies in the source namespace MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The namespace was not found. NOT_PERMITTED • You are not permitted to take a study in this account NOT_ENABLED • the feature is not enabled check the enable_take_study_feature and take_study_source_namespace account settings |
Notes |
|
Description | Reuest studies from one of study_request_accounts accounts. Studies will be shared or duplicated. |
---|---|
URL | /study/request/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) namespace_id • The namespace id requested studies to put (share or duplicate) into comments • Free form request comments account_id • The account id to send the study request to patientid • The MRN a study should match (optional) patient_first_name • The patient first name a study should match patient_last_name • The patient last name a study should match patient_sex • The patient sex a study should match patient_birth_date • The patient date of birth a study should match modality • The modality a study should match (optional) study_date_start • The DICOM date that a study date should be greater or equal to (optional) study_date_end • The DICOM date that a study date should be less or equal to (optional) study_description • The string a study description should partially match (optional) |
Returns |
status • OK |
Permission | study_request_edit |
Errors |
ALREADY • An active (pending or in progress) study request with the same study criteria and the same namespace/account combination already exists NOT_FOUND • The namespace or account was not found. NOT_PERMITTED • You are not permitted to request a study into this namespace NOT_ENABLED • the feature is not enabled. Check the study_request_accounts account settings |
Notes |
|
Description | Get the study_request |
---|---|
URL | /study/request/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study request uuid |
Returns |
status • OK uuid • The study request uuid comments • Free form request comments study_request_status • Status of the study request. 'N' - pending, 'I' - in progress, 'R' - rejected, 'C' - closed patientid • The MRN a study should match patient_first_name • The patient first name a study should match patient_last_name • The patient last name a study should match patient_sex • The patient sex a study should match patient_birth_date • The patient date of birth a study should match modality • The modality a study should match study_date_start • The DICOM date that a study date should be greater or equal to study_date_end • The DICOM date that a study date should be less or equal to study_description • The string a study description should partially match --- The following fields are only returned if the user has study_request_view permission in the requesting account --- requested_account_id • The account id that the study request is sent to namespace_id • Id of the namespace a study will be received into --- The following fields are only returned if the user has study_request_view_inbound permission in the requested account --- requesting_account_id • Id of the account that the study request was received from requesting_account_name • Name of the account that the study request was received from |
Errors |
NOT_FOUND • The study request was not found NOT_PERMITTED • You are not permitted to access this study request |
Notes |
Description | Get matching studies for the request |
---|---|
URL | /study/request/match |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) study_request_id • The study request uuid |
Returns |
status • OK studies • An array of the studies that are mathing request's criteria and the user has study_share_request or study_duplicate_request access permission. Each object holds the same fields as the /study/get call |
Errors |
NOT_FOUND • The study request was not found REQUEST_CLOSED • The request is not active (pending or in progress) |
Notes |
Tag commands
Description | List the tags |
---|---|
URL | /tag/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) object • Object class (Study|User_account|Group|Location|Account|Patient|Case|Order|Message) filter.* • Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK tags • An array of the tags |
Errors | |
Notes |
|
Description | Add a tag to an object |
---|---|
URL | /tag/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) tag • Value of the tag object • Object class to apply it to (Study|User_account|Group|Location|Account|Patient|Case|Order|Message) object_id • UUID of the object |
Returns |
status • OK |
Permission | study_tag |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_OBJECT • The object type is invalid NOT_FOUND • The object was not found NOT_PERMITTED • You are not permitted to tag this object |
Notes |
Description | Delete a tag from an object |
---|---|
URL | /tag/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) tag • Value of the tag object • Object class to apply it to (Study|User_account|Group|Location|Account|Patient|Case|Order) object_id • UUID of the object |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_OBJECT • The object type is invalid NOT_FOUND • The object was not found |
Notes |
Annotation commands
Description | List the annotations |
---|---|
URL | /annotation/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (study_id|study_uid && storage_namespace && phi_namespace) The uuid of the study or the storage triplet |
Returns |
status • OK annotations • An array of the annotations. Each object holds the same fields as the /annotation/get call |
Permission | annotation_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to view the study of the annotations |
Notes | The list command will return all annotation done on every version of the study. This will allow annotations to be viewed across shares. |
Description | Add an annotation |
---|---|
URL | /annotation/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (study_id|study_uid && storage_namespace && phi_namespace) The uuid of the study or the storage triplet series_uid • The series uid instance_uid • The instance uid frame_number • The frame number (json|stamp) • The JSON annotation data structure or the stamp flag |
Returns |
status • OK uuid • The uuid |
Permission | annotation_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to add annotations to the study INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field |
Notes |
Description | Edit an annotation |
---|---|
URL | /annotation/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the annotation json • The JSON annotation data structure |
Returns |
status • OK uuid • The uuid |
Permission | annotation_edit and annotation ownership |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to add annotations to the study INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field |
Notes |
Description | Get the annotation |
---|---|
URL | /annotation/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the annotation |
Returns |
status • OK uuid • Id of the annotation user_id • User who created the annotation user_name • The user name series_uid • The series uid instance_uid • The instance uid frame_number • The frame number json • The JSON annotation data structure stamp • The stamp flag |
Permission | annotation_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The annotation was not found. NOT_PERMITTED • You are not permitted to view the annotation |
Notes |
Description | Delete the annotation |
---|---|
URL | /annotation/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the annotation |
Returns |
status • OK |
Permission | annotation_edit and annotation ownership |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The annotation was not found. NOT_PERMITTED • You are not permitted to delete the annotation |
Notes |
Key image commands
Description | List the key images |
---|---|
URL | /keyimage/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (study_id|study_uid && storage_namespace && phi_namespace) The uuid of the study or the storage triplet |
Returns |
status • OK images • An array of the keyimages. Each object holds the same fields as the /keyimage/get call |
Permission | keyimage_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to view the study or key images for the study |
Notes | The list command will return all key images done on every version of the study. This will allow key images to be viewed across shares. |
Description | Add a key image |
---|---|
URL | /keyimage/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (study_id|study_uid && storage_namespace && phi_namespace) The uuid of the study or the storage triplet series_uid • The series uid instance_uid • The instance uid frame_number • The frame number version • The frame version |
Returns |
status • OK uuid • The uuid |
Permission | keyimage_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to mark key images for the study |
Notes |
Description | Get the key image |
---|---|
URL | /keyimage/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the keyimage |
Returns |
status • OK uuid • Id of the keyimage user_id • User who created the keyimage user_name • The user name series_uid • The series uid instance_uid • The instance uid frame_number • The frame number version • The frame version |
Permission | keyimage_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The key image was not found. NOT_PERMITTED • You are not permitted to view the key image |
Notes |
Description | Delete the key image |
---|---|
URL | /keyimage/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the key image |
Returns |
status • OK |
Permission | keyimage_edit and key image ownership |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The key image was not found. NOT_PERMITTED • You are not permitted to delete the key image |
Notes |
Study validation commands
Description | List the validation rules |
---|---|
URL | /validate/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash validates • An array of the validates. Each object holds the same fields as the /validate/get call |
Permission | validate_view or route_view or route_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to view the validation rule |
Notes |
Description | Add a validation rule |
---|---|
URL | /validate/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id name • The validation rule name conditions • The validation conditions |
Returns |
status • OK uuid • The uuid |
Permission | validate_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to add validation rules NOT_FOUND • The object was not found. The error_subtype holds the type of the object INVALID_CONDITION • A condition is invalid. The error_subtype holds more detail |
Notes |
|
Description | Modify a validation rule |
---|---|
URL | /validate/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The validation id name • The validation rule name conditions • The validation conditions |
Returns |
status • OK |
Permission | validate_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The validation rule was not found NOT_PERMITTED • You are not permitted to add validation rules INVALID_CONDITION • A condition is invalid. The error_subtype holds more detail |
Notes |
Description | Get a validation rule |
---|---|
URL | /validate/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the validate |
Returns |
status • OK name • Name of the rule conditions • The validation conditions |
Permission | validate_view or route_view or route_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The validate was not found. NOT_PERMITTED • You are not permitted to view the validation rule |
Notes |
Description | Delete the validation rule |
---|---|
URL | /validate/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the validation rule |
Returns |
status • OK |
Permission | validate_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The validation rule was not found. NOT_PERMITTED • You are not permitted to delete the validation rule IN_USE • The validation rule is used in a routing rule |
Notes |
Study DICOM data commands
Description | List the DICOM data for studies |
---|---|
URL | /dicomdata/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (study_id|namespace_id) • uuid of the study or namespace to search filter.* Filters (optional) page.* Pagination (optional) dicom_tags • A JSON list of the DICOM tags to return (optional) |
Returns |
status • OK page • The pagination status hash dicomdatas • An array of the dicom data objects. Each object holds the same fields as the /dicomdata/get call |
Permission | dicomdata_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to view the DICOM data |
Notes |
|
Description | Get the DICOM data |
---|---|
URL | /dicomdata/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the DICOM data dicom_tags A JSON list of the DICOM tags to return (optional) customfields • An array of the custom fields associated with this dicomdata. Each object has the following fields (This is only returned if the dicomdata has custom fields) |
Returns |
status • OK uuid • Id of the DICOM data study_id • The study id study_uid • The study uid series_uid • The series uid instance_uid • The instance uid dicom_tags • The DICOM tags and values |
Permission | dicomdata_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The DICOM data was not found. NOT_PERMITTED • You are not permitted to view the DICOM data |
Notes |
Rad report commands
Description | Add a radreport |
---|---|
URL | /radreport/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) study_id • Id of the study to add the radreport to type • The type of the radreport fields • A JSON hash of the fields in the report (optional) |
Returns |
status • OK uuid • The uuid |
Permission | radreport_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to add a radreport to the study INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field |
Notes |
Description | Modify a radreport |
---|---|
URL | /radreport/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the radreport fields • A JSON hash of the fields in the report (optional) attachment • A JSON hash of the storage attachment information (optional) |
Returns |
status • OK |
Permission | radreport_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to add a radreport to the study INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field |
Notes |
Description | Get the radreport |
---|---|
URL | /radreport/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the radreport |
Returns |
status • OK uuid • Id of the radreport type • Type of radreport fields • Fields in the radreport attachment • The storage attachment information user_id • User who created the radreport study_id • Associated study created • Date and time the radreport was created updated • Date and time the radreport was updated |
Permission | radreport_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport was not found. NOT_PERMITTED • You are not permitted to view the radreport |
Notes |
Description | Attach an audit action to a radreport |
---|---|
URL | /radreport/audit |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The id of the radreport action • The audit action (SIGNED|MEDICAL_EDIT|ADMIN_EDIT|REPORT_GENERATED) detail • Additional information |
Returns |
status • OK |
Permission | radreport_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport can not be found INVALID_ACTION • An invalid action was passed |
Notes |
Description | Delete the radreport |
---|---|
URL | /radreport/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the radreport |
Returns |
status • OK |
Permission | radreport_edit plus you must have created the radreport |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport was not found. NOT_PERMITTED • You are not permitted to delete the radreport |
Notes |
Description | Get the description of the radreport |
---|---|
URL | /radreport/description |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the radreport |
Returns |
status • OK uuid • Id of the radreport description • One line description of the radreport type • Type of radreport can_edit • Can the user edit the radreport |
Permission | radreport_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport was not found. NOT_PERMITTED • You are not permitted to view the radreport |
Notes |
Description | List the radreports for a user |
---|---|
URL | /radreport/user/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) user_id • The user id filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash radreports • An array of the radreports. Each object holds the same fields as the /radreport/get call |
Permission | This will only return radreports the calling user has radreport_view permissions for |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The user was not found. |
Notes |
Description | Get a list of the user radreport macros |
---|---|
URL | /radreportmacro/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account modality • Limit to this modality (optional) type • Limit to this type (optional) filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK macros • An array of the macros. Each object holds the same fields as the /radreportmacro/get call page • The pagination status hash |
Permission | radreport_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to perform this operation |
Notes |
Description | Add a radreport macro |
---|---|
URL | /radreportmacro/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account modality • Modality type • Type of radreport name • Name of the macro body • JSON body of the macro hotkey • Hotkey of the macro (optional) |
Returns |
status • OK uuid • Id of the macro |
Permission | radreport_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to perform this operation |
Notes |
Description | Edit a radreport macro |
---|---|
URL | /radreportmacro/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the macro modality • Modality (optional) type • Type of radreport (optional) name • Name of the macro (optional) body • JSON body of the macro (optional) hotkey • Hotkey of the macro (optional) |
Returns |
status • OK uuid • Id of the macro |
Permission | radreport_edit plus ownership of the macro |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to perform this operation |
Notes |
Description | Get a radreport macro |
---|---|
URL | /radreportmacro/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the macro |
Returns |
status • OK uuid • Id of the macro modality • Modality type • Type of radreport name • Name of the macro body • JSON body of the macro hotkey • Hotkey of the macro |
Permission | radreport_view plus ownership of the macro |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to perform this operation |
Notes |
Description | Delete a radreport macro |
---|---|
URL | /radreportmacro/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the macro |
Returns |
status • OK |
Permission | radreport_edit plus ownership of the macro |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to perform this operation |
Notes |
Description | Returns the PDF report |
---|---|
URL | /radreport/pdf |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The radreport uuid |
Returns | Streams back the PDF report |
Permission | radreport_view |
Errors | 404 not found |
Notes |
Description | Fax the radreport |
---|---|
URL | /radreport/fax |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The radreport uuid number • The fax number to send the PDF report to |
Returns |
status • OK |
Permission | radreport_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport can not be found NOT_PERMITTED • You are not permitted to do this INVALID_PHONE • The fax number is invalid PDF_FAILED • The PDF report failed to generate NO_ATTACHMENT • The radreport does not have an attached report |
Notes |
Description | Email a radreport |
---|---|
URL | /radreport/email |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The radreport uuid email • The email address(es) to send the radreport to |
Returns |
status • OK |
Permission | radreport_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport can not be found NOT_PERMITTED • You are not permitted to do this INVALID_EMAIL • An invalid email address was passed NO_ATTACHMENT • The radreport does not have an attached report PDF_FAILED • The PDF report failed to generate |
Notes |
|
Description | Get a list of the account radreport templates |
---|---|
URL | /radreport/template/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account type • Limit to this type (optional) active • Limit to active templates (optional) filter.* • Filters (optional) page.* • Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK templates • An array of the templates. Each object holds the same fields as the /radreport/template/get call page • The pagination status hash |
Permission | radreport_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to perform this operation |
Notes |
Description | Add a radreport template |
---|---|
URL | /radreport/template/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account type • Type of radreport name • Name of the template body • Body of the template preview • Preview of the template (optional) options • JSON options of the template (optional) |
Returns |
status • OK uuid • Id of the template |
Permission | sysadmin or support |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_SYSADMIN_OR_SUPPORT • The user is not a sysadmin or support user |
Notes |
Description | Edit a radreport template |
---|---|
URL | /radreport/template/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the template type • Type of radreport (optional) name • Name of the template (optional) body • Body of the template (optional) preview • Preview of the template (optional) options • JSON options of the template (optional) |
Returns |
status • OK uuid • Id of the template |
Permission | sysadmin or support |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_SYSADMIN_OR_SUPPORT • You are not permitted to perform this operation |
Notes |
Description | Get a radreport template |
---|---|
URL | /radreport/template/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the template |
Returns |
status • OK uuid • Id of the template type • Type of radreport name • Name of the template body • Body of the template preview • Preview of the template options • JSON options of the template active • Flag if the template is active |
Permission | radreport_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport template can not be found NOT_PERMITTED • You are not permitted to perform this operation |
Notes |
Description | Get a radreport template by type |
---|---|
URL | /radreport/template/get/type |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account type • Type of the template |
Returns |
status • OK uuid • Id of the template type • Type of radreport name • Name of the template body • Body of the template preview • Preview of the template options • JSON options of the template active • Flag if the template is active |
Permission | radreport_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport template can not be found NOT_PERMITTED • You are not permitted to perform this operation |
Notes |
Description | Delete a radreport template |
---|---|
URL | /radreport/template/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the template |
Returns |
status • OK |
Permission | sysadmin or support |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_SYSADMIN_OR_SUPPORT • The user is not a sysadmin or support user |
Notes |
Description | Activate a radreport template |
---|---|
URL | /radreport/template/activate |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the template |
Returns |
status • OK uuid • Id of the template |
Permission | sysadmin or support |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport template can not be found NOT_SYSADMIN_OR_SUPPORT • The user is not a sysadmin or support user |
Notes |
|
Custom code commands
Description | Add the code |
---|---|
URL | /customcode/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) name • The name of the code type • Type of code (AI_CUSTOM_VALIDATION_CODE) language • Language of code (PYTHON) code • The code settings • JSON hash of settings (optional) zip • Base64 encoded ZIP file (optional) |
Returns |
status • OK uuid • The code uuid |
Permission | customcode_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to add code INVALID_TYPE • Invalid type INVALID_LANGUAGE • Invalid language NOT_HASH • The field is not a hash |
Notes |
Description | Get the code |
---|---|
URL | /customcode/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The code uuid |
Returns |
status • OK uuid • The code uuid name • code name account_id • account uuid account_name • account name type • code type language • code language code • The code settings • JSON hash of settings is_deployed • Flag if the code is deployed deployments • An array of the customcode deployments, ordered from most recent to earliest. Each object has the fields in the /customcode/deploy/get call. has_zip • Flag if the code has an associated zip file |
Permission | customcode_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The code can not be found NOT_PERMITTED • You are not permitted to view this code |
Notes |
Description | Modify the code |
---|---|
URL | /customcode/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The code uuid name • The name of the code (optional) code • The code (optional) settings • JSON hash of settings (optional) zip • Base64 encoded ZIP file (optional) |
Returns |
status • OK uuid • The code uuid |
Permission | customcode_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to edit the code NOT_HASH • The field is not a hash IS_DEPLOYED • The code is deployed and can not be edited ONE_ZIP_ONLY • Only one code with an attached zip can be deployed to the namespace |
Notes |
Description | Returns the customcode zip file |
---|---|
URL | /customcode/zip |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The code uuid |
Returns | Streams back the zip file |
Errors | 404 not found |
Notes |
Description | Delete the code |
---|---|
URL | /customcode/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The code uuid |
Returns |
status • OK |
Permission | customcode_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to delete the code IS_DEPLOYED • The code is deployed and can not be deleted |
Notes |
Description | Get a list of the code for the account |
---|---|
URL | /customcode/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash customcodes • An array of the customcode. Each object holds the same fields as the /customcode/get call |
Permission | customcode_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view code in this account |
Notes |
|
Description | Deploy customcode for a namespace |
---|---|
URL | /customcode/deploy |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the customcode namespace_id • uuid of the namespace |
Returns |
status • OK uuid • Deployment uuid |
Permission | customcode_deploy |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The namespace or customcode can not be found NOT_PERMITTED • You are not permitted to deploy code in this namespace ALREADY • The code is already deployed for this namespace |
Notes |
Description | Un-deploy customcode |
---|---|
URL | /customcode/undeploy |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) deployment_id • Deployment uuid |
Returns |
status • OK |
Permission | customcode_deploy |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The deployment can not be found NOT_PERMITTED • You are not permitted to undeploy code in this namespace |
Notes |
Description | Get a customcode deployment |
---|---|
URL | /customcode/deploy/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of customcode deployment |
Returns |
status • OK uuid • uuid of the deployment customcode_id • uuid of the customcode customcode_name • name of the customcode namespace_id • uuid of the namespace namespace_name • name of the namespace |
Permission | customcode_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The customcode deployment can not be found NOT_PERMITTED • You are not permitted to do this |
Notes |
Description | List customcode deployments |
---|---|
URL | /customcode/deploy/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (namespace_id|customcode_id) • uuid of either the namespace or customcode to show the deployments for filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash deployments • An array of the objects. Each object in the array will have the fields available in /customcode/deploy/get |
Permission | customcode_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The namespace or customcode can not be found NOT_PERMITTED • You are not permitted to do this |
Notes |
Case commands
Cases are automatically created by the second opinion workflow for a share codeDescription | Get a case |
---|---|
URL | /case/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The case uuid |
Returns |
status • OK uuid • The case uuid name • case name created • Date and time the case was created paid • Flag if a payment being made against the case share_code • Share code the case is associated with user_name • Name of the user the case is for user_email • Email of the user the case is for studies • An array of the studies associated with this case. Each study has the fields from /study/get tags • An array of user tags associated with this object (This is only returned if the object has tags) customfields • An array of the custom fields associated with this case. Each object has the following fields (This is only returned if the case has custom fields) case_status • Status of the case case_status_date • Date and time the case was set to the current status case_status_tags • The available case status tags submitted • Flag if the case was submitted submitted_date • Date and time the case was submitted returned_date • Date and time the case was returned returned_reason • Reason the case was returned completed • Flag if the case is completed completed_date • Date and time the case was completed closed • Flag if the case is closed closed_date • Date and time the case was closed The rest of the fields are not returned to the case owner assigned_admin_id • Id of the admin user assigned to the case assigned_admin_name • Name of the admin user assigned to the case assigned_admin_date • Date and time the case was assigned to the admin user assigned_medical_id • Id of the medical user assigned to the case assigned_medical_name • Name of the medical user assigned to the case assigned_medical_date • Date and time the case was assigned to a medical user locked_user_id • Id of the user who has locked the case locked_user_name • Name of the user who has locked the case |
Permission | case_view or the case owner, or the assigned medical user if case_view and case_view_only_own are enabled |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The case can not be found NOT_PERMITTED • You are not permitted to view this case |
Notes |
|
Description | Edit a case |
---|---|
URL | /case/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The case uuid name • case name (optional) submitted • Flag if the case is submitted (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) The rest of the fields can not be set by the case owner completed • Flag if the case is completed (optional) closed • Flag if the case is closed (optional) case_status • The case status (optional) assigned_admin_id • Id of the admin user assigned to the case (optional) assigned_medical_id • Id of the medical user assigned to the case (optional) |
Returns |
status • OK |
Permission | case_edit or the case owner, or the assigned medical user if case_edit and case_edit_only_own are enabled |
Errors |
NOT_FOUND • The case or assigned user can not be found NOT_PERMITTED • You are not permitted to edit the case NOT_IN_ACCOUNT • The assigned user is not in the account INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details INVALID_CASE_STATUS • Invalid case status LOCKED • The case is locked by another user |
Notes |
|
Description | Return a case to the owner |
---|---|
URL | /case/return |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The case uuid reason • The reason the case was returned |
Returns |
status • OK |
Permission | case_edit, or the assigned medical user if case_edit and case_edit_only_own are enabled |
Errors |
NOT_FOUND • The case can not be found NOT_PERMITTED • You are not permitted to return the case |
Notes | A case can only be returned if it is submitted and not closed or completed |
Description | Delete a case |
---|---|
URL | /case/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The case uuid |
Returns |
status • OK |
Permission | case_delete |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The case can not be found NOT_PERMITTED • You are not permitted to delete the case |
Notes |
Description | Get a list of the cases for the current user or the account |
---|---|
URL | /case/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account (optional) filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash cases • An array of the cases. Each object holds the same fields as the /case/get call |
Permission | case_view or case ownership, or the assigned medical user if case_view and case_view_only_own are enabled |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view cases in this account |
Notes |
Description | Attach or detach a study to a case |
---|---|
URL | /case/attach |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Case uuid study_id • Study uuid detach • Flag to detach the study from the case (optional) |
Returns |
status • OK |
Permission | Only the assigned admin or medical user can do this |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The case or study can not be found NOT_PERMITTED • You are not permitted to do this |
Notes | The attached study will be shared into the users PHR account |
Patient commands
Description | Add a patient |
---|---|
URL | /patient/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account to add them to study_id • Id of the study to create a patient from (optional) (name|first&&last) • Patient name as either full name or first and last (optional if study_id is used) mrn • MRN (optional if study_id is used) sex • Gender (optional) birth_date • Birth date (optional) email • Email address (optional) mobile_phone • Mobile phone number (optional) alt_email • Alternate email address (optional) alt_mobile_phone • Alternate mobile phone number (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) event_share • Notify the patient if a new study is available on the patient portal (optional) event_new_report • Notify the patient if a report is attached on the patient portal (optional) |
Returns |
status • OK uuid • The uuid |
Permission | patient_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account or study was not found. The error_subtype holds the type of field not found NOT_PERMITTED • You are not permitted to add a patient to the account INVALID_PHONE • The phone number is invalid INVALID_EMAIL • The email is invalid ALREADY_EXISTS • The patient is already in the account ALREADY_USED • The email or phone number is already used by another patient. The error_subtype holds the field that is already used INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details |
Notes |
|
Description | Get a patient |
---|---|
URL | /patient/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The patient uuid |
Returns |
status • OK uuid • The patient uuid name • Patient name first • Patient first name last • Patient last name mrn • MRN sex • Gender birth_date • Birth date email • Email address mobile_phone • Mobile phone number alt_email • Alternate email address alt_mobile_phone • Alternate mobile phone number event_share • Notify the patient if a new study is available on the patient portal event_new_report • Notify the patient if a report is attached on the patient portal tags • An array of user tags associated with this object (This is only returned if the object has tags) customfields • An array of the custom fields associated with this patient. Each object has the following fields (This is only returned if the group has custom fields) |
Permission | patient_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to view this patient |
Notes |
Description | Edit a patient |
---|---|
URL | /patient/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The patient uuid (name|first&&last) • Patient name as either full name or first and last mrn • MRN sex • Gender birth_date • Birth date email • Email address (optional) mobile_phone • Mobile phone number (optional) alt_email • Alternate email address (optional) alt_mobile_phone • Alternate mobile phone number (optional) event_share • Notify the patient if a new study is available on the patient portal (optional) event_new_report • Notify the patient if a report is attached on the patient portal (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) |
Returns |
status • OK |
Permission | patient_edit |
Errors |
NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to edit the patient INVALID_PHONE • The phone number is invalid INVALID_EMAIL • The email is invalid ALREADY_EXISTS • The MRN is in use by another patient ALREADY_USED • The email or phone number is already used by another patient. The error_subtype holds the field that is already used INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details |
Notes |
Description | Delete a patient |
---|---|
URL | /patient/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The patient uuid |
Returns |
status • OK |
Permission | patient_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to delete the patient |
Notes |
Description | Get a list of the patients in the account |
---|---|
URL | /patient/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash patients • An array of the patients. Each object holds the same fields as the /patient/get call |
Permission | patient_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view patients in this account |
Notes | The default sort is by recent activity. |
Description | Get a list of the studies for the patient |
---|---|
URL | /patient/study/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The patient id viewable_only • Flag if they only want the studies the user can view |
Returns |
status • OK studies • An array of the studies. Each object holds the same fields as the /study/get call |
Permission | patient_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to view this patient |
Notes |
Description | Find a patient for the portal |
---|---|
URL | /patient/portal/find |
Parameters |
first • The first name last • The last name birth_date • Date of birth mrn • MRN (required if the require_mrn_for_patient_portal account setting is on) |
Returns |
status • OK patient_id • The patient id study_count • The number of studies for the patient email • The obscured version of the patient email mobile_phone • The obscured version of the patient phone alt_email • The obscured version of the patient email alt_mobile_phone • The obscured version of the patient phone dup_email • Flag if another patient has the same email dup_mobile_phone • Flag if another patient has the same mobile_phone other_patients • An array of the other matching patients. Each object holds the same fields as documented above. This field is only returned if there are other matching patients. |
Permission | The enable_patient_portal flag needs to be turned on for the account and the call needs to come for a vanity for the account |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to perform this search INVALID_DATE • An invalid date was passed |
Notes |
|
Description | Send a PIN to the patient |
---|---|
URL | /patient/portal/pin |
Parameters |
patient_id • The patient id email • Flag if they want the PIN sent via email mobile_phone • Flag if they want the PIN sent via SMS alt_email • Flag if they want the PIN sent via the alt_email alt_mobile_phone • Flag if they want the PIN sent via SMS to the alt_mobile_phone |
Returns |
status • OK |
Permission | The enable_patient_portal flag needs to be turned on for the account and the call needs to come for a vanity for the account |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to do this |
Notes |
|
Description | Login to the patient portal |
---|---|
URL | /patient/portal/login |
Parameters |
patient_id • The patient id pin • The PIN |
Returns |
status • OK sid • Session id |
Permission | The enable_patient_portal flag needs to be turned on for the account and the call needs to come for a vanity for the account |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found INVALID_PIN • The PIN is invalid or expired NOT_PERMITTED • You are not permitted to do this LOCKOUT • Too many failed attempts |
Notes |
Description | List user's accounts with patient portal enabled |
---|---|
URL | /patient/portal/list |
Parameters |
page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash portals • An array of the accounts with patient portal enabled. Each object holds the following fields * uuid • The account UUID * name • Name of the account * vanity • Vanity host name(s) for the account |
Permission | |
Errors | |
Notes | Only patient portals with the expose_patient_portal setting turned on are returned. |
Order commands
Description | Add a order |
---|---|
URL | /order/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account to add them to patientid • Patient MRN patient_name • Patient name accession_number • Accession number patient_sex • Gender patient_birth_date • DOB referring_physician • Referring physician sending_facility • Sending facility customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) |
Returns |
status • OK uuid • The uuid |
Permission | order_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account was not found. The error_subtype holds the type of field not found NOT_PERMITTED • You are not permitted to add a order to the account INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details |
Notes |
Description | Get an order |
---|---|
URL | /order/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The order uuid |
Returns |
status • OK uuid • The order uuid patientid • Patient MRN patient_name • Patient name accession_number • Accession number patient_sex • Gender patient_birth_date • DOB referring_physician • Referring physician sending_facility • Sending facility tags • An array of user tags associated with this object (This is only returned if the object has tags) customfields • An array of the custom fields associated with this order. Each object has the following fields (This is only returned if the order has custom fields) sps • An array of the SPS records associated with this order. Each record has the following fields * uuid • Id of the SPS * modality • Modality * scheduled_procedure_step_id • Step ID * requested_procedure_id • Procedure ID * requested_procedure_description • Procedure description * scheduled_station_aetitle • Station AE title * scheduled_procedure_step_start_date • Start date * scheduled_procedure_step_start_time • Start time * scheduled_procedure_step_description • Step description * mpps_status • The modality performed procedure step (mpps) status * mpps_uid • The UID for the mpps --- The following field is only returned if the enable_orders_in_worklist account setting is enabled --- studies • An array of study ids linked with this order (having the same accession_number). |
Permission | order_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The order can not be found NOT_PERMITTED • You are not permitted to view this order |
Notes |
Description | Edit a order |
---|---|
URL | /order/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The order uuid patientid • Patient MRN patient_name • Patient name accession_number • Accession number patient_sex • Gender patient_birth_date • DOB referring_physician • Referring physician sending_facility • Sending facility customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) |
Returns |
status • OK |
Permission | order_edit |
Errors |
NOT_FOUND • The order can not be found NOT_PERMITTED • You are not permitted to edit the order INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details |
Notes |
Description | Delete a order |
---|---|
URL | /order/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The order uuid |
Returns |
status • OK |
Permission | order_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The order can not be found NOT_PERMITTED • You are not permitted to delete the order |
Notes |
Description | Get a list of the orders in the account |
---|---|
URL | /order/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash orders • An array of the orders. Each object holds the same fields as the /order/get call |
Permission | order_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view orders in this account |
Notes |
|
Description | Add a scheduled procedure step to an order |
---|---|
URL | /order/sps/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) order_id • uuid of the order modality • Modality scheduled_procedure_step_id • Step ID requested_procedure_id • Procedure ID requested_procedure_description • Procedure description scheduled_station_aetitle • Station AE title scheduled_procedure_step_start_date • Start date scheduled_procedure_step_start_time • Start time scheduled_procedure_step_description • Step description |
Returns |
status • OK uuid • UUID of the SPS |
Permission | order_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The order can not be found NOT_PERMITTED • You are not permitted to edit orders in this account |
Notes |
Description | Edit a scheduled procedure step |
---|---|
URL | /order/sps/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • UUID of the SPS modality • Modality (optional) scheduled_procedure_step_id • Step ID (optional) requested_procedure_id • Procedure ID (optional) requested_procedure_description • Procedure description (optional) scheduled_station_aetitle • Station AE title (optional) scheduled_procedure_step_start_date • Start date (optional) scheduled_procedure_step_start_time • Start time (optional) scheduled_procedure_step_description • Step description (optional) |
Returns |
status • OK |
Permission | order_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The SPS can not be found NOT_PERMITTED • You are not permitted to edit orders in this account |
Notes |
Description | Delete a scheduled procedure step |
---|---|
URL | /order/sps/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • UUID of the SPS |
Returns |
status • OK |
Permission | order_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The SPS can not be found NOT_PERMITTED • You are not permitted to edit orders in this account |
Notes |
Description | Set the mpps status of a SPS |
---|---|
URL | /order/sps/status |
Parameters |
uuid • The node id serial_no • The serial number of the node mpps_uid • The mpps UUID of the SPS mpps_status • The mpps status to set (PENDING|IN_PROGRESS|DISCONTINUED|COMPLETED) |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The SPS can not be found NOT_PERMITTED • You are not permitted to set the status INVALID_STATUS • An invalid status was passed |
Notes |
Description | Find SPS orders for MWL processing |
---|---|
URL | /order/sps/find |
Parameters |
(sid || node_id && serial_no) • Either the sid or the node uuid and serial number account_id • The account uuid if sid authentication is used filter.* Filters (optional) |
Returns |
status • OK sps • An array of the matching sps record. Each record has the following fields * patientid • Patient MRN * patient_name • Patient name * accession_number • Accession number * patient_sex • Gender * patient_birth_date • DOB * referring_physician • Referring physician * modality • Modality * study_uid • Study UID * scheduled_procedure_step_id • Step ID * requested_procedure_id • Procedure ID * requested_procedure_description • Procedure description * scheduled_station_aetitle • Station AE title * scheduled_procedure_step_start_date • Start date * scheduled_procedure_step_start_time • Start time * scheduled_procedure_step_description • Step description * mpps_status • The modality performed procedure step (mpps) status * mpps_uid • The UID for the mpps |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found NOT_PERMITTED • You are not permitted to view orders in this account |
Permission | order_view if sid authentication is used |
Notes |
|
HL7 commands
Description | Get a list of HL7 messages in an account |
---|---|
URL | /hl7/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash messages • An array of the HL7 messages. Each message holds the following fields: * uuid • uuid of the message * created • Created datetime stamp of the message * type • Message type * accession_numbers • Array of the message accession numbers * patientid • Patient MRN * patient_name • Patient name |
Permission | hl7_message_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account_id can not be found NOT_PERMITTED • You are not permitted to do this |
Notes |
Description | Add a HL7 message to the system |
---|---|
URL | /hl7/add |
Parameters |
uuid • The node id serial_no • The serial number of the node message • The HL7 message accession_number • Use this accession number instead of the accession number in the HL7 message (optional) |
Returns |
status • OK ack • The HL7 acknowledgement uuid • UUID of the message |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found INVALID_MESSAGE • The message could not parsed as a HL7 message |
Notes |
|
Description | Get a HL7 message |
---|---|
URL | /hl7/get |
Parameters |
(sid || node_id && serial_no) • Either the sid or the node uuid and serial number uuid • The hl7 uuid (study_id || study_uid && storage_namespace && phi_namespace) • The study uuid or the storage triplet (optional) raw • Flag to return the raw HL7 message as well |
Returns |
status • OK uuid • The hl7 uuid created • The date and time the report was created. segments • A JSON list of lists of the segments in the message hl7_template • The hl7_template to render the message with (optional) raw • The hl7 message (optional) |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The hl7 can not be found NOT_PERMITTED • You are not permitted to access this hl7 |
Notes |
Description | Delete a HL7 message |
---|---|
URL | /hl7/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The hl7 uuid |
Returns |
status • OK |
Permission | hl7_message_delete or study_report_delete permission for the associated study |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The hl7 can not be found NOT_PERMITTED • You are not permitted to delete this hl7 |
Notes |
Description | Return the latest HL7 report for a study |
---|---|
URL | /hl7/study/report |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) study_id • The study uuid |
Returns |
status • OK text • Plain text version of the report |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to view this |
Notes |
Description | Extract the report from the HL7 and attach it to the studies |
---|---|
URL | /hl7/extract/report |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The HL7 uuid |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The HL7 can not be found NOT_PERMITTED • You are not permitted to access this HL7 message NOT_CONFIGURED • The node setting report_from_hl7 is not configured |
Notes |
Description | List the HL7 templates for the account |
---|---|
URL | /hl7/template/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account uuid |
Returns |
status • OK templates • A array of the template objects. Each object contains the fields in /hl7/template/get |
Permission | hl7_template_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view this list |
Notes |
Description | Add a HL7 template to the account |
---|---|
URL | /hl7/template/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account uuid name • Name of the template body • The HL7 message with replacement expressions |
Returns |
status • OK uuid • Id of the template |
Permission | hl7_template_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to do this INVALID_HL7 • The body is not a valid HL7 message |
Notes |
|
Description | Modify a HL7 template |
---|---|
URL | /hl7/template/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The template id name • Name of the template body • The HL7 message with replacement expressions |
Returns |
status • OK |
Permission | hl7_template_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The template can not be found NOT_PERMITTED • You are not permitted to do this INVALID_HL7 • The body is not a valid HL7 message |
Notes |
Description | Get a HL7 template |
---|---|
URL | /hl7/template/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The template id |
Returns |
status • OK uuid • The template id name • Name of the template type • Type of the HL7 message body • The HL7 message with replacement expressions |
Permission | hl7_template_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The template can not be found NOT_PERMITTED • You are not permitted to do this |
Notes |
Description | Render a HL7 template for a study |
---|---|
URL | /hl7/template/render |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The template id study_id • The study id hl7_id • Optional hl7 message text • Flag if you want the text returned rather than the JSON hex • Flag if you want a hexdump of the text returned rather than the JSON |
Returns |
status • OK message • The HL7 message |
Permission | hl7_template_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The template or study can not be found NOT_PERMITTED • You are not permitted to do this |
Notes |
Description | Delete a HL7 template |
---|---|
URL | /hl7/template/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The template id |
Returns |
status • OK |
Permission | hl7_template_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The template can not be found NOT_PERMITTED • You are not permitted to do this |
Notes |
Description | List the HL7 transforms for the account |
---|---|
URL | /hl7/transform/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account uuid filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash transforms • A array of the transform objects. Each object contains the fields in /hl7/transform/get |
Permission | hl7_transform_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view this list |
Notes |
Description | Add a HL7 transform to the account |
---|---|
URL | /hl7/transform/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account uuid name • Name of the transform order_by • A numeric ordering value. Transformations are run in this order from lowest to highest conditions • A JSON array of the transform conditions replacements • A JSON array of the transform replacements |
Returns |
status • OK uuid • Id of the transform |
Permission | hl7_transform_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to do this DUPLICATE_ORDER_BY • The order_by value is used by another transform NOT_LIST • The field is not a JSON array. The error_subtype holds the name of the field INVALID_CONDITION • An invalid condition was passed. The error_subtype holds the details on why it is invalid INVALID_REPLACEMENT • An invalid replacement was passed. The error_subtype holds the details on why it is invalid |
Notes |
|
Description | Modify a HL7 transform |
---|---|
URL | /hl7/transform/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The transform id name • Name of the transform order_by • A numeric ordering value. Transformations are run in this order from lowest to highest conditions • A JSON array of the transform conditions replacements • A JSON array of the transform replacements |
Returns |
status • OK |
Permission | hl7_transform_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to do this DUPLICATE_ORDER_BY • The order_by value is used by another transform NOT_LIST • The field is not a JSON array. The error_subtype holds the name of the field INVALID_CONDITION • An invalid condition was passed. The error_subtype holds the details on why it is invalid INVALID_REPLACEMENT • An invalid replacement was passed. The error_subtype holds the details on why it is invalid |
Notes |
Description | Get a HL7 transform |
---|---|
URL | /hl7/transform/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The transform id |
Returns |
status • OK uuid • The transform id name • Name of the transform order_by • A numeric ordering value. Transformations are run in this order from lowest to highest conditions • A JSON array of the transform conditions replacements • A JSON array of the transform replacements |
Permission | hl7_transform_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The transform can not be found NOT_PERMITTED • You are not permitted to do this |
Notes |
Description | Delete a HL7 transform |
---|---|
URL | /hl7/transform/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The transform id |
Returns |
status • OK |
Permission | hl7_transform_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The transform can not be found NOT_PERMITTED • You are not permitted to do this |
Notes |
Description | Test HL7 transformation |
---|---|
URL | /hl7/transform/test |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) hl7 • HL7 message to run the transformations on |
Returns |
status • OK hl7 • The transformed HL7 message |
Permission | hl7_transform_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to do this |
Notes |
Description | Parse a HL7 message and show the field and values |
---|---|
URL | /hl7/parse/fields |
Parameters |
message • HL7 message to parse fields • Comma delimited list of the field to return. Use the notation specified in /hl7/transform/add (optional) |
Returns |
status • OK fields • A JSON array of the fields and values |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_MESSAGE • The message could not parsed as a HL7 message |
Notes |
Setting commands
Description | Set a setting value for the user |
---|---|
URL | /setting/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) key • The key to store the value under. If the key name begins with temp_ it is only available for the session. value • The value to store user_id • A sysadmin user can set the value for a specific user (optional) |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
Notes |
|
Description | Get a setting value for the user |
---|---|
URL | /setting/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) key • The key to get user_id • A sysadmin user can get the value for a specific user (optional) |
Returns |
status • OK value • The setting value |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
Notes |
Description | Get all the settings for a user |
---|---|
URL | /setting/get/all |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) |
Returns |
status • OK settings • The hash of all non-temporary user settings |
Errors | |
Notes |
Node commands
Harvester commandsDescription | List the nodes for an account |
---|---|
URL | /node/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash nodes • An array of the nodes. Each object holds the following same fields as the /node/get call |
Permission | node_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view this list |
Notes |
Description | List public nodes |
---|---|
URL | /node/public |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account the user is in filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash nodes • An array of the nodes. Each object will have the following fields * uuid • Node id * facility_name • Name of the facility it is installed at * facility_zip • Zip code of the facility it is installed at * facility_contact • Name of the facility contact * facility_contact_title • Title of the facility contact * facility_email • Email of the facility contact * facility_notes • Notes about the facility * connect_status • A status indicating a connection request state |
Permission | node_connect |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node or account can not be found NOT_PERMITTED • You are not permitted to do this INVALID_FILTER • Invalid filter field |
Notes |
|
Description | Request a connection to a public node |
---|---|
URL | /node/connect |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The node id account_id • The account the user is in message • Message (optional) |
Returns |
status • OK |
Permission | node_connect |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node or account can not be found NOT_PERMITTED • You are not permitted to do this ALREADY_CONNECTED • The node is already connected to the account ALREADY_PENDING • The node is pending connection already |
Notes | An email requesting the connection will sent to Ambra, the node operator and the user. The email is generated from the node_connect template for the account the node is located in. |
Description | Approve a public node connection |
---|---|
URL | /node/approve |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The node id account_id • The account which requested the connection |
Returns |
status • OK |
Permission | node_approve_connect |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node, node connection request or account can not be found NOT_PERMITTED • You are not permitted to do this ALREADY_CONNECTED • The node is already connected to the account |
Notes |
Description | Add a node |
---|---|
URL | /node/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) name • Description of the node uuid • uuid of the node (optional, you can use this to explicitly set the UUID) (account_id|location_id|group_id) • uuid of the account, location or group to link this node to type • Type of node (STORAGE|HARVESTER|ACCELERATOR|CLEARINGHOUSE|VIRTUAL|UTILITY|XDS) os_type • Node OS type, used with HARVESTER node type only (WINDOWS|MACOS) (optional) accelerator_id • uuid of the accelerator if this is an accelerator node facility_name • Name of the facility it is installed at (optional) facility_zip • Zip code of the facility it is installed at (optional) facility_contact • Name of the facility contact (optional) facility_contact_title • Title of the facility contact (optional) facility_email • Email of the facility contact (optional) facility_notes • Notes about the facility (optional) category • Node category (ACTIVE|INACTIVE|MIGRATION|TEST|DUPLICATE|INTEGRATED|ACCELERATOR) (optional) is_public • Flag if the node is public (optional) ctc_bucket • Name of the S3 bucket to use for a cloud to cloud gateway (optional) |
Returns |
status • OK uuid • The node uuid serial_no • The node serial number |
Permission | node_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields ACCOUNT_NOT_FOUND • The account was not found NOT_PERMITTED • You are not permitted to add a node to this account INVALID_UUID • Invalid uuid format or this uuid is already in use INVALID_TYPE • Invalid type of node INVALID_OS_TYPE • Invalid OS type of node INVALID_LINKAGE • The linkage is invalid |
Notes |
|
Description | Edit a node |
---|---|
URL | /node/set |
Parameters |
(sid|serial_no) • The session id or serial number of the node uuid • The node id name • Description of the node (optional) configuration • The configuration as a JSON hash of key values pairs (optional) reload_configuration • If this flag is set the node will be instructed to reload it's configuration on the next ping (optional) monitor_study_create • Check if the node is sending studies normally (optional) monitor_study_create_threshold • Threshold in minutes for triggering the monitor_study_create notification (optional) monitor_node_ping • Check if the node is pinging (optional) monitor_node_slow_push • Check if the node is pushing slowly (optional) monitor_node_slow_push_threshold • Threshold in minutes for triggering the monitor_node_slow_push notification (optional) monitor_node_last_send • Check if the node has sent a study recently (optional) monitor_node_last_send_threshold • Threshold in minutes for triggering the monitor_node_last_send notification (optional) monitor_email • Email address(es) to send monitor failure notices (optional) warning_email • Email address(es) to send warning notices (optional) storage_namespace • Namespace uuid to attach the node to. This requires a sysadmin sid and must be within the same account (optional) settings • A hash of the account settings that the node can override (optional) setting_SETTING_NAME • Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional) facility_name • Name of the facility it is installed at (optional) facility_zip • Zip code of the facility it is installed at (optional) facility_contact • Name of the facility contact (optional) facility_contact_title • Title of the facility contact (optional) facility_email • Email of the facility contact (optional) facility_notes • Notes about the facility (optional) category • Node category (ACTIVE|INACTIVE|MIGRATION|TEST|DUPLICATE|INTEGRATED) (optional) is_public • Flag if the node is public (optional) ctc_bucket • Name of the S3 bucket to use for a cloud to cloud gateway (optional) |
Returns |
status • OK |
Permission | node_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field NOT_PERMITTED • You are not permitted to edit this node INVALID_CONFIGURATION • An invalid combination of configuration options was set. The error_subtype will hold more detail NO_NODE_OVERRIDE • The setting does not allow a node override |
Notes |
|
Description | Get a node |
---|---|
URL | /node/get |
Parameters |
uuid • The node id (sid|serial_no) • The session id or serial number of the node |
Returns |
status • OK name • Description of the node uuid • uuid of the node type • The type of the node os_type • Node OS type serial_no • The serial number of the node storage_namespace • The storage namespace the node should harvest to storage_namespace_name • The name of the storage namespace the node should harvest to configuration • The configuration as JSON hash of key values pairs monitor_study_create • Check if the node is sending studies normally monitor_study_create_threshold • Threshold in minutes for triggering the monitor_study_create notification monitor_node_ping • Check if the node is pinging monitor_node_slow_push • Check if the node is pushing slowly monitor_node_slow_push_threshold • Threshold in minutes for triggering the monitor_node_slow_push notification monitor_node_last_send • Check if the node has sent a study recently monitor_node_last_send_threshold • Threshold in minutes for triggering the monitor_node_last_send notification monitor_email • Email address(es) to send monitor failure notices warning_email • Email address(es) to send warning notices accelerator_id • uuid of the accelerator if this is an accelerator node account_id • The associated account id settings • A hash of the account settings that the node has overridden has_access • Flag if the user has node_view or node_edit permissions on this node facility_name • Name of the facility it is installed at facility_zip • Zip code of the facility it is installed at facility_contact • Name of the facility contact facility_contact_title • Title of the facility contact facility_email • Email of the facility contact facility_notes • Notes about the facility category • Node category (ACTIVE|INACTIVE|MIGRATION|TEST|DUPLICATE|INTEGRATED) is_public • Flag if the node is public ctc_bucket • Name of the S3 bucket to use for a cloud to cloud gateway (optional) last_ping • Number of seconds since the nodes last ping. -1 if the node has never pinged |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found |
Notes |
Description | Ping node |
---|---|
URL | /node/ping |
Parameters |
uuid • The node id serial_no • The serial number of the node ack • Flag if the gateway wants to use the acknowledge workflow |
Returns |
status • OK reload_configuration • An optional flag field, if set the node should reload it's configuration. ack • Flag if an acknowledgement is needed (optional) studies • An array of the studies each object in the array will have the following fields * uuid • Id of the push job * study_uid • The study uid * storage_namespace • The storage namespace * phi_namespace • The phi namespace * engine_fqdn • The FQDN of the storage engine for the study * modality • The study modality * size • The study size * image_count • The study image_count * accession_number • The study accession number * patientid • The study MRN * destination_id • Id of the destination (if the destination is DICOM) * aetitle • The ae title to send to (if the destination is DICOM) * address • The destination address (if the destination is DICOM) * port • The destination port (if the destination is DICOM) * path • The destination path (if the destination is FOLDER) * bundle • The bundle type (if the destination is FOLDER) * detail • Any additional detail from the /study/cmove or "use_cache" if local routing is required or "is_auto" if this was created by routing rules fetch • An array of the studies to fetch each object in the array will have the following fields * uuid • Id of the fetch job * accession_number • The accession number to query on * destination_id • Id of the destination * aetitle • The ae title to query to * address • The query address * port • The query port * study_uid • Study uid to query for * patientid • Patient id to query for * destination_ae_title • Value of the field in the thin study (optional) * source • Source of the fetch either 'H' for an HL7 triggered fetch or 'O' for other hl7 • An array of HL7 messages to deliver each object in the array will have the following fields * uuid • Id of the job * destination_id • Id of the destination * message • The HL7 message to deliver * address • The HL7 destination address * port • The HL7 destination port search_results • An array of the results from the /destination/search jobs run by the gateway. Each object in the array will have the following fields * uuid • Id of the search results * destination_id • Id of the destination that was searched * payload • Payload from the search * search_id • UUID of the original search search • An array of the search jobs to run. Each object in the array will have the following fields * uuid • Id of the search job * destination_id • Id of the destination * aetitle • The ae title to query to * address • The query address * port • The query port * mwl_search • Flag to indicate if this is a modality worklist search * node_search • Flag to indicate if this is a search from another node * create_thin • Value entered in the /destination/search * create_study • Value entered in the /destination/search * The rest of the fields are the optional search parameters in either the /destination/search or the /destination/search/mwl call webhook • An array of the webhooks to run. Each object in the array will have the following fields * uuid • Id of the webhook job * method • The HTTP method to use * url • The URL to call * parameters • A JSON hash of the call parameters * auth • The webhook auth setting burn • An array of the CD burn jobs to run. Each object in the array will have the following fields * uuid • Id of the burn job * name • Name of the destination * template • The template for the job * priority • Priority of the job * studies • An array of the studies to burn. Each object in the array will have the following fields ** study_uid • The study uid ** modality • The study modality ** size • The study size ** image_count • The study image_count ** study_description • The study description ** study_date • The study date ** storage_namespace • The storage namespace ** phi_namespace • The phi namespace ** engine_fqdn • The FQDN of the storage engine for the study ** labels • A JSON array of the labels log • An array of the log search jobs to run. Each object in the array will have the following fields * start • The start date and time for the log range * end • The end date and time for the log range * type • The log type to process (log|dicom|queue|system) |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found |
Notes |
|
Description | Acknowledge the last ping |
---|---|
URL | /node/ping/ack |
Parameters |
uuid • The node id serial_no • The serial number of the node |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found |
Notes |
Description | Update the status of a job picked up /node/ping |
---|---|
URL | /node/deliver |
Parameters |
uuid • The node id serial_no • The serial number of the node job_id • The uuid of the push job, not used for local pushes (optional) status • Status code of the job (S|F|P|B|U) - Success, failure, partial transfer, blocked or uncached status_reason • Detail on the status change (optional) ack • The HL7 ACK if this was an HL7 job (optional) email_reason • Email the user this reason for the status change (optional) is_local • The flag used to indicate the local push (optional) study_uid • The study uid of the local push, required for local pushes only (optional) destination_id • The uuid of the destination, required for local pushes (optional) |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node or job can not be found INVALID_STATUS • Invalid status code |
Notes |
|
Description | Update the status of a fetch job picked up /node/ping |
---|---|
URL | /node/retrieve |
Parameters |
uuid • The node id serial_no • The serial number of the node job_id • The uuid of the fetch job status • Status code of the job (S|F|P) - Success, failure, partial transfer |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node or job can not be found INVALID_STATUS • Invalid status code |
Notes | The uuid and serial_no can also be passed using basic auth as the username/password combination |
Description | Set the status of webhook picked up /node/ping |
---|---|
URL | /node/webhook |
Parameters |
uuid • The node id serial_no • The serial number of the node webhook_id • The uuid of the webhook job status • Status code of the job (S|F) - Success, failure error_message • Detailed error message (optional) |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node or webhook can not be found INVALID_STATUS • Invalid status code |
Notes | The uuid and serial_no can also be passed using basic auth as the username/password combination |
Description | Get the node configuration |
---|---|
URL | /node/configuration |
Parameters |
uuid • The node id serial_no • The serial number of the node |
Returns |
status • OK storage_namespace • The storage namespace the node should harvest to configuration • The configuration as JSON hash of key values pairs destinations • An array of the destinations for the node. Each object holds the following same fields as the /destination/get call account_settings • A hash of the relevant account settings. (study_search_modifiers) |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found |
Notes |
The uuid and serial_no can also be passed using basic auth as the username/password combination
The ingress_filter element contains a json string which includes the group/element, the type of comparison and the value to test against. A sample document is as follows: |
Description | Delete a node |
---|---|
URL | /node/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The node id |
Returns |
status • OK |
Permission | node_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found NOT_PERMITTED • You are not permitted to delete this node HAS_DESTINATIONS • The node has associated destinations |
Notes |
Description | A study was queued for pushing to storage |
---|---|
URL | /node/study/queued |
Parameters |
uuid • The node id serial_no • The serial number of the node study_uid • The study uid |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found |
Notes | A node should notify services when it receives a study that needs to be pushed to the cloud. This call is needed for the monitor_study_create check to work. |
Description | Return the results of a search |
---|---|
URL | /node/found |
Parameters |
uuid • The node id serial_no • The serial number of the node search_id • The id of the search request studies • A JSON array of the studies found. Each object has the following fields * study_uid • The study_uid * study_date • The study date * accession_number • The accession number * referring_physician • The referring physician * patient_name • Patient name * patientid • Patient ID * patient_sex • Gender * patient_birth_date • Birth date * study_description • Study description * modality • Modality * result_fields • A JSON structure with the answers for the requested result_fields in /destination/search (optional) |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node or search can not be found INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field ALREADY_DONE • The search has already had results returned against it |
Notes |
Description | Return the results of a modality worklist search |
---|---|
URL | /node/found/mwl |
Parameters |
uuid • The node id serial_no • The serial number of the node search_id • The id of the search request orders • A JSON array of the orders found. Each object has the following fields * patient_name • Patient name * patientid • Patient id * accession_number • Accession number * patient_sex • Gender * patient_birth_date • Birth date * order_number • Order number * order_date • Order date |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node or search can not be found INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field ALREADY_DONE • The search has already had results returned against it |
Notes |
Description | Notify for a node event |
---|---|
URL | /node/event |
Parameters |
uuid • The node id serial_no • The serial number of the node event • The event (c_echo_error) destination_id • The id of the destination if the event is associated with a destination |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node or destination can not be found INVALID_EVENT • Invalid event SCHEDULE_IS_OFF • The event is outside of its scheduled time |
Notes |
Description | Request logs from the node be attached to a study |
---|---|
URL | /node/log |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The node id start • Start time stamp in YYYY-MM-DD HH:MM:SS format end • End time stamp in YYYY-MM-DD HH:MM:SS format type • Type of log (log|dicom|queue|system) defaults to log if not passed |
Returns |
status • OK |
Permission | node_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found NOT_PERMITTED • You are not permitted to perform this action INVALID_DATE_TIME • The timestamp is invalid INVALID_RANGE • An invalid time range was specified TRY_LATER • The log search queue is full |
Notes |
|
Description | Record a metric for a job on the node |
---|---|
URL | /node/metric |
Parameters |
uuid • The node id serial_no • The serial number of the node job_id • The uuid of the push job metric • The metric to record |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node or job can not be found INVALID_METRIC • The metric is invalid for this job type |
Notes |
The following metrics are supported
|
Description | Set performance counters for the node |
---|---|
URL | /node/performance/set |
Parameters |
uuid • The node id serial_no • The serial number of the node data • A JSON data structure with performance data |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found |
Notes |
Description | Get performance counters for the node |
---|---|
URL | /node/performance/get |
Parameters |
(sid|serial_no) • The session id or serial number of the node uuid • The node id |
Returns |
status • OK data • The node's performance data |
Errors |
NOT_FOUND • The node can not be found NOT_PERMITTED • You are not permitted to view this node |
Notes |
Description | Add a progress record for the node |
---|---|
URL | /node/progress/add |
Parameters |
uuid • The node id serial_no • The serial number of the node queue • The queue state • The status destination_id • The destination uuid (optional) study_uid • Study uid (optional) patientid • DICOM tag (0010,0020) (optional) accession_number • DICOM tag (0008,0050) (optional) detail • JSON detail (optional) |
Returns |
status • OK uuid • The record uuid |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node or destination can not be found |
Notes |
Description | List the progress records for the node or destination |
---|---|
URL | /node/progress/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (node_id|destination_id) • The node or destination id filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash last_ping • Number of seconds since the nodes last ping. -1 if the node has never pinged progresses • An array of the progress records. Each object holds the following same fields as the /node/progress/get call |
Permission | node_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found NOT_PERMITTED • You are not permitted to do this |
Notes |
|
Description | Get a node progress record |
---|---|
URL | /node/progress/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The node progress uuid |
Returns |
status • OK destination_id • The destination uuid destination_name • The destination name queue • The queue state • The status study_uid • Study uid patientid • DICOM tag (0010,0020) (optional) accession_number • DICOM tag (0008,0050) (optional) detail • JSON detail created • Timestamp |
Permission | node_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The record can not be found NOT_PERMITTED • You are not permitted to do this |
Notes |
Destination commands
Dicom destinationsDescription | List the destinations for the account |
---|---|
URL | /destination/list |
Parameters |
(sid || node_id && serial_no) • Either the sid or the node uuid and serial number uuid • uuid of the destination account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash destinations • An array of the destinations. Each object holds the following same fields as the /destination/get call |
Permission | destination_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view this list |
Notes |
Description | Add a destination to the account |
---|---|
URL | /destination/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account node_id • uuid of the node that handles the destination name • Name of the destination type • Type of the destination either DICOM, FOLDER, ACCELERATOR,VIRTUAL, BURNER, XDS, LINKED or UPLOADER. Defaults to DICOM (optional) linked_destination • uuid of the destination for LINKED destinations linked_qr_to_referred_account • A flag to create resultant studies in the linked destination's account (not the account of LINKED destination where the search was initiated). Meaningful for LINKED destinations only (opional) linked_qr_activity_in_referred_account • A flag to create DESTINATION_SEARCH activities in the linked destination's account. Meaningful for LINKED destinations only (opional) path • Path of the folder for a FOLDER type of destination (required if FOLDER type) aetitle • Aetitle of the destination (required if DICOM type) address • Address of the destination (required if DICOM type) port • Port of the destination (required if DICOM type) can_query_retrieve • Can this destination support query retrieve from HL7 messages (optional) can_retrieve_thin • Can this destination support retrieving thin studies (optional) can_search • Can this destination support searching (optional) can_mwl_search • Can this destination support searching a modality work list (optional) sqlch_psh_if_img_unchg • Squelch pushes to the destination if the image count has not changed and the push is by a routing rule (optional) sqlch_psh_if_route_hl7 • Squelch pushes to the destination if the push was generated by HL7 triggered routing (optional) hl7_address • Address of an attached HL7 destination (optional except for VIRTUAL destinations) hl7_port • Port of an attached HL7 destination (optional except for VIRTUAL destinations) c_echo_interval • Interval in seconds to C echo the destination (optional) c_echo_schedule • C echo schedule (optional) fire_webhooks • Fire webhooks for events associated with this destination (optional) default_query_retrieve_level • Default query retrieve level this can be either (study|series|image) and defaults to study if not specified (optional) push_related_studies • Push all the related studies (same MRN/patientid) in the namespace when a study is pushed (optional) gateway_settings • Gateway settings (optional) cd_burn_info • A JSON hash with the CD burning information (optional) cd_burn_name • Name for the CD burner software (optional) cd_burn_priority • Integer value for the burner priority (optional) sort_order • Integer value for sorting (optional) hl7_fetch_filter • A transform condition expression (see /transform/add for format) to match against the HL7 message. Only fire a query retrieve if the message matches the condition (optional) manual_push_roles • A comma separated list of role uuids, a user is required to have one of them to manually push to this destination (optional) ui_json • JSON for UI settings (optional) |
Returns |
status • OK uuid • uuid of the destination |
Permission | destination_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found INVALID_NODE_TYPE • The node is not a harvester NODE_NOT_FOUND • The node can not be found INVALID_VALUE • An invalid value was passed. The error_subtype holds the value DUP_AETITLE • Duplicate aetitle. All destinations for the same node must have a unique aetitle NOT_PERMITTED • You are not permitted to add a destination to this account INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag INVALID_INTEGER • An invalid integer was passed. The error_subtype holds the name of the invalid integer INVALID_SCHEDULE • The schedule is invalid. The error_subtype holds the error detail INVALID_TYPE • An invalid type was passed INVALID_GATEWAY_TYPE • The type is wrong for the gateway it is getting attached to INVALID_CD_BURN_INFO • Invalid cd_burn_info. The error_subtype holds more detail INVALID_NODE_TYPE • The node type is invalid for this type of destination NOT_SYSADMIN • The user is not a sysadmin user |
Notes |
|
Description | Edit a destination |
---|---|
URL | /destination/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the destination name • Name of the destination (optional) path • Path of the folder (optional) aetitle • Aetitle of the destination (optional) address • Address of the destination (optional) port • Port of the destination (optional) node_id • uuid of the node that handles the destination (optional) can_query_retrieve • Can this destination support query retrieve from HL7 messages (optional) can_retrieve_thin • Can this destination support retrieving thin studies (optional) can_search • Can this destination support searching (optional) can_mwl_search • Can this destination support searching a modality work list (optional) sqlch_psh_if_img_unchg • Squelch pushes to the destination if the image count has not changed and the push is by a routing rule (optional) sqlch_psh_if_route_hl7 • Squelch pushes to the destination if the push was generated by HL7 triggered routing (optional) hl7_address • Address of an attached HL7 destination (optional) hl7_port • Port of an attached HL7 destination (optional) c_echo_interval • Interval in seconds to C echo the destination (optional) c_echo_schedule • C echo schedule (optional) fire_webhooks • Fire webhooks for events associated with this destination (optional) default_query_retrieve_level • Default query retrieve level this can be either (study|series|image) and defaults to study if not specified (optional) push_related_studies • Push all the related studies (same MRN/patientid) in the namespace when a study is pushed (optional) gateway_settings • Gateway settings (optional) cd_burn_info • A JSON hash with the CD burning information (optional) cd_burn_name • Name for the CD burner software (optional) cd_burn_priority • Integer value for the burner priority (optional) sort_order • Integer value for sorting (optional) hl7_fetch_filter • A transform condition expression (see /transform/add for format) to match against the HL7 message. Only fire a query retrieve if the message matches the condition (optional) manual_push_roles • A comma separated list of role uuids, a user is required to have one of them to manually push to this destination (optional) linked_qr_to_referred_account • A flag to create resultant studies in the linked destination's account (not the account of LINKED destination where the search was initiated). Meaningful for LINKED destinations only (opional) linked_qr_activity_in_referred_account • A flag to create DESTINATION_SEARCH activities in the linked destination's account. Meaningful for LINKED destinations only (opional) ui_json • JSON for UI settings (optional) |
Returns |
status • OK |
Permission | destination_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The destination can not be found NOT_PERMITTED • You are not permitted to edit the destination NODE_NOT_FOUND • The node can not be found INVALID_NODE_TYPE • The node is not a harvester INVALID_VALUE • An invalid value was passed. The error_subtype holds the value DUP_AETITLE • Duplicate aetitle. All destinations for the same node must have a unique aetitle INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag INVALID_INTEGER • An invalid integer was passed. The error_subtype holds the name of the invalid integer INVALID_SCHEDULE • The schedule is invalid. The error_subtype holds the error detail INVALID_CD_BURN_INFO • Invalid cd_burn_info. The error_subtype holds more detail |
Notes |
Description | Get a destination |
---|---|
URL | /destination/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the destination |
Returns |
status • OK uuid • uuid of the destination name • Name of the destination type • Type of the destination path • Path of the folder aetitle • Aetitle of the destination address • Address of the destination port • Port of the destination node_id • id of the handle that handles the destination can_query_retrieve • Can this destination support query retrieve from HL7 messages can_retrieve_thin • Can this destination support retrieving thin studies can_search • Can this destination support searching can_mwl_search • Can this destination support searching a modality work list sqlch_psh_if_img_unchg • Squelch pushes to the destination if the image count has not changed and the push is by a routing rule sqlch_psh_if_route_hl7 • Squelch pushes to the destination if the push was generated by HL7 triggered routing hl7_address • Address of an attached HL7 destination hl7_port • Port of an attached HL7 destination c_echo_interval • Interval in seconds to C echo the destination c_echo_schedule • C echo schedule fire_webhooks • Fire webhooks for events associated with this destination default_query_retrieve_level • Default query retrieve level push_related_studies • Push all the related studies (same MRN/patientid) in the namespace when a study is pushed gateway_settings • Gateway settings cd_burn_info • A JSON hash with the CD burning information cd_burn_name • Name for the CD burner software cd_burn_priority • Integer value for the burner priority sort_order • Integer value for sorting hl7_fetch_filter • A transform condition expression (see /transform/add for format) to match against the HL7 message. Only fire a query retrieve if the message matches the condition linked_destination • uuid of the linked destination if this is a LINKED type destination manual_push_roles • A comma separated list of role uuids, a user is required to have one of them to manually push to this destination linked_qr_to_referred_account • A flag to create resultant studies in the linked destination's account (not the account of LINKED destination where the search was initiated). Meaningful for LINKED destinations only linked_qr_activity_in_referred_account • A flag to create DESTINATION_SEARCH activities in the linked destination's account. Meaningful for LINKED destinations only ui_json • JSON for UI settings |
Permission | destination_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The destination can not be found NOT_PERMITTED • You are not permitted to view the destination |
Notes |
Description | Delete a destination |
---|---|
URL | /destination/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the destination |
Returns |
status • OK |
Permission | destination_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The destination can not be found NOT_PERMITTED • You are not permitted to delete the destination |
Notes |
Description | Search a destination |
---|---|
URL | /destination/search |
Parameters |
(sid || node_id && serial_no) • Either the sid or the node uuid and serial number uuid • uuid of the destination copy_to • uuid of a namespace to copy the retrieved or create_thin studies into (optional) push_to • uuid of a destination to push the retrieved studies to (optional) create_thin • The maximum number of thin studies to create from this search instead of creating an activity for the search results (optional) create_study • The maximum number of studies to retrieve from this search instead of creating an activity for the search results (optional) share_email • Email to share retrieved studies with on subsequent /destination/retrieve (optional) bundle_id • An integral number Used internally to track searches initiated from a single bundle (optional) message • A message to display when studies are found (optional) -- The rest of the fields are used for the search -- study_uid • Study uid to find (optional) patient_name • Patient name to find (optional) patientid • Patient id to find (optional) accession_number • Accession number to find (optional) referring_physician • Referring physician to find (optional) modality • Modality (optional) start_datetime • DICOM start date time stamp to bound the search (optional) end_datetime • DICOM end date time stamp to bound the search (optional) patient_sex • Gender to find (optional) patient_birth_date • Birth date to find (optional) query_fields • A JSON hash of additional query fields (optional) result_fields • A JSON array of DICOM tags that the destination should return (optional) |
Returns |
status • OK uuid • UUID of the search |
Permission | destination_search |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The destination or namespace can not be found NOT_PERMITTED • You are not permitted to search the destination NOT_SUPPORTED • The destination does not support searching a destination INSUFFICIENT_CRITERIA • Not enough search fields are populated |
Notes |
|
Description | Retrieve a study from a destination |
---|---|
URL | /destination/retrieve |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) activity_id • uuid of the DESTINATION_SEARCH activity to retrieve from message • A message to display when studies are retrieved (optional) |
Returns |
status • OK |
Permission | destination_search |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The activity can not be found |
Notes |
Description | Run a modality worklist search on a destination |
---|---|
URL | /destination/search/mwl |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the destination study_id • The id of the study we are searching for orders for -- The rest of the fields are used for the search -- patient_name • Patient name to find (optional) patientid • Patient id to find (optional) accession_number • Accession number to find (optional) patient_sex • Gender to find (optional) patient_birth_date • Birth date to find (optional) order_number • Order number to find (optional) order_date • Order date to find (optional) |
Returns |
status • OK |
Permission | destination_search |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The destination or study can not be found NOT_PERMITTED • You are not permitted to search the destination NOT_SUPPORTED • The destination does not support searching a destination INSUFFICIENT_CRITERIA • Not enough search fields are populated |
Notes |
Route commands
Routing rulesDescription | List the routing rules for the account |
---|---|
URL | /route/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash routes • An array of the routing rules. Each object holds the following same fields as the /route/get call |
Permission | route_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view this list |
Notes |
Description | Add a routing rule |
---|---|
URL | /route/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) name • Name of the route (account_id|group_id|location_id|namespace_id) • uuid of the account, group or location or namespace the route is linked with conditions • Route conditions in JSON format actions • Route actions in JSON format options • Route options in JSON format (optional) schedule • Route schedule in JSON format (optional) on_share • Apply the rule to studies shared into the namespace on_harvest • Apply the rule to studies harvested into the namespace on_upload • Apply the rule to studies uploaded into the namespace - flag (optional) on_manual_route • Apply this rule for a manually routed study - flag (optional) on_thin • Apply this rule to thin studies when they are created - flag (optional) no_re_run • Do not run this rule on a re-notification from storage - flag (optional) suspended • This rule is suspended and not applied - flag (optional) delay • Number of minutes to delay running this rule for after it is triggered (optional) delay_seconds • Number of seconds to delay running this rule for after it is triggered (optional) delay_till_schedule • Delay running this rule after it is triggered until the next scheduled time - flag (optional) other_namespaces • A comma separated list of the uuid of other namespaces to apply this rule to (optional) manual_roles • A comma separated list of the uuid of roles that can run the rule manually (optional) |
Returns |
status • OK uuid • The route uuid |
Permission | route_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag ACCOUNT_NOT_FOUND • The account was not found NOT_PERMITTED • You are not permitted to add a route to that account INVALID_LINKAGE • The linkage is invalid INVALID_CONDITION • A condition is invalid. The error_subtype holds the condition INVALID_ACTION • An action is invalid. The error_subtype holds the error detail INVALID_OPTION • An option is invalid. The error_subtype holds the error detail INVALID_SCHEDULE • The schedule is invalid. The error_subtype holds the error detail INVALID_OTHER_NAMESPACES • The other_namespaces is invalid. The error_subtype holds the error detail INVALID_MANUAL_ROLES • The manual_roles is invalid. The error_subtype holds the error detail |
Notes |
|
Description | Save a routing rule |
---|---|
URL | /route/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The route uuid name • Name of the route (optional) conditions • Route conditions in JSON format (optional) actions • Route actions in JSON format (optional) options • Route options in JSON format (optional) schedule • Route schedule in JSON format (optional) on_share • Apply the rule to studies shared into the namespace (optional) on_harvest • Apply the rule to studies harvested into the namespace (optional) on_upload • Apply the rule to studies uploaded into the namespace - flag (optional) on_manual_route • Apply this rule for a manually routed study- flag (optional) on_thin • Apply this rule to thin studies when they are created - flag (optional) no_re_run • Do not run this rule on a re-notification from storage - flag (optional) suspended • This rule is suspended and not applied - flag (optional) delay • Number of minutes to delay running this rule for after it is triggered (optional) delay_seconds • Number of seconds to delay running this rule for after it is triggered (optional) delay_till_schedule • Delay running this rule after it is triggered until the next scheduled time - flag (optional) other_namespaces • A comma separated list of the uuid of other namespaces to apply this rule to (optional) manual_roles • A comma separated list of the uuid of roles that can run the rule manually (optional) |
Returns |
status • OK |
Permission | route_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The route can not be found NOT_PERMITTED • You are not permitted to edit the route INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field INVALID_CONDITION • A condition is invalid. The error_subtype holds the condition INVALID_ACTION • An action is invalid. The error_subtype holds the error detail INVALID_OPTION • An option is invalid. The error_subtype holds the error detail INVALID_SCHEDULE • The schedule is invalid. The error_subtype holds the error detail INVALID_OTHER_NAMESPACES • The other_namespaces is invalid. The error_subtype holds the error detail INVALID_MANUAL_ROLES • The manual_roles is invalid. The error_subtype holds the error detail |
Notes | See the /route/add command notes for the format of the conditions and actions fields |
Description | Get a routing rule |
---|---|
URL | /route/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The route uuid |
Returns |
status • OK name • Name of the route namespace_id • uuid of the namespaces the route is associated with namespace_name • Name of the namespaces the route is associated with conditions • Route conditions as a JSON structure actions • Route actions as a JSON structure options • Route actions as a JSON structure schedule • Route schedule in JSON format on_share • Apply the rule to studies shared into the namespace - flag on_harvest • Apply the rule to studies harvested into the namespace - flag on_upload • Apply the rule to studies uploaded into the namespace - flag on_manual_route • Apply this rule for a manually routed study- flag on_thin • Apply this rule to thin studies when they are created - flag no_re_run • Do not run this rule on a re-notification from storage - flag suspended • This rule is suspended and not applied - flag delay • Number of minutes to delay running this rule for after it is triggered delay_seconds • Number of seconds to delay running this rule for after it is triggered delay_till_schedule • Delay running this rule after it is triggered until the next scheduled time - flag capture_email • Does an email need to be captured to run this rule - flag other_namespaces • A comma separated list of the uuid of other namespaces to apply this rule to manual_roles • A comma separated list of the uuid of roles that can run the rule manually |
Permission | route_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The route can not be found NOT_PERMITTED • You are not permitted to view the route |
Notes |
Description | Delete a routing rule |
---|---|
URL | /route/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The route uuid |
Returns |
status • OK |
Permission | route_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The route can not be found NOT_PERMITTED • You are not permitted to delete the route |
Notes |
Description | Test the matching on PHYSICIAN_ALIAS |
---|---|
URL | /route/physician/alias/match |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account to test in lv • The tag text to match against the PHYSICIAN_ALIAS rule. |
Returns |
status • OK users • An array of the users that matched the tag. Each object holds the fields from the /account/user/get call excluding the locations and groups fields |
Permission | route_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to do this |
Notes |
Account (organization) commands
Description | List the accounts the user belongs to |
---|---|
URL | /account/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) permissions • Flag to return the users role and permissions in the accounts (optional) |
Returns |
status • OK page • The pagination status hash accounts • An array of the accounts. Each object holds the following same fields as the /account/get call --- The following field fields are append to the account objects if the permissions flag is specified --- * permissions • The users permissions in the account * role_id • uuid of the users account role * role_name • Name of the users account role * default_role_id • uuid of the default account role * default_role_name • Name of the default account role |
Errors | |
Notes |
Description | Save an account |
---|---|
URL | /account/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account uuid name • Name of the account (optional) vanity • Vanity host name for the account. Multiple host names can be specified in a comma separate list (optional) password_expire • Number of days before account passwords expire. No expiration if zero. (optional) session_expire • Number of minutes before an idle session expires. (optional) must_approve • Flag if shared studies must be approved for the account namespace (optional) must_approve_upload • Flag if uploaded studies must be approved (optional) must_approve_harvest • Flag if harvested studies must be approved (optional) must_approve_move • Flag if moved studies must be approved (optional) no_share • Flag if studies can not be shared with this account (optional). Studies can still be shared with locations, groups and users in the account. can_request • Flag if user can request to join the account share_code • The share code of the account (optional) share_description • The share description of the account (optional) share_settings • Share settings JSON structure of the share display settings (optional) share_via_gateway • Flag if a gateway share is allowed (optional) hl7_template • The HL7 reporting template for the account (optional) search_threshold • The number of studies record in the namespace to switch the UI from list to search mode (optional) settings • A hash of the account settings (optional) setting_SETTING_NAME • Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional) css • Custom CSS for the account (optional) vendor • Vendor name (optional) role_id • Id for the default role for the account (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) |
Returns |
status • OK |
Permission | account_edit |
Errors |
NOT_FOUND • The object was not found. The error_subtype holds the name of field that triggered the error NOT_PERMITTED • You are not permitted to modify this record DUPLICATE_NAME • The account name is already taken DUPLICATE_VANITY • The vanity host name is already taken. The error_subtype holds the taken hostname INVALID_VANITY • The vanity host name is invalid. The error_subtype holds the invalid hostname INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag DUP_SHARE_CODE • The share code is already used INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details INVALID_INTEGER • An invalid integer was passed. The error_subtype holds the name of the invalid integer INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field ROLE_NAMESPACE_MISMATCH, subtype INCOMPATIBLE_ROLE, data contains role_id and namespace_id • The role cannot be used for the account |
Notes |
|
Description | Get an account |
---|---|
URL | /account/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account uuid permissions • Flag to return the users role and permissions in the accounts (optional) brand_settings • A comma delimited list of the settings from /brand/get for this vanity to return (optional) |
Returns |
status • OK uuid • Account uuid name • Name of the account vanity • Vanity host name(s) for the account password_expire • Number of days before account passwords expire. session_expire • Number of minutes before an idle session expires. namespace_id • Namespace of the account must_approve • Flag if shared studies must be approved must_approve_upload • Flag if uploaded studies must be approved must_approve_harvest • Flag if harvested studies must be approved must_approve_move • Flag if moved studies must be approved no_share • Flag to stop sharing into this namespace can_request • Flag if user can request to join the account share_code • The share code of the account share_description • The share description of the account share_settings • Share settings JSON structure of the share display settings share_via_gateway • Flag if a gateway share is allowed hl7_template • The HL7 reporting template for the account search_threshold • The number of studies record in the namespace to switch the UI from list to search mode css • The account CSS settings vendor • Vendor name role_id • Id of the default role for the account role_name • Name of the default role for the account settings • A hash of the account settings and brand settings (returned as brand_(SETTING NAME) connected • Flag if they are connected to a payment processor tags • An array of user tags associated with this object (This is only returned if the object has tags) customfields • An array of the custom fields associated with this account. Each object has the following fields (This is only returned if the group has custom fields) --- The following field fields are returned if the permissions flag is specified --- * permissions • The users permissions in the account * role_id • uuid of the users account role * role_name • Name of the users account role * default_role_id • uuid of the default account role * default_role_name • Name of the default account role * has_activity_permission • Flag if the user has activity permissions within the account |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found |
Notes |
Description | Add a user to an account |
---|---|
URL | /account/user/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account uuid (email|user_id) • The email address or uuid of the user to add role_id • uuid of the users role in the account (optional). account_email • Users account_email. Only set this if it is different than the users login email (optional). account_alias • Users alias in the account. (optional). account_login • Users login name in the account. (optional). account_password • Password for the account_password. (optional). password_reset • Flag if the password needs to be reset. (optional). global • Flag if this is a global user (optional). epic_user • Epic user used to map Epic users into Ambra's ones to track activity. (optional). session_expire • Number of minutes before an idle session expires. (optional) max_sessions • Over-ride value for the max number of simultaneous sessions the user can have. (optional). set_default_organization • A flag to set this account as a default one for the user using user_default_organization Setting. (optional) sso_only • Flag if the user can only login via SSO. (optional). event_share • Notify the user on a share into the account namespace (optional) event_approve • Notify the user on a approval needed into the account namespace (optional) event_upload • Notify the user on an upload into the account namespace (optional) event_upload_fail • Notify the user on a failed upload into the account namespace (optional) event_harvest • Notify the user on a harvest into the account namespace (optional) event_join • Notify the user on a join request for the account (optional) event_purge • Notify the user the results of a purge job for the account (optional) event_new_report • Notify the user when a report is attached in the account namespace (optional) event_report_remove • Notify the user when a report is removed in the account namespace (optional) event_study_comment • Notify the user when a comment is attached to a study in the namespace (optional) event_status_change • Notify the user when the status of a study is changed (optional) event_message • Notify the user when a message is sent to the account namespace (optional) event_node • Notify the user when an account node sends an event (optional) event_link • Notify the user when an anonymous link is hit in the namespace (optional) event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace (optional) event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds (optional) event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails (optional) event_case_assignment • Notify the user when they are assigned a case as a medical or admin user (optional) event_incoming_study_request • Notify the user when they get an incoming study request (optional) settings • A hash of the account settings that the user can override (optional) setting_SETTING_NAME • Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional) |
Returns |
status • OK uuid • uuid of the user |
Permission | account_user_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to add this user to the account USER_NOT_FOUND • The user can not be found ALREADY_EXISTS • The user is already a member of the account INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag DUPLICATE_NAME • The account_login is already in use BAD_PASSWORD • Password needs to be at least 8 characters long, contain at least two numbers, contain at least two characters and can't be one of your last three passwords INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details ROLE_NAMESPACE_MISMATCH, subtype INCOMPATIBLE_ROLE, data contains role_id and namespace_id • The role cannot be used for the account ROLE_NAMESPACE_MISMATCH, subtype GLOBAL_USER_WITH_RESTRICTED_ROLE, data contains role_id, namespace_id and user_id • They are adding a global user with a role restricted to group/location and there is a group/location in the account |
Notes |
|
Description | Edit the users account information |
---|---|
URL | /account/user/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account uuid user_id • The users uuid role_id • uuid of the users role in the account (optional). account_email • Users account_email. Only set this if it is different than the users login email (optional). account_alias • Users alias in the account. (optional). account_login • Users login name in the account. (optional). account_password • Password for the account_password. (optional). password_reset • Flag if the password needs to be reset. (optional). global • Flag if this is a global user. (optional). epic_user • Epic user used to map Epic users into Ambra's ones to track activity (optional). session_expire • Number of minutes before an idle session expires. (optional) max_sessions • Over-ride value for the max number of simultaneous sessions the user can have. (optional). sso_only • Flag if the user can only login via SSO. (optional). event_share • Notify the user on a share into the account namespace (optional) event_approve • Notify the user on a approval needed into the account namespace (optional) event_upload • Notify the user on an upload into the account namespace (optional) event_upload_fail • Notify the user on a failed upload into the account namespace (optional) event_harvest • Notify the user on a harvest into the account namespace (optional) event_join • Notify the user on a join request for the account (optional) event_purge • Notify the user the results of a purge job for the account (optional) event_new_report • Notify the user when a report is attached in the account namespace (optional) event_report_remove • Notify the user when a report is removed in the account namespace (optional) event_study_comment • Notify the user when a comment is attached to a study in the namespace (optional) event_status_change • Notify the user when the status of a study is changed (optional) event_message • Notify the user when a message is sent to the account namespace (optional) event_node • Notify the user when an account node sends an event (optional) event_link • Notify the user when an anonymous link is hit in the namespace (optional) event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace (optional) event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds (optional) event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails (optional) event_case_assignment • Notify the user when they are assigned a case as a medical or admin user (optional) event_incoming_study_request • Notify the user when they get an incoming study request (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) settings • A hash of the account settings that the user can override (optional) setting_SETTING_NAME • Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional) |
Returns |
status • OK |
Permission | account_user_edit or the user can set the event flags and custom fields for themselves |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to edit this user USER_NOT_FOUND • The user can not be found or is not a member of this account ROLE_NOT_FOUND • The role was not found or is not an account role INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag DUPLICATE_NAME • The account_login is already in use BAD_PASSWORD • Password needs to be at least 8 characters long, contain at least two numbers, contain at least two characters and can't be one of your last three passwords INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details CAN_NOT_PROMOTE • A user can not switch themselves to an admin role if they are currently not in an admin role NO_USER_OVERRIDE • The setting does not allow a user override ROLE_NAMESPACE_MISMATCH, subtype INCOMPATIBLE_ROLE, data contains role_id and namespace_id • The role cannot be used for the account ROLE_NAMESPACE_MISMATCH, subtype GLOBAL_USER_WITH_RESTRICTED_ROLE, data contains role_id, namespace_id and user_id • They are making the user global with a role restricted to group/location and there is a group/location in the account |
Notes |
|
Description | Get the users account information |
---|---|
URL | /account/user/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account uuid user_id • The users uuid |
Returns |
status • OK user_id • The user id user_name • The user name user_email • The users email address role_id • uuid of the users account role role_name • Name of the users account role disabled • Is the user disabled account_email • Email address for account usage account_alias • Users account alias account_login • Users login name in the account password_reset • Flag if the password needs to be reset user_account_id • Id linking user and account for external integrations global • Flag if this is a global user. epic_user • Epic user used to map Epic users into Ambra's ones to track activity. session_expire • Number of minutes before an idle session expires last_login • The users last login date and time max_sessions • Over-ride value for the max number of simultaneous sessions the user can have sso_only • Flag if the user can only login via SSO event_share • Notify the user on a share into the account namespace event_approve • Notify the user on a approval needed into the account namespace event_upload • Notify the user on an upload into the account namespace event_upload_fail • Notify the user on a failed upload into the account namespace event_harvest • Notify the user on a harvest into the account namespace event_join • Notify the user on a join request for the account event_purge • Notify the user the results of a purge job for the account event_new_report • Notify the user when a report is attached in the account namespace event_report_remove • Notify the user when a report is removed in the account namespace event_study_comment • Notify the user when a comment is attached to a study in the namespace event_status_change • Notify the user when the status of a study is changed event_message • Notify the user when a message is sent to the account namespace event_node • Notify the user when an account node sends an event event_link • Notify the user when an anonymous link is hit in the namespace event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds (optional) event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails (optional) event_case_assignment • Notify the user when they are assigned a case as a medical or admin user (optional) event_incoming_study_request • Notify the user when they get an incoming study request groups • An array of the accounts groups the user is a member of locations • An array of the accounts locations the user is a member of. Both of these contain the following fields. * uuid • uuid of the group/location * name • name of the group/location * role_id • uuid of the role in the group/location * role_name • name of the role in the group/location tags • An array of user tags associated with this object (This is only returned if the object has tags) customfields • An array of the custom fields associated with this user. Each object has the following fields (This is only returned if the user has custom fields) settings • A hash of the account settings that the user has overridden |
Permission | account_user_view or the user can get the information for themselves |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found USER_NOT_FOUND • The user can not be found or is not a member of this account |
Notes |
Description | Delete a user from the account |
---|---|
URL | /account/user/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account uuid user_id • The user uuid |
Returns |
status • OK |
Permission | account_user_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to delete this user USER_NOT_FOUND • The user can not be found or is not a member of this account |
Notes | The user will also be deleted from all groups and locations in the account |
Description | List the users in an account |
---|---|
URL | /account/user/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account uuid filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Permission | account_user_view or case_edit |
Returns |
status • OK page • The pagination status hash users • An array of the users. Each object holds the fields from the /account/user/get call excluding the locations and groups fields |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to list the users in this account |
Notes |
Description | Build a user login report |
---|---|
URL | /account/user/report/login |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account uuid user_id • Limit to this user_id (optional) |
Permission | account_user_view |
Returns |
status • OK report_id • The report id |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to list the users in this account |
Notes | This call will kick off the building of the report. Poll for the report status with /report/status command and download it with the /report/zip command. |
Description | Set a rule on who can share with whom |
---|---|
URL | /account/can/share |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id by_type • The type of object that can share. (user|account|group|location) by_id • The uuid of the object that can share with_type • The type of object that they can share with (user|account|group|location) with_id • The uuid of the object that they can share with |
Returns |
status • OK |
Permission | account_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to perform this action BY_NOT_FOUND • The "by" object can not be found WITH_NOT_FOUND • The "with" object can not be found INVALID_TYPE • The type of object is invalidate. The error_subtype holds the type that is invalid |
Notes |
Description | Stop a account share rule |
---|---|
URL | /account/can/share/stop |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id by_type • The type of object that can share. (user|account|group|location) by_id • The uuid of the object that can share with_type • The type of object that they can share with (user|account|group|location) with_id • The uuid of the object that they can share with |
Returns |
status • OK |
Permission | account_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to perform this action BY_NOT_FOUND • The "by" object can not be found WITH_NOT_FOUND • The "with" object can not be found INVALID_TYPE • The type of object is invalidate. The error_subtype holds the type that is invalid |
Notes |
Description | Get a list of the account share rules |
---|---|
URL | /account/can/share/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id |
Returns |
status • OK rules • An array of the account share rules. Each rule holds the following fields. * by_type • The type of object that can share. (user|account|group|location) * by_id • The uuid of the object that can share * by_name • The name of the object that can share * with_type • The type of object that they can share with (user|account|group|location) * with_id • The uuid of the object that they can share with * with_name • The name of the object that they can share with |
Permission | account_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to perform this action |
Notes |
Description | Get any customized css for the account |
---|---|
URL | /account/css |
Parameters |
(account_id|vanity) • The account_id or vanity name to get the css for (optional) |
Returns | A CSS file |
Errors | |
Notes |
Description | Get the settings for an account |
---|---|
URL | /account/settings |
Parameters |
sid • The session id (optional if not passed then only un-authenticated settings are returned) (account_id|vanity) • The account_id or vanity name to get the settings for settings • A comma delimited list of the settings to return (optional) brand_settings • A comma delimited list of the settings from /brand/get for this vanity to return (optional) namespace_id • Apply overrides for the namespace (optional) |
Returns |
status • OK settings • A hash of the account settings, brand settings (returned as brand_(SETTING NAME), and vanity registration customfields if defined |
Errors |
NOT_FOUND • The account or namespace can not be found |
Notes |
Description | Validate settings for an account |
---|---|
URL | /account/settings/validate |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account uuid settings • A hash of the account settings with values to validate (optional) setting_SETTING_NAME • Validate an individual setting. This is an alternative to the settings hash (optional) |
Returns |
status • OK |
Errors |
NOT_FOUND • The account or namespace can not be found INVALID_SETTING • An invalid setting was passed. The error_subtype holds the name of the invalid setting INVALID_SETTING_VALUE • An invalid setting value was passed. The error_subtype holds the name of the setting with the invalid value |
Notes |
|
Description | Connect the account to the payment processor |
---|---|
URL | /account/connect |
Parameters |
sid • The session id uuid • The account_id code • The OAuth code |
Returns |
status • OK |
Permission | account_edit |
Errors |
NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to do this TOKEN_FAILED • The OAuth code did not return a valid token from the processor |
Notes |
Description | Return a counter value for the passed MD5 value |
---|---|
URL | /account/md5/counter |
Parameters |
(sid || node_id && serial_no) • Either a sid or the node id and serial number uuid • UUID of the account (only needed for sid authentication) md5 • The MD5 value |
Returns |
status • OK counter • The numeric counter value |
Errors |
NOT_FOUND • The account can not be found or the user is not a part of it |
Notes | If the MD5 does not exist for the account a new counter value will be created. If it does exist the old counter value will be returned. |
Description | List the accounts that are allowed to be requested for a study |
---|---|
URL | /account/list/requestable |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) namespace_id • Id of the namespace to receive requested studies into |
Returns |
status • OK accounts • An array of the accounts. Each object holds the following fields: uuid, name |
Permission |
study_request_edit |
Errors |
NOT_FOUND • The namespace can not be found NOT_PERMITTED • You are not allowed to list requestable accounts NOT_ENABLED • The study request feature is not enabled |
Notes |
|
Location commands
Description | List the locations for an account |
---|---|
URL | /location/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash locations • An array of the locations. Each object holds the following same fields as the /location/get call |
Permission | location_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view this list |
Notes |
Description | Add a location |
---|---|
URL | /location/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) name • Name of the location account_id • uuid of the account must_approve • Flag if shared studies must be approved for the location (optional) must_approve_upload • Flag if uploaded studies must be approved (optional) must_approve_harvest • Flag if harvested studies must be approved (optional) must_approve_move • Flag if moved studies must be approved (optional) no_share • Flag if studies can not be shared with this location (optional). Studies can still be shared with users in the location. share_code • The share code of the location (optional) share_description • The share description of the location (optional) share_settings • Share settings JSON structure of the share display settings (optional) share_via_gateway • Flag if a gateway share is allowed (optional) hl7_template • The HL7 reporting template for the location (optional) search_threshold • The number of studies record in the namespace to switch the UI from list to search mode (optional) role_id • Id for the default role for the location (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) |
Returns |
status • OK uuid • The uuid namespace_id • The association namespace uuid |
Permission | location_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields ACCOUNT_NOT_FOUND • The account was not found NOT_FOUND • The object was not found. The error_subtype holds the name of field that triggered the error NOT_PERMITTED • You are not permitted to add a location to the account INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag DUP_SHARE_CODE • The share code is already used INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field ROLE_NAMESPACE_MISMATCH, subtype INCOMPATIBLE_ROLE, data contains role_id and namespace_id • The role cannot be used for a location ROLE_NAMESPACE_MISMATCH, subtype GLOBAL_USER_WITH_RESTRICTED_ROLE, data contains role_id and user_id • You are adding the location to the account with a global user with restricted role |
Notes |
Description | Save a location |
---|---|
URL | /location/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The location uuid name • Name of the location (optional) must_approve • Flag if shared studies must be approved for the location (optional) must_approve_upload • Flag if uploaded studies must be approved (optional) must_approve_harvest • Flag if harvested studies must be approved (optional) must_approve_move • Flag if moved studies must be approved (optional) no_share • Flag if studies can not be shared with this location (optional). Studies can still be shared with users in the location. share_code • The share code of the location (optional) share_description • The share description of the location (optional) share_settings • Share settings JSON structure of the share display settings (optional) share_via_gateway • Flag if a gateway share is allowed (optional) hl7_template • The HL7 reporting template for the location (optional) search_threshold • The number of studies record in the namespace to switch the UI from list to search mode (optional) role_id • Id for the default role for the location (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) |
Returns |
status • OK |
Permission | location_edit |
Errors |
NOT_FOUND • The object was not found. The error_subtype holds the name of field that triggered the error NOT_PERMITTED • You are not permitted to edit the location INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag DUP_SHARE_CODE • The share code is already used INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field ROLE_NAMESPACE_MISMATCH, subtype INCOMPATIBLE_ROLE, data contains role_id and namespace_id • The role cannot be used for locations |
Notes |
Description | Get a location |
---|---|
URL | /location/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The location uuid |
Returns |
status • OK uuid • The location uuid name • Name of the location namespace_id • namespace of the location must_approve • Flag if shared studies must be approved must_approve_upload • Flag if uploaded studies must be approved must_approve_harvest • Flag if harvested studies must be approved must_approve_move • Flag if moved studies must be approved no_share • Flag to stop sharing into this namespace share_code • The share code of the location share_description • The share description of the location share_settings • Share settings JSON structure of the share display settings share_via_gateway • Flag if a gateway share is allowed (optional) hl7_template • The HL7 reporting template for the location search_threshold • The number of studies record in the namespace to switch the UI from list to search mode (optional) tags • An array of user tags associated with this object (This is only returned if the object has tags) role_id • Id of the default role for the location role_name • Name of the default role for the location customfields • An array of the custom fields associated with this location. Each object has the following fields (This is only returned if the group has custom fields) |
Permission | location_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The location can not be found NOT_PERMITTED • You are not permitted to view this location |
Notes |
Description | Delete a location |
---|---|
URL | /location/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The location uuid |
Returns |
status • OK |
Permission | location_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The location can not be found NOT_PERMITTED • You are not permitted to delete the location NOT_EMPTY • The location still has studies in it |
Notes |
Description | Add or update a user to a location |
---|---|
URL | /location/user/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The location id user_id • Id of the user role_id • Id of the users role within the location (optional). If not passed the default location role will be assigned event_share • Notify the user on a share into the location namespace (optional) event_approve • Notify the user on a approval needed into the location namespace (optional) event_upload • Notify the user on an upload into the location namespace (optional) event_upload_fail • Notify the user on a failed upload into the location namespace event_harvest • Notify the user on a harvest into the location namespace (optional) event_new_report • Notify the user when a report is attached in the location namespace (optional) event_report_remove • Notify the user when a report is removed in the location namespace (optional) event_study_comment • Notify the user when a comment is attached to a study in the namespace (optional) event_status_change • Notify the user when the status of a study is changed (optional) event_message • Notify the user when a message is sent to the location namespace (optional) event_node • Notify the user when a location node sends an event (optional) event_link • Notify the user when an anonymous link is hit in the namespace (optional) event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace (optional) event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds (optional) event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails (optional) event_case_assignment • Notify the user when they are assigned a case as a medical or admin user (optional) event_incoming_study_request • Notify the user when they get an incoming study request (optional) no_physician_alias_share • Flag to exclude this location from a physician alias share (optional) |
Returns |
status • OK |
Permission | location_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The location can not be found NOT_PERMITTED • You are not permitted to edit the location ROLE_NAMESPACE_MISMATCH, subtype INCOMPATIBLE_ROLE, data contains role_id and namespace_id • The role cannot be used for locations USER_NOT_FOUND • The user was not found or is not in the account ROLE_NOT_FOUND • The role was not found or is not in the account INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag |
Notes |
Description | Remove a user from a location |
---|---|
URL | /location/user/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The location id user_id • The user id |
Returns |
status • OK |
Permission | location_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The location can not be found NOT_PERMITTED • You are not permitted to edit the location |
Notes |
Description | List the users in a location |
---|---|
URL | /location/user/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The location id filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash users • An array of the users. Each object holds the following fields * user_id • The user id * user_name • The user name * role_id • The users role id * role_name • The users role name * event_share • Notify the user on a share into the location namespace * event_approve • Notify the user on a approval needed into the location namespace * event_upload • Notify the user on an upload into the location namespace * event_upload_fail • Notify the user on a failed upload into the location namespace * event_harvest • Notify the user on a harvest into the location namespace * event_new_report • Notify the user when a report is attached in the location namespace * event_report_remove • Notify the user when a report is removed in the location namespace * event_study_comment • Notify the user when a comment is attached to a study in the namespace * event_status_change • Notify the user when the status of a study is changed * event_message • Notify the user when a message is sent to the location namespace * event_node • Notify the user when a location node sends an event * event_link • Notify the user when an anonymous link is hit in the namespace * event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace * event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds * event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails * event_case_assignment • Notify the user when they are assigned a case as a medical or admin user * event_incoming_study_request • Notify the user when they get an incoming study request * no_physician_alias_share • Flag to exclude this location from a physician alias share |
Permission | location_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The location can not be found NOT_PERMITTED • You are not permitted list the users at the location |
Notes |
Group commands
Description | List the groups for an account |
---|---|
URL | /group/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash groups • An array of the groups. Each object holds the following same fields as the /group/get call |
Permission | group_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view this list |
Notes |
Description | Add a group |
---|---|
URL | /group/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) name • Name of the group account_id • uuid of the account must_approve • Flag if shared studies must be approved for the group (optional) must_approve_upload • Flag if uploaded studies must be approved (optional) must_approve_harvest • Flag if harvested studies must be approved (optional) must_approve_move • Flag if moved studies must be approved (optional) no_share • Flag if studies can not be shared with this group (optional). Studies can still be shared with users in the group. share_code • The share code of the group (optional) share_description • The share description of the group (optional) share_settings • Share settings JSON structure of the share display settings (optional) share_via_gateway • Flag if a gateway share is allowed (optional) hl7_template • The HL7 reporting template for the group (optional) search_threshold • The number of studies record in the namespace to switch the UI from list to search mode (optional) role_id • Id for the default role for the group (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) |
Returns |
status • OK uuid • The uuid namespace_id • The association namespace uuid |
Permission | group_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields ACCOUNT_NOT_FOUND • The account was not found NOT_FOUND • The object was not found. The error_subtype holds the name of field that triggered the error NOT_PERMITTED • You are not permitted to add a group to that account INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag DUP_SHARE_CODE • The share code is already used INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field ROLE_NAMESPACE_MISMATCH, subtype INCOMPATIBLE_ROLE, data contains role_id and namespace_id • The role cannot be used for a group ROLE_NAMESPACE_MISMATCH, subtype GLOBAL_USER_WITH_RESTRICTED_ROLE, data contains role_id and user_id • You are adding the group to the account with a global user with restricted role |
Notes |
Description | Save a group |
---|---|
URL | /group/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The group uuid name • Name of the group (optional) must_approve • Flag if shared studies must be approved for the group (optional) must_approve_upload • Flag if uploaded studies must be approved (optional) must_approve_harvest • Flag if harvested studies must be approved (optional) must_approve_move • Flag if moved studies must be approved (optional) no_share • Flag if studies can not be shared with this group (optional). Studies can still be shared with users in the group. share_code • The share code of the group (optional) share_description • The share description of the group (optional) share_settings • Share settings JSON structure of the share display settings (optional) share_via_gateway • Flag if a gateway share is allowed (optional) hl7_template • The HL7 reporting template for the group (optional) search_threshold • The number of studies record in the namespace to switch the UI from list to search mode (optional) role_id • Id for the default role for the group (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) |
Returns |
status • OK |
Permission | group_edit |
Errors |
NOT_FOUND • The object was not found. The error_subtype holds the name of field that triggered the error NOT_PERMITTED • You are not permitted to edit the location INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag DUP_SHARE_CODE • The share code is already used INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field ROLE_NAMESPACE_MISMATCH, subtype INCOMPATIBLE_ROLE, data contains role_id and namespace_id • The role cannot be used for groups |
Notes |
Description | Get a group |
---|---|
URL | /group/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The group uuid |
Returns |
status • OK uuid • The group uuid name • Name of the group namespace_id • Namespace of the group must_approve • Flag if shared studies must be approved must_approve_upload • Flag if uploaded studies must be approved must_approve_harvest • Flag if harvested studies must be approved must_approve_move • Flag if moved studies must be approved no_share • Flag to stop sharing into this group share_code • The share code of the group share_description • The share description of the group share_settings • Share settings JSON structure of the share display settings share_via_gateway • Flag if a gateway share is allowed (optional) hl7_template • The HL7 reporting template for the group search_threshold • The number of studies record in the namespace to switch the UI from list to search mode tags • An array of user tags associated with this object (This is only returned if the object has tags) role_id • Id of the default role for the group role_name • Name of the default role for the group customfields • An array of the custom fields associated with this group. Each object has the following fields (This is only returned if the group has custom fields) |
Permission | group_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The group can not be found NOT_PERMITTED • You are not permitted to view this group |
Notes |
Description | Delete a group |
---|---|
URL | /group/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The group uuid |
Returns |
status • OK |
Permission | group_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The group can not be found NOT_PERMITTED • You are not permitted to delete this group NOT_EMPTY • The group still has studies in it |
Notes |
Description | Add or update a user to a group |
---|---|
URL | /group/user/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The group id user_id • Id of the user role_id • Id of the users role within the group (optional). If not passed the default group role will be assigned event_share • Notify the user on a share into the group namespace (optional) event_approve • Notify the user on a approval needed into the group namespace (optional) event_upload • Notify the user on an upload into the group namespace (optional) event_upload_fail • Notify the user on a failed upload into the group namespace (optional) event_harvest • Notify the user on a harvest into the group namespace (optional) event_new_report • Notify the user when a report is attached in the group namespace (optional) event_report_remove • Notify the user when a report is removed in the group namespace (optional) event_study_comment • Notify the user when a comment is attached to a study in the namespace (optional) event_status_change • Notify the user when the status of a study is changed (optional) event_message • Notify the user when a message is sent to the group namespace (optional) event_node • Notify the user when a group node sends an event (optional) event_link • Notify the user when an anonymous link is hit in the namespace (optional) event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace (optional) event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds (optional) event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails (optional) event_case_assignment • Notify the user when they are assigned a case as a medical or admin user (optional) event_incoming_study_request • Notify the user when they get an incoming study request (optional) no_physician_alias_share • Flag to exclude this group from a physician alias share (optional) |
Returns |
status • OK |
Permission | group_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The group can not be found NOT_PERMITTED • You are not permitted to edit the group ROLE_NAMESPACE_MISMATCH, subtype INCOMPATIBLE_ROLE, data contains role_id and namespace_id • The role cannot be used for groups USER_NOT_FOUND • The user was not found or is not in the account ROLE_NOT_FOUND • The role was not found or is not in the account INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag |
Notes |
Description | Remove a user from a group |
---|---|
URL | /group/user/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The group id user_id • Id of the user |
Returns |
status • OK |
Permission | group_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The group can not be found NOT_PERMITTED • You are not permitted to edit the group |
Notes |
Description | List the users in a group |
---|---|
URL | /group/user/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The group id filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash users • An array of the users. Each object holds the following fields * user_id • The user id * user_name • The user name * role_id • The users role id * role_name • The users role name * event_share • Notify the user on a share into the group namespace * event_approve • Notify the user on a approval needed into the group namespace * event_upload • Notify the user on an upload into the group namespace * event_upload_fail • Notify the user on a failed upload into the group namespace * event_harvest • Notify the user on a harvest into the group namespace * event_new_report • Notify the user when a report is attached in the group namespace * event_report_remove • Notify the user when a report is removed in the group namespace * event_study_comment • Notify the user when a comment is attached to a study in the namespace * event_status_change • Notify the user when the status of a study is changed * event_message • Notify the user when a message is sent to the group namespace * event_node • Notify the user when a group node sends an event * event_link • Notify the user when an anonymous link is hit in the namespace * event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace * event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds * event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails * event_case_assignment • Notify the user when they are assigned a case as a medical or admin user * event_incoming_study_request • Notify the user when they get an incoming study request * no_physician_alias_share • Flag to exclude this group from a physician alias share |
Permission | group_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The group can not be found NOT_PERMITTED • You are not permitted list the group |
Notes |
Role commands
Description | List the roles for an account |
---|---|
URL | /role/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash roles • An array of the roles. Each object holds the following same fields as the /role/get call |
Permission | role_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view this list |
Notes |
Description | Add a role |
---|---|
URL | /role/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) name • Name of the role for_account • A flag that the role can be used in an account, default is on (optional) for_group • A flag that the role can be used in a group, default is on (optional) for_location • A flag that the role can be used in a location, default is on (optional) account_id • uuid of the account permissions • A hash of the role permissions (optional) settings • A hash of the role settings (optional) setting_SETTING_NAME • Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional) |
Returns |
status • OK uuid • The uuid |
Permission | role_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields ACCOUNT_NOT_FOUND • The account was not found NOT_PERMITTED • You are not permitted to add a role to that account INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field INVALID_PERMISSION • Invalid permission flag. The error_subtype holds the name of the permission flag. INVALID_PERMISSION_VALUE • The permission flag has an invalid value. The error_subtype holds the name of the permission flag. |
Notes | If permissions are not passed the role is given the default set of permissions |
Description | Save a role |
---|---|
URL | /role/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The role uuid name • Name of the role (optional) description • Description of the role (optional) for_account • A flag that the role can be used in an account (optional) for_group • A flag that the role can be used in a group (optional) for_location • A flag that the role can be used in a location (optional) permissions • A hash of the role permissions (optional) permission_PERMISSION_NAME • Set an individual permission. This is an alternative to the permissions hash for easier use in the API tester (optional) settings • A hash of the role settings (optional) setting_SETTING_NAME • Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional) |
Returns |
status • OK |
Permission | role_edit |
Errors |
NOT_FOUND • The role can not be found NOT_PERMITTED • You are not permitted to edit the role INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field INVALID_PERMISSION • Invalid permission flag. The error_subtype holds the name of the permission flag. INVALID_PERMISSION_VALUE • The permission flag has an invalid value. The error_subtype holds the name of the permission flag. NO_OTHER_ROLE_EDIT • No other role has role_edit permissions so you can not disable role_edit for this role |
Notes | The permissions hash does not need to be complete. It can include only the items you want to update or the entire set. |
Description | Get a role |
---|---|
URL | /role/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The role uuid |
Returns |
status • OK uuid • The role uuid name • Name of the role description • Description of the role. for_account • A flag that the role can be used in an account for_group • A flag that the role can be used in a group for_location • A flag that the role can be used in a location, type • Type of the role. If it is system generated this will be either admin or user permissions • The role permissions as a JSON hash |
Permission | role_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The role can not be found NOT_PERMITTED • You are not permitted to view this role |
Notes |
Description | Delete a role |
---|---|
URL | /role/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The role uuid |
Returns |
status • OK |
Permission | role_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The role can not be found NOT_PERMITTED • You are not permitted to delete this role IN_USE • The role is in use. The error_subtype holds a array of the objects that are using it |
Notes |
Description | Get the default permissions |
---|---|
URL | /role/default/permissions |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id (optional) |
Returns |
status • OK permissions • A hash of the permissions. Each key is a permission and the value list is the default admin/user values as per the permissions documentation |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
Notes |
Description | Build a detailed role report |
---|---|
URL | /role/report/detail |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id |
Returns |
status • OK report_id • The report id |
Permission | role_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account was not found NOT_PERMITTED • You are not permitted to run this report REPORT_ERROR • Unable to start the report |
Notes | This call will kick off the building of the report. Poll for the report status with /report/status command and download it with the /report/zip command. |
Activity commands
Description | List the activities for the user |
---|---|
URL | /activity/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • Limit to activities in this account and the personal activities filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) strict_account_filter • Flag to apply the account_id to personal activites as well (optional) study_extra • Flag to return extra study fields (optional) |
Returns |
status • OK page • The pagination status hash activities • An array of the activities. Each object holds the same fields as the /activity/get call |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
Notes |
Description | Count the activities for the user |
---|---|
URL | /activity/list/count |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • Limit to activities in this account and the personal activities filter.* Filters (optional) |
Returns |
status • OK count • Count of the activities |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields RUNNING • This call is currently runnning for the user |
Notes |
Description | Get the activity |
---|---|
URL | /activity/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The activity uuid study_extra • Flag to return extra study fields (optional) |
Returns |
status • OK uuid • The activity uuid created • The date and time the activity was created. created_by • The name of the user who created the activity. type • Type of activities. Based on the type different fields are returned as follows
|
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The activity was not found NOT_PERMITTED • You are not permitted to access this activity |
Notes |
|
Description | Delete an activity |
---|---|
URL | /activity/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The activity uuid |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The activity was not found NOT_PERMITTED • You are not permitted to delete this activity |
Notes |
Audit commands
Description | Audit the changes to an object |
---|---|
URL | /audit/object |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The uuid of the object to audit filter.* • Filters (optional) page.* Pagination (optional) reverse • Flag to reverse the default sort order (optional) download • Flag to create a zipped CSV file. A report_id will be returned and the file can be accessed via /report/status and /report/zip (optional) customfield_detail • Flag to include the customfield name in the detail (optional) |
Returns |
status • OK report_id • The report id if the download flag was set. The rest of the parameters will not be returned (optional) page • The pagination status hash events • An array of the events associated with this object. Each object in the array will have the following fields * uuid • uuid of the object * action • The type of change or event * what • Name of the object the action was on * who • Name of the user who did this * proxy • Name of the proxy user who did this if the action was done by a proxy * when • Date and time * type • Type of object the action was on * detail • Details - see the notes * with • If this event involves another entity (e.g. a share) this field will exist and have the name of the other entity (optional) * track • A JSON hash of tracking keys and values if tracking is applied to this event (optional) * client_address • IP address that performed the action * sid • sid that performed the action |
Permission | audit_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to access this object NOT_FOUND • The object was not found |
Notes |
|
Description | Audit what a user has done in an account |
---|---|
URL | /audit/user |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) user_id • The id of the user to audit account_id • The id of the account page.* Pagination (optional) filter.* Filters (optional) reverse • Flag to reverse the default sort order (optional) study_fields • JSON list of study fields to include in the response (optional) download • Flag to create a zipped CSV file. A report_id will be returned and the file can be accessed via /report/status and /report/zip (optional) |
Returns |
status • OK report_id • The report id if the download flag was set. The rest of the parameters will not be returned (optional) page • The pagination status hash events • An array of the events associated with this object. Each object in the array will have the following fields * uuid • uuid of the object * action • The type of change or event * what • Name of the object the action was on * who • Name of the user who did this * proxy • Name of the proxy user who did this if the action was done by a proxy * when • Date and time * type • Type of object the action was on * detail • Details - see the notes in /audit/object * with • If this event involves another entity (e.g. a share) this field will exist and have the name of the other entity (optional) * track • A JSON hash of tracking keys and values if tracking is applied to this event (optional) * client_address • IP address that performed the action * sid • sid that performed the action * study • A JSON hash of study fields for study events. Returned only if study_fields are provided in the parameters |
Permission | audit_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to access this user record NOT_FOUND • The user was not found |
Notes |
|
Description | Audit all events in an account |
---|---|
URL | /audit/account |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The id of the account filter.* • Filters (optional) page.* • Pagination (optional) reverse • Flag to reverse the default sort order (optional) download • Flag to create a zipped CSV file. A report_id will be returned and the file can be accessed via /report/status and /report/zip (optional) |
Returns |
status • OK report_id • The report id if the download flag was set. The rest of the parameters will not be returned (optional) page • The pagination status hash events • An array of the events associated with this object. Each object in the array will have the following fields * uuid • uuid of the object * action • The type of change or event * what • Name of the object the action was on * who • Name of the user who did this * proxy • Name of the proxy user who did this if the action was done by a proxy * when • Date and time * type • Type of object the action was on * detail • Details - see the notes in /audit/object * with • If this event involves another entity (e.g. a share) this field will exist and have the name of the other entity (optional) * track • A JSON hash of tracking keys and values if tracking is applied to this event (optional) * client_address • IP address that performed the action * sid • sid that performed the action |
Permission | audit_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to access this information NOT_FOUND • The account was not found |
Notes |
|
Description | Return deleted records |
---|---|
URL | /audit/deleted |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The id of the account type • The type of the object (Study|User etc.) page.* Pagination (optional) |
Returns |
status • OK page • The pagination status hash objects • An array of the objects . Each object in the array will have the following fields * uuid • uuid of the deleted object * who • Name of the user who deleted the object * proxy • Name of the proxy user who did this if the action was done by a proxy * when • Date and time * client_address • IP address that performed the action * sid • sid that performed the action |
Permission | audit_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to access this record |
Notes | Use the uuid to retrieve the full history from /audit/object |
Description | Log a message |
---|---|
URL | /audit/log |
Parameters |
sid • sid (optional) bucket • Name of the bucket to log to The rest of the parameters are logged to a message in the bucket |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_BUCKET • The bucket name can only contain A-z characters and must be between 4 and 16 characters long |
Notes |
Description | Get the failed login events |
---|---|
URL | /audit/failedlogins |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The id of the account from_time • Only return events after the epoch time (optional) |
Returns |
status • OK events • An array of the events. Each event is an array with the following fields * Epoch time of the event * LOCKOUT if the login failed due to the lockout or PRIMARY if the login failed due to invalid credentials * The vanity of the event * The client IP address * The rest of the fields hold the email and account information depending on the parameters used for /session/login |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to access this information NOT_FOUND • The account was not found |
Notes | Collection of this data needs to be enabled via the audit_failed_logins account switch |
Namespace commands
Description | Get the study permissions for the namespace |
---|---|
URL | /namespace/permissions |
Parameters |
(sid|uuid&serial_no) • Either the sid or the node id and serial number (namespace_id|study_id|study_uid && storage_namespace && phi_namespace) The uuid of the namespace or study or the study_uid/storage_namespace/phi_namespace triplet oauth • Flag to return the OAuth token information for the user (optional) |
Returns |
status • OK study_edit • The permission flag setting ↳ study_edit_approved • The permission flag setting ↳ study_edit_unapproved • The permission flag setting study_download • The permission flag setting study_browse • The permission flag setting study_share • The permission flag setting ↳ study_share_email • The permission flag setting ↳ study_share_share_code • The permission flag setting ↳ study_share_account • The permission flag setting ↳ study_share_location • The permission flag setting ↳ study_share_group • The permission flag setting ↳ study_share_user • The permission flag setting ↳ study_share_rsna • The permission flag setting ↳ study_share_npi • The permission flag setting ↳ study_share_request • The permission flag setting study_push • The permission flag setting study_delete • The permission flag setting study_approve • The permission flag setting study_view • The permission flag setting study_upload • The permission flag setting study_report_upload • The permission flag setting study_report_delete • The permission flag setting study_sync • The permission flag setting study_merge • The permission flag setting reports • A JSON array of the report ids they can view. This is not returned if they can view all reports oauth • A JSON hash containing the the OAuth token and ttl |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_CREDENTIALS • The sid or node credentials are invalid NOT_FOUND • The object was not found |
Notes |
Description | Set/get the settings for the namespace |
---|---|
URL | /namespace/settings |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The uuid of the namespace no_dup_share • Flag to stop duplicate studies (same study_uid and image count) from getting shared into the namespace study_field_flags • A JSON hash of study_field_* role values to override the role values for studies in the namespace ------ The following account settings can be over-ridden in the namespace ------ enable_dicom_wrapping • Value for the setting auto_enable_dicom_wrapping • Value for the setting single_file_dicom_wrapping • Value for the setting disable_duplicate_study_upload • Value for the setting force_new_study_on_upload • Value for the setting enable_multipart_uploader • Value for the setting allow_drag_and_drop_in_study_uploader • Value for the setting link_defaults • Value for the setting upload_settings • Value for the setting auto_create_patient • Value for the setting enable_epic_patient_lookup • Value for the setting ui_json • JSON for UI setting possible options: pixel_anonymize_color • Value for the setting priority_notifications • Value for the setting enable_namespace_ai_questions • Value for the setting disable_mobile_dicom_wrapping • Value for the setting enable_dicom_deidentification • Value for the setting try_update_original_study • Value for the setting must_approve_duplicate_study_uid • Value for the setting reverse_patient_name • Value for the setting And all the ai_* settings |
Returns |
status • OK no_dup_share • The setting value study_field_flags • The setting value ------ Account settings that have been over-ridden in the namespace ------ |
Permission | account_edit or ownership for a PHR namespace to modify the settings |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The namespace was not found INVALID_SETTING • An invalid setting was passed. The error_subtype holds the name of the invalid setting INVALID_SETTING_VALUE • An invalid setting value was passed. The error_subtype holds the name of the setting with the invalid value |
Notes |
Description | Validate and get the full description of a share code |
---|---|
URL | /namespace/share_code |
Parameters |
(share_code|namespace_id) • The share code or namespace id (sid || uuid && serial_no) • Either the sid or the node id and serial number (optional) |
Returns |
status • OK share_code • The share code share_description • The share description share_settings • Share settings JSON structure of the share display settings share_type • What are you sharing with (account|location|group|user) share_name • The name of what you are sharing with namespace_id • Namespace for the share code account_id • Id of the account currency • 3-letter ISO code for currency to charge in (optional - see notes) charge_description • The description of the charge (optional - see notes) second_opinion_share • Flag if this is a second opinion workflow (optional) second_opinion_config • JSON configuration for the second opinion workflow (optional) second_opinion_case • The second opinion case. The fields are per /case/get (optional) pricing • Pricing table in JSON format. (optional - see notes) customfields_pricing • Pricing table in JSON format. (optional - see notes) sum_price_matches • A flag to be used with customfields_pricing pricing table payment_processor • JSON hash of the payment processor information (optional) cc_description • A description of the users credit card on file (optional - see notes) enable_dicom_wrapping • Is dicom wrapping enabled for the associated account enable_dicom_deidentification • Is the dicom de-identification tool enabled for the associated account enable_dicomdir_scan • Is dicomdir scanning enabled for the associated account consolidate_wrapped_jpegs • Is consolidated wrapped jpegs enabled for the associated account upload_one_study • Only allow one study to be selected and uploaded render_wrapped_pdf • Value of the flag for the associated account render_wrapped_avi • Value of the flag for the associated account render_wrapped_video • Value of the flag for the associated account sr_render_css • Value of the flag for the associated account auto_wrap_images • Value of the flag for the associated account reencode_dicom_mp4 • Value of the flag for the associated account duplicate_study_check • Value of the flag for the associated account disable_duplicate_study_upload • Flag for the setting force_new_study_on_upload • Flag for the setting confirm_before_upload • Value of the flag for the associated account study_download_no_reports • Value of the flag for the associated account share_charge_by_modality • Charge shares (including second opinion) by modality of a shared study auto_enable_dicom_wrapping • Flag for the setting single_file_dicom_wrapping • Flag for the setting enable_multipart_uploader • Flag for the setting allow_drag_and_drop_in_study_uploader • Flag for the setting upload_select_none • Flag for the setting hide_help_tool • Flag for the setting is_production • Flag if this is a production site is_anonymous • Flag if this is an anonymous upload anonymize_rules • If the upload should anonymize the study this will hold the rules from the /namespace/anonymize calls dicom_tag_map • If the upload should anonymize the study this will hold the dicom tag to name map prompt_for_anonymize • Flag to prompt if the anonymization rules should be applied batch_encode_cine • Value of the flag for the associated account encapsulate_wrapped_pdf • Value of the flag for the associated account dicom_deidentification_at_ingress • Value of the flag for the associated account upload_settings • Value of the namespace setting customfields • An array of the custom fields that should be captured during the share process ordered by display_order. Each object has the following fields plus these additional fields. (This is only returned if the share has custom fields). If a sid is passed all custom fields for the namespace will be returned * capture_on_share_code • Should the field be capture on the share code * wrapped_dicom_only • Only capture for wrapped DICOM uploads * dicom_only • Only capture for non-wrapped DICOM uploads link_parameters • A JSON hash of any additional parameters generated by a link usage (optional) permissions • The namespace permissions |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The share code was not found or if gateway credentials are passed is not valid for gateway uploads INVALID_LINK • The anonymous upload link is no longer valid |
Notes |
Namespace share_settings is a JSON hash; keys are the action, value are specific to the action and defined here:
|
Description | Set/get the price for sharing with a namespace, also enable and configure the second opinion workflow |
---|---|
URL | /namespace/share/pricing |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The uuid of the namespace currency • 3-letter ISO code for currency to charge in (USD|GBP) (optional) charge_description • The description of the charge (optional) pricing • Pricing table in JSON format (optional) customfields_pricing • Pricing table in JSON format (optional) sum_price_matches • Flag to search for all matches in customfields_pricing table and to add them up (optional) second_opinion_share • Flag to enable/disable the second opinion workflow for the share (optional) second_opinion_config • JSON configuration for the second opinion workflow (optional) share_charge_by_modality • Charge shares (including second opinion) by modality of a shared study if this flag is set (optional) |
Returns |
status • OK currency • 3-letter ISO code for currency to charge in is_production • Flag if this is a production site charge_description • The description of the charge pricing • Pricing table in JSON format. customfields_pricing • Pricing table in JSON format. sum_price_matches • Flag to search for all matches in pricing table and to add them up second_opinion_share • Flag to enable/disable the second opinion workflow for the share second_opinion_config • JSON configuration for the second opinion workflow share_charge_by_modality • Charge shares (including second opinion) by modality of a shared study if this flag is set |
Permission | account_edit if setting account_view if getting |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to price this namespace NOT_FOUND • The namespace was not found INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field INVALID_INTEGER • The price is not an integer number INVALID_CONDITION • The pricing condition is invalid INVALID_FLAG • The field is not a valid flag NOT_LIST • The customfields_pricing table is not a JSON list NOT_HASH • The pricing field is not a hash INVALID_CURRENCY • Invalid currency NEEDS_ANY_OR_ALL • The hash needs an "ANY" or "ALL" key ONLY_ALL • If the hash has an ALL value it can't have any other values INVALID_AMOUNT • An invalid amount. The error_subtype holds the invalid amount |
Notes |
Pricing table
|
Description | Calculate price for sharing with this namespace. The price is calculated based on customfields, so it is useless for namespaces set up to charge by modality. |
---|---|
URL | /namespace/share/price |
Parameters |
uuid • The uuid of the namespace customfield-(CUSTOMFIELD_UUID) • Custom field(s) defined for the case (or study) account objects with values entered in the second opinion wizard (or in the image share screen) (optional) |
Returns |
status • OK price • Calculated price in pennies or null for no price match |
Errors |
NOT_FOUND • The namespace can not be found NOT_CUSTOMFIELDS_PRICING • The namespace is set up to charge by modality |
Notes |
|
Description | Set/get the anonymization rules for the namespace |
---|---|
URL | /namespace/anonymize |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The uuid of the namespace rules • Anonymization rules in JSON format. The format is a hash with the keys the names of the fields to anonymize and the values the regular expressions to apply. (optional) prompt_for_anonymize • Flag to prompt if the anonymization rules should be applied. Only applicable to ingress anonymization. (optional) |
Returns |
status • OK rules • The anonymization rules in JSON format. anonymize_at_ingress • If the anonymize at ingress feature is turned on this flag is returned prompt_for_anonymize • Flag to prompt if the anonymization rules should be applied. Only applicable to ingress anonymization dicom_tag_map • If the anonymize at ingress feature is turned on this map of field names to dicom tags is returned |
Permission | account_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to anonymize this namespace NOT_FOUND • The namespace was not found INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field NOT_HASH • The rules field is not a hash INVALID_FIELD_NAME • The field name is n the rules hash is invalid. The error_subtype holds the invalid field name INVALID_REGEXP • Invalid regular expression. The error_subtype holds the invalid regexp. |
Notes |
|
Description | Set/get the cover page template for the namespace |
---|---|
URL | /namespace/coverpage |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The uuid of the namespace coverpage • The coverpage value. See the notes for formatting details or pass an empty string to remove the current cover page. (optional) |
Returns |
status • OK coverpage • The coverpage value. |
Permission | account_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to do this NOT_FOUND • The namespace was not found |
Notes |
The coverpage value should be a JSON structure with Text::Template expressions for the key values. e.g.
\{ "title": "This is an outside study", "footer": "Dicomgrid.com", "uploadedDate": "{$created_at}", "uploadedBy": "{$created_by_name}", "studyInstanceUid": "{$study_uid}", "modality": "{$modality}", "accessionNumber": "{$accession_number}", "studyDescription": "{$study_description}", "studyDate": "{$study_date}" \} |
Description | Validate custom field values for a namespace |
---|---|
URL | /namespace/validate/customfields |
Parameters |
share_code • The share code customfield-CUSTOMFIELD_UUID • Custom field(s) |
Returns |
status • OK |
Errors |
INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details |
Notes |
Description | Set/get the event default values that are applied when a user is added to a namespace |
---|---|
URL | /namespace/event/defaults |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The uuid of the namespace event_share • Notify the user on a share into the namespace (optional) event_approve • Notify the user on a approval needed into the namespace (optional) event_upload • Notify the user on an upload into the namespace (optional) event_upload_fail • Notify the user on a failed upload into the namespace (optional) event_harvest • Notify the user on a harvest into the namespace (optional) event_new_report • Notify the user when a report is attached in the namespace (optional) event_report_remove • Notify the user when a report is removed in the namespace (optional) event_study_comment • Notify the user when a comment is attached to a study in the namespace (optional) event_status_change • Notify the user when the status of a study is changed (optional) event_message • Notify the user when a message is sent to the namespace (optional) event_node • Notify the user when a namespace node sends an event (optional) event_link • Notify the user when an anonymous link is hit in the namespace (optional) event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace (optional) event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds (optional) event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails (optional) event_case_assignment • Notify the user when they are assigned a case as a medical or admin user (optional) event_incoming_study_request • Notify the user when they get an incoming study request (optional) |
Returns |
status • OK event_share • Notify the user on a share into the namespace event_approve • Notify the user on a approval needed into the namespace event_upload • Notify the user on an upload into the namespace event_upload_fail • Notify the user on a failed upload into the namespace event_harvest • Notify the user on a harvest into the namespace event_new_report • Notify the user when a report is attached in the namespace event_report_remove • Notify the user when a report is removed in the namespace event_study_comment • Notify the user when a comment is attached to a study in the namespace event_status_change • Notify the user when the status of a study is changed event_message • Notify the user when a message is sent to the namespace event_node • Notify the user when a namespace node sends an event event_link • Notify the user when an anonymous link is hit in the namespace event_link_mine • Notify the user when an anonymous link created by the user is hit in the namespace event_thin_study_success • Notify the user when a thin study retrieval they initiated succeeds (optional) event_thin_study_fail • Notify the user when a thin study retrieval they initiated fails (optional) event_case_assignment • Notify the user when they are assigned a case as a medical or admin user (optional) event_incoming_study_request • Notify the user when they get an incoming study request |
Permission | account_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to apply defaults to this namespace NOT_FOUND • The namespace was not found INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag |
Notes |
Description | Set/get the study default values for the namespace |
---|---|
URL | /namespace/study/defaults |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The uuid of the namespace defaults • Default values in JSON format. The format is a hash with the keys the names of the fields and the values are the default value. The available field name are as listed in the returned field hash. (optional) |
Returns |
status • OK defaults • The default values in JSON format. fields • A hash of the fields that can have default values. The study fields have the DICOM tag as the value and the custom fields have the field name as the value. |
Permission | account_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to apply defaults to this namespace NOT_FOUND • The namespace was not found INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field NOT_HASH • The rules field is not a hash INVALID_FIELD_NAME • The field name in the default hash is invalid. The error_subtype holds the invalid field name |
Notes |
|
Description | Get the FQDN for the storage engine |
---|---|
URL | /namespace/engine/fqdn |
Parameters |
(namespace_id|study_id|study_uid && storage_namespace && phi_namespace) • The uuid of the namespace or study or the study_uid/storage_namespace/phi_namespace triplet source • The source of the query (optional) |
Returns |
status • OK engine_fqdn • The FQDN of the storage engine to use engine_url • URL of the storage engine to use storage_namespace • Storage namespace to use |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The namespace was not found |
Notes |
Description | Build a report of the users who have been removed from the namespace |
---|---|
URL | /namespace/removed/user/report |
Parameters |
sid • The session id uuid • The UUID of the namespace account_id • The UUID of the account. A report will be produced for group, location and account namespaces of this account email • Optional email address to send the report to |
Returns |
status • OK report_id • The report id |
Permission | account_edit or sysadmin or support user |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The namespace was not found NOT_PERMITTED • You are not permitted to do this |
Notes |
Description | Ask an AI question for the namespace |
---|---|
URL | /namespace/question |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The namespace id question • The question to ask or a JSON array of questions to ask detail • Optional detail to pass through to the AI stack |
Returns |
status • OK |
Permission | group_edit, location_edit or account_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The namespace or question was not found. NOT_PERMITTED • You are not permitted to do this NODE_NOT_SETUP • A node needs to be attached to the namespace for this question IN_PROCESS • The question is currently in process |
Notes |
|
Description | Attach an audit action to a namespace |
---|---|
URL | /namespace/audit |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The id of the namespace action • The audit action (AI_ACTION) detail • Additional information |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found INVALID_ACTION • An invalid action was passed |
Notes |
help commands
Description | Get help |
---|---|
URL | /help/get |
Parameters |
sid • The session id key • The help key |
Returns |
status • OK text • The help text |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The help was not found |
Notes |
Description | Set help text |
---|---|
URL | /help/set |
Parameters |
sid • The session id of a system administrator or account support user key • The help key text • The help text |
Returns |
status • OK |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_SYSADMIN_OR_SUPPORT • The user is not a sysadmin or support user |
Notes |
Terminology commands
Description | List terminology overrides for the account |
---|---|
URL | /terminology/account/overrides |
Parameters |
sid • The session id of a system administrator or account administrator (account_id || vanity || study_uid && storage_namespace && phi_namespace) • The uuid or vanity name of the account or study triplet to apply any account overrides for (optional) |
Returns |
status • OK tags • An array of hashes of tags * tag • The tag * val • The value of the tag * language • The language of the tag * vanity • The vanity of the tag |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account or vanity was not found |
Notes | If a tag is not overridden for the account or vanity it is not returned. |
Description | Get the terminology tags |
---|---|
URL | /terminology/tags |
Parameters |
tags • A comma separated list of the terminology tags to look up (optional) language • The ISO 639-1 language code (account_id || vanity || study_uid && storage_namespace && phi_namespace) • The uuid or vanity name of the account or study triplet to apply any account overrides for (optional) |
Returns |
status • OK values • A hash of the tags and their values |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
Notes | If a tag does not have a value in the database the tag is not returned |
Description | Set terminology values |
---|---|
URL | /terminology/set |
Parameters |
sid • The session id of a system administrator or account administrator tag • The tag to set language • The ISO 639-1 language code account_id • The uuid of the account to apply the tag for (optional) vanity • Vanity to apply the tag for (optional) value • The value of the tag. If this is empty the tag is deleted |
Returns |
status • OK |
Permission | account_edit or sysadmin |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_SYSADMIN_OR_SUPPORT • The user is not a sysadmin or support user and is trying to set global tags NOT_PERMITTED • The user is not an account administrator and is trying to set account tags NO_VALUE • The value parameter was not passed NOT_FOUND • The account was not found |
Notes |
Description | Get a list of the terminology tags |
---|---|
URL | /terminology/list |
Parameters |
tags • A comma separated list of the terminology tags to look up language • The ISO 639-1 language code (account_id|vanity) • The uuid or vanity name of the account to apply any account overrides for (optional) |
Returns |
status • OK tags • An array of hashes of tags * tag • The tag * val • The value of the tag * language • The language of the tag |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
Notes | If you pass in both a vanity and account_id the account/vanity override tags will be returned as well |
Description | Get the terminology in i18next format |
---|---|
URL | /terminology/i18next |
Parameters |
lng • The language code (account_id|vanity) • The uuid or vanity name of the account to apply any account overrides for (optional) |
Returns | The data in i18next format |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
Notes |
Analytics commands
Description | Get the study analytics |
---|---|
URL | /analytics/study |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (account_id|namespace_id) • The account or namespace to get the analytics for period • The time period (day|week|month|year) count • The number of periods to get end_date • The end date, default is today if not passed (optional) |
Returns |
status • OK current • The date and timestamp for how current the analytics data is periods • An array of the periods for earliest to latest each object in the array will have the following fields * start • Starting date of the period * end • Ending date of the period * label • Display label for the period * study_create • Number of studies created * study_create_harvest • Number of harvested studies created * study_create_upload • Number of uploaded studies created * study_create_share • Number of shared studies created * study_create_copy • Number of copied studies created * study_delete • Number of studies deleted * study_view • Number of studies viewed * study_report_view • Number of reports viewed * study_download • Number of studies downloaded * study_push • Number of studies pushed * study_share_out • Number of studies shared out of the account or namespace * study_share_in • Number of studies shared into the account or namespace * study_approve • Number of studies approved into the account or namespace * study_auto_approve • Number of studies auto approved into the account or namespace |
Permission | analytics_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_PARAMETERS • Only pass a account_id or namespace_id NOT_FOUND • The account or namespace can not be found NOT_PERMITTED • You are not permitted to view analytics for this account or namespace INVALID_PERIOD • An invalid period INVALID_END_DATE • An invalid period INVALID_COUNT• Invalid or excessive count value |
Notes |
Description | Get the patient portal analytics |
---|---|
URL | /analytics/patient/portal |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id patient_id • Patient filter (optional) period • The time period (day|week|month|year) count • The number of periods to get end_date • The end date, default is today if not passed (optional) |
Returns |
status • OK current • The date and timestamp for how current the analytics data is periods • An array of the periods for earliest to latest each object in the array will have the following fields * start • Starting date of the period * end • Ending date of the period * label • Display label for the period * study_view • Number of studies viewed * study_report_view • Number of reports viewed * study_download • Number of studies downloaded * study_share_out • Number of studies shared out of the account or namespace * login • Number of logins |
Permission | analytics_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account or patient can not be found NOT_PERMITTED • You are not permitted to view analytics for this account or namespace INVALID_PERIOD • An invalid period INVALID_END_DATE • An invalid period INVALID_COUNT • Invalid or excessive count value |
Notes |
Description | Get the radreport analytics |
---|---|
URL | /analytics/radreport |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id namespace_id • Namespace filter (optional) user_id • User filter (optional) period • The time period (day|week|month|year) count • The number of periods to get end_date • The end date, default is today if not passed (optional) |
Returns |
status • OK current • The date and timestamp for how current the analytics data is periods • An array of the periods for earliest to latest each object in the array will have the following fields * start • Starting date of the period * end • Ending date of the period * label • Display label for the period * radreport_create • Number of radreports created * radreport_delete • Number of radreports deleted * radreport_signed • Number of radreports signed * radreport_report_generated • Number of radreports generated * namespaces • A JSON array of unique namespaces covered by the period. Each array element is a hash with a id and name kv pair * users • A JSON array of unique users covered by the period. Each array element is a hash with a id and name kv pair |
Permission | analytics_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account or patient can not be found NOT_PERMITTED • You are not permitted to view analytics for this account or namespace INVALID_PERIOD • An invalid period INVALID_END_DATE • An invalid period INVALID_COUNT • Invalid or excessive count value |
Notes |
Description | Get the user analytics |
---|---|
URL | /analytics/user |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id namespace_id • Namespace filter (optional) user_id • User filter (optional) period • The time period (day|week|month|year) count • The number of periods to get end_date • The end date, default is today if not passed (optional) |
Returns |
status • OK current • The date and timestamp for how current the analytics data is periods • An array of the periods for earliest to latest each object in the array will have the following fields * start • Starting date of the period * end • Ending date of the period * label • Display label for the period * study_approve • Number of studies approved * study_reject • Number of studies rejected * study_upload_epic • Number of studies uploaded using Epic workflow * study_view • Number of studies viewed * namespaces • A JSON array of unique namespaces covered by the period. Each array element is a hash with a id and name kv pair * users • A JSON array of unique users covered by the period. Each array element is a hash with a id and name kv pair |
Permission | analytics_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account or patient can not be found NOT_PERMITTED • You are not permitted to view analytics for this account or namespace INVALID_PERIOD • An invalid period INVALID_END_DATE • An invalid period INVALID_COUNT • Invalid or excessive count value |
Notes |
Filter commands
Description | List the filters the user has |
---|---|
URL | /filter/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) type • The type of filter to list account_id • Limit to global filters and filters within the account namespaces filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash filters • An array of the filters the user has. Each object holds the following same fields as the /filter/get call |
Errors | |
Notes |
Description | Add a filter |
---|---|
URL | /filter/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) name • The name of the filter type • The type of the filter configuration • The configuration as a JSON data structure |
Returns |
status • OK uuid • The filter uuid |
Errors | |
Notes |
The configuration can be either of these forms
|
Description | Get a filter |
---|---|
URL | /filter/get |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The filter uuid |
Returns |
status • OK name • The name of the filter type • The type of the filter configuration • The configuration as a JSON data structure owner • Flag if the user is the owner of this filter |
Errors |
NOT_FOUND • The filter can not be found |
Notes |
Description | Edit a filter |
---|---|
URL | /filter/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The filter uuid name • The name of the filter (optional) type • The type of the filter (optional) configuration • The configuration as a JSON data structure (optional) |
Returns |
status • OK uuid • The filter uuid |
Errors |
NOT_FOUND • The filter can not be found NOT_PERMITTED • You are not the owner of the filter |
Notes |
Description | Delete a filter |
---|---|
URL | /filter/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The filter uuid |
Returns |
status • OK |
Errors |
NOT_FOUND • The filter can not be found NOT_PERMITTED • You are not the owner of the filter |
Notes |
Description | Share a filter |
---|---|
URL | /filter/share |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The filter uuid (account_id|location_id|group_id|user_id) • uuid of the account, location, group or user to share this filter with |
Returns |
status • OK |
Errors |
NOT_FOUND • The filter or share object can not be found. The error_subtype holds a the name of the key that can not be found NOT_PERMITTED • You are not the owner of the filter or are not permitted to share a filter with the destination INVALID_PARAMETERS • Only pass a account_id or a location_id or a group_id or a user_id |
Notes |
Description | Stop sharing a filter |
---|---|
URL | /filter/share/stop |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The filter uuid (account_id|location_id|group_id|user_id) • uuid of the account, location, group or user to stop sharing this filter with |
Returns |
status • OK |
Errors |
NOT_FOUND • The filter can not be found NOT_PERMITTED • You are not the owner of the filter |
Notes |
Description | Get the filter shares |
---|---|
URL | /filter/share/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The filter uuid |
Returns |
status • OK account_id • A list of the account_id's the filter is shared with location_id • A list of the location_id's the filter is shared with group_id • A list of the group_id's the filter is shared with user_id • A list of the user_id's the filter is shared with |
Errors |
NOT_FOUND • The filter can not be found |
Notes |
Custom field commands
Custom fieldsDescription | List the custom fields for the account |
---|---|
URL | /customfield/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
Returns |
status • OK page • The pagination status hash customfields • An array of the customfields. Each object holds the following same fields as the /customfield/get call |
Permission | customfield_view or role_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view this list |
Notes |
Description | Add a custom field to the account |
---|---|
URL | /customfield/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account name • Name of the customfield object • The object to associate the customfield with (Study|User_account|Group|Location|Account|Patient|Case|Order|Appointment|Dicomdata) type • Type of the custom field (text|number|date|memo|select|multiselect|radio|checkbox|search) capture_on_share_code • Flag if the field should be captured during a share code exchange (only applicable to study fields) display_order • Integer to order how the fields should be displayed wrapped_dicom_only • Only capture for wrapped DICOM uploads during a share code exchange dicom_only • Only capture for non-wrapped DICOM uploads during a share code exchange required • Flag if the field is required options • Additional options in JSON format (optional) hl7_segment • Segment to map this field to in HL7 ORM messages. Valid values are (NTE|PID|PID1|PV1|PV2|OBR|DG1|OBX|CTI|BLG|ORC) (only applicable to study fields) (optional) hl7_field • Segment field number to map this field to in HL7 ORM messages. Valid values are 1 to 64. (only applicable to study fields) (optional) hl7_component • Component number to map this field to in HL7 ORM messages. Valid values are 1 to 64. (only applicable to study fields) (optional) load_hl7 • If this is set to a HL7 message type the value of this field will be updated from the hl7_segment, hl7_field and hl7_component from incoming HL7 messages of the matching message type (only applicable to study fields) (optional) load_hl7_filter • Filter token for the load_hl7 option (only applicable to study fields) (optional) dicom_tag • DICOM tag to map this field to. Format should be of form (1234,1234). (only applicable to study fields) (optional) other_dicom_tags • JSON array of other DICOM tags to map this field to. (only applicable to study fields) (optional) load_dicom_tag • Flag to load the current value from the study into this field. (only applicable if a dicom_tag is specified) (optional) dicom_tag_ignore_empty • Flag to not map an empty custom field to the DICOM tag. (only applicable if a dicom_tag is specified) (optional) load_from_sr • Load the value from the structured reports in the study (only applicable to study fields) .(optional) field_flag • Default customfield flag (optional) |
Returns |
status • OK uuid • uuid of the customfield |
Permission | customfield_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to add a customfield to this account INVALID_TYPE • An invalid type was passed. INVALID_OBJECT • An invalid object was passed. INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field INVALID_OPTIONS • An option is invalid. The error_subtype holds the specific error message INVALID_HL7_OBJECT • HL7 fields can only be applied to study fields INVALID_HL7_SEGMENT • Invalid segment name INVALID_DICOM_TAG_OBJECT • DICOM tags can only be applied to study fields INVALID_DICOM_TAG • The DICOM tag is invalid INVALID_SEARCH_SOURCE • An invalid search source was passed. NO_DICOM_TAG_DEFINED • The load_dicom_tag flag is set but the dicom_tag field is not defined |
Notes |
|
Description | Edit a custom field |
---|---|
URL | /customfield/set |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the customfield name • Name of the customfield (optional) capture_on_share_code • Flag if the study type field should be captured during a share code exchange (optional) display_order • Integer to order how the fields should be displayed (optional) wrapped_dicom_only • Only capture for wrapped DICOM uploads during a share code exchange (optional) dicom_only • Only capture for non-wrapped DICOM uploads during a share code exchange (optional) required • Flag if the field is required (optional) options • Additional options in JSON format (optional) hl7_segment • Segment to map this field to in HL7 ORM messages. Valid values are (NTE|PID|PID1|PV1|PV2|OBR|DG1|OBX|CTI|BLG|ORC) (only applicable to study fields) (optional) hl7_field • Segment field number to map this field to in HL7 ORM messages. Valid values are 1 to 64. (only applicable to study fields) (optional) hl7_component • Component number to map this field to in HL7 ORM messages. Valid values are 1 to 64. (only applicable to study fields) (optional) load_hl7 • If this is set to a HL7 message type the value of this field will be updated from the hl7_segment, hl7_field and hl7_component from incoming HL7 messages of the matching message type (only applicable to study fields) (optional) load_hl7_filter • Filter token for the load_hl7 option (only applicable to study fields) (optional) dicom_tag • Dicom tag to map this field to. Format should be of form (1234,1234). (only applicable to study fields) (optional) other_dicom_tags • JSON array of other DICOM tags to map this field to. (only applicable to study fields) (optional) load_dicom_tag • Flag to load the current value from the study into this field. (only applicable if a dicom_tag is specified) (optional) dicom_tag_ignore_empty • Flag to not map an empty custom field to the DICOM tag. (only applicable if a dicom_tag is specified) (optional) load_from_sr • Load the value from the structured reports in the study. (only applicable to study fields) .(optional) field_flag • Default customfield flag (optional) |
Returns |
status • OK |
Permission | customfield_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The customfield can not be found NOT_PERMITTED • You are not permitted to edit the customfield INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field INVALID_OPTIONS • An option is invalid. The error_subtype holds the specific error message INVALID_HL7_OBJECT • HL7 fields can only be applied to study fields INVALID_HL7_SEGMENT • Invalid segment name INVALID_HL7_FIELD • Invalid field number INVALID_DICOM_TAG_OBJECT • DICOM tags can only be applied to study fields INVALID_DICOM_TAG • The DICOM tag is invalid NO_DICOM_TAG_DEFINED • The load_dicom_tag flag is set but the dicom_tag field is not defined |
Notes | See the /customfield/add command notes for the format of the options field |
Description | Delete a customfield |
---|---|
URL | /customfield/delete |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the customfield |
Returns |
status • OK |
Permission | customfield_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The customfield can not be found NOT_PERMITTED • You are not permitted to delete the customfield |
Notes |
Description | Lookup a custom field by name |
---|---|
URL | /customfield/lookup |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account name • Name of the customfield |
Returns |
status • OK uuid • Id of the customfield object • Object it is associated with type • Type of the customfield |
Permission | You need to be a member of the account |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The customfield can not be found NOT_PERMITTED • You are not permitted to do this |
Notes |
Description | Search and return the results for a search type customfield |
---|---|
URL | /customfield/search |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the customfield search • The value to search for (optional) |
Returns |
status • OK results • An array of the search results |
Permission | You need to be a member of the account |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The customfield can not be found NOT_PERMITTED • You are not permitted to do this NOT_A_SEARCH • This is not a search type of customfield |
Notes |
Webhook commands
Description | List the webhooks for the account |
---|---|
URL | /webhook/list |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account |
Returns |
status • OK webhooks • An array of the webhooks. Each object holds the following same fields as the /webhook/get call |
Permission | webhook_view |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view this list |
Notes |
Description | Add a webhook to the account |
---|---|
URL | /webhook/add |
Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account node_id • uuid of the node to proxy the webhook through (optional) name • Name of the webhook event • Event to call it on (See the notes for the available events) url • URL to call method • Method to call it with (POST|GET|POST_JSON|PUT) suspended • This webhook is suspended and not triggered (optional) parameters • A JSON object of the parameter names and values (optional) retry • Retry the webhook if it fails (optional) sid_user_id • UUID of the user to generate a sid as (optional) filter_field • Name of the study field to filter on (optional) filter_regexp • Regular expression to match the value of the filter_field against (optional) once • Flag that this webhook should only be run once for a specific study (optional) by_uid • Flag to expand the once search to include studies with the same study_uid (optional) by_accession_number • Flag to expand the once search to include studies with the same accession_number (optional) delay • Number of seconds to delay running this webhook for after it is triggered (optional) max_age • Ignore studies that are more than this number of days old based on the study_date (optional) auth • A JSON hash with the authentication details (optional) cron • Cron timing string for CRON events e.g 0 9 * * mon-fri (optional) |
Returns |
status • OK uuid • uuid of the webhook |
Permission | webhook_edit |
Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields ACCOUNT_NOT_FOUND • The account can not be found NODE_NOT_FOUND • The node can not be found USER_NOT_FOUND • The basic authentication user can not be found NOT_PERMITTED • You are not permitted to add a webhook to this account INVALID_METHOD • An invalid method was passed INVALID_EVENT • An invalid event was passed INVALID_JSON • The parameters field is not in valid JSON format. NOT_HASH • The parameter or auth field is not a hash. SID_USER_NOT_FOUND • The sid user can not be found SID_USER_NOT_IN_ACCOUNT • The sid user is not a member of this account INVALID_REGEXP • Invalid regular expression INVALID_FILTER_FIELD • Invalid filter field name INCOMPLETE_FILTER • Both a field and regexp are required INVALID_TRANSFORM_CONDITION • The transform condition is invalid SFDC_NOT_HASH • The SFDC auth value is not a JSON hash SFDC_JWT_NOT_HASH • The SFDC auth value is not a JSON hash SFDC_MISSING_FIELDS • Fields are missing for the SFDC auth hash SFDC_JWT_MISSING_FIELDS • Fields are missing for the SFDC auth hash FDC_JWT_INVALID_PRIVATE_KEY • The private key is invalid CUSTOM_NOT_HASH • The custom auth value is not a JSON hash INVALID_CRON • The cron value is invalid NOT_WITH_CRON • The delay or retry option can not be used for cron events |
Notes |
|