candidhealth 0.24.1 → 0.24.3

data/lib/candidhealth/custom_schemas/v_1/types/schema_instance.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module CustomSchemas
+    module V1
+      module Types
+        class SchemaInstance
+          # @return [String] The schema to which the content must adhere.
+          attr_reader :schema_id
+          # @return [Hash{String => Object}] 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.
+          attr_reader :content
+          # @return [OpenStruct] Additional properties unmapped to the current class definition
+          attr_reader :additional_properties
+          # @return [Object]
+          attr_reader :_field_set
+          protected :_field_set
+
+          OMIT = Object.new
+
+          # @param schema_id [String] The schema to which the content must adhere.
+          # @param content [Hash{String => Object}] 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.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::CustomSchemas::V1::Types::SchemaInstance]
+          def initialize(schema_id:, content:, additional_properties: nil)
+            @schema_id = schema_id
+            @content = content
+            @additional_properties = additional_properties
+            @_field_set = { "schema_id": schema_id, "content": content }
+          end
+
+          # Deserialize a JSON object to an instance of SchemaInstance
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::CustomSchemas::V1::Types::SchemaInstance]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            schema_id = struct["schema_id"]
+            content = struct["content"]
+            new(
+              schema_id: schema_id,
+              content: content,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of SchemaInstance to a JSON object
+          #
+          # @return [String]
+          def to_json(*_args)
+            @_field_set&.to_json
+          end
+
+          # Leveraged for Union-type generation, validate_raw attempts to parse the given
+          #  hash and check each fields type against the current object's property
+          #  definitions.
+          #
+          # @param obj [Object]
+          # @return [Void]
+          def self.validate_raw(obj:)
+            obj.schema_id.is_a?(String) != false || raise("Passed value for field obj.schema_id is not the expected type, validation failed.")
+            obj.content.is_a?(Hash) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/custom_schemas/v_1/types/schema_validation_error.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "schema_with_name_already_exists_error"
+require_relative "key_with_name_already_exists_error"
+
+module CandidApiClient
+  module CustomSchemas
+    module V1
+      module Types
+        class SchemaValidationError
+          # @return [Object]
+          attr_reader :member
+          # @return [String]
+          attr_reader :discriminant
+
+          private_class_method :new
+          alias kind_of? is_a?
+
+          # @param member [Object]
+          # @param discriminant [String]
+          # @return [CandidApiClient::CustomSchemas::V1::Types::SchemaValidationError]
+          def initialize(member:, discriminant:)
+            @member = member
+            @discriminant = discriminant
+          end
+
+          # Deserialize a JSON object to an instance of SchemaValidationError
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::CustomSchemas::V1::Types::SchemaValidationError]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            member = case struct.type
+                     when "schema_name_already_exists"
+                       CandidApiClient::CustomSchemas::V1::Types::SchemaWithNameAlreadyExistsError.from_json(json_object: json_object)
+                     when "key_name_already_exists"
+                       CandidApiClient::CustomSchemas::V1::Types::KeyWithNameAlreadyExistsError.from_json(json_object: json_object)
+                     else
+                       CandidApiClient::CustomSchemas::V1::Types::SchemaWithNameAlreadyExistsError.from_json(json_object: json_object)
+                     end
+            new(member: member, discriminant: struct.type)
+          end
+
+          # For Union Types, to_json functionality is delegated to the wrapped member.
+          #
+          # @return [String]
+          def to_json(*_args)
+            case @discriminant
+            when "schema_name_already_exists"
+              { **@member.to_json, type: @discriminant }.to_json
+            when "key_name_already_exists"
+              { **@member.to_json, type: @discriminant }.to_json
+            else
+              { "type": @discriminant, value: @member }.to_json
+            end
+            @member.to_json
+          end
+
+          # Leveraged for Union-type generation, validate_raw attempts to parse the given
+          #  hash and check each fields type against the current object's property
+          #  definitions.
+          #
+          # @param obj [Object]
+          # @return [Void]
+          def self.validate_raw(obj:)
+            case obj.type
+            when "schema_name_already_exists"
+              CandidApiClient::CustomSchemas::V1::Types::SchemaWithNameAlreadyExistsError.validate_raw(obj: obj)
+            when "key_name_already_exists"
+              CandidApiClient::CustomSchemas::V1::Types::KeyWithNameAlreadyExistsError.validate_raw(obj: obj)
+            else
+              raise("Passed value matched no type within the union, validation failed.")
+            end
+          end
+
+          # For Union Types, is_a? functionality is delegated to the wrapped member.
+          #
+          # @param obj [Object]
+          # @return [Boolean]
+          def is_a?(obj)
+            @member.is_a?(obj)
+          end
+
+          # @param member [CandidApiClient::CustomSchemas::V1::Types::SchemaWithNameAlreadyExistsError]
+          # @return [CandidApiClient::CustomSchemas::V1::Types::SchemaValidationError]
+          def self.schema_name_already_exists(member:)
+            new(member: member, discriminant: "schema_name_already_exists")
+          end
+
+          # @param member [CandidApiClient::CustomSchemas::V1::Types::KeyWithNameAlreadyExistsError]
+          # @return [CandidApiClient::CustomSchemas::V1::Types::SchemaValidationError]
+          def self.key_name_already_exists(member:)
+            new(member: member, discriminant: "key_name_already_exists")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/custom_schemas/v_1/types/schema_validation_failure.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "schema_validation_error"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module CustomSchemas
+    module V1
+      module Types
+        class SchemaValidationFailure
+          # @return [Array<CandidApiClient::CustomSchemas::V1::Types::SchemaValidationError>]
+          attr_reader :errors
+          # @return [OpenStruct] Additional properties unmapped to the current class definition
+          attr_reader :additional_properties
+          # @return [Object]
+          attr_reader :_field_set
+          protected :_field_set
+
+          OMIT = Object.new
+
+          # @param errors [Array<CandidApiClient::CustomSchemas::V1::Types::SchemaValidationError>]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::CustomSchemas::V1::Types::SchemaValidationFailure]
+          def initialize(errors:, additional_properties: nil)
+            @errors = errors
+            @additional_properties = additional_properties
+            @_field_set = { "errors": errors }
+          end
+
+          # Deserialize a JSON object to an instance of SchemaValidationFailure
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::CustomSchemas::V1::Types::SchemaValidationFailure]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            errors = parsed_json["errors"]&.map do |item|
+              item = item.to_json
+              CandidApiClient::CustomSchemas::V1::Types::SchemaValidationError.from_json(json_object: item)
+            end
+            new(errors: errors, additional_properties: struct)
+          end
+
+          # Serialize an instance of SchemaValidationFailure to a JSON object
+          #
+          # @return [String]
+          def to_json(*_args)
+            @_field_set&.to_json
+          end
+
+          # Leveraged for Union-type generation, validate_raw attempts to parse the given
+          #  hash and check each fields type against the current object's property
+          #  definitions.
+          #
+          # @param obj [Object]
+          # @return [Void]
+          def self.validate_raw(obj:)
+            obj.errors.is_a?(Array) != false || raise("Passed value for field obj.errors is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/custom_schemas/v_1/types/schema_with_name_already_exists_error.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module CustomSchemas
+    module V1
+      module Types
+        class SchemaWithNameAlreadyExistsError
+          # @return [String]
+          attr_reader :name
+          # @return [String]
+          attr_reader :id
+          # @return [OpenStruct] Additional properties unmapped to the current class definition
+          attr_reader :additional_properties
+          # @return [Object]
+          attr_reader :_field_set
+          protected :_field_set
+
+          OMIT = Object.new
+
+          # @param name [String]
+          # @param id [String]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::CustomSchemas::V1::Types::SchemaWithNameAlreadyExistsError]
+          def initialize(name:, id:, additional_properties: nil)
+            @name = name
+            @id = id
+            @additional_properties = additional_properties
+            @_field_set = { "name": name, "id": id }
+          end
+
+          # Deserialize a JSON object to an instance of SchemaWithNameAlreadyExistsError
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::CustomSchemas::V1::Types::SchemaWithNameAlreadyExistsError]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            name = struct["name"]
+            id = struct["id"]
+            new(
+              name: name,
+              id: id,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of SchemaWithNameAlreadyExistsError to a JSON object
+          #
+          # @return [String]
+          def to_json(*_args)
+            @_field_set&.to_json
+          end
+
+          # Leveraged for Union-type generation, validate_raw attempts to parse the given
+          #  hash and check each fields type against the current object's property
+          #  definitions.
+          #
+          # @param obj [Object]
+          # @return [Void]
+          def self.validate_raw(obj:)
+            obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+            obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/encounters/v_4/client.rb

@@ -33,6 +33,7 @@ require_relative "types/patient_history_category"
 require_relative "../../service_lines/v_2/types/service_line_create"
 require_relative "../../guarantor/v_1/types/guarantor_create"
 require_relative "../../claim_submission/v_1/types/external_claim_submission_create"
+require_relative "../../custom_schemas/v_1/types/schema_instance"
 require "async"
 
 module CandidApiClient
@@ -552,6 +553,11 @@ module CandidApiClient
         #   * :patient_control_number (String)
         #   * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::ClaimSubmissionRecordCreate>)
         # @param tag_ids [Array<String>] Names of tags that should be on the encounter.
+        # @param schema_instances [Array<Hash>] 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.Request of type Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>, as a Hash
+        #   * :schema_id (String)
+        #   * :content (Hash{String => Object})
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::Encounters::V4::Types::Encounter]
         # @example
