phenoml 16.0.0 → 17.0.0

package/dist/esm/api/resources/fhir/client/Client.d.mts

@@ -1,7 +1,7 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
 import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
 import * as core from "../../../../core/index.mjs";
-import * as phenoml from "../../../index.mjs";
+import type * as phenoml from "../../../index.mjs";
 export declare namespace FhirClient {
     type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
@@ -11,7 +11,19 @@ export declare class FhirClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<FhirClient.Options>;
     constructor(options?: FhirClient.Options);
     /**
-     * Retrieves FHIR resources from the specified provider. Supports both individual resource retrieval and search operations based on the FHIR path and query parameters.
+     * Retrieves FHIR resources from the specified provider. Supports both individual resource retrieval (e.g. `Patient/123` via the path) and search operations.
+     *
+     * FHIR search parameters are passed through to the upstream server verbatim as native query-string parameters; this proxy does not model, validate, or transform them. Append standard FHIR search parameters directly to the request URL. Supported parameters include:
+     * - Resource-specific search parameters (e.g. `name` for Patient, `status` for Observation)
+     * - Common search parameters (`_id`, `_lastUpdated`, `_tag`, `_profile`, `_security`, `_text`, `_content`, `_filter`)
+     * - Result parameters (`_count`, `_offset`, `_sort`, `_include`, `_revinclude`, `_summary`, `_elements`)
+     * - Search prefixes for dates, numbers, and quantities (`eq`, `ne`, `gt`, `ge`, `lt`, `le`, `sa`, `eb`, `ap`)
+     *
+     * Examples:
+     * - `Patient?name=John%20Doe&_count=10&_sort=family`
+     * - `Observation?patient=Patient/123&date=ge2023-01-01&category=vital-signs&_sort=-date`
+     *
+     * When using a generated SDK, supply these via the client's request-level query-parameter option (the SDK escape hatch) rather than a typed argument.
      *
      * The request is proxied to the configured FHIR server with appropriate authentication headers.
      *
@@ -26,21 +38,13 @@ export declare class FhirClient {
      * @param {phenoml.fhir.SearchRequest} request
      * @param {FhirClient.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link phenoml.fhir.BadRequestError}
-     * @throws {@link phenoml.fhir.UnauthorizedError}
-     * @throws {@link phenoml.fhir.NotFoundError}
-     * @throws {@link phenoml.fhir.TooManyRequestsError}
-     * @throws {@link phenoml.fhir.InternalServerError}
-     * @throws {@link phenoml.fhir.BadGatewayError}
-     * @throws {@link phenoml.fhir.ServiceUnavailableError}
-     *
      * @example
      *     await client.fhir.search("550e8400-e29b-41d4-a716-446655440000", "Patient", {
      *         "X-Phenoml-On-Behalf-Of": "Patient/550e8400-e29b-41d4-a716-446655440000",
      *         "X-Phenoml-Fhir-Provider": "550e8400-e29b-41d4-a716-446655440000:eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c..."
      *     })
      */
-    search(fhir_provider_id: string, fhir_path: string, request?: phenoml.fhir.SearchRequest, requestOptions?: FhirClient.RequestOptions): core.HttpResponsePromise<phenoml.fhir.SearchResponse>;
+    search(fhir_provider_id: string, fhir_path: string, request?: phenoml.fhir.SearchRequest, requestOptions?: FhirClient.RequestOptions): core.HttpResponsePromise<unknown>;
     private __search;
     /**
      * Creates a new FHIR resource on the specified provider. The request body should contain a valid FHIR resource in JSON format.
@@ -58,23 +62,16 @@ export declare class FhirClient {
      * @param {phenoml.fhir.CreateRequest} request
      * @param {FhirClient.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link phenoml.fhir.BadRequestError}
-     * @throws {@link phenoml.fhir.UnauthorizedError}
-     * @throws {@link phenoml.fhir.TooManyRequestsError}
-     * @throws {@link phenoml.fhir.InternalServerError}
-     * @throws {@link phenoml.fhir.BadGatewayError}
-     * @throws {@link phenoml.fhir.ServiceUnavailableError}
-     *
      * @example
      *     await client.fhir.create("550e8400-e29b-41d4-a716-446655440000", "Patient", {
      *         "X-Phenoml-On-Behalf-Of": "Patient/550e8400-e29b-41d4-a716-446655440000",
      *         "X-Phenoml-Fhir-Provider": "550e8400-e29b-41d4-a716-446655440000:eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c...",
      *         body: {
-     *             resourceType: "Patient"
+     *             "resourceType": "Patient"
      *         }
      *     })
      */
-    create(fhir_provider_id: string, fhir_path: string, request: phenoml.fhir.CreateRequest, requestOptions?: FhirClient.RequestOptions): core.HttpResponsePromise<phenoml.fhir.FhirResource>;
+    create(fhir_provider_id: string, fhir_path: string, request: phenoml.fhir.CreateRequest, requestOptions?: FhirClient.RequestOptions): core.HttpResponsePromise<unknown>;
     private __create;
     /**
      * Creates or updates a FHIR resource on the specified provider. If the resource exists, it will be updated; otherwise, it will be created.
@@ -92,24 +89,17 @@ export declare class FhirClient {
      * @param {phenoml.fhir.UpsertRequest} request
      * @param {FhirClient.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link phenoml.fhir.BadRequestError}
-     * @throws {@link phenoml.fhir.UnauthorizedError}
-     * @throws {@link phenoml.fhir.TooManyRequestsError}
-     * @throws {@link phenoml.fhir.InternalServerError}
-     * @throws {@link phenoml.fhir.BadGatewayError}
-     * @throws {@link phenoml.fhir.ServiceUnavailableError}
-     *
      * @example
      *     await client.fhir.upsert("550e8400-e29b-41d4-a716-446655440000", "Patient", {
      *         "X-Phenoml-On-Behalf-Of": "Patient/550e8400-e29b-41d4-a716-446655440000",
      *         "X-Phenoml-Fhir-Provider": "550e8400-e29b-41d4-a716-446655440000:eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c...",
      *         body: {
-     *             resourceType: "Patient",
-     *             id: "123"
+     *             "resourceType": "Patient",
+     *             "id": "123"
      *         }
      *     })
      */
-    upsert(fhir_provider_id: string, fhir_path: string, request: phenoml.fhir.UpsertRequest, requestOptions?: FhirClient.RequestOptions): core.HttpResponsePromise<phenoml.fhir.FhirResource>;
+    upsert(fhir_provider_id: string, fhir_path: string, request: phenoml.fhir.UpsertRequest, requestOptions?: FhirClient.RequestOptions): core.HttpResponsePromise<unknown>;
     private __upsert;
     /**
      * Deletes a FHIR resource from the specified provider.
@@ -127,29 +117,25 @@ export declare class FhirClient {
      * @param {phenoml.fhir.DeleteRequest} request
      * @param {FhirClient.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link phenoml.fhir.BadRequestError}
-     * @throws {@link phenoml.fhir.UnauthorizedError}
-     * @throws {@link phenoml.fhir.NotFoundError}
-     * @throws {@link phenoml.fhir.TooManyRequestsError}
-     * @throws {@link phenoml.fhir.InternalServerError}
-     * @throws {@link phenoml.fhir.BadGatewayError}
-     * @throws {@link phenoml.fhir.ServiceUnavailableError}
-     *
      * @example
      *     await client.fhir.delete("550e8400-e29b-41d4-a716-446655440000", "Patient", {
      *         "X-Phenoml-On-Behalf-Of": "Patient/550e8400-e29b-41d4-a716-446655440000",
      *         "X-Phenoml-Fhir-Provider": "550e8400-e29b-41d4-a716-446655440000:eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c..."
      *     })
      */
-    delete(fhir_provider_id: string, fhir_path: string, request?: phenoml.fhir.DeleteRequest, requestOptions?: FhirClient.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
+    delete(fhir_provider_id: string, fhir_path: string, request?: phenoml.fhir.DeleteRequest, requestOptions?: FhirClient.RequestOptions): core.HttpResponsePromise<unknown>;
     private __delete;
     /**
-     * Partially updates a FHIR resource on the specified provider using JSON Patch operations as defined in RFC 6902.
+     * Partially updates a FHIR resource on the specified provider.
+     *
+     * Two body formats are supported, selected by request content type:
+     * - `application/json-patch+json` — an array of JSON Patch operations as defined in RFC 6902. Each operation specifies:
+     *   - `op`: The operation type (add, remove, replace, move, copy, test)
+     *   - `path`: JSON Pointer to the target location in the resource
+     *   - `value`: The value to use (required for add, replace, and test operations)
+     * - `application/fhir+json` — a partial FHIR resource for merge-patch semantics.
      *
-     * The request body should contain an array of JSON Patch operations. Each operation specifies:
-     * - `op`: The operation type (add, remove, replace, move, copy, test)
-     * - `path`: JSON Pointer to the target location in the resource
-     * - `value`: The value to use (required for add, replace, and test operations)
+     * **Note:** This proxy currently forwards the request body to the upstream FHIR server with `Content-Type: application/fhir+json` regardless of the declared request content type. JSON Patch (RFC 6902) therefore only succeeds against upstream servers that accept patch arrays under `application/fhir+json`; servers that strictly enforce patch media types may reject or misinterpret it. Support for either format ultimately depends on the upstream FHIR server.
      *
      * The request is proxied to the configured FHIR server with appropriate authentication headers.
      *
@@ -164,14 +150,6 @@ export declare class FhirClient {
      * @param {phenoml.fhir.PatchRequest} request
      * @param {FhirClient.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link phenoml.fhir.BadRequestError}
-     * @throws {@link phenoml.fhir.UnauthorizedError}
-     * @throws {@link phenoml.fhir.NotFoundError}
-     * @throws {@link phenoml.fhir.TooManyRequestsError}
-     * @throws {@link phenoml.fhir.InternalServerError}
-     * @throws {@link phenoml.fhir.BadGatewayError}
-     * @throws {@link phenoml.fhir.ServiceUnavailableError}
-     *
      * @example
      *     await client.fhir.patch("550e8400-e29b-41d4-a716-446655440000", "Patient", {
      *         "X-Phenoml-On-Behalf-Of": "Patient/550e8400-e29b-41d4-a716-446655440000",
@@ -234,7 +212,7 @@ export declare class FhirClient {
      *             }]
      *     })
      */
-    patch(fhir_provider_id: string, fhir_path: string, request: phenoml.fhir.PatchRequest, requestOptions?: FhirClient.RequestOptions): core.HttpResponsePromise<phenoml.fhir.FhirResource>;
+    patch(fhir_provider_id: string, fhir_path: string, request: phenoml.fhir.PatchRequest, requestOptions?: FhirClient.RequestOptions): core.HttpResponsePromise<unknown>;
     private __patch;
     /**
      * Executes a FHIR Bundle transaction or batch operation on the specified provider. This allows multiple FHIR resources to be processed in a single request.
@@ -249,21 +227,20 @@ export declare class FhirClient {
      * @param {phenoml.fhir.ExecuteBundleRequest} request
      * @param {FhirClient.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link phenoml.fhir.BadRequestError}
-     * @throws {@link phenoml.fhir.UnauthorizedError}
-     * @throws {@link phenoml.fhir.TooManyRequestsError}
-     * @throws {@link phenoml.fhir.InternalServerError}
-     * @throws {@link phenoml.fhir.BadGatewayError}
-     * @throws {@link phenoml.fhir.ServiceUnavailableError}
-     *
      * @example
      *     await client.fhir.executeBundle("550e8400-e29b-41d4-a716-446655440000", {
      *         "X-Phenoml-On-Behalf-Of": "Patient/550e8400-e29b-41d4-a716-446655440000",
      *         "X-Phenoml-Fhir-Provider": "550e8400-e29b-41d4-a716-446655440000:eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c...",
      *         body: {
-     *             resourceType: "Bundle",
-     *             entry: [{
-     *                     resource: {
+     *             "resourceType": "Bundle",
+     *             "type": "transaction",
+     *             "entry": [
+     *                 {
+     *                     "request": {
+     *                         "method": "POST",
+     *                         "url": "Patient"
+     *                     },
+     *                     "resource": {
      *                         "resourceType": "Patient",
      *                         "name": [
      *                             {
@@ -273,27 +250,25 @@ export declare class FhirClient {
      *                                 ]
      *                             }
      *                         ]
-     *                     },
-     *                     request: {
-     *                         method: "POST",
-     *                         url: "Patient"
      *                     }
-     *                 }, {
-     *                     resource: {
+     *                 },
+     *                 {
+     *                     "request": {
+     *                         "method": "POST",
+     *                         "url": "Observation"
+     *                     },
+     *                     "resource": {
      *                         "resourceType": "Observation",
      *                         "status": "final",
      *                         "subject": {
      *                             "reference": "Patient/123"
      *                         }
-     *                     },
-     *                     request: {
-     *                         method: "POST",
-     *                         url: "Observation"
      *                     }
-     *                 }]
+     *                 }
+     *             ]
      *         }
      *     })
      */
-    executeBundle(fhir_provider_id: string, request: phenoml.fhir.ExecuteBundleRequest, requestOptions?: FhirClient.RequestOptions): core.HttpResponsePromise<phenoml.fhir.FhirBundle>;
+    executeBundle(fhir_provider_id: string, request: phenoml.fhir.ExecuteBundleRequest, requestOptions?: FhirClient.RequestOptions): core.HttpResponsePromise<unknown>;
     private __executeBundle;
 }