@oystehr/sdk 3.0.0

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

@@ -0,0 +1,3 @@
+export interface M2mGetParams {
+    id: string;
+}

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

@@ -0,0 +1,5 @@
+import { M2m } from './M2m';
+/**
+ * M2M Client
+ */
+export type M2mGetResponse = M2m;

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

@@ -0,0 +1,25 @@
+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/dist/esm/resources/types/M2mListResponse.d.ts

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

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

@@ -0,0 +1,10 @@
+export interface M2mListV2Params {
+    name?: string;
+    id?: string;
+    profile?: string;
+    roleId?: string;
+    cursor?: string;
+    limit?: number;
+    sort?: string;
+    sortOrder?: string;
+}

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

@@ -0,0 +1,16 @@
+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/dist/esm/resources/types/M2mRotateSecretParams.d.ts

@@ -0,0 +1,3 @@
+export interface M2mRotateSecretParams {
+    id: string;
+}

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

@@ -0,0 +1,6 @@
+/**
+ * M2M Client secret rotated
+ */
+export interface M2mRotateSecretResponse {
+    secret?: string;
+}

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

@@ -0,0 +1,21 @@
+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/dist/esm/resources/types/M2mUpdateResponse.d.ts

@@ -0,0 +1,5 @@
+import { M2m } from './M2m';
+/**
+ * M2M Updated
+ */
+export type M2mUpdateResponse = M2m;

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

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

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

@@ -0,0 +1,14 @@
+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/dist/esm/resources/types/PaymentMethodDeleteParams.d.ts

@@ -0,0 +1,16 @@
+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/dist/esm/resources/types/PaymentMethodListParams.d.ts

@@ -0,0 +1,12 @@
+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/dist/esm/resources/types/PaymentMethodListResponse.d.ts

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

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

@@ -0,0 +1,16 @@
+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/dist/esm/resources/types/PaymentMethodSetUpParams.d.ts

@@ -0,0 +1,12 @@
+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/dist/esm/resources/types/PaymentMethodSetUpResponse.d.ts

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

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

@@ -0,0 +1,17 @@
+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/dist/esm/resources/types/ProjectGetResponse.d.ts

@@ -0,0 +1,5 @@
+import { Project } from './Project';
+/**
+ * Project settings
+ */
+export type ProjectGetResponse = Project;

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

@@ -0,0 +1,16 @@
+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/dist/esm/resources/types/ProjectUpdateResponse.d.ts

@@ -0,0 +1,5 @@
+import { Project } from './Project';
+/**
+ * Project information updated
+ */
+export type ProjectUpdateResponse = Project;

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

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

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

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

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

@@ -0,0 +1,10 @@
+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/dist/esm/resources/types/RcmSubmitProfessionalClaimResponse.d.ts

@@ -0,0 +1,5 @@
+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/dist/esm/resources/types/RcmValidateProfessionalClaimParams.d.ts

