candidhealth 0.43.1 → 0.46.0

package/api/resources/preEncounter/resources/patients/resources/v1/client/requests/CreatePatientRequest.d.ts

@@ -5,186 +5,146 @@ import * as CandidApi from "../../../../../../../../index";
 /**
  * @example
  *     {
- *         skipDuplicateCheck: true,
  *         body: {
  *             name: {
- *                 family: "string",
- *                 given: ["string"],
- *                 use: "USUAL",
- *                 period: {},
- *                 suffix: "string"
+ *                 family: "family",
+ *                 given: ["given", "given"],
+ *                 use: "USUAL"
  *             },
  *             otherNames: [{
- *                     family: "string",
- *                     given: ["string"],
- *                     use: "USUAL",
- *                     period: {},
- *                     suffix: "string"
+ *                     family: "family",
+ *                     given: ["given", "given"],
+ *                     use: "USUAL"
+ *                 }, {
+ *                     family: "family",
+ *                     given: ["given", "given"],
+ *                     use: "USUAL"
  *                 }],
- *             otherIdentifiers: [{
- *                     value: "string",
- *                     system: "string"
- *                 }],
- *             gender: "MAN",
  *             birthDate: "2023-01-15",
- *             socialSecurityNumber: "string",
  *             biologicalSex: "FEMALE",
- *             sexualOrientation: "HETEROSEXUAL",
- *             pronouns: ["string"],
- *             race: "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
- *             ethnicity: "HISPANIC_OR_LATINO",
- *             disabilityStatus: "DISABLED",
- *             maritalStatus: "ANNULLED",
- *             deceased: "2024-01-15T09:30:00Z",
- *             multipleBirth: 1,
  *             primaryAddress: {
  *                 use: "HOME",
- *                 line: ["string"],
- *                 city: "string",
- *                 state: "string",
- *                 postalCode: "string",
- *                 country: "string",
- *                 period: {}
+ *                 line: ["line", "line"],
+ *                 city: "city",
+ *                 state: "state",
+ *                 postalCode: "postal_code",
+ *                 country: "country"
  *             },
  *             otherAddresses: [{
  *                     use: "HOME",
- *                     line: ["string"],
- *                     city: "string",
- *                     state: "string",
- *                     postalCode: "string",
- *                     country: "string",
- *                     period: {}
+ *                     line: ["line", "line"],
+ *                     city: "city",
+ *                     state: "state",
+ *                     postalCode: "postal_code",
+ *                     country: "country"
+ *                 }, {
+ *                     use: "HOME",
+ *                     line: ["line", "line"],
+ *                     city: "city",
+ *                     state: "state",
+ *                     postalCode: "postal_code",
+ *                     country: "country"
  *                 }],
  *             primaryTelecom: {
- *                 value: "string",
+ *                 value: "value",
  *                 use: "HOME"
  *             },
  *             otherTelecoms: [{
- *                     value: "string",
+ *                     value: "value",
+ *                     use: "HOME"
+ *                 }, {
+ *                     value: "value",
  *                     use: "HOME"
  *                 }],
- *             email: "string",
- *             electronicCommunicationOptIn: true,
- *             photo: "string",
- *             language: "string",
- *             externalProvenance: {
- *                 externalId: "string",
- *                 systemName: "string"
- *             },
  *             contacts: [{
- *                     relationship: ["SELF"],
+ *                     relationship: ["SELF", "SELF"],
  *                     name: {
- *                         family: "string",
- *                         given: ["string"],
- *                         use: "USUAL",
- *                         period: {},
- *                         suffix: "string"
+ *                         family: "family",
+ *                         given: ["given", "given"],
+ *                         use: "USUAL"
  *                     },
  *                     telecoms: [{
- *                             value: "string",
+ *                             value: "value",
+ *                             use: "HOME"
+ *                         }, {
+ *                             value: "value",
  *                             use: "HOME"
  *                         }],
  *                     addresses: [{
  *                             use: "HOME",
- *                             line: ["string"],
- *                             city: "string",
- *                             state: "string",
- *                             postalCode: "string",
- *                             country: "string",
- *                             period: {}
+ *                             line: ["line", "line"],
+ *                             city: "city",
+ *                             state: "state",
+ *                             postalCode: "postal_code",
+ *                             country: "country"
+ *                         }, {
+ *                             use: "HOME",
+ *                             line: ["line", "line"],
+ *                             city: "city",
+ *                             state: "state",
+ *                             postalCode: "postal_code",
+ *                             country: "country"
+ *                         }]
+ *                 }, {
+ *                     relationship: ["SELF", "SELF"],
+ *                     name: {
+ *                         family: "family",
+ *                         given: ["given", "given"],
+ *                         use: "USUAL"
+ *                     },
+ *                     telecoms: [{
+ *                             value: "value",
+ *                             use: "HOME"
+ *                         }, {
+ *                             value: "value",
+ *                             use: "HOME"
  *                         }],
- *                     period: {},
- *                     hipaaAuthorization: true
+ *                     addresses: [{
+ *                             use: "HOME",
+ *                             line: ["line", "line"],
+ *                             city: "city",
+ *                             state: "state",
+ *                             postalCode: "postal_code",
+ *                             country: "country"
+ *                         }, {
+ *                             use: "HOME",
+ *                             line: ["line", "line"],
+ *                             city: "city",
+ *                             state: "state",
+ *                             postalCode: "postal_code",
+ *                             country: "country"
+ *                         }]
  *                 }],
  *             generalPractitioners: [{
  *                     name: {
- *                         family: "string",
- *                         given: ["string"],
- *                         use: "USUAL",
- *                         period: {},
- *                         suffix: "string"
+ *                         family: "family",
+ *                         given: ["given", "given"],
+ *                         use: "USUAL"
  *                     },
- *                     type: "PRIMARY",
- *                     npi: "string",
  *                     telecoms: [{
- *                             value: "string",
+ *                             value: "value",
  *                             use: "HOME"
- *                         }],
- *                     addresses: [],
- *                     period: {},
- *                     canonicalId: CandidApi.preEncounter.CanonicalProviderId("string"),
- *                     fax: "string"
- *                 }],
- *             filingOrder: {
- *                 coverages: [CandidApi.preEncounter.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]
- *             },
- *             nonInsurancePayers: [CandidApi.preEncounter.CanonicalNonInsurancePayerId("string")],
- *             nonInsurancePayerAssociations: [{
- *                     id: CandidApi.preEncounter.CanonicalNonInsurancePayerId("string")
- *                 }],
- *             guarantor: {
- *                 name: {
- *                     family: "string",
- *                     given: ["string"],
- *                     use: "USUAL",
- *                     period: {},
- *                     suffix: "string"
- *                 },
- *                 telecom: {
- *                     value: "string",
- *                     use: "HOME"
- *                 },
- *                 email: "string",
- *                 birthDate: "2023-01-15",
- *                 address: {
- *                     use: "HOME",
- *                     line: ["string"],
- *                     city: "string",
- *                     state: "string",
- *                     postalCode: "string",
- *                     country: "string",
- *                     period: {}
- *                 }
- *             },
- *             selfPay: true,
- *             authorizations: [{
- *                     payerId: CandidApi.preEncounter.PayerId("string"),
- *                     payerName: "string",
- *                     additionalPayerInformation: {},
- *                     authorizationNumber: "string",
- *                     cptCode: "string",
- *                     applyForAllCptCodes: true,
- *                     units: "VISIT",
- *                     quantity: 1,
- *                     period: {},
- *                     notes: "string"
- *                 }],
- *             referrals: [{
- *                     provider: {
- *                         name: {
- *                             family: "string",
- *                             given: ["string"],
- *                             use: "USUAL",
- *                             period: {},
- *                             suffix: "string"
- *                         },
- *                         type: "PRIMARY",
- *                         npi: "string",
- *                         telecoms: [{
- *                                 value: "string",
- *                                 use: "HOME"
- *                             }],
- *                         addresses: [],
- *                         period: {},
- *                         canonicalId: CandidApi.preEncounter.CanonicalProviderId("string"),
- *                         fax: "string"
+ *                         }, {
+ *                             value: "value",
+ *                             use: "HOME"
+ *                         }]
+ *                 }, {
+ *                     name: {
+ *                         family: "family",
+ *                         given: ["given", "given"],
+ *                         use: "USUAL"
  *                     },
- *                     referralNumber: "string"
+ *                     telecoms: [{
+ *                             value: "value",
+ *                             use: "HOME"
+ *                         }, {
+ *                             value: "value",
+ *                             use: "HOME"
+ *                         }]
  *                 }],
- *             primaryServiceFacilityId: "string",
- *             doNotInvoiceReason: "BANKRUPTCY",
- *             noteIds: [CandidApi.preEncounter.NoteId("string")],
- *             tagIds: [CandidApi.preEncounter.TagId("string")]
+ *             filingOrder: {
+ *                 coverages: [CandidApi.preEncounter.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.preEncounter.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]
+ *             }
  *         }
  *     }
  */

