phenoml 2.0.0__py3-none-any.whl → 2.1.0__py3-none-any.whl

phenoml/construe/__init__.py

@@ -3,6 +3,7 @@
 # isort: skip_file
 
 from .types import (
+    Citation,
     CodeResponse,
     CodeSystemDetails,
     CodeSystemInfo,
@@ -35,6 +36,7 @@ from .errors import (
 
 __all__ = [
     "BadRequestError",
+    "Citation",
     "CodeResponse",
     "CodeSystemDetails",
     "CodeSystemInfo",

phenoml/construe/client.py

@@ -49,7 +49,7 @@ class ConstrueClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ConstrueUploadCodeSystemResponse:
         """
-        Upload a custom medical code system with codes and descriptions for use in code extraction.
+        Upload a custom medical code system with codes and descriptions for use in code extraction. Requires a paid plan.
         Upon upload, construe generates embeddings for all of the codes in the code system and stores them in the vector database so you can
         subsequently use the code system for construe/extract and lang2fhir/create (coming soon!)
 
@@ -123,7 +123,9 @@ class ConstrueClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ExtractCodesResult:
         """
-        Converts natural language text into structured medical codes
+        Converts natural language text into structured medical codes.
+
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
 
         Parameters
         ----------
@@ -162,7 +164,7 @@ class ConstrueClient:
         self, *, request_options: typing.Optional[RequestOptions] = None
     ) -> ListCodeSystemsResponse:
         """
-        Returns metadata about all available code systems including built-in and custom systems.
+        Returns the terminology server's catalog of available code systems, including both built-in standard terminologies and custom uploaded systems.
 
         Parameters
         ----------
@@ -196,7 +198,9 @@ class ConstrueClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ListCodesResponse:
         """
-        Returns a paginated list of all codes in the specified code system.
+        Returns a paginated list of all codes in the specified code system from the terminology server.
+
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
 
         Parameters
         ----------
@@ -248,7 +252,9 @@ class ConstrueClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GetCodeResponse:
         """
-        Returns details for a specific code within a code system.
+        Looks up a specific code in the terminology server and returns its details.
+
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
 
         Parameters
         ----------
@@ -313,6 +319,8 @@ class ConstrueClient:
 
         See also: `/search/text` for faster keyword-based lookup with typo tolerance.
 
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
+
         Parameters
         ----------
         codesystem : str
@@ -354,7 +362,7 @@ class ConstrueClient:
         )
         return _response.data
 
-    def text_search_keyword_based(
+    def terminology_server_text_search(
         self,
         codesystem: str,
         *,
@@ -383,6 +391,8 @@ class ConstrueClient:
 
         See also: `/search/semantic` for finding conceptually similar codes.
 
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
+
         Parameters
         ----------
         codesystem : str
@@ -412,14 +422,14 @@ class ConstrueClient:
         client = phenoml(
             token="YOUR_TOKEN",
         )
-        client.construe.text_search_keyword_based(
+        client.construe.terminology_server_text_search(
             codesystem="ICD-10-CM",
             q="E11.65",
             version="version",
             limit=1,
         )
         """
-        _response = self._raw_client.text_search_keyword_based(
+        _response = self._raw_client.terminology_server_text_search(
             codesystem, q=q, version=version, limit=limit, request_options=request_options
         )
         return _response.data
@@ -454,7 +464,7 @@ class AsyncConstrueClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ConstrueUploadCodeSystemResponse:
         """
-        Upload a custom medical code system with codes and descriptions for use in code extraction.
+        Upload a custom medical code system with codes and descriptions for use in code extraction. Requires a paid plan.
         Upon upload, construe generates embeddings for all of the codes in the code system and stores them in the vector database so you can
         subsequently use the code system for construe/extract and lang2fhir/create (coming soon!)
 
@@ -536,7 +546,9 @@ class AsyncConstrueClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ExtractCodesResult:
         """
-        Converts natural language text into structured medical codes
+        Converts natural language text into structured medical codes.
+
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
 
         Parameters
         ----------
@@ -583,7 +595,7 @@ class AsyncConstrueClient:
         self, *, request_options: typing.Optional[RequestOptions] = None
     ) -> ListCodeSystemsResponse:
         """
-        Returns metadata about all available code systems including built-in and custom systems.
+        Returns the terminology server's catalog of available code systems, including both built-in standard terminologies and custom uploaded systems.
 
         Parameters
         ----------
@@ -625,7 +637,9 @@ class AsyncConstrueClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ListCodesResponse:
         """
-        Returns a paginated list of all codes in the specified code system.
+        Returns a paginated list of all codes in the specified code system from the terminology server.
+
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
 
         Parameters
         ----------
@@ -685,7 +699,9 @@ class AsyncConstrueClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GetCodeResponse:
         """
-        Returns details for a specific code within a code system.
+        Looks up a specific code in the terminology server and returns its details.
+
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
 
         Parameters
         ----------
@@ -758,6 +774,8 @@ class AsyncConstrueClient:
 
         See also: `/search/text` for faster keyword-based lookup with typo tolerance.
 
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
+
         Parameters
         ----------
         codesystem : str
@@ -807,7 +825,7 @@ class AsyncConstrueClient:
         )
         return _response.data
 
-    async def text_search_keyword_based(
+    async def terminology_server_text_search(
         self,
         codesystem: str,
         *,
@@ -836,6 +854,8 @@ class AsyncConstrueClient:
 
         See also: `/search/semantic` for finding conceptually similar codes.
 
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
+
         Parameters
         ----------
         codesystem : str
@@ -870,7 +890,7 @@ class AsyncConstrueClient:
 
 
         async def main() -> None:
-            await client.construe.text_search_keyword_based(
+            await client.construe.terminology_server_text_search(
                 codesystem="ICD-10-CM",
                 q="E11.65",
                 version="version",
@@ -880,7 +900,7 @@ class AsyncConstrueClient:
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.text_search_keyword_based(
+        _response = await self._raw_client.terminology_server_text_search(
             codesystem, q=q, version=version, limit=limit, request_options=request_options
         )
         return _response.data

phenoml/construe/raw_client.py

@@ -51,7 +51,7 @@ class RawConstrueClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[ConstrueUploadCodeSystemResponse]:
         """
-        Upload a custom medical code system with codes and descriptions for use in code extraction.
+        Upload a custom medical code system with codes and descriptions for use in code extraction. Requires a paid plan.
         Upon upload, construe generates embeddings for all of the codes in the code system and stores them in the vector database so you can
         subsequently use the code system for construe/extract and lang2fhir/create (coming soon!)
 
@@ -187,7 +187,9 @@ class RawConstrueClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[ExtractCodesResult]:
         """
-        Converts natural language text into structured medical codes
+        Converts natural language text into structured medical codes.
+
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
 
         Parameters
         ----------
@@ -287,7 +289,7 @@ class RawConstrueClient:
         self, *, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[ListCodeSystemsResponse]:
         """
-        Returns metadata about all available code systems including built-in and custom systems.
+        Returns the terminology server's catalog of available code systems, including both built-in standard terminologies and custom uploaded systems.
 
         Parameters
         ----------
@@ -351,7 +353,9 @@ class RawConstrueClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[ListCodesResponse]:
         """
-        Returns a paginated list of all codes in the specified code system.
+        Returns a paginated list of all codes in the specified code system from the terminology server.
+
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
 
         Parameters
         ----------
@@ -453,7 +457,9 @@ class RawConstrueClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[GetCodeResponse]:
         """
-        Returns details for a specific code within a code system.
+        Looks up a specific code in the terminology server and returns its details.
+
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
 
         Parameters
         ----------
@@ -567,6 +573,8 @@ class RawConstrueClient:
 
         See also: `/search/text` for faster keyword-based lookup with typo tolerance.
 
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
+
         Parameters
         ----------
         codesystem : str
@@ -658,7 +666,7 @@ class RawConstrueClient:
             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 text_search_keyword_based(
+    def terminology_server_text_search(
         self,
         codesystem: str,
         *,
@@ -687,6 +695,8 @@ class RawConstrueClient:
 
         See also: `/search/semantic` for finding conceptually similar codes.
 
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
+
         Parameters
         ----------
         codesystem : str
@@ -819,7 +829,7 @@ class AsyncRawConstrueClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[ConstrueUploadCodeSystemResponse]:
         """
-        Upload a custom medical code system with codes and descriptions for use in code extraction.
+        Upload a custom medical code system with codes and descriptions for use in code extraction. Requires a paid plan.
         Upon upload, construe generates embeddings for all of the codes in the code system and stores them in the vector database so you can
         subsequently use the code system for construe/extract and lang2fhir/create (coming soon!)
 
@@ -955,7 +965,9 @@ class AsyncRawConstrueClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[ExtractCodesResult]:
         """
-        Converts natural language text into structured medical codes
+        Converts natural language text into structured medical codes.
+
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
 
         Parameters
         ----------
@@ -1055,7 +1067,7 @@ class AsyncRawConstrueClient:
         self, *, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[ListCodeSystemsResponse]:
         """
-        Returns metadata about all available code systems including built-in and custom systems.
+        Returns the terminology server's catalog of available code systems, including both built-in standard terminologies and custom uploaded systems.
 
         Parameters
         ----------
@@ -1119,7 +1131,9 @@ class AsyncRawConstrueClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[ListCodesResponse]:
         """
-        Returns a paginated list of all codes in the specified code system.
+        Returns a paginated list of all codes in the specified code system from the terminology server.
+
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
 
         Parameters
         ----------
@@ -1221,7 +1235,9 @@ class AsyncRawConstrueClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[GetCodeResponse]:
         """
-        Returns details for a specific code within a code system.
+        Looks up a specific code in the terminology server and returns its details.
+
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
 
         Parameters
         ----------
@@ -1335,6 +1351,8 @@ class AsyncRawConstrueClient:
 
         See also: `/search/text` for faster keyword-based lookup with typo tolerance.
 
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
+
         Parameters
         ----------
         codesystem : str
@@ -1426,7 +1444,7 @@ class AsyncRawConstrueClient:
             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 text_search_keyword_based(
+    async def terminology_server_text_search(
         self,
         codesystem: str,
         *,
@@ -1455,6 +1473,8 @@ class AsyncRawConstrueClient:
 
         See also: `/search/semantic` for finding conceptually similar codes.
 
+        Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
+
         Parameters
         ----------
         codesystem : str

phenoml/construe/types/__init__.py

@@ -2,6 +2,7 @@
 
 # isort: skip_file
 
+from .citation import Citation
 from .code_response import CodeResponse
 from .code_system_details import CodeSystemDetails
 from .code_system_info import CodeSystemInfo
@@ -22,6 +23,7 @@ from .text_search_result import TextSearchResult
 from .upload_request_format import UploadRequestFormat
 
 __all__ = [
+    "Citation",
     "CodeResponse",
     "CodeSystemDetails",
     "CodeSystemInfo",

phenoml/construe/types/citation.py

@@ -0,0 +1,36 @@
+# 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 Citation(UniversalBaseModel):
+    """
+    A reference to source text that led to a code extraction
+    """
+
+    text: str = pydantic.Field()
+    """
+    The exact text span containing evidence for the code
+    """
+
+    begin_offset: int = pydantic.Field()
+    """
+    Starting byte offset in the original input text (0-indexed)
+    """
+
+    end_offset: int = pydantic.Field()
+    """
+    Ending byte offset (exclusive), such that input[begin_offset:end_offset] == text
+    """
+
+    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/extract_request_config.py

@@ -50,6 +50,15 @@ class ExtractRequestConfig(UniversalBaseModel):
     Whether to include codes that failed validation in the results
     """
 
+    include_citations: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether to include source text citations for each extracted code.
+    Citations show the exact text spans (with character offsets) that led to each code.
+    Only available when using chunking_method: "sentences".
+    The "none" method returns full text as one chunk (not useful for citations).
+    LLM-based chunking (paragraphs, topics) does not support citations.
+    """
+
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
     else:

phenoml/construe/types/extract_request_system.py

@@ -21,7 +21,9 @@ class ExtractRequestSystem(UniversalBaseModel):
     * CPT - version 2025
     
     Custom systems:
-    * Any valid system name configured in your environment. Must have self-hosted construe module.
+    * Any valid system name uploaded via /construe/upload. Requires a paid plan.
+    
+    Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
     """
 
     version: typing.Optional[str] = pydantic.Field(default=None)

phenoml/construe/types/extracted_code_result.py

@@ -6,6 +6,7 @@ import pydantic
 import typing_extensions
 from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ...core.serialization import FieldMetadata
+from .citation import Citation
 
 
 class ExtractedCodeResult(UniversalBaseModel):
@@ -36,6 +37,19 @@ class ExtractedCodeResult(UniversalBaseModel):
     Explanation for why this code was extracted (if include_rationale is true)
     """
 
+    is_ancestor: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether this code is an ancestor (parent) of an extracted code rather than directly extracted.
+    Only present when include_ancestors is true.
+    """
+
+    citations: typing.Optional[typing.List[Citation]] = pydantic.Field(default=None)
+    """
+    Source text references showing where this code was found in the input.
+    Only present when include_citations is true and chunking method supports it.
+    Ancestor codes do not receive citations.
+    """
+
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
     else:

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/2.0.0",
+            "User-Agent": "phenoml/2.1.0",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "phenoml",
-            "X-Fern-SDK-Version": "2.0.0",
+            "X-Fern-SDK-Version": "2.1.0",
             **(self.get_custom_headers() or {}),
         }
         headers["Authorization"] = f"Bearer {self._get_token()}"

phenoml/fhir/__init__.py

@@ -15,9 +15,10 @@ from .types import (
     FhirResourceMeta,
     FhirSearchResponse,
 )
-from .errors import BadRequestError, InternalServerError, NotFoundError, UnauthorizedError
+from .errors import BadGatewayError, BadRequestError, InternalServerError, NotFoundError, UnauthorizedError
 
 __all__ = [
+    "BadGatewayError",
     "BadRequestError",
     "ErrorResponse",
     "FhirBundle",

phenoml/fhir/errors/__init__.py

@@ -2,9 +2,10 @@
 
 # isort: skip_file
 
+from .bad_gateway_error import BadGatewayError
 from .bad_request_error import BadRequestError
 from .internal_server_error import InternalServerError
 from .not_found_error import NotFoundError
 from .unauthorized_error import UnauthorizedError
 
-__all__ = ["BadRequestError", "InternalServerError", "NotFoundError", "UnauthorizedError"]
+__all__ = ["BadGatewayError", "BadRequestError", "InternalServerError", "NotFoundError", "UnauthorizedError"]

phenoml/fhir/errors/bad_gateway_error.py

@@ -0,0 +1,11 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ...core.api_error import ApiError
+from ..types.error_response import ErrorResponse
+
+
+class BadGatewayError(ApiError):
+    def __init__(self, body: ErrorResponse, headers: typing.Optional[typing.Dict[str, str]] = None):
+        super().__init__(status_code=502, headers=headers, body=body)

phenoml/fhir/raw_client.py

@@ -10,10 +10,12 @@ from ..core.jsonable_encoder import jsonable_encoder
 from ..core.pydantic_utilities import parse_obj_as
 from ..core.request_options import RequestOptions
 from ..core.serialization import convert_and_respect_annotation_metadata
+from .errors.bad_gateway_error import BadGatewayError
 from .errors.bad_request_error import BadRequestError
 from .errors.internal_server_error import InternalServerError
 from .errors.not_found_error import NotFoundError
 from .errors.unauthorized_error import UnauthorizedError
+from .types.error_response import ErrorResponse
 from .types.fhir_bundle import FhirBundle
 from .types.fhir_bundle_entry_item import FhirBundleEntryItem
 from .types.fhir_patch_request_body_item import FhirPatchRequestBodyItem
@@ -147,6 +149,17 @@ class RawFhirClient:
                         ),
                     ),
                 )
+            if _response.status_code == 502:
+                raise BadGatewayError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
@@ -269,6 +282,17 @@ class RawFhirClient:
                         ),
                     ),
                 )
