candidhealth 1.17.4 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c907e57fe09a7b163e6d44585d2a69376f204983c85d43dd26220149a6694d0f
-  data.tar.gz: 58cd71bf71c30d23255b0d81e41a2fe8c5a35d53679e4c8223887a960bcbc37a
+  metadata.gz: c65cdab7bf3ed118a5ea843e9cd50f42e958a4cf5882be39c2ba16e2ab7ffba8
+  data.tar.gz: 11a091b5008bcf3de805e8dad61170ff7f78c688382d2f14e683ace94502f32e
 SHA512:
-  metadata.gz: 2fe6caaa6612e74c1a87a0e258e38e156f3b9ae297def9cde43e31adaee5a96ab6cccf331029cee82fda77be2995ea447e8f57d65f587b056299d636d380660e
-  data.tar.gz: cf1b2956b8919f0adc773ace5820d11453924fa54af5c1d3a4fbcf81948a913ab641f66ef4a976d3487e5370e983cdef59f74cdf7703e97279947712dcfa7629
+  metadata.gz: d364c2e8241d2fee088c4857c7cab3cea9af3a37243091eeb5b0f089827c539cfd3d93d6359c3400b5a4ae62795ead95df4b3b93c340e97b7936d5ccb1b1a45f
+  data.tar.gz: cd4d71f9ea67cced4413891d6e90b16cc6d6102cc6a0ad46fc9a44df5d048eba7f1bb4629402dc484dcf5a60975392506bb88f2f9513d2555e4571e3330346c1

data/lib/candid/client.rb

@@ -7,7 +7,7 @@ module Candid
       @raw_client = Candid::Internal::Http::RawClient.new(
         base_url: base_url,
         headers: {
-          "User-Agent": "candidhealth/1.17.4",
+          "User-Agent": "candidhealth/1.18.0",
           "X-Fern-Language": "Ruby"
         }
       )

data/lib/candid/commons/types/emr_payer_crosswalk.rb

@@ -8,6 +8,7 @@ module Candid
 
         HEALTHIE = "HEALTHIE"
         CANVAS = "CANVAS"
+        HL_7_WEBPT_E_34_EPIC = "HL7_WEBPT_E34_EPIC"
       end
     end
   end

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

@@ -13,7 +13,7 @@ module Candid
         def get_all(request_options: {}, **params)
           params = Candid::Internal::Types::Utils.symbolize_keys(params)
           _query_param_names = %i[limit claim_status sort page_token date_of_service_min date_of_service_max
-                                  primary_payer_names search_term external_id diagnoses_updated_since tag_ids work_queue_id billable_status responsible_party owner_of_next_action patient_external_id]
+                                  primary_payer_names search_term external_id diagnoses_updated_since tag_ids work_queue_id billable_status responsible_party owner_of_next_action patient_external_id include_merged_patient_data]
           _query = params.slice(*_query_param_names)
           params.except(*_query_param_names)
 

data/lib/candid/encounters/v_4/types/get_all_encounters_request.rb

@@ -27,6 +27,7 @@ module Candid
             Candid::Encounters::V4::Types::EncounterOwnerOfNextActionType
           }, optional: true, nullable: false
           field :patient_external_id, -> { String }, optional: true, nullable: false
+          field :include_merged_patient_data, -> { Internal::Types::Boolean }, optional: true, nullable: false
         end
       end
     end

data/lib/candid/pre_encounter/appointments/v_1/client.rb

@@ -36,6 +36,17 @@ module Candid
 
           # Gets all Visits within a given time range. The return list is ordered by start_time ascending.
           #
+          # **IMPORTANT:** This endpoint requires a date filter on `appointment.startTimestamp` to ensure acceptable query performance.
+          # Without date filtering, the query can take 50+ seconds on large datasets due to grouping and aggregation operations.
+          #
+          # Example filters:
+          # - `appointment.startTimestamp|gt|2024-01-01` - appointments after January 1, 2024
+          # - `appointment.startTimestamp|eq|2024-12-08` - appointments on December 8, 2024
+          # - `appointment.startTimestamp|lt|2024-12-31` - appointments before December 31, 2024
+          #
+          # You can combine the date filter with other filters using commas:
+          # - `appointment.startTimestamp|gt|2024-01-01,appointment.status|eq|PENDING`
+          #
           # @return [Candid::PreEncounter::Appointments::V1::Types::VisitsPage]
           def get_visits(request_options: {}, **params)
             params = Candid::Internal::Types::Utils.symbolize_keys(params)

