candidhealth 0.35.3 → 0.38.0

package/api/resources/encounters/resources/v4/client/Client.d.ts

@@ -93,9 +93,7 @@ export declare class V4 {
      *             taxId: "string",
      *             npi: "string",
      *             taxonomyCode: "string",
-     *             firstName: "string",
-     *             lastName: "string",
-     *             organizationName: "string"
+     *             providerCommercialLicenseType: CandidApi.BillingProviderCommercialLicenseType.LicensedClinicalSocialWorker
      *         },
      *         renderingProvider: {
      *             npi: "string",
@@ -107,10 +105,7 @@ export declare class V4 {
      *                 state: CandidApi.State.Ny,
      *                 zipCode: "10001",
      *                 zipPlusFourCode: "1234"
-     *             },
-     *             firstName: "string",
-     *             lastName: "string",
-     *             organizationName: "string"
+     *             }
      *         },
      *         referringProvider: {
      *             npi: "string",
@@ -122,10 +117,7 @@ export declare class V4 {
      *                 state: CandidApi.State.Ny,
      *                 zipCode: "10001",
      *                 zipPlusFourCode: "1234"
-     *             },
-     *             firstName: "string",
-     *             lastName: "string",
-     *             organizationName: "string"
+     *             }
      *         },
      *         initialReferringProvider: {
      *             npi: "string",
@@ -138,10 +130,7 @@ export declare class V4 {
      *                 zipCode: "10001",
      *                 zipPlusFourCode: "1234"
      *             },
-     *             qualifier: CandidApi.QualifierCode.Dq,
-     *             firstName: "string",
-     *             lastName: "string",
-     *             organizationName: "string"
+     *             qualifier: CandidApi.QualifierCode.Dq
      *         },
      *         supervisingProvider: {
      *             npi: "string",
@@ -153,10 +142,7 @@ export declare class V4 {
      *                 state: CandidApi.State.Ny,
      *                 zipCode: "10001",
      *                 zipPlusFourCode: "1234"
-     *             },
-     *             firstName: "string",
-     *             lastName: "string",
-     *             organizationName: "string"
+     *             }
      *         },
      *         serviceFacility: {
      *             organizationName: "string",
@@ -168,33 +154,16 @@ export declare class V4 {
      *                 state: CandidApi.State.Ny,
      *                 zipCode: "10001",
      *                 zipPlusFourCode: "1234"
-     *             }
+     *             },
+     *             secondaryIdentification: "string"
      *         },
      *         subscriberPrimary: {
      *             insuranceCard: {
      *                 memberId: "string",
      *                 payerName: "string",
-     *                 payerId: "string",
-     *                 rxBin: "string",
-     *                 rxPcn: "string",
-     *                 imageUrlFront: "string",
-     *                 imageUrlBack: "string",
-     *                 emrPayerCrosswalk: CandidApi.EmrPayerCrosswalk.Healthie,
-     *                 groupNumber: "string",
-     *                 planName: "string",
-     *                 planType: CandidApi.SourceOfPaymentCode.SelfPay,
-     *                 insuranceType: CandidApi.InsuranceTypeCode.C01
+     *                 payerId: "string"
      *             },
      *             patientRelationshipToSubscriberCode: CandidApi.PatientRelationshipToInsuredCodeAll.Spouse,
-     *             dateOfBirth: "2023-01-15",
-     *             address: {
-     *                 address1: "123 Main St",
-     *                 address2: "Apt 1",
-     *                 city: "New York",
-     *                 state: CandidApi.State.Ny,
-     *                 zipCode: "10001",
-     *                 zipPlusFourCode: "1234"
-     *             },
      *             firstName: "string",
      *             lastName: "string",
      *             gender: CandidApi.Gender.Male
@@ -203,27 +172,9 @@ export declare class V4 {
      *             insuranceCard: {
      *                 memberId: "string",
      *                 payerName: "string",
-     *                 payerId: "string",
-     *                 rxBin: "string",
-     *                 rxPcn: "string",
-     *                 imageUrlFront: "string",
-     *                 imageUrlBack: "string",
-     *                 emrPayerCrosswalk: CandidApi.EmrPayerCrosswalk.Healthie,
-     *                 groupNumber: "string",
-     *                 planName: "string",
-     *                 planType: CandidApi.SourceOfPaymentCode.SelfPay,
-     *                 insuranceType: CandidApi.InsuranceTypeCode.C01
+     *                 payerId: "string"
      *             },
      *             patientRelationshipToSubscriberCode: CandidApi.PatientRelationshipToInsuredCodeAll.Spouse,
-     *             dateOfBirth: "2023-01-15",
-     *             address: {
-     *                 address1: "123 Main St",
-     *                 address2: "Apt 1",
-     *                 city: "New York",
-     *                 state: CandidApi.State.Ny,
-     *                 zipCode: "10001",
-     *                 zipPlusFourCode: "1234"
-     *             },
      *             firstName: "string",
      *             lastName: "string",
      *             gender: CandidApi.Gender.Male
@@ -294,10 +245,7 @@ export declare class V4 {
      *                         state: CandidApi.State.Ny,
      *                         zipCode: "10001",
      *                         zipPlusFourCode: "1234"
-     *                     },
-     *                     firstName: "string",
-     *                     lastName: "string",
-     *                     organizationName: "string"
+     *                     }
      *                 },
      *                 testResults: [{
      *                         value: 1.1,
@@ -451,9 +399,7 @@ export declare class V4 {
      *             taxId: "string",
      *             npi: "string",
      *             taxonomyCode: "string",
-     *             firstName: "string",
-     *             lastName: "string",
-     *             organizationName: "string"
+     *             providerCommercialLicenseType: CandidApi.BillingProviderCommercialLicenseType.LicensedClinicalSocialWorker
      *         },
      *         renderingProvider: {
      *             npi: "string",
@@ -465,10 +411,7 @@ export declare class V4 {
      *                 state: CandidApi.State.Ny,
      *                 zipCode: "10001",
      *                 zipPlusFourCode: "1234"
-     *             },
-     *             firstName: "string",
-     *             lastName: "string",
-     *             organizationName: "string"
+     *             }
      *         },
      *         initialReferringProvider: {
      *             npi: "string",
@@ -481,10 +424,7 @@ export declare class V4 {
      *                 zipCode: "10001",
      *                 zipPlusFourCode: "1234"
      *             },
-     *             qualifier: CandidApi.QualifierCode.Dq,
-     *             firstName: "string",
-     *             lastName: "string",
-     *             organizationName: "string"
+     *             qualifier: CandidApi.QualifierCode.Dq
      *         },
      *         supervisingProvider: {
      *             npi: "string",
@@ -496,10 +436,7 @@ export declare class V4 {
      *                 state: CandidApi.State.Ny,
      *                 zipCode: "10001",
      *                 zipPlusFourCode: "1234"
-     *             },
-     *             firstName: "string",
-     *             lastName: "string",
-     *             organizationName: "string"
+     *             }
      *         },
      *         serviceFacility: {
      *             organizationName: "string",
@@ -511,7 +448,8 @@ export declare class V4 {
      *                 state: CandidApi.State.Ny,
      *                 zipCode: "10001",
      *                 zipPlusFourCode: "1234"
-     *             }
+     *             },
+     *             secondaryIdentification: "string"
      *         },
      *         diagnoses: [{
      *                 name: "string",
@@ -577,10 +515,7 @@ export declare class V4 {
      *                         state: CandidApi.State.Ny,
      *                         zipCode: "10001",
      *                         zipPlusFourCode: "1234"
-     *                     },
-     *                     firstName: "string",
-     *                     lastName: "string",
-     *                     organizationName: "string"
+     *                     }
      *                 },
      *                 testResults: [{
      *                         value: 1.1,
@@ -681,20 +616,14 @@ export declare class V4 {
      *
      * @example
      *     await client.encounters.v4.update(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
+     *         diagnosisIds: [CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
+     *         placeOfServiceCodeAsSubmitted: CandidApi.FacilityTypeCode.Pharmacy,
+     *         benefitsAssignedToProvider: true,
      *         priorAuthorizationNumber: CandidApi.encounters.v4.PriorAuthorizationNumber("string"),
      *         externalId: CandidApi.EncounterExternalId("string"),
      *         dateOfService: "2023-01-15",
-     *         diagnosisIds: [CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
-     *         tagIds: [CandidApi.TagId("string")],
-     *         clinicalNotes: [{
-     *                 category: CandidApi.encounters.v4.NoteCategory.Clinical,
-     *                 notes: [{
-     *                         text: "string",
-     *                         authorName: "string",
-     *                         authorNpi: CandidApi.Npi("string"),
-     *                         timestamp: new Date("2024-01-15T09:30:00.000Z")
-     *                     }]
-     *             }],
+     *         tagIds: [],
+     *         clinicalNotes: [],
      *         payToAddress: {
      *             address1: "123 Main St",
      *             address2: "Apt 1",
@@ -706,37 +635,17 @@ export declare class V4 {
      *         billableStatus: CandidApi.encounters.v4.BillableStatusType.Billable,
      *         responsibleParty: CandidApi.encounters.v4.ResponsiblePartyType.InsurancePay,
      *         providerAcceptsAssignment: true,
-     *         benefitsAssignedToProvider: true,
      *         synchronicity: CandidApi.encounters.v4.SynchronicityType.Synchronous,
      *         placeOfServiceCode: CandidApi.FacilityTypeCode.Pharmacy,
-     *         placeOfServiceCodeAsSubmitted: CandidApi.FacilityTypeCode.Pharmacy,
      *         appointmentType: "string",
      *         endDateOfService: "2023-01-15",
      *         subscriberPrimary: {
      *             insuranceCard: {
      *                 memberId: "string",
      *                 payerName: "string",
-     *                 payerId: "string",
-     *                 rxBin: "string",
-     *                 rxPcn: "string",
-     *                 imageUrlFront: "string",
-     *                 imageUrlBack: "string",
-     *                 emrPayerCrosswalk: CandidApi.EmrPayerCrosswalk.Healthie,
-     *                 groupNumber: "string",
-     *                 planName: "string",
-     *                 planType: CandidApi.SourceOfPaymentCode.SelfPay,
-     *                 insuranceType: CandidApi.InsuranceTypeCode.C01
+     *                 payerId: "string"
      *             },
      *             patientRelationshipToSubscriberCode: CandidApi.PatientRelationshipToInsuredCodeAll.Spouse,
-     *             dateOfBirth: "2023-01-15",
-     *             address: {
-     *                 address1: "123 Main St",
-     *                 address2: "Apt 1",
-     *                 city: "New York",
-     *                 state: CandidApi.State.Ny,
-     *                 zipCode: "10001",
-     *                 zipPlusFourCode: "1234"
-     *             },
      *             firstName: "string",
      *             lastName: "string",
      *             gender: CandidApi.Gender.Male
@@ -745,27 +654,9 @@ export declare class V4 {
      *             insuranceCard: {
      *                 memberId: "string",
      *                 payerName: "string",
-     *                 payerId: "string",
-     *                 rxBin: "string",
-     *                 rxPcn: "string",
-     *                 imageUrlFront: "string",
-     *                 imageUrlBack: "string",
-     *                 emrPayerCrosswalk: CandidApi.EmrPayerCrosswalk.Healthie,
-     *                 groupNumber: "string",
-     *                 planName: "string",
-     *                 planType: CandidApi.SourceOfPaymentCode.SelfPay,
-     *                 insuranceType: CandidApi.InsuranceTypeCode.C01
+     *                 payerId: "string"
      *             },
      *             patientRelationshipToSubscriberCode: CandidApi.PatientRelationshipToInsuredCodeAll.Spouse,
-     *             dateOfBirth: "2023-01-15",
-     *             address: {
-     *                 address1: "123 Main St",
-     *                 address2: "Apt 1",
-     *                 city: "New York",
-     *                 state: CandidApi.State.Ny,
-     *                 zipCode: "10001",
-     *                 zipPlusFourCode: "1234"
-     *             },
      *             firstName: "string",
      *             lastName: "string",
      *             gender: CandidApi.Gender.Male
@@ -777,43 +668,9 @@ export declare class V4 {
      *         onsetOfCurrentIllnessOrSymptomDate: "2023-01-15",
      *         lastMenstrualPeriodDate: "2023-01-15",
      *         delayReasonCode: CandidApi.DelayReasonCode.C1,
-     *         patient: {
-     *             firstName: "string",
-     *             lastName: "string",
-     *             gender: CandidApi.Gender.Male,
-     *             externalId: "string",
-     *             dateOfBirth: "2023-01-15",
-     *             address: {
-     *                 address1: "123 Main St",
-     *                 address2: "Apt 1",
-     *                 city: "New York",
-     *                 state: CandidApi.State.Ny,
-     *                 zipCode: "10001",
-     *                 zipPlusFourCode: "1234"
-     *             },
-     *             phoneNumbers: [{
-     *                     number: "1234567890",
-     *                     type: CandidApi.PhoneNumberType.Home
-     *                 }],
-     *             phoneConsent: true,
-     *             email: CandidApi.Email("johndoe@joincandidhealth.com"),
-     *             emailConsent: true,
-     *             nonInsurancePayers: [CandidApi.nonInsurancePayers.v1.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
-     *             nonInsurancePayersInfo: [{
-     *                     nonInsurancePayerId: CandidApi.nonInsurancePayers.v1.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
-     *                     memberId: "string"
-     *                 }]
-     *         },
+     *         patient: {},
      *         patientAuthorizedRelease: true,
-     *         schemaInstances: [{
-     *                 schemaId: CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582"),
-     *                 content: {
-     *                     "provider_category": "internist",
-     *                     "is_urgent_care": true,
-     *                     "bmi": 24.2,
-     *                     "age": 38
-     *                 }
-     *             }],
+     *         schemaInstances: [],
      *         vitals: {
      *             heightIn: 70,
      *             weightLbs: 165,
@@ -823,29 +680,8 @@ export declare class V4 {
      *             hemoglobinGdl: 15.1,
      *             hematocritPct: 51.2
      *         },
-     *         existingMedications: [{
-     *                 name: "Lisinopril",
-     *                 rxCui: CandidApi.encounters.v4.RxCui("860975"),
-     *                 dosage: "10mg",
-     *                 dosageForm: "Tablet",
-     *                 frequency: "Once Daily",
-     *                 asNeeded: true
-     *             }],
-     *         renderingProvider: {
-     *             npi: "string",
-     *             taxonomyCode: "string",
-     *             address: {
-     *                 address1: "123 Main St",
-     *                 address2: "Apt 1",
-     *                 city: "New York",
-     *                 state: CandidApi.State.Ny,
-     *                 zipCode: "10001",
-     *                 zipPlusFourCode: "1234"
-     *             },
-     *             firstName: "string",
-     *             lastName: "string",
-     *             organizationName: "string"
-     *         },
+     *         existingMedications: [],
+     *         renderingProvider: {},
      *         serviceFacility: {
      *             organizationName: "Test Organization",
      *             address: {
@@ -857,89 +693,11 @@ export declare class V4 {
      *                 zipPlusFourCode: "1234"
      *             }
      *         },
-     *         guarantor: {
-     *             firstName: "string",
-     *             lastName: "string",
-     *             externalId: "string",
-     *             dateOfBirth: "2023-01-15",
-     *             address: {
-     *                 address1: "123 Main St",
-     *                 address2: "Apt 1",
-     *                 city: "New York",
-     *                 state: CandidApi.State.Ny,
-     *                 zipCode: "10001",
-     *                 zipPlusFourCode: "1234"
-     *             },
-     *             phoneNumbers: [{
-     *                     number: "1234567890",
-     *                     type: CandidApi.PhoneNumberType.Home
-     *                 }],
-     *             phoneConsent: true,
-     *             email: CandidApi.Email("johndoe@joincandidhealth.com"),
-     *             emailConsent: true
-     *         },
-     *         billingProvider: {
-     *             address: {
-     *                 address1: "123 Main St",
-     *                 address2: "Apt 1",
-     *                 city: "New York",
-     *                 state: CandidApi.State.Ny,
-     *                 zipCode: "10001",
-     *                 zipPlusFourCode: "1234"
-     *             },
-     *             taxId: "string",
-     *             npi: "string",
-     *             taxonomyCode: "string",
-     *             firstName: "string",
-     *             lastName: "string",
-     *             organizationName: "string"
-     *         },
-     *         supervisingProvider: {
-     *             npi: "string",
-     *             taxonomyCode: "string",
-     *             address: {
-     *                 address1: "123 Main St",
-     *                 address2: "Apt 1",
-     *                 city: "New York",
-     *                 state: CandidApi.State.Ny,
-     *                 zipCode: "10001",
-     *                 zipPlusFourCode: "1234"
-     *             },
-     *             firstName: "string",
-     *             lastName: "string",
-     *             organizationName: "string"
-     *         },
-     *         referringProvider: {
-     *             npi: "string",
-     *             taxonomyCode: "string",
-     *             address: {
-     *                 address1: "123 Main St",
-     *                 address2: "Apt 1",
-     *                 city: "New York",
-     *                 state: CandidApi.State.Ny,
-     *                 zipCode: "10001",
-     *                 zipPlusFourCode: "1234"
-     *             },
-     *             firstName: "string",
-     *             lastName: "string",
-     *             organizationName: "string"
-     *         },
-     *         initialReferringProvider: {
-     *             npi: "string",
-     *             taxonomyCode: "string",
-     *             address: {
-     *                 address1: "123 Main St",
-     *                 address2: "Apt 1",
-     *                 city: "New York",
-     *                 state: CandidApi.State.Ny,
-     *                 zipCode: "10001",
-     *                 zipPlusFourCode: "1234"
-     *             },
-     *             qualifier: CandidApi.QualifierCode.Dq,
-     *             firstName: "string",
-     *             lastName: "string",
-     *             organizationName: "string"
-     *         },
+     *         guarantor: {},
+     *         billingProvider: {},
+     *         supervisingProvider: {},
+     *         referringProvider: {},
+     *         initialReferringProvider: {},
      *         referralNumber: "string"
      *     })
      */