candidhealth 0.30.0 → 0.32.0

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

@@ -29,8 +29,32 @@ export declare class V1 {
      *
      * @example
      *     await client.preEncounter.patients.v1.create({
-     *         name: {},
-     *         otherNames: [{}],
+     *         name: {
+     *             family: "string",
+     *             given: ["string"],
+     *             use: CandidApi.preEncounter.NameUse.Usual,
+     *             period: {
+     *                 start: {
+     *                     "key": "value"
+     *                 },
+     *                 end: {
+     *                     "key": "value"
+     *                 }
+     *             }
+     *         },
+     *         otherNames: [{
+     *                 family: "string",
+     *                 given: ["string"],
+     *                 use: CandidApi.preEncounter.NameUse.Usual,
+     *                 period: {
+     *                     start: {
+     *                         "key": "value"
+     *                     },
+     *                     end: {
+     *                         "key": "value"
+     *                     }
+     *                 }
+     *             }],
      *         gender: CandidApi.preEncounter.Gender.Man,
      *         birthDate: "2023-01-15",
      *         socialSecurityNumber: "string",
@@ -42,10 +66,52 @@ export declare class V1 {
      *         maritalStatus: CandidApi.preEncounter.patients.v1.MaritalStatus.Annulled,
      *         deceased: new Date("2024-01-15T09:30:00.000Z"),
      *         multipleBirth: 1,
-     *         primaryAddress: {},
-     *         otherAddresses: [{}],
-     *         primaryTelecom: {},
-     *         otherTelecoms: [{}],
+     *         primaryAddress: {
+     *             use: CandidApi.preEncounter.AddressUse.Home,
+     *             line: ["string"],
+     *             city: "string",
+     *             state: "string",
+     *             postalCode: "string",
+     *             country: "string",
+     *             period: {
+     *                 start: {
+     *                     "key": "value"
+     *                 },
+     *                 end: {
+     *                     "key": "value"
+     *                 }
+     *             }
+     *         },
+     *         otherAddresses: [{
+     *                 use: CandidApi.preEncounter.AddressUse.Home,
+     *                 line: ["string"],
+     *                 city: "string",
+     *                 state: "string",
+     *                 postalCode: "string",
+     *                 country: "string",
+     *                 period: {
+     *                     start: {
+     *                         "key": "value"
+     *                     },
+     *                     end: {
+     *                         "key": "value"
+     *                     }
+     *                 }
+     *             }],
+     *         primaryTelecom: {
+     *             value: "string",
+     *             use: CandidApi.preEncounter.ContactPointUse.Home,
+     *             period: {
+     *                 "key": "value"
+     *             }
+     *         },
+     *         otherTelecoms: [{
+     *                 value: "string",
+     *                 use: CandidApi.preEncounter.ContactPointUse.Home,
+     *                 period: {
+     *                     "key": "value"
+     *                 }
+     *             }],
      *         email: "string",
      *         electronicCommunicationOptIn: true,
      *         photo: "string",
@@ -56,13 +122,88 @@ export declare class V1 {
      *         },
      *         contacts: [{
      *                 relationship: [CandidApi.preEncounter.Relationship.Self],
-     *                 name: {},
-     *                 telecoms: [{}],
-     *                 addresses: [{}],
-     *                 period: {},
+     *                 name: {
+     *                     family: "string",
+     *                     given: ["string"],
+     *                     use: CandidApi.preEncounter.NameUse.Usual,
+     *                     period: {
+     *                         start: {
+     *                             "key": "value"
+     *                         },
+     *                         end: {
+     *                             "key": "value"
+     *                         }
+     *                     }
+     *                 },
+     *                 telecoms: [{
+     *                         value: "string",
+     *                         use: CandidApi.preEncounter.ContactPointUse.Home,
+     *                         period: {
+     *                             "key": "value"
+     *                         }
+     *                     }],
+     *                 addresses: [{
+     *                         use: CandidApi.preEncounter.AddressUse.Home,
+     *                         line: ["string"],
+     *                         city: "string",
+     *                         state: "string",
+     *                         postalCode: "string",
+     *                         country: "string",
+     *                         period: {
+     *                             start: {
+     *                                 "key": "value"
+     *                             },
+     *                             end: {
+     *                                 "key": "value"
+     *                             }
+     *                         }
+     *                     }],
+     *                 period: {
+     *                     start: {
+     *                         "key": "value"
+     *                     },
+     *                     end: {
+     *                         "key": "value"
+     *                     }
+     *                 },
      *                 hipaaAuthorization: true
      *             }],
-     *         generalPractitioners: [{}],
+     *         generalPractitioners: [{
+     *                 name: {
+     *                     family: "string",
+     *                     given: ["string"],
+     *                     use: CandidApi.preEncounter.NameUse.Usual,
+     *                     period: {
+     *                         start: {
+     *                             "key": "value"
+     *                         },
+     *                         end: {
+     *                             "key": "value"
+     *                         }
+     *                     }
+     *                 },
+     *                 type: CandidApi.preEncounter.ExternalProviderType.Primary,
+     *                 npi: "string",
+     *                 telecoms: [{
+     *                         value: "string",
+     *                         use: CandidApi.preEncounter.ContactPointUse.Home,
+     *                         period: {
+     *                             "key": "value"
+     *                         }
+     *                     }],
+     *                 addresses: [{
+     *                         "key": "value"
+     *                     }],
+     *                 period: {
+     *                     start: {
+     *                         "key": "value"
+     *                     },
+     *                     end: {
+     *                         "key": "value"
+     *                     }
+     *                 },
+     *                 canonicalId: CandidApi.preEncounter.CanonicalProviderId("string")
+     *             }],
      *         filingOrder: {
      *             coverages: [CandidApi.preEncounter.coverages.v1.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]
      *         }
@@ -77,8 +218,32 @@ export declare class V1 {
      *
      * @example
      *     await client.preEncounter.patients.v1.createNoDuplicateCheck({
-     *         name: {},
-     *         otherNames: [{}],
+     *         name: {
+     *             family: "string",
+     *             given: ["string"],
+     *             use: CandidApi.preEncounter.NameUse.Usual,
+     *             period: {
+     *                 start: {
+     *                     "key": "value"
+     *                 },
+     *                 end: {
+     *                     "key": "value"
+     *                 }
+     *             }
+     *         },
+     *         otherNames: [{
+     *                 family: "string",
+     *                 given: ["string"],
+     *                 use: CandidApi.preEncounter.NameUse.Usual,
+     *                 period: {
+     *                     start: {
+     *                         "key": "value"
+     *                     },
+     *                     end: {
+     *                         "key": "value"
+     *                     }
+     *                 }
+     *             }],
      *         gender: CandidApi.preEncounter.Gender.Man,
      *         birthDate: "2023-01-15",
      *         socialSecurityNumber: "string",
@@ -90,10 +255,52 @@ export declare class V1 {
      *         maritalStatus: CandidApi.preEncounter.patients.v1.MaritalStatus.Annulled,
      *         deceased: new Date("2024-01-15T09:30:00.000Z"),
      *         multipleBirth: 1,
-     *         primaryAddress: {},
-     *         otherAddresses: [{}],
-     *         primaryTelecom: {},
-     *         otherTelecoms: [{}],
+     *         primaryAddress: {
+     *             use: CandidApi.preEncounter.AddressUse.Home,
+     *             line: ["string"],
+     *             city: "string",
+     *             state: "string",
+     *             postalCode: "string",
+     *             country: "string",
+     *             period: {
+     *                 start: {
+     *                     "key": "value"
+     *                 },
+     *                 end: {
+     *                     "key": "value"
+     *                 }
+     *             }
+     *         },
+     *         otherAddresses: [{
+     *                 use: CandidApi.preEncounter.AddressUse.Home,
+     *                 line: ["string"],
+     *                 city: "string",
+     *                 state: "string",
+     *                 postalCode: "string",
+     *                 country: "string",
+     *                 period: {
+     *                     start: {
+     *                         "key": "value"
+     *                     },
+     *                     end: {
+     *                         "key": "value"
+     *                     }
+     *                 }
+     *             }],
+     *         primaryTelecom: {
+     *             value: "string",
+     *             use: CandidApi.preEncounter.ContactPointUse.Home,
+     *             period: {
+     *                 "key": "value"
+     *             }
+     *         },
+     *         otherTelecoms: [{
+     *                 value: "string",
+     *                 use: CandidApi.preEncounter.ContactPointUse.Home,
+     *                 period: {
+     *                     "key": "value"
+     *                 }
+     *             }],
      *         email: "string",
      *         electronicCommunicationOptIn: true,
      *         photo: "string",
@@ -104,13 +311,88 @@ export declare class V1 {
      *         },
      *         contacts: [{
      *                 relationship: [CandidApi.preEncounter.Relationship.Self],
-     *                 name: {},
-     *                 telecoms: [{}],
-     *                 addresses: [{}],
-     *                 period: {},
+     *                 name: {
+     *                     family: "string",
+     *                     given: ["string"],
+     *                     use: CandidApi.preEncounter.NameUse.Usual,
+     *                     period: {
+     *                         start: {
+     *                             "key": "value"
+     *                         },
+     *                         end: {
+     *                             "key": "value"
+     *                         }
+     *                     }
+     *                 },
+     *                 telecoms: [{
+     *                         value: "string",
+     *                         use: CandidApi.preEncounter.ContactPointUse.Home,
+     *                         period: {
+     *                             "key": "value"
+     *                         }
+     *                     }],
+     *                 addresses: [{
+     *                         use: CandidApi.preEncounter.AddressUse.Home,
+     *                         line: ["string"],
+     *                         city: "string",
+     *                         state: "string",
+     *                         postalCode: "string",
+     *                         country: "string",
+     *                         period: {
+     *                             start: {
+     *                                 "key": "value"
+     *                             },
+     *                             end: {
+     *                                 "key": "value"
+     *                             }
+     *                         }
+     *                     }],
+     *                 period: {
+     *                     start: {
+     *                         "key": "value"
+     *                     },
+     *                     end: {
+     *                         "key": "value"
+     *                     }
+     *                 },
      *                 hipaaAuthorization: true
      *             }],
-     *         generalPractitioners: [{}],
+     *         generalPractitioners: [{
+     *                 name: {
+     *                     family: "string",
+     *                     given: ["string"],
+     *                     use: CandidApi.preEncounter.NameUse.Usual,
+     *                     period: {
+     *                         start: {
+     *                             "key": "value"
+     *                         },
+     *                         end: {
+     *                             "key": "value"
+     *                         }
+     *                     }
+     *                 },
+     *                 type: CandidApi.preEncounter.ExternalProviderType.Primary,
+     *                 npi: "string",
+     *                 telecoms: [{
+     *                         value: "string",
+     *                         use: CandidApi.preEncounter.ContactPointUse.Home,
+     *                         period: {
+     *                             "key": "value"
+     *                         }
+     *                     }],
+     *                 addresses: [{
+     *                         "key": "value"
+     *                     }],
+     *                 period: {
+     *                     start: {
+     *                         "key": "value"
+     *                     },
+     *                     end: {
+     *                         "key": "value"
+     *                     }
+     *                 },
+     *                 canonicalId: CandidApi.preEncounter.CanonicalProviderId("string")
+     *             }],
      *         filingOrder: {
      *             coverages: [CandidApi.preEncounter.coverages.v1.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]
      *         }
@@ -163,8 +445,32 @@ export declare class V1 {
      *
      * @example
      *     await client.preEncounter.patients.v1.update(CandidApi.preEncounter.patients.v1.PatientId("string"), "string", {
-     *         name: {},
-     *         otherNames: [{}],
+     *         name: {
+     *             family: "string",
+     *             given: ["string"],
+     *             use: CandidApi.preEncounter.NameUse.Usual,
+     *             period: {
+     *                 start: {
+     *                     "key": "value"
+     *                 },
+     *                 end: {
+     *                     "key": "value"
+     *                 }
+     *             }
+     *         },
+     *         otherNames: [{
+     *                 family: "string",
+     *                 given: ["string"],
+     *                 use: CandidApi.preEncounter.NameUse.Usual,
+     *                 period: {
+     *                     start: {
+     *                         "key": "value"
+     *                     },
+     *                     end: {
+     *                         "key": "value"
+     *                     }
+     *                 }
+     *             }],
      *         gender: CandidApi.preEncounter.Gender.Man,
      *         birthDate: "2023-01-15",
      *         socialSecurityNumber: "string",
@@ -176,10 +482,52 @@ export declare class V1 {
      *         maritalStatus: CandidApi.preEncounter.patients.v1.MaritalStatus.Annulled,
      *         deceased: new Date("2024-01-15T09:30:00.000Z"),
      *         multipleBirth: 1,
-     *         primaryAddress: {},
-     *         otherAddresses: [{}],
-     *         primaryTelecom: {},
-     *         otherTelecoms: [{}],
+     *         primaryAddress: {
+     *             use: CandidApi.preEncounter.AddressUse.Home,
+     *             line: ["string"],
+     *             city: "string",
+     *             state: "string",
+     *             postalCode: "string",
+     *             country: "string",
+     *             period: {
+     *                 start: {
+     *                     "key": "value"
+     *                 },
+     *                 end: {
+     *                     "key": "value"
+     *                 }
+     *             }
+     *         },
+     *         otherAddresses: [{
+     *                 use: CandidApi.preEncounter.AddressUse.Home,
+     *                 line: ["string"],
+     *                 city: "string",
+     *                 state: "string",
+     *                 postalCode: "string",
+     *                 country: "string",
+     *                 period: {
+     *                     start: {
+     *                         "key": "value"
+     *                     },
+     *                     end: {
+     *                         "key": "value"
+     *                     }
+     *                 }
+     *             }],
+     *         primaryTelecom: {
+     *             value: "string",
+     *             use: CandidApi.preEncounter.ContactPointUse.Home,
+     *             period: {
+     *                 "key": "value"
+     *             }
+     *         },
+     *         otherTelecoms: [{
+     *                 value: "string",
+     *                 use: CandidApi.preEncounter.ContactPointUse.Home,
+     *                 period: {
+     *                     "key": "value"
+     *                 }
+     *             }],
      *         email: "string",
      *         electronicCommunicationOptIn: true,
      *         photo: "string",
@@ -190,13 +538,88 @@ export declare class V1 {
      *         },
      *         contacts: [{
      *                 relationship: [CandidApi.preEncounter.Relationship.Self],
-     *                 name: {},
-     *                 telecoms: [{}],
-     *                 addresses: [{}],
-     *                 period: {},
+     *                 name: {
+     *                     family: "string",
+     *                     given: ["string"],
+     *                     use: CandidApi.preEncounter.NameUse.Usual,
+     *                     period: {
+     *                         start: {
+     *                             "key": "value"
+     *                         },
+     *                         end: {
+     *                             "key": "value"
+     *                         }
+     *                     }
+     *                 },
+     *                 telecoms: [{
+     *                         value: "string",
+     *                         use: CandidApi.preEncounter.ContactPointUse.Home,
+     *                         period: {
+     *                             "key": "value"
+     *                         }
+     *                     }],
+     *                 addresses: [{
+     *                         use: CandidApi.preEncounter.AddressUse.Home,
+     *                         line: ["string"],
+     *                         city: "string",
+     *                         state: "string",
+     *                         postalCode: "string",
+     *                         country: "string",
+     *                         period: {
+     *                             start: {
+     *                                 "key": "value"
+     *                             },
+     *                             end: {
+     *                                 "key": "value"
+     *                             }
+     *                         }
+     *                     }],
+     *                 period: {
+     *                     start: {
+     *                         "key": "value"
+     *                     },
+     *                     end: {
+     *                         "key": "value"
+     *                     }
+     *                 },
      *                 hipaaAuthorization: true
      *             }],
-     *         generalPractitioners: [{}],
+     *         generalPractitioners: [{
+     *                 name: {
+     *                     family: "string",
+     *                     given: ["string"],
+     *                     use: CandidApi.preEncounter.NameUse.Usual,
+     *                     period: {
+     *                         start: {
+     *                             "key": "value"
+     *                         },
+     *                         end: {
+     *                             "key": "value"
+     *                         }
+     *                     }
+     *                 },
+     *                 type: CandidApi.preEncounter.ExternalProviderType.Primary,
+     *                 npi: "string",
+     *                 telecoms: [{
+     *                         value: "string",
+     *                         use: CandidApi.preEncounter.ContactPointUse.Home,
+     *                         period: {
+     *                             "key": "value"
+     *                         }
+     *                     }],
+     *                 addresses: [{
+     *                         "key": "value"
+     *                     }],
+     *                 period: {
+     *                     start: {
+     *                         "key": "value"
+     *                     },
+     *                     end: {
+     *                         "key": "value"
+     *                     }
+     *                 },
+     *                 canonicalId: CandidApi.preEncounter.CanonicalProviderId("string")
+     *             }],
      *         filingOrder: {
      *             coverages: [CandidApi.preEncounter.coverages.v1.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]
      *         }