@oystehr/sdk 4.3.9 → 4.3.11

package/src/resources/classes/fhir-ext.ts

@@ -9,6 +9,7 @@ import {
   Bundle,
   BundleEntry,
   Coding,
+  FhirAsyncBulkOutputResult,
   FhirAsyncJobHandle,
   FhirAsyncJobStatus,
   FhirAsyncWaitOptions,
@@ -266,6 +267,43 @@ export interface OystehrFHIRUpdateClientRequest extends OystehrClientRequest {
   optimisticLockingVersionId?: string;
 }
 
+/**
+ * Optional parameter that can be passed to the FHIR create method. In addition
+ * to the standard request options, it supports FHIR conditional create via the
+ * 'If-None-Exist' header.
+ */
+export interface OystehrFHIRCreateClientRequest extends OystehrClientRequest {
+  /**
+   * Perform a FHIR conditional create using the 'If-None-Exist' header. The value is a
+   * FHIR search query that identifies whether a matching resource already exists:
+   *   - if no resource matches, the resource is created as normal;
+   *   - if exactly one resource matches, no resource is created and the existing one is returned;
+   *   - if more than one resource matches, the request fails with a 412 Precondition Failed error.
+   *
+   * Accepts either a raw search query string (e.g. `'identifier=http://acme.org|1234'`) or an
+   * array of SearchParam objects (e.g. `[{ name: 'identifier', value: 'http://acme.org|1234' }]`).
+   *
+   * @see https://www.hl7.org/fhir/http.html#cond-update for the conditional create specification.
+   */
+  ifNoneExist?: string | SearchParam[];
+}
+
+/**
+ * Serializes an If-None-Exist value into a FHIR search query string. A raw string is
+ * returned unchanged; an array of SearchParam objects is encoded as a query string
+ * (e.g. "identifier=sys|123&active=true").
+ */
+function ifNoneExistToString(value: string | SearchParam[]): string {
+  if (typeof value === 'string') {
+    return value;
+  }
+  const search = new URLSearchParams();
+  for (const param of value) {
+    search.append(param.name, String(param.value));
+  }
+  return search.toString();
+}
+
 function isAsyncRequestMode(mode: FhirResponseMode | undefined): mode is Exclude<FhirResponseMode, 'sync'> {
   return mode === 'async-bundle' || mode === 'async-bulk';
 }
@@ -329,37 +367,93 @@ export async function search<T extends FhirResource>(
   return bundle;
 }
 
+/**
+ * Performs an iterative FHIR search over initial request and following "next" urls,
+ * collecting all pages into a single Bundle.
+ *
+ * @param params FHIR search parameters plus optional pageSize that will overwrite _count in params
+ * @param request optional OystehrClientRequest object
+ * @returns FHIR Bundle resource that contains all entries across all pages. Bundle-level metadata
+ * (id, meta, total, etc.) is taken from the first page.
+ */
+export async function searchAndGetAllPages<T extends FhirResource>(
+  this: SDKResource,
+  params: FhirSearchParams<T> & { pageSize?: number },
+  request?: OystehrClientRequest & { mode?: 'sync' | undefined }
+): Promise<Bundle<T>> {
+  const { pageSize, ...searchParams } = params;
+
+  let firstPageParams: FhirSearchParams<T> = searchParams;
+  if (pageSize) {
+    const baseParams = (searchParams.params ?? []).filter((p) => p.name !== '_count') ?? [];
+    firstPageParams = { ...searchParams, params: [...baseParams, { name: '_count', value: pageSize }] };
+  }
+
+  const allEntries: Array<BundleEntry<T>> = [];
+
+  const typedSearch = search<T>;
+  // search returns Bundle, and fhirRequest in the while block returns FhirBundle
+  let currentBundle: Bundle<T> | FhirBundle<T> = await typedSearch.call(this, firstPageParams, request);
+  const firstBundle = { ...currentBundle, link: currentBundle.link?.filter((link) => link.relation !== 'next') };
+
+  // eslint-disable-next-line no-constant-condition
+  while (true) {
+    const entries = currentBundle.entry as Array<BundleEntry<T>> | undefined;
+    if (entries) {
+      allEntries.push(...entries);
+    }
+
+    const nextLink: string | undefined = currentBundle.link?.find((link) => link.relation === 'next')?.url;
+    if (!nextLink) {
+      break;
+    }
+    currentBundle = await this.fhirRequest<FhirBundle<T>>(nextLink, 'GET')({}, request);
+  }
+
+  return {
+    ...firstBundle,
+    entry: allEntries.length ? allEntries : undefined,
+    unbundle: function (this: { entry?: Array<BundleEntry<T>> }) {
+      return this.entry?.map((e) => e.resource).filter((r): r is T => r !== undefined) ?? [];
+    },
+  };
+}
+
 export async function create<T extends FhirResource>(
   this: SDKResource,
   params: FhirCreateParams<T>,
-  request: OystehrClientRequest & { mode: Exclude<FhirResponseMode, 'sync'> }
+  request: OystehrFHIRCreateClientRequest & { mode: Exclude<FhirResponseMode, 'sync'> }
 ): Promise<FhirAsyncJobHandle>;
 export async function create<T extends FhirResource>(
   this: SDKResource,
   params: FhirCreateParams<T>,
-  request?: OystehrClientRequest & { mode?: 'sync' | undefined }
+  request?: OystehrFHIRCreateClientRequest & { mode?: 'sync' | undefined }
 ): Promise<FhirFetcherResponse<FhirResourceReturnValue<T>>>;
 export async function create<T extends FhirResource>(
   this: SDKResource,
   params: FhirCreateParams<T>,
-  request?: OystehrClientRequest
+  request?: OystehrFHIRCreateClientRequest
 ): Promise<FhirFetcherResponse<FhirResourceReturnValue<T>> | FhirAsyncJobHandle> {
   const tagged = applyTagToResource(this.config, params);
   const { resourceType } = tagged;
   const requestMode = request?.mode;
+  const ifNoneExistRequest = {
+    ...request,
+    ifNoneExist: request?.ifNoneExist !== undefined ? ifNoneExistToString(request.ifNoneExist) : undefined,
+  };
   if (isAsyncRequestMode(requestMode)) {
     return await this.startAsyncJob(
       `/${resourceType}`,
       'POST',
       tagged as unknown as Record<string, unknown>,
       requestMode,
-      request
+      ifNoneExistRequest
     );
   }
 
   return await this.fhirRequest<FhirResourceReturnValue<T>>(`/${resourceType}`, 'POST')(
     tagged as unknown as Record<string, unknown>,
-    request
+    ifNoneExistRequest
   );
 }
 
@@ -510,6 +604,13 @@ function getRetryDelayMs(retryAfter: string | undefined, fallbackMs: number): nu
   return fallbackMs;
 }
 
