candidhealth 1.7.0 → 1.9.0

package/api/resources/encounters/resources/v4/client/index.js

@@ -15,9 +15,6 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-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);
-};
 var __importStar = (this && this.__importStar) || (function () {
     var ownKeys = function(o) {
         ownKeys = Object.getOwnPropertyNames || function (o) {
@@ -35,11 +32,14 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
+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 });
 exports.update = exports.createFromPreEncounterPatient = exports.create = exports.get = exports.getAll = void 0;
-__exportStar(require("./requests"), exports);
 exports.getAll = __importStar(require("./getAll"));
 exports.get = __importStar(require("./get"));
 exports.create = __importStar(require("./create"));
 exports.createFromPreEncounterPatient = __importStar(require("./createFromPreEncounterPatient"));
 exports.update = __importStar(require("./update"));
+__exportStar(require("./requests"), exports);

package/api/resources/encounters/resources/v4/client/requests/GetAllEncountersRequest.d.ts

@@ -14,34 +14,22 @@ import * as CandidApi from "../../../../../../index";
  *         primaryPayerNames: "Medicare,Medicaid",
  *         searchTerm: "doe",
  *         externalId: CandidApi.EncounterExternalId("123456"),
- *         diagnosesUpdatedSince: "2019-08-24T14:15:22Z"
+ *         diagnosesUpdatedSince: new Date("2019-08-24T14:15:22.000Z")
  *     }
  */
 export interface GetAllEncountersRequest {
-    /**
-     * Maximum number of entities per page, defaults to 100.
-     */
+    /** Maximum number of entities per page, defaults to 100. */
     limit?: number;
-    /**
-     * Indicates the current status of an insurance claim within the billing process.
-     */
+    /** Indicates the current status of an insurance claim within the billing process. */
     claimStatus?: CandidApi.ClaimStatus;
-    /**
-     * Defaults to created_at:desc.
-     */
+    /** Defaults to created_at:desc. */
     sort?: CandidApi.encounters.v4.EncounterSortOptions;
     pageToken?: CandidApi.PageToken;
-    /**
-     * Date formatted as YYYY-MM-DD; eg: 2019-08-25.
-     */
+    /** Date formatted as YYYY-MM-DD; eg: 2019-08-25. */
     dateOfServiceMin?: string;
-    /**
-     * Date formatted as YYYY-MM-DD; eg: 2019-08-25.
-     */
+    /** Date formatted as YYYY-MM-DD; eg: 2019-08-25. */
     dateOfServiceMax?: string;
-    /**
-     * Comma delimited string.
-     */
+    /** Comma delimited string. */
     primaryPayerNames?: string;
     /**
      * Filter by any of the following fields: encounter_id, claim_id, patient external_id,
@@ -49,33 +37,19 @@ export interface GetAllEncountersRequest {
      * or encounter external id.
      */
     searchTerm?: string;
-    /**
-     * Filter to an exact match on encounter external_id, if one exists.
-     */
+    /** Filter to an exact match on encounter external_id, if one exists. */
     externalId?: CandidApi.EncounterExternalId;
-    /**
-     * ISO 8601 timestamp; ideally in UTC (although not required): 2019-08-24T14:15:22Z.
-     */
+    /** ISO 8601 timestamp; ideally in UTC (although not required): 2019-08-24T14:15:22Z. */
     diagnosesUpdatedSince?: Date;
-    /**
-     * Filter by name of tags on encounters.
-     */
+    /** Filter by name of tags on encounters. */
     tagIds?: CandidApi.TagId | CandidApi.TagId[];
     workQueueId?: CandidApi.WorkQueueId;
-    /**
-     * 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.
-     */
+    /** 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.
-     */
+    /** 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. */
     responsibleParty?: CandidApi.encounters.v4.ResponsiblePartyType;
-    /**
-     * The party who is responsible for taking the next action on an Encounter, as defined by ownership of open Tasks.
-     */
+    /** The party who is responsible for taking the next action on an Encounter, as defined by ownership of open Tasks. */
     ownerOfNextAction?: CandidApi.encounters.v4.EncounterOwnerOfNextActionType;
-    /**
-     * The patient ID from the external EMR platform for the patient
-     */
+    /** The patient ID from the external EMR platform for the patient */
     patientExternalId?: string;
 }

package/api/resources/encounters/resources/v4/client/requests/index.d.ts

@@ -1,3 +1 @@
 export { type GetAllEncountersRequest } from "./GetAllEncountersRequest";
-export { type EncounterCreate } from "./EncounterCreate";
-export { type EncounterUpdate } from "./EncounterUpdate";

package/api/resources/encounters/resources/v4/types/ClinicalNoteCategory.d.ts

@@ -11,7 +11,7 @@ import * as CandidApi from "../../../../../index";
  *                 text: "Mild chest pain since morning.",
  *                 authorName: "John Doe",
  *                 authorNpi: CandidApi.Npi("1234567890"),
- *                 timestamp: "2023-01-01T00:00:00Z"
+ *                 timestamp: new Date("2023-01-01T00:00:00.000Z")
  *             }]
  *     }
  */

