phenoml 0.0.2__py3-none-any.whl → 0.0.17__py3-none-any.whl

phenoml/workflows/types/__init__.py

@@ -0,0 +1,53 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+from .create_workflow_request_fhir_provider_id import CreateWorkflowRequestFhirProviderId
+from .create_workflow_response import CreateWorkflowResponse
+from .decision_node_definition import DecisionNodeDefinition
+from .execute_workflow_response import ExecuteWorkflowResponse
+from .execute_workflow_response_results import ExecuteWorkflowResponseResults
+from .lang2fhir_create_definition import Lang2FhirCreateDefinition
+from .lang2fhir_search_definition import Lang2FhirSearchDefinition
+from .list_workflows_response import ListWorkflowsResponse
+from .step_operation import StepOperation
+from .sub_workflow_definition import SubWorkflowDefinition
+from .update_workflow_request_fhir_provider_id import UpdateWorkflowRequestFhirProviderId
+from .workflow_config import WorkflowConfig
+from .workflow_definition import WorkflowDefinition
+from .workflow_graph import WorkflowGraph
+from .workflow_response import WorkflowResponse
+from .workflow_response_graph import WorkflowResponseGraph
+from .workflow_step import WorkflowStep
+from .workflow_step_summary import WorkflowStepSummary
+from .workflow_step_summary_type import WorkflowStepSummaryType
+from .workflow_step_type import WorkflowStepType
+from .workflows_delete_response import WorkflowsDeleteResponse
+from .workflows_get_response import WorkflowsGetResponse
+from .workflows_update_response import WorkflowsUpdateResponse
+
+__all__ = [
+    "CreateWorkflowRequestFhirProviderId",
+    "CreateWorkflowResponse",
+    "DecisionNodeDefinition",
+    "ExecuteWorkflowResponse",
+    "ExecuteWorkflowResponseResults",
+    "Lang2FhirCreateDefinition",
+    "Lang2FhirSearchDefinition",
+    "ListWorkflowsResponse",
+    "StepOperation",
+    "SubWorkflowDefinition",
+    "UpdateWorkflowRequestFhirProviderId",
+    "WorkflowConfig",
+    "WorkflowDefinition",
+    "WorkflowGraph",
+    "WorkflowResponse",
+    "WorkflowResponseGraph",
+    "WorkflowStep",
+    "WorkflowStepSummary",
+    "WorkflowStepSummaryType",
+    "WorkflowStepType",
+    "WorkflowsDeleteResponse",
+    "WorkflowsGetResponse",
+    "WorkflowsUpdateResponse",
+]

phenoml/workflows/types/create_workflow_request_fhir_provider_id.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreateWorkflowRequestFhirProviderId = typing.Union[str, typing.List[str]]

phenoml/workflows/types/create_workflow_response.py

@@ -0,0 +1,44 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .workflow_definition import WorkflowDefinition
+from .workflow_response import WorkflowResponse
+
+
+class CreateWorkflowResponse(UniversalBaseModel):
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether the workflow was created successfully
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Status message
+    """
+
+    workflow_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    ID of the created workflow
+    """
+
+    workflow: typing.Optional[WorkflowResponse] = pydantic.Field(default=None)
+    """
+    Simplified workflow response with only essential step information
+    """
+
+    workflow_details: typing.Optional[WorkflowDefinition] = pydantic.Field(default=None)
+    """
+    Only included when verbose=true - contains full implementation details including operation definitions and placeholders
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

phenoml/{tools/types/fhir_client_config.py → workflows/types/decision_node_definition.py}

@@ -6,19 +6,20 @@ import pydantic
 from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
-class FhirClientConfig(UniversalBaseModel):
+class DecisionNodeDefinition(UniversalBaseModel):
+    expression: typing.Optional[str] = pydantic.Field(default=None)
     """
-    Provider-specific configuration and metadata
+    Simple equality expression for decision logic
     """
 
-    fhir_store_id: typing.Optional[str] = pydantic.Field(default=None)
+    paths: typing.Optional[typing.Dict[str, str]] = pydantic.Field(default=None)
     """
-    FHIR store ID for Google Healthcare provider
+    Maps decision outcomes to next step IDs
     """
 
-    on_behalf_of_email: typing.Optional[str] = pydantic.Field(default=None)
+    runtime_placeholders: typing.Optional[typing.Dict[str, str]] = pydantic.Field(default=None)
     """