data/lib/candid/pre_encounter/appointments/v_1/types/visit.rb

@@ -18,6 +18,9 @@ module Candid
             field :primary_coverage_status, lambda {
               Candid::PreEncounter::Coverages::V1::Types::CoverageStatus
             }, optional: true, nullable: false
+            field :secondary_coverage_status, lambda {
+              Candid::PreEncounter::Coverages::V1::Types::CoverageStatus
+            }, optional: true, nullable: false
           end
         end
       end

data/lib/candid/pre_encounter/coverages/v_1/client.rb

@@ -110,14 +110,21 @@ module Candid
             end
           end
 
-          # Gets a coverage along with it's full history.  The return list is ordered by version ascending.
+          # Gets a coverage's history. Full history is returned if no filters are
+          # defined. The return list is ordered by version, defaulting to ascending.
           #
           # @return [Array[Candid::PreEncounter::Coverages::V1::Types::Coverage]]
           def get_history(request_options: {}, **params)
+            params = Candid::Internal::Types::Utils.symbolize_keys(params)
+            _query_param_names = %i[start end non_auto_updated_coverages_only sort_direction limit]
+            _query = params.slice(*_query_param_names)
+            params = params.except(*_query_param_names)
+
             _request = Candid::Internal::JSON::Request.new(
               base_url: request_options[:base_url] || Candid::Environment::PRODUCTION,
               method: "GET",
-              path: "/coverages/v1/#{params[:id]}/history"
+              path: "/coverages/v1/#{params[:id]}/history",
+              query: _query
             )
             begin
               _response = @client.send(_request)

data/lib/candid/pre_encounter/coverages/v_1/types/coverage_benefits.rb

@@ -16,6 +16,7 @@ module Candid
               Internal::Types::Array[Candid::PreEncounter::Coverages::V1::Types::BenefitsRelatedEntity]
             }, optional: true, nullable: false
             field :notes, -> { String }, optional: true, nullable: false
+            field :auto_updated_eligibility_check_id, -> { String }, optional: true, nullable: false
           end
         end
       end

data/lib/candid/pre_encounter/coverages/v_1/types/coverages_get_history_request.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Candid
+  module PreEncounter
+    module Coverages
+      module V1
+        module Types
+          class CoveragesGetHistoryRequest < Internal::Types::Model
+            field :id, -> { String }, optional: false, nullable: false
+            field :start, -> { String }, optional: true, nullable: false
+            field :end_, -> { String }, optional: true, nullable: false
+            field :non_auto_updated_coverages_only, -> { Internal::Types::Boolean }, optional: true, nullable: false
+            field :sort_direction, lambda {
+              Candid::PreEncounter::Common::Types::SortDirection
+            }, optional: true, nullable: false
+            field :limit, -> { Integer }, optional: true, nullable: false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candid/pre_encounter/coverages/v_1/types/mutable_coverage.rb

@@ -30,6 +30,7 @@ module Candid
               Candid::PreEncounter::Coverages::V1::Types::CoverageBenefits
             }, optional: true, nullable: false
             field :orcon, -> { Internal::Types::Boolean }, optional: true, nullable: false
+            field :auto_update_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
           end
         end
       end

data/lib/candid/pre_encounter/lists/v_1/client.rb

@@ -15,7 +15,7 @@ module Candid
           # @return [Candid::PreEncounter::Lists::V1::Types::PatientListPage]
           def get_patient_list(request_options: {}, **params)
             params = Candid::Internal::Types::Utils.symbolize_keys(params)
-            _query_param_names = %i[page_token limit sort_field sort_direction filters]
+            _query_param_names = %i[page_token limit sort_field sort_direction filters include_deactivated]
             _query = params.slice(*_query_param_names)
             params.except(*_query_param_names)
 
@@ -44,7 +44,7 @@ module Candid
           # @return [Candid::PreEncounter::Lists::V1::Types::AppointmentListPage]
           def get_appointment_list(request_options: {}, **params)
             params = Candid::Internal::Types::Utils.symbolize_keys(params)
-            _query_param_names = %i[sort_field sort_direction limit page_token filters]
+            _query_param_names = %i[sort_field sort_direction limit page_token filters include_deactivated]
             _query = params.slice(*_query_param_names)
             params.except(*_query_param_names)
 

data/lib/candid/pre_encounter/lists/v_1/types/appointment_list_item.rb