package/api/resources/encounters/resources/v4/types/Encounter.d.ts

@@ -13,7 +13,7 @@ import * as CandidApi from "../../../../../index";
  *                 clearinghouseClaimId: "5BA7C3AB-2BC2-496C-8B10-6CAC73D0729D",
  *                 payerClaimId: "9BB9F259-9756-4F16-8F53-9DBB9F7EB1BB",
  *                 serviceLines: [{
- *                         createdAt: "2023-01-01T00:00:00Z",
+ *                         createdAt: new Date("2023-01-01T00:00:00.000Z"),
  *                         modifiers: [CandidApi.ProcedureModifier.TwentyTwo],
  *                         chargeAmountCents: 10000,
  *                         allowedAmountCents: 8000,
@@ -27,7 +27,7 @@ import * as CandidApi from "../../../../../index";
  *                         diagnosisIdThree: CandidApi.DiagnosisId("81795126-A3AC-443C-B47E-7259A16AB4A2"),
  *                         serviceLineEraData: {
  *                             serviceLineAdjustments: [{
- *                                     createdAt: "2023-01-01T00:00:00Z",
+ *                                     createdAt: new Date("2023-01-01T00:00:00.000Z"),
  *                                     adjustmentGroupCode: "CO",
  *                                     adjustmentReasonCode: "CO",
  *                                     adjustmentAmountCents: 1000,
@@ -36,7 +36,7 @@ import * as CandidApi from "../../../../../index";
  *                             remittanceAdviceRemarkCodes: ["N362"]
  *                         },
  *                         serviceLineManualAdjustments: [{
- *                                 createdAt: "2023-01-01T00:00:00Z",
+ *                                 createdAt: new Date("2023-01-01T00:00:00.000Z"),
  *                                 adjustmentGroupCode: "CO",
  *                                 adjustmentReasonCode: "CO",
  *                                 adjustmentAmountCents: 1000,
@@ -44,8 +44,8 @@ import * as CandidApi from "../../../../../index";
  *                             }],
  *                         relatedInvoices: [{
  *                                 id: CandidApi.InvoiceId("901BE2F1-41BC-456E-9987-4FE2F84F9D75"),
- *                                 createdAt: "2023-01-01T00:00:00Z",
- *                                 updatedAt: "2023-01-01T00:00:00Z",
+ *                                 createdAt: new Date("2023-01-01T00:00:00.000Z"),
+ *                                 updatedAt: new Date("2023-01-01T00:00:00.000Z"),
  *                                 organzationId: CandidApi.OrganizationId("F13F73D4-4344-46EA-9D93-33BCFFBB9F36"),
  *                                 sourceId: "9B626577-8808-4F28-9ED1-F0DFF0D49BBC",
  *                                 sourceCustomerId: "624D1972-8C69-4C2F-AEFA-10856F734DB3",
@@ -130,6 +130,7 @@ import * as CandidApi from "../../../../../index";
  *             phoneConsent: true,
  *             email: CandidApi.Email("johndoe@joincandidhealth.com"),
  *             emailConsent: true,
+ *             autoChargeConsent: true,
  *             externalId: "49460F77-6456-41F1-AC6D-0AED08614D39",
  *             dateOfBirth: "2000-01-01",
  *             address: {
@@ -153,6 +154,7 @@ import * as CandidApi from "../../../../../index";
  *             phoneConsent: true,
  *             email: CandidApi.Email("johndoe@joincandidhealth.com"),
  *             emailConsent: true,
+ *             autoChargeConsent: true,
  *             firstName: "John",
  *             lastName: "Doe",
  *             externalId: "49460F77-6456-41F1-AC6D-0AED08614D39",
@@ -292,8 +294,8 @@ import * as CandidApi from "../../../../../index";
  *         url: CandidApi.LinkUrl("https://example.com"),
  *         diagnoses: [{
  *                 diagnosisId: CandidApi.DiagnosisId("5C770E00-4BBF-42AF-A73F-99C5E91FC0DB"),
- *                 createdAt: "2023-01-01T00:00:00Z",
- *                 updatedAt: "2023-01-01T00:00:00Z",
+ *                 createdAt: new Date("2023-01-01T00:00:00.000Z"),
+ *                 updatedAt: new Date("2023-01-01T00:00:00.000Z"),
  *                 encounterId: CandidApi.EncounterId("3F63985B-51A4-4DD4-9418-7D50B2520792"),
  *                 name: "John Doe",
  *                 codeType: CandidApi.DiagnosisTypeCode.Abf,
@@ -306,13 +308,13 @@ import * as CandidApi from "../../../../../index";
  *                         text: "Mild chest pain since morning.",
  *                         authorName: "John Doe",
  *                         authorNpi: CandidApi.Npi("1234567890"),
- *                         timestamp: "2023-01-01T00:00:00Z"
+ *                         timestamp: new Date("2023-01-01T00:00:00.000Z")
  *                     }]
  *             }],
  *         billingNotes: [{
  *                 billingNoteId: CandidApi.billingNotes.v2.BillingNoteId("99882EEA-936F-4E71-BC4F-520E4D14E3E2"),
  *                 encounterId: CandidApi.EncounterId("8BCFB6A8-2876-4111-9E3F-602B541FCF62"),
- *                 createdAt: "2023-01-01T00:00:00Z",
+ *                 createdAt: new Date("2023-01-01T00:00:00.000Z"),
  *                 authorAuth0Id: "F0DE3BF9-F9A1-4FA7-BF6B-28C0B46BADD8",
  *                 authorName: "John Doe",
  *                 text: "Patient was billed for an MRI."
@@ -340,7 +342,7 @@ import * as CandidApi from "../../../../../index";
  *                 sourceInternalId: "D1A76039-D5C5-4323-A2FC-B7C8B6AEF6A4",
  *                 source: CandidApi.patientPayments.v3.PatientPaymentSource.ManualEntry,
  *                 amountCents: 2000,
- *                 paymentTimestamp: "2023-01-01T00:00:00Z",
+ *                 paymentTimestamp: new Date("2023-01-01T00:00:00.000Z"),
  *                 status: CandidApi.patientPayments.v3.PatientPaymentStatus.Pending,
  *                 paymentName: "John Doe",
  *                 paymentNote: "test payment note",
@@ -356,7 +358,7 @@ import * as CandidApi from "../../../../../index";
  *             }],
  *         codingAttribution: CandidApi.encounters.v4.CodingAttributionType.Candid,
  *         workQueueId: CandidApi.WorkQueueId("12"),
- *         workQueueMembershipActivatedAt: "2023-01-01T00:00:00Z",
+ *         workQueueMembershipActivatedAt: new Date("2023-01-01T00:00:00.000Z"),
  *         ownerOfNextAction: CandidApi.encounters.v4.EncounterOwnerOfNextActionType.Candid,
  *         submissionOrigin: CandidApi.encounters.v4.EncounterSubmissionOriginType.Candid,
  *         externalId: CandidApi.EncounterExternalId("5C21490F-A9C0-45F4-B5DB-136E3AEC617A"),
@@ -375,15 +377,6 @@ import * as CandidApi from "../../../../../index";
  *                 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.encounters.v4.InterventionCategory.Lifestyle,
@@ -426,7 +419,7 @@ import * as CandidApi from "../../../../../index";
  *                     "age": 38
  *                 }
  *             }],
- *         createdAt: "2023-01-01T00:00:00Z",
+ *         createdAt: new Date("2023-01-01T00:00:00.000Z"),
  *         nextResponsibleParty: CandidApi.NextResponsibleParty.Primary
  *     }
  */
@@ -446,7 +439,7 @@ export interface Encounter extends CandidApi.encounters.v4.EncounterBase {
     patient: CandidApi.Patient;
     /** Personal and contact info for the guarantor of the patient responsibility. */
     guarantor?: CandidApi.guarantor.v1.Guarantor;
-    /** 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 form or Form Locator 1 on a UB-04 claim form. */
     billingProvider: CandidApi.encounterProviders.v2.EncounterProvider;
     /**
      * The rendering provider is the practitioner -- physician, nurse practitioner, etc. -- performing the service.
@@ -454,46 +447,39 @@ export interface Encounter extends CandidApi.encounters.v4.EncounterBase {
      */
     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;
+    attendingProvider?: CandidApi.encounterProviders.v2.EncounterProvider;
     /**
      * 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.
-     */
+    /** 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.
-     */
+    /** 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) details.
-     * Required for institutional submission.
      */
     dischargeHour?: number;
     /**
-     * 837i CL1-03
+     * 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;
+    operatingProvider?: CandidApi.encounterProviders.v2.EncounterProvider;
     /** 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;
+    otherOperatingProvider?: CandidApi.encounterProviders.v2.EncounterProvider;
     /** 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. */
+    /** 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.TypeOfBillComposite;
     referringProvider?: CandidApi.encounterProviders.v2.EncounterProvider;
     initialReferringProvider?: CandidApi.encounterProviders.v2.EncounterProvider;
     supervisingProvider?: CandidApi.encounterProviders.v2.EncounterProvider;
-    /** 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.EncounterServiceFacility;
     /**
      * Subscriber_primary is required when responsible_party is INSURANCE_PAY (i.e. when the claim should be billed to insurance).
@@ -506,13 +492,13 @@ export interface Encounter extends CandidApi.encounters.v4.EncounterBase {
     subscriberSecondary?: CandidApi.Subscriber;
     /** Contains details of the tertiary insurance subscriber. */
     subscriberTertiary?: CandidApi.Subscriber;
-    /** 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;
     /** URL that links directly to the claim created in Candid. */
     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. */
+    /** Contains the primary and other diagnosis health care code information objects associated with this encounter. For professional claims, these diagnoses correspond with those that are set on service lines directly, where as for institutional claims these are only associated directly with the claim itself.  See also Health Care Code Information objects and corresponding apis. */
     diagnoses: CandidApi.Diagnosis[];
     /** 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[];
@@ -547,9 +533,9 @@ export interface Encounter extends CandidApi.encounters.v4.EncounterBase {
     schemaInstances: CandidApi.customSchemas.v1.SchemaInstance[];
     /** 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 */
+    /** 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 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/api/resources/encounters/resources/v4/types/EncounterBase.d.ts

@@ -12,7 +12,7 @@ export interface EncounterBase {
     /**
      * Date formatted as YYYY-MM-DD; eg: 2019-08-24.
      * This date must be the local date in the timezone where the service occurred.
-     * Box 24a on the CMS-1500 claim form.
+     * Box 24a on the CMS-1500 claim form or Form Locator 45 on the UB-04 claim form.
      * If service occurred over a range of dates, this should be the start date.
      * date_of_service must be defined on either the encounter or the service lines but not both.
      * If there are greater than zero service lines, it is recommended to specify date_of_service on the service_line instead of on the encounter to prepare for future API versions.
@@ -29,25 +29,24 @@ export interface EncounterBase {
     /**
      * Whether this patient has authorized the release of medical information
      * for billing purpose.
-     * Box 12 on the CMS-1500 claim form.
+     * Box 12 on the CMS-1500 claim form  or Form Locator 52 on a UB-04 claim form.
      */
     patientAuthorizedRelease: boolean;
     /**
      * Whether this patient has authorized insurance payments to be made to you,
      * not them. If false, patient may receive reimbursement.
-     * Box 13 on the CMS-1500 claim form.
+     * Box 13 on the CMS-1500 claim form or Form Locator 53 on a UB-04 claim form.
      */
     benefitsAssignedToProvider: boolean;
     /**
      * Whether you have accepted the patient's authorization for insurance payments
      * to be made to you, not them.
-     * Box 27 on the CMS-1500 claim form.
+     * Box 27 on the CMS-1500 claim form. There is no exact equivalent of this field on a UB-04 claim, however contributes to the concept of Form Locator 53.
      */
     providerAcceptsAssignment: boolean;
     /** Human-readable description of the appointment type (ex: "Acupuncture - Headaches"). */
     appointmentType?: string;
     existingMedications?: CandidApi.encounters.v4.Medication[];
-    vitals?: CandidApi.encounters.v4.Vitals;
     interventions?: CandidApi.encounters.v4.Intervention[];
     /** Specifies the address to which payments for the claim should be sent. */
     payToAddress?: CandidApi.StreetAddressLongZip;
@@ -59,6 +58,7 @@ export interface EncounterBase {
      * directly with the provider, such as over video or a phone call.
      */
     synchronicity?: CandidApi.encounters.v4.SynchronicityType;
+    vitals?: CandidApi.encounters.v4.Vitals;
     /**
      * 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
@@ -67,7 +67,7 @@ export interface EncounterBase {
     billableStatus: CandidApi.encounters.v4.BillableStatusType;
     /**
      * Defines additional information on the claim needed by the payer.
-     * Box 19 on the CMS-1500 claim form.
+     * Box 19 on the CMS-1500 claim form or Form Locator 80 on a UB-04 claim form.
      */
     additionalInformation?: string;
     /**
@@ -78,27 +78,26 @@ export interface EncounterBase {
      */
     serviceAuthorizationExceptionCode?: CandidApi.encounters.v4.ServiceAuthorizationExceptionCode;
     /**
-     * 837p Loop2300 DTP*435, CMS-1500 Box 18
+     * 837p Loop2300 DTP*435, CMS-1500 Box 18 or UB-04 Form Locator 12.
      * Required on all ambulance claims when the patient was known to be admitted to the hospital.
      * OR
      * Required on all claims involving inpatient medical visits.
      */
     admissionDate?: string;
-    /**
-     * 837p Loop2300 DTP*096, CMS-1500 Box 18
-     * Required for inpatient claims when the patient was discharged from the facility and the discharge date is known.
-     */
+    /** 837p Loop2300 DTP*096, CMS-1500 Box 18 Required for inpatient claims when the patient was discharged from the facility and the discharge date is known. Not used on an institutional claim. */
     dischargeDate?: string;
     /**
      * 837p Loop2300 DTP*431, CMS-1500 Box 14
      * Required for the initial medical service or visit performed in response to a medical emergency when the date is available and is different than the date of service.
      * OR
      * This date is the onset of acute symptoms for the current illness or condition.
+     *  For UB-04 claims, this is populated separately via occurrence codes.
      */
     onsetOfCurrentIllnessOrSymptomDate?: string;
     /**
      * 837p Loop2300 DTP*484, CMS-1500 Box 14
      * Required when, in the judgment of the provider, the services on this claim are related to the patient's pregnancy.
+     * This field is populated separately via occurrence codes for UB-04 claim forms.
      */
     lastMenstrualPeriodDate?: string;
     /**

package/api/resources/encounters/resources/v4/types/EncounterCreate.d.ts

@@ -0,0 +1,27 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface EncounterCreate 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 form  or Form Locator 1 on a UB-04 claim form.. */
+    billingProvider: CandidApi.encounterProviders.v2.BillingProvider;
+    /**
+     * 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[];
+    /** 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;
+    /**
+     * 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;
+    /**
+     * 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[];
+}

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

@@ -2,57 +2,24 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../../../../index";
-export interface EncounterCreateFromPreEncounter 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 form. */
-    billingProvider: CandidApi.encounterProviders.v2.BillingProvider;
+export interface EncounterCreateFromPreEncounter extends CandidApi.encountersUniversal.UniversalEncounterCreateFromPreEncounterBase {
     /**
      * 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 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.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. */
-    serviceFacility?: CandidApi.EncounterServiceFacilityBase;
+    /** 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;
     /**
      * 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[];
-    /**
-     * Spot to store misc, human-readable, notes about this encounter to be used
-     * 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[];
-    /**
-     * 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/api/resources/encounters/resources/v4/types/EncounterDeepOptional.d.ts

@@ -3,6 +3,11 @@
  */
 import * as CandidApi from "../../../../../index";
 export interface EncounterDeepOptional extends CandidApi.encounters.v4.EncounterOptional {
+    /**
+     * 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
@@ -11,9 +16,9 @@ export interface EncounterDeepOptional extends CandidApi.encounters.v4.Encounter
     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. */
+    /** Refers to Loop 2300 - Segment PWK on the 837P and 837i 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 */
+    /** Refers to Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the 837P and 837i form */
     epsdtReferral?: CandidApi.encounters.v4.EpsdtReferralOptional;
     /**
      * Existing medications that should be on the encounter.
@@ -56,7 +61,7 @@ export interface EncounterDeepOptional extends CandidApi.encounters.v4.Encounter
     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. */
+    /** 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.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;
@@ -73,7 +78,7 @@ export interface EncounterDeepOptional extends CandidApi.encounters.v4.Encounter
     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. */
+    /** 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 or Form Locator 1 on a UB-04 claim form. */
     billingProvider?: CandidApi.encounterProviders.v2.BillingProviderUpdateWithOptionalAddress;
     /** Specifies the address to which payments for the claim should be sent. */
     payToAddress?: CandidApi.StreetAddressShortZipOptional;