@metriport/api-sdk 6.0.1-alpha.1 → 6.0.1-alpha.2

package/src/devices/models/common/sample.ts

@@ -1,7 +0,0 @@
-import { SourceInfo } from "./source-info";
-
-export interface Sample {
-  time: string;
-  value: number;
-  data_source?: SourceInfo;
-}

package/src/devices/models/common/sex.ts

@@ -1 +0,0 @@
-export type Sex = "male" | "female";

package/src/devices/models/common/source-info.ts

@@ -1,8 +0,0 @@
-import { SourceType } from "./source-type";
-
-export interface SourceInfo {
-  source_type?: SourceType;
-  id?: string;
-  name?: string;
-  type?: string;
-}

package/src/devices/models/common/source-type.ts

@@ -1,4 +0,0 @@
-export enum SourceType {
-  manual = "MANUAL_ENTRY",
-  device = "DEVICE",
-}

package/src/devices/models/common/temperature.ts

@@ -1,13 +0,0 @@
-import { Sample } from "./sample";
-
-export interface Temperature {
-  core?: {
-    avg_celcius?: number;
-    samples_celcius?: Sample[];
-  };
-  delta_celcius?: number;
-  skin?: {
-    avg_celcius?: number;
-    samples_celcius?: Sample[];
-  };
-}

package/src/devices/models/metriport-data.ts

@@ -1,5 +0,0 @@
-import { Metadata } from "./common/metadata";
-
-export interface MetriportData {
-  metadata: Metadata;
-}

package/src/devices/models/nutrition.ts

@@ -1,10 +0,0 @@
-import { Aminos } from "./common/aminos";
-import { Macros } from "./common/macros";
-import { Micros } from "./common/micros";
-import { Food } from "./common/food";
-import { MetriportData } from "./metriport-data";
-
-export interface Nutrition extends MetriportData {
-  summary?: { macros?: Macros; micros?: Micros; aminos?: Aminos };
-  foods?: Food[];
-}

package/src/devices/models/sleep.ts

@@ -1,29 +0,0 @@
-import { HeartRate } from "./common/heart-rate";
-import { HeartRateVariability } from "./common/heart-rate-variability";
-import { Respiration } from "./common/respiration";
-import { Temperature } from "./common/temperature";
-import { MetriportData } from "./metriport-data";
-
-export interface Sleep extends MetriportData {
-  start_time?: string;
-  end_time?: string;
-  durations?: SleepDurations;
-  biometrics?: SleepBiometrics;
-  // TODO: sleep events, ie times woken up?
-}
-export interface SleepDurations {
-  total_seconds?: number;
-  awake_seconds?: number;
-  deep_seconds?: number;
-  rem_seconds?: number;
-  light_seconds?: number;
-  in_bed_seconds?: number;
-  time_to_fall_asleep_seconds?: number;
-  no_data_seconds?: number;
-}
-export interface SleepBiometrics {
-  heart_rate?: HeartRate;
-  hrv?: HeartRateVariability;
-  respiration?: Respiration;
-  temperature?: Temperature;
-}

package/src/devices/models/user.ts

@@ -1,14 +0,0 @@
-import { Sex } from "./common/sex";
-import { MetriportData } from "./metriport-data";
-
-export interface User extends MetriportData {
-  age?: number;
-  first_name?: string;
-  last_name?: string;
-  city?: string;
-  country?: string;
-  date_of_birth?: string;
-  email?: string;
-  region?: string; // can be state, province, etc.
-  sex?: Sex;
-}

package/src/index.ts