@@ -15,6 +15,9 @@ module Candid
             field :primary_coverage, lambda {
               Candid::PreEncounter::Coverages::V1::Types::MutableCoverage
             }, optional: true, nullable: false
+            field :secondary_coverage, lambda {
+              Candid::PreEncounter::Coverages::V1::Types::MutableCoverage
+            }, optional: true, nullable: false
             field :primary_service_type, lambda {
               Candid::PreEncounter::Appointments::V1::Types::UniversalServiceIdentifier
             }, optional: true, nullable: false

data/lib/candid/pre_encounter/lists/v_1/types/appointments_get_list_request.rb

@@ -13,6 +13,7 @@ module Candid
             field :limit, -> { Integer }, optional: true, nullable: false
             field :page_token, -> { String }, optional: true, nullable: false
             field :filters, -> { String }, optional: true, nullable: false
+            field :include_deactivated, -> { Internal::Types::Boolean }, optional: true, nullable: false
           end
         end
       end

data/lib/candid/pre_encounter/lists/v_1/types/patient_list_item.rb

@@ -19,6 +19,8 @@ module Candid
             field :next_appointment, lambda {
               Candid::PreEncounter::Appointments::V1::Types::MutableAppointment
             }, optional: true, nullable: false
+            field :primary_mrn, -> { String }, optional: true, nullable: false
+            field :alternative_mrns, -> { Internal::Types::Array[String] }, optional: false, nullable: false
           end
         end
       end

data/lib/candid/pre_encounter/lists/v_1/types/patient_list_request.rb

@@ -13,6 +13,7 @@ module Candid
               Candid::PreEncounter::Common::Types::SortDirection
             }, optional: true, nullable: false
             field :filters, -> { String }, optional: true, nullable: false
+            field :include_deactivated, -> { Internal::Types::Boolean }, optional: true, nullable: false
           end
         end
       end

data/lib/candid/pre_encounter/patients/v_1/client.rb

@@ -193,6 +193,35 @@ module Candid
             raise error_class.new(_response.body, code: code)
           end
 
+          # Gets a patient along with their coverages at a specific point in time. Note that the date passed in is only used to determine what the filing order was for that patient during that time. The actual data returned will always be the latest version of the patient and coverages.
+          #
+          # @return [Candid::PreEncounter::Patients::V1::Types::PatientCoverageSnapshot]
+          def get_coverage_snapshot(request_options: {}, **params)
+            params = Candid::Internal::Types::Utils.symbolize_keys(params)
+            _query_param_names = %i[date]
+            _query = params.slice(*_query_param_names)
+            params = params.except(*_query_param_names)
+
+            _request = Candid::Internal::JSON::Request.new(
+              base_url: request_options[:base_url] || Candid::Environment::PRODUCTION,
+              method: "GET",
+              path: "/patients/v1/#{params[:id]}/snapshot",
+              query: _query
+            )
+            begin
+              _response = @client.send(_request)
+            rescue Net::HTTPRequestTimeout
+              raise Candid::Errors::TimeoutError
+            end
+            code = _response.code.to_i
+            if code.between?(200, 299)
+              Candid::PreEncounter::Patients::V1::Types::PatientCoverageSnapshot.load(_response.body)
+            else
+              error_class = Candid::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(_response.body, code: code)
+            end
+          end
+
           # Updates a patient. The path must contain the next version number to prevent race conditions. For example, if the current version of the patient is n, you will need to send a request to this endpoint with `/{id}/n+1` to update the patient. Updating historic versions is not supported.
           #
           # @return [Candid::PreEncounter::Patients::V1::Types::Patient]

data/lib/candid/pre_encounter/patients/v_1/types/get_coverage_snapshot_request.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Candid
+  module PreEncounter
+    module Patients
+      module V1
+        module Types
+          class GetCoverageSnapshotRequest < Internal::Types::Model
+            field :id, -> { String }, optional: false, nullable: false
+            field :date, -> { String }, optional: true, nullable: false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candid/pre_encounter/patients/v_1/types/patient_coverage_snapshot.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Candid
+  module PreEncounter
+    module Patients
+      module V1
+        module Types
+          class PatientCoverageSnapshot < Internal::Types::Model
+            field :patient, -> { Candid::PreEncounter::Patients::V1::Types::Patient }, optional: false, nullable: false
+            field :primary_coverage, lambda {
+              Candid::PreEncounter::Coverages::V1::Types::Coverage
+            }, optional: true, nullable: false
+            field :secondary_coverage, lambda {
+              Candid::PreEncounter::Coverages::V1::Types::Coverage
+            }, optional: true, nullable: false
+            field :tertiary_coverage, lambda {
+              Candid::PreEncounter::Coverages::V1::Types::Coverage
+            }, optional: true, nullable: false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Candid
-  VERSION = "1.17.4"
+  VERSION = "1.18.0"
 end