@@ -576,10 +582,11 @@ module CandidApiClient
         #    service_lines: [{ modifiers: [TWENTY_TWO], procedure_code: "string", quantity: "string", units: MJ, charge_amount_cents: 1, diagnosis_pointers: [1], drug_identification: {  }, place_of_service_code: PHARMACY, description: "string", date_of_service: DateTime.parse(2023-01-15), end_date_of_service: DateTime.parse(2023-01-15), referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" }, initial_referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, qualifier: DQ, first_name: "string", last_name: "string", organization_name: "string" }, supervising_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" }, ordering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" } }],
         #    guarantor: { phone_numbers: [{ number: "1234567890", type: HOME }], phone_consent: true, email: "johndoe@joincandidhealth.com", email_consent: true, first_name: "string", last_name: "string", external_id: "string", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
         #    external_claim_submission: { claim_created_at: DateTime.parse(2023-01-01T12:00:00.000Z), patient_control_number: "PATIENT_CONTROL_NUMBER", submission_records: [{ submitted_at: DateTime.parse(2023-01-01T13:00:00.000Z), claim_frequency_code: ORIGINAL, payer_responsibility: PRIMARY, intended_submission_medium: ELECTRONIC }, { submitted_at: DateTime.parse(2023-01-04T12:00:00.000Z), claim_frequency_code: REPLACEMENT, payer_responsibility: PRIMARY, intended_submission_medium: PAPER }] },
