candidhealth 0.6.3 → 0.6.4

package/api/resources/auth/resources/v2/client/Client.js

@@ -62,7 +62,7 @@ class V2 {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "candidhealth",
-                "X-Fern-SDK-Version": "0.6.3",
+                "X-Fern-SDK-Version": "0.6.4",
             },
             contentType: "application/json",
             body: await serializers.auth.v2.AuthGetTokenRequest.jsonOrThrow(request, {

package/api/resources/auth/resources/v2/types/AuthGetTokenRequest.d.ts

@@ -1,6 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         clientId: "YOUR_CLIENT_ID",
+ *         clientSecret: "YOUR_CLIENT_SECRET"
+ *     }
+ */
 export interface AuthGetTokenRequest {
     /** Your application's Client ID. */
     clientId: string;

package/api/resources/auth/resources/v2/types/AuthGetTokenResponse.d.ts

@@ -1,6 +1,14 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * @example
+ *     {
+ *         accessToken: "eyJz93a...k4laUWw",
+ *         expiresIn: 86400,
+ *         tokenType: "Bearer"
+ *     }
+ */
 export interface AuthGetTokenResponse {
     accessToken: string;
     /** Time in seconds. */

package/api/resources/billingNotes/resources/v2/client/Client.js

@@ -48,7 +48,7 @@ class V2 {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "candidhealth",
-                "X-Fern-SDK-Version": "0.6.3",
+                "X-Fern-SDK-Version": "0.6.4",
             },
             contentType: "application/json",
             body: await serializers.billingNotes.v2.StandaloneBillingNoteCreate.jsonOrThrow(request, {

package/api/resources/billingNotes/resources/v2/types/BillingNote.d.ts

@@ -2,6 +2,17 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../../../..";
+/**
+ * @example
+ *     {
+ *         billingNoteId: CandidApi.billingNotes.v2.BillingNoteId("99882EEA-936F-4E71-BC4F-520E4D14E3E2"),
+ *         encounterId: CandidApi.EncounterId("8BCFB6A8-2876-4111-9E3F-602B541FCF62"),
+ *         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."
+ *     }
+ */
 export interface BillingNote extends CandidApi.billingNotes.v2.BillingNoteBase {
     billingNoteId: CandidApi.billingNotes.v2.BillingNoteId;
     encounterId: CandidApi.EncounterId;

package/api/resources/claims/types/Claim.d.ts

@@ -2,6 +2,82 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../..";
+/**
+ * @example
+ *     {
+ *         claimId: CandidApi.ClaimId("DD9D7F82-37B5-449D-AA63-26925398335B"),
+ *         status: CandidApi.ClaimStatus.BillerReceived,
+ *         clearinghouse: "Change Healthcare",
+ *         clearinghouseClaimId: "5BA7C3AB-2BC2-496C-8B10-6CAC73D0729D",
+ *         payerClaimId: "9BB9F259-9756-4F16-8F53-9DBB9F7EB1BB",
+ *         serviceLines: [{
+ *                 modifiers: [CandidApi.ProcedureModifier.TwentyTwo],
+ *                 chargeAmountCents: 10000,
+ *                 allowedAmountCents: 8000,
+ *                 insuranceBalanceCents: 0,
+ *                 patientBalanceCents: 2000,
+ *                 paidAmountCents: 8000,
+ *                 patientResponsibilityCents: 2000,
+ *                 diagnosisIdZero: CandidApi.DiagnosisId("4AC84BCD-12F5-4F86-A57B-E06749127C98"),
+ *                 diagnosisIdOne: CandidApi.DiagnosisId("EEA5CA5A-8B43-45FD-8CBD-C6CC1103E759"),
+ *                 diagnosisIdTwo: CandidApi.DiagnosisId("5C4AA029-2DB9-4202-916E-E93C708F65FF"),
+ *                 diagnosisIdThree: CandidApi.DiagnosisId("81795126-A3AC-443C-B47E-7259A16AB4A2"),
+ *                 serviceLineEraData: {
+ *                     serviceLineAdjustments: [{
+ *                             createdAt: new Date("2023-01-01T00:00:00.000Z"),
+ *                             adjustmentGroupCode: "CO",
+ *                             adjustmentReasonCode: "CO",
+ *                             adjustmentAmountCents: 1000,
+ *                             adjustmentNote: "test_note"
+ *                         }],
+ *                     remittanceAdviceRemarkCodes: ["N362"]
+ *                 },
+ *                 serviceLineManualAdjustments: [{
+ *                         createdAt: new Date("2023-01-01T00:00:00.000Z"),
+ *                         adjustmentGroupCode: "CO",
+ *                         adjustmentReasonCode: "CO",
+ *                         adjustmentAmountCents: 1000,
+ *                         adjustmentNote: "test_note"
+ *                     }],
+ *                 relatedInvoices: [{
+ *                         id: CandidApi.InvoiceId("901BE2F1-41BC-456E-9987-4FE2F84F9D75"),
+ *                         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",
+ *                         patientExternalId: CandidApi.PatientExternalId("10FED4D6-4C5A-48DF-838A-EEF45A74788D"),
+ *                         note: "test_note",
+ *                         dueDate: CandidApi.Date_("2023-10-10"),
+ *                         status: CandidApi.InvoiceStatus.Draft,
+ *                         url: "https://example.com",
+ *                         customerInvoiceUrl: "https://example.com",
+ *                         items: [{
+ *                                 serviceLineId: CandidApi.ServiceLineId("CED00F23-6E68-4678-9DBC-F5AA2969A565"),
+ *                                 amountCents: 500
+ *                             }]
+ *                     }],
+ *                 denialReason: {
+ *                     reason: CandidApi.serviceLines.v2.DenialReasonContent.AuthorizationRequired
+ *                 },
+ *                 placeOfServiceCode: CandidApi.FacilityTypeCode.Pharmacy,
+ *                 serviceLineId: CandidApi.ServiceLineId("CED00F23-6E68-4678-9DBC-F5AA2969A565"),
+ *                 procedureCode: "99213",
+ *                 quantity: CandidApi.Decimal("1"),
+ *                 units: CandidApi.ServiceLineUnits.Mj,
+ *                 claimId: CandidApi.ClaimId("026A1FB8-748E-4859-A2D7-3EA9E07D25AE"),
+ *                 dateOfServiceRange: {
+ *                     startDate: CandidApi.Date_("2023-01-01"),
+ *                     endDate: CandidApi.Date_("2023-01-03")
+ *                 }
+ *             }],
+ *         eras: [{
+ *                 eraId: CandidApi.EraId("4D844EF1-2253-43CD-A4F1-6DB7E65CB54B"),
+ *                 checkNumber: "CHK12345",
+ *                 checkDate: CandidApi.Date_("2023-10-12")
+ *             }]
+ *     }
+ */
 export interface Claim {
     claimId: CandidApi.ClaimId;
     status: CandidApi.ClaimStatus;

package/api/resources/commons/types/Email.d.ts

@@ -2,6 +2,10 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../..";
+/**
+ * @example
+ *     CandidApi.Email("johndoe@joincandidhealth.com")
+ */
 export declare type Email = string & {
     Email: void;
 };

package/api/resources/commons/types/PageToken.d.ts

@@ -2,6 +2,10 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../..";
+/**
+ * @example
+ *     CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9")
+ */
 export declare type PageToken = string & {
     PageToken: void;
 };

package/api/resources/commons/types/PhoneNumber.d.ts

@@ -2,6 +2,13 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../..";
+/**
+ * @example
+ *     {
+ *         number: "1234567890",
+ *         type: CandidApi.PhoneNumberType.Home
+ *     }
+ */
 export interface PhoneNumber {
     number: string;
     type: CandidApi.PhoneNumberType;

package/api/resources/commons/types/StreetAddressLongZip.d.ts

@@ -2,6 +2,17 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../..";
+/**
+ * @example
+ *     {
+ *         address1: "123 Main St",
+ *         address2: "Apt 1",
+ *         city: "New York",
+ *         state: CandidApi.State.Ny,
+ *         zipCode: "10001",
+ *         zipPlusFourCode: "1234"
+ *     }
+ */
 export interface StreetAddressLongZip extends CandidApi.StreetAddressBase {
     /** 4-digit zip add-on code https://en.wikipedia.org/wiki/ZIP_Code#ZIP+4 */
     zipPlusFourCode: string;

package/api/resources/commons/types/StreetAddressShortZip.d.ts

@@ -2,6 +2,17 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../..";
+/**
+ * @example
+ *     {
+ *         address1: "123 Main St",
+ *         address2: "Apt 1",
+ *         city: "New York",
+ *         state: CandidApi.State.Ny,
+ *         zipCode: "10001",
+ *         zipPlusFourCode: "1234"
+ *     }
+ */
 export interface StreetAddressShortZip extends CandidApi.StreetAddressBase {
     /** 4-digit zip add-on code https://en.wikipedia.org/wiki/ZIP_Code#ZIP+4 */
     zipPlusFourCode?: string;

package/api/resources/diagnoses/types/Diagnosis.d.ts

@@ -2,6 +2,18 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../..";
+/**
+ * @example
+ *     {
+ *         diagnosisId: CandidApi.DiagnosisId("5C770E00-4BBF-42AF-A73F-99C5E91FC0DB"),
+ *         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,
+ *         code: "I10"
+ *     }
+ */
 export interface Diagnosis extends CandidApi.StandaloneDiagnosisCreate {
     diagnosisId: CandidApi.DiagnosisId;
     createdAt: Date;

package/api/resources/eligibility/resources/v2/client/Client.js

@@ -65,7 +65,7 @@ class V2 {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "candidhealth",
-                "X-Fern-SDK-Version": "0.6.3",
+                "X-Fern-SDK-Version": "0.6.4",
             },
             contentType: "application/json",
             body: request,

package/api/resources/encounterProviders/resources/v2/types/EncounterProvider.d.ts

@@ -2,6 +2,26 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../../../..";
+/**
+ * @example
+ *     {
+ *         providerId: CandidApi.encounterProviders.v2.ProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+ *         address: {
+ *             address1: "123 Main St",
+ *             address2: "Apt 1",
+ *             city: "New York",
+ *             state: CandidApi.State.Ny,
+ *             zipCode: "10001",
+ *             zipPlusFourCode: "1234"
+ *         },
+ *         taxId: "123456789",
+ *         npi: "1234567890",
+ *         taxonomyCode: "207Q00000X",
+ *         firstName: "John",
+ *         lastName: "Doe",
+ *         organizationName: "Organization Name"
+ *     }
+ */
 export interface EncounterProvider extends CandidApi.encounterProviders.v2.EncounterProviderBase {
     providerId: CandidApi.encounterProviders.v2.ProviderId;
     address: CandidApi.StreetAddressLongZip;

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

@@ -103,7 +103,7 @@ class V4 {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "candidhealth",
-                "X-Fern-SDK-Version": "0.6.3",
+                "X-Fern-SDK-Version": "0.6.4",
             },
             contentType: "application/json",
             queryParameters: _queryParams,
@@ -133,7 +133,7 @@ class V4 {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "candidhealth",
-                "X-Fern-SDK-Version": "0.6.3",
+                "X-Fern-SDK-Version": "0.6.4",
             },
             contentType: "application/json",
             timeoutMs: 60000,
@@ -162,7 +162,7 @@ class V4 {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "candidhealth",
-                "X-Fern-SDK-Version": "0.6.3",
+                "X-Fern-SDK-Version": "0.6.4",
             },
             contentType: "application/json",
             body: await serializers.encounters.v4.EncounterCreate.jsonOrThrow(request, {
@@ -212,7 +212,7 @@ class V4 {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "candidhealth",
-                "X-Fern-SDK-Version": "0.6.3",
+                "X-Fern-SDK-Version": "0.6.4",
             },
             contentType: "application/json",
             body: await serializers.encounters.v4.EncounterUpdate.jsonOrThrow(request, {

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

@@ -2,6 +2,19 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as CandidApi from "../../../../..";
+/**
+ * @example
+ *     {
+ *         category: CandidApi.encounters.v4.NoteCategory.Clinical,
+ *         notes: ["Patient complained of mild chest pain."],
+ *         notesStructured: [{
+ *                 text: "Mild chest pain since morning.",
+ *                 authorName: "John Doe",
+ *                 authorNpi: CandidApi.Npi("1234567890"),
+ *                 timestamp: new Date("2023-01-01T00:00:00.000Z")
+ *             }]
+ *     }
+ */
 export interface ClinicalNoteCategory {
     category: CandidApi.encounters.v4.NoteCategory;
     notes: string[];