@@ -1,60 +0,0 @@
-// Devices API
-export { MetriportDevicesApi } from "./devices/client/metriport";
-export { Activity } from "./devices/models/activity";
-export { Biometrics } from "./devices/models/biometrics";
-export { Body } from "./devices/models/body";
-export { ProviderSource } from "./devices/models/common/provider-source";
-export { Food } from "./devices/models/common/food";
-export { Nutrition } from "./devices/models/nutrition";
-export { Sleep } from "./devices/models/sleep";
-export { User } from "./devices/models/user";
-export { ConnectedUserInfo } from "./devices/models/common/connected-user-info";
-export { SourceType } from "./devices/models/common/source-type";
-// Medical API
-export { MetriportMedicalApi } from "./medical/client/metriport";
-export { Address, addressSchema } from "./medical/models/common/address";
-export { BaseUpdate, baseUpdateSchema } from "./medical/models/common/base-update";
-export { USState, usStateSchema } from "./medical/models/common/us-data";
-export {
-  contactSchema,
-  Demographics,
-  demographicsSchema,
-  genderAtBirthSchema,
-  PersonalIdentifier,
-  personalIdentifierSchema,
-} from "./medical/models/demographics";
-export {
-  DocumentList,
-  documentListSchema,
-  DocumentQuery,
-  documentQuerySchema,
-  DocumentQueryStatus,
-  documentQueryStatusSchema,
-  DocumentReference,
-  documentReferenceSchema,
-} from "./medical/models/document";
-export {
-  Facility,
-  FacilityCreate,
-  facilityCreateSchema,
-  facilityListSchema,
-  facilitySchema,
-} from "./medical/models/facility";
-export { MedicalDataSource } from "./medical/models/common/medical-data-source";
-export {
-  Organization,
-  OrganizationCreate,
-  organizationCreateSchema,
-  organizationSchema,
-  OrgType,
-  orgTypeSchema,
-} from "./medical/models/organization";
-export {
-  Patient,
-  PatientCreate,
-  patientCreateSchema,
-  patientListSchema,
-  patientSchema,
-  PatientUpdate,
-  patientUpdateSchema,
-} from "./medical/models/patient";

package/src/medical/client/metriport.ts

