candidhealth 1.6.0 → 1.8.1

package/dist/api/resources/encounters/resources/v4/types/EncounterUpdate.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface EncounterUpdate extends CandidApi.encountersUniversal.UniversalEncounterUpdateBase {
+    /**
+     * If a vitals entity already exists for the encounter, then all values will be updated to the provided values.
+     * Otherwise, a new vitals object will be created for the encounter.
+     */
+    vitals?: CandidApi.encounters.v4.VitalsUpdate;
+    /**
+     * Ideally, this field should contain no more than 12 diagnoses. However, more diagnoses
+     * may be submitted at this time, and coders will later prioritize the 12 that will be
+     * submitted to the payor.
+     */
+    diagnosisIds?: CandidApi.DiagnosisId[];
+}

package/dist/api/resources/encounters/resources/v4/types/EncounterUpdate.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/encounters/resources/v4/types/index.d.ts

@@ -1,13 +1,13 @@
+export * from "./EncounterCreate";
+export * from "./EncounterUpdate";
+export * from "./Encounter";
 export * from "./EncounterCreateFromPreEncounter";
 export * from "./EncounterBase";
 export * from "./EncounterOptional";
 export * from "./EncounterDeepOptional";
-export * from "./Encounter";
 export * from "./EncounterSortOptions";
 export * from "./Medication";
 export * from "./MedicationOptional";
-export * from "./Vitals";
-export * from "./VitalsUpdate";
 export * from "./Intervention";
 export * from "./InterventionOptional";
 export * from "./InterventionCategory";
@@ -22,9 +22,9 @@ export * from "./IntakeQuestionOptional";
 export * from "./IntakeResponseAndFollowUps";
 export * from "./IntakeFollowUp";
 export * from "./ClinicalNoteCategoryCreate";
+export * from "./NoteCategory";
 export * from "./ClinicalNoteCategoryCreateOptional";
 export * from "./ClinicalNoteCategory";
-export * from "./NoteCategory";
 export * from "./ClinicalNote";
 export * from "./ClinicalNoteOptional";
 export * from "./ResponsiblePartyType";
@@ -58,4 +58,7 @@ export * from "./ValueDoesNotMatchKeyTypeError";
 export * from "./MultipleInstancesForSchemaError";
 export * from "./SchemaInstanceValidationError";
 export * from "./PayerPlanGroupPayerDoesNotMatchInsuranceCardError";
+export * from "./EncounterRenderingOrAttendingProviderRequiredError";
 export * from "./EncounterSubmissionExpectation";
+export * from "./Vitals";
+export * from "./VitalsUpdate";

package/dist/api/resources/encounters/resources/v4/types/index.js

@@ -14,16 +14,16 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./EncounterCreate"), exports);
+__exportStar(require("./EncounterUpdate"), exports);
+__exportStar(require("./Encounter"), exports);
 __exportStar(require("./EncounterCreateFromPreEncounter"), exports);
 __exportStar(require("./EncounterBase"), exports);
 __exportStar(require("./EncounterOptional"), exports);
 __exportStar(require("./EncounterDeepOptional"), exports);
-__exportStar(require("./Encounter"), exports);
 __exportStar(require("./EncounterSortOptions"), exports);
 __exportStar(require("./Medication"), exports);
 __exportStar(require("./MedicationOptional"), exports);
-__exportStar(require("./Vitals"), exports);
-__exportStar(require("./VitalsUpdate"), exports);
 __exportStar(require("./Intervention"), exports);
 __exportStar(require("./InterventionOptional"), exports);
 __exportStar(require("./InterventionCategory"), exports);
@@ -38,9 +38,9 @@ __exportStar(require("./IntakeQuestionOptional"), exports);
 __exportStar(require("./IntakeResponseAndFollowUps"), exports);
 __exportStar(require("./IntakeFollowUp"), exports);
 __exportStar(require("./ClinicalNoteCategoryCreate"), exports);
+__exportStar(require("./NoteCategory"), exports);
 __exportStar(require("./ClinicalNoteCategoryCreateOptional"), exports);
 __exportStar(require("./ClinicalNoteCategory"), exports);
-__exportStar(require("./NoteCategory"), exports);
 __exportStar(require("./ClinicalNote"), exports);
 __exportStar(require("./ClinicalNoteOptional"), exports);
 __exportStar(require("./ResponsiblePartyType"), exports);
@@ -74,4 +74,7 @@ __exportStar(require("./ValueDoesNotMatchKeyTypeError"), exports);
 __exportStar(require("./MultipleInstancesForSchemaError"), exports);
 __exportStar(require("./SchemaInstanceValidationError"), exports);
 __exportStar(require("./PayerPlanGroupPayerDoesNotMatchInsuranceCardError"), exports);
