@oystehr/sdk 3.0.0

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

@@ -0,0 +1,59 @@
+export interface ApplicationUpdateParams {
+    /**
+     * The name of the Application. This value is displayed to end users on the hosted login screen.
+     */
+    name?: string;
+    /**
+     * The Application's OAuth 2.0 client identifier.
+     */
+    clientId?: string;
+    /**
+     * A description of the application to help you differentiate it from other applications in the project. This value is not displayed to end users.
+     */
+    description?: string;
+    /**
+     * When a user accesses the hosted login screen directly instead of being redirected to it from your application, Oystehr detects this condition and redirects the user to the loginRedirectUri to get them back on track. The loginRedirectUri must be a route in your application that redirects to the 'https://auth.zapehr.com/authorize' endpoint. This typically looks like, 'https://example.com/login'.
+     */
+    loginRedirectUri?: string;
+    /**
+     * When true, users can authenticate to the Application with their email address.
+     */
+    loginWithEmailEnabled?: boolean;
+    /**
+     * The list of allowed callback URLs for the Application. When a user completes authentication on the hosted login screen, they are redirected back to the app that prompted the authentication. Because the callback URL can be tampered with, as a security measure, Oystehr only redirects to callback URLs which are listed here. allowedCallbackUrls may be an empty array.
+     */
+    allowedCallbackUrls?: string[];
+    /**
+     * The list of allowed logout URLs for the Application. After a logout is completed, a user will be redirected to a URL specified with the logout request.  Because the logout redirect URL can be tampered with, as a security measure, Oystehr only redirects to logout redirect URLs which are listed here. allowedLogoutUrls may be an empty array.
+     */
+    allowedLogoutUrls?: string[];
+    /**
+     * The list of allowed web origins URLs for the Application. Any domain that needs to be able to initiate a login must be listed here. These URLs must not include any path or query strings (e.g. 'https://docs.oystehr.com'). An asterisk may be used as a wildcard placeholder for subdomains (e.g. https://*.oystehr.com). allowedWebOriginsUrls may be an empty array.
+     */
+    allowedWebOriginsUrls?: string[];
+    /**
+     * The allowed CORS origins urls for the Application. Any domain that needs to be able to make requests from browser JavaScript to our identity provider APIs must be listed here. These URLs must not include any path or query strings (e.g. 'https://docs.oystehr.com'). By default, all domains from `allowedCallbackUrls` are allowed. allowedCORSOriginsUrls may be an empty array.
+     */
+    allowedCORSOriginsUrls?: string[];
+    /**
+     * When true, users can authenticate to the Application with 'passwordless SMS'. With passwordless SMS, users enter their phone number and receive a one-time code via SMS to authenticate. Users enter the code on the login screen to complete authentication.
+     */
+    passwordlessSMS?: boolean;
+    /**
+     * When true, users will be prompted to enter a code from A TOTP-MFA application after they authenticate with their first form of authentication.
+     */
+    mfaEnabled?: boolean;
+    /**
+     * When true, an invitation email is automatically sent to users who are invited to the Application. This email contains Oystehr branding, so it is recommended to set this to 'false' and send your own invitation email for production use.
+     */
+    shouldSendInviteEmail?: boolean;
+    /**
+     * The URL of your application's logo. This logo is displayed on the hosted login screen. The recommended size for this asset is 150px x 150px.
+     */
+    logoUri?: string;
+    /**
+     * When true, a refresh token will be provided to a user during authorization.
+     */
+    refreshTokenEnabled?: boolean;
+    id: string;
+}

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

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

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

@@ -0,0 +1,8 @@
+export interface Card {
+    id?: string;
+    brand: string;
+    expirationMonth: number;
+    expirationYear: number;
+    lastFour: string;
+    cardHolder?: string;
+}

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

@@ -0,0 +1,7 @@
+export interface CardIdentifier {
+    id: string;
+    brand: string;
+    exp_month: number;
+    exp_year: number;
+    last_four: string;
+}

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