+            if _response.status_code == 502:
+                raise BadGatewayError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
@@ -391,6 +415,17 @@ class RawFhirClient:
                         ),
                     ),
                 )
+            if _response.status_code == 502:
+                raise BadGatewayError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
@@ -503,6 +538,17 @@ class RawFhirClient:
                         ),
                     ),
                 )
+            if _response.status_code == 502:
+                raise BadGatewayError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
@@ -628,6 +674,17 @@ class RawFhirClient:
                         ),
                     ),
                 )
+            if _response.status_code == 502:
+                raise BadGatewayError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
@@ -741,6 +798,17 @@ class RawFhirClient:
                         ),
                     ),
                 )
+            if _response.status_code == 502:
+                raise BadGatewayError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
@@ -869,6 +937,17 @@ class AsyncRawFhirClient:
                         ),
                     ),
                 )
+            if _response.status_code == 502:
+                raise BadGatewayError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
@@ -991,6 +1070,17 @@ class AsyncRawFhirClient:
                         ),
                     ),
                 )
+            if _response.status_code == 502:
+                raise BadGatewayError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
@@ -1113,6 +1203,17 @@ class AsyncRawFhirClient:
                         ),
                     ),
                 )
+            if _response.status_code == 502:
+                raise BadGatewayError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
@@ -1225,6 +1326,17 @@ class AsyncRawFhirClient:
                         ),
                     ),
                 )