-        #    tag_ids: ["string"]
+        #    tag_ids: ["string"],
+        #    schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }]
         #  )
         def create(external_id:, patient_authorized_release:, benefits_assigned_to_provider:,
-                   provider_accepts_assignment:, billable_status:, responsible_party:, patient:, billing_provider:, rendering_provider:, diagnoses:, place_of_service_code:, prior_authorization_number: nil, appointment_type: nil, existing_medications: nil, vitals: nil, interventions: nil, pay_to_address: nil, synchronicity: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, additional_properties: nil, _field_set: nil, date_of_service: nil, end_date_of_service: nil, referring_provider: nil, initial_referring_provider: nil, supervising_provider: nil, service_facility: nil, subscriber_primary: nil, subscriber_secondary: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, guarantor: nil, external_claim_submission: nil, tag_ids: nil, request_options: nil)
+                   provider_accepts_assignment:, billable_status:, responsible_party:, patient:, billing_provider:, rendering_provider:, diagnoses:, place_of_service_code:, prior_authorization_number: nil, appointment_type: nil, existing_medications: nil, vitals: nil, interventions: nil, pay_to_address: nil, synchronicity: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, additional_properties: nil, _field_set: nil, date_of_service: nil, end_date_of_service: nil, referring_provider: nil, initial_referring_provider: nil, supervising_provider: nil, service_facility: nil, subscriber_primary: nil, subscriber_secondary: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, guarantor: nil, external_claim_submission: nil, tag_ids: nil, schema_instances: nil, request_options: nil)
           response = @request_client.conn.post do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
@@ -631,7 +638,8 @@ module CandidApiClient
               service_lines: service_lines,
               guarantor: guarantor,
               external_claim_submission: external_claim_submission,
-              tag_ids: tag_ids
+              tag_ids: tag_ids,
+              schema_instances: schema_instances
             }.compact
             req.url "#{@request_client.get_url(environment: CandidApi,
                                                request_options: request_options)}/api/encounters/v4"
