@oystehr/sdk 3.0.0 → 3.0.2

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

@@ -1,5 +1,22 @@
-import { Operation } from 'fast-json-patch';
-import { BatchInput, BatchInputRequest, Binary, Bundle, BundleEntry, FhirBundle, FhirResource } from '../..';
+import { Address as AddressR4B, HumanName as HumanNameR4B } from 'fhir/r4b';
+import { Address as AddressR5, HumanName as HumanNameR5 } from 'fhir/r5';
+import {
+  BatchInput,
+  BatchInputRequest,
+  Binary,
+  Bundle,
+  BundleEntry,
+  FhirBundle,
+  FhirCreateParams,
+  FhirDeleteParams,
+  FhirGetParams,
+  FhirHistoryGetParams,
+  FhirHistorySearchParams,
+  FhirPatchParams,
+  FhirResource,
+  FhirSearchParams,
+  FhirUpdateParams,
+} from '../..';
 import { addParamsToSearch, FhirFetcherResponse, OystehrClientRequest, SDKResource } from '../../client/client';
 
 /**
@@ -26,12 +43,13 @@ export interface OystehrFHIRUpdateClientRequest extends OystehrClientRequest {
  */
 export async function search<T extends FhirResource>(
   this: SDKResource,
-  { resourceType, params }: { resourceType: string; params?: { name: string; value: string | number }[] },
+  params: FhirSearchParams,
   request?: OystehrClientRequest
 ): Promise<FhirFetcherResponse<Bundle<T>>> {
+  const { resourceType, params: searchParams } = params;
   let paramMap: Record<string, (string | number)[]> | undefined;
-  if (params) {
-    paramMap = Object.entries(params).reduce((acc, [_, param]) => {
+  if (searchParams) {
+    paramMap = Object.entries(searchParams).reduce((acc, [_, param]) => {
       if (!acc[param.name]) {
         acc[param.name] = [];
       }
@@ -45,7 +63,8 @@ export async function search<T extends FhirResource>(
   });
   const bundle: Bundle<T> = {
     ...requestBundle,
-    unbundle: function (this: Bundle<T>) {
+    entry: requestBundle.entry as Array<BundleEntry<T>> | undefined,
+    unbundle: function (this: { entry?: Array<BundleEntry<T>> | undefined }) {
       return this.entry?.map((entry) => entry.resource).filter((entry): entry is T => entry !== undefined) ?? [];
     },
   };
@@ -54,7 +73,7 @@ export async function search<T extends FhirResource>(
 
 export async function create<T extends FhirResource>(
   this: SDKResource,
-  params: T,
+  params: FhirCreateParams<T>,
   request?: OystehrClientRequest
 ): Promise<FhirFetcherResponse<T>> {
   const { resourceType } = params;
@@ -63,7 +82,7 @@ export async function create<T extends FhirResource>(
 
 export async function get<T extends FhirResource>(
   this: SDKResource,
-  { resourceType, id }: { resourceType: string; id: string },
+  { resourceType, id }: FhirGetParams,
   request?: OystehrClientRequest
 ): Promise<FhirFetcherResponse<T>> {
   return this.fhirRequest<T>(`/${resourceType}/${id}`, 'GET')({}, request);
@@ -71,7 +90,7 @@ export async function get<T extends FhirResource>(
 
 export async function update<T extends FhirResource>(
   this: SDKResource,
-  params: T,
+  params: FhirUpdateParams<T>,
   request?: OystehrFHIRUpdateClientRequest
 ): Promise<FhirFetcherResponse<T>> {
   const { id, resourceType } = params;
@@ -83,7 +102,7 @@ export async function update<T extends FhirResource>(
 
 export async function patch<T extends FhirResource>(
   this: SDKResource,
-  { resourceType, id, operations }: { resourceType: string; id: string; operations: Operation[] },
+  { resourceType, id, operations }: FhirPatchParams,
   request?: OystehrFHIRUpdateClientRequest
 ): Promise<FhirFetcherResponse<T>> {
   return this.fhirRequest(`/${resourceType}/${id}`, 'PATCH')(operations, {
@@ -95,7 +114,7 @@ export async function patch<T extends FhirResource>(
 
 async function del<T extends FhirResource>(
   this: SDKResource,
-  { resourceType, id }: { resourceType: string; id: string },
+  { resourceType, id }: FhirDeleteParams,
   request?: OystehrClientRequest
 ): Promise<FhirFetcherResponse<T>> {
   return this.fhirRequest(`/${resourceType}/${id}`, 'DELETE')({}, request);
@@ -104,12 +123,12 @@ export { del as delete };
 
 export async function history<T extends FhirResource>(
   this: SDKResource,
-  { resourceType, id }: { resourceType: string; id: string },
+  { resourceType, id }: FhirHistorySearchParams,
   request?: OystehrClientRequest
 ): Promise<FhirFetcherResponse<Bundle<T>>>;
 export async function history<T extends FhirResource>(
   this: SDKResource,
-  { resourceType, id, versionId }: { resourceType: string; id: string; versionId: string },
+  { resourceType, id, versionId }: FhirHistoryGetParams,
   request?: OystehrClientRequest
 ): Promise<FhirFetcherResponse<T>>;
 export async function history<T extends FhirResource>(
@@ -212,3 +231,68 @@ function bundleRequest(type: 'batch' | 'transaction') {
 
 export const batch = bundleRequest('batch');
 export const transaction = bundleRequest('transaction');
+
+export function formatAddress(
+  address: AddressR4B | AddressR5,
+  options?: { all?: boolean; use?: boolean; lineSeparator?: string }
+): string {
+  const builder = [];
+
+  if (address.line) {
+    builder.push(...address.line);
+  }
+
+  if (address.city || address.state || address.postalCode) {
+    const cityStateZip = [];
+    if (address.city) {
+      cityStateZip.push(address.city);
+    }
+    if (address.state) {
+      cityStateZip.push(address.state);
+    }
+    if (address.postalCode) {
+      cityStateZip.push(address.postalCode);
+    }
+    builder.push(cityStateZip.join(', '));
+  }
+
+  if (address.use && (options?.all || options?.use)) {
+    builder.push('[' + address.use + ']');
+  }
+
+  return builder.join(options?.lineSeparator || ', ').trim();
+}
+
+export function formatHumanName(
+  name: HumanNameR4B | HumanNameR5,
+  options?: {
+    all?: boolean;
+    prefix?: boolean;
+    suffix?: boolean;
+    use?: boolean;
+  }
+): string {
+  const builder = [];
+
+  if (name.prefix && options?.prefix !== false) {
+    builder.push(...name.prefix);
+  }
+
+  if (name.given) {
+    builder.push(...name.given);
+  }
+
+  if (name.family) {
+    builder.push(name.family);
+  }
+
+  if (name.suffix && options?.suffix !== false) {
+    builder.push(...name.suffix);
+  }
+
+  if (name.use && (options?.all || options?.use)) {
+    builder.push('[' + name.use + ']');
+  }
+
+  return builder.join(' ').trim();
+}

package/src/resources/classes/fhir.ts

@@ -23,4 +23,6 @@ export class Fhir extends SDKResource {
   history = ext.history;
   batch = ext.batch;
   transaction = ext.transaction;
+  formatAddress = ext.formatAddress;
+  formatHumanName = ext.formatHumanName;
 }

package/src/resources/classes/index.ts

@@ -23,6 +23,7 @@ import { Zambda } from './zambda';
 import { ZambdaLogStream } from './zambdaLogStream';
 
 export class Oystehr {
+  readonly config: OystehrConfig;
   readonly application: Application;
   readonly developer: Developer;
   readonly m2m: M2m;
@@ -44,6 +45,7 @@ export class Oystehr {
   readonly zambdaLogStream: ZambdaLogStream;
   readonly fhir: Fhir;
   constructor(config: OystehrConfig) {
+    this.config = config;
     this.application = new Application(config);
     this.developer = new Developer(config);
     this.m2m = new M2m(config);

package/src/resources/types/AccessPolicy.ts

@@ -4,6 +4,6 @@ export interface AccessPolicy {
   rule: {
     resource?: string[];
     action?: string[];
-    effect?: string;
+    effect?: 'Allow' | 'Deny';
   }[];
 }

package/src/resources/types/ClaimCMS1500.ts

@@ -8,14 +8,21 @@ import { ClaimId } from './ClaimId';
 import { ClaimName } from './ClaimName';
 
 export interface ClaimCMS1500 {
-  _1_insuranceProgram: string;
+  _1_insuranceProgram:
+    | 'MEDICARE'
+    | 'MEDICAID'
+    | 'TRICARE'
+    | 'CHAMPVA'
+    | 'GROUP_HEALTH_PLAN'
+    | 'FECA_BLK_LUNG'
+    | 'OTHER';
   _1a_insuredIdNumber: string;
   _2_patientName: ClaimName;
   _3_patientBirthDate: ClaimDate;
-  _3_patientSex: string;
+  _3_patientSex: 'M' | 'F';
   _4_insuredName?: ClaimName;
   _5_patientAddress: ClaimAddress;
-  _6_patientRelationshipToInsured?: string;
+  _6_patientRelationshipToInsured?: 'Self' | 'Spouse' | 'Child' | 'Other';
   _7_insuredAddress?: ClaimAddress;
   _9_otherInsuredName?: ClaimName;
   _9a_otherInsuredPolicyOrGroupNumber?: string;
@@ -29,7 +36,7 @@ export interface ClaimCMS1500 {
   _10d_claimCodes?: string[];
   _11_insuredPolicyGroupOrFecaNumber?: string;
   _11a_insuredDateOfBirth?: ClaimDate;
-  _11a_insuredSex?: string;
+  _11a_insuredSex?: 'M' | 'F';
   _11b_otherClaimId?: string;
   _11c_insurancePlanNameOrProgramName?: string;
   _11d_anotherHealthBenefitPlan: boolean;
@@ -81,7 +88,7 @@ export interface ClaimCMS1500 {
   }[];
   _25_federalTaxIdNumber: {
     value: string;
-    type: string;
+    type: 'SSN' | 'EIN';
   };
   _26_patientAccountNumber?: string;
   _27_acceptAssignment?: boolean;

package/src/resources/types/ConversationAddParticipantParams.ts

@@ -13,7 +13,7 @@ export interface ConversationAddParticipantParams {
     /**
      * The channel to use to communicate with the participant. The `chat` channel allows the Developer or User whose `profile` resource is in `participantReference` to join the Conversation via the Twilio Conversations SDK which enables web and native mobile chat. If channel is `sms` then `phoneNumber` must be supplied. The participant's phone number, specified in the `phoneNumber`, is added to the Conversation. They will receive SMS messages from the Conversation, and replies to the phone number from which they receive the messages will be sent to the Conversation.
      */
-    channel: string;
+    channel: 'sms' | 'chat';
     /**
      * The phone number of the participant. Required if `channel` is `sms`.
      */

package/src/resources/types/ErxMedicationSearchResponse.ts

@@ -26,9 +26,9 @@ export interface ErxMedicationSearchResponse {
     /**
      * Null implies a medication can not be prescribed
      */
-    type?: string | null;
-    concept: string;
-    schedule?: string | null;
+    type?: ('RX' | 'OTC') | null;
+    concept: 'DRUG' | 'PRODUCT' | 'PACKAGE';
+    schedule?: ('I' | 'II' | 'III' | 'IV' | 'V') | null;
     controlled: boolean;
     brandName?: string | null;
     genericName?: string | null;

package/src/resources/types/Project.ts

@@ -16,5 +16,5 @@ export interface Project {
   sandbox: boolean;
   defaultPatientRole?: RoleStub;
   defaultSSOUserRole?: RoleStub;
-  fhirVersion: string;
+  fhirVersion: 'r4' | 'r5';
 }

package/src/resources/types/VersionGetResponse.ts

@@ -7,7 +7,7 @@ export interface VersionGetResponse {
   /**
    * Always "project"
    */
-  api: string;
+  api: 'project';
   /**
    * The project API version
    */
@@ -15,5 +15,5 @@ export interface VersionGetResponse {
   /**
    * Always "production"
    */
-  environment: string;
+  environment: 'production';
 }

package/src/resources/types/Z3GetPresignedUrlParams.ts

@@ -1,7 +1,7 @@
 // AUTOGENERATED -- DO NOT EDIT
 
 export interface Z3GetPresignedUrlParams {
-  action: string;
+  action: 'upload' | 'download';
   /**
    * An optional parameter that determines which type of S3 object should be created.
    */

package/src/resources/types/ZambdaCreateParams.ts

@@ -10,6 +10,6 @@ export interface ZambdaCreateParams {
   /**
    * The trigger method for the Zambda Function determines how the Function is invoked. Learn more about the different types here, https://docs.oystehr.com/services/zambda/#types-of-zambdas.
    */
-  triggerMethod: string;
+  triggerMethod?: 'http_auth' | 'http_open' | 'subscription' | 'cron';
   schedule?: ZambdaSchedule;
 }

package/src/resources/types/ZambdaFunction.ts

@@ -15,11 +15,11 @@ export interface ZambdaFunction {
   /**
    * The Zambda Function status provides information about the Functions state including whether it is ready to be invoked.
    */
-  status: string;
+  status: 'Draft' | 'Pending' | 'Active' | 'Failed' | 'Inactive' | 'Validating';
   /**
    * The trigger method for the Zambda Function determines how the Function is invoked. Learn more about the different types here, https://docs.oystehr.com/services/zambda/#types-of-zambdas.
    */
-  triggerMethod: string;
+  triggerMethod: 'http_auth' | 'http_open' | 'subscription' | 'cron';
   schedule?: ZambdaSchedule;
   /**
    * Info about the zip file that was uploaded for the Zambda Function.

package/src/resources/types/ZambdaUpdateParams.ts

@@ -10,11 +10,11 @@ export interface ZambdaUpdateParams {
   /**
    * The trigger method for the Zambda Function determines how the Function is invoked. Learn more about the different types here, https://docs.oystehr.com/services/zambda/#types-of-zambdas.
    */
-  triggerMethod?: string;
+  triggerMethod?: 'http_auth' | 'http_open' | 'subscription' | 'cron';
   schedule?: ZambdaSchedule;
   /**
    * The runtime to use for the Zambda Function. This property is optional and defaults to "nodejs20.x".
    */
-  runtime?: string;
+  runtime?: 'nodejs18.x' | 'nodejs20.x';
   id: string;
 }

package/src/resources/types/fhir.ts

@@ -15,12 +15,67 @@ import type {
 } from 'fhir/r5';
 
 export type FhirResource = FhirResourceR4B | FhirResourceR5;
+// We're doing this "Omit dance" with the Bundle types because TypeScript
+// produces incorrect BundleEntry<F> types when F is a union of multiple FHIR
+// types. The guess is it's something about the conditional generic typing, but
+// we haven't found a different way to resolve it.
+//
+// No "omit dance":
+// entry: BundleEntry<Patient>[] | BundleEntry<Practitioner>[] | undefined
+// With "omit dance":
+// entry: (BundleEntry<Patient> | BundleEntry<Practitioner>)[] | undefined
+//
+// The latter can be used with array functions like `.find()`.
 export type FhirBundle<F extends FhirResource> = F extends FhirResourceR4B ? BundleR4B<F> : BundleR5<F>;
-export type Bundle<F extends FhirResource> = FhirBundle<F> & { unbundle: (this: Bundle<F>) => F[] };
+export type EntrylessFhirBundle<F extends FhirResource> = F extends FhirResourceR4B
+  ? Omit<BundleR4B<F>, 'entry'>
+  : Omit<BundleR5<F>, 'entry'>;
+export type Bundle<F extends FhirResource> = EntrylessFhirBundle<F> & {
+  entry?: Array<BundleEntry<F>> | undefined;
+  unbundle: (this: { entry?: Array<BundleEntry<F>> }) => F[];
+};
 export type BundleEntry<F extends FhirResource> = F extends FhirResourceR4B ? BundleEntryR4B<F> : BundleEntryR5<F>;
 export type Binary<F extends FhirResource> = F extends FhirResourceR4B ? BinaryR4B : BinaryR5;
 export type OperationOutcome = OperationOutcomeR4B | OperationOutcomeR5;
 
+export type SearchParam = { name: string; value: string | number };
+
+export interface FhirSearchParams {
+  resourceType: string;
+  params?: SearchParam[];
+}
+
+export interface FhirGetParams {
+  resourceType: string;
+  id: string;
+}
+
+export type FhirCreateParams<T extends FhirResource> = T;
+
+export type FhirUpdateParams<T extends FhirResource> = T;
+
+export interface FhirPatchParams {
+  resourceType: string;
+  id: string;
+  operations: Operation[];
+}
+
+export interface FhirDeleteParams {
+  resourceType: string;
+  id: string;
+}
+
+export interface FhirHistorySearchParams {
+  resourceType: string;
+  id: string;
+}
+
+export interface FhirHistoryGetParams {
+  resourceType: string;
+  id: string;
+  versionId: string;
+}
+
 interface BatchInputBaseRequest {
   url: string;
 }

package/dist/cjs/fhir/fhir-types.d.ts

@@ -1,9 +0,0 @@
-import * as R4B from 'fhir/r4b';
-import * as R5 from 'fhir/r5';
-export type Binary = R4B.Binary | R5.Binary;
-export type FhirResource = R4B.FhirResource | R5.FhirResource;
-export type Resource = R4B.Resource | R5.Resource;
-export type Bundle<BundleContentType = FhirResource> = R4B.Bundle<BundleContentType> | R5.Bundle<BundleContentType>;
-export type BundleEntry<BundleContentType = FhirResource> = R4B.BundleEntry<BundleContentType> | R5.BundleEntry<BundleContentType>;
-export type Address = R4B.Address | R5.Address;
-export type HumanName = R4B.HumanName | R5.HumanName;

package/dist/cjs/fhir/index.d.ts

@@ -1,2 +0,0 @@
-export * from './utils';
-export * from './fhir-types';

package/dist/cjs/fhir/utils.d.ts

@@ -1,14 +0,0 @@
-import { Address, HumanName } from './fhir-types';
-export interface AddressFormatOptions {
-    all?: boolean;
-    use?: boolean;
-    lineSeparator?: string;
-}
-export interface HumanNameFormatOptions {
-    all?: boolean;
-    prefix?: boolean;
-    suffix?: boolean;
-    use?: boolean;
-}
-export declare function formatAddress(address: Address, options?: AddressFormatOptions): string;
-export declare function formatHumanName(name: HumanName, options?: HumanNameFormatOptions): string;

package/dist/esm/fhir/fhir-types.d.ts

@@ -1,9 +0,0 @@
-import * as R4B from 'fhir/r4b';
-import * as R5 from 'fhir/r5';
-export type Binary = R4B.Binary | R5.Binary;
-export type FhirResource = R4B.FhirResource | R5.FhirResource;
-export type Resource = R4B.Resource | R5.Resource;
-export type Bundle<BundleContentType = FhirResource> = R4B.Bundle<BundleContentType> | R5.Bundle<BundleContentType>;
-export type BundleEntry<BundleContentType = FhirResource> = R4B.BundleEntry<BundleContentType> | R5.BundleEntry<BundleContentType>;
-export type Address = R4B.Address | R5.Address;
-export type HumanName = R4B.HumanName | R5.HumanName;

package/dist/esm/fhir/index.d.ts

@@ -1,2 +0,0 @@
-export * from './utils';
-export * from './fhir-types';

package/dist/esm/fhir/utils.d.ts

@@ -1,14 +0,0 @@
-import { Address, HumanName } from './fhir-types';
-export interface AddressFormatOptions {
-    all?: boolean;
-    use?: boolean;
-    lineSeparator?: string;
-}
-export interface HumanNameFormatOptions {
-    all?: boolean;
-    prefix?: boolean;
-    suffix?: boolean;
-    use?: boolean;
-}
-export declare function formatAddress(address: Address, options?: AddressFormatOptions): string;
-export declare function formatHumanName(name: HumanName, options?: HumanNameFormatOptions): string;

package/src/fhir/fhir-types.ts

@@ -1,15 +0,0 @@
-import * as R4B from 'fhir/r4b';
-import * as R5 from 'fhir/r5';
-
-// Resources
-export type Binary = R4B.Binary | R5.Binary;
-export type FhirResource = R4B.FhirResource | R5.FhirResource;
-export type Resource = R4B.Resource | R5.Resource;
-export type Bundle<BundleContentType = FhirResource> = R4B.Bundle<BundleContentType> | R5.Bundle<BundleContentType>;
-export type BundleEntry<BundleContentType = FhirResource> =
-  | R4B.BundleEntry<BundleContentType>
-  | R5.BundleEntry<BundleContentType>;
-
-// DataTypes
-export type Address = R4B.Address | R5.Address;
-export type HumanName = R4B.HumanName | R5.HumanName;

package/src/fhir/index.ts

@@ -1,2 +0,0 @@
-export * from './utils';
-export * from './fhir-types';

package/src/fhir/utils.ts

@@ -1,68 +0,0 @@
-import { Address, HumanName } from './fhir-types';
-
-export interface AddressFormatOptions {
-  all?: boolean;
-  use?: boolean;
-  lineSeparator?: string;
-}
-
-export interface HumanNameFormatOptions {
-  all?: boolean;
-  prefix?: boolean;
-  suffix?: boolean;
-  use?: boolean;
-}
-
-export function formatAddress(address: Address, options?: AddressFormatOptions): string {
-  const builder = [];
-
-  if (address.line) {
-    builder.push(...address.line);
-  }
-
-  if (address.city || address.state || address.postalCode) {
-    const cityStateZip = [];
-    if (address.city) {
-      cityStateZip.push(address.city);
-    }
-    if (address.state) {
-      cityStateZip.push(address.state);
-    }
-    if (address.postalCode) {
-      cityStateZip.push(address.postalCode);
-    }
-    builder.push(cityStateZip.join(', '));
-  }
-
-  if (address.use && (options?.all || options?.use)) {
-    builder.push('[' + address.use + ']');
-  }
-
-  return builder.join(options?.lineSeparator || ', ').trim();
-}
-
-export function formatHumanName(name: HumanName, options?: HumanNameFormatOptions): string {
-  const builder = [];
-
-  if (name.prefix && options?.prefix !== false) {
-    builder.push(...name.prefix);
-  }
-
-  if (name.given) {
-    builder.push(...name.given);
-  }
-
-  if (name.family) {
-    builder.push(name.family);
-  }
-
-  if (name.suffix && options?.suffix !== false) {
-    builder.push(...name.suffix);
-  }
-
-  if (name.use && (options?.all || options?.use)) {
-    builder.push('[' + name.use + ']');
-  }
-
-  return builder.join(' ').trim();
-}