@oystehr/sdk 3.0.0

package/src/resources/types/DeveloperUpdateParams.ts

@@ -0,0 +1,12 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { AccessPolicy } from './AccessPolicy';
+
+export interface DeveloperUpdateParams {
+  /**
+   * A list of ids of roles to be assigned to the developer.
+   */
+  roles?: string[];
+  accessPolicy?: AccessPolicy;
+  id: string;
+}

package/src/resources/types/DeveloperUpdateResponse.ts

@@ -0,0 +1,7 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { Developer } from './Developer';
+/**
+ * Developer Updated
+ */
+export type DeveloperUpdateResponse = Developer;

package/src/resources/types/ErxAllergySearchParams.ts

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

package/src/resources/types/ErxAllergySearchResponse.ts

@@ -0,0 +1,21 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+/**
+ * Allergens
+ */
+export interface ErxAllergySearchResponse {
+  allergens?: {
+    /**
+     * The Photon identifier for the allergen.
+     */
+    id?: string;
+    /**
+     * Human readible name of allergen.
+     */
+    name?: string;
+    /**
+     * RxNorm Concept Unique (RxCUI) identifier of allergen.
+     */
+    rxcui?: string;
+  }[];
+}

package/src/resources/types/ErxMedicationSearchParams.ts

@@ -0,0 +1,8 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface ErxMedicationSearchParams {
+  name?: string;
+  code?: string;
+  after?: string;
+  first?: number;
+}

package/src/resources/types/ErxMedicationSearchResponse.ts

@@ -0,0 +1,40 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+/**
+ * Medications
+ */
+export interface ErxMedicationSearchResponse {
+  medications?: {
+    /**
+     * The Photon identifier for the medication.
+     */
+    id: string;
+    /**
+     * Human readible name of medication.
+     */
+    name: string;
+    codes: {
+      /**
+       * RxNorm Concept Unique (RxCUI) identifier of medication.
+       */
+      rxcui?: string | null;
+      productNDC?: string | null;
+      packageNDC?: string | null;
+      SKU?: string | null;
+      HCPCS?: string | null;
+    };
+    /**
+     * Null implies a medication can not be prescribed
+     */
+    type?: string | null;
+    concept: string;
+    schedule?: string | null;
+    controlled: boolean;
+    brandName?: string | null;
+    genericName?: string | null;
+    strength?: string | null;
+    form?: string | null;
+    manufacturer?: string | null;
+    description?: string | null;
+  }[];
+}

package/src/resources/types/ErxSyncPatientParams.ts

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

package/src/resources/types/ErxSyncPatientResponse.ts

@@ -0,0 +1,11 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+/**
+ * Photon sync response
+ */
+export interface ErxSyncPatientResponse {
+  /**
+   * The Photon identifier for the patient.
+   */
+  photonPatientId?: string;
+}

package/src/resources/types/M2m.ts

@@ -0,0 +1,33 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { AccessPolicy } from './AccessPolicy';
+import { RoleStub } from './RoleStub';
+
+export interface M2m {
+  id: string;
+  /**
+   * The OAuth 2.0 client identifier for the M2M Client. Use this, combined with the client secret (from the `rotate-secret` endpoint), to authenticate with the OAuth 2.0 client credentials flow and receive an access token.
+   */
+  clientId: string;
+  /**
+   * Reference to the FHIR Device resource that represents the M2M Client in the FHIR store.
+   */
+  profile: string;
+  /**
+   * An URL of JWK set used for getting an access token by signed authentication JWT
+   */
+  jwksUrl?: string;
+  /**
+   * A name for the M2M Client to help you differentiate it from other M2M Clients in the project.
+   */
+  name: string;
+  /**
+   * A description of the M2M Client to help you differentiate it from other M2M Clients in the project.
+   */
+  description?: string;
+  accessPolicy?: AccessPolicy;
+  /**
+   * A list of roles assigned to this M2M Client
+   */
+  roles: RoleStub[];
+}

package/src/resources/types/M2mCreateParams.ts

@@ -0,0 +1,23 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { AccessPolicy } from './AccessPolicy';
+
+export interface M2mCreateParams {
+  /**
+   * A name for the M2M Client to help you differentiate it from other M2M Clients in the project.
+   */
+  name: string;
+  /**
+   * A description of the M2M Client to help you differentiate it from other M2M Clients in the project.
+   */
+  description: string;
+  accessPolicy?: AccessPolicy;
+  /**
+   * A list of Role IDs to assign to the M2M client. If the accessPolicy property is not provided this property is required and may not be empty.
+   */
+  roles?: string[];
+  /**
+   * An URL of JWK set used for getting an access token by signed authentication JWT
+   */
+  jwksUrl?: string;
+}

package/src/resources/types/M2mCreateResponse.ts

@@ -0,0 +1,7 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { M2m } from './M2m';
+/**
+ * M2M created
+ */
+export type M2mCreateResponse = M2m;

package/src/resources/types/M2mDeleteParams.ts

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

package/src/resources/types/M2mGetParams.ts

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

package/src/resources/types/M2mGetResponse.ts

@@ -0,0 +1,7 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { M2m } from './M2m';
+/**
+ * M2M Client
+ */
+export type M2mGetResponse = M2m;

package/src/resources/types/M2mListItem.ts

@@ -0,0 +1,28 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { AccessPolicy } from './AccessPolicy';
+
+export interface M2mListItem {
+  id: string;
+  /**
+   * The OAuth 2.0 client identifier for the M2M Client. Use this, combined with the client secret (from the `rotate-secret` endpoint), to authenticate with the OAuth 2.0 client credentials flow and receive an access token.
+   */
+  clientId: string;
+  /**
+   * Reference to the FHIR Device resource that represents the M2M Client in the FHIR store.
+   */
+  profile: string;
+  /**
+   * An URL of JWK set used for getting an access token by signed authentication JWT
+   */
+  jwksUrl?: string;
+  /**
+   * A name for the M2M Client to help you differentiate it from other M2M Clients in the project.
+   */
+  name: string;
+  /**
+   * A description of the M2M Client to help you differentiate it from other M2M Clients in the project.
+   */
+  description?: string;
+  accessPolicy?: AccessPolicy;
+}

package/src/resources/types/M2mListResponse.ts

@@ -0,0 +1,7 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { M2mListItem } from './M2mListItem';
+/**
+ * List of M2M clients
+ */
+export type M2mListResponse = M2mListItem[];

package/src/resources/types/M2mListV2Params.ts

@@ -0,0 +1,12 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface M2mListV2Params {
+  name?: string;
+  id?: string;
+  profile?: string;
+  roleId?: string;
+  cursor?: string;
+  limit?: number;
+  sort?: string;
+  sortOrder?: string;
+}

package/src/resources/types/M2mListV2Response.ts

@@ -0,0 +1,18 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { M2mListItem } from './M2mListItem';
+/**
+ * List of all M2M clients with pagination details.
+ */
+export interface M2mListV2Response {
+  /**
+   * An array of M2M Client objects. This array is empty if no M2M Clients match the query criteria.
+   */
+  data: M2mListItem[];
+  metadata: {
+    /**
+     * Cursor to fetch the next page of results. Null if there are no further pages.
+     */
+    nextCursor: string | null;
+  };
+}

package/src/resources/types/M2mRotateSecretParams.ts

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

package/src/resources/types/M2mRotateSecretResponse.ts

@@ -0,0 +1,8 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+/**
+ * M2M Client secret rotated
+ */
+export interface M2mRotateSecretResponse {
+  secret?: string;
+}

package/src/resources/types/M2mUpdateParams.ts

@@ -0,0 +1,24 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { AccessPolicy } from './AccessPolicy';
+
+export interface M2mUpdateParams {
+  /**
+   * A name for the M2M Client to help you differentiate it from other M2M Clients in the project.
+   */
+  name?: string;
+  /**
+   * A description of the M2M Client to help you differentiate it from other M2M Clients in the project.
+   */
+  description?: string;
+  accessPolicy?: AccessPolicy;
+  /**
+   * A list of Role IDs to assign to the M2M client. If the accessPolicy property is not provided this property is required and may not be empty.
+   */
+  roles?: string[];
+  /**
+   * An URL of JWK set used for getting an access token by signed authentication JWT
+   */
+  jwksUrl?: string;
+  id: string;
+}

package/src/resources/types/M2mUpdateResponse.ts

@@ -0,0 +1,7 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { M2m } from './M2m';
+/**
+ * M2M Updated
+ */
+export type M2mUpdateResponse = M2m;

package/src/resources/types/MessagingGetMessagingConfigResponse.ts

@@ -0,0 +1,10 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { MessagingServiceInfo } from './MessagingServiceInfo';
+/**
+ * Successfully returned a Messaging Services configuration.
+ */
+export interface MessagingGetMessagingConfigResponse {
+  conversationConfig?: MessagingServiceInfo;
+  transactionalSMSConfig?: MessagingServiceInfo;
+}