package/api/resources/preEncounter/resources/patients/resources/v1/client/requests/CreatePatientWithMrnRequest.d.ts

@@ -5,187 +5,147 @@ import * as CandidApi from "../../../../../../../../index";
 /**
  * @example
  *     {
- *         skipDuplicateCheck: true,
  *         body: {
- *             mrn: "string",
  *             name: {
- *                 family: "string",
- *                 given: ["string"],
- *                 use: "USUAL",
- *                 period: {},
- *                 suffix: "string"
+ *                 family: "family",
+ *                 given: ["given", "given"],
+ *                 use: "USUAL"
  *             },
  *             otherNames: [{
- *                     family: "string",
- *                     given: ["string"],
- *                     use: "USUAL",
- *                     period: {},
- *                     suffix: "string"
+ *                     family: "family",
+ *                     given: ["given", "given"],
+ *                     use: "USUAL"
+ *                 }, {
+ *                     family: "family",
+ *                     given: ["given", "given"],
+ *                     use: "USUAL"
  *                 }],
- *             otherIdentifiers: [{
- *                     value: "string",
- *                     system: "string"
- *                 }],
- *             gender: "MAN",
  *             birthDate: "2023-01-15",
- *             socialSecurityNumber: "string",
  *             biologicalSex: "FEMALE",
- *             sexualOrientation: "HETEROSEXUAL",
- *             pronouns: ["string"],
- *             race: "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
- *             ethnicity: "HISPANIC_OR_LATINO",
- *             disabilityStatus: "DISABLED",
- *             maritalStatus: "ANNULLED",
- *             deceased: "2024-01-15T09:30:00Z",
- *             multipleBirth: 1,
  *             primaryAddress: {
  *                 use: "HOME",
- *                 line: ["string"],
- *                 city: "string",
- *                 state: "string",
- *                 postalCode: "string",
- *                 country: "string",
- *                 period: {}
+ *                 line: ["line", "line"],
+ *                 city: "city",
+ *                 state: "state",
+ *                 postalCode: "postal_code",
+ *                 country: "country"
  *             },
  *             otherAddresses: [{
  *                     use: "HOME",
- *                     line: ["string"],
- *                     city: "string",
- *                     state: "string",
- *                     postalCode: "string",
- *                     country: "string",
- *                     period: {}
+ *                     line: ["line", "line"],
+ *                     city: "city",
+ *                     state: "state",
+ *                     postalCode: "postal_code",
+ *                     country: "country"
+ *                 }, {
+ *                     use: "HOME",
+ *                     line: ["line", "line"],
+ *                     city: "city",
+ *                     state: "state",
+ *                     postalCode: "postal_code",
+ *                     country: "country"
  *                 }],
  *             primaryTelecom: {
- *                 value: "string",
+ *                 value: "value",
  *                 use: "HOME"
  *             },
  *             otherTelecoms: [{
- *                     value: "string",
+ *                     value: "value",
+ *                     use: "HOME"
+ *                 }, {
+ *                     value: "value",
  *                     use: "HOME"
  *                 }],
- *             email: "string",
- *             electronicCommunicationOptIn: true,
- *             photo: "string",
- *             language: "string",
- *             externalProvenance: {
- *                 externalId: "string",
- *                 systemName: "string"
- *             },
  *             contacts: [{
- *                     relationship: ["SELF"],
+ *                     relationship: ["SELF", "SELF"],
  *                     name: {
- *                         family: "string",
- *                         given: ["string"],
- *                         use: "USUAL",
- *                         period: {},
- *                         suffix: "string"
+ *                         family: "family",
+ *                         given: ["given", "given"],
+ *                         use: "USUAL"
  *                     },
  *                     telecoms: [{
- *                             value: "string",
+ *                             value: "value",
+ *                             use: "HOME"
+ *                         }, {
+ *                             value: "value",
  *                             use: "HOME"
  *                         }],
  *                     addresses: [{
  *                             use: "HOME",
- *                             line: ["string"],
- *                             city: "string",
- *                             state: "string",
- *                             postalCode: "string",
- *                             country: "string",
- *                             period: {}
+ *                             line: ["line", "line"],
+ *                             city: "city",
+ *                             state: "state",
+ *                             postalCode: "postal_code",
+ *                             country: "country"
+ *                         }, {
+ *                             use: "HOME",
+ *                             line: ["line", "line"],
+ *                             city: "city",
+ *                             state: "state",
+ *                             postalCode: "postal_code",
+ *                             country: "country"
+ *                         }]
+ *                 }, {
+ *                     relationship: ["SELF", "SELF"],
+ *                     name: {
+ *                         family: "family",
+ *                         given: ["given", "given"],
+ *                         use: "USUAL"
+ *                     },
+ *                     telecoms: [{
+ *                             value: "value",
+ *                             use: "HOME"
+ *                         }, {
+ *                             value: "value",
+ *                             use: "HOME"
  *                         }],
- *                     period: {},
- *                     hipaaAuthorization: true
+ *                     addresses: [{
+ *                             use: "HOME",
+ *                             line: ["line", "line"],
+ *                             city: "city",
+ *                             state: "state",
+ *                             postalCode: "postal_code",
+ *                             country: "country"
+ *                         }, {
+ *                             use: "HOME",
+ *                             line: ["line", "line"],
+ *                             city: "city",
+ *                             state: "state",
+ *                             postalCode: "postal_code",
+ *                             country: "country"
+ *                         }]
  *                 }],
  *             generalPractitioners: [{
  *                     name: {
- *                         family: "string",
- *                         given: ["string"],
- *                         use: "USUAL",
- *                         period: {},
- *                         suffix: "string"
+ *                         family: "family",
+ *                         given: ["given", "given"],
+ *                         use: "USUAL"
  *                     },
- *                     type: "PRIMARY",
- *                     npi: "string",
  *                     telecoms: [{
- *                             value: "string",
+ *                             value: "value",
  *                             use: "HOME"
- *                         }],
- *                     addresses: [],
- *                     period: {},
- *                     canonicalId: CandidApi.preEncounter.CanonicalProviderId("string"),
- *                     fax: "string"
+ *                         }, {
+ *                             value: "value",
+ *                             use: "HOME"
+ *                         }]
+ *                 }, {
+ *                     name: {
+ *                         family: "family",
+ *                         given: ["given", "given"],
+ *                         use: "USUAL"
+ *                     },
+ *                     telecoms: [{
+ *                             value: "value",
+ *                             use: "HOME"
+ *                         }, {
+ *                             value: "value",
+ *                             use: "HOME"
+ *                         }]
  *                 }],
  *             filingOrder: {
- *                 coverages: [CandidApi.preEncounter.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]
+ *                 coverages: [CandidApi.preEncounter.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.preEncounter.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]
  *             },
- *             nonInsurancePayers: [CandidApi.preEncounter.CanonicalNonInsurancePayerId("string")],
- *             nonInsurancePayerAssociations: [{
- *                     id: CandidApi.preEncounter.CanonicalNonInsurancePayerId("string")
- *                 }],
- *             guarantor: {
- *                 name: {
- *                     family: "string",
- *                     given: ["string"],
- *                     use: "USUAL",
- *                     period: {},
- *                     suffix: "string"
- *                 },
- *                 telecom: {
- *                     value: "string",
- *                     use: "HOME"
- *                 },
- *                 email: "string",
- *                 birthDate: "2023-01-15",
- *                 address: {
- *                     use: "HOME",
- *                     line: ["string"],
- *                     city: "string",
- *                     state: "string",
- *                     postalCode: "string",
- *                     country: "string",
- *                     period: {}
- *                 }
- *             },
- *             selfPay: true,
- *             authorizations: [{
- *                     payerId: CandidApi.preEncounter.PayerId("string"),
- *                     payerName: "string",
- *                     additionalPayerInformation: {},
- *                     authorizationNumber: "string",
- *                     cptCode: "string",
- *                     applyForAllCptCodes: true,
- *                     units: "VISIT",
- *                     quantity: 1,
- *                     period: {},
- *                     notes: "string"
- *                 }],
- *             referrals: [{
- *                     provider: {
- *                         name: {
- *                             family: "string",
- *                             given: ["string"],
- *                             use: "USUAL",
- *                             period: {},
- *                             suffix: "string"
- *                         },
- *                         type: "PRIMARY",
- *                         npi: "string",
- *                         telecoms: [{
- *                                 value: "string",
- *                                 use: "HOME"
- *                             }],
- *                         addresses: [],
- *                         period: {},
- *                         canonicalId: CandidApi.preEncounter.CanonicalProviderId("string"),
- *                         fax: "string"
- *                     },
- *                     referralNumber: "string"
- *                 }],
- *             primaryServiceFacilityId: "string",
- *             doNotInvoiceReason: "BANKRUPTCY",
- *             noteIds: [CandidApi.preEncounter.NoteId("string")],
- *             tagIds: [CandidApi.preEncounter.TagId("string")]
+ *             mrn: "mrn"
  *         }
  *     }
  */

