candidhealth 0.24.2 → 0.24.3

package/api/resources/customSchemas/resources/v1/client/requests/SchemaCreate.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/api/resources/customSchemas/resources/v1/client/requests/SchemaUpdate.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../../index";
+/**
+ * @example
+ *     {
+ *         name: "string",
+ *         description: "string",
+ *         fieldsToAdd: [{
+ *                 key: "string",
+ *                 type: CandidApi.Primitive.Boolean
+ *             }]
+ *     }
+ */
+export interface SchemaUpdate {
+    name?: string;
+    description?: string;
+    /** A list of typed entries to add to schema. Only additive modifications are permitted. */
+    fieldsToAdd?: CandidApi.customSchemas.v1.SchemaField[];
+}

package/api/resources/customSchemas/resources/v1/client/requests/SchemaUpdate.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/api/resources/customSchemas/resources/v1/client/requests/index.d.ts

@@ -0,0 +1,2 @@
+export { type SchemaCreate } from "./SchemaCreate";
+export { type SchemaUpdate } from "./SchemaUpdate";

package/api/resources/customSchemas/resources/v1/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/customSchemas/resources/v1/client/update.d.ts

@@ -0,0 +1,40 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+import * as core from "../../../../../../core";
+export declare type Error = CandidApi.customSchemas.v1.update.Error.EntityNotFoundError | CandidApi.customSchemas.v1.update.Error.UnauthorizedError | CandidApi.customSchemas.v1.update.Error.SchemaValidationHttpFailure | CandidApi.customSchemas.v1.update.Error._Unknown;
+export declare namespace Error {
+    interface EntityNotFoundError extends _Utils {
+        errorName: "EntityNotFoundError";
+        content: CandidApi.EntityNotFoundErrorMessage;
+    }
+    interface UnauthorizedError extends _Utils {
+        errorName: "UnauthorizedError";
+        content: CandidApi.UnauthorizedErrorMessage;
+    }
+    interface SchemaValidationHttpFailure extends _Utils {
+        errorName: "SchemaValidationHttpFailure";
+        content: CandidApi.customSchemas.v1.SchemaValidationFailure;
+    }
+    interface _Unknown extends _Utils {
+        errorName: void;
+        content: core.Fetcher.Error;
+    }
+    interface _Utils {
+        _visit: <_Result>(visitor: CandidApi.customSchemas.v1.update.Error._Visitor<_Result>) => _Result;
+    }
+    interface _Visitor<_Result> {
+        entityNotFoundError: (value: CandidApi.EntityNotFoundErrorMessage) => _Result;
+        unauthorizedError: (value: CandidApi.UnauthorizedErrorMessage) => _Result;
+        schemaValidationHttpFailure: (value: CandidApi.customSchemas.v1.SchemaValidationFailure) => _Result;
+        _other: (value: core.Fetcher.Error) => _Result;
+    }
+}
+export declare const Error: {
+    readonly entityNotFoundError: (value: CandidApi.EntityNotFoundErrorMessage) => CandidApi.customSchemas.v1.update.Error.EntityNotFoundError;
+    readonly unauthorizedError: (value: CandidApi.UnauthorizedErrorMessage) => CandidApi.customSchemas.v1.update.Error.UnauthorizedError;
+    readonly schemaValidationHttpFailure: (value: CandidApi.customSchemas.v1.SchemaValidationFailure) => CandidApi.customSchemas.v1.update.Error.SchemaValidationHttpFailure;
+    readonly _unknown: (fetcherError: core.Fetcher.Error) => CandidApi.customSchemas.v1.update.Error._Unknown;
+    readonly _visit: <_Result>(value: CandidApi.customSchemas.v1.update.Error, visitor: CandidApi.customSchemas.v1.update.Error._Visitor<_Result>) => _Result;
+};

package/api/resources/customSchemas/resources/v1/client/update.js