@@ -1,328 +0,0 @@
-import axios, { AxiosInstance, AxiosStatic, CreateAxiosDefaults } from "axios";
-import {
-  API_KEY_HEADER,
-  BASE_ADDRESS,
-  BASE_ADDRESS_SANDBOX,
-  DEFAULT_AXIOS_TIMEOUT_MILLIS,
-} from "../../shared";
-import { getETagHeader } from "../models/common/base-update";
-import {
-  documentListSchema,
-  DocumentQuery,
-  documentQuerySchema,
-  DocumentReference,
-} from "../models/document";
-import { Facility, FacilityCreate, facilityListSchema, facilitySchema } from "../models/facility";
-import { Organization, OrganizationCreate, organizationSchema } from "../models/organization";
-import {
-  Patient,
-  PatientCreate,
-  patientListSchema,
-  patientSchema,
-  PatientUpdate,
-} from "../models/patient";
-
-const NO_DATA_MESSAGE = "No data returned from API";
-const BASE_PATH = "/medical/v1";
-const ORGANIZATION_URL = `/organization`;
-const FACILITY_URL = `/facility`;
-const PATIENT_URL = `/patient`;
-const DOCUMENT_URL = `/document`;
-
-export type Options = {
-  axios?: AxiosStatic; // Set axios if it fails to load
-  timeout?: number;
-  additionalHeaders?: Record<string, string>;
-} & (
-  | {
-      sandbox?: boolean;
-      baseAddress?: never;
-    }
-  | {
-      sandbox?: never;
-      baseAddress?: string;
-    }
-);
-
-export class MetriportMedicalApi {
-  readonly api: AxiosInstance;
-
-  static readonly headers = {
-    clientApp: "x-metriport-client",
-  };
-
-  /**
-   * Creates a new instance of the Metriport Medical API client.
-   *
-   * @param apiKey Your Metriport API key.
-   * @param options - Optional parameters
-   * @param options.additionalHeaders - HTTP headers to be used in all requests.
-   * @param options.axios - Axios instance, default, useful when the dependency is not being imported
-   *          properly by NPM.
-   * @param options.sandbox - Indicates whether to connect to the sandbox, default false.
-   * @param options.timeout - Connection timeout in milliseconds, default 20 seconds.
-   */
-  constructor(apiKey: string, options: Options = {}) {
-    const headers = { [API_KEY_HEADER]: apiKey, ...options.additionalHeaders };
-    const { sandbox, timeout } = options;
-
-    const baseURL =
-      (options.baseAddress || (sandbox ? BASE_ADDRESS_SANDBOX : BASE_ADDRESS)) + BASE_PATH;
-    const axiosConfig: CreateAxiosDefaults = {
-      timeout: timeout ?? DEFAULT_AXIOS_TIMEOUT_MILLIS,
-      baseURL,
-      headers,
-    };
-
-    if (axios) {
-      this.api = axios.create(axiosConfig);
-    } else if (options.axios) {
-      this.api = options.axios.create(axiosConfig);
-    } else {
-      throw new Error(`Failed to initialize Axios`);
-    }
-  }
-
-  /**
-   * Creates a new organization.
-   *
-   * @param data The data to be used to create a new organization.
-   * @returns The created organization.
-   */
-  async createOrganization(data: OrganizationCreate): Promise<Organization> {
-    const resp = await this.api.post(ORGANIZATION_URL, data);
-    if (!resp.data) throw new Error(NO_DATA_MESSAGE);
-    return organizationSchema.parse(resp.data);
-  }
-
-  /**
-   * Updates an organization.
-   *
-   * @param organization The organization data to be updated.
-   * @return The updated organization.
-   */
-  async updateOrganization(organization: Organization): Promise<Organization> {
-    type FieldsToOmit = "id";
-    const payload: Omit<Organization, FieldsToOmit> & Record<FieldsToOmit, undefined> = {
-      ...organization,
-      id: undefined,
-    };
-    const resp = await this.api.put(`${ORGANIZATION_URL}/${organization.id}`, payload, {
-      headers: { ...getETagHeader(organization) },
-    });
-    if (!resp.data) throw new Error(NO_DATA_MESSAGE);
-    return organizationSchema.parse(resp.data);
-  }
-
-  /**
-   * Retrieve an organization representing this account.
-   *
-   * @returns The organization, or undefined if no organization has been created.
-   */
-  async getOrganization(): Promise<Organization | undefined> {
-    const resp = await this.api.get(ORGANIZATION_URL);
-    if (!resp.data) return undefined;
-    return organizationSchema.parse(resp.data);
-  }
-
-  /**
-   * Creates a new facility.
-   *
-   * @param data The data to be used to create a new facility.
-   * @return The newly created facility.
-   */
-  async createFacility(data: FacilityCreate): Promise<Facility> {
-    const resp = await this.api.post(`${FACILITY_URL}`, data);
-    if (!resp.data) throw new Error(NO_DATA_MESSAGE);
-    return facilitySchema.parse(resp.data);
-  }
-
-  /**
-   * Returns a facility.
-   *
-   * @param id The ID of the facility to be returned.
-   * @return The facilities.
-   */
-  async getFacility(id: string): Promise<Facility> {
-    const resp = await this.api.get(`${FACILITY_URL}/${id}`);
-    if (!resp.data) throw new Error(NO_DATA_MESSAGE);
-    return facilitySchema.parse(resp.data);
-  }
-
-  /**
-   * Updates a facility.
-   *
-   * @param facility The facility data to be updated.
-   * @return The updated facility.
-   */
-  async updateFacility(facility: Facility): Promise<Facility> {
-    type FieldsToOmit = "id";
-    const payload: Omit<Facility, FieldsToOmit> & Record<FieldsToOmit, undefined> = {
-      ...facility,
-      id: undefined,
-    };
-    const resp = await this.api.put(`${FACILITY_URL}/${facility.id}`, payload, {
-      headers: { ...getETagHeader(facility) },
-    });
-    if (!resp.data) throw new Error(NO_DATA_MESSAGE);
-    return facilitySchema.parse(resp.data);
-  }
-
-  /**
-   * Returns the facilities associated with this account.
-   *
-   * @return The list of facilities.
-   */
-  async listFacilities(): Promise<Facility[]> {
-    const resp = await this.api.get(`${FACILITY_URL}`);
-    if (!resp.data) [];
-    return facilityListSchema.parse(resp.data).facilities;
-  }
-
-  /**
-   * Creates a new patient at Metriport and HIEs.
-   *
-   * @param data The data to be used to create a new patient.
-   * @param facilityId The facility providing the NPI to support this operation.
-   * @return The newly created patient.
-   */
-  async createPatient(data: PatientCreate, facilityId: string): Promise<Patient> {
-    const resp = await this.api.post(`${PATIENT_URL}`, data, {
-      params: { facilityId },
-    });
-    if (!resp.data) throw new Error(NO_DATA_MESSAGE);
-    return patientSchema.parse(resp.data);
-  }
-
-  /**
-   * Returns a patient.
-   *
-   * @param id The ID of the patient to be returned.
-   * @return The patients.
-   */
-  async getPatient(id: string): Promise<Patient> {
-    const resp = await this.api.get(`${PATIENT_URL}/${id}`);
-    if (!resp.data) throw new Error(NO_DATA_MESSAGE);
-    return patientSchema.parse(resp.data);
-  }
-
-  /**
-   * Updates a patient at Metriport and at HIEs the patient is linked to.
-   *
-   * @param patient The patient data to be updated.
-   * @param facilityId The facility providing the NPI to support this operation.
-   * @return The updated patient.
-   */
-  async updatePatient(patient: PatientUpdate, facilityId: string): Promise<Patient> {
-    type FieldsToOmit = "id";
-    const payload: Omit<PatientUpdate, FieldsToOmit> & Record<FieldsToOmit, undefined> = {
-      ...patient,
-      id: undefined,
-    };
-    const resp = await this.api.put(`${PATIENT_URL}/${patient.id}`, payload, {
-      params: { facilityId },
-      headers: { ...getETagHeader(patient) },
-    });
-    if (!resp.data) throw new Error(NO_DATA_MESSAGE);
-    return patientSchema.parse(resp.data);
-  }
-
-  /**
-   * Removes a patient at Metriport and at HIEs the patient is linked to.
-   *
-   * @param patientId The ID of the patient data to be deleted.
-   * @param facilityId The facility providing the NPI to support this operation.
-   */
-  async deletePatient(patientId: string, facilityId: string, eTag?: string): Promise<void> {
-    await this.api.delete(`${PATIENT_URL}/${patientId}`, {
-      params: { facilityId },
-      headers: { ...getETagHeader({ eTag }) },
-    });
-  }
-
-  /**
-   * Returns the patients associated with given facility.
-   *
-   * @param facilityId The ID of the facility.
-   * @return The list of patients.
-   */
-  async listPatients(facilityId: string): Promise<Patient[]> {
-    const resp = await this.api.get(`${PATIENT_URL}`, {
-      params: { facilityId },
-    });
-    if (!resp.data) [];
-    return patientListSchema.parse(resp.data).patients;
-  }
-
-  /**
-   * Returns document references for the given patient across HIEs.
-   *
-   * @param patientId Patient ID for which to retrieve document metadata.
-   * @param facilityId The facility providing the NPI to support this operation.
-   * @return The list of available document references.
-   */
-  async listDocuments(patientId: string, facilityId: string): Promise<DocumentReference[]> {
-    const resp = await this.api.get(`${DOCUMENT_URL}`, {
-      params: {
-        patientId,
-        facilityId,
-      },
-    });
-    if (!resp.data) return [];
-    return documentListSchema.parse(resp.data).documents;
-  }
-
-  /**
-   * Start a document query for the given patient across HIEs.
-   *
-   * @param patientId Patient ID for which to retrieve document metadata.
-   * @param facilityId The facility providing the NPI to support this operation.
-   * @return The document query progress & status indicating whether its being executed or not.
-   */
-  async startDocumentQuery(patientId: string, facilityId: string): Promise<DocumentQuery> {
-    const resp = await this.api.post(`${DOCUMENT_URL}/query`, null, {
-      params: {
-        patientId,
-        facilityId,
-      },
-    });
-    if (!resp.data) throw new Error(NO_DATA_MESSAGE);
-    return documentQuerySchema.parse(resp.data);
-  }
-
-  /**
-   * Returns the document query status for the specified patient.
-   *
-   * @param patientId Patient ID for which to retrieve document query status.
-   * @return The document query progress & status indicating whether its being executed or not.
-   */
-  async getDocumentQueryStatus(patientId: string): Promise<DocumentQuery> {
-    const resp = await this.api.get(`${DOCUMENT_URL}/query`, {
-      params: { patientId },
-    });
-    if (!resp.data) throw new Error(NO_DATA_MESSAGE);
-    return documentQuerySchema.parse(resp.data);
-  }
-
-  /**
-   * Returns a URL that can be used to download the document.
-   *
-   * @param req.query.fileName The file name of the document in s3.
-   * @param req.query.conversionType The doc type to convert to. Valid values are "html" and "pdf".
-   * @return presigned url
-   */
-  //eslint-disable-next-line @typescript-eslint/no-explicit-any
-  async getDocumentUrl(
-    fileName: string,
-    conversionType?: "html" | "pdf"
-  ): Promise<{ url: string }> {
-    const resp = await this.api.get(`${DOCUMENT_URL}/downloadUrl`, {
-      params: {
-        fileName,
-        conversionType,
-      },
-    });
-
-    return resp.data;
-  }
-}