@@ -784,6 +792,15 @@ module CandidApiClient
         # @param patient_authorized_release [Boolean] Whether this patient has authorized the release of medical information
         #  for billing purpose.
         #  Box 12 on the CMS-1500 claim form.
+        # @param schema_instances [Array<Hash>] 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.Request of type Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>, as a Hash
+        #   * :schema_id (String)
+        #   * :content (Hash{String => Object})
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::Encounters::V4::Types::Encounter]
         # @example
@@ -815,10 +832,11 @@ module CandidApiClient
         #    onset_of_current_illness_or_symptom_date: DateTime.parse(2023-01-15),
         #    last_menstrual_period_date: DateTime.parse(2023-01-15),
         #    delay_reason_code: C_1,
-        #    patient_authorized_release: true
+        #    patient_authorized_release: true,
+        #    schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }]
         #  )
         def update(encounter_id:, prior_authorization_number: nil, external_id: nil, date_of_service: nil,
-                   diagnosis_ids: nil, tag_ids: nil, clinical_notes: nil, pay_to_address: nil, billable_status: nil, responsible_party: nil, provider_accepts_assignment: nil, benefits_assigned_to_provider: nil, synchronicity: nil, place_of_service_code: nil, place_of_service_code_as_submitted: nil, appointment_type: nil, end_date_of_service: nil, subscriber_primary: nil, subscriber_secondary: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, patient_authorized_release: nil, request_options: nil)
+                   diagnosis_ids: nil, tag_ids: nil, clinical_notes: nil, pay_to_address: nil, billable_status: nil, responsible_party: nil, provider_accepts_assignment: nil, benefits_assigned_to_provider: nil, synchronicity: nil, place_of_service_code: nil, place_of_service_code_as_submitted: nil, appointment_type: nil, end_date_of_service: nil, subscriber_primary: nil, subscriber_secondary: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, patient_authorized_release: nil, schema_instances: nil, request_options: nil)
           response = @request_client.conn.patch do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
@@ -854,7 +872,8 @@ module CandidApiClient
               onset_of_current_illness_or_symptom_date: onset_of_current_illness_or_symptom_date,
               last_menstrual_period_date: last_menstrual_period_date,
               delay_reason_code: delay_reason_code,
-              patient_authorized_release: patient_authorized_release
+              patient_authorized_release: patient_authorized_release,
+              schema_instances: schema_instances
             }.compact
             req.url "#{@request_client.get_url(environment: CandidApi,
                                                request_options: request_options)}/api/encounters/v4/#{encounter_id}"
@@ -1381,6 +1400,11 @@ module CandidApiClient
         #   * :patient_control_number (String)
         #   * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::ClaimSubmissionRecordCreate>)
         # @param tag_ids [Array<String>] Names of tags that should be on the encounter.
+        # @param schema_instances [Array<Hash>] 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.Request of type Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>, as a Hash
+        #   * :schema_id (String)
+        #   * :content (Hash{String => Object})
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::Encounters::V4::Types::Encounter]
         # @example
@@ -1405,10 +1429,11 @@ module CandidApiClient
         #    service_lines: [{ modifiers: [TWENTY_TWO], procedure_code: "string", quantity: "string", units: MJ, charge_amount_cents: 1, diagnosis_pointers: [1], drug_identification: {  }, place_of_service_code: PHARMACY, description: "string", date_of_service: DateTime.parse(2023-01-15), end_date_of_service: DateTime.parse(2023-01-15), referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" }, initial_referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, qualifier: DQ, first_name: "string", last_name: "string", organization_name: "string" }, supervising_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" }, ordering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" } }],
         #    guarantor: { phone_numbers: [{ number: "1234567890", type: HOME }], phone_consent: true, email: "johndoe@joincandidhealth.com", email_consent: true, first_name: "string", last_name: "string", external_id: "string", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
         #    external_claim_submission: { claim_created_at: DateTime.parse(2023-01-01T12:00:00.000Z), patient_control_number: "PATIENT_CONTROL_NUMBER", submission_records: [{ submitted_at: DateTime.parse(2023-01-01T13:00:00.000Z), claim_frequency_code: ORIGINAL, payer_responsibility: PRIMARY, intended_submission_medium: ELECTRONIC }, { submitted_at: DateTime.parse(2023-01-04T12:00:00.000Z), claim_frequency_code: REPLACEMENT, payer_responsibility: PRIMARY, intended_submission_medium: PAPER }] },
