candidhealth 1.6.0 → 1.8.0

data/lib/candidhealth/individual/types/patient_base.rb

@@ -13,10 +13,10 @@ module CandidApiClient
         # @return [String] The ID used to identify this individual in your system. For example, your
         #  internal patient ID or an EHR patient ID.
         attr_reader :external_id
-        # @return [Date] Box 3 on the CMS-1500 claim form. The date format should be in ISO 8601 date;
-        #  formatted YYYY-MM-DD (i.e. 2012-02-01)
+        # @return [Date] Box 3 on the CMS-1500 claim form or Form Locator 10 on a UB-04 claim form. The
+        #  date format should be in ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)
         attr_reader :date_of_birth
-        # @return [CandidApiClient::Commons::Types::StreetAddressShortZip] Box 5 on the CMS-1500 claim form.
+        # @return [CandidApiClient::Commons::Types::StreetAddressShortZip] Box 5 on the CMS-1500 claim form or Form Locator 9 on a UB-04 claim form.
         attr_reader :address
         # @return [String]
         attr_reader :first_name
@@ -34,9 +34,9 @@ module CandidApiClient
 
         # @param external_id [String] The ID used to identify this individual in your system. For example, your
         #  internal patient ID or an EHR patient ID.
-        # @param date_of_birth [Date] Box 3 on the CMS-1500 claim form. The date format should be in ISO 8601 date;
-        #  formatted YYYY-MM-DD (i.e. 2012-02-01)
-        # @param address [CandidApiClient::Commons::Types::StreetAddressShortZip] Box 5 on the CMS-1500 claim form.
+        # @param date_of_birth [Date] Box 3 on the CMS-1500 claim form or Form Locator 10 on a UB-04 claim form. The
+        #  date format should be in ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)
+        # @param address [CandidApiClient::Commons::Types::StreetAddressShortZip] Box 5 on the CMS-1500 claim form or Form Locator 9 on a UB-04 claim form.
         # @param first_name [String]
         # @param last_name [String]
         # @param gender [CandidApiClient::Individual::Types::Gender]

data/lib/candidhealth/individual/types/patient_create.rb

@@ -27,10 +27,10 @@ module CandidApiClient
         # @return [String] The ID used to identify this individual in your system. For example, your
         #  internal patient ID or an EHR patient ID.
         attr_reader :external_id
-        # @return [Date] Box 3 on the CMS-1500 claim form. The date format should be in ISO 8601 date;
-        #  formatted YYYY-MM-DD (i.e. 2012-02-01)
+        # @return [Date] Box 3 on the CMS-1500 claim form or Form Locator 10 on a UB-04 claim form. The
+        #  date format should be in ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)
         attr_reader :date_of_birth
-        # @return [CandidApiClient::Commons::Types::StreetAddressShortZip] Box 5 on the CMS-1500 claim form.
+        # @return [CandidApiClient::Commons::Types::StreetAddressShortZip] Box 5 on the CMS-1500 claim form or Form Locator 9 on a UB-04 claim form.
         attr_reader :address
         # @return [String]
         attr_reader :first_name
@@ -54,9 +54,9 @@ module CandidApiClient
         # @param email_consent [Boolean] Defaults to false
         # @param external_id [String] The ID used to identify this individual in your system. For example, your
         #  internal patient ID or an EHR patient ID.
-        # @param date_of_birth [Date] Box 3 on the CMS-1500 claim form. The date format should be in ISO 8601 date;
-        #  formatted YYYY-MM-DD (i.e. 2012-02-01)
-        # @param address [CandidApiClient::Commons::Types::StreetAddressShortZip] Box 5 on the CMS-1500 claim form.
+        # @param date_of_birth [Date] Box 3 on the CMS-1500 claim form or Form Locator 10 on a UB-04 claim form. The
+        #  date format should be in ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)
+        # @param address [CandidApiClient::Commons::Types::StreetAddressShortZip] Box 5 on the CMS-1500 claim form or Form Locator 9 on a UB-04 claim form.
         # @param first_name [String]
         # @param last_name [String]
         # @param gender [CandidApiClient::Individual::Types::Gender]