package/src/medical/models/common/address.ts

@@ -1,20 +0,0 @@
-import { z } from "zod";
-import { usStateSchema } from "./us-data";
-import { defaultOptionalString, stripNonNumericChars } from "../../../shared";
-
-const zipLength = 5;
-export const addressSchema = z.object({
-  addressLine1: defaultOptionalString,
-  addressLine2: defaultOptionalString,
-  city: defaultOptionalString,
-  state: usStateSchema.or(defaultOptionalString),
-  zip: z.coerce
-    .string()
-    .transform(zipStr => stripNonNumericChars(zipStr))
-    .refine(zip => zip.length === zipLength, {
-      message: `Zip must be a string consisting of ${zipLength} numbers`,
-    }),
-  country: defaultOptionalString.default("USA"), // here for backwards compatibility, we'll ignore this and always default to USA
-});
-
-export type Address = z.infer<typeof addressSchema>;

package/src/medical/models/common/base-update.ts

@@ -1,11 +0,0 @@
-import { z } from "zod";
-
-export const baseUpdateSchema = z.object({
-  id: z.string(),
-  eTag: z.string().optional(),
-});
-export type BaseUpdate = z.infer<typeof baseUpdateSchema>;
-
-export function getETagHeader(entity: Pick<BaseUpdate, "eTag">) {
-  return entity.eTag ? { "If-Match": entity.eTag } : undefined;
-}