data/lib/candid.rb

@@ -700,6 +700,7 @@ require_relative "candid/pre_encounter/lists/v_1/types/appointment_list_item"
 require_relative "candid/pre_encounter/lists/v_1/types/appointment_list_page"
 require_relative "candid/pre_encounter/notes/v_1/types/mutable_note"
 require_relative "candid/pre_encounter/notes/v_1/types/note"
+require_relative "candid/pre_encounter/patients/v_1/types/patient_coverage_snapshot"
 require_relative "candid/pre_encounter/patients/v_1/types/patient_page"
 require_relative "candid/pre_encounter/tags/v_1/types/mutable_tag"
 require_relative "candid/pre_encounter/tags/v_1/types/tag"
@@ -866,6 +867,7 @@ require_relative "candid/pre_encounter/appointments/v_1/types/appointment_scan_r
 require_relative "candid/pre_encounter/coverages/client"
 require_relative "candid/pre_encounter/coverages/v_1/client"
 require_relative "candid/pre_encounter/coverages/v_1/types/coverage_get_multi_paginated_request"
+require_relative "candid/pre_encounter/coverages/v_1/types/coverages_get_history_request"
 require_relative "candid/pre_encounter/coverages/v_1/types/coverage_get_multi_request"
 require_relative "candid/pre_encounter/coverages/v_1/types/coverage_scan_request"
 require_relative "candid/pre_encounter/coverages/v_1/types/check_eligibility_request"
@@ -889,6 +891,7 @@ require_relative "candid/pre_encounter/patients/v_1/types/create_patient_request
 require_relative "candid/pre_encounter/patients/v_1/types/create_patient_with_mrn_request"
 require_relative "candid/pre_encounter/patients/v_1/types/patients_search_request_paginated"
 require_relative "candid/pre_encounter/patients/v_1/types/search_providers_request"
+require_relative "candid/pre_encounter/patients/v_1/types/get_coverage_snapshot_request"
 require_relative "candid/pre_encounter/patients/v_1/types/patient_get_multi_request"
 require_relative "candid/pre_encounter/patients/v_1/types/patient_scan_request"
 require_relative "candid/pre_encounter/tags/client"

data/reference.md

@@ -4379,6 +4379,14 @@ or encounter external id.
 
 **patient_external_id:** `String` — The patient ID from the external EMR platform for the patient
     
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**include_merged_patient_data:** `Internal::Types::Boolean` — If true and patient_external_id is set, then also include the encounters of all alternative patients.
+    
 </dd>
 </dl>
 </dd>
