candidhealth 0.24.2 → 0.24.4

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

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../../../../../environments";
 import * as core from "../../../../../../../../core";
-import { Patients } from "../resources/patients/client/Client";
+import * as CandidApi from "../../../../../../../index";
 export declare namespace V1 {
     interface Options {
         environment?: core.Supplier<environments.CandidApiEnvironment | environments.CandidApiEnvironmentUrls>;
@@ -21,6 +21,170 @@ export declare namespace V1 {
 export declare class V1 {
     protected readonly _options: V1.Options;
     constructor(_options?: V1.Options);
-    protected _patients: Patients | undefined;
-    get patients(): Patients;
+    /**
+     * Adds a patient. VersionConflictError is returned when the patient's external ID is already in use.
+     *
+     * @param {CandidApi.preEncounter.patients.v1.MutablePatient} request
+     * @param {V1.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.preEncounter.patients.v1.create({
+     *         name: {},
+     *         otherNames: [{}],
+     *         gender: CandidApi.preEncounter.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"),
+     *         multipleBirth: 1,
+     *         primaryAddress: {},
+     *         otherAddresses: [{}],
+     *         primaryTelecom: {},
+     *         otherTelecoms: [{}],
+     *         email: "string",
+     *         electronicCommunicationOptIn: true,
+     *         photo: "string",
+     *         language: "string",
+     *         externalProvenance: {
+     *             externalId: "string",
+     *             systemName: "string"
+     *         },
+     *         contacts: [{
+     *                 relationship: [CandidApi.preEncounter.Relationship.Self],
+     *                 name: {},
+     *                 gender: CandidApi.preEncounter.Gender.Man,
+     *                 telecoms: [{}],
+     *                 addresses: [{}],
+     *                 period: {}
+     *             }],
+     *         generalPractitioners: [{
+     *                 name: {},
+     *                 npi: "string",
+     *                 telecoms: [{}],
+     *                 addresses: [{}],
+     *                 period: {}
+     *             }],
+     *         filingOrder: {
+     *             coverages: [CandidApi.preEncounter.coverages.v1.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]
+     *         }
+     *     })
+     */
+    create(request: CandidApi.preEncounter.patients.v1.MutablePatient, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient, CandidApi.preEncounter.patients.v1.create.Error>>;
+    /**
+     * Gets a patient.
+     *
+     * @param {CandidApi.preEncounter.patients.v1.PatientId} id
+     * @param {V1.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.preEncounter.patients.v1.get(CandidApi.preEncounter.patients.v1.PatientId("string"))
+     */
+    get(id: CandidApi.preEncounter.patients.v1.PatientId, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient, CandidApi.preEncounter.patients.v1.get.Error>>;
+    /**
+     * Gets a patient along with it's full history. The return list is ordered by version ascending.
+     *
+     * @param {CandidApi.preEncounter.patients.v1.PatientId} id
+     * @param {V1.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.preEncounter.patients.v1.getHistory(CandidApi.preEncounter.patients.v1.PatientId("string"))
+     */
+    getHistory(id: CandidApi.preEncounter.patients.v1.PatientId, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient[], CandidApi.preEncounter.patients.v1.getHistory.Error>>;
+    /**
+     * Updates a patient. The path must contain the most recent version to prevent races. Updating historic versions is not supported.
+     *
+     * @param {CandidApi.preEncounter.patients.v1.PatientId} id
+     * @param {string} version
+     * @param {CandidApi.preEncounter.patients.v1.MutablePatient} request
+     * @param {V1.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.preEncounter.patients.v1.update(CandidApi.preEncounter.patients.v1.PatientId("string"), "string", {
+     *         name: {},
+     *         otherNames: [{}],
+     *         gender: CandidApi.preEncounter.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"),
+     *         multipleBirth: 1,
+     *         primaryAddress: {},
+     *         otherAddresses: [{}],
+     *         primaryTelecom: {},
+     *         otherTelecoms: [{}],
+     *         email: "string",
+     *         electronicCommunicationOptIn: true,
+     *         photo: "string",
+     *         language: "string",
+     *         externalProvenance: {
+     *             externalId: "string",
+     *             systemName: "string"
+     *         },
+     *         contacts: [{
+     *                 relationship: [CandidApi.preEncounter.Relationship.Self],
+     *                 name: {},
+     *                 gender: CandidApi.preEncounter.Gender.Man,
+     *                 telecoms: [{}],
+     *                 addresses: [{}],
+     *                 period: {}
+     *             }],
+     *         generalPractitioners: [{
+     *                 name: {},
+     *                 npi: "string",
+     *                 telecoms: [{}],
+     *                 addresses: [{}],
+     *                 period: {}
+     *             }],
+     *         filingOrder: {
+     *             coverages: [CandidApi.preEncounter.coverages.v1.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]
+     *         }
+     *     })
+     */
+    update(id: CandidApi.preEncounter.patients.v1.PatientId, version: string, request: CandidApi.preEncounter.patients.v1.MutablePatient, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient, CandidApi.preEncounter.patients.v1.update.Error>>;
+    /**
+     * Sets a patient as deactivated. The path must contain the most recent version to prevent races. Dactivating historic versions is not supported. Subsequent updates via PUT to the patient will "reactivate" the patient and set the deactivated flag to false.
+     *
+     * @param {CandidApi.preEncounter.patients.v1.PatientId} id
+     * @param {string} version
+     * @param {V1.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.preEncounter.patients.v1.deactivate(CandidApi.preEncounter.patients.v1.PatientId("string"), "string")
+     */
+    deactivate(id: CandidApi.preEncounter.patients.v1.PatientId, version: string, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<void, CandidApi.preEncounter.patients.v1.deactivate.Error>>;
+    /**
+     * Searches for patients that match the query parameters.
+     *
+     * @param {CandidApi.preEncounter.patients.v1.PatientsSearchRequest} request
+     * @param {V1.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.preEncounter.patients.v1.search({
+     *         nameContains: "string"
+     *     })
+     */
+    search(request?: CandidApi.preEncounter.patients.v1.PatientsSearchRequest, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient[], CandidApi.preEncounter.patients.v1.search.Error>>;
+    /**
+     * Scans up to 100 patient updates. The since query parameter is inclusive, and the result list is ordered by updatedAt descending.
+     *
+     * @param {CandidApi.preEncounter.patients.v1.PatientScanRequest} request
+     * @param {V1.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.preEncounter.patients.v1.scan({
+     *         since: new Date("2024-01-15T09:30:00.000Z")
+     *     })
+     */
+    scan(request: CandidApi.preEncounter.patients.v1.PatientScanRequest, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient[], CandidApi.preEncounter.patients.v1.scan.Error>>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }