npm - candidhealth - Versions diffs - 0.39.4 → 0.39.6 - Mend

candidhealth 0.39.4 → 0.39.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3579) hide show

package/api/resources/preEncounter/resources/patients/resources/v1/client/Client.d.ts CHANGED Viewed

@@ -7,6 +7,8 @@ import * as CandidApi from "../../../../../../../index";
 export declare namespace V1 {
     interface Options {
         environment?: core.Supplier<environments.CandidApiEnvironment | environments.CandidApiEnvironmentUrls>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         token?: core.Supplier<core.BearerToken | undefined>;
     }
     interface RequestOptions {
@@ -16,6 +18,8 @@ export declare namespace V1 {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class V1 {
@@ -34,28 +38,28 @@ export declare class V1 {
      *             name: {
      *                 family: "string",
      *                 given: ["string"],
-     *                 use: CandidApi.preEncounter.NameUse.Usual,
+     *                 use: "USUAL",
      *                 period: {}
      *             },
      *             otherNames: [{
      *                     family: "string",
      *                     given: ["string"],
-     *                     use: CandidApi.preEncounter.NameUse.Usual,
+     *                     use: "USUAL",
      *                     period: {}
      *                 }],
-     *             gender: CandidApi.preEncounter.Gender.Man,
+     *             gender: "MAN",
      *             birthDate: "2023-01-15",
      *             socialSecurityNumber: "string",
-     *             biologicalSex: CandidApi.preEncounter.Sex.Female,
-     *             sexualOrientation: CandidApi.preEncounter.SexualOrientation.Heterosexual,
-     *             race: CandidApi.preEncounter.Race.AmericanIndianOrAlaskaNative,
-     *             ethnicity: CandidApi.preEncounter.Ethnicity.HispanicOrLatino,
-     *             disabilityStatus: CandidApi.preEncounter.DisabilityStatus.Disabled,
-     *             maritalStatus: CandidApi.preEncounter.patients.v1.MaritalStatus.Annulled,
-     *             deceased: new Date("2024-01-15T09:30:00.000Z"),
+     *             biologicalSex: "FEMALE",
+     *             sexualOrientation: "HETEROSEXUAL",
+     *             race: "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
+     *             ethnicity: "HISPANIC_OR_LATINO",
+     *             disabilityStatus: "DISABLED",
+     *             maritalStatus: "ANNULLED",
+     *             deceased: "2024-01-15T09:30:00Z",
      *             multipleBirth: 1,
      *             primaryAddress: {
-     *                 use: CandidApi.preEncounter.AddressUse.Home,
+     *                 use: "HOME",
      *                 line: ["string"],
      *                 city: "string",
      *                 state: "string",
@@ -64,7 +68,7 @@ export declare class V1 {
      *                 period: {}
      *             },
      *             otherAddresses: [{
-     *                     use: CandidApi.preEncounter.AddressUse.Home,
+     *                     use: "HOME",
      *                     line: ["string"],
      *                     city: "string",
      *                     state: "string",
@@ -74,11 +78,11 @@ export declare class V1 {
      *                 }],
      *             primaryTelecom: {
      *                 value: "string",
-     *                 use: CandidApi.preEncounter.ContactPointUse.Home
+     *                 use: "HOME"
      *             },
      *             otherTelecoms: [{
      *                     value: "string",
-     *                     use: CandidApi.preEncounter.ContactPointUse.Home
+     *                     use: "HOME"
      *                 }],
      *             email: "string",
      *             electronicCommunicationOptIn: true,
@@ -89,19 +93,19 @@ export declare class V1 {
      *                 systemName: "string"
      *             },
      *             contacts: [{
-     *                     relationship: [CandidApi.preEncounter.Relationship.Self],
+     *                     relationship: ["SELF"],
      *                     name: {
      *                         family: "string",
      *                         given: ["string"],
-     *                         use: CandidApi.preEncounter.NameUse.Usual,
+     *                         use: "USUAL",
      *                         period: {}
      *                     },
      *                     telecoms: [{
      *                             value: "string",
-     *                             use: CandidApi.preEncounter.ContactPointUse.Home
+     *                             use: "HOME"
      *                         }],
      *                     addresses: [{
-     *                             use: CandidApi.preEncounter.AddressUse.Home,
+     *                             use: "HOME",
      *                             line: ["string"],
      *                             city: "string",
      *                             state: "string",
@@ -116,14 +120,14 @@ export declare class V1 {
      *                     name: {
      *                         family: "string",
      *                         given: ["string"],
-     *                         use: CandidApi.preEncounter.NameUse.Usual,
+     *                         use: "USUAL",
      *                         period: {}
      *                     },
-     *                     type: CandidApi.preEncounter.ExternalProviderType.Primary,
+     *                     type: "PRIMARY",
      *                     npi: "string",
      *                     telecoms: [{
      *                             value: "string",
-     *                             use: CandidApi.preEncounter.ContactPointUse.Home
+     *                             use: "HOME"
      *                         }],
      *                     addresses: [],
      *                     period: {},
@@ -140,17 +144,17 @@ export declare class V1 {
      *                 name: {
      *                     family: "string",
      *                     given: ["string"],
-     *                     use: CandidApi.preEncounter.NameUse.Usual,
+     *                     use: "USUAL",
      *                     period: {}
      *                 },
      *                 telecom: {
      *                     value: "string",
-     *                     use: CandidApi.preEncounter.ContactPointUse.Home
+     *                     use: "HOME"
      *                 },
      *                 email: "string",
      *                 birthDate: "2023-01-15",
      *                 address: {
-     *                     use: CandidApi.preEncounter.AddressUse.Home,
+     *                     use: "HOME",
      *                     line: ["string"],
      *                     city: "string",
      *                     state: "string",
@@ -166,7 +170,7 @@ export declare class V1 {
      *                     additionalPayerInformation: {},
      *                     authorizationNumber: "string",
      *                     cptCode: "string",
-     *                     units: CandidApi.preEncounter.patients.v1.AuthorizationUnit.Visit,
+     *                     units: "VISIT",
      *                     quantity: 1,
      *                     period: {},
      *                     notes: "string"
@@ -176,14 +180,14 @@ export declare class V1 {
      *                         name: {
      *                             family: "string",
      *                             given: ["string"],
-     *                             use: CandidApi.preEncounter.NameUse.Usual,
+     *                             use: "USUAL",
      *                             period: {}
      *                         },
-     *                         type: CandidApi.preEncounter.ExternalProviderType.Primary,
+     *                         type: "PRIMARY",
      *                         npi: "string",
      *                         telecoms: [{
      *                                 value: "string",
-     *                                 use: CandidApi.preEncounter.ContactPointUse.Home
+     *                                 use: "HOME"
      *                             }],
      *                         addresses: [],
      *                         period: {},
@@ -192,7 +196,7 @@ export declare class V1 {
      *                     referralNumber: "string"
      *                 }],
      *             primaryServiceFacilityId: "string",
-     *             doNotInvoiceReason: CandidApi.preEncounter.patients.v1.DoNotInvoiceReason.Bankruptcy,
+     *             doNotInvoiceReason: "BANKRUPTCY",
      *             noteIds: [CandidApi.preEncounter.NoteId("string")],
      *             tagIds: [CandidApi.preEncounter.TagId("string")]
      *         }
@@ -213,28 +217,28 @@ export declare class V1 {
      *             name: {
      *                 family: "string",
      *                 given: ["string"],
-     *                 use: CandidApi.preEncounter.NameUse.Usual,
+     *                 use: "USUAL",
      *                 period: {}
      *             },
      *             otherNames: [{
      *                     family: "string",
      *                     given: ["string"],
-     *                     use: CandidApi.preEncounter.NameUse.Usual,
+     *                     use: "USUAL",
      *                     period: {}
      *                 }],
-     *             gender: CandidApi.preEncounter.Gender.Man,
+     *             gender: "MAN",
      *             birthDate: "2023-01-15",
      *             socialSecurityNumber: "string",
-     *             biologicalSex: CandidApi.preEncounter.Sex.Female,
-     *             sexualOrientation: CandidApi.preEncounter.SexualOrientation.Heterosexual,
-     *             race: CandidApi.preEncounter.Race.AmericanIndianOrAlaskaNative,
-     *             ethnicity: CandidApi.preEncounter.Ethnicity.HispanicOrLatino,
-     *             disabilityStatus: CandidApi.preEncounter.DisabilityStatus.Disabled,
-     *             maritalStatus: CandidApi.preEncounter.patients.v1.MaritalStatus.Annulled,
-     *             deceased: new Date("2024-01-15T09:30:00.000Z"),
+     *             biologicalSex: "FEMALE",
+     *             sexualOrientation: "HETEROSEXUAL",
+     *             race: "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
+     *             ethnicity: "HISPANIC_OR_LATINO",
+     *             disabilityStatus: "DISABLED",
+     *             maritalStatus: "ANNULLED",
+     *             deceased: "2024-01-15T09:30:00Z",
      *             multipleBirth: 1,
      *             primaryAddress: {
-     *                 use: CandidApi.preEncounter.AddressUse.Home,
+     *                 use: "HOME",
      *                 line: ["string"],
      *                 city: "string",
      *                 state: "string",
@@ -243,7 +247,7 @@ export declare class V1 {
      *                 period: {}
      *             },
      *             otherAddresses: [{
-     *                     use: CandidApi.preEncounter.AddressUse.Home,
+     *                     use: "HOME",
      *                     line: ["string"],
      *                     city: "string",
      *                     state: "string",
@@ -253,11 +257,11 @@ export declare class V1 {
      *                 }],
      *             primaryTelecom: {
      *                 value: "string",
-     *                 use: CandidApi.preEncounter.ContactPointUse.Home
+     *                 use: "HOME"
      *             },
      *             otherTelecoms: [{
      *                     value: "string",
-     *                     use: CandidApi.preEncounter.ContactPointUse.Home
+     *                     use: "HOME"
      *                 }],
      *             email: "string",
      *             electronicCommunicationOptIn: true,
@@ -268,19 +272,19 @@ export declare class V1 {
      *                 systemName: "string"
      *             },
      *             contacts: [{
-     *                     relationship: [CandidApi.preEncounter.Relationship.Self],
+     *                     relationship: ["SELF"],
      *                     name: {
      *                         family: "string",
      *                         given: ["string"],
-     *                         use: CandidApi.preEncounter.NameUse.Usual,
+     *                         use: "USUAL",
      *                         period: {}
      *                     },
      *                     telecoms: [{
      *                             value: "string",
-     *                             use: CandidApi.preEncounter.ContactPointUse.Home
+     *                             use: "HOME"
      *                         }],
      *                     addresses: [{
-     *                             use: CandidApi.preEncounter.AddressUse.Home,
+     *                             use: "HOME",
      *                             line: ["string"],
      *                             city: "string",
      *                             state: "string",
@@ -295,14 +299,14 @@ export declare class V1 {
      *                     name: {
      *                         family: "string",
      *                         given: ["string"],
-     *                         use: CandidApi.preEncounter.NameUse.Usual,
+     *                         use: "USUAL",
      *                         period: {}
      *                     },
-     *                     type: CandidApi.preEncounter.ExternalProviderType.Primary,
+     *                     type: "PRIMARY",
      *                     npi: "string",
      *                     telecoms: [{
      *                             value: "string",
-     *                             use: CandidApi.preEncounter.ContactPointUse.Home
+     *                             use: "HOME"
      *                         }],
      *                     addresses: [],
      *                     period: {},
@@ -319,17 +323,17 @@ export declare class V1 {
      *                 name: {
      *                     family: "string",
      *                     given: ["string"],
-     *                     use: CandidApi.preEncounter.NameUse.Usual,
+     *                     use: "USUAL",
      *                     period: {}
      *                 },
      *                 telecom: {
      *                     value: "string",
-     *                     use: CandidApi.preEncounter.ContactPointUse.Home
+     *                     use: "HOME"
      *                 },
      *                 email: "string",
      *                 birthDate: "2023-01-15",
      *                 address: {
-     *                     use: CandidApi.preEncounter.AddressUse.Home,
+     *                     use: "HOME",
      *                     line: ["string"],
      *                     city: "string",
      *                     state: "string",
@@ -345,7 +349,7 @@ export declare class V1 {
      *                     additionalPayerInformation: {},
      *                     authorizationNumber: "string",
      *                     cptCode: "string",
-     *                     units: CandidApi.preEncounter.patients.v1.AuthorizationUnit.Visit,
+     *                     units: "VISIT",
      *                     quantity: 1,
      *                     period: {},
      *                     notes: "string"
@@ -355,14 +359,14 @@ export declare class V1 {
      *                         name: {
      *                             family: "string",
      *                             given: ["string"],
-     *                             use: CandidApi.preEncounter.NameUse.Usual,
+     *                             use: "USUAL",
      *                             period: {}
      *                         },
-     *                         type: CandidApi.preEncounter.ExternalProviderType.Primary,
+     *                         type: "PRIMARY",
      *                         npi: "string",
      *                         telecoms: [{
      *                                 value: "string",
-     *                                 use: CandidApi.preEncounter.ContactPointUse.Home
+     *                                 use: "HOME"
      *                             }],
      *                         addresses: [],
      *                         period: {},
@@ -371,7 +375,7 @@ export declare class V1 {
      *                     referralNumber: "string"
      *                 }],
      *             primaryServiceFacilityId: "string",
-     *             doNotInvoiceReason: CandidApi.preEncounter.patients.v1.DoNotInvoiceReason.Bankruptcy,
+     *             doNotInvoiceReason: "BANKRUPTCY",
      *             noteIds: [CandidApi.preEncounter.NoteId("string")],
      *             tagIds: [CandidApi.preEncounter.TagId("string")]
      *         }
@@ -390,7 +394,7 @@ export declare class V1 {
      *         mrn: "string",
      *         pageToken: CandidApi.preEncounter.PageToken("string"),
      *         sortField: CandidApi.preEncounter.patients.v1.PatientSortField("string"),
-     *         sortDirection: CandidApi.preEncounter.SortDirection.Asc
+     *         sortDirection: "asc"
      *     })
      */
     getMulti(request?: CandidApi.preEncounter.patients.v1.PatientsSearchRequestPaginated, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.PatientPage, CandidApi.preEncounter.patients.v1.getMulti.Error>>;
@@ -427,28 +431,28 @@ export declare class V1 {
      *         name: {
      *             family: "string",
      *             given: ["string"],
-     *             use: CandidApi.preEncounter.NameUse.Usual,
+     *             use: "USUAL",
      *             period: {}
      *         },
      *         otherNames: [{
      *                 family: "string",
      *                 given: ["string"],
-     *                 use: CandidApi.preEncounter.NameUse.Usual,
+     *                 use: "USUAL",
      *                 period: {}
      *             }],
-     *         gender: CandidApi.preEncounter.Gender.Man,
+     *         gender: "MAN",
      *         birthDate: "2023-01-15",
      *         socialSecurityNumber: "string",
-     *         biologicalSex: CandidApi.preEncounter.Sex.Female,
-     *         sexualOrientation: CandidApi.preEncounter.SexualOrientation.Heterosexual,
-     *         race: CandidApi.preEncounter.Race.AmericanIndianOrAlaskaNative,
-     *         ethnicity: CandidApi.preEncounter.Ethnicity.HispanicOrLatino,
-     *         disabilityStatus: CandidApi.preEncounter.DisabilityStatus.Disabled,
-     *         maritalStatus: CandidApi.preEncounter.patients.v1.MaritalStatus.Annulled,
-     *         deceased: new Date("2024-01-15T09:30:00.000Z"),
+     *         biologicalSex: "FEMALE",
+     *         sexualOrientation: "HETEROSEXUAL",
+     *         race: "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
+     *         ethnicity: "HISPANIC_OR_LATINO",
+     *         disabilityStatus: "DISABLED",
+     *         maritalStatus: "ANNULLED",
+     *         deceased: "2024-01-15T09:30:00Z",
      *         multipleBirth: 1,
      *         primaryAddress: {
-     *             use: CandidApi.preEncounter.AddressUse.Home,
+     *             use: "HOME",
      *             line: ["string"],
      *             city: "string",
      *             state: "string",
@@ -457,7 +461,7 @@ export declare class V1 {
      *             period: {}
      *         },
      *         otherAddresses: [{
-     *                 use: CandidApi.preEncounter.AddressUse.Home,
+     *                 use: "HOME",
      *                 line: ["string"],
      *                 city: "string",
      *                 state: "string",
@@ -467,11 +471,11 @@ export declare class V1 {
      *             }],
      *         primaryTelecom: {
      *             value: "string",
-     *             use: CandidApi.preEncounter.ContactPointUse.Home
+     *             use: "HOME"
      *         },
      *         otherTelecoms: [{
      *                 value: "string",
-     *                 use: CandidApi.preEncounter.ContactPointUse.Home
+     *                 use: "HOME"
      *             }],
      *         email: "string",
      *         electronicCommunicationOptIn: true,
@@ -482,19 +486,19 @@ export declare class V1 {
      *             systemName: "string"
      *         },
      *         contacts: [{
-     *                 relationship: [CandidApi.preEncounter.Relationship.Self],
+     *                 relationship: ["SELF"],
      *                 name: {
      *                     family: "string",
      *                     given: ["string"],
-     *                     use: CandidApi.preEncounter.NameUse.Usual,
+     *                     use: "USUAL",
      *                     period: {}
      *                 },
      *                 telecoms: [{
      *                         value: "string",
-     *                         use: CandidApi.preEncounter.ContactPointUse.Home
+     *                         use: "HOME"
      *                     }],
      *                 addresses: [{
-     *                         use: CandidApi.preEncounter.AddressUse.Home,
+     *                         use: "HOME",
      *                         line: ["string"],
      *                         city: "string",
      *                         state: "string",
@@ -509,14 +513,14 @@ export declare class V1 {
      *                 name: {
      *                     family: "string",
      *                     given: ["string"],
-     *                     use: CandidApi.preEncounter.NameUse.Usual,
+     *                     use: "USUAL",
      *                     period: {}
      *                 },
-     *                 type: CandidApi.preEncounter.ExternalProviderType.Primary,
+     *                 type: "PRIMARY",
      *                 npi: "string",
      *                 telecoms: [{
      *                         value: "string",
-     *                         use: CandidApi.preEncounter.ContactPointUse.Home
+     *                         use: "HOME"
      *                     }],
      *                 addresses: [],
      *                 period: {},
@@ -533,17 +537,17 @@ export declare class V1 {
      *             name: {
      *                 family: "string",
      *                 given: ["string"],
-     *                 use: CandidApi.preEncounter.NameUse.Usual,
+     *                 use: "USUAL",
      *                 period: {}
      *             },
      *             telecom: {
      *                 value: "string",
-     *                 use: CandidApi.preEncounter.ContactPointUse.Home
+     *                 use: "HOME"
      *             },
      *             email: "string",
      *             birthDate: "2023-01-15",
      *             address: {
-     *                 use: CandidApi.preEncounter.AddressUse.Home,
+     *                 use: "HOME",
      *                 line: ["string"],
      *                 city: "string",
      *                 state: "string",
@@ -559,7 +563,7 @@ export declare class V1 {
      *                 additionalPayerInformation: {},
      *                 authorizationNumber: "string",
      *                 cptCode: "string",
-     *                 units: CandidApi.preEncounter.patients.v1.AuthorizationUnit.Visit,
+     *                 units: "VISIT",
      *                 quantity: 1,
      *                 period: {},
      *                 notes: "string"
@@ -569,14 +573,14 @@ export declare class V1 {
      *                     name: {
      *                         family: "string",
      *                         given: ["string"],
-     *                         use: CandidApi.preEncounter.NameUse.Usual,
+     *                         use: "USUAL",
      *                         period: {}
      *                     },
-     *                     type: CandidApi.preEncounter.ExternalProviderType.Primary,
+     *                     type: "PRIMARY",
      *                     npi: "string",
      *                     telecoms: [{
      *                             value: "string",
-     *                             use: CandidApi.preEncounter.ContactPointUse.Home
+     *                             use: "HOME"
      *                         }],
      *                     addresses: [],
      *                     period: {},
@@ -585,7 +589,7 @@ export declare class V1 {
      *                 referralNumber: "string"
      *             }],
      *         primaryServiceFacilityId: "string",
-     *         doNotInvoiceReason: CandidApi.preEncounter.patients.v1.DoNotInvoiceReason.Bankruptcy,
+     *         doNotInvoiceReason: "BANKRUPTCY",
      *         noteIds: [CandidApi.preEncounter.NoteId("string")],
      *         tagIds: [CandidApi.preEncounter.TagId("string")]
      *     })
@@ -623,7 +627,7 @@ export declare class V1 {
      *
      * @example
      *     await client.preEncounter.patients.v1.scan({
-     *         since: new Date("2024-01-15T09:30:00.000Z")
+     *         since: "2024-01-15T09:30:00Z"
      *     })
      */
     scan(request: CandidApi.preEncounter.patients.v1.PatientScanRequest, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient[], CandidApi.preEncounter.patients.v1.scan.Error>>;