+            if _response.status_code == 502:
+                raise BadGatewayError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
@@ -1350,6 +1462,17 @@ class AsyncRawFhirClient:
                         ),
                     ),
                 )
+            if _response.status_code == 502:
+                raise BadGatewayError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)
@@ -1463,6 +1586,17 @@ class AsyncRawFhirClient:
                         ),
                     ),
                 )
+            if _response.status_code == 502:
+                raise BadGatewayError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # 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)

{phenoml-2.0.0.dist-info → phenoml-2.1.0.dist-info}/METADATA

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

{phenoml-2.0.0.dist-info → phenoml-2.1.0.dist-info}/RECORD

@@ -60,8 +60,8 @@ phenoml/cohort/raw_client.py,sha256=yhquYZ6fNyhAJG_-6YwQqLMOcIP_JvojryxOEXt_Qfc,
 phenoml/cohort/types/__init__.py,sha256=zNq1Pom_534srvUJxnEcFPoUK98Cr4oYzPxvL_ifBmc,218
 phenoml/cohort/types/cohort_response.py,sha256=A0ekTeNT6jh_yMRAcdnMoavcrqUGKZuy_6-k4YwoFmk,981
 phenoml/cohort/types/search_concept.py,sha256=yIGRoIp8ASZ0I0G-9UA6eTseoZPwHrUuvRRQMamf4yA,1041