@@ -0,0 +1,6 @@
+import { ClaimCMS1500 } from './ClaimCMS1500';
+export interface RcmValidateProfessionalClaimParams {
+    cms1500: ClaimCMS1500;
+    submitterOrganizationName: string;
+    payerId: string;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * 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/dist/esm/resources/types/Role.d.ts

@@ -0,0 +1,16 @@
+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/dist/esm/resources/types/RoleCreateParams.d.ts

@@ -0,0 +1,12 @@
+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/dist/esm/resources/types/RoleCreateResponse.d.ts

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

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

@@ -0,0 +1,3 @@
+export interface RoleDeleteParams {
+    roleId: string;
+}

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

@@ -0,0 +1,3 @@
+export interface RoleGetParams {
+    roleId: string;
+}

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

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

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

@@ -0,0 +1,14 @@
+export interface RoleListItem {
+    /**
+     * The unique id of the role
+     */
+    id: string;
+    /**
+     * The name of the role.
+     */
+    name: string;
+    /**
+     * The number of users, developers, and M2M Clients that have this role.
+     */
+    memberCount: number;
+}

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

@@ -0,0 +1,5 @@
+import { RoleListItem } from './RoleListItem';
+/**
+ * List of all Roles in the project.
+ */
+export type RoleListResponse = RoleListItem[];

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

@@ -0,0 +1,10 @@
+export interface RoleStub {
+    /**
+     * The unique id of the role
+     */
+    id: string;
+    /**
+     * The name of the role.
+     */
+    name: string;
+}

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

@@ -0,0 +1,17 @@
+import { AccessPolicy } from './AccessPolicy';
+export interface RoleUpdateParams {
+    /**
+     * 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;
+    roleId: string;
+}

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

@@ -0,0 +1,5 @@
+import { Role } from './Role';
+/**
+ * Role Updated
+ */
+export type RoleUpdateResponse = Role;

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

@@ -0,0 +1,10 @@
+export interface Secret {
+    /**
+     * A name for the secret used to identify it for use in Zambda Functions. May contain letters, numbers, dashes, and underscores.
+     */
+    name: string;
+    /**
+     * The secret value. Common examples include M2M Client credentials used to call Oystehr APIs, and third-party API keys used to integrate with external systems.
+     */
+    value: string;
+}

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

@@ -0,0 +1,3 @@
+export interface SecretDeleteParams {
+    name: string;
+}

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

@@ -0,0 +1,3 @@
+export interface SecretGetParams {
+    name: string;
+}

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

@@ -0,0 +1,5 @@
+import { Secret } from './Secret';
+/**
+ * The secret was fetched successfully.
+ */
+export type SecretGetResponse = Secret;

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

@@ -0,0 +1,6 @@
+export interface SecretListItem {
+    /**
+     * A name for the secret used to identify it for use in Zambda Functions. May contain letters, numbers, dashes, and underscores.
+     */
+    name: string;
+}

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

@@ -0,0 +1,5 @@
+import { SecretListItem } from './SecretListItem';
+/**
+ * List of all Secrets in the project.
+ */
+export type SecretListResponse = SecretListItem[];

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

@@ -0,0 +1,10 @@
+export interface SecretSetParams {
+    /**
+     * A name for the secret used to identify it for use in Zambda Functions. May contain letters, numbers, dashes, and underscores.
+     */
+    name: string;
+    /**
+     * The secret value. Common examples include M2M Client credentials used to call Oystehr APIs, and third-party API keys used to integrate with external systems.
+     */
+    value: string;
+}

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

@@ -0,0 +1,5 @@
+import { Secret } from './Secret';
+/**
+ * Secret created, or if secret is already defined, secret is updated.
+ */
+export type SecretSetResponse = Secret;

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

@@ -0,0 +1,7 @@
+import { Encounter } from 'fhir/r4b';
+export interface TelemedCreateMeetingParams {
+    /**
+     * Well formed Encounter with the https://extensions.fhir.zapehr.com/encounter-other-participants extension specified optionally.
+     */
+    encounter?: Encounter;
+}

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

@@ -0,0 +1,10 @@
+import { Encounter } from 'fhir/r4b';
+/**
+ * Successfully created a telemed meeting.
+ */
+export interface TelemedCreateMeetingResponse {
+    /**
+     * Returns well formed Encounter with video meeting information in the https://extensions.fhir.zapehr.com/encounter-virtual-service-pre-release extension.
+     */
+    encounter?: Encounter;
+}

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

@@ -0,0 +1,4 @@
+export interface TelemedJoinMeetingParams {
+    encounterId: string;
+    anonymous?: boolean;
+}

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

@@ -0,0 +1,27 @@
+/**
+ * Meeting and Attendee objects for joining a video meeting returned successfully.
+ */
+export interface TelemedJoinMeetingResponse {
+    /**
+     * The attendee object including details like AttendeeId and ExternalUserId.
+     */
+    Attendee?: {
+        /**
+         * Unique identifier for the attendee.
+         */
+        AttendeeId?: string;
+        /**
+         * External user identifier used to map to the attendee.
+         */
+        ExternalUserId?: string;
+    };
+    /**
+     * The meeting object including details necessary for joining the meeting.
+     */
+    Meeting?: {
+        /**
+         * Unique identifier for the meeting.
+         */
+        MeetingId?: string;
+    };
+}

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

@@ -0,0 +1,10 @@
+export interface TransactionalSMSSendParams {
+    /**
+     * A reference to a FHIR Patient, RelatedPerson, or Practitioner resource in the format: `Patient/some-uuid`, `RelatedPerson/some-uuid`, or `Practitioner/some-uuid`.
+     */
+    resource: string;
+    /**
+     * The message to send. Messages over 160 characters will be split into multiple SMS messages.
+     */
+    message: string;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * Successfully created a send message request. Note that this does not mean the message was sent successfully; there may be a reason the message is not sent.
+ */
+export interface TransactionalSMSSendResponse {
+    /**
+     * The UUID of the FHIR Communication resource that represents the message
+     */
+    resourceId?: string;
+}

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

@@ -0,0 +1,36 @@
+import { AccessPolicy } from './AccessPolicy';
+import { RoleStub } from './RoleStub';
+export interface User {
+    id: string;
+    /**
+     * A name for the User to help you differentiate them from other Users in the project. Defaults to the User's email or phone number if not provided.
+     */
+    name: string;
+    /**
+     * The User's email address.
+     */
+    email: string | null;
+    /**
+     * The User's phone number.
+     */
+    phoneNumber: string | null;
+    /**
+     * The name of the connection used to authenticate the User. One of: email, sms, or the name of a custom SSO connection.
+     */
+    authenticationMethod: string;
+    accessPolicy?: AccessPolicy;
+    /**
+     * ssoData contains information about the user from a third-party SSO identity provider. For example, if you send a `upn` or other information in a SAML payload, it is stored here. It is only populated if the User authenticated via SSO with a third-party identity provider.
+     */
+    ssoData?: {
+        [k: string]: any;
+    };
+    /**
+     * Reference to the FHIR resource that represents the User in the FHIR store. May be any of the following resource types: Practitioner, Patient, RelatedPerson.
+     */
+    profile: string;
+    /**
+     * The roles assigned to the User.
+     */
+    roles?: RoleStub[];
+}

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

@@ -0,0 +1,3 @@
+export interface UserDeleteParams {
+    id: string;
+}

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

@@ -0,0 +1,3 @@
+export interface UserGetParams {
+    id: string;
+}

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

@@ -0,0 +1,5 @@
+import { User } from './User';
+/**
+ * Information about a specific user
+ */
+export type UserGetResponse = User;