@@ -0,0 +1,8 @@
+import { Card } from './Card';
+export interface ChargeDetails {
+    chargeUuid: string;
+    currency: string;
+    amount: number;
+    date: string;
+    card: Card;
+}

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

@@ -0,0 +1,6 @@
+export interface ChargeIssueParams {
+    /**
+     * An ID reference to a FHIR Encounter resource in the format: `some-uuid`.
+     */
+    encounterId?: string;
+}

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

@@ -0,0 +1,6 @@
+export interface ChargeStatusParams {
+    /**
+     * An ID reference to a FHIR Encounter resource in the format: `some-uuid`.
+     */
+    encounterId?: string;
+}

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

@@ -0,0 +1,5 @@
+import { ChargeDetails } from './ChargeDetails';
+/**
+ * Retrieve charge status for the specified encounter based on FHIR Encounter ID and an associated Charge Item.
+ */
+export type ChargeStatusResponse = ChargeDetails;

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

@@ -0,0 +1,7 @@
+export interface ClaimAddress {
+    line: string;
+    city: string;
+    state: string;
+    zipCode: string;
+    telephone?: string | null;
+}

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

@@ -0,0 +1,100 @@
+import { ClaimAddress } from './ClaimAddress';
+import { ClaimDate } from './ClaimDate';
+import { ClaimDatePeriod } from './ClaimDatePeriod';
+import { ClaimDateWithQualifier } from './ClaimDateWithQualifier';
+import { ClaimId } from './ClaimId';
+import { ClaimName } from './ClaimName';
+export interface ClaimCMS1500 {
+    _1_insuranceProgram: string;
+    _1a_insuredIdNumber: string;
+    _2_patientName: ClaimName;
+    _3_patientBirthDate: ClaimDate;
+    _3_patientSex: string;
+    _4_insuredName?: ClaimName;
+    _5_patientAddress: ClaimAddress;
+    _6_patientRelationshipToInsured?: string;
+    _7_insuredAddress?: ClaimAddress;
+    _9_otherInsuredName?: ClaimName;
+    _9a_otherInsuredPolicyOrGroupNumber?: string;
+    _9d_otherInsuredInsurancePlanNameOrProgramName?: string;
+    _10_patientConditionRelations?: {
+        _a_employment?: boolean;
+        _b_autoAccident?: boolean;
+        _b_autoAccidentState?: string;
+        _c_otherAccident?: boolean;
+    };
+    _10d_claimCodes?: string[];
+    _11_insuredPolicyGroupOrFecaNumber?: string;
+    _11a_insuredDateOfBirth?: ClaimDate;
+    _11a_insuredSex?: string;
+    _11b_otherClaimId?: string;
+    _11c_insurancePlanNameOrProgramName?: string;
+    _11d_anotherHealthBenefitPlan: boolean;
+    _12_patientSignedDate?: ClaimDate;
+    _14_dateOfCurrentIllness?: ClaimDateWithQualifier;
+    _15_otherDate?: ClaimDateWithQualifier;
+    _16_patientUnableToWorkPeriod?: ClaimDatePeriod;
+    _17_referringProvider: {
+        qualifier: string;
+        name: ClaimName;
+        _a_otherId?: ClaimId;
+        _b_npiId: string;
+    };
+    _18_hospitalizationDates?: ClaimDatePeriod;
+    _19_additionalClaimInformation?: string;
+    _20_outsideLab?: {
+        purchased?: boolean;
+        charges?: number;
+    };
+    _21_diagnosis: {
+        icdIndicator: string;
+        codes: string[];
+    };
+    _22_resubmission?: {
+        code: string;
+        originalReferenceNumber: string;
+    };
+    _23_priorAuthorizationNumber?: string;
+    _24_services: {
+        _a_datesOfService: ClaimDatePeriod;
+        _b_placeOfService: string;
+        _c_emergency?: boolean;
+        _d_procedures: {
+            cptOrHcpcs: string;
+            modifiers?: string[];
+        };
+        _e_diagnosisPointer: string;
+        _f_charges: number;
+        _g_daysOrUnits: number;
+        _h_epsdtAndFamilyPlan?: {
+            epsdt?: string;
+            familyPlan?: boolean;
+        };
+        _j_renderingProviderId: {
+            otherId?: ClaimId;
+            npiId: string;
+        };
+        supplementalInformation?: string;
+    }[];
+    _25_federalTaxIdNumber: {
+        value: string;
+        type: string;
+    };
+    _26_patientAccountNumber?: string;
+    _27_acceptAssignment?: boolean;
+    _28_totalCharge: number;
+    _29_amountPaid?: number;
+    _31_physicianSignedDate: ClaimDate;
+    _32_serviceFacilityLocationInfo: {
+        name: string;
+        address: ClaimAddress;
+        _a_npiId?: string;
+        _b_otherId?: ClaimId;
+    };
+    _33_billingProviderInfoAndPhone: {
+        name: string;
+        address: ClaimAddress;
+        _a_npiId: string;
+        _b_otherId?: ClaimId;
+    };
+}

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

@@ -0,0 +1,5 @@
+export interface ClaimDate {
+    day: string;
+    month: string;
+    year: string;
+}

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

@@ -0,0 +1,5 @@
+import { ClaimDate } from './ClaimDate';
+export interface ClaimDatePeriod {
+    from: ClaimDate;
+    to?: ClaimDate;
+}

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

@@ -0,0 +1,5 @@
+import { ClaimDate } from './ClaimDate';
+export interface ClaimDateWithQualifier {
+    date: ClaimDate;
+    qualifier: string;
+}

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

@@ -0,0 +1,4 @@
+export interface ClaimId {
+    qualifier: string;
+    value: string;
+}

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

@@ -0,0 +1,6 @@
+export interface ClaimName {
+    firstName: string;
+    lastName: string;
+    middleName?: string | null;
+    suffix?: string | null;
+}

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

@@ -0,0 +1,21 @@
+export interface ConversationAddParticipantParams {
+    /**
+     * 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;
+    participants: {
+        /**
+         * A valid FHIR Patient, RelatedPerson, or Practitioner relative reference in the format: `Patient/some-uuid`, `RelatedPerson/some-uuid`, or `Practitioner/some-uuid`. Each participantReference must be present in `Encounter.participant` for the Encounter specified in `encounterReference`.
+         */
+        participantReference: string;
+        /**
+         * 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;
+        /**
+         * The phone number of the participant. Required if `channel` is `sms`.
+         */
+        phoneNumber?: string;
+    }[];
+    conversationId: string;
+}

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

@@ -0,0 +1,7 @@
+import { Encounter } from 'fhir/r4b';
+export interface ConversationCreateParams {
+    /**
+     * A valid FHIR Encounter resource JSON object. This resource will be created to represent the Conversation in the FHIR Store.
+     */
+    encounter: Encounter;
+}

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

@@ -0,0 +1,10 @@
+import { Encounter } from 'fhir/r4b';
+/**
+ * Successfully created a Conversation.
+ */
+export interface ConversationCreateResponse {
+    /**
+     * The FHIR Encounter resource that represents the Conversation in the FHIR Store modified to include the https://extensions.fhir.zapehr.com/encounter-virtual-service-pre-release extension which holds the Twilio Conversation SID.
+     */
+    encounter: Encounter;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * Successfully returned a Conversation Token for the caller.
+ */
+export interface ConversationGetTokenResponse {
+    /**
+     * A Twilio Conversations access token scoped to the identity of the caller. This token can be used to join the Conversation via the Twilio Conversations SDK.
+     */
+    token: string;
+}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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