MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or namespace was not found. NOT_PERMITTED • You are not permitted to duplicate the study to this namespace ALREADY_EXISTS • The study already exists in the destination namespace FAILED • The storage call failed to run |
| Notes | This creates a full copy of the study as if it was uploaded into the namespace |
| Description | Split a study into multiple studies, one per series |
|---|---|
| URL | /study/split |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id namespace_id • The namespace id to split it into no_split • Do not split on the series just create a new study with a study UID |
| Returns |
status • OK |
| Permission | study_split for the study and study_upload for the destination namespace |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or namespace was not found. NOT_AVAILABLE • The study is not available. NOT_PERMITTED • You are not permitted to split the study to this namespace RECENT_NAMESPACE_SPLIT • The study was the result of a split in this namespace within the last 24 hours RUNNING • The split job is currently running |
| Notes |
| Description | Freeze or thaw a study |
|---|---|
| URL | /study/freeze |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id thaw • Flag to thaw a frozen study |
| Returns |
status • OK |
| Permission | study_freeze |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study NOT_AVAILABLE • The study is not available. NOT_PERMITTED • You are not permitted to freeze or thaw the study ALREADY • The study is already frozen or thawed |
| Notes |
|
| Description | Run a manual routing rule on a study |
|---|---|
| URL | /study/manual/route |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id route_id • The routing rule id email • The email to share with if the rule has a share_email action with the USER_ENTRY token (optional) message • The share message for the email share (optional) |
| Returns |
status • OK |
| Permission | study_manual_route |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or routing rule was not found. NOT_PERMITTED • You are not permitted to manually route the study ROUTE_NOT_MATCHED • The study does not match the route criteria INVALID_EMAIL • An invalid email address was passed |
| Notes |
| Description | Find matching HL7 orders for the study |
|---|---|
| URL | /study/find/order |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id (accession_number|patientid|patient_name) • The full or partial accession number, MRN or patient name to search by. If none are passed the studies accession number will be used (optional) page.* Pagination (optional) |
| Returns |
status • OK page • The pagination status hash orders • An array of the orders. Each order has the following fields * find_order_uuid • UUID of the search record * accession_number • Accession number * patientid • Patient MRN * patient_name • Patient name * patient_sex • Patient sex * patient_phone • Patient phone * patient_birth_date • Patient birth date * order_datetime • Date and time of the order * study_description • Study description * ordering_provider • Ordering provider |
| Permission | study_approve |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to find orders for this study |
| Notes |
|
| Description | Archive a study |
|---|---|
| URL | /study/archive |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id |
| Returns |
status • OK |
| Permission | study_delete and the study needs to be either the last copy or primary copy |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to do this ALREADY_THIN • This is already a thin study NO_FRESH_ARCHIVE • A fresh archive copy of the study does not exist |
| Notes |
| Description | Request that a thin study be retrieved and loaded into storage |
|---|---|
| URL | /study/retrieve |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to do this NOT_THIN • This is not a thin study MISSING_INFO • The study needs a study_uid and an accession number NO_QUERY_DESTINATION • No query retrieve destination for a node that creates phantoms is available |
| Notes |
| Description | Add a comment to the study |
|---|---|
| URL | /study/comment/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) study_id • The study id body • The comment body |
| Returns |
status • OK uuid • The comment uuid |
| Permission | study_comment_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to do this |
| Notes |
| Description | Delete a study comment |
|---|---|
| URL | /study/comment/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The comment id |
| Returns |
status • OK |
| Permission | study_comment_edit and you must be the creator of the comment |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The comment was not found. NOT_PERMITTED • You are not permitted to do this |
| Notes |
| Description | Get a study comment |
|---|---|
| URL | /study/comment/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The comment id |
| Returns |
status • OK uuid • Comment id study_id • Id of the study the comment is associated with user_id • Id of the user who created the comment user_name • Name of the user who created the comment body • The comment body created • Created datetime stamp of the comment is_mine • Flag if I created this comment |
| Permission | study_comment_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The comment was not found. NOT_PERMITTED • You are not permitted to do this |
| Notes |
| Description | Run a validation rule against the study |
|---|---|
| URL | /study/validate |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id validate_id • The validation id series • Only validate the specified series (optional) |
| Returns |
status • OK score • The validation score. The score is the number of conditions that failed conditions • An array of the conditions that failed |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or validation was not found. NOT_PERMITTED • You are not permitted to do this UNABLE_TO_VALIDATE • The study is not available or did not return the data needed to validate |
| Notes |
|
| Description | Attach a customfield report to the study |
|---|---|
| URL | /study/attach/customfields |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id report_name • The report name (optional defaults to customfields.txt) |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to do this NOT_AVAILABLE • The study is available |
| Notes | A text report with the names and values of the customfields for the study will be attached to the study |
| Description | Return the link to the external viewer for the study |
|---|---|
| URL | /study/external/viewer |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id redirect • A flag to return an HTTP redirect to the viewer URL rather than the JSON structure |
| Returns |
status • OK url • The url for the external viewer |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to do this NOT_AVAILABLE • The study is not available UNABLE_TO_GENERATE • The link could not be successfully generated |
| Notes |
| Description | Ask an AI question for the study |
|---|---|
| URL | /study/question |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id question • The question to ask or a JSON array of questions to ask detail • Optional detail to pass through to the AI stack |
| Returns |
status • OK |
| Permission | study_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or question was not found. NOT_PERMITTED • You are not permitted to do this NOT_ENABLED • The account does not have the ai_QUESTION customfield NODE_NOT_SETUP • A node needs to be attached to the study namespace for this question IN_PROCESS • The question is currently in process |
| Notes |
|
| Description | Load the DICOM data for a study |
|---|---|
| URL | /study/dicomdata/load |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id |
| Returns |
status • OK |
| Permission | study_view and dicomdata_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or question was not found. NOT_PERMITTED • You are not permitted to do this NOT_AVAILABLE • The study is not available in storage RUNNING • A load job is already running |
| Notes |
| Description | Record a timing event for the study |
|---|---|
| URL | /study/timing/event |
| Parameters |
(sid || node_id && serial_no) • Either the sid or the node uuid and serial number study_uid • The study uid storage_namespace • The storage namespace event • The event size • The number of bytes associated with the event (optional) |
| Returns |
status • OK |
| Permission | study_upload for sid authentication |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to do this |
| Notes |
| Description | Get the timing log for the study |
|---|---|
| URL | /study/timing/log |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK events • An array of the events. Each object has the following fields ** created • The time stamp for the event ** event • The description of the event ** size • The number of bytes associated with the event ** node_id • UUID of the associated node ** node_name • Name of the associated node |
| Permission | study_timing_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to do this |
| Notes |
| Description | Sync the study against the storage data and re-run routing rules |
|---|---|
| URL | /study/sync |
| Parameters |
(sid || node_id && serial_no) • Either the sid or the node id and serial number (study_id || study_uid && storage_namespace && phi_namespace) • The study id or the study_uid/storage_namespace/phi_namespace triplet image_count • Update the study image count and then sync (optional) |
| Returns |
status • OK |
| Permission |
sysadmin or study_sync permissions or if image_count is passed then study_upload or phr namespace is required |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to sync this study BLOCKED • This is a repeat sync which is not allowed |
| Notes |
|
Tag commands
| Description | List the tags |
|---|---|
| URL | /tag/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) object • Object class (Study|User_account|Group|Location|Account|Patient|Case|Order|Message) filter.* • Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK tags • An array of the tags |
| Errors | |
| Notes |
|
| Description | Add a tag to an object |
|---|---|
| URL | /tag/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) tag • Value of the tag object • Object class to apply it to (Study|User_account|Group|Location|Account|Patient|Case|Order|Message) object_id • UUID of the object |
| Returns |
status • OK |
| Permission | study_tag |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_OBJECT • The object type is invalid NOT_FOUND • The object was not found NOT_PERMITTED • You are not permitted to tag this object |
| Notes |
| Description | Delete a tag from an object |
|---|---|
| URL | /tag/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) tag • Value of the tag object • Object class to apply it to (Study|User_account|Group|Location|Account|Patient|Case|Order) object_id • UUID of the object |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_OBJECT • The object type is invalid NOT_FOUND • The object was not found |
| Notes |
Annotation commands
| Description | List the annotations |
|---|---|
| URL | /annotation/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (study_id|study_uid && storage_namespace && phi_namespace) The uuid of the study or the storage triplet |
| Returns |
status • OK annotations • An array of the annotations. Each object holds the same fields as the /annotation/get call |
| Permission | annotation_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to view the study of the annotations |
| Notes | The list command will return all annotation done on every version of the study. This will allow annotations to be viewed across shares. |
| Description | Add an annotation |
|---|---|
| URL | /annotation/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (study_id|study_uid && storage_namespace && phi_namespace) The uuid of the study or the storage triplet series_uid • The series uid instance_uid • The instance uid frame_number • The frame number (json|stamp) • The JSON annotation data structure or the stamp flag |
| Returns |
status • OK uuid • The uuid |
| Permission | annotation_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to add annotations to the study INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field |
| Notes |
| Description | Edit an annotation |
|---|---|
| URL | /annotation/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the annotation json • The JSON annotation data structure |
| Returns |
status • OK uuid • The uuid |
| Permission | annotation_edit and annotation ownership |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to add annotations to the study INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field |
| Notes |
| Description | Get the annotation |
|---|---|
| URL | /annotation/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the annotation |
| Returns |
status • OK uuid • Id of the annotation user_id • User who created the annotation user_name • The user name series_uid • The series uid instance_uid • The instance uid frame_number • The frame number json • The JSON annotation data structure stamp • The stamp flag |
| Permission | annotation_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The annotation was not found. NOT_PERMITTED • You are not permitted to view the annotation |
| Notes |
| Description | Delete the annotation |
|---|---|
| URL | /annotation/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the annotation |
| Returns |
status • OK |
| Permission | annotation_edit and annotation ownership |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The annotation was not found. NOT_PERMITTED • You are not permitted to delete the annotation |
| Notes |
Key image commands
| Description | List the key images |
|---|---|
| URL | /keyimage/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (study_id|study_uid && storage_namespace && phi_namespace) The uuid of the study or the storage triplet |
| Returns |
status • OK images • An array of the keyimages. Each object holds the same fields as the /keyimage/get call |
| Permission | keyimage_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to view the study or key images for the study |
| Notes | The list command will return all key images done on every version of the study. This will allow key images to be viewed across shares. |
| Description | Add a key image |
|---|---|
| URL | /keyimage/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (study_id|study_uid && storage_namespace && phi_namespace) The uuid of the study or the storage triplet series_uid • The series uid instance_uid • The instance uid frame_number • The frame number version • The frame version |
| Returns |
status • OK uuid • The uuid |
| Permission | keyimage_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to mark key images for the study |
| Notes |
| Description | Get the key image |
|---|---|
| URL | /keyimage/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the keyimage |
| Returns |
status • OK uuid • Id of the keyimage user_id • User who created the keyimage user_name • The user name series_uid • The series uid instance_uid • The instance uid frame_number • The frame number version • The frame version |
| Permission | keyimage_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The key image was not found. NOT_PERMITTED • You are not permitted to view the key image |
| Notes |
| Description | Delete the key image |
|---|---|
| URL | /keyimage/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the key image |
| Returns |
status • OK |
| Permission | keyimage_edit and key image ownership |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The key image was not found. NOT_PERMITTED • You are not permitted to delete the key image |
| Notes |
Study validation commands
| Description | List the validation rules |
|---|---|
| URL | /validate/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash validates • An array of the validates. Each object holds the same fields as the /validate/get call |
| Permission | validate_view or route_view or route_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to view the validation rule |
| Notes |
| Description | Add a validation rule |
|---|---|
| URL | /validate/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • The account id name • The validation rule name conditions • The validation conditions |
| Returns |
status • OK uuid • The uuid |
| Permission | validate_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to add validation rules NOT_FOUND • The object was not found. The error_subtype holds the type of the object INVALID_CONDITION • A condition is invalid. The error_subtype holds more detail |
| Notes |
|
| Description | Modify a validation rule |
|---|---|
| URL | /validate/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The validation id name • The validation rule name conditions • The validation conditions |
| Returns |
status • OK |
| Permission | validate_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The validation rule was not found NOT_PERMITTED • You are not permitted to add validation rules INVALID_CONDITION • A condition is invalid. The error_subtype holds more detail |
| Notes |
| Description | Get a validation rule |
|---|---|
| URL | /validate/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the validate |
| Returns |
status • OK name • Name of the rule conditions • The validation conditions |
| Permission | validate_view or route_view or route_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The validate was not found. NOT_PERMITTED • You are not permitted to view the validation rule |
| Notes |
| Description | Delete the validation rule |
|---|---|
| URL | /validate/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the validation rule |
| Returns |
status • OK |
| Permission | validate_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The validation rule was not found. NOT_PERMITTED • You are not permitted to delete the validation rule IN_USE • The validation rule is used in a routing rule |
| Notes |
Study DICOM data commands
| Description | List the DICOM data for studies |
|---|---|
| URL | /dicomdata/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (study_id|namespace_id) • uuid of the study or namespace to search filter.* Filters (optional) page.* Pagination (optional) dicom_tags • A JSON list of the DICOM tags to return (optional) |
| Returns |
status • OK page • The pagination status hash dicomdatas • An array of the dicom data objects. Each object holds the same fields as the /dicomdata/get call |
| Permission | dicomdata_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to view the DICOM data |
| Notes |
|
| Description | Get the DICOM data |
|---|---|
| URL | /dicomdata/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the DICOM data dicom_tags A JSON list of the DICOM tags to return (optional) customfields • An array of the custom fields associated with this dicomdata. Each object has the following fields (This is only returned if the dicomdata has custom fields) |
| Returns |
status • OK uuid • Id of the DICOM data study_id • The study id study_uid • The study uid series_uid • The series uid instance_uid • The instance uid dicom_tags • The DICOM tags and values |
| Permission | dicomdata_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The DICOM data was not found. NOT_PERMITTED • You are not permitted to view the DICOM data |
| Notes |
Rad report commands
| Description | Add a radreport |
|---|---|
| URL | /radreport/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) study_id • Id of the study to add the radreport to type • The type of the radreport fields • A JSON hash of the fields in the report (optional) |
| Returns |
status • OK uuid • The uuid |
| Permission | radreport_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to add a radreport to the study INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field |
| Notes |
| Description | Modify a radreport |
|---|---|
| URL | /radreport/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the radreport fields • A JSON hash of the fields in the report (optional) attachment • A JSON hash of the storage attachment information (optional) |
| Returns |
status • OK |
| Permission | radreport_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to add a radreport to the study INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field |
| Notes |
| Description | Get the radreport |
|---|---|
| URL | /radreport/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the radreport |
| Returns |
status • OK uuid • Id of the radreport type • Type of radreport fields • Fields in the radreport attachment • The storage attachment information user_id • User who created the radreport study_id • Associated study created • Date and time the radreport was created updated • Date and time the radreport was updated |
| Permission | radreport_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport was not found. NOT_PERMITTED • You are not permitted to view the radreport |
| Notes |
| Description | Attach an audit action to a radreport |
|---|---|
| URL | /radreport/audit |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The id of the radreport action • The audit action (SIGNED|MEDICAL_EDIT|ADMIN_EDIT|REPORT_GENERATED) detail • Additional information |
| Returns |
status • OK |
| Permission | radreport_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport can not be found INVALID_ACTION • An invalid action was passed |
| Notes |
| Description | Delete the radreport |
|---|---|
| URL | /radreport/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the radreport |
| Returns |
status • OK |
| Permission | radreport_edit plus you must have created the radreport |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport was not found. NOT_PERMITTED • You are not permitted to delete the radreport |
| Notes |
| Description | Get the description of the radreport |
|---|---|
| URL | /radreport/description |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Id of the radreport |
| Returns |
status • OK uuid • Id of the radreport description • One line description of the radreport type • Type of radreport can_edit • Can the user edit the radreport |
| Permission | radreport_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport was not found. NOT_PERMITTED • You are not permitted to view the radreport |
| Notes |
| Description | List the radreports for a user |
|---|---|
| URL | /radreport/user/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) user_id • The user id filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash radreports • An array of the radreports. Each object holds the same fields as the /radreport/get call |
| Permission | This will only return radreports the calling user has radreport_view permissions for |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The user was not found. |
| Notes |
| Description | Get a list of the user radreport macros |
|---|---|
| URL | /radreportmacro/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account modality • Limit to this modality (optional) type • Limit to this type (optional) filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK macros • An array of the macros. Each object holds the same fields as the /radreportmacro/get call page • The pagination status hash |
| Permission | radreport_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to perform this operation |
| Notes |
| Description | Add a radreport macro |
|---|---|
| URL | /radreportmacro/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account modality • Modality type • Type of radreport name • Name of the macro body • JSON body of the macro hotkey • Hotkey of the macro (optional) |
| Returns |
status • OK uuid • Id of the macro |
| Permission | radreport_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to perform this operation |
| Notes |
| Description | Edit a radreport macro |
|---|---|
| URL | /radreportmacro/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the macro modality • Modality (optional) type • Type of radreport (optional) name • Name of the macro (optional) body • JSON body of the macro (optional) hotkey • Hotkey of the macro (optional) |
| Returns |
status • OK uuid • Id of the macro |
| Permission | radreport_edit plus ownership of the macro |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to perform this operation |
| Notes |
| Description | Get a radreport macro |
|---|---|
| URL | /radreportmacro/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the macro |
| Returns |
status • OK uuid • Id of the macro modality • Modality type • Type of radreport name • Name of the macro body • JSON body of the macro hotkey • Hotkey of the macro |
| Permission | radreport_view plus ownership of the macro |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to perform this operation |
| Notes |
| Description | Delete a radreport macro |
|---|---|
| URL | /radreportmacro/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the macro |
| Returns |
status • OK |
| Permission | radreport_edit plus ownership of the macro |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to perform this operation |
| Notes |
| Description | Returns the PDF report |
|---|---|
| URL | /radreport/pdf |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The radreport uuid |
| Returns | Streams back the PDF report |
| Permission | radreport_view |
| Errors | 404 not found |
| Notes |
| Description | Fax the radreport |
|---|---|
| URL | /radreport/fax |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The radreport uuid number • The fax number to send the PDF report to |
| Returns |
status • OK |
| Permission | radreport_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport can not be found INVALID_PHONE • The fax number is invalid PDF_FAILED • The PDF report failed to generate NO_ATTACHMENT • The radreport does not have an attached report |
| Notes |
| Description | Get a list of the account radreport templates |
|---|---|
| URL | /radreport/template/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account type • Limit to this type (optional) active • Limit to active templates (optional) filter.* • Filters (optional) page.* • Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK templates • An array of the templates. Each object holds the same fields as the /radreport/template/get call page • The pagination status hash |
| Permission | radreport_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to perform this operation |
| Notes |
| Description | Add a radreport template |
|---|---|
| URL | /radreport/template/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account type • Type of radreport name • Name of the template body • Body of the template preview • Preview of the template (optional) options • JSON options of the template (optional) |
| Returns |
status • OK uuid • Id of the template |
| Permission | sysadmin or support |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_SYSADMIN_OR_SUPPORT • The user is not a sysadmin or support user |
| Notes |
| Description | Edit a radreport template |
|---|---|
| URL | /radreport/template/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the template type • Type of radreport (optional) name • Name of the template (optional) body • Body of the template (optional) preview • Preview of the template (optional) options • JSON options of the template (optional) |
| Returns |
status • OK uuid • Id of the template |
| Permission | sysadmin or support |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_SYSADMIN_OR_SUPPORT • You are not permitted to perform this operation |
| Notes |
| Description | Get a radreport template |
|---|---|
| URL | /radreport/template/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the template |
| Returns |
status • OK uuid • Id of the template type • Type of radreport name • Name of the template body • Body of the template preview • Preview of the template options • JSON options of the template active • Flag if the template is active |
| Permission | radreport_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport template can not be found NOT_PERMITTED • You are not permitted to perform this operation |
| Notes |
| Description | Get a radreport template by type |
|---|---|
| URL | /radreport/template/get/type |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account type • Type of the template |
| Returns |
status • OK uuid • Id of the template type • Type of radreport name • Name of the template body • Body of the template preview • Preview of the template options • JSON options of the template active • Flag if the template is active |
| Permission | radreport_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport template can not be found NOT_PERMITTED • You are not permitted to perform this operation |
| Notes |
| Description | Delete a radreport template |
|---|---|
| URL | /radreport/template/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the template |
| Returns |
status • OK |
| Permission | sysadmin or support |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_SYSADMIN_OR_SUPPORT • The user is not a sysadmin or support user |
| Notes |
| Description | Activate a radreport template |
|---|---|
| URL | /radreport/template/activate |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the template |
| Returns |
status • OK uuid • Id of the template |
| Permission | sysadmin or support |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport template can not be found NOT_SYSADMIN_OR_SUPPORT • The user is not a sysadmin or support user |
| Notes |
|
Custom code commands
| Description | Add the code |
|---|---|
| URL | /customcode/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) name • The name of the code type • Type of code (AI_CUSTOM_VALIDATION_CODE) language • Language of code (PYTHON) code • The code settings • JSON hash of settings (optional) zip • Base64 encoded ZIP file (optional) |
| Returns |
status • OK uuid • The code uuid |
| Permission | customcode_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to add code INVALID_TYPE • Invalid type INVALID_LANGUAGE • Invalid language NOT_HASH • The field is not a hash |
| Notes |
| Description | Get the code |
|---|---|
| URL | /customcode/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The code uuid |
| Returns |
status • OK uuid • The code uuid name • code name account_id • account uuid account_name • account name type • code type language • code language code • The code settings • JSON hash of settings is_deployed • Flag if the code is deployed has_zip • Flag if the code has an associated zip file |
| Permission | customcode_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The code can not be found NOT_PERMITTED • You are not permitted to view this code |
| Notes |
| Description | Modify the code |
|---|---|
| URL | /customcode/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The code uuid name • The name of the code (optional) code • The code (optional) settings • JSON hash of settings (optional) zip • Base64 encoded ZIP file (optional) |
| Returns |
status • OK uuid • The code uuid |
| Permission | customcode_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to edit the code NOT_HASH • The field is not a hash IS_DEPLOYED • The code is deployed and can not be edited ONE_ZIP_ONLY • Only one code with an attached zip can be deployed to the namespace |
| Notes |
| Description | Returns the customcode zip file |
|---|---|
| URL | /customcode/zip |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The code uuid |
| Returns | Streams back the zip file |
| Errors | 404 not found |
| Notes |
| Description | Delete the code |
|---|---|
| URL | /customcode/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The code uuid |
| Returns |
status • OK |
| Permission | customcode_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to delete the code IS_DEPLOYED • The code is deployed and can not be deleted |
| Notes |
| Description | Get a list of the code for the account |
|---|---|
| URL | /customcode/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash customcodes • An array of the customcode. Each object holds the same fields as the /customcode/get call |
| Permission | customcode_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view code in this account |
| Notes |
|
| Description | Deploy customcode for a namespace |
|---|---|
| URL | /customcode/deploy |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the customcode namespace_id • uuid of the namespace |
| Returns |
status • OK uuid • Deployment uuid |
| Permission | customcode_deploy |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The namespace or customcode can not be found NOT_PERMITTED • You are not permitted to deploy code in this namespace ALREADY • The code is already deployed for this namespace |
| Notes |
| Description | Un-deploy customcode |
|---|---|
| URL | /customcode/undeploy |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) deployment_id • Deployment uuid |
| Returns |
status • OK |
| Permission | customcode_deploy |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The deployment can not be found NOT_PERMITTED • You are not permitted to undeploy code in this namespace |
| Notes |
| Description | Get a customcode deployment |
|---|---|
| URL | /customcode/deploy/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of customcode deployment |
| Returns |
status • OK uuid • uuid of the deployment customcode_id • uuid of the customcode customcode_name • name of the customcode namespace_id • uuid of the namespace namespace_name • name of the namespace |
| Permission | customcode_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The customcode deployment can not be found NOT_PERMITTED • You are not permitted to do this |
| Notes |
| Description | List customcode deployments |
|---|---|
| URL | /customcode/deploy/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (namespace_id|customcode_id) • uuid of either the namespace or customcode to show the deployments for filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash deployments • An array of the objects. Each object in the array will have the fields available in /customcode/deploy/get |
| Permission | customcode_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The namespace or customcode can not be found NOT_PERMITTED • You are not permitted to do this |
| Notes |
Case commands
Cases are automatically created by the second opinion workflow for a share code| Description | Get a case |
|---|---|
| URL | /case/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The case uuid |
| Returns |
status • OK uuid • The case uuid name • case name created • Date and time the case was created paid • Flag if a payment being made against the case share_code • Share code the case is associated with user_name • Name of the user the case is for user_email • Email of the user the case is for studies • An array of the studies associated with this case. Each study has the fields from /study/get tags • An array of user tags associated with this object (This is only returned if the object has tags) customfields • An array of the custom fields associated with this case. Each object has the following fields (This is only returned if the case has custom fields) case_status • Status of the case case_status_date • Date and time the case was set to the current status case_status_tags • The available case status tags submitted • Flag if the case was submitted submitted_date • Date and time the case was submitted returned_date • Date and time the case was returned returned_reason • Reason the case was returned completed • Flag if the case is completed completed_date • Date and time the case was completed closed • Flag if the case is closed closed_date • Date and time the case was closed The rest of the fields are not returned to the case owner assigned_admin_id • Id of the admin user assigned to the case assigned_admin_name • Name of the admin user assigned to the case assigned_admin_date • Date and time the case was assigned to the admin user assigned_medical_id • Id of the medical user assigned to the case assigned_medical_name • Name of the medical user assigned to the case assigned_medical_date • Date and time the case was assigned to a medical user locked_user_id • Id of the user who has locked the case locked_user_name • Name of the user who has locked the case |
| Permission | case_view or the case owner, or the assigned medical user if case_view and case_view_only_own are enabled |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The case can not be found NOT_PERMITTED • You are not permitted to view this case |
| Notes |
|
| Description | Edit a case |
|---|---|
| URL | /case/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The case uuid name • case name (optional) submitted • Flag if the case is submitted (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) The rest of the fields can not be set by the case owner completed • Flag if the case is completed (optional) closed • Flag if the case is closed (optional) case_status • The case status (optional) assigned_admin_id • Id of the admin user assigned to the case (optional) assigned_medical_id • Id of the medical user assigned to the case (optional) |
| Returns |
status • OK |
| Permission | case_edit or the case owner, or the assigned medical user if case_edit and case_edit_only_own are enabled |
| Errors |
NOT_FOUND • The case or assigned user can not be found NOT_PERMITTED • You are not permitted to edit the case NOT_IN_ACCOUNT • The assigned user is not in the account INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details INVALID_CASE_STATUS • Invalid case status LOCKED • The case is locked by another user |
| Notes |
|
| Description | Return a case to the owner |
|---|---|
| URL | /case/return |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The case uuid reason • The reason the case was returned |
| Returns |
status • OK |
| Permission | case_edit, or the assigned medical user if case_edit and case_edit_only_own are enabled |
| Errors |
NOT_FOUND • The case can not be found NOT_PERMITTED • You are not permitted to return the case |
| Notes | A case can only be returned if it is submitted and not closed or completed |
| Description | Delete a case |
|---|---|
| URL | /case/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The case uuid |
| Returns |
status • OK |
| Permission | case_delete |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The case can not be found NOT_PERMITTED • You are not permitted to delete the case |
| Notes |
| Description | Get a list of the cases for the current user or the account |
|---|---|
| URL | /case/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account (optional) filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash cases • An array of the cases. Each object holds the same fields as the /case/get call |
| Permission | case_view or case ownership, or the assigned medical user if case_view and case_view_only_own are enabled |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view cases in this account |
| Notes |
| Description | Attach or detach a study to a case |
|---|---|
| URL | /case/attach |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • Case uuid study_id • Study uuid detach • Flag to detach the study from the case (optional) |
| Returns |
status • OK |
| Permission | Only the assigned admin or medical user can do this |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The case or study can not be found NOT_PERMITTED • You are not permitted to do this |
| Notes | The attached study will be shared into the users PHR account |
| Description | Calculate price for second opinion |
|---|---|
| URL | /case/price |
| Parameters |
share_code • The share code of the second opinion namespace. customfield-(CUSTOMFIELD_UUID) • Custom field(s) defined for the case objects with values stated in the second opinion wizard (optional) |
| Returns |
status • OK price • Calculated price in pennies or null for no price list match |
| Errors |
NOT_FOUND • The namespace can not be found |
| Notes |
|
Patient commands
| Description | Add a patient |
|---|---|
| URL | /patient/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account to add them to study_id • Id of the study to create a patient from (optional) (name|first&&last) • Patient name as either full name or first and last (optional if study_id is used) mrn • MRN (optional if study_id is used) sex • Gender (optional) birth_date • Birth date (optional) email • Email address (optional) mobile_phone • Mobile phone number (optional) alt_email • Alternate email address (optional) alt_mobile_phone • Alternate mobile phone number (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) event_share • Notify the patient if a new study is available on the patient portal (optional) |
| Returns |
status • OK uuid • The uuid |
| Permission | patient_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account or study was not found. The error_subtype holds the type of field not found NOT_PERMITTED • You are not permitted to add a patient to the account INVALID_PHONE • The phone number is invalid INVALID_EMAIL • The email is invalid ALREADY_EXISTS • The patient is already in the account ALREADY_USED • The email or phone number is already used by another patient. The error_subtype holds the field that is already used INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details |
| Notes | If a study is used the base fields values are taken from the study and any explicit values sent in the call will override the study fields |
| Description | Get a patient |
|---|---|
| URL | /patient/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The patient uuid |
| Returns |
status • OK uuid • The patient uuid name • Patient name first • Patient first name last • Patient last name mrn • MRN sex • Gender birth_date • Birth date email • Email address mobile_phone • Mobile phone number alt_email • Alternate email address alt_mobile_phone • Alternate mobile phone number event_share • Notify the patient if a new study is available on the patient portal tags • An array of user tags associated with this object (This is only returned if the object has tags) customfields • An array of the custom fields associated with this patient. Each object has the following fields (This is only returned if the group has custom fields) |
| Permission | patient_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to view this patient |
| Notes |
| Description | Edit a patient |
|---|---|
| URL | /patient/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The patient uuid (name|first&&last) • Patient name as either full name or first and last mrn • MRN sex • Gender birth_date • Birth date email • Email address (optional) mobile_phone • Mobile phone number (optional) alt_email • Alternate email address (optional) alt_mobile_phone • Alternate mobile phone number (optional) event_share • Notify the patient if a new study is available on the patient portal (optional) customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) |
| Returns |
status • OK |
| Permission | patient_edit |
| Errors |
NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to edit the patient INVALID_PHONE • The phone number is invalid INVALID_EMAIL • The email is invalid ALREADY_EXISTS • The MRN is in use by another patient ALREADY_USED • The email or phone number is already used by another patient. The error_subtype holds the field that is already used INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details |
| Notes |
| Description | Delete a patient |
|---|---|
| URL | /patient/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The patient uuid |
| Returns |
status • OK |
| Permission | patient_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to delete the patient |
| Notes |
| Description | Get a list of the patients in the account |
|---|---|
| URL | /patient/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash patients • An array of the patients. Each object holds the same fields as the /patient/get call |
| Permission | patient_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view patients in this account |
| Notes | The default sort is by recent activity. |
| Description | Get a list of the studies for the patient |
|---|---|
| URL | /patient/study/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The patient id viewable_only • Flag if they only want the studies the user can view |
| Returns |
status • OK studies • An array of the studies. Each object holds the same fields as the /study/get call |
| Permission | patient_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to view this patient |
| Notes |
| Description | Find a patient for the portal |
|---|---|
| URL | /patient/portal/find |
| Parameters |
first • The first name last • The last name birth_date • Date of birth mrn • MRN (required if the require_mrn_for_patient_portal account setting is on) |
| Returns |
status • OK patient_id • The patient id study_count • The number of studies for the patient email • The obscured version of the patient email mobile_phone • The obscured version of the patient phone alt_email • The obscured version of the patient email alt_mobile_phone • The obscured version of the patient phone dup_email • Flag if another patient has the same email dup_mobile_phone • Flag if another patient has the same mobile_phone other_patients • An array of the other matching patients. Each object holds the same fields as documented above. This field is only returned if there are other matching patients. |
| Permission | The enable_patient_portal flag needs to be turned on for the account and the call needs to come for a vanity for the account |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to perform this search INVALID_DATE • An invalid date was passed |
| Notes |
|
| Description | Send a PIN to the patient |
|---|---|
| URL | /patient/portal/pin |
| Parameters |
patient_id • The patient id email • Flag if they want the PIN sent via email mobile_phone • Flag if they want the PIN sent via SMS alt_email • Flag if they want the PIN sent via the alt_email alt_mobile_phone • Flag if they want the PIN sent via SMS to the alt_mobile_phone |
| Returns |
status • OK |
| Permission | The enable_patient_portal flag needs to be turned on for the account and the call needs to come for a vanity for the account |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to do this |
| Notes |
|
| Description | Login to the patient portal |
|---|---|
| URL | /patient/portal/login |
| Parameters |
patient_id • The patient id pin • The PIN |
| Returns |
status • OK sid • Session id |
| Permission | The enable_patient_portal flag needs to be turned on for the account and the call needs to come for a vanity for the account |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found INVALID_PIN • The PIN is invalid or expired NOT_PERMITTED • You are not permitted to do this LOCKOUT • Too many failed attempts |
| Notes |
Order commands
| Description | Add a order |
|---|---|
| URL | /order/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account to add them to patientid • Patient MRN patient_name • Patient name accession_number • Accession number patient_sex • Gender patient_birth_date • DOB referring_physician • Referring physician sending_facility • Sending facility customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) |
| Returns |
status • OK uuid • The uuid |
| Permission | order_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account was not found. The error_subtype holds the type of field not found NOT_PERMITTED • You are not permitted to add a order to the account INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details |
| Notes |
| Description | Get an order |
|---|---|
| URL | /order/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The order uuid |
| Returns |
status • OK uuid • The order uuid patientid • Patient MRN patient_name • Patient name accession_number • Accession number patient_sex • Gender patient_birth_date • DOB referring_physician • Referring physician sending_facility • Sending facility tags • An array of user tags associated with this object (This is only returned if the object has tags) customfields • An array of the custom fields associated with this order. Each object has the following fields (This is only returned if the order has custom fields) sps • An array of the SPS records associated with this order. Each record has the following fields * uuid • Id of the SPS * modality • Modality * scheduled_procedure_step_id • Step ID * requested_procedure_id • Procedure ID * requested_procedure_description • Procedure description * scheduled_station_aetitle • Station AE title * scheduled_procedure_step_start_date • Start date * scheduled_procedure_step_start_time • Start time * scheduled_procedure_step_description • Step description * mpps_status • The modality performed procedure step (mpps) status * mpps_uid • The UID for the mpps |
| Permission | order_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The order can not be found NOT_PERMITTED • You are not permitted to view this order |
| Notes |
| Description | Edit a order |
|---|---|
| URL | /order/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The order uuid patientid • Patient MRN patient_name • Patient name accession_number • Accession number patient_sex • Gender patient_birth_date • DOB referring_physician • Referring physician sending_facility • Sending facility customfield-CUSTOMFIELD_UUID • Custom field(s) (optional) |
| Returns |
status • OK |
| Permission | order_edit |
| Errors |
NOT_FOUND • The order can not be found NOT_PERMITTED • You are not permitted to edit the order INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details |
| Notes |
| Description | Delete a order |
|---|---|
| URL | /order/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The order uuid |
| Returns |
status • OK |
| Permission | order_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The order can not be found NOT_PERMITTED • You are not permitted to delete the order |
| Notes |
| Description | Get a list of the orders in the account |
|---|---|
| URL | /order/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash orders • An array of the orders. Each object holds the same fields as the /order/get call |
| Permission | order_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view orders in this account |
| Notes |
| Description | Add a scheduled procedure step to an order |
|---|---|
| URL | /order/sps/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) order_id • uuid of the order modality • Modality scheduled_procedure_step_id • Step ID requested_procedure_id • Procedure ID requested_procedure_description • Procedure description scheduled_station_aetitle • Station AE title scheduled_procedure_step_start_date • Start date scheduled_procedure_step_start_time • Start time scheduled_procedure_step_description • Step description |
| Returns |
status • OK uuid • UUID of the SPS |
| Permission | order_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The order can not be found NOT_PERMITTED • You are not permitted to edit orders in this account |
| Notes |
| Description | Edit a scheduled procedure step |
|---|---|
| URL | /order/sps/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • UUID of the SPS modality • Modality (optional) scheduled_procedure_step_id • Step ID (optional) requested_procedure_id • Procedure ID (optional) requested_procedure_description • Procedure description (optional) scheduled_station_aetitle • Station AE title (optional) scheduled_procedure_step_start_date • Start date (optional) scheduled_procedure_step_start_time • Start time (optional) scheduled_procedure_step_description • Step description (optional) |
| Returns |
status • OK |
| Permission | order_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The SPS can not be found NOT_PERMITTED • You are not permitted to edit orders in this account |
| Notes |
| Description | Delete a scheduled procedure step |
|---|---|
| URL | /order/sps/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • UUID of the SPS |
| Returns |
status • OK |
| Permission | order_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The SPS can not be found NOT_PERMITTED • You are not permitted to edit orders in this account |
| Notes |
| Description | Set the mpps status of a SPS |
|---|---|
| URL | /order/sps/status |
| Parameters |
uuid • The node id serial_no • The serial number of the node mpps_uid • The mpps UUID of the SPS mpps_status • The mpps status to set (PENDING|IN_PROGRESS|DISCONTINUED|COMPLETED) |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The SPS can not be found NOT_PERMITTED • You are not permitted to set the status INVALID_STATUS • An invalid status was passed |
| Notes |
| Description | Find SPS orders for MWL processing |
|---|---|
| URL | /order/sps/find |
| Parameters |
(sid || node_id && serial_no) • Either the sid or the node uuid and serial number account_id • The account uuid if sid authentication is used filter.* Filters (optional) |
| Returns |
status • OK sps • An array of the matching sps record. Each record has the following fields * patientid • Patient MRN * patient_name • Patient name * accession_number • Accession number * patient_sex • Gender * patient_birth_date • DOB * referring_physician • Referring physician * modality • Modality * study_uid • Study UID * scheduled_procedure_step_id • Step ID * requested_procedure_id • Procedure ID * requested_procedure_description • Procedure description * scheduled_station_aetitle • Station AE title * scheduled_procedure_step_start_date • Start date * scheduled_procedure_step_start_time • Start time * scheduled_procedure_step_description • Step description * mpps_status • The modality performed procedure step (mpps) status * mpps_uid • The UID for the mpps |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found NOT_PERMITTED • You are not permitted to view orders in this account |
| Permission | order_view if sid authentication is used |
| Notes |
|
HL7 commands
| Description | Get a list of HL7 messages in an account |
|---|---|
| URL | /hl7/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash messages • An array of the HL7 messages. Each message holds the following fields: * uuid • uuid of the message * created • Created datetime stamp of the message * type • Message type * accession_numbers • Array of the message accession numbers * patientid • Patient MRN * patient_name • Patient name |
| Permission | hl7_message_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account_id can not be found NOT_PERMITTED • You are not permitted to do this |
| Notes |
| Description | Add a HL7 message to the system |
|---|---|
| URL | /hl7/add |
| Parameters |
uuid • The node id serial_no • The serial number of the node message • The HL7 message accession_number • Use this accession number instead of the accession number in the HL7 message (optional) |
| Returns |
status • OK ack • The HL7 acknowledgement uuid • UUID of the message |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found INVALID_MESSAGE • The message could not parsed as a HL7 message |
| Notes |
| Description | Get a HL7 message |
|---|---|
| URL | /hl7/get |
| Parameters |
(sid || node_id && serial_no) • Either the sid or the node uuid and serial number uuid • The hl7 uuid (study_id || study_uid && storage_namespace && phi_namespace) • The study uuid or the storage triplet (optional) raw • Flag to return the raw HL7 message as well |
| Returns |
status • OK uuid • The hl7 uuid created • The date and time the report was created. segments • A JSON list of lists of the segments in the message hl7_template • The hl7_template to render the message with (optional) raw • The hl7 message (optional) |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The hl7 can not be found NOT_PERMITTED • You are not permitted to access this hl7 |
| Notes |
| Description | Delete a HL7 message |
|---|---|
| URL | /hl7/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The hl7 uuid |
| Returns |
status • OK |
| Permission | 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 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 |
| 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 | 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) 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_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) 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 | The configuration hash does not need to be complete. It can include only the items you want to update or the entire set. |
| 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 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 accelerator_id • uuid of the accelerator if this is an accelerator node account_id • The associated account id settings • A hash of the account settings that the node has overridden has_access • Flag if the user has node_view or node_edit permissions on this node facility_name • Name of the facility it is installed at facility_zip • Zip code of the facility it is installed at facility_contact • Name of the facility contact facility_contact_title • Title of the facility contact facility_email • Email of the facility contact facility_notes • Notes about the facility category • Node category (ACTIVE|INACTIVE|MIGRATION|TEST|DUPLICATE|INTEGRATED) is_public • Flag if the node is public ctc_bucket • Name of the S3 bucket to use for a cloud to cloud gateway (optional) last_ping • Number of seconds since the nodes last ping. -1 if the node has never pinged |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found |
| Notes |
| Description | Ping node |
|---|---|
| URL | /node/ping |
| Parameters |
uuid • The node id serial_no • The serial number of the node ack • Flag if the gateway wants to use the acknowledge workflow |
| Returns |
status • OK reload_configuration • An optional flag field, if set the node should reload it's configuration. ack • Flag if an acknowledgement is needed (optional) studies • An array of the studies each object in the array will have the following fields * uuid • Id of the push job * study_uid • The study uid * storage_namespace • The storage namespace * phi_namespace • The phi namespace * engine_fqdn • The FQDN of the storage engine for the study * modality • The study modality * size • The study size * image_count • The study image_count * accession_number • The study accession number * patientid • The study MRN * destination_id • Id of the destination (if the destination is DICOM) * aetitle • The ae title to send to (if the destination is DICOM) * address • The destination address (if the destination is DICOM) * port • The destination port (if the destination is DICOM) * path • The destination path (if the destination is FOLDER) * bundle • The bundle type (if the destination is FOLDER) * detail • Any additional detail from the /study/cmove or "use_cache" if local routing is required or "is_auto" if this was created by routing rules fetch • An array of the studies to fetch each object in the array will have the following fields * uuid • Id of the fetch job * accession_number • The accession number to query on * destination_id • Id of the destination * aetitle • The ae title to query to * address • The query address * port • The query port * study_uid • Study uid to query for * patientid • Patient id to query for * destination_ae_title • Value of the field in the thin study (optional) * source • Source of the fetch either 'H' for an HL7 triggered fetch or 'O' for other hl7 • An array of HL7 messages to deliver each object in the array will have the following fields * uuid • Id of the job * destination_id • Id of the destination * message • The HL7 message to deliver * address • The HL7 destination address * port • The HL7 destination port search_results • An array of the results from the /destination/search jobs run by the gateway. Each object in the array will have the following fields * uuid • Id of the search results * destination_id • Id of the destination that was searched * payload • Payload from the search * search_id • UUID of the original search search • An array of the search jobs to run. Each object in the array will have the following fields * uuid • Id of the search job * destination_id • Id of the destination * aetitle • The ae title to query to * address • The query address * port • The query port * mwl_search • Flag to indicate if this is a modality worklist search * node_search • Flag to indicate if this is a search from another node * 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 * study_uid • The study uid to attach the log to * storage_namespace • The storage namespace of the study * phi_namespace • The phi namespace of the study * engine_fqdn • The FQDN of the storage engine for the study * start • The start date and time for the log range * end • The end date and time for the log range |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found |
| Notes |
|
| Description | Acknowledge the last ping |
|---|---|
| URL | /node/ping/ack |
| Parameters |
uuid • The node id serial_no • The serial number of the node |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found |
| Notes |
| Description | Update the status of a job picked up /node/ping |
|---|---|
| URL | /node/deliver |
| Parameters |
uuid • The node id serial_no • The serial number of the node job_id • The uuid of the push job, not used for local pushes (optional) status • Status code of the job (S|F|P|B|U) - Success, failure, partial transfer, blocked or uncached status_reason • Detail on the status change (optional) ack • The HL7 ACK if this was an HL7 job (optional) email_reason • Email the user this reason for the status change (optional) is_local • The flag used to indicate the local push (optional) study_uid • The study uid of the local push, required for local pushes only (optional) destination_id • The uuid of the destination, required for local pushes (optional) |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node or job can not be found INVALID_STATUS • Invalid status code |
| Notes |
|
| Description | Update the status of a fetch job picked up /node/ping |
|---|---|
| URL | /node/retrieve |
| Parameters |
uuid • The node id serial_no • The serial number of the node job_id • The uuid of the fetch job status • Status code of the job (S|F|P) - Success, failure, partial transfer |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node or job can not be found INVALID_STATUS • Invalid status code |
| Notes | The uuid and serial_no can also be passed using basic auth as the username/password combination |
| Description | Set the status of webhook picked up /node/ping |
|---|---|
| URL | /node/webhook |
| Parameters |
uuid • The node id serial_no • The serial number of the node webhook_id • The uuid of the webhook job status • Status code of the job (S|F) - Success, failure error_message • Detailed error message (optional) |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node or webhook can not be found INVALID_STATUS • Invalid status code |
| Notes | The uuid and serial_no can also be passed using basic auth as the username/password combination |
| Description | Get the node configuration |
|---|---|
| URL | /node/configuration |
| Parameters |
uuid • The node id serial_no • The serial number of the node |
| Returns |
status • OK storage_namespace • The storage namespace the node should harvest to configuration • The configuration as JSON hash of key values pairs destinations • An array of the destinations for the node. Each object holds the following same fields as the /destination/get call account_settings • A hash of the relevant account settings. (study_search_modifiers) |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found |
| Notes |
The uuid and serial_no can also be passed using basic auth as the username/password combination
The ingress_filter element contains a json string which includes the group/element, the type of comparison and the value to test against. A sample document is as follows: |
| Description | Delete a node |
|---|---|
| URL | /node/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The node id |
| Returns |
status • OK |
| Permission | node_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found NOT_PERMITTED • You are not permitted to delete this node HAS_DESTINATIONS • The node has associated destinations |
| Notes |
| Description | A study was queued for pushing to storage |
|---|---|
| URL | /node/study/queued |
| Parameters |
uuid • The node id serial_no • The serial number of the node study_uid • The study uid |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found |
| Notes | A node should notify services when it receives a study that needs to be pushed to the cloud. This call is needed for the monitor_study_create check to work. |
| Description | Return the results of a search |
|---|---|
| URL | /node/found |
| Parameters |
uuid • The node id serial_no • The serial number of the node search_id • The id of the search request studies • A JSON array of the studies found. Each object has the following fields * study_uid • The study_uid * study_date • The study date * accession_number • The accession number * referring_physician • The referring physician * patient_name • Patient name * patientid • Patient ID * patient_sex • Gender * patient_birth_date • Birth date * study_description • Study description * modality • Modality * result_fields • A JSON structure with the answers for the requested result_fields in /destination/search (optional) |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node or search can not be found INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field ALREADY_DONE • The search has already had results returned against it |
| Notes |
| Description | Return the results of a modality worklist search |
|---|---|
| URL | /node/found/mwl |
| Parameters |
uuid • The node id serial_no • The serial number of the node search_id • The id of the search request orders • A JSON array of the orders found. Each object has the following fields * patient_name • Patient name * patientid • Patient id * accession_number • Accession number * patient_sex • Gender * patient_birth_date • Birth date * order_number • Order number * order_date • Order date |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node or search can not be found INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field ALREADY_DONE • The search has already had results returned against it |
| Notes |
| Description | Notify for a node event |
|---|---|
| URL | /node/event |
| Parameters |
uuid • The node id serial_no • The serial number of the node event • The event (c_echo_error) destination_id • The id of the destination if the event is associated with a destination |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node or destination can not be found INVALID_EVENT • Invalid event SCHEDULE_IS_OFF • The event is outside of its scheduled time |
| Notes |
| Description | Request logs from the node be attached to a study |
|---|---|
| URL | /node/log |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The node id start • Start time stamp in YYYY-MM-DD HH:MM:SS format end • End time stamp in YYYY-MM-DD HH:MM:SS format type • Type of log (log|dicom|queue) defaults to log if not passed |
| Returns |
status • OK |
| Permission | node_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found NOT_PERMITTED • You are not permitted to perform this action INVALID_DATE_TIME • The timestamp is invalid INVALID_RANGE • An invalid time range was specified TRY_LATER • The log search queue is full |
| Notes |
|
| Description | Record a metric for a job on the node |
|---|---|
| URL | /node/metric |
| Parameters |
uuid • The node id serial_no • The serial number of the node job_id • The uuid of the push job metric • The metric to record |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node or job can not be found INVALID_METRIC • The metric is invalid for this job type |
| Notes |
The following metrics are supported
|
| Description | 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 uuid • uuid of the destination account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash destinations • An array of the destinations. Each object holds the following same fields as the /destination/get call |
| Permission | destination_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view this list |
| Notes |
| Description | Add a destination to the account |
|---|---|
| URL | /destination/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account node_id • uuid of the node that handles the destination name • Name of the destination type • Type of the destination either DICOM, FOLDER, ACCELERATOR,VIRTUAL, BURNER, XDS, LINKED or UPLOADER. Defaults to DICOM (optional) linked_destination • uuid of the destination for LINKED destinations path • Path of the folder for a FOLDER type of destination (required if FOLDER type) aetitle • Aetitle of the destination (required if DICOM type) address • Address of the destination (required if DICOM type) port • Port of the destination (required if DICOM type) can_query_retrieve • Can this destination support query retrieve from HL7 messages (optional) can_retrieve_thin • Can this destination support retrieving thin studies (optional) can_search • Can this destination support searching (optional) can_mwl_search • Can this destination support searching a modality work list (optional) sqlch_psh_if_img_unchg • Squelch pushes to the destination if the image count has not changed and the push is by a routing rule (optional) sqlch_psh_if_route_hl7 • Squelch pushes to the destination if the push was generated by HL7 triggered routing (optional) hl7_address • Address of an attached HL7 destination (optional except for VIRTUAL destinations) hl7_port • Port of an attached HL7 destination (optional except for VIRTUAL destinations) c_echo_interval • Interval in seconds to C echo the destination (optional) c_echo_schedule • C echo schedule (optional) fire_webhooks • Fire webhooks for events associated with this destination (optional) default_query_retrieve_level • Default query retrieve level this can be either (study|series|image) and defaults to study if not specified (optional) push_related_studies • Push all the related studies (same MRN/patientid) in the namespace when a study is pushed (optional) gateway_settings • Gateway settings (optional) cd_burn_info • A JSON hash with the CD burning information (optional) cd_burn_name • Name for the CD burner software (optional) cd_burn_priority • Integer value for the burner priority (optional) sort_order • Integer value for sorting (optional) hl7_fetch_filter • A transform condition expression (see /transform/add for format) to match against the HL7 message. Only fire a query retrieve if the message matches the condition (optional) |
| Returns |
status • OK uuid • uuid of the destination |
| Permission | destination_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found INVALID_NODE_TYPE • The node is not a harvester NODE_NOT_FOUND • The node can not be found INVALID_VALUE • An invalid value was passed. The error_subtype holds the value DUP_AETITLE • Duplicate aetitle. All destinations for the same node must have a unique aetitle NOT_PERMITTED • You are not permitted to add a destination to this account INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag INVALID_INTEGER • An invalid integer was passed. The error_subtype holds the name of the invalid integer INVALID_SCHEDULE • The schedule is invalid. The error_subtype holds the error detail INVALID_TYPE • An invalid type was passed INVALID_GATEWAY_TYPE • The type is wrong for the gateway it is getting attached to INVALID_CD_BURN_INFO • Invalid cd_burn_info. The error_subtype holds more detail INVALID_NODE_TYPE • The node type is invalid for this type of destination NOT_SYSADMIN • The user is not a sysadmin user |
| Notes |
|
| Description | Edit a destination |
|---|---|
| URL | /destination/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the destination name • Name of the destination (optional) path • Path of the folder (optional) aetitle • Aetitle of the destination (optional) address • Address of the destination (optional) port • Port of the destination (optional) node_id • uuid of the node that handles the destination (optional) can_query_retrieve • Can this destination support query retrieve from HL7 messages (optional) can_retrieve_thin • Can this destination support retrieving thin studies (optional) can_search • Can this destination support searching (optional) can_mwl_search • Can this destination support searching a modality work list (optional) sqlch_psh_if_img_unchg • Squelch pushes to the destination if the image count has not changed and the push is by a routing rule (optional) sqlch_psh_if_route_hl7 • Squelch pushes to the destination if the push was generated by HL7 triggered routing (optional) hl7_address • Address of an attached HL7 destination (optional) hl7_port • Port of an attached HL7 destination (optional) c_echo_interval • Interval in seconds to C echo the destination (optional) c_echo_schedule • C echo schedule (optional) fire_webhooks • Fire webhooks for events associated with this destination (optional) default_query_retrieve_level • Default query retrieve level this can be either (study|series|image) and defaults to study if not specified (optional) push_related_studies • Push all the related studies (same MRN/patientid) in the namespace when a study is pushed (optional) gateway_settings • Gateway settings (optional) cd_burn_info • A JSON hash with the CD burning information (optional) cd_burn_name • Name for the CD burner software (optional) cd_burn_priority • Integer value for the burner priority (optional) sort_order • Integer value for sorting (optional) hl7_fetch_filter • A transform condition expression (see /transform/add for format) to match against the HL7 message. Only fire a query retrieve if the message matches the condition (optional) |
| Returns |
status • OK |
| Permission | destination_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The destination can not be found NOT_PERMITTED • You are not permitted to edit the destination NODE_NOT_FOUND • The node can not be found INVALID_NODE_TYPE • The node is not a harvester INVALID_VALUE • An invalid value was passed. The error_subtype holds the value DUP_AETITLE • Duplicate aetitle. All destinations for the same node must have a unique aetitle INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag INVALID_INTEGER • An invalid integer was passed. The error_subtype holds the name of the invalid integer INVALID_SCHEDULE • The schedule is invalid. The error_subtype holds the error detail INVALID_CD_BURN_INFO • Invalid cd_burn_info. The error_subtype holds more detail |
| Notes |
| Description | Get a destination |
|---|---|
| URL | /destination/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the destination |
| Returns |
status • OK uuid • uuid of the destination name • Name of the destination type • Type of the destination path • Path of the folder aetitle • Aetitle of the destination address • Address of the destination port • Port of the destination node_id • id of the handle that handles the destination can_query_retrieve • Can this destination support query retrieve from HL7 messages can_retrieve_thin • Can this destination support retrieving thin studies can_search • Can this destination support searching can_mwl_search • Can this destination support searching a modality work list sqlch_psh_if_img_unchg • Squelch pushes to the destination if the image count has not changed and the push is by a routing rule sqlch_psh_if_route_hl7 • Squelch pushes to the destination if the push was generated by HL7 triggered routing hl7_address • Address of an attached HL7 destination hl7_port • Port of an attached HL7 destination c_echo_interval • Interval in seconds to C echo the destination c_echo_schedule • C echo schedule fire_webhooks • Fire webhooks for events associated with this destination default_query_retrieve_level • Default query retrieve level push_related_studies • Push all the related studies (same MRN/patientid) in the namespace when a study is pushed gateway_settings • Gateway settings cd_burn_info • A JSON hash with the CD burning information cd_burn_name • Name for the CD burner software cd_burn_priority • Integer value for the burner priority sort_order • Integer value for sorting hl7_fetch_filter • A transform condition expression (see /transform/add for format) to match against the HL7 message. Only fire a query retrieve if the message matches the condition linked_destination • uuid of the linked destination if this is a LINKED type destination |
| Permission | destination_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The destination can not be found NOT_PERMITTED • You are not permitted to view the destination |
| Notes |
| Description | Delete a destination |
|---|---|
| URL | /destination/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the destination |
| Returns |
status • OK |
| Permission | destination_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The destination can not be found NOT_PERMITTED • You are not permitted to delete the destination |
| Notes |
| Description | Search a destination |
|---|---|
| URL | /destination/search |
| Parameters |
(sid || node_id && serial_no) • Either the sid or the node uuid and serial number uuid • uuid of the destination copy_to • uuid of a namespace to copy the retrieved or create_thin studies into (optional) push_to • uuid of a destination to push the retrieved studies to (optional) create_thin • The maximum number of thin studies to create from this search instead of creating an activity for the search results (optional) create_study • The maximum number of studies to retrieve from this search instead of creating an activity for the search results (optional) -- The rest of the fields are used for the search -- study_uid • Study uid to find (optional) patient_name • Patient name to find (optional) patientid • Patient id to find (optional) accession_number • Accession number to find (optional) referring_physician • Referring physician to find (optional) modality • Modality (optional) start_datetime • DICOM start date time stamp to bound the search (optional) end_datetime • DICOM end date time stamp to bound the search (optional) patient_sex • Gender to find (optional) patient_birth_date • Birth date to find (optional) query_fields • A JSON hash of additional query fields (optional) result_fields • A JSON array of DICOM tags that the destination should return (optional) |
| Returns |
status • OK uuid • UUID of the search |
| Permission | destination_search |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The destination or namespace can not be found NOT_PERMITTED • You are not permitted to search the destination NOT_SUPPORTED • The destination does not support searching a destination INSUFFICIENT_CRITERIA • Not enough search fields are populated |
| Notes |
|
| Description | Retrieve a study from a destination |
|---|---|
| URL | /destination/retrieve |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) activity_id • uuid of the DESTINATION_SEARCH activity to retrieve from |
| 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 |