Skip to content

ConnectHealth  >  Operations  >  start_patient_insights_job

start_patient_insights_job

Operation

start_patient_insights_job async 

start_patient_insights_job(input: StartPatientInsightsJobInput, plugins: list[Plugin] | None = None) -> StartPatientInsightsJobOutput

Starts a new patient insights job.

Parameters:

Name Type Description Default
input StartPatientInsightsJobInput

An instance of StartPatientInsightsJobInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
StartPatientInsightsJobOutput

An instance of StartPatientInsightsJobOutput.

Input

StartPatientInsightsJobInput dataclass

Dataclass for StartPatientInsightsJobInput structure.

Attributes

client_token class-attribute instance-attribute 
client_token: str | None = None

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

domain_id class-attribute instance-attribute 
domain_id: str | None = None
encounter_context class-attribute instance-attribute 
encounter_context: PatientInsightsEncounterContext | None = None
input_data_config class-attribute instance-attribute 
input_data_config: InputDataConfig | None = None
insights_context class-attribute instance-attribute 
insights_context: InsightsContext | None = None
output_data_config class-attribute instance-attribute 
output_data_config: OutputDataConfig | None = None
patient_context class-attribute instance-attribute 
patient_context: PatientInsightsPatientContext | None = None
user_context class-attribute instance-attribute 
user_context: UserContext | None = None

Output

StartPatientInsightsJobOutput dataclass

Dataclass for StartPatientInsightsJobOutput structure.

Attributes

creation_time class-attribute instance-attribute 
creation_time: datetime | None = None

Date and time the patient insights job was submitted.

job_arn instance-attribute 
job_arn: str
job_id instance-attribute 
job_id: str