@oystehr/sdk 4.3.10 → 4.3.12

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

@@ -267,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';
 }
@@ -385,34 +422,38 @@ export async function searchAndGetAllPages<T extends FhirResource>(
 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
   );
 }
 
@@ -946,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

@@ -32,9 +32,40 @@ export class Fhir extends SDKResource {
   update = ext.update;
   patch = ext.patch;
   delete = ext.delete;
+  /**
+   * 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
+   */
   getAsyncJob = ext.getAsyncJob;
+  /**
+   * 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
+   */
   waitForAsyncJob = ext.waitForAsyncJob;
+  /**
+   * 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
+   */
   waitForAsyncBulkOutput = ext.waitForAsyncBulkOutput;
+  /**
+   * 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
+   */
   waitForAsyncBulkBundle = ext.waitForAsyncBulkBundle;
   cancelAsyncJob = ext.cancelAsyncJob;
   history = ext.history;

package/src/resources/classes/rcm.ts

@@ -8,6 +8,8 @@ import {
   RcmGetPayerResponse,
   RcmListPayersParams,
   RcmListPayersResponse,
+  RcmProcessEraParams,
+  RcmProcessEraResponse,
   RcmSetClaimStatusParams,
   RcmSetClaimStatusResponse,
   RcmSubmitClaimParams,
@@ -100,4 +102,13 @@ export class Rcm extends SDKResource {
   getPayer(params: RcmGetPayerParams, request?: OystehrClientRequest): Promise<RcmGetPayerResponse> {
     return this.request('/payer/{id}', 'get', this.#baseUrlThunk.bind(this))(params, request);
   }
+  /**
+   * Allows to manually process EDI835.
+   *
+   * Access Policy Action: `RCM:ProcessEra`
+   * Access Policy Resource: `RCM:Era`
+   */
+  processEra(params: RcmProcessEraParams, request?: OystehrClientRequest): Promise<RcmProcessEraResponse> {
+    return this.request('/process-era', 'post', this.#baseUrlThunk.bind(this))(params, request);
+  }
 }

package/src/resources/classes/terminology.ts

@@ -6,6 +6,8 @@ import {
   TerminologySearchCptResponse,
   TerminologySearchHcpcsParams,
   TerminologySearchHcpcsResponse,
+  TerminologySearchIcd10Params,
+  TerminologySearchIcd10Response,
 } from '../..';
 import { SDKResource } from '../../client/client';
 import { OystehrConfig } from '../../config';
@@ -38,4 +40,16 @@ export class Terminology extends SDKResource {
   ): Promise<TerminologySearchHcpcsResponse> {
     return this.request('/hcpcs/search', 'get', this.#baseUrlThunk.bind(this))(params, request);
   }
+  /**
+   * Search ICD-10-CM (International Classification of Diseases, 10th Revision, Clinical Modification) diagnosis codes by code or description. Only billable (leaf-node) codes are returned, including codes expanded with their required seventh character. Supports exact matches, prefix searches, and full-text search with BM25 ranking.
+   *
+   * Access Policy Action: `Terminology:SearchCodes`
+   * Access Policy Resource: `Terminology:Code:*`
+   */
+  searchIcd10(
+    params: TerminologySearchIcd10Params,
+    request?: OystehrClientRequest
+  ): Promise<TerminologySearchIcd10Response> {
+    return this.request('/icd10/search', 'get', this.#baseUrlThunk.bind(this))(params, request);
+  }
 }

package/src/resources/classes/z3.ts

@@ -6,6 +6,8 @@ import {
   Z3CreateBucketResponse,
   Z3DeleteBucketParams,
   Z3DeleteObjectParams,
+  Z3EmptyBucketParams,
+  Z3EmptyBucketResponse,
   Z3GetPresignedUrlParams,
   Z3GetPresignedUrlResponse,
   Z3ListBucketsResponse,
@@ -67,6 +69,15 @@ export class Z3 extends SDKResource {
   deleteBucket(params: Z3DeleteBucketParams, request?: OystehrClientRequest): Promise<void> {
     return this.request('/z3/{bucketName}', 'delete', this.#baseUrlThunk.bind(this))(params, request);
   }
+  /**
+   * Recursively delete all Z3 Objects in the Bucket with the provided name. [Z3](https://docs.oystehr.com/oystehr/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.
+   *
+   * Access Policy Action: `Z3:EmptyBucket`
+   * Access Policy Resource: `Z3:BucketName`
+   */
+  emptyBucket(params: Z3EmptyBucketParams, request?: OystehrClientRequest): Promise<Z3EmptyBucketResponse> {
+    return this.request('/z3/{bucketName}/objects', 'delete', this.#baseUrlThunk.bind(this))(params, request);
+  }
   /**
    * List all Z3 Objects at the provided path in the Bucket with the provided name [Z3](https://docs.oystehr.com/oystehr/services/z3/) is Oystehr's built-in and fully integrated solution for file storage.
    *

package/src/resources/types/ErxGetMedicationHistoryResponse.ts

@@ -38,7 +38,7 @@ export type ErxGetMedicationHistoryResponse = {
   schedule: number | null;
   directions: string | null;
   substitutionsAllowed: boolean;
-  writtenDate: string;
+  writtenDate: string | null;
   effectiveDate: string | null;
   lastFillDate: string | null;
   expirationDate: string | null;

package/src/resources/types/ErxGetPharmacyParams.ts

@@ -0,0 +1,5 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface ErxGetPharmacyParams {
+  pharmacyId: string;
+}

package/src/resources/types/ErxGetPharmacyResponse.ts

@@ -0,0 +1,18 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+/**
+ * Success
+ */
+export interface ErxGetPharmacyResponse {
+  id: number;
+  name: string;
+  address1: string;
+  address2: string | null;
+  city: string;
+  state: string;
+  zipCode: string;
+  phone: string;
+  fax: string | null;
+  specialties: string[];
+  ncpdpId: string;
+}

package/src/resources/types/ErxSearchPharmaciesResponse.ts

@@ -8,12 +8,12 @@ export interface ErxSearchPharmaciesResponse {
     id: number;
     name: string;
     address1: string;
-    address2?: string;
+    address2: string | null;
     city: string;
     state: string;
     zipCode: string;
     phone: string;
-    fax?: string;
+    fax: string | null;
     specialties: string[];
     ncpdpId: string;
   }[];

package/src/resources/types/LabOrderSubmitParams.ts

@@ -14,4 +14,8 @@ export interface LabOrderSubmitParams {
    * A client-provided string used to identify all tests in an order. See [Submit Lab](https://docs.oystehr.com/oystehr/services/lab/submit-an-order/#client-provided-order-number/) for more details.
    */
   orderNumber?: string;
+  /**
+   * Flag to indicate which patient ID to transmit on the lab order. Defaults to false, instead using the Patient resource's UUID. If set to true but no friendly ID is found, throws a 400 error. See [Friendly Patient ID](https://docs.oystehr.com/oystehr/services/fhir/friendly-patient-id/) for more information on the friendly ID. See [Submit Lab](https://docs.oystehr.com/oystehr/services/lab/submit-an-order/#friendly-patient-id-in-lab-orders/) for more information on submitting using the friendly ID.
+   */
+  useFriendlyPatientId?: boolean;
 }

package/src/resources/types/RcmProcessEraParams.ts

@@ -0,0 +1,8 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface RcmProcessEraParams {
+  /**
+   * EDI835 X12 string representing ERA
+   */
+  edi835: string;
+}

package/src/resources/types/RcmProcessEraResponse.ts

@@ -0,0 +1,7 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { Bundle } from 'fhir/r4b';
+/**
+ * Bundle with FHIR transaction output with resources created after procesing ERA.
+ */
+export type RcmProcessEraResponse = Bundle;

package/src/resources/types/TerminologySearchIcd10Params.ts

@@ -0,0 +1,11 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface TerminologySearchIcd10Params {
+  query: string;
+  searchType?: 'code' | 'description' | 'all';
+  limit?: number;
+  cursor?: string;
+  strictMatch?: boolean;
+  includeSynonyms?: boolean;
+  specialty?: 'urgent-care'[];
+}

package/src/resources/types/TerminologySearchIcd10Response.ts

@@ -0,0 +1,29 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+/**
+ * ICD-10-CM code search results
+ */
+export interface TerminologySearchIcd10Response {
+  /**
+   * Array of ICD-10-CM codes matching the search.
+   */
+  codes: {
+    /**
+     * ICD-10-CM code.
+     */
+    code: string;
+    /**
+     * Human-readable description of the ICD-10-CM code.
+     */
+    display: string;
+  }[];
+  /**
+   * Pagination metadata.
+   */
+  metadata: {
+    /**
+     * Cursor for the next page of results. Null if no more results.
+     */
+    nextCursor: string | null;
+  };
+}

package/src/resources/types/Z3EmptyBucketParams.ts

@@ -0,0 +1,5 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface Z3EmptyBucketParams {
+  bucketName: string;
+}

package/src/resources/types/Z3EmptyBucketResponse.ts

@@ -0,0 +1,11 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+/**
+ * Z3 Bucket was emptied successfully.
+ */
+export interface Z3EmptyBucketResponse {
+  /**
+   * The number of Z3 Objects deleted from the bucket.
+   */
+  deletedCount: number;
+}

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[];
 }
 
 /**

package/src/resources/types/index.ts

@@ -123,6 +123,8 @@ export * from './Z3ListBucketsResponse';
 export * from './Z3CreateBucketParams';
 export * from './Z3CreateBucketResponse';
 export * from './Z3DeleteBucketParams';
+export * from './Z3EmptyBucketParams';
+export * from './Z3EmptyBucketResponse';
 export * from './Z3ListObjectsParams';
 export * from './Z3ListObjectsResponse';
 export * from './Z3GetPresignedUrlParams';
@@ -165,6 +167,8 @@ export * from './ErxCancelPrescriptionParams';
 export * from './ErxSyncPatientParams';
 export * from './ErxSearchPharmaciesParams';
 export * from './ErxSearchPharmaciesResponse';
+export * from './ErxGetPharmacyParams';
+export * from './ErxGetPharmacyResponse';
 export * from './ErxConnectPractitionerParams';
 export * from './ErxConnectPractitionerResponse';
 export * from './ErxCheckPractitionerEnrollmentParams';
@@ -175,6 +179,8 @@ export * from './TerminologySearchCptParams';
 export * from './TerminologySearchCptResponse';
 export * from './TerminologySearchHcpcsParams';
 export * from './TerminologySearchHcpcsResponse';
+export * from './TerminologySearchIcd10Params';
+export * from './TerminologySearchIcd10Response';
 export * from './ZambdaSchedule';
 export * from './ZambdaFunction';
 export * from './ZambdaExecuteResult';
@@ -210,3 +216,5 @@ export * from './RcmListPayersParams';
 export * from './RcmListPayersResponse';
 export * from './RcmGetPayerParams';
 export * from './RcmGetPayerResponse';
+export * from './RcmProcessEraParams';
+export * from './RcmProcessEraResponse';