@@ -11390,6 +11398,17 @@ client.pre_encounter.appointments.v_1.create({
 <dd>
 
 Gets all Visits within a given time range. The return list is ordered by start_time ascending.
+
+**IMPORTANT:** This endpoint requires a date filter on `appointment.startTimestamp` to ensure acceptable query performance.
+Without date filtering, the query can take 50+ seconds on large datasets due to grouping and aggregation operations.
+
+Example filters:
+- `appointment.startTimestamp|gt|2024-01-01` - appointments after January 1, 2024
+- `appointment.startTimestamp|eq|2024-12-08` - appointments on December 8, 2024
+- `appointment.startTimestamp|lt|2024-12-31` - appointments before December 31, 2024
+
+You can combine the date filter with other filters using commas:
+- `appointment.startTimestamp|gt|2024-01-01,appointment.status|eq|PENDING`
 </dd>
 </dl>
 </dd>
@@ -11452,6 +11471,9 @@ client.pre_encounter.appointments.v_1.get_visits();
 <dd>
 
 **filters:** `String` 
+
+**Required:** Must include a date filter on appointment.startTimestamp (using gt, lt, or eq operators).
+Example: appointment.startTimestamp|gt|2024-01-01
     
 </dd>
 </dl>
@@ -12059,7 +12081,8 @@ client.pre_encounter.coverages.v_1.get();
 <dl>
 <dd>
 
-Gets a coverage along with it's full history.  The return list is ordered by version ascending.
+Gets a coverage's history. Full history is returned if no filters are 
+defined. The return list is ordered by version, defaulting to ascending.
 </dd>
 </dl>
 </dd>
@@ -12074,7 +12097,7 @@ Gets a coverage along with it's full history.  The return list is ordered by ver
 <dd>
 
 ```ruby
-client.pre_encounter.coverages.v_1.get_history();
+client.pre_encounter.coverages.v_1.get_history(id: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32');
 ```
 </dd>
 </dl>
@@ -12091,6 +12114,46 @@ client.pre_encounter.coverages.v_1.get_history();
 
 **id:** `String` 
     
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**start:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**end_:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**non_auto_updated_coverages_only:** `Internal::Types::Boolean` — If true, only returns coverages that have NOT been auto-updated by the system.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**sort_direction:** `Candid::PreEncounter::Common::Types::SortDirection` — Defaults to ascending. Sorts by version.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**limit:** `Integer` — Must be between 0 and 1000. No default.
+    
 </dd>
 </dl>
 </dd>
@@ -13179,6 +13242,14 @@ client.pre_encounter.lists.v_1.get_patient_list();
 
 **filters:** `String` 
     
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**include_deactivated:** `Internal::Types::Boolean` — If true, includes deactivated patients in the results. Defaults to false.
+    
 </dd>
 </dl>
 </dd>
@@ -13265,6 +13336,14 @@ client.pre_encounter.lists.v_1.get_appointment_list();
 
 **filters:** `String` 
     
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**include_deactivated:** `Internal::Types::Boolean` — If true, includes deactivated appointments in the results. Defaults to false.
+    
 </dd>
 </dl>
 </dd>
@@ -13943,6 +14022,68 @@ client.pre_encounter.patients.v_1.get_history();
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.pre_encounter.patients.v_1.get_coverage_snapshot(id) -> Candid::PreEncounter::Patients::V1::Types::PatientCoverageSnapshot</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Gets a patient along with their coverages at a specific point in time. Note that the date passed in is only used to determine what the filing order was for that patient during that time. The actual data returned will always be the latest version of the patient and coverages.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.pre_encounter.patients.v_1.get_coverage_snapshot(id: 'id');
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**date:** `String` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: candidhealth
 version: !ruby/object:Gem::Version
-  version: 1.17.4
+  version: 1.18.0
 platform: ruby
 authors:
 - Candid
@@ -711,6 +711,7 @@ files:
 - lib/candid/pre_encounter/coverages/v_1/types/coverage_status.rb
 - lib/candid/pre_encounter/coverages/v_1/types/coverage_value.rb
 - lib/candid/pre_encounter/coverages/v_1/types/coverage_value_unit.rb
+- lib/candid/pre_encounter/coverages/v_1/types/coverages_get_history_request.rb
 - lib/candid/pre_encounter/coverages/v_1/types/coverages_page.rb
 - lib/candid/pre_encounter/coverages/v_1/types/expanded_member_info.rb
 - lib/candid/pre_encounter/coverages/v_1/types/insurance_plan.rb
@@ -790,6 +791,7 @@ files:
 - lib/candid/pre_encounter/patients/v_1/types/do_not_invoice_reason.rb
 - lib/candid/pre_encounter/patients/v_1/types/external_provenance.rb
 - lib/candid/pre_encounter/patients/v_1/types/filing_order.rb
+- lib/candid/pre_encounter/patients/v_1/types/get_coverage_snapshot_request.rb
 - lib/candid/pre_encounter/patients/v_1/types/guarantor.rb
 - lib/candid/pre_encounter/patients/v_1/types/inferred_patient_metadata.rb
 - lib/candid/pre_encounter/patients/v_1/types/marital_status.rb
@@ -797,6 +799,7 @@ files:
 - lib/candid/pre_encounter/patients/v_1/types/mutable_patient_with_mrn.rb
 - lib/candid/pre_encounter/patients/v_1/types/origination_detail.rb
 - lib/candid/pre_encounter/patients/v_1/types/patient.rb
+- lib/candid/pre_encounter/patients/v_1/types/patient_coverage_snapshot.rb
 - lib/candid/pre_encounter/patients/v_1/types/patient_get_multi_request.rb
 - lib/candid/pre_encounter/patients/v_1/types/patient_page.rb
 - lib/candid/pre_encounter/patients/v_1/types/patient_scan_request.rb