-phenoml/construe/__init__.py,sha256=4RjZ8KtqX_siMN5gVigcXfP7UIpQe9Md5uO7wcoojNw,1535
-phenoml/construe/client.py,sha256=VD8fQ26X0fCeToP9bvWVPcbVgkEOL86xPCp7GzRIx_c,26795
+phenoml/construe/__init__.py,sha256=KHCJ7TiA4JxJ55RZpC6JQwQc5o9R7rBlBPL2pYqYOY8,1565
+phenoml/construe/client.py,sha256=xbWorgGPs6vk4e0tmI4zst0evbMnYXeT5pHziDLHqvA,27913
 phenoml/construe/errors/__init__.py,sha256=OW8bCfk31qWc4LNXH4Csi91w88lP8Vwjku3kN-X6dYk,718
 phenoml/construe/errors/bad_request_error.py,sha256=nv0bK4gtOnTon6a2NdVxJxHBje_O_7wIoRtXLZHovUQ,339
 phenoml/construe/errors/conflict_error.py,sha256=NyA4yoleBcQcrDK2rF79eVs62xclhih2kpEIBlAToow,337
@@ -71,18 +71,19 @@ phenoml/construe/errors/not_found_error.py,sha256=hQ1KdyGQJCBQqo6iLu2-szlKJdzaoV
 phenoml/construe/errors/not_implemented_error.py,sha256=xI30CT0KC5dz6BojqH9VXfa9syDvBp8ofKaWv_PxM0c,343
 phenoml/construe/errors/service_unavailable_error.py,sha256=eY72I1v4lGcCKg76JWWQhXcCIFV7ejpjEMOz4iaWJkE,347
 phenoml/construe/errors/unauthorized_error.py,sha256=h8T6QhXuTo0GLL9MKfIM5p--wDqlB1-ZkMp3lY-aM3E,341
