candidhealth 0.39.11 → 0.40.0

package/reference.md

@@ -3026,6 +3026,12 @@ await client.encounters.v4.create({
         conditionIndicator2: "AV",
         conditionIndicator3: "AV",
     },
+    claimSupplementalInformation: [
+        {
+            attachmentReportTypeCode: "03",
+            attachmentTransmissionCode: "BM",
+        },
+    ],
     externalId: CandidApi.EncounterExternalId("string"),
     dateOfService: "2023-01-15",
     endDateOfService: "2023-01-15",
@@ -6919,6 +6925,13 @@ await client.nonInsurancePayers.v1.create({
         zipCode: "10001",
         zipPlusFourCode: "1234",
     },
+    clinicalTrials: [
+        {
+            name: "string",
+            clinicalTrialNumber: "string",
+            clinicalTrialPhase: "Phase 1",
+        },
+    ],
 });
 ```
 
@@ -9625,6 +9638,7 @@ await client.preEncounter.appointments.v1.create({
             given: ["string"],
             use: "USUAL",
             period: {},
+            suffix: "string",
         },
         type: "PRIMARY",
         npi: "string",
@@ -9923,6 +9937,7 @@ await client.preEncounter.appointments.v1.update(CandidApi.AppointmentId("string
             given: ["string"],
             use: "USUAL",
             period: {},
+            suffix: "string",
         },
         type: "PRIMARY",
         npi: "string",
@@ -10170,6 +10185,7 @@ await client.preEncounter.coverages.v1.create({
             given: ["string"],
             use: "USUAL",
             period: {},
+            suffix: "string",
         },
         dateOfBirth: "2023-01-15",
         biologicalSex: "FEMALE",
@@ -10277,6 +10293,7 @@ await client.preEncounter.coverages.v1.update(CandidApi.CoverageId("d5e9c84f-c2b
             given: ["string"],
             use: "USUAL",
             period: {},
+            suffix: "string",
         },
         dateOfBirth: "2023-01-15",
         biologicalSex: "FEMALE",
@@ -10926,6 +10943,376 @@ await client.preEncounter.eligibilityChecks.v1.post({
 </dl>
 </details>
 
+## PreEncounter Images V1
+
+<details><summary><code>client.preEncounter.images.v1.<a href="/src/api/resources/preEncounter/resources/images/resources/v1/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.Image, CandidApi.preEncounter.images.v1.create.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Adds an image. VersionConflictError is returned if a front or back of this coverage already exists.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.images.v1.create({
+    fileName: "string",
+    displayName: "string",
+    fileType: "string",
+    status: "PENDING",
+    coverage: {
+        id: CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+        side: "FRONT",
+    },
+    patient: {
+        id: CandidApi.PatientId("string"),
+        notes: "string",
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.MutableImage`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.preEncounter.images.v1.<a href="/src/api/resources/preEncounter/resources/images/resources/v1/client/Client.ts">get</a>(id) -> core.APIResponse<CandidApi.Image, CandidApi.preEncounter.images.v1.get.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Gets an image by imageId.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.images.v1.get(CandidApi.ImageId("string"));
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `CandidApi.ImageId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.preEncounter.images.v1.<a href="/src/api/resources/preEncounter/resources/images/resources/v1/client/Client.ts">update</a>(id, version, { ...params }) -> core.APIResponse<CandidApi.Image, CandidApi.preEncounter.images.v1.update.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates an Image. The path must contain the most recent version to prevent races.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.images.v1.update(CandidApi.ImageId("string"), "string", {
+    fileName: "string",
+    displayName: "string",
+    fileType: "string",
+    status: "PENDING",
+    coverage: {
+        id: CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+        side: "FRONT",
+    },
+    patient: {
+        id: CandidApi.PatientId("string"),
+        notes: "string",
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `CandidApi.ImageId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**version:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.MutableImage`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.preEncounter.images.v1.<a href="/src/api/resources/preEncounter/resources/images/resources/v1/client/Client.ts">deactivate</a>(id, version) -> core.APIResponse<void, CandidApi.preEncounter.images.v1.deactivate.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Sets an Image as deactivated. The path must contain the most recent version to prevent races.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.images.v1.deactivate(CandidApi.ImageId("string"), "string");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `CandidApi.ImageId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**version:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.preEncounter.images.v1.<a href="/src/api/resources/preEncounter/resources/images/resources/v1/client/Client.ts">getMulti</a>({ ...params }) -> core.APIResponse<CandidApi.Image[], CandidApi.preEncounter.images.v1.getMulti.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Searches for images that match the query parameters.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.images.v1.getMulti({
+    patientId: "string",
+    coverageId: "string",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.preEncounter.images.v1.ImageGetMultiRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## PreEncounter Lists V1
 
 <details><summary><code>client.preEncounter.lists.v1.<a href="/src/api/resources/preEncounter/resources/lists/resources/v1/client/Client.ts">getPatientList</a>({ ...params }) -> core.APIResponse<CandidApi.PatientListPage, CandidApi.preEncounter.lists.v1.getPatientList.Error></code></summary>
@@ -11390,6 +11777,7 @@ await client.preEncounter.patients.v1.create({
             given: ["string"],
             use: "USUAL",
             period: {},
+            suffix: "string",
         },
         otherNames: [
             {
@@ -11397,6 +11785,7 @@ await client.preEncounter.patients.v1.create({
                 given: ["string"],
                 use: "USUAL",
                 period: {},
+                suffix: "string",
             },
         ],
         otherIdentifiers: [
@@ -11462,6 +11851,7 @@ await client.preEncounter.patients.v1.create({
                     given: ["string"],
                     use: "USUAL",
                     period: {},
+                    suffix: "string",
                 },
                 telecoms: [
                     {
@@ -11491,6 +11881,7 @@ await client.preEncounter.patients.v1.create({
                     given: ["string"],
                     use: "USUAL",
                     period: {},
+                    suffix: "string",
                 },
                 type: "PRIMARY",
                 npi: "string",
@@ -11521,6 +11912,7 @@ await client.preEncounter.patients.v1.create({
                 given: ["string"],
                 use: "USUAL",
                 period: {},
+                suffix: "string",
             },
             telecom: {
                 value: "string",
@@ -11546,6 +11938,7 @@ await client.preEncounter.patients.v1.create({
                 additionalPayerInformation: {},
                 authorizationNumber: "string",
                 cptCode: "string",
+                applyForAllCptCodes: true,
                 units: "VISIT",
                 quantity: 1,
                 period: {},
@@ -11560,6 +11953,7 @@ await client.preEncounter.patients.v1.create({
                         given: ["string"],
                         use: "USUAL",
                         period: {},
+                        suffix: "string",
                     },
                     type: "PRIMARY",
                     npi: "string",
@@ -11654,6 +12048,7 @@ await client.preEncounter.patients.v1.createWithMrn({
             given: ["string"],
             use: "USUAL",
             period: {},
+            suffix: "string",
         },
         otherNames: [
             {
@@ -11661,6 +12056,7 @@ await client.preEncounter.patients.v1.createWithMrn({
                 given: ["string"],
                 use: "USUAL",
                 period: {},
+                suffix: "string",
             },
         ],
         otherIdentifiers: [
@@ -11726,6 +12122,7 @@ await client.preEncounter.patients.v1.createWithMrn({
                     given: ["string"],
                     use: "USUAL",
                     period: {},
+                    suffix: "string",
                 },
                 telecoms: [
                     {
@@ -11755,6 +12152,7 @@ await client.preEncounter.patients.v1.createWithMrn({
                     given: ["string"],
                     use: "USUAL",
                     period: {},
+                    suffix: "string",
                 },
                 type: "PRIMARY",
                 npi: "string",
@@ -11785,6 +12183,7 @@ await client.preEncounter.patients.v1.createWithMrn({
                 given: ["string"],
                 use: "USUAL",
                 period: {},
+                suffix: "string",
             },
             telecom: {
                 value: "string",
@@ -11810,6 +12209,7 @@ await client.preEncounter.patients.v1.createWithMrn({
                 additionalPayerInformation: {},
                 authorizationNumber: "string",
                 cptCode: "string",
+                applyForAllCptCodes: true,
                 units: "VISIT",
                 quantity: 1,
                 period: {},
@@ -11824,6 +12224,7 @@ await client.preEncounter.patients.v1.createWithMrn({
                         given: ["string"],
                         use: "USUAL",
                         period: {},
+                        suffix: "string",
                     },
                     type: "PRIMARY",
                     npi: "string",
@@ -11950,6 +12351,71 @@ await client.preEncounter.patients.v1.getMulti({
 </dl>
 </details>
 
+<details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">searchProviders</a>({ ...params }) -> core.APIResponse<CandidApi.ExternalProvider[], CandidApi.preEncounter.patients.v1.searchProviders.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Searches for referring providers that match the query parameters. The search is case-insensitive, supports fuzzy matching, and matches against provider name and NPI. The search criteria must be an alphanumeric string, and the search is limited to the first 20 results.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.patients.v1.searchProviders({
+    searchCriteria: "string",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.preEncounter.patients.v1.SearchProvidersRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">get</a>(id) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.get.Error></code></summary>
 <dl>
 <dd>
@@ -12110,6 +12576,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
         given: ["string"],
         use: "USUAL",
         period: {},
+        suffix: "string",
     },
     otherNames: [
         {
@@ -12117,6 +12584,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
             given: ["string"],
             use: "USUAL",
             period: {},
+            suffix: "string",
         },
     ],
     otherIdentifiers: [
@@ -12182,6 +12650,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
                 given: ["string"],
                 use: "USUAL",
                 period: {},
+                suffix: "string",
             },
             telecoms: [
                 {
@@ -12211,6 +12680,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
                 given: ["string"],
                 use: "USUAL",
                 period: {},
+                suffix: "string",
             },
             type: "PRIMARY",
             npi: "string",
@@ -12241,6 +12711,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
             given: ["string"],
             use: "USUAL",
             period: {},
+            suffix: "string",
         },
         telecom: {
             value: "string",
@@ -12266,6 +12737,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
             additionalPayerInformation: {},
             authorizationNumber: "string",
             cptCode: "string",
+            applyForAllCptCodes: true,
             units: "VISIT",
             quantity: 1,
             period: {},
@@ -12280,6 +12752,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
                     given: ["string"],
                     use: "USUAL",
                     period: {},
+                    suffix: "string",
                 },
                 type: "PRIMARY",
                 npi: "string",

package/serialization/resources/encounters/resources/v4/client/requests/EncounterCreate.d.ts

@@ -25,6 +25,7 @@ import { ExternalClaimSubmissionCreate } from "../../../../../claimSubmission/re
 import { TagId } from "../../../../../tags/types/TagId";
 import { SchemaInstance } from "../../../../../customSchemas/resources/v1/types/SchemaInstance";
 import { EpsdtReferral } from "../../types/EpsdtReferral";
+import { ClaimSupplementalInformation } from "../../types/ClaimSupplementalInformation";
 import { EncounterBase } from "../../types/EncounterBase";
 export declare const EncounterCreate: core.serialization.Schema<serializers.encounters.v4.EncounterCreate.Raw, CandidApi.encounters.v4.EncounterCreate>;
 export declare namespace EncounterCreate {
@@ -52,5 +53,6 @@ export declare namespace EncounterCreate {
         schema_instances?: SchemaInstance.Raw[] | null;
         referral_number?: string | null;
         epsdt_referral?: EpsdtReferral.Raw | null;
+        claim_supplemental_information?: ClaimSupplementalInformation.Raw[] | null;
     }
 }

package/serialization/resources/encounters/resources/v4/client/requests/EncounterCreate.js

@@ -59,6 +59,7 @@ const ExternalClaimSubmissionCreate_1 = require("../../../../../claimSubmission/
 const TagId_1 = require("../../../../../tags/types/TagId");
 const SchemaInstance_1 = require("../../../../../customSchemas/resources/v1/types/SchemaInstance");
 const EpsdtReferral_1 = require("../../types/EpsdtReferral");
+const ClaimSupplementalInformation_1 = require("../../types/ClaimSupplementalInformation");
 const EncounterBase_1 = require("../../types/EncounterBase");
 exports.EncounterCreate = core.serialization
     .object({
@@ -85,5 +86,6 @@ exports.EncounterCreate = core.serialization
     schemaInstances: core.serialization.property("schema_instances", core.serialization.list(SchemaInstance_1.SchemaInstance).optional()),
     referralNumber: core.serialization.property("referral_number", core.serialization.string().optional()),
     epsdtReferral: core.serialization.property("epsdt_referral", EpsdtReferral_1.EpsdtReferral.optional()),
+    claimSupplementalInformation: core.serialization.property("claim_supplemental_information", core.serialization.list(ClaimSupplementalInformation_1.ClaimSupplementalInformation).optional()),
 })
     .extend(EncounterBase_1.EncounterBase);

package/serialization/resources/encounters/resources/v4/types/ClaimSupplementalInformation.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../../../index";
+import * as CandidApi from "../../../../../../api/index";
+import * as core from "../../../../../../core";
+import { ReportTypeCode } from "./ReportTypeCode";
+import { ReportTransmissionCode } from "./ReportTransmissionCode";
+export declare const ClaimSupplementalInformation: core.serialization.ObjectSchema<serializers.encounters.v4.ClaimSupplementalInformation.Raw, CandidApi.encounters.v4.ClaimSupplementalInformation>;
+export declare namespace ClaimSupplementalInformation {
+    interface Raw {
+        attachment_report_type_code: ReportTypeCode.Raw;
+        attachment_transmission_code: ReportTransmissionCode.Raw;
+        attachment_control_number?: string | null;
+    }
+}