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

phenoml/tools/client.py

@@ -6,13 +6,10 @@ from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
 from .mcp_server.client import AsyncMcpServerClient, McpServerClient
 from .raw_client import AsyncRawToolsClient, RawToolsClient
-from .types.cohort_request_provider import CohortRequestProvider
 from .types.cohort_response import CohortResponse
-from .types.fhir_client_config import FhirClientConfig
-from .types.lang2fhir_and_create_request_provider import Lang2FhirAndCreateRequestProvider
+from .types.lang2fhir_and_create_multi_response import Lang2FhirAndCreateMultiResponse
 from .types.lang2fhir_and_create_request_resource import Lang2FhirAndCreateRequestResource
 from .types.lang2fhir_and_create_response import Lang2FhirAndCreateResponse
-from .types.lang2fhir_and_search_request_provider import Lang2FhirAndSearchRequestProvider
 from .types.lang2fhir_and_search_response import Lang2FhirAndSearchResponse
 
 # this is used as the default value for optional parameters
@@ -40,8 +37,9 @@ class ToolsClient:
         *,
         resource: Lang2FhirAndCreateRequestResource,
         text: str,
-        provider: typing.Optional[Lang2FhirAndCreateRequestProvider] = OMIT,
-        meta: typing.Optional[FhirClientConfig] = OMIT,
+        phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
+        provider: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Lang2FhirAndCreateResponse:
         """
@@ -55,10 +53,16 @@ class ToolsClient:
         text : str
             Natural language text to convert to FHIR resource
 
-        provider : typing.Optional[Lang2FhirAndCreateRequestProvider]
-            FHIR provider to use for storing the resource
+        phenoml_on_behalf_of : typing.Optional[str]
+            Optional header for on-behalf-of authentication. Used when making requests on behalf of another user or entity.
+            Must be in the format: Patient/{uuid} or Practitioner/{uuid}
 
-        meta : typing.Optional[FhirClientConfig]
+        phenoml_fhir_provider : typing.Optional[str]
+            Optional header for FHIR provider authentication. Contains credentials in the format {fhir_provider_id}:{oauth2_token}.
+            Multiple FHIR provider integrations can be provided as comma-separated values.
+
+        provider : typing.Optional[str]
+            FHIR provider ID - must be a valid UUID from existing FHIR providers. also supports provider by name (e.g. medplum)
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -76,12 +80,87 @@ class ToolsClient:
             token="YOUR_TOKEN",
         )
         client.tools.create_fhir_resource(
+            phenoml_on_behalf_of="Patient/550e8400-e29b-41d4-a716-446655440000",
+            phenoml_fhir_provider="550e8400-e29b-41d4-a716-446655440000:eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c...",
             resource="auto",
             text="Patient John Doe has severe asthma with acute exacerbation",
         )
         """
         _response = self._raw_client.create_fhir_resource(
-            resource=resource, text=text, provider=provider, meta=meta, request_options=request_options
+            resource=resource,
+            text=text,
+            phenoml_on_behalf_of=phenoml_on_behalf_of,
+            phenoml_fhir_provider=phenoml_fhir_provider,
+            provider=provider,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def create_fhir_resources_multi(
+        self,
+        *,
+        text: str,
+        provider: str,
+        phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
+        version: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Lang2FhirAndCreateMultiResponse:
+        """
+        Extracts multiple FHIR resources from natural language text and stores them in a FHIR server.
+        Automatically detects Patient, Condition, MedicationRequest, Observation, and other resource types.
+        Resources are linked with proper references and submitted as a transaction bundle.
+        For FHIR servers that don't auto-resolve urn:uuid references, this endpoint will automatically
+        resolve them via PUT requests after the initial bundle creation.
+
+        Parameters
+        ----------
+        text : str
+            Natural language text containing multiple clinical concepts to extract
+
+        provider : str
+            FHIR provider ID or name
+
+        phenoml_on_behalf_of : typing.Optional[str]
+            Optional header for on-behalf-of authentication. Used when making requests on behalf of another user or entity.
+            Must be in the format: Patient/{uuid} or Practitioner/{uuid}
+
+        phenoml_fhir_provider : typing.Optional[str]
+            Optional header for FHIR provider authentication. Contains credentials in the format {fhir_provider_id}:{oauth2_token}.
+            Multiple FHIR provider integrations can be provided as comma-separated values.
+
+        version : typing.Optional[str]
+            FHIR version to use
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Lang2FhirAndCreateMultiResponse
+            Successfully created FHIR resources
+
+        Examples
+        --------
+        from phenoml import phenoml
+
+        client = phenoml(
+            token="YOUR_TOKEN",
+        )
+        client.tools.create_fhir_resources_multi(
+            phenoml_on_behalf_of="Patient/550e8400-e29b-41d4-a716-446655440000",
+            phenoml_fhir_provider="550e8400-e29b-41d4-a716-446655440000:eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c...",
+            text="John Smith, 45-year-old male, diagnosed with Type 2 Diabetes. Prescribed Metformin 500mg twice daily.",
+            provider="medplum",
+        )
+        """
+        _response = self._raw_client.create_fhir_resources_multi(
+            text=text,
+            provider=provider,
+            phenoml_on_behalf_of=phenoml_on_behalf_of,
+            phenoml_fhir_provider=phenoml_fhir_provider,
+            version=version,
+            request_options=request_options,
         )
         return _response.data
 
@@ -89,11 +168,12 @@ class ToolsClient:
         self,
         *,
         text: str,
+        phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
         patient_id: typing.Optional[str] = OMIT,
         practitioner_id: typing.Optional[str] = OMIT,
         count: typing.Optional[int] = OMIT,
-        provider: typing.Optional[Lang2FhirAndSearchRequestProvider] = OMIT,
-        meta: typing.Optional[FhirClientConfig] = OMIT,
+        provider: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Lang2FhirAndSearchResponse:
         """
@@ -104,6 +184,14 @@ class ToolsClient:
         text : str
             Natural language text to convert to FHIR search parameters
 
+        phenoml_on_behalf_of : typing.Optional[str]
+            Optional header for on-behalf-of authentication. Used when making requests on behalf of another user or entity.
+            Must be in the format: Patient/{uuid} or Practitioner/{uuid}
+
+        phenoml_fhir_provider : typing.Optional[str]
+            Optional header for FHIR provider authentication. Contains credentials in the format {fhir_provider_id}:{oauth2_token}.
+            Multiple FHIR provider integrations can be provided as comma-separated values.
+
         patient_id : typing.Optional[str]
             Patient ID to filter results
 
@@ -113,10 +201,8 @@ class ToolsClient:
         count : typing.Optional[int]
             Maximum number of results to return
 
-        provider : typing.Optional[Lang2FhirAndSearchRequestProvider]
-            FHIR provider to use for searching
-
-        meta : typing.Optional[FhirClientConfig]
+        provider : typing.Optional[str]
+            FHIR provider ID - must be a valid UUID from existing FHIR providers. also supports provider by name (e.g. medplum)
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -134,16 +220,19 @@ class ToolsClient:
             token="YOUR_TOKEN",
         )
         client.tools.search_fhir_resources(
+            phenoml_on_behalf_of="Patient/550e8400-e29b-41d4-a716-446655440000",
+            phenoml_fhir_provider="550e8400-e29b-41d4-a716-446655440000:eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c...",
             text="Find all appointments for patient John Doe next week",
         )
         """
         _response = self._raw_client.search_fhir_resources(
             text=text,
+            phenoml_on_behalf_of=phenoml_on_behalf_of,
+            phenoml_fhir_provider=phenoml_fhir_provider,
             patient_id=patient_id,
             practitioner_id=practitioner_id,
             count=count,
             provider=provider,
-            meta=meta,
             request_options=request_options,
         )
         return _response.data
@@ -152,8 +241,9 @@ class ToolsClient:
         self,
         *,
         text: str,
-        provider: CohortRequestProvider,
-        meta: typing.Optional[FhirClientConfig] = OMIT,
+        provider: str,
+        phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> CohortResponse:
         """
@@ -164,10 +254,16 @@ class ToolsClient:
         text : str
             Natural language text describing the patient cohort criteria
 
-        provider : CohortRequestProvider
-            FHIR provider to use for searching
+        provider : str
+            FHIR provider ID - must be a valid UUID from existing FHIR providers. also supports provider by name (e.g. medplum)
 
-        meta : typing.Optional[FhirClientConfig]
+        phenoml_on_behalf_of : typing.Optional[str]
+            Optional header for on-behalf-of authentication. Used when making requests on behalf of another user or entity.
+            Must be in the format: Patient/{uuid} or Practitioner/{uuid}
+
+        phenoml_fhir_provider : typing.Optional[str]
+            Optional header for FHIR provider authentication. Contains credentials in the format {fhir_provider_id}:{oauth2_token}.
+            Multiple FHIR provider integrations can be provided as comma-separated values.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -185,12 +281,18 @@ class ToolsClient:
             token="YOUR_TOKEN",
         )
         client.tools.analyze_cohort(
+            phenoml_on_behalf_of="Patient/550e8400-e29b-41d4-a716-446655440000",
+            phenoml_fhir_provider="550e8400-e29b-41d4-a716-446655440000:eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c...",
             text="female patients over 20 with diabetes but not hypertension",
-            provider="medplum",
+            provider="550e8400-e29b-41d4-a716-446655440000",
         )
         """
         _response = self._raw_client.analyze_cohort(
-            text=text, provider=provider, meta=meta, request_options=request_options
+            text=text,
+            provider=provider,
+            phenoml_on_behalf_of=phenoml_on_behalf_of,
+            phenoml_fhir_provider=phenoml_fhir_provider,
+            request_options=request_options,
         )
         return _response.data
 
@@ -216,8 +318,9 @@ class AsyncToolsClient:
         *,
         resource: Lang2FhirAndCreateRequestResource,
         text: str,
-        provider: typing.Optional[Lang2FhirAndCreateRequestProvider] = OMIT,
-        meta: typing.Optional[FhirClientConfig] = OMIT,
+        phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
+        provider: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Lang2FhirAndCreateResponse:
         """
@@ -231,10 +334,16 @@ class AsyncToolsClient:
         text : str
             Natural language text to convert to FHIR resource
 
-        provider : typing.Optional[Lang2FhirAndCreateRequestProvider]
-            FHIR provider to use for storing the resource
+        phenoml_on_behalf_of : typing.Optional[str]
+            Optional header for on-behalf-of authentication. Used when making requests on behalf of another user or entity.
+            Must be in the format: Patient/{uuid} or Practitioner/{uuid}
+
+        phenoml_fhir_provider : typing.Optional[str]
+            Optional header for FHIR provider authentication. Contains credentials in the format {fhir_provider_id}:{oauth2_token}.
+            Multiple FHIR provider integrations can be provided as comma-separated values.
 
-        meta : typing.Optional[FhirClientConfig]
+        provider : typing.Optional[str]
+            FHIR provider ID - must be a valid UUID from existing FHIR providers. also supports provider by name (e.g. medplum)
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -257,6 +366,8 @@ class AsyncToolsClient:
 
         async def main() -> None:
             await client.tools.create_fhir_resource(
+                phenoml_on_behalf_of="Patient/550e8400-e29b-41d4-a716-446655440000",
+                phenoml_fhir_provider="550e8400-e29b-41d4-a716-446655440000:eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c...",
                 resource="auto",
                 text="Patient John Doe has severe asthma with acute exacerbation",
             )
@@ -265,7 +376,88 @@ class AsyncToolsClient:
         asyncio.run(main())
         """
         _response = await self._raw_client.create_fhir_resource(
-            resource=resource, text=text, provider=provider, meta=meta, request_options=request_options
+            resource=resource,
+            text=text,
+            phenoml_on_behalf_of=phenoml_on_behalf_of,
+            phenoml_fhir_provider=phenoml_fhir_provider,
+            provider=provider,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def create_fhir_resources_multi(
+        self,
+        *,
+        text: str,
+        provider: str,
+        phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
+        version: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> Lang2FhirAndCreateMultiResponse:
+        """
+        Extracts multiple FHIR resources from natural language text and stores them in a FHIR server.
+        Automatically detects Patient, Condition, MedicationRequest, Observation, and other resource types.
+        Resources are linked with proper references and submitted as a transaction bundle.
+        For FHIR servers that don't auto-resolve urn:uuid references, this endpoint will automatically
+        resolve them via PUT requests after the initial bundle creation.
+
+        Parameters
+        ----------
+        text : str
+            Natural language text containing multiple clinical concepts to extract
+
+        provider : str
+            FHIR provider ID or name
+
+        phenoml_on_behalf_of : typing.Optional[str]
+            Optional header for on-behalf-of authentication. Used when making requests on behalf of another user or entity.
+            Must be in the format: Patient/{uuid} or Practitioner/{uuid}
+
+        phenoml_fhir_provider : typing.Optional[str]
+            Optional header for FHIR provider authentication. Contains credentials in the format {fhir_provider_id}:{oauth2_token}.
+            Multiple FHIR provider integrations can be provided as comma-separated values.
+
+        version : typing.Optional[str]
+            FHIR version to use
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Lang2FhirAndCreateMultiResponse
+            Successfully created FHIR resources
+
+        Examples
+        --------
+        import asyncio
+
+        from phenoml import Asyncphenoml
+
+        client = Asyncphenoml(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.tools.create_fhir_resources_multi(
+                phenoml_on_behalf_of="Patient/550e8400-e29b-41d4-a716-446655440000",
+                phenoml_fhir_provider="550e8400-e29b-41d4-a716-446655440000:eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c...",
+                text="John Smith, 45-year-old male, diagnosed with Type 2 Diabetes. Prescribed Metformin 500mg twice daily.",
+                provider="medplum",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_fhir_resources_multi(
+            text=text,
+            provider=provider,
+            phenoml_on_behalf_of=phenoml_on_behalf_of,
+            phenoml_fhir_provider=phenoml_fhir_provider,
+            version=version,
+            request_options=request_options,
         )
         return _response.data
 
@@ -273,11 +465,12 @@ class AsyncToolsClient:
         self,
         *,
         text: str,
+        phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
         patient_id: typing.Optional[str] = OMIT,
         practitioner_id: typing.Optional[str] = OMIT,
         count: typing.Optional[int] = OMIT,
-        provider: typing.Optional[Lang2FhirAndSearchRequestProvider] = OMIT,
-        meta: typing.Optional[FhirClientConfig] = OMIT,
+        provider: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> Lang2FhirAndSearchResponse:
         """
@@ -288,6 +481,14 @@ class AsyncToolsClient:
         text : str
             Natural language text to convert to FHIR search parameters
 
+        phenoml_on_behalf_of : typing.Optional[str]
+            Optional header for on-behalf-of authentication. Used when making requests on behalf of another user or entity.
+            Must be in the format: Patient/{uuid} or Practitioner/{uuid}
+
+        phenoml_fhir_provider : typing.Optional[str]
+            Optional header for FHIR provider authentication. Contains credentials in the format {fhir_provider_id}:{oauth2_token}.
+            Multiple FHIR provider integrations can be provided as comma-separated values.
+
         patient_id : typing.Optional[str]
             Patient ID to filter results
 
@@ -297,10 +498,8 @@ class AsyncToolsClient:
         count : typing.Optional[int]
             Maximum number of results to return
 
-        provider : typing.Optional[Lang2FhirAndSearchRequestProvider]
-            FHIR provider to use for searching
-
-        meta : typing.Optional[FhirClientConfig]
+        provider : typing.Optional[str]
+            FHIR provider ID - must be a valid UUID from existing FHIR providers. also supports provider by name (e.g. medplum)
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -323,6 +522,8 @@ class AsyncToolsClient:
 
         async def main() -> None:
             await client.tools.search_fhir_resources(
+                phenoml_on_behalf_of="Patient/550e8400-e29b-41d4-a716-446655440000",
+                phenoml_fhir_provider="550e8400-e29b-41d4-a716-446655440000:eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c...",
                 text="Find all appointments for patient John Doe next week",
             )
 
@@ -331,11 +532,12 @@ class AsyncToolsClient:
         """
         _response = await self._raw_client.search_fhir_resources(
             text=text,
+            phenoml_on_behalf_of=phenoml_on_behalf_of,
+            phenoml_fhir_provider=phenoml_fhir_provider,
             patient_id=patient_id,
             practitioner_id=practitioner_id,
             count=count,
             provider=provider,
-            meta=meta,
             request_options=request_options,
         )
         return _response.data
@@ -344,8 +546,9 @@ class AsyncToolsClient:
         self,
         *,
         text: str,
-        provider: CohortRequestProvider,
-        meta: typing.Optional[FhirClientConfig] = OMIT,
+        provider: str,
+        phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> CohortResponse:
         """
@@ -356,10 +559,16 @@ class AsyncToolsClient:
         text : str
             Natural language text describing the patient cohort criteria
 
-        provider : CohortRequestProvider
-            FHIR provider to use for searching
+        provider : str
+            FHIR provider ID - must be a valid UUID from existing FHIR providers. also supports provider by name (e.g. medplum)
+
+        phenoml_on_behalf_of : typing.Optional[str]
+            Optional header for on-behalf-of authentication. Used when making requests on behalf of another user or entity.
+            Must be in the format: Patient/{uuid} or Practitioner/{uuid}
 
-        meta : typing.Optional[FhirClientConfig]
+        phenoml_fhir_provider : typing.Optional[str]
+            Optional header for FHIR provider authentication. Contains credentials in the format {fhir_provider_id}:{oauth2_token}.
+            Multiple FHIR provider integrations can be provided as comma-separated values.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -382,14 +591,20 @@ class AsyncToolsClient:
 
         async def main() -> None:
             await client.tools.analyze_cohort(
+                phenoml_on_behalf_of="Patient/550e8400-e29b-41d4-a716-446655440000",
+                phenoml_fhir_provider="550e8400-e29b-41d4-a716-446655440000:eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c...",
                 text="female patients over 20 with diabetes but not hypertension",
-                provider="medplum",
+                provider="550e8400-e29b-41d4-a716-446655440000",
             )
 
 
         asyncio.run(main())
         """
         _response = await self._raw_client.analyze_cohort(
-            text=text, provider=provider, meta=meta, request_options=request_options
+            text=text,
+            provider=provider,
+            phenoml_on_behalf_of=phenoml_on_behalf_of,
+            phenoml_fhir_provider=phenoml_fhir_provider,
+            request_options=request_options,
         )
         return _response.data