package/api/resources/preEncounter/resources/patients/resources/v1/client/requests/PatientGetMultiRequest.d.ts

@@ -3,10 +3,7 @@
  */
 /**
  * @example
- *     {
- *         mrn: "string",
- *         similarNameOrdering: "string"
- *     }
+ *     {}
  */
 export interface PatientGetMultiRequest {
     mrn?: string;

package/api/resources/preEncounter/resources/patients/resources/v1/client/requests/PatientsSearchRequestPaginated.d.ts

@@ -4,13 +4,7 @@
 import * as CandidApi from "../../../../../../../../index";
 /**
  * @example
- *     {
- *         limit: 1,
- *         mrn: "string",
- *         pageToken: CandidApi.preEncounter.PageToken("string"),
- *         sortField: CandidApi.preEncounter.patients.v1.PatientSortField("string"),
- *         sortDirection: "asc"
- *     }
+ *     {}
  */
 export interface PatientsSearchRequestPaginated {
     limit?: number;

package/api/resources/preEncounter/resources/patients/resources/v1/client/requests/SearchProvidersRequest.d.ts

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         searchCriteria: "string"
+ *         searchCriteria: "search_criteria"
  *     }
  */
 export interface SearchProvidersRequest {

package/api/resources/preEncounter/resources/patients/resources/v1/types/MutablePatient.d.ts

@@ -24,9 +24,9 @@ export interface MutablePatient {
     ethnicity?: CandidApi.preEncounter.Ethnicity;
     disabilityStatus?: CandidApi.preEncounter.DisabilityStatus;
     maritalStatus?: CandidApi.preEncounter.patients.v1.MaritalStatus;
-    /** Time of death for the patient. Leave unset if the patient is not deceased. */
+    /** Time of death for the patient.  Leave unset if the patient is not deceased. */
     deceased?: Date;
-    /** The number of siblings the patient was born with. Leave unset if the patient was not part of a multiple birth. */
+    /** The number of siblings the patient was born with.  Leave unset if the patient was not part of a multiple birth. */
     multipleBirth?: number;
     /** The primary address for the patient. */
     primaryAddress: CandidApi.preEncounter.Address;
@@ -40,7 +40,7 @@ export interface MutablePatient {
     electronicCommunicationOptIn?: boolean;
     photo?: string;
     language?: string;
-    /** Information about the upstream system that owns this patient data. Leave unset if Candid owns patient data. */
+    /** Information about the upstream system that owns this patient data.  Leave unset if Candid owns patient data. */
     externalProvenance?: CandidApi.preEncounter.patients.v1.ExternalProvenance;
     /** Contacts for the patient. */
     contacts: CandidApi.preEncounter.patients.v1.Contact[];

package/api/resources/preEncounter/resources/patients/resources/v1/types/Patient.d.ts

@@ -6,8 +6,8 @@ import * as CandidApi from "../../../../../../../index";
  * A patient object with immutable server-owned properties.
  */
 export interface Patient extends CandidApi.preEncounter.BaseModel, CandidApi.preEncounter.patients.v1.MutablePatient {
-    /** The unique UUID identifier for a Patient. Patient ID is used in machine contexts. */
+    /** The unique UUID identifier for a Patient.  Patient ID is used in machine contexts. */
     id: CandidApi.preEncounter.PatientId;
-    /** The medical record number for the patient. Human-friendly Candid generated MRNs are of the form "YYMMDDXXXX", where "YYYYMMDD" is the date of patient creation and "XXXX" is a zero-padded incrementing integer. */
+    /** The medical record number for the patient.  Human-friendly Candid generated MRNs are of the form "YYMMDDXXXX", where "YYYYMMDD" is the date of patient creation and "XXXX" is a zero-padded incrementing integer. */
     mrn: string;
 }