-        #    tag_ids: ["string"]
+        #    tag_ids: ["string"],
+        #    schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }]
         #  )
         def create(external_id:, patient_authorized_release:, benefits_assigned_to_provider:,
-                   provider_accepts_assignment:, billable_status:, responsible_party:, patient:, billing_provider:, rendering_provider:, diagnoses:, place_of_service_code:, prior_authorization_number: nil, appointment_type: nil, existing_medications: nil, vitals: nil, interventions: nil, pay_to_address: nil, synchronicity: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, additional_properties: nil, _field_set: nil, date_of_service: nil, end_date_of_service: nil, referring_provider: nil, initial_referring_provider: nil, supervising_provider: nil, service_facility: nil, subscriber_primary: nil, subscriber_secondary: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, guarantor: nil, external_claim_submission: nil, tag_ids: nil, request_options: nil)
+                   provider_accepts_assignment:, billable_status:, responsible_party:, patient:, billing_provider:, rendering_provider:, diagnoses:, place_of_service_code:, prior_authorization_number: nil, appointment_type: nil, existing_medications: nil, vitals: nil, interventions: nil, pay_to_address: nil, synchronicity: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, additional_properties: nil, _field_set: nil, date_of_service: nil, end_date_of_service: nil, referring_provider: nil, initial_referring_provider: nil, supervising_provider: nil, service_facility: nil, subscriber_primary: nil, subscriber_secondary: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, guarantor: nil, external_claim_submission: nil, tag_ids: nil, schema_instances: nil, request_options: nil)
           Async do
             response = @request_client.conn.post do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -1461,7 +1486,8 @@ module CandidApiClient
                 service_lines: service_lines,
                 guarantor: guarantor,
                 external_claim_submission: external_claim_submission,
-                tag_ids: tag_ids
+                tag_ids: tag_ids,
+                schema_instances: schema_instances
               }.compact
               req.url "#{@request_client.get_url(environment: CandidApi,
                                                  request_options: request_options)}/api/encounters/v4"
@@ -1615,6 +1641,15 @@ module CandidApiClient
         # @param patient_authorized_release [Boolean] Whether this patient has authorized the release of medical information
         #  for billing purpose.
         #  Box 12 on the CMS-1500 claim form.
+        # @param schema_instances [Array<Hash>] 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.Request of type Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>, as a Hash
+        #   * :schema_id (String)
+        #   * :content (Hash{String => Object})
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::Encounters::V4::Types::Encounter]
         # @example
@@ -1646,10 +1681,11 @@ module CandidApiClient
         #    onset_of_current_illness_or_symptom_date: DateTime.parse(2023-01-15),
         #    last_menstrual_period_date: DateTime.parse(2023-01-15),
         #    delay_reason_code: C_1,
-        #    patient_authorized_release: true
+        #    patient_authorized_release: true,
+        #    schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }]
         #  )
         def update(encounter_id:, prior_authorization_number: nil, external_id: nil, date_of_service: nil,
-                   diagnosis_ids: nil, tag_ids: nil, clinical_notes: nil, pay_to_address: nil, billable_status: nil, responsible_party: nil, provider_accepts_assignment: nil, benefits_assigned_to_provider: nil, synchronicity: nil, place_of_service_code: nil, place_of_service_code_as_submitted: nil, appointment_type: nil, end_date_of_service: nil, subscriber_primary: nil, subscriber_secondary: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, patient_authorized_release: nil, request_options: nil)
+                   diagnosis_ids: nil, tag_ids: nil, clinical_notes: nil, pay_to_address: nil, billable_status: nil, responsible_party: nil, provider_accepts_assignment: nil, benefits_assigned_to_provider: nil, synchronicity: nil, place_of_service_code: nil, place_of_service_code_as_submitted: nil, appointment_type: nil, end_date_of_service: nil, subscriber_primary: nil, subscriber_secondary: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, patient_authorized_release: nil, schema_instances: nil, request_options: nil)
           Async do
             response = @request_client.conn.patch do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -1686,7 +1722,8 @@ module CandidApiClient
                 onset_of_current_illness_or_symptom_date: onset_of_current_illness_or_symptom_date,
                 last_menstrual_period_date: last_menstrual_period_date,
                 delay_reason_code: delay_reason_code,