-phenoml/construe/raw_client.py,sha256=liF12jN6_X7F4N1mvjo2ETJb3y3o6i9myOYQnV-3sZw,62166
-phenoml/construe/types/__init__.py,sha256=J2zYQRjytXyrpfRYwVgTji9Cqt5eDiVqKF1oe1Q4vmY,1672
+phenoml/construe/raw_client.py,sha256=D_egRBiFICg5YSfrm9S5RdhZin8z516Wirk62sfGbBE,63264
+phenoml/construe/types/__init__.py,sha256=OpjGeaS5BgVQhFvJs4c82KcB0_hjra_UShW5nFQalf8,1719
+phenoml/construe/types/citation.py,sha256=8xuaHC9eRFaTIWCmS7eVGoFXIr1buNWzVkQboS8_wH8,949
 phenoml/construe/types/code_response.py,sha256=w9DNpGQLEwCtQjY_EyQ7ARF6FFcyY0PJn5PgrmzxbwI,806
 phenoml/construe/types/code_system_details.py,sha256=fq6SFEObhTDD4DSplavTKvcQed7AZI6IXdXL7VTCFN8,867
 phenoml/construe/types/code_system_info.py,sha256=M5bfzOJV11UDMtTVUzDBQ_OQwmCtSccGPTTRF8Betrk,655
 phenoml/construe/types/construe_upload_code_system_response.py,sha256=s0m5EHpkhkp7hYiC5zLZeIeqQ4mrwXlPI1Msihb-ZGo,566
 phenoml/construe/types/extract_codes_result.py,sha256=DbVDLWqtmt9TyD5MC0q8grgnNXPnXq4eJnLDinTe0uc,701
-phenoml/construe/types/extract_request_config.py,sha256=2A22PNA1Hxq9qz1x89LvbySF-Hw8iB6oA2QqoSIrvg8,2112
+phenoml/construe/types/extract_request_config.py,sha256=HBozvJPQJqZq1wP5WeJZnLmyBTffdcUn667luv3oCA4,2576
 phenoml/construe/types/extract_request_config_chunking_method.py,sha256=AmVPPj0oT5r0pwWUoFxG_K8s5g8xaGYIRsPt3VvqSXQ,209
 phenoml/construe/types/extract_request_config_validation_method.py,sha256=6uUqKn8DXF34EDtNKPa6KLW07DsxgQF2aR5BGdG5Fd4,199
-phenoml/construe/types/extract_request_system.py,sha256=50qkxvinJKS5y1_glr-OFe5tQRyMWLYpeny1NZ9gFzw,1191
-phenoml/construe/types/extracted_code_result.py,sha256=3mIHO952KjbMRBY_YvwBt75XOjqdflg9Odc-xBbURac,1321
+phenoml/construe/types/extract_request_system.py,sha256=dMLflz7FeNbXwMmoEn8jlypqnAfFr_oh2aasbdiQ-CA,1257
+phenoml/construe/types/extracted_code_result.py,sha256=RsL8Er3m6D_FA885lsCowmDq0WTXoU_t1L4O6fyHqng,1890
 phenoml/construe/types/get_code_response.py,sha256=cDR4SI3AvfQnpOlblXOCLOizxPjFacKmBWyC789o5cw,881
 phenoml/construe/types/list_code_systems_response.py,sha256=XPHSKsg6sIYAyLgIlSJRtkj6KtfCslL01V21HubzyWo,612
 phenoml/construe/types/list_codes_response.py,sha256=f5ZOQ6nYUGYX2S1nc1qtScm-EcNUHWHxpJxq9BH7pFo,909
@@ -93,7 +94,7 @@ phenoml/construe/types/text_search_result.py,sha256=FqHzcSBId9Pcp68gB10aJJYsHpsy
 phenoml/construe/types/upload_request_format.py,sha256=5mJhMM7R7hn6gGQNDJT9lxPDsRpUkRzqNxtRU0Nnlls,158
 phenoml/core/__init__.py,sha256=lTcqUPXcx4112yLDd70RAPeqq6tu3eFMe1pKOqkW9JQ,1562
 phenoml/core/api_error.py,sha256=44vPoTyWN59gonCIZMdzw7M1uspygiLnr3GNFOoVL2Q,614
-phenoml/core/client_wrapper.py,sha256=vk504TvNeh8V3j9n2ce9EVq1Z0hLaM5upqStADgDk8A,2641
+phenoml/core/client_wrapper.py,sha256=pT8QCb_CxBgzRdPY4RmXvEOsMeUjjObBDrzSEnboH04,2641
 phenoml/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
 phenoml/core/file.py,sha256=d4NNbX8XvXP32z8KpK2Xovv33nFfruIrpz0QWxlgpZk,2663
 phenoml/core/force_multipart.py,sha256=awxh5MtcRYe74ehY8U76jzv6fYM_w_D3Rur7KQQzSDk,429
@@ -106,14 +107,15 @@ phenoml/core/remove_none_from_dict.py,sha256=EU9SGgYidWq7SexuJbNs4-PZ-5Bl3Vppd86
 phenoml/core/request_options.py,sha256=h0QUNCFVdCW_7GclVySCAY2w4NhtXVBUCmHgmzaxpcg,1681
 phenoml/core/serialization.py,sha256=ECL3bvv_0i7U4uvPidZCNel--MUbA0iq0aGcNKi3kws,9818
 phenoml/environment.py,sha256=x2TB5u9AblwVCke6_38YZmVhcjjHLE5gXBo5TMeaeO8,164
