@oystehr/sdk 3.0.9 → 3.0.11

package/dist/esm/resources/types/index.d.ts

@@ -164,3 +164,11 @@ export * from './ZambdaLogStreamGetParams';
 export * from './ZambdaLogStreamGetResponse';
 export * from './FaxSendParams';
 export * from './FaxSendResponse';
+export * from './LabRouteListResponse';
+export * from './LabRouteCreateParams';
+export * from './LabRouteDeleteParams';
+export * from './LabOrderableItemListParams';
+export * from './LabOrderableItemListResponse';
+export * from './LabOrderableItemQuestionnaireGetParams';
+export * from './LabOrderableItemQuestionnaireGetResponse';
+export * from './LabOrderSubmitParams';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oystehr/sdk",
-  "version": "3.0.9",
+  "version": "3.0.11",
   "description": "Oystehr SDK",
   "scripts": {
     "lint": "eslint .",
@@ -14,7 +14,7 @@
     "parser": "ts-node debug-parser.ts",
     "publish-to-npmjs": "npm run build && npm publish",
     "publish-to-npmjs-next": "npm run build && npm publish --tag next",
-    "generate": "ts-node scripts/generate-sdk-v3 project,fax src/resources"
+    "generate": "ts-node scripts/generate-sdk-v3 project,fax,lab src/resources"
   },
   "engines": {
     "npm": ">=8.0.0",

package/src/config.ts

@@ -16,6 +16,7 @@ export interface OystehrConfig {
     faxApiUrl?: string;
     fhirApiUrl?: string;
     projectApiUrl?: string;
+    labApiUrl?: string;
   };
   /**
    * Optionally provide a custom fetch implementation. This must conform to the

package/src/resources/classes/index.ts

@@ -8,6 +8,7 @@ import { Developer } from './developer';
 import { Erx } from './erx';
 import { Fax } from './fax';
 import { Fhir } from './fhir';
+import { Lab } from './lab';
 import { M2m } from './m2m';
 import { Messaging } from './messaging';
 import { PaymentMethod } from './paymentMethod';
@@ -45,6 +46,7 @@ export class Oystehr {
   readonly zambda: Zambda;
   readonly zambdaLogStream: ZambdaLogStream;
   readonly fax: Fax;
+  readonly lab: Lab;
   readonly fhir: Fhir;
   constructor(config: OystehrConfig) {
     this.config = config;
@@ -71,6 +73,7 @@ export class Oystehr {
     this.zambda = new Zambda(config);
     this.zambdaLogStream = new ZambdaLogStream(config);
     this.fax = new Fax(config);
+    this.lab = new Lab(config);
     this.fhir = new Fhir(config);
   }
 }

package/src/resources/classes/lab.ts

@@ -0,0 +1,113 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import {
+  LabOrderableItemListParams,
+  LabOrderableItemListResponse,
+  LabOrderableItemQuestionnaireGetParams,
+  LabOrderableItemQuestionnaireGetResponse,
+  LabOrderSubmitParams,
+  LabRouteCreateParams,
+  LabRouteDeleteParams,
+  LabRouteListResponse,
+  OystehrClientRequest,
+} from '../..';
+import { SDKResource } from '../../client/client';
+import { OystehrConfig } from '../../config';
+
+export class Lab extends SDKResource {
+  constructor(config: OystehrConfig) {
+    super(config);
+  }
+  #baseUrlThunk(): string {
+    return this.config.services?.['labApiUrl'] ?? 'https://labs-api.zapehr.com/v1';
+  }
+  /**
+   * Gets a list of Routes associated with the project. Returns an empty list if no Routes are found.
+   *
+   * Access Policy Requirements:
+   * Action: `Lab:GetRoutes`
+   * Access Policy Resource: `Lab:Route`
+   */
+  routeList(request?: OystehrClientRequest): Promise<LabRouteListResponse> {
+    return this.request('/route', 'get', this.#baseUrlThunk.bind(this))(request);
+  }
+  /**
+   * Create a route. A Route represents that a lab and particular customer have a relationship, and a Route is necessary to submit an order to a lab. See [Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) for more details.
+   *
+   * Access Policy Requirements:
+   * Action: `Lab:CreateRoute`
+   * Access Policy Resource: `Lab:Route`
+   */
+  routeCreate(params: LabRouteCreateParams, request?: OystehrClientRequest): Promise<void> {
+    return this.request('/route', 'post', this.#baseUrlThunk.bind(this))(params, request);
+  }
+  /**
+   * Delete a route. Deleting a Route will permanently remove the `routeGuid`. Orders can no longer be submitted to this lab until a new Route is created. See [Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#delete-route) for more details.
+   *
+   * Access Policy Requirements:
+   * Action: `Lab:DeleteRoute`
+   * Access Policy Resource: `Lab:Route`
+   */
+  routeDelete(params: LabRouteDeleteParams, request?: OystehrClientRequest): Promise<void> {
+    return this.request('/route/{routeGuid}', 'delete', this.#baseUrlThunk.bind(this))(params, request);
+  }
+  /**
+   * Returns list of active orderable items for the latest compendium version. Page size is default 25 and max 100 items. See [orderable item Search](https://docs.oystehr.com/oystehr/services/lab/explore-the-compendium/#orderable-item-search) for more details.
+   *
+   * Access Policy Requirements:
+   * Action: `Lab:SearchOrderableItems`
+   * Access Policy Resource: `Lab:OrderableItem`
+   */
+  orderableItemList(
+    params: LabOrderableItemListParams,
+    request?: OystehrClientRequest
+  ): Promise<LabOrderableItemListResponse>;
+  /**
+   * Returns list of active orderable items for the latest compendium version. Page size is default 25 and max 100 items. See [orderable item Search](https://docs.oystehr.com/oystehr/services/lab/explore-the-compendium/#orderable-item-search) for more details.
+   *
+   * Access Policy Requirements:
+   * Action: `Lab:SearchOrderableItems`
+   * Access Policy Resource: `Lab:OrderableItem`
+   */
+  orderableItemList(request?: OystehrClientRequest): Promise<LabOrderableItemListResponse>;
+  /**
+   * Returns list of active orderable items for the latest compendium version. Page size is default 25 and max 100 items. See [orderable item Search](https://docs.oystehr.com/oystehr/services/lab/explore-the-compendium/#orderable-item-search) for more details.
+   *
+   * Access Policy Requirements:
+   * Action: `Lab:SearchOrderableItems`
+   * Access Policy Resource: `Lab:OrderableItem`
+   */
+  orderableItemList(
+    params?: LabOrderableItemListParams | OystehrClientRequest,
+    request?: OystehrClientRequest
+  ): Promise<LabOrderableItemListResponse> {
+    return this.request('/orderableItem', 'get', this.#baseUrlThunk.bind(this))(params, request);
+  }
+  /**
+   * Retrieve the AOE (Answer on Entry) Questionnaire for the given orderable item. The orderable item is defined by its labGuid, compendiumVersion, and itemCode. See [AOE](https://docs.oystehr.com/oystehr/services/lab/explore-the-compendium/#AOE) for more details.
+   *
+   * Access Policy Requirements:
+   * Action: `Lab:SearchOrderableItems`
+   * Access Policy Resource: `Lab:OrderableItem`
+   */
+  orderableItemQuestionnaireGet(
+    params: LabOrderableItemQuestionnaireGetParams,
+    request?: OystehrClientRequest
+  ): Promise<LabOrderableItemQuestionnaireGetResponse> {
+    return this.request(
+      '/canonical-questionnaire/lab/{labGuid}/compendium/{compendiumVersion}/item/{itemCode}/questionnaire',
+      'get',
+      this.#baseUrlThunk.bind(this)
+    )(params, request);
+  }
+  /**
+   * Submit a lab order. Oystehr's [Submit Lab](https://docs.oystehr.com/oystehr/services/lab/submit-an-order/) feature allows users to submit a well configured ServiceRequest to an external lab. In order to successfully submit an order, a [Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) to and Organization representing that lab must exist.
+   *
+   * Access Policy Requirements:
+   * Action: `Lab:SubmitOrder`
+   * Access Policy Resource: `Lab:Order`
+   */
+  orderSubmit(params: LabOrderSubmitParams, request?: OystehrClientRequest): Promise<void> {
+    return this.request('/submit', 'post', this.#baseUrlThunk.bind(this))(params, request);
+  }
+}

package/src/resources/classes/project.ts

@@ -12,7 +12,7 @@ export class Project extends SDKResource {
     return this.config.services?.['projectApiUrl'] ?? 'https://project-api.zapehr.com/v1';
   }
   /**
-   * Get the Project settings for a Project. Developers must specify a [project ID](https://docs.oystehr.com/oystehr/core-documentation/authenticating-api-requests/#x-zapehr-project-id-header) in the header. A Project is the logically-isolated instance of Oystehr that segments your data from other Projects. [Projects](https://docs.oystehr.com/oystehr/services/project/) are completely independent from each other, having their own separate [FHIR store](https://docs.oystehr.com/oystehr/services/fhir/basics/), [Applications](https://docs.oystehr.com/oystehr/services/app/applications/), [Users](https://docs.oystehr.com/oystehr/services/app/users/), etc .
+   * Get the Project settings for a Project. Developers must specify a [project ID](https://docs.oystehr.com/oystehr/core-documentation/authenticating-api-requests/#x-oystehr-project-id-header) in the header. A Project is the logically-isolated instance of Oystehr that segments your data from other Projects. [Projects](https://docs.oystehr.com/oystehr/services/project/) are completely independent from each other, having their own separate [FHIR store](https://docs.oystehr.com/oystehr/services/fhir/basics/), [Applications](https://docs.oystehr.com/oystehr/services/app/applications/), [Users](https://docs.oystehr.com/oystehr/services/app/users/), etc .
    *
    * Access Policy Action: `Project:GetProjectInfo`
    * Access Policy Resource: `Project:Settings`

package/src/resources/types/LabOrderSubmitParams.ts

@@ -0,0 +1,13 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface LabOrderSubmitParams {
+  primaryId?: string;
+  /**
+   * Provided by the lab, indicates a financial relationship between the lab and the customer.
+   */
+  accountNumber: string;
+  /**
+   * Valid ServiceRequest FHIR resource representing an order. See [Submit Lab](https://docs.oystehr.com/oystehr/services/lab/submit-an-order/) for more details.
+   */
+  serviceRequest: string;
+}

package/src/resources/types/LabOrderableItemListParams.ts

@@ -0,0 +1,13 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface LabOrderableItemListParams {
+  cursor?: string;
+  itemCodes?: string;
+  itemCptCodes?: string;
+  itemLoincs?: string;
+  itemNames?: string;
+  labIds?: string;
+  limit?: number;
+  sort?: 'itemCodes' | 'itemLoincs' | 'itemNames' | 'labIds';
+  sortOrder?: 'asc' | 'desc';
+}

package/src/resources/types/LabOrderableItemListResponse.ts

@@ -0,0 +1,136 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { Questionnaire } from 'fhir/r4b';
+/**
+ * orderable item results
+ */
+export interface LabOrderableItemListResponse {
+  orderableItems?: {
+    /**
+     * Identifying lab information and compendium version
+     */
+    lab?: {
+      /**
+       * Identifying labGuid pertaining to the specific result
+       */
+      labGuid?: string;
+      /**
+       * Name of lab
+       */
+      labName?: string;
+      /**
+       * Description of lab
+       */
+      labType?: string;
+      /**
+       * Current compendium version for given lab
+       */
+      compendiumVersion?: string;
+    };
+    /**
+     * Specific orderable item details
+     */
+    item?: {
+      /**
+       * Code uniquely identifying the orderable item for the given lab and compendium version
+       */
+      itemCode?: string;
+      /**
+       * LOINC code associated with this orderable item.
+       */
+      itemLoinc?: string;
+      /**
+       * Type of orderable item
+       */
+      itemType?: string;
+      /**
+       * Name of the orderable item.
+       */
+      itemName?: string;
+      /**
+       * Unique name of the orderable item. Typically a combination of the itemCode and itemName
+       */
+      uniqueName?: string;
+      /**
+       * List of the sample(s) that must be collected for this orderable item
+       */
+      specimens?: {
+        /**
+         * Description of container necessary to store the sample.
+         */
+        container?: string;
+        /**
+         * Volume of the specimen to be collected
+         */
+        volume?: string;
+        /**
+         * Minimum volume of specimen below which teh test is not performable
+         */
+        minimumVolume?: string;
+        /**
+         * Instructions for storing the specimen after collection
+         */
+        storageRequirements?: string;
+        /**
+         * Instructions for how to collect the sample
+         */
+        collectionInstructions?: string;
+      }[];
+      /**
+       * List of the component(s) comprising this orderable item
+       */
+      components?: {
+        /**
+         * Description of container necessary to store the sample.
+         */
+        componentItemCode?: string;
+        /**
+         * Name of component
+         */
+        name?: string;
+        /**
+         * LOINC code identifying the component
+         */
+        loinc?: string;
+        /**
+         * Unit of measurement
+         */
+        uom?: string;
+        /**
+         * Reference range associated with the component
+         */
+        range?: string;
+        /**
+         * Type of the component, such as List, Numeric, Free Text
+         */
+        type?: string;
+      }[];
+      /**
+       * Array of CPT codes associated with the orderable item
+       */
+      cptCodes?: {
+        /**
+         * CPT Code used for billing for medical services and procedures
+         */
+        cptCode?: string;
+        /**
+         * Number of billable units
+         */
+        serviceUnitsCount?: number;
+      }[];
+      /**
+       * Answer On Entry Questionnaire. See FHIR Questionnaire for schema
+       */
+      aoe?: Questionnaire;
+    };
+  }[];
+  /**
+   * Pagination details
+   */
+  metadata?: {
+    /**
+     * Cursor to include in subsequent request for next page of results. Will be null if there are no more results.
+     */
+    nextCursor?: string;
+  };
+}

package/src/resources/types/LabOrderableItemQuestionnaireGetParams.ts

@@ -0,0 +1,8 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface LabOrderableItemQuestionnaireGetParams {
+  primaryId?: string;
+  labGuid: string;
+  compendiumVersion: string;
+  itemCode: string;
+}

package/src/resources/types/LabOrderableItemQuestionnaireGetResponse.ts

@@ -0,0 +1,7 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { Questionnaire } from 'fhir/r4b';
+/**
+ * AOE Questionnaire
+ */
+export type LabOrderableItemQuestionnaireGetResponse = Questionnaire;

package/src/resources/types/LabRouteCreateParams.ts

@@ -0,0 +1,43 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface LabRouteCreateParams {
+  primaryId?: string;
+  /**
+   * Provided by the lab, indicates a financial relationship between the lab and the customer.
+   */
+  accountNumber: string;
+  /**
+   * Unique identifier of a lab. Searchable via orderable item Search.
+   */
+  labGuid: string;
+  /**
+   * Name of the Primary (Practice or Provider depending on the Route). Required for certain labs. See [Create Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) for more details.
+   */
+  primaryName?: string;
+  /**
+   * Address of the Primary. Required for certain labs. See [Create Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) for more details.
+   */
+  primaryAddress?: {
+    address1: string;
+    address2?: string;
+    city: string;
+    stateProvinceCode: string;
+    postalCode: string;
+  };
+  /**
+   * String representing accepted End User License Agreement Version. Required for certain labs. See [Create Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) for more details.
+   */
+  eulaVersion?: string;
+  /**
+   * Name of individual who accepted the End User License Agreement. Required for certain labs. See [Create Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) for more details.
+   */
+  eulaAccepterFullName?: string;
+  /**
+   * ISO string representing when the End User License Agreement was accepted. Required for certain labs. See [Create Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) for more details.
+   */
+  eulaAcceptanceDateTimeUtc?: string;
+  /**
+   * Site ID for the Primary. ClientSiteID is assigned by the lab. This disambiguates instances where the same Account Number is used across multiple physical locations. Required for certain labs. See [Create Route](https://docs.oystehr.com/oystehr/services/lab/onboarding-a-lab/#create-route) for more details.
+   */
+  clientSiteId?: string;
+}

package/src/resources/types/LabRouteDeleteParams.ts

@@ -0,0 +1,6 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface LabRouteDeleteParams {
+  primaryId?: string;
+  routeGuid: string;
+}

package/src/resources/types/LabRouteListResponse.ts

@@ -0,0 +1,19 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+/**
+ * List of Routes associated with the calling projectId.
+ */
+export type LabRouteListResponse = {
+  /**
+   * Unique identifier of the created Route.
+   */
+  routeGuid?: string;
+  /**
+   * Unique identifier of a lab. Searchable via orderable item Search
+   */
+  labGuid?: string;
+  /**
+   * Provided by the lab, indicates a financial relationship between the lab and the customer.
+   */
+  accountNumber?: string;
+}[];

package/src/resources/types/ZambdaExecuteResult.ts

@@ -8,5 +8,12 @@ export interface ZambdaExecuteResult {
   /**
    * JSON response payload from the Zambda Function
    */
-  output: string;
+  output:
+    | {
+        [k: string]: any;
+      }
+    | any[]
+    | string
+    | number
+    | null;
 }

package/src/resources/types/index.ts

@@ -166,3 +166,11 @@ export * from './ZambdaLogStreamGetParams';
 export * from './ZambdaLogStreamGetResponse';
 export * from './FaxSendParams';
 export * from './FaxSendResponse';
+export * from './LabRouteListResponse';
+export * from './LabRouteCreateParams';
+export * from './LabRouteDeleteParams';
+export * from './LabOrderableItemListParams';
+export * from './LabOrderableItemListResponse';
+export * from './LabOrderableItemQuestionnaireGetParams';
+export * from './LabOrderableItemQuestionnaireGetResponse';
+export * from './LabOrderSubmitParams';