+__exportStar(require("./EncounterRenderingOrAttendingProviderRequiredError"), exports);
 __exportStar(require("./EncounterSubmissionExpectation"), exports);
+__exportStar(require("./Vitals"), exports);
+__exportStar(require("./VitalsUpdate"), exports);

package/dist/api/resources/encountersUniversal/index.d.ts

@@ -0,0 +1 @@
+export * from "./types";

package/dist/api/resources/encountersUniversal/index.js

@@ -0,0 +1,17 @@
+"use strict";
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);

package/dist/api/resources/encountersUniversal/types/UniversalEncounterCreate.d.ts

@@ -0,0 +1,49 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../index";
+export interface UniversalEncounterCreate extends CandidApi.encountersUniversal.UniversalEncounterCreateBase {
+    /** The billing provider is the provider or business entity submitting the claim. Billing provider may be, but is not necessarily, the same person/NPI as the rendering provider. From a payer's perspective, this represents the person or entity being reimbursed. When a contract exists with the target payer, the billing provider should be the entity contracted with the payer. In some circumstances, this will be an individual provider. In that case, submit that provider's NPI and the tax ID (TIN) that the provider gave to the payer during contracting. In other cases, the billing entity will be a medical group. If so, submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim or Form Locator 1 on a UB-04 claim form. */
+    billingProvider: CandidApi.encounterProviders.v2.BillingProvider;
+    /** Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. This box is not used on a UB-04 or 837i claim form. 02 for telemedicine, 11 for in-person. Full list [here](https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set). */
+    placeOfServiceCode?: CandidApi.FacilityTypeCode;
+    /**
+     * The rendering provider is the practitioner -- physician, nurse practitioner, etc. -- performing the service.
+     * For telehealth services, the rendering provider performs the visit, asynchronous communication, or other service. The rendering provider address should generally be the same as the service facility address.
+     */
+    renderingProvider?: CandidApi.encounterProviders.v2.RenderingProvider;
+    serviceLines?: CandidApi.serviceLines.v2.UniversalServiceLineCreate[];
+    /** The health care code information associated with this encounter, which includes things such as diagnoses, vitals, procedures, occurrences, reason for visit, and numerous other code related fields. */
+    healthCareCodeInformation?: CandidApi.healthCareCodeInformation.v1.HealthCareCodeInformationCreate;
+    /** Describes the currently expected target form for this encounter.  This can change later, but it orients this encounter in the pipeline and effects reporting. */
+    submissionExpectation: CandidApi.encounters.v4.EncounterSubmissionExpectation;
+    /** 837i NM1 2500 variant for Loop ID-2310.  Used to indicate the individual whom has overall responsibility for the patient in institutional claims processing. */
+    attendingProvider?: CandidApi.encounterProviders.v2.RenderingProvider;
+    /**
+     * 837i Loop 2300 DTP-03
+     * Extension of the admission date with hour (0-23 integer) details.
+     */
+    admissionHour?: number;
+    /** 837i Loop 2300 CL1-01 Code used to indicate the priority of an admission or visit. Equivalent to Form Locator 14 Priority of Admission on a UB-04 claim, not used on CMS-1500 claim forms. */
+    admissionTypeCode?: CandidApi.x12.v1.TypeOfAdmissionOrVisitCode;
+    /** 837i Loop 2300 CLI1-02 Code used to indicate the conditions under which an admission occurs. Equivalent to Form Locator 15 Point of Origin on a UB-04 claim, not used on CMS-1500 claim forms. */
+    admissionSourceCode?: CandidApi.x12.v1.PointOfOriginForAdmissionOrVisitCode;
+    /**
+     * 837i Loop 2300 DTP-03
+     * Extension of the discharge date with hour (0-23 integer) details.
+     */
+    dischargeHour?: number;
+    /**
+     * 837i CL1-03 or Form Locator 17 on a UB-04 claim form. This is a required field on UB-04 claims.
+     * Code indicating patient status as of the "statement covers through date" .
+     */
+    dischargeStatus?: CandidApi.x12.v1.PatientDischargeStatusCode;
+    /** 837i NM1 2500 variant for Loop ID-2310.  Used to indicate the individual whom has primary responsibility for surgical procedures in institutional claims processing. */
+    operatingProvider?: CandidApi.encounterProviders.v2.RenderingProvider;
+    /** 837i NM1 2500 variant for Loop ID-2310.  Used to indicate the individual whom has secondary responsibility for surgical procedures in institutional claims processing.  Only used when operating_provider is also set. */
+    otherOperatingProvider?: CandidApi.encounterProviders.v2.RenderingProvider;
+    /** Four digit code used in institutional forms to indicate the type of bill (e.g., hospital inpatient, hospital outpatient). First digit is a leading 0, followed by the type_of_facility, type_of_care, then frequency_code. Professional forms are not required to submit this attribute. You may send the 4 digit code via raw_code, or each individual digit separately via composite_codes. */
+    typeOfBill?: CandidApi.x12.v1.TypeOfBillCompositeUpdate;
+    /** 837i-REF1000 -- an optional state indicating where an accident related to the encounter occurred. */
+    accidentStateOrProvinceCode?: CandidApi.State;
+}