-    Email address to use for On-Behalf-Of requests (Medplum only). If provided, the request will be made on behalf of the Patient or Practitioner with this email address.
+    Maps placeholder tokens to their input data paths for decision evaluation
     """
 
     if IS_PYDANTIC_V2:

phenoml/workflows/types/execute_workflow_response.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .execute_workflow_response_results import ExecuteWorkflowResponseResults
+
+
+class ExecuteWorkflowResponse(UniversalBaseModel):
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether the workflow execution was successful
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Status message with execution details
+    """
+
+    results: typing.Optional[ExecuteWorkflowResponseResults] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

phenoml/{construe/types/internal_server_error_body.py → workflows/types/execute_workflow_response_results.py}

@@ -6,15 +6,10 @@ import pydantic
 from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
-class InternalServerErrorBody(UniversalBaseModel):
-    status: typing.Optional[int] = pydantic.Field(default=None)
+class ExecuteWorkflowResponseResults(UniversalBaseModel):
+    steps: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
     """
-    HTTP status code.
-    """
-
-    message: typing.Optional[str] = pydantic.Field(default=None)
-    """
-    Error message.
+    Results for each executed workflow step, keyed by step ID
     """
 
     if IS_PYDANTIC_V2:

phenoml/workflows/types/lang2fhir_create_definition.py

@@ -0,0 +1,37 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class Lang2FhirCreateDefinition(UniversalBaseModel):
+    original_description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Original natural language description
+    """
+
+    resource_type: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    FHIR resource type to create
+    """
+
+    resource_template: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    Prepared FHIR resource template
+    """
+
+    runtime_placeholders: typing.Optional[typing.Dict[str, str]] = pydantic.Field(default=None)
+    """
+    Maps placeholder tokens to their input data paths
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

phenoml/workflows/types/lang2fhir_search_definition.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class Lang2FhirSearchDefinition(UniversalBaseModel):
+    original_query: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Original natural language query
+    """
+
+    resource_type: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    FHIR resource type to search
+    """
+
+    search_parameters: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    Prepared FHIR search parameters
+    """
+
+    required_fields: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Fields needed from search results
+    """
+
+    runtime_placeholders: typing.Optional[typing.Dict[str, str]] = pydantic.Field(default=None)
+    """
+    Maps placeholder tokens to their input data paths
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

phenoml/workflows/types/list_workflows_response.py

@@ -0,0 +1,39 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .workflow_definition import WorkflowDefinition
+from .workflow_response import WorkflowResponse
+
+
+class ListWorkflowsResponse(UniversalBaseModel):
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether the workflow list was retrieved successfully
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Status message
+    """
+
+    workflows: typing.Optional[typing.List[WorkflowResponse]] = pydantic.Field(default=None)
+    """
+    Array of simplified workflow responses for the authenticated user
+    """
+
+    workflow_details: typing.Optional[typing.List[WorkflowDefinition]] = pydantic.Field(default=None)
+    """
+    Only included when verbose=true - contains full implementation details for all workflows
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

phenoml/workflows/types/step_operation.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .decision_node_definition import DecisionNodeDefinition
+from .lang2fhir_create_definition import Lang2FhirCreateDefinition
+from .lang2fhir_search_definition import Lang2FhirSearchDefinition
+from .sub_workflow_definition import SubWorkflowDefinition
+
+
+class StepOperation(UniversalBaseModel):
+    search_definition: typing.Optional[Lang2FhirSearchDefinition] = None
+    create_definition: typing.Optional[Lang2FhirCreateDefinition] = None
+    workflow_definition: typing.Optional[SubWorkflowDefinition] = None
+    decision_definition: typing.Optional[DecisionNodeDefinition] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

phenoml/workflows/types/sub_workflow_definition.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class SubWorkflowDefinition(UniversalBaseModel):
+    workflow_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    ID of the workflow to execute as a sub-workflow
+    """
+
+    input: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    Input data to pass to the sub-workflow
+    """
+
+    runtime_placeholders: typing.Optional[typing.Dict[str, str]] = pydantic.Field(default=None)
+    """
+    Maps placeholder tokens to their input data paths for sub-workflow
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

