phenoml 0.0.8__py3-none-any.whl → 0.0.10__py3-none-any.whl

phenoml/fhir/raw_client.py

@@ -36,6 +36,7 @@ class RawFhirClient:
         *,
         query_parameters: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None,
         phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[FhirSearchResponse]:
         """
@@ -66,6 +67,11 @@ class RawFhirClient:
 
         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.
@@ -83,6 +89,7 @@ class RawFhirClient:
             },
             headers={
                 "X-Phenoml-On-Behalf-Of": str(phenoml_on_behalf_of) if phenoml_on_behalf_of is not None else None,
+                "X-Phenoml-Fhir-Provider": str(phenoml_fhir_provider) if phenoml_fhir_provider is not None else None,
             },
             request_options=request_options,
         )
@@ -152,6 +159,7 @@ class RawFhirClient:
         *,
         resource_type: str,
         phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
         id: typing.Optional[str] = OMIT,
         meta: typing.Optional[FhirResourceMeta] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
@@ -180,6 +188,11 @@ class RawFhirClient:
 
         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.
 
         id : typing.Optional[str]
             Logical ID of the resource
@@ -208,6 +221,7 @@ class RawFhirClient:
             headers={
                 "content-type": "application/fhir+json",
                 "X-Phenoml-On-Behalf-Of": str(phenoml_on_behalf_of) if phenoml_on_behalf_of is not None else None,
+                "X-Phenoml-Fhir-Provider": str(phenoml_fhir_provider) if phenoml_fhir_provider is not None else None,
             },
             request_options=request_options,
             omit=OMIT,
@@ -267,6 +281,7 @@ class RawFhirClient:
         *,
         resource_type: str,
         phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
         id: typing.Optional[str] = OMIT,
         meta: typing.Optional[FhirResourceMeta] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
@@ -295,6 +310,11 @@ class RawFhirClient:
 
         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.
 
         id : typing.Optional[str]
             Logical ID of the resource
@@ -323,6 +343,7 @@ class RawFhirClient:
             headers={
                 "content-type": "application/fhir+json",
                 "X-Phenoml-On-Behalf-Of": str(phenoml_on_behalf_of) if phenoml_on_behalf_of is not None else None,
+                "X-Phenoml-Fhir-Provider": str(phenoml_fhir_provider) if phenoml_fhir_provider is not None else None,
             },
             request_options=request_options,
             omit=OMIT,
@@ -381,6 +402,7 @@ class RawFhirClient:
         fhir_path: str,
         *,
         phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[typing.Dict[str, typing.Optional[typing.Any]]]:
         """
@@ -404,6 +426,11 @@ class RawFhirClient:
 
         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.
@@ -418,6 +445,7 @@ class RawFhirClient:
             method="DELETE",
             headers={
                 "X-Phenoml-On-Behalf-Of": str(phenoml_on_behalf_of) if phenoml_on_behalf_of is not None else None,
+                "X-Phenoml-Fhir-Provider": str(phenoml_fhir_provider) if phenoml_fhir_provider is not None else None,
             },
             request_options=request_options,
         )
@@ -487,6 +515,7 @@ class RawFhirClient:
         *,
         request: typing.Sequence[FhirPatchRequestBodyItem],
         phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[FhirResource]:
         """
@@ -517,6 +546,11 @@ class RawFhirClient:
 
         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.
@@ -535,6 +569,7 @@ class RawFhirClient:
             headers={
                 "content-type": "application/json-patch+json",
                 "X-Phenoml-On-Behalf-Of": str(phenoml_on_behalf_of) if phenoml_on_behalf_of is not None else None,
+                "X-Phenoml-Fhir-Provider": str(phenoml_fhir_provider) if phenoml_fhir_provider is not None else None,
             },
             request_options=request_options,
             omit=OMIT,
@@ -604,6 +639,7 @@ class RawFhirClient:
         *,
         entry: typing.Sequence[FhirBundleEntryItem],
         phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
         total: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[FhirBundle]:
@@ -626,6 +662,11 @@ class RawFhirClient:
 
         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.
 
         total : typing.Optional[int]
             Total number of resources that match the search criteria.
@@ -652,6 +693,7 @@ class RawFhirClient:
             headers={
                 "content-type": "application/fhir+json",
                 "X-Phenoml-On-Behalf-Of": str(phenoml_on_behalf_of) if phenoml_on_behalf_of is not None else None,
+                "X-Phenoml-Fhir-Provider": str(phenoml_fhir_provider) if phenoml_fhir_provider is not None else None,
             },
             request_options=request_options,
             omit=OMIT,
@@ -716,6 +758,7 @@ class AsyncRawFhirClient:
         *,
         query_parameters: typing.Optional[typing.Dict[str, typing.Optional[str]]] = None,
         phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[FhirSearchResponse]:
         """
