Models¶
Ambra SDK models.
Do not edit this file by hand. This is generated by parsing /v3/dictionary.html service doc.
-
class
ambra_sdk.models.generated.Accelerator(*, id=None, uuid=None, account_id=None, account=None, address=None, fqdn=None, geo_fqdn=None, global_field=None, name=None, push_shared_studies=None, retention_days=None, serial_no=None, upgrade=None, version=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Accelerator.
-
account_id¶ String(FK. The associated account)
-
address¶ String(The domain name and IP address)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
fqdn¶ String(The domain name and IP address)
-
geo_fqdn¶ String(The domain name and IP address)
-
global_field¶ Boolean(Is it a global accelerator)
-
id¶ Integer(Primary key for internal use)
-
name¶ String(Name)
Boolean(Push shared studies to the accelerator)
-
retention_days¶ Integer(Retention days)
-
serial_no¶ String(The serial number)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
upgrade¶ Boolean(Version and upgrade flag)
-
uuid¶ String(UUID for external use)
-
version¶ String(Version and upgrade flag)
-
-
class
ambra_sdk.models.generated.Account(*, id=None, uuid=None, access_token=None, billing=None, can_request=None, css=None, customfields=None, fair_warning=None, name=None, namespace_id=None, namespace=None, password_expire=None, radreport_mail_out_authorized=None, role_id=None, role=None, saml=None, session_expire=None, settings=None, site_management_account_id=None, site_management_account=None, vanity_h=None, vendor=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Account.
-
access_token¶ String(Stripe access token)
-
billing¶ DictField(Billing information)
-
can_request¶ Boolean(Can request)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
css¶ String(Account css)
-
customfields¶ DictField(Custom fields)
-
fair_warning¶ String(Fair warning data. This should be a JSON hash of the keys needed to run and distribute the report)
-
id¶ Integer(Primary key for internal use)
-
name¶ String(Name)
-
namespace_id¶ String(FK. Namespace of the account)
-
password_expire¶ Integer(Days before the passwords expire)
Boolean(Did an account admin authorized radreports mailing out)
-
role_id¶ String(FK. Default role id)
-
saml¶ DictField(Native SAML information)
-
session_expire¶ Integer(Minutes before an idle session expires)
-
settings¶ DictField(Account settings)
-
site_management_account_id¶ String(FK. Site management account id for the trial study account)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
vanity_h¶ DictField(Vanity URLs)
-
vendor¶ String(The vendor field)
-
AccountCanShare.
alias of
Account
String(FK. The account this rule is for)
alias of
Account
String(FK. Who is sharing)
alias of
Group
String(FK. Who is sharing)
alias of
Location
String(FK. Who is sharing)
alias of
User
String(FK. Who is sharing)
DateTime(Timestamp when the record was created)
String(FK. ID of the user who created the record)
alias of
User
Integer(Primary key for internal use)
DateTime(Timestamp when the record was last updated)
String(FK. ID of the user who updated the record)
alias of
User
alias of
Account
String(FK. With who can they share)
alias of
Group
String(FK. With who can they share)
alias of
Location
String(FK. With who can they share)
alias of
User
String(FK. With who can they share)
-
class
ambra_sdk.models.generated.AccountMd5Counter(*, id=None, account_id=None, account=None, counter=None, md5=None, created=None, created_by=None, created_by_obj=None)[source]¶ AccountMd5Counter.
-
account_id¶ String(FK. Primary key for internal use)
-
counter¶ Integer(Primary key for internal use)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
md5¶ String(Primary key for internal use)
-
-
class
ambra_sdk.models.generated.AccountSamlRole(*, id=None, account_id=None, account=None, 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, for_group=None, for_location=None, namespace_id=None, namespace=None, role_id=None, role=None, saml_role=None, sequence=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ AccountSamlRole.
-
account_id¶ String(FK. The account this rule is for)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
event_approve¶ Boolean(The event flags)
-
event_case_assignment¶ Boolean(The event flags)
-
event_harvest¶ Boolean(The event flags)
-
event_incoming_study_request¶ Boolean(The event flags)
-
event_link¶ Boolean(The event flags)
-
event_link_mine¶ Boolean(The event flags)
-
event_message¶ Boolean(The event flags)
-
event_new_report¶ Boolean(The event flags)
-
event_node¶ Boolean(The event flags)
-
event_query_add¶ Boolean(The event flags)
-
event_query_edit¶ Boolean(The event flags)
-
event_query_reply¶ Boolean(The event flags)
-
event_report_remove¶ Boolean(The event flags)
Boolean(The event flags)
-
event_site_qualified¶ Boolean(The event flags)
-
event_status_change¶ Boolean(The event flags)
-
event_study_comment¶ Boolean(The event flags)
-
event_thin_study_fail¶ Boolean(The event flags)
-
event_thin_study_success¶ Boolean(The event flags)
-
event_upload¶ Boolean(The event flags)
-
event_upload_fail¶ Boolean(The event flags)
-
for_group¶ Boolean(Apply this mapping to all namespaces of the corresponding type)
-
for_location¶ Boolean(Apply this mapping to all namespaces of the corresponding type)
-
id¶ Integer(Primary key for internal use)
-
namespace_id¶ String(FK. The namespace this is for)
-
role_id¶ String(FK. The role this is for)
-
saml_role¶ String(The SAML role)
-
sequence¶ Integer(Ordering sequence)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
-
class
ambra_sdk.models.generated.Activity(*, id=None, uuid=None, approval_reason=None, message=None, namespace_id=None, namespace=None, node_connect_id=None, node_connect=None, priority=None, qctask_id=None, qctask=None, study_id=None, study=None, type_field=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Activity.
-
approval_reason¶ String(The reason why the study is pending approval. S - share, U - upload, H - harvest, M - move, D - duplicate UID, E - auto edits)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
message¶ String(Message associated with activity)
-
namespace_id¶ String(FK. Id of the namespace the activity is associated with)
-
node_connect¶ alias of
NodeConnect
-
node_connect_id¶ String(FK. Id of the node connect request the activity is associated with)
-
priority¶ Integer(The activity priority)
-
qctask¶ Model descriptor.
-
qctask_id¶ String(FK. Id of the clinical trial QC task)
-
study_id¶ String(FK. Id of the study the activity is associated with)
-
type_field¶ String(Type of activity)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. Id of the user the activity is specifically for.)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.AiQuestion(*, id=None, uuid=None, account_id=None, account=None, answer=None, answered=None, detail=None, namespace_id=None, namespace=None, next_question=None, pickup=None, question=None, raw_answer=None, study_id=None, study=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ AiQuestion.
-
account_id¶ String(FK. The study, namespace and account id)
-
answer¶ String(Question and answer)
-
answered¶ DateTime(When was this picked up and answered by the ai stack)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
detail¶ String(Question and answer)
-
id¶ Integer(Primary key for internal use)
-
namespace_id¶ String(FK. The study, namespace and account id)
-
next_question¶ Integer(Id of the next question to ask when this one is answered)
-
pickup¶ DateTime(When was this picked up and answered by the ai stack)
-
question¶ String(Question and answer)
-
raw_answer¶ String(Question and answer)
-
study_id¶ String(FK. The study, namespace and account id)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Analytics(*, id=None, clickhouse_last_id=None, last_id=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Analytics.
-
clickhouse_last_id¶ Integer(The id of the last audit job processed)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
last_id¶ Integer(The id of the last audit job processed)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
-
class
ambra_sdk.models.generated.Annotation(*, id=None, uuid=None, frame_number=None, instance_uid=None, json=None, series_uid=None, stamp=None, study_id=None, study=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Annotation.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
frame_number¶ String(The frame identification)
-
id¶ Integer(Primary key for internal use)
-
instance_uid¶ String(The frame identification)
-
json¶ String(Data structure)
-
series_uid¶ String(The frame identification)
-
stamp¶ Boolean(This is a stamped so no other user can create or edit an annotation for this image)
-
study_id¶ String(FK. Associated study)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. User who created the annotation)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Anonymization(*, id=None, uuid=None, account_id=None, account=None, name=None, rules=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Anonymization.
-
account_id¶ String(FK. The associated account)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
name¶ String(Name)
-
rules¶ String(Anonymization rules)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Appointment(*, id=None, uuid=None, account_id=None, account=None, customfields=None, description=None, end_time=None, external_id=None, patient_id=None, patient=None, start_time=None, status=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Appointment.
-
account_id¶ String(FK. The associated account)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
customfields¶ DictField(Custom fields)
-
description¶ String(Description)
-
end_time¶ DateTime(Time range)
-
external_id¶ String(Filler/Placer Appointment ID or other id)
-
id¶ Integer(Primary key for internal use)
-
patient_id¶ String(FK. The associated patient)
-
start_time¶ DateTime(Time range)
-
status¶ String(Status of the Appointment - Active/Cancelled/Discontinued)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. The associated user)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.ArchiveStudy(*, id=None, uuid=None, archive_vault_id=None, archive_vault=None, datum_signature=None, delay_until=None, engine_id=None, engine=None, expedite=None, job_id=None, last_error=None, make_thin=None, need_delete=None, need_restore=None, need_store=None, priority=None, started_at=None, storage_namespace=None, storage_namespace_obj=None, study_uid=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ ArchiveStudy.
-
archive_vault¶ Model descriptor.
-
archive_vault_id¶ String(FK. The vault it is stored in)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
datum_signature¶ String(Signature of the current study datum)
-
delay_until¶ DateTime(Delay the store or delete until this time)
-
engine_id¶ String(FK. The storage engine)
-
expedite¶ Boolean(Should we do an expedited retrieval)
-
id¶ Integer(Primary key for internal use)
-
job_id¶ String(When was the job started and the Last error message)
-
last_error¶ String(When was the job started and the Last error message)
-
make_thin¶ Boolean(Do we need to make the study thin after archiving)
-
need_delete¶ Boolean(Flag to control the store,restore and delete of the study. Indexed so the count in the control loop is fast)
-
need_restore¶ Boolean(Flag to control the store,restore and delete of the study. Indexed so the count in the control loop is fast)
-
need_store¶ Boolean(Flag to control the store,restore and delete of the study. Indexed so the count in the control loop is fast)
-
priority¶ Integer(Job priority. The higher the number the higher the priority of the job. This mirrors the archive flag in namespace)
-
started_at¶ DateTime(When was the job started and the Last error message)
-
storage_namespace¶ String(FK. The storage namespace)
-
study_uid¶ String(Study instance id)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.ArchiveStudyAws(*, id=None, uuid=None, archive_study_id=None, archive_study=None, aws_archive=None, datum_signature=None, job_id=None, state=None, type_field=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ ArchiveStudyAws.
-
archive_study¶ Model descriptor.
-
archive_study_id¶ String(FK. The associated study archive)
-
aws_archive¶ String(The id of the AWS archive)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
datum_signature¶ String(Signature of the current study datum)
-
id¶ Integer(Primary key for internal use)
-
job_id¶ String(Job Id and state, state can be PENDING, RETRIEVING, RETRIEVED, RESTORING, RESTORED, DONE)
-
state¶ String(Job Id and state, state can be PENDING, RETRIEVING, RETRIEVED, RESTORING, RESTORED, DONE)
-
type_field¶ String(Type archive either datum or phi)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.ArchiveVault(*, id=None, uuid=None, key=None, region=None, secret=None, storage_class=None, vault=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ ArchiveVault.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
key¶ String(AWS credentials)
-
region¶ String(AWS credentials)
-
secret¶ String(AWS credentials)
-
storage_class¶ String(AWS credentials)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
vault¶ String(AWS credentials)
-
-
class
ambra_sdk.models.generated.Audit(*, id=None, uuid=None, account_id=None, account=None, action=None, data=None, parent_id=None, parent=None, pid=None, proxy_id=None, proxy=None, type_field=None, user_id=None, user=None, created=None)[source]¶ Audit.
-
account_id¶ String(FK. Account id of the association account)
-
action¶ String(The audit action)
-
created¶ DateTime(Timestamp when the record was created)
-
data¶ String(The audit data)
-
id¶ Integer(Primary key for internal use)
-
parent¶ Model descriptor.
-
parent_id¶ String(FK. Id of the parent object)
-
pid¶ String(After the June 29 2016 release this holds the sid and client ip address)
-
proxy_id¶ String(FK. Id of the proxy user who did the action)
-
type_field¶ String(Type of object we are auditing)
-
user_id¶ String(FK. User who did the action)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.BillingSummary(*, id=None, uuid=None, account_id=None, account=None, account_name=None, account_uuid=None, admin_fee=None, annual_volume_floor_count=None, bucket_charges=None, flat_rate=None, month=None, monthly_volume_floor_count=None, mtd_studies=None, per_study_price=None, size=None, size_past=None, size_price=None, size_price_past=None, storage_overage=None, storage_price=None, total=None, total_storage_size=None, ytd_studies=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ BillingSummary.
-
account_id¶ String(FK. The account)
-
account_name¶ String(The account)
-
account_uuid¶ String(The account)
-
admin_fee¶ Float(The fields)
-
annual_volume_floor_count¶ Float(The fields)
-
bucket_charges¶ Float(The fields)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
flat_rate¶ Float(The fields)
-
id¶ Integer(Primary key for internal use)
-
month¶ String(The month this is for)
-
monthly_volume_floor_count¶ Float(The fields)
-
mtd_studies¶ Float(The fields)
-
per_study_price¶ Float(The fields)
-
size¶ Float(The fields)
-
size_past¶ Float(The fields)
-
size_price¶ Float(The fields)
-
size_price_past¶ Float(The fields)
-
storage_overage¶ Float(The fields)
-
storage_price¶ Float(The fields)
-
total¶ Float(The fields)
-
total_storage_size¶ Float(The fields)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
ytd_studies¶ Float(The fields)
-
-
class
ambra_sdk.models.generated.BoxFile(*, id=None, uuid=None, not_dicom=None, sha1=None, storage_namespace=None, storage_namespace_obj=None, study_uid=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ BoxFile.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
not_dicom¶ Boolean(Flag if this is not a dicom file)
-
sha1¶ String(Sha1 of the file)
-
storage_namespace¶ String(FK. The storage namespace)
-
study_uid¶ String(Study instance id)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. User who created it)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Brand(*, id=None, uuid=None, anonymous_permissions=None, anonymous_session_expire=None, cd_multi=None, cd_single=None, cd_viewer_settings=None, cluster_id=None, cluster=None, css=None, image_1=None, image_2=None, image_3=None, image_4=None, less=None, name=None, oauth=None, phr_default_events=None, phr_permissions=None, safari_instruction_1=None, safari_instruction_2=None, safari_instruction_3=None, safari_instruction_4=None, safari_instruction_5=None, saml=None, saml_redirect_url=None, session_expire=None, settings=None, ssi_js=None, support_html=None, svg_1=None, svg_2=None, ui_json=None, uploader_icon=None, uploader_logo=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Brand.
-
anonymous_permissions¶ String(The permissions over-ride as a json structure)
-
anonymous_session_expire¶ Integer(Minutes before an idle session expires)
-
cd_multi¶ String(The branding elements)
-
cd_single¶ String(The branding elements)
-
cd_viewer_settings¶ String(The branding elements)
-
cluster_id¶ String(FK. The cluster associated with the brand)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
css¶ String(The branding elements)
-
id¶ Integer(Primary key for internal use)
-
image_1¶ String(The branding elements)
-
image_2¶ String(The branding elements)
-
image_3¶ String(The branding elements)
-
image_4¶ String(The branding elements)
-
less¶ String(The branding elements)
-
name¶ String(Name for the brand)
-
oauth¶ String(OAuth information)
-
phr_default_events¶ String(The events over-ride as a json structure)
-
phr_permissions¶ String(The permissions over-ride as a json structure)
-
safari_instruction_1¶ String(The branding elements)
-
safari_instruction_2¶ String(The branding elements)
-
safari_instruction_3¶ String(The branding elements)
-
safari_instruction_4¶ String(The branding elements)
-
safari_instruction_5¶ String(The branding elements)
-
saml¶ DictField(Native SAML information)
-
saml_redirect_url¶ String(PingOne SAML info)
-
session_expire¶ Integer(Minutes before an idle session expires)
-
settings¶ DictField(Brand settings)
-
ssi_js¶ String(The branding elements)
-
support_html¶ String(The branding elements)
-
svg_1¶ String(The branding elements)
-
svg_2¶ String(The branding elements)
-
ui_json¶ String(The branding elements)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uploader_icon¶ String(The branding elements)
-
uploader_logo¶ String(The branding elements)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.BrandNamespace(*, id=None, uuid=None, brand_id=None, brand=None, namespace_id=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ BrandNamespace.
-
brand_id¶ String(FK. )
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
namespace_id¶ String()
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.BrandVanity(*, id=None, uuid=None, brand_id=None, brand=None, vanity=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ BrandVanity.
-
brand_id¶ String(FK. )
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
vanity¶ String()
-
-
class
ambra_sdk.models.generated.Case(*, id=None, uuid=None, account_id=None, account=None, assigned_admin_date=None, assigned_admin_id=None, assigned_admin=None, assigned_medical_date=None, assigned_medical_id=None, assigned_medical=None, case_status=None, case_status_date=None, closed=None, closed_date=None, completed=None, completed_date=None, customfields=None, name=None, namespace_id=None, namespace=None, returned_date=None, returned_reason=None, study_charge_id=None, submitted=None, submitted_date=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Case.
-
account_id¶ String(FK. The associated account)
-
assigned_admin_date¶ DateTime(The admin assigned to the case)
-
assigned_admin_id¶ String(FK. The admin assigned to the case)
-
assigned_medical_date¶ DateTime(The medical person assigned to the case)
-
assigned_medical_id¶ String(FK. The medical person assigned to the case)
-
case_status¶ String(The status of the case and the date of the last change)
-
case_status_date¶ DateTime(The status of the case and the date of the last change)
-
closed¶ Boolean(The case is closed)
-
closed_date¶ DateTime(The case is closed)
-
completed¶ Boolean(The case is completed)
-
completed_date¶ DateTime(The case is completed)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
customfields¶ DictField(Custom fields)
-
id¶ Integer(Primary key for internal use)
-
name¶ String(Basic information)
-
namespace_id¶ String(FK. The namespace the case is in)
-
returned_date¶ DateTime(The returned date and reason)
-
returned_reason¶ String(The returned date and reason)
-
study_charge_id¶ String(FK. Payment for the case)
-
submitted¶ Boolean(The case is submitted)
-
submitted_date¶ DateTime(The case is submitted)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. The user the case is for)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.CaseStatusLock(*, id=None, uuid=None, case_id=None, case=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ CaseStatusLock.
-
case_id¶ String(FK. The case and user id)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. The case and user id)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.CaseStudy(*, id=None, uuid=None, case_id=None, case=None, storage_namespace=None, storage_namespace_obj=None, study_uid=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ CaseStudy.
-
case_id¶ String(FK. )
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
storage_namespace¶ String(FK. )
-
study_uid¶ String()
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Cluster(*, id=None, uuid=None, archive=None, archive_cluster_id=None, archive_cluster=None, backup_cluster_id=None, backup_cluster=None, copies=None, is_default=None, is_load_balanced=None, max_days=None, name=None, rsync=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Cluster.
-
archive¶ Boolean(Is this an archive cluster)
-
archive_cluster¶ Model descriptor.
-
archive_cluster_id¶ String(FK. Id of the archive cluster this should be backed up to)
-
backup_cluster¶ Model descriptor.
-
backup_cluster_id¶ String(FK. Id of the backup cluster this should be backed up to)
-
copies¶ Integer(Number of copies in the cluster)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
is_default¶ Boolean(This is the default cluster)
-
is_load_balanced¶ Boolean(This is a load balanced cluster)
-
max_days¶ Integer(Max days studies should stay in the cluster)
-
name¶ String(Name for the cluster)
-
rsync¶ Boolean(Is this a rsync cluster)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.ClusterAccount(*, id=None, uuid=None, account_id=None, account=None, cluster_id=None, cluster=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ ClusterAccount.
-
account_id¶ String(FK. Id of the cluster and account)
-
cluster_id¶ String(FK. Id of the cluster and account)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.ClusterNamespace(*, id=None, uuid=None, cluster_id=None, cluster=None, namespace_id=None, namespace=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ ClusterNamespace.
-
cluster_id¶ String(FK. Id of the cluster and account)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
namespace_id¶ String(FK. Id of the cluster and account)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Customcode(*, id=None, uuid=None, account_id=None, account=None, code=None, has_zip=None, language=None, name=None, settings=None, type_field=None, zip=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Customcode.
-
account_id¶ String(FK. The account)
-
code¶ String(The code)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
has_zip¶ Boolean(Associated zip file)
-
id¶ Integer(Primary key for internal use)
-
language¶ String(Type of code and the language)
-
name¶ String(Basic information)
-
settings¶ JsonB(The settings)
-
type_field¶ String(Type of code and the language)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
zip¶ String(Associated zip file)
-
-
class
ambra_sdk.models.generated.CustomcodeDeploy(*, id=None, uuid=None, account_id=None, account=None, customcode_id=None, customcode=None, namespace_id=None, namespace=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ CustomcodeDeploy.
-
account_id¶ String(FK. Deployment information)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
customcode¶ alias of
Customcode
-
customcode_id¶ String(FK. Deployment information)
-
id¶ Integer(Primary key for internal use)
-
namespace_id¶ String(FK. Deployment information)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Customfield(*, id=None, uuid=None, account_id=None, account=None, 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, has_macro=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, object=None, options=None, other_customfield_id=None, other_customfield=None, other_customfield_no_overwrite_with_blank=None, other_customfield_no_refresh_on_reshare=None, other_dicom_tags=None, required=None, type_field=None, wrapped_dicom_only=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Customfield.
-
account_id¶ String(FK. Associated object and account)
-
capture_on_destination_search¶ Boolean(Settings)
Boolean(Settings)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
dicom_only¶ Boolean(Settings)
-
dicom_tag¶ String(Map to this DICOM tag in storage)
-
dicom_tag_ignore_empty¶ Boolean(Do not do the DICOM tag mapping if the field is empty)
-
display_order¶ Integer(Order the fields should be displayed in)
-
field_flag¶ String(Custom field visibility flag)
-
has_macro¶ Boolean(Flag if the values has a macro that needs expansion)
-
hl7_component¶ Integer(HL7 options)
-
hl7_field¶ Integer(HL7 options)
-
hl7_segment¶ String(HL7 options)
-
id¶ Integer(Primary key for internal use)
-
load_dicom_tag¶ Boolean(Load the DICOM tag from storage)
-
load_from_sr¶ String(Load the value from the SR)
-
load_hl7¶ String(HL7 options)
-
load_hl7_filter¶ String(HL7 options)
-
load_order¶ Boolean(Map to other object's customfield)
-
name¶ String(Name and type of the field)
-
object¶ String(Associated object and account)
-
options¶ String(Settings)
-
other_customfield¶ alias of
Customfield
-
other_customfield_id¶ String(FK. Map to other object's customfield)
-
other_customfield_no_overwrite_with_blank¶ Boolean(Map to other object's customfield)
Boolean(Map to other object's customfield)
String(An array of other DICOM tags to map to in storage)
-
required¶ Boolean(Settings)
-
type_field¶ String(Name and type of the field)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
wrapped_dicom_only¶ Boolean(Settings)
-
-
class
ambra_sdk.models.generated.CustomfieldMapping(*, id=None, uuid=None, from_customfield_id=None, from_customfield=None, overwrite_with_blank=None, refresh_on_edit=None, refresh_on_reshare=None, reverse_refresh_on_edit=None, to_customfield_id=None, to_customfield=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ CustomfieldMapping.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
from_customfield¶ alias of
Customfield
-
from_customfield_id¶ String(FK. The source customfield)
-
id¶ Integer(Primary key for internal use)
-
overwrite_with_blank¶ Boolean(The mapping options)
-
refresh_on_edit¶ Boolean(The mapping options)
Boolean(The mapping options)
-
reverse_refresh_on_edit¶ Boolean(The mapping options)
-
to_customfield¶ alias of
Customfield
-
to_customfield_id¶ String(FK. The destination customfield)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.DatabaseScripts(*, id=None, name=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ DatabaseScripts.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
name¶ String(Name of the script that was run)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
-
class
ambra_sdk.models.generated.Destination(*, id=None, uuid=None, account_id=None, account=None, address=None, aetitle=None, c_echo_interval=None, c_echo_schedule=None, can_push_hl7=None, can_query_retrieve=None, can_retrieve_thin=None, can_search=None, can_search_mwl=None, cd_burn_info=None, cd_burn_name=None, cd_burn_priority=None, default_query_retrieve_level=None, fire_webhooks=None, gateway_settings=None, global_field=None, hl7_address=None, hl7_fetch_filter=None, hl7_port=None, linked_destination=None, linked_destination_obj=None, linked_qr_activity_in_referred_account=None, linked_qr_to_referred_account=None, manual_push_roles=None, name=None, node_id=None, node=None, path=None, port=None, push_related_studies=None, sort_order=None, sqlch_psh_if_img_unchg=None, sqlch_psh_if_route_hl7=None, type_field=None, ui_json=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Destination.
-
account_id¶ String(FK. The associated account)
-
address¶ String(DICOM Address and port of the destination)
-
aetitle¶ String(AEtitle)
-
c_echo_interval¶ Integer(Do a c echo of the destination every c_echo_interval seconds)
-
c_echo_schedule¶ String(The c echo schedule)
-
can_push_hl7¶ Boolean(Flags for destination capabilities)
-
can_query_retrieve¶ Boolean(Flags for destination capabilities)
-
can_retrieve_thin¶ Boolean(Flags for destination capabilities)
-
can_search¶ Boolean(Flags for destination capabilities)
-
can_search_mwl¶ Boolean(Flags for destination capabilities)
-
cd_burn_info¶ String(The CD burner information)
-
cd_burn_name¶ String(The CD burner information)
-
cd_burn_priority¶ Integer(The CD burner information)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
default_query_retrieve_level¶ String(How the query retrieve should be done)
-
fire_webhooks¶ Boolean(Fire webhooks for this destination)
-
gateway_settings¶ String(Gateway stores settings and data here)
-
global_field¶ Boolean(Is it a global accelerator destination)
-
hl7_address¶ String(HL7 ORM destination address and port)
-
hl7_fetch_filter¶ String(Fetch filter)
-
hl7_port¶ Integer(HL7 ORM destination address and port)
-
id¶ Integer(Primary key for internal use)
-
linked_destination¶ String(FK. The id of the linked destination)
-
linked_destination_obj¶ alias of
Destination
-
linked_qr_activity_in_referred_account¶ Boolean(Create search activity in the referred account instead of the linked destination's account)
-
linked_qr_to_referred_account¶ Boolean(Create result studies in the referred account instead of the linked destination's account)
-
manual_push_roles¶ String(Comma separated list of role uuids allowed to push manually)
-
name¶ String(Name)
-
node_id¶ String(FK. The associated node)
-
path¶ String(Path for a FOLDER destination)
-
port¶ Integer(DICOM Address and port of the destination)
Boolean(Push all related studies in the namespace when a study is pushed)
-
sort_order¶ Integer(Sort order)
-
sqlch_psh_if_img_unchg¶ Boolean(Flag if destination should squelch re-pushes if the image count has not changed)
-
sqlch_psh_if_route_hl7¶ Boolean(Flag if destination should squelch pushes that are generated by HL7 based routing)
-
type_field¶ String(Type of destination can be either a DICOM, FOLDER, LINKED, DISTRIBUTING, ACCELERATOR or BURNER)
-
ui_json¶ String(JSON for UI settings)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.DestinationBurn(*, id=None, uuid=None, batch_no=None, destination_id=None, destination=None, metrics=None, node_id=None, node=None, patientid=None, pickup=None, status=None, status_reason=None, study_h=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ DestinationBurn.
-
batch_no¶ String(Batch no)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
destination¶ alias of
Destination
-
destination_id¶ String(FK. The destination)
-
id¶ Integer(Primary key for internal use)
-
metrics¶ DictField(The metrics hash)
-
node_id¶ String(FK. The node to use)
-
patientid¶ String(The patient id)
-
pickup¶ DateTime(When was this picked up by the node)
-
status¶ String(Status of the delivery)
-
status_reason¶ String(Status of the delivery)
-
study_h¶ DictField(The hash of studies to burn)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.DestinationDistributed(*, id=None, uuid=None, child_id=None, child=None, parent_id=None, parent=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ DestinationDistributed.
-
child¶ alias of
DestinationDistributed
-
child_id¶ String(FK. The DICOM destination)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
parent¶ alias of
DestinationDistributed
-
parent_id¶ String(FK. The distributing destination)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.DestinationSearch(*, id=None, uuid=None, anonymize=None, asked_by=None, asked_by_obj=None, asking_node=None, asking_node_obj=None, bundle_id=None, copy_to=None, copy_to_obj=None, count=None, create_study=None, create_thin=None, destination_id=None, destination=None, distributing_destination_id=None, distributing_destination=None, extra=None, gateway_anonymization=None, hl7_id=None, hl7=None, linked_destination_id=None, linked_destination=None, message=None, node_id=None, node=None, payload=None, pickup=None, push_to=None, push_to_obj=None, refetch_study=None, results=None, share_email=None, sid=None, status=None, study_id=None, study=None, study_request_id=None, study_request=None, tracking_number=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ DestinationSearch.
-
anonymize¶ String(The associated anonymization rules)
-
asked_by¶ String(FK. This is the id of the destination search that requested the asking_node search)
-
asking_node¶ String(FK. Pass the results of this back to this node)
-
bundle_id¶ Integer(Bundle operation link. Index needed for summarizing bundled searches)
-
copy_to¶ String(FK. Namespace to copy any retrieved or thin studies into)
-
count¶ Integer(Status of the search)
-
create_study¶ Integer(Number of studies or thin studies to create from the search rather than creating an activity)
-
create_thin¶ Integer(Number of studies or thin studies to create from the search rather than creating an activity)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
destination¶ alias of
Destination
-
destination_id¶ String(FK. The destination to search)
-
distributing_destination¶ alias of
DestinationDistributed
-
distributing_destination_id¶ String(FK. The distributing destination that initiated the search)
-
extra¶ String(Extra data for speciality workflows like MPI)
-
gateway_anonymization¶ Integer(Flag to run anonymization on the gateway side)
-
hl7_id¶ String(FK. The search was triggered by this HL7 message)
-
id¶ Integer(Primary key for internal use)
-
linked_destination¶ alias of
Destination
-
linked_destination_id¶ String(FK. The linked destination that initiated the search)
-
message¶ String(Message. Depreciated. To be deleted after 2021-04 release)
-
node_id¶ String(FK. The node to use)
-
payload¶ String(The search payload)
-
pickup¶ DateTime(When was this picked up by the node)
-
push_to¶ String(FK. Destination to push any retrieved studies to)
-
push_to_obj¶ alias of
Destination
-
refetch_study¶ Boolean(Flag to refetch existing studies with the results)
-
results¶ String(The search results)
String(Email to share retrieved studies with)
-
sid¶ String(SID where the search originated from)
-
status¶ String(Status of the search)
-
study_id¶ String(FK. Study id if this is a MWL search)
-
study_request¶ alias of
StudyRequest
-
study_request_id¶ String(FK. Study request that initiated the search)
-
tracking_number¶ String(Tracking number)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. The user who ran the search)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Dicomdata(*, id=None, uuid=None, customfields=None, dicom_tags=None, instance_uid=None, phi_namespace=None, phi_namespace_obj=None, series_uid=None, storage_namespace=None, storage_namespace_obj=None, study_id=None, study=None, study_uid=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Dicomdata.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
customfields¶ DictField(Custom fields)
DictField(The tags as a hstore)
-
id¶ Integer(Primary key for internal use)
-
instance_uid¶ String(The series and image identification)
-
phi_namespace¶ String(FK. Associated study)
-
series_uid¶ String(The series and image identification)
-
storage_namespace¶ String(FK. Associated study)
-
study_id¶ String(FK. Associated study)
-
study_uid¶ String(Associated study)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Dictionary(*, id=None, uuid=None, account_id=None, account=None, case_sensitive=None, lookup=None, name=None, object=None, replace=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Dictionary.
-
account_id¶ String(FK. Name and account)
-
case_sensitive¶ Boolean(Settings)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
lookup¶ String(JSON array of the fields names to lookup on)
-
name¶ String(Name and account)
-
object¶ String(Type of object the dictionary runs against)
-
replace¶ String(JSON array of the fields names to replace)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.DictionaryAttach(*, id=None, uuid=None, account_id=None, account=None, add_if_no_match=None, approve_if_match=None, delay=None, dictionary_id=None, dictionary=None, global_counter=None, namespace_id=None, namespace=None, run_once=None, sequence=None, skip_if_lookup_unchanged=None, skip_if_replace_has_value=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ DictionaryAttach.
-
account_id¶ String(FK. The attachment is either to an account or a namespace)
-
add_if_no_match¶ Boolean(Options)
-
approve_if_match¶ Boolean(Options)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
delay¶ Integer(Options)
-
dictionary¶ alias of
Dictionary
-
dictionary_id¶ String(FK. Associated dictionary)
-
global_counter¶ Boolean(Options)
-
id¶ Integer(Primary key for internal use)
-
namespace_id¶ String(FK. The attachment is either to an account or a namespace)
-
run_once¶ Boolean(Options)
-
sequence¶ Integer(The sequence to order by)
-
skip_if_lookup_unchanged¶ Boolean(Options)
-
skip_if_replace_has_value¶ Boolean(Options)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.DictionaryEntry(*, id=None, uuid=None, dictionary_id=None, dictionary=None, lookup=None, md5=None, regexp=None, replace=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ DictionaryEntry.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
dictionary¶ alias of
Dictionary
-
dictionary_id¶ String(FK. Associated dictionary)
-
id¶ Integer(Primary key for internal use)
-
lookup¶ String(JSON array or regexp of the lookup value)
-
md5¶ String(MD5 of the record)
-
regexp¶ Boolean(Is this a regexp)
-
replace¶ String(JSON array of the replace values)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.DictionaryRun(*, id=None, uuid=None, delay=None, dictionary_attach_id=None, dictionary_attach=None, object_id=None, succeeded=None, created=None, created_by=None, created_by_obj=None)[source]¶ DictionaryRun.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
delay¶ Integer(Used to kick stuck jobs. Depreciated, should be removed after 2021-11-03)
-
dictionary_attach¶ alias of
DictionaryAttach
-
dictionary_attach_id¶ String(FK. Associated dictionary)
-
id¶ Integer(Primary key for internal use)
-
object_id¶ Integer(The object this dict was applied to)
-
succeeded¶ Boolean(Used to kick stuck jobs. Depreciated, should be removed after 2021-11-03)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Drchrono(*, id=None, uuid=None, account_id=None, account=None, doctor=None, refresh_token=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Drchrono.
-
account_id¶ String(FK. Associated account)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
doctor¶ String(Doctor id on drchrono)
-
id¶ Integer(Primary key for internal use)
-
refresh_token¶ String(Refresh token)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. Associated user)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Engine(*, id=None, uuid=None, cluster_id=None, cluster=None, fqdn=None, free_disk_space=None, ghc_info=None, host_map=None, idle_storage_host=None, is_full=None, is_offline=None, magic_sid=None, max_pull_jobs=None, max_push_jobs=None, no_backup=None, no_phi=None, no_purge=None, services_url=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Engine.
-
cluster_id¶ String(FK. The cluster it is in)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
fqdn¶ String(The fully qualified domain name of the storage engine)
-
free_disk_space¶ Integer(The free disk space threshold)
-
ghc_info¶ String(The Google healthcare information)
-
host_map¶ String(The host map JSON)
-
id¶ Integer(Primary key for internal use)
-
idle_storage_host¶ String(The URL services should for archiving activity)
-
is_full¶ Boolean(Flag if the engine is full or offline)
-
is_offline¶ Boolean(Flag if the engine is full or offline)
-
magic_sid¶ String(The magic sid for the storage engine)
-
max_pull_jobs¶ Integer(The max number of pull jobs to run on the engine at one time)
-
max_push_jobs¶ Integer(The max number of push jobs to run on the engine at one time)
-
no_backup¶ Boolean(Turn off backups for this engine)
-
no_phi¶ Boolean(No PHI is stored on this engine)
-
no_purge¶ Boolean(Exclude studies on this engine from all purges)
-
services_url¶ String(The URL services should use to access the storage engine)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Filter(*, id=None, uuid=None, account_id=None, account=None, configuration=None, name=None, namespace_id=None, namespace=None, tier_path=None, type_field=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Filter.
-
account_id¶ String(FK. The associated account)
-
configuration¶ String(The configuration as a json structure)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
name¶ String(Name)
-
namespace_id¶ String(FK. the phi namespace id)
-
tier_path¶ String(For tiered filters, the path)
-
type_field¶ String(The type of the filter)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. The user)
-
uuid¶ String(UUID for external use)
-
FilterShare.
alias of
Account
String(FK. Who it is shared with)
DateTime(Timestamp when the record was created)
String(FK. ID of the user who created the record)
alias of
User
alias of
Filter
String(FK. Primary key for internal use)
alias of
Group
String(FK. Who it is shared with)
Integer(Primary key for internal use)
alias of
Location
String(FK. Who it is shared with)
alias of
Role
String(FK. Who it is shared with)
DateTime(Timestamp when the record was last updated)
String(FK. ID of the user who updated the record)
alias of
User
alias of
User
String(FK. Who it is shared with)
-
class
ambra_sdk.models.generated.FilterTier(*, id=None, ancestor_id=None, ancestor=None, depth=None, descendant_id=None, descendant=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ FilterTier.
-
ancestor¶ Model descriptor.
-
ancestor_id¶ String(FK. Primary key for internal use)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
depth¶ Integer(Primary key for internal use)
-
descendant¶ Model descriptor.
-
descendant_id¶ String(FK. Primary key for internal use)
-
id¶ Integer(Primary key for internal use)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
-
class
ambra_sdk.models.generated.Group(*, id=None, uuid=None, account_id=None, account=None, customfields=None, name=None, namespace_id=None, namespace=None, role_id=None, role=None, site_id=None, site=None, site_inactive=None, site_qualified=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Group.
-
account_id¶ String(FK. The associated account)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
customfields¶ DictField(Custom fields)
-
id¶ Integer(Primary key for internal use)
-
name¶ String(Name)
-
namespace_id¶ String(FK. The namespace)
-
role_id¶ String(FK. Default role id)
-
site_id¶ String(FK. Associated trial site)
-
site_inactive¶ Boolean(Inactive flag to deactivate a group in a Trial Account)
-
site_qualified¶ Boolean(Associated trial site)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Help(*, id=None, uuid=None, key=None, text=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Help.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
key¶ String(Help key)
-
text¶ String(The help text)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Hl7(*, id=None, uuid=None, accession_number_h=None, account_id=None, account=None, md5=None, message=None, node_id=None, node=None, patient_name=None, patientid=None, type_field=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Hl7.
-
accession_number_h¶ DictField(KV storage of all the accession numbers in the message)
-
account_id¶ String(FK. Account the message is for)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
md5¶ String(md5 hash of the message)
-
message¶ String(The message data)
-
node_id¶ String(FK. Node that sent the message)
-
patient_name¶ String(Patient Name)
-
patientid¶ String(Patient MRN)
-
type_field¶ String(Type of message)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Hl7Accession(*, id=None, accession_number=None, account_id=None, account=None, hl7_id=None, hl7=None, study_id=None, study=None, type_field=None, created=None)[source]¶ Hl7Accession.
-
accession_number¶ String(Accession number)
-
account_id¶ String(FK. Account)
-
created¶ DateTime(Timestamp when the record was created)
-
hl7_id¶ String(FK. Message)
-
id¶ Integer(Primary key for internal use)
-
study_id¶ String(FK. Id of the study an order was associated with by the /study/find/order functionality)
-
type_field¶ String(Type of message)
-
-
class
ambra_sdk.models.generated.Hl7Template(*, id=None, uuid=None, account_id=None, account=None, body=None, name=None, type_field=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Hl7Template.
-
account_id¶ String(FK. The associated account)
-
body¶ String(Type of message)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
name¶ String(Name)
-
type_field¶ String(Type of message)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Hl7Transform(*, id=None, uuid=None, account_id=None, account=None, conditions=None, name=None, order_by=None, replacements=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Hl7Transform.
-
account_id¶ String(FK. The associated account)
-
conditions¶ String()
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
name¶ String(Name)
-
order_by¶ Integer()
-
replacements¶ String()
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Keyimage(*, id=None, uuid=None, frame_number=None, instance_uid=None, series_uid=None, study_id=None, study=None, user_id=None, user=None, version=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Keyimage.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
frame_number¶ String(The frame identification)
-
id¶ Integer(Primary key for internal use)
-
instance_uid¶ String(The frame identification)
-
series_uid¶ String(The frame identification)
-
study_id¶ String(FK. Associated study)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. User who created the annotation)
-
uuid¶ String(UUID for external use)
-
version¶ String(The frame identification)
-
-
class
ambra_sdk.models.generated.Link(*, id=None, uuid=None, acceptance_required=None, account_id=None, account=None, action=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, message=None, mfm_page=None, minutes_alive=None, mobile_phone=None, namespace_id=None, namespace=None, notify=None, parameters=None, password=None, password_is_dob=None, password_max_attempts=None, pin_auth=None, prompt_for_anonymize=None, referer=None, share_code=None, share_on_view=None, skip_email_prompt=None, study_id=None, study=None, ui_json=None, upload_match=None, upload_study_customfields=None, use_share_code=None, user_id=None, user=None, workflow=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Link.
-
acceptance_required¶ Boolean(Is acceptance of the study required)
-
account_id¶ String(FK. The associated account)
-
action¶ String(Action to take on the link. This can either be view, list or upload)
-
anonymize¶ String(Anonymization rules to be applied to studies uploaded via this link)
-
charge_amount¶ Integer(Charge amount in pennies)
-
charge_currency¶ String(Charge amount in pennies)
-
charge_description¶ String(Charge amount in pennies)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
email¶ String(Email address, any additional message and other notification emails to send the link to)
-
filter¶ String(The study the link is for or the filter expression or the namespace for an upload action)
-
id¶ Integer(Primary key for internal use)
-
include_priors¶ Boolean(Include priors)
-
inherit_permissions¶ Boolean(Should the anon session inherit link owner's permissions)
-
max_hits¶ Integer(The maximum number of times the link can be used)
-
message¶ String(Mobile phone used to send additional message to)
-
mfm_page¶ Boolean(Should they go to the MFM page)
-
minutes_alive¶ Integer(The number of minutes the link will be alive for)
-
mobile_phone¶ String(Mobile phone used to send additional message to)
-
namespace_id¶ String(FK. The study the link is for or the filter expression or the namespace for an upload action)
-
notify¶ String(Mobile phone used to send additional message to)
-
parameters¶ String(Optional parameter to include on the link)
-
password¶ String(Password to access link)
-
password_is_dob¶ Boolean(The password is the study DOB)
-
password_max_attempts¶ Integer(Max number of failed password attempts on the link)
-
pin_auth¶ Boolean(The email must be an account member and PIN auth is required)
-
prompt_for_anonymize¶ Boolean(Anonymization rules to be applied to studies uploaded via this link)
-
referer¶ String(The referer for the link)
String(Share code for the link)
Boolean(Share the study after it is viewed)
-
skip_email_prompt¶ Boolean(Skip ask for the email)
-
study_id¶ String(FK. The study the link is for or the filter expression or the namespace for an upload action)
-
ui_json¶ String(JSON for UI settings)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
upload_match¶ String(Must match rules for uploads)
-
upload_study_customfields¶ DictField(Study custom fields for STUDY_UPLOAD)
Boolean(Use the namespace share code information for uploads)
-
user_id¶ String(FK. The user who created the link. Any filter is applied in this users context as well)
-
uuid¶ String(UUID for external use)
-
workflow¶ String(Workflow this link is involved in. Possible values epic_upload, patient_studies)
-
-
class
ambra_sdk.models.generated.LinkCharge(*, id=None, uuid=None, account_id=None, account=None, charge_amount=None, link_id=None, link=None, processor=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ LinkCharge.
-
account_id¶ String(FK. Link and account id)
-
charge_amount¶ Integer(The charge amount)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
link_id¶ String(FK. Link and account id)
-
processor¶ String(The processor information)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.LinkUsage(*, id=None, uuid=None, account_id=None, account=None, client_address=None, client_email=None, context_user_id=None, context_user=None, extra=None, link_id=None, link=None, sid=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ LinkUsage.
-
account_id¶ String(FK. Link and account id)
-
client_address¶ String(Address that used the link)
-
client_email¶ String(Address that used the link)
-
context_user_id¶ String(FK. An account user id used to pull the user's preferences)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
extra¶ String(Any extra analytical data to store with the link)
-
id¶ Integer(Primary key for internal use)
-
link_id¶ String(FK. Link and account id)
-
sid¶ String(Sid of the session)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Location(*, id=None, uuid=None, account_id=None, account=None, customfields=None, name=None, namespace_id=None, namespace=None, role_id=None, role=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Location.
-
account_id¶ String(FK. The associated account)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
customfields¶ DictField(Custom fields)
-
id¶ Integer(Primary key for internal use)
-
name¶ String(Name)
-
namespace_id¶ String(FK. The namespace)
-
role_id¶ String(FK. Default role id)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.MailTemplate(*, id=None, uuid=None, account_id=None, account=None, bcc=None, cc=None, delay=None, filter_field=None, filter_regexp=None, from_email_address=None, from_email_name=None, html=None, namespace_id=None, namespace=None, reply_to_email_address=None, sms=None, squelch_period=None, txt=None, type_field=None, vanity=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ MailTemplate.
-
account_id¶ String(FK. Account the template is for)
-
bcc¶ String(Email addresses)
-
cc¶ String(Email addresses)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
delay¶ Integer(Number of seconds to delay sending the mail for)
-
filter_field¶ String(Filter field and regexp)
-
filter_regexp¶ String(Filter field and regexp)
-
from_email_address¶ String(Email addresses)
-
from_email_name¶ String(Email addresses)
-
html¶ String(Templates)
-
id¶ Integer(Primary key for internal use)
-
namespace_id¶ String(FK. Scope it down to a namespace or vanity)
-
reply_to_email_address¶ String(Email addresses)
-
sms¶ String(Templates)
-
squelch_period¶ Integer(Number of seconds to squelch sending the mail for for a given template and a study)
-
txt¶ String(Templates)
-
type_field¶ String(Tmpl type)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
vanity¶ String(Scope it down to a namespace or vanity)
-
-
class
ambra_sdk.models.generated.Meeting(*, id=None, uuid=None, link_id=None, link=None, name=None, state=None, study_id=None, study=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Meeting.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
link_id¶ String(FK. Associated link)
-
name¶ String(Name of the meeting)
-
state¶ String(Current state data structure)
-
study_id¶ String(FK. Associated study)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. User who created the meeting)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.MeetingUser(*, id=None, uuid=None, meeting_id=None, meeting=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ MeetingUser.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
meeting_id¶ String(FK. )
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. )
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Message(*, id=None, uuid=None, account_id=None, account=None, body=None, namespace_id=None, namespace=None, parent_id=None, parent=None, query_id=None, query=None, study_id=None, study=None, study_request_id=None, study_request=None, study_request_namespace_id=None, study_request_namespace=None, study_uid=None, subject=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Message.
-
account_id¶ String(FK. The account of a study for study messages)
-
body¶ String(Body of the message)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
namespace_id¶ String(FK. The namespace the message is for)
-
parent_id¶ String(FK. The parent message)
-
query_id¶ String(FK. The linked query object)
-
study_id¶ String(FK. The study the message is for)
-
study_request¶ alias of
StudyRequest
-
study_request_id¶ String(FK. The study request the message is for)
-
study_request_namespace_id¶ String(FK. The destination namespace of the study request the message is for)
-
study_uid¶ String(The study UID the message is for)
-
subject¶ String(Subject)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. The user who sent the message)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Namespace(*, id=None, uuid=None, accelerator_id=None, accelerator=None, account_id=None, account=None, anonymization_id=None, anonymization=None, anonymize=None, archive_vault_id=None, archive_vault=None, cache=None, charge_description=None, coverpage=None, currency=None, 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, group_id=None, group=None, harvest_hold=None, hl7_template=None, linkage_name=None, location_id=None, location=None, must_approve=None, must_approve_harvest=None, must_approve_move=None, must_approve_upload=None, no_bill=None, no_cluster_archive=None, no_share=None, prompt_for_anonymize=None, search_threshold=None, second_opinion_config=None, second_opinion_share=None, settings=None, share_charge_by_modality=None, share_code=None, share_customfields_pricing=None, share_description=None, share_pricing=None, share_settings=None, share_via_gateway=None, study_defaults=None, sum_price_matches=None, upload_hold=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Namespace.
-
accelerator¶ alias of
Accelerator
-
accelerator_id¶ String(FK. Global accelerator it is attached too)
-
account_id¶ String(FK. Who it is linked to)
-
anonymization¶ Model descriptor.
-
anonymization_id¶ String(FK. Anonymization rules)
-
anonymize¶ String(Anonymization rules)
-
archive_vault¶ Model descriptor.
-
archive_vault_id¶ String(FK. The vault to archive studies too)
-
cache¶ Boolean(Cache new studies image)
-
charge_description¶ String(Charging information)
-
coverpage¶ String(Cover page template)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
currency¶ String(Charging information)
-
event_approve¶ Boolean(The default event settings flags)
-
event_case_assignment¶ Boolean(The default event settings flags)
-
event_harvest¶ Boolean(The default event settings flags)
-
event_incoming_study_request¶ Boolean(The default event settings flags)
-
event_link¶ Boolean(The default event settings flags)
-
event_link_mine¶ Boolean(The default event settings flags)
-
event_message¶ Boolean(The default event settings flags)
-
event_new_report¶ Boolean(The default event settings flags)
-
event_node¶ Boolean(The default event settings flags)
-
event_query_add¶ Boolean(The default event settings flags)
-
event_query_edit¶ Boolean(The default event settings flags)
-
event_query_reply¶ Boolean(The default event settings flags)
-
event_report_remove¶ Boolean(The default event settings flags)
Boolean(The default event settings flags)
-
event_site_qualified¶ Boolean(The default event settings flags)
-
event_status_change¶ Boolean(The default event settings flags)
-
event_study_comment¶ Boolean(The default event settings flags)
-
event_thin_study_fail¶ Boolean(The default event settings flags)
-
event_thin_study_success¶ Boolean(The default event settings flags)
-
event_upload¶ Boolean(The default event settings flags)
-
event_upload_fail¶ Boolean(The default event settings flags)
-
group_id¶ String(FK. Who it is linked to)
-
harvest_hold¶ Integer(Storage settings)
-
hl7_template¶ String(HL7 template for the namespace)
-
id¶ Integer(Primary key for internal use)
-
linkage_name¶ String(Name of the linked object for sorting purposes)
-
location_id¶ String(FK. Who it is linked to)
-
must_approve¶ Boolean(Flag if study approval for a share is needed)
-
must_approve_harvest¶ Boolean(Flag if study approval for a harvest is needed)
-
must_approve_move¶ Boolean(Flag if study approval for a move is needed)
-
must_approve_upload¶ Boolean(Flag if study approval for a upload is needed)
-
no_bill¶ Boolean(Do not bill this namespace)
-
no_cluster_archive¶ Boolean(Storage settings)
Boolean(Flag if this namespace can not be shared into)
-
prompt_for_anonymize¶ Boolean(Anonymization rules)
-
search_threshold¶ Integer(The UI search threshold)
-
second_opinion_config¶ String(Second opinion settings)
Boolean(Second opinion settings)
-
settings¶ DictField(Namespace settings)
Boolean(Charging information)
String(Share code for the name space)
String(Charging information)
String(Share code for the name space)
String(Charging information)
String(Share code for the name space)
Boolean(Allow gateway uploads to the share code)
-
study_defaults¶ String(Study defaults)
-
sum_price_matches¶ Boolean(Charging information)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
upload_hold¶ Integer(Storage settings)
-
user_id¶ String(FK. Who it is linked to)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.NamespaceChildren(*, id=None, uuid=None, account_id=None, account=None, child_id=None, child=None, fields=None, namespace_id=None, namespace=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ NamespaceChildren.
-
account_id¶ String(FK. Account the namespaces are in)
-
child¶ Model descriptor.
-
child_id¶ String(FK. Child namespace)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
fields¶ String(JSON list of the fields)
-
id¶ Integer(Primary key for internal use)
-
namespace_id¶ String(FK. Parent namespace)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Node(*, id=None, uuid=None, accelerator_id=None, accelerator=None, account_id=None, account=None, category=None, configuration_h=None, ctc_bucket=None, facility_contact=None, facility_contact_title=None, facility_email=None, facility_name=None, facility_notes=None, facility_state=None, facility_zip=None, global_field=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, namespace_id=None, namespace=None, os_type=None, performance_data=None, reload_configuration=None, serial_no=None, settings=None, type_field=None, user_id=None, user=None, warning_email=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Node.
-
accelerator¶ alias of
Accelerator
-
accelerator_id¶ String(FK. The associated accelerator)
-
account_id¶ String(FK. The associated account)
-
category¶ String(Category and searchability)
-
configuration_h¶ DictField(The configuration hash)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
ctc_bucket¶ String(Category and searchability)
-
facility_contact¶ String(Facility information)
-
facility_contact_title¶ String(Facility information)
-
facility_email¶ String(Facility information)
-
facility_name¶ String(Facility information)
-
facility_notes¶ String(Facility information)
-
facility_state¶ String(Facility information)
-
facility_zip¶ String(Facility information)
-
global_field¶ Boolean(Is it a global accelerator destination)
-
id¶ Integer(Primary key for internal use)
-
is_public¶ Boolean(Category and searchability)
-
monitor_email¶ String(Monitoring flags)
-
monitor_node_last_send¶ Boolean(Monitoring flags)
-
monitor_node_last_send_threshold¶ Integer(Number of minutes as the threshold for firing the notification)
-
monitor_node_ping¶ Boolean(Monitoring flags)
-
monitor_node_slow_push¶ Boolean(Monitoring flags)
-
monitor_node_slow_push_threshold¶ Integer(Number of minutes as the threshold for firing the notification)
-
monitor_study_create¶ Boolean(Monitoring flags)
-
monitor_study_create_threshold¶ Integer(Number of minutes as the threshold for firing the notification)
-
name¶ String(Name)
-
namespace_id¶ String(FK. The associated namespace)
-
os_type¶ String(OS type of the node, used for harvester only currently)
-
performance_data¶ String(Performance counters from node. Depreciated. To be deleted after 2021-06 release)
-
reload_configuration¶ Boolean(Reload configuration)
-
serial_no¶ String(The serial number)
-
settings¶ DictField(Account settings overrides)
-
type_field¶ String(The type of the node)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. The user to generate a node sid for)
-
uuid¶ String(UUID for external use)
-
warning_email¶ String(Emails that node's warning messages will go to)
-
-
class
ambra_sdk.models.generated.NodeConnect(*, id=None, uuid=None, from_account_id=None, from_account=None, message=None, node_id=None, node=None, status=None, to_account_id=None, to_account=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None)[source]¶ NodeConnect.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
from_account_id¶ String(FK. Node information)
-
id¶ Integer(Primary key for internal use)
-
message¶ String(Message)
-
node_id¶ String(FK. Node information)
-
status¶ String(Status P-Pending, R-Rejected, A-Approved, C-Connected)
-
to_account_id¶ String(FK. Node information)
-
user_id¶ String(FK. Node information)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.NodeEvent(*, id=None, uuid=None, count=None, destination_id=None, destination=None, event=None, node_id=None, node=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ NodeEvent.
-
count¶ Integer(Count of the number of times this event was fired. The audit table will have detail on the individual events.)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
destination¶ alias of
Destination
-
destination_id¶ String(FK. The event parameters)
-
event¶ String(The event parameters)
-
id¶ Integer(Primary key for internal use)
-
node_id¶ String(FK. The event parameters)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.NodePerformanceData(*, id=None, uuid=None, node_id=None, node=None, performance_data=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ NodePerformanceData.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
node_id¶ String(FK. Node information)
-
performance_data¶ String(as well as a rolling array of maybe 10 minutes worth of CPU, memory, disk and network usage)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.NodeProgress(*, id=None, uuid=None, accession_number=None, destination_id=None, destination=None, detail=None, node_id=None, node=None, patientid=None, queue=None, state=None, study_uid=None, created=None, created_by=None, created_by_obj=None)[source]¶ NodeProgress.
-
accession_number¶ String(Study information)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
destination¶ alias of
Destination
-
destination_id¶ String(FK. Node information)
-
detail¶ String(Description of the progress)
-
id¶ Integer(Primary key for internal use)
-
node_id¶ String(FK. Node information)
-
patientid¶ String(Study information)
-
queue¶ String(Queue information)
-
state¶ String(Queue information)
-
study_uid¶ String(Study information)
-
uuid¶ String(UUID for external use)
-
NpiInviteShare.
DateTime(Timestamp when the record was created)
String(FK. ID of the user who created the record)
alias of
User
Boolean(Flag if the share was done)
Integer(Primary key for internal use)
String(Share message)
String(NPI to invite)
alias of
Study
String(FK. Id for the study to be shared)
DateTime(Timestamp when the record was last updated)
String(FK. ID of the user who updated the record)
alias of
User
alias of
User
String(FK. Id the invitation is from)
String(UUID for external use)
-
class
ambra_sdk.models.generated.Order(*, id=None, uuid=None, accession_number=None, account_id=None, account=None, customfields=None, is_manual=None, order_number=None, patient_birth_date=None, patient_name=None, patient_sex=None, patientid=None, referring_physician=None, sending_facility=None, study_uid=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Order.
-
accession_number¶ String(Basic information)
-
account_id¶ String(FK. The associated account)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
customfields¶ DictField(Custom fields)
-
id¶ Integer(Primary key for internal use)
-
is_manual¶ Boolean(Flag indicating if order was created through the API)
-
order_number¶ String(Basic information)
-
patient_birth_date¶ String(Basic information)
-
patient_name¶ String(Basic information)
-
patient_sex¶ String(Basic information)
-
patientid¶ String(Basic information)
-
referring_physician¶ String(Basic information)
-
sending_facility¶ String(Basic information)
-
study_uid¶ String(The study uid)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.OrderSps(*, id=None, uuid=None, modality=None, mpps_status=None, mpps_uid=None, order_id=None, order=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, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ OrderSps.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
modality¶ String(The step information)
-
mpps_status¶ String(The mpps information)
-
mpps_uid¶ String(The mpps information)
-
order_id¶ String(FK. The associated order)
-
requested_procedure_description¶ String(The step information)
-
requested_procedure_id¶ String(The step information)
-
scheduled_procedure_step_description¶ String(The step information)
-
scheduled_procedure_step_id¶ String(The step information)
-
scheduled_procedure_step_start_date¶ String(The step information)
-
scheduled_procedure_step_start_time¶ String(The step information)
-
scheduled_station_aetitle¶ String(The step information)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Patient(*, id=None, uuid=None, account_id=None, account=None, alt_email=None, alt_mobile_phone=None, birth_date=None, customfields=None, email=None, event_new_report=None, event_share=None, first=None, last=None, last_event=None, mobile_phone=None, mrn=None, name=None, settings=None, sex=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Patient.
-
account_id¶ String(FK. The associated account)
-
alt_email¶ String(Contact info)
-
alt_mobile_phone¶ String(Contact info)
-
birth_date¶ String(Basic information)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
customfields¶ DictField(Custom fields)
-
email¶ String(Contact info)
-
event_new_report¶ Boolean(The event flags)
Boolean(The event flags)
-
first¶ String(Basic information)
-
id¶ Integer(Primary key for internal use)
-
last¶ String(Basic information)
-
last_event¶ DateTime(Ordering field)
-
mobile_phone¶ String(Contact info)
-
mrn¶ String(Basic information)
-
name¶ String(Basic information)
-
settings¶ DictField(Account settings overrides)
-
sex¶ String(Basic information)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. The associated user)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.PerfEvent(*, id=None, account_id=None, account=None, action_id=None, browser=None, bytes_transferred=None, day=None, event=None, event_timestamp=None, event_type=None, namespace_id=None, namespace=None, os=None, parameters=None, processing_time=None, proxy_id=None, proxy=None, records_processed=None, sid=None, source=None, study_id=None, study=None, ua=None, user_id=None, user=None, vanity=None, created=None)[source]¶ PerfEvent.
-
account_id¶ String(FK. Objects tied to the action)
-
action_id¶ String(User action ID to track events relation)
-
browser¶ String(User environment detected using User-Agent)
-
bytes_transferred¶ Integer(Bytes transferred over network)
-
created¶ DateTime(Timestamp when the record was created)
-
day¶ Date(Reporting day)
-
event¶ String(Event label (eg API endpoint, short mnemonic name for user action like study_list))
-
event_timestamp¶ DateTime(Time of event provided by user)
-
event_type¶ String(Event type (eg services_call, user_action))
-
id¶ Integer(Primary key for internal use)
-
namespace_id¶ String(FK. Objects tied to the action)
-
os¶ String(User environment detected using User-Agent)
-
parameters¶ String(Action arguments (eg HTTP GET params))
-
processing_time¶ Integer(Time spent on action in milliseconds)
-
proxy_id¶ String(FK. User ID)
-
records_processed¶ Integer(Count of object records processed)
-
sid¶ String(Session ID)
-
source¶ String(Event source (eg UI, AI))
-
study_id¶ String(FK. Objects tied to the action)
-
ua¶ String(User-Agent header)
-
user_id¶ String(FK. User ID)
-
vanity¶ String(Vanity)
-
-
class
ambra_sdk.models.generated.Purge(*, id=None, uuid=None, account_id=None, account=None, adults=None, archive=None, days_old=None, days_old_how=None, global_field=None, max_deletes=None, minors=None, modalities=None, name=None, namespaces=None, object=None, owned_phr=None, shared_from_phr=None, skinny=None, study_status_tags=None, suspended=None, thin=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Purge.
-
account_id¶ String(FK. The associated object and account)
-
adults¶ Boolean(Include adults in this rule)
-
archive¶ Boolean(Flag to make it a thin, archive or skinny study)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
days_old¶ Integer(Age of the studies to purge and how to calculate the purge)
-
days_old_how¶ String(Age of the studies to purge and how to calculate the purge)
-
global_field¶ Boolean(Is this a global purge rule)
-
id¶ Integer(Primary key for internal use)
-
max_deletes¶ Integer(Maximum number of purges per run of the rule)
-
minors¶ Boolean(Include minors in this rule)
-
modalities¶ String(The modalities to limit the rule to as a JSON array)
-
name¶ String(Name)
-
namespaces¶ String(The namespaces to limit the rule to as a JSON array)
-
object¶ String(The associated object and account)
-
owned_phr¶ Boolean(Include owned PHR namespaces in the rule)
Boolean(If a study was shared from a PHR delete the copy in the PHR as well)
-
skinny¶ Boolean(Flag to make it a thin, archive or skinny study)
String(A CSV list of the study status tags limit the purge to)
-
suspended¶ Boolean(Suspend this rule from running)
-
thin¶ Boolean(Flag to make it a thin, archive or skinny study)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Qctask(*, id=None, uuid=None, customfields=None, message=None, namespace_id=None, namespace=None, priority=None, qctask_status=None, query_id=None, query=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Qctask.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
customfields¶ DictField(Custom fields)
-
id¶ Integer(Primary key for internal use)
-
message¶ String(Message associated with activity)
-
namespace_id¶ String(FK. Id of the namespace the activity is associated with)
-
priority¶ Integer(The activity priority)
-
qctask_status¶ String(QC task status)
-
query_id¶ String(FK. Optional Query link. Depreciated. Should be removed after 2022 February release)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. Id of the user the activity is specifically for.)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.QctaskQuery(*, id=None, uuid=None, qctask_id=None, qctask=None, query_id=None, query=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ QctaskQuery.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
qctask¶ Model descriptor.
-
qctask_id¶ String(FK. QC task)
-
query_id¶ String(FK. Query)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.QctaskStudy(*, id=None, uuid=None, qctask_id=None, qctask=None, study_id=None, study=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ QctaskStudy.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
qctask¶ Model descriptor.
-
qctask_id¶ String(FK. QC task)
-
study_id¶ String(FK. Study)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Query(*, id=None, uuid=None, account_id=None, account=None, body=None, customfields=None, escalation_count_since_status_change=None, group_id=None, group=None, last_reminder=None, last_reply=None, last_status_change=None, notify=None, owner_namespace_id=None, owner_namespace=None, owner_user_id=None, owner_user=None, query_no=None, query_status=None, query_type=None, reminder_count_since_reply=None, study_id=None, study=None, subject=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Query.
-
account_id¶ String(FK. Query links)
-
body¶ String(Query description)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
customfields¶ DictField(Custom fields)
-
escalation_count_since_status_change¶ Integer(Communication plan counters)
-
group_id¶ String(FK. Query links)
-
id¶ Integer(Primary key for internal use)
-
last_reminder¶ DateTime(Communication plan counters)
-
last_reply¶ DateTime(Communication plan counters)
-
last_status_change¶ DateTime(Communication plan counters)
-
notify¶ String(Additional notification receivers (emails CSV))
-
owner_namespace_id¶ String(FK. The owners)
-
owner_user_id¶ String(FK. The owners)
-
query_no¶ Integer(The query number (displayed as a 7-digit number). Depreciated in favor of id. Please remove in 2022.)
-
query_status¶ String(Query status)
-
query_type¶ String(The type of the query)
-
reminder_count_since_reply¶ Integer(Communication plan counters)
-
study_id¶ String(FK. Query links)
-
subject¶ String(Subject line)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.QueryAttachment(*, id=None, uuid=None, name=None, phantom=None, query_id=None, query=None, size=None, thumbnail=None, thumbnail_id=None, thumbnail_id_obj=None, tombstone=None, type_field=None, created=None, created_by=None, created_by_obj=None)[source]¶ QueryAttachment.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
name¶ String(The attachment name)
-
phantom¶ Boolean(The attachment phantom flag to hide half-uploaded attachments)
-
query_id¶ String(FK. The owning query)
-
size¶ Integer(The attachment size)
-
thumbnail¶ Boolean(The thumbnail sign)
-
thumbnail_id¶ String(FK. The related thumbnail)
-
thumbnail_id_obj¶ Model descriptor.
-
tombstone¶ Boolean(The attachment tombstone to hide half-deleted attachments)
-
type_field¶ String(The attachment MIME-type)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.QueryRecipient(*, id=None, uuid=None, query_id=None, query=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ QueryRecipient.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
query_id¶ String(FK. Mapping between the user and query)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. Mapping between the user and query)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.QuerySeen(*, id=None, uuid=None, message_id=None, message=None, query_id=None, query=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ QuerySeen.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
message_id¶ String(FK. The last message seen by the user in the Query)
-
query_id¶ String(FK. The Query)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. The User)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Radreport(*, id=None, uuid=None, attachment=None, fields=None, study_id=None, study=None, type_field=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Radreport.
-
attachment¶ String(The attachment information)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
fields¶ String(The fields in the report)
-
id¶ Integer(Primary key for internal use)
-
study_id¶ String(FK. Attached study)
-
type_field¶ String(Type of report)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. User who created the report)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.RadreportAnalytics(*, id=None, account_id=None, account=None, day=None, namespace_id=None, namespace=None, radreport_create=None, radreport_delete=None, radreport_report_generated=None, radreport_signed=None, user_id=None, user=None)[source]¶ RadreportAnalytics.
-
account_id¶ String(FK. The primary keys)
-
day¶ Date(The day)
-
id¶ Integer(Primary key for internal use)
-
namespace_id¶ String(FK. The primary keys)
-
radreport_create¶ Integer(The metrics)
-
radreport_delete¶ Integer(The metrics)
-
radreport_report_generated¶ Integer(The metrics)
-
radreport_signed¶ Integer(The metrics)
-
user_id¶ String(FK. The primary keys)
-
-
class
ambra_sdk.models.generated.RadreportTemplate(*, id=None, uuid=None, account_id=None, account=None, active=None, body=None, name=None, options=None, preview=None, type_field=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ RadreportTemplate.
-
account_id¶ String(FK. Associated account)
-
active¶ Boolean(Is this the active record)
-
body¶ String(Template fields)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
name¶ String(Description of report template)
-
options¶ String(Template metadata)
-
preview¶ String(Template fields)
-
type_field¶ String(Type of report template)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Radreportmacro(*, id=None, uuid=None, account_id=None, account=None, body=None, hotkey=None, modality=None, name=None, type_field=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Radreportmacro.
-
account_id¶ String(FK. Associated account)
-
body¶ String(Macro fields)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
hotkey¶ String(Macro fields)
-
id¶ Integer(Primary key for internal use)
-
modality¶ String(Macro fields)
-
name¶ String(Macro fields)
-
type_field¶ String(Type of report)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. User who owns the macro)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Role(*, id=None, uuid=None, account_id=None, account=None, description=None, for_account=None, for_group=None, for_location=None, name=None, permissions=None, settings=None, type_field=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Role.
-
account_id¶ String(FK. The associated account)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
description¶ String(Description)
-
for_account¶ Boolean(Allowed namespace types flags)
-
for_group¶ Boolean(Allowed namespace types flags)
-
for_location¶ Boolean(Allowed namespace types flags)
-
id¶ Integer(Primary key for internal use)
-
name¶ String(Name)
-
permissions¶ String(The permissions as a json structure)
-
settings¶ DictField(Account settings overrides)
-
type_field¶ String(Type if role is system created)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Route(*, id=None, uuid=None, account_id=None, account=None, 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, namespace_id=None, namespace=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, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Route.
-
account_id¶ String(FK. The associated account)
-
actions¶ String(The rule actions)
-
conditions¶ String(The rule conditions)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
delay¶ Integer(Number of minutes to delay running this rule after it is triggered)
-
delay_from_study_field¶ String(Field that delay_from_study_seconds will be applied to)
-
delay_from_study_seconds¶ Integer(Number of seconds to delay running this rule after point in time stated in a study's field)
-
delay_seconds¶ Integer(Number of seconds to delay running this rule after it is triggered)
-
delay_till_schedule¶ Boolean(Delay running the rule until the schedule time)
-
id¶ Integer(Primary key for internal use)
-
manual_roles¶ DictField(Roles that can manually run this route)
-
name¶ String(Name)
-
namespace_id¶ String(FK. The associated namespace)
-
no_re_run¶ Boolean(Should the rule be not be run on a re-run of a storage notification)
-
on_harvest¶ Boolean(Should the rule be run on harvested studies)
-
on_manual_route¶ Boolean(Should the rule be able to be applied manually)
Boolean(Should the rule be run on shared studies)
-
on_thin¶ Boolean(Should the rule be run on the creation of thin studies)
-
on_upload¶ Boolean(Should the rule be run on uploaded studies)
-
only_re_run¶ Boolean(Should the rule only be run on a re-run of a storage notification)
-
options¶ String(The rule options)
-
other_namespaces¶ DictField(The other namespaces this rule is associated with)
-
schedule¶ String(The rule schedule)
-
suspended¶ Boolean(Suspend this rule from running)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.RouteRoundRobin(*, id=None, action=None, route_id=None, route=None, study_id=None, study=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ RouteRoundRobin.
-
action¶ String(Primary key for internal use)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
route_id¶ String(FK. Primary key for internal use)
-
study_id¶ String(FK. Primary key for internal use)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
-
class
ambra_sdk.models.generated.RsnaclrDoc(*, id=None, uuid=None, attachmentid=None, author=None, class_code=None, comments=None, communityid=None, confidentiality_code=None, creation_time=None, documentid=None, event_code_list=None, format_code=None, healthcare_facility_type_code=None, language_code=None, legal_authenticator=None, limited_metadata=None, mime_type=None, patientid=None, practice_setting_code=None, reference_id_list=None, repositoryid=None, rsna_status=None, rsnaclr_subset_id=None, rsnaclr_subset=None, service_start_time=None, service_stop_time=None, sha1=None, size=None, source_patient_id=None, source_patient_info=None, title=None, type_code=None, uniqueid=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ RsnaclrDoc.
-
attachmentid¶ String()
JsonB()
-
class_code¶ JsonB()
-
comments¶ String()
-
communityid¶ String()
-
confidentiality_code¶ JsonB()
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
creation_time¶ String()
-
documentid¶ String()
-
event_code_list¶ JsonB()
-
format_code¶ JsonB()
-
healthcare_facility_type_code¶ JsonB()
-
id¶ Integer(Primary key for internal use)
-
language_code¶ String()
-
legal_authenticator¶ String()
-
limited_metadata¶ Boolean()
-
mime_type¶ String()
-
patientid¶ String()
-
practice_setting_code¶ JsonB()
-
reference_id_list¶ JsonB()
-
repositoryid¶ String()
-
rsna_status¶ String()
-
rsnaclr_subset¶ alias of
RsnaclrSubset
-
rsnaclr_subset_id¶ String(FK. The associated submission set)
-
service_start_time¶ String()
-
service_stop_time¶ String()
-
sha1¶ String()
-
size¶ Integer()
-
source_patient_id¶ String()
-
source_patient_info¶ JsonB()
-
title¶ String()
-
type_code¶ JsonB()
-
uniqueid¶ String()
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.RsnaclrSubset(*, id=None, uuid=None, author=None, comments=None, communityid=None, content_type_code=None, intended_recipient=None, limited_metadata=None, patientid=None, rsna_status=None, sourceid=None, study_id=None, study=None, submission_time=None, title=None, uniqueid=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ RsnaclrSubset.
JsonB()
-
comments¶ String()
-
communityid¶ String()
-
content_type_code¶ JsonB()
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
intended_recipient¶ JsonB()
-
limited_metadata¶ Boolean()
-
patientid¶ String(RSNA patient Id)
-
rsna_status¶ String(Status of the submission set)
-
sourceid¶ String()
-
study_id¶ String(FK. Study the submission set is attached to)
-
submission_time¶ String()
-
title¶ String()
-
uniqueid¶ String()
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
class
ambra_sdk.models.generated.Rsync(*, id=None, uuid=None, is_full=None, name=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Rsync.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
is_full¶ Boolean(Is the account full)
-
name¶ String(ssh account name)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Scanner(*, id=None, uuid=None, account_id=None, account=None, customfields=None, manufacturer=None, modality=None, model=None, name=None, serial_no=None, site_id=None, site=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Scanner.
-
account_id¶ String(FK. The associated account)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
customfields¶ DictField(Custom fields)
-
id¶ Integer(Primary key for internal use)
-
manufacturer¶ String(The scanner manufacturer)
-
modality¶ String(Scanner modality)
-
model¶ String(The model)
-
name¶ String(Name)
-
serial_no¶ String(The serial number)
-
site_id¶ String(FK. The site owning the scanner)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.ScannerValidated(*, id=None, uuid=None, group_id=None, group=None, scanner_id=None, scanner=None, study_uid=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ ScannerValidated.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
group_id¶ String(FK. Mapping between the scanner and group)
-
id¶ Integer(Primary key for internal use)
-
scanner_id¶ String(FK. Mapping between the scanner and group)
-
study_uid¶ String(The study_uid that validated the scanner)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Setting(*, id=None, uuid=None, key=None, user_id=None, user=None, value=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Setting.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
key¶ String()
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. )
-
uuid¶ String(UUID for external use)
-
value¶ String()
-
-
class
ambra_sdk.models.generated.Site(*, id=None, uuid=None, account_id=None, account=None, address1=None, address2=None, city=None, country=None, inactive=None, name=None, site_id=None, site=None, state=None, zip=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Site.
-
account_id¶ String(FK. The associated account)
-
address1¶ String(Location fields)
-
address2¶ String(Location fields)
-
city¶ String(Location fields)
-
country¶ String(Location fields)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
inactive¶ Boolean(Inactive flag to hide a site from lists)
-
name¶ String(Name)
-
site_id¶ String(FK. The associated site in case this one is a satellite site)
-
state¶ String(Location fields)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
zip¶ String(Location fields)
-
-
class
ambra_sdk.models.generated.StorageStudy(*, id=None, uuid=None, corrupt=None, engine_id=None, engine=None, is_frozen=None, last_update=None, rsync_id=None, rsync=None, storage_namespace=None, storage_namespace_obj=None, study_uid=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ StorageStudy.
-
corrupt¶ Boolean(Flag if the study is corrupt)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
engine_id¶ String(FK. The storage engine)
-
id¶ Integer(Primary key for internal use)
-
is_frozen¶ Boolean(Flag if the study is frozen)
-
last_update¶ DateTime(Time of the last update of the study)
-
rsync_id¶ String(FK. The rysnc account)
-
storage_namespace¶ String(FK. The storage namespace)
-
study_uid¶ String(Study instance id)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Study(*, id=None, uuid=None, accession_number=None, account_id=None, attachment_count=None, callback_url=None, compressed_size=None, created_for=None, created_for_obj=None, customfields=None, destination_ae_title=None, engine_id=None, engine=None, image_count=None, integration_key=None, last_status_change=None, medical_record_locator=None, modality=None, must_approve=None, node_id=None, node=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, phantom=None, phi_namespace=None, phi_namespace_obj=None, referring_physician=None, seconds_to_ingest=None, shared_from=None, shared_from_obj=None, size=None, source=None, source_ae_title=None, status_timer=None, storage_namespace=None, storage_namespace_obj=None, storage_state=None, study_date=None, study_description=None, study_status=None, study_time=None, study_uid=None, thin=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Study.
-
accession_number¶ String(This is the MRN)
-
account_id¶ Integer(The associated account)
-
attachment_count¶ Integer(This is the MRN)
-
callback_url¶ String(2013-11 - This is depreciated as the storage id is now used. If this is dropped update its usage in the database script.)
-
compressed_size¶ Integer(This is the MRN)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
created_for¶ String(FK. A user on whose behalf the study is created)
-
customfields¶ DictField(Custom fields)
-
destination_ae_title¶ String(The aetitle the study was harvested against)
-
engine_id¶ String(FK. The storage engine the study is stored on)
-
id¶ Integer(Primary key for internal use)
-
image_count¶ Integer(This is the MRN)
-
integration_key¶ String(Key for integration with third party systems)
-
last_status_change¶ DateTime(Timestamp to calculate how long a study spent in current status. This removes the need for searching through audit records.)
-
medical_record_locator¶ String(This is the MRN)
-
modality¶ String(This is the MRN)
-
must_approve¶ Boolean(Flag if study approval is needed)
-
node_id¶ String(FK. The harvest node id)
-
patient_additional_history¶ String(This is the MRN)
-
patient_address¶ String(This is the MRN)
-
patient_age¶ String(This is the MRN)
-
patient_birth_date¶ String(This is the MRN)
-
patient_birth_time¶ String(This is the MRN)
-
patient_birthname¶ String(This is the MRN)
-
patient_comments¶ String(This is the MRN)
-
patient_current_location¶ String(This is the MRN)
-
patient_ethnic_group¶ String(This is the MRN)
-
patient_institution_residence¶ String(This is the MRN)
-
patient_mother_birthname¶ String(This is the MRN)
-
patient_name¶ String(Dicom fields)
-
patient_name_other¶ String(This is the MRN)
-
patient_occupation¶ String(This is the MRN)
-
patient_phone¶ String(This is the MRN)
-
patient_religious_preference¶ String(This is the MRN)
-
patient_sex¶ String(This is the MRN)
-
patient_size¶ String(This is the MRN)
-
patient_weight¶ String(This is the MRN)
-
patientid¶ String(This is the MRN)
-
patientid_other¶ String(This is the MRN)
-
phantom¶ Boolean(A phantom study is one that is in the process loading into storage)
-
phi_namespace¶ String(FK. The PHI namespace. This controls the study visibility)
-
referring_physician¶ String(This is the MRN)
-
seconds_to_ingest¶ Integer(The number of seconds it took to ingest the study. -1 if we don't have enough data to calculate this)
String(FK. Id of the study this was originally shared from)
alias of
StudyShare
-
size¶ Integer(This is the MRN)
-
source¶ String(The original source of the study)
-
source_ae_title¶ String(The aetitle the study was harvested against)
-
status_timer¶ Integer(The timer value at status enter. Real timer value must be calculated at read time)
-
storage_namespace¶ String(FK. The storage namespace)
-
storage_state¶ String(Storage state. Empty or null is available or else 'U' if unavailable or 'R' if getting restored from the archive)
-
study_date¶ String(This is the MRN)
-
study_description¶ String(This is the MRN)
-
study_status¶ String(The status of the study)
-
study_time¶ String(This is the MRN)
-
study_uid¶ String(Study instance id)
-
thin¶ Boolean(A thin study is not in primary storage and needs to be query retrieved to be loaded into storage or loaded from an archive)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.StudyAnalytics(*, id=None, account_id=None, account=None, customfields=None, day=None, login=None, modality=None, namespace_id=None, namespace=None, study_approve=None, study_auto_approve=None, study_create=None, study_create_copy=None, study_create_harvest=None, study_create_share=None, study_create_upload=None, study_delete=None, study_download=None, study_push=None, study_report_view=None, study_share_in=None, study_share_out=None, study_view=None, study_view_load_cnt=None, study_view_load_tot=None)[source]¶ StudyAnalytics.
-
account_id¶ String(FK. The primary keys)
-
customfields¶ DictField(The primary keys)
-
day¶ Date(The day)
-
id¶ Integer(Primary key for internal use)
-
login¶ Integer(Login)
-
modality¶ String(The primary keys)
-
namespace_id¶ String(FK. The primary keys)
-
study_approve¶ Integer(Study approved)
-
study_auto_approve¶ Integer(Study approved)
-
study_create¶ Integer(Total study created)
-
study_create_copy¶ Integer(Count by creation type)
-
study_create_harvest¶ Integer(Count by creation type)
Integer(Count by creation type)
-
study_create_upload¶ Integer(Count by creation type)
-
study_delete¶ Integer(Delete, view download and push)
-
study_download¶ Integer(Delete, view download and push)
-
study_push¶ Integer(Delete, view download and push)
-
study_report_view¶ Integer(Delete, view download and push)
Integer(Share in and out)
Integer(Share in and out)
-
study_view¶ Integer(Delete, view download and push)
-
study_view_load_cnt¶ Integer(Study view count and total load time)
-
study_view_load_tot¶ Integer(Study view count and total load time)
-
-
class
ambra_sdk.models.generated.StudyAttachment(*, id=None, uuid=None, attachment_guid=None, storage_namespace=None, storage_namespace_obj=None, study_uid=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ StudyAttachment.
-
attachment_guid¶ String(The attachment id)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
storage_namespace¶ String(FK. The storage namespace)
-
study_uid¶ String(Study instance id)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. The user id)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.StudyCharge(*, id=None, uuid=None, account_id=None, account=None, detail=None, study_id=None, study=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ StudyCharge.
-
account_id¶ String(FK. The study and account id)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
detail¶ String(The stripe capture)
-
id¶ Integer(Primary key for internal use)
-
study_id¶ String(FK. The study and account id)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.StudyComment(*, id=None, uuid=None, body=None, study_id=None, study=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ StudyComment.
-
body¶ String(Body of the comment)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
study_id¶ String(FK. The study and user id)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. The study and user id)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.StudyCopy(*, id=None, new_study_id=None, new_study=None, purpose=None, study_id=None, study=None, created=None, created_by=None, created_by_obj=None)[source]¶ StudyCopy.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
new_study_id¶ String(FK. Id of the study copy)
-
purpose¶ String(Copy purpose)
-
study_id¶ String(FK. Primary key for internal use)
-
-
class
ambra_sdk.models.generated.StudyDeleted(*, id=None, uuid=None, accession_number=None, account_id=None, attachment_count=None, callback_url=None, compressed_size=None, created_for=None, created_for_obj=None, customfields=None, deleted=None, deleted_by=None, deleted_by_obj=None, destination_ae_title=None, engine_id=None, engine=None, image_count=None, integration_key=None, last_status_change=None, medical_record_locator=None, modality=None, must_approve=None, node_id=None, node=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, phantom=None, phi_namespace=None, phi_namespace_obj=None, referring_physician=None, seconds_to_ingest=None, shared_from=None, shared_from_obj=None, size=None, source=None, source_ae_title=None, status_timer=None, storage_namespace=None, storage_namespace_obj=None, storage_state=None, study_date=None, study_description=None, study_status=None, study_time=None, study_uid=None, thin=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ StudyDeleted.
-
accession_number¶ String()
-
account_id¶ Integer()
-
attachment_count¶ Integer()
-
callback_url¶ String()
-
compressed_size¶ Integer()
-
created¶ DateTime()
-
created_by¶ String(FK. )
-
created_for¶ String(FK. )
-
customfields¶ DictField()
-
deleted¶ DateTime()
-
deleted_by¶ String(FK. )
-
destination_ae_title¶ String()
-
engine_id¶ String(FK. )
-
id¶ Integer()
-
image_count¶ Integer()
-
integration_key¶ String()
-
last_status_change¶ DateTime()
-
medical_record_locator¶ String()
-
modality¶ String()
-
must_approve¶ Boolean()
-
node_id¶ String(FK. )
-
patient_additional_history¶ String()
-
patient_address¶ String()
-
patient_age¶ String()
-
patient_birth_date¶ String()
-
patient_birth_time¶ String()
-
patient_birthname¶ String()
-
patient_comments¶ String()
-
patient_current_location¶ String()
-
patient_ethnic_group¶ String()
-
patient_institution_residence¶ String()
-
patient_mother_birthname¶ String()
-
patient_name¶ String()
-
patient_name_other¶ String()
-
patient_occupation¶ String()
-
patient_phone¶ String()
-
patient_religious_preference¶ String()
-
patient_sex¶ String()
-
patient_size¶ String()
-
patient_weight¶ String()
-
patientid¶ String()
-
patientid_other¶ String()
-
phantom¶ Boolean()
-
phi_namespace¶ String(FK. )
-
referring_physician¶ String()
-
seconds_to_ingest¶ Integer()
String(FK. )
alias of
StudyShare
-
size¶ Integer()
-
source¶ String()
-
source_ae_title¶ String()
-
status_timer¶ Integer()
-
storage_namespace¶ String(FK. )
-
storage_state¶ String()
-
study_date¶ String()
-
study_description¶ String()
-
study_status¶ String()
-
study_time¶ String()
-
study_uid¶ String()
-
thin¶ Boolean()
-
updated¶ DateTime()
-
updated_by¶ String(FK. )
-
uuid¶ String()
-
-
class
ambra_sdk.models.generated.StudyFetch(*, id=None, uuid=None, accession_number=None, anonymize=None, customfields=None, destination_id=None, destination=None, distributing_destination_id=None, distributing_destination=None, end_datetime=None, message=None, node_id=None, node=None, patientid=None, pickup=None, source=None, start_datetime=None, status=None, study_id=None, study=None, study_uid=None, tracking_number=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ StudyFetch.
-
accession_number¶ String(The accession number to fetch)
-
anonymize¶ String(The associated anonymization rules)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
customfields¶ DictField(Custom fields to be applied to the fetched study)
-
destination¶ alias of
Destination
-
destination_id¶ String(FK. The destination)
-
distributing_destination¶ alias of
DestinationDistributed
-
distributing_destination_id¶ String(FK. The distributing destination that initiated the fetch)
-
end_datetime¶ String(Extra data to scope the fetch down further)
-
id¶ Integer(Primary key for internal use)
-
message¶ String(Message. Depreciated. To be deleted after 2021-04 release)
-
node_id¶ String(FK. The node to use)
-
patientid¶ String(Extra data to scope the fetch down further)
-
pickup¶ DateTime(When was this picked up by the node)
-
source¶ String(How was the study fetch trigger, 'H'l7 or 'O'ther)
-
start_datetime¶ String(Extra data to scope the fetch down further)
-
status¶ String(Status of the delivery)
-
study_id¶ String(FK. Study id if this is for a thin study)
-
study_uid¶ String(Extra data to scope the fetch down further)
-
tracking_number¶ String(Tracking number)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.StudyHl7(*, id=None, uuid=None, ack=None, destination_id=None, destination=None, distributing_destination_id=None, distributing_destination=None, hl7_id=None, hl7=None, hl7_template_hl7_id=None, hl7_template_hl7=None, hl7_template_id=None, hl7_template=None, node_id=None, node=None, pickup=None, status=None, status_reason=None, study_id=None, study=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ StudyHl7.
-
ack¶ String(The returned ACK message)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
destination¶ alias of
Destination
-
destination_id¶ String(FK. The destination)
-
distributing_destination¶ alias of
DestinationDistributed
-
distributing_destination_id¶ String(FK. The distributing destination that initiated the push)
-
hl7_id¶ String(FK. The study or hl7 id to use)
-
hl7_template¶ alias of
Hl7Template
-
hl7_template_hl7¶ alias of
Hl7Template
-
hl7_template_hl7_id¶ String(FK. HL7 template and associated hl7 message to use in the template)
-
hl7_template_id¶ String(FK. HL7 template and associated hl7 message to use in the template)
-
id¶ Integer(Primary key for internal use)
-
node_id¶ String(FK. The node to use)
-
pickup¶ DateTime(When was this picked up by the node)
-
status¶ String(Status of the delivery)
-
status_reason¶ String(Status of the delivery)
-
study_id¶ String(FK. The study or hl7 id to use)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.StudyNotReady(*, id=None, phi_namespace=None, phi_namespace_obj=None, study_id=None, study=None)[source]¶ StudyNotReady.
-
id¶ Integer(Primary key for internal use)
-
phi_namespace¶ String(FK. Primary key for internal use)
-
study_id¶ String(FK. Primary key for internal use)
-
-
class
ambra_sdk.models.generated.StudyNotify(*, id=None, customfields=None, study_id=None, study=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ StudyNotify.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
customfields¶ DictField(The DICOM tags, named as such so we get merging at save)
-
id¶ Integer(Primary key for internal use)
-
study_id¶ String(FK. The study id)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
-
class
ambra_sdk.models.generated.StudyPhi(*, id=None, uuid=None, customfields=None, extended=None, study_id=None, study=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ StudyPhi.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
customfields¶ DictField(The PHI override in DICOM tag=>value format. We name this customfields so we get the merging at save)
-
extended¶ String(The extended PHI attributes)
-
id¶ Integer(Primary key for internal use)
-
study_id¶ String(FK. The study id)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.StudyPush(*, id=None, uuid=None, destination_id=None, destination=None, detail=None, image_count=None, is_local=None, node_id=None, node=None, pending=None, pickup=None, status=None, status_reason=None, study_id=None, study=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ StudyPush.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
destination¶ alias of
Destination
-
destination_id¶ String(FK. The destination)
-
detail¶ String(Additional detail to send to the node)
-
id¶ Integer(Primary key for internal use)
-
image_count¶ Integer(The image count when the study was pushed)
-
is_local¶ Boolean(Is this push local?)
-
node_id¶ String(FK. The node to use)
-
pending¶ Integer(Counter for pending deliveries needed)
-
pickup¶ DateTime(When was this picked up by the node)
-
status¶ String(Status of the delivery)
-
status_reason¶ String(Status of the delivery)
-
study_id¶ String(FK. The study to push)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.StudyPushStatus(*, id=None, uuid=None, account_id=None, account=None, copy_src_phi_namespace=None, copy_src_phi_namespace_obj=None, destination_id=None, destination=None, phi_namespace=None, phi_namespace_obj=None, status=None, status_reason=None, study_id=None, study=None, study_push_id=None, study_push=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ StudyPushStatus.
-
account_id¶ String(FK. Account for scoping 'same account' filter down)
-
copy_src_phi_namespace¶ String(FK. PHI namespace for the source of this study if copied. Used to narrow list filters down)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
destination¶ alias of
Destination
-
destination_id¶ String(FK. The destination)
-
id¶ Integer(Primary key for internal use)
-
phi_namespace¶ String(FK. PHI namespace to allow for scoping the filter down)
-
status¶ String(Current status - pe'N'ding, 'I'n-process, 'P'artial, 'S'uccess, 'F'ailure)
-
status_reason¶ String(Current status - pe'N'ding, 'I'n-process, 'P'artial, 'S'uccess, 'F'ailure)
-
study_id¶ String(FK. The study)
-
study_push_id¶ String(FK. The latest push)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.StudyRequest(*, id=None, uuid=None, account_id=None, account=None, comments=None, inbound_activity_id=None, inbound_activity=None, modality=None, namespace_id=None, namespace=None, outbound_activity_id=None, outbound_activity=None, patient_birth_date=None, patient_first_name=None, patient_last_name=None, patient_sex=None, patientid=None, status=None, study_date_end=None, study_date_start=None, study_description=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ StudyRequest.
-
account_id¶ String(FK. The requested account)
-
comments¶ String(Free form comments)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
inbound_activity_id¶ String(FK. Associated activities)
-
modality¶ String(Study search criteria)
-
namespace_id¶ String(FK. The destination namespace)
-
outbound_activity_id¶ String(FK. Associated activities)
-
patient_birth_date¶ String(Study search criteria)
-
patient_first_name¶ String(Study search criteria)
-
patient_last_name¶ String(Study search criteria)
-
patient_sex¶ String(Study search criteria)
-
patientid¶ String(Study search criteria)
-
status¶ String(The request status N-pending, R-rejected, I-in progress, C-closed)
-
study_date_end¶ String(Study search criteria)
-
study_date_start¶ String(Study search criteria)
-
study_description¶ String(Study search criteria)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.StudyRequestFound(*, id=None, uuid=None, destination_search_id=None, destination_search=None, result=None, study_fetch_id=None, study_fetch=None, study_request_id=None, study_request=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ StudyRequestFound.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
destination_search¶ alias of
DestinationSearch
-
destination_search_id¶ String(FK. The query id)
-
id¶ Integer(Primary key for internal use)
-
result¶ String(The search result)
-
study_fetch¶ alias of
StudyFetch
-
study_fetch_id¶ String(FK. The retrieve id)
-
study_request¶ alias of
StudyRequest
-
study_request_id¶ String(FK. The study request id)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
StudyShare.
alias of
Account
String(FK. Who it is shared with)
DateTime(Timestamp when the record was created)
String(FK. ID of the user who created the record)
alias of
User
alias of
Group
String(FK. Who it is shared with)
Integer(Primary key for internal use)
alias of
Location
String(FK. Who it is shared with)
String(Share message)
alias of
Study
String(FK. Id of the new study created by the share)
alias of
Study
String(FK. Primary key for internal use)
DateTime(Timestamp when the record was last updated)
String(FK. ID of the user who updated the record)
alias of
User
alias of
User
String(FK. Who it is shared with)
StudyShareAi.
alias of
Account
String(FK. UUID for external use)
DateTime(Timestamp when the record was created)
String(FK. ID of the user who created the record)
alias of
User
alias of
Account
String(FK. Id and account of the study it was shared from)
alias of
Study
String(FK. Id and account of the study it was shared from)
Integer(Primary key for internal use)
alias of
Study
String(FK. UUID for external use)
DateTime(Timestamp when the record was last updated)
String(FK. ID of the user who updated the record)
alias of
User
String(UUID for external use)
StudyShareRsna.
DateTime(Timestamp when the record was created)
String(FK. ID of the user who created the record)
alias of
User
String(The PIN and Exam id)
Integer(Primary key for internal use)
String(The PIN and Exam id)
String(Reason the delivery failed)
String(Status of the delivery)
alias of
Study
String(FK. The study shared)
DateTime(Timestamp when the record was last updated)
String(FK. ID of the user who updated the record)
alias of
User
String(UUID for external use)
-
class
ambra_sdk.models.generated.StudySplit(*, id=None, new_study_id=None, new_study=None, study_id=None, study=None, created=None, created_by=None, created_by_obj=None)[source]¶ StudySplit.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
new_study_id¶ String(FK. Id of the study split)
-
study_id¶ String(FK. Primary key for internal use)
-
-
class
ambra_sdk.models.generated.StudyStar(*, id=None, star=None, study_id=None, study=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ StudyStar.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
star¶ Boolean(The study star)
-
study_id¶ String(FK. )
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. )
-
-
class
ambra_sdk.models.generated.StudyStatusLock(*, id=None, uuid=None, study_id=None, study=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ StudyStatusLock.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
study_id¶ String(FK. The study and user id)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. The study and user id)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.StudyTiming(*, id=None, event=None, node_id=None, node=None, size=None, storage_namespace=None, storage_namespace_obj=None, study_uid=None, created=None, created_by=None, created_by_obj=None)[source]¶ StudyTiming.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
event¶ String(The event)
-
id¶ Integer(Primary key for internal use)
-
node_id¶ String(FK. Node id)
-
size¶ Integer(The event)
-
storage_namespace¶ String(FK. The study uid and storage namespace)
-
study_uid¶ String(The study uid and storage namespace)
-
-
class
ambra_sdk.models.generated.StudyUpload(*, id=None, message=None, study_id=None, study=None, created=None, created_by=None, created_by_obj=None)[source]¶ StudyUpload.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
message¶ String(The messge to send out on upload finish)
-
study_id¶ String(FK. The study id)
-
-
class
ambra_sdk.models.generated.System(*, id=None, ai_password=None, ai_username=None, apply_account_password_expire_to_users=None, archive=None, athena_pk=None, athena_sk=None, aws_pk=None, aws_region=None, aws_sk=None, azure_access_key=None, azure_account_name=None, azure_endpoint_suffix=None, azure_query_attachments_dir=None, box_client_id=None, box_client_secret=None, box_enterprises=None, cache=None, captcha_pk=None, captcha_sk=None, clickhouse_version=None, database_version=None, documo_mfax_caller_id=None, documo_mfax_key=None, drchrono_client_id=None, drchrono_client_secret=None, drchrono_redirect_uri=None, email_from=None, email_from_name=None, email_validation=None, enhanced_security=None, global_purge=None, google_client_id=None, google_client_secret=None, google_service_account=None, hide_help_tool=None, indicator_html=None, indicator_md5=None, log_days=None, login_page_banner_html=None, login_page_banner_show_start=None, login_page_banner_show_stop=None, passwdqc=None, passwdqc_description=None, permissions_mask=None, phr_bypass_study_oversized_threshold=None, phr_permissions=None, privacy_html=None, privacy_md5=None, prometheus_password=None, rsna_xds=None, stripe_ca=None, stripe_pk=None, stripe_sk=None, stripe_uri=None, sysadmin_pin_required=None, terms_html=None, terms_md5=None, twilio_callback_password=None, twilio_from=None, twilio_pk=None, twilio_sk=None, ui_json=None, updates_html=None, updates_html_version=None, updates_release_notes=None, updates_show_start=None, updates_show_stop=None, user_settings=None, watchdog_host=None, websocket_domain=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ System.
-
ai_password¶ String(AI stack basic auth credentials)
-
ai_username¶ String(AI stack basic auth credentials)
-
apply_account_password_expire_to_users¶ Boolean(Apply account's password_expire to its users' passwords)
-
archive¶ DictField(The archive settings)
-
athena_pk¶ String(Athena key and secret)
-
athena_sk¶ String(Athena key and secret)
-
aws_pk¶ String(AWS information)
-
aws_region¶ String(AWS information)
-
aws_sk¶ String(AWS information)
-
azure_access_key¶ String(Azure information)
-
azure_account_name¶ String(Azure information)
-
azure_endpoint_suffix¶ String(Azure information)
-
azure_query_attachments_dir¶ String(Azure information)
-
box_client_id¶ String(Box information)
-
box_client_secret¶ String(Box information)
-
box_enterprises¶ String(Box information)
-
cache¶ Boolean(Cache new studies images)
-
captcha_pk¶ String(Captcha public key)
-
captcha_sk¶ String(Captcha secret key)
-
clickhouse_version¶ Integer(ClickHouse scheme version)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
database_version¶ Integer(Database version)
-
documo_mfax_caller_id¶ String(Documo (mFax) key and caller_id phone number)
-
documo_mfax_key¶ String(Documo (mFax) key and caller_id phone number)
-
drchrono_client_id¶ String(Drchrono information)
-
drchrono_client_secret¶ String(Drchrono information)
-
drchrono_redirect_uri¶ String(Drchrono information)
-
email_from¶ String(From email address and name)
-
email_from_name¶ String(From email address and name)
-
email_validation¶ Boolean(Flag to enable email validation)
-
enhanced_security¶ Boolean(Enable enhanced security)
-
global_purge¶ Boolean(Flag to enable global purge rule support)
-
google_client_id¶ String(Google information)
-
google_client_secret¶ String(Google information)
-
google_service_account¶ String(Google information)
-
hide_help_tool¶ Boolean(Flag to hide the help tool globally)
-
id¶ Integer(Primary key for internal use)
-
indicator_html¶ String(HTML for the terms of use, privacy policy and indicators of use)
-
indicator_md5¶ String(MD5 sums of the terms of use, privacy policy and indicators of use)
-
log_days¶ Integer(Number of days to retain logs for)
String(Login page banner text)
DateTime(Login page banner text)
DateTime(Login page banner text)
-
passwdqc¶ String(Password controls)
-
passwdqc_description¶ String(Password controls)
-
permissions_mask¶ String(Permissions mask)
-
phr_bypass_study_oversized_threshold¶ Boolean(Bypass oversized threshold for studies in PHR accounts)
-
phr_permissions¶ String(The PHR permissions over-ride)
-
privacy_html¶ String(HTML for the terms of use, privacy policy and indicators of use)
-
privacy_md5¶ String(MD5 sums of the terms of use, privacy policy and indicators of use)
-
prometheus_password¶ String(Prometheus password for scraping)
-
rsna_xds¶ String(RSNA XDS server)
-
stripe_ca¶ String(Stripe connect client id)
-
stripe_pk¶ String(Stripe public key)
-
stripe_sk¶ String(Stripe secret key)
-
stripe_uri¶ String(Stripe URI)
-
sysadmin_pin_required¶ Boolean(Require 2FA for a support or sysadmin user)
-
terms_html¶ String(HTML for the terms of use, privacy policy and indicators of use)
-
terms_md5¶ String(MD5 sums of the terms of use, privacy policy and indicators of use)
-
twilio_callback_password¶ String(Twilio key, secret, from phone number and callback password for HTTP basic authentication)
-
twilio_from¶ String(Twilio key, secret, from phone number and callback password for HTTP basic authentication)
-
twilio_pk¶ String(Twilio key, secret, from phone number and callback password for HTTP basic authentication)
-
twilio_sk¶ String(Twilio key, secret, from phone number and callback password for HTTP basic authentication)
-
ui_json¶ String(System-wide UI settings)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
updates_html¶ String(Updates text)
-
updates_html_version¶ Integer(Updates text)
-
updates_release_notes¶ String(Updates text)
-
updates_show_start¶ DateTime(Updates text)
-
updates_show_stop¶ DateTime(Updates text)
-
user_settings¶ DictField(Default user settings)
-
watchdog_host¶ String(Watch dog host, used if not set in site.conf)
-
websocket_domain¶ String(Websocket domain)
-
-
class
ambra_sdk.models.generated.Tag(*, id=None, uuid=None, object=None, tag=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Tag.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
object¶ String(The associated user and object class)
-
tag¶ String(The tag)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. The associated user and object class)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.TagObject(*, id=None, uuid=None, object=None, object_id=None, tags=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ TagObject.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
object¶ String(The user and object fields)
-
object_id¶ String(FK. The user and object fields)
DictField(The tags)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. The user and object fields)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.TemplateAssign(*, id=None, uuid=None, account_id=None, account=None, name=None, version=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ TemplateAssign.
-
account_id¶ String(FK. Account the template is for)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
name¶ String(Template name, this is the directory name for the template)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
version¶ String(Version, this is the file name to serve)
-
-
class
ambra_sdk.models.generated.Terminology(*, id=None, uuid=None, account_id=None, account=None, language=None, tag=None, value=None, vanity=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Terminology.
-
account_id¶ String(FK. Account id if we have an over ride)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
language¶ String(ISO 639-1 code of the language)
-
tag¶ String(Dynamic tag)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
value¶ String(The translated value)
-
vanity¶ String(Vanity override)
-
-
class
ambra_sdk.models.generated.TrainingAccount(*, id=None, uuid=None, account_id=None, account=None, form_description=None, form_number=None, group_description=None, group_number=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ TrainingAccount.
-
account_id¶ String(FK. )
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
form_description¶ String()
-
form_number¶ String()
-
group_description¶ String()
-
group_number¶ Integer()
-
id¶ Integer(Primary key for internal use)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.TrainingUser(*, id=None, uuid=None, form_number=None, results=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ TrainingUser.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
form_number¶ String()
-
id¶ Integer(Primary key for internal use)
-
results¶ DictField(The form data from the training)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. )
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.TrustedDevice(*, id=None, uuid=None, client_address=None, user_id=None, user=None, created=None, updated=None)[source]¶ TrustedDevice.
-
client_address¶ String(IP address)
-
created¶ DateTime(Timestamp when the record was created)
-
id¶ Integer(Primary key for internal use)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
user_id¶ String(FK. User who owns the device)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.User(*, id=None, uuid=None, access_token=None, allowed_login_brands=None, app_password=None, billing=None, blocked=None, disabled=None, email=None, email_validation=None, 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, first=None, indicator_md5=None, last=None, last_login=None, last_reset=None, mobile_phone=None, namespace_id=None, namespace=None, npi=None, oauth=None, password=None, pin_required=None, pkey_last_reset=None, privacy_md5=None, public_key=None, refresh_token=None, signature=None, support=None, sysadmin=None, terms_md5=None, time_zone=None, token=None, ui_json=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ User.
-
access_token¶ String(Stripe access token)
-
allowed_login_brands¶ String(A list of brands user can login from)
-
app_password¶ String(Password)
-
billing¶ Boolean(Are they a billing person)
-
blocked¶ Boolean(Is a the user blocked from the system)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
disabled¶ Boolean(Is a the user disabled from the system)
-
email¶ String(Email address)
-
email_validation¶ Boolean(2 - email is validated)
-
event_approve¶ Boolean(The event flags for the personal namespace)
-
event_case_assignment¶ Boolean(The event flags for the personal namespace)
-
event_harvest¶ Boolean(The event flags for the personal namespace)
-
event_incoming_study_request¶ Boolean(The event flags for the personal namespace)
-
event_link¶ Boolean(The event flags for the personal namespace)
-
event_link_mine¶ Boolean(The event flags for the personal namespace)
-
event_message¶ Boolean(The event flags for the personal namespace)
-
event_new_report¶ Boolean(The event flags for the personal namespace)
-
event_query_add¶ Boolean(The event flags for the personal namespace)
-
event_query_edit¶ Boolean(The event flags for the personal namespace)
-
event_query_reply¶ Boolean(The event flags for the personal namespace)
-
event_report_remove¶ Boolean(The event flags for the personal namespace)
Boolean(The event flags for the personal namespace)
-
event_site_qualified¶ Boolean(The event flags for the personal namespace)
-
event_status_change¶ Boolean(The event flags for the personal namespace)
-
event_study_comment¶ Boolean(The event flags for the personal namespace)
-
event_thin_study_fail¶ Boolean(The event flags for the personal namespace)
-
event_thin_study_success¶ Boolean(The event flags for the personal namespace)
-
event_upload¶ Boolean(The event flags for the personal namespace)
-
event_upload_fail¶ Boolean(The event flags for the personal namespace)
-
first¶ String(Name)
-
id¶ Integer(Primary key for internal use)
-
indicator_md5¶ String(MD5 sums of the accepted terms of use, privacy policy and indicators of use)
-
last¶ String(Name)
-
last_login¶ DateTime(This is depreciated and stored in redis, this field should be dropped in the future)
-
last_reset¶ DateTime(Time the password was last reset)
-
mobile_phone¶ String(Mobile phone)
-
namespace_id¶ String(FK. Their namespace)
-
npi¶ String(NPI number)
-
oauth¶ String(OAuth id and refresh token)
-
password¶ String(Password)
-
pin_required¶ Boolean(Is a PIN required for login)
-
pkey_last_reset¶ DateTime(Time the public key was last reset)
-
privacy_md5¶ String(MD5 sums of the accepted terms of use, privacy policy and indicators of use)
-
public_key¶ String(Public key for authentication)
-
refresh_token¶ String(OAuth id and refresh token)
-
signature¶ String(Signature image (base64))
-
support¶ Boolean(Are they a support person)
-
sysadmin¶ Boolean(Are they a system administrator)
-
terms_md5¶ String(MD5 sums of the accepted terms of use, privacy policy and indicators of use)
-
time_zone¶ String(Timezone)
-
token¶ String(Shared secret for TOKEN authentication)
-
ui_json¶ String(JSON for UI settings)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.UserAccount(*, id=None, uuid=None, account_alias=None, account_email=None, account_id=None, account=None, account_login=None, account_password=None, customfields=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_field=None, global_role_id=None, global_role=None, last_reset=None, max_sessions=None, password_reset=None, role_id=None, role=None, session_expire=None, settings=None, sso_only=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ UserAccount.
-
account_alias¶ String(The users alias for the account)
-
account_email¶ String(The email for account. One needed if this is different that the users email)
-
account_id¶ String(FK. Mapping between the user and account)
-
account_login¶ String(The users login name for the account)
-
account_password¶ String(The users password in the account)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
customfields¶ DictField(Custom fields)
-
epic_user¶ String(Epic user to match account user against)
-
event_approve¶ Boolean(The event flags)
-
event_case_assignment¶ Boolean(The event flags)
-
event_harvest¶ Boolean(The event flags)
-
event_incoming_study_request¶ Boolean(The event flags)
-
event_join¶ Boolean(The event flags)
-
event_link¶ Boolean(The event flags)
-
event_link_mine¶ Boolean(The event flags)
-
event_message¶ Boolean(The event flags)
-
event_new_report¶ Boolean(The event flags)
-
event_node¶ Boolean(The event flags)
-
event_purge¶ Boolean(The event flags)
-
event_query_add¶ Boolean(The event flags)
-
event_query_edit¶ Boolean(The event flags)
-
event_query_reply¶ Boolean(The event flags)
-
event_report_remove¶ Boolean(The event flags)
Boolean(The event flags)
-
event_site_qualified¶ Boolean(The event flags)
-
event_status_change¶ Boolean(The event flags)
-
event_study_comment¶ Boolean(The event flags)
-
event_thin_study_fail¶ Boolean(The event flags)
-
event_thin_study_success¶ Boolean(The event flags)
-
event_upload¶ Boolean(The event flags)
-
event_upload_fail¶ Boolean(The event flags)
-
global_field¶ Boolean(This user is automatically added to every group and location in the account)
-
global_role_id¶ String(FK. This role is used as a namespace role if defined)
-
id¶ Integer(Primary key for internal use)
-
last_reset¶ DateTime(Time the password was last reset)
-
max_sessions¶ Integer(Override for the max number of sessions a user can have)
-
password_reset¶ Boolean(Flag to reset the password)
-
role_id¶ String(FK. Role)
-
session_expire¶ Integer(Minutes before an idle session expires, this is an override of the account setting)
-
settings¶ DictField(Account settings overrides)
-
sso_only¶ Boolean(Flag that the user can only login via SSO)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. Mapping between the user and account)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.UserAnalytics(*, id=None, account_id=None, account=None, day=None, namespace_id=None, namespace=None, study_approve=None, study_reject=None, study_upload_epic=None, study_view=None, study_view_load_cnt=None, study_view_load_tot=None, time=None, user_id=None, user=None)[source]¶ UserAnalytics.
-
account_id¶ String(FK. The primary keys)
-
day¶ Date(The day and time)
-
id¶ Integer(Primary key for internal use)
-
namespace_id¶ String(FK. The primary keys)
-
study_approve¶ Integer(The metrics)
-
study_reject¶ Integer(The metrics)
-
study_upload_epic¶ Integer(The metrics)
-
study_view¶ Integer(The metrics)
-
study_view_load_cnt¶ Integer(Study view count and total load time)
-
study_view_load_tot¶ Integer(Study view count and total load time)
-
time¶ DateTime(The day and time)
-
user_id¶ String(FK. The primary keys)
-
-
class
ambra_sdk.models.generated.UserAws(*, id=None, uuid=None, customer_identifier=None, product_code=None, subscription_state=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ UserAws.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
customer_identifier¶ String(The AWS customer identifier)
-
id¶ Integer(Primary key for internal use)
-
product_code¶ String(The product they are registered for)
-
subscription_state¶ String(The state of the subscription)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. User id)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.UserGroup(*, id=None, uuid=None, 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, group_id=None, group=None, no_physician_alias_share=None, role_id=None, role=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ UserGroup.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
event_approve¶ Boolean(The event flags)
-
event_case_assignment¶ Boolean(The event flags)
-
event_harvest¶ Boolean(The event flags)
-
event_incoming_study_request¶ Boolean(The event flags)
-
event_link¶ Boolean(The event flags)
-
event_link_mine¶ Boolean(The event flags)
-
event_message¶ Boolean(The event flags)
-
event_new_report¶ Boolean(The event flags)
-
event_node¶ Boolean(The event flags)
-
event_query_add¶ Boolean(The event flags)
-
event_query_edit¶ Boolean(The event flags)
-
event_query_reply¶ Boolean(The event flags)
-
event_report_remove¶ Boolean(The event flags)
Boolean(The event flags)
-
event_site_qualified¶ Boolean(The event flags)
-
event_status_change¶ Boolean(The event flags)
-
event_study_comment¶ Boolean(The event flags)
-
event_thin_study_fail¶ Boolean(The event flags)
-
event_thin_study_success¶ Boolean(The event flags)
-
event_upload¶ Boolean(The event flags)
-
event_upload_fail¶ Boolean(The event flags)
-
group_id¶ String(FK. Mapping between the user and group)
-
id¶ Integer(Primary key for internal use)
Boolean(Do not do a physician alias share into this group)
-
role_id¶ String(FK. Role override for the user in this group)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. Mapping between the user and group)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.UserInvite(*, id=None, uuid=None, account_id=None, account=None, email=None, global_field=None, groups=None, locations=None, role_id=None, role=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ UserInvite.
-
account_id¶ String(FK. Account the invitation is for)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
email¶ String(Email address to invite)
-
global_field¶ Boolean(This user is automatically added to every group and location in the account)
-
groups¶ String(JSON hashes of the groups and locations to add them to with the role as the key value)
-
id¶ Integer(Primary key for internal use)
-
locations¶ String(JSON hashes of the groups and locations to add them to with the role as the key value)
-
role_id¶ String(FK. Role the invitation is for)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. Id of the user who accepted the invitation)
-
uuid¶ String(UUID for external use)
-
UserInviteShare.
DateTime(Timestamp when the record was created)
String(FK. ID of the user who created the record)
alias of
User
String(Email address to invite)
Integer(Primary key for internal use)
String(Share message)
alias of
Study
String(FK. Id for the study to be shared)
DateTime(Timestamp when the record was last updated)
String(FK. ID of the user who updated the record)
alias of
User
alias of
User
String(FK. Id the invitation is from)
String(UUID for external use)
-
class
ambra_sdk.models.generated.UserLocation(*, id=None, uuid=None, 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, location_id=None, location=None, no_physician_alias_share=None, role_id=None, role=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ UserLocation.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
event_approve¶ Boolean(The event flags)
-
event_case_assignment¶ Boolean(The event flags)
-
event_harvest¶ Boolean(The event flags)
-
event_incoming_study_request¶ Boolean(The event flags)
-
event_link¶ Boolean(The event flags)
-
event_link_mine¶ Boolean(The event flags)
-
event_message¶ Boolean(The event flags)
-
event_new_report¶ Boolean(The event flags)
-
event_node¶ Boolean(The event flags)
-
event_query_add¶ Boolean(The event flags)
-
event_query_edit¶ Boolean(The event flags)
-
event_query_reply¶ Boolean(The event flags)
-
event_report_remove¶ Boolean(The event flags)
Boolean(The event flags)
-
event_site_qualified¶ Boolean(The event flags)
-
event_status_change¶ Boolean(The event flags)
-
event_study_comment¶ Boolean(The event flags)
-
event_thin_study_fail¶ Boolean(The event flags)
-
event_thin_study_success¶ Boolean(The event flags)
-
event_upload¶ Boolean(The event flags)
-
event_upload_fail¶ Boolean(The event flags)
-
id¶ Integer(Primary key for internal use)
-
location_id¶ String(FK. Mapping between the user and location)
Boolean(Do not do a physician alias share into this location)
-
role_id¶ String(FK. Role override for the user in this location)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. Mapping between the user and location)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.UserSite(*, id=None, uuid=None, role_name=None, site_id=None, site=None, user_id=None, user=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ UserSite.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
role_name¶ String(Role will be mapped to a study account role by name)
-
site_id¶ String(FK. Mapping between the user and site)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
user_id¶ String(FK. Mapping between the user and site)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Validate(*, id=None, uuid=None, account_id=None, account=None, conditions=None, name=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Validate.
-
account_id¶ String(FK. The associated account)
-
conditions¶ String(The validate conditions)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
name¶ String(Name)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.Webhook(*, id=None, uuid=None, account_id=None, account=None, 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, last_error=None, max_age=None, method=None, name=None, node_id=None, node=None, once=None, parameters=None, retry=None, retry_count=None, sid_user_id=None, sid_user=None, suspended=None, url=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ Webhook.
-
account_id¶ String(FK. The account)
-
auth¶ String(The webhook auth)
-
by_accession_number¶ Boolean(Expand the once to check by accession_number as well)
-
by_uid¶ Boolean(Expand the once to check by study_uid as well)
-
by_webhook_event¶ Boolean(Apply the once to a webhook event for the WEBHOOK_FAILED)
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
cron¶ String(Cron string for a cron type of webhook)
-
delay¶ Integer(Number of seconds to delay running this webhook after it is triggered)
-
event¶ String(The event to trigger the webhook for)
-
filter_field¶ String(Filter field and regexp)
-
filter_regexp¶ String(Filter field and regexp)
-
id¶ Integer(Primary key for internal use)
-
last_error¶ String(Note this value is now stored in the redis and this field should be depreciated and dropped)
-
max_age¶ Integer(Ignore studies that are more than this number of days old)
-
method¶ String(Call method)
-
name¶ String(Name)
-
node_id¶ String(FK. The node id to proxy the call through)
-
once¶ Boolean(Run this only once for a specific study)
-
parameters¶ String(The parameters for the call)
-
retry¶ Boolean(Retry if it fails and a counter to track the retries)
-
retry_count¶ Integer(Retry if it fails and a counter to track the retries)
-
sid_user_id¶ String(FK. The user id to generate a sid as)
-
suspended¶ Boolean(Suspend this hook from running)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
url¶ String(The URL to call)
-
uuid¶ String(UUID for external use)
-
-
class
ambra_sdk.models.generated.WebhookNode(*, id=None, uuid=None, method=None, node_id=None, node=None, parameters=None, pickup=None, status=None, url=None, webhook_id=None, webhook=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ WebhookNode.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
method¶ String(Call method)
-
node_id¶ String(FK. The node id to proxy the call through)
-
parameters¶ String(The parameters for the call)
-
pickup¶ DateTime(When was this picked up by the node)
-
status¶ String(Status of the delivery)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
url¶ String(The URL to call)
-
uuid¶ String(UUID for external use)
-
webhook_id¶ String(FK. The webhook id)
-
-
class
ambra_sdk.models.generated.WebhookOnce(*, id=None, uuid=None, study_id=None, study=None, webhook_id=None, webhook=None, created=None, created_by=None, created_by_obj=None, updated=None, updated_by=None, updated_by_obj=None)[source]¶ WebhookOnce.
-
created¶ DateTime(Timestamp when the record was created)
-
created_by¶ String(FK. ID of the user who created the record)
-
id¶ Integer(Primary key for internal use)
-
study_id¶ String(FK. The webhook and study id)
-
updated¶ DateTime(Timestamp when the record was last updated)
-
updated_by¶ String(FK. ID of the user who updated the record)
-
uuid¶ String(UUID for external use)
-
webhook_id¶ String(FK. The webhook and study id)
-