-                patient_authorized_release: patient_authorized_release
+                patient_authorized_release: patient_authorized_release,
+                schema_instances: schema_instances
               }.compact
               req.url "#{@request_client.get_url(environment: CandidApi,
                                                  request_options: request_options)}/api/encounters/v4/#{encounter_id}"

data/lib/candidhealth/encounters/v_4/types/encounter.rb

@@ -17,6 +17,7 @@ require_relative "../../../tags/types/tag"
 require_relative "coding_attribution_type"
 require_relative "encounter_owner_of_next_action_type"
 require_relative "encounter_submission_origin_type"
+require_relative "../../../custom_schemas/v_1/types/schema_instance"
 require_relative "medication"
 require_relative "vitals"
 require_relative "intervention"
@@ -144,6 +145,10 @@ module CandidApiClient
           #  For Encounters created with an external_claim_submission object, this will be
           #  EncounterSubmissionOriginType.EXTERNAL.
           attr_reader :submission_origin
+          # @return [Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>] 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.
+          attr_reader :schema_instances
           # @return [String] A client-specified unique ID to associate with this encounter;
           #  for example, your internal encounter ID or a Dr. Chrono encounter ID.
           #  This field should not contain PHI.
@@ -311,6 +316,9 @@ module CandidApiClient
           #  EncounterSubmissionOriginType.CANDID.
           #  For Encounters created with an external_claim_submission object, this will be
           #  EncounterSubmissionOriginType.EXTERNAL.
+          # @param schema_instances [Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>] 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.
           # @param external_id [String] A client-specified unique ID to associate with this encounter;
           #  for example, your internal encounter ID or a Dr. Chrono encounter ID.
           #  This field should not contain PHI.
@@ -372,7 +380,7 @@ module CandidApiClient
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::Encounters::V4::Types::Encounter]
           def initialize(date_of_service:, encounter_id:, claims:, patient:, billing_provider:, rendering_provider:,
-                         service_facility:, url:, diagnoses:, clinical_notes:, patient_histories:, patient_payments:, tags:, owner_of_next_action:, submission_origin:, external_id:, patient_authorized_release:, benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, responsible_party:, patient_control_number: OMIT, end_date_of_service: OMIT, guarantor: OMIT, referring_provider: OMIT, initial_referring_provider: OMIT, supervising_provider: OMIT, subscriber_primary: OMIT, subscriber_secondary: OMIT, billing_notes: OMIT, place_of_service_code: OMIT, place_of_service_code_as_submitted: OMIT, coding_attribution: OMIT, work_queue_id: OMIT, work_queue_membership_activated_at: OMIT, prior_authorization_number: OMIT, appointment_type: OMIT, existing_medications: OMIT, vitals: OMIT, interventions: OMIT, pay_to_address: OMIT, synchronicity: OMIT, additional_information: OMIT, service_authorization_exception_code: OMIT, admission_date: OMIT, discharge_date: OMIT, onset_of_current_illness_or_symptom_date: OMIT, last_menstrual_period_date: OMIT, delay_reason_code: OMIT, additional_properties: nil)
+                         service_facility:, url:, diagnoses:, clinical_notes:, patient_histories:, patient_payments:, tags:, owner_of_next_action:, submission_origin:, schema_instances:, external_id:, patient_authorized_release:, benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, responsible_party:, patient_control_number: OMIT, end_date_of_service: OMIT, guarantor: OMIT, referring_provider: OMIT, initial_referring_provider: OMIT, supervising_provider: OMIT, subscriber_primary: OMIT, subscriber_secondary: OMIT, billing_notes: OMIT, place_of_service_code: OMIT, place_of_service_code_as_submitted: OMIT, coding_attribution: OMIT, work_queue_id: OMIT, work_queue_membership_activated_at: OMIT, prior_authorization_number: OMIT, appointment_type: OMIT, existing_medications: OMIT, vitals: OMIT, interventions: OMIT, pay_to_address: OMIT, synchronicity: OMIT, additional_information: OMIT, service_authorization_exception_code: OMIT, admission_date: OMIT, discharge_date: OMIT, onset_of_current_illness_or_symptom_date: OMIT, last_menstrual_period_date: OMIT, delay_reason_code: OMIT, additional_properties: nil)
             @patient_control_number = patient_control_number if patient_control_number != OMIT
             @date_of_service = date_of_service
             @end_date_of_service = end_date_of_service if end_date_of_service != OMIT
@@ -406,6 +414,7 @@ module CandidApiClient
             end
             @owner_of_next_action = owner_of_next_action
             @submission_origin = submission_origin