package/src/resources/types/MessagingServiceInfo.ts

@@ -0,0 +1,16 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface MessagingServiceInfo {
+  /**
+   * A phone number that is used by service.
+   */
+  phoneNumber?: string;
+  /**
+   * A type of the used phone number. Can be Toll-Free or 10DLC.
+   */
+  phoneNumberType?: string;
+  /**
+   * Represents an information about limits of sending messages per certain amount of time.
+   */
+  rateLimits?: string;
+}

package/src/resources/types/PaymentMethodDeleteParams.ts

@@ -0,0 +1,18 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface PaymentMethodDeleteParams {
+  /**
+   * An ID reference to a FHIR Patient resource who is the beneficiary, in the format: `some-uuid`.
+   */
+  beneficiaryPatientId: string;
+  /**
+   * An ID reference to a FHIR Patient resource who is the payor, in the format: `some-uuid`.
+   *
+   * If not specified, beneficiary is also assumed to be the payor.
+   */
+  payorPatientId?: string;
+  /**
+   * An ID reference to a payment method: `pm_someAlphaNumbericId`.
+   */
+  paymentMethodId: string;
+}

package/src/resources/types/PaymentMethodListParams.ts

@@ -0,0 +1,14 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface PaymentMethodListParams {
+  /**
+   * An ID reference to a FHIR Patient resource who is the beneficiary, in the format: `some-uuid`.
+   */
+  beneficiaryPatientId: string;
+  /**
+   * An ID reference to a FHIR Patient resource who is the payor, in the format: `some-uuid`.
+   *
+   * If not specified, beneficiary is also assumed to be the payor.
+   */
+  payorPatientId?: string;
+}

package/src/resources/types/PaymentMethodListResponse.ts

@@ -0,0 +1,10 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { CardIdentifier } from './CardIdentifier';
+/**
+ * List of payment methods for the user, including the default.
+ */
+export interface PaymentMethodListResponse {
+  cards?: CardIdentifier[];
+  default?: CardIdentifier;
+}

package/src/resources/types/PaymentMethodSetDefaultParams.ts

@@ -0,0 +1,18 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface PaymentMethodSetDefaultParams {
+  /**
+   * An ID reference to a FHIR Patient resource who is the beneficiary, in the format: `some-uuid`.
+   */
+  beneficiaryPatientId: string;
+  /**
+   * An ID reference to a FHIR Patient resource who is the payor, in the format: `some-uuid`.
+   *
+   * If not specified, beneficiary is also assumed to be the payor.
+   */
+  payorPatientId?: string;
+  /**
+   * An ID reference to a payment method: `pm_someAlphaNumbericId`.
+   */
+  paymentMethodId: string;
+}

package/src/resources/types/PaymentMethodSetUpParams.ts

@@ -0,0 +1,14 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface PaymentMethodSetUpParams {
+  /**
+   * An ID reference to a FHIR Patient resource who is the beneficiary, in the format: `some-uuid`.
+   */
+  beneficiaryPatientId: string;
+  /**
+   * An ID reference to a FHIR Patient resource who is the payor, in the format: `some-uuid`.
+   *
+   * If not specified, beneficiary is also assumed to be the payor.
+   */
+  payorPatientId?: string;
+}

package/src/resources/types/PaymentMethodSetUpResponse.ts

@@ -0,0 +1,11 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+/**
+ * Successfully requested a payment method setup.
+ */
+export interface PaymentMethodSetUpResponse {
+  /**
+   * Client secret for registering a payment method for the payor.
+   */
+  clientSecret?: string;
+}

package/src/resources/types/Project.ts

@@ -0,0 +1,20 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { RoleStub } from './RoleStub';
+
+export interface Project {
+  id: string;
+  name: string;
+  description: string;
+  /**
+   * Allows users to self-register to applications in this project.
+   */
+  signupEnabled: boolean;
+  /**
+   * Indicates whether the project is in sandbox mode - currently for testing eRx features without affecting real medical services.
+   */
+  sandbox: boolean;
+  defaultPatientRole?: RoleStub;
+  defaultSSOUserRole?: RoleStub;
+  fhirVersion: string;
+}

package/src/resources/types/ProjectGetResponse.ts

@@ -0,0 +1,7 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { Project } from './Project';
+/**
+ * Project settings
+ */
+export type ProjectGetResponse = Project;

package/src/resources/types/ProjectUpdateParams.ts