phenoml/workflows/types/update_workflow_request_fhir_provider_id.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+UpdateWorkflowRequestFhirProviderId = typing.Union[str, typing.List[str]]

phenoml/workflows/types/workflow_config.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class WorkflowConfig(UniversalBaseModel):
+    fhir_provider_ids: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    FHIR provider IDs for executing workflow steps
+    """
+
+    dynamic_generation: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether to use dynamic lang2fhir generation instead of pre-populated templates
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

phenoml/workflows/types/workflow_definition.py

@@ -0,0 +1,57 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .workflow_config import WorkflowConfig
+from .workflow_graph import WorkflowGraph
+
+
+class WorkflowDefinition(UniversalBaseModel):
+    id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier for the workflow
+    """
+
+    user_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    ID of the user who created the workflow
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Human-readable name for the workflow
+    """
+
+    workflow_instructions: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Natural language instructions that define the workflow logic
+    """
+
+    sample_data: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    Sample data used for workflow graph generation
+    """
+
+    config: typing.Optional[WorkflowConfig] = None
+    graph: typing.Optional[WorkflowGraph] = None
+    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Timestamp when the workflow was created
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Timestamp when the workflow was last updated
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

phenoml/workflows/types/workflow_graph.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .workflow_step import WorkflowStep
+
+
+class WorkflowGraph(UniversalBaseModel):
+    steps: typing.Optional[typing.List[WorkflowStep]] = pydantic.Field(default=None)
+    """
+    Ordered list of workflow execution steps
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

phenoml/workflows/types/workflow_response.py

@@ -0,0 +1,61 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .workflow_config import WorkflowConfig
+from .workflow_response_graph import WorkflowResponseGraph
+
+
+class WorkflowResponse(UniversalBaseModel):
+    """
+    Simplified workflow representation without implementation details
+    """
+
+    id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier for the workflow
+    """
+
+    user_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    ID of the user who created the workflow
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Human-readable name for the workflow
+    """
+
+    workflow_instructions: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Natural language instructions that define the workflow logic
+    """
+
+    sample_data: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    Sample data used for workflow graph generation
+    """
+
+    config: typing.Optional[WorkflowConfig] = None
+    graph: typing.Optional[WorkflowResponseGraph] = None
+    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Timestamp when the workflow was created
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Timestamp when the workflow was last updated
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

phenoml/workflows/types/workflow_response_graph.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .workflow_step_summary import WorkflowStepSummary
+
+
+class WorkflowResponseGraph(UniversalBaseModel):
+    steps: typing.Optional[typing.List[WorkflowStepSummary]] = pydantic.Field(default=None)
+    """
+    Simplified list of workflow steps without operation details
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

phenoml/workflows/types/workflow_step.py

@@ -0,0 +1,55 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .step_operation import StepOperation
+from .workflow_step_type import WorkflowStepType
+
+
+class WorkflowStep(UniversalBaseModel):
+    id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier for the step
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Human-readable name for the step
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Detailed description of what the step does
+    """
+
+    type: typing.Optional[WorkflowStepType] = pydantic.Field(default=None)
+    """
+    Type of operation this step performs
+    """
+
+    operation: typing.Optional[StepOperation] = None
+    provider_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Selected FHIR provider ID for this step
+    """
+
+    dependencies: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    IDs of steps this step depends on
+    """
+
+    dynamic_generation: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether to use dynamic lang2fhir generation for this step
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

phenoml/workflows/types/workflow_step_summary.py

@@ -0,0 +1,47 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .workflow_step_summary_type import WorkflowStepSummaryType
+
+
+class WorkflowStepSummary(UniversalBaseModel):
+    """
+    Simplified workflow step without implementation details
+    """
+
+    id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier for the step
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Human-readable name for the step
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Detailed description of what the step does
+    """
+
+    type: typing.Optional[WorkflowStepSummaryType] = pydantic.Field(default=None)
+    """
+    Type of operation this step performs
+    """
+
+    provider_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Selected FHIR provider ID for this step
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

phenoml/workflows/types/workflow_step_summary_type.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+WorkflowStepSummaryType = typing.Union[typing.Literal["search", "create", "workflow", "decision_node"], typing.Any]