phenoml 0.0.20 → 0.0.22

package/dist/cjs/Client.js

@@ -52,8 +52,8 @@ class phenomlClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "phenoml",
-                "X-Fern-SDK-Version": "0.0.20",
-                "User-Agent": "phenoml/0.0.20",
+                "X-Fern-SDK-Version": "0.0.22",
+                "User-Agent": "phenoml/0.0.22",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/api/resources/agent/client/Client.d.ts

@@ -169,7 +169,7 @@ export declare class Agent {
      *     await client.agent.getChatMessages({
      *         chat_session_id: "chat_session_id",
      *         num_messages: 1,
-     *         role: "role",
+     *         role: "user",
      *         order: "asc"
      *     })
      */

package/dist/cjs/api/resources/agent/client/Client.js

@@ -616,7 +616,7 @@ class Agent {
      *     await client.agent.getChatMessages({
      *         chat_session_id: "chat_session_id",
      *         num_messages: 1,
-     *         role: "role",
+     *         role: "user",
      *         order: "asc"
      *     })
      */

package/dist/cjs/api/resources/agent/client/requests/AgentGetChatMessagesRequest.d.ts

@@ -4,7 +4,7 @@ import type * as phenoml from "../../../../index.js";
  *     {
  *         chat_session_id: "chat_session_id",
  *         num_messages: 1,
- *         role: "role",
+ *         role: "user",
  *         order: "asc"
  *     }
  */
@@ -13,8 +13,17 @@ export interface AgentGetChatMessagesRequest {
     chat_session_id: string;
     /** Number of messages to return */
     num_messages?: number;
-    /** Filter by role */
-    role?: string;
+    /**
+     * Filter by one or more message roles. Multiple roles can be specified as a comma-separated string.
+     * If not specified, messages with all roles are returned.
+     *
+     * **Available roles:**
+     * - `user` - Messages from the user
+     * - `assistant` - Text responses from the AI assistant
+     * - `model` - Function/tool call requests from the model
+     * - `function` - Function/tool call results
+     */
+    role?: phenoml.agent.AgentGetChatMessagesRequestRole;
     /** Order of messages */
     order?: phenoml.agent.AgentGetChatMessagesRequestOrder;
 }

package/dist/cjs/api/resources/agent/types/AgentGetChatMessagesRequestRole.d.ts

@@ -0,0 +1,7 @@
+export declare const AgentGetChatMessagesRequestRole: {
+    readonly User: "user";
+    readonly Assistant: "assistant";
+    readonly Model: "model";
+    readonly Function: "function";
+};
+export type AgentGetChatMessagesRequestRole = (typeof AgentGetChatMessagesRequestRole)[keyof typeof AgentGetChatMessagesRequestRole];

package/dist/cjs/api/resources/agent/types/AgentGetChatMessagesRequestRole.js

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentGetChatMessagesRequestRole = void 0;
+exports.AgentGetChatMessagesRequestRole = {
+    User: "user",
+    Assistant: "assistant",
+    Model: "model",
+    Function: "function",
+};

package/dist/cjs/api/resources/agent/types/ChatMessageTemplate.d.ts

@@ -3,8 +3,14 @@ export interface ChatMessageTemplate {
     id?: string;
     /** Chat session ID */
     session_id?: string;
-    /** Message role */
-    role?: string;
+    /**
+     * Message role indicating the source/type of the message:
+     * - `user` - Messages from the user
+     * - `assistant` - Text responses from the AI assistant
+     * - `model` - Function/tool call requests to the model
+     * - `function` - Function/tool call results
+     */
+    role?: ChatMessageTemplate.Role;
     /** Message content */
     content?: string;
     /** Message created time */
@@ -22,3 +28,19 @@ export interface ChatMessageTemplate {
     /** Message order */
     message_order?: number;
 }
+export declare namespace ChatMessageTemplate {
+    /**
+     * Message role indicating the source/type of the message:
+     * - `user` - Messages from the user
+     * - `assistant` - Text responses from the AI assistant
+     * - `model` - Function/tool call requests to the model
+     * - `function` - Function/tool call results
+     */
+    const Role: {
+        readonly User: "user";
+        readonly Assistant: "assistant";
+        readonly Model: "model";
+        readonly Function: "function";
+    };
+    type Role = (typeof Role)[keyof typeof Role];
+}

package/dist/cjs/api/resources/agent/types/ChatMessageTemplate.js

@@ -1,3 +1,20 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatMessageTemplate = void 0;
+var ChatMessageTemplate;
+(function (ChatMessageTemplate) {
+    /**
+     * Message role indicating the source/type of the message:
+     * - `user` - Messages from the user
+     * - `assistant` - Text responses from the AI assistant
+     * - `model` - Function/tool call requests to the model
+     * - `function` - Function/tool call results
+     */
+    ChatMessageTemplate.Role = {
+        User: "user",
+        Assistant: "assistant",
+        Model: "model",
+        Function: "function",
+    };
+})(ChatMessageTemplate || (exports.ChatMessageTemplate = ChatMessageTemplate = {}));

package/dist/cjs/api/resources/agent/types/index.d.ts

@@ -2,6 +2,7 @@ export * from "./AgentChatResponse.js";
 export * from "./AgentCreateRequest.js";
 export * from "./AgentDeleteResponse.js";
 export * from "./AgentGetChatMessagesRequestOrder.js";
+export * from "./AgentGetChatMessagesRequestRole.js";
 export * from "./AgentGetChatMessagesResponse.js";
 export * from "./AgentListResponse.js";
 export * from "./AgentPromptsResponse.js";

package/dist/cjs/api/resources/agent/types/index.js

@@ -18,6 +18,7 @@ __exportStar(require("./AgentChatResponse.js"), exports);
 __exportStar(require("./AgentCreateRequest.js"), exports);
 __exportStar(require("./AgentDeleteResponse.js"), exports);
 __exportStar(require("./AgentGetChatMessagesRequestOrder.js"), exports);
+__exportStar(require("./AgentGetChatMessagesRequestRole.js"), exports);
 __exportStar(require("./AgentGetChatMessagesResponse.js"), exports);
 __exportStar(require("./AgentListResponse.js"), exports);
 __exportStar(require("./AgentPromptsResponse.js"), exports);

package/dist/cjs/api/resources/fhirProvider/client/Client.d.ts

@@ -11,7 +11,9 @@ export declare class FhirProvider {
     protected readonly _options: FhirProvider.Options;
     constructor(_options: FhirProvider.Options);
     /**
-     * Creates a new FHIR provider configuration with authentication credentials
+     * Creates a new FHIR provider configuration with authentication credentials.
+     *
+     * Note: The "sandbox" provider type cannot be created via this API - it is managed internally.
      *
      * @param {phenoml.fhirProvider.FhirProviderCreateRequest} request
      * @param {FhirProvider.RequestOptions} requestOptions - Request-specific configuration.
@@ -32,12 +34,14 @@ export declare class FhirProvider {
     create(request: phenoml.fhirProvider.FhirProviderCreateRequest, requestOptions?: FhirProvider.RequestOptions): core.HttpResponsePromise<phenoml.fhirProvider.FhirProviderResponse>;
     private __create;
     /**
-     * Retrieves a list of all active FHIR providers for the authenticated user
+     * Retrieves a list of all active FHIR providers for the authenticated user.
+     *
+     * On shared instances, only sandbox providers are returned.
+     * Sandbox providers return FhirProviderSandboxInfo.
      *
      * @param {FhirProvider.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link phenoml.fhirProvider.UnauthorizedError}
-     * @throws {@link phenoml.fhirProvider.ForbiddenError}
      * @throws {@link phenoml.fhirProvider.InternalServerError}
      *
      * @example
@@ -46,7 +50,10 @@ export declare class FhirProvider {
     list(requestOptions?: FhirProvider.RequestOptions): core.HttpResponsePromise<phenoml.fhirProvider.FhirProviderListResponse>;
     private __list;
     /**
-     * Retrieves a specific FHIR provider configuration by its ID
+     * Retrieves a specific FHIR provider configuration by its ID.
+     *
+     * Sandbox providers return FhirProviderSandboxInfo.
+     * On shared instances, only sandbox providers can be accessed.
      *
      * @param {string} fhirProviderId - ID of the FHIR provider to retrieve
      * @param {FhirProvider.RequestOptions} requestOptions - Request-specific configuration.
@@ -62,7 +69,9 @@ export declare class FhirProvider {
     get(fhirProviderId: string, requestOptions?: FhirProvider.RequestOptions): core.HttpResponsePromise<phenoml.fhirProvider.FhirProviderResponse>;
     private __get;
     /**
-     * Soft deletes a FHIR provider by setting is_active to false
+     * Soft deletes a FHIR provider by setting is_active to false.
+     *
+     * Note: Sandbox providers cannot be deleted.
      *
      * @param {string} fhirProviderId - ID of the FHIR provider to delete
      * @param {FhirProvider.RequestOptions} requestOptions - Request-specific configuration.
@@ -78,7 +87,10 @@ export declare class FhirProvider {
     delete(fhirProviderId: string, requestOptions?: FhirProvider.RequestOptions): core.HttpResponsePromise<phenoml.fhirProvider.FhirProviderDeleteResponse>;
     private __delete;
     /**
-     * Adds a new authentication configuration to an existing FHIR provider. This enables key rotation and multiple auth configurations per provider.
+     * Adds a new authentication configuration to an existing FHIR provider.
+     * This enables key rotation and multiple auth configurations per provider.
+     *
+     * Note: Sandbox providers cannot be modified.
      *
      * @param {string} fhirProviderId - ID of the FHIR provider to add auth config to
      * @param {phenoml.fhirProvider.FhirProviderAddAuthConfigRequest} request
@@ -98,7 +110,13 @@ export declare class FhirProvider {
     addAuthConfig(fhirProviderId: string, request: phenoml.fhirProvider.FhirProviderAddAuthConfigRequest, requestOptions?: FhirProvider.RequestOptions): core.HttpResponsePromise<phenoml.fhirProvider.FhirProviderResponse>;
     private __addAuthConfig;
     /**
-     * Sets which authentication configuration should be active for a FHIR provider. Only one auth config can be active at a time.
+     * Sets which authentication configuration should be active for a FHIR provider.
+     * Only one auth config can be active at a time.
+     *
+     * If the specified auth config is already active, the request succeeds without
+     * making any changes and returns a message indicating the config is already active.
+     *
+     * Note: Sandbox providers cannot be modified.
      *
      * @param {string} fhirProviderId - ID of the FHIR provider
      * @param {phenoml.fhirProvider.FhirProviderSetActiveAuthConfigRequest} request
@@ -115,10 +133,13 @@ export declare class FhirProvider {
      *         auth_config_id: "auth-config-123"
      *     })
      */
-    setActiveAuthConfig(fhirProviderId: string, request: phenoml.fhirProvider.FhirProviderSetActiveAuthConfigRequest, requestOptions?: FhirProvider.RequestOptions): core.HttpResponsePromise<phenoml.fhirProvider.FhirProviderSetActiveAuthConfigResponse>;
+    setActiveAuthConfig(fhirProviderId: string, request: phenoml.fhirProvider.FhirProviderSetActiveAuthConfigRequest, requestOptions?: FhirProvider.RequestOptions): core.HttpResponsePromise<phenoml.fhirProvider.FhirProviderResponse>;
     private __setActiveAuthConfig;
     /**
-     * Removes an authentication configuration from a FHIR provider. Cannot remove the currently active auth configuration.
+     * Removes an authentication configuration from a FHIR provider.
+     * Cannot remove the currently active auth configuration.
+     *
+     * Note: Sandbox providers cannot be modified.
      *
      * @param {string} fhirProviderId - ID of the FHIR provider
      * @param {phenoml.fhirProvider.FhirProviderRemoveAuthConfigRequest} request

package/dist/cjs/api/resources/fhirProvider/client/Client.js

@@ -54,7 +54,9 @@ class FhirProvider {
         this._options = _options;
     }
     /**
-     * Creates a new FHIR provider configuration with authentication credentials
+     * Creates a new FHIR provider configuration with authentication credentials.
+     *
+     * Note: The "sandbox" provider type cannot be created via this API - it is managed internally.
      *
      * @param {phenoml.fhirProvider.FhirProviderCreateRequest} request
      * @param {FhirProvider.RequestOptions} requestOptions - Request-specific configuration.
@@ -133,12 +135,14 @@ class FhirProvider {
         });
     }
     /**
-     * Retrieves a list of all active FHIR providers for the authenticated user
+     * Retrieves a list of all active FHIR providers for the authenticated user.
+     *
+     * On shared instances, only sandbox providers are returned.
+     * Sandbox providers return FhirProviderSandboxInfo.
      *
      * @param {FhirProvider.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link phenoml.fhirProvider.UnauthorizedError}
-     * @throws {@link phenoml.fhirProvider.ForbiddenError}
      * @throws {@link phenoml.fhirProvider.InternalServerError}
      *
      * @example
@@ -170,8 +174,6 @@ class FhirProvider {
                 switch (_response.error.statusCode) {
                     case 401:
                         throw new phenoml.fhirProvider.UnauthorizedError(_response.error.body, _response.rawResponse);
-                    case 403:
-                        throw new phenoml.fhirProvider.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new phenoml.fhirProvider.InternalServerError(_response.error.body, _response.rawResponse);
                     default:
@@ -200,7 +202,10 @@ class FhirProvider {
         });
     }
     /**
-     * Retrieves a specific FHIR provider configuration by its ID
+     * Retrieves a specific FHIR provider configuration by its ID.
+     *
+     * Sandbox providers return FhirProviderSandboxInfo.
+     * On shared instances, only sandbox providers can be accessed.
      *
      * @param {string} fhirProviderId - ID of the FHIR provider to retrieve
      * @param {FhirProvider.RequestOptions} requestOptions - Request-specific configuration.
@@ -271,7 +276,9 @@ class FhirProvider {
         });
     }
     /**
-     * Soft deletes a FHIR provider by setting is_active to false
+     * Soft deletes a FHIR provider by setting is_active to false.
+     *
+     * Note: Sandbox providers cannot be deleted.
      *
      * @param {string} fhirProviderId - ID of the FHIR provider to delete
      * @param {FhirProvider.RequestOptions} requestOptions - Request-specific configuration.
@@ -342,7 +349,10 @@ class FhirProvider {
         });
     }
     /**
-     * Adds a new authentication configuration to an existing FHIR provider. This enables key rotation and multiple auth configurations per provider.
+     * Adds a new authentication configuration to an existing FHIR provider.
+     * This enables key rotation and multiple auth configurations per provider.
+     *
+     * Note: Sandbox providers cannot be modified.
      *
      * @param {string} fhirProviderId - ID of the FHIR provider to add auth config to
      * @param {phenoml.fhirProvider.FhirProviderAddAuthConfigRequest} request
@@ -422,7 +432,13 @@ class FhirProvider {
         });
     }
     /**
-     * Sets which authentication configuration should be active for a FHIR provider. Only one auth config can be active at a time.
+     * Sets which authentication configuration should be active for a FHIR provider.
+     * Only one auth config can be active at a time.
+     *
+     * If the specified auth config is already active, the request succeeds without
+     * making any changes and returns a message indicating the config is already active.
+     *
+     * Note: Sandbox providers cannot be modified.
      *
      * @param {string} fhirProviderId - ID of the FHIR provider
      * @param {phenoml.fhirProvider.FhirProviderSetActiveAuthConfigRequest} request
@@ -502,7 +518,10 @@ class FhirProvider {
         });
     }
     /**
-     * Removes an authentication configuration from a FHIR provider. Cannot remove the currently active auth configuration.
+     * Removes an authentication configuration from a FHIR provider.
+     * Cannot remove the currently active auth configuration.
+     *
+     * Note: Sandbox providers cannot be modified.
      *
      * @param {string} fhirProviderId - ID of the FHIR provider
      * @param {phenoml.fhirProvider.FhirProviderRemoveAuthConfigRequest} request

package/dist/cjs/api/resources/fhirProvider/types/FhirProviderAuthConfig.d.ts

@@ -8,12 +8,17 @@ export interface FhirProviderAuthConfig {
     auth_method?: phenoml.fhirProvider.AuthMethod;
     /** Whether this auth configuration is currently active */
     is_active_auth_config?: boolean;
+    /** Timestamp when this auth configuration was created */
+    created_at?: string;
+    /** Timestamp when this auth configuration was last updated */
+    updated_at?: string;
     /** Public key certificate in PEM format (visible for JWT auth) */
     public_key_cert_pem?: string;
     json_web_key?: phenoml.fhirProvider.JsonWebKey;
     /** Expiry time for credentials (JWT auth only) */
     credential_expiry?: string;
     smart_configuration?: phenoml.fhirProvider.SmartConfiguration;
+    service_account_metadata?: phenoml.fhirProvider.ServiceAccountMetadata;
     /** OAuth scopes */
     scopes?: string;
 }

package/dist/cjs/api/resources/fhirProvider/types/FhirProviderListResponse.d.ts

@@ -1,6 +1,21 @@
 import type * as phenoml from "../../../index.js";
+/**
+ * Response payload for listing FHIR Providers.
+ * On shared instances, only sandbox providers are returned (as FhirProviderSandboxInfo).
+ * On dedicated instances, full provider details are returned (as FhirProviderTemplate).
+ */
 export interface FhirProviderListResponse {
     success?: boolean;
     message?: string;
-    fhir_providers?: phenoml.fhirProvider.FhirProviderTemplate[];
+    /**
+     * List of FHIR providers. Sandbox providers return FhirProviderSandboxInfo,
+     * other providers return FhirProviderTemplate.
+     */
+    fhir_providers?: FhirProviderListResponse.FhirProviders.Item[];
+}
+export declare namespace FhirProviderListResponse {
+    type FhirProviders = FhirProviders.Item[];
+    namespace FhirProviders {
+        type Item = phenoml.fhirProvider.FhirProviderTemplate | phenoml.fhirProvider.FhirProviderSandboxInfo;
+    }
 }

package/dist/cjs/api/resources/fhirProvider/types/FhirProviderResponse.d.ts

@@ -1,6 +1,16 @@
 import type * as phenoml from "../../../index.js";
+/**
+ * Response payload for a single FHIR Provider operation.
+ */
 export interface FhirProviderResponse {
     success?: boolean;
     message?: string;
-    data?: phenoml.fhirProvider.FhirProviderTemplate;
+    /** Provider details. Sandbox providers return FhirProviderSandboxInfo. */
+    data?: FhirProviderResponse.Data;
+}
+export declare namespace FhirProviderResponse {
+    /**
+     * Provider details. Sandbox providers return FhirProviderSandboxInfo.
+     */
+    type Data = phenoml.fhirProvider.FhirProviderTemplate | phenoml.fhirProvider.FhirProviderSandboxInfo;
 }

package/dist/cjs/api/resources/fhirProvider/types/FhirProviderSandboxInfo.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Information returned for sandbox FHIR providers.
+ */
+export interface FhirProviderSandboxInfo {
+    /** Unique identifier for the FHIR provider */
+    id?: string;
+    /** Display name for the FHIR provider */
+    name?: string;
+    /** Optional description of the FHIR provider */
+    description?: string;
+    /** Provider type (always "sandbox" for this schema) */
+    provider?: "sandbox";
+    /** Whether the FHIR provider is active */
+    is_active?: boolean;
+}

package/dist/cjs/api/resources/fhirProvider/types/Provider.d.ts

@@ -1,4 +1,9 @@
-/** Type of FHIR server provider */
+/**
+ * Type of FHIR server provider.
+ *
+ * The "sandbox" provider type is managed internally and cannot be created via API.
+ * It is used on shared instances.
+ */
 export declare const Provider: {
     readonly Athenahealth: "athenahealth";
     readonly Canvas: "canvas";
@@ -8,5 +13,6 @@ export declare const Provider: {
     readonly GoogleHealthcare: "google_healthcare";
     readonly Hapi: "hapi";
     readonly Medplum: "medplum";
+    readonly Sandbox: "sandbox";
 };
 export type Provider = (typeof Provider)[keyof typeof Provider];

package/dist/cjs/api/resources/fhirProvider/types/Provider.js

@@ -2,7 +2,12 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Provider = void 0;
-/** Type of FHIR server provider */
+/**
+ * Type of FHIR server provider.
+ *
+ * The "sandbox" provider type is managed internally and cannot be created via API.
+ * It is used on shared instances.
+ */
 exports.Provider = {
     Athenahealth: "athenahealth",
     Canvas: "canvas",
@@ -12,4 +17,5 @@ exports.Provider = {
     GoogleHealthcare: "google_healthcare",
     Hapi: "hapi",
     Medplum: "medplum",
+    Sandbox: "sandbox",
 };

package/dist/cjs/api/resources/fhirProvider/types/ServiceAccountMetadata.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Non-sensitive metadata from a Google Cloud Service Account, exposed in API responses to help identify auth configurations without revealing sensitive credentials.
+ */
+export interface ServiceAccountMetadata {
+    /** Account type (always "service_account") */
+    type?: string;
+    /** Google Cloud project ID */
+    project_id?: string;
+    /** Service account email address */
+    client_email?: string;
+    /** Service account client ID */
+    client_id?: string;
+}

package/dist/cjs/api/resources/fhirProvider/types/ServiceAccountMetadata.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/fhirProvider/types/index.d.ts

@@ -4,11 +4,12 @@ export * from "./FhirProviderDeleteResponse.js";
 export * from "./FhirProviderListResponse.js";
 export * from "./FhirProviderRemoveAuthConfigResponse.js";
 export * from "./FhirProviderResponse.js";
-export * from "./FhirProviderSetActiveAuthConfigResponse.js";
+export * from "./FhirProviderSandboxInfo.js";
 export * from "./FhirProviderTemplate.js";
 export * from "./FhirQueryResponse.js";
 export * from "./JsonWebKey.js";
 export * from "./Provider.js";
 export * from "./Role.js";
 export * from "./ServiceAccountKey.js";
+export * from "./ServiceAccountMetadata.js";
 export * from "./SmartConfiguration.js";

package/dist/cjs/api/resources/fhirProvider/types/index.js

@@ -20,11 +20,12 @@ __exportStar(require("./FhirProviderDeleteResponse.js"), exports);
 __exportStar(require("./FhirProviderListResponse.js"), exports);
 __exportStar(require("./FhirProviderRemoveAuthConfigResponse.js"), exports);
 __exportStar(require("./FhirProviderResponse.js"), exports);
-__exportStar(require("./FhirProviderSetActiveAuthConfigResponse.js"), exports);
+__exportStar(require("./FhirProviderSandboxInfo.js"), exports);
 __exportStar(require("./FhirProviderTemplate.js"), exports);
 __exportStar(require("./FhirQueryResponse.js"), exports);
 __exportStar(require("./JsonWebKey.js"), exports);
 __exportStar(require("./Provider.js"), exports);
 __exportStar(require("./Role.js"), exports);
 __exportStar(require("./ServiceAccountKey.js"), exports);
+__exportStar(require("./ServiceAccountMetadata.js"), exports);
 __exportStar(require("./SmartConfiguration.js"), exports);

package/dist/cjs/api/resources/lang2Fhir/client/Client.d.ts

@@ -49,7 +49,14 @@ export declare class Lang2Fhir {
     createMulti(request: phenoml.lang2Fhir.CreateMultiRequest, requestOptions?: Lang2Fhir.RequestOptions): core.HttpResponsePromise<phenoml.lang2Fhir.CreateMultiResponse>;
     private __createMulti;
     /**
-     * Converts natural language text into FHIR search parameters
+     * Converts natural language text into FHIR search parameters.
+     * Automatically identifies the appropriate FHIR resource type and generates valid search query parameters.
+     *
+     * Supported resource types include: AllergyIntolerance, Appointment, CarePlan, CareTeam, Condition,
+     * Coverage, Device, DiagnosticReport, DocumentReference, Encounter, Goal, Immunization, Location,
+     * Medication, MedicationRequest, Observation, Organization, Patient, PlanDefinition, Practitioner,
+     * PractitionerRole, Procedure, Provenance, Questionnaire, QuestionnaireResponse, RelatedPerson,
+     * Schedule, ServiceRequest, Slot, and Specimen.
      *
      * @param {phenoml.lang2Fhir.SearchRequest} request
      * @param {Lang2Fhir.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/lang2Fhir/client/Client.js

@@ -201,7 +201,14 @@ class Lang2Fhir {
         });
     }
     /**
-     * Converts natural language text into FHIR search parameters
+     * Converts natural language text into FHIR search parameters.
+     * Automatically identifies the appropriate FHIR resource type and generates valid search query parameters.
+     *
+     * Supported resource types include: AllergyIntolerance, Appointment, CarePlan, CareTeam, Condition,
+     * Coverage, Device, DiagnosticReport, DocumentReference, Encounter, Goal, Immunization, Location,
+     * Medication, MedicationRequest, Observation, Organization, Patient, PlanDefinition, Practitioner,
+     * PractitionerRole, Procedure, Provenance, Questionnaire, QuestionnaireResponse, RelatedPerson,
+     * Schedule, ServiceRequest, Slot, and Specimen.
      *
      * @param {phenoml.lang2Fhir.SearchRequest} request
      * @param {Lang2Fhir.RequestOptions} requestOptions - Request-specific configuration.

package/dist/cjs/api/resources/lang2Fhir/client/requests/SearchRequest.d.ts

@@ -5,6 +5,16 @@
  *     }
  */
 export interface SearchRequest {
-    /** Natural language text to convert into FHIR search parameters */
+    /**
+     * Natural language text to convert into FHIR search parameters.
+     * The system will automatically identify the appropriate resource type and generate valid search parameters.
+     *
+     * Examples:
+     * - "Appointments between March 2-9, 2025" → Appointment search with date range
+     * - "Patients with diabetes" → Condition search with code parameter
+     * - "Active medication requests for metformin" → MedicationRequest search
+     * - "Lab results for creatinine" → DiagnosticReport search
+     * - "Dr. Smith's schedule" → Practitioner or Schedule search
+     */
     text: string;
 }

package/dist/cjs/api/resources/lang2Fhir/types/SearchResponse.d.ts

@@ -1,6 +1,46 @@
 export interface SearchResponse {
     /** The FHIR resource type identified for the search */
-    resourceType?: string;
-    /** FHIR search parameters in standard format */
+    resourceType?: SearchResponse.ResourceType;
+    /**
+     * FHIR search parameters in standard query string format.
+     * Parameters are formatted according to the FHIR specification with appropriate operators.
+     * Code parameters are resolved to standard terminology codes (SNOMED CT, LOINC, RxNorm, ICD-10-CM).
+     */
     searchParams?: string;
 }
+export declare namespace SearchResponse {
+    /** The FHIR resource type identified for the search */
+    const ResourceType: {
+        readonly AllergyIntolerance: "AllergyIntolerance";
+        readonly Appointment: "Appointment";
+        readonly CarePlan: "CarePlan";
+        readonly CareTeam: "CareTeam";
+        readonly Condition: "Condition";
+        readonly Coverage: "Coverage";
+        readonly Device: "Device";
+        readonly DiagnosticReport: "DiagnosticReport";
+        readonly DocumentReference: "DocumentReference";
+        readonly Encounter: "Encounter";
+        readonly Goal: "Goal";
+        readonly Immunization: "Immunization";
+        readonly Location: "Location";
+        readonly Medication: "Medication";
+        readonly MedicationRequest: "MedicationRequest";
+        readonly Observation: "Observation";
+        readonly Organization: "Organization";
+        readonly Patient: "Patient";
+        readonly PlanDefinition: "PlanDefinition";
+        readonly Practitioner: "Practitioner";
+        readonly PractitionerRole: "PractitionerRole";
+        readonly Procedure: "Procedure";
+        readonly Provenance: "Provenance";
+        readonly Questionnaire: "Questionnaire";
+        readonly QuestionnaireResponse: "QuestionnaireResponse";
+        readonly RelatedPerson: "RelatedPerson";
+        readonly Schedule: "Schedule";
+        readonly ServiceRequest: "ServiceRequest";
+        readonly Slot: "Slot";
+        readonly Specimen: "Specimen";
+    };
+    type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
+}