+/**
+ *  Fetches the status of an async job. If the job is still in progress, returns an object with status 202. If the job is completed, returns the job result with status 200. If the job has failed, returns an object with status 500 and an OperationOutcome resource describing the failure. If the job has expired, returns an object with status 410.
+ * @param this The SDKResource context (this is an extension method and should be called with the SDKResource instance as the context, e.g. `sdkResource.getAsyncJob(jobId)`)
+ * @param jobId The ID of the async job to fetch
+ * @param request  Optional OystehrClientRequest for authentication and headers
+ * @returns  A Promise that resolves to the FhirAsyncJobStatus
+ */
 export async function getAsyncJob<T extends FhirResource>(
   this: SDKResource,
   jobId: string,
@@ -518,6 +619,14 @@ export async function getAsyncJob<T extends FhirResource>(
   return await this.fetchAsyncJobStatus<T>(jobId, request);
 }
 
+/**
+ *  Waits for an async job to complete by polling its status until it reaches a terminal state (success, failure, or expiration) or the specified timeout is reached. Returns the final job status. Throws if the job fails, expires, or does not complete within the timeout.
+ * @param this  The SDKResource context (this is an extension method and should be called with the SDKResource instance as the context, e.g. `sdkResource.waitForAsyncJob(jobId)`)
+ * @param jobId  The ID of the async job to wait for
+ * @param options  Optional FhirAsyncWaitOptions to configure polling behavior
+ * @param request  Optional OystehrClientRequest for authentication and headers
+ * @returns  A Promise that resolves to the final FhirAsyncJobStatus
+ */
 export async function waitForAsyncJob<T extends FhirResource>(
   this: SDKResource,
   jobId: string,
@@ -548,6 +657,143 @@ export async function waitForAsyncJob<T extends FhirResource>(
   });
 }
 
