start_patient_insights_job¶
Operation¶
start_patient_insights_job
¶
start_patient_insights_job(request: StartPatientInsightsJobInput | StartPatientInsightsJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartPatientInsightsJobInputDict]) -> StartPatientInsightsJobOutput
Starts a new patient insights job.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
StartPatientInsightsJobInput | StartPatientInsightsJobInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[StartPatientInsightsJobInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StartPatientInsightsJobOutput
|
An instance of |
start_patient_insights_job
async
¶
start_patient_insights_job(request: StartPatientInsightsJobInput | StartPatientInsightsJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartPatientInsightsJobInputDict]) -> StartPatientInsightsJobOutput
Starts a new patient insights job.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
StartPatientInsightsJobInput | StartPatientInsightsJobInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[StartPatientInsightsJobInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StartPatientInsightsJobOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
StartPatientInsightsJobInputDict
¶
Bases: TypedDict
Dictionary form of StartPatientInsightsJobInput.
Attributes¶
client_token
instance-attribute
¶
client_token: str | None
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
encounter_context
instance-attribute
¶
encounter_context: Required[PatientInsightsEncounterContext | PatientInsightsEncounterContextDict]
input_data_config
instance-attribute
¶
input_data_config: Required[InputDataConfig | InputDataConfigDict]
insights_context
instance-attribute
¶
insights_context: Required[InsightsContext | InsightsContextDict]
output_data_config
instance-attribute
¶
output_data_config: Required[OutputDataConfig | OutputDataConfigDict]
patient_context
instance-attribute
¶
patient_context: Required[PatientInsightsPatientContext | PatientInsightsPatientContextDict]
StartPatientInsightsJobInput
dataclass
¶
Bases: _SerdeShape
Dataclass for StartPatientInsightsJobInput structure.
Attributes¶
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
encounter_context
class-attribute
instance-attribute
¶
encounter_context: PatientInsightsEncounterContext | None = ...
input_data_config
class-attribute
instance-attribute
¶
input_data_config: InputDataConfig | None = ...
insights_context
class-attribute
instance-attribute
¶
insights_context: InsightsContext | None = ...
output_data_config
class-attribute
instance-attribute
¶
output_data_config: OutputDataConfig | None = ...
patient_context
class-attribute
instance-attribute
¶
patient_context: PatientInsightsPatientContext | None = ...
Output¶
StartPatientInsightsJobOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for StartPatientInsightsJobOutput structure.
Attributes¶
creation_time
class-attribute
instance-attribute
¶
creation_time: datetime | None = ...
Date and time the patient insights job was submitted.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.