@@ -0,0 +1,18 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface ProjectUpdateParams {
+  name?: string;
+  description?: string;
+  /**
+   * Allows users to self-register to applications in this project.
+   */
+  signupEnabled?: boolean;
+  /**
+   * The id of a role that will be assigned to self-registering users of the project's applications.
+   */
+  defaultPatientRoleId?: string | null;
+  /**
+   * The id of a role that will be assigned to users who authenticate using your SSO identity provider.
+   */
+  defaultSSOUserRoleId?: string | null;
+}

package/src/resources/types/ProjectUpdateResponse.ts

@@ -0,0 +1,7 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { Project } from './Project';
+/**
+ * Project information updated
+ */
+export type ProjectUpdateResponse = Project;

package/src/resources/types/RcmEligibilityCheckParams.ts

@@ -0,0 +1,8 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+export interface RcmEligibilityCheckParams {
+  /**
+   * Identifier of the CoverageEligibilityRequest that the eligibility check will reference.
+   */
+  eligibilityRequestId?: string;
+}

package/src/resources/types/RcmEligibilityCheckResponse.ts

@@ -0,0 +1,7 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { CoverageEligibilityResponse } from 'fhir/r4b';
+/**
+ * A valid FHIR CoverageEligibilityResponse object will be returned with details on the eligibility result.
+ */
+export type RcmEligibilityCheckResponse = CoverageEligibilityResponse;

package/src/resources/types/RcmSubmitProfessionalClaimParams.ts

@@ -0,0 +1,13 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { ClaimCMS1500 } from './ClaimCMS1500';
+
+export interface RcmSubmitProfessionalClaimParams {
+  /**
+   * Enabling testMode will perform a dry run of claim submission. The claim will not be sent to payers, but the request processing and response will remain the same.
+   */
+  testMode?: boolean;
+  cms1500: ClaimCMS1500;
+  submitterOrganizationName: string;
+  payerId: string;
+}

package/src/resources/types/RcmSubmitProfessionalClaimResponse.ts

@@ -0,0 +1,7 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { Claim } from 'fhir/r4b';
+/**
+ * A valid FHIR Claim object will be returned with details on the claim submission result.
+ */
+export type RcmSubmitProfessionalClaimResponse = Claim;

package/src/resources/types/RcmValidateProfessionalClaimParams.ts

@@ -0,0 +1,9 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { ClaimCMS1500 } from './ClaimCMS1500';
+
+export interface RcmValidateProfessionalClaimParams {
+  cms1500: ClaimCMS1500;
+  submitterOrganizationName: string;
+  payerId: string;
+}

package/src/resources/types/RcmValidateProfessionalClaimResponse.ts

@@ -0,0 +1,23 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+/**
+ * Claim validation result.
+ */
+export interface RcmValidateProfessionalClaimResponse {
+  errors?: {
+    field?: string;
+    value?: string;
+    code?: string;
+    description?: string;
+    followupAction?: string;
+    location?: string;
+  }[];
+  meta?: {
+    submitterId?: string;
+    senderId?: string;
+    billerId?: string;
+    traceId?: string;
+    applicationMode?: string;
+  };
+  editStatus?: string;
+}

package/src/resources/types/Role.ts

@@ -0,0 +1,19 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { AccessPolicy } from './AccessPolicy';
+
+export interface Role {
+  /**
+   * The unique id of the role
+   */
+  id: string;
+  /**
+   * The name of the role.
+   */
+  name: string;
+  /**
+   * A description of the Role to help you differentiate it from other Roles in the project.
+   */
+  description?: string;
+  accessPolicy: AccessPolicy;
+}

package/src/resources/types/RoleCreateParams.ts

@@ -0,0 +1,15 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { AccessPolicy } from './AccessPolicy';
+
+export interface RoleCreateParams {
+  /**
+   * The name of the role.
+   */
+  name: string;
+  /**
+   * A description of the Role to help you differentiate it from other Roles in the project.
+   */
+  description?: string;
+  accessPolicy?: AccessPolicy;
+}

package/src/resources/types/RoleCreateResponse.ts

@@ -0,0 +1,7 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { Role } from './Role';
+/**
+ * Successfully created a new role.
+ */
+export type RoleCreateResponse = Role;

package/src/resources/types/RoleDeleteParams.ts

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

package/src/resources/types/RoleGetParams.ts

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

package/src/resources/types/RoleGetResponse.ts

@@ -0,0 +1,7 @@
+// AUTOGENERATED -- DO NOT EDIT
+
+import { Role } from './Role';
+/**
+ * Role with a map of Users, Developers, and M2M Clients assigned the Role.
+ */
+export type RoleGetResponse = Role;