data/lib/candidhealth/individual/types/patient_update.rb

@@ -21,10 +21,10 @@ module CandidApiClient
         # @return [String] The ID used to identify this individual in your system. For example, your
         #  internal patient ID or an EHR patient ID.
         attr_reader :external_id
-        # @return [Date] Box 3 on the CMS-1500 claim form. The date format should be in ISO 8601 date;
-        #  formatted YYYY-MM-DD (i.e. 2012-02-01)
+        # @return [Date] Box 3 on the CMS-1500 claim form or Form Locator 10 on a UB-04 claim form. The
+        #  date format should be in ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)
         attr_reader :date_of_birth
-        # @return [CandidApiClient::Commons::Types::StreetAddressShortZip] Box 5 on the CMS-1500 claim form.
+        # @return [CandidApiClient::Commons::Types::StreetAddressShortZip] Box 5 on the CMS-1500 claim form or Form Locator 9 on a UB-04 claim form.
         attr_reader :address
         # @return [Array<CandidApiClient::Commons::Types::PhoneNumber>]
         attr_reader :phone_numbers
@@ -53,9 +53,9 @@ module CandidApiClient
         # @param gender [CandidApiClient::Individual::Types::Gender]
         # @param external_id [String] The ID used to identify this individual in your system. For example, your
         #  internal patient ID or an EHR patient ID.
-        # @param date_of_birth [Date] Box 3 on the CMS-1500 claim form. The date format should be in ISO 8601 date;
-        #  formatted YYYY-MM-DD (i.e. 2012-02-01)
-        # @param address [CandidApiClient::Commons::Types::StreetAddressShortZip] Box 5 on the CMS-1500 claim form.
+        # @param date_of_birth [Date] Box 3 on the CMS-1500 claim form or Form Locator 10 on a UB-04 claim form. The
+        #  date format should be in ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)
+        # @param address [CandidApiClient::Commons::Types::StreetAddressShortZip] Box 5 on the CMS-1500 claim form or Form Locator 9 on a UB-04 claim form.
         # @param phone_numbers [Array<CandidApiClient::Commons::Types::PhoneNumber>]
         # @param phone_consent [Boolean]
         # @param email [String]

data/lib/candidhealth/individual/types/patient_update_with_optional_address.rb

@@ -21,10 +21,10 @@ module CandidApiClient
         # @return [String] The ID used to identify this individual in your system. For example, your
         #  internal patient ID or an EHR patient ID.
         attr_reader :external_id
-        # @return [Date] Box 3 on the CMS-1500 claim form. The date format should be in ISO 8601 date;
-        #  formatted YYYY-MM-DD (i.e. 2012-02-01)
+        # @return [Date] Box 3 on the CMS-1500 claim form or Form Locator 10 on a UB-04 claim form. The
+        #  date format should be in ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)
         attr_reader :date_of_birth
-        # @return [CandidApiClient::Commons::Types::StreetAddressShortZipOptional] Box 5 on the CMS-1500 claim form.
+        # @return [CandidApiClient::Commons::Types::StreetAddressShortZipOptional] Box 5 on the CMS-1500 claim form or Form Locator 9 on a UB-04 claim form.
         attr_reader :address
         # @return [Array<CandidApiClient::Commons::Types::PhoneNumberOptional>]
         attr_reader :phone_numbers
@@ -53,9 +53,9 @@ module CandidApiClient
         # @param gender [CandidApiClient::Individual::Types::Gender]
         # @param external_id [String] The ID used to identify this individual in your system. For example, your
         #  internal patient ID or an EHR patient ID.
