candidhealth 0.39.2 → 0.39.4

package/reference.md

@@ -2911,14 +2911,7 @@ await client.encounters.v4.create({
     clinicalNotes: [
         {
             category: CandidApi.NoteCategory.Clinical,
-            notes: [
-                {
-                    text: "string",
-                    authorName: "string",
-                    authorNpi: CandidApi.Npi("string"),
-                    timestamp: new Date("2024-01-15T09:30:00.000Z"),
-                },
-            ],
+            notes: [],
         },
     ],
     billingNotes: [
@@ -2952,47 +2945,10 @@ await client.encounters.v4.create({
     ],
     serviceLines: [
         {
-            modifiers: [CandidApi.ProcedureModifier.TwentyTwo],
             procedureCode: "string",
             quantity: CandidApi.Decimal("string"),
             units: CandidApi.ServiceLineUnits.Mj,
-            chargeAmountCents: 1,
-            diagnosisPointers: [1],
-            drugIdentification: {
-                serviceIdQualifier: CandidApi.ServiceIdQualifier.EanUcc13,
-                nationalDrugCode: "string",
-                nationalDrugUnitCount: "string",
-                measurementUnitCode: CandidApi.MeasurementUnitCode.Milliliters,
-                linkSequenceNumber: "string",
-                pharmacyPrescriptionNumber: "string",
-                conversionFormula: "string",
-                drugDescription: "string",
-            },
-            placeOfServiceCode: CandidApi.FacilityTypeCode.Pharmacy,
-            description: "string",
-            dateOfService: "2023-01-15",
-            endDateOfService: "2023-01-15",
-            orderingProvider: {
-                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",
-            },
-            testResults: [
-                {
-                    value: 1.1,
-                    resultType: CandidApi.TestResultType.Hematocrit,
-                },
-            ],
+            diagnosisPointers: [],
         },
     ],
     guarantor: {
@@ -3049,6 +3005,11 @@ await client.encounters.v4.create({
         },
     ],
     referralNumber: "string",
+    epsdtReferral: {
+        conditionIndicator1: CandidApi.EpsdtReferralConditionIndicatorCode.Av,
+        conditionIndicator2: CandidApi.EpsdtReferralConditionIndicatorCode.Av,
+        conditionIndicator3: CandidApi.EpsdtReferralConditionIndicatorCode.Av,
+    },
     externalId: CandidApi.EncounterExternalId("string"),
     dateOfService: "2023-01-15",
     endDateOfService: "2023-01-15",
@@ -3283,14 +3244,7 @@ await client.encounters.v4.createFromPreEncounterPatient({
     clinicalNotes: [
         {
             category: CandidApi.NoteCategory.Clinical,
-            notes: [
-                {
-                    text: "string",
-                    authorName: "string",
-                    authorNpi: CandidApi.Npi("string"),
-                    timestamp: new Date("2024-01-15T09:30:00.000Z"),
-                },
-            ],
+            notes: [],
         },
     ],
     billingNotes: [
@@ -3324,49 +3278,316 @@ await client.encounters.v4.createFromPreEncounterPatient({
     ],
     serviceLines: [
         {
-            modifiers: [CandidApi.ProcedureModifier.TwentyTwo],
             procedureCode: "string",
             quantity: CandidApi.Decimal("string"),
             units: CandidApi.ServiceLineUnits.Mj,
-            chargeAmountCents: 1,
-            diagnosisPointers: [1],
-            drugIdentification: {
-                serviceIdQualifier: CandidApi.ServiceIdQualifier.EanUcc13,
-                nationalDrugCode: "string",
-                nationalDrugUnitCount: "string",
-                measurementUnitCode: CandidApi.MeasurementUnitCode.Milliliters,
-                linkSequenceNumber: "string",
-                pharmacyPrescriptionNumber: "string",
-                conversionFormula: "string",
-                drugDescription: "string",
+            diagnosisPointers: [],
+        },
+    ],
+    externalClaimSubmission: {
+        claimCreatedAt: new Date("2023-01-01T12:00:00.000Z"),
+        patientControlNumber: "PATIENT_CONTROL_NUMBER",
+        submissionRecords: [
+            {
+                submittedAt: new Date("2023-01-01T13:00:00.000Z"),
+                claimFrequencyCode: CandidApi.ClaimFrequencyTypeCode.Original,
+                payerResponsibility: CandidApi.ClaimSubmissionPayerResponsibilityType.Primary,
+                intendedSubmissionMedium: CandidApi.IntendedSubmissionMedium.Electronic,
             },
-            placeOfServiceCode: CandidApi.FacilityTypeCode.Pharmacy,
-            description: "string",
-            dateOfService: "2023-01-15",
-            endDateOfService: "2023-01-15",
-            orderingProvider: {
-                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",
+            {
+                submittedAt: new Date("2023-01-04T12:00:00.000Z"),
+                claimFrequencyCode: CandidApi.ClaimFrequencyTypeCode.Replacement,
+                payerResponsibility: CandidApi.ClaimSubmissionPayerResponsibilityType.Primary,
+                intendedSubmissionMedium: CandidApi.IntendedSubmissionMedium.Paper,
+            },
+        ],
+    },
+    tagIds: [CandidApi.TagId("string")],
+    schemaInstances: [
+        {
+            schemaId: CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582"),
+            content: {
+                provider_category: "internist",
+                is_urgent_care: true,
+                bmi: 24.2,
+                age: 38,
+            },
+        },
+    ],
+    externalId: CandidApi.EncounterExternalId("string"),
+    dateOfService: "2023-01-15",
+    endDateOfService: "2023-01-15",
+    patientAuthorizedRelease: true,
+    benefitsAssignedToProvider: true,
+    providerAcceptsAssignment: true,
+    appointmentType: "string",
+    existingMedications: [
+        {
+            name: "Lisinopril",
+            rxCui: CandidApi.RxCui("860975"),
+            dosage: "10mg",
+            dosageForm: "Tablet",
+            frequency: "Once Daily",
+            asNeeded: true,
+        },
+    ],
+    vitals: {
+        heightIn: 70,
+        weightLbs: 165,
+        bloodPressureSystolicMmhg: 115,
+        bloodPressureDiastolicMmhg: 85,
+        bodyTemperatureF: 98,
+        hemoglobinGdl: 15.1,
+        hematocritPct: 51.2,
+    },
+    interventions: [
+        {
+            name: "Physical Therapy Session",
+            category: CandidApi.InterventionCategory.Lifestyle,
+            description:
+                "A session focused on improving muscular strength, flexibility, and range of motion post-injury.",
+            medication: {
+                name: "Lisinopril",
+                rxCui: CandidApi.RxCui("860975"),
+                dosage: "10mg",
+                dosageForm: "Tablet",
+                frequency: "Once Daily",
+                asNeeded: true,
             },
-            testResults: [
+            labs: [
                 {
-                    value: 1.1,
-                    resultType: CandidApi.TestResultType.Hematocrit,
+                    name: "Genetic Health Labs",
+                    code: "GH12345",
+                    codeType: CandidApi.LabCodeType.Quest,
                 },
             ],
         },
     ],
+    payToAddress: {
+        address1: "123 Main St",
+        address2: "Apt 1",
+        city: "New York",
+        state: CandidApi.State.Ny,
+        zipCode: "10001",
+        zipPlusFourCode: "1234",
+    },
+    synchronicity: CandidApi.SynchronicityType.Synchronous,
+    billableStatus: CandidApi.BillableStatusType.Billable,
+    additionalInformation: "string",
+    serviceAuthorizationExceptionCode: CandidApi.ServiceAuthorizationExceptionCode.C1,
+    admissionDate: "2023-01-15",
+    dischargeDate: "2023-01-15",
+    onsetOfCurrentIllnessOrSymptomDate: "2023-01-15",
+    lastMenstrualPeriodDate: "2023-01-15",
+    delayReasonCode: CandidApi.DelayReasonCode.C1,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.EncounterCreateFromPreEncounter`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V4.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.encounters.v4.<a href="/src/api/resources/encounters/resources/v4/client/Client.ts">createFromPreEncounterPatientInternal</a>({ ...params }) -> core.APIResponse<CandidApi.Encounter, CandidApi.encounters.v4.createFromPreEncounterPatientInternal.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create an encounter from a pre-encounter patient and appointment. This endpoint is intended to be used by consumers who are managing
+patients and appointments in the pre-encounter service and is currently under development. Consumers who are not taking advantage
+of the pre-encounter service should use the standard create endpoint.
+
+The endpoint will create an encounter from the provided fields, pulling information from the provided patient and appointment objects
+where applicable. In particular, the following fields are populated from the patient and appointment objects:
+
+-   Patient
+-   Referring Provider
+-   Subscriber Primary
+-   Subscriber Secondary
+-   Referral Number
+-   Responsible Party
+-   Guarantor
+
+Utilizing this endpoint opts you into automatic updating of the encounter when the patient or appointment is updated, assuming the
+encounter has not already been submitted or adjudicated.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.encounters.v4.createFromPreEncounterPatientInternal({
+    preEncounterPatientId: CandidApi.PreEncounterPatientId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+    preEncounterAppointmentIds: [CandidApi.PreEncounterAppointmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
+    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",
+        providerCommercialLicenseType: CandidApi.BillingProviderCommercialLicenseType.LicensedClinicalSocialWorker,
+        firstName: "string",
+        lastName: "string",
+        organizationName: "string",
+    },
+    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",
+    },
+    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",
+    },
+    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",
+    },
+    serviceFacility: {
+        organizationName: "string",
+        npi: "string",
+        address: {
+            address1: "123 Main St",
+            address2: "Apt 1",
+            city: "New York",
+            state: CandidApi.State.Ny,
+            zipCode: "10001",
+            zipPlusFourCode: "1234",
+        },
+        secondaryIdentification: "string",
+    },
+    diagnoses: [
+        {
+            name: "string",
+            codeType: CandidApi.DiagnosisTypeCode.Abf,
+            code: "string",
+        },
+    ],
+    clinicalNotes: [
+        {
+            category: CandidApi.NoteCategory.Clinical,
+            notes: [],
+        },
+    ],
+    billingNotes: [
+        {
+            text: "string",
+        },
+    ],
+    placeOfServiceCode: CandidApi.FacilityTypeCode.Pharmacy,
+    patientHistories: [
+        {
+            category: CandidApi.PatientHistoryCategoryEnum.PresentIllness,
+            questions: [
+                {
+                    id: CandidApi.IntakeQuestionId("6E7FBCE4-A8EA-46D0-A8D8-FF83CA3BB176"),
+                    text: "Do you have any allergies?",
+                    responses: [
+                        {
+                            response: "No allergies",
+                            followUps: [
+                                {
+                                    id: CandidApi.IntakeFollowUpId("4F3D57F9-AC94-49D6-87E4-E804B709917A"),
+                                    text: "Do you have any allergies?",
+                                    response: "No allergies",
+                                },
+                            ],
+                        },
+                    ],
+                },
+            ],
+        },
+    ],
+    serviceLines: [
+        {
+            procedureCode: "string",
+            quantity: CandidApi.Decimal("string"),
+            units: CandidApi.ServiceLineUnits.Mj,
+            diagnosisPointers: [],
+        },
+    ],
     externalClaimSubmission: {
         claimCreatedAt: new Date("2023-01-01T12:00:00.000Z"),
         patientControlNumber: "PATIENT_CONTROL_NUMBER",
@@ -3479,7 +3700,7 @@ await client.encounters.v4.createFromPreEncounterPatient({
 <dl>
 <dd>
 
-**request:** `CandidApi.encounters.v4.EncounterCreateFromPreEncounter`
+**request:** `CandidApi.EncounterCreateFromPreEncounter`
 
 </dd>
 </dl>
@@ -8778,6 +8999,8 @@ await client.serviceLines.v2.create({
             resultType: CandidApi.TestResultType.Hematocrit,
         },
     ],
+    hasEpsdtIndicator: true,
+    hasFamilyPlanningIndicator: true,
 });
 ```
 
@@ -8860,6 +9083,8 @@ await client.serviceLines.v2.update(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-
             resultType: CandidApi.TestResultType.Hematocrit,
         },
     ],
+    hasEpsdtIndicator: true,
+    hasFamilyPlanningIndicator: true,
 });
 ```
 
@@ -10045,12 +10270,7 @@ await client.preEncounter.coverages.v1.create({
         memberId: "string",
         payerId: CandidApi.PayerId("string"),
         payerName: "string",
-        additionalPayerInformation: {
-            availityEligibilityId: "string",
-            availityPayerId: "string",
-            availityPayerName: "string",
-            availityRemittancePayerId: "string",
-        },
+        additionalPayerInformation: {},
         groupNumber: "string",
         name: "string",
         planType: CandidApi.NetworkType.SelfPay,
@@ -10164,12 +10384,7 @@ await client.preEncounter.coverages.v1.update(CandidApi.CoverageId("d5e9c84f-c2b
         memberId: "string",
         payerId: CandidApi.PayerId("string"),
         payerName: "string",
-        additionalPayerInformation: {
-            availityEligibilityId: "string",
-            availityPayerId: "string",
-            availityPayerName: "string",
-            availityRemittancePayerId: "string",
-        },
+        additionalPayerInformation: {},
         groupNumber: "string",
         name: "string",
         planType: CandidApi.NetworkType.SelfPay,
@@ -11259,9 +11474,13 @@ await client.preEncounter.patients.v1.create({
             {
                 payerId: CandidApi.PayerId("string"),
                 payerName: "string",
+                additionalPayerInformation: {},
                 authorizationNumber: "string",
                 cptCode: "string",
                 units: CandidApi.AuthorizationUnit.Visit,
+                quantity: 1,
+                period: {},
+                notes: "string",
             },
         ],
         referrals: [
@@ -11511,9 +11730,13 @@ await client.preEncounter.patients.v1.createWithMrn({
             {
                 payerId: CandidApi.PayerId("string"),
                 payerName: "string",
+                additionalPayerInformation: {},
                 authorizationNumber: "string",
                 cptCode: "string",
                 units: CandidApi.AuthorizationUnit.Visit,
+                quantity: 1,
+                period: {},
+                notes: "string",
             },
         ],
         referrals: [
@@ -11955,9 +12178,13 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
         {
             payerId: CandidApi.PayerId("string"),
             payerName: "string",
+            additionalPayerInformation: {},
             authorizationNumber: "string",
             cptCode: "string",
             units: CandidApi.AuthorizationUnit.Visit,
+            quantity: 1,
+            period: {},
+            notes: "string",
         },
     ],
     referrals: [

package/serialization/resources/commons/types/EpsdtReferralConditionIndicatorCode.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../index";
+import * as CandidApi from "../../../../api/index";
+import * as core from "../../../../core";
+export declare const EpsdtReferralConditionIndicatorCode: core.serialization.Schema<serializers.EpsdtReferralConditionIndicatorCode.Raw, CandidApi.EpsdtReferralConditionIndicatorCode>;
+export declare namespace EpsdtReferralConditionIndicatorCode {
+    type Raw = "AV" | "NU" | "S2" | "ST";
+}

package/serialization/resources/commons/types/EpsdtReferralConditionIndicatorCode.js

@@ -0,0 +1,31 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EpsdtReferralConditionIndicatorCode = void 0;
+const core = __importStar(require("../../../../core"));
+exports.EpsdtReferralConditionIndicatorCode = core.serialization.enum_(["AV", "NU", "S2", "ST"]);

package/serialization/resources/commons/types/index.d.ts

@@ -64,3 +64,4 @@ export * from "./Email";
 export * from "./DelayReasonCode";
 export * from "./IntendedSubmissionMedium";
 export * from "./BillingProviderCommercialLicenseType";
+export * from "./EpsdtReferralConditionIndicatorCode";

package/serialization/resources/commons/types/index.js

@@ -80,3 +80,4 @@ __exportStar(require("./Email"), exports);
 __exportStar(require("./DelayReasonCode"), exports);
 __exportStar(require("./IntendedSubmissionMedium"), exports);
 __exportStar(require("./BillingProviderCommercialLicenseType"), exports);
+__exportStar(require("./EpsdtReferralConditionIndicatorCode"), exports);

package/serialization/resources/encounters/resources/v4/client/createFromPreEncounterPatientInternal.d.ts

@@ -0,0 +1,39 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../../../index";
+import * as CandidApi from "../../../../../../api/index";
+import * as core from "../../../../../../core";
+import { EncounterExternalIdUniquenessErrorType } from "../types/EncounterExternalIdUniquenessErrorType";
+import { EncounterPatientControlNumberUniquenessErrorType } from "../types/EncounterPatientControlNumberUniquenessErrorType";
+import { EntityNotFoundErrorMessage } from "../../../../commons/types/EntityNotFoundErrorMessage";
+import { RequestValidationError } from "../../../../commons/types/RequestValidationError";
+import { SchemaInstanceValidationFailure } from "../types/SchemaInstanceValidationFailure";
+export declare const Error: core.serialization.Schema<serializers.encounters.v4.createFromPreEncounterPatientInternal.Error.Raw, CandidApi.encounters.v4.createFromPreEncounterPatientInternal.Error>;
+export declare namespace Error {
+    type Raw = Error.EncounterExternalIdUniquenessError | Error.EncounterPatientControlNumberUniquenessError | Error.EntityNotFoundError | Error.HttpRequestValidationsError | Error.SchemaInstanceValidationHttpFailure | Error.HttpRequestValidationError;
+    interface EncounterExternalIdUniquenessError {
+        errorName: "EncounterExternalIdUniquenessError";
+        content: EncounterExternalIdUniquenessErrorType.Raw;
+    }
+    interface EncounterPatientControlNumberUniquenessError {
+        errorName: "EncounterPatientControlNumberUniquenessError";
+        content: EncounterPatientControlNumberUniquenessErrorType.Raw;
+    }
+    interface EntityNotFoundError {
+        errorName: "EntityNotFoundError";
+        content: EntityNotFoundErrorMessage.Raw;
+    }
+    interface HttpRequestValidationsError {
+        errorName: "HttpRequestValidationsError";
+        content: RequestValidationError.Raw[];
+    }
+    interface SchemaInstanceValidationHttpFailure {
+        errorName: "SchemaInstanceValidationHttpFailure";
+        content: SchemaInstanceValidationFailure.Raw;
+    }
+    interface HttpRequestValidationError {
+        errorName: "HttpRequestValidationError";
+        content: RequestValidationError.Raw;
+    }
+}