@@ -0,0 +1,80 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Error = void 0;
+const CandidApi = __importStar(require("../../../../../index"));
+exports.Error = {
+    entityNotFoundError: (value) => {
+        return {
+            content: value,
+            errorName: "EntityNotFoundError",
+            _visit: function (visitor) {
+                return CandidApi.customSchemas.v1.update.Error._visit(this, visitor);
+            },
+        };
+    },
+    unauthorizedError: (value) => {
+        return {
+            content: value,
+            errorName: "UnauthorizedError",
+            _visit: function (visitor) {
+                return CandidApi.customSchemas.v1.update.Error._visit(this, visitor);
+            },
+        };
+    },
+    schemaValidationHttpFailure: (value) => {
+        return {
+            content: value,
+            errorName: "SchemaValidationHttpFailure",
+            _visit: function (visitor) {
+                return CandidApi.customSchemas.v1.update.Error._visit(this, visitor);
+            },
+        };
+    },
+    _unknown: (fetcherError) => {
+        return {
+            errorName: undefined,
+            content: fetcherError,
+            _visit: function (visitor) {
+                return CandidApi.customSchemas.v1.update.Error._visit(this, visitor);
+            },
+        };
+    },
+    _visit: (value, visitor) => {
+        switch (value.errorName) {
+            case "EntityNotFoundError":
+                return visitor.entityNotFoundError(value.content);
+            case "UnauthorizedError":
+                return visitor.unauthorizedError(value.content);
+            case "SchemaValidationHttpFailure":
+                return visitor.schemaValidationHttpFailure(value.content);
+            default:
+                return visitor._other(value);
+        }
+    },
+};

package/api/resources/customSchemas/resources/v1/index.d.ts

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

package/api/resources/customSchemas/resources/v1/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
+__exportStar(require("./client"), exports);

package/api/resources/customSchemas/resources/v1/types/KeyWithNameAlreadyExistsError.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface KeyWithNameAlreadyExistsError {
+    key: string;
+    valueType: CandidApi.Primitive;
+}

package/api/resources/customSchemas/resources/v1/types/KeyWithNameAlreadyExistsError.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/api/resources/customSchemas/resources/v1/types/Schema.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface Schema {
+    id: CandidApi.SchemaId;
+    name: string;
+    description?: string;
+    fields: CandidApi.customSchemas.v1.SchemaField[];
+}

package/api/resources/customSchemas/resources/v1/types/Schema.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/api/resources/customSchemas/resources/v1/types/SchemaField.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface SchemaField {
+    key: string;
+    type: CandidApi.Primitive;
+}

package/api/resources/customSchemas/resources/v1/types/SchemaField.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/api/resources/customSchemas/resources/v1/types/SchemaGetMultiResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface SchemaGetMultiResponse {
+    schemas: CandidApi.customSchemas.v1.Schema[];
+}

package/api/resources/customSchemas/resources/v1/types/SchemaGetMultiResponse.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/api/resources/customSchemas/resources/v1/types/SchemaInstance.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+/**
+ * @example
+ *     {
+ *         schemaId: CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582"),
+ *         content: {
+ *             "provider_category": "internist",
+ *             "is_urgent_care": true,
+ *             "bmi": 24.2,
+ *             "age": 38
+ *         }
+ *     }
+ */
+export interface SchemaInstance {
+    /** The schema to which the content must adhere. */
+    schemaId: CandidApi.SchemaId;
+    /** A set of key-value pairs that adhere to the naming and type convention of the schema. Not all keys in the schema must be included, but attaching any key that does not exist in the schema or attaching a key with the incorrect value type will result in errors. */
+    content: Record<string, unknown>;
+}

package/api/resources/customSchemas/resources/v1/types/SchemaInstance.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/api/resources/customSchemas/resources/v1/types/SchemaValidationError.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export declare type SchemaValidationError = CandidApi.customSchemas.v1.SchemaValidationError.SchemaNameAlreadyExists | CandidApi.customSchemas.v1.SchemaValidationError.KeyNameAlreadyExists;
+export declare namespace SchemaValidationError {
+    interface SchemaNameAlreadyExists extends CandidApi.customSchemas.v1.SchemaWithNameAlreadyExistsError {
+        type: "schema_name_already_exists";
+    }
+    interface KeyNameAlreadyExists extends CandidApi.customSchemas.v1.KeyWithNameAlreadyExistsError {
+        type: "key_name_already_exists";
+    }
+}

package/api/resources/customSchemas/resources/v1/types/SchemaValidationError.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/api/resources/customSchemas/resources/v1/types/SchemaValidationFailure.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface SchemaValidationFailure {
+    errors: CandidApi.customSchemas.v1.SchemaValidationError[];
+}

