candidhealth 1.0.0 → 1.4.0

package/dist/api/resources/encounters/resources/v4/client/Client.js

@@ -143,7 +143,7 @@ class V4 {
             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/encounters/v4"),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "candidhealth/1.0.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.4.0", "User-Agent": "candidhealth/1.4.0", "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",
                 queryParameters: _queryParams,
                 requestType: "json",
@@ -181,7 +181,7 @@ class V4 {
             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/encounters/v4/${encodeURIComponent(serializers.EncounterId.jsonOrThrow(encounterId))}`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "candidhealth/1.0.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.4.0", "User-Agent": "candidhealth/1.4.0", "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",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -255,7 +255,7 @@ class V4 {
             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/encounters/v4"),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "candidhealth/1.0.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.4.0", "User-Agent": "candidhealth/1.4.0", "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.encounters.v4.EncounterCreate.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -364,7 +364,7 @@ class V4 {
             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/encounters/v4/create-from-pre-encounter"),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "candidhealth/1.0.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.4.0", "User-Agent": "candidhealth/1.4.0", "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.encounters.v4.EncounterCreateFromPreEncounter.jsonOrThrow(request, {
@@ -426,7 +426,7 @@ class V4 {
             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/encounters/v4/${encodeURIComponent(serializers.EncounterId.jsonOrThrow(encounterId))}`),
                 method: "PATCH",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.0.0", "User-Agent": "candidhealth/1.0.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.4.0", "User-Agent": "candidhealth/1.4.0", "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.encounters.v4.EncounterUpdate.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),

package/dist/api/resources/encounters/resources/v4/client/requests/EncounterCreate.d.ts