package/src/medical/models/common/medical-data-source.ts

@@ -1,3 +0,0 @@
-export enum MedicalDataSource {
-  COMMONWELL = "COMMONWELL",
-}

package/src/medical/models/common/us-data.ts

@@ -1,56 +0,0 @@
-import { z } from "zod";
-
-export enum USState {
-  AL = "AL",
-  AK = "AK",
-  AZ = "AZ",
-  AR = "AR",
-  CA = "CA",
-  CO = "CO",
-  CT = "CT",
-  DE = "DE",
-  DC = "DC",
-  FL = "FL",
-  GA = "GA",
-  HI = "HI",
-  ID = "ID",
-  IL = "IL",
-  IN = "IN",
-  IA = "IA",
-  KS = "KS",
-  KY = "KY",
-  LA = "LA",
-  ME = "ME",
-  MD = "MD",
-  MA = "MA",
-  MI = "MI",
-  MN = "MN",
-  MS = "MS",
-  MO = "MO",
-  MT = "MT",
-  NE = "NE",
-  NV = "NV",
-  NH = "NH",
-  NJ = "NJ",
-  NM = "NM",
-  NY = "NY",
-  NC = "NC",
-  ND = "ND",
-  OH = "OH",
-  OK = "OK",
-  OR = "OR",
-  PA = "PA",
-  RI = "RI",
-  SC = "SC",
-  SD = "SD",
-  TN = "TN",
-  TX = "TX",
-  UT = "UT",
-  VT = "VT",
-  VA = "VA",
-  WA = "WA",
-  WV = "WV",
-  WI = "WI",
-  WY = "WY",
-}
-export const usStateSchema = z.nativeEnum(USState);

package/src/medical/models/demographics.ts

@@ -1,63 +0,0 @@
-import { z } from "zod";
-import { addressSchema } from "./common/address";
-import { usStateSchema } from "./common/us-data";
-import {
-  defaultDateString,
-  defaultNameString,
-  defaultOptionalString,
-  stripNonNumericChars,
-} from "../../shared";
-
-const basePersonalIdentifierSchema = z.object({
-  value: z.string(),
-  period: z
-    .object({
-      start: z.string(),
-      end: z.string().optional(),
-    })
-    .or(
-      z.object({
-        start: z.string().optional(),
-        end: z.string(),
-      })
-    )
-    .optional(),
-  assigner: z.string().optional(),
-});
-
-export const driverLicenseIdentifierSchema = z.object({
-  type: z.literal("driversLicense"),
-  state: usStateSchema,
-});
-
-export const personalIdentifierSchema = basePersonalIdentifierSchema.merge(
-  driverLicenseIdentifierSchema
-);
-export type PersonalIdentifier = z.infer<typeof personalIdentifierSchema>;
-
-export const genderAtBirthSchema = z.enum(["F", "M"]);
-
-const phoneLength = 10;
-export const contactSchema = z
-  .object({
-    phone: z.coerce
-      .string()
-      .transform(phone => stripNonNumericChars(phone))
-      .refine(phone => phone.length === phoneLength, {
-        message: `Phone must be a string consisting of ${phoneLength} numbers. For example: 4153245540`,
-      })
-      .or(defaultOptionalString),
-    email: z.string().email().or(defaultOptionalString),
-  })
-  .refine(c => c.email || c.phone, { message: "Either email or phone must be present" });
-
-export const demographicsSchema = z.object({
-  firstName: defaultNameString,
-  lastName: defaultNameString,
-  dob: defaultDateString,
-  genderAtBirth: genderAtBirthSchema,
-  personalIdentifiers: z.array(personalIdentifierSchema).optional(),
-  address: z.array(addressSchema).or(addressSchema),
-  contact: z.array(contactSchema).optional().or(contactSchema.optional()),
-});
-export type Demographics = z.infer<typeof demographicsSchema>;