@@ -746,6 +789,11 @@ class AsyncRawFhirClient:
 
         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.
@@ -763,6 +811,7 @@ class AsyncRawFhirClient:
             },
             headers={
                 "X-Phenoml-On-Behalf-Of": str(phenoml_on_behalf_of) if phenoml_on_behalf_of is not None else None,
+                "X-Phenoml-Fhir-Provider": str(phenoml_fhir_provider) if phenoml_fhir_provider is not None else None,
             },
             request_options=request_options,
         )
@@ -832,6 +881,7 @@ class AsyncRawFhirClient:
         *,
         resource_type: str,
         phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
         id: typing.Optional[str] = OMIT,
         meta: typing.Optional[FhirResourceMeta] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
@@ -860,6 +910,11 @@ class AsyncRawFhirClient:
 
         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.
 
         id : typing.Optional[str]
             Logical ID of the resource
@@ -888,6 +943,7 @@ class AsyncRawFhirClient:
             headers={
                 "content-type": "application/fhir+json",
                 "X-Phenoml-On-Behalf-Of": str(phenoml_on_behalf_of) if phenoml_on_behalf_of is not None else None,
+                "X-Phenoml-Fhir-Provider": str(phenoml_fhir_provider) if phenoml_fhir_provider is not None else None,
             },
             request_options=request_options,
             omit=OMIT,
@@ -947,6 +1003,7 @@ class AsyncRawFhirClient:
         *,
         resource_type: str,
         phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
         id: typing.Optional[str] = OMIT,
         meta: typing.Optional[FhirResourceMeta] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
@@ -975,6 +1032,11 @@ class AsyncRawFhirClient:
 
         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.
 
         id : typing.Optional[str]
             Logical ID of the resource
@@ -1003,6 +1065,7 @@ class AsyncRawFhirClient:
             headers={
                 "content-type": "application/fhir+json",
                 "X-Phenoml-On-Behalf-Of": str(phenoml_on_behalf_of) if phenoml_on_behalf_of is not None else None,
+                "X-Phenoml-Fhir-Provider": str(phenoml_fhir_provider) if phenoml_fhir_provider is not None else None,
             },
             request_options=request_options,
             omit=OMIT,
@@ -1061,6 +1124,7 @@ class AsyncRawFhirClient:
         fhir_path: str,
         *,
         phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[typing.Dict[str, typing.Optional[typing.Any]]]:
         """
@@ -1084,6 +1148,11 @@ class AsyncRawFhirClient:
 
         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.
@@ -1098,6 +1167,7 @@ class AsyncRawFhirClient:
             method="DELETE",
             headers={
                 "X-Phenoml-On-Behalf-Of": str(phenoml_on_behalf_of) if phenoml_on_behalf_of is not None else None,
+                "X-Phenoml-Fhir-Provider": str(phenoml_fhir_provider) if phenoml_fhir_provider is not None else None,
             },
             request_options=request_options,
         )
@@ -1167,6 +1237,7 @@ class AsyncRawFhirClient:
         *,
         request: typing.Sequence[FhirPatchRequestBodyItem],
         phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[FhirResource]:
         """
@@ -1197,6 +1268,11 @@ class AsyncRawFhirClient:
 
         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.
@@ -1215,6 +1291,7 @@ class AsyncRawFhirClient:
             headers={
                 "content-type": "application/json-patch+json",
                 "X-Phenoml-On-Behalf-Of": str(phenoml_on_behalf_of) if phenoml_on_behalf_of is not None else None,
+                "X-Phenoml-Fhir-Provider": str(phenoml_fhir_provider) if phenoml_fhir_provider is not None else None,
             },
             request_options=request_options,
             omit=OMIT,
@@ -1284,6 +1361,7 @@ class AsyncRawFhirClient:
         *,
         entry: typing.Sequence[FhirBundleEntryItem],
         phenoml_on_behalf_of: typing.Optional[str] = None,
+        phenoml_fhir_provider: typing.Optional[str] = None,
         total: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[FhirBundle]:
@@ -1306,6 +1384,11 @@ class AsyncRawFhirClient:
 
         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.
 
         total : typing.Optional[int]
             Total number of resources that match the search criteria.
@@ -1332,6 +1415,7 @@ class AsyncRawFhirClient:
             headers={
                 "content-type": "application/fhir+json",
                 "X-Phenoml-On-Behalf-Of": str(phenoml_on_behalf_of) if phenoml_on_behalf_of is not None else None,
+                "X-Phenoml-Fhir-Provider": str(phenoml_fhir_provider) if phenoml_fhir_provider is not None else None,
             },
             request_options=request_options,
             omit=OMIT,

phenoml/fhir_provider/__init__.py

@@ -15,6 +15,7 @@ from .types import (
     FhirQueryResponseData,
     JsonWebKey,
     Provider,
+    Role,
     ServiceAccountKey,
     SmartConfiguration,
 )
@@ -37,6 +38,7 @@ __all__ = [
     "JsonWebKey",
     "NotFoundError",
     "Provider",
+    "Role",
     "ServiceAccountKey",
     "SmartConfiguration",
     "UnauthorizedError",

phenoml/fhir_provider/client.py

@@ -13,6 +13,7 @@ from .types.fhir_provider_remove_auth_config_response import FhirProviderRemoveA
 from .types.fhir_provider_response import FhirProviderResponse
 from .types.fhir_provider_set_active_auth_config_response import FhirProviderSetActiveAuthConfigResponse
 from .types.provider import Provider
+from .types.role import Role
 from .types.service_account_key import ServiceAccountKey
 
 # this is used as the default value for optional parameters
@@ -45,6 +46,7 @@ class FhirProviderClient:
         client_id: typing.Optional[str] = OMIT,
         client_secret: typing.Optional[str] = OMIT,
         service_account_key: typing.Optional[ServiceAccountKey] = OMIT,
+        role: typing.Optional[Role] = OMIT,
         scopes: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> FhirProviderResponse:
@@ -74,8 +76,10 @@ class FhirProviderClient:
 
         service_account_key : typing.Optional[ServiceAccountKey]
 
+        role : typing.Optional[Role]
+
         scopes : typing.Optional[str]
-            OAuth scopes to request
+            OAuth scopes to request. Cannot be specified with role. If neither role nor scopes are specified, the provider-specific default role will be used. You are solely responsible for ensuring the scopes are valid options for the provider being created or updated.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -108,6 +112,7 @@ class FhirProviderClient:
             client_id=client_id,
             client_secret=client_secret,
             service_account_key=service_account_key,
+            role=role,
             scopes=scopes,
             request_options=request_options,
         )
@@ -213,6 +218,7 @@ class FhirProviderClient:
         client_secret: typing.Optional[str] = OMIT,
         service_account_key: typing.Optional[ServiceAccountKey] = OMIT,
         credential_expiry: typing.Optional[dt.datetime] = OMIT,
+        role: typing.Optional[Role] = OMIT,
         scopes: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> FhirProviderResponse:
@@ -234,8 +240,10 @@ class FhirProviderClient:
         credential_expiry : typing.Optional[dt.datetime]
             Expiry time for JWT credentials (only applicable for JWT auth method)
 
+        role : typing.Optional[Role]
+
         scopes : typing.Optional[str]
-            OAuth scopes to request
+            OAuth scopes to request. Cannot be specified with role. If neither role nor scopes are specified, the provider-specific default role will be used. You are solely responsible for ensuring the scopes are valid options for the provider being created or updated.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -263,6 +271,7 @@ class FhirProviderClient:
             client_secret=client_secret,
             service_account_key=service_account_key,
             credential_expiry=credential_expiry,
+            role=role,
             scopes=scopes,
             request_options=request_options,
         )
@@ -373,6 +382,7 @@ class AsyncFhirProviderClient:
         client_id: typing.Optional[str] = OMIT,
         client_secret: typing.Optional[str] = OMIT,
         service_account_key: typing.Optional[ServiceAccountKey] = OMIT,
+        role: typing.Optional[Role] = OMIT,
         scopes: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> FhirProviderResponse:
@@ -402,8 +412,10 @@ class AsyncFhirProviderClient:
 
         service_account_key : typing.Optional[ServiceAccountKey]
 
+        role : typing.Optional[Role]
+
         scopes : typing.Optional[str]