@@ -89,7 +89,7 @@ export interface EncounterCreate extends CandidApi.encounters.v4.EncounterBase {
      * submitted to the payor.
      */
     diagnoses: CandidApi.DiagnosisCreate[];
-    /** Holds a collection of clinical observations made by healthcare providers during patient encounters. */
+    /** 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

package/dist/api/resources/encounters/resources/v4/client/requests/EncounterUpdate.d.ts

@@ -7,6 +7,32 @@ import * as CandidApi from "../../../../../../index";
  *     {}
  */
 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 */
+    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. */
+    claimSupplementalInformation?: CandidApi.encounters.v4.ClaimSupplementalInformation[];
+    /**
+     * 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. Updating schema instances utilizes PUT
+     * semantics, so the schema instances on the encounter will be set to whatever inputs are provided. If null
+     * is provided as an input, then the encounter's schema instances will be cleared.
+     */
+    schemaInstances?: CandidApi.customSchemas.v1.SchemaInstance[];
+    /**
+     * Existing medications that should be on the encounter.
+     * Note all current existing medications on encounter will be overridden with this list.
+     */
+    existingMedications?: CandidApi.encounters.v4.Medication[];
+    /** Personal and contact info for the guarantor of the patient responsibility. */
+    guarantor?: CandidApi.guarantor.v1.GuarantorUpdate;
+    /** Contains details of the primary insurance subscriber. */
+    subscriberPrimary?: CandidApi.SubscriberCreate;
+    /** Contains details of the secondary insurance subscriber. */
+    subscriberSecondary?: CandidApi.SubscriberCreate;
+    /** Contains details of the tertiary insurance subscriber. */
+    subscriberTertiary?: CandidApi.SubscriberCreate;
     /** Specifies the address to which payments for the claim should be sent. */
     payToAddress?: CandidApi.StreetAddressLongZip;
     /**

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface ClaimSupplementalInformationOptional {
+    attachmentReportTypeCode?: CandidApi.encounters.v4.ReportTypeCode;
+    attachmentTransmissionCode?: CandidApi.encounters.v4.ReportTransmissionCode;
+    attachmentControlNumber?: string;
+}

package/dist/api/resources/encounters/resources/v4/types/ClaimSupplementalInformationOptional.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/ClinicalNoteCategoryCreateOptional.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface ClinicalNoteCategoryCreateOptional {
+    category?: CandidApi.encounters.v4.NoteCategory;
+    notes?: CandidApi.encounters.v4.ClinicalNoteOptional[];
+}

package/dist/api/resources/encounters/resources/v4/types/ClinicalNoteCategoryCreateOptional.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/ClinicalNoteOptional.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface ClinicalNoteOptional {
+    text?: string;
+    authorName?: string;
+    authorNpi?: CandidApi.Npi;
+    timestamp?: Date;
+}

package/dist/api/resources/encounters/resources/v4/types/ClinicalNoteOptional.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/Encounter.d.ts

@@ -355,7 +355,7 @@ import * as CandidApi from "../../../../../index";
  *                 color: CandidApi.TagColorEnum.Black
  *             }],
  *         codingAttribution: CandidApi.encounters.v4.CodingAttributionType.Candid,
- *         workQueueId: CandidApi.WorkQueueId("000856FE-1024-418F-BF96-2E7347AB4520"),
+ *         workQueueId: CandidApi.WorkQueueId("12"),
  *         workQueueMembershipActivatedAt: "2023-01-01T00:00:00Z",
  *         ownerOfNextAction: CandidApi.encounters.v4.EncounterOwnerOfNextActionType.Candid,
  *         submissionOrigin: CandidApi.encounters.v4.EncounterSubmissionOriginType.Candid,
@@ -426,10 +426,15 @@ import * as CandidApi from "../../../../../index";
  *                     "age": 38
  *                 }
  *             }],
- *         createdAt: "2023-01-01T00:00:00Z"
+ *         createdAt: "2023-01-01T00:00:00Z",
+ *         nextResponsibleParty: CandidApi.NextResponsibleParty.Primary
  *     }
  */
 export interface Encounter extends CandidApi.encounters.v4.EncounterBase {
+    /** 837i-REF1000 -- an optional state indicating where an accident related to the encounter occurred. */
+    accidentStateOrProvinceCode?: CandidApi.State;
+    /** If the encounter was created from ingested charge captures, this is the associated Charge Capture Claim Creation Id. */
+    claimCreationId?: CandidApi.ChargeCaptureClaimCreationId;
     /**
      * A patient control number (PCN) is a unique identifier assigned to a patient within a healthcare system or facility.
      * It's used to track and manage a patient's medical records, treatments, and other healthcare-related information.
@@ -448,6 +453,43 @@ export interface Encounter extends CandidApi.encounters.v4.EncounterBase {
      * 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.EncounterProvider;
+    /** 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) details.
+     * Required for institutional submission.
+     */
+    admissionHour?: number;
+    /**
+     * 837i Loop 2300 CL1-01
+     * Code used to indicate the priority of an admission or visit.
+     */
+    admissionTypeCode?: CandidApi.x12.v1.TypeOfAdmissionOrVisitCode;
+    /**
+     * 837i Loop 2300 CLI1-02
+     * Code used to indicate the conditions under which an admission occurs.
+     */
+    admissionSourceCode?: CandidApi.x12.v1.PointOfOriginForAdmissionOrVisitCode;
+    /**
+     * 837i Loop 2300 DTP-03
+     * Extension of the discharge date with hour (0-23) details.
+     * Required for institutional submission.
+     */
+    dischargeHour?: number;
+    /**
+     * 837i CL1-03
+     * 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;
+    /** 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;
+    /** Used by institutional forms to indicate how the bill is to be interpreted. Professional forms are not required to submit this attribute. */
+    typeOfBill?: CandidApi.x12.v1.TypeOfBillComposite;
     referringProvider?: CandidApi.encounterProviders.v2.EncounterProvider;
     initialReferringProvider?: CandidApi.encounterProviders.v2.EncounterProvider;
     supervisingProvider?: CandidApi.encounterProviders.v2.EncounterProvider;
@@ -472,7 +514,7 @@ export interface Encounter extends CandidApi.encounters.v4.EncounterBase {
     url: CandidApi.LinkUrl;
     /** 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.Diagnosis[];
-    /** Holds a collection of clinical observations made by healthcare providers during patient encounters. */
+    /** 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.ClinicalNoteCategory[];
     /**
      * Spot to store misc, human-readable, notes about this encounter to be
@@ -515,4 +557,6 @@ export interface Encounter extends CandidApi.encounters.v4.EncounterBase {
     lastSubmittedAt?: Date;
     /** The date and time the encounter was created. */
     createdAt: Date;
+    /** The party (payer, patient, etc.) responsible for the remainder of the balance on the claim. */
+    nextResponsibleParty?: CandidApi.NextResponsibleParty;
 }

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

@@ -27,7 +27,7 @@ export interface EncounterCreateFromPreEncounter extends CandidApi.encounters.v4
      * submitted to the payor.
      */
     diagnoses: CandidApi.DiagnosisCreate[];
-    /** Holds a collection of clinical observations made by healthcare providers during patient encounters. */
+    /** 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

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

@@ -0,0 +1,80 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface EncounterDeepOptional extends CandidApi.encounters.v4.EncounterOptional {
+    /**
+     * 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.DiagnosisCreateOptional[];
+    /** 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.ClinicalNoteCategoryCreateOptional[];
+    /** Refers to Loop 2300 - Segment PWK on the 837P form. No more than 10 entries are permitted. */
+    claimSupplementalInformation?: CandidApi.encounters.v4.ClaimSupplementalInformationOptional[];
+    /** Refers Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the 837P form */
+    epsdtReferral?: CandidApi.encounters.v4.EpsdtReferralOptional;
+    /**
+     * Existing medications that should be on the encounter.
+     * Note all current existing medications on encounter will be overridden with this list.
+     */
+    existingMedications?: CandidApi.encounters.v4.MedicationOptional[];
+    /** Personal and contact info for the guarantor of the patient responsibility. */
+    guarantor?: CandidApi.guarantor.v1.GuarantorOptional;
+    /** Contains details of the primary insurance subscriber. */
+    subscriberPrimary?: CandidApi.SubscriberCreateOptional;
+    /** Contains details of the secondary insurance subscriber. */
+    subscriberSecondary?: CandidApi.SubscriberCreateOptional;
+    /** Contains details of the tertiary insurance subscriber. */
+    subscriberTertiary?: CandidApi.SubscriberCreateOptional;
+    interventions?: CandidApi.encounters.v4.InterventionOptional[];
+    /**
+     * 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. Updating schema instances utilizes PUT
+     * semantics, so the schema instances on the encounter will be set to whatever inputs are provided. If null
+     * is provided as an input, then the encounter's schema instances will be cleared.
+     */
+    schemaInstances?: CandidApi.customSchemas.v1.SchemaInstanceOptional[];
+    /**
+     * ***This field is in beta.***
+     * 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.ExternalClaimSubmissionCreateOptional;
+    /**
+     * 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.ServiceLineCreateOptional[];
+    patientHistories?: CandidApi.encounters.v4.PatientHistoryCategoryOptional[];
+    /**
+     * Spot to store misc, human-readable, notes about this encounter to be
+     * used in the billing process.
+     */
+    billingNotes?: CandidApi.billingNotes.v2.BillingNoteBaseOptional[];
+    /** Contains the identification information of the individual receiving medical services. */
+    patient?: CandidApi.PatientUpdateWithOptionalAddress;
+    /** 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. */
+    serviceFacility?: CandidApi.EncounterServiceFacilityUpdateWithOptionalAddress;
+    /** 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.RenderingProviderUpdateWithOptionalAddress;
+    /**
+     * The second iteration of Loop ID-2310. 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.
+     */
+    initialReferringProvider?: CandidApi.encounterProviders.v2.InitialReferringProviderUpdateWithOptionalAddress;
+    /**
+     * The final provider who referred the services that were rendered.
+     * All physicians who order services or refer Medicare beneficiaries must
+     * report this data.
+     */
+    referringProvider?: CandidApi.encounterProviders.v2.ReferringProviderUpdateWithOptionalAddress;
+    /** Required when the rendering provider is supervised by a physician. If not required by this implementation guide, do not send. */
+    supervisingProvider?: CandidApi.encounterProviders.v2.SupervisingProviderUpdateWithOptionalAddress;
+    /** 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.BillingProviderUpdateWithOptionalAddress;
+    /** Specifies the address to which payments for the claim should be sent. */
+    payToAddress?: CandidApi.StreetAddressShortZipOptional;
+}

package/dist/api/resources/encounters/resources/v4/types/EncounterDeepOptional.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/EncounterOptional.d.ts

@@ -23,8 +23,6 @@ export interface EncounterOptional {
     dateOfService?: string;
     /** Names of tags that should be on the encounter.  Note all tags on encounter will be overridden with this list. */
     tagIds?: CandidApi.TagId[];
-    /** Holds a collection of clinical observations made by healthcare providers during patient encounters. */
-    clinicalNotes?: CandidApi.encounters.v4.ClinicalNoteCategoryCreate[];
     /** Defines if the Encounter is to be billed by Candid to the responsible_party. Examples for when this should be set to NOT_BILLABLE include if the Encounter has not occurred yet or if there is no intention of ever billing the responsible_party. */
     billableStatus?: CandidApi.encounters.v4.BillableStatusType;
     /** Defines the party to be billed with the initial balance owed on the claim. Use SELF_PAY if you intend to bill self pay/cash pay. */
@@ -45,12 +43,6 @@ export interface EncounterOptional {
      * If service lines have distinct end_date_of_service values, updating the encounter's end_date_of_service will fail. If all service line end_date_of_service values are the same, updating the encounter's end_date_of_service will update all service line date_of_service values.
      */
     endDateOfService?: string;
-    /** Contains details of the primary insurance subscriber. */
-    subscriberPrimary?: CandidApi.SubscriberCreate;
-    /** Contains details of the secondary insurance subscriber. */
-    subscriberSecondary?: CandidApi.SubscriberCreate;
-    /** Contains details of the tertiary insurance subscriber. */
-    subscriberTertiary?: CandidApi.SubscriberCreate;
     /**
      * Defines additional information on the claim needed by the payer.
      * Box 19 on the CMS-1500 claim form.
@@ -98,31 +90,13 @@ export interface EncounterOptional {
      * Box 12 on the CMS-1500 claim form.
      */
     patientAuthorizedRelease?: boolean;
-    /**
-     * 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. Updating schema instances utilizes PUT
-     * semantics, so the schema instances on the encounter will be set to whatever inputs are provided. If null
-     * is provided as an input, then the encounter's schema instances will be cleared.
-     */
-    schemaInstances?: CandidApi.customSchemas.v1.SchemaInstance[];
     /**
      * 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;
-    /**
-     * Existing medications that should be on the encounter.
-     * Note all current existing medications on encounter will be overridden with this list.
-     */
-    existingMedications?: CandidApi.encounters.v4.Medication[];
-    /** Personal and contact info for the guarantor of the patient responsibility. */
-    guarantor?: CandidApi.guarantor.v1.GuarantorUpdate;
     /** Refers to REF*9F on the 837p. 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 */
-    epsdtReferral?: CandidApi.encounters.v4.EpsdtReferral;
-    /** Refers to Loop 2300 - Segment PWK on the 837P form. 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/encounters/resources/v4/types/EncounterPage.d.ts

@@ -356,7 +356,7 @@ import * as CandidApi from "../../../../../index";
  *                         color: CandidApi.TagColorEnum.Black
  *                     }],
  *                 codingAttribution: CandidApi.encounters.v4.CodingAttributionType.Candid,
- *                 workQueueId: CandidApi.WorkQueueId("000856FE-1024-418F-BF96-2E7347AB4520"),
+ *                 workQueueId: CandidApi.WorkQueueId("12"),
  *                 workQueueMembershipActivatedAt: "2023-01-01T00:00:00Z",
  *                 ownerOfNextAction: CandidApi.encounters.v4.EncounterOwnerOfNextActionType.Candid,
  *                 submissionOrigin: CandidApi.encounters.v4.EncounterSubmissionOriginType.Candid,
@@ -427,7 +427,8 @@ import * as CandidApi from "../../../../../index";
  *                             "age": 38
  *                         }
  *                     }],
- *                 createdAt: "2023-01-01T00:00:00Z"
+ *                 createdAt: "2023-01-01T00:00:00Z",
+ *                 nextResponsibleParty: CandidApi.NextResponsibleParty.Primary
  *             }]
  *     }
  */

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Used to describe the currently expected target form for this encounter.  This effects what
+ * validations and queues the form is processed under.  If you're not sure, you can set this value
+ * to UNEXPECTED, in which case the form will be treated loosely during processing.  Before
+ * submission, this value will be required by some rules or user intervention.  It can be changed
+ * at any time, although doing so may incur other rules.
+ */
+export type EncounterSubmissionExpectation = 
+/**
+ * Treat this encounter as a potential professional claim submission and validate it as such. */
+"TARGET_PROFESSIONAL"
+/**
+ * Treat this encounter as a potential institutional claim submission and validate it as such. */
+ | "TARGET_INSTITUTIONAL";
+export declare const EncounterSubmissionExpectation: {
+    readonly TargetProfessional: "TARGET_PROFESSIONAL";
+    readonly TargetInstitutional: "TARGET_INSTITUTIONAL";
+};

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

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EncounterSubmissionExpectation = void 0;
+exports.EncounterSubmissionExpectation = {
+    TargetProfessional: "TARGET_PROFESSIONAL",
+    TargetInstitutional: "TARGET_INSTITUTIONAL",
+};

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface EpsdtReferralOptional {
+    conditionIndicator1?: CandidApi.EpsdtReferralConditionIndicatorCode;
+    conditionIndicator2?: CandidApi.EpsdtReferralConditionIndicatorCode;
+    conditionIndicator3?: CandidApi.EpsdtReferralConditionIndicatorCode;
+}

package/dist/api/resources/encounters/resources/v4/types/EpsdtReferralOptional.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/IntakeQuestionOptional.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+/**
+ * @example
+ *     {
+ *         id: CandidApi.encounters.v4.IntakeQuestionId("6E7FBCE4-A8EA-46D0-A8D8-FF83CA3BB176"),
+ *         text: "Do you have any allergies?",
+ *         responses: [{
+ *                 response: "No allergies",
+ *                 followUps: [{
+ *                         id: CandidApi.encounters.v4.IntakeFollowUpId("4F3D57F9-AC94-49D6-87E4-E804B709917A"),
+ *                         text: "Do you have any allergies?",
+ *                         response: "No allergies"
+ *                     }]
+ *             }]
+ *     }
+ */
+export interface IntakeQuestionOptional {
+    id?: CandidApi.encounters.v4.IntakeQuestionId;
+    text?: string;
+    responses?: CandidApi.encounters.v4.IntakeResponseAndFollowUps[];
+}

package/dist/api/resources/encounters/resources/v4/types/IntakeQuestionOptional.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/InterventionOptional.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface InterventionOptional {
+    name?: string;
+    category?: CandidApi.encounters.v4.InterventionCategory;
+    /** "Examples: 'Birth Control LAC', 'Tracking', 'Stress Management', 'Supplement', 'Labs'" */
+    description?: string;
+    /** Required when `type` is `allopathic`. */
+    medication?: CandidApi.encounters.v4.MedicationOptional;
+    /** Required when `type` is `tests`. */
+    labs?: CandidApi.encounters.v4.LabOptional[];
+}

package/dist/api/resources/encounters/resources/v4/types/InterventionOptional.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/LabOptional.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+/**
+ * @example
+ *     {
+ *         name: "Genetic Health Labs",
+ *         code: "GH12345",
+ *         codeType: CandidApi.encounters.v4.LabCodeType.Quest
+ *     }
+ */
+export interface LabOptional {
+    name?: string;
+    code?: string;
+    codeType?: CandidApi.encounters.v4.LabCodeType;
+}

package/dist/api/resources/encounters/resources/v4/types/LabOptional.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/MedicationOptional.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface MedicationOptional {
+    name?: string;
+    rxCui?: CandidApi.encounters.v4.RxCui;
+    dosage?: string;
+    dosageForm?: string;
+    frequency?: string;
+    asNeeded?: boolean;
+}

package/dist/api/resources/encounters/resources/v4/types/MedicationOptional.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/PatientHistoryCategoryOptional.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface PatientHistoryCategoryOptional {
+    category?: CandidApi.encounters.v4.PatientHistoryCategoryEnum;
+    /** Must contain at least one item. */
+    questions?: CandidApi.encounters.v4.IntakeQuestionOptional[];
+}

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

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