+            @schema_instances = schema_instances
             @external_id = external_id
             @prior_authorization_number = prior_authorization_number if prior_authorization_number != OMIT
             @patient_authorized_release = patient_authorized_release
@@ -461,6 +470,7 @@ module CandidApiClient
               "work_queue_membership_activated_at": work_queue_membership_activated_at,
               "owner_of_next_action": owner_of_next_action,
               "submission_origin": submission_origin,
+              "schema_instances": schema_instances,
               "external_id": external_id,
               "prior_authorization_number": prior_authorization_number,
               "patient_authorized_release": patient_authorized_release,
@@ -597,6 +607,10 @@ module CandidApiClient
                                                  end
             owner_of_next_action = struct["owner_of_next_action"]
             submission_origin = struct["submission_origin"]
+            schema_instances = parsed_json["schema_instances"]&.map do |item|
+              item = item.to_json
+              CandidApiClient::CustomSchemas::V1::Types::SchemaInstance.from_json(json_object: item)
+            end
             external_id = struct["external_id"]
             prior_authorization_number = struct["prior_authorization_number"]
             patient_authorized_release = struct["patient_authorized_release"]
@@ -667,6 +681,7 @@ module CandidApiClient
               work_queue_membership_activated_at: work_queue_membership_activated_at,
               owner_of_next_action: owner_of_next_action,
               submission_origin: submission_origin,
+              schema_instances: schema_instances,
               external_id: external_id,
               prior_authorization_number: prior_authorization_number,
               patient_authorized_release: patient_authorized_release,
@@ -734,6 +749,7 @@ module CandidApiClient
             obj.work_queue_membership_activated_at&.is_a?(DateTime) != false || raise("Passed value for field obj.work_queue_membership_activated_at is not the expected type, validation failed.")
             obj.owner_of_next_action.is_a?(CandidApiClient::Encounters::V4::Types::EncounterOwnerOfNextActionType) != false || raise("Passed value for field obj.owner_of_next_action is not the expected type, validation failed.")
             obj.submission_origin.is_a?(CandidApiClient::Encounters::V4::Types::EncounterSubmissionOriginType) != false || raise("Passed value for field obj.submission_origin is not the expected type, validation failed.")
+            obj.schema_instances.is_a?(Array) != false || raise("Passed value for field obj.schema_instances is not the expected type, validation failed.")
             obj.external_id.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")
             obj.prior_authorization_number&.is_a?(String) != false || raise("Passed value for field obj.prior_authorization_number is not the expected type, validation failed.")
             obj.patient_authorized_release.is_a?(Boolean) != false || raise("Passed value for field obj.patient_authorized_release is not the expected type, validation failed.")

data/lib/candidhealth/encounters/v_4/types/key_does_not_exist_error.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module Encounters
+    module V4
+      module Types
+        class KeyDoesNotExistError
+          # @return [String]
+          attr_reader :key
+          # @return [String]
+          attr_reader :schema_id
+          # @return [OpenStruct] Additional properties unmapped to the current class definition
+          attr_reader :additional_properties
+          # @return [Object]
+          attr_reader :_field_set
+          protected :_field_set
+
+          OMIT = Object.new
+
+          # @param key [String]
+          # @param schema_id [String]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::Encounters::V4::Types::KeyDoesNotExistError]
+          def initialize(key:, schema_id:, additional_properties: nil)
+            @key = key
+            @schema_id = schema_id
+            @additional_properties = additional_properties
+            @_field_set = { "key": key, "schema_id": schema_id }
+          end
+
+          # Deserialize a JSON object to an instance of KeyDoesNotExistError
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::Encounters::V4::Types::KeyDoesNotExistError]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            key = struct["key"]
+            schema_id = struct["schema_id"]
+            new(
+              key: key,
+              schema_id: schema_id,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of KeyDoesNotExistError to a JSON object
+          #
+          # @return [String]
+          def to_json(*_args)
+            @_field_set&.to_json
+          end
+
+          # Leveraged for Union-type generation, validate_raw attempts to parse the given
+          #  hash and check each fields type against the current object's property
+          #  definitions.
+          #
+          # @param obj [Object]
+          # @return [Void]
+          def self.validate_raw(obj:)
+            obj.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
+            obj.schema_id.is_a?(String) != false || raise("Passed value for field obj.schema_id is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end