-            OAuth scopes to request
+            OAuth scopes to request. Cannot be specified with role. If neither role nor scopes are specified, the provider-specific default role will be used. You are solely responsible for ensuring the scopes are valid options for the provider being created or updated.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -444,6 +456,7 @@ class AsyncFhirProviderClient:
             client_id=client_id,
             client_secret=client_secret,
             service_account_key=service_account_key,
+            role=role,
             scopes=scopes,
             request_options=request_options,
         )
@@ -573,6 +586,7 @@ class AsyncFhirProviderClient:
         client_secret: typing.Optional[str] = OMIT,
         service_account_key: typing.Optional[ServiceAccountKey] = OMIT,
         credential_expiry: typing.Optional[dt.datetime] = OMIT,
+        role: typing.Optional[Role] = OMIT,
         scopes: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> FhirProviderResponse:
@@ -594,8 +608,10 @@ class AsyncFhirProviderClient:
         credential_expiry : typing.Optional[dt.datetime]
             Expiry time for JWT credentials (only applicable for JWT auth method)
 
+        role : typing.Optional[Role]
+
         scopes : typing.Optional[str]
-            OAuth scopes to request
+            OAuth scopes to request. Cannot be specified with role. If neither role nor scopes are specified, the provider-specific default role will be used. You are solely responsible for ensuring the scopes are valid options for the provider being created or updated.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -631,6 +647,7 @@ class AsyncFhirProviderClient:
             client_secret=client_secret,
             service_account_key=service_account_key,
             credential_expiry=credential_expiry,
+            role=role,
             scopes=scopes,
             request_options=request_options,
         )

phenoml/fhir_provider/raw_client.py

@@ -23,6 +23,7 @@ from .types.fhir_provider_remove_auth_config_response import FhirProviderRemoveA
 from .types.fhir_provider_response import FhirProviderResponse
 from .types.fhir_provider_set_active_auth_config_response import FhirProviderSetActiveAuthConfigResponse
 from .types.provider import Provider
+from .types.role import Role
 from .types.service_account_key import ServiceAccountKey
 
 # this is used as the default value for optional parameters
@@ -44,6 +45,7 @@ class RawFhirProviderClient:
         client_id: typing.Optional[str] = OMIT,
         client_secret: typing.Optional[str] = OMIT,
         service_account_key: typing.Optional[ServiceAccountKey] = OMIT,
+        role: typing.Optional[Role] = OMIT,
         scopes: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[FhirProviderResponse]:
@@ -73,8 +75,10 @@ class RawFhirProviderClient:
 
         service_account_key : typing.Optional[ServiceAccountKey]
 
+        role : typing.Optional[Role]
+
         scopes : typing.Optional[str]