-        # @param date_of_birth [Date] Box 3 on the CMS-1500 claim form. The date format should be in ISO 8601 date;
-        #  formatted YYYY-MM-DD (i.e. 2012-02-01)
-        # @param address [CandidApiClient::Commons::Types::StreetAddressShortZipOptional] Box 5 on the CMS-1500 claim form.
+        # @param date_of_birth [Date] Box 3 on the CMS-1500 claim form or Form Locator 10 on a UB-04 claim form. The
+        #  date format should be in ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)
+        # @param address [CandidApiClient::Commons::Types::StreetAddressShortZipOptional] Box 5 on the CMS-1500 claim form or Form Locator 9 on a UB-04 claim form.
         # @param phone_numbers [Array<CandidApiClient::Commons::Types::PhoneNumberOptional>]
         # @param phone_consent [Boolean]
         # @param email [String]

data/lib/candidhealth/organization_providers/v_2/types/license_type.rb

@@ -104,6 +104,8 @@ module CandidApiClient
           NP_C = "NP-C"
           PA_C = "PA-C"
           AMFT = "AMFT"
+          CDN = "CDN"
+          CNS = "CNS"
         end
       end
     end

data/lib/candidhealth/patient_ar/client.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "v_1/client"
+
+module CandidApiClient
+  module PatientAr
+    class Client
+      # @return [CandidApiClient::PatientAr::V1::V1Client]
+      attr_reader :v_1
+
+      # @param request_client [CandidApiClient::RequestClient]
+      # @return [CandidApiClient::PatientAr::Client]
+      def initialize(request_client:)
+        @v_1 = CandidApiClient::PatientAr::V1::V1Client.new(request_client: request_client)
+      end
+    end
+
+    class AsyncClient
+      # @return [CandidApiClient::PatientAr::V1::AsyncV1Client]
+      attr_reader :v_1
+
+      # @param request_client [CandidApiClient::AsyncRequestClient]
+      # @return [CandidApiClient::PatientAr::AsyncClient]
+      def initialize(request_client:)
+        @v_1 = CandidApiClient::PatientAr::V1::AsyncV1Client.new(request_client: request_client)
+      end
+    end
+  end
+end

