phenoml 0.0.15__tar.gz → 0.0.17__tar.gz

{phenoml-0.0.15 → phenoml-0.0.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: phenoml
-Version: 0.0.15
+Version: 0.0.17
 Summary: 
 Requires-Python: >=3.8,<4.0
 Classifier: Intended Audience :: Developers

{phenoml-0.0.15 → phenoml-0.0.17}/pyproject.toml

@@ -3,7 +3,7 @@ name = "phenoml"
 
 [tool.poetry]
 name = "phenoml"
-version = "v0.0.15"
+version = "v0.0.17"
 description = ""
 readme = "README.md"
 authors = []

{phenoml-0.0.15 → phenoml-0.0.17}/src/phenoml/core/client_wrapper.py

@@ -22,10 +22,10 @@ class BaseClientWrapper:
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
-            "User-Agent": "phenoml/AUTO",
+            "User-Agent": "phenoml/v0.0.17",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "phenoml",
-            "X-Fern-SDK-Version": "v0.0.15",
+            "X-Fern-SDK-Version": "v0.0.17",
             **(self.get_custom_headers() or {}),
         }
         headers["Authorization"] = f"Bearer {self._get_token()}"

{phenoml-0.0.15 → phenoml-0.0.17}/src/phenoml/lang2fhir/__init__.py