-            OAuth scopes to request
+            OAuth scopes to request. Cannot be specified with role. If neither role nor scopes are specified, the provider-specific default role will be used. You are solely responsible for ensuring the scopes are valid options for the provider being created or updated.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -85,7 +89,7 @@ class RawFhirProviderClient:
             FHIR provider created successfully
         """
         _response = self._client_wrapper.httpx_client.request(
-            "fhir-provider/create",
+            "fhir-provider",
             method="POST",
             json={
                 "name": name,
@@ -98,6 +102,7 @@ class RawFhirProviderClient:
                 "service_account_key": convert_and_respect_annotation_metadata(
                     object_=service_account_key, annotation=ServiceAccountKey, direction="write"
                 ),
+                "role": role,
                 "scopes": scopes,
             },
             headers={
@@ -408,6 +413,7 @@ class RawFhirProviderClient:
         client_secret: typing.Optional[str] = OMIT,
         service_account_key: typing.Optional[ServiceAccountKey] = OMIT,
         credential_expiry: typing.Optional[dt.datetime] = OMIT,
+        role: typing.Optional[Role] = OMIT,
         scopes: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[FhirProviderResponse]:
@@ -429,8 +435,10 @@ class RawFhirProviderClient:
         credential_expiry : typing.Optional[dt.datetime]
             Expiry time for JWT credentials (only applicable for JWT auth method)
 
+        role : typing.Optional[Role]
+
         scopes : typing.Optional[str]
-            OAuth scopes to request
+            OAuth scopes to request. Cannot be specified with role. If neither role nor scopes are specified, the provider-specific default role will be used. You are solely responsible for ensuring the scopes are valid options for the provider being created or updated.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -450,6 +458,7 @@ class RawFhirProviderClient:
                     object_=service_account_key, annotation=ServiceAccountKey, direction="write"
                 ),
                 "credential_expiry": credential_expiry,
+                "role": role,
                 "scopes": scopes,
             },
             headers={
@@ -752,6 +761,7 @@ class AsyncRawFhirProviderClient:
         client_id: typing.Optional[str] = OMIT,
         client_secret: typing.Optional[str] = OMIT,
         service_account_key: typing.Optional[ServiceAccountKey] = OMIT,
+        role: typing.Optional[Role] = OMIT,
         scopes: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[FhirProviderResponse]:
@@ -781,8 +791,10 @@ class AsyncRawFhirProviderClient:
 
         service_account_key : typing.Optional[ServiceAccountKey]
 
+        role : typing.Optional[Role]
+
         scopes : typing.Optional[str]
-            OAuth scopes to request
+            OAuth scopes to request. Cannot be specified with role. If neither role nor scopes are specified, the provider-specific default role will be used. You are solely responsible for ensuring the scopes are valid options for the provider being created or updated.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -793,7 +805,7 @@ class AsyncRawFhirProviderClient:
             FHIR provider created successfully
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "fhir-provider/create",
+            "fhir-provider",
             method="POST",
             json={
                 "name": name,
@@ -806,6 +818,7 @@ class AsyncRawFhirProviderClient:
                 "service_account_key": convert_and_respect_annotation_metadata(
                     object_=service_account_key, annotation=ServiceAccountKey, direction="write"
                 ),
+                "role": role,
                 "scopes": scopes,
             },
             headers={
@@ -1116,6 +1129,7 @@ class AsyncRawFhirProviderClient:
         client_secret: typing.Optional[str] = OMIT,
         service_account_key: typing.Optional[ServiceAccountKey] = OMIT,
         credential_expiry: typing.Optional[dt.datetime] = OMIT,
+        role: typing.Optional[Role] = OMIT,
         scopes: typing.Optional[str] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[FhirProviderResponse]:
@@ -1137,8 +1151,10 @@ class AsyncRawFhirProviderClient:
         credential_expiry : typing.Optional[dt.datetime]
             Expiry time for JWT credentials (only applicable for JWT auth method)
 
+        role : typing.Optional[Role]
+
         scopes : typing.Optional[str]
-            OAuth scopes to request
+            OAuth scopes to request. Cannot be specified with role. If neither role nor scopes are specified, the provider-specific default role will be used. You are solely responsible for ensuring the scopes are valid options for the provider being created or updated.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1158,6 +1174,7 @@ class AsyncRawFhirProviderClient:
                     object_=service_account_key, annotation=ServiceAccountKey, direction="write"
                 ),
                 "credential_expiry": credential_expiry,
+                "role": role,
                 "scopes": scopes,
             },
             headers={

phenoml/fhir_provider/types/__init__.py

@@ -14,6 +14,7 @@ from .fhir_query_response import FhirQueryResponse
 from .fhir_query_response_data import FhirQueryResponseData
 from .json_web_key import JsonWebKey
 from .provider import Provider
+from .role import Role
 from .service_account_key import ServiceAccountKey
 from .smart_configuration import SmartConfiguration
 
@@ -30,6 +31,7 @@ __all__ = [
     "FhirQueryResponseData",
     "JsonWebKey",
     "Provider",
+    "Role",
     "ServiceAccountKey",
     "SmartConfiguration",
 ]

phenoml/fhir_provider/types/auth_method.py

@@ -3,5 +3,5 @@
 import typing
 
 AuthMethod = typing.Union[
-    typing.Literal["client_secret", "google_healthcare", "jwt", "on_behalf_of", "none"], typing.Any
+    typing.Literal["client_secret", "google_healthcare", "jwt", "on_behalf_of", "token_passthrough", "none"], typing.Any
 ]

phenoml/fhir_provider/types/role.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+Role = typing.Union[
+    typing.Literal[
+        "SmartV1Admin",
+        "SmartV1Read",
+        "SmartV1Write",
+        "SmartV2Admin",
+        "SmartV2Read",
+        "SmartV2Write",
+        "USCDISmartV1Admin",
+        "USCDISmartV1Read",
+        "USCDISmartV1Write",
+        "USCDISmartV2Admin",
+        "USCDISmartV2Read",
+        "USCDISmartV2Write",
+        "CernerSmartV1Admin",
+        "CernerSmartV1Read",
+        "CernerSmartV1Write",
+        "CernerSmartV2Admin",
+        "CernerSmartV2Read",
+        "CernerSmartV2Write",
+    ],
+    typing.Any,
+]