@oystehr/sdk 3.0.0

package/dist/cjs/resources/types/ConversationMessageParams.d.ts

@@ -0,0 +1,13 @@
+export interface ConversationMessageParams {
+    /**
+     * The message to send to the Conversation. Must be no more than 1600 characters.
+     */
+    message: string;
+    /**
+     * A string metadata field you can use to store any data you wish. This data can be retrieved by all Conversation participants. The string value must contain structurally valid JSON if specified.
+     */
+    attributes?: {
+        [k: string]: any;
+    };
+    conversationId: string;
+}

package/dist/cjs/resources/types/ConversationRemoveParticipantParams.d.ts

@@ -0,0 +1,11 @@
+export interface ConversationRemoveParticipantParams {
+    /**
+     * A valid FHIR Encounter relative reference in the format: `Encounter/some-uuid`. This reference must be a valid Encounter in the FHIR store which has the https://extensions.fhir.zapehr.com/encounter-virtual-service-pre-release extension from being created by `POST /message/conversation`.
+     */
+    encounterReference: string;
+    /**
+     * A valid FHIR profile reference in the format: for example, `Patient/some-uuid`. This reference must be a valid Patient, Practitioner, or RelatedPerson present in the FHIR store and which has been previously added to the Conversation.
+     */
+    participantReference: string;
+    conversationId: string;
+}

package/dist/cjs/resources/types/Developer.d.ts

@@ -0,0 +1,20 @@
+import { RoleStub } from './RoleStub';
+export interface Developer {
+    id: string;
+    /**
+     * The email with which the developer was invited.
+     */
+    email: string;
+    /**
+     * The developer's name. This defaults to the email with which the developer was invited.
+     */
+    name: string;
+    /**
+     * Reference to the FHIR Practitioner resource that represents the developer in the FHIR store.
+     */
+    profile: string;
+    /**
+     * The roles assigned to the User.
+     */
+    roles: RoleStub[];
+}

package/dist/cjs/resources/types/DeveloperDeleteParams.d.ts

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

package/dist/cjs/resources/types/DeveloperGetParams.d.ts

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

package/dist/cjs/resources/types/DeveloperGetResponse.d.ts

@@ -0,0 +1,5 @@
+import { Developer } from './Developer';
+/**
+ * Developer
+ */
+export type DeveloperGetResponse = Developer;

package/dist/cjs/resources/types/DeveloperInviteParams.d.ts

@@ -0,0 +1,17 @@
+import { Practitioner } from 'fhir/r4b';
+import { AccessPolicy } from './AccessPolicy';
+export interface DeveloperInviteParams {
+    /**
+     * The email with which the developer was invited.
+     */
+    email: string;
+    /**
+     * A valid FHIR Practitioner Resource JSON object. The FHIR Practitioner resource will be created to represent the developer in the FHIR store.
+     */
+    practitioner: Practitioner;
+    /**
+     * A list of ids of roles to be assigned to the developer.
+     */
+    roles?: string[];
+    accessPolicy?: AccessPolicy;
+}

package/dist/cjs/resources/types/DeveloperInviteResponse.d.ts

@@ -0,0 +1,23 @@
+import { RoleStub } from './RoleStub';
+/**
+ * Successfully invited a developer
+ */
+export interface DeveloperInviteResponse {
+    id: string;
+    /**
+     * The email with which the developer was invited.
+     */
+    email: string;
+    /**
+     * The ID of the FHIR Practitioner resource that represents the developer. Also known as the Developer's "profile".
+     */
+    practitionerId: string;
+    /**
+     * The ID of the invite
+     */
+    invitationUrl: string;
+    /**
+     * The roles assigned to the developer.
+     */
+    roles: RoleStub[];
+}

package/dist/cjs/resources/types/DeveloperListItem.d.ts

@@ -0,0 +1,7 @@
+export interface DeveloperListItem {
+    id: string;
+    /**
+     * The developer's name. This defaults to the email with which the developer was invited.
+     */
+    name: string;
+}

package/dist/cjs/resources/types/DeveloperListResponse.d.ts

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

package/dist/cjs/resources/types/DeveloperListV2Params.d.ts

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

package/dist/cjs/resources/types/DeveloperListV2Response.d.ts

@@ -0,0 +1,29 @@
+/**
+ * List of all Developers with pagination details.
+ */
+export interface DeveloperListV2Response {
+    /**
+     * An array of developer objects. This array is empty if no developers match the query criteria.
+     */
+    data: {
+        id: string;
+        /**
+         * The email with which the developer was invited.
+         */
+        email: string;
+        /**
+         * The developer's name. This defaults to the email with which the developer was invited.
+         */
+        name: string;
+        /**
+         * Reference to the FHIR Practitioner resource that represents the developer in the FHIR store.
+         */
+        profile: string;
+    }[];
+    metadata: {
+        /**
+         * Cursor to fetch the next page of results. Null if there are no further pages.
+         */
+        nextCursor: string | null;
+    };
+}

package/dist/cjs/resources/types/DeveloperUpdateParams.d.ts

@@ -0,0 +1,9 @@
+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/dist/cjs/resources/types/DeveloperUpdateResponse.d.ts

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

package/dist/cjs/resources/types/ErxAllergySearchParams.d.ts

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

package/dist/cjs/resources/types/ErxAllergySearchResponse.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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/dist/cjs/resources/types/ErxMedicationSearchParams.d.ts

@@ -0,0 +1,6 @@
+export interface ErxMedicationSearchParams {
+    name?: string;
+    code?: string;
+    after?: string;
+    first?: number;
+}

package/dist/cjs/resources/types/ErxMedicationSearchResponse.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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/dist/cjs/resources/types/ErxSyncPatientParams.d.ts

@@ -0,0 +1,3 @@
+export interface ErxSyncPatientParams {
+    patientId: string;
+}

package/dist/cjs/resources/types/ErxSyncPatientResponse.d.ts

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

package/dist/cjs/resources/types/M2m.d.ts

@@ -0,0 +1,30 @@
+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/dist/cjs/resources/types/M2mCreateParams.d.ts

@@ -0,0 +1,20 @@
+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/dist/cjs/resources/types/M2mCreateResponse.d.ts

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

package/dist/cjs/resources/types/M2mDeleteParams.d.ts

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

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

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

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

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

package/dist/cjs/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/cjs/resources/types/M2mListResponse.d.ts

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

package/dist/cjs/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/cjs/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/cjs/resources/types/M2mRotateSecretParams.d.ts

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

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

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

package/dist/cjs/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/cjs/resources/types/M2mUpdateResponse.d.ts

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

package/dist/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/resources/types/ProjectGetResponse.d.ts

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

package/dist/cjs/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/cjs/resources/types/ProjectUpdateResponse.d.ts

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

package/dist/cjs/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/cjs/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/cjs/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/cjs/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;