-phenoml/fhir/__init__.py,sha256=CGOe2OSGyiryHY66fcRyZXsSMHiM5Y_GkTNPUqzwTP8,910
+phenoml/fhir/__init__.py,sha256=zIsx4hoEBYLeZpXAleNc2zZYm48K9Cesxmu1lVB7aNo,950
 phenoml/fhir/client.py,sha256=1hQSCDOYsC89zPlPWHJIKgVBa-j8mRT_97lDHFJ3jN8,43581
-phenoml/fhir/errors/__init__.py,sha256=1K_bceYvXUdWyvhH-WRwOEcc1gkiT_K6kGrs3VKg3PA,372
+phenoml/fhir/errors/__init__.py,sha256=9mougWJnia9nrNLt0kHJB7fMylhz6I9IhN4Su2XX6_E,438
+phenoml/fhir/errors/bad_gateway_error.py,sha256=-NquqI4plYJj4z9xUwa3qvJsK5XdGMHrCL6zDxTvaaI,374
 phenoml/fhir/errors/bad_request_error.py,sha256=nv0bK4gtOnTon6a2NdVxJxHBje_O_7wIoRtXLZHovUQ,339
 phenoml/fhir/errors/internal_server_error.py,sha256=biBHJfSP1_zWF5CJgxY4B8wrL1uC18RSccQ-BCKmYNs,343
 phenoml/fhir/errors/not_found_error.py,sha256=hQ1KdyGQJCBQqo6iLu2-szlKJdzaoV5odq_7kdXAEbc,337
 phenoml/fhir/errors/unauthorized_error.py,sha256=h8T6QhXuTo0GLL9MKfIM5p--wDqlB1-ZkMp3lY-aM3E,341
-phenoml/fhir/raw_client.py,sha256=XZE1iWjujv5hSROSSo8kdG773l6T_vKV66iZYqcvNks,66380
+phenoml/fhir/raw_client.py,sha256=K-eBndiyB78j4BfwK7hc-XKfNrKf8e-R4zoFRMUWbHQ,71750
 phenoml/fhir/types/__init__.py,sha256=J9Gj1h5TZ5mNjBYE-Vn2bVPR3VCRwRIf1BrS5DHQrV4,1054
 phenoml/fhir/types/error_response.py,sha256=Vw1veSbj51ki93gmYml3fRjB6XAEwvnkcYkSNhyLDeU,897
 phenoml/fhir/types/fhir_bundle.py,sha256=p_CsuL2U1q7Qzmkdu6vCBtNZLznWmHXw5WtMzDnstdE,1373
@@ -264,7 +266,7 @@ phenoml/workflows/types/workflows_delete_response.py,sha256=izcubUOnSNOgThD9Ozo6
 phenoml/workflows/types/workflows_get_response.py,sha256=gfNyUs14JSynprRwT-fuq4IDsGrPZmUSsK3WmgqIEi8,891
 phenoml/workflows/types/workflows_update_response.py,sha256=FEvQpC9ZRk8dV1oaIAwV5bSDD2tkXZ5fG4mozRjibuQ,1046
 phenoml/wrapper_client.py,sha256=JYTdhXgju4tOsata06wQY_ZbMsuMj3qaxkgvDzpY068,5022
-phenoml-2.0.0.dist-info/LICENSE,sha256=Am1fNNveR2gcmOloSWQTsnUw2SQEF8HtowFqIvlagfk,1064
-phenoml-2.0.0.dist-info/METADATA,sha256=p7eHNT7TrxLHOEWys5gTDVbqmvnVjHns-KNzRQYfvWM,5330
-phenoml-2.0.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-phenoml-2.0.0.dist-info/RECORD,,
+phenoml-2.1.0.dist-info/LICENSE,sha256=Am1fNNveR2gcmOloSWQTsnUw2SQEF8HtowFqIvlagfk,1064
+phenoml-2.1.0.dist-info/METADATA,sha256=NyFbd9whY0E4436OXxs01mPEhbdyeowfsUA4uAjYufU,5330
+phenoml-2.1.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+phenoml-2.1.0.dist-info/RECORD,,