(sid || uuid && serial_no) • Either the sid or the node id and serial number (study_id || study_uid || study_uid && storage_namespace && phi_namespace) • The uuid of the study if sid authentication or the study_uid if node authentication or the storage triplet if you want a future set patient_name • DICOM tag (0010,0010) (optional) patientid • DICOM tag (0010,0020) (optional) patient_sex • DICOM tag (0010,0040) (optional) patient_birth_date • DICOM tag (0010,0030) (optional) patient_birth_time • DICOM tag (0010,0032) (optional) patient_age • DICOM tag (0010,1010) (optional) patient_weight • DICOM tag (0010,1030) (optional) patient_address • DICOM tag (0010,1040) (optional) patient_size • DICOM tag (0010,1020) (optional) patientid_other • DICOM tag (0010,1000) (optional) patient_name_other • DICOM tag (0010,1001) (optional) patient_phone • DICOM tag (0010,2154) (optional) patient_additional_history • DICOM tag (0010,21B0) (optional) study_description • DICOM tag (0008,1030) (optional) accession_number • DICOM tag (0008,0050) (optional) patient_birthname • DICOM tag (0010,1005) (optional) patient_mother_birthname • DICOM tag (0010,1060) (optional) medical_record_locator • DICOM tag (0010,1090) (optional) patient_religious_preference • DICOM tag (0010,21F0) (optional) patient_comments • DICOM tag (0010,4000) (optional) patient_current_location • DICOM tag (0038,0300) (optional) patient_institution_residence • DICOM tag (0038,0400) (optional) patient_ethnic_group • DICOM tag (0010,2160) (optional) patient_occupation • DICOM tag (0010,2180) (optional) study_date • DICOM tag (0008,0020) (optional) study_time • DICOM tag (0008,0030) (optional) modality • DICOM tag (0008,0060) (optional) referring_physician • DICOM tag (0008,0090) (optional) image_count • Images in the study (optional) attachment_count • Attachment count (optional) integration_key • Integration key for the study (optional) destination_ae_title • The destination aetitle (optional) source_ae_title • The source aetitle (optional) node_id • If this is a thin study the gateway UUID to retrieve it from can be specified (optional) customfield-{CUSTOMFIELD_UUID|DICOM_TAG} • Custom field(s), see notes in /study/add (optional) use_upload_permission • Flag to use the upload permissions for the permissions check (optional) find_order_uuid • UUID of the search record used to modify the study (optional) seconds_to_ingest • Flag to re-calculate the seconds_to_ingest metric (optional) parital_save • Flag to bypass unset required customfields. Works only if account setting study_set_unapproved_allow_bypass_required_fields is set (optional) |
| Returns |
status • OK uuid • The study uuid |
| Permission |
study_edit or study_thin or study_upload if the study was previously uploaded and the use_upload_permission flag was set |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_CREDENTIALS • The sid or node credentials are invalid NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to edit this study INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details PENDING_MUST_MATCH • The study is pending a must match approval from storage and can not be edited in this state |
| Notes |
|
| Description | Delete a study |
|---|---|
| URL | /study/delete |
| Parameters |
(sid || node_id && serial_no) • Either the sid or the node id and serial number (uuid || study_uid && storage_namespace && phi_namespace) • The study uuid or the storage triplet |
| Returns |
status • OK |
| Permission | study_delete |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to delete this study |
| Notes |
| Description | Get a list of the studies the user can see |
|---|---|
| URL | /study/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) template • A JSON hash with name, account_id and language of the template to return (optional) extra • Flag to return extra data as detailed in /study/get (optional) customfield_h • Flag to return a customfield hash as detailed in /study/get (optional) permissions_diff • Flag to return only the permissions that differ from the namespace permissions (optional) fields • A JSON list of the study fields to return (optional) limit.hl7 • Limit the length of Hl7 list to return. Zero means no limit (optional) |
| Returns |
status • OK page • The pagination status hash studies • An array of the studies the user has. Each object holds the following same fields as the /study/get call template • The template HTML if a template was requested |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_TEMPLATE • The template is invalid the error_subtype holds the detail |
| Notes |
|
| Description | Get a count of the studies the user can see |
|---|---|
| URL | /study/count |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) filter.* Filters (optional) |
| Returns |
status • OK count • The study count |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
| Notes |
|
| Description | PACS mode. Get a count of the studies the user can see per each filter set |
|---|---|
| URL | /study/count_by_filter |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) filter.* • Filters (optional) filter_uuids • JSON array of filter.uuid (optional) |
| Returns |
status • OK count_by_filter • JSON hash of pairs {filter.uuid => $count} |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields INVALID_FIELD • Invalid filter_uuids JSON array of uuids |
| Notes |
|
| Description | Get a list of the studies the node can see |
|---|---|
| URL | /study/cfind |
| Parameters |
uuid • The node id serial_no • The serial number of the node entire_account • Flag to search the entire account rather than just the nodes namespace. (optional) is_available • Flag to limit search to studies that are ready for viewing. (optional) filter.* Filters (optional) page.* Pagination (optional) |
| Returns |
status • OK page • The pagination status hash studies • An array of the studies the user has. Each object holds the following same fields as the /study/get call |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found RUNNING • This cfind is currently in process |
| Notes | The list is sorted by creation order from most recent to oldest |
| Description | Get a study |
|---|---|
| URL | /study/get |
| Parameters |
(sid || node_id && serial_no) • Either the sid or the node uuid and serial number (uuid || study_uid && storage_namespace && phi_namespace) • The study uuid or the storage triplet full_hl7 • Flag to return the full hl7 record instead of just the uuid (optional) limit.hl7 • Limit the length of Hl7 list to return. Zero means no limit (optional) permissions_diff • Flag to return only the permissions that differ from the namespace permissions (optional) extra • Flag to return extra data as detailed below (optional) customfield_h • Flag to return a customfield hash as detailed below (optional) fields • A JSON list of the study fields to return (optional) |
| Returns |
status • OK uuid • Study uuid star • The study star flag study_uid • Study uid in storage phi_namespace • PHI namespace phi_namespace_name • PHI namespace description storage_namespace • Storage namespace engine_fqdn • The FQDN of the storage engine the study is stored on source • Source of the study (upload|harvest|share|copy) source_ae_title • The source aetitle for the harvesting destination_ae_title • The destination aetitle for the harvesting must_approve • A flag that the study must be approved or rejected before it is generally visible in the namespace share_message • If this study was shared this field will exist and hold any share message phantom • Is this a phantom study, a phantom study is one that is loading into storage thin • Is this a thin study, a thin study is not in storage and needs to be query retrieved to be loaded into storage patient_name • DICOM tag (0010,0010) patientid • DICOM tag (0010,0020) patient_sex • DICOM tag (0010,0040) patient_birth_date • DICOM tag (0010,0030) patient_birth_time • DICOM tag (0010,0032) patient_age • DICOM tag (0010,1010) patient_weight • DICOM tag (0010,1030) patient_address • DICOM tag (0010,1040) patient_size • DICOM tag (0010,1020) patientid_other • DICOM tag (0010,1000) patient_name_other • DICOM tag (0010,1001) patient_phone • DICOM tag (0010,2154) patient_additional_history • DICOM tag (0010,21B0) study_description • DICOM tag (0008,1030) accession_number • DICOM tag (0008,0050) patient_birthname • DICOM tag (0010,1005) patient_mother_birthname • DICOM tag (0010,1060) medical_record_locator • DICOM tag (0010,1090) patient_religious_preference • DICOM tag (0010,21F0) patient_comments • DICOM tag (0010,4000) patient_current_location • DICOM tag (0038,0300) patient_institution_residence • DICOM tag (0038,0400) patient_ethnic_group • DICOM tag (0010,2160) patient_occupation • DICOM tag (0010,2180) study_date • DICOM tag (0008,0020) study_time • DICOM tag (0008,0030) modality • DICOM tag (0008,0060) referring_physician • DICOM tag (0008,0090) image_count • Images in the study attachment_count • Attachment count size • Size of the study in bytes compressed_size • Compressed size of the study in bytes integration_key • Integration key for the study permissions • A hash of the study_* type permissions for this study patient_id • If the user has patient_view permissions in the account this field will exist and hold the patient uuid created • Created datetime stamp of the study updated • Updated datetime stamp of the study study_status • The study status. Is null for just created study. study_status_tags • The available study status tags. (This is only returned if they have study_status_edit permissions on the study and the study is not locked by another user) study_status_tags_default • The "default" value for study_status. It is calculated as (account.settings.study_status_tags_default || account.settings.study_status_tags[0]) study_status_timer • The study status timer value in seconds. A value of -1 means the timer has completed and this is only returned if the study_status_timer account flag is on. is_dicom_wrapped • Is the study a wrapped DICOM is_locked • Is the study locked by another user is_frozen • Is the study frozen is_being_retrieved • Is this a thin study in the process of being retrieved has_external_viewer • A flag if the study has an external viewer option seconds_to_ingest • The number of seconds it took to ingest the study. Blank if the study was ingested before this feature was added, -1 if we don't have enough data to calculate this accelerators • A JSON list of accelerator FQDN the study may be on (only returned if the probe_for_accelerator flag is on) viewer_link • Link to the study viewer. If the account has SAML SSO the link will be to the SSO entry point, if not it will be a direct link. hl7 • An array of the hl7 objects associated with this study. Each object has the following fields or is the complete record from /hl7/get if the full_hl7 flag is passed * uuid • Id of the object tags • An array of user tags associated with this object (This is only returned if the object has tags) customfields • An array of the custom fields associated with this study. Each object has the following fields (This is only returned if the study has custom fields) customfields_DICOM • An array of the DICOM tag custom fields associated with this study. Each object has the following fields (This is only returned if the study has DICOM tag custom fields) * tag • DICOM tag * value • Value of the custom field radreports • An array of the radreports associated with this study. Each object has the fields in the /radreport/description call routes • An array of the manual routes that the user can run against this study. Each object has the following fields (This is only returned if manual routes are available) * uuid • Route id * name • Route name * capture_email • Does an email need to be captured to run this rule - flag meetings • An array of the meetings the user can join. Each object has the fields in /meeting/get call (This is only returned if meetings are available) comments • An array of the study comments, order from most recent too earliest. This is only returned if the user has the study_comment_view permissions. Each object has the fields in the /study/comment/get call. study_push_status • An array of the study push status. This is only returned if the study_push_status account setting is enabled. Each object has the following fields. * destination_uuid • Destination Id * destination_name • Destination Name * status • The status, either 'I'n process, pe'N'ding, 'S'uccessful, 'P'artial or 'F'ailed * status_reason • Additional detail for the status * image_count • The image count for the push * updated • Date and time the status was last updated * created • Date and time the push was created * group_key • The string key used to group push statuses. Statuses that group: local pushes (by destination address), copy statuses, same UID statuses * is_local • The flag indicating if the corresponding push was local --- The following fields are only returned if the extra flag is specified --- created_at • Date and time the record was created primary_created • Date and time the record for the primary study was created account_name • Name of the account the study is in created_by_name • Name of the user who created the study created_by_email • Email of the user who created the study created_by_mobile_phone • Mobile phone number of the user who created the study created_by_type • Type of user who created the study created_for_name • Name of the user who the study was created for created_for_type • Type of user the study was created for hipaa_name • HIPAA compliant version of the patient name first_name • Patient first name last_name • Patient last name study_status • Study status value message_count • Number of messages associated with this study last_access • Date and time the study was last accessed in storage query_count • Number of open queries associated with this study --- The following field is only returned if the customfield_h flag is specified --- customfield_h • A JSON hash of the customfield values keyed by the UUID --- The following field is only returned if the enable_orders_in_worklist account setting is enabled --- order_count • Number of orders linked with this study (having the same accession_number). This field is filterable. --- The following field is only returned if the enable_radreport_lock_reading account setting is enabled --- radreport_locked_user_id • Only if there is some locked radreport for this study. Contains uuid of lock owner. |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to access this study |
| Notes |
| Description | Get the users permissions on the study |
|---|---|
| URL | /study/permissions |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid |
| Returns |
status • OK study_edit • The permission flag setting ↳ study_edit_approved • The permission flag setting ↳ study_edit_unapproved • The permission flag setting study_download • The permission flag setting study_browse • The permission flag setting study_share • The permission flag setting ↳ study_share_email • The permission flag setting ↳ study_share_share_code • The permission flag setting ↳ study_share_account • The permission flag setting ↳ study_share_location • The permission flag setting ↳ study_share_group • The permission flag setting ↳ study_share_user • The permission flag setting ↳ study_share_rsna • The permission flag setting ↳ study_share_npi • The permission flag setting ↳ study_share_request • The permission flag setting study_push • The permission flag setting study_delete • The permission flag setting study_approve • The permission flag setting study_view • The permission flag setting study_upload • The permission flag setting study_report_view • The permission flag setting study_report_view_only_own • The permission flag setting study_report_hl7_view • The permission flag setting study_report_upload • The permission flag setting study_report_delete • The permission flag setting study_sync • The permission flag setting study_status_tags_ignore_rules • The permission flag setting radreport_edit • The permission flag setting radreport_view • The permission flag setting radreport_view_only_own • The permission flag setting meeting_edit • The permission flag setting meeting_view • The permission flag setting link_direct • The permission flag setting link_edit • The permission flag setting link_edit_pin • The permission flag setting link_view • The permission flag setting reports • A JSON array of the report ids they can view. This is not returned if they can view all reports |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to access this study |
| Notes |
| Description | Check if a study exists in a namespace |
|---|---|
| URL | /study/exists |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (uuid || study_uid && storage_namespace && phi_namespace || study_uid && account_id) • The study uuid, the storage triplet, or the study uid and account id |
| Returns |
status • OK exists • Flag if the study exists |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields |
| Notes |
| Description | Push a study to a destination |
|---|---|
| URL | /study/push |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid destination_id • The destination to push it to batch_no • The batch number if pushing to a CD burner ping • Flag to send the ping job back in this call |
| Returns |
status • OK (uuid|ping) • Id of the push job or the ping job if the ping flag was sent |
| Permission | study_push |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or destination can not be found NOT_PERMITTED • You are not permitted to push this study PENDING • There is already a pending push job NOT_READY • The study is not ready for pushing |
| Notes |
| Description | Push a study HL7 message to a destination |
|---|---|
| URL | /study/push/hl7 |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid destination_id • The destination to push it to hl7_template_id • The HL7 template to use (optional) hl7_id • HL7 message to use in the template (optional) once • Flag that this message should only be sent a maximum of one time (optional) |
| Returns |
status • OK uuid • Id of the push job |
| Permission | study_push |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study, destination, template or hl7 message can not be found NOT_PERMITTED • You are not permitted to push this study NO_HL7_SUPPORT • The destination doesn't support HL7 |
| Notes |
|
| Description | Returns a PDF report for the study HL7 message |
|---|---|
| URL | /study/pdf/hl7 |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid hl7_id • HL7 message to create the PDF report for |
| Returns | Streams back the PDF report |
| Permission | study_report_hl7_view |
| Errors |
[404] • Not found |
| Notes |
| Description | Fax a PDF report for the study's HL7 message |
|---|---|
| URL | /study/fax/hl7 |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid hl7_id • HL7 message to create the PDF report for number • The fax number to send the PDF report to |
| Returns |
status • OK |
| Permission | study_report_hl7_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or HL7 message can not be found INVALID_PHONE • The fax number is invalid PDF_FAILED • The PDF report failed to generate |
| Notes |
| Description | Request a cmove of a study |
|---|---|
| URL | /study/cmove |
| Parameters |
uuid • The node id serial_no • The serial number of the node study_uid • The study uid aetitle • The aetitle to send to detail • Additional detail to send on the /node/ping (optional) ping • Flag to send the ping job back in this call |
| Returns |
status • OK (uuid|ping) • Id of the push job or the ping job if the ping flag was sent |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found STUDY_NOT_FOUND • The study can not be found DESTINATION_NOT_FOUND • The destination can not be found PENDING • There is already a pending push job NOT_READY • The study is not ready for pushing RETRIEVE • A thin study retrieval error. The error_subtype holds further detail |
| Notes |
|
| Description | Can a node remove a study from local disk cache |
|---|---|
| URL | /study/node/can/remove |
| Parameters |
uuid • The node id serial_no • The serial number of the node study_uid • The study uid |
| Returns |
status • OK can_remove • Flag if the node can remove the study from local cache |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The node can not be found STUDY_NOT_FOUND • The study can not be found |
| Notes |
| Description | Who can they share a study |
|---|---|
| URL | /study/share/who |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid type • Type of objects you want (account|location|group|user) |
| Returns |
status • OK shares • An array of the objects they can share this study with. Each object in the array will have the following fields * uuid • Id of the object * name • Name of the object |
| Permission | study_share |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or share object can not be found. The error_subtype holds a the name of the key that can not be found NOT_PERMITTED • You are not permitted to share this study |
| Notes |
| Description | Share a study |
|---|---|
| URL | /study/share |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (uuid || study_uid && storage_namespace && phi_namespace) • The study uuid or the storage triplet if you want a future share (account_id || location_id || group_id || user_id || share_code || email || masshiway || rsna || npi || study_request_id) • uuid of the account, location, group, user, study request or share code, email address(es), RSNA, NPI or masshiway recipient to share this study with message • Message to the recipient (optional) integration_key • Integration key to tag the share with (optional) charge_authorized • Flag that the sender authorized charging for this share (optional) charge_modality • Modality of the study the charge was authorized for (optional) customfield-{CUSTOMFIELD_UUID} • Custom field(s) to apply to the shared study (optional) |
| Returns |
status • OK |
| Permission | study_share |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or share object can not be found. The error_subtype holds a the name of the key that can not be found NOT_PERMITTED • You are not permitted to share this study NOT_MATCHED • This study does not match the study request criteria REQUEST_CLOSED • The study request is closed INVALID_PARAMETERS • Only pass a account_id or a location_id or a group_id or a user_id or a share code or an email INVALID_EMAIL • An invalid email was passed for an email share INVALID_NPI • An invalid NPI was passed for a NPI share PHANTOM • This is a phantom study INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field NOT_HASH • The field is not a JSON hash. The error_subtype holds the name of the field SHARE_FAILED (SAME) • The study can't be shared into the same namespace. SHARE_FAILED (NO_DESTINATION) • The study can't be shared with a deleted object. SHARE_FAILED (DECLINED) • The charge card was declined. SHARE_FAILED (NO_CARD) • The user does not have a card on file. SHARE_FAILED (NO_CHARGE_MODALITY) • The charge modality is required if charge_authorized is set and the charging is by modality. SHARE_FAILED (NO_DUP_SHARE) • The destination namespace has the no_dup_share flag turned on and this study is a duplicate of an existing study in the namespace. |
| Notes |
|
| Description | Stop sharing a study |
|---|---|
| URL | /study/share/stop |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid (account_id || location_id || group_id || user_id || user_invite_share_id) • uuid of the account, location, group, user or user invitation to stop sharing this study with |
| Returns |
status • OK |
| Permission | study_share |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or share object can not be found. The error_subtype holds a the name of the key that can not be found NOT_PERMITTED • You are not permitted to stop sharing this study INVALID_PARAMETERS • Only pass a account_id or a location_id or a group_id or a user_id |
| Notes |
| Description | Get the study shares |
|---|---|
| URL | /study/share/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid name • Flag to return a hash with both the uuid and name of the object (optional) |
| Returns |
status • OK account_id • A list of the account_ids the study is shared with location_id • A list of the location_ids the study is shared with group_id • A list of the group_ids the study is shared with user_id • A list of the user_ids the study is shared with user_invite_share_id • A list of the user invitations the study is shared with |
| Permission | study_share |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to view this list |
| Notes |
| Description | Approve a study |
|---|---|
| URL | /study/approve |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid delay • Number of seconds to delay showing the study as approved and running routing and events on it (optional) must_match • A JSON hash of study field names and values that must match before showing the study as approved and running routing and events on it (optional) |
| Returns |
status • OK |
| Permission | study_approve |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to approve this study DELAY_OR_MATCH • You can either delay or match, not both INVALID_DELAY • A delay must be between 0 and 600 seconds INVALID_JSON • The field is not in valid JSON format. The error_subtype holds the name of the field INVALID_FIELD • An invalid must match field was passed. The error_subtype holds the name of the field INVALID_CUSTOMFIELD • Some custom fields are required and not set. The error_subtype holds an array of the error details |
| Notes |
|
| Description | Reject a study |
|---|---|
| URL | /study/reject |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid message • Message to send to the person who shared the study (optional) |
| Returns |
status • OK |
| Permission | study_approve |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to approve this study |
| Notes |
|
| Description | Attach an audit action to a study |
|---|---|
| URL | /study/audit |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The id of the study (optional if study_uid and storage_namespace are passed) study_uid • The v3 storage uid of the study (optional if uuid is passed) storage_namespace • The storage namespace of the study (optional if uuid is passed) phi_namespace • The phi namespace of the study (optional) action • The audit action (STUDY_VIEW|STUDY_VIEW_REASON|STUDY_EDIT|STUDY_ANONYMIZE|REPORT_UPLOAD|REPORT_REMOVE|REPORT_VIEW|IMAGE_ADDED|IMAGE_UPDATED|IMAGE_DELETED|STUDY_DOWNLOAD|ACCEPTED_NOT_DIAGNOSTIC|CANCELED_NOT_DIAGNOSTIC|AI_ACTION|VIEWER_ACTION|SIGNED_REPORT_ADDENDUM) detail • Additional information |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found INVALID_ACTION • An invalid action was passed |
| Notes |
|
| Description | Set the star flag on a study for the user |
|---|---|
| URL | /study/star |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The id of the study star • Star flag set on or off (1|0) |
| Returns |
status • OK |
| Permission | study_star |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to star this study NOT_FOUND • The study can not be found INVALID_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag |
| Notes |
| Description | Build a study detailed report |
|---|---|
| URL | /study/report/detail |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • Limit to studies in the passed account filter.* Filters (optional) sort_by • Sorting (optional) limit • Maximum size of the report. The default is 30,000 rows. If the report will be bigger than this an error will be returned (optional) |
| Returns |
status • OK report_id • The report id |
| Permission | study_report_detail |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields REPORT_ERROR • Unable to start the report |
| Notes | This call will kick off the building of the report. Poll for the report status with /report/status command and download it with the /report/zip command. |
| Description | Build a series detail report for recently acquired studies |
|---|---|
| URL | /study/report/series |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) namespace_id • Namespace to run the report on hours • Report on studies acquired within the last number of hours limit • Maximum size of the report. The default is 30,000 studies. If the report will be bigger than this an error will be returned (optional) email • Send the report to this email address(es) when it is done |
| Returns |
status • OK report_id • The report id |
| Permission | study_report_detail |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields REPORT_ERROR • Unable to start the report |
| Notes |
|
| Description | Get the viewer settings for the study |
|---|---|
| URL | /study/viewer/settings |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (study_id || study_uid && storage_namespace && phi_namespace) • Either the study uuid or the storage triplet |
| Returns |
status • OK enable_v2_viewer • Value for the account flag enable_v3_viewer • Value for the account flag enable_viewer_print • Value for the account flag viewer_show_reports • Value for the account flag enable_viewer_export • Value for the account flag viewer_diagnostic_quality • Value for the account flag viewer_diagnostic_quality_always • Value for the account flag viewer_preload_diagnostic_images • Value for the account flag viewer_enable_mpr • Value for the account flag viewer_single_instance_series • Value for the account flag viewer_multiframe_split_method • Value for the account flag viewer_study_page_link_visible • Value for the account flag viewer_study_page_link_url • Value for the account flag viewer_setting_not_diagnostic • Value for the account flag auto_transcode • Value for the account flag auto_transcode_modalities • Value for the account flag viewer_default_mouse_tool • Value for the account flag viewer_link_series • Value for the account flag enable_viewer_toggle_annotations • Value for the account flag enable_dicom_tag_customfields • Value for the account flag radreport_branding_from_phi_namespace • Value for the account flag viewer_anon_annotations_clear • Value for the account flag accession_number_for_study_uid • Value for the account flag viewer_study_enable_cpp_transcoding • Value for the namespace || account flag no_edit_dicom_tags • If enable_dicom_tag_customfields is on this is a JSON list of the DICOM tags that can not be edited accelerators • A JSON list of accelerator FQDN the study may be on (only returned if the probe_for_accelerator flag is on) viewer_config • The viewer configuration JSON |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found |
| Notes |
| Description | Get the viewer3 settings for the study |
|---|---|
| URL | /study/viewer3/settings |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (study_id || study_uid && storage_namespace && phi_namespace) • Either the study uuid or the storage triplet settings • A JSON list of user settings set via /setting/set to return (optional) |
| Returns |
status • OK account_config • The account viewer3_config setting role_config • The role viewer3_config settings user_config • The user viewer3_confing settings accelerators • A JSON list of accelerator FQDN the study may be on (only returned if the probe_for_accelerator flag is on) enable_dicom_tag_customfields • Value for the account flag accession_number_for_study_uid • Value for the account flag viewer_study_page_link_visible • Value for the account flag with any brand override applied no_edit_dicom_tags • If enable_dicom_tag_customfields is on this is a JSON list of the DICOM tags that can not be edited viewer_study_enable_cpp_transcoding • Value for the namespace || account flag settings • JSON hash of the requested settings (optional) The rest of the fields are the same as /user/get |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found |
| Notes |
| Description | Gets the status and next available tags for a study according to account settings: study_status_tags + study_status_role_tags + study_status_tags_rules and role permission study_status_tags_ignore_rules |
|---|---|
| URL | /study/status/get |
| Parameters |
sid • The session id study_id • Study uuid * • Any other parameters that could be processed by study_status_tags_rules |
| Returns |
status • OK study_status • The study status. Is null for just created study. study_status_tags • The available study status tags. (This is only returned if they have study_status_editi> permission on the study and the study is not locked by another user) study_status_tags_default • The "default" value for study_status. It is calculated as (account.settings.study_status_tags_default || account.settings.study_status_tags[0]) |
| Permission | study_status_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 can not be found NOT_PERMITTED • You are not permitted to view the status for this study |
| Notes | Now study_status_tags is calculated this way: 1. Original list is account.settings.study_status_tags. 2. If account.settings.study_status_role_tags is non-empty, then all tags which are not set there for provided user_account.role are deleted from the list. 3. If permission study_status_tags_ignore_rules is not set and account.settings.study_status_tags_rules is non-empty, then "next values list" is calculated from that rules and the result is intersection of that two lists. |
| Description | Set the status of a study |
|---|---|
| URL | /study/status/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) study_id • Study uuid old • The old study status value new • The new study status value |
| Returns |
status • OK |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to set the status for this study STALE • The study status you have is stale INVALID_TAG • The study status new value is not a valid value LOCKED • Another user has locked this study SINGLETON • The stage is a singleton stage and the user already has a locked study |
| Notes | Possible tags against INVALID_VALUE are calculated as in /study/status/get with one exception - if account.settings.study_status_tags_ignore_rules_on_set is set, then it is calculated with no regard to account.settings.study_status_tags_rules, so only account.settings.study_status_role_tags is relevant. |
| Description | Returns a list of the studies the user has locked in the order they were locked |
|---|---|
| URL | /study/status/locks |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) page.* Pagination (optional) |
| Returns |
status • OK page • The pagination status hash studies • An array of the locked studies. Each object holds the following same fields as the /study/get call |
| Errors | |
| Notes |
| Description | Returns the history of the study status changes for the study |
|---|---|
| URL | /study/status/history |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) study_id • Study uuid |
| Returns |
status • OK history • An array of the status changes for the study. Each record has the following fields * date • Date and time of the change * old • The old status value * new • The new status value * seconds • The number of seconds the study was in the old status |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to view the status for this study |
| Notes |
| Description | Move the study to another PHI namespace |
|---|---|
| URL | /study/move |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id namespace_id • The namespace id |
| Returns |
status • OK |
| Permission | study_move |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or namespace was not found. NOT_PERMITTED • You are not permitted to move the study to this namespace ALREADY_EXISTS • The study already exists in the destination namespace |
| Notes | The user must have share permissions on the namespace they are trying to move the study too. |
| Description | Duplicate a study to another namespace |
|---|---|
| URL | /study/duplicate |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id (namespace_id || study_request_id) • The namespace or study request id to duplicate it to include_attachments • Also duplicate attachments (optional) overwrite • Flag if you want to overwrite an existing study in the destination namespace (optional) exclude_phi • Flag to not duplicate PHI data (optional) |
| Returns |
status • OK |
| Permission | study_duplicate for the study and study_upload for the destination namespace. study_duplicate_request is required additionally when duplicating by request |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study or namespace was not found. NOT_PERMITTED • You are not permitted to duplicate the study to this namespace ALREADY_EXISTS • The study already exists in the destination namespace FAILED • The storage call failed to run NOT_MATCHED • This study does not match the study request criteria REQUEST_CLOSED • The study request is closed NO_DESTINATION • The study can't be duplicated to a deleted object's namespace |
| Notes | This creates a full copy of the study as if it was uploaded into the namespace |
| Description | Clone a study optionally changing series/images uids |
|---|---|
| URL | /study/clone |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study id new_series_uids • Flag if you want to generate new uids for the study series (optional) new_image_uids • Flag if you want to generate new uids for the study images (optional) |
| Returns |
status • OK study_uid • new study uid |
| Permission | study_view and study_clone |
| Errors |
MISSING_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_FLAG • An invalid flag was passed. The error_subtype holds the name of the invalid flag NOT_FOUND • The study was not found. NOT_PERMITTED • You are not permitted to clone the study NOT_AVAILABLE • The study is not available. FAILED • The storage call failed to run |
| Notes | This creates a copy of the study with a new UID in the storage 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 viewer_tag • An external viewer's tag (optional) redirect • A flag to return an HTTP redirect to the viewer URL rather than the JSON structure view_reason • The view reason to be tracked in the audit trail (optional) |
| 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 |
The account's default external viewer (the default_external_viewer ) is selected in case viewer_tag was not passed. The first external viewer from the configured list is selected in case neither viewer_tag nor default_external_viewer were specified.
|
| 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) reload_load_dicom_tag • Flag to force a reload of all load_dicom_tag customfields (optional) |
| Returns |
status • OK |
| Permission |
sysadmin or study_sync permissions or if image_count is passed then study_upload or phr namespace is required |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The study can not be found NOT_PERMITTED • You are not permitted to sync this study BLOCKED • This is a repeat sync which is not allowed |
| Notes |
|
| Description | Take studies from take_study_source_namespace namespace. Studies will be shared. |
|---|---|
| URL | /study/take |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) namespace_id • The namespace id to take a study into |
| Returns |
status • OK |
| Permission | study_take |
| Errors |
NOTHING_TO_TAKE • There is no unshared studies in the source namespace MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The namespace was not found. NOT_PERMITTED • You are not permitted to take a study in this account NOT_ENABLED • the feature is not enabled check the enable_take_study_feature and take_study_source_namespace account settings |
| Notes |
|
| Description | Reuest studies from one of study_request_accounts accounts. Studies will be shared or duplicated. |
|---|---|
| URL | /study/request/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) namespace_id • The namespace id requested studies to put (share or duplicate) into comments • Free form request comments account_id • The account id to send the study request to patientid • The MRN a study should match (optional) patient_first_name • The patient first name a study should match patient_last_name • The patient last name a study should match patient_sex • The patient sex a study should match (optional) patient_birth_date • The patient date of birth a study should match modality • The modality a study should match (optional) study_date_start • The DICOM date that a study date should be greater or equal to (optional) study_date_end • The DICOM date that a study date should be less or equal to (optional) study_description • The string a study description should partially match (optional) |
| Returns |
status • OK uuid • The study request uuid |
| Permission | study_request_edit |
| Errors |
ALREADY • An active (pending or in progress) study request with the same study criteria and the same namespace/account combination already exists NOT_FOUND • The namespace or account was not found. NOT_PERMITTED • You are not permitted to request a study into this namespace |
| Notes |
|
| Description | Get the study_request |
|---|---|
| URL | /study/request/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study request uuid |
| Returns |
status • OK uuid • The study request uuid comments • Free form request comments study_request_status • Status of the study request. 'N' - pending, 'I' - in progress, 'R' - rejected, 'C' - closed patientid • The MRN a study should match patient_first_name • The patient first name a study should match patient_last_name • The patient last name a study should match patient_sex • The patient sex a study should match patient_birth_date • The patient date of birth a study should match modality • The modality a study should match study_date_start • The DICOM date that a study date should be greater or equal to study_date_end • The DICOM date that a study date should be less or equal to study_description • The string a study description should partially match message_count • The number of message passed through the study request. Returned if the user has message_view permission --- The following fields are only returned if the user has study_request_view permission in the requesting account --- requested_account_id • The account id that the study request is sent to namespace_id • Id of the namespace a study will be received into --- The following fields are only returned if the user has study_request_view_inbound permission in the requested account --- requesting_account_id • Id of the account that the study request was received from requesting_account_name • Name of the account that the study request was received from searches • A list of searches initiated using this study request. Each search is an destination search object with the following fields: uuid, pickup, status, created, updated, destination_id found • A list of search results produced for searches initiated using this study request. Each search result is an object with the following fields: uuid, destination_search_id, study_fetch_id, and other fields provided by a node (see studies parameter in /node/found) |
| Errors |
NOT_FOUND • The study request was not found NOT_PERMITTED • You are not permitted to access this study request |
| Notes |
| Description | Get matching studies for the request |
|---|---|
| URL | /study/request/match |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) study_request_id • The study request uuid |
| Returns |
status • OK studies • An array of the studies that are mathing request's criteria and the user has study_share_request or study_duplicate_request access permission. Each object holds the same fields as the /study/get call |
| Errors |
NOT_FOUND • The study request was not found REQUEST_CLOSED • The request is not active (pending or in progress) |
| Notes |
| Description | Revive a deleted study from storage during the storage_delete_delay period |
|---|---|
| URL | /study/revive |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The study uuid |
| Returns |
status • OK |
| Permission | sysadmin or support |
| Errors |
NOT_SYSADMIN_OR_SUPPORT • The user is not a sysadmin or support user NOT_FOUND • The deleted study can not be found CAN_NOT_REVIVE • The study can not be revived |
| Notes | This will reload the study from storage as a new study. |
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|Query) 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 or annotation_edit_only_own reset |
| Errors |
MISSING_FIELDS • A required 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 or annotation_edit_only_own reset |
| Errors |
MISSING_FIELDS • A required 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) do_unlock • A flag indicating to unlock study radreport lock (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 LOCKED • There is radreport-lock for the corresponding study by different SID. |
| Notes | If account.settings.enable_radreport_lock_reading is set, then it tries to radreport-lock in a study as in /study/lock?type=RADREPORT, updating it's radreport_uuid. If do_unlock is provided, then drops that radreport-lock after successful save. Error=LOCKED provides error_subtype=RADREPORT_LOCKED, error_data={"locked_radreport_id":radreport_uuid,"locked_user_id":user_uuid}. |
| 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) do_unlock • A flag indicating to unlock study radreport lock (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 LOCKED • There is radreport-lock for the corresponding study by different SID. |
| Notes | Look /radreport/add notes about enable_radreport_lock_reading. |
| 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 --- The following field is only returned if the enable_radreport_lock_reading account setting is enabled AND this radreport is locked --- locked_user_id • uuid of lock owner |
| 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 LOCKED • There is radreport-lock for the corresponding study by different USER. |
| Notes |
If account.settings.enable_radreport_lock_reading is set and there is radreport-locked for the study at the moment by different USER, then errot=LOCKED, error_subtype=RADREPORT_LOCKED, error_data={"locked_radreport_id":radreport_uuid,"locked_user_id":user_uuid}. |
| 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. See notes below. --- The following field is only returned if the enable_radreport_lock_reading account setting is enabled AND this radreport is locked --- locked_user_id • uuid of lock owner |
| 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 | Only if account.settings.enable_radreport_lock_reading is set. can_edit is set to 0 if this radreport is locked by another sid. |
| Description | Lock the radreport or prolongate the current lock |
|---|---|
| URL | /radreport/lock |
| 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 |
| Errors |
MISSING_FIELDS • A required 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 lock the radreport LOCKED • This radreport is locked at the moment by another sid. error_subtype=RADREPORT_LOCKED. error_data={"locked_radreport_id":radreport_uuid,"locked_user_id":user_uuid}. |
| Notes | If account.settings.enable_radreport_lock_reading is NOT set, then always NOT_PERMITTED. The same user cant lock radreport with other sid. Lock expires in 1 hour. Each next call prolongates it. On successful lock (not prolongate) the RADREPORT_LOCKED event is sent to study channel. |
| Description | Unlock the radreport |
|---|---|
| URL | /radreport/unlock |
| 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 |
| Errors |
MISSING_FIELDS • A required 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 lock the radreport ALREADY • This report is not locked LOCKED • This radreport is locked at the moment by another user. error_subtype=RADREPORT_LOCKED. error_data={"locked_radreport_id":radreport_uuid,"locked_user_id":user_uuid}. |
| Notes | If account.settings.enable_radreport_lock_reading is NOT set, then always NOT_PERMITTED. If lock owner is the same user, then radreport CAN be unlocked even if sid differs. On successful unlock the RADREPORT_UNLOCKED event is sent to study channel. |
| Description | List the radreports for a user |
|---|---|
| URL | /radreport/user/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) user_id • The user id filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash radreports • An array of the radreports. Each object holds the same fields as the /radreport/get call |
| Permission | This will only return radreports the calling user has radreport_view permissions for |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The user was not found. |
| Notes |
| Description | Get a list of the user radreport macros |
|---|---|
| URL | /radreportmacro/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account modality • Limit to this modality (optional) type • Limit to this type (optional) filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK macros • An array of the macros. Each object holds the same fields as the /radreportmacro/get call page • The pagination status hash |
| Permission | radreport_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to perform this operation |
| Notes |
| Description | Add a radreport macro |
|---|---|
| URL | /radreportmacro/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account modality • Modality type • Type of radreport name • Name of the macro body • JSON body of the macro hotkey • Hotkey of the macro (optional) |
| Returns |
status • OK uuid • Id of the macro |
| Permission | radreport_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to perform this operation |
| Notes |
| Description | Edit a radreport macro |
|---|---|
| URL | /radreportmacro/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the macro modality • Modality (optional) type • Type of radreport (optional) name • Name of the macro (optional) body • JSON body of the macro (optional) hotkey • Hotkey of the macro (optional) |
| Returns |
status • OK uuid • Id of the macro |
| Permission | radreport_edit plus ownership of the macro |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to perform this operation |
| Notes |
| Description | Get a radreport macro |
|---|---|
| URL | /radreportmacro/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the macro |
| Returns |
status • OK uuid • Id of the macro modality • Modality type • Type of radreport name • Name of the macro body • JSON body of the macro hotkey • Hotkey of the macro |
| Permission | radreport_view plus ownership of the macro |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to perform this operation |
| Notes |
| Description | Delete a radreport macro |
|---|---|
| URL | /radreportmacro/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the macro |
| Returns |
status • OK |
| Permission | radreport_edit plus ownership of the macro |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to perform this operation |
| Notes |
| Description | Returns the PDF report |
|---|---|
| URL | /radreport/pdf |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The radreport uuid |
| Returns | Streams back the PDF report |
| Permission | radreport_view |
| Errors |
[404] • Not found |
| Notes |
| Description | Fax the radreport |
|---|---|
| URL | /radreport/fax |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The radreport uuid number • The fax number to send the PDF report to |
| Returns |
status • OK |
| Permission | radreport_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport can not be found NOT_PERMITTED • You are not permitted to do this INVALID_PHONE • The fax number is invalid PDF_FAILED • The PDF report failed to generate NO_ATTACHMENT • The radreport does not have an attached report NOT_ENABLED • The radreport mailing out is not enabled for the account |
| Notes |
| Description | Email a radreport |
|---|---|
| URL | /radreport/email |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The radreport uuid email • The email address(es) to send the radreport to |
| Returns |
status • OK |
| Permission | radreport_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The radreport can not be found NOT_PERMITTED • You are not permitted to do this INVALID_EMAIL • An invalid email address was passed NO_ATTACHMENT • The radreport does not have an attached report PDF_FAILED • The PDF report failed to generate NOT_ENABLED • The radreport mailing out is not enabled for the account |
| 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) account_id • uuid of the account name • The name of the code type • Type of code (AI_CUSTOM_VALIDATION_CODE) language • Language of code (PYTHON) code • The code settings • JSON hash of settings (optional) zip • Base64 encoded ZIP file (optional) |
| Returns |
status • OK uuid • The code uuid |
| Permission | customcode_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to add code INVALID_TYPE • Invalid type INVALID_LANGUAGE • Invalid language NOT_HASH • The field is not a hash |
| Notes |
| Description | Get the code |
|---|---|
| URL | /customcode/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The code uuid |
| Returns |
status • OK uuid • The code uuid name • code name account_id • account uuid account_name • account name type • code type language • code language code • The code settings • JSON hash of settings is_deployed • Flag if the code is deployed deployments • An array of the customcode deployments, ordered from most recent to earliest. Each object has the fields in the /customcode/deploy/get call. has_zip • Flag if the code has an associated zip file |
| Permission | customcode_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The code can not be found NOT_PERMITTED • You are not permitted to view this code |
| Notes |
| Description | Modify the code |
|---|---|
| URL | /customcode/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The code uuid name • The name of the code (optional) code • The code (optional) settings • JSON hash of settings (optional) zip • Base64 encoded ZIP file (optional) |
| Returns |
status • OK uuid • The code uuid |
| Permission | customcode_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to edit the code NOT_HASH • The field is not a hash IS_DEPLOYED • The code is deployed and can not be edited ONE_ZIP_ONLY • Only one code with an attached zip can be deployed to the namespace |
| Notes |
| Description | Returns the customcode zip file |
|---|---|
| URL | /customcode/zip |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The code uuid |
| Returns | Streams back the zip file |
| Errors |
[404] • Not found |
| Notes |
| Description | Delete the code |
|---|---|
| URL | /customcode/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The code uuid |
| Returns |
status • OK |
| Permission | customcode_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_PERMITTED • You are not permitted to delete the code IS_DEPLOYED • The code is deployed and can not be deleted |
| Notes |
| Description | Get a list of the code for the account |
|---|---|
| URL | /customcode/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash customcodes • An array of the customcode. Each object holds the same fields as the /customcode/get call |
| Permission | customcode_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view code in this account |
| Notes |
|
| Description | Deploy customcode for a namespace |
|---|---|
| URL | /customcode/deploy |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of the customcode namespace_id • uuid of the namespace |
| Returns |
status • OK uuid • Deployment uuid |
| Permission | customcode_deploy |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The namespace or customcode can not be found NOT_PERMITTED • You are not permitted to deploy code in this namespace ALREADY • The code is already deployed for this namespace |
| Notes |
| Description | Un-deploy customcode |
|---|---|
| URL | /customcode/undeploy |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) deployment_id • Deployment uuid |
| Returns |
status • OK |
| Permission | customcode_deploy |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The deployment can not be found NOT_PERMITTED • You are not permitted to undeploy code in this namespace |
| Notes |
| Description | Get a customcode deployment |
|---|---|
| URL | /customcode/deploy/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • uuid of customcode deployment |
| Returns |
status • OK uuid • uuid of the deployment customcode_id • uuid of the customcode customcode_name • name of the customcode namespace_id • uuid of the namespace namespace_name • name of the namespace |
| Permission | customcode_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The customcode deployment can not be found NOT_PERMITTED • You are not permitted to do this |
| Notes |
| Description | List customcode deployments |
|---|---|
| URL | /customcode/deploy/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) (namespace_id || customcode_id) • uuid of either the namespace or customcode to show the deployments for filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash deployments • An array of the objects. Each object in the array will have the fields available in /customcode/deploy/get |
| Permission | customcode_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The namespace or customcode can not be found NOT_PERMITTED • You are not permitted to do this |
| Notes |
Case commands
Cases are automatically created by the second opinion workflow for a share 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 |
Patient commands
| Description | Add a patient |
|---|---|
| URL | /patient/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account to add them to study_id • Id of the study to create a patient from (optional) (name || first && last) • Patient name as either full name or first and last (optional if study_id is used) mrn • MRN (optional if study_id is used) sex • Gender (optional) birth_date • Birth date (optional) email • Email address (optional) mobile_phone • Mobile phone number (optional) alt_email • Alternate email address (optional) alt_mobile_phone • Alternate mobile phone number (optional) customfield-{CUSTOMFIELD_UUID} • Custom field(s) (optional) event_share • Notify the patient if a new study is available on the patient portal (optional) event_new_report • Notify the patient if a report is attached on the patient portal (optional) |
| Returns |
status • OK uuid • The uuid |
| Permission | patient_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account or study was not found. The error_subtype holds the type of field not found NOT_PERMITTED • You are not permitted to add a patient to the account INVALID_PHONE • The phone number is invalid INVALID_EMAIL • The email is invalid ALREADY_EXISTS • The patient is already in the account ALREADY_USED • The email or phone number is already used by another patient. The error_subtype holds the field that is already used INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details |
| Notes |
|
| Description | Get a patient |
|---|---|
| URL | /patient/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The patient uuid |
| Returns |
status • OK uuid • The patient uuid name • Patient name first • Patient first name last • Patient last name mrn • MRN sex • Gender birth_date • Birth date email • Email address mobile_phone • Mobile phone number alt_email • Alternate email address alt_mobile_phone • Alternate mobile phone number event_share • Notify the patient if a new study is available on the patient portal event_new_report • Notify the patient if a report is attached on the patient portal tags • An array of user tags associated with this object (This is only returned if the object has tags) customfields • An array of the custom fields associated with this patient. Each object has the following fields (This is only returned if the group has custom fields) studies • An array of study ids linked with this patient (having the same mrn), which this user has access to. |
| Permission | patient_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to view this patient |
| Notes |
| Description | Edit a patient |
|---|---|
| URL | /patient/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The patient uuid (name || first && last) • Patient name as either full name or first and last mrn • MRN sex • Gender birth_date • Birth date email • Email address (optional) mobile_phone • Mobile phone number (optional) alt_email • Alternate email address (optional) alt_mobile_phone • Alternate mobile phone number (optional) event_share • Notify the patient if a new study is available on the patient portal (optional) event_new_report • Notify the patient if a report is attached on the patient portal (optional) customfield-{CUSTOMFIELD_UUID} • Custom field(s) (optional) settings • A hash of the patient settings, see Notes. (optional) setting_{SETTING_NAME} • Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional) |
| Returns |
status • OK |
| Permission | 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 NO_PATIENT_OVERRIDE • The setting does not allow a patient override INVALID_SETTING • An invalid setting was passed. The error_subtype holds the name of the invalid setting INVALID_SETTING_VALUE • An invalid setting value was passed. The error_subtype holds the name of the setting with the invalid value |
| Notes | Current allowed settings are patient_portal_event_new_report_notify_type and patient_portal_event_share_notify_type |
| Description | Merge patients with optionally setting some of patient fields |
|---|---|
| URL | /patient/merge |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The destination patient uuid src • The JSON array of patient uuids to merge into destionation do_update_patient_studies • Update patient studies' sex an phone if those are modified (optional) do_delete • Delete src patients after merge (optional) sex • Gender (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) event_share • Notify the patient if a new study is available on the patient portal (optional) event_new_report • Notify the patient if a report is attached on the patient portal (optional) customfield-{CUSTOMFIELD_UUID} • Custom field(s) (optional) settings • A hash of the patient settings, see Notes. (optional) setting_{SETTING_NAME} • Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional) |
| Returns |
status • OK |
| Permission | patient_merge |
| Errors |
NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to merge the patients PATIENT_NAME_DOB_MISMATCH • Patients should contain the same name and date of birth MULTIPLE_ACCOUNTS • Patients from different accounts provided INVALID_PHONE • The phone number is invalid INVALID_EMAIL • The email is invalid 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 NO_PATIENT_OVERRIDE • The setting does not allow a patient override INVALID_SETTING • An invalid setting was passed. The error_subtype holds the name of the invalid setting INVALID_SETTING_VALUE • An invalid setting value was passed. The error_subtype holds the name of the setting with the invalid value |
| Notes | If account.settings.auto_update_patient_studies is set, then do_update_patient_studies is set. |
| Description | Delete a patient |
|---|---|
| URL | /patient/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The patient uuid |
| Returns |
status • OK |
| Permission | patient_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to delete the patient |
| Notes |
| Description | Get a list of the patients in the account |
|---|---|
| URL | /patient/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash patients • An array of the patients. Each object holds the same fields as the /patient/get call |
| Permission | patient_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view patients in this account |
| Notes | The default sort is by recent activity. |
| Description | Get a list of the studies for the patient |
|---|---|
| URL | /patient/study/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The patient id viewable_only • Flag if they only want the studies the user can view |
| Returns |
status • OK studies • An array of the studies. Each object holds the same fields as the /study/get call |
| Permission | patient_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to view this patient |
| Notes |
| Description | Find a patient for the portal |
|---|---|
| URL | /patient/portal/find |
| Parameters |
first • The first name last • The last name birth_date • Date of birth mrn • MRN (required if the require_mrn_for_patient_portal account setting is on) |
| Returns |
status • OK patient_id • The patient id study_count • The number of studies for the patient email • The obscured version of the patient email mobile_phone • The obscured version of the patient phone alt_email • The obscured version of the patient email alt_mobile_phone • The obscured version of the patient phone dup_email • Flag if another patient has the same email dup_mobile_phone • Flag if another patient has the same mobile_phone other_patients • An array of the other matching patients. Each object holds the same fields as documented above. This field is only returned if there are other matching patients. |
| Permission | The enable_patient_portal flag needs to be turned on for the account and the call needs to come for a vanity for the account |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to perform this search INVALID_DATE • An invalid date was passed |
| Notes |
|
| Description | Send a PIN to the patient |
|---|---|
| URL | /patient/portal/pin |
| Parameters |
patient_id • The patient id email • Flag if they want the PIN sent via email mobile_phone • Flag if they want the PIN sent via SMS alt_email • Flag if they want the PIN sent via the alt_email alt_mobile_phone • Flag if they want the PIN sent via SMS to the alt_mobile_phone |
| Returns |
status • OK |
| Permission | The enable_patient_portal flag needs to be turned on for the account and the call needs to come for a vanity for the account |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found NOT_PERMITTED • You are not permitted to do this |
| Notes |
|
| Description | Login to the patient portal |
|---|---|
| URL | /patient/portal/login |
| Parameters |
patient_id • The patient id pin • The PIN |
| Returns |
status • OK sid • Session id |
| Permission | The enable_patient_portal flag needs to be turned on for the account and the call needs to come for a vanity for the account |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The patient can not be found INVALID_PIN • The PIN is invalid or expired NOT_PERMITTED • You are not permitted to do this LOCKOUT • Too many failed attempts |
| Notes |
| Description | List user's accounts with patient portal enabled |
|---|---|
| URL | /patient/portal/list |
| Parameters |
page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash portals • An array of the accounts with patient portal enabled. Each object holds the following fields * uuid • The account UUID * name • Name of the account * vanity • Vanity host name(s) for the account |
| Permission | |
| Errors | |
| Notes | Only patient portals with the expose_patient_portal setting turned on are returned. |
Order commands
| Description | Add a order |
|---|---|
| URL | /order/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account to add them to patientid • Patient MRN patient_name • Patient name accession_number • Accession number patient_sex • Gender patient_birth_date • DOB referring_physician • Referring physician sending_facility • Sending facility customfield-{CUSTOMFIELD_UUID} • Custom field(s) (optional) |
| Returns |
status • OK uuid • The uuid |
| Permission | order_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account was not found. The error_subtype holds the type of field not found NOT_PERMITTED • You are not permitted to add a order to the account INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details |
| Notes |
| Description | Get an order |
|---|---|
| URL | /order/get |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The order uuid |
| Returns |
status • OK uuid • The order uuid patientid • Patient MRN patient_name • Patient name accession_number • Accession number patient_sex • Gender patient_birth_date • DOB referring_physician • Referring physician sending_facility • Sending facility tags • An array of user tags associated with this object (This is only returned if the object has tags) customfields • An array of the custom fields associated with this order. Each object has the following fields (This is only returned if the order has custom fields) sps • An array of the SPS records associated with this order. Each record has the following fields * uuid • Id of the SPS * modality • Modality * scheduled_procedure_step_id • Step ID * requested_procedure_id • Procedure ID * requested_procedure_description • Procedure description * scheduled_station_aetitle • Station AE title * scheduled_procedure_step_start_date • Start date * scheduled_procedure_step_start_time • Start time * scheduled_procedure_step_description • Step description * mpps_status • The modality performed procedure step (mpps) status * mpps_uid • The UID for the mpps --- The following field is only returned if the enable_orders_in_worklist account setting is enabled --- studies • An array of study ids linked with this order (having the same accession_number). |
| Permission | order_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The order can not be found NOT_PERMITTED • You are not permitted to view this order |
| Notes |
| Description | Edit a order |
|---|---|
| URL | /order/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The order uuid patientid • Patient MRN patient_name • Patient name accession_number • Accession number patient_sex • Gender patient_birth_date • DOB referring_physician • Referring physician sending_facility • Sending facility customfield-{CUSTOMFIELD_UUID} • Custom field(s) (optional) |
| Returns |
status • OK |
| Permission | order_edit |
| Errors |
NOT_FOUND • The order can not be found NOT_PERMITTED • You are not permitted to edit the order INVALID_CUSTOMFIELD • Invalid custom field(s) name or value were passed. The error_subtype holds an array of the error details |
| Notes |
| Description | Delete a order |
|---|---|
| URL | /order/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • The order uuid |
| Returns |
status • OK |
| Permission | order_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The order can not be found NOT_PERMITTED • You are not permitted to delete the order |
| Notes |
| Description | Get a list of the orders in the account |
|---|---|
| URL | /order/list |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) account_id • uuid of the account filter.* Filters (optional) page.* Pagination (optional) sort_by • Sorting (optional) |
| Returns |
status • OK page • The pagination status hash orders • An array of the orders. Each object holds the same fields as the /order/get call |
| Permission | order_view |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The account can not be found NOT_PERMITTED • You are not permitted to view orders in this account |
| Notes |
|
| Description | Add a scheduled procedure step to an order |
|---|---|
| URL | /order/sps/add |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) order_id • uuid of the order modality • Modality scheduled_procedure_step_id • Step ID requested_procedure_id • Procedure ID requested_procedure_description • Procedure description scheduled_station_aetitle • Station AE title scheduled_procedure_step_start_date • Start date scheduled_procedure_step_start_time • Start time scheduled_procedure_step_description • Step description |
| Returns |
status • OK uuid • UUID of the SPS |
| Permission | order_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The order can not be found NOT_PERMITTED • You are not permitted to edit orders in this account |
| Notes |
| Description | Edit a scheduled procedure step |
|---|---|
| URL | /order/sps/set |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • UUID of the SPS modality • Modality (optional) scheduled_procedure_step_id • Step ID (optional) requested_procedure_id • Procedure ID (optional) requested_procedure_description • Procedure description (optional) scheduled_station_aetitle • Station AE title (optional) scheduled_procedure_step_start_date • Start date (optional) scheduled_procedure_step_start_time • Start time (optional) scheduled_procedure_step_description • Step description (optional) |
| Returns |
status • OK |
| Permission | order_edit |
| Errors |
MISSING_FIELDS • A required field is missing or does not have data in it. The error_subtype holds a array of all the missing fields NOT_FOUND • The SPS can not be found NOT_PERMITTED • You are not permitted to edit orders in this account |
| Notes |
| Description | Delete a scheduled procedure step |
|---|---|
| URL | /order/sps/delete |
| Parameters |
sid • The session id (optional if basic authentication or an OAuth token is used) uuid • UUID of the SPS |
| Returns |
status • OK |
| Permission | order_edit |
| Errors |