package/dist/api/resources/encountersUniversal/types/UniversalEncounterCreate.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/{encounters/resources/v4/client/requests/EncounterCreate.d.ts → encountersUniversal/types/UniversalEncounterCreateBase.d.ts}

@@ -1,58 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as CandidApi from "../../../../../../index";
-/**
- * @example
- *     {
- *         patient: {
- *             firstName: "first_name",
- *             lastName: "last_name",
- *             gender: "male",
- *             externalId: "external_id",
- *             dateOfBirth: "2023-01-15",
- *             address: {
- *                 address1: "address1",
- *                 city: "city",
- *                 state: "AA",
- *                 zipCode: "zip_code"
- *             }
- *         },
- *         billingProvider: {
- *             address: {
- *                 address1: "address1",
- *                 city: "city",
- *                 state: "AA",
- *                 zipCode: "zip_code",
- *                 zipPlusFourCode: "zip_plus_four_code"
- *             },
- *             taxId: "tax_id",
- *             npi: "npi"
- *         },
- *         renderingProvider: {
- *             npi: "npi"
- *         },
- *         responsibleParty: "INSURANCE_PAY",
- *         diagnoses: [{
- *                 codeType: "ABF",
- *                 code: "code"
- *             }, {
- *                 codeType: "ABF",
- *                 code: "code"
- *             }],
- *         placeOfServiceCode: "01"
- *     }
- */
-export interface EncounterCreate extends CandidApi.encounters.v4.EncounterBase {
+import * as CandidApi from "../../../index";
+export interface UniversalEncounterCreateBase extends CandidApi.encounters.v4.EncounterBase {
     /** Contains the identification information of the individual receiving medical services. */
     patient: CandidApi.PatientCreate;
-    /** The billing provider is the provider or business entity submitting the claim. Billing provider may be, but is not necessarily, the same person/NPI as the rendering provider. From a payer's perspective, this represents the person or entity being reimbursed. When a contract exists with the target payer, the billing provider should be the entity contracted with the payer. In some circumstances, this will be an individual provider. In that case, submit that provider's NPI and the tax ID (TIN) that the provider gave to the payer during contracting. In other cases, the billing entity will be a medical group. If so, submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim form. */
-    billingProvider: CandidApi.encounterProviders.v2.BillingProvider;
-    /**
-     * The rendering provider is the practitioner -- physician, nurse practitioner, etc. -- performing the service.
-     * For telehealth services, the rendering provider performs the visit, asynchronous communication, or other service. The rendering provider address should generally be the same as the service facility address.
-     */
-    renderingProvider: CandidApi.encounterProviders.v2.RenderingProvider;
     /**
      * The final provider who referred the services that were rendered.
      * All physicians who order services or refer Medicare beneficiaries must
@@ -60,13 +12,14 @@ export interface EncounterCreate extends CandidApi.encounters.v4.EncounterBase {
      */
     referringProvider?: CandidApi.encounterProviders.v2.ReferringProvider;
     /**
-     * The second iteration of Loop ID-2310. Use code "P3 - Primary Care Provider" in this loop to
+     * The second iteration of Loop ID-2310 on an 837P form. Use code "P3 - Primary Care Provider" in this loop to
      * indicate the initial referral from the primary care provider or whatever provider wrote the initial referral for this patient's episode of care being billed/reported in this transaction.
+     * Not used in an 837i claim
      */
     initialReferringProvider?: CandidApi.encounterProviders.v2.InitialReferringProvider;
     /** Required when the rendering provider is supervised by a physician. If not required by this implementation guide, do not send. */
     supervisingProvider?: CandidApi.encounterProviders.v2.SupervisingProvider;
-    /** Encounter Service facility is typically the location a medical service was rendered, such as a provider office or hospital. For telehealth, service facility can represent the provider's location when the service was delivered (e.g., home), or the location where an in-person visit would have taken place, whichever is easier to identify. If the provider is in-network, service facility may be defined in payer contracts. Box 32 on the CMS-1500 claim form. Note that for an in-network claim to be successfully adjudicated, the service facility address listed on claims must match what was provided to the payer during the credentialing process. */
+    /** Encounter Service facility is typically the location a medical service was rendered, such as a provider office or hospital. For telehealth, service facility can represent the provider's location when the service was delivered (e.g., home), or the location where an in-person visit would have taken place, whichever is easier to identify. If the provider is in-network, service facility may be defined in payer contracts. Box 32 on the CMS-1500 claim form. There is no equivalent on the paper UB-04 claim form, but this field is equivalent to Loop 2310E Service Facility Location details on an 837i form, and is used when this is different to the entity identified as the Billing Provider. Note that for an in-network claim to be successfully adjudicated, the service facility address listed */
     serviceFacility?: CandidApi.EncounterServiceFacilityBase;
     /**
      * Subscriber_primary is required when responsible_party is INSURANCE_PAY (i.e. when the claim should be billed to insurance).
@@ -79,16 +32,10 @@ export interface EncounterCreate extends CandidApi.encounters.v4.EncounterBase {
     subscriberSecondary?: CandidApi.SubscriberCreate;
     /** Please always include this when you have it, even for self-pay claims. */
     subscriberTertiary?: CandidApi.SubscriberCreate;
-    /** Box 23 on the CMS-1500 claim form. */
+    /** Box 23 on the CMS-1500 claim form or Form Locator 63 on a UB-04 claim form. */
     priorAuthorizationNumber?: CandidApi.encounters.v4.PriorAuthorizationNumber;
     /** Defines the party to be billed with the initial balance owed on the claim. */
     responsibleParty: CandidApi.encounters.v4.ResponsiblePartyType;
-    /**
-     * Ideally, this field should contain no more than 12 diagnoses. However, more diagnoses
-     * may be submitted at this time, and coders will later prioritize the 12 that will be
-     * submitted to the payor.
-     */
-    diagnoses: CandidApi.DiagnosisCreate[];
     /** Holds a collection of clinical observations made by healthcare providers during patient encounters. Please note that medical records for appeals should be sent using the Encounter Attachments API. */
     clinicalNotes?: CandidApi.encounters.v4.ClinicalNoteCategoryCreate[];
     /**
@@ -96,15 +43,7 @@ export interface EncounterCreate extends CandidApi.encounters.v4.EncounterBase {
      * in the billing process.
      */
     billingNotes?: CandidApi.billingNotes.v2.BillingNoteBase[];
-    /** Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for telemedicine, 11 for in-person. Full list [here](https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set). */
-    placeOfServiceCode: CandidApi.FacilityTypeCode;
     patientHistories?: CandidApi.encounters.v4.PatientHistoryCategory[];
-    /**
-     * Each service line must be linked to a diagnosis. Concretely,
-     * `service_line.diagnosis_pointers`must contain at least one entry which should be
-     * in bounds of the diagnoses list field.
-     */
-    serviceLines?: CandidApi.serviceLines.v2.ServiceLineCreate[];
     /** Personal and contact info for the guarantor of the patient responsibility. */
     guarantor?: CandidApi.guarantor.v1.GuarantorCreate;
     /**
@@ -119,11 +58,11 @@ export interface EncounterCreate extends CandidApi.encounters.v4.EncounterBase {
      * instances cannot be created for the same schema on an encounter.
      */
     schemaInstances?: CandidApi.customSchemas.v1.SchemaInstance[];
-    /** Refers to REF*9F on the 837p. Value cannot be greater than 50 characters. */
+    /** Refers to REF*9F on the 837p and 837i. Value cannot be greater than 50 characters. */
     referralNumber?: string;
-    /** Refers Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the 837P form */
+    /** Refers to Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the 837P and 837i form */
     epsdtReferral?: CandidApi.encounters.v4.EpsdtReferral;
-    /** Refers to Loop 2300 - Segment PWK on the 837P form. No more than 10 entries are permitted. */
+    /** Refers to Loop 2300 - Segment PWK on the 837P and 837i forms. No more than 10 entries are permitted. */
     claimSupplementalInformation?: CandidApi.encounters.v4.ClaimSupplementalInformation[];
     /** When Medicaid is billed as the secondary payer the Carrier Code is used to identify the primary payer. This is required for certain states. */
     secondaryPayerCarrierCode?: string;

package/dist/api/resources/encountersUniversal/types/UniversalEncounterCreateBase.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/encountersUniversal/types/UniversalEncounterCreateFromPreEncounter.d.ts

@@ -0,0 +1,47 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../index";
+export interface UniversalEncounterCreateFromPreEncounter extends CandidApi.encountersUniversal.UniversalEncounterCreateFromPreEncounterBase {
+    /** Describes the currently expected target form for this encounter.  This effects what validations and queues the form is processed under. */
+    submissionExpectation: CandidApi.encounters.v4.EncounterSubmissionExpectation;
+    /**
+     * The rendering provider is the practitioner -- physician, nurse practitioner, etc. -- performing the service.
+     * For telehealth services, the rendering provider performs the visit, asynchronous communication, or other service. The rendering provider address should generally be the same as the service facility address.
+     */
+    renderingProvider?: CandidApi.encounterProviders.v2.RenderingProvider;
+    /** The health care code information associated with this encounter, which includes things such as diagnoses, vitals, procedures, occurrences, reason for visit, and numerous other code related fields. */
+    healthCareCodeInformation?: CandidApi.healthCareCodeInformation.v1.HealthCareCodeInformationCreate;
+    /** Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. This box is not used on a UB-04 or 837i claim form. 02 for telemedicine, 11 for in-person. Full list [here](https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set). */
+    placeOfServiceCode?: CandidApi.FacilityTypeCode;
+    serviceLines?: CandidApi.serviceLines.v2.UniversalServiceLineCreate[];
+    /** 837i NM1 2500 variant for Loop ID-2310.  Used to indicate the individual whom has overall responsibility for the patient in institutional claims processing. */
+    attendingProvider?: CandidApi.encounterProviders.v2.RenderingProvider;
+    /**
+     * 837i Loop 2300 DTP-03
+     * Extension of the admission date with hour (0-23 integer) details.
+     */
+    admissionHour?: number;
+    /** 837i Loop 2300 CL1-01 Code used to indicate the priority of an admission or visit. Equivalent to Form Locator 14 Priority of Admission on a UB-04 claim, not used on CMS-1500 claim forms. */
+    admissionTypeCode?: CandidApi.x12.v1.TypeOfAdmissionOrVisitCode;
+    /** 837i Loop 2300 CLI1-02 Code used to indicate the conditions under which an admission occurs. Equivalent to Form Locator 15 Point of Origin on a UB-04 claim, not used on CMS-1500 claim forms. */
+    admissionSourceCode?: CandidApi.x12.v1.PointOfOriginForAdmissionOrVisitCode;
+    /**
+     * 837i Loop 2300 DTP-03
+     * Extension of the discharge date with hour (0-23 integer) details.
+     */
+    dischargeHour?: number;
+    /**
+     * 837i CL1-03 or Form Locator 17 on a UB-04 claim form. This is a required field on UB-04 claims.
+     * Code indicating patient status as of the "statement covers through date" .
+     */
+    dischargeStatus?: CandidApi.x12.v1.PatientDischargeStatusCode;
+    /** 837i NM1 2500 variant for Loop ID-2310.  Used to indicate the individual whom has primary responsibility for surgical procedures in institutional claims processing. */
+    operatingProvider?: CandidApi.encounterProviders.v2.RenderingProvider;
+    /** 837i NM1 2500 variant for Loop ID-2310.  Used to indicate the individual whom has secondary responsibility for surgical procedures in institutional claims processing.  Only used when operating_provider is also set. */
+    otherOperatingProvider?: CandidApi.encounterProviders.v2.RenderingProvider;
+    /** Four digit code used in institutional forms to indicate the type of bill (e.g., hospital inpatient, hospital outpatient). First digit is a leading 0, followed by the type_of_facility, type_of_care, then frequency_code. Professional forms are not required to submit this attribute. You may send the 4 digit code via raw_code, or each individual digit separately via composite_codes. */
+    typeOfBill?: CandidApi.x12.v1.TypeOfBillCompositeUpdate;
+    /** 837i-REF1000 -- an optional state indicating where an accident related to the encounter occurred. */
+    accidentStateOrProvinceCode?: CandidApi.State;
+}

package/dist/api/resources/encountersUniversal/types/UniversalEncounterCreateFromPreEncounter.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/encountersUniversal/types/UniversalEncounterCreateFromPreEncounterBase.d.ts

@@ -0,0 +1,40 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../index";
+export interface UniversalEncounterCreateFromPreEncounterBase extends CandidApi.encounters.v4.EncounterBase {
+    preEncounterPatientId: CandidApi.PreEncounterPatientId;
+    preEncounterAppointmentIds: CandidApi.PreEncounterAppointmentId[];
+    /** The billing provider is the provider or business entity submitting the claim. Billing provider may be, but is not necessarily, the same person/NPI as the rendering provider. From a payer's perspective, this represents the person or entity being reimbursed. When a contract exists with the target payer, the billing provider should be the entity contracted with the payer. In some circumstances, this will be an individual provider. In that case, submit that provider's NPI and the tax ID (TIN) that the provider gave to the payer during contracting. In other cases, the billing entity will be a medical group. If so, submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim or Form Locator 1 on a UB-04 claim form. */
+    billingProvider: CandidApi.encounterProviders.v2.BillingProvider;
+    /**
+     * The second iteration of Loop ID-2310 on an 837P form. Use code "P3 - Primary Care Provider" in this loop to
+     * indicate the initial referral from the primary care provider or whatever provider wrote the initial referral for this patient's episode of care being billed/reported in this transaction.
+     * Not used in an 837i claim
+     */
+    initialReferringProvider?: CandidApi.encounterProviders.v2.InitialReferringProvider;
+    /** Required when the rendering provider is supervised by a physician. If not required by this implementation guide, do not send. */
+    supervisingProvider?: CandidApi.encounterProviders.v2.SupervisingProvider;
+    /** Encounter Service facility is typically the location a medical service was rendered, such as a provider office or hospital. For telehealth, service facility can represent the provider's location when the service was delivered (e.g., home), or the location where an in-person visit would have taken place, whichever is easier to identify. If the provider is in-network, service facility may be defined in payer contracts. Box 32 on the CMS-1500 claim form. There is no equivalent on the paper UB-04 claim form, but this field is equivalent to Loop 2310E Service Facility Location details on an 837i form, and is used when this is different to the entity identified as the Billing Provider. Note that for an in-network claim to be successfully adjudicated, the service facility address listed */
+    serviceFacility?: CandidApi.EncounterServiceFacilityBase;
+    /** Holds a collection of clinical observations made by healthcare providers during patient encounters. Please note that medical records for appeals should be sent using the Encounter Attachments API. */
+    clinicalNotes?: CandidApi.encounters.v4.ClinicalNoteCategoryCreate[];
+    /**
+     * Spot to store misc, human-readable, notes about this encounter to be used
+     * in the billing process.
+     */
+    billingNotes?: CandidApi.billingNotes.v2.BillingNoteBase[];
+    patientHistories?: CandidApi.encounters.v4.PatientHistoryCategory[];
+    /**
+     * To be included for claims that have been submitted outside of Candid.
+     * Candid supports posting remits and payments to these claims and working them in-platform (e.g. editing, resubmitting).
+     */
+    externalClaimSubmission?: CandidApi.claimSubmission.v1.ExternalClaimSubmissionCreate;
+    /** Names of tags that should be on the encounter. */
+    tagIds?: CandidApi.TagId[];
+    /**
+     * Key-value pairs that must adhere to a schema created via the Custom Schema API. Multiple schema
+     * instances cannot be created for the same schema on an encounter.
+     */
+    schemaInstances?: CandidApi.customSchemas.v1.SchemaInstance[];
+}

package/dist/api/resources/encountersUniversal/types/UniversalEncounterCreateFromPreEncounterBase.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/encountersUniversal/types/UniversalEncounterUpdate.d.ts

@@ -0,0 +1,39 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../index";
+export interface UniversalEncounterUpdate extends CandidApi.encountersUniversal.UniversalEncounterUpdateBase {
+    /** The health care code information associated with this encounter, which includes things such as diagnoses, vitals, procedures, occurrences, reason for visit, and numerous other code related fields. */
+    healthCareCodeInformation?: CandidApi.healthCareCodeInformation.v1.HealthCareCodeInformationUpdate;
+    /** 837i NM1 2500 variant for Loop ID-2310.  Used to indicate the individual whom has overall responsibility for the patient in institutional claims processing. */
+    attendingProvider?: CandidApi.encounterProviders.v2.RenderingProviderUpdate;
+    /**
+     * 837i Loop 2300 DTP-03
+     * Extension of the admission date with hour (0-23 integer) details.
+     */
+    admissionHour?: number;
+    /** 837i Loop 2300 CL1-01 Code used to indicate the priority of an admission or visit. Equivalent to Form Locator 14 Priority of Admission on a UB-04 claim, not used on CMS-1500 claim forms. */
+    admissionTypeCode?: CandidApi.x12.v1.TypeOfAdmissionOrVisitCode;
+    /** 837i Loop 2300 CLI1-02 Code used to indicate the conditions under which an admission occurs. Equivalent to Form Locator 15 Point of Origin on a UB-04 claim, not used on CMS-1500 claim forms. */
+    admissionSourceCode?: CandidApi.x12.v1.PointOfOriginForAdmissionOrVisitCode;
+    /**
+     * 837i Loop 2300 DTP-03
+     * Extension of the discharge date with hour (0-23 integer) details.
+     */
+    dischargeHour?: number;
+    /**
+     * 837i CL1-03 or Form Locator 17 on a UB-04 claim form. This is a required field on UB-04 claims.
+     * Code indicating patient status as of the "statement covers through date".
+     */
+    dischargeStatus?: CandidApi.x12.v1.PatientDischargeStatusCode;
+    /** 837i NM1 2500 variant for Loop ID-2310.  Used to indicate the individual whom has primary responsibility for surgical procedures in institutional claims processing. */
+    operatingProvider?: CandidApi.encounterProviders.v2.RenderingProviderUpdate;
+    /** 837i NM1 2500 variant for Loop ID-2310.  Used to indicate the individual whom has secondary responsibility for surgical procedures in institutional claims processing.  Only used when operating_provider is also set. */
+    otherOperatingProvider?: CandidApi.encounterProviders.v2.RenderingProviderUpdate;
+    /** Four digit code used in institutional forms to indicate the type of bill (e.g., hospital inpatient, hospital outpatient). First digit is a leading 0, followed by the type_of_facility, type_of_care, then frequency_code. Professional forms are not required to submit this attribute. You may send the 4 digit code via raw_code, or each individual digit separately via composite_codes. */
+    typeOfBill?: CandidApi.x12.v1.TypeOfBillCompositeUpdate;
+    /** 837i-REF1000 -- an optional state indicating where an accident related to the encounter occurred. */
+    accidentStateOrProvinceCode?: CandidApi.State;
+    /** Describes the currently expected target form for this encounter.  This effects what validations and queues the form is processed under.  When this value is not set, it should be assumed to be TARGET_PROFESSIONAL. */
+    submissionExpectation?: CandidApi.encounters.v4.EncounterSubmissionExpectation;
+}

package/dist/api/resources/encountersUniversal/types/UniversalEncounterUpdate.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/{encounters/resources/v4/client/requests/EncounterUpdate.d.ts → encountersUniversal/types/UniversalEncounterUpdateBase.d.ts}

@@ -1,17 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as CandidApi from "../../../../../../index";
-/**
- * @example
- *     {}
- */
-export interface EncounterUpdate extends CandidApi.encounters.v4.EncounterOptional {
-    /** Refers Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the 837P form */
+import * as CandidApi from "../../../index";
+export interface UniversalEncounterUpdateBase extends CandidApi.encounters.v4.EncounterOptional {
+    /** Refers to Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the 837P and 837i form */
     epsdtReferral?: CandidApi.encounters.v4.EpsdtReferral;
     /** Holds a collection of clinical observations made by healthcare providers during patient encounters. Please note that medical records for appeals should be sent using the Encounter Attachments API. */
     clinicalNotes?: CandidApi.encounters.v4.ClinicalNoteCategoryCreate[];
-    /** Refers to Loop 2300 - Segment PWK on the 837P form. No more than 10 entries are permitted. */
+    /** Refers to Loop 2300 - Segment PWK on the 837P and 837i form. No more than 10 entries are permitted. */
     claimSupplementalInformation?: CandidApi.encounters.v4.ClaimSupplementalInformation[];
     /**
      * Key-value pairs that must adhere to a schema created via the Custom Schema API. Multiple schema
@@ -36,14 +32,9 @@ export interface EncounterUpdate extends CandidApi.encounters.v4.EncounterOption
     /** Specifies the address to which payments for the claim should be sent. */
     payToAddress?: CandidApi.StreetAddressLongZip;
     /**
-     * Ideally, this field should contain no more than 12 diagnoses. However, more diagnoses
-     * may be submitted at this time, and coders will later prioritize the 12 that will be
-     * submitted to the payor.
-     */
-    diagnosisIds?: CandidApi.DiagnosisId[];
-    /**
-     * The second iteration of Loop ID-2310. Use code "P3 - Primary Care Provider" in this loop to
+     * The second iteration of Loop ID-2310 on an 837P form. Use code "P3 - Primary Care Provider" in this loop to
      * indicate the initial referral from the primary care provider or whatever provider wrote the initial referral for this patient's episode of care being billed/reported in this transaction.
+     * Not used in an 837i claim
      */
     initialReferringProvider?: CandidApi.encounterProviders.v2.InitialReferringProviderUpdate;
     /**
@@ -59,12 +50,12 @@ export interface EncounterUpdate extends CandidApi.encounters.v4.EncounterOption
      * For telehealth services, the rendering provider performs the visit, asynchronous communication, or other service. The rendering provider address should generally be the same as the service facility address.
      */
     renderingProvider?: CandidApi.encounterProviders.v2.RenderingProviderUpdate;
-    /** Encounter Service facility is typically the location a medical service was rendered, such as a provider office or hospital. For telehealth, service facility can represent the provider's location when the service was delivered (e.g., home), or the location where an in-person visit would have taken place, whichever is easier to identify. If the provider is in-network, service facility may be defined in payer contracts. Box 32 on the CMS-1500 claim form. Note that for an in-network claim to be successfully adjudicated, the service facility address listed on claims must match what was provided to the payer during the credentialing process. */
+    /** Encounter Service facility is typically the location a medical service was rendered, such as a provider office or hospital. For telehealth, service facility can represent the provider's location when the service was delivered (e.g., home), or the location where an in-person visit would have taken place, whichever is easier to identify. If the provider is in-network, service facility may be defined in payer contracts. Box 32 on the CMS-1500 claim form. There is no equivalent on the paper UB-04 claim form, but this field is equivalent to Loop 2310E Service Facility Location details on an 837i form, and is used when this is different to the entity identified as the Billing Provider. Note that for an in-network claim to be successfully adjudicated, the service facility address listed */
     serviceFacility?: CandidApi.EncounterServiceFacilityUpdate;
     /** Required when the rendering provider is supervised by a physician. If not required by this implementation guide, do not send. */
     supervisingProvider?: CandidApi.encounterProviders.v2.SupervisingProviderUpdate;
-    /** The billing provider is the provider or business entity submitting the claim. Billing provider may be, but is not necessarily, the same person/NPI as the rendering provider. From a payer's perspective, this represents the person or entity being reimbursed. When a contract exists with the target payer, the billing provider should be the entity contracted with the payer. In some circumstances, this will be an individual provider. In that case, submit that provider's NPI and the tax ID (TIN) that the provider gave to the payer during contracting. In other cases, the billing entity will be a medical group. If so, submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim form. */
+    /** The billing provider is the provider or business entity submitting the claim. Billing provider may be, but is not necessarily, the same person/NPI as the rendering provider. From a payer's perspective, this represents the person or entity being reimbursed. When a contract exists with the target payer, the billing provider should be the entity contracted with the payer. In some circumstances, this will be an individual provider. In that case, submit that provider's NPI and the tax ID (TIN) that the provider gave to the payer during contracting. In other cases, the billing entity will be a medical group. If so, submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim or Form Locator 1 on a UB-04 claim form. */
     billingProvider?: CandidApi.encounterProviders.v2.BillingProviderUpdate;
-    /** Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for telemedicine, 11 for in-person. Full list [here](https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set). */
+    /** Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. This box is not used on a UB-04 or 837i claim form. 02 for telemedicine, 11 for in-person. Full list [here](https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set). */
     placeOfServiceCodeAsSubmitted?: CandidApi.FacilityTypeCode;
 }

package/dist/api/resources/encountersUniversal/types/UniversalEncounterUpdateBase.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/encountersUniversal/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./UniversalEncounterCreate";
+export * from "./UniversalEncounterCreateBase";
+export * from "./UniversalEncounterUpdate";
+export * from "./UniversalEncounterUpdateBase";
+export * from "./UniversalEncounterCreateFromPreEncounter";
+export * from "./UniversalEncounterCreateFromPreEncounterBase";

package/dist/api/resources/encountersUniversal/types/index.js

@@ -0,0 +1,22 @@
+"use strict";
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./UniversalEncounterCreate"), exports);
+__exportStar(require("./UniversalEncounterCreateBase"), exports);
+__exportStar(require("./UniversalEncounterUpdate"), exports);
+__exportStar(require("./UniversalEncounterUpdateBase"), exports);
+__exportStar(require("./UniversalEncounterCreateFromPreEncounter"), exports);
+__exportStar(require("./UniversalEncounterCreateFromPreEncounterBase"), exports);

package/dist/api/resources/expectedNetworkStatus/resources/v1/client/Client.js

@@ -81,7 +81,7 @@ class V1 {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CandidApiEnvironment.Production).candidApi, "/api/expected-network-status/v1"),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.6.0", "User-Agent": "candidhealth/1.6.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.8.1", "User-Agent": "candidhealth/1.8.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.expectedNetworkStatus.v1.ExpectedNetworkStatusRequest.jsonOrThrow(request, {

package/dist/api/resources/expectedNetworkStatus/resources/v2/client/Client.js

@@ -99,7 +99,7 @@ class V2 {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CandidApiEnvironment.Production).candidApi, `/api/expected-network-status/v2/compute/${encodeURIComponent(serializers.organizationProviders.v2.OrganizationProviderId.jsonOrThrow(renderingProviderId))}`),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.6.0", "User-Agent": "candidhealth/1.6.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.8.1", "User-Agent": "candidhealth/1.8.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.expectedNetworkStatus.v2.ExpectedNetworkStatusRequestV2.jsonOrThrow(request, {
@@ -182,7 +182,7 @@ class V2 {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : ((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CandidApiEnvironment.Production).candidApi, "/api/expected-network-status/v2/compute"),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.6.0", "User-Agent": "candidhealth/1.6.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.8.1", "User-Agent": "candidhealth/1.8.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.expectedNetworkStatus.v2.ComputeAllInNetworkProvidersRequest.jsonOrThrow(request, {