+function parseNdjsonResources<T extends FhirResource>(ndjson: string, sourceUrl: string): T[] {
+  const resources: T[] = [];
+  const lines = ndjson.split('\n');
+  for (let index = 0; index < lines.length; index++) {
+    const line = lines[index].trim();
+    if (line.length === 0) {
+      continue;
+    }
+    try {
+      resources.push(JSON.parse(line) as T);
+    } catch (error) {
+      throw new OystehrSdkError({
+        message: `Failed to parse NDJSON line ${index + 1} from ${sourceUrl}`,
+        code: 500,
+        cause: error,
+      });
+    }
+  }
+  return resources;
+}
+
+/**
+ *  Waits for an async job to complete and retrieves the bulk output manifest and files. Throws if the job fails, expires, or does not complete within the specified timeout.
+ * @param this  The SDKResource context (this is an extension method and should be called with the SDKResource instance as the context, e.g. `sdkResource.waitForAsyncBulkOutput(jobId)`)
+ * @param jobId  The ID of the async job to wait for
+ * @param options  Optional FhirAsyncWaitOptions to configure polling behavior
+ * @param request  Optional OystehrClientRequest for authentication and headers
+ * @returns  A Promise that resolves to a FhirAsyncBulkOutputResult containing the bulk output manifest and files
+ */
+export async function waitForAsyncBulkOutput<T extends FhirResource>(
+  this: SDKResource,
+  jobId: string,
+  options?: FhirAsyncWaitOptions,
+  request?: OystehrClientRequest
+): Promise<FhirAsyncBulkOutputResult<T>> {
+  const status = await waitForAsyncJob.call(this, jobId, options, request);
+
+  if (status.status === 404) {
+    throw new OystehrSdkError({
+      message: `Async job ${jobId} not found`,
+      code: 404,
+    });
+  }
+
+  if (status.status === 410) {
+    throw new OystehrSdkError({
+      message: `Async job ${jobId} expired`,
+      code: 410,
+    });
+  }
+
+  if (status.status !== 200 || !('mode' in status) || status.mode !== 'bulk') {
+    throw new OystehrSdkError({
+      message: `Async job ${jobId} did not complete in bulk mode`,
+      code: status.status,
+    });
+  }
+
+  const accessToken = request?.accessToken ?? this.config.accessToken;
+  const projectId = request?.projectId ?? this.config.projectId;
+  if (status.manifest.requiresAccessToken && !accessToken) {
+    throw new OystehrSdkError({
+      message: `Bulk output for async job ${jobId} requires an access token`,
+      code: 401,
+    });
+  }
+
+  const fetchImpl = this.config.fetch ?? fetch;
+  const headers: Record<string, string> = {};
+  if (projectId) {
+    headers['x-zapehr-project-id'] = projectId;
+    headers['x-oystehr-project-id'] = projectId;
+  }
+  if (status.manifest.requiresAccessToken && accessToken) {
+    headers.Authorization = `Bearer ${accessToken}`;
+  }
+  const requestHeaders = Object.keys(headers).length > 0 ? headers : undefined;
+
+  const output = await Promise.all(
+    status.manifest.output.map(async (file) => {
+      const response = await fetchImpl(
+        new Request(file.url, {
+          method: 'GET',
+          headers: requestHeaders,
+        })
+      );
+
+      if (!response.ok) {
+        throw new OystehrSdkError({
+          message: `Failed to download bulk output (${file.type}): HTTP ${response.status}`,
+          code: response.status,
+        });
+      }
+
+      const ndjson = await response.text();
+      return {
+        ...file,
+        resources: parseNdjsonResources<T>(ndjson, file.url),
+      };
+    })
+  );
+
+  return {
+    manifest: status.manifest,
+    output,
+  };
+}
+
+/**
+ * Wrapper around waitForAsyncBulkOutput that transforms the retrieved bulk output files into a single Bundle resource containing all the output resources as entries. This is a convenience method for use cases where you want to work with the bulk output as a Bundle, but it may not be efficient for large outputs due to the overhead of downloading and parsing all files and constructing the Bundle in memory.
+ * Can be slow due to downloading and parsing potentially large NDJSON files, so use only if you need the full output as a Bundle resource. For more efficient processing of large bulk outputs, use waitForAsyncBulkOutput directly.
+ * @param jobId the ID of the async job to wait for
+ * @param options optional FhirAsyncWaitOptions to configure polling behavior
+ * @param request optional OystehrClientRequest for authentication and headers
+ * @returns a Promise that resolves to a Bundle containing all resources from the bulk output
+ */
+export async function waitForAsyncBulkBundle<T extends FhirResource>(
+  this: SDKResource,
+  jobId: string,
+  options?: FhirAsyncWaitOptions,
+  request?: OystehrClientRequest
+): Promise<Bundle<T>> {
+  const bulkOutput = await waitForAsyncBulkOutput.call(this, jobId, options, request);
+  const resources = bulkOutput.output.flatMap((file) => file.resources);
+
+  const bundle = {
+    resourceType: 'Bundle',
+    type: 'collection',
+    entry: resources.map((resource) => ({ resource } as BundleEntry<T>)),
+    unbundle: function (this: { entry?: Array<BundleEntry<T>> | undefined }) {
+      return this.entry?.map((entry) => entry.resource).filter((value): value is T => value !== undefined) ?? [];
+    },
+  } as unknown as Bundle<T>;
+
+  return bundle;
+}
+
 export async function cancelAsyncJob(this: SDKResource, jobId: string, request?: OystehrClientRequest): Promise<void> {
   await this.fhirRequest(`/async-job/${jobId}`, 'DELETE')({}, request);
 }
@@ -741,9 +987,13 @@ function batchInputRequestToBundleEntryItem<T extends FhirResource>(
   // POST creates require a full resource
   if (method === 'POST' && 'resource' in request) {
     const resource = applyTagToResource(config, request.resource);
-    const { fullUrl } = request;
+    const { fullUrl, ifNoneExist } = request;
     return {
-      ...baseRequest,
+      request: {
+        ...baseRequest.request,
+        // Conditional create: only create the resource if no existing resource matches the query.
+        ifNoneExist: ifNoneExist !== undefined ? ifNoneExistToString(ifNoneExist) : undefined,
+      },
       resource: resource as T,
       fullUrl,
     } as BundleEntry<T>;

package/src/resources/classes/fhir.ts

@@ -18,14 +18,25 @@ export class Fhir extends SDKResource {
    * @returns FHIR Bundle resource
    */
   search = ext.search;
+  /**
+   * Performs an iterative FHIR search over initial request and following "next" urls,
+   * collecting all pages into a single Bundle.
+   * @param params FHIR search parameters plus optional pageSize that will overwrite _count in params
+   * @param request optional OystehrClientRequest object
+   * @returns FHIR Bundle resource that contains all entries across all pages. Bundle-level metadata
+   * (id, meta, total, etc.) is taken from the first page.
+   */
+  searchAndGetAllPages = ext.searchAndGetAllPages;
   create = ext.create;
   get = ext.get;
-  getAsyncJob = ext.getAsyncJob;
-  waitForAsyncJob = ext.waitForAsyncJob;
-  cancelAsyncJob = ext.cancelAsyncJob;
   update = ext.update;
   patch = ext.patch;
   delete = ext.delete;
+  getAsyncJob = ext.getAsyncJob;
+  waitForAsyncJob = ext.waitForAsyncJob;
+  waitForAsyncBulkOutput = ext.waitForAsyncBulkOutput;
+  waitForAsyncBulkBundle = ext.waitForAsyncBulkBundle;
+  cancelAsyncJob = ext.cancelAsyncJob;
   history = ext.history;
   batch = ext.batch;
   transaction = ext.transaction;

package/src/resources/types/FaxSendParams.ts

@@ -2,7 +2,7 @@
 
 export interface FaxSendParams {
   /**
-   * A Z3 URL of the document you want to send. Your user must have access to this document.
+   * A Z3 URL of the PDF document you want to send. Your user must have access to this document.
    */
   media: string;
   /**

package/src/resources/types/ZambdaCreateParams.ts

@@ -15,7 +15,7 @@ export interface ZambdaCreateParams {
   /**
    * The runtime to use for the Zambda Function.
    */
-  runtime: 'nodejs20.x' | 'nodejs22.x' | 'nodejs24.x' | 'python3.13' | 'python3.12' | 'java21' | 'dotnet8' | 'ruby3.3';
+  runtime: 'nodejs22.x' | 'nodejs24.x' | 'python3.13' | 'python3.12' | 'java21' | 'dotnet8' | 'ruby3.3';
   /**
    * The amount of memory in MB to allocate to the Zambda Function. If not specified, a system default (1024MB) will be used. Min: 128MB, Max: 10240MB.
    */

package/src/resources/types/ZambdaUpdateParams.ts

@@ -15,7 +15,7 @@ export interface ZambdaUpdateParams {
   /**
    * The runtime to use for the Zambda Function.
    */
-  runtime?: 'nodejs20.x' | 'nodejs22.x' | 'nodejs24.x' | 'python3.13' | 'python3.12' | 'java21' | 'dotnet8' | 'ruby3.3';
+  runtime?: 'nodejs22.x' | 'nodejs24.x' | 'python3.13' | 'python3.12' | 'java21' | 'dotnet8' | 'ruby3.3';
   /**
    * The amount of memory in MB to allocate to the Zambda Function. If not specified, a system default (1024MB) will be used. Min: 128MB, Max: 10240MB.
    */

package/src/resources/types/fhir.ts

@@ -127,6 +127,19 @@ export interface BatchInputPostRequest<F extends FhirResource> extends BatchInpu
   method: 'POST';
   resource: F;
   fullUrl?: string;
+  /**
+   * Perform a FHIR conditional create for this entry using the bundle entry's `ifNoneExist`
+   * field. The value is a FHIR search query that identifies whether a matching resource already
+   * exists: if no resource matches, the resource is created; if exactly one matches, no resource
+   * is created and the existing one is returned; if more than one matches, the entry fails with a
+   * 412 Precondition Failed error.
+   *
+   * Accepts either a raw search query string (e.g. `'identifier=http://acme.org|1234'`) or an
+   * array of SearchParam objects (e.g. `[{ name: 'identifier', value: 'http://acme.org|1234' }]`).
+   *
+   * @see https://www.hl7.org/fhir/http.html#cond-update
+   */
+  ifNoneExist?: string | SearchParam[];
 }
 
 /**
@@ -227,6 +240,15 @@ export interface FhirAsyncJobCompletedBulk {
   manifest: FhirAsyncBulkManifest;
 }
 
+export interface FhirAsyncBulkOutputFileResult<T extends FhirResource = FhirResource> extends FhirAsyncBulkOutputFile {
+  resources: T[];
+}
+
+export interface FhirAsyncBulkOutputResult<T extends FhirResource = FhirResource> {
+  manifest: FhirAsyncBulkManifest;
+  output: FhirAsyncBulkOutputFileResult<T>[];
+}
+
 export interface FhirAsyncJobExpired {
   status: 410;
 }