@@ -3,6 +3,11 @@
 # isort: skip_file
 
 from .types import (
+    CreateMultiResponse,
+    CreateMultiResponseBundle,
+    CreateMultiResponseBundleEntryItem,
+    CreateMultiResponseBundleEntryItemRequest,
+    CreateMultiResponseResourcesItem,
     CreateRequestResource,
     DocumentRequestFileType,
     DocumentRequestResource,
@@ -14,6 +19,11 @@ from .errors import BadRequestError, FailedDependencyError, ForbiddenError, Inte
 
 __all__ = [
     "BadRequestError",
+    "CreateMultiResponse",
+    "CreateMultiResponseBundle",
+    "CreateMultiResponseBundleEntryItem",
+    "CreateMultiResponseBundleEntryItemRequest",
+    "CreateMultiResponseResourcesItem",
     "CreateRequestResource",
     "DocumentRequestFileType",
     "DocumentRequestResource",

{phenoml-0.0.15 → phenoml-0.0.17}/src/phenoml/lang2fhir/client.py

@@ -5,6 +5,7 @@ import typing
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
 from .raw_client import AsyncRawLang2FhirClient, RawLang2FhirClient
+from .types.create_multi_response import CreateMultiResponse
 from .types.create_request_resource import CreateRequestResource
 from .types.document_request_file_type import DocumentRequestFileType
 from .types.document_request_resource import DocumentRequestResource
@@ -79,6 +80,54 @@ class Lang2FhirClient:
         )
         return _response.data
 
+    def create_multi(
+        self,
+        *,
+        text: str,
+        version: typing.Optional[str] = OMIT,
+        provider: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateMultiResponse:
+        """
+        Analyzes natural language text and extracts multiple FHIR resources, returning them as a transaction Bundle.
+        Automatically detects Patient, Condition, MedicationRequest, Observation, and other resource types from the text.
+        Resources are linked with proper references (e.g., Conditions reference the Patient).
+
+        Parameters
+        ----------
+        text : str
+            Natural language text containing multiple clinical concepts to extract
+
+        version : typing.Optional[str]
+            FHIR version to use
+
+        provider : typing.Optional[str]
+            Optional FHIR provider name for provider-specific profiles
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateMultiResponse
+            Successfully extracted FHIR resources
+
+        Examples
+        --------
+        from phenoml import phenoml
+
+        client = phenoml(
+            token="YOUR_TOKEN",
+        )
+        client.lang2fhir.create_multi(
+            text="John Smith, 45-year-old male, diagnosed with Type 2 Diabetes. Prescribed Metformin 500mg twice daily.",
+        )
+        """
+        _response = self._raw_client.create_multi(
+            text=text, version=version, provider=provider, request_options=request_options
+        )
+        return _response.data
+
     def search(self, *, text: str, request_options: typing.Optional[RequestOptions] = None) -> SearchResponse:
         """
         Converts natural language text into FHIR search parameters
@@ -143,9 +192,9 @@ class Lang2FhirClient:
             token="YOUR_TOKEN",
         )
         client.lang2fhir.upload_profile(
-            version="version",
-            resource="custom-patient",
-            profile="profile",
+            version="R4",
+            resource="condition-encounter-diagnosis",
+            profile="(base64 encoded JSON string of the FHIR profile)",
         )
         """
         _response = self._raw_client.upload_profile(
@@ -278,6 +327,62 @@ class AsyncLang2FhirClient:
         )
         return _response.data
 
+    async def create_multi(
+        self,
+        *,
+        text: str,
+        version: typing.Optional[str] = OMIT,
+        provider: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreateMultiResponse:
+        """
+        Analyzes natural language text and extracts multiple FHIR resources, returning them as a transaction Bundle.
+        Automatically detects Patient, Condition, MedicationRequest, Observation, and other resource types from the text.
+        Resources are linked with proper references (e.g., Conditions reference the Patient).
+
+        Parameters
+        ----------
+        text : str
+            Natural language text containing multiple clinical concepts to extract
+
+        version : typing.Optional[str]
+            FHIR version to use
+
+        provider : typing.Optional[str]
+            Optional FHIR provider name for provider-specific profiles
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateMultiResponse
+            Successfully extracted FHIR resources
+
+        Examples
+        --------
+        import asyncio
+
+        from phenoml import Asyncphenoml
+
+        client = Asyncphenoml(
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.lang2fhir.create_multi(
+                text="John Smith, 45-year-old male, diagnosed with Type 2 Diabetes. Prescribed Metformin 500mg twice daily.",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_multi(
+            text=text, version=version, provider=provider, request_options=request_options
+        )
+        return _response.data
+
     async def search(self, *, text: str, request_options: typing.Optional[RequestOptions] = None) -> SearchResponse:
         """
         Converts natural language text into FHIR search parameters
@@ -355,9 +460,9 @@ class AsyncLang2FhirClient:
 
         async def main() -> None:
             await client.lang2fhir.upload_profile(
-                version="version",
-                resource="custom-patient",
-                profile="profile",
+                version="R4",
+                resource="condition-encounter-diagnosis",
+                profile="(base64 encoded JSON string of the FHIR profile)",
             )
 
 

{phenoml-0.0.15 → phenoml-0.0.17}/src/phenoml/lang2fhir/raw_client.py

@@ -13,6 +13,7 @@ from .errors.failed_dependency_error import FailedDependencyError
 from .errors.forbidden_error import ForbiddenError
 from .errors.internal_server_error import InternalServerError
 from .errors.unauthorized_error import UnauthorizedError
+from .types.create_multi_response import CreateMultiResponse
 from .types.create_request_resource import CreateRequestResource
 from .types.document_request_file_type import DocumentRequestFileType
 from .types.document_request_resource import DocumentRequestResource
@@ -120,6 +121,100 @@ class RawLang2FhirClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
+    def create_multi(
+        self,
+        *,
+        text: str,
+        version: typing.Optional[str] = OMIT,
+        provider: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[CreateMultiResponse]:
+        """
+        Analyzes natural language text and extracts multiple FHIR resources, returning them as a transaction Bundle.
+        Automatically detects Patient, Condition, MedicationRequest, Observation, and other resource types from the text.
+        Resources are linked with proper references (e.g., Conditions reference the Patient).
+
+        Parameters
+        ----------
+        text : str
+            Natural language text containing multiple clinical concepts to extract
+
+        version : typing.Optional[str]
+            FHIR version to use
+
+        provider : typing.Optional[str]
+            Optional FHIR provider name for provider-specific profiles
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[CreateMultiResponse]
+            Successfully extracted FHIR resources
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "lang2fhir/create/multi",
+            method="POST",
+            json={
+                "text": text,
+                "version": version,
+                "provider": provider,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CreateMultiResponse,
+                    parse_obj_as(
+                        type_=CreateMultiResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
     def search(
         self, *, text: str, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[SearchResponse]:
@@ -502,6 +597,100 @@ class AsyncRawLang2FhirClient:
             raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
         raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
 
+    async def create_multi(
+        self,
+        *,
+        text: str,
+        version: typing.Optional[str] = OMIT,
+        provider: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[CreateMultiResponse]:
+        """
+        Analyzes natural language text and extracts multiple FHIR resources, returning them as a transaction Bundle.
+        Automatically detects Patient, Condition, MedicationRequest, Observation, and other resource types from the text.
+        Resources are linked with proper references (e.g., Conditions reference the Patient).
+
+        Parameters
+        ----------
+        text : str
+            Natural language text containing multiple clinical concepts to extract
+
+        version : typing.Optional[str]
+            FHIR version to use
+
+        provider : typing.Optional[str]
+            Optional FHIR provider name for provider-specific profiles
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[CreateMultiResponse]
+            Successfully extracted FHIR resources
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "lang2fhir/create/multi",
+            method="POST",
+            json={
+                "text": text,
+                "version": version,
+                "provider": provider,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CreateMultiResponse,
+                    parse_obj_as(
+                        type_=CreateMultiResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
     async def search(
         self, *, text: str, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[SearchResponse]:

{phenoml-0.0.15 → phenoml-0.0.17}/src/phenoml/lang2fhir/types/__init__.py

@@ -2,6 +2,11 @@
 
 # isort: skip_file
 
+from .create_multi_response import CreateMultiResponse
+from .create_multi_response_bundle import CreateMultiResponseBundle
+from .create_multi_response_bundle_entry_item import CreateMultiResponseBundleEntryItem
+from .create_multi_response_bundle_entry_item_request import CreateMultiResponseBundleEntryItemRequest
+from .create_multi_response_resources_item import CreateMultiResponseResourcesItem
 from .create_request_resource import CreateRequestResource
 from .document_request_file_type import DocumentRequestFileType
 from .document_request_resource import DocumentRequestResource
@@ -10,6 +15,11 @@ from .lang2fhir_upload_profile_response import Lang2FhirUploadProfileResponse
 from .search_response import SearchResponse
 
 __all__ = [
+    "CreateMultiResponse",
+    "CreateMultiResponseBundle",
+    "CreateMultiResponseBundleEntryItem",
+    "CreateMultiResponseBundleEntryItemRequest",
+    "CreateMultiResponseResourcesItem",
     "CreateRequestResource",
     "DocumentRequestFileType",
     "DocumentRequestResource",

phenoml-0.0.17/src/phenoml/lang2fhir/types/create_multi_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 .create_multi_response_bundle import CreateMultiResponseBundle
+from .create_multi_response_resources_item import CreateMultiResponseResourcesItem
+
+
+class CreateMultiResponse(UniversalBaseModel):
+    success: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether extraction was successful
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Status message
+    """
+
+    bundle: typing.Optional[CreateMultiResponseBundle] = pydantic.Field(default=None)
+    """
+    FHIR transaction Bundle containing all extracted resources
+    """
+
+    resources: typing.Optional[typing.List[CreateMultiResponseResourcesItem]] = pydantic.Field(default=None)
+    """
+    Summary of extracted resources
+    """
+
+    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-0.0.17/src/phenoml/lang2fhir/types/create_multi_response_bundle.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...core.serialization import FieldMetadata
+from .create_multi_response_bundle_entry_item import CreateMultiResponseBundleEntryItem
+
+
+class CreateMultiResponseBundle(UniversalBaseModel):
+    """
+    FHIR transaction Bundle containing all extracted resources
+    """
+
+    resource_type: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="resourceType")] = None
+    type: typing.Optional[str] = None
+    entry: typing.Optional[typing.List[CreateMultiResponseBundleEntryItem]] = 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-0.0.17/src/phenoml/lang2fhir/types/create_multi_response_bundle_entry_item.py

@@ -0,0 +1,24 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...core.serialization import FieldMetadata
+from .create_multi_response_bundle_entry_item_request import CreateMultiResponseBundleEntryItemRequest
+
+
+class CreateMultiResponseBundleEntryItem(UniversalBaseModel):
+    full_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="fullUrl")] = None
+    resource: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None
+    request: typing.Optional[CreateMultiResponseBundleEntryItemRequest] = 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-0.0.17/src/phenoml/lang2fhir/types/create_multi_response_bundle_entry_item_request.py

@@ -0,0 +1,20 @@
+# 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 CreateMultiResponseBundleEntryItemRequest(UniversalBaseModel):
+    method: typing.Optional[str] = None
+    url: typing.Optional[str] = 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-0.0.17/src/phenoml/lang2fhir/types/create_multi_response_resources_item.py

@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...core.serialization import FieldMetadata
+
+
+class CreateMultiResponseResourcesItem(UniversalBaseModel):
+    temp_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="tempId")] = pydantic.Field(
+        default=None
+    )
+    """
+    Temporary UUID for the resource
+    """
+
+    resource_type: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="resourceType")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    FHIR resource type
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Text excerpt this resource was extracted from
+    """
+
+    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-0.0.15 → phenoml-0.0.17}/src/phenoml/summary/__init__.py

@@ -7,6 +7,7 @@ from .types import (
     CreateSummaryRequestMode,
     CreateSummaryResponse,
     CreateSummaryTemplateResponse,
+    ErrorResponse,
     FhirBundle,
     FhirBundleEntryItem,
     FhirResource,
@@ -24,6 +25,7 @@ __all__ = [
     "CreateSummaryRequestMode",
     "CreateSummaryResponse",
     "CreateSummaryTemplateResponse",
+    "ErrorResponse",
     "FhirBundle",
     "FhirBundleEntryItem",
     "FhirResource",

{phenoml-0.0.15 → phenoml-0.0.17}/src/phenoml/summary/client.py

@@ -268,19 +268,25 @@ class SummaryClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> CreateSummaryResponse:
         """
-        Creates a summary from FHIR resources using one of two modes:
+        Creates a summary from FHIR resources using one of three modes:
         - **narrative**: Uses a template to substitute FHIR data into placeholders (requires template_id)
         - **flatten**: Flattens FHIR resources into a searchable format for RAG/search (no template needed)
+        - **ips**: Generates an International Patient Summary (IPS) narrative per ISO 27269/HL7 FHIR IPS IG. Requires a Bundle with exactly one Patient resource (returns 400 error if no Patient or multiple Patients are present). Automatically filters resources to those referencing the patient and generates sections for allergies, medications, problems, immunizations, procedures, and vital signs.
 
         Parameters
         ----------
         fhir_resources : CreateSummaryRequestFhirResources
-            FHIR resources (single resource or Bundle)
+            FHIR resources (single resource or Bundle).
+            For IPS mode, must be a Bundle containing exactly one Patient resource with at least one
+            identifier (id, fullUrl, or identifier field). Returns an error if no Patient is found,
+            if multiple Patients are present, or if the Patient has no identifiers. Resources are
+            automatically filtered to only include those referencing the patient.
 
         mode : typing.Optional[CreateSummaryRequestMode]
             Summary generation mode:
             - narrative: Substitute FHIR data into a template (requires template_id)
             - flatten: Flatten FHIR resources for RAG/search (no template needed)
+            - ips: Generate International Patient Summary (IPS) narrative per ISO 27269/HL7 FHIR IPS IG
 
         template_id : typing.Optional[str]
             ID of the template to use (required for narrative mode)
@@ -603,19 +609,25 @@ class AsyncSummaryClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> CreateSummaryResponse:
         """
-        Creates a summary from FHIR resources using one of two modes:
+        Creates a summary from FHIR resources using one of three modes:
         - **narrative**: Uses a template to substitute FHIR data into placeholders (requires template_id)
         - **flatten**: Flattens FHIR resources into a searchable format for RAG/search (no template needed)
+        - **ips**: Generates an International Patient Summary (IPS) narrative per ISO 27269/HL7 FHIR IPS IG. Requires a Bundle with exactly one Patient resource (returns 400 error if no Patient or multiple Patients are present). Automatically filters resources to those referencing the patient and generates sections for allergies, medications, problems, immunizations, procedures, and vital signs.
 
         Parameters
         ----------
         fhir_resources : CreateSummaryRequestFhirResources
-            FHIR resources (single resource or Bundle)
+            FHIR resources (single resource or Bundle).
+            For IPS mode, must be a Bundle containing exactly one Patient resource with at least one
+            identifier (id, fullUrl, or identifier field). Returns an error if no Patient is found,
+            if multiple Patients are present, or if the Patient has no identifiers. Resources are
+            automatically filtered to only include those referencing the patient.
 
         mode : typing.Optional[CreateSummaryRequestMode]
             Summary generation mode:
             - narrative: Substitute FHIR data into a template (requires template_id)
             - flatten: Flatten FHIR resources for RAG/search (no template needed)
+            - ips: Generate International Patient Summary (IPS) narrative per ISO 27269/HL7 FHIR IPS IG
 
         template_id : typing.Optional[str]
             ID of the template to use (required for narrative mode)