package/api/resources/customSchemas/resources/v1/types/SchemaValidationFailure.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/api/resources/customSchemas/resources/v1/types/SchemaWithNameAlreadyExistsError.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface SchemaWithNameAlreadyExistsError {
+    name: string;
+    id: CandidApi.SchemaId;
+}

package/api/resources/customSchemas/resources/v1/types/SchemaWithNameAlreadyExistsError.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/api/resources/customSchemas/resources/v1/types/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./Schema";
+export * from "./SchemaInstance";
+export * from "./SchemaField";
+export * from "./SchemaGetMultiResponse";
+export * from "./SchemaWithNameAlreadyExistsError";
+export * from "./KeyWithNameAlreadyExistsError";
+export * from "./SchemaValidationFailure";
+export * from "./SchemaValidationError";

package/api/resources/customSchemas/resources/v1/types/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Schema"), exports);
+__exportStar(require("./SchemaInstance"), exports);
+__exportStar(require("./SchemaField"), exports);
+__exportStar(require("./SchemaGetMultiResponse"), exports);
+__exportStar(require("./SchemaWithNameAlreadyExistsError"), exports);
+__exportStar(require("./KeyWithNameAlreadyExistsError"), exports);
+__exportStar(require("./SchemaValidationFailure"), exports);
+__exportStar(require("./SchemaValidationError"), exports);

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

@@ -83,7 +83,7 @@ class V2 {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "candidhealth",
-                    "X-Fern-SDK-Version": "0.24.2",
+                    "X-Fern-SDK-Version": "0.24.3",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -156,7 +156,7 @@ class V2 {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "candidhealth",
-                    "X-Fern-SDK-Version": "0.24.2",
+                    "X-Fern-SDK-Version": "0.24.3",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -227,7 +227,7 @@ class V2 {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "candidhealth",
-                    "X-Fern-SDK-Version": "0.24.2",
+                    "X-Fern-SDK-Version": "0.24.3",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/api/resources/encounters/resources/v4/client/Client.d.ts

@@ -364,6 +364,15 @@ export declare class V4 {
      *                 }]
      *         },
      *         tagIds: [CandidApi.TagId("string")],
+     *         schemaInstances: [{
+     *                 schemaId: CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582"),
+     *                 content: {
+     *                     "provider_category": "internist",
+     *                     "is_urgent_care": true,
+     *                     "bmi": 24.2,
+     *                     "age": 38
+     *                 }
+     *             }],
      *         externalId: CandidApi.EncounterExternalId("string"),
      *         priorAuthorizationNumber: CandidApi.encounters.v4.PriorAuthorizationNumber("string"),
      *         patientAuthorizedRelease: true,
@@ -522,7 +531,16 @@ export declare class V4 {
      *         onsetOfCurrentIllnessOrSymptomDate: "2023-01-15",
      *         lastMenstrualPeriodDate: "2023-01-15",
      *         delayReasonCode: CandidApi.DelayReasonCode.C1,
-     *         patientAuthorizedRelease: true
+     *         patientAuthorizedRelease: true,
+     *         schemaInstances: [{
+     *                 schemaId: CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582"),
+     *                 content: {
+     *                     "provider_category": "internist",
+     *                     "is_urgent_care": true,
+     *                     "bmi": 24.2,
+     *                     "age": 38
+     *                 }
+     *             }]
      *     })
      */
     update(encounterId: CandidApi.EncounterId, request?: CandidApi.encounters.v4.EncounterUpdate, requestOptions?: V4.RequestOptions): Promise<core.APIResponse<CandidApi.encounters.v4.Encounter, CandidApi.encounters.v4.update.Error>>;

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

@@ -132,7 +132,7 @@ class V4 {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "candidhealth",
-                    "X-Fern-SDK-Version": "0.24.2",
+                    "X-Fern-SDK-Version": "0.24.3",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -178,7 +178,7 @@ class V4 {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "candidhealth",
-                    "X-Fern-SDK-Version": "0.24.2",
+                    "X-Fern-SDK-Version": "0.24.3",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -521,6 +521,15 @@ class V4 {
      *                 }]
      *         },
      *         tagIds: [CandidApi.TagId("string")],
