Service namespace¶
-
class
ambra_sdk.service.entrypoints.Account(api)[source]¶ Account.
Can share.
- Parameters
account_id – The account id
by_id – The uuid of the object that can share
by_type – The type of object that can share. (user|account|group|location)
with_id – The uuid of the object that they can share with
with_type – The type of object that they can share with (user|account|group|location)
Can share list.
- Parameters
account_id – The account id
Can share stop.
- Parameters
account_id – The account id
by_id – The uuid of the object that can share
by_type – The type of object that can share. (user|account|group|location)
with_id – The uuid of the object that they can share with
with_type – The type of object that they can share with (user|account|group|location)
-
get(uuid, brand_settings=None, permissions=None)[source]¶ Get.
- Parameters
uuid – The account uuid
brand_settings – A comma delimited list of the settings from /brand/get for this vanity to return (optional)
permissions – Flag to return the users role and permissions in the accounts (optional)
-
list(permissions=None)[source]¶ List.
- Parameters
permissions – Flag to return the users role and permissions in the accounts (optional)
-
list_requestable(namespace_id)[source]¶ List requestable.
- Parameters
namespace_id – Id of the namespace to receive requested studies into
-
md5_counter(md5, uuid, node_id=None, serial_no=None)[source]¶ Md5 counter.
- Parameters
md5 – The MD5 value
uuid – UUID of the account (only needed for sid authentication)
node_id – node_id
serial_no – serial_no
Radreport email authorize.
- Parameters
captcha_response – A solved captcha
uuid – The account id
-
set(uuid, can_request=None, css=None, customfield_param=None, hl7_template=None, must_approve=None, must_approve_harvest=None, must_approve_move=None, must_approve_upload=None, name=None, no_share=None, password_expire=None, role_id=None, search_threshold=None, session_expire=None, setting_param=None, settings=None, share_code=None, share_description=None, share_settings=None, share_via_gateway=None, site_management_account_id=None, vanity=None, vendor=None)[source]¶ Set.
- Parameters
uuid – The account uuid
can_request – Flag if user can request to join the account (optional)
css – Custom CSS for the account (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
hl7_template – The HL7 reporting template for the account (optional)
must_approve – Flag if shared studies must be approved for the account namespace (optional)
must_approve_harvest – Flag if harvested studies must be approved (optional)
must_approve_move – Flag if moved studies must be approved (optional)
must_approve_upload – Flag if uploaded studies must be approved (optional)
name – Name of the account (optional)
no_share – Flag if studies can not be shared with this account (optional). Studies can still be shared with locations, groups and users in the account.
password_expire – Number of days before account passwords expire. No expiration if zero. (optional)
role_id – Id for the default role for the account (optional)
search_threshold – The number of studies record in the namespace to switch the UI from list to search mode (optional)
session_expire – Number of minutes before an idle session expires. (optional)
setting_param – Expected values are SETTING_NAME. Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional)
settings – A hash of the account settings (optional)
share_code – The share code of the account (optional)
share_description – The share description of the account (optional)
share_settings – Share settings JSON structure of the share display settings (optional)
share_via_gateway – Flag if a gateway share is allowed (optional)
site_management_account_id – The corresponding site management account (optional)
vanity – Vanity host name for the account. Multiple host names can be specified in a comma separate list (optional)
vendor – Vendor name (optional)
-
settings(account_id=None, brand_settings=None, namespace_id=None, settings=None, vanity=None)[source]¶ Settings.
- Parameters
account_id – account_id
brand_settings – A comma delimited list of the settings from /brand/get for this vanity to return (optional)
namespace_id – Apply overrides for the namespace (optional)
settings – A comma delimited list of the settings to return (optional)
vanity – vanity
-
settings_validate(uuid, setting_param=None, settings=None)[source]¶ Settings validate.
- Parameters
uuid – The account uuid
setting_param – Expected values are SETTING_NAME. Validate an individual setting. This is an alternative to the settings hash (optional)
settings – A hash of the account settings with values to validate (optional)
-
user_add(uuid, account_alias=None, account_email=None, account_login=None, account_password=None, customfield_param=None, email=None, epic_user=None, event_approve=None, event_case_assignment=None, event_harvest=None, event_incoming_study_request=None, event_join=None, event_link=None, event_link_mine=None, event_message=None, event_new_report=None, event_node=None, event_purge=None, event_query_add=None, event_query_edit=None, event_query_reply=None, event_report_remove=None, event_share=None, event_site_qualified=None, event_status_change=None, event_study_comment=None, event_thin_study_fail=None, event_thin_study_success=None, event_upload=None, event_upload_fail=None, global_param=None, global_role_id=None, max_sessions=None, password_reset=None, role_id=None, session_expire=None, set_default_organization=None, setting_param=None, settings=None, sso_only=None, user_id=None)[source]¶ User add.
- Parameters
uuid – The account uuid
account_alias – Users alias in the account. (optional).
account_email – Users account_email. Only set this if it is different than the users login email (optional).
account_login – Users login name in the account. (optional).
account_password – Password for the account_password. (optional).
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
email – email
epic_user – Epic user used to map Epic users into Ambra’s ones to track activity. (optional).
event_approve – Notify the user on a approval needed into the account namespace (optional)
event_case_assignment – Notify the user when they are assigned a case as a medical or admin user (optional)
event_harvest – Notify the user on a harvest into the account namespace (optional)
event_incoming_study_request – Notify the user when they get an incoming study request (optional)
event_join – Notify the user on a join request for the account (optional)
event_link – Notify the user when an anonymous link is hit in the namespace (optional)
event_link_mine – Notify the user when an anonymous link created by the user is hit in the namespace (optional)
event_message – Notify the user when a message is sent to the account namespace (optional)
event_new_report – Notify the user when a report is attached in the account namespace (optional)
event_node – Notify the user when an account node sends an event (optional)
event_purge – Notify the user the results of a purge job for the account (optional)
event_query_add – Notify the user when a new query is issued (optional)
event_query_edit – Notify the user when a query is edites (optional)
event_query_reply – Notify the user when they leave a new reply in a query (optional)
event_report_remove – Notify the user when a report is removed in the account namespace (optional)
event_share – Notify the user on a share into the account namespace (optional)
event_site_qualified – Notify the user when a trial site is qualified for the clinical trial account (optional)
event_status_change – Notify the user when the status of a study is changed (optional)
event_study_comment – Notify the user when a comment is attached to a study in the namespace (optional)
event_thin_study_fail – Notify the user when a thin study retrieval they initiated fails (optional)
event_thin_study_success – Notify the user when a thin study retrieval they initiated succeeds (optional)
event_upload – Notify the user on an upload into the account namespace (optional)
event_upload_fail – Notify the user on a failed upload into the account namespace (optional)
global_param – Flag if this is a global user (optional).
global_role_id – uuid of a role to be used in groups and locations when the global user is added to them, this role overrides groups’/locations’ default roles (optional).
max_sessions – Over-ride value for the max number of simultaneous sessions the user can have. (optional).
password_reset – Flag if the password needs to be reset. (optional).
role_id – uuid of the users role in the account (optional).
session_expire – Number of minutes before an idle session expires. (optional)
set_default_organization – A flag to set this account as a default one for the user using user_default_organization Setting. (optional)
setting_param – Expected values are SETTING_NAME. Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional)
settings – A hash of the account settings that the user can override (optional)
sso_only – Flag if the user can only login via SSO. (optional).
user_id – user_id
-
user_delete(user_id, uuid)[source]¶ User delete.
- Parameters
user_id – The user uuid
uuid – The account uuid
-
user_get(user_id, uuid)[source]¶ User get.
- Parameters
user_id – The users uuid
uuid – The account uuid
-
user_report_login(uuid, user_id=None)[source]¶ User report login.
- Parameters
uuid – The account uuid
user_id – Limit to this user_id (optional)
-
user_set(user_id, uuid, account_alias=None, account_email=None, account_login=None, account_password=None, customfield_param=None, epic_user=None, event_approve=None, event_case_assignment=None, event_harvest=None, event_incoming_study_request=None, event_join=None, event_link=None, event_link_mine=None, event_message=None, event_new_report=None, event_node=None, event_purge=None, event_query_add=None, event_query_edit=None, event_query_reply=None, event_report_remove=None, event_share=None, event_site_qualified=None, event_status_change=None, event_study_comment=None, event_thin_study_fail=None, event_thin_study_success=None, event_upload=None, event_upload_fail=None, global_param=None, global_role_id=None, max_sessions=None, password_reset=None, role_id=None, session_expire=None, setting_param=None, settings=None, sso_only=None)[source]¶ User set.
- Parameters
user_id – The users uuid
uuid – The account uuid
account_alias – Users alias in the account. (optional).
account_email – Users account_email. Only set this if it is different than the users login email (optional).
account_login – Users login name in the account. (optional).
account_password – Password for the account_password. (optional).
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
epic_user – Epic user used to map Epic users into Ambra’s ones to track activity (optional).
event_approve – Notify the user on a approval needed into the account namespace (optional)
event_case_assignment – Notify the user when they are assigned a case as a medical or admin user (optional)
event_harvest – Notify the user on a harvest into the account namespace (optional)
event_incoming_study_request – Notify the user when they get an incoming study request (optional)
event_join – Notify the user on a join request for the account (optional)
event_link – Notify the user when an anonymous link is hit in the namespace (optional)
event_link_mine – Notify the user when an anonymous link created by the user is hit in the namespace (optional)
event_message – Notify the user when a message is sent to the account namespace (optional)
event_new_report – Notify the user when a report is attached in the account namespace (optional)
event_node – Notify the user when an account node sends an event (optional)
event_purge – Notify the user the results of a purge job for the account (optional)
event_query_add – Notify the user when a new query is issued (optional)
event_query_edit – Notify the user when a query is edites (optional)
event_query_reply – Notify the user when they leave a new reply in a query (optional)
event_report_remove – Notify the user when a report is removed in the account namespace (optional)
event_share – Notify the user on a share into the account namespace (optional)
event_site_qualified – Notify the user when a trial site is qualified for the clinical trial account (optional)
event_status_change – Notify the user when the status of a study is changed (optional)
event_study_comment – Notify the user when a comment is attached to a study in the namespace (optional)
event_thin_study_fail – Notify the user when a thin study retrieval they initiated fails (optional)
event_thin_study_success – Notify the user when a thin study retrieval they initiated succeeds (optional)
event_upload – Notify the user on an upload into the account namespace (optional)
event_upload_fail – Notify the user on a failed upload into the account namespace (optional)
global_param – Flag if this is a global user. (optional).
global_role_id – uuid of a role to be used in groups and locations when the global user is added to them, this role overrides groups’/locations’ default roles (optional).
max_sessions – Over-ride value for the max number of simultaneous sessions the user can have. (optional).
password_reset – Flag if the password needs to be reset. (optional).
role_id – uuid of the users role in the account (optional).
session_expire – Number of minutes before an idle session expires. (optional)
setting_param – Expected values are SETTING_NAME. Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional)
settings – A hash of the account settings that the user can override (optional)
sso_only – Flag if the user can only login via SSO. (optional).
-
class
ambra_sdk.service.entrypoints.Activity(api)[source]¶ Activity.
-
get(uuid, study_extra=None)[source]¶ Get.
- Parameters
uuid – The activity uuid
study_extra – Flag to return extra study fields (optional)
-
list(account_id, strict_account_filter=None, study_extra=None)[source]¶ List.
- Parameters
account_id – Limit to activities in this account and the personal activities
strict_account_filter – Flag to apply the account_id to personal activites as well (optional)
study_extra – Flag to return extra study fields (optional)
-
-
class
ambra_sdk.service.entrypoints.Analytics(api)[source]¶ Analytics.
-
patient_portal(account_id, count, period, time_zone, end_date=None, patient_id=None)[source]¶ Patient portal.
- Parameters
account_id – The account id
count – The number of periods to get
period – The time period (day|week|month|year)
time_zone – The report’s time zone. Time zone selection order: current user’s time zone, time_zone parameter, UTC by default.
end_date – The end date, default is today if not passed (optional)
patient_id – Patient filter (optional)
-
radreport(account_id, count, period, time_zone, end_date=None, namespace_id=None, user_id=None)[source]¶ Radreport.
- Parameters
account_id – The account id
count – The number of periods to get
period – The time period (day|week|month|year)
time_zone – The report’s time zone. Time zone selection order: current user’s time zone, time_zone parameter, UTC by default.
end_date – The end date, default is today if not passed (optional)
namespace_id – Namespace filter (optional)
user_id – User filter (optional)
-
study(count, period, time_zone, account_id=None, customfield_param=None, end_date=None, modality=None, namespace_id=None)[source]¶ Study.
- Parameters
count – The number of periods to get
period – The time period (day|week|month|year)
time_zone – The report’s time zone. Time zone selection order: current user’s time zone, time_zone parameter, UTC by default.
account_id – account_id
customfield_param – Expected values are CUSTOMFIELD_UUID. Filter analytics by a subset of study customfields (optional)
end_date – The end date, default is today if not passed (optional)
modality – Filter analytics by modality (optional)
namespace_id – namespace_id
-
user(account_id, count, period, time_zone, end_date=None, end_time=None, namespace_id=None, user_id=None)[source]¶ User.
- Parameters
account_id – The account id
count – The number of periods to get
period – The time period (hour|day|week|month|year)
time_zone – The report’s time zone. Time zone selection order: current user’s time zone, time_zone parameter, UTC by default.
end_date – The end date, for backwards compatibility (optional)
end_time – The end date and time, default is now if not passed (optional)
namespace_id – Namespace filter (optional)
user_id – User filter (optional)
-
-
class
ambra_sdk.service.entrypoints.Annotation(api)[source]¶ Annotation.
-
add(frame_number, instance_uid, series_uid, json=None, phi_namespace=None, stamp=None, storage_namespace=None, study_id=None, study_uid=None)[source]¶ Add.
- Parameters
frame_number – The frame number
instance_uid – The instance uid
series_uid – The series uid
json – json
phi_namespace – phi_namespace
stamp – stamp
storage_namespace – storage_namespace
study_id – study_id
study_uid – study_uid
-
-
class
ambra_sdk.service.entrypoints.Anonymization(api)[source]¶ Anonymization.
-
class
ambra_sdk.service.entrypoints.Appointment(api)[source]¶ Appointment.
-
add(account_id, end_time, patient_id, start_time, customfield_param=None, description=None, user_id=None)[source]¶ Add.
- Parameters
account_id – uuid of the account to add them to
end_time – End date and time of the appointment
patient_id – Id of the patient to create the appointment for
start_time – Start date and time of the appointment
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
description – Description of the appointment (optional)
user_id – Id of the user to create the appointment for (optional defaults to current user)
-
set(customfields, description, end_time, start_time, user_id, uuid, status=None)[source]¶ Set.
- Parameters
customfields – An array of the custom fields associated with this appointment. Each object has the following fields (This is only returned if the group has custom fields)
description – Description of the appointment
end_time – End date and time of the appointment
start_time – Start date and time of the appointment
user_id – Id of the user
uuid – The appointment uuid
status – Status of the appointment (A|C|D) - Active, Cancelled, Discontinued (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncAccount(api)[source]¶ AsyncAccount.
Can share.
- Parameters
account_id – The account id
by_id – The uuid of the object that can share
by_type – The type of object that can share. (user|account|group|location)
with_id – The uuid of the object that they can share with
with_type – The type of object that they can share with (user|account|group|location)
Can share list.
- Parameters
account_id – The account id
Can share stop.
- Parameters
account_id – The account id
by_id – The uuid of the object that can share
by_type – The type of object that can share. (user|account|group|location)
with_id – The uuid of the object that they can share with
with_type – The type of object that they can share with (user|account|group|location)
-
get(uuid, brand_settings=None, permissions=None)[source]¶ Get.
- Parameters
uuid – The account uuid
brand_settings – A comma delimited list of the settings from /brand/get for this vanity to return (optional)
permissions – Flag to return the users role and permissions in the accounts (optional)
-
list(permissions=None)[source]¶ List.
- Parameters
permissions – Flag to return the users role and permissions in the accounts (optional)
-
list_requestable(namespace_id)[source]¶ List requestable.
- Parameters
namespace_id – Id of the namespace to receive requested studies into
-
md5_counter(md5, uuid, node_id=None, serial_no=None)[source]¶ Md5 counter.
- Parameters
md5 – The MD5 value
uuid – UUID of the account (only needed for sid authentication)
node_id – node_id
serial_no – serial_no
Radreport email authorize.
- Parameters
captcha_response – A solved captcha
uuid – The account id
-
set(uuid, can_request=None, css=None, customfield_param=None, hl7_template=None, must_approve=None, must_approve_harvest=None, must_approve_move=None, must_approve_upload=None, name=None, no_share=None, password_expire=None, role_id=None, search_threshold=None, session_expire=None, setting_param=None, settings=None, share_code=None, share_description=None, share_settings=None, share_via_gateway=None, site_management_account_id=None, vanity=None, vendor=None)[source]¶ Set.
- Parameters
uuid – The account uuid
can_request – Flag if user can request to join the account (optional)
css – Custom CSS for the account (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
hl7_template – The HL7 reporting template for the account (optional)
must_approve – Flag if shared studies must be approved for the account namespace (optional)
must_approve_harvest – Flag if harvested studies must be approved (optional)
must_approve_move – Flag if moved studies must be approved (optional)
must_approve_upload – Flag if uploaded studies must be approved (optional)
name – Name of the account (optional)
no_share – Flag if studies can not be shared with this account (optional). Studies can still be shared with locations, groups and users in the account.
password_expire – Number of days before account passwords expire. No expiration if zero. (optional)
role_id – Id for the default role for the account (optional)
search_threshold – The number of studies record in the namespace to switch the UI from list to search mode (optional)
session_expire – Number of minutes before an idle session expires. (optional)
setting_param – Expected values are SETTING_NAME. Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional)
settings – A hash of the account settings (optional)
share_code – The share code of the account (optional)
share_description – The share description of the account (optional)
share_settings – Share settings JSON structure of the share display settings (optional)
share_via_gateway – Flag if a gateway share is allowed (optional)
site_management_account_id – The corresponding site management account (optional)
vanity – Vanity host name for the account. Multiple host names can be specified in a comma separate list (optional)
vendor – Vendor name (optional)
-
settings(account_id=None, brand_settings=None, namespace_id=None, settings=None, vanity=None)[source]¶ Settings.
- Parameters
account_id – account_id
brand_settings – A comma delimited list of the settings from /brand/get for this vanity to return (optional)
namespace_id – Apply overrides for the namespace (optional)
settings – A comma delimited list of the settings to return (optional)
vanity – vanity
-
settings_validate(uuid, setting_param=None, settings=None)[source]¶ Settings validate.
- Parameters
uuid – The account uuid
setting_param – Expected values are SETTING_NAME. Validate an individual setting. This is an alternative to the settings hash (optional)
settings – A hash of the account settings with values to validate (optional)
-
user_add(uuid, account_alias=None, account_email=None, account_login=None, account_password=None, customfield_param=None, email=None, epic_user=None, event_approve=None, event_case_assignment=None, event_harvest=None, event_incoming_study_request=None, event_join=None, event_link=None, event_link_mine=None, event_message=None, event_new_report=None, event_node=None, event_purge=None, event_query_add=None, event_query_edit=None, event_query_reply=None, event_report_remove=None, event_share=None, event_site_qualified=None, event_status_change=None, event_study_comment=None, event_thin_study_fail=None, event_thin_study_success=None, event_upload=None, event_upload_fail=None, global_param=None, global_role_id=None, max_sessions=None, password_reset=None, role_id=None, session_expire=None, set_default_organization=None, setting_param=None, settings=None, sso_only=None, user_id=None)[source]¶ User add.
- Parameters
uuid – The account uuid
account_alias – Users alias in the account. (optional).
account_email – Users account_email. Only set this if it is different than the users login email (optional).
account_login – Users login name in the account. (optional).
account_password – Password for the account_password. (optional).
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
email – email
epic_user – Epic user used to map Epic users into Ambra’s ones to track activity. (optional).
event_approve – Notify the user on a approval needed into the account namespace (optional)
event_case_assignment – Notify the user when they are assigned a case as a medical or admin user (optional)
event_harvest – Notify the user on a harvest into the account namespace (optional)
event_incoming_study_request – Notify the user when they get an incoming study request (optional)
event_join – Notify the user on a join request for the account (optional)
event_link – Notify the user when an anonymous link is hit in the namespace (optional)
event_link_mine – Notify the user when an anonymous link created by the user is hit in the namespace (optional)
event_message – Notify the user when a message is sent to the account namespace (optional)
event_new_report – Notify the user when a report is attached in the account namespace (optional)
event_node – Notify the user when an account node sends an event (optional)
event_purge – Notify the user the results of a purge job for the account (optional)
event_query_add – Notify the user when a new query is issued (optional)
event_query_edit – Notify the user when a query is edites (optional)
event_query_reply – Notify the user when they leave a new reply in a query (optional)
event_report_remove – Notify the user when a report is removed in the account namespace (optional)
event_share – Notify the user on a share into the account namespace (optional)
event_site_qualified – Notify the user when a trial site is qualified for the clinical trial account (optional)
event_status_change – Notify the user when the status of a study is changed (optional)
event_study_comment – Notify the user when a comment is attached to a study in the namespace (optional)
event_thin_study_fail – Notify the user when a thin study retrieval they initiated fails (optional)
event_thin_study_success – Notify the user when a thin study retrieval they initiated succeeds (optional)
event_upload – Notify the user on an upload into the account namespace (optional)
event_upload_fail – Notify the user on a failed upload into the account namespace (optional)
global_param – Flag if this is a global user (optional).
global_role_id – uuid of a role to be used in groups and locations when the global user is added to them, this role overrides groups’/locations’ default roles (optional).
max_sessions – Over-ride value for the max number of simultaneous sessions the user can have. (optional).
password_reset – Flag if the password needs to be reset. (optional).
role_id – uuid of the users role in the account (optional).
session_expire – Number of minutes before an idle session expires. (optional)
set_default_organization – A flag to set this account as a default one for the user using user_default_organization Setting. (optional)
setting_param – Expected values are SETTING_NAME. Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional)
settings – A hash of the account settings that the user can override (optional)
sso_only – Flag if the user can only login via SSO. (optional).
user_id – user_id
-
user_delete(user_id, uuid)[source]¶ User delete.
- Parameters
user_id – The user uuid
uuid – The account uuid
-
user_get(user_id, uuid)[source]¶ User get.
- Parameters
user_id – The users uuid
uuid – The account uuid
-
user_report_login(uuid, user_id=None)[source]¶ User report login.
- Parameters
uuid – The account uuid
user_id – Limit to this user_id (optional)
-
user_set(user_id, uuid, account_alias=None, account_email=None, account_login=None, account_password=None, customfield_param=None, epic_user=None, event_approve=None, event_case_assignment=None, event_harvest=None, event_incoming_study_request=None, event_join=None, event_link=None, event_link_mine=None, event_message=None, event_new_report=None, event_node=None, event_purge=None, event_query_add=None, event_query_edit=None, event_query_reply=None, event_report_remove=None, event_share=None, event_site_qualified=None, event_status_change=None, event_study_comment=None, event_thin_study_fail=None, event_thin_study_success=None, event_upload=None, event_upload_fail=None, global_param=None, global_role_id=None, max_sessions=None, password_reset=None, role_id=None, session_expire=None, setting_param=None, settings=None, sso_only=None)[source]¶ User set.
- Parameters
user_id – The users uuid
uuid – The account uuid
account_alias – Users alias in the account. (optional).
account_email – Users account_email. Only set this if it is different than the users login email (optional).
account_login – Users login name in the account. (optional).
account_password – Password for the account_password. (optional).
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
epic_user – Epic user used to map Epic users into Ambra’s ones to track activity (optional).
event_approve – Notify the user on a approval needed into the account namespace (optional)
event_case_assignment – Notify the user when they are assigned a case as a medical or admin user (optional)
event_harvest – Notify the user on a harvest into the account namespace (optional)
event_incoming_study_request – Notify the user when they get an incoming study request (optional)
event_join – Notify the user on a join request for the account (optional)
event_link – Notify the user when an anonymous link is hit in the namespace (optional)
event_link_mine – Notify the user when an anonymous link created by the user is hit in the namespace (optional)
event_message – Notify the user when a message is sent to the account namespace (optional)
event_new_report – Notify the user when a report is attached in the account namespace (optional)
event_node – Notify the user when an account node sends an event (optional)
event_purge – Notify the user the results of a purge job for the account (optional)
event_query_add – Notify the user when a new query is issued (optional)
event_query_edit – Notify the user when a query is edites (optional)
event_query_reply – Notify the user when they leave a new reply in a query (optional)
event_report_remove – Notify the user when a report is removed in the account namespace (optional)
event_share – Notify the user on a share into the account namespace (optional)
event_site_qualified – Notify the user when a trial site is qualified for the clinical trial account (optional)
event_status_change – Notify the user when the status of a study is changed (optional)
event_study_comment – Notify the user when a comment is attached to a study in the namespace (optional)
event_thin_study_fail – Notify the user when a thin study retrieval they initiated fails (optional)
event_thin_study_success – Notify the user when a thin study retrieval they initiated succeeds (optional)
event_upload – Notify the user on an upload into the account namespace (optional)
event_upload_fail – Notify the user on a failed upload into the account namespace (optional)
global_param – Flag if this is a global user. (optional).
global_role_id – uuid of a role to be used in groups and locations when the global user is added to them, this role overrides groups’/locations’ default roles (optional).
max_sessions – Over-ride value for the max number of simultaneous sessions the user can have. (optional).
password_reset – Flag if the password needs to be reset. (optional).
role_id – uuid of the users role in the account (optional).
session_expire – Number of minutes before an idle session expires. (optional)
setting_param – Expected values are SETTING_NAME. Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional)
settings – A hash of the account settings that the user can override (optional)
sso_only – Flag if the user can only login via SSO. (optional).
-
class
ambra_sdk.service.entrypoints.AsyncActivity(api)[source]¶ AsyncActivity.
-
get(uuid, study_extra=None)[source]¶ Get.
- Parameters
uuid – The activity uuid
study_extra – Flag to return extra study fields (optional)
-
list(account_id, strict_account_filter=None, study_extra=None)[source]¶ List.
- Parameters
account_id – Limit to activities in this account and the personal activities
strict_account_filter – Flag to apply the account_id to personal activites as well (optional)
study_extra – Flag to return extra study fields (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncAnalytics(api)[source]¶ AsyncAnalytics.
-
patient_portal(account_id, count, period, time_zone, end_date=None, patient_id=None)[source]¶ Patient portal.
- Parameters
account_id – The account id
count – The number of periods to get
period – The time period (day|week|month|year)
time_zone – The report’s time zone. Time zone selection order: current user’s time zone, time_zone parameter, UTC by default.
end_date – The end date, default is today if not passed (optional)
patient_id – Patient filter (optional)
-
radreport(account_id, count, period, time_zone, end_date=None, namespace_id=None, user_id=None)[source]¶ Radreport.
- Parameters
account_id – The account id
count – The number of periods to get
period – The time period (day|week|month|year)
time_zone – The report’s time zone. Time zone selection order: current user’s time zone, time_zone parameter, UTC by default.
end_date – The end date, default is today if not passed (optional)
namespace_id – Namespace filter (optional)
user_id – User filter (optional)
-
study(count, period, time_zone, account_id=None, customfield_param=None, end_date=None, modality=None, namespace_id=None)[source]¶ Study.
- Parameters
count – The number of periods to get
period – The time period (day|week|month|year)
time_zone – The report’s time zone. Time zone selection order: current user’s time zone, time_zone parameter, UTC by default.
account_id – account_id
customfield_param – Expected values are CUSTOMFIELD_UUID. Filter analytics by a subset of study customfields (optional)
end_date – The end date, default is today if not passed (optional)
modality – Filter analytics by modality (optional)
namespace_id – namespace_id
-
user(account_id, count, period, time_zone, end_date=None, end_time=None, namespace_id=None, user_id=None)[source]¶ User.
- Parameters
account_id – The account id
count – The number of periods to get
period – The time period (hour|day|week|month|year)
time_zone – The report’s time zone. Time zone selection order: current user’s time zone, time_zone parameter, UTC by default.
end_date – The end date, for backwards compatibility (optional)
end_time – The end date and time, default is now if not passed (optional)
namespace_id – Namespace filter (optional)
user_id – User filter (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncAnnotation(api)[source]¶ AsyncAnnotation.
-
add(frame_number, instance_uid, series_uid, json=None, phi_namespace=None, stamp=None, storage_namespace=None, study_id=None, study_uid=None)[source]¶ Add.
- Parameters
frame_number – The frame number
instance_uid – The instance uid
series_uid – The series uid
json – json
phi_namespace – phi_namespace
stamp – stamp
storage_namespace – storage_namespace
study_id – study_id
study_uid – study_uid
-
-
class
ambra_sdk.service.entrypoints.AsyncAnonymization(api)[source]¶ AsyncAnonymization.
-
class
ambra_sdk.service.entrypoints.AsyncAppointment(api)[source]¶ AsyncAppointment.
-
add(account_id, end_time, patient_id, start_time, customfield_param=None, description=None, user_id=None)[source]¶ Add.
- Parameters
account_id – uuid of the account to add them to
end_time – End date and time of the appointment
patient_id – Id of the patient to create the appointment for
start_time – Start date and time of the appointment
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
description – Description of the appointment (optional)
user_id – Id of the user to create the appointment for (optional defaults to current user)
-
set(customfields, description, end_time, start_time, user_id, uuid, status=None)[source]¶ Set.
- Parameters
customfields – An array of the custom fields associated with this appointment. Each object has the following fields (This is only returned if the group has custom fields)
description – Description of the appointment
end_time – End date and time of the appointment
start_time – Start date and time of the appointment
user_id – Id of the user
uuid – The appointment uuid
status – Status of the appointment (A|C|D) - Active, Cancelled, Discontinued (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncAudit(api)[source]¶ AsyncAudit.
-
account(account_id, download=None, reverse=None)[source]¶ Account.
- Parameters
account_id – The id of the account
download – Flag to create a zipped CSV file. A report_id will be returned and the file can be accessed via /report/status and /report/zip (optional)
reverse – Flag to reverse the default sort order (optional)
-
deleted(account_id, type)[source]¶ Deleted.
- Parameters
account_id – The id of the account
type – The type of the object (Study|User etc.)
-
failedlogins(account_id, from_time=None)[source]¶ Failedlogins.
- Parameters
account_id – The id of the account
from_time – Only return events after the epoch time (optional)
-
log(bucket, rest_params=None)[source]¶ Log.
- Parameters
bucket – Name of the bucket to log to
rest_params – Parameters are logged to a message in the bucket
-
object(uuid, customfield_detail=None, download=None, reverse=None)[source]¶ Object.
- Parameters
uuid – The uuid of the object to audit
customfield_detail – Flag to include the customfield name in the detail (optional)
download – Flag to create a zipped CSV file. A report_id will be returned and the file can be accessed via /report/status and /report/zip (optional)
reverse – Flag to reverse the default sort order (optional)
-
user(account_id, user_id, download=None, reverse=None, study_fields=None)[source]¶ User.
- Parameters
account_id – The id of the account
user_id – The id of the user to audit
download – Flag to create a zipped CSV file. A report_id will be returned and the file can be accessed via /report/status and /report/zip (optional)
reverse – Flag to reverse the default sort order (optional)
study_fields – JSON list of study fields to include in the response (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncCase(api)[source]¶ AsyncCase.
-
attach(study_id, uuid, detach=None)[source]¶ Attach.
- Parameters
study_id – Study uuid
uuid – Case uuid
detach – Flag to detach the study from the case (optional)
-
return_method(reason, uuid)[source]¶ Return.
- Parameters
reason – The reason the case was returned
uuid – The case uuid
-
set(uuid, assigned_admin_id=None, assigned_medical_id=None, case_status=None, closed=None, completed=None, customfield_param=None, name=None, submitted=None)[source]¶ Set.
- Parameters
uuid – The case uuid
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)
case_status – The case status (optional)
closed – Flag if the case is closed (optional)
completed – Flag if the case is completed (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
name – case name (optional)
submitted – Flag if the case is submitted (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncCustomcode(api)[source]¶ AsyncCustomcode.
-
add(account_id, code, language, name, type, settings=None, zip=None)[source]¶ Add.
- Parameters
account_id – uuid of the account
code – The code
language – Language of code (PYTHON)
name – The name of the code
type – Type of code (AI_CUSTOM_VALIDATION_CODE)
settings – JSON hash of settings (optional)
zip – Base64 encoded ZIP file (optional)
-
deploy(namespace_id, uuid)[source]¶ Deploy.
- Parameters
namespace_id – uuid of the namespace
uuid – uuid of the customcode
-
deploy_list(customcode_id=None, namespace_id=None)[source]¶ Deploy list.
- Parameters
customcode_id – customcode_id
namespace_id – namespace_id
-
-
class
ambra_sdk.service.entrypoints.AsyncCustomfield(api)[source]¶ AsyncCustomfield.
-
add(account_id, name, object, capture_on_destination_search=None, capture_on_share_code=None, dicom_only=None, dicom_tag=None, dicom_tag_ignore_empty=None, display_order=None, field_flag=None, hl7_component=None, hl7_field=None, hl7_segment=None, load_dicom_tag=None, load_from_sr=None, load_hl7=None, load_hl7_filter=None, load_order=None, options=None, other_customfield_id=None, other_dicom_tags=None, required=None, type=None, wrapped_dicom_only=None)[source]¶ Add.
- Parameters
account_id – uuid of the account
name – Name of the customfield
object – The object to associate the customfield with (Study|User_account|Group|Location|Account|Patient|Case|Order|Appointment|Dicomdata|Scanner|Query)
capture_on_destination_search – Flag if the field should be captured during query retrieve on /destination/search call (only applicable to study fields) (optional)
capture_on_share_code – Flag if the field should be captured during a share code exchange (only applicable to study fields) (optional)
dicom_only – Only capture for non-wrapped DICOM uploads during a share code exchange (optional)
dicom_tag – DICOM tag to map this field to. Format should be of form (1234,1234). (only applicable to study fields) (optional)
dicom_tag_ignore_empty – Flag to not map an empty custom field to the DICOM tag. (only applicable if a dicom_tag is specified) (optional)
display_order – Integer to order how the fields should be displayed (optional)
field_flag – Default customfield flag (optional)
hl7_component – Component number to map this field to in HL7 ORM messages. Valid values are 1 to 64. (only applicable to study fields) (optional)
hl7_field – Segment field number to map this field to in HL7 ORM messages. Valid values are 1 to 64. (only applicable to study fields) (optional)
hl7_segment – Segment to map this field to in HL7 ORM messages. Valid values are (NTE|PID|PID1|PV1|PV2|OBR|DG1|OBX|CTI|BLG|ORC) (only applicable to study fields) (optional)
load_dicom_tag – Flag to load the current value from the study into this field. (only applicable if a dicom_tag is specified) (optional)
load_from_sr – Load the value from the structured reports in the study (only applicable to study fields) .(optional)
load_hl7 – If this is set to a HL7 message type the value of this field will be updated from the hl7_segment, hl7_field and hl7_component from incoming HL7 messages of the matching message type (only applicable to study fields) (optional)
load_hl7_filter – Filter token for the load_hl7 option (only applicable to study fields) (optional)
load_order – If this flag is on the value of this field will be loaded from a customfield of the matching Order. The customfield is defined by the other_customfield_id parameter (optional)
options – Additional options in JSON format (optional)
other_customfield_id – Id of a customfield to map its value to this customfield’s value (optional)
other_dicom_tags – JSON array of other DICOM tags to map this field to. (only applicable to study fields) (optional)
required – Flag if the field is required (optional)
type – Type of the custom field (text|number|date|memo|select|multiselect|radio|checkbox|search|bool) (optional)
wrapped_dicom_only – Only capture for wrapped DICOM uploads during a share code exchange (optional)
-
lookup(account_id, name)[source]¶ Lookup.
- Parameters
account_id – uuid of the account
name – Name of the customfield
-
mapping_add(from_customfield_id, to_customfield_id, overwrite_with_blank=None, refresh_on_edit=None, refresh_on_reshare=None, reverse_refresh_on_edit=None)[source]¶ Mapping add.
- Parameters
from_customfield_id – The source custom field id
to_customfield_id – The destination custom field id
overwrite_with_blank – Flag if the destination customfield should be updated with a blank value, 1 by default (optional)
refresh_on_edit – Flag if the destination customfield should be updated on the source customfield edit, 1 by default (optional)
refresh_on_reshare – Flag if the destination customfield should be updated on Study reshare, 1 by default (optional)
reverse_refresh_on_edit – Flag if the mapping should apply in reverse, ie to the customfield designated as a from_customfield_id of the original study when a shared version of the study is edited, 0 by default (optional)
-
mapping_delete(uuid)[source]¶ Mapping delete.
- Parameters
uuid – uuid of the customfield mapping rule
-
mapping_set(uuid, overwrite_with_blank=None, refresh_on_edit=None, refresh_on_reshare=None, reverse_refresh_on_edit=None)[source]¶ Mapping set.
- Parameters
uuid – uuid of the customfield mapping rule
overwrite_with_blank – Flag if the destination customfield should be updated with a blank value, 1 by default (optional)
refresh_on_edit – Flag if the destination customfield should be updated on the source customfield edit, 1 by default (optional)
refresh_on_reshare – Flag if the destination customfield should be updated on Study reshare, 1 by default (optional)
reverse_refresh_on_edit – Flag if the mapping should apply in reverse, ie to the customfield designated as a from_customfield_id of the original study when a shared version of the study is edited, 0 by default (optional)
-
search(uuid, search=None)[source]¶ Search.
- Parameters
uuid – uuid of the customfield
search – The value to search for (optional)
-
set(uuid, capture_on_destination_search=None, capture_on_share_code=None, dicom_only=None, dicom_tag=None, dicom_tag_ignore_empty=None, display_order=None, field_flag=None, hl7_component=None, hl7_field=None, hl7_segment=None, load_dicom_tag=None, load_from_sr=None, load_hl7=None, load_hl7_filter=None, load_order=None, name=None, options=None, other_customfield_id=None, other_customfield_no_overwrite_with_blank=None, other_customfield_no_refresh_on_reshare=None, other_dicom_tags=None, required=None, wrapped_dicom_only=None)[source]¶ Set.
- Parameters
uuid – uuid of the customfield
capture_on_destination_search – Flag if the field should be captured during query retrieve on /destination/search call (optional)
capture_on_share_code – Flag if the study type field should be captured during a share code exchange (optional)
dicom_only – Only capture for non-wrapped DICOM uploads during a share code exchange (optional)
dicom_tag – Dicom tag to map this field to. Format should be of form (1234,1234). (only applicable to study fields) (optional)
dicom_tag_ignore_empty – Flag to not map an empty custom field to the DICOM tag. (only applicable if a dicom_tag is specified) (optional)
display_order – Integer to order how the fields should be displayed (optional)
field_flag – Default customfield flag (optional)
hl7_component – Component number to map this field to in HL7 ORM messages. Valid values are 1 to 64. (only applicable to study fields) (optional)
hl7_field – Segment field number to map this field to in HL7 ORM messages. Valid values are 1 to 64. (only applicable to study fields) (optional)
hl7_segment – Segment to map this field to in HL7 ORM messages. Valid values are (NTE|PID|PID1|PV1|PV2|OBR|DG1|OBX|CTI|BLG|ORC) (only applicable to study fields) (optional)
load_dicom_tag – Flag to load the current value from the study into this field. (only applicable if a dicom_tag is specified) (optional)
load_from_sr – Load the value from the structured reports in the study. (only applicable to study fields) .(optional)
load_hl7 – If this is set to a HL7 message type the value of this field will be updated from the hl7_segment, hl7_field and hl7_component from incoming HL7 messages of the matching message type (only applicable to study fields) (optional)
load_hl7_filter – Filter token for the load_hl7 option (only applicable to study fields) (optional)
load_order – If this flag is on the value of this field will be loaded from a customfield of the matching Order. The customfield is defined by the other_customfield_id parameter (optional)
name – Name of the customfield (optional)
options – Additional options in JSON format (optional)
other_customfield_id – Id of a customfield to map its value to this customfield’s value (optional)
other_customfield_no_overwrite_with_blank – Flag if the customfield should be updated with a blank value (optional)
other_customfield_no_refresh_on_reshare – Flag if the customfield should be updated on Study reshare (optional)
other_dicom_tags – JSON array of other DICOM tags to map this field to. (only applicable to study fields) (optional)
required – Flag if the field is required (optional)
wrapped_dicom_only – Only capture for wrapped DICOM uploads during a share code exchange (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncDestination(api)[source]¶ AsyncDestination.
-
add(account_id, address, aetitle, distributed_destinations, linked_destination, linked_qr_activity_in_referred_account, linked_qr_to_referred_account, name, node_id, path, port, c_echo_interval=None, c_echo_schedule=None, can_mwl_search=None, can_push_hl7=None, can_query_retrieve=None, can_retrieve_thin=None, can_search=None, cd_burn_info=None, cd_burn_name=None, cd_burn_priority=None, default_query_retrieve_level=None, fire_webhooks=None, gateway_settings=None, hl7_address=None, hl7_fetch_filter=None, hl7_port=None, manual_push_roles=None, push_related_studies=None, sort_order=None, sqlch_psh_if_img_unchg=None, sqlch_psh_if_route_hl7=None, type=None, ui_json=None)[source]¶ Add.
- Parameters
account_id – uuid of the account
address – Address of the destination (required if DICOM type)
aetitle – Aetitle of the destination (required if DICOM type)
distributed_destinations – A JSON array of destination ids. This list will be used to process requests in round robin manner. Meaningful for DISTRIBUTING destination type only (opional)
linked_destination – uuid of the destination for LINKED destinations
linked_qr_activity_in_referred_account – A flag to create DESTINATION_SEARCH activities in the linked destination’s account. Meaningful for LINKED destinations only (opional)
linked_qr_to_referred_account – A flag to create resultant studies in the linked destination’s account (not the account of LINKED destination where the search was initiated). Meaningful for LINKED destinations only (opional)
name – Name of the destination
node_id – uuid of the node that handles the destination
path – Path of the folder for a FOLDER type of destination (required if FOLDER type)
port – Port of the destination (required if DICOM type)
c_echo_interval – Interval in seconds to C echo the destination (optional)
c_echo_schedule – C echo schedule (optional)
can_mwl_search – Can this destination support searching a modality work list (optional)
can_push_hl7 – Can this destination support pushong Hl7 messages (optional)
can_query_retrieve – Can this destination support query retrieve from HL7 messages (optional)
can_retrieve_thin – Can this destination support retrieving thin studies (optional)
can_search – Can this destination support searching (optional)
cd_burn_info – A JSON hash with the CD burning information (optional)
cd_burn_name – Name for the CD burner software (optional)
cd_burn_priority – Integer value for the burner priority (optional)
default_query_retrieve_level – Default query retrieve level this can be either (study|series|image) and defaults to study if not specified (optional)
fire_webhooks – Fire webhooks for events associated with this destination (optional)
gateway_settings – Gateway settings (optional)
hl7_address – Address of an attached HL7 destination (optional except for VIRTUAL destinations)
hl7_fetch_filter – A transform condition expression (see /transform/add for format) to match against the HL7 message. Only fire a query retrieve if the message matches the condition (optional)
hl7_port – Port of an attached HL7 destination (optional except for VIRTUAL destinations)
manual_push_roles – A comma separated list of role uuids, a user is required to have one of them to manually push to this destination (optional)
push_related_studies – Push all the related studies (same MRN/patientid) in the namespace when a study is pushed (optional)
sort_order – Integer value for sorting (optional)
sqlch_psh_if_img_unchg – Squelch pushes to the destination if the image count has not changed and the push is by a routing rule (optional)
sqlch_psh_if_route_hl7 – Squelch pushes to the destination if the push was generated by HL7 triggered routing (optional)
type – Type of the destination either DICOM, FOLDER, ACCELERATOR,VIRTUAL, BURNER, XDS, LINKED, DISTRIBUTING or UPLOADER. Defaults to DICOM (optional)
ui_json – JSON for UI settings (optional)
-
list(account_id, node_id=None, serial_no=None)[source]¶ List.
- Parameters
account_id – uuid of the account
node_id – node_id
serial_no – serial_no
-
retrieve(activity_id, send_method, study_request_found_id, customfield_param=None)[source]¶ Retrieve.
- Parameters
activity_id – uuid of the DESTINATION_SEARCH activity to retrieve from
send_method – The method to send a study as a study request response (share|duplicate)
study_request_found_id – UUID of a study request search results to retrieve and send as study request response
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) will be set for the study retrieved (optional)
-
search(uuid, accession_number=None, anonymize=None, anonymize_param=None, bundle_id=None, copy_to=None, create_study=None, create_thin=None, customfield_param=None, customfield_quoted_param=None, end_datetime=None, modality=None, node_id=None, patient_birth_date=None, patient_name=None, patient_sex=None, patientid=None, push_to=None, query_fields=None, referring_physician=None, refetch_study=None, result_fields=None, serial_no=None, share_email=None, start_datetime=None, study_request_id=None, study_uid=None, tracking_number=None)[source]¶ Search.
- Parameters
uuid – uuid of the destination
accession_number – Accession number to find (optional)
anonymize – A JSON hash of anonymization rules to apply to retrieved studies (optional)
anonymize_param – Expected values are STUDY_FIELD. The anonymization rules breakdown. This overrides the anonymize parameter if passed (optional)
bundle_id – An integral number Used internally to track searches initiated from a single bundle (optional)
copy_to – uuid of a namespace to copy the retrieved or create_thin studies into (optional)
create_study – The maximum number of studies to retrieve from this search instead of creating an activity for the search results (optional)
create_thin – The maximum number of thin studies to create from this search instead of creating an activity for the search results (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) will be set for the resultant studies after /destination/retrieve call (optional)
customfield_quoted_param – Expected values are CUSTOMFIELD_NAME. Custom field(s) to be set for the resultant studies. (optional)
end_datetime – DICOM end date time stamp to bound the search (optional)
modality – Modality (optional)
node_id – node_id
patient_birth_date – Birth date to find (optional)
patient_name – Patient name to find (optional)
patient_sex – Gender to find (optional)
patientid – Patient id to find (optional)
push_to – uuid of a destination to push the retrieved studies to (optional)
query_fields – A JSON hash of additional query fields (optional)
referring_physician – Referring physician to find (optional)
refetch_study – Flag to refetch the search results when studies have been fetched already (optional)
result_fields – A JSON array of DICOM tags that the destination should return (optional)
serial_no – serial_no
share_email – Email to share retrieved studies with on subsequent /destination/retrieve (optional)
start_datetime – DICOM start date time stamp to bound the search (optional)
study_request_id – uuid of a study request (optional)
study_uid – Study uid to find (optional)
tracking_number – A UUID tracking number that can be used to pull a report against this search (optional)
-
search_mwl(study_id, uuid, accession_number=None, order_date=None, order_number=None, patient_birth_date=None, patient_name=None, patient_sex=None, patientid=None)[source]¶ Search mwl.
- Parameters
study_id – The id of the study we are searching for orders for
uuid – uuid of the destination
accession_number – Accession number to find (optional)
order_date – Order date to find (optional)
order_number – Order number to find (optional)
patient_birth_date – Birth date to find (optional)
patient_name – Patient name to find (optional)
patient_sex – Gender to find (optional)
patientid – Patient id to find (optional)
-
search_report(email, tracking_number)[source]¶ Search report.
- Parameters
email – Optional email address to send the report to
tracking_number – The tracking number to report on
-
set(distributed_destinations, linked_qr_activity_in_referred_account, linked_qr_to_referred_account, uuid, address=None, aetitle=None, c_echo_interval=None, c_echo_schedule=None, can_mwl_search=None, can_push_hl7=None, can_query_retrieve=None, can_retrieve_thin=None, can_search=None, cd_burn_info=None, cd_burn_name=None, cd_burn_priority=None, default_query_retrieve_level=None, fire_webhooks=None, gateway_settings=None, hl7_address=None, hl7_fetch_filter=None, hl7_port=None, manual_push_roles=None, name=None, node_id=None, path=None, port=None, push_related_studies=None, sort_order=None, sqlch_psh_if_img_unchg=None, sqlch_psh_if_route_hl7=None, ui_json=None)[source]¶ Set.
- Parameters
distributed_destinations – A JSON array of destination ids. This list will be used to process requests in round robin manner. Meaningful for DISTRIBUTING destination type only (opional)
linked_qr_activity_in_referred_account – A flag to create DESTINATION_SEARCH activities in the linked destination’s account. Meaningful for LINKED destinations only (opional)
linked_qr_to_referred_account – A flag to create resultant studies in the linked destination’s account (not the account of LINKED destination where the search was initiated). Meaningful for LINKED destinations only (opional)
uuid – uuid of the destination
address – Address of the destination (optional)
aetitle – Aetitle of the destination (optional)
c_echo_interval – Interval in seconds to C echo the destination (optional)
c_echo_schedule – C echo schedule (optional)
can_mwl_search – Can this destination support searching a modality work list (optional)
can_push_hl7 – Can this destination support pushong Hl7 messages (optional)
can_query_retrieve – Can this destination support query retrieve from HL7 messages (optional)
can_retrieve_thin – Can this destination support retrieving thin studies (optional)
can_search – Can this destination support searching (optional)
cd_burn_info – A JSON hash with the CD burning information (optional)
cd_burn_name – Name for the CD burner software (optional)
cd_burn_priority – Integer value for the burner priority (optional)
default_query_retrieve_level – Default query retrieve level this can be either (study|series|image) and defaults to study if not specified (optional)
fire_webhooks – Fire webhooks for events associated with this destination (optional)
gateway_settings – Gateway settings (optional)
hl7_address – Address of an attached HL7 destination (optional)
hl7_fetch_filter – A transform condition expression (see /transform/add for format) to match against the HL7 message. Only fire a query retrieve if the message matches the condition (optional)
hl7_port – Port of an attached HL7 destination (optional)
manual_push_roles – A comma separated list of role uuids, a user is required to have one of them to manually push to this destination (optional)
name – Name of the destination (optional)
node_id – uuid of the node that handles the destination (optional)
path – Path of the folder (optional)
port – Port of the destination (optional)
push_related_studies – Push all the related studies (same MRN/patientid) in the namespace when a study is pushed (optional)
sort_order – Integer value for sorting (optional)
sqlch_psh_if_img_unchg – Squelch pushes to the destination if the image count has not changed and the push is by a routing rule (optional)
sqlch_psh_if_route_hl7 – Squelch pushes to the destination if the push was generated by HL7 triggered routing (optional)
ui_json – JSON for UI settings (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncDicomdata(api)[source]¶ AsyncDicomdata.
-
get(customfields, uuid, dicom_tags=None)[source]¶ Get.
- Parameters
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)
uuid – Id of the DICOM data
dicom_tags – A JSON list of the DICOM tags to return (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncDictionary(api)[source]¶ AsyncDictionary.
-
add(account_id, case_sensitive, lookup, name, object, replace)[source]¶ Add.
- Parameters
account_id – The account id
case_sensitive – Flag if the dictionary lookup is case sensitive or not
lookup – A JSON array of field names that will be concatenated and MD5 hashed for the dictionary lookup value
name – The dictionary name
object – Object this is applied against (Study|Order|User_account|Case|Patient)
replace – A JSON array of the field names that will be replaced for a successful lookup
-
attach(uuid, account_id=None, add_if_no_match=None, approve_if_match=None, delay=None, global_counter=None, namespace_id=None, run_once=None, sequence=None, skip_if_lookup_unchanged=None, skip_if_replace_has_value=None)[source]¶ Attach.
- Parameters
uuid – The dictionary id
account_id – account_id
add_if_no_match – Flag to add the lookup and replace values to the dictionary if no match occurs (optional)
approve_if_match – Approve the object if there was a match (optional)
delay – An integer number of seconds to delay the dictionary application (optional)
global_counter – A flag if you want the counter to run against the account namespace instead of the object namespace (optional)
namespace_id – namespace_id
run_once – Flag to make dictionary apply only once per object (optional)
sequence – An integer value. Attachments are processed from low number to high number (optional)
skip_if_lookup_unchanged – Flag to skip the lookup if the lookup field(s) are un-changed (optional)
skip_if_replace_has_value – Flag to skip the lookup if the replace field already has a value (optional)
-
attach_set(uuid, add_if_no_match=None, approve_if_match=None, delay=None, global_counter=None, run_once=None, sequence=None, skip_if_lookup_unchanged=None, skip_if_replace_has_value=None)[source]¶ Attach set.
- Parameters
uuid – The dictionary attach id
add_if_no_match – Flag to add the lookup and replace values to the dictionary if no match occurs (optional)
approve_if_match – Approve the object if there was a match (optional)
delay – An integer number of seconds to delay the dictionary application (optional)
global_counter – A flag if you want the counter to run against the account namespace instead of the object namespace (optional)
run_once – Flag to make dictionary apply only once per object (optional)
sequence – An integer value. Attachments are processed from low number to high number (optional)
skip_if_lookup_unchanged – Flag to skip the lookup if the lookup field(s) are un-changed (optional)
skip_if_replace_has_value – Flag to skip the lookup if any of the replace fields already has a value (optional)
-
entries(uuid, lookup=None)[source]¶ Entries.
- Parameters
uuid – The dictionary id
lookup – Only return the entry for the optional lookup entry (optional)
-
entry_add(lookup, replace, uuid, regexp=None)[source]¶ Entry add.
- Parameters
lookup – The JSON array of the lookup values to add. Alternatively a regular expression if the regexp parameter is passed
replace – The JSON array of the replacement field values
uuid – The dictionary id
regexp – An integer value that indicates that this entry is a regular expression (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncFilter(api)[source]¶ AsyncFilter.
-
add(configuration, name, type, account_id=None, tier_parent_id=None)[source]¶ Add.
- Parameters
configuration – The configuration as a JSON data structure
name – The name of the filter
type – The type of the filter
account_id – The account id to link this filter with (optional)
tier_parent_id – The uuid of the filter that this filter should be a child of (optional, for tiered filters)
-
list(account_id, type)[source]¶ List.
- Parameters
account_id – Limit to global filters and filters within the account namespaces
type – The type of filter to list (repeat this to get multiple types)
-
set(uuid, account_id=None, configuration=None, name=None, type=None)[source]¶ Set.
- Parameters
uuid – The filter uuid
account_id – The account id to link this filter with (optional)
configuration – The configuration as a JSON data structure (optional)
name – The name of the filter (optional)
type – The type of the filter (optional)
Share.
- Parameters
uuid – The filter uuid
account_id – account_id
group_id – group_id
location_id – location_id
role_id – role_id
user_id – user_id
Share list.
- Parameters
uuid – The filter uuid
Share stop.
- Parameters
uuid – The filter uuid
account_id – account_id
group_id – group_id
location_id – location_id
role_id – role_id
user_id – user_id
-
-
class
ambra_sdk.service.entrypoints.AsyncGroup(api)[source]¶ AsyncGroup.
-
add(account_id, name, customfield_param=None, hl7_template=None, must_approve=None, must_approve_harvest=None, must_approve_move=None, must_approve_upload=None, no_share=None, role_id=None, search_threshold=None, share_code=None, share_description=None, share_settings=None, share_via_gateway=None, site_id=None)[source]¶ Add.
- Parameters
account_id – uuid of the account
name – Name of the group
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
hl7_template – The HL7 reporting template for the group (optional)
must_approve – Flag if shared studies must be approved for the group (optional)
must_approve_harvest – Flag if harvested studies must be approved (optional)
must_approve_move – Flag if moved studies must be approved (optional)
must_approve_upload – Flag if uploaded studies must be approved (optional)
no_share – Flag if studies can not be shared with this group (optional). Studies can still be shared with users in the group.
role_id – Id for the default role for the group (optional)
search_threshold – The number of studies record in the namespace to switch the UI from list to search mode (optional)
share_code – The share code of the group (optional)
share_description – The share description of the group (optional)
share_settings – Share settings JSON structure of the share display settings (optional)
share_via_gateway – Flag if a gateway share is allowed (optional)
site_id – The associated site id. Required in case require_site_id_for_groups account setting is set (optional)
-
scanner_validate(invalidate, scanner_id, uuid, study_uid=None)[source]¶ Scanner validate.
- Parameters
invalidate – Flag if the scaner is being invalidated
scanner_id – The scanner id
uuid – The group id
study_uid – The study uid used to validate the scaner. Required when validating (optional)
-
set(uuid, customfield_param=None, hl7_template=None, must_approve=None, must_approve_harvest=None, must_approve_move=None, must_approve_upload=None, name=None, no_share=None, role_id=None, search_threshold=None, share_code=None, share_description=None, share_settings=None, share_via_gateway=None, site_id=None, site_inactive=None, site_qualified=None)[source]¶ Set.
- Parameters
uuid – The group uuid
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
hl7_template – The HL7 reporting template for the group (optional)
must_approve – Flag if shared studies must be approved for the group (optional)
must_approve_harvest – Flag if harvested studies must be approved (optional)
must_approve_move – Flag if moved studies must be approved (optional)
must_approve_upload – Flag if uploaded studies must be approved (optional)
name – Name of the group (optional)
no_share – Flag if studies can not be shared with this group (optional). Studies can still be shared with users in the group.
role_id – Id for the default role for the group (optional)
search_threshold – The number of studies record in the namespace to switch the UI from list to search mode (optional)
share_code – The share code of the group (optional)
share_description – The share description of the group (optional)
share_settings – Share settings JSON structure of the share display settings (optional)
share_via_gateway – Flag if a gateway share is allowed (optional)
site_id – The associated site id. Required in case require_site_id_for_groups account setting is set (optional)
site_inactive – Inactive flag to deactivate the site in a Trial Account (optional)
site_qualified – Flag if the site is qualified for the trial (optional)
-
user_add(user_id, uuid, event_approve=None, event_case_assignment=None, event_harvest=None, event_incoming_study_request=None, event_link=None, event_link_mine=None, event_message=None, event_new_report=None, event_node=None, event_query_add=None, event_query_edit=None, event_query_reply=None, event_report_remove=None, event_share=None, event_site_qualified=None, event_status_change=None, event_study_comment=None, event_thin_study_fail=None, event_thin_study_success=None, event_upload=None, event_upload_fail=None, no_physician_alias_share=None, role_id=None)[source]¶ User add.
- Parameters
user_id – Id of the user
uuid – The group id
event_approve – Notify the user on a approval needed into the group namespace (optional)
event_case_assignment – Notify the user when they are assigned a case as a medical or admin user (optional)
event_harvest – Notify the user on a harvest into the group namespace (optional)
event_incoming_study_request – Notify the user when they get an incoming study request (optional)
event_link – Notify the user when an anonymous link is hit in the namespace (optional)
event_link_mine – Notify the user when an anonymous link created by the user is hit in the namespace (optional)
event_message – Notify the user when a message is sent to the group namespace (optional)
event_new_report – Notify the user when a report is attached in the group namespace (optional)
event_node – Notify the user when a group node sends an event (optional)
event_query_add – Notify the user when a new query is issued (optional)
event_query_edit – Notify the user when a query is edites (optional)
event_query_reply – Notify the user when they leave a new reply in a query (optional)
event_report_remove – Notify the user when a report is removed in the group namespace (optional)
event_share – Notify the user on a share into the group namespace (optional)
event_site_qualified – Notify the user when a trial site is qualified for the clinical trial account (optional)
event_status_change – Notify the user when the status of a study is changed (optional)
event_study_comment – Notify the user when a comment is attached to a study in the namespace (optional)
event_thin_study_fail – Notify the user when a thin study retrieval they initiated fails (optional)
event_thin_study_success – Notify the user when a thin study retrieval they initiated succeeds (optional)
event_upload – Notify the user on an upload into the group namespace (optional)
event_upload_fail – Notify the user on a failed upload into the group namespace (optional)
no_physician_alias_share – Flag to exclude this group from a physician alias share (optional)
role_id – Id of the users role within the group (optional). If not passed the default group role will be assigned
-
-
class
ambra_sdk.service.entrypoints.AsyncHl7(api)[source]¶ AsyncHl7.
-
add(message, serial_no, uuid, accession_number=None)[source]¶ Add.
- Parameters
message – The HL7 message
serial_no – The serial number of the node
uuid – The node id
accession_number – Use this accession number instead of the accession number in the HL7 message (optional)
-
get(raw, uuid, node_id=None, phi_namespace=None, serial_no=None, storage_namespace=None, study_id=None, study_uid=None)[source]¶ Get.
- Parameters
raw – Flag to return the raw HL7 message as well
uuid – The hl7 uuid
node_id – node_id
phi_namespace – phi_namespace
serial_no – serial_no
storage_namespace – storage_namespace
study_id – study_id
study_uid – study_uid
-
parse_fields(message, fields=None)[source]¶ Parse fields.
- Parameters
message – HL7 message to parse
fields – Comma delimited list of the field to return. Use the notation specified in /hl7/transform/add (optional)
-
template_add(account_id, body, name)[source]¶ Template add.
- Parameters
account_id – The account uuid
body – The HL7 message with replacement expressions
name – Name of the template
-
template_render(hex, hl7_id, study_id, text, uuid)[source]¶ Template render.
- Parameters
hex – Flag if you want a hexdump of the text returned rather than the JSON
hl7_id – Optional hl7 message
study_id – The study id
text – Flag if you want the text returned rather than the JSON
uuid – The template id
-
template_set(body, name, uuid)[source]¶ Template set.
- Parameters
body – The HL7 message with replacement expressions
name – Name of the template
uuid – The template id
-
transform_add(account_id, conditions, name, order_by, replacements)[source]¶ Transform add.
- Parameters
account_id – The account uuid
conditions – A JSON array of the transform conditions
name – Name of the transform
order_by – A numeric ordering value. Transformations are run in this order from lowest to highest
replacements – A JSON array of the transform replacements
-
transform_set(conditions, name, order_by, replacements, uuid)[source]¶ Transform set.
- Parameters
conditions – A JSON array of the transform conditions
name – Name of the transform
order_by – A numeric ordering value. Transformations are run in this order from lowest to highest
replacements – A JSON array of the transform replacements
uuid – The transform id
-
-
class
ambra_sdk.service.entrypoints.AsyncKeyimage(api)[source]¶ AsyncKeyimage.
-
add(frame_number, instance_uid, series_uid, version, phi_namespace=None, storage_namespace=None, study_id=None, study_uid=None)[source]¶ Add.
- Parameters
frame_number – The frame number
instance_uid – The instance uid
series_uid – The series uid
version – The frame version
phi_namespace – phi_namespace
storage_namespace – storage_namespace
study_id – study_id
study_uid – study_uid
-
-
class
ambra_sdk.service.entrypoints.AsyncLink(api)[source]¶ AsyncLink.
-
add(action, prompt_for_anonymize, acceptance_required=None, account_id=None, anonymize=None, charge_amount=None, charge_currency=None, charge_description=None, email=None, filter=None, include_priors=None, inherit_permissions=None, max_hits=None, meeting_id=None, message=None, mfm_page=None, minutes_alive=None, mobile_phone=None, namespace_id=None, notify=None, parameters=None, password=None, password_is_dob=None, password_max_attempts=None, pin_auth=None, referer=None, share_code=None, share_on_view=None, skip_email_prompt=None, study_id=None, ui_json=None, upload_match=None, upload_study_customfields=None, use_share_code=None, user_id=None, workflow=None)[source]¶ Add.
- Parameters
action – Link action (STUDY_LIST|STUDY_VIEW|STUDY_UPLOAD)
prompt_for_anonymize – Flag to prompt if the anonymization rules should be applied on ingress
acceptance_required – Flag that acceptance of TOS is required (optional)
account_id – account_id
anonymize – Anonymization rules to the applied to any STUDY_UPLOAD done with this link. Rules are formatted as per the rules parameter in /namespace/anonymize (optional)
charge_amount – Amount to charge in pennies before the link can be accessed (optional)
charge_currency – Charge currency (optional)
charge_description – Charge description (optional)
email – Email the link to these addresses (optional)
filter – filter
include_priors – Include prior studies (optional)
inherit_permissions – Flag for the link sessions to inherit permissions from the user stored in the user_id link attribute (optional)
max_hits – The maximum number of times the link can be used (optional)
meeting_id – UUID of the meeting to associate the link with (optional)
message – Message to include in the email (optional)
mfm_page – Flag to launch the MFM page instead of the viewer (optional)
minutes_alive – The maximum number of minutes the link will be alive for (optional)
mobile_phone – Send the link to this phone number (optional)
namespace_id – namespace_id
notify – Comma or space separated list of additional emails to notify of link usage (optional)
parameters – JSON array of parameters to add to the redirect URL or return in /namespace/share_code if an upload e.g. [“integration_key”,”abc”] Where abc is integration key. (optional)
password – Link password (optional)
password_is_dob – Flag that the password is the patient_birth_date for the study (study_id is required) (optional)
password_max_attempts – The maximum number of failed password attempt (optional)
pin_auth – An account member email and PIN authentication is required (optional)
referer – The link can only be accessed from the specified referer. The referer can be a regexp to match multiple referers (optional)
share_code – share code for a STUDY_UPLOAD (optional)
share_on_view – Flag to share the study with the email after it is viewed (optional)
skip_email_prompt – Skip the prompt for email step (optional)
study_id – study_id
ui_json – JSON for UI settings (optional)
upload_match – A JSON hash of DICOM tags and regular expressions they must match uploaded against this link (optional)
upload_study_customfields – A JSON hash of customfields that will be mapped to a study on study upload. A key is a customfield UUID, a value is a value for the field (optional)
use_share_code – Flag to use the namespace share code settings for a STUDY_UPLOAD (optional)
user_id – The link user. Any filter is applied in this users context (optional)
workflow – The workflow this link is intended for (patient_studies) (optional)
-
charge(charge_token, uuid)[source]¶ Charge.
- Parameters
charge_token – The stripe charge token
uuid – The uuid of the link
-
external(u, v)[source]¶ External.
- param u
The uuid of the user_account record to create the guest link as
- param v
A JSON hash with the following keys pairs. The JSON must be encrypted and base64 encoded
- filter.*=>Filter field(s) as per the /study/list to specify the study(s) to construct the link for
The include_priors link option value can be passed as a key Any additional fields will the saved in the study audit trail and the following fields email_address, redirect_url, integration_key and skip_email_prompt will be available in /namespace/share_code if this is an upload link
-
get(acceptance_required, account_id, action, anonymize, charge_amount, charge_currency, charge_description, created, description, email, filter, has_password, include_priors, inherit_permissions, is_meeting, max_hits, message, mfm_page, minutes_alive, mobile_phone, namespace_id, namespace_name, notify, parameters, password_is_dob, password_max_attempts, pin_auth, prompt_for_anonymize, redirect_url, referer, share_on_view, short_id, skip_email_prompt, study_id, ui_json, upload_match, upload_study_customfields, url, use_share_code, user_id, uuid, workflow)[source]¶ Get.
- Parameters
acceptance_required – Flag that acceptance of TOS is required
account_id – The account id
action – Link action
anonymize – Any anonymization rules
charge_amount – Amount to charge in pennies before the link can be accessed
charge_currency – Charge currency
charge_description – Charge description
created – Created datetime stamp of the link
description – Description of the link
email – Email address the link was sent to
filter – The filter expression
has_password – Flag if the link has a password or not
include_priors – Include prior studies
inherit_permissions – Flag for the link sessions to inherit permissions from the user stored in the user_id link attribute
is_meeting – Flag if the link is for a meeting
max_hits – The maximum number of times the link can be used
message – Message to include in the email
mfm_page – Flag to launch the MFM page instead of the viewer
minutes_alive – The maximum number of minutes the link will be alive for
mobile_phone – Cellular phone number the link was sent to
namespace_id – Id of the namespace for upload links
namespace_name – Name of the namespace for upload links
notify – Comma or space separated list of additional emails to notify of link usage
parameters – JSON array parameters to add to the redirect URL
password_is_dob – Flag that the password is the patient_birth_date for the study
password_max_attempts – The maximum number of failed password attempt
pin_auth – An account member email and PIN authentication is required
prompt_for_anonymize – Flag to prompt if the anonymization rules should be applied on ingress
redirect_url – URL for the /link/redirect API which will take you directly to the study viewer or uploader
referer – The link can only be accessed from the specified referer
share_on_view – Flag to share the study with the email after it is viewed
short_id – Short ID of the link for the ‘patient_studies’ workflow
skip_email_prompt – Skip the prompt for email step
study_id – uuid of the study
ui_json – JSON for UI settings
upload_match – A JSON hash of DICOM tags and regular expressions they must match uploaded against this link
upload_study_customfields – A JSON hash of customfields that will be mapped to a study on study upload
url – URL for the link which will take you to the UI entry point for links to enter email, password etc.
use_share_code – Flag to use the namespace share code settings for a STUDY_UPLOAD
user_id – The user id
uuid – Id of the link
workflow – The workflow this link is intended for
-
list(account_id=None, study_id=None, user_id=None)[source]¶ List.
- Parameters
account_id – account_id
study_id – study_id
user_id – user_id
-
redirect(link_charge_id=None, password=None, pin=None, short_id=None, uuid=None, v=None)[source]¶ Redirect.
- param link_charge_id
The uuid of the prior charge against this link (optional)
- param password
Password if needed (optional)
- param pin
pin
- param short_id
short_id
- param uuid
uuid
- param v
A JSON hash with the following keys pairs. The JSON must be encrypted (optional)
context_user_id - an account user id for eUnity
-
session(email_address=None, link_charge_id=None, password=None, pin=None, short_id=None, uuid=None)[source]¶ Session.
- Parameters
email_address – The users email (optional)
link_charge_id – The uuid of the prior charge against this link (optional)
password – Password if needed (optional)
pin – pin
short_id – short_id
uuid – uuid
-
sid(email, uuid)[source]¶ Sid.
- Parameters
email – Email address to associate with this usage
uuid – The uuid of the link usage
-
-
class
ambra_sdk.service.entrypoints.AsyncLocation(api)[source]¶ AsyncLocation.
-
add(account_id, name, customfield_param=None, hl7_template=None, must_approve=None, must_approve_harvest=None, must_approve_move=None, must_approve_upload=None, no_share=None, role_id=None, search_threshold=None, share_code=None, share_description=None, share_settings=None, share_via_gateway=None)[source]¶ Add.
- Parameters
account_id – uuid of the account
name – Name of the location
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
hl7_template – The HL7 reporting template for the location (optional)
must_approve – Flag if shared studies must be approved for the location (optional)
must_approve_harvest – Flag if harvested studies must be approved (optional)
must_approve_move – Flag if moved studies must be approved (optional)
must_approve_upload – Flag if uploaded studies must be approved (optional)
no_share – Flag if studies can not be shared with this location (optional). Studies can still be shared with users in the location.
role_id – Id for the default role for the location (optional)
search_threshold – The number of studies record in the namespace to switch the UI from list to search mode (optional)
share_code – The share code of the location (optional)
share_description – The share description of the location (optional)
share_settings – Share settings JSON structure of the share display settings (optional)
share_via_gateway – Flag if a gateway share is allowed (optional)
-
set(uuid, customfield_param=None, hl7_template=None, must_approve=None, must_approve_harvest=None, must_approve_move=None, must_approve_upload=None, name=None, no_share=None, role_id=None, search_threshold=None, share_code=None, share_description=None, share_settings=None, share_via_gateway=None)[source]¶ Set.
- Parameters
uuid – The location uuid
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
hl7_template – The HL7 reporting template for the location (optional)
must_approve – Flag if shared studies must be approved for the location (optional)
must_approve_harvest – Flag if harvested studies must be approved (optional)
must_approve_move – Flag if moved studies must be approved (optional)
must_approve_upload – Flag if uploaded studies must be approved (optional)
name – Name of the location (optional)
no_share – Flag if studies can not be shared with this location (optional). Studies can still be shared with users in the location.
role_id – Id for the default role for the location (optional)
search_threshold – The number of studies record in the namespace to switch the UI from list to search mode (optional)
share_code – The share code of the location (optional)
share_description – The share description of the location (optional)
share_settings – Share settings JSON structure of the share display settings (optional)
share_via_gateway – Flag if a gateway share is allowed (optional)
-
user_add(event_upload_fail, user_id, uuid, event_approve=None, event_case_assignment=None, event_harvest=None, event_incoming_study_request=None, event_link=None, event_link_mine=None, event_message=None, event_new_report=None, event_node=None, event_query_add=None, event_query_edit=None, event_query_reply=None, event_report_remove=None, event_share=None, event_site_qualified=None, event_status_change=None, event_study_comment=None, event_thin_study_fail=None, event_thin_study_success=None, event_upload=None, no_physician_alias_share=None, role_id=None)[source]¶ User add.
- Parameters
event_upload_fail – Notify the user on a failed upload into the location namespace
user_id – Id of the user
uuid – The location id
event_approve – Notify the user on a approval needed into the location namespace (optional)
event_case_assignment – Notify the user when they are assigned a case as a medical or admin user (optional)
event_harvest – Notify the user on a harvest into the location namespace (optional)
event_incoming_study_request – Notify the user when they get an incoming study request (optional)
event_link – Notify the user when an anonymous link is hit in the namespace (optional)
event_link_mine – Notify the user when an anonymous link created by the user is hit in the namespace (optional)
event_message – Notify the user when a message is sent to the location namespace (optional)
event_new_report – Notify the user when a report is attached in the location namespace (optional)
event_node – Notify the user when a location node sends an event (optional)
event_query_add – Notify the user when a new query is issued (optional)
event_query_edit – Notify the user when a query is edites (optional)
event_query_reply – Notify the user when they leave a new reply in a query (optional)
event_report_remove – Notify the user when a report is removed in the location namespace (optional)
event_share – Notify the user on a share into the location namespace (optional)
event_site_qualified – Notify the user when a trial site is qualified for the clinical trial account (optional)
event_status_change – Notify the user when the status of a study is changed (optional)
event_study_comment – Notify the user when a comment is attached to a study in the namespace (optional)
event_thin_study_fail – Notify the user when a thin study retrieval they initiated fails (optional)
event_thin_study_success – Notify the user when a thin study retrieval they initiated succeeds (optional)
event_upload – Notify the user on an upload into the location namespace (optional)
no_physician_alias_share – Flag to exclude this location from a physician alias share (optional)
role_id – Id of the users role within the location (optional). If not passed the default location role will be assigned
-
-
class
ambra_sdk.service.entrypoints.AsyncMeeting(api)[source]¶ AsyncMeeting.
-
add(name, state, phi_namespace=None, storage_namespace=None, study_id=None, study_uid=None)[source]¶ Add.
- Parameters
name – Title of the meeting
state – State of the meeting
phi_namespace – phi_namespace
storage_namespace – storage_namespace
study_id – study_id
study_uid – study_uid
-
events_add(event, uuid)[source]¶ Events add.
- Parameters
event – Event to send to the meeting
uuid – UUID of the meeting
-
-
class
ambra_sdk.service.entrypoints.AsyncMessage(api)[source]¶ AsyncMessage.
-
add(body, account_id=None, email=None, group_id=None, location_id=None, namespace_id=None, parent_id=None, query_id=None, share_code=None, study_id=None, study_request_id=None, subject=None, user_id=None)[source]¶ Add.
- Parameters
body – The body of the message
account_id – account_id
email – email
group_id – group_id
location_id – location_id
namespace_id – namespace_id
parent_id – The uuid of the parent message (optional)
query_id – query_id
share_code – share_code
study_id – study_id
study_request_id – study_request_id
subject – The subject of the message (optional)
user_id – user_id
-
-
class
ambra_sdk.service.entrypoints.AsyncNamespace(api)[source]¶ AsyncNamespace.
-
anonymize(uuid, anonymization_id=None, prompt_for_anonymize=None, rules=None)[source]¶ Anonymize.
- Parameters
uuid – The uuid of the namespace
anonymization_id – The uuid of the anonymization profile to connect to the namespace. (optional)
prompt_for_anonymize – Flag to prompt if the anonymization rules should be applied. Only applicable to ingress anonymization. (optional)
rules – Anonymization rules in JSON format. The format is a hash with the keys the names of the fields to anonymize and the values the regular expressions to apply. (optional)
-
audit(action, detail, uuid)[source]¶ Audit.
- Parameters
action – The audit action (AI_ACTION)
detail – Additional information
uuid – The id of the namespace
-
coverpage(uuid, coverpage=None)[source]¶ Coverpage.
- Parameters
uuid – The uuid of the namespace
coverpage – The coverpage value. See the notes for formatting details or pass an empty string to remove the current cover page. (optional)
-
engine_fqdn(namespace_id=None, phi_namespace=None, source=None, storage_namespace=None, study_id=None, study_uid=None)[source]¶ Engine fqdn.
- Parameters
namespace_id – namespace_id
phi_namespace – phi_namespace
source – The source of the query (optional)
storage_namespace – storage_namespace
study_id – study_id
study_uid – study_uid
-
event_defaults(uuid, event_approve=None, event_case_assignment=None, event_harvest=None, event_incoming_study_request=None, event_link=None, event_link_mine=None, event_message=None, event_new_report=None, event_node=None, event_query_add=None, event_query_edit=None, event_query_reply=None, event_report_remove=None, event_share=None, event_site_qualified=None, event_status_change=None, event_study_comment=None, event_thin_study_fail=None, event_thin_study_success=None, event_upload=None, event_upload_fail=None)[source]¶ Event defaults.
- Parameters
uuid – The uuid of the namespace
event_approve – Notify the user on a approval needed into the namespace (optional)
event_case_assignment – Notify the user when they are assigned a case as a medical or admin user (optional)
event_harvest – Notify the user on a harvest into the namespace (optional)
event_incoming_study_request – Notify the user when they get an incoming study request (optional)
event_link – Notify the user when an anonymous link is hit in the namespace (optional)
event_link_mine – Notify the user when an anonymous link created by the user is hit in the namespace (optional)
event_message – Notify the user when a message is sent to the namespace (optional)
event_new_report – Notify the user when a report is attached in the namespace (optional)
event_node – Notify the user when a namespace node sends an event (optional)
event_query_add – Notify the user when a new query is issued (optional)
event_query_edit – Notify the user when a query is edites (optional)
event_query_reply – Notify the user when they leave a new reply in a query (optional)
event_report_remove – Notify the user when a report is removed in the namespace (optional)
event_share – Notify the user on a share into the namespace (optional)
event_site_qualified – Notify the user when a trial site is qualified for the clinical trial account (optional)
event_status_change – Notify the user when the status of a study is changed (optional)
event_study_comment – Notify the user when a comment is attached to a study in the namespace (optional)
event_thin_study_fail – Notify the user when a thin study retrieval they initiated fails (optional)
event_thin_study_success – Notify the user when a thin study retrieval they initiated succeeds (optional)
event_upload – Notify the user on an upload into the namespace (optional)
event_upload_fail – Notify the user on a failed upload into the namespace (optional)
-
permissions(namespace_id=None, oauth=None, phi_namespace=None, serial_no=None, storage_namespace=None, study_id=None, study_uid=None, uuid=None)[source]¶ Permissions.
- Parameters
namespace_id – namespace_id
oauth – Flag to return the OAuth token information for the user (optional)
phi_namespace – phi_namespace
serial_no – serial_no
storage_namespace – storage_namespace
study_id – study_id
study_uid – study_uid
uuid – uuid
-
question(detail, question, uuid)[source]¶ Question.
- Parameters
detail – Optional detail to pass through to the AI stack
question – The question to ask or a JSON array of questions to ask
uuid – The namespace id
-
removed_user_report(account_id, email, uuid)[source]¶ Removed user report.
- Parameters
account_id – The UUID of the account. A report will be produced for group, location and account namespaces of this account
email – Optional email address to send the report to
uuid – The UUID of the namespace
-
settings(uuid, ai_settings=None, allow_drag_and_drop_in_study_uploader=None, auto_create_patient=None, auto_enable_dicom_wrapping=None, cloud_storage_config=None, disable_duplicate_study_upload=None, disable_mobile_dicom_wrapping=None, download_anonymize=None, enable_dicom_deidentification=None, enable_dicom_wrapping=None, enable_epic_patient_lookup=None, enable_multipart_uploader=None, enable_namespace_ai_questions=None, epic_prompt_for_anonymize=None, force_new_study_on_upload=None, ira_namespace=None, link_defaults=None, must_approve_duplicate_study_uid=None, no_dup_share=None, pixel_anonymize_color=None, priority_notifications=None, remove_private_tags_on_upload=None, reverse_patient_name=None, share_related=None, single_file_dicom_wrapping=None, study_field_flags=None, study_size_soft_threshold_per_user=None, try_update_original_study=None, try_update_original_study_from_namespaces=None, try_update_original_study_to_namespaces=None, ui_json=None, upload_settings=None)[source]¶ Settings.
- param uuid
The uuid of the namespace
- param ai_settings
Other AI settings
- param allow_drag_and_drop_in_study_uploader
Value for the setting (optional)
- param auto_create_patient
Value for the setting (optional)
- param auto_enable_dicom_wrapping
Value for the setting (optional)
- param cloud_storage_config
Value for the setting (optional)
- param disable_duplicate_study_upload
Value for the setting (optional)
- param disable_mobile_dicom_wrapping
Value for the setting (optional)
- param download_anonymize
Anonymization rules to apply on study download. The setting format should follow the anonymize_tags parameter format of the Storage /study/{namespace}/{studyUid}/download call (optional)
- param enable_dicom_deidentification
Value for the setting (optional)
- param enable_dicom_wrapping
Value for the setting (optional)
- param enable_epic_patient_lookup
Value for the setting (optional)
- param enable_multipart_uploader
Value for the setting (optional)
- param enable_namespace_ai_questions
Value for the setting (optional)
- param epic_prompt_for_anonymize
Value for the setting (optional)
- param force_new_study_on_upload
Value for the setting (optional)
- param ira_namespace
Flag to make the namespace viable owner namespace for Queries (optional)
- param link_defaults
Value for the setting (optional)
- param must_approve_duplicate_study_uid
Value for the setting (optional)
- param no_dup_share
Flag to stop duplicate studies (same study_uid and image count) from getting shared into the namespace (optional)
- param pixel_anonymize_color
Value for the setting (optional)
- param priority_notifications
Value for the setting (optional)
- param remove_private_tags_on_upload
Flag the storage to anonymize or remove all private tags from a study (optional)
- param reverse_patient_name
Value for the setting (optional)
- param share_related
Flag to make study shares with this namespace include related studies (same PHI namespace, same MRN) (optional)
- param single_file_dicom_wrapping
Value for the setting (optional)
- param study_field_flags
A JSON hash of study_field_* role values to override the role values for studies in the namespace (optional)
- param study_size_soft_threshold_per_user
A threshold for studies size per user. An email (by study_quota_exceeded template) will be sent when this limit is exceeded by a user. A JSON hash of study_field_* role values to override the role values for studies in the namespace (optional)
- param try_update_original_study
Value for the setting (optional)
- param try_update_original_study_from_namespaces
Value for the setting (optional)
- param try_update_original_study_to_namespaces
Value for the setting (optional)
- param ui_json
JSON for UI setting (optional) possible options:
pixel_de_id_by_default (boolean) Pixel de-id tool is set by default when uploading study to this namespace show_image_on_upload_page (boolean) Show computer image with CD on upload page when image is uploading to this namespace
- param upload_settings
Value for the setting (optional)
Share_code.
- Parameters
namespace_id – namespace_id
serial_no – serial_no
share_code – share_code
uuid – uuid
Share price.
- Parameters
uuid – The uuid of the namespace
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) defined for the case (or study) account objects with values entered in the second opinion wizard (or in the image share screen) (optional)
Share pricing.
- Parameters
uuid – The uuid of the namespace
charge_description – The description of the charge (optional)
currency – 3-letter ISO code for currency to charge in (USD|GBP) (optional)
customfields_pricing – Pricing table in JSON format (optional)
pricing – Pricing table in JSON format (optional)
second_opinion_config – JSON configuration for the second opinion workflow (optional)
second_opinion_share – Flag to enable/disable the second opinion workflow for the share (optional)
share_charge_by_modality – Charge shares (including second opinion) by modality of a shared study if this flag is set (optional)
sum_price_matches – Flag to search for all matches in customfields_pricing table and to add them up (optional)
-
study_defaults(uuid, defaults=None)[source]¶ Study defaults.
- Parameters
uuid – The uuid of the namespace
defaults – Default values in JSON format. The format is a hash with the keys the names of the fields and the values are the default value. The available field name are as listed in the returned field hash. (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncNode(api)[source]¶ AsyncNode.
-
add(accelerator_id, name, type, account_id=None, category=None, ctc_bucket=None, facility_contact=None, facility_contact_title=None, facility_email=None, facility_name=None, facility_notes=None, facility_zip=None, group_id=None, is_public=None, location_id=None, os_type=None, uuid=None)[source]¶ Add.
- Parameters
accelerator_id – uuid of the accelerator if this is an accelerator node
name – Description of the node
type – Type of node (STORAGE|HARVESTER|ACCELERATOR|CLEARINGHOUSE|VIRTUAL|UTILITY|XDS)
account_id – account_id
category – Node category (ACTIVE|INACTIVE|MIGRATION|TEST|DUPLICATE|INTEGRATED|ACCELERATOR) (optional)
ctc_bucket – Name of the S3 bucket to use for a cloud to cloud gateway (optional)
facility_contact – Name of the facility contact (optional)
facility_contact_title – Title of the facility contact (optional)
facility_email – Email of the facility contact (optional)
facility_name – Name of the facility it is installed at (optional)
facility_notes – Notes about the facility (optional)
facility_zip – Zip code of the facility it is installed at (optional)
group_id – group_id
is_public – Flag if the node is public (optional)
location_id – location_id
os_type – Node OS type, used with HARVESTER node type only (WINDOWS|MACOS) (optional)
uuid – uuid of the node (optional, you can use this to explicitly set the UUID)
-
approve(account_id, uuid)[source]¶ Approve.
- Parameters
account_id – The account which requested the connection
uuid – The node id
-
configuration(serial_no, uuid)[source]¶ Configuration.
- Parameters
serial_no – The serial number of the node
uuid – The node id
-
connect(account_id, uuid, message=None)[source]¶ Connect.
- Parameters
account_id – The account the user is in
uuid – The node id
message – Message (optional)
-
deliver(serial_no, status, uuid, ack=None, destination_id=None, email_reason=None, is_local=None, job_id=None, status_reason=None, study_uid=None)[source]¶ Deliver.
- Parameters
serial_no – The serial number of the node
status – Status code of the job (S|F|P|B|U) - Success, failure, partial transfer, blocked or uncached
uuid – The node id
ack – The HL7 ACK if this was an HL7 job (optional)
destination_id – The uuid of the destination, required for local pushes (optional)
email_reason – Email the user this reason for the status change (optional)
is_local – The flag used to indicate the local push (optional)
job_id – The uuid of the push job, not used for local pushes (optional)
status_reason – Detail on the status change (optional)
study_uid – The study uid of the local push, required for local pushes only (optional)
-
event(destination_id, event, serial_no, uuid)[source]¶ Event.
- Parameters
destination_id – The id of the destination if the event is associated with a destination
event – The event (c_echo_error)
serial_no – The serial number of the node
uuid – The node id
-
found(search_id, serial_no, uuid, status=None, studies=None)[source]¶ Found.
- Parameters
search_id – The id of the search request
serial_no – The serial number of the node
uuid – The node id
status – Status code of the job, S by default (S|F) - Success, failure (optional)
studies – A JSON array of the studies found. Each object has the following fields (optional) * study_uid The study_uid * study_date The study date * accession_number The accession number * referring_physician The referring physician * patient_name Patient name * patientid Patient ID * patient_sex Gender * patient_birth_date Birth date * study_description Study description * modality Modality * result_fields A JSON structure with the answers for the requested result_fields in /destination/search (optional)
-
found_mwl(search_id, serial_no, uuid, orders=None, status=None)[source]¶ Found mwl.
- Parameters
search_id – The id of the search request
serial_no – The serial number of the node
uuid – The node id
orders – A JSON array of the orders found. Each object has the following fields (optional) * patient_name Patient name * patientid Patient id * accession_number Accession number * patient_sex Gender * patient_birth_date Birth date * order_number Order number * order_date Order date
status – Status code of the job, S by default (S|F) - Success, failure (optional)
-
log(end, start, type, uuid)[source]¶ Log.
- Parameters
end – End time stamp in YYYY-MM-DD HH:MM:SS format
start – Start time stamp in YYYY-MM-DD HH:MM:SS format
type – Type of log (log|dicom|queue|system) defaults to log if not passed
uuid – The node id
-
metric(job_id, metric, serial_no, uuid)[source]¶ Metric.
- Parameters
job_id – The uuid of the push job
metric – The metric to record
serial_no – The serial number of the node
uuid – The node id
-
performance_get(uuid, serial_no=None)[source]¶ Performance get.
- Parameters
uuid – The node id
serial_no – serial_no
-
performance_set(data, serial_no, uuid)[source]¶ Performance set.
- Parameters
data – A JSON data structure with performance data
serial_no – The serial number of the node
uuid – The node id
-
ping(ack, serial_no, uuid)[source]¶ Ping.
- Parameters
ack – Flag if the gateway wants to use the acknowledge workflow
serial_no – The serial number of the node
uuid – The node id
-
ping_ack(serial_no, uuid)[source]¶ Ping ack.
- Parameters
serial_no – The serial number of the node
uuid – The node id
-
progress_add(queue, serial_no, state, uuid, accession_number=None, destination_id=None, detail=None, patientid=None, study_uid=None)[source]¶ Progress add.
- Parameters
queue – The queue
serial_no – The serial number of the node
state – The status
uuid – The node id
accession_number – DICOM tag (0008,0050) (optional)
destination_id – The destination uuid (optional)
detail – JSON detail (optional)
patientid – DICOM tag (0010,0020) (optional)
study_uid – Study uid (optional)
-
progress_list(destination_id=None, node_id=None)[source]¶ Progress list.
- Parameters
destination_id – destination_id
node_id – node_id
-
retrieve(job_id, serial_no, status, uuid)[source]¶ Retrieve.
- Parameters
job_id – The uuid of the fetch job
serial_no – The serial number of the node
status – Status code of the job (S|F|P) - Success, failure, partial transfer
uuid – The node id
-
set(uuid, category=None, configuration=None, ctc_bucket=None, facility_contact=None, facility_contact_title=None, facility_email=None, facility_name=None, facility_notes=None, facility_zip=None, is_public=None, monitor_email=None, monitor_node_last_send=None, monitor_node_last_send_threshold=None, monitor_node_ping=None, monitor_node_slow_push=None, monitor_node_slow_push_threshold=None, monitor_study_create=None, monitor_study_create_threshold=None, name=None, reload_configuration=None, serial_no=None, setting_param=None, settings=None, storage_namespace=None, warning_email=None)[source]¶ Set.
- Parameters
uuid – The node id
category – Node category (ACTIVE|INACTIVE|MIGRATION|TEST|DUPLICATE|INTEGRATED) (optional)
configuration – The configuration as a JSON hash of key values pairs (optional)
ctc_bucket – Name of the S3 bucket to use for a cloud to cloud gateway (optional)
facility_contact – Name of the facility contact (optional)
facility_contact_title – Title of the facility contact (optional)
facility_email – Email of the facility contact (optional)
facility_name – Name of the facility it is installed at (optional)
facility_notes – Notes about the facility (optional)
facility_zip – Zip code of the facility it is installed at (optional)
is_public – Flag if the node is public (optional)
monitor_email – Email address(es) to send monitor failure notices (optional)
monitor_node_last_send – Check if the node has sent a study recently (optional)
monitor_node_last_send_threshold – Threshold in minutes for triggering the monitor_node_last_send notification (optional)
monitor_node_ping – Check if the node is pinging (optional)
monitor_node_slow_push – Check if the node is pushing slowly (optional)
monitor_node_slow_push_threshold – Threshold in minutes for triggering the monitor_node_slow_push notification (optional)
monitor_study_create – Check if the node is sending studies normally (optional)
monitor_study_create_threshold – Threshold in minutes for triggering the monitor_study_create notification (optional)
name – Description of the node (optional)
reload_configuration – If this flag is set the node will be instructed to reload it’s configuration on the next ping (optional)
serial_no – serial_no
setting_param – Expected values are SETTING_NAME. Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional)
settings – A hash of the account settings that the node can override (optional)
storage_namespace – Namespace uuid to attach the node to. This requires a sysadmin sid and must be within the same account (optional)
warning_email – Email address(es) to send warning notices (optional)
-
study_anonymized(new_study_uid, old_study_uid, serial_no, uuid)[source]¶ Study anonymized.
- Parameters
new_study_uid – The new study uid
old_study_uid – The old study uid
serial_no – The serial number of the node
uuid – The node id
-
study_queued(serial_no, study_uid, uuid)[source]¶ Study queued.
- Parameters
serial_no – The serial number of the node
study_uid – The study uid
uuid – The node id
-
webhook(serial_no, status, uuid, webhook_id, error_message=None)[source]¶ Webhook.
- Parameters
serial_no – The serial number of the node
status – Status code of the job (S|F) - Success, failure
uuid – The node id
webhook_id – The uuid of the webhook job
error_message – Detailed error message (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncOrder(api)[source]¶ AsyncOrder.
-
add(accession_number, account_id, patient_birth_date, patient_name, patient_sex, patientid, referring_physician, sending_facility, customfield_param=None)[source]¶ Add.
- Parameters
accession_number – Accession number
account_id – uuid of the account to add them to
patient_birth_date – DOB
patient_name – Patient name
patient_sex – Gender
patientid – Patient MRN
referring_physician – Referring physician
sending_facility – Sending facility
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
-
set(accession_number, patient_birth_date, patient_name, patient_sex, patientid, referring_physician, sending_facility, uuid, customfield_param=None)[source]¶ Set.
- Parameters
accession_number – Accession number
patient_birth_date – DOB
patient_name – Patient name
patient_sex – Gender
patientid – Patient MRN
referring_physician – Referring physician
sending_facility – Sending facility
uuid – The order uuid
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
-
sps_add(modality, order_id, requested_procedure_description, requested_procedure_id, scheduled_procedure_step_description, scheduled_procedure_step_id, scheduled_procedure_step_start_date, scheduled_procedure_step_start_time, scheduled_station_aetitle)[source]¶ Sps add.
- Parameters
modality – Modality
order_id – uuid of the order
requested_procedure_description – Procedure description
requested_procedure_id – Procedure ID
scheduled_procedure_step_description – Step description
scheduled_procedure_step_id – Step ID
scheduled_procedure_step_start_date – Start date
scheduled_procedure_step_start_time – Start time
scheduled_station_aetitle – Station AE title
-
sps_find(account_id, node_id=None, serial_no=None)[source]¶ Sps find.
- Parameters
account_id – The account uuid if sid authentication is used
node_id – node_id
serial_no – serial_no
-
sps_set(uuid, modality=None, requested_procedure_description=None, requested_procedure_id=None, scheduled_procedure_step_description=None, scheduled_procedure_step_id=None, scheduled_procedure_step_start_date=None, scheduled_procedure_step_start_time=None, scheduled_station_aetitle=None)[source]¶ Sps set.
- Parameters
uuid – UUID of the SPS
modality – Modality (optional)
requested_procedure_description – Procedure description (optional)
requested_procedure_id – Procedure ID (optional)
scheduled_procedure_step_description – Step description (optional)
scheduled_procedure_step_id – Step ID (optional)
scheduled_procedure_step_start_date – Start date (optional)
scheduled_procedure_step_start_time – Start time (optional)
scheduled_station_aetitle – Station AE title (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncPatient(api)[source]¶ AsyncPatient.
-
add(account_id, alt_email=None, alt_mobile_phone=None, birth_date=None, customfield_param=None, email=None, event_new_report=None, event_share=None, first=None, last=None, mobile_phone=None, mrn=None, name=None, sex=None, study_id=None)[source]¶ Add.
- Parameters
account_id – uuid of the account to add them to
alt_email – Alternate email address (optional)
alt_mobile_phone – Alternate mobile phone number (optional)
birth_date – Birth date (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
email – Email address (optional)
event_new_report – Notify the patient if a report is attached on the patient portal (optional)
event_share – Notify the patient if a new study is available on the patient portal (optional)
first – first
last – last
mobile_phone – Mobile phone number (optional)
mrn – MRN (optional if study_id is used)
name – name
sex – Gender (optional)
study_id – Id of the study to create a patient from (optional)
-
portal_find(birth_date, first, last, mrn)[source]¶ Portal find.
- Parameters
birth_date – Date of birth
first – The first name
last – The last name
mrn – MRN (required if the require_mrn_for_patient_portal account setting is on)
-
portal_login(patient_id, pin)[source]¶ Portal login.
- Parameters
patient_id – The patient id
pin – The PIN
-
portal_pin(alt_email, alt_mobile_phone, email, mobile_phone, patient_id)[source]¶ Portal pin.
- Parameters
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
email – Flag if they want the PIN sent via email
mobile_phone – Flag if they want the PIN sent via SMS
patient_id – The patient id
-
set(birth_date, mrn, sex, uuid, alt_email=None, alt_mobile_phone=None, customfield_param=None, email=None, event_new_report=None, event_share=None, first=None, last=None, mobile_phone=None, name=None, setting_param=None, settings=None)[source]¶ Set.
- Parameters
birth_date – Birth date
mrn – MRN
sex – Gender
uuid – The patient uuid
alt_email – Alternate email address (optional)
alt_mobile_phone – Alternate mobile phone number (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
email – Email address (optional)
event_new_report – Notify the patient if a report is attached on the patient portal (optional)
event_share – Notify the patient if a new study is available on the patient portal (optional)
first – first
last – last
mobile_phone – Mobile phone number (optional)
name – name
setting_param – Expected values are SETTING_NAME. Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional)
settings – A hash of the patient settings, see Notes. (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncPurge(api)[source]¶ AsyncPurge.
-
add(account_id, days_old, days_old_how, name, adults=None, archive=None, global_param=None, max_deletes=None, minors=None, modalities=None, namespaces=None, object=None, owned_phr=None, shared_from_phr=None, skinny=None, study_status_tags=None, suspended=None, thin=None)[source]¶ Add.
- Parameters
account_id – uuid of the account the rule is for
days_old – Studies greater than or equal to these days old will be purged
days_old_how – How should the days old value be calculated using the ‘U’pdated, ‘C’reated or ‘S’tudy date
name – Name of the purge rule
adults – Apply this rule to adults - flag (optional)
archive – Archive the studies rather than deleting them - flag (optional)
global_param – Flag to make this a global purge rule (optional)
max_deletes – Maximum number of purges per run of the rule (optional)
minors – Apply this rule to minors - flag (optional)
modalities – A JSON array of modalities to limit the rule to (optional)
namespaces – A JSON array of namespace uuid to limit the rule to (optional)
object – The object to be purged, Study by default (Study|Hl7) (optional)
owned_phr – Apply this rule to owned PHR namespaces - flag (optional)
shared_from_phr – If a study was shared from a PHR namespace delete the copy in the PHR namespace as well - flag (optional)
skinny – Make the studies skinny rather than deleting - flag (optional)
study_status_tags – A comma separated list of study status tags to purge (optional)
suspended – This rule is suspended and not applied - flag (optional)
thin – Make the studies thin rather than deleting - flag (optional)
-
run(dry_run, account_id=None, object=None, rule_id=None)[source]¶ Run.
- Parameters
dry_run – Do a dry run of the rule - flag
account_id – account_id
object – Limit purging to this object only (optional)
rule_id – rule_id
-
set(uuid, adults=None, archive=None, days_old=None, days_old_how=None, global_param=None, max_deletes=None, minors=None, modalities=None, name=None, namespaces=None, owned_phr=None, shared_from_phr=None, skinny=None, study_status_tags=None, suspended=None, thin=None)[source]¶ Set.
- Parameters
uuid – Id of the purge rule
adults – Apply this rule to adults - flag (optional)
archive – Archive the studies rather than deleting them - flag (optional)
days_old – Studies greater than or equal to these days old will be purged (optional)
days_old_how – How should the days old value be calculated using the ‘U’pdated, ‘C’reated or ‘S’tudy date (optional)
global_param – Flag to make this a global purge rule (optional)
max_deletes – Maximum number of purges per run of the rule (optional)
minors – Apply this rule to minors - flag (optional)
modalities – A JSON array of modalities to limit the rule to) (optional)
name – Name of the purge rule (optional)
namespaces – A JSON array of namespace uuid to limit the rule to (optional)
owned_phr – Apply this rule owned PHR namespaces - flag (optional)
shared_from_phr – If a study was shared from a PHR namespace delete the copy in the PHR namespace as well - flag (optional)
skinny – Make the studies skinny rather than deleting - flag (optional)
study_status_tags – A comma separated list of study status tags to purge (optional)
suspended – This rule is suspended and not applied - flag (optional)
thin – Make the studies thin rather than deleting - flag (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncQctask(api)[source]¶ AsyncQctask.
-
add(namespace_id, priority, customfield_param=None, message=None, qctask_status=None, queries=None, query_id=None, studies=None, user_id=None)[source]¶ Add.
- Parameters
namespace_id – Id of the namespace assigned to the QC Task
priority – QC Task priority
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
message – Explanatory message for the QC Task (optional)
qctask_status – Status of the QC task, Open by default (Open|InProgress|Closed) (optional)
queries – A JSON array of the query uuid(s) associate the QC Task to (optional)
query_id – Id of the query to associate the QC Task to (optional)
studies – A JSON array of the study uuid(s) (optional)
user_id – Id of the user to assign the QC Task to (optional)
-
set(uuid, customfield_param=None, message=None, priority=None, queries=None, studies=None, user_id=None)[source]¶ Set.
- Parameters
uuid – The QC Task uuid
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
message – Explanatory message for the QC Task (optional)
priority – QC Task priority (optional)
queries – A JSON array of the query uuid(s) associate the QC Task to (optional)
studies – A JSON array of the study uuid(s) (optional)
user_id – Id of the user to assign the QC Task to (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncQuery(api)[source]¶ AsyncQuery.
-
add(group_id, subject, body=None, customfield_param=None, notify=None, owner_namespace_id=None, owner_user_id=None, query_type=None, recipients=None, study_id=None)[source]¶ Add.
- Parameters
group_id – Id of the group associated to a trial site to add them to
subject – Subject line of the query
body – The query body (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
notify – Comma delimited list of the emails to be notified of the query events (optional)
owner_namespace_id – The namespace owning the query. The account default from the default_query_owner_namespace account setting is used if not passed through the parameter (optional)
owner_user_id – The user owning the query (optional)
query_type – The query type (optional)
recipients – JSON array of the user UUIDs to add to the query as recipients (optional)
study_id – The study the query is related to (optional)
-
attachment_add(length, name, query_id, type, thumbnail_length=None, thumbnail_type=None)[source]¶ Attachment add.
- Parameters
length – The attachment size in bytes
name – The attachment display name
query_id – Query UUID
type – The attachment MIME-type
thumbnail_length – The attachment’s thumbnail MIME-type (optional)
thumbnail_type – The attachment’s thumbnail size in bytes (optional)
-
seen(uuid, message_id=None)[source]¶ Seen.
- Parameters
uuid – The query uuid
message_id – ID of the last seen message (optional)
-
set(uuid, body=None, customfield_param=None, group_id=None, notify=None, owner_user_id=None, query_type=None, recipients=None, subject=None)[source]¶ Set.
- Parameters
uuid – The query uuid
body – The query body (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
group_id – Id of the group associated to a trial site to add them to. Group change is not allowed for study-related queries (optional)
notify – Comma delimited list of the emails to be notified of the query events (optional)
owner_user_id – The user owning the query (optional)
query_type – The query type (optional)
recipients – JSON array of the user UUIDs to add to the query as recipients (optional)
subject – Subject line of the query (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncRadreport(api)[source]¶ AsyncRadreport.
-
add(study_id, type, fields=None)[source]¶ Add.
- Parameters
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)
-
audit(action, detail, uuid)[source]¶ Audit.
- Parameters
action – The audit action (SIGNED|MEDICAL_EDIT|ADMIN_EDIT|REPORT_GENERATED)
detail – Additional information
uuid – The id of the radreport
-
email(email, uuid)[source]¶ Email.
- Parameters
email – The email address(es) to send the radreport to
uuid – The radreport uuid
-
fax(number, uuid)[source]¶ Fax.
- Parameters
number – The fax number to send the PDF report to
uuid – The radreport uuid
-
set(uuid, attachment=None, fields=None)[source]¶ Set.
- Parameters
uuid – Id of the radreport
attachment – A JSON hash of the storage attachment information (optional)
fields – A JSON hash of the fields in the report (optional)
-
template_add(account_id, body, name, type, options=None, preview=None)[source]¶ Template add.
- Parameters
account_id – uuid of the account
body – Body of the template
name – Name of the template
type – Type of radreport
options – JSON options of the template (optional)
preview – Preview of the template (optional)
-
template_get_type(account_id, type)[source]¶ Template get type.
- Parameters
account_id – uuid of the account
type – Type of the template
-
template_list(account_id, active=None, type=None)[source]¶ Template list.
- Parameters
account_id – uuid of the account
active – Limit to active templates (optional)
type – Limit to this type (optional)
-
template_set(uuid, body=None, name=None, options=None, preview=None, type=None)[source]¶ Template set.
- Parameters
uuid – uuid of the template
body – Body of the template (optional)
name – Name of the template (optional)
options – JSON options of the template (optional)
preview – Preview of the template (optional)
type – Type of radreport (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncRadreportmacro(api)[source]¶ AsyncRadreportmacro.
-
add(account_id, body, modality, name, type, hotkey=None)[source]¶ Add.
- Parameters
account_id – uuid of the account
body – JSON body of the macro
modality – Modality
name – Name of the macro
type – Type of radreport
hotkey – Hotkey of the macro (optional)
-
list(account_id, modality=None, type=None)[source]¶ List.
- Parameters
account_id – uuid of the account
modality – Limit to this modality (optional)
type – Limit to this type (optional)
-
set(uuid, body=None, hotkey=None, modality=None, name=None, type=None)[source]¶ Set.
- Parameters
uuid – uuid of the macro
body – JSON body of the macro (optional)
hotkey – Hotkey of the macro (optional)
modality – Modality (optional)
name – Name of the macro (optional)
type – Type of radreport (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncRole(api)[source]¶ AsyncRole.
-
add(account_id, name, for_account=None, for_group=None, for_location=None, permissions=None, setting_param=None, settings=None)[source]¶ Add.
- Parameters
account_id – uuid of the account
name – Name of the role
for_account – A flag that the role can be used in an account, default is on (optional)
for_group – A flag that the role can be used in a group, default is on (optional)
for_location – A flag that the role can be used in a location, default is on (optional)
permissions – A hash of the role permissions (optional)
setting_param – Expected values are SETTING_NAME. Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional)
settings – A hash of the role settings (optional)
-
default_permissions(account_id=None)[source]¶ Default permissions.
- Parameters
account_id – The account id (optional)
-
set(uuid, description=None, for_account=None, for_group=None, for_location=None, name=None, permission_param=None, permissions=None, setting_param=None, settings=None)[source]¶ Set.
- Parameters
uuid – The role uuid
description – Description of the role (optional)
for_account – A flag that the role can be used in an account (optional)
for_group – A flag that the role can be used in a group (optional)
for_location – A flag that the role can be used in a location (optional)
name – Name of the role (optional)
permission_param – Expected values are PERMISSION_NAME. Set an individual permission. This is an alternative to the permissions hash for easier use in the API tester (optional)
permissions – A hash of the role permissions (optional)
setting_param – Expected values are SETTING_NAME. Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional)
settings – A hash of the role settings (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncRoute(api)[source]¶ AsyncRoute.
-
add(actions, conditions, name, on_harvest, on_share, account_id=None, delay=None, delay_from_study_field=None, delay_from_study_seconds=None, delay_seconds=None, delay_till_schedule=None, group_id=None, location_id=None, manual_roles=None, namespace_id=None, no_re_run=None, on_manual_route=None, on_thin=None, on_upload=None, only_re_run=None, options=None, other_namespaces=None, schedule=None, suspended=None)[source]¶ Add.
- Parameters
actions – Route actions in JSON format
conditions – Route conditions in JSON format
name – Name of the route
on_harvest – Apply the rule to studies harvested into the namespace
on_share – Apply the rule to studies shared into the namespace
account_id – account_id
delay – Number of minutes to delay running this rule for after it is triggered (optional)
delay_from_study_field – Delay running this rule, start counting from this study’s datetime field (optional)
delay_from_study_seconds – Number of seconds to delay running this rule for after a timepoint defined by delay_from_study_field (optional)
delay_seconds – Number of seconds to delay running this rule for after it is triggered (optional)
delay_till_schedule – Delay running this rule after it is triggered until the next scheduled time - flag (optional)
group_id – group_id
location_id – location_id
manual_roles – A comma separated list of the uuid of roles that can run the rule manually (optional)
namespace_id – namespace_id
no_re_run – Do not run this rule on a re-notification from storage - flag (optional)
on_manual_route – Apply this rule for a manually routed study - flag (optional)
on_thin – Apply this rule to thin studies when they are created - flag (optional)
on_upload – Apply the rule to studies uploaded into the namespace - flag (optional)
only_re_run – Only run this rule on a re-notification from storage - flag (optional)
options – Route options in JSON format (optional)
other_namespaces – A comma separated list of the uuid of other namespaces to apply this rule to (optional)
schedule – Route schedule in JSON format (optional)
suspended – This rule is suspended and not applied - flag (optional)
-
physician_alias_match(account_id, lv)[source]¶ Physician alias match.
- Parameters
account_id – The account to test in
lv – The tag text to match against the PHYSICIAN_ALIAS rule.
-
set(uuid, actions=None, conditions=None, delay=None, delay_from_study_field=None, delay_from_study_seconds=None, delay_seconds=None, delay_till_schedule=None, manual_roles=None, name=None, no_re_run=None, on_harvest=None, on_manual_route=None, on_share=None, on_thin=None, on_upload=None, only_re_run=None, options=None, other_namespaces=None, schedule=None, suspended=None)[source]¶ Set.
- Parameters
uuid – The route uuid
actions – Route actions in JSON format (optional)
conditions – Route conditions in JSON format (optional)
delay – Number of minutes to delay running this rule for after it is triggered (optional)
delay_from_study_field – Delay running this rule, start counting from this study’s datetime field (optional)
delay_from_study_seconds – Number of seconds to delay running this rule for after a timepoint defined by delay_from_study_field (optional)
delay_seconds – Number of seconds to delay running this rule for after it is triggered (optional)
delay_till_schedule – Delay running this rule after it is triggered until the next scheduled time - flag (optional)
manual_roles – A comma separated list of the uuid of roles that can run the rule manually (optional)
name – Name of the route (optional)
no_re_run – Do not run this rule on a re-notification from storage - flag (optional)
on_harvest – Apply the rule to studies harvested into the namespace (optional)
on_manual_route – Apply this rule for a manually routed study- flag (optional)
on_share – Apply the rule to studies shared into the namespace (optional)
on_thin – Apply this rule to thin studies when they are created - flag (optional)
on_upload – Apply the rule to studies uploaded into the namespace - flag (optional)
only_re_run – Only run this rule on a re-notification from storage - flag (optional)
options – Route options in JSON format (optional)
other_namespaces – A comma separated list of the uuid of other namespaces to apply this rule to (optional)
schedule – Route schedule in JSON format (optional)
suspended – This rule is suspended and not applied - flag (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncRsna(api)[source]¶ AsyncRsna.
-
phr_study(access_code, dob, exam_id, namespace, pin, clearinghouse=None)[source]¶ Phr_study.
- Parameters
access_code – RSNA-generated access code
dob – Patient’s date of birth YYYYMMDD
exam_id – RSNA-generated exam ID/token/email (DEPRECATED June 2015 - use access_code)
namespace – Namespace where retrieved exam will be stored
pin – RSNA-generated PIN (DEPRECATED June 2015 - use access_code)
clearinghouse – Clearinghouse to retrieve exam from: test or blank (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncScanner(api)[source]¶ AsyncScanner.
-
add(name, site_id, customfield_param=None, manufacturer=None, modality=None, model=None, serial_no=None)[source]¶ Add.
- Parameters
name – Name of the scanner
site_id – Id of the site to add them to
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
manufacturer – The manufacturer of the scanner (optional)
modality – Modality (optional)
model – The scanner model (optional)
serial_no – The serial number of the scanner (optional)
-
set(uuid, customfield_param=None, manufacturer=None, modality=None, model=None, name=None, serial_no=None)[source]¶ Set.
- Parameters
uuid – The scanner uuid
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
manufacturer – The manufacturer of the scanner (optional)
modality – Modality (optional)
model – The scanner model (optional)
name – Name of the scanner (optional)
serial_no – The serial number of the scanner (optional)
-
-
class
ambra_sdk.service.entrypoints.AsyncSession(api)[source]¶ AsyncSession.
-
async
get_sid(username: str, password: str, special_headers_for_login: Optional[Dict[str, str]] = None) → str[source]¶ Get sid from credentials.
- Parameters
username – user name
password – user password
special_headers_for_login – special headers for login
- Returns
sid
-
login(login, account_login=None, account_name=None, email=None, location=None, new_password=None, password=None, use_pkey=None, validate_session=None, vanity=None)[source]¶ Login.
- Parameters
login – The user account_login or email address
account_login – account_login
account_name – account_name
email – email
location – Login location. (optional)
new_password – Change the password or account password to this. (optional)
password – password
use_pkey – use_pkey
validate_session – If you would like to validate an existing session rather than create a new one pass in the sid of the session to valid in this parameter. It will check if the session is still valid and the credentials are for the session. (optional)
vanity – The account vanity name. (optional)
-
oauth(code, redirect_uri, vendor)[source]¶ Oauth.
- Parameters
code – The OAuth code
redirect_uri – The redirect_uri used to get the code parameter
vendor – The OAuth vendor (doximity|google|brand)
-
oauth_token(client_id, client_secret, grant_type, duration=None)[source]¶ Oauth token.
- Parameters
client_id – The users email address
client_secret – The users password
grant_type – The grant type, set to client_credentials
duration – The number of seconds the token is valid for (optional and defaults to 3600 with a maximum value of 86400)
-
permissions(account_id=None, namespace_id=None)[source]¶ Permissions.
- Parameters
account_id – account_id
namespace_id – namespace_id
-
pin(pin, remember_device=None)[source]¶ Pin.
- Parameters
pin – The PIN
remember_device – Remember the device as trusted. (optional)
-
async
-
class
ambra_sdk.service.entrypoints.AsyncSetting(api)[source]¶ AsyncSetting.
-
class
ambra_sdk.service.entrypoints.AsyncSite(api)[source]¶ AsyncSite.
-
add(account_id, name, address1=None, address2=None, city=None, country=None, site_id=None, state=None, zip=None)[source]¶ Add.
- Parameters
account_id – uuid of the account to add them to
name – The sites name
address1 – Address line 1 of the site (optional)
address2 – Address line 2 of the site (optional)
city – The city the site is located in (optional)
country – The country of the site (optional)
site_id – The site to attach them to as a satellite site (optional)
state – The state code of the site (optional)
zip – The zip code of the site (optional)
-
set(uuid, address1=None, address2=None, city=None, country=None, inactive=None, name=None, site_id=None, state=None, zip=None)[source]¶ Set.
- Parameters
uuid – The site uuid
address1 – Address line 1 of the site (optional)
address2 – Address line 2 of the site (optional)
city – The city the site is located in (optional)
country – The country of the site (optional)
inactive – Flag if the site is actively used. Might be used to filter out inactive sites (optional)
name – The sites name (optional)
site_id – The site to attach them to as a satellite site (optional)
state – The state code of the site (optional)
zip – The zip code of the site (optional)
-
user_add(role_name, uuid, email=None, user_id=None)[source]¶ User add.
- Parameters
role_name – The role name that should be used for the user in groups
uuid – The group id
email – email
user_id – user_id
-
-
class
ambra_sdk.service.entrypoints.AsyncStudy(api)[source]¶ Async Study namespace.
-
add(accession_number=None, attachment_count=None, customfield_param=None, destination_ae_title=None, image_count=None, integration_key=None, medical_record_locator=None, modality=None, node_id=None, patient_additional_history=None, patient_address=None, patient_age=None, patient_birth_date=None, patient_birth_time=None, patient_birthname=None, patient_comments=None, patient_current_location=None, patient_ethnic_group=None, patient_institution_residence=None, patient_mother_birthname=None, patient_name=None, patient_name_other=None, patient_occupation=None, patient_phone=None, patient_religious_preference=None, patient_sex=None, patient_size=None, patient_weight=None, patientid=None, patientid_other=None, phi_namespace=None, referring_physician=None, serial_no=None, source_ae_title=None, storage_namespace=None, study_date=None, study_description=None, study_time=None, study_uid=None, thin=None, uuid=None)[source]¶ Add.
- Parameters
accession_number – DICOM tag (0008,0050) (optional)
attachment_count – Attachment count (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID|DICOM_TAG. Custom field(s), see notes in /study/add (optional)
destination_ae_title – The destination aetitle (optional)
image_count – Images in the study (optional)
integration_key – Integration key for the study (optional)
medical_record_locator – DICOM tag (0010,1090) (optional)
modality – DICOM tag (0008,0060) (optional)
node_id – If this is a thin study the gateway UUID to retrieve it from can be specified (optional)
patient_additional_history – DICOM tag (0010,21B0) (optional)
patient_address – DICOM tag (0010,1040) (optional)
patient_age – DICOM tag (0010,1010) (optional)
patient_birth_date – DICOM tag (0010,0030) (optional)
patient_birth_time – DICOM tag (0010,0032) (optional)
patient_birthname – DICOM tag (0010,1005) (optional)
patient_comments – DICOM tag (0010,4000) (optional)
patient_current_location – DICOM tag (0038,0300) (optional)
patient_ethnic_group – DICOM tag (0010,2160) (optional)
patient_institution_residence – DICOM tag (0038,0400) (optional)
patient_mother_birthname – DICOM tag (0010,1060) (optional)
patient_name – DICOM tag (0010,0010)(optional)
patient_name_other – DICOM tag (0010,1001) (optional)
patient_occupation – DICOM tag (0010,2180) (optional)
patient_phone – DICOM tag (0010,2154) (optional)
patient_religious_preference – DICOM tag (0010,21F0) (optional)
patient_sex – DICOM tag (0010,0040) (optional)
patient_size – DICOM tag (0010,1020) (optional)
patient_weight – DICOM tag (0010,1030) (optional)
patientid – DICOM tag (0010,0020) (optional)
patientid_other – DICOM tag (0010,1000) (optional)
phi_namespace – phi_namespace
referring_physician – DICOM tag (0008,0090) (optional)
serial_no – serial_no
source_ae_title – The source aetitle (optional)
storage_namespace – storage_namespace
study_date – DICOM tag (0008,0020) (optional)
study_description – DICOM tag (0008,1030) (optional)
study_time – DICOM tag (0008,0030) (optional)
study_uid – study_uid
thin – Flag to add this as a thin study (optional)
uuid – uuid
-
approve(uuid, delay=None, must_match=None)[source]¶ Approve.
- Parameters
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)
-
attach_customfields(uuid, report_name=None)[source]¶ Attach customfields.
- Parameters
uuid – The study id
report_name – The report name (optional defaults to customfields.txt)
-
audit(action, detail, phi_namespace=None, storage_namespace=None, study_uid=None, uuid=None)[source]¶ Audit.
- Parameters
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)
detail – Additional information
phi_namespace – The phi namespace of the study (optional)
storage_namespace – The storage namespace of the study (optional if uuid is passed)
study_uid – The v3 storage uid of the study (optional if uuid is passed)
uuid – The id of the study (optional if study_uid and storage_namespace are passed)
-
cfind(serial_no, uuid, entire_account=None, is_available=None)[source]¶ Cfind.
- Parameters
serial_no – The serial number of the node
uuid – The node id
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)
-
clone(uuid, new_image_uids=None, new_series_uids=None)[source]¶ Clone.
- Parameters
uuid – The study id
new_image_uids – Flag if you want to generate new uids for the study images (optional)
new_series_uids – Flag if you want to generate new uids for the study series (optional)
-
cmove(aetitle, ping, serial_no, study_uid, uuid, detail=None)[source]¶ Cmove.
- Parameters
aetitle – The aetitle to send to
ping – Flag to send the ping job back in this call
serial_no – The serial number of the node
study_uid – The study uid
uuid – The node id
detail – Additional detail to send on the /node/ping (optional)
-
comment_add(body, study_id)[source]¶ Comment add.
- Parameters
body – The comment body
study_id – The study id
-
delete(node_id=None, phi_namespace=None, serial_no=None, storage_namespace=None, study_uid=None, uuid=None)[source]¶ Delete.
- Parameters
node_id – node_id
phi_namespace – phi_namespace
serial_no – serial_no
storage_namespace – storage_namespace
study_uid – study_uid
uuid – uuid
-
duplicate(uuid, exclude_phi=None, include_attachments=None, namespace_id=None, overwrite=None, study_request_id=None)[source]¶ Duplicate.
- Parameters
uuid – The study id
exclude_phi – Flag to not duplicate PHI data (optional)
include_attachments – Also duplicate attachments (optional)
namespace_id – namespace_id
overwrite – Flag if you want to overwrite an existing study in the destination namespace (optional)
study_request_id – study_request_id
-
exists(account_id=None, phi_namespace=None, storage_namespace=None, study_uid=None, uuid=None)[source]¶ Exists.
- Parameters
account_id – account_id
phi_namespace – phi_namespace
storage_namespace – storage_namespace
study_uid – study_uid
uuid – uuid
-
external_viewer(redirect, uuid, view_reason=None, viewer_tag=None)[source]¶ External viewer.
- Parameters
redirect – A flag to return an HTTP redirect to the viewer URL rather than the JSON structure
uuid – The study id
view_reason – The view reason to be tracked in the audit trail (optional)
viewer_tag – An external viewer’s tag (optional)
-
fax_hl7(hl7_id, number, uuid)[source]¶ Fax hl7.
- Parameters
hl7_id – HL7 message to create the PDF report for
number – The fax number to send the PDF report to
uuid – The study uuid
-
find_order(uuid, accession_number=None, patient_name=None, patientid=None)[source]¶ Find order.
- Parameters
uuid – The study id
accession_number – accession_number
patient_name – patient_name
patientid – patientid
-
freeze(thaw, uuid)[source]¶ Freeze.
- Parameters
thaw – Flag to thaw a frozen study
uuid – The study id
-
get(customfield_h=None, extra=None, fields=None, full_hl7=None, limit_hl7=None, node_id=None, permissions_diff=None, phi_namespace=None, serial_no=None, storage_namespace=None, study_uid=None, uuid=None)[source]¶ Get.
- Parameters
customfield_h – Flag to return a customfield hash as detailed below (optional)
extra – Flag to return extra data as detailed below (optional)
fields – A JSON list of the study fields to return (optional)
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)
node_id – node_id
permissions_diff – Flag to return only the permissions that differ from the namespace permissions (optional)
phi_namespace – phi_namespace
serial_no – serial_no
storage_namespace – storage_namespace
study_uid – study_uid
uuid – uuid
-
list(customfield_h=None, extra=None, fields=None, limit_hl7=None, permissions_diff=None, template=None)[source]¶ List.
- Parameters
customfield_h – Flag to return a customfield hash as detailed in /study/get (optional)
extra – Flag to return extra data as detailed in /study/get (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)
permissions_diff – Flag to return only the permissions that differ from the namespace permissions (optional)
template – A JSON hash with name, account_id and language of the template to return (optional)
-
manual_route(route_id, uuid, email=None, message=None)[source]¶ Manual route.
- Parameters
route_id – The routing rule id
uuid – The study 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)
-
move(namespace_id, uuid)[source]¶ Move.
- Parameters
namespace_id – The namespace id
uuid – The study id
-
node_can_remove(serial_no, study_uid, uuid)[source]¶ Node can remove.
- Parameters
serial_no – The serial number of the node
study_uid – The study uid
uuid – The node id
-
pdf_hl7(hl7_id, uuid)[source]¶ Pdf hl7.
- Parameters
hl7_id – HL7 message to create the PDF report for
uuid – The study uuid
-
push(batch_no, destination_id, ping, uuid)[source]¶ Push.
- Parameters
batch_no – The batch number if pushing to a CD burner
destination_id – The destination to push it to
ping – Flag to send the ping job back in this call
uuid – The study uuid
-
push_hl7(destination_id, uuid, hl7_id=None, hl7_template_id=None, once=None)[source]¶ Push hl7.
- Parameters
destination_id – The destination to push it to
uuid – The study uuid
hl7_id – HL7 message to use in the template (optional)
hl7_template_id – The HL7 template to use (optional)
once – Flag that this message should only be sent a maximum of one time (optional)
-
question(detail, question, uuid)[source]¶ Question.
- Parameters
detail – Optional detail to pass through to the AI stack
question – The question to ask or a JSON array of questions to ask
uuid – The study id
-
reject(uuid, message=None)[source]¶ Reject.
- Parameters
uuid – The study uuid
message – Message to send to the person who shared the study (optional)
-
report_detail(account_id, limit=None)[source]¶ Report detail.
- Parameters
account_id – Limit to studies in the passed account
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)
-
report_series(email, hours, namespace_id, limit=None)[source]¶ Report series.
- Parameters
email – Send the report to this email address(es) when it is done
hours – Report on studies acquired within the last number of hours
namespace_id – Namespace to run the report on
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)
-
request_add(account_id, comments, namespace_id, patient_birth_date, patient_first_name, patient_last_name, modality=None, patient_sex=None, patientid=None, study_date_end=None, study_date_start=None, study_description=None)[source]¶ Request add.
- Parameters
account_id – The account id to send the study request to
comments – Free form request comments
namespace_id – The namespace id requested studies to put (share or duplicate) into
patient_birth_date – The patient date of birth 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
modality – The modality a study should match (optional)
patient_sex – The patient sex a study should match (optional)
patientid – The MRN a study should match (optional)
study_date_end – The DICOM date that a study date should be less or equal to (optional)
study_date_start – The DICOM date that a study date should be greater or equal to (optional)
study_description – The string a study description should partially match (optional)
-
request_match(study_request_id)[source]¶ Request match.
- Parameters
study_request_id – The study request uuid
-
set(accession_number=None, attachment_count=None, customfield_param=None, destination_ae_title=None, find_order_uuid=None, image_count=None, integration_key=None, medical_record_locator=None, modality=None, node_id=None, patient_additional_history=None, patient_address=None, patient_age=None, patient_birth_date=None, patient_birth_time=None, patient_birthname=None, patient_comments=None, patient_current_location=None, patient_ethnic_group=None, patient_institution_residence=None, patient_mother_birthname=None, patient_name=None, patient_name_other=None, patient_occupation=None, patient_phone=None, patient_religious_preference=None, patient_sex=None, patient_size=None, patient_weight=None, patientid=None, patientid_other=None, phi_namespace=None, referring_physician=None, seconds_to_ingest=None, serial_no=None, source_ae_title=None, storage_namespace=None, study_date=None, study_description=None, study_id=None, study_time=None, study_uid=None, use_upload_permission=None, uuid=None)[source]¶ Set.
- Parameters
accession_number – DICOM tag (0008,0050) (optional)
attachment_count – Attachment count (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID|DICOM_TAG. Custom field(s), see notes in /study/add (optional)
destination_ae_title – The destination aetitle (optional)
find_order_uuid – UUID of the search record used to modify the study (optional)
image_count – Images in the study (optional)
integration_key – Integration key for the study (optional)
medical_record_locator – DICOM tag (0010,1090) (optional)
modality – DICOM tag (0008,0060) (optional)
node_id – If this is a thin study the gateway UUID to retrieve it from can be specified (optional)
patient_additional_history – DICOM tag (0010,21B0) (optional)
patient_address – DICOM tag (0010,1040) (optional)
patient_age – DICOM tag (0010,1010) (optional)
patient_birth_date – DICOM tag (0010,0030) (optional)
patient_birth_time – DICOM tag (0010,0032) (optional)
patient_birthname – DICOM tag (0010,1005) (optional)
patient_comments – DICOM tag (0010,4000) (optional)
patient_current_location – DICOM tag (0038,0300) (optional)
patient_ethnic_group – DICOM tag (0010,2160) (optional)
patient_institution_residence – DICOM tag (0038,0400) (optional)
patient_mother_birthname – DICOM tag (0010,1060) (optional)
patient_name – DICOM tag (0010,0010) (optional)
patient_name_other – DICOM tag (0010,1001) (optional)
patient_occupation – DICOM tag (0010,2180) (optional)
patient_phone – DICOM tag (0010,2154) (optional)
patient_religious_preference – DICOM tag (0010,21F0) (optional)
patient_sex – DICOM tag (0010,0040) (optional)
patient_size – DICOM tag (0010,1020) (optional)
patient_weight – DICOM tag (0010,1030) (optional)
patientid – DICOM tag (0010,0020) (optional)
patientid_other – DICOM tag (0010,1000) (optional)
phi_namespace – phi_namespace
referring_physician – DICOM tag (0008,0090) (optional)
seconds_to_ingest – Flag to re-calculate the seconds_to_ingest metric (optional)
serial_no – serial_no
source_ae_title – The source aetitle (optional)
storage_namespace – storage_namespace
study_date – DICOM tag (0008,0020) (optional)
study_description – DICOM tag (0008,1030) (optional)
study_id – study_id
study_time – DICOM tag (0008,0030) (optional)
study_uid – study_uid
use_upload_permission – Flag to use the upload permissions for the permissions check (optional)
uuid – uuid
Share.
- Parameters
account_id – account_id
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_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) to apply to the shared study (optional)
email – email
group_id – group_id
integration_key – Integration key to tag the share with (optional)
location_id – location_id
masshiway – masshiway
message – Message to the recipient (optional)
npi – npi
phi_namespace – phi_namespace
rsna – rsna
share_code – share_code
storage_namespace – storage_namespace
study_request_id – study_request_id
study_uid – study_uid
user_id – user_id
uuid – uuid
Share list.
- Parameters
uuid – The study uuid
name – Flag to return a hash with both the uuid and name of the object (optional)
Share stop.
- Parameters
uuid – The study uuid
account_id – account_id
group_id – group_id
location_id – location_id
user_id – user_id
user_invite_share_id – user_invite_share_id
Share who.
- Parameters
type – Type of objects you want (account|location|group|user)
uuid – The study uuid
-
split(namespace_id, no_split, uuid)[source]¶ Split.
- Parameters
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
uuid – The study id
-
star(star, uuid)[source]¶ Star.
- Parameters
star – Star flag set on or off (1|0)
uuid – The id of the study
-
status_get(study_id)[source]¶ Status get.
- Parameters
study_id – Study uuid * Any other parameters that could be processed by study_status_tags_rules
-
status_set(new, old, study_id)[source]¶ Status set.
- Parameters
new – The new study status value
old – The old study status value
study_id – Study uuid
-
sync(image_count=None, node_id=None, phi_namespace=None, reload_load_dicom_tag=None, serial_no=None, storage_namespace=None, study_id=None, study_uid=None)[source]¶ Sync.
- Parameters
image_count – Update the study image count and then sync (optional)
node_id – node_id
phi_namespace – phi_namespace
reload_load_dicom_tag – Flag to force a reload of all load_dicom_tag customfields (optional)
serial_no – serial_no
storage_namespace – storage_namespace
study_id – study_id
study_uid – study_uid
-
timing_event(event, storage_namespace, study_uid, node_id=None, serial_no=None, size=None)[source]¶ Timing event.
- Parameters
event – The event
storage_namespace – The storage namespace
study_uid – The study uid
node_id – node_id
serial_no – serial_no
size – The number of bytes associated with the event (optional)
-
validate(uuid, validate_id, series=None)[source]¶ Validate.
- Parameters
uuid – The study id
validate_id – The validation id
series – Only validate the specified series (optional)
-
viewer3_settings(phi_namespace=None, settings=None, storage_namespace=None, study_id=None, study_uid=None)[source]¶ Viewer3 settings.
- Parameters
phi_namespace – phi_namespace
settings – A JSON list of user settings set via /setting/set to return (optional)
storage_namespace – storage_namespace
study_id – study_id
study_uid – study_uid
-
-
class
ambra_sdk.service.entrypoints.AsyncTag(api)[source]¶ AsyncTag.
-
add(object, object_id, tag)[source]¶ Add.
- Parameters
object – Object class to apply it to (Study|User_account|Group|Location|Account|Patient|Case|Order|Message|Query)
object_id – UUID of the object
tag – Value of the tag
-
-
class
ambra_sdk.service.entrypoints.AsyncTerminology(api)[source]¶ AsyncTerminology.
-
account_overrides(account_id=None, phi_namespace=None, storage_namespace=None, study_uid=None, vanity=None)[source]¶ Account overrides.
- Parameters
account_id – account_id
phi_namespace – phi_namespace
storage_namespace – storage_namespace
study_uid – study_uid
vanity – vanity
-
i18next(lng, account_id=None, vanity=None)[source]¶ I18next.
- Parameters
lng – The language code
account_id – account_id
vanity – vanity
-
list(language, tags, account_id=None, vanity=None)[source]¶ List.
- Parameters
language – The ISO 639-1 language code
tags – A comma separated list of the terminology tags to look up
account_id – account_id
vanity – vanity
-
set(language, tag, value, account_id=None, vanity=None)[source]¶ Set.
- Parameters
language – The ISO 639-1 language code
tag – The tag to set
value – The value of the tag. If this is empty the tag is deleted
account_id – The uuid of the account to apply the tag for (optional)
vanity – Vanity to apply the tag for (optional)
Tags.
- Parameters
language – The ISO 639-1 language code
account_id – account_id
phi_namespace – phi_namespace
storage_namespace – storage_namespace
study_uid – study_uid
tags – A comma separated list of the terminology tags to look up (optional)
vanity – vanity
-
-
class
ambra_sdk.service.entrypoints.AsyncTraining(api)[source]¶ AsyncTraining.
-
class
ambra_sdk.service.entrypoints.AsyncUser(api)[source]¶ AsyncUser.
-
add(account_id, email, first, last, mobile_phone, password)[source]¶ Add.
- Parameters
account_id – Account id to check for the user_edit permission
email – Email
first – First name
last – Last name
mobile_phone – SMS phone number
password – Password
-
enable(uuid, disable=None)[source]¶ Enable.
- Parameters
uuid – User uuid
disable – A flag indicating whether to disable the user (optional)
-
event(namespace_id, uuid=None)[source]¶ Event.
- Parameters
namespace_id – Id of the namespace to set the flags on
uuid – Return event flags for this user, not current user (optional)
-
event_set(namespace_id, event_approve=None, event_case_assignment=None, event_harvest=None, event_incoming_study_request=None, event_link=None, event_link_mine=None, event_message=None, event_new_report=None, event_query_add=None, event_query_edit=None, event_query_reply=None, event_report_remove=None, event_share=None, event_site_qualified=None, event_status_change=None, event_study_comment=None, event_thin_study_fail=None, event_thin_study_success=None, event_upload=None, event_upload_fail=None, uuid=None)[source]¶ Event set.
- Parameters
namespace_id – Id of the namespace to set the flags on
event_approve – Notify the user on a approval needed into the namespace (optional)
event_case_assignment – Notify the user when they are assigned a case as a medical or admin user (optional)
event_harvest – Notify the user on a harvest into the namespace (optional)
event_incoming_study_request – Notify the user when they get an incoming study request (optional)
event_link – Notify the user when an anonymous link is hit in the namespace (optional)
event_link_mine – Notify the user when an anonymous link created by the user is hit in the namespace (optional)
event_message – Notify the user when a message is sent to the namespace (optional)
event_new_report – Notify the user when a report is attached in the namespace (optional)
event_query_add – Notify the user when a new query is issued (optional)
event_query_edit – Notify the user when a query is edites (optional)
event_query_reply – Notify the user when they leave a new reply in a query (optional)
event_report_remove – Notify the user when a report is removed in the namespace (optional)
event_share – Notify the user on a share into the namespace (optional)
event_site_qualified – Notify the user when a trial site is qualified for the clinical trial account (optional)
event_status_change – Notify the user when the status of a study is changed (optional)
event_study_comment – Notify the user when a comment is attached to a study in the namespace (optional)
event_thin_study_fail – Notify the user when a thin study retrieval they initiated fails (optional)
event_thin_study_success – Notify the user when a thin study retrieval they initiated succeeds (optional)
event_upload – Notify the user on an upload into the namespace (optional)
event_upload_fail – Notify the user on a failed upload into the namespace (optional)
uuid – Return event flags for this user, not current user (optional)
-
get(account_id=None, uuid=None)[source]¶ Get.
- Parameters
account_id – Account id if you are trying to get a user other than yourself (optional)
uuid – The users uuid (optional). Uses the session user if not passed
-
invite(account_id, email, link, groups=None, link_already=None, locations=None, role_id=None)[source]¶ Invite.
- Parameters
account_id – The account to invite the person too
email – Email address of the person to invite
link – URL to accept the invitation at. The invitation id will be appended to the link
groups – A JSON hash with the keys the group uuids to add the user to and the values the role uuid for the group (optional)
link_already – URL to accept the invitation at for an existing user on the system. The invitation id will be appended to the link (optional)
locations – A JSON hash with the keys the location uuids to add the user to and the values the role uuid for the location (optional)
role_id – The role to give the user (optional)
-
join(email, first, last, password, captcha_response=None, customfield_param=None, share_code=None)[source]¶ Join.
- Parameters
email – Email
first – First name
last – Last name
password – Password
captcha_response – Response from captcha (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) defined in the vanity_registration_customfields account setting (optional)
share_code – Share code they are joining from (optional)
-
join_request(account_id)[source]¶ Join request.
- Parameters
account_id – Id of the account to request to join
-
namespace_list(account_id=None, name_and_id_only=None, plus_phr=None)[source]¶ Namespace list.
- Parameters
account_id – Only return the namespaces for this account (optional)
name_and_id_only – Flag to return only the the namespace name and uuid (optional)
plus_phr – Flag to include the PHR account as well if account_id was specified (optional)
-
password_reset(password, token)[source]¶ Password reset.
- Parameters
password – The new password
token – The reset token
-
pubkey_list(serial_no, uuid)[source]¶ Pubkey list.
- Parameters
serial_no – The serial number of the node
uuid – The node id
-
pubkey_set(email, public_key, serial_no, uuid)[source]¶ Pubkey set.
- Parameters
email – The users email
public_key – A public key for public key authentication
serial_no – The serial number of the node
uuid – The node id
-
set(indicator_md5, privacy_md5, terms_md5, account_id=None, allowed_login_brands=None, cc_token=None, email=None, first=None, last=None, mobile_phone=None, old_password=None, password=None, pin_required=None, public_key=None, share_code=None, share_description=None, time_zone=None, ui_json=None, uuid=None)[source]¶ Set.
- param indicator_md5
MD5 of the accepted indications of use
- param privacy_md5
MD5 of the accepted privacy policy
- param terms_md5
MD5 of the accepted terms of service
- param account_id
Account id if you are trying to set a user other than yourself (optional)
- param allowed_login_brands
A comma separated list of Brand UUIDs that the user is allowed to use when logging in (optional)
- param cc_token
The credit card token to attach to the users account (optional)
- param email
Email (optional)
- param first
First name (optional)
- param last
Last name (optional)
- param mobile_phone
SMS phone number (optional)
- param old_password
Previous user password (optional)
- param password
User password (optional)
- param pin_required
Flag to require a PIN for every login (optional)
- param public_key
A public key for public key authentication (optional)
- param share_code
The share code of the user (optional)
- param share_description
The share description of the user (optional)
- param time_zone
The users time zone name as per https://www.postgresql.org/docs/9.1/static/view-pg-timezone-names.html (optional)
- param ui_json
JSON for UI settings (optional) possible options:
show_org_manage_link (boolean) Show link to manage multiple organizations advanced_search (array) Advanced search customization for role. See account level “advanced_search” ui_json param for possible values enable_v3_viewer (boolean) If set, enables ProViewer for PHR account
- param uuid
The users uuid (optional). Uses the session user if not passed
-
signature(signature)[source]¶ Signature.
- Parameters
signature – Set the users signature to this base64 encoded image
-
-
class
ambra_sdk.service.entrypoints.AsyncValidate(api)[source]¶ AsyncValidate.
-
class
ambra_sdk.service.entrypoints.AsyncWebhook(api)[source]¶ AsyncWebhook.
-
add(account_id, event, method, name, url, auth=None, by_accession_number=None, by_uid=None, by_webhook_event=None, cron=None, delay=None, filter_field=None, filter_regexp=None, max_age=None, node_id=None, once=None, parameters=None, retry=None, sid_user_id=None, suspended=None)[source]¶ Add.
- Parameters
account_id – uuid of the account
event – Event to call it on (See the notes for the available events)
method – Method to call it with (POST|GET|POST_JSON|PUT|GET_JSON)
name – Name of the webhook
url – URL to call
auth – A JSON hash with the authentication details (optional)
by_accession_number – Flag to expand the once search to include studies with the same accession_number (optional)
by_uid – Flag to expand the once search to include studies with the same study_uid (optional)
by_webhook_event – Flag to fire WEBHOOK_FAILED once at final unsuccessful try of a failing webhook (optional)
cron – Cron timing string for CRON events e.g 0 9 * * mon-fri(optional)
delay – Number of seconds to delay running this webhook for after it is triggered (optional)
filter_field – Name of the study field (by default) or another object’s field (should have prefix like “webhook.”) to filter on (optional)
filter_regexp – Regular expression to match the value of the filter_field against (optional)
max_age – Ignore studies that are more than this number of days old based on the study_date (optional)
node_id – uuid of the node to proxy the webhook through (optional)
once – Flag that this webhook should only be run once for a specific study (optional)
parameters – A JSON object of the parameter names and values (optional)
retry – Retry the webhook if it fails (optional)
sid_user_id – UUID of the user to generate a sid as (optional)
suspended – This webhook is suspended and not triggered (optional)
-
email(html, subject, template_id, text, to, webhook_id)[source]¶ Email.
- Parameters
html – The HTML part of the email
subject – The subject of the email
template_id – The email template UUID to be used
text – The text part of the email
to – The email address(es) to send the email to
webhook_id – The uuid of the calling webhook
-
event(type, integration_key=None, namespace_id=None, share_code=None, study_count=None)[source]¶ Event.
- Parameters
type – The type of event (STUDY_UPLOAD_START|STUDY_UPLOAD_END)
integration_key – The integration key associated with the event (optional)
namespace_id – namespace_id
share_code – share_code
study_count – The number of studies associated with the event (optional)
-
run(study_id, uuid)[source]¶ Run.
- Parameters
study_id – uuid of the study to run the webhook for
uuid – uuid of the webhook
-
set(uuid, auth=None, by_accession_number=None, by_uid=None, by_webhook_event=None, cron=None, delay=None, event=None, filter_field=None, filter_regexp=None, max_age=None, method=None, name=None, node_id=None, once=None, parameters=None, retry=None, sid_user_id=None, suspended=None, url=None)[source]¶ Set.
- Parameters
uuid – uuid of the webhook
auth – A JSON hash with the authentication details (optional)
by_accession_number – Flag to expand the once search to include studies with the same accession_number (optional)
by_uid – Flag to expand the once search to include studies with the same study_uid (optional)
by_webhook_event – Flag to fire WEBHOOK_FAILED once at final unsuccessful try of a failing webhook (optional)
cron – Cron timing string for CRON events (optional)
delay – Number of seconds to delay running this webhook for after it is triggered (optional)
event – Event to call it on (optional see add command for options)
filter_field – Name of the field to filter on (optional)
filter_regexp – Regular expression to match the value of the filter_field against (optional)
max_age – Ignore studies that are more than this number of days old based on the study_date (optional)
method – Method to call it with (optional see add command for options)
name – Name of the webhook (optional)
node_id – uuid of the node to proxy the webhook through (optional)
once – Flag that this webhook should only be run once for a specific study (optional)
parameters – A JSON object of the parameter names and values (optional see add command for options)
retry – Retry the webhook if it fails (optional)
sid_user_id – UUID of the user to generate a sid as (optional)
suspended – This webhook is suspended and not triggered (optional)
url – URL to call (optional)
-
-
class
ambra_sdk.service.entrypoints.Audit(api)[source]¶ Audit.
-
account(account_id, download=None, reverse=None)[source]¶ Account.
- Parameters
account_id – The id of the account
download – Flag to create a zipped CSV file. A report_id will be returned and the file can be accessed via /report/status and /report/zip (optional)
reverse – Flag to reverse the default sort order (optional)
-
deleted(account_id, type)[source]¶ Deleted.
- Parameters
account_id – The id of the account
type – The type of the object (Study|User etc.)
-
failedlogins(account_id, from_time=None)[source]¶ Failedlogins.
- Parameters
account_id – The id of the account
from_time – Only return events after the epoch time (optional)
-
log(bucket, rest_params=None)[source]¶ Log.
- Parameters
bucket – Name of the bucket to log to
rest_params – Parameters are logged to a message in the bucket
-
object(uuid, customfield_detail=None, download=None, reverse=None)[source]¶ Object.
- Parameters
uuid – The uuid of the object to audit
customfield_detail – Flag to include the customfield name in the detail (optional)
download – Flag to create a zipped CSV file. A report_id will be returned and the file can be accessed via /report/status and /report/zip (optional)
reverse – Flag to reverse the default sort order (optional)
-
user(account_id, user_id, download=None, reverse=None, study_fields=None)[source]¶ User.
- Parameters
account_id – The id of the account
user_id – The id of the user to audit
download – Flag to create a zipped CSV file. A report_id will be returned and the file can be accessed via /report/status and /report/zip (optional)
reverse – Flag to reverse the default sort order (optional)
study_fields – JSON list of study fields to include in the response (optional)
-
-
class
ambra_sdk.service.entrypoints.Case(api)[source]¶ Case.
-
attach(study_id, uuid, detach=None)[source]¶ Attach.
- Parameters
study_id – Study uuid
uuid – Case uuid
detach – Flag to detach the study from the case (optional)
-
return_method(reason, uuid)[source]¶ Return.
- Parameters
reason – The reason the case was returned
uuid – The case uuid
-
set(uuid, assigned_admin_id=None, assigned_medical_id=None, case_status=None, closed=None, completed=None, customfield_param=None, name=None, submitted=None)[source]¶ Set.
- Parameters
uuid – The case uuid
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)
case_status – The case status (optional)
closed – Flag if the case is closed (optional)
completed – Flag if the case is completed (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
name – case name (optional)
submitted – Flag if the case is submitted (optional)
-
-
class
ambra_sdk.service.entrypoints.Customcode(api)[source]¶ Customcode.
-
add(account_id, code, language, name, type, settings=None, zip=None)[source]¶ Add.
- Parameters
account_id – uuid of the account
code – The code
language – Language of code (PYTHON)
name – The name of the code
type – Type of code (AI_CUSTOM_VALIDATION_CODE)
settings – JSON hash of settings (optional)
zip – Base64 encoded ZIP file (optional)
-
deploy(namespace_id, uuid)[source]¶ Deploy.
- Parameters
namespace_id – uuid of the namespace
uuid – uuid of the customcode
-
deploy_list(customcode_id=None, namespace_id=None)[source]¶ Deploy list.
- Parameters
customcode_id – customcode_id
namespace_id – namespace_id
-
-
class
ambra_sdk.service.entrypoints.Customfield(api)[source]¶ Customfield.
-
add(account_id, name, object, capture_on_destination_search=None, capture_on_share_code=None, dicom_only=None, dicom_tag=None, dicom_tag_ignore_empty=None, display_order=None, field_flag=None, hl7_component=None, hl7_field=None, hl7_segment=None, load_dicom_tag=None, load_from_sr=None, load_hl7=None, load_hl7_filter=None, load_order=None, options=None, other_customfield_id=None, other_dicom_tags=None, required=None, type=None, wrapped_dicom_only=None)[source]¶ Add.
- Parameters
account_id – uuid of the account
name – Name of the customfield
object – The object to associate the customfield with (Study|User_account|Group|Location|Account|Patient|Case|Order|Appointment|Dicomdata|Scanner|Query)
capture_on_destination_search – Flag if the field should be captured during query retrieve on /destination/search call (only applicable to study fields) (optional)
capture_on_share_code – Flag if the field should be captured during a share code exchange (only applicable to study fields) (optional)
dicom_only – Only capture for non-wrapped DICOM uploads during a share code exchange (optional)
dicom_tag – DICOM tag to map this field to. Format should be of form (1234,1234). (only applicable to study fields) (optional)
dicom_tag_ignore_empty – Flag to not map an empty custom field to the DICOM tag. (only applicable if a dicom_tag is specified) (optional)
display_order – Integer to order how the fields should be displayed (optional)
field_flag – Default customfield flag (optional)
hl7_component – Component number to map this field to in HL7 ORM messages. Valid values are 1 to 64. (only applicable to study fields) (optional)
hl7_field – Segment field number to map this field to in HL7 ORM messages. Valid values are 1 to 64. (only applicable to study fields) (optional)
hl7_segment – Segment to map this field to in HL7 ORM messages. Valid values are (NTE|PID|PID1|PV1|PV2|OBR|DG1|OBX|CTI|BLG|ORC) (only applicable to study fields) (optional)
load_dicom_tag – Flag to load the current value from the study into this field. (only applicable if a dicom_tag is specified) (optional)
load_from_sr – Load the value from the structured reports in the study (only applicable to study fields) .(optional)
load_hl7 – If this is set to a HL7 message type the value of this field will be updated from the hl7_segment, hl7_field and hl7_component from incoming HL7 messages of the matching message type (only applicable to study fields) (optional)
load_hl7_filter – Filter token for the load_hl7 option (only applicable to study fields) (optional)
load_order – If this flag is on the value of this field will be loaded from a customfield of the matching Order. The customfield is defined by the other_customfield_id parameter (optional)
options – Additional options in JSON format (optional)
other_customfield_id – Id of a customfield to map its value to this customfield’s value (optional)
other_dicom_tags – JSON array of other DICOM tags to map this field to. (only applicable to study fields) (optional)
required – Flag if the field is required (optional)
type – Type of the custom field (text|number|date|memo|select|multiselect|radio|checkbox|search|bool) (optional)
wrapped_dicom_only – Only capture for wrapped DICOM uploads during a share code exchange (optional)
-
lookup(account_id, name)[source]¶ Lookup.
- Parameters
account_id – uuid of the account
name – Name of the customfield
-
mapping_add(from_customfield_id, to_customfield_id, overwrite_with_blank=None, refresh_on_edit=None, refresh_on_reshare=None, reverse_refresh_on_edit=None)[source]¶ Mapping add.
- Parameters
from_customfield_id – The source custom field id
to_customfield_id – The destination custom field id
overwrite_with_blank – Flag if the destination customfield should be updated with a blank value, 1 by default (optional)
refresh_on_edit – Flag if the destination customfield should be updated on the source customfield edit, 1 by default (optional)
refresh_on_reshare – Flag if the destination customfield should be updated on Study reshare, 1 by default (optional)
reverse_refresh_on_edit – Flag if the mapping should apply in reverse, ie to the customfield designated as a from_customfield_id of the original study when a shared version of the study is edited, 0 by default (optional)
-
mapping_delete(uuid)[source]¶ Mapping delete.
- Parameters
uuid – uuid of the customfield mapping rule
-
mapping_set(uuid, overwrite_with_blank=None, refresh_on_edit=None, refresh_on_reshare=None, reverse_refresh_on_edit=None)[source]¶ Mapping set.
- Parameters
uuid – uuid of the customfield mapping rule
overwrite_with_blank – Flag if the destination customfield should be updated with a blank value, 1 by default (optional)
refresh_on_edit – Flag if the destination customfield should be updated on the source customfield edit, 1 by default (optional)
refresh_on_reshare – Flag if the destination customfield should be updated on Study reshare, 1 by default (optional)
reverse_refresh_on_edit – Flag if the mapping should apply in reverse, ie to the customfield designated as a from_customfield_id of the original study when a shared version of the study is edited, 0 by default (optional)
-
search(uuid, search=None)[source]¶ Search.
- Parameters
uuid – uuid of the customfield
search – The value to search for (optional)
-
set(uuid, capture_on_destination_search=None, capture_on_share_code=None, dicom_only=None, dicom_tag=None, dicom_tag_ignore_empty=None, display_order=None, field_flag=None, hl7_component=None, hl7_field=None, hl7_segment=None, load_dicom_tag=None, load_from_sr=None, load_hl7=None, load_hl7_filter=None, load_order=None, name=None, options=None, other_customfield_id=None, other_customfield_no_overwrite_with_blank=None, other_customfield_no_refresh_on_reshare=None, other_dicom_tags=None, required=None, wrapped_dicom_only=None)[source]¶ Set.
- Parameters
uuid – uuid of the customfield
capture_on_destination_search – Flag if the field should be captured during query retrieve on /destination/search call (optional)
capture_on_share_code – Flag if the study type field should be captured during a share code exchange (optional)
dicom_only – Only capture for non-wrapped DICOM uploads during a share code exchange (optional)
dicom_tag – Dicom tag to map this field to. Format should be of form (1234,1234). (only applicable to study fields) (optional)
dicom_tag_ignore_empty – Flag to not map an empty custom field to the DICOM tag. (only applicable if a dicom_tag is specified) (optional)
display_order – Integer to order how the fields should be displayed (optional)
field_flag – Default customfield flag (optional)
hl7_component – Component number to map this field to in HL7 ORM messages. Valid values are 1 to 64. (only applicable to study fields) (optional)
hl7_field – Segment field number to map this field to in HL7 ORM messages. Valid values are 1 to 64. (only applicable to study fields) (optional)
hl7_segment – Segment to map this field to in HL7 ORM messages. Valid values are (NTE|PID|PID1|PV1|PV2|OBR|DG1|OBX|CTI|BLG|ORC) (only applicable to study fields) (optional)
load_dicom_tag – Flag to load the current value from the study into this field. (only applicable if a dicom_tag is specified) (optional)
load_from_sr – Load the value from the structured reports in the study. (only applicable to study fields) .(optional)
load_hl7 – If this is set to a HL7 message type the value of this field will be updated from the hl7_segment, hl7_field and hl7_component from incoming HL7 messages of the matching message type (only applicable to study fields) (optional)
load_hl7_filter – Filter token for the load_hl7 option (only applicable to study fields) (optional)
load_order – If this flag is on the value of this field will be loaded from a customfield of the matching Order. The customfield is defined by the other_customfield_id parameter (optional)
name – Name of the customfield (optional)
options – Additional options in JSON format (optional)
other_customfield_id – Id of a customfield to map its value to this customfield’s value (optional)
other_customfield_no_overwrite_with_blank – Flag if the customfield should be updated with a blank value (optional)
other_customfield_no_refresh_on_reshare – Flag if the customfield should be updated on Study reshare (optional)
other_dicom_tags – JSON array of other DICOM tags to map this field to. (only applicable to study fields) (optional)
required – Flag if the field is required (optional)
wrapped_dicom_only – Only capture for wrapped DICOM uploads during a share code exchange (optional)
-
-
class
ambra_sdk.service.entrypoints.Destination(api)[source]¶ Destination.
-
add(account_id, address, aetitle, distributed_destinations, linked_destination, linked_qr_activity_in_referred_account, linked_qr_to_referred_account, name, node_id, path, port, c_echo_interval=None, c_echo_schedule=None, can_mwl_search=None, can_push_hl7=None, can_query_retrieve=None, can_retrieve_thin=None, can_search=None, cd_burn_info=None, cd_burn_name=None, cd_burn_priority=None, default_query_retrieve_level=None, fire_webhooks=None, gateway_settings=None, hl7_address=None, hl7_fetch_filter=None, hl7_port=None, manual_push_roles=None, push_related_studies=None, sort_order=None, sqlch_psh_if_img_unchg=None, sqlch_psh_if_route_hl7=None, type=None, ui_json=None)[source]¶ Add.
- Parameters
account_id – uuid of the account
address – Address of the destination (required if DICOM type)
aetitle – Aetitle of the destination (required if DICOM type)
distributed_destinations – A JSON array of destination ids. This list will be used to process requests in round robin manner. Meaningful for DISTRIBUTING destination type only (opional)
linked_destination – uuid of the destination for LINKED destinations
linked_qr_activity_in_referred_account – A flag to create DESTINATION_SEARCH activities in the linked destination’s account. Meaningful for LINKED destinations only (opional)
linked_qr_to_referred_account – A flag to create resultant studies in the linked destination’s account (not the account of LINKED destination where the search was initiated). Meaningful for LINKED destinations only (opional)
name – Name of the destination
node_id – uuid of the node that handles the destination
path – Path of the folder for a FOLDER type of destination (required if FOLDER type)
port – Port of the destination (required if DICOM type)
c_echo_interval – Interval in seconds to C echo the destination (optional)
c_echo_schedule – C echo schedule (optional)
can_mwl_search – Can this destination support searching a modality work list (optional)
can_push_hl7 – Can this destination support pushong Hl7 messages (optional)
can_query_retrieve – Can this destination support query retrieve from HL7 messages (optional)
can_retrieve_thin – Can this destination support retrieving thin studies (optional)
can_search – Can this destination support searching (optional)
cd_burn_info – A JSON hash with the CD burning information (optional)
cd_burn_name – Name for the CD burner software (optional)
cd_burn_priority – Integer value for the burner priority (optional)
default_query_retrieve_level – Default query retrieve level this can be either (study|series|image) and defaults to study if not specified (optional)
fire_webhooks – Fire webhooks for events associated with this destination (optional)
gateway_settings – Gateway settings (optional)
hl7_address – Address of an attached HL7 destination (optional except for VIRTUAL destinations)
hl7_fetch_filter – A transform condition expression (see /transform/add for format) to match against the HL7 message. Only fire a query retrieve if the message matches the condition (optional)
hl7_port – Port of an attached HL7 destination (optional except for VIRTUAL destinations)
manual_push_roles – A comma separated list of role uuids, a user is required to have one of them to manually push to this destination (optional)
push_related_studies – Push all the related studies (same MRN/patientid) in the namespace when a study is pushed (optional)
sort_order – Integer value for sorting (optional)
sqlch_psh_if_img_unchg – Squelch pushes to the destination if the image count has not changed and the push is by a routing rule (optional)
sqlch_psh_if_route_hl7 – Squelch pushes to the destination if the push was generated by HL7 triggered routing (optional)
type – Type of the destination either DICOM, FOLDER, ACCELERATOR,VIRTUAL, BURNER, XDS, LINKED, DISTRIBUTING or UPLOADER. Defaults to DICOM (optional)
ui_json – JSON for UI settings (optional)
-
list(account_id, node_id=None, serial_no=None)[source]¶ List.
- Parameters
account_id – uuid of the account
node_id – node_id
serial_no – serial_no
-
retrieve(activity_id, send_method, study_request_found_id, customfield_param=None)[source]¶ Retrieve.
- Parameters
activity_id – uuid of the DESTINATION_SEARCH activity to retrieve from
send_method – The method to send a study as a study request response (share|duplicate)
study_request_found_id – UUID of a study request search results to retrieve and send as study request response
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) will be set for the study retrieved (optional)
-
search(uuid, accession_number=None, anonymize=None, anonymize_param=None, bundle_id=None, copy_to=None, create_study=None, create_thin=None, customfield_param=None, customfield_quoted_param=None, end_datetime=None, modality=None, node_id=None, patient_birth_date=None, patient_name=None, patient_sex=None, patientid=None, push_to=None, query_fields=None, referring_physician=None, refetch_study=None, result_fields=None, serial_no=None, share_email=None, start_datetime=None, study_request_id=None, study_uid=None, tracking_number=None)[source]¶ Search.
- Parameters
uuid – uuid of the destination
accession_number – Accession number to find (optional)
anonymize – A JSON hash of anonymization rules to apply to retrieved studies (optional)
anonymize_param – Expected values are STUDY_FIELD. The anonymization rules breakdown. This overrides the anonymize parameter if passed (optional)
bundle_id – An integral number Used internally to track searches initiated from a single bundle (optional)
copy_to – uuid of a namespace to copy the retrieved or create_thin studies into (optional)
create_study – The maximum number of studies to retrieve from this search instead of creating an activity for the search results (optional)
create_thin – The maximum number of thin studies to create from this search instead of creating an activity for the search results (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) will be set for the resultant studies after /destination/retrieve call (optional)
customfield_quoted_param – Expected values are CUSTOMFIELD_NAME. Custom field(s) to be set for the resultant studies. (optional)
end_datetime – DICOM end date time stamp to bound the search (optional)
modality – Modality (optional)
node_id – node_id
patient_birth_date – Birth date to find (optional)
patient_name – Patient name to find (optional)
patient_sex – Gender to find (optional)
patientid – Patient id to find (optional)
push_to – uuid of a destination to push the retrieved studies to (optional)
query_fields – A JSON hash of additional query fields (optional)
referring_physician – Referring physician to find (optional)
refetch_study – Flag to refetch the search results when studies have been fetched already (optional)
result_fields – A JSON array of DICOM tags that the destination should return (optional)
serial_no – serial_no
share_email – Email to share retrieved studies with on subsequent /destination/retrieve (optional)
start_datetime – DICOM start date time stamp to bound the search (optional)
study_request_id – uuid of a study request (optional)
study_uid – Study uid to find (optional)
tracking_number – A UUID tracking number that can be used to pull a report against this search (optional)
-
search_mwl(study_id, uuid, accession_number=None, order_date=None, order_number=None, patient_birth_date=None, patient_name=None, patient_sex=None, patientid=None)[source]¶ Search mwl.
- Parameters
study_id – The id of the study we are searching for orders for
uuid – uuid of the destination
accession_number – Accession number to find (optional)
order_date – Order date to find (optional)
order_number – Order number to find (optional)
patient_birth_date – Birth date to find (optional)
patient_name – Patient name to find (optional)
patient_sex – Gender to find (optional)
patientid – Patient id to find (optional)
-
search_report(email, tracking_number)[source]¶ Search report.
- Parameters
email – Optional email address to send the report to
tracking_number – The tracking number to report on
-
set(distributed_destinations, linked_qr_activity_in_referred_account, linked_qr_to_referred_account, uuid, address=None, aetitle=None, c_echo_interval=None, c_echo_schedule=None, can_mwl_search=None, can_push_hl7=None, can_query_retrieve=None, can_retrieve_thin=None, can_search=None, cd_burn_info=None, cd_burn_name=None, cd_burn_priority=None, default_query_retrieve_level=None, fire_webhooks=None, gateway_settings=None, hl7_address=None, hl7_fetch_filter=None, hl7_port=None, manual_push_roles=None, name=None, node_id=None, path=None, port=None, push_related_studies=None, sort_order=None, sqlch_psh_if_img_unchg=None, sqlch_psh_if_route_hl7=None, ui_json=None)[source]¶ Set.
- Parameters
distributed_destinations – A JSON array of destination ids. This list will be used to process requests in round robin manner. Meaningful for DISTRIBUTING destination type only (opional)
linked_qr_activity_in_referred_account – A flag to create DESTINATION_SEARCH activities in the linked destination’s account. Meaningful for LINKED destinations only (opional)
linked_qr_to_referred_account – A flag to create resultant studies in the linked destination’s account (not the account of LINKED destination where the search was initiated). Meaningful for LINKED destinations only (opional)
uuid – uuid of the destination
address – Address of the destination (optional)
aetitle – Aetitle of the destination (optional)
c_echo_interval – Interval in seconds to C echo the destination (optional)
c_echo_schedule – C echo schedule (optional)
can_mwl_search – Can this destination support searching a modality work list (optional)
can_push_hl7 – Can this destination support pushong Hl7 messages (optional)
can_query_retrieve – Can this destination support query retrieve from HL7 messages (optional)
can_retrieve_thin – Can this destination support retrieving thin studies (optional)
can_search – Can this destination support searching (optional)
cd_burn_info – A JSON hash with the CD burning information (optional)
cd_burn_name – Name for the CD burner software (optional)
cd_burn_priority – Integer value for the burner priority (optional)
default_query_retrieve_level – Default query retrieve level this can be either (study|series|image) and defaults to study if not specified (optional)
fire_webhooks – Fire webhooks for events associated with this destination (optional)
gateway_settings – Gateway settings (optional)
hl7_address – Address of an attached HL7 destination (optional)
hl7_fetch_filter – A transform condition expression (see /transform/add for format) to match against the HL7 message. Only fire a query retrieve if the message matches the condition (optional)
hl7_port – Port of an attached HL7 destination (optional)
manual_push_roles – A comma separated list of role uuids, a user is required to have one of them to manually push to this destination (optional)
name – Name of the destination (optional)
node_id – uuid of the node that handles the destination (optional)
path – Path of the folder (optional)
port – Port of the destination (optional)
push_related_studies – Push all the related studies (same MRN/patientid) in the namespace when a study is pushed (optional)
sort_order – Integer value for sorting (optional)
sqlch_psh_if_img_unchg – Squelch pushes to the destination if the image count has not changed and the push is by a routing rule (optional)
sqlch_psh_if_route_hl7 – Squelch pushes to the destination if the push was generated by HL7 triggered routing (optional)
ui_json – JSON for UI settings (optional)
-
-
class
ambra_sdk.service.entrypoints.Dicomdata(api)[source]¶ Dicomdata.
-
get(customfields, uuid, dicom_tags=None)[source]¶ Get.
- Parameters
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)
uuid – Id of the DICOM data
dicom_tags – A JSON list of the DICOM tags to return (optional)
-
-
class
ambra_sdk.service.entrypoints.Dictionary(api)[source]¶ Dictionary.
-
add(account_id, case_sensitive, lookup, name, object, replace)[source]¶ Add.
- Parameters
account_id – The account id
case_sensitive – Flag if the dictionary lookup is case sensitive or not
lookup – A JSON array of field names that will be concatenated and MD5 hashed for the dictionary lookup value
name – The dictionary name
object – Object this is applied against (Study|Order|User_account|Case|Patient)
replace – A JSON array of the field names that will be replaced for a successful lookup
-
attach(uuid, account_id=None, add_if_no_match=None, approve_if_match=None, delay=None, global_counter=None, namespace_id=None, run_once=None, sequence=None, skip_if_lookup_unchanged=None, skip_if_replace_has_value=None)[source]¶ Attach.
- Parameters
uuid – The dictionary id
account_id – account_id
add_if_no_match – Flag to add the lookup and replace values to the dictionary if no match occurs (optional)
approve_if_match – Approve the object if there was a match (optional)
delay – An integer number of seconds to delay the dictionary application (optional)
global_counter – A flag if you want the counter to run against the account namespace instead of the object namespace (optional)
namespace_id – namespace_id
run_once – Flag to make dictionary apply only once per object (optional)
sequence – An integer value. Attachments are processed from low number to high number (optional)
skip_if_lookup_unchanged – Flag to skip the lookup if the lookup field(s) are un-changed (optional)
skip_if_replace_has_value – Flag to skip the lookup if the replace field already has a value (optional)
-
attach_set(uuid, add_if_no_match=None, approve_if_match=None, delay=None, global_counter=None, run_once=None, sequence=None, skip_if_lookup_unchanged=None, skip_if_replace_has_value=None)[source]¶ Attach set.
- Parameters
uuid – The dictionary attach id
add_if_no_match – Flag to add the lookup and replace values to the dictionary if no match occurs (optional)
approve_if_match – Approve the object if there was a match (optional)
delay – An integer number of seconds to delay the dictionary application (optional)
global_counter – A flag if you want the counter to run against the account namespace instead of the object namespace (optional)
run_once – Flag to make dictionary apply only once per object (optional)
sequence – An integer value. Attachments are processed from low number to high number (optional)
skip_if_lookup_unchanged – Flag to skip the lookup if the lookup field(s) are un-changed (optional)
skip_if_replace_has_value – Flag to skip the lookup if any of the replace fields already has a value (optional)
-
entries(uuid, lookup=None)[source]¶ Entries.
- Parameters
uuid – The dictionary id
lookup – Only return the entry for the optional lookup entry (optional)
-
entry_add(lookup, replace, uuid, regexp=None)[source]¶ Entry add.
- Parameters
lookup – The JSON array of the lookup values to add. Alternatively a regular expression if the regexp parameter is passed
replace – The JSON array of the replacement field values
uuid – The dictionary id
regexp – An integer value that indicates that this entry is a regular expression (optional)
-
-
class
ambra_sdk.service.entrypoints.Filter(api)[source]¶ Filter.
-
add(configuration, name, type, account_id=None, tier_parent_id=None)[source]¶ Add.
- Parameters
configuration – The configuration as a JSON data structure
name – The name of the filter
type – The type of the filter
account_id – The account id to link this filter with (optional)
tier_parent_id – The uuid of the filter that this filter should be a child of (optional, for tiered filters)
-
list(account_id, type)[source]¶ List.
- Parameters
account_id – Limit to global filters and filters within the account namespaces
type – The type of filter to list (repeat this to get multiple types)
-
set(uuid, account_id=None, configuration=None, name=None, type=None)[source]¶ Set.
- Parameters
uuid – The filter uuid
account_id – The account id to link this filter with (optional)
configuration – The configuration as a JSON data structure (optional)
name – The name of the filter (optional)
type – The type of the filter (optional)
Share.
- Parameters
uuid – The filter uuid
account_id – account_id
group_id – group_id
location_id – location_id
role_id – role_id
user_id – user_id
Share list.
- Parameters
uuid – The filter uuid
Share stop.
- Parameters
uuid – The filter uuid
account_id – account_id
group_id – group_id
location_id – location_id
role_id – role_id
user_id – user_id
-
-
class
ambra_sdk.service.entrypoints.Group(api)[source]¶ Group.
-
add(account_id, name, customfield_param=None, hl7_template=None, must_approve=None, must_approve_harvest=None, must_approve_move=None, must_approve_upload=None, no_share=None, role_id=None, search_threshold=None, share_code=None, share_description=None, share_settings=None, share_via_gateway=None, site_id=None)[source]¶ Add.
- Parameters
account_id – uuid of the account
name – Name of the group
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
hl7_template – The HL7 reporting template for the group (optional)
must_approve – Flag if shared studies must be approved for the group (optional)
must_approve_harvest – Flag if harvested studies must be approved (optional)
must_approve_move – Flag if moved studies must be approved (optional)
must_approve_upload – Flag if uploaded studies must be approved (optional)
no_share – Flag if studies can not be shared with this group (optional). Studies can still be shared with users in the group.
role_id – Id for the default role for the group (optional)
search_threshold – The number of studies record in the namespace to switch the UI from list to search mode (optional)
share_code – The share code of the group (optional)
share_description – The share description of the group (optional)
share_settings – Share settings JSON structure of the share display settings (optional)
share_via_gateway – Flag if a gateway share is allowed (optional)
site_id – The associated site id. Required in case require_site_id_for_groups account setting is set (optional)
-
scanner_validate(invalidate, scanner_id, uuid, study_uid=None)[source]¶ Scanner validate.
- Parameters
invalidate – Flag if the scaner is being invalidated
scanner_id – The scanner id
uuid – The group id
study_uid – The study uid used to validate the scaner. Required when validating (optional)
-
set(uuid, customfield_param=None, hl7_template=None, must_approve=None, must_approve_harvest=None, must_approve_move=None, must_approve_upload=None, name=None, no_share=None, role_id=None, search_threshold=None, share_code=None, share_description=None, share_settings=None, share_via_gateway=None, site_id=None, site_inactive=None, site_qualified=None)[source]¶ Set.
- Parameters
uuid – The group uuid
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
hl7_template – The HL7 reporting template for the group (optional)
must_approve – Flag if shared studies must be approved for the group (optional)
must_approve_harvest – Flag if harvested studies must be approved (optional)
must_approve_move – Flag if moved studies must be approved (optional)
must_approve_upload – Flag if uploaded studies must be approved (optional)
name – Name of the group (optional)
no_share – Flag if studies can not be shared with this group (optional). Studies can still be shared with users in the group.
role_id – Id for the default role for the group (optional)
search_threshold – The number of studies record in the namespace to switch the UI from list to search mode (optional)
share_code – The share code of the group (optional)
share_description – The share description of the group (optional)
share_settings – Share settings JSON structure of the share display settings (optional)
share_via_gateway – Flag if a gateway share is allowed (optional)
site_id – The associated site id. Required in case require_site_id_for_groups account setting is set (optional)
site_inactive – Inactive flag to deactivate the site in a Trial Account (optional)
site_qualified – Flag if the site is qualified for the trial (optional)
-
user_add(user_id, uuid, event_approve=None, event_case_assignment=None, event_harvest=None, event_incoming_study_request=None, event_link=None, event_link_mine=None, event_message=None, event_new_report=None, event_node=None, event_query_add=None, event_query_edit=None, event_query_reply=None, event_report_remove=None, event_share=None, event_site_qualified=None, event_status_change=None, event_study_comment=None, event_thin_study_fail=None, event_thin_study_success=None, event_upload=None, event_upload_fail=None, no_physician_alias_share=None, role_id=None)[source]¶ User add.
- Parameters
user_id – Id of the user
uuid – The group id
event_approve – Notify the user on a approval needed into the group namespace (optional)
event_case_assignment – Notify the user when they are assigned a case as a medical or admin user (optional)
event_harvest – Notify the user on a harvest into the group namespace (optional)
event_incoming_study_request – Notify the user when they get an incoming study request (optional)
event_link – Notify the user when an anonymous link is hit in the namespace (optional)
event_link_mine – Notify the user when an anonymous link created by the user is hit in the namespace (optional)
event_message – Notify the user when a message is sent to the group namespace (optional)
event_new_report – Notify the user when a report is attached in the group namespace (optional)
event_node – Notify the user when a group node sends an event (optional)
event_query_add – Notify the user when a new query is issued (optional)
event_query_edit – Notify the user when a query is edites (optional)
event_query_reply – Notify the user when they leave a new reply in a query (optional)
event_report_remove – Notify the user when a report is removed in the group namespace (optional)
event_share – Notify the user on a share into the group namespace (optional)
event_site_qualified – Notify the user when a trial site is qualified for the clinical trial account (optional)
event_status_change – Notify the user when the status of a study is changed (optional)
event_study_comment – Notify the user when a comment is attached to a study in the namespace (optional)
event_thin_study_fail – Notify the user when a thin study retrieval they initiated fails (optional)
event_thin_study_success – Notify the user when a thin study retrieval they initiated succeeds (optional)
event_upload – Notify the user on an upload into the group namespace (optional)
event_upload_fail – Notify the user on a failed upload into the group namespace (optional)
no_physician_alias_share – Flag to exclude this group from a physician alias share (optional)
role_id – Id of the users role within the group (optional). If not passed the default group role will be assigned
-
-
class
ambra_sdk.service.entrypoints.Hl7(api)[source]¶ Hl7.
-
add(message, serial_no, uuid, accession_number=None)[source]¶ Add.
- Parameters
message – The HL7 message
serial_no – The serial number of the node
uuid – The node id
accession_number – Use this accession number instead of the accession number in the HL7 message (optional)
-
get(raw, uuid, node_id=None, phi_namespace=None, serial_no=None, storage_namespace=None, study_id=None, study_uid=None)[source]¶ Get.
- Parameters
raw – Flag to return the raw HL7 message as well
uuid – The hl7 uuid
node_id – node_id
phi_namespace – phi_namespace
serial_no – serial_no
storage_namespace – storage_namespace
study_id – study_id
study_uid – study_uid
-
parse_fields(message, fields=None)[source]¶ Parse fields.
- Parameters
message – HL7 message to parse
fields – Comma delimited list of the field to return. Use the notation specified in /hl7/transform/add (optional)
-
template_add(account_id, body, name)[source]¶ Template add.
- Parameters
account_id – The account uuid
body – The HL7 message with replacement expressions
name – Name of the template
-
template_render(hex, hl7_id, study_id, text, uuid)[source]¶ Template render.
- Parameters
hex – Flag if you want a hexdump of the text returned rather than the JSON
hl7_id – Optional hl7 message
study_id – The study id
text – Flag if you want the text returned rather than the JSON
uuid – The template id
-
template_set(body, name, uuid)[source]¶ Template set.
- Parameters
body – The HL7 message with replacement expressions
name – Name of the template
uuid – The template id
-
transform_add(account_id, conditions, name, order_by, replacements)[source]¶ Transform add.
- Parameters
account_id – The account uuid
conditions – A JSON array of the transform conditions
name – Name of the transform
order_by – A numeric ordering value. Transformations are run in this order from lowest to highest
replacements – A JSON array of the transform replacements
-
transform_set(conditions, name, order_by, replacements, uuid)[source]¶ Transform set.
- Parameters
conditions – A JSON array of the transform conditions
name – Name of the transform
order_by – A numeric ordering value. Transformations are run in this order from lowest to highest
replacements – A JSON array of the transform replacements
uuid – The transform id
-
-
class
ambra_sdk.service.entrypoints.Keyimage(api)[source]¶ Keyimage.
-
add(frame_number, instance_uid, series_uid, version, phi_namespace=None, storage_namespace=None, study_id=None, study_uid=None)[source]¶ Add.
- Parameters
frame_number – The frame number
instance_uid – The instance uid
series_uid – The series uid
version – The frame version
phi_namespace – phi_namespace
storage_namespace – storage_namespace
study_id – study_id
study_uid – study_uid
-
-
class
ambra_sdk.service.entrypoints.Link(api)[source]¶ Link.
-
add(action, prompt_for_anonymize, acceptance_required=None, account_id=None, anonymize=None, charge_amount=None, charge_currency=None, charge_description=None, email=None, filter=None, include_priors=None, inherit_permissions=None, max_hits=None, meeting_id=None, message=None, mfm_page=None, minutes_alive=None, mobile_phone=None, namespace_id=None, notify=None, parameters=None, password=None, password_is_dob=None, password_max_attempts=None, pin_auth=None, referer=None, share_code=None, share_on_view=None, skip_email_prompt=None, study_id=None, ui_json=None, upload_match=None, upload_study_customfields=None, use_share_code=None, user_id=None, workflow=None)[source]¶ Add.
- Parameters
action – Link action (STUDY_LIST|STUDY_VIEW|STUDY_UPLOAD)
prompt_for_anonymize – Flag to prompt if the anonymization rules should be applied on ingress
acceptance_required – Flag that acceptance of TOS is required (optional)
account_id – account_id
anonymize – Anonymization rules to the applied to any STUDY_UPLOAD done with this link. Rules are formatted as per the rules parameter in /namespace/anonymize (optional)
charge_amount – Amount to charge in pennies before the link can be accessed (optional)
charge_currency – Charge currency (optional)
charge_description – Charge description (optional)
email – Email the link to these addresses (optional)
filter – filter
include_priors – Include prior studies (optional)
inherit_permissions – Flag for the link sessions to inherit permissions from the user stored in the user_id link attribute (optional)
max_hits – The maximum number of times the link can be used (optional)
meeting_id – UUID of the meeting to associate the link with (optional)
message – Message to include in the email (optional)
mfm_page – Flag to launch the MFM page instead of the viewer (optional)
minutes_alive – The maximum number of minutes the link will be alive for (optional)
mobile_phone – Send the link to this phone number (optional)
namespace_id – namespace_id
notify – Comma or space separated list of additional emails to notify of link usage (optional)
parameters – JSON array of parameters to add to the redirect URL or return in /namespace/share_code if an upload e.g. [“integration_key”,”abc”] Where abc is integration key. (optional)
password – Link password (optional)
password_is_dob – Flag that the password is the patient_birth_date for the study (study_id is required) (optional)
password_max_attempts – The maximum number of failed password attempt (optional)
pin_auth – An account member email and PIN authentication is required (optional)
referer – The link can only be accessed from the specified referer. The referer can be a regexp to match multiple referers (optional)
share_code – share code for a STUDY_UPLOAD (optional)
share_on_view – Flag to share the study with the email after it is viewed (optional)
skip_email_prompt – Skip the prompt for email step (optional)
study_id – study_id
ui_json – JSON for UI settings (optional)
upload_match – A JSON hash of DICOM tags and regular expressions they must match uploaded against this link (optional)
upload_study_customfields – A JSON hash of customfields that will be mapped to a study on study upload. A key is a customfield UUID, a value is a value for the field (optional)
use_share_code – Flag to use the namespace share code settings for a STUDY_UPLOAD (optional)
user_id – The link user. Any filter is applied in this users context (optional)
workflow – The workflow this link is intended for (patient_studies) (optional)
-
charge(charge_token, uuid)[source]¶ Charge.
- Parameters
charge_token – The stripe charge token
uuid – The uuid of the link
-
external(u, v)[source]¶ External.
- param u
The uuid of the user_account record to create the guest link as
- param v
A JSON hash with the following keys pairs. The JSON must be encrypted and base64 encoded
- filter.*=>Filter field(s) as per the /study/list to specify the study(s) to construct the link for
The include_priors link option value can be passed as a key Any additional fields will the saved in the study audit trail and the following fields email_address, redirect_url, integration_key and skip_email_prompt will be available in /namespace/share_code if this is an upload link
-
get(acceptance_required, account_id, action, anonymize, charge_amount, charge_currency, charge_description, created, description, email, filter, has_password, include_priors, inherit_permissions, is_meeting, max_hits, message, mfm_page, minutes_alive, mobile_phone, namespace_id, namespace_name, notify, parameters, password_is_dob, password_max_attempts, pin_auth, prompt_for_anonymize, redirect_url, referer, share_on_view, short_id, skip_email_prompt, study_id, ui_json, upload_match, upload_study_customfields, url, use_share_code, user_id, uuid, workflow)[source]¶ Get.
- Parameters
acceptance_required – Flag that acceptance of TOS is required
account_id – The account id
action – Link action
anonymize – Any anonymization rules
charge_amount – Amount to charge in pennies before the link can be accessed
charge_currency – Charge currency
charge_description – Charge description
created – Created datetime stamp of the link
description – Description of the link
email – Email address the link was sent to
filter – The filter expression
has_password – Flag if the link has a password or not
include_priors – Include prior studies
inherit_permissions – Flag for the link sessions to inherit permissions from the user stored in the user_id link attribute
is_meeting – Flag if the link is for a meeting
max_hits – The maximum number of times the link can be used
message – Message to include in the email
mfm_page – Flag to launch the MFM page instead of the viewer
minutes_alive – The maximum number of minutes the link will be alive for
mobile_phone – Cellular phone number the link was sent to
namespace_id – Id of the namespace for upload links
namespace_name – Name of the namespace for upload links
notify – Comma or space separated list of additional emails to notify of link usage
parameters – JSON array parameters to add to the redirect URL
password_is_dob – Flag that the password is the patient_birth_date for the study
password_max_attempts – The maximum number of failed password attempt
pin_auth – An account member email and PIN authentication is required
prompt_for_anonymize – Flag to prompt if the anonymization rules should be applied on ingress
redirect_url – URL for the /link/redirect API which will take you directly to the study viewer or uploader
referer – The link can only be accessed from the specified referer
share_on_view – Flag to share the study with the email after it is viewed
short_id – Short ID of the link for the ‘patient_studies’ workflow
skip_email_prompt – Skip the prompt for email step
study_id – uuid of the study
ui_json – JSON for UI settings
upload_match – A JSON hash of DICOM tags and regular expressions they must match uploaded against this link
upload_study_customfields – A JSON hash of customfields that will be mapped to a study on study upload
url – URL for the link which will take you to the UI entry point for links to enter email, password etc.
use_share_code – Flag to use the namespace share code settings for a STUDY_UPLOAD
user_id – The user id
uuid – Id of the link
workflow – The workflow this link is intended for
-
list(account_id=None, study_id=None, user_id=None)[source]¶ List.
- Parameters
account_id – account_id
study_id – study_id
user_id – user_id
-
redirect(link_charge_id=None, password=None, pin=None, short_id=None, uuid=None, v=None)[source]¶ Redirect.
- param link_charge_id
The uuid of the prior charge against this link (optional)
- param password
Password if needed (optional)
- param pin
pin
- param short_id
short_id
- param uuid
uuid
- param v
A JSON hash with the following keys pairs. The JSON must be encrypted (optional)
context_user_id - an account user id for eUnity
-
session(email_address=None, link_charge_id=None, password=None, pin=None, short_id=None, uuid=None)[source]¶ Session.
- Parameters
email_address – The users email (optional)
link_charge_id – The uuid of the prior charge against this link (optional)
password – Password if needed (optional)
pin – pin
short_id – short_id
uuid – uuid
-
sid(email, uuid)[source]¶ Sid.
- Parameters
email – Email address to associate with this usage
uuid – The uuid of the link usage
-
-
class
ambra_sdk.service.entrypoints.Location(api)[source]¶ Location.
-
add(account_id, name, customfield_param=None, hl7_template=None, must_approve=None, must_approve_harvest=None, must_approve_move=None, must_approve_upload=None, no_share=None, role_id=None, search_threshold=None, share_code=None, share_description=None, share_settings=None, share_via_gateway=None)[source]¶ Add.
- Parameters
account_id – uuid of the account
name – Name of the location
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
hl7_template – The HL7 reporting template for the location (optional)
must_approve – Flag if shared studies must be approved for the location (optional)
must_approve_harvest – Flag if harvested studies must be approved (optional)
must_approve_move – Flag if moved studies must be approved (optional)
must_approve_upload – Flag if uploaded studies must be approved (optional)
no_share – Flag if studies can not be shared with this location (optional). Studies can still be shared with users in the location.
role_id – Id for the default role for the location (optional)
search_threshold – The number of studies record in the namespace to switch the UI from list to search mode (optional)
share_code – The share code of the location (optional)
share_description – The share description of the location (optional)
share_settings – Share settings JSON structure of the share display settings (optional)
share_via_gateway – Flag if a gateway share is allowed (optional)
-
set(uuid, customfield_param=None, hl7_template=None, must_approve=None, must_approve_harvest=None, must_approve_move=None, must_approve_upload=None, name=None, no_share=None, role_id=None, search_threshold=None, share_code=None, share_description=None, share_settings=None, share_via_gateway=None)[source]¶ Set.
- Parameters
uuid – The location uuid
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
hl7_template – The HL7 reporting template for the location (optional)
must_approve – Flag if shared studies must be approved for the location (optional)
must_approve_harvest – Flag if harvested studies must be approved (optional)
must_approve_move – Flag if moved studies must be approved (optional)
must_approve_upload – Flag if uploaded studies must be approved (optional)
name – Name of the location (optional)
no_share – Flag if studies can not be shared with this location (optional). Studies can still be shared with users in the location.
role_id – Id for the default role for the location (optional)
search_threshold – The number of studies record in the namespace to switch the UI from list to search mode (optional)
share_code – The share code of the location (optional)
share_description – The share description of the location (optional)
share_settings – Share settings JSON structure of the share display settings (optional)
share_via_gateway – Flag if a gateway share is allowed (optional)
-
user_add(event_upload_fail, user_id, uuid, event_approve=None, event_case_assignment=None, event_harvest=None, event_incoming_study_request=None, event_link=None, event_link_mine=None, event_message=None, event_new_report=None, event_node=None, event_query_add=None, event_query_edit=None, event_query_reply=None, event_report_remove=None, event_share=None, event_site_qualified=None, event_status_change=None, event_study_comment=None, event_thin_study_fail=None, event_thin_study_success=None, event_upload=None, no_physician_alias_share=None, role_id=None)[source]¶ User add.
- Parameters
event_upload_fail – Notify the user on a failed upload into the location namespace
user_id – Id of the user
uuid – The location id
event_approve – Notify the user on a approval needed into the location namespace (optional)
event_case_assignment – Notify the user when they are assigned a case as a medical or admin user (optional)
event_harvest – Notify the user on a harvest into the location namespace (optional)
event_incoming_study_request – Notify the user when they get an incoming study request (optional)
event_link – Notify the user when an anonymous link is hit in the namespace (optional)
event_link_mine – Notify the user when an anonymous link created by the user is hit in the namespace (optional)
event_message – Notify the user when a message is sent to the location namespace (optional)
event_new_report – Notify the user when a report is attached in the location namespace (optional)
event_node – Notify the user when a location node sends an event (optional)
event_query_add – Notify the user when a new query is issued (optional)
event_query_edit – Notify the user when a query is edites (optional)
event_query_reply – Notify the user when they leave a new reply in a query (optional)
event_report_remove – Notify the user when a report is removed in the location namespace (optional)
event_share – Notify the user on a share into the location namespace (optional)
event_site_qualified – Notify the user when a trial site is qualified for the clinical trial account (optional)
event_status_change – Notify the user when the status of a study is changed (optional)
event_study_comment – Notify the user when a comment is attached to a study in the namespace (optional)
event_thin_study_fail – Notify the user when a thin study retrieval they initiated fails (optional)
event_thin_study_success – Notify the user when a thin study retrieval they initiated succeeds (optional)
event_upload – Notify the user on an upload into the location namespace (optional)
no_physician_alias_share – Flag to exclude this location from a physician alias share (optional)
role_id – Id of the users role within the location (optional). If not passed the default location role will be assigned
-
-
class
ambra_sdk.service.entrypoints.Meeting(api)[source]¶ Meeting.
-
add(name, state, phi_namespace=None, storage_namespace=None, study_id=None, study_uid=None)[source]¶ Add.
- Parameters
name – Title of the meeting
state – State of the meeting
phi_namespace – phi_namespace
storage_namespace – storage_namespace
study_id – study_id
study_uid – study_uid
-
events_add(event, uuid)[source]¶ Events add.
- Parameters
event – Event to send to the meeting
uuid – UUID of the meeting
-
-
class
ambra_sdk.service.entrypoints.Message(api)[source]¶ Message.
-
add(body, account_id=None, email=None, group_id=None, location_id=None, namespace_id=None, parent_id=None, query_id=None, share_code=None, study_id=None, study_request_id=None, subject=None, user_id=None)[source]¶ Add.
- Parameters
body – The body of the message
account_id – account_id
email – email
group_id – group_id
location_id – location_id
namespace_id – namespace_id
parent_id – The uuid of the parent message (optional)
query_id – query_id
share_code – share_code
study_id – study_id
study_request_id – study_request_id
subject – The subject of the message (optional)
user_id – user_id
-
-
class
ambra_sdk.service.entrypoints.Namespace(api)[source]¶ Namespace.
-
anonymize(uuid, anonymization_id=None, prompt_for_anonymize=None, rules=None)[source]¶ Anonymize.
- Parameters
uuid – The uuid of the namespace
anonymization_id – The uuid of the anonymization profile to connect to the namespace. (optional)
prompt_for_anonymize – Flag to prompt if the anonymization rules should be applied. Only applicable to ingress anonymization. (optional)
rules – Anonymization rules in JSON format. The format is a hash with the keys the names of the fields to anonymize and the values the regular expressions to apply. (optional)
-
audit(action, detail, uuid)[source]¶ Audit.
- Parameters
action – The audit action (AI_ACTION)
detail – Additional information
uuid – The id of the namespace
-
coverpage(uuid, coverpage=None)[source]¶ Coverpage.
- Parameters
uuid – The uuid of the namespace
coverpage – The coverpage value. See the notes for formatting details or pass an empty string to remove the current cover page. (optional)
-
engine_fqdn(namespace_id=None, phi_namespace=None, source=None, storage_namespace=None, study_id=None, study_uid=None)[source]¶ Engine fqdn.
- Parameters
namespace_id – namespace_id
phi_namespace – phi_namespace
source – The source of the query (optional)
storage_namespace – storage_namespace
study_id – study_id
study_uid – study_uid
-
event_defaults(uuid, event_approve=None, event_case_assignment=None, event_harvest=None, event_incoming_study_request=None, event_link=None, event_link_mine=None, event_message=None, event_new_report=None, event_node=None, event_query_add=None, event_query_edit=None, event_query_reply=None, event_report_remove=None, event_share=None, event_site_qualified=None, event_status_change=None, event_study_comment=None, event_thin_study_fail=None, event_thin_study_success=None, event_upload=None, event_upload_fail=None)[source]¶ Event defaults.
- Parameters
uuid – The uuid of the namespace
event_approve – Notify the user on a approval needed into the namespace (optional)
event_case_assignment – Notify the user when they are assigned a case as a medical or admin user (optional)
event_harvest – Notify the user on a harvest into the namespace (optional)
event_incoming_study_request – Notify the user when they get an incoming study request (optional)
event_link – Notify the user when an anonymous link is hit in the namespace (optional)
event_link_mine – Notify the user when an anonymous link created by the user is hit in the namespace (optional)
event_message – Notify the user when a message is sent to the namespace (optional)
event_new_report – Notify the user when a report is attached in the namespace (optional)
event_node – Notify the user when a namespace node sends an event (optional)
event_query_add – Notify the user when a new query is issued (optional)
event_query_edit – Notify the user when a query is edites (optional)
event_query_reply – Notify the user when they leave a new reply in a query (optional)
event_report_remove – Notify the user when a report is removed in the namespace (optional)
event_share – Notify the user on a share into the namespace (optional)
event_site_qualified – Notify the user when a trial site is qualified for the clinical trial account (optional)
event_status_change – Notify the user when the status of a study is changed (optional)
event_study_comment – Notify the user when a comment is attached to a study in the namespace (optional)
event_thin_study_fail – Notify the user when a thin study retrieval they initiated fails (optional)
event_thin_study_success – Notify the user when a thin study retrieval they initiated succeeds (optional)
event_upload – Notify the user on an upload into the namespace (optional)
event_upload_fail – Notify the user on a failed upload into the namespace (optional)
-
permissions(namespace_id=None, oauth=None, phi_namespace=None, serial_no=None, storage_namespace=None, study_id=None, study_uid=None, uuid=None)[source]¶ Permissions.
- Parameters
namespace_id – namespace_id
oauth – Flag to return the OAuth token information for the user (optional)
phi_namespace – phi_namespace
serial_no – serial_no
storage_namespace – storage_namespace
study_id – study_id
study_uid – study_uid
uuid – uuid
-
question(detail, question, uuid)[source]¶ Question.
- Parameters
detail – Optional detail to pass through to the AI stack
question – The question to ask or a JSON array of questions to ask
uuid – The namespace id
-
removed_user_report(account_id, email, uuid)[source]¶ Removed user report.
- Parameters
account_id – The UUID of the account. A report will be produced for group, location and account namespaces of this account
email – Optional email address to send the report to
uuid – The UUID of the namespace
-
settings(uuid, ai_settings=None, allow_drag_and_drop_in_study_uploader=None, auto_create_patient=None, auto_enable_dicom_wrapping=None, cloud_storage_config=None, disable_duplicate_study_upload=None, disable_mobile_dicom_wrapping=None, download_anonymize=None, enable_dicom_deidentification=None, enable_dicom_wrapping=None, enable_epic_patient_lookup=None, enable_multipart_uploader=None, enable_namespace_ai_questions=None, epic_prompt_for_anonymize=None, force_new_study_on_upload=None, ira_namespace=None, link_defaults=None, must_approve_duplicate_study_uid=None, no_dup_share=None, pixel_anonymize_color=None, priority_notifications=None, remove_private_tags_on_upload=None, reverse_patient_name=None, share_related=None, single_file_dicom_wrapping=None, study_field_flags=None, study_size_soft_threshold_per_user=None, try_update_original_study=None, try_update_original_study_from_namespaces=None, try_update_original_study_to_namespaces=None, ui_json=None, upload_settings=None)[source]¶ Settings.
- param uuid
The uuid of the namespace
- param ai_settings
Other AI settings
- param allow_drag_and_drop_in_study_uploader
Value for the setting (optional)
- param auto_create_patient
Value for the setting (optional)
- param auto_enable_dicom_wrapping
Value for the setting (optional)
- param cloud_storage_config
Value for the setting (optional)
- param disable_duplicate_study_upload
Value for the setting (optional)
- param disable_mobile_dicom_wrapping
Value for the setting (optional)
- param download_anonymize
Anonymization rules to apply on study download. The setting format should follow the anonymize_tags parameter format of the Storage /study/{namespace}/{studyUid}/download call (optional)
- param enable_dicom_deidentification
Value for the setting (optional)
- param enable_dicom_wrapping
Value for the setting (optional)
- param enable_epic_patient_lookup
Value for the setting (optional)
- param enable_multipart_uploader
Value for the setting (optional)
- param enable_namespace_ai_questions
Value for the setting (optional)
- param epic_prompt_for_anonymize
Value for the setting (optional)
- param force_new_study_on_upload
Value for the setting (optional)
- param ira_namespace
Flag to make the namespace viable owner namespace for Queries (optional)
- param link_defaults
Value for the setting (optional)
- param must_approve_duplicate_study_uid
Value for the setting (optional)
- param no_dup_share
Flag to stop duplicate studies (same study_uid and image count) from getting shared into the namespace (optional)
- param pixel_anonymize_color
Value for the setting (optional)
- param priority_notifications
Value for the setting (optional)
- param remove_private_tags_on_upload
Flag the storage to anonymize or remove all private tags from a study (optional)
- param reverse_patient_name
Value for the setting (optional)
- param share_related
Flag to make study shares with this namespace include related studies (same PHI namespace, same MRN) (optional)
- param single_file_dicom_wrapping
Value for the setting (optional)
- param study_field_flags
A JSON hash of study_field_* role values to override the role values for studies in the namespace (optional)
- param study_size_soft_threshold_per_user
A threshold for studies size per user. An email (by study_quota_exceeded template) will be sent when this limit is exceeded by a user. A JSON hash of study_field_* role values to override the role values for studies in the namespace (optional)
- param try_update_original_study
Value for the setting (optional)
- param try_update_original_study_from_namespaces
Value for the setting (optional)
- param try_update_original_study_to_namespaces
Value for the setting (optional)
- param ui_json
JSON for UI setting (optional) possible options:
pixel_de_id_by_default (boolean) Pixel de-id tool is set by default when uploading study to this namespace show_image_on_upload_page (boolean) Show computer image with CD on upload page when image is uploading to this namespace
- param upload_settings
Value for the setting (optional)
Share_code.
- Parameters
namespace_id – namespace_id
serial_no – serial_no
share_code – share_code
uuid – uuid
Share price.
- Parameters
uuid – The uuid of the namespace
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) defined for the case (or study) account objects with values entered in the second opinion wizard (or in the image share screen) (optional)
Share pricing.
- Parameters
uuid – The uuid of the namespace
charge_description – The description of the charge (optional)
currency – 3-letter ISO code for currency to charge in (USD|GBP) (optional)
customfields_pricing – Pricing table in JSON format (optional)
pricing – Pricing table in JSON format (optional)
second_opinion_config – JSON configuration for the second opinion workflow (optional)
second_opinion_share – Flag to enable/disable the second opinion workflow for the share (optional)
share_charge_by_modality – Charge shares (including second opinion) by modality of a shared study if this flag is set (optional)
sum_price_matches – Flag to search for all matches in customfields_pricing table and to add them up (optional)
-
study_defaults(uuid, defaults=None)[source]¶ Study defaults.
- Parameters
uuid – The uuid of the namespace
defaults – Default values in JSON format. The format is a hash with the keys the names of the fields and the values are the default value. The available field name are as listed in the returned field hash. (optional)
-
-
class
ambra_sdk.service.entrypoints.Node(api)[source]¶ Node.
-
add(accelerator_id, name, type, account_id=None, category=None, ctc_bucket=None, facility_contact=None, facility_contact_title=None, facility_email=None, facility_name=None, facility_notes=None, facility_zip=None, group_id=None, is_public=None, location_id=None, os_type=None, uuid=None)[source]¶ Add.
- Parameters
accelerator_id – uuid of the accelerator if this is an accelerator node
name – Description of the node
type – Type of node (STORAGE|HARVESTER|ACCELERATOR|CLEARINGHOUSE|VIRTUAL|UTILITY|XDS)
account_id – account_id
category – Node category (ACTIVE|INACTIVE|MIGRATION|TEST|DUPLICATE|INTEGRATED|ACCELERATOR) (optional)
ctc_bucket – Name of the S3 bucket to use for a cloud to cloud gateway (optional)
facility_contact – Name of the facility contact (optional)
facility_contact_title – Title of the facility contact (optional)
facility_email – Email of the facility contact (optional)
facility_name – Name of the facility it is installed at (optional)
facility_notes – Notes about the facility (optional)
facility_zip – Zip code of the facility it is installed at (optional)
group_id – group_id
is_public – Flag if the node is public (optional)
location_id – location_id
os_type – Node OS type, used with HARVESTER node type only (WINDOWS|MACOS) (optional)
uuid – uuid of the node (optional, you can use this to explicitly set the UUID)
-
approve(account_id, uuid)[source]¶ Approve.
- Parameters
account_id – The account which requested the connection
uuid – The node id
-
configuration(serial_no, uuid)[source]¶ Configuration.
- Parameters
serial_no – The serial number of the node
uuid – The node id
-
connect(account_id, uuid, message=None)[source]¶ Connect.
- Parameters
account_id – The account the user is in
uuid – The node id
message – Message (optional)
-
deliver(serial_no, status, uuid, ack=None, destination_id=None, email_reason=None, is_local=None, job_id=None, status_reason=None, study_uid=None)[source]¶ Deliver.
- Parameters
serial_no – The serial number of the node
status – Status code of the job (S|F|P|B|U) - Success, failure, partial transfer, blocked or uncached
uuid – The node id
ack – The HL7 ACK if this was an HL7 job (optional)
destination_id – The uuid of the destination, required for local pushes (optional)
email_reason – Email the user this reason for the status change (optional)
is_local – The flag used to indicate the local push (optional)
job_id – The uuid of the push job, not used for local pushes (optional)
status_reason – Detail on the status change (optional)
study_uid – The study uid of the local push, required for local pushes only (optional)
-
event(destination_id, event, serial_no, uuid)[source]¶ Event.
- Parameters
destination_id – The id of the destination if the event is associated with a destination
event – The event (c_echo_error)
serial_no – The serial number of the node
uuid – The node id
-
found(search_id, serial_no, uuid, status=None, studies=None)[source]¶ Found.
- Parameters
search_id – The id of the search request
serial_no – The serial number of the node
uuid – The node id
status – Status code of the job, S by default (S|F) - Success, failure (optional)
studies – A JSON array of the studies found. Each object has the following fields (optional) * study_uid The study_uid * study_date The study date * accession_number The accession number * referring_physician The referring physician * patient_name Patient name * patientid Patient ID * patient_sex Gender * patient_birth_date Birth date * study_description Study description * modality Modality * result_fields A JSON structure with the answers for the requested result_fields in /destination/search (optional)
-
found_mwl(search_id, serial_no, uuid, orders=None, status=None)[source]¶ Found mwl.
- Parameters
search_id – The id of the search request
serial_no – The serial number of the node
uuid – The node id
orders – A JSON array of the orders found. Each object has the following fields (optional) * patient_name Patient name * patientid Patient id * accession_number Accession number * patient_sex Gender * patient_birth_date Birth date * order_number Order number * order_date Order date
status – Status code of the job, S by default (S|F) - Success, failure (optional)
-
log(end, start, type, uuid)[source]¶ Log.
- Parameters
end – End time stamp in YYYY-MM-DD HH:MM:SS format
start – Start time stamp in YYYY-MM-DD HH:MM:SS format
type – Type of log (log|dicom|queue|system) defaults to log if not passed
uuid – The node id
-
metric(job_id, metric, serial_no, uuid)[source]¶ Metric.
- Parameters
job_id – The uuid of the push job
metric – The metric to record
serial_no – The serial number of the node
uuid – The node id
-
performance_get(uuid, serial_no=None)[source]¶ Performance get.
- Parameters
uuid – The node id
serial_no – serial_no
-
performance_set(data, serial_no, uuid)[source]¶ Performance set.
- Parameters
data – A JSON data structure with performance data
serial_no – The serial number of the node
uuid – The node id
-
ping(ack, serial_no, uuid)[source]¶ Ping.
- Parameters
ack – Flag if the gateway wants to use the acknowledge workflow
serial_no – The serial number of the node
uuid – The node id
-
ping_ack(serial_no, uuid)[source]¶ Ping ack.
- Parameters
serial_no – The serial number of the node
uuid – The node id
-
progress_add(queue, serial_no, state, uuid, accession_number=None, destination_id=None, detail=None, patientid=None, study_uid=None)[source]¶ Progress add.
- Parameters
queue – The queue
serial_no – The serial number of the node
state – The status
uuid – The node id
accession_number – DICOM tag (0008,0050) (optional)
destination_id – The destination uuid (optional)
detail – JSON detail (optional)
patientid – DICOM tag (0010,0020) (optional)
study_uid – Study uid (optional)
-
progress_list(destination_id=None, node_id=None)[source]¶ Progress list.
- Parameters
destination_id – destination_id
node_id – node_id
-
retrieve(job_id, serial_no, status, uuid)[source]¶ Retrieve.
- Parameters
job_id – The uuid of the fetch job
serial_no – The serial number of the node
status – Status code of the job (S|F|P) - Success, failure, partial transfer
uuid – The node id
-
set(uuid, category=None, configuration=None, ctc_bucket=None, facility_contact=None, facility_contact_title=None, facility_email=None, facility_name=None, facility_notes=None, facility_zip=None, is_public=None, monitor_email=None, monitor_node_last_send=None, monitor_node_last_send_threshold=None, monitor_node_ping=None, monitor_node_slow_push=None, monitor_node_slow_push_threshold=None, monitor_study_create=None, monitor_study_create_threshold=None, name=None, reload_configuration=None, serial_no=None, setting_param=None, settings=None, storage_namespace=None, warning_email=None)[source]¶ Set.
- Parameters
uuid – The node id
category – Node category (ACTIVE|INACTIVE|MIGRATION|TEST|DUPLICATE|INTEGRATED) (optional)
configuration – The configuration as a JSON hash of key values pairs (optional)
ctc_bucket – Name of the S3 bucket to use for a cloud to cloud gateway (optional)
facility_contact – Name of the facility contact (optional)
facility_contact_title – Title of the facility contact (optional)
facility_email – Email of the facility contact (optional)
facility_name – Name of the facility it is installed at (optional)
facility_notes – Notes about the facility (optional)
facility_zip – Zip code of the facility it is installed at (optional)
is_public – Flag if the node is public (optional)
monitor_email – Email address(es) to send monitor failure notices (optional)
monitor_node_last_send – Check if the node has sent a study recently (optional)
monitor_node_last_send_threshold – Threshold in minutes for triggering the monitor_node_last_send notification (optional)
monitor_node_ping – Check if the node is pinging (optional)
monitor_node_slow_push – Check if the node is pushing slowly (optional)
monitor_node_slow_push_threshold – Threshold in minutes for triggering the monitor_node_slow_push notification (optional)
monitor_study_create – Check if the node is sending studies normally (optional)
monitor_study_create_threshold – Threshold in minutes for triggering the monitor_study_create notification (optional)
name – Description of the node (optional)
reload_configuration – If this flag is set the node will be instructed to reload it’s configuration on the next ping (optional)
serial_no – serial_no
setting_param – Expected values are SETTING_NAME. Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional)
settings – A hash of the account settings that the node can override (optional)
storage_namespace – Namespace uuid to attach the node to. This requires a sysadmin sid and must be within the same account (optional)
warning_email – Email address(es) to send warning notices (optional)
-
study_anonymized(new_study_uid, old_study_uid, serial_no, uuid)[source]¶ Study anonymized.
- Parameters
new_study_uid – The new study uid
old_study_uid – The old study uid
serial_no – The serial number of the node
uuid – The node id
-
study_queued(serial_no, study_uid, uuid)[source]¶ Study queued.
- Parameters
serial_no – The serial number of the node
study_uid – The study uid
uuid – The node id
-
webhook(serial_no, status, uuid, webhook_id, error_message=None)[source]¶ Webhook.
- Parameters
serial_no – The serial number of the node
status – Status code of the job (S|F) - Success, failure
uuid – The node id
webhook_id – The uuid of the webhook job
error_message – Detailed error message (optional)
-
-
class
ambra_sdk.service.entrypoints.Order(api)[source]¶ Order.
-
add(accession_number, account_id, patient_birth_date, patient_name, patient_sex, patientid, referring_physician, sending_facility, customfield_param=None)[source]¶ Add.
- Parameters
accession_number – Accession number
account_id – uuid of the account to add them to
patient_birth_date – DOB
patient_name – Patient name
patient_sex – Gender
patientid – Patient MRN
referring_physician – Referring physician
sending_facility – Sending facility
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
-
set(accession_number, patient_birth_date, patient_name, patient_sex, patientid, referring_physician, sending_facility, uuid, customfield_param=None)[source]¶ Set.
- Parameters
accession_number – Accession number
patient_birth_date – DOB
patient_name – Patient name
patient_sex – Gender
patientid – Patient MRN
referring_physician – Referring physician
sending_facility – Sending facility
uuid – The order uuid
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
-
sps_add(modality, order_id, requested_procedure_description, requested_procedure_id, scheduled_procedure_step_description, scheduled_procedure_step_id, scheduled_procedure_step_start_date, scheduled_procedure_step_start_time, scheduled_station_aetitle)[source]¶ Sps add.
- Parameters
modality – Modality
order_id – uuid of the order
requested_procedure_description – Procedure description
requested_procedure_id – Procedure ID
scheduled_procedure_step_description – Step description
scheduled_procedure_step_id – Step ID
scheduled_procedure_step_start_date – Start date
scheduled_procedure_step_start_time – Start time
scheduled_station_aetitle – Station AE title
-
sps_find(account_id, node_id=None, serial_no=None)[source]¶ Sps find.
- Parameters
account_id – The account uuid if sid authentication is used
node_id – node_id
serial_no – serial_no
-
sps_set(uuid, modality=None, requested_procedure_description=None, requested_procedure_id=None, scheduled_procedure_step_description=None, scheduled_procedure_step_id=None, scheduled_procedure_step_start_date=None, scheduled_procedure_step_start_time=None, scheduled_station_aetitle=None)[source]¶ Sps set.
- Parameters
uuid – UUID of the SPS
modality – Modality (optional)
requested_procedure_description – Procedure description (optional)
requested_procedure_id – Procedure ID (optional)
scheduled_procedure_step_description – Step description (optional)
scheduled_procedure_step_id – Step ID (optional)
scheduled_procedure_step_start_date – Start date (optional)
scheduled_procedure_step_start_time – Start time (optional)
scheduled_station_aetitle – Station AE title (optional)
-
-
class
ambra_sdk.service.entrypoints.Patient(api)[source]¶ Patient.
-
add(account_id, alt_email=None, alt_mobile_phone=None, birth_date=None, customfield_param=None, email=None, event_new_report=None, event_share=None, first=None, last=None, mobile_phone=None, mrn=None, name=None, sex=None, study_id=None)[source]¶ Add.
- Parameters
account_id – uuid of the account to add them to
alt_email – Alternate email address (optional)
alt_mobile_phone – Alternate mobile phone number (optional)
birth_date – Birth date (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
email – Email address (optional)
event_new_report – Notify the patient if a report is attached on the patient portal (optional)
event_share – Notify the patient if a new study is available on the patient portal (optional)
first – first
last – last
mobile_phone – Mobile phone number (optional)
mrn – MRN (optional if study_id is used)
name – name
sex – Gender (optional)
study_id – Id of the study to create a patient from (optional)
-
portal_find(birth_date, first, last, mrn)[source]¶ Portal find.
- Parameters
birth_date – Date of birth
first – The first name
last – The last name
mrn – MRN (required if the require_mrn_for_patient_portal account setting is on)
-
portal_login(patient_id, pin)[source]¶ Portal login.
- Parameters
patient_id – The patient id
pin – The PIN
-
portal_pin(alt_email, alt_mobile_phone, email, mobile_phone, patient_id)[source]¶ Portal pin.
- Parameters
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
email – Flag if they want the PIN sent via email
mobile_phone – Flag if they want the PIN sent via SMS
patient_id – The patient id
-
set(birth_date, mrn, sex, uuid, alt_email=None, alt_mobile_phone=None, customfield_param=None, email=None, event_new_report=None, event_share=None, first=None, last=None, mobile_phone=None, name=None, setting_param=None, settings=None)[source]¶ Set.
- Parameters
birth_date – Birth date
mrn – MRN
sex – Gender
uuid – The patient uuid
alt_email – Alternate email address (optional)
alt_mobile_phone – Alternate mobile phone number (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
email – Email address (optional)
event_new_report – Notify the patient if a report is attached on the patient portal (optional)
event_share – Notify the patient if a new study is available on the patient portal (optional)
first – first
last – last
mobile_phone – Mobile phone number (optional)
name – name
setting_param – Expected values are SETTING_NAME. Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional)
settings – A hash of the patient settings, see Notes. (optional)
-
-
class
ambra_sdk.service.entrypoints.Purge(api)[source]¶ Purge.
-
add(account_id, days_old, days_old_how, name, adults=None, archive=None, global_param=None, max_deletes=None, minors=None, modalities=None, namespaces=None, object=None, owned_phr=None, shared_from_phr=None, skinny=None, study_status_tags=None, suspended=None, thin=None)[source]¶ Add.
- Parameters
account_id – uuid of the account the rule is for
days_old – Studies greater than or equal to these days old will be purged
days_old_how – How should the days old value be calculated using the ‘U’pdated, ‘C’reated or ‘S’tudy date
name – Name of the purge rule
adults – Apply this rule to adults - flag (optional)
archive – Archive the studies rather than deleting them - flag (optional)
global_param – Flag to make this a global purge rule (optional)
max_deletes – Maximum number of purges per run of the rule (optional)
minors – Apply this rule to minors - flag (optional)
modalities – A JSON array of modalities to limit the rule to (optional)
namespaces – A JSON array of namespace uuid to limit the rule to (optional)
object – The object to be purged, Study by default (Study|Hl7) (optional)
owned_phr – Apply this rule to owned PHR namespaces - flag (optional)
shared_from_phr – If a study was shared from a PHR namespace delete the copy in the PHR namespace as well - flag (optional)
skinny – Make the studies skinny rather than deleting - flag (optional)
study_status_tags – A comma separated list of study status tags to purge (optional)
suspended – This rule is suspended and not applied - flag (optional)
thin – Make the studies thin rather than deleting - flag (optional)
-
run(dry_run, account_id=None, object=None, rule_id=None)[source]¶ Run.
- Parameters
dry_run – Do a dry run of the rule - flag
account_id – account_id
object – Limit purging to this object only (optional)
rule_id – rule_id
-
set(uuid, adults=None, archive=None, days_old=None, days_old_how=None, global_param=None, max_deletes=None, minors=None, modalities=None, name=None, namespaces=None, owned_phr=None, shared_from_phr=None, skinny=None, study_status_tags=None, suspended=None, thin=None)[source]¶ Set.
- Parameters
uuid – Id of the purge rule
adults – Apply this rule to adults - flag (optional)
archive – Archive the studies rather than deleting them - flag (optional)
days_old – Studies greater than or equal to these days old will be purged (optional)
days_old_how – How should the days old value be calculated using the ‘U’pdated, ‘C’reated or ‘S’tudy date (optional)
global_param – Flag to make this a global purge rule (optional)
max_deletes – Maximum number of purges per run of the rule (optional)
minors – Apply this rule to minors - flag (optional)
modalities – A JSON array of modalities to limit the rule to) (optional)
name – Name of the purge rule (optional)
namespaces – A JSON array of namespace uuid to limit the rule to (optional)
owned_phr – Apply this rule owned PHR namespaces - flag (optional)
shared_from_phr – If a study was shared from a PHR namespace delete the copy in the PHR namespace as well - flag (optional)
skinny – Make the studies skinny rather than deleting - flag (optional)
study_status_tags – A comma separated list of study status tags to purge (optional)
suspended – This rule is suspended and not applied - flag (optional)
thin – Make the studies thin rather than deleting - flag (optional)
-
-
class
ambra_sdk.service.entrypoints.Qctask(api)[source]¶ Qctask.
-
add(namespace_id, priority, customfield_param=None, message=None, qctask_status=None, queries=None, query_id=None, studies=None, user_id=None)[source]¶ Add.
- Parameters
namespace_id – Id of the namespace assigned to the QC Task
priority – QC Task priority
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
message – Explanatory message for the QC Task (optional)
qctask_status – Status of the QC task, Open by default (Open|InProgress|Closed) (optional)
queries – A JSON array of the query uuid(s) associate the QC Task to (optional)
query_id – Id of the query to associate the QC Task to (optional)
studies – A JSON array of the study uuid(s) (optional)
user_id – Id of the user to assign the QC Task to (optional)
-
set(uuid, customfield_param=None, message=None, priority=None, queries=None, studies=None, user_id=None)[source]¶ Set.
- Parameters
uuid – The QC Task uuid
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
message – Explanatory message for the QC Task (optional)
priority – QC Task priority (optional)
queries – A JSON array of the query uuid(s) associate the QC Task to (optional)
studies – A JSON array of the study uuid(s) (optional)
user_id – Id of the user to assign the QC Task to (optional)
-
-
class
ambra_sdk.service.entrypoints.Query(api)[source]¶ Query.
-
add(group_id, subject, body=None, customfield_param=None, notify=None, owner_namespace_id=None, owner_user_id=None, query_type=None, recipients=None, study_id=None)[source]¶ Add.
- Parameters
group_id – Id of the group associated to a trial site to add them to
subject – Subject line of the query
body – The query body (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
notify – Comma delimited list of the emails to be notified of the query events (optional)
owner_namespace_id – The namespace owning the query. The account default from the default_query_owner_namespace account setting is used if not passed through the parameter (optional)
owner_user_id – The user owning the query (optional)
query_type – The query type (optional)
recipients – JSON array of the user UUIDs to add to the query as recipients (optional)
study_id – The study the query is related to (optional)
-
attachment_add(length, name, query_id, type, thumbnail_length=None, thumbnail_type=None)[source]¶ Attachment add.
- Parameters
length – The attachment size in bytes
name – The attachment display name
query_id – Query UUID
type – The attachment MIME-type
thumbnail_length – The attachment’s thumbnail MIME-type (optional)
thumbnail_type – The attachment’s thumbnail size in bytes (optional)
-
seen(uuid, message_id=None)[source]¶ Seen.
- Parameters
uuid – The query uuid
message_id – ID of the last seen message (optional)
-
set(uuid, body=None, customfield_param=None, group_id=None, notify=None, owner_user_id=None, query_type=None, recipients=None, subject=None)[source]¶ Set.
- Parameters
uuid – The query uuid
body – The query body (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
group_id – Id of the group associated to a trial site to add them to. Group change is not allowed for study-related queries (optional)
notify – Comma delimited list of the emails to be notified of the query events (optional)
owner_user_id – The user owning the query (optional)
query_type – The query type (optional)
recipients – JSON array of the user UUIDs to add to the query as recipients (optional)
subject – Subject line of the query (optional)
-
-
class
ambra_sdk.service.entrypoints.Radreport(api)[source]¶ Radreport.
-
add(study_id, type, fields=None)[source]¶ Add.
- Parameters
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)
-
audit(action, detail, uuid)[source]¶ Audit.
- Parameters
action – The audit action (SIGNED|MEDICAL_EDIT|ADMIN_EDIT|REPORT_GENERATED)
detail – Additional information
uuid – The id of the radreport
-
email(email, uuid)[source]¶ Email.
- Parameters
email – The email address(es) to send the radreport to
uuid – The radreport uuid
-
fax(number, uuid)[source]¶ Fax.
- Parameters
number – The fax number to send the PDF report to
uuid – The radreport uuid
-
set(uuid, attachment=None, fields=None)[source]¶ Set.
- Parameters
uuid – Id of the radreport
attachment – A JSON hash of the storage attachment information (optional)
fields – A JSON hash of the fields in the report (optional)
-
template_add(account_id, body, name, type, options=None, preview=None)[source]¶ Template add.
- Parameters
account_id – uuid of the account
body – Body of the template
name – Name of the template
type – Type of radreport
options – JSON options of the template (optional)
preview – Preview of the template (optional)
-
template_get_type(account_id, type)[source]¶ Template get type.
- Parameters
account_id – uuid of the account
type – Type of the template
-
template_list(account_id, active=None, type=None)[source]¶ Template list.
- Parameters
account_id – uuid of the account
active – Limit to active templates (optional)
type – Limit to this type (optional)
-
template_set(uuid, body=None, name=None, options=None, preview=None, type=None)[source]¶ Template set.
- Parameters
uuid – uuid of the template
body – Body of the template (optional)
name – Name of the template (optional)
options – JSON options of the template (optional)
preview – Preview of the template (optional)
type – Type of radreport (optional)
-
-
class
ambra_sdk.service.entrypoints.Radreportmacro(api)[source]¶ Radreportmacro.
-
add(account_id, body, modality, name, type, hotkey=None)[source]¶ Add.
- Parameters
account_id – uuid of the account
body – JSON body of the macro
modality – Modality
name – Name of the macro
type – Type of radreport
hotkey – Hotkey of the macro (optional)
-
list(account_id, modality=None, type=None)[source]¶ List.
- Parameters
account_id – uuid of the account
modality – Limit to this modality (optional)
type – Limit to this type (optional)
-
set(uuid, body=None, hotkey=None, modality=None, name=None, type=None)[source]¶ Set.
- Parameters
uuid – uuid of the macro
body – JSON body of the macro (optional)
hotkey – Hotkey of the macro (optional)
modality – Modality (optional)
name – Name of the macro (optional)
type – Type of radreport (optional)
-
-
class
ambra_sdk.service.entrypoints.Role(api)[source]¶ Role.
-
add(account_id, name, for_account=None, for_group=None, for_location=None, permissions=None, setting_param=None, settings=None)[source]¶ Add.
- Parameters
account_id – uuid of the account
name – Name of the role
for_account – A flag that the role can be used in an account, default is on (optional)
for_group – A flag that the role can be used in a group, default is on (optional)
for_location – A flag that the role can be used in a location, default is on (optional)
permissions – A hash of the role permissions (optional)
setting_param – Expected values are SETTING_NAME. Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional)
settings – A hash of the role settings (optional)
-
default_permissions(account_id=None)[source]¶ Default permissions.
- Parameters
account_id – The account id (optional)
-
set(uuid, description=None, for_account=None, for_group=None, for_location=None, name=None, permission_param=None, permissions=None, setting_param=None, settings=None)[source]¶ Set.
- Parameters
uuid – The role uuid
description – Description of the role (optional)
for_account – A flag that the role can be used in an account (optional)
for_group – A flag that the role can be used in a group (optional)
for_location – A flag that the role can be used in a location (optional)
name – Name of the role (optional)
permission_param – Expected values are PERMISSION_NAME. Set an individual permission. This is an alternative to the permissions hash for easier use in the API tester (optional)
permissions – A hash of the role permissions (optional)
setting_param – Expected values are SETTING_NAME. Set an individual setting. This is an alternative to the settings hash for easier use in the API tester (optional)
settings – A hash of the role settings (optional)
-
-
class
ambra_sdk.service.entrypoints.Route(api)[source]¶ Route.
-
add(actions, conditions, name, on_harvest, on_share, account_id=None, delay=None, delay_from_study_field=None, delay_from_study_seconds=None, delay_seconds=None, delay_till_schedule=None, group_id=None, location_id=None, manual_roles=None, namespace_id=None, no_re_run=None, on_manual_route=None, on_thin=None, on_upload=None, only_re_run=None, options=None, other_namespaces=None, schedule=None, suspended=None)[source]¶ Add.
- Parameters
actions – Route actions in JSON format
conditions – Route conditions in JSON format
name – Name of the route
on_harvest – Apply the rule to studies harvested into the namespace
on_share – Apply the rule to studies shared into the namespace
account_id – account_id
delay – Number of minutes to delay running this rule for after it is triggered (optional)
delay_from_study_field – Delay running this rule, start counting from this study’s datetime field (optional)
delay_from_study_seconds – Number of seconds to delay running this rule for after a timepoint defined by delay_from_study_field (optional)
delay_seconds – Number of seconds to delay running this rule for after it is triggered (optional)
delay_till_schedule – Delay running this rule after it is triggered until the next scheduled time - flag (optional)
group_id – group_id
location_id – location_id
manual_roles – A comma separated list of the uuid of roles that can run the rule manually (optional)
namespace_id – namespace_id
no_re_run – Do not run this rule on a re-notification from storage - flag (optional)
on_manual_route – Apply this rule for a manually routed study - flag (optional)
on_thin – Apply this rule to thin studies when they are created - flag (optional)
on_upload – Apply the rule to studies uploaded into the namespace - flag (optional)
only_re_run – Only run this rule on a re-notification from storage - flag (optional)
options – Route options in JSON format (optional)
other_namespaces – A comma separated list of the uuid of other namespaces to apply this rule to (optional)
schedule – Route schedule in JSON format (optional)
suspended – This rule is suspended and not applied - flag (optional)
-
physician_alias_match(account_id, lv)[source]¶ Physician alias match.
- Parameters
account_id – The account to test in
lv – The tag text to match against the PHYSICIAN_ALIAS rule.
-
set(uuid, actions=None, conditions=None, delay=None, delay_from_study_field=None, delay_from_study_seconds=None, delay_seconds=None, delay_till_schedule=None, manual_roles=None, name=None, no_re_run=None, on_harvest=None, on_manual_route=None, on_share=None, on_thin=None, on_upload=None, only_re_run=None, options=None, other_namespaces=None, schedule=None, suspended=None)[source]¶ Set.
- Parameters
uuid – The route uuid
actions – Route actions in JSON format (optional)
conditions – Route conditions in JSON format (optional)
delay – Number of minutes to delay running this rule for after it is triggered (optional)
delay_from_study_field – Delay running this rule, start counting from this study’s datetime field (optional)
delay_from_study_seconds – Number of seconds to delay running this rule for after a timepoint defined by delay_from_study_field (optional)
delay_seconds – Number of seconds to delay running this rule for after it is triggered (optional)
delay_till_schedule – Delay running this rule after it is triggered until the next scheduled time - flag (optional)
manual_roles – A comma separated list of the uuid of roles that can run the rule manually (optional)
name – Name of the route (optional)
no_re_run – Do not run this rule on a re-notification from storage - flag (optional)
on_harvest – Apply the rule to studies harvested into the namespace (optional)
on_manual_route – Apply this rule for a manually routed study- flag (optional)
on_share – Apply the rule to studies shared into the namespace (optional)
on_thin – Apply this rule to thin studies when they are created - flag (optional)
on_upload – Apply the rule to studies uploaded into the namespace - flag (optional)
only_re_run – Only run this rule on a re-notification from storage - flag (optional)
options – Route options in JSON format (optional)
other_namespaces – A comma separated list of the uuid of other namespaces to apply this rule to (optional)
schedule – Route schedule in JSON format (optional)
suspended – This rule is suspended and not applied - flag (optional)
-
-
class
ambra_sdk.service.entrypoints.Rsna(api)[source]¶ Rsna.
-
phr_study(access_code, dob, exam_id, namespace, pin, clearinghouse=None)[source]¶ Phr_study.
- Parameters
access_code – RSNA-generated access code
dob – Patient’s date of birth YYYYMMDD
exam_id – RSNA-generated exam ID/token/email (DEPRECATED June 2015 - use access_code)
namespace – Namespace where retrieved exam will be stored
pin – RSNA-generated PIN (DEPRECATED June 2015 - use access_code)
clearinghouse – Clearinghouse to retrieve exam from: test or blank (optional)
-
-
class
ambra_sdk.service.entrypoints.Scanner(api)[source]¶ Scanner.
-
add(name, site_id, customfield_param=None, manufacturer=None, modality=None, model=None, serial_no=None)[source]¶ Add.
- Parameters
name – Name of the scanner
site_id – Id of the site to add them to
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
manufacturer – The manufacturer of the scanner (optional)
modality – Modality (optional)
model – The scanner model (optional)
serial_no – The serial number of the scanner (optional)
-
set(uuid, customfield_param=None, manufacturer=None, modality=None, model=None, name=None, serial_no=None)[source]¶ Set.
- Parameters
uuid – The scanner uuid
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) (optional)
manufacturer – The manufacturer of the scanner (optional)
modality – Modality (optional)
model – The scanner model (optional)
name – Name of the scanner (optional)
serial_no – The serial number of the scanner (optional)
-
-
class
ambra_sdk.service.entrypoints.Session(api)[source]¶ Session.
-
get_sid(username: str, password: str, special_headers_for_login: Optional[Dict[str, str]] = None) → str[source]¶ Get sid from credentials.
- Parameters
username – user name
password – user password
special_headers_for_login – special headers for login
- Returns
sid
-
login(login, account_login=None, account_name=None, email=None, location=None, new_password=None, password=None, use_pkey=None, validate_session=None, vanity=None)[source]¶ Login.
- Parameters
login – The user account_login or email address
account_login – account_login
account_name – account_name
email – email
location – Login location. (optional)
new_password – Change the password or account password to this. (optional)
password – password
use_pkey – use_pkey
validate_session – If you would like to validate an existing session rather than create a new one pass in the sid of the session to valid in this parameter. It will check if the session is still valid and the credentials are for the session. (optional)
vanity – The account vanity name. (optional)
-
oauth(code, redirect_uri, vendor)[source]¶ Oauth.
- Parameters
code – The OAuth code
redirect_uri – The redirect_uri used to get the code parameter
vendor – The OAuth vendor (doximity|google|brand)
-
oauth_token(client_id, client_secret, grant_type, duration=None)[source]¶ Oauth token.
- Parameters
client_id – The users email address
client_secret – The users password
grant_type – The grant type, set to client_credentials
duration – The number of seconds the token is valid for (optional and defaults to 3600 with a maximum value of 86400)
-
permissions(account_id=None, namespace_id=None)[source]¶ Permissions.
- Parameters
account_id – account_id
namespace_id – namespace_id
-
pin(pin, remember_device=None)[source]¶ Pin.
- Parameters
pin – The PIN
remember_device – Remember the device as trusted. (optional)
-
-
class
ambra_sdk.service.entrypoints.Setting(api)[source]¶ Setting.
-
class
ambra_sdk.service.entrypoints.Site(api)[source]¶ Site.
-
add(account_id, name, address1=None, address2=None, city=None, country=None, site_id=None, state=None, zip=None)[source]¶ Add.
- Parameters
account_id – uuid of the account to add them to
name – The sites name
address1 – Address line 1 of the site (optional)
address2 – Address line 2 of the site (optional)
city – The city the site is located in (optional)
country – The country of the site (optional)
site_id – The site to attach them to as a satellite site (optional)
state – The state code of the site (optional)
zip – The zip code of the site (optional)
-
set(uuid, address1=None, address2=None, city=None, country=None, inactive=None, name=None, site_id=None, state=None, zip=None)[source]¶ Set.
- Parameters
uuid – The site uuid
address1 – Address line 1 of the site (optional)
address2 – Address line 2 of the site (optional)
city – The city the site is located in (optional)
country – The country of the site (optional)
inactive – Flag if the site is actively used. Might be used to filter out inactive sites (optional)
name – The sites name (optional)
site_id – The site to attach them to as a satellite site (optional)
state – The state code of the site (optional)
zip – The zip code of the site (optional)
-
user_add(role_name, uuid, email=None, user_id=None)[source]¶ User add.
- Parameters
role_name – The role name that should be used for the user in groups
uuid – The group id
email – email
user_id – user_id
-
-
class
ambra_sdk.service.entrypoints.Study(api)[source]¶ Study namespace.
-
add(accession_number=None, attachment_count=None, customfield_param=None, destination_ae_title=None, image_count=None, integration_key=None, medical_record_locator=None, modality=None, node_id=None, patient_additional_history=None, patient_address=None, patient_age=None, patient_birth_date=None, patient_birth_time=None, patient_birthname=None, patient_comments=None, patient_current_location=None, patient_ethnic_group=None, patient_institution_residence=None, patient_mother_birthname=None, patient_name=None, patient_name_other=None, patient_occupation=None, patient_phone=None, patient_religious_preference=None, patient_sex=None, patient_size=None, patient_weight=None, patientid=None, patientid_other=None, phi_namespace=None, referring_physician=None, serial_no=None, source_ae_title=None, storage_namespace=None, study_date=None, study_description=None, study_time=None, study_uid=None, thin=None, uuid=None)[source]¶ Add.
- Parameters
accession_number – DICOM tag (0008,0050) (optional)
attachment_count – Attachment count (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID|DICOM_TAG. Custom field(s), see notes in /study/add (optional)
destination_ae_title – The destination aetitle (optional)
image_count – Images in the study (optional)
integration_key – Integration key for the study (optional)
medical_record_locator – DICOM tag (0010,1090) (optional)
modality – DICOM tag (0008,0060) (optional)
node_id – If this is a thin study the gateway UUID to retrieve it from can be specified (optional)
patient_additional_history – DICOM tag (0010,21B0) (optional)
patient_address – DICOM tag (0010,1040) (optional)
patient_age – DICOM tag (0010,1010) (optional)
patient_birth_date – DICOM tag (0010,0030) (optional)
patient_birth_time – DICOM tag (0010,0032) (optional)
patient_birthname – DICOM tag (0010,1005) (optional)
patient_comments – DICOM tag (0010,4000) (optional)
patient_current_location – DICOM tag (0038,0300) (optional)
patient_ethnic_group – DICOM tag (0010,2160) (optional)
patient_institution_residence – DICOM tag (0038,0400) (optional)
patient_mother_birthname – DICOM tag (0010,1060) (optional)
patient_name – DICOM tag (0010,0010)(optional)
patient_name_other – DICOM tag (0010,1001) (optional)
patient_occupation – DICOM tag (0010,2180) (optional)
patient_phone – DICOM tag (0010,2154) (optional)
patient_religious_preference – DICOM tag (0010,21F0) (optional)
patient_sex – DICOM tag (0010,0040) (optional)
patient_size – DICOM tag (0010,1020) (optional)
patient_weight – DICOM tag (0010,1030) (optional)
patientid – DICOM tag (0010,0020) (optional)
patientid_other – DICOM tag (0010,1000) (optional)
phi_namespace – phi_namespace
referring_physician – DICOM tag (0008,0090) (optional)
serial_no – serial_no
source_ae_title – The source aetitle (optional)
storage_namespace – storage_namespace
study_date – DICOM tag (0008,0020) (optional)
study_description – DICOM tag (0008,1030) (optional)
study_time – DICOM tag (0008,0030) (optional)
study_uid – study_uid
thin – Flag to add this as a thin study (optional)
uuid – uuid
-
approve(uuid, delay=None, must_match=None)[source]¶ Approve.
- Parameters
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)
-
attach_customfields(uuid, report_name=None)[source]¶ Attach customfields.
- Parameters
uuid – The study id
report_name – The report name (optional defaults to customfields.txt)
-
audit(action, detail, phi_namespace=None, storage_namespace=None, study_uid=None, uuid=None)[source]¶ Audit.
- Parameters
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)
detail – Additional information
phi_namespace – The phi namespace of the study (optional)
storage_namespace – The storage namespace of the study (optional if uuid is passed)
study_uid – The v3 storage uid of the study (optional if uuid is passed)
uuid – The id of the study (optional if study_uid and storage_namespace are passed)
-
cfind(serial_no, uuid, entire_account=None, is_available=None)[source]¶ Cfind.
- Parameters
serial_no – The serial number of the node
uuid – The node id
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)
-
clone(uuid, new_image_uids=None, new_series_uids=None)[source]¶ Clone.
- Parameters
uuid – The study id
new_image_uids – Flag if you want to generate new uids for the study images (optional)
new_series_uids – Flag if you want to generate new uids for the study series (optional)
-
cmove(aetitle, ping, serial_no, study_uid, uuid, detail=None)[source]¶ Cmove.
- Parameters
aetitle – The aetitle to send to
ping – Flag to send the ping job back in this call
serial_no – The serial number of the node
study_uid – The study uid
uuid – The node id
detail – Additional detail to send on the /node/ping (optional)
-
comment_add(body, study_id)[source]¶ Comment add.
- Parameters
body – The comment body
study_id – The study id
-
delete(node_id=None, phi_namespace=None, serial_no=None, storage_namespace=None, study_uid=None, uuid=None)[source]¶ Delete.
- Parameters
node_id – node_id
phi_namespace – phi_namespace
serial_no – serial_no
storage_namespace – storage_namespace
study_uid – study_uid
uuid – uuid
-
duplicate(uuid, exclude_phi=None, include_attachments=None, namespace_id=None, overwrite=None, study_request_id=None)[source]¶ Duplicate.
- Parameters
uuid – The study id
exclude_phi – Flag to not duplicate PHI data (optional)
include_attachments – Also duplicate attachments (optional)
namespace_id – namespace_id
overwrite – Flag if you want to overwrite an existing study in the destination namespace (optional)
study_request_id – study_request_id
-
exists(account_id=None, phi_namespace=None, storage_namespace=None, study_uid=None, uuid=None)[source]¶ Exists.
- Parameters
account_id – account_id
phi_namespace – phi_namespace
storage_namespace – storage_namespace
study_uid – study_uid
uuid – uuid
-
external_viewer(redirect, uuid, view_reason=None, viewer_tag=None)[source]¶ External viewer.
- Parameters
redirect – A flag to return an HTTP redirect to the viewer URL rather than the JSON structure
uuid – The study id
view_reason – The view reason to be tracked in the audit trail (optional)
viewer_tag – An external viewer’s tag (optional)
-
fax_hl7(hl7_id, number, uuid)[source]¶ Fax hl7.
- Parameters
hl7_id – HL7 message to create the PDF report for
number – The fax number to send the PDF report to
uuid – The study uuid
-
find_order(uuid, accession_number=None, patient_name=None, patientid=None)[source]¶ Find order.
- Parameters
uuid – The study id
accession_number – accession_number
patient_name – patient_name
patientid – patientid
-
freeze(thaw, uuid)[source]¶ Freeze.
- Parameters
thaw – Flag to thaw a frozen study
uuid – The study id
-
get(customfield_h=None, extra=None, fields=None, full_hl7=None, limit_hl7=None, node_id=None, permissions_diff=None, phi_namespace=None, serial_no=None, storage_namespace=None, study_uid=None, uuid=None)[source]¶ Get.
- Parameters
customfield_h – Flag to return a customfield hash as detailed below (optional)
extra – Flag to return extra data as detailed below (optional)
fields – A JSON list of the study fields to return (optional)
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)
node_id – node_id
permissions_diff – Flag to return only the permissions that differ from the namespace permissions (optional)
phi_namespace – phi_namespace
serial_no – serial_no
storage_namespace – storage_namespace
study_uid – study_uid
uuid – uuid
-
list(customfield_h=None, extra=None, fields=None, limit_hl7=None, permissions_diff=None, template=None)[source]¶ List.
- Parameters
customfield_h – Flag to return a customfield hash as detailed in /study/get (optional)
extra – Flag to return extra data as detailed in /study/get (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)
permissions_diff – Flag to return only the permissions that differ from the namespace permissions (optional)
template – A JSON hash with name, account_id and language of the template to return (optional)
-
manual_route(route_id, uuid, email=None, message=None)[source]¶ Manual route.
- Parameters
route_id – The routing rule id
uuid – The study 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)
-
move(namespace_id, uuid)[source]¶ Move.
- Parameters
namespace_id – The namespace id
uuid – The study id
-
node_can_remove(serial_no, study_uid, uuid)[source]¶ Node can remove.
- Parameters
serial_no – The serial number of the node
study_uid – The study uid
uuid – The node id
-
pdf_hl7(hl7_id, uuid)[source]¶ Pdf hl7.
- Parameters
hl7_id – HL7 message to create the PDF report for
uuid – The study uuid
-
push(batch_no, destination_id, ping, uuid)[source]¶ Push.
- Parameters
batch_no – The batch number if pushing to a CD burner
destination_id – The destination to push it to
ping – Flag to send the ping job back in this call
uuid – The study uuid
-
push_hl7(destination_id, uuid, hl7_id=None, hl7_template_id=None, once=None)[source]¶ Push hl7.
- Parameters
destination_id – The destination to push it to
uuid – The study uuid
hl7_id – HL7 message to use in the template (optional)
hl7_template_id – The HL7 template to use (optional)
once – Flag that this message should only be sent a maximum of one time (optional)
-
question(detail, question, uuid)[source]¶ Question.
- Parameters
detail – Optional detail to pass through to the AI stack
question – The question to ask or a JSON array of questions to ask
uuid – The study id
-
reject(uuid, message=None)[source]¶ Reject.
- Parameters
uuid – The study uuid
message – Message to send to the person who shared the study (optional)
-
report_detail(account_id, limit=None)[source]¶ Report detail.
- Parameters
account_id – Limit to studies in the passed account
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)
-
report_series(email, hours, namespace_id, limit=None)[source]¶ Report series.
- Parameters
email – Send the report to this email address(es) when it is done
hours – Report on studies acquired within the last number of hours
namespace_id – Namespace to run the report on
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)
-
request_add(account_id, comments, namespace_id, patient_birth_date, patient_first_name, patient_last_name, modality=None, patient_sex=None, patientid=None, study_date_end=None, study_date_start=None, study_description=None)[source]¶ Request add.
- Parameters
account_id – The account id to send the study request to
comments – Free form request comments
namespace_id – The namespace id requested studies to put (share or duplicate) into
patient_birth_date – The patient date of birth 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
modality – The modality a study should match (optional)
patient_sex – The patient sex a study should match (optional)
patientid – The MRN a study should match (optional)
study_date_end – The DICOM date that a study date should be less or equal to (optional)
study_date_start – The DICOM date that a study date should be greater or equal to (optional)
study_description – The string a study description should partially match (optional)
-
request_match(study_request_id)[source]¶ Request match.
- Parameters
study_request_id – The study request uuid
-
set(accession_number=None, attachment_count=None, customfield_param=None, destination_ae_title=None, find_order_uuid=None, image_count=None, integration_key=None, medical_record_locator=None, modality=None, node_id=None, patient_additional_history=None, patient_address=None, patient_age=None, patient_birth_date=None, patient_birth_time=None, patient_birthname=None, patient_comments=None, patient_current_location=None, patient_ethnic_group=None, patient_institution_residence=None, patient_mother_birthname=None, patient_name=None, patient_name_other=None, patient_occupation=None, patient_phone=None, patient_religious_preference=None, patient_sex=None, patient_size=None, patient_weight=None, patientid=None, patientid_other=None, phi_namespace=None, referring_physician=None, seconds_to_ingest=None, serial_no=None, source_ae_title=None, storage_namespace=None, study_date=None, study_description=None, study_id=None, study_time=None, study_uid=None, use_upload_permission=None, uuid=None)[source]¶ Set.
- Parameters
accession_number – DICOM tag (0008,0050) (optional)
attachment_count – Attachment count (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID|DICOM_TAG. Custom field(s), see notes in /study/add (optional)
destination_ae_title – The destination aetitle (optional)
find_order_uuid – UUID of the search record used to modify the study (optional)
image_count – Images in the study (optional)
integration_key – Integration key for the study (optional)
medical_record_locator – DICOM tag (0010,1090) (optional)
modality – DICOM tag (0008,0060) (optional)
node_id – If this is a thin study the gateway UUID to retrieve it from can be specified (optional)
patient_additional_history – DICOM tag (0010,21B0) (optional)
patient_address – DICOM tag (0010,1040) (optional)
patient_age – DICOM tag (0010,1010) (optional)
patient_birth_date – DICOM tag (0010,0030) (optional)
patient_birth_time – DICOM tag (0010,0032) (optional)
patient_birthname – DICOM tag (0010,1005) (optional)
patient_comments – DICOM tag (0010,4000) (optional)
patient_current_location – DICOM tag (0038,0300) (optional)
patient_ethnic_group – DICOM tag (0010,2160) (optional)
patient_institution_residence – DICOM tag (0038,0400) (optional)
patient_mother_birthname – DICOM tag (0010,1060) (optional)
patient_name – DICOM tag (0010,0010) (optional)
patient_name_other – DICOM tag (0010,1001) (optional)
patient_occupation – DICOM tag (0010,2180) (optional)
patient_phone – DICOM tag (0010,2154) (optional)
patient_religious_preference – DICOM tag (0010,21F0) (optional)
patient_sex – DICOM tag (0010,0040) (optional)
patient_size – DICOM tag (0010,1020) (optional)
patient_weight – DICOM tag (0010,1030) (optional)
patientid – DICOM tag (0010,0020) (optional)
patientid_other – DICOM tag (0010,1000) (optional)
phi_namespace – phi_namespace
referring_physician – DICOM tag (0008,0090) (optional)
seconds_to_ingest – Flag to re-calculate the seconds_to_ingest metric (optional)
serial_no – serial_no
source_ae_title – The source aetitle (optional)
storage_namespace – storage_namespace
study_date – DICOM tag (0008,0020) (optional)
study_description – DICOM tag (0008,1030) (optional)
study_id – study_id
study_time – DICOM tag (0008,0030) (optional)
study_uid – study_uid
use_upload_permission – Flag to use the upload permissions for the permissions check (optional)
uuid – uuid
Share.
- Parameters
account_id – account_id
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_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) to apply to the shared study (optional)
email – email
group_id – group_id
integration_key – Integration key to tag the share with (optional)
location_id – location_id
masshiway – masshiway
message – Message to the recipient (optional)
npi – npi
phi_namespace – phi_namespace
rsna – rsna
share_code – share_code
storage_namespace – storage_namespace
study_request_id – study_request_id
study_uid – study_uid
user_id – user_id
uuid – uuid
Share list.
- Parameters
uuid – The study uuid
name – Flag to return a hash with both the uuid and name of the object (optional)
Share stop.
- Parameters
uuid – The study uuid
account_id – account_id
group_id – group_id
location_id – location_id
user_id – user_id
user_invite_share_id – user_invite_share_id
Share who.
- Parameters
type – Type of objects you want (account|location|group|user)
uuid – The study uuid
-
split(namespace_id, no_split, uuid)[source]¶ Split.
- Parameters
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
uuid – The study id
-
star(star, uuid)[source]¶ Star.
- Parameters
star – Star flag set on or off (1|0)
uuid – The id of the study
-
status_get(study_id)[source]¶ Status get.
- Parameters
study_id – Study uuid * Any other parameters that could be processed by study_status_tags_rules
-
status_set(new, old, study_id)[source]¶ Status set.
- Parameters
new – The new study status value
old – The old study status value
study_id – Study uuid
-
sync(image_count=None, node_id=None, phi_namespace=None, reload_load_dicom_tag=None, serial_no=None, storage_namespace=None, study_id=None, study_uid=None)[source]¶ Sync.
- Parameters
image_count – Update the study image count and then sync (optional)
node_id – node_id
phi_namespace – phi_namespace
reload_load_dicom_tag – Flag to force a reload of all load_dicom_tag customfields (optional)
serial_no – serial_no
storage_namespace – storage_namespace
study_id – study_id
study_uid – study_uid
-
timing_event(event, storage_namespace, study_uid, node_id=None, serial_no=None, size=None)[source]¶ Timing event.
- Parameters
event – The event
storage_namespace – The storage namespace
study_uid – The study uid
node_id – node_id
serial_no – serial_no
size – The number of bytes associated with the event (optional)
-
validate(uuid, validate_id, series=None)[source]¶ Validate.
- Parameters
uuid – The study id
validate_id – The validation id
series – Only validate the specified series (optional)
-
viewer3_settings(phi_namespace=None, settings=None, storage_namespace=None, study_id=None, study_uid=None)[source]¶ Viewer3 settings.
- Parameters
phi_namespace – phi_namespace
settings – A JSON list of user settings set via /setting/set to return (optional)
storage_namespace – storage_namespace
study_id – study_id
study_uid – study_uid
-
-
class
ambra_sdk.service.entrypoints.Tag(api)[source]¶ Tag.
-
add(object, object_id, tag)[source]¶ Add.
- Parameters
object – Object class to apply it to (Study|User_account|Group|Location|Account|Patient|Case|Order|Message|Query)
object_id – UUID of the object
tag – Value of the tag
-
-
class
ambra_sdk.service.entrypoints.Terminology(api)[source]¶ Terminology.
-
account_overrides(account_id=None, phi_namespace=None, storage_namespace=None, study_uid=None, vanity=None)[source]¶ Account overrides.
- Parameters
account_id – account_id
phi_namespace – phi_namespace
storage_namespace – storage_namespace
study_uid – study_uid
vanity – vanity
-
i18next(lng, account_id=None, vanity=None)[source]¶ I18next.
- Parameters
lng – The language code
account_id – account_id
vanity – vanity
-
list(language, tags, account_id=None, vanity=None)[source]¶ List.
- Parameters
language – The ISO 639-1 language code
tags – A comma separated list of the terminology tags to look up
account_id – account_id
vanity – vanity
-
set(language, tag, value, account_id=None, vanity=None)[source]¶ Set.
- Parameters
language – The ISO 639-1 language code
tag – The tag to set
value – The value of the tag. If this is empty the tag is deleted
account_id – The uuid of the account to apply the tag for (optional)
vanity – Vanity to apply the tag for (optional)
Tags.
- Parameters
language – The ISO 639-1 language code
account_id – account_id
phi_namespace – phi_namespace
storage_namespace – storage_namespace
study_uid – study_uid
tags – A comma separated list of the terminology tags to look up (optional)
vanity – vanity
-
-
class
ambra_sdk.service.entrypoints.Training(api)[source]¶ Training.
-
class
ambra_sdk.service.entrypoints.User(api)[source]¶ User.
-
add(account_id, email, first, last, mobile_phone, password)[source]¶ Add.
- Parameters
account_id – Account id to check for the user_edit permission
email – Email
first – First name
last – Last name
mobile_phone – SMS phone number
password – Password
-
enable(uuid, disable=None)[source]¶ Enable.
- Parameters
uuid – User uuid
disable – A flag indicating whether to disable the user (optional)
-
event(namespace_id, uuid=None)[source]¶ Event.
- Parameters
namespace_id – Id of the namespace to set the flags on
uuid – Return event flags for this user, not current user (optional)
-
event_set(namespace_id, event_approve=None, event_case_assignment=None, event_harvest=None, event_incoming_study_request=None, event_link=None, event_link_mine=None, event_message=None, event_new_report=None, event_query_add=None, event_query_edit=None, event_query_reply=None, event_report_remove=None, event_share=None, event_site_qualified=None, event_status_change=None, event_study_comment=None, event_thin_study_fail=None, event_thin_study_success=None, event_upload=None, event_upload_fail=None, uuid=None)[source]¶ Event set.
- Parameters
namespace_id – Id of the namespace to set the flags on
event_approve – Notify the user on a approval needed into the namespace (optional)
event_case_assignment – Notify the user when they are assigned a case as a medical or admin user (optional)
event_harvest – Notify the user on a harvest into the namespace (optional)
event_incoming_study_request – Notify the user when they get an incoming study request (optional)
event_link – Notify the user when an anonymous link is hit in the namespace (optional)
event_link_mine – Notify the user when an anonymous link created by the user is hit in the namespace (optional)
event_message – Notify the user when a message is sent to the namespace (optional)
event_new_report – Notify the user when a report is attached in the namespace (optional)
event_query_add – Notify the user when a new query is issued (optional)
event_query_edit – Notify the user when a query is edites (optional)
event_query_reply – Notify the user when they leave a new reply in a query (optional)
event_report_remove – Notify the user when a report is removed in the namespace (optional)
event_share – Notify the user on a share into the namespace (optional)
event_site_qualified – Notify the user when a trial site is qualified for the clinical trial account (optional)
event_status_change – Notify the user when the status of a study is changed (optional)
event_study_comment – Notify the user when a comment is attached to a study in the namespace (optional)
event_thin_study_fail – Notify the user when a thin study retrieval they initiated fails (optional)
event_thin_study_success – Notify the user when a thin study retrieval they initiated succeeds (optional)
event_upload – Notify the user on an upload into the namespace (optional)
event_upload_fail – Notify the user on a failed upload into the namespace (optional)
uuid – Return event flags for this user, not current user (optional)
-
get(account_id=None, uuid=None)[source]¶ Get.
- Parameters
account_id – Account id if you are trying to get a user other than yourself (optional)
uuid – The users uuid (optional). Uses the session user if not passed
-
invite(account_id, email, link, groups=None, link_already=None, locations=None, role_id=None)[source]¶ Invite.
- Parameters
account_id – The account to invite the person too
email – Email address of the person to invite
link – URL to accept the invitation at. The invitation id will be appended to the link
groups – A JSON hash with the keys the group uuids to add the user to and the values the role uuid for the group (optional)
link_already – URL to accept the invitation at for an existing user on the system. The invitation id will be appended to the link (optional)
locations – A JSON hash with the keys the location uuids to add the user to and the values the role uuid for the location (optional)
role_id – The role to give the user (optional)
-
join(email, first, last, password, captcha_response=None, customfield_param=None, share_code=None)[source]¶ Join.
- Parameters
email – Email
first – First name
last – Last name
password – Password
captcha_response – Response from captcha (optional)
customfield_param – Expected values are CUSTOMFIELD_UUID. Custom field(s) defined in the vanity_registration_customfields account setting (optional)
share_code – Share code they are joining from (optional)
-
join_request(account_id)[source]¶ Join request.
- Parameters
account_id – Id of the account to request to join
-
namespace_list(account_id=None, name_and_id_only=None, plus_phr=None)[source]¶ Namespace list.
- Parameters
account_id – Only return the namespaces for this account (optional)
name_and_id_only – Flag to return only the the namespace name and uuid (optional)
plus_phr – Flag to include the PHR account as well if account_id was specified (optional)
-
password_reset(password, token)[source]¶ Password reset.
- Parameters
password – The new password
token – The reset token
-
pubkey_list(serial_no, uuid)[source]¶ Pubkey list.
- Parameters
serial_no – The serial number of the node
uuid – The node id
-
pubkey_set(email, public_key, serial_no, uuid)[source]¶ Pubkey set.
- Parameters
email – The users email
public_key – A public key for public key authentication
serial_no – The serial number of the node
uuid – The node id
-
set(indicator_md5, privacy_md5, terms_md5, account_id=None, allowed_login_brands=None, cc_token=None, email=None, first=None, last=None, mobile_phone=None, old_password=None, password=None, pin_required=None, public_key=None, share_code=None, share_description=None, time_zone=None, ui_json=None, uuid=None)[source]¶ Set.
- param indicator_md5
MD5 of the accepted indications of use
- param privacy_md5
MD5 of the accepted privacy policy
- param terms_md5
MD5 of the accepted terms of service
- param account_id
Account id if you are trying to set a user other than yourself (optional)
- param allowed_login_brands
A comma separated list of Brand UUIDs that the user is allowed to use when logging in (optional)
- param cc_token
The credit card token to attach to the users account (optional)
- param email
Email (optional)
- param first
First name (optional)
- param last
Last name (optional)
- param mobile_phone
SMS phone number (optional)
- param old_password
Previous user password (optional)
- param password
User password (optional)
- param pin_required
Flag to require a PIN for every login (optional)
- param public_key
A public key for public key authentication (optional)
- param share_code
The share code of the user (optional)
- param share_description
The share description of the user (optional)
- param time_zone
The users time zone name as per https://www.postgresql.org/docs/9.1/static/view-pg-timezone-names.html (optional)
- param ui_json
JSON for UI settings (optional) possible options:
show_org_manage_link (boolean) Show link to manage multiple organizations advanced_search (array) Advanced search customization for role. See account level “advanced_search” ui_json param for possible values enable_v3_viewer (boolean) If set, enables ProViewer for PHR account
- param uuid
The users uuid (optional). Uses the session user if not passed
-
signature(signature)[source]¶ Signature.
- Parameters
signature – Set the users signature to this base64 encoded image
-
-
class
ambra_sdk.service.entrypoints.Validate(api)[source]¶ Validate.
-
class
ambra_sdk.service.entrypoints.Webhook(api)[source]¶ Webhook.
-
add(account_id, event, method, name, url, auth=None, by_accession_number=None, by_uid=None, by_webhook_event=None, cron=None, delay=None, filter_field=None, filter_regexp=None, max_age=None, node_id=None, once=None, parameters=None, retry=None, sid_user_id=None, suspended=None)[source]¶ Add.
- Parameters
account_id – uuid of the account
event – Event to call it on (See the notes for the available events)
method – Method to call it with (POST|GET|POST_JSON|PUT|GET_JSON)
name – Name of the webhook
url – URL to call
auth – A JSON hash with the authentication details (optional)
by_accession_number – Flag to expand the once search to include studies with the same accession_number (optional)
by_uid – Flag to expand the once search to include studies with the same study_uid (optional)
by_webhook_event – Flag to fire WEBHOOK_FAILED once at final unsuccessful try of a failing webhook (optional)
cron – Cron timing string for CRON events e.g 0 9 * * mon-fri(optional)
delay – Number of seconds to delay running this webhook for after it is triggered (optional)
filter_field – Name of the study field (by default) or another object’s field (should have prefix like “webhook.”) to filter on (optional)
filter_regexp – Regular expression to match the value of the filter_field against (optional)
max_age – Ignore studies that are more than this number of days old based on the study_date (optional)
node_id – uuid of the node to proxy the webhook through (optional)
once – Flag that this webhook should only be run once for a specific study (optional)
parameters – A JSON object of the parameter names and values (optional)
retry – Retry the webhook if it fails (optional)
sid_user_id – UUID of the user to generate a sid as (optional)
suspended – This webhook is suspended and not triggered (optional)
-
email(html, subject, template_id, text, to, webhook_id)[source]¶ Email.
- Parameters
html – The HTML part of the email
subject – The subject of the email
template_id – The email template UUID to be used
text – The text part of the email
to – The email address(es) to send the email to
webhook_id – The uuid of the calling webhook
-
event(type, integration_key=None, namespace_id=None, share_code=None, study_count=None)[source]¶ Event.
- Parameters
type – The type of event (STUDY_UPLOAD_START|STUDY_UPLOAD_END)
integration_key – The integration key associated with the event (optional)
namespace_id – namespace_id
share_code – share_code
study_count – The number of studies associated with the event (optional)
-
run(study_id, uuid)[source]¶ Run.
- Parameters
study_id – uuid of the study to run the webhook for
uuid – uuid of the webhook
-
set(uuid, auth=None, by_accession_number=None, by_uid=None, by_webhook_event=None, cron=None, delay=None, event=None, filter_field=None, filter_regexp=None, max_age=None, method=None, name=None, node_id=None, once=None, parameters=None, retry=None, sid_user_id=None, suspended=None, url=None)[source]¶ Set.
- Parameters
uuid – uuid of the webhook
auth – A JSON hash with the authentication details (optional)
by_accession_number – Flag to expand the once search to include studies with the same accession_number (optional)
by_uid – Flag to expand the once search to include studies with the same study_uid (optional)
by_webhook_event – Flag to fire WEBHOOK_FAILED once at final unsuccessful try of a failing webhook (optional)
cron – Cron timing string for CRON events (optional)
delay – Number of seconds to delay running this webhook for after it is triggered (optional)
event – Event to call it on (optional see add command for options)
filter_field – Name of the field to filter on (optional)
filter_regexp – Regular expression to match the value of the filter_field against (optional)
max_age – Ignore studies that are more than this number of days old based on the study_date (optional)
method – Method to call it with (optional see add command for options)
name – Name of the webhook (optional)
node_id – uuid of the node to proxy the webhook through (optional)
once – Flag that this webhook should only be run once for a specific study (optional)
parameters – A JSON object of the parameter names and values (optional see add command for options)
retry – Retry the webhook if it fails (optional)
sid_user_id – UUID of the user to generate a sid as (optional)
suspended – This webhook is suspended and not triggered (optional)
url – URL to call (optional)
-