data/lib/candidhealth/patient_ar/v_1/client.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require "date"
+require_relative "types/list_inventory_paged_response"
+require_relative "types/invoice_itemization_response"
+require "async"
+
+module CandidApiClient
+  module PatientAr
+    module V1
+      class V1Client
+        # @return [CandidApiClient::RequestClient]
+        attr_reader :request_client
+
+        # @param request_client [CandidApiClient::RequestClient]
+        # @return [CandidApiClient::PatientAr::V1::V1Client]
+        def initialize(request_client:)
+          @request_client = request_client
+        end
+
+        # NOTE: This service is in-development and can only be used by select partners.
+        #  Please contact Candid Health to request access.
+        #  Retrieve a list of inventory records based on the provided filters. Each
+        #  inventory record provides the latest invoiceable status of the associated claim.
+        #  The response is paginated, and the `page_token` can be used to retrieve
+        #  subsequent pages. Initial requests should not include `page_token`.
+        #
+        # @param since [DateTime] Timestamp to filter records since, inclusive
+        # @param limit [Integer] Maximum number of records to return, default is 100
+        # @param page_token [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientAr::V1::Types::ListInventoryPagedResponse]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_ar.v_1.list_inventory
+        def list_inventory(since: nil, limit: nil, page_token: nil, request_options: nil)
+          response = @request_client.conn.get 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?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "since": since,
+              "limit": limit,
+              "page_token": page_token
+            }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/patient-ar/v1/inventory"
+          end
+          CandidApiClient::PatientAr::V1::Types::ListInventoryPagedResponse.from_json(json_object: response.body)
+        end
+
+        # NOTE: This service is in-development and can only be used by select partners.
+        #  Please contact Candid Health to request access.
+        #  Provides detailed itemization of invoice data for a specific claim.
+        #
+        # @param claim_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientAr::V1::Types::InvoiceItemizationResponse]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_ar.v_1.itemize(claim_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def itemize(claim_id:, request_options: nil)
+          response = @request_client.conn.get 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?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/patient-ar/v1/invoice-itemization/#{claim_id}"
+          end
+          CandidApiClient::PatientAr::V1::Types::InvoiceItemizationResponse.from_json(json_object: response.body)
+        end
+      end
+
+      class AsyncV1Client
+        # @return [CandidApiClient::AsyncRequestClient]
+        attr_reader :request_client
+
+        # @param request_client [CandidApiClient::AsyncRequestClient]
+        # @return [CandidApiClient::PatientAr::V1::AsyncV1Client]
+        def initialize(request_client:)
+          @request_client = request_client
+        end
+
+        # NOTE: This service is in-development and can only be used by select partners.
+        #  Please contact Candid Health to request access.
+        #  Retrieve a list of inventory records based on the provided filters. Each
+        #  inventory record provides the latest invoiceable status of the associated claim.
+        #  The response is paginated, and the `page_token` can be used to retrieve
+        #  subsequent pages. Initial requests should not include `page_token`.
+        #
+        # @param since [DateTime] Timestamp to filter records since, inclusive
+        # @param limit [Integer] Maximum number of records to return, default is 100
+        # @param page_token [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientAr::V1::Types::ListInventoryPagedResponse]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_ar.v_1.list_inventory
+        def list_inventory(since: nil, limit: nil, page_token: nil, request_options: nil)
+          Async do
+            response = @request_client.conn.get 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?
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
+              req.params = {
+                **(request_options&.additional_query_parameters || {}),
+                "since": since,
+                "limit": limit,
+                "page_token": page_token
+              }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/patient-ar/v1/inventory"
+            end
+            CandidApiClient::PatientAr::V1::Types::ListInventoryPagedResponse.from_json(json_object: response.body)
+          end
+        end
+
+        # NOTE: This service is in-development and can only be used by select partners.
+        #  Please contact Candid Health to request access.
+        #  Provides detailed itemization of invoice data for a specific claim.
+        #
+        # @param claim_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientAr::V1::Types::InvoiceItemizationResponse]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_ar.v_1.itemize(claim_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def itemize(claim_id:, request_options: nil)
+          Async do
+            response = @request_client.conn.get 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?
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/patient-ar/v1/invoice-itemization/#{claim_id}"
+            end
+            CandidApiClient::PatientAr::V1::Types::InvoiceItemizationResponse.from_json(json_object: response.body)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/patient_ar/v_1/types/insurance_adjustment_info.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module PatientAr
+    module V1
+      module Types
+        class InsuranceAdjustmentInfo
+          # @return [Integer] The total amount of insurance adjustments in cents for the service line.
+          attr_reader :total_adjustment_cents
+          # @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 total_adjustment_cents [Integer] The total amount of insurance adjustments in cents for the service line.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::PatientAr::V1::Types::InsuranceAdjustmentInfo]
+          def initialize(total_adjustment_cents:, additional_properties: nil)
+            @total_adjustment_cents = total_adjustment_cents
+            @additional_properties = additional_properties
+            @_field_set = { "total_adjustment_cents": total_adjustment_cents }
+          end
+
+          # Deserialize a JSON object to an instance of InsuranceAdjustmentInfo
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::PatientAr::V1::Types::InsuranceAdjustmentInfo]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            total_adjustment_cents = struct["total_adjustment_cents"]
+            new(total_adjustment_cents: total_adjustment_cents, additional_properties: struct)
+          end
+
+          # Serialize an instance of InsuranceAdjustmentInfo 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.total_adjustment_cents.is_a?(Integer) != false || raise("Passed value for field obj.total_adjustment_cents is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/patient_ar/v_1/types/insurance_payment_info.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module PatientAr
+    module V1
+      module Types
+        class InsurancePaymentInfo
+          # @return [Integer] The total amount of insurance payments in cents for the service line.
+          attr_reader :total_payment_cents
+          # @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 total_payment_cents [Integer] The total amount of insurance payments in cents for the service line.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::PatientAr::V1::Types::InsurancePaymentInfo]
+          def initialize(total_payment_cents:, additional_properties: nil)
+            @total_payment_cents = total_payment_cents
+            @additional_properties = additional_properties
+            @_field_set = { "total_payment_cents": total_payment_cents }
+          end
+
+          # Deserialize a JSON object to an instance of InsurancePaymentInfo
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::PatientAr::V1::Types::InsurancePaymentInfo]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            total_payment_cents = struct["total_payment_cents"]
+            new(total_payment_cents: total_payment_cents, additional_properties: struct)
+          end
+
+          # Serialize an instance of InsurancePaymentInfo 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.total_payment_cents.is_a?(Integer) != false || raise("Passed value for field obj.total_payment_cents is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/patient_ar/v_1/types/invalid_filters_error_type.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module PatientAr
+    module V1
+      module Types
+        class InvalidFiltersErrorType
+          # @return [String]
+          attr_reader :message
+          # @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 message [String]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::PatientAr::V1::Types::InvalidFiltersErrorType]
+          def initialize(message:, additional_properties: nil)
+            @message = message
+            @additional_properties = additional_properties
+            @_field_set = { "message": message }
+          end
+
+          # Deserialize a JSON object to an instance of InvalidFiltersErrorType
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::PatientAr::V1::Types::InvalidFiltersErrorType]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            message = struct["message"]
+            new(message: message, additional_properties: struct)
+          end
+
+          # Serialize an instance of InvalidFiltersErrorType 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.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/patient_ar/v_1/types/inventory_record.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "date"
+require_relative "patient_ar_status"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module PatientAr
+    module V1
+      module Types
+        class InventoryRecord
+          # @return [String]
+          attr_reader :claim_id
+          # @return [String]
+          attr_reader :encounter_id
+          # @return [DateTime]
+          attr_reader :timestamp
+          # @return [String]
+          attr_reader :patient_external_id
+          # @return [CandidApiClient::PatientAr::V1::Types::PatientArStatus]
+          attr_reader :patient_ar_status
+          # @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 claim_id [String]
+          # @param encounter_id [String]
+          # @param timestamp [DateTime]
+          # @param patient_external_id [String]
+          # @param patient_ar_status [CandidApiClient::PatientAr::V1::Types::PatientArStatus]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::PatientAr::V1::Types::InventoryRecord]
+          def initialize(claim_id:, encounter_id:, timestamp:, patient_external_id:, patient_ar_status:,
+                         additional_properties: nil)
+            @claim_id = claim_id
+            @encounter_id = encounter_id
+            @timestamp = timestamp
+            @patient_external_id = patient_external_id
+            @patient_ar_status = patient_ar_status
+            @additional_properties = additional_properties
+            @_field_set = {
+              "claim_id": claim_id,
+              "encounter_id": encounter_id,
+              "timestamp": timestamp,
+              "patient_external_id": patient_external_id,
+              "patient_ar_status": patient_ar_status
+            }
+          end
+
+          # Deserialize a JSON object to an instance of InventoryRecord
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::PatientAr::V1::Types::InventoryRecord]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            claim_id = struct["claim_id"]
+            encounter_id = struct["encounter_id"]
+            timestamp = (DateTime.parse(parsed_json["timestamp"]) unless parsed_json["timestamp"].nil?)
+            patient_external_id = struct["patient_external_id"]
+            patient_ar_status = struct["patient_ar_status"]
+            new(
+              claim_id: claim_id,
+              encounter_id: encounter_id,
+              timestamp: timestamp,
+              patient_external_id: patient_external_id,
+              patient_ar_status: patient_ar_status,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of InventoryRecord 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.claim_id.is_a?(String) != false || raise("Passed value for field obj.claim_id is not the expected type, validation failed.")
+            obj.encounter_id.is_a?(String) != false || raise("Passed value for field obj.encounter_id is not the expected type, validation failed.")
+            obj.timestamp.is_a?(DateTime) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
+            obj.patient_external_id.is_a?(String) != false || raise("Passed value for field obj.patient_external_id is not the expected type, validation failed.")
+            obj.patient_ar_status.is_a?(CandidApiClient::PatientAr::V1::Types::PatientArStatus) != false || raise("Passed value for field obj.patient_ar_status is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end