phenoml 0.0.2 → 0.0.4

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

@@ -0,0 +1,293 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as phenoml from "../../../index.mjs";
+export declare namespace Fhir {
+    interface Options {
+        environment?: core.Supplier<environments.phenomlEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+export declare class Fhir {
+    protected readonly _options: Fhir.Options;
+    constructor(_options?: Fhir.Options);
+    /**
+     * Retrieves FHIR resources from the specified provider. Supports both individual resource retrieval and search operations based on the FHIR path and query parameters.
+     *
+     * The request is proxied to the configured FHIR server with appropriate authentication headers.
+     *
+     * @param {string} fhirProviderId - The ID of the FHIR provider to use. Can be either:
+     *                                  - A UUID representing the provider ID
+     *                                  - A provider name (legacy support - will just use the most recently updated provider with this name)
+     * @param {string} fhirPath - The FHIR resource path to operate on. This follows FHIR RESTful API conventions.
+     *                            Examples:
+     *                            - "Patient" (for resource type operations)
+     *                            - "Patient/123" (for specific resource operations)
+     *                            - "Patient/123/_history" (for history operations)
+     * @param {phenoml.fhir.FhirSearchRequest} request
+     * @param {Fhir.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link phenoml.fhir.BadRequestError}
+     * @throws {@link phenoml.fhir.UnauthorizedError}
+     * @throws {@link phenoml.fhir.NotFoundError}
+     * @throws {@link phenoml.fhir.InternalServerError}
+     *
+     * @example
+     *     await client.fhir.search("550e8400-e29b-41d4-a716-446655440000", "Patient", {
+     *         "X-Phenoml-On-Behalf-Of": "user@example.com"
+     *     })
+     */
+    search(fhirProviderId: string, fhirPath: string, request?: phenoml.fhir.FhirSearchRequest, requestOptions?: Fhir.RequestOptions): core.HttpResponsePromise<phenoml.fhir.FhirSearchResponse>;
+    private __search;
+    /**
+     * Creates a new FHIR resource on the specified provider. The request body should contain a valid FHIR resource in JSON format.
+     *
+     * The request is proxied to the configured FHIR server with appropriate authentication headers.
+     *
+     * @param {string} fhirProviderId - The ID of the FHIR provider to use. Can be either:
+     *                                  - A UUID representing the provider ID
+     *                                  - A provider name (legacy support - will just use the most recently updated provider with this name)
+     * @param {string} fhirPath - The FHIR resource path to operate on. This follows FHIR RESTful API conventions.
+     *                            Examples:
+     *                            - "Patient" (for resource type operations)
+     *                            - "Patient/123" (for specific resource operations)
+     *                            - "Patient/123/_history" (for history operations)
+     * @param {phenoml.fhir.FhirCreateRequest} request
+     * @param {Fhir.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link phenoml.fhir.BadRequestError}
+     * @throws {@link phenoml.fhir.UnauthorizedError}
+     * @throws {@link phenoml.fhir.InternalServerError}
+     *
+     * @example
+     *     await client.fhir.create("550e8400-e29b-41d4-a716-446655440000", "Patient", {
+     *         "X-Phenoml-On-Behalf-Of": "user@example.com",
+     *         body: {
+     *             resourceType: "Patient"
+     *         }
+     *     })
+     */
+    create(fhirProviderId: string, fhirPath: string, request: phenoml.fhir.FhirCreateRequest, requestOptions?: Fhir.RequestOptions): core.HttpResponsePromise<phenoml.fhir.FhirResource>;
+    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.
+     *
+     * The request is proxied to the configured FHIR server with appropriate authentication headers.
+     *
+     * @param {string} fhirProviderId - The ID of the FHIR provider to use. Can be either:
+     *                                  - A UUID representing the provider ID
+     *                                  - A provider name (legacy support - will just use the most recently updated provider with this name)
+     * @param {string} fhirPath - The FHIR resource path to operate on. This follows FHIR RESTful API conventions.
+     *                            Examples:
+     *                            - "Patient" (for resource type operations)
+     *                            - "Patient/123" (for specific resource operations)
+     *                            - "Patient/123/_history" (for history operations)
+     * @param {phenoml.fhir.FhirUpsertRequest} request
+     * @param {Fhir.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link phenoml.fhir.BadRequestError}
+     * @throws {@link phenoml.fhir.UnauthorizedError}
+     * @throws {@link phenoml.fhir.InternalServerError}
+     *
+     * @example
+     *     await client.fhir.upsert("550e8400-e29b-41d4-a716-446655440000", "Patient", {
+     *         "X-Phenoml-On-Behalf-Of": "user@example.com",
+     *         body: {
+     *             resourceType: "Patient",
+     *             id: "123"
+     *         }
+     *     })
+     */
+    upsert(fhirProviderId: string, fhirPath: string, request: phenoml.fhir.FhirUpsertRequest, requestOptions?: Fhir.RequestOptions): core.HttpResponsePromise<phenoml.fhir.FhirResource>;
+    private __upsert;
+    /**
+     * Deletes a FHIR resource from the specified provider.
+     *
+     * The request is proxied to the configured FHIR server with appropriate authentication headers.
+     *
+     * @param {string} fhirProviderId - The ID of the FHIR provider to use. Can be either:
+     *                                  - A UUID representing the provider ID
+     *                                  - A provider name (legacy support - will just use the most recently updated provider with this name)
+     * @param {string} fhirPath - The FHIR resource path to operate on. This follows FHIR RESTful API conventions.
+     *                            Examples:
+     *                            - "Patient" (for resource type operations)
+     *                            - "Patient/123" (for specific resource operations)
+     *                            - "Patient/123/_history" (for history operations)
+     * @param {phenoml.fhir.FhirDeleteRequest} request
+     * @param {Fhir.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link phenoml.fhir.BadRequestError}
+     * @throws {@link phenoml.fhir.UnauthorizedError}
+     * @throws {@link phenoml.fhir.NotFoundError}
+     * @throws {@link phenoml.fhir.InternalServerError}
+     *
+     * @example
+     *     await client.fhir.delete("550e8400-e29b-41d4-a716-446655440000", "Patient", {
+     *         "X-Phenoml-On-Behalf-Of": "user@example.com"
+     *     })
+     */
+    delete(fhirProviderId: string, fhirPath: string, request?: phenoml.fhir.FhirDeleteRequest, requestOptions?: Fhir.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
+    private __delete;
+    /**
+     * Partially updates a FHIR resource on the specified provider using JSON Patch operations as defined in RFC 6902.
+     *
+     * 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)
+     *
+     * The request is proxied to the configured FHIR server with appropriate authentication headers.
+     *
+     * @param {string} fhirProviderId - The ID of the FHIR provider to use. Can be either:
+     *                                  - A UUID representing the provider ID
+     *                                  - A provider name (legacy support - will just use the most recently updated provider with this name)
+     * @param {string} fhirPath - The FHIR resource path to operate on. This follows FHIR RESTful API conventions.
+     *                            Examples:
+     *                            - "Patient" (for resource type operations)
+     *                            - "Patient/123" (for specific resource operations)
+     *                            - "Patient/123/_history" (for history operations)
+     * @param {phenoml.fhir.FhirPatchRequest} request
+     * @param {Fhir.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link phenoml.fhir.BadRequestError}
+     * @throws {@link phenoml.fhir.UnauthorizedError}
+     * @throws {@link phenoml.fhir.NotFoundError}
+     * @throws {@link phenoml.fhir.InternalServerError}
+     *
+     * @example
+     *     await client.fhir.patch("550e8400-e29b-41d4-a716-446655440000", "Patient", {
+     *         "X-Phenoml-On-Behalf-Of": "user@example.com",
+     *         body: [{
+     *                 op: "replace",
+     *                 path: "/name/0/family",
+     *                 value: "NewFamilyName"
+     *             }]
+     *     })
+     *
+     * @example
+     *     await client.fhir.patch("550e8400-e29b-41d4-a716-446655440000", "Patient", {
+     *         "X-Phenoml-On-Behalf-Of": "user@example.com",
+     *         body: [{
+     *                 op: "add",
+     *                 path: "/telecom/-",
+     *                 value: {
+     *                     "system": "phone",
+     *                     "value": "+1-555-123-4567",
+     *                     "use": "home"
+     *                 }
+     *             }]
+     *     })
+     *
+     * @example
+     *     await client.fhir.patch("550e8400-e29b-41d4-a716-446655440000", "Patient", {
+     *         "X-Phenoml-On-Behalf-Of": "user@example.com",
+     *         body: [{
+     *                 op: "replace",
+     *                 path: "/name/0/family",
+     *                 value: "Smith"
+     *             }, {
+     *                 op: "add",
+     *                 path: "/telecom/-",
+     *                 value: {
+     *                     "system": "email",
+     *                     "value": "john.smith@example.com"
+     *                 }
+     *             }, {
+     *                 op: "remove",
+     *                 path: "/address/0"
+     *             }]
+     *     })
+     *
+     * @example
+     *     await client.fhir.patch("550e8400-e29b-41d4-a716-446655440000", "Patient", {
+     *         "X-Phenoml-On-Behalf-Of": "user@example.com",
+     *         body: [{
+     *                 op: "test",
+     *                 path: "/gender",
+     *                 value: "male"
+     *             }, {
+     *                 op: "replace",
+     *                 path: "/gender",
+     *                 value: "female"
+     *             }]
+     *     })
+     */
+    patch(fhirProviderId: string, fhirPath: string, request: phenoml.fhir.FhirPatchRequest, requestOptions?: Fhir.RequestOptions): core.HttpResponsePromise<phenoml.fhir.FhirResource>;
+    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.
+     *
+     * The request body should contain a valid FHIR Bundle resource with transaction or batch type.
+     *
+     * The request is proxied to the configured FHIR server with appropriate authentication headers.
+     *
+     * @param {string} fhirProviderId - The ID of the FHIR provider to use. Can be either:
+     *                                  - A UUID representing the provider ID
+     *                                  - A provider name (legacy support - will just use the most recently updated provider with this name)
+     * @param {phenoml.fhir.FhirExecuteBundleRequest} request
+     * @param {Fhir.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link phenoml.fhir.BadRequestError}
+     * @throws {@link phenoml.fhir.UnauthorizedError}
+     * @throws {@link phenoml.fhir.InternalServerError}
+     *
+     * @example
+     *     await client.fhir.executeBundle("550e8400-e29b-41d4-a716-446655440000", {
+     *         "X-Phenoml-On-Behalf-Of": "user@example.com",
+     *         body: {
+     *             resourceType: "Bundle",
+     *             entry: [{
+     *                     resource: {
+     *                         "resourceType": "Patient",
+     *                         "name": [
+     *                             {
+     *                                 "family": "Doe",
+     *                                 "given": [
+     *                                     "John"
+     *                                 ]
+     *                             }
+     *                         ]
+     *                     },
+     *                     request: {
+     *                         method: "POST",
+     *                         url: "Patient"
+     *                     }
+     *                 }, {
+     *                     resource: {
+     *                         "resourceType": "Observation",
+     *                         "status": "final",
+     *                         "subject": {
+     *                             "reference": "Patient/123"
+     *                         }
+     *                     },
+     *                     request: {
+     *                         method: "POST",
+     *                         url: "Observation"
+     *                     }
+     *                 }]
+     *         }
+     *     })
+     */
+    executeBundle(fhirProviderId: string, request: phenoml.fhir.FhirExecuteBundleRequest, requestOptions?: Fhir.RequestOptions): core.HttpResponsePromise<phenoml.fhir.FhirBundle>;
+    private __executeBundle;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}