+     *         schemaInstances: [{
+     *                 schemaId: CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582"),
+     *                 content: {
+     *                     "provider_category": "internist",
+     *                     "is_urgent_care": true,
+     *                     "bmi": 24.2,
+     *                     "age": 38
+     *                 }
+     *             }],
      *         externalId: CandidApi.EncounterExternalId("string"),
      *         priorAuthorizationNumber: CandidApi.encounters.v4.PriorAuthorizationNumber("string"),
      *         patientAuthorizedRelease: true,
@@ -591,7 +600,7 @@ class V4 {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "candidhealth",
-                    "X-Fern-SDK-Version": "0.24.2",
+                    "X-Fern-SDK-Version": "0.24.3",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -621,6 +630,7 @@ class V4 {
                     case "EncounterGuarantorMissingContactInfoError":
                     case "HttpRequestValidationsError":
                     case "CashPayPayerError":
+                    case "SchemaInstanceValidationHttpFailure":
                         return {
                             ok: false,
                             error: serializers.encounters.v4.create.Error.parseOrThrow(_response.error.body, {
@@ -736,7 +746,16 @@ class V4 {
      *         onsetOfCurrentIllnessOrSymptomDate: "2023-01-15",
      *         lastMenstrualPeriodDate: "2023-01-15",
      *         delayReasonCode: CandidApi.DelayReasonCode.C1,
-     *         patientAuthorizedRelease: true
+     *         patientAuthorizedRelease: true,
+     *         schemaInstances: [{
+     *                 schemaId: CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582"),
+     *                 content: {
+     *                     "provider_category": "internist",
+     *                     "is_urgent_care": true,
+     *                     "bmi": 24.2,
+     *                     "age": 38
+     *                 }
+     *             }]
      *     })
      */
     update(encounterId, request = {}, requestOptions) {
@@ -750,7 +769,7 @@ class V4 {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "candidhealth",
-                    "X-Fern-SDK-Version": "0.24.2",
+                    "X-Fern-SDK-Version": "0.24.3",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -778,6 +797,7 @@ class V4 {
                     case "EntityNotFoundError":
                     case "UnauthorizedError":
                     case "HttpRequestValidationsError":
+                    case "SchemaInstanceValidationHttpFailure":
                         return {
                             ok: false,
                             error: serializers.encounters.v4.update.Error.parseOrThrow(_response.error.body, {

package/api/resources/encounters/resources/v4/client/create.d.ts

@@ -3,7 +3,7 @@
  */
 import * as CandidApi from "../../../../../index";
 import * as core from "../../../../../../core";
-export declare type Error = CandidApi.encounters.v4.create.Error.EncounterExternalIdUniquenessError | CandidApi.encounters.v4.create.Error.EncounterPatientControlNumberUniquenessError | CandidApi.encounters.v4.create.Error.EntityNotFoundError | CandidApi.encounters.v4.create.Error.EncounterGuarantorMissingContactInfoError | CandidApi.encounters.v4.create.Error.HttpRequestValidationsError | CandidApi.encounters.v4.create.Error.CashPayPayerError | CandidApi.encounters.v4.create.Error._Unknown;
+export declare type Error = CandidApi.encounters.v4.create.Error.EncounterExternalIdUniquenessError | CandidApi.encounters.v4.create.Error.EncounterPatientControlNumberUniquenessError | CandidApi.encounters.v4.create.Error.EntityNotFoundError | CandidApi.encounters.v4.create.Error.EncounterGuarantorMissingContactInfoError | CandidApi.encounters.v4.create.Error.HttpRequestValidationsError | CandidApi.encounters.v4.create.Error.CashPayPayerError | CandidApi.encounters.v4.create.Error.SchemaInstanceValidationHttpFailure | CandidApi.encounters.v4.create.Error._Unknown;
 export declare namespace Error {
     interface EncounterExternalIdUniquenessError extends _Utils {
         errorName: "EncounterExternalIdUniquenessError";
@@ -29,6 +29,10 @@ export declare namespace Error {
         errorName: "CashPayPayerError";
         content: CandidApi.encounters.v4.CashPayPayerErrorMessage;
     }
+    interface SchemaInstanceValidationHttpFailure extends _Utils {
+        errorName: "SchemaInstanceValidationHttpFailure";
+        content: CandidApi.encounters.v4.SchemaInstanceValidationFailure;
+    }
     interface _Unknown extends _Utils {
         errorName: void;
         content: core.Fetcher.Error;
@@ -43,6 +47,7 @@ export declare namespace Error {
         encounterGuarantorMissingContactInfoError: (value: CandidApi.encounters.v4.EncounterGuarantorMissingContactInfoErrorType) => _Result;
         httpRequestValidationsError: (value: CandidApi.RequestValidationError[]) => _Result;
         cashPayPayerError: (value: CandidApi.encounters.v4.CashPayPayerErrorMessage) => _Result;
+        schemaInstanceValidationHttpFailure: (value: CandidApi.encounters.v4.SchemaInstanceValidationFailure) => _Result;
         _other: (value: core.Fetcher.Error) => _Result;
     }
 }
@@ -53,6 +58,7 @@ export declare const Error: {
     readonly encounterGuarantorMissingContactInfoError: (value: CandidApi.encounters.v4.EncounterGuarantorMissingContactInfoErrorType) => CandidApi.encounters.v4.create.Error.EncounterGuarantorMissingContactInfoError;
     readonly httpRequestValidationsError: (value: CandidApi.RequestValidationError[]) => CandidApi.encounters.v4.create.Error.HttpRequestValidationsError;
     readonly cashPayPayerError: (value: CandidApi.encounters.v4.CashPayPayerErrorMessage) => CandidApi.encounters.v4.create.Error.CashPayPayerError;
+    readonly schemaInstanceValidationHttpFailure: (value: CandidApi.encounters.v4.SchemaInstanceValidationFailure) => CandidApi.encounters.v4.create.Error.SchemaInstanceValidationHttpFailure;
     readonly _unknown: (fetcherError: core.Fetcher.Error) => CandidApi.encounters.v4.create.Error._Unknown;
     readonly _visit: <_Result>(value: CandidApi.encounters.v4.create.Error, visitor: CandidApi.encounters.v4.create.Error._Visitor<_Result>) => _Result;
 };

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

@@ -83,6 +83,15 @@ exports.Error = {
             },
         };
     },
+    schemaInstanceValidationHttpFailure: (value) => {
+        return {
+            content: value,
+            errorName: "SchemaInstanceValidationHttpFailure",
+            _visit: function (visitor) {
+                return CandidApi.encounters.v4.create.Error._visit(this, visitor);
+            },
+        };
+    },
     _unknown: (fetcherError) => {
         return {
             errorName: undefined,
@@ -106,6 +115,8 @@ exports.Error = {
                 return visitor.httpRequestValidationsError(value.content);
             case "CashPayPayerError":
                 return visitor.cashPayPayerError(value.content);
+            case "SchemaInstanceValidationHttpFailure":
+                return visitor.schemaInstanceValidationHttpFailure(value.content);
             default:
                 return visitor._other(value);
         }

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

@@ -315,6 +315,15 @@ import * as CandidApi from "../../../../../../index";
  *                 }]
  *         },
  *         tagIds: [CandidApi.TagId("string")],
+ *         schemaInstances: [{
+ *                 schemaId: CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582"),
+ *                 content: {
+ *                     "provider_category": "internist",
+ *                     "is_urgent_care": true,
+ *                     "bmi": 24.2,
+ *                     "age": 38
+ *                 }
+ *             }],
  *         externalId: CandidApi.EncounterExternalId("string"),
  *         priorAuthorizationNumber: CandidApi.encounters.v4.PriorAuthorizationNumber("string"),
  *         patientAuthorizedRelease: true,
@@ -490,4 +499,10 @@ export interface EncounterCreate extends CandidApi.encounters.v4.EncounterBase {
     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/client/requests/EncounterUpdate.d.ts

@@ -96,7 +96,16 @@ import * as CandidApi from "../../../../../../index";
  *         onsetOfCurrentIllnessOrSymptomDate: "2023-01-15",
  *         lastMenstrualPeriodDate: "2023-01-15",
  *         delayReasonCode: CandidApi.DelayReasonCode.C1,
- *         patientAuthorizedRelease: true
+ *         patientAuthorizedRelease: true,
+ *         schemaInstances: [{
+ *                 schemaId: CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582"),
+ *                 content: {
+ *                     "provider_category": "internist",
+ *                     "is_urgent_care": true,
+ *                     "bmi": 24.2,
+ *                     "age": 38
+ *                 }
+ *             }]
  *     }
  */
 export interface EncounterUpdate {
@@ -239,4 +248,12 @@ export interface EncounterUpdate {
      *
      */
     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[];
 }