MISSING_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 | To filter by accession number use parameter like filter.accession_number_h->'917364'.equals=1 .
|
| 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 commands| Description | 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 (optional) 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) * created_at • Timestamp when the push job was created (if the destination is DICOM) * created_by_name • Name of the user who created the push job (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 * anonymize • A JSON hash of anonymization rules to apply to retrieved studies (optional) 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) xml • An array of the XML jobs to process |
| Errors |
MISSING_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 CONFLICTING_STATUS • This status conflicts with a prior status update |
| 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 | A study was anonymized by the gateway |
|---|---|
| URL | /node/study/anonymized |
| Parameters |
uuid • The node id serial_no • The serial number of the node old_study_uid • The old study uid new_study_uid • The new 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 a study_uid is anonymized prior to uploading the study to the storage. This call is needed to adjust actions scheduled on the study (shares, edits, etc). |
| 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 status • Status code of the job, S by default (S|F) - Success, failure (optional) studies • A JSON array of the studies found. Each object has the following fields (optional) * 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 INVALID_STATUS • An invalid status was passed |
| 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 status • Status code of the job, S by default (S|F) - Success, failure (optional) orders • A JSON array of the orders found. Each object has the following fields (optional) * 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 INVALID_STATUS • An invalid status was passed |
| 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 | Send XML to or from a node |
|---|---|
| URL | /node/xml |
| Parameters |
(sid || serial_no) • The session id or serial number of the node uuid • The node id xml • XML message |
| Returns |
status • OK |
| Permission | |
| Errors |
MISSING_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_XML • The XML does not parse FULL • The XML 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 destinations| Description | 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 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, DISTRIBUTING 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) distributed_destinations • A JSON array of destination ids. This list will be used to process requests in round robin manner. Meaningful for DISTRIBUTING destination type 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_search_mwl • Can this destination support searching a modality work list (optional) can_push_hl7 • Can this destination support pushong Hl7 messages (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 INVALID_DISTRIBUTED_DESTINATION • distributed_destinations configuration is invalid 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_search_mwl • Can this destination support searching a modality work list (optional) can_push_hl7 • Can this destination support pushong Hl7 messages (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) distributed_destinations • A JSON array of destination ids. This list will be used to process requests in round robin manner. Meaningful for DISTRIBUTING destination type 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 INVALID_DISTRIBUTED_DESTINATION • distributed_destinations configuration is invalid |
| 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_search_mwl • Can this destination support searching a modality work list can_push_hl7 • Can this destination support pushong Hl7 messages 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 distributed_destinations • A JSON array of destination ids. This list is used to process requests in round robin manner 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 study_request_id • uuid of a study request (optional) 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) refetch_study • Flag to refetch the search results when studies have been fetched already (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) customfield-{CUSTOMFIELD_UUID} • Custom field(s) will be set for the resultant studies after /destination/retrieve call (optional) customfield-'{CUSTOMFIELD_NAME}' • Custom field(s) to be set for the resultant studies. (optional) anonymize • A JSON hash of anonymization rules to apply to retrieved studies (optional) anonymize_{STUDY_FIELD} • The anonymization rules breakdown. This overrides the anonymize parameter if passed (optional) tracking_number • A UUID tracking number that can be used to pull a report against this search (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, namespace or study request can not be found NOT_PERMITTED • You are not permitted to search the destination NOT_SUPPORTED • The destination does not support searching a destination INVALID_FIELD_NAME • The field cannot be used in anonymization rules. The error_subtype holds the invalid field name. INVALID_REGEXP • Invalid anonymization rule regular expression. The error_subtype holds the invalid regexp. INSUFFICIENT_CRITERIA • Not enough search fields are populated CAN_NOT_TRACK • Tracking only works with the create_study option |
| Notes |
|
| Description | Generate a report against the tracking number of the search(s) |
|---|---|
| URL | /destination/search/report |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) tracking_number • The tracking number to report on email • Optional email address to send the report to |
| Returns |
status • OK report_id • The report id |
| 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 namespace was not found NOT_PERMITTED • You are not permitted to do this |
| 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) -- The following fields are used for the activity retrieve workflow --
activity_id • uuid of the DESTINATION_SEARCH activity to retrieve fromcustomfield-{CUSTOMFIELD_UUID} • Custom field(s) will be set for the study retrieved (optional) -- The following fields are used for the study request workflow --
study_request_found_id • UUID of a study request search results to retrieve and send as study request responsesend_method • The method to send a study as a study request response (share|duplicate) |
| 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 rules| Description | 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) only_re_run • Only 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) delay_from_study_field • Delay running this rule, start counting from this study's datetime field (optional) delay_from_study_seconds • Number of seconds to delay running this rule for after a timepoint defined by delay_from_study_field (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) only_re_run • Only 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) delay_from_study_field • Delay running this rule, start counting from this study's datetime field (optional) delay_from_study_seconds • Number of seconds to delay running this rule for after a timepoint defined by delay_from_study_field (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 only_re_run • Only 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 delay_from_study_field • Delay running this rule, start counting from this study's datetime field delay_from_study_seconds • Number of seconds to delay running this rule for after a timepoint defined by delay_from_study_field |
| 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 (optional) 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) site_management_account_id • The corresponding site management account (optional) |
| Returns |
status • OK |
| Permission | account_edit, sysadmin or support is required to set site_management_account_id |
| 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 (INCOMPATIBLE_ROLE) • The role cannot be used for the account, data contains role_id and namespace_id NOT_SITE_MANAGEMENT_ACCOUNT • The account passed in site_management_account_id does not have the enable_site_management setting enabled NOT_SYSADMIN_OR_SUPPORT • The user is not a sysadmin or support user |
| 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) site_management_account_id • The corresponding site management account --- 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). global_role_id • uuid of a role to be used in groups and locations when the global user is added to them, this role overrides groups'/locations' default roles (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) event_query_add • Notify the user when a new query is issued (optional) event_query_edit • Notify the user when a query is edited (optional) event_query_new_recipient • Notify the user when they are added to a query as a new recipient (optional) event_query_reply • Notify the user when they leave a new reply in a query (optional) event_site_qualified • Notify the user when a trial site is qualified for the clinical trial account (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) customfield-{CUSTOMFIELD_UUID} • Custom field(s) (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 (INCOMPATIBLE_ROLE) • The role cannot be used for the account, data contains role_id and namespace_id ROLE_NAMESPACE_MISMATCH (GLOBAL_USER_WITH_RESTRICTED_ROLE) • They are adding a global user with a role restricted to group/location and there is a group/location in the account, data contains role_id, namespace_id and user_id |
| 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). global_role_id • uuid of a role to be used in groups and locations when the global user is added to them, this role overrides groups'/locations' default roles (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) event_query_add • Notify the user when a new query is issued (optional) event_query_edit • Notify the user when a query is edited (optional) event_query_new_recipient • Notify the user when they are added to a query as a new recipient (optional) event_query_reply • Notify the user when they leave a new reply in a query (optional) event_site_qualified • Notify the user when a trial site is qualified for the clinical trial account (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 (INCOMPATIBLE_ROLE) • The role cannot be used for the account, data contains role_id and namespace_id ROLE_NAMESPACE_MISMATCH (GLOBAL_USER_WITH_RESTRICTED_ROLE) • They are making the user global with a role restricted to group/location and there is a group/location in the account, data contains role_id, namespace_id and user_id. |
| 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. global_role_id • uuid of a role to be used in groups and locations when the global user is added to them, this role overrides groups'/locations' default roles. 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 event_query_add • Notify the user when a new query is issued (optional) event_query_edit • Notify the user when a query is edited (optional) event_query_new_recipient • Notify the user when they are added to a query as a new recipient (optional) event_query_reply • Notify the user when they leave a new reply in a query (optional) event_site_qualified • Notify the user when a trial site is qualified for the clinical trial account (optional) 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 IN_USE • The user is a sid user for an account webhook |
| 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 |
| Notes |
|
| Description | Authorize the system to send out radreports |
|---|---|
| URL | /account/radreport/email/authorize |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The account id captcha_response • A solved captcha |
| Returns |
status • OK |
| Permission |
The requesting user should be a sysadmin of the account |
| Errors |
NOT_FOUND • The account can not be found NOT_PERMITTED • You are not the account's sysadmin NOT_ENABLED • The feature of sending radreports out is not enabled for the account CAPTCHA_FAILED • The captcha is not solved |
| 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 DUP_NAMESPACE_NAME • namespace_names_globally_unique is enabled and there is another namespace with the same name 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 (INCOMPATIBLE_ROLE) • The role cannot be used for a location, data contains role_id and namespace_id ROLE_NAMESPACE_MISMATCH (GLOBAL_USER_WITH_RESTRICTED_ROLE) • You are adding the location to the account with a global user with restricted role, data contains role_id and user_id |
| 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 DUP_NAMESPACE_NAME • namespace_names_globally_unique is enabled and there is another namespace with the same name 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 (INCOMPATIBLE_ROLE) • The role cannot be used for locations, data contains role_id and namespace_id |
| 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) event_query_add • Notify the user when a new query is issued (optional) event_query_edit • Notify the user when a query is edited (optional) event_query_new_recipient • Notify the user when they are added to a query as a new recipient (optional) event_query_reply • Notify the user when they leave a new reply in a query (optional) event_site_qualified • Notify the user when a trial site is qualified for the clinical trial account (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 (INCOMPATIBLE_ROLE) • The role cannot be used for locations, data contains role_id and namespace_id 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 CAN_NOT_PROMOTE • A user can not switch themselves to an admin role if they are currently not in an admin role |
| 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 * event_query_add • Notify the user when a new query is issued * event_query_edit • Notify the user when a query is edited * event_query_new_recipient • Notify the user when they are added to a query as a new recipient * event_query_reply • Notify the user when they leave a new reply in a query * event_site_qualified • Notify the user when a trial site is qualified for the clinical trial account * 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) site_id • The associated site id. Required in case require_site_id_for_groups account setting is set (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 DUP_NAMESPACE_NAME • namespace_names_globally_unique is enabled and there is another namespace with the same name 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 (INCOMPATIBLE_ROLE) • The role cannot be used for a group, data contains role_id and namespace_id ROLE_NAMESPACE_MISMATCH (GLOBAL_USER_WITH_RESTRICTED_ROLE) • You are adding the group to the account with a global user with restricted role, data contains role_id and user_id SITE_NOT_ALLOWED • The account is not listed in the site account's linked_study_accounts setting |
| 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) site_id • The associated site id. Required in case require_site_id_for_groups account setting is set (optional) site_qualified • Flag if the site is qualified for the trial (optional) site_inactive • Inactive flag to deactivate the site in a Trial Account (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 DUP_NAMESPACE_NAME • namespace_names_globally_unique is enabled and there is another namespace with the same name 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 (INCOMPATIBLE_ROLE) • The role cannot be used for groups, data contains role_id and namespace_id SITE_NOT_ALLOWED • The account is not listed in the site account's linked_study_accounts setting |
| 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) -- The following fields are returned when there is a site association for the group --