candidhealth 1.17.3 → 1.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/candid/client.rb +1 -1
- data/lib/candid/commons/types/emr_payer_crosswalk.rb +1 -0
- data/lib/candid/encounters/v_4/client.rb +1 -1
- data/lib/candid/encounters/v_4/types/get_all_encounters_request.rb +1 -0
- data/lib/candid/financials/types/allocation.rb +1 -0
- data/lib/candid/financials/types/allocation_earmark_type.rb +2 -2
- data/lib/candid/financials/types/balance_earmark.rb +15 -0
- data/lib/candid/pre_encounter/appointments/v_1/client.rb +11 -0
- data/lib/candid/pre_encounter/appointments/v_1/types/visit.rb +3 -0
- data/lib/candid/pre_encounter/coverages/v_1/client.rb +9 -2
- data/lib/candid/pre_encounter/coverages/v_1/types/coverage_benefits.rb +1 -0
- data/lib/candid/pre_encounter/coverages/v_1/types/coverages_get_history_request.rb +22 -0
- data/lib/candid/pre_encounter/coverages/v_1/types/mutable_coverage.rb +1 -0
- data/lib/candid/pre_encounter/lists/v_1/client.rb +2 -2
- data/lib/candid/pre_encounter/lists/v_1/types/appointment_list_item.rb +3 -0
- data/lib/candid/pre_encounter/lists/v_1/types/appointments_get_list_request.rb +1 -0
- data/lib/candid/pre_encounter/lists/v_1/types/patient_list_item.rb +2 -0
- data/lib/candid/pre_encounter/lists/v_1/types/patient_list_request.rb +1 -0
- data/lib/candid/pre_encounter/patients/v_1/client.rb +29 -0
- data/lib/candid/pre_encounter/patients/v_1/types/get_coverage_snapshot_request.rb +16 -0
- data/lib/candid/pre_encounter/patients/v_1/types/patient_coverage_snapshot.rb +24 -0
- data/lib/candid/version.rb +1 -1
- data/lib/candid.rb +5 -1
- data/reference.md +143 -2
- metadata +5 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c65cdab7bf3ed118a5ea843e9cd50f42e958a4cf5882be39c2ba16e2ab7ffba8
|
|
4
|
+
data.tar.gz: 11a091b5008bcf3de805e8dad61170ff7f78c688382d2f14e683ace94502f32e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d364c2e8241d2fee088c4857c7cab3cea9af3a37243091eeb5b0f089827c539cfd3d93d6359c3400b5a4ae62795ead95df4b3b93c340e97b7936d5ccb1b1a45f
|
|
7
|
+
data.tar.gz: cd4d71f9ea67cced4413891d6e90b16cc6d6102cc6a0ad46fc9a44df5d048eba7f1bb4629402dc484dcf5a60975392506bb88f2f9513d2555e4571e3330346c1
|
data/lib/candid/client.rb
CHANGED
|
@@ -13,7 +13,7 @@ module Candid
|
|
|
13
13
|
def get_all(request_options: {}, **params)
|
|
14
14
|
params = Candid::Internal::Types::Utils.symbolize_keys(params)
|
|
15
15
|
_query_param_names = %i[limit claim_status sort page_token date_of_service_min date_of_service_max
|
|
16
|
-
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]
|
|
16
|
+
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]
|
|
17
17
|
_query = params.slice(*_query_param_names)
|
|
18
18
|
params.except(*_query_param_names)
|
|
19
19
|
|
|
@@ -27,6 +27,7 @@ module Candid
|
|
|
27
27
|
Candid::Encounters::V4::Types::EncounterOwnerOfNextActionType
|
|
28
28
|
}, optional: true, nullable: false
|
|
29
29
|
field :patient_external_id, -> { String }, optional: true, nullable: false
|
|
30
|
+
field :include_merged_patient_data, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
30
31
|
end
|
|
31
32
|
end
|
|
32
33
|
end
|
|
@@ -6,6 +6,7 @@ module Candid
|
|
|
6
6
|
class Allocation < Internal::Types::Model
|
|
7
7
|
field :amount_cents, -> { Integer }, optional: false, nullable: false
|
|
8
8
|
field :target, -> { Candid::Financials::Types::AllocationTarget }, optional: false, nullable: false
|
|
9
|
+
field :earmark, -> { Candid::Financials::Types::BalanceEarmark }, optional: true, nullable: false
|
|
9
10
|
end
|
|
10
11
|
end
|
|
11
12
|
end
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
module Candid
|
|
4
4
|
module Financials
|
|
5
5
|
module Types
|
|
6
|
-
#
|
|
7
|
-
#
|
|
6
|
+
# If enabled for your organization, defines how a patient prepayment allocation should be earmarked for future auto-allocation.
|
|
7
|
+
# Earmarks hold the allocation until a matching encounter is created, then attempt to allocate to that encounter.
|
|
8
8
|
# Only applicable for unattributed allocations.
|
|
9
9
|
class AllocationEarmarkType < Internal::Types::Model
|
|
10
10
|
extend Candid::Internal::Types::Union
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Candid
|
|
4
|
+
module Financials
|
|
5
|
+
module Types
|
|
6
|
+
# Represents an active balance earmarking record that holds allocated funds for future auto-allocation.
|
|
7
|
+
# Earmarks are created when funds are allocated but should be held for a specific encounter or date of service.
|
|
8
|
+
# Only active (non-deleted) earmarks are returned.
|
|
9
|
+
class BalanceEarmark < Internal::Types::Model
|
|
10
|
+
field :id, -> { String }, optional: false, nullable: false
|
|
11
|
+
field :target, -> { Candid::Financials::Types::AllocationEarmarkType }, optional: false, nullable: false
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
@@ -36,6 +36,17 @@ module Candid
|
|
|
36
36
|
|
|
37
37
|
# Gets all Visits within a given time range. The return list is ordered by start_time ascending.
|
|
38
38
|
#
|
|
39
|
+
# **IMPORTANT:** This endpoint requires a date filter on `appointment.startTimestamp` to ensure acceptable query performance.
|
|
40
|
+
# Without date filtering, the query can take 50+ seconds on large datasets due to grouping and aggregation operations.
|
|
41
|
+
#
|
|
42
|
+
# Example filters:
|
|
43
|
+
# - `appointment.startTimestamp|gt|2024-01-01` - appointments after January 1, 2024
|
|
44
|
+
# - `appointment.startTimestamp|eq|2024-12-08` - appointments on December 8, 2024
|
|
45
|
+
# - `appointment.startTimestamp|lt|2024-12-31` - appointments before December 31, 2024
|
|
46
|
+
#
|
|
47
|
+
# You can combine the date filter with other filters using commas:
|
|
48
|
+
# - `appointment.startTimestamp|gt|2024-01-01,appointment.status|eq|PENDING`
|
|
49
|
+
#
|
|
39
50
|
# @return [Candid::PreEncounter::Appointments::V1::Types::VisitsPage]
|
|
40
51
|
def get_visits(request_options: {}, **params)
|
|
41
52
|
params = Candid::Internal::Types::Utils.symbolize_keys(params)
|
|
@@ -18,6 +18,9 @@ module Candid
|
|
|
18
18
|
field :primary_coverage_status, lambda {
|
|
19
19
|
Candid::PreEncounter::Coverages::V1::Types::CoverageStatus
|
|
20
20
|
}, optional: true, nullable: false
|
|
21
|
+
field :secondary_coverage_status, lambda {
|
|
22
|
+
Candid::PreEncounter::Coverages::V1::Types::CoverageStatus
|
|
23
|
+
}, optional: true, nullable: false
|
|
21
24
|
end
|
|
22
25
|
end
|
|
23
26
|
end
|
|
@@ -110,14 +110,21 @@ module Candid
|
|
|
110
110
|
end
|
|
111
111
|
end
|
|
112
112
|
|
|
113
|
-
# Gets a coverage
|
|
113
|
+
# Gets a coverage's history. Full history is returned if no filters are
|
|
114
|
+
# defined. The return list is ordered by version, defaulting to ascending.
|
|
114
115
|
#
|
|
115
116
|
# @return [Array[Candid::PreEncounter::Coverages::V1::Types::Coverage]]
|
|
116
117
|
def get_history(request_options: {}, **params)
|
|
118
|
+
params = Candid::Internal::Types::Utils.symbolize_keys(params)
|
|
119
|
+
_query_param_names = %i[start end non_auto_updated_coverages_only sort_direction limit]
|
|
120
|
+
_query = params.slice(*_query_param_names)
|
|
121
|
+
params = params.except(*_query_param_names)
|
|
122
|
+
|
|
117
123
|
_request = Candid::Internal::JSON::Request.new(
|
|
118
124
|
base_url: request_options[:base_url] || Candid::Environment::PRODUCTION,
|
|
119
125
|
method: "GET",
|
|
120
|
-
path: "/coverages/v1/#{params[:id]}/history"
|
|
126
|
+
path: "/coverages/v1/#{params[:id]}/history",
|
|
127
|
+
query: _query
|
|
121
128
|
)
|
|
122
129
|
begin
|
|
123
130
|
_response = @client.send(_request)
|
|
@@ -16,6 +16,7 @@ module Candid
|
|
|
16
16
|
Internal::Types::Array[Candid::PreEncounter::Coverages::V1::Types::BenefitsRelatedEntity]
|
|
17
17
|
}, optional: true, nullable: false
|
|
18
18
|
field :notes, -> { String }, optional: true, nullable: false
|
|
19
|
+
field :auto_updated_eligibility_check_id, -> { String }, optional: true, nullable: false
|
|
19
20
|
end
|
|
20
21
|
end
|
|
21
22
|
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Candid
|
|
4
|
+
module PreEncounter
|
|
5
|
+
module Coverages
|
|
6
|
+
module V1
|
|
7
|
+
module Types
|
|
8
|
+
class CoveragesGetHistoryRequest < Internal::Types::Model
|
|
9
|
+
field :id, -> { String }, optional: false, nullable: false
|
|
10
|
+
field :start, -> { String }, optional: true, nullable: false
|
|
11
|
+
field :end_, -> { String }, optional: true, nullable: false
|
|
12
|
+
field :non_auto_updated_coverages_only, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
13
|
+
field :sort_direction, lambda {
|
|
14
|
+
Candid::PreEncounter::Common::Types::SortDirection
|
|
15
|
+
}, optional: true, nullable: false
|
|
16
|
+
field :limit, -> { Integer }, optional: true, nullable: false
|
|
17
|
+
end
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -30,6 +30,7 @@ module Candid
|
|
|
30
30
|
Candid::PreEncounter::Coverages::V1::Types::CoverageBenefits
|
|
31
31
|
}, optional: true, nullable: false
|
|
32
32
|
field :orcon, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
33
|
+
field :auto_update_enabled, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
33
34
|
end
|
|
34
35
|
end
|
|
35
36
|
end
|
|
@@ -15,7 +15,7 @@ module Candid
|
|
|
15
15
|
# @return [Candid::PreEncounter::Lists::V1::Types::PatientListPage]
|
|
16
16
|
def get_patient_list(request_options: {}, **params)
|
|
17
17
|
params = Candid::Internal::Types::Utils.symbolize_keys(params)
|
|
18
|
-
_query_param_names = %i[page_token limit sort_field sort_direction filters]
|
|
18
|
+
_query_param_names = %i[page_token limit sort_field sort_direction filters include_deactivated]
|
|
19
19
|
_query = params.slice(*_query_param_names)
|
|
20
20
|
params.except(*_query_param_names)
|
|
21
21
|
|
|
@@ -44,7 +44,7 @@ module Candid
|
|
|
44
44
|
# @return [Candid::PreEncounter::Lists::V1::Types::AppointmentListPage]
|
|
45
45
|
def get_appointment_list(request_options: {}, **params)
|
|
46
46
|
params = Candid::Internal::Types::Utils.symbolize_keys(params)
|
|
47
|
-
_query_param_names = %i[sort_field sort_direction limit page_token filters]
|
|
47
|
+
_query_param_names = %i[sort_field sort_direction limit page_token filters include_deactivated]
|
|
48
48
|
_query = params.slice(*_query_param_names)
|
|
49
49
|
params.except(*_query_param_names)
|
|
50
50
|
|
|
@@ -15,6 +15,9 @@ module Candid
|
|
|
15
15
|
field :primary_coverage, lambda {
|
|
16
16
|
Candid::PreEncounter::Coverages::V1::Types::MutableCoverage
|
|
17
17
|
}, optional: true, nullable: false
|
|
18
|
+
field :secondary_coverage, lambda {
|
|
19
|
+
Candid::PreEncounter::Coverages::V1::Types::MutableCoverage
|
|
20
|
+
}, optional: true, nullable: false
|
|
18
21
|
field :primary_service_type, lambda {
|
|
19
22
|
Candid::PreEncounter::Appointments::V1::Types::UniversalServiceIdentifier
|
|
20
23
|
}, optional: true, nullable: false
|
|
@@ -13,6 +13,7 @@ module Candid
|
|
|
13
13
|
field :limit, -> { Integer }, optional: true, nullable: false
|
|
14
14
|
field :page_token, -> { String }, optional: true, nullable: false
|
|
15
15
|
field :filters, -> { String }, optional: true, nullable: false
|
|
16
|
+
field :include_deactivated, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
16
17
|
end
|
|
17
18
|
end
|
|
18
19
|
end
|
|
@@ -19,6 +19,8 @@ module Candid
|
|
|
19
19
|
field :next_appointment, lambda {
|
|
20
20
|
Candid::PreEncounter::Appointments::V1::Types::MutableAppointment
|
|
21
21
|
}, optional: true, nullable: false
|
|
22
|
+
field :primary_mrn, -> { String }, optional: true, nullable: false
|
|
23
|
+
field :alternative_mrns, -> { Internal::Types::Array[String] }, optional: false, nullable: false
|
|
22
24
|
end
|
|
23
25
|
end
|
|
24
26
|
end
|
|
@@ -13,6 +13,7 @@ module Candid
|
|
|
13
13
|
Candid::PreEncounter::Common::Types::SortDirection
|
|
14
14
|
}, optional: true, nullable: false
|
|
15
15
|
field :filters, -> { String }, optional: true, nullable: false
|
|
16
|
+
field :include_deactivated, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
16
17
|
end
|
|
17
18
|
end
|
|
18
19
|
end
|
|
@@ -193,6 +193,35 @@ module Candid
|
|
|
193
193
|
raise error_class.new(_response.body, code: code)
|
|
194
194
|
end
|
|
195
195
|
|
|
196
|
+
# 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.
|
|
197
|
+
#
|
|
198
|
+
# @return [Candid::PreEncounter::Patients::V1::Types::PatientCoverageSnapshot]
|
|
199
|
+
def get_coverage_snapshot(request_options: {}, **params)
|
|
200
|
+
params = Candid::Internal::Types::Utils.symbolize_keys(params)
|
|
201
|
+
_query_param_names = %i[date]
|
|
202
|
+
_query = params.slice(*_query_param_names)
|
|
203
|
+
params = params.except(*_query_param_names)
|
|
204
|
+
|
|
205
|
+
_request = Candid::Internal::JSON::Request.new(
|
|
206
|
+
base_url: request_options[:base_url] || Candid::Environment::PRODUCTION,
|
|
207
|
+
method: "GET",
|
|
208
|
+
path: "/patients/v1/#{params[:id]}/snapshot",
|
|
209
|
+
query: _query
|
|
210
|
+
)
|
|
211
|
+
begin
|
|
212
|
+
_response = @client.send(_request)
|
|
213
|
+
rescue Net::HTTPRequestTimeout
|
|
214
|
+
raise Candid::Errors::TimeoutError
|
|
215
|
+
end
|
|
216
|
+
code = _response.code.to_i
|
|
217
|
+
if code.between?(200, 299)
|
|
218
|
+
Candid::PreEncounter::Patients::V1::Types::PatientCoverageSnapshot.load(_response.body)
|
|
219
|
+
else
|
|
220
|
+
error_class = Candid::Errors::ResponseError.subclass_for_code(code)
|
|
221
|
+
raise error_class.new(_response.body, code: code)
|
|
222
|
+
end
|
|
223
|
+
end
|
|
224
|
+
|
|
196
225
|
# 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.
|
|
197
226
|
#
|
|
198
227
|
# @return [Candid::PreEncounter::Patients::V1::Types::Patient]
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Candid
|
|
4
|
+
module PreEncounter
|
|
5
|
+
module Patients
|
|
6
|
+
module V1
|
|
7
|
+
module Types
|
|
8
|
+
class GetCoverageSnapshotRequest < Internal::Types::Model
|
|
9
|
+
field :id, -> { String }, optional: false, nullable: false
|
|
10
|
+
field :date, -> { String }, optional: true, nullable: false
|
|
11
|
+
end
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Candid
|
|
4
|
+
module PreEncounter
|
|
5
|
+
module Patients
|
|
6
|
+
module V1
|
|
7
|
+
module Types
|
|
8
|
+
class PatientCoverageSnapshot < Internal::Types::Model
|
|
9
|
+
field :patient, -> { Candid::PreEncounter::Patients::V1::Types::Patient }, optional: false, nullable: false
|
|
10
|
+
field :primary_coverage, lambda {
|
|
11
|
+
Candid::PreEncounter::Coverages::V1::Types::Coverage
|
|
12
|
+
}, optional: true, nullable: false
|
|
13
|
+
field :secondary_coverage, lambda {
|
|
14
|
+
Candid::PreEncounter::Coverages::V1::Types::Coverage
|
|
15
|
+
}, optional: true, nullable: false
|
|
16
|
+
field :tertiary_coverage, lambda {
|
|
17
|
+
Candid::PreEncounter::Coverages::V1::Types::Coverage
|
|
18
|
+
}, optional: true, nullable: false
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
end
|
data/lib/candid/version.rb
CHANGED
data/lib/candid.rb
CHANGED
|
@@ -467,11 +467,12 @@ require_relative "candid/financials/types/claim_allocation_target"
|
|
|
467
467
|
require_relative "candid/financials/types/billing_provider_allocation_target"
|
|
468
468
|
require_relative "candid/financials/types/appointment_allocation_target"
|
|
469
469
|
require_relative "candid/financials/types/allocation_target"
|
|
470
|
+
require_relative "candid/financials/types/allocation_earmark_type"
|
|
471
|
+
require_relative "candid/financials/types/balance_earmark"
|
|
470
472
|
require_relative "candid/financials/types/allocation"
|
|
471
473
|
require_relative "candid/insurance_refunds/v_1/types/insurance_refund"
|
|
472
474
|
require_relative "candid/payers/v_3/types/payer_info"
|
|
473
475
|
require_relative "candid/payers/v_3/types/payer_identifier"
|
|
474
|
-
require_relative "candid/financials/types/allocation_earmark_type"
|
|
475
476
|
require_relative "candid/financials/types/appointment_by_id_and_patient_external_id"
|
|
476
477
|
require_relative "candid/financials/types/allocation_target_create"
|
|
477
478
|
require_relative "candid/financials/types/allocation_create"
|
|
@@ -699,6 +700,7 @@ require_relative "candid/pre_encounter/lists/v_1/types/appointment_list_item"
|
|
|
699
700
|
require_relative "candid/pre_encounter/lists/v_1/types/appointment_list_page"
|
|
700
701
|
require_relative "candid/pre_encounter/notes/v_1/types/mutable_note"
|
|
701
702
|
require_relative "candid/pre_encounter/notes/v_1/types/note"
|
|
703
|
+
require_relative "candid/pre_encounter/patients/v_1/types/patient_coverage_snapshot"
|
|
702
704
|
require_relative "candid/pre_encounter/patients/v_1/types/patient_page"
|
|
703
705
|
require_relative "candid/pre_encounter/tags/v_1/types/mutable_tag"
|
|
704
706
|
require_relative "candid/pre_encounter/tags/v_1/types/tag"
|
|
@@ -865,6 +867,7 @@ require_relative "candid/pre_encounter/appointments/v_1/types/appointment_scan_r
|
|
|
865
867
|
require_relative "candid/pre_encounter/coverages/client"
|
|
866
868
|
require_relative "candid/pre_encounter/coverages/v_1/client"
|
|
867
869
|
require_relative "candid/pre_encounter/coverages/v_1/types/coverage_get_multi_paginated_request"
|
|
870
|
+
require_relative "candid/pre_encounter/coverages/v_1/types/coverages_get_history_request"
|
|
868
871
|
require_relative "candid/pre_encounter/coverages/v_1/types/coverage_get_multi_request"
|
|
869
872
|
require_relative "candid/pre_encounter/coverages/v_1/types/coverage_scan_request"
|
|
870
873
|
require_relative "candid/pre_encounter/coverages/v_1/types/check_eligibility_request"
|
|
@@ -888,6 +891,7 @@ require_relative "candid/pre_encounter/patients/v_1/types/create_patient_request
|
|
|
888
891
|
require_relative "candid/pre_encounter/patients/v_1/types/create_patient_with_mrn_request"
|
|
889
892
|
require_relative "candid/pre_encounter/patients/v_1/types/patients_search_request_paginated"
|
|
890
893
|
require_relative "candid/pre_encounter/patients/v_1/types/search_providers_request"
|
|
894
|
+
require_relative "candid/pre_encounter/patients/v_1/types/get_coverage_snapshot_request"
|
|
891
895
|
require_relative "candid/pre_encounter/patients/v_1/types/patient_get_multi_request"
|
|
892
896
|
require_relative "candid/pre_encounter/patients/v_1/types/patient_scan_request"
|
|
893
897
|
require_relative "candid/pre_encounter/tags/client"
|
data/reference.md
CHANGED
|
@@ -4379,6 +4379,14 @@ or encounter external id.
|
|
|
4379
4379
|
|
|
4380
4380
|
**patient_external_id:** `String` — The patient ID from the external EMR platform for the patient
|
|
4381
4381
|
|
|
4382
|
+
</dd>
|
|
4383
|
+
</dl>
|
|
4384
|
+
|
|
4385
|
+
<dl>
|
|
4386
|
+
<dd>
|
|
4387
|
+
|
|
4388
|
+
**include_merged_patient_data:** `Internal::Types::Boolean` — If true and patient_external_id is set, then also include the encounters of all alternative patients.
|
|
4389
|
+
|
|
4382
4390
|
</dd>
|
|
4383
4391
|
</dl>
|
|
4384
4392
|
</dd>
|
|
@@ -11390,6 +11398,17 @@ client.pre_encounter.appointments.v_1.create({
|
|
|
11390
11398
|
<dd>
|
|
11391
11399
|
|
|
11392
11400
|
Gets all Visits within a given time range. The return list is ordered by start_time ascending.
|
|
11401
|
+
|
|
11402
|
+
**IMPORTANT:** This endpoint requires a date filter on `appointment.startTimestamp` to ensure acceptable query performance.
|
|
11403
|
+
Without date filtering, the query can take 50+ seconds on large datasets due to grouping and aggregation operations.
|
|
11404
|
+
|
|
11405
|
+
Example filters:
|
|
11406
|
+
- `appointment.startTimestamp|gt|2024-01-01` - appointments after January 1, 2024
|
|
11407
|
+
- `appointment.startTimestamp|eq|2024-12-08` - appointments on December 8, 2024
|
|
11408
|
+
- `appointment.startTimestamp|lt|2024-12-31` - appointments before December 31, 2024
|
|
11409
|
+
|
|
11410
|
+
You can combine the date filter with other filters using commas:
|
|
11411
|
+
- `appointment.startTimestamp|gt|2024-01-01,appointment.status|eq|PENDING`
|
|
11393
11412
|
</dd>
|
|
11394
11413
|
</dl>
|
|
11395
11414
|
</dd>
|
|
@@ -11452,6 +11471,9 @@ client.pre_encounter.appointments.v_1.get_visits();
|
|
|
11452
11471
|
<dd>
|
|
11453
11472
|
|
|
11454
11473
|
**filters:** `String`
|
|
11474
|
+
|
|
11475
|
+
**Required:** Must include a date filter on appointment.startTimestamp (using gt, lt, or eq operators).
|
|
11476
|
+
Example: appointment.startTimestamp|gt|2024-01-01
|
|
11455
11477
|
|
|
11456
11478
|
</dd>
|
|
11457
11479
|
</dl>
|
|
@@ -12059,7 +12081,8 @@ client.pre_encounter.coverages.v_1.get();
|
|
|
12059
12081
|
<dl>
|
|
12060
12082
|
<dd>
|
|
12061
12083
|
|
|
12062
|
-
Gets a coverage
|
|
12084
|
+
Gets a coverage's history. Full history is returned if no filters are
|
|
12085
|
+
defined. The return list is ordered by version, defaulting to ascending.
|
|
12063
12086
|
</dd>
|
|
12064
12087
|
</dl>
|
|
12065
12088
|
</dd>
|
|
@@ -12074,7 +12097,7 @@ Gets a coverage along with it's full history. The return list is ordered by ver
|
|
|
12074
12097
|
<dd>
|
|
12075
12098
|
|
|
12076
12099
|
```ruby
|
|
12077
|
-
client.pre_encounter.coverages.v_1.get_history();
|
|
12100
|
+
client.pre_encounter.coverages.v_1.get_history(id: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32');
|
|
12078
12101
|
```
|
|
12079
12102
|
</dd>
|
|
12080
12103
|
</dl>
|
|
@@ -12091,6 +12114,46 @@ client.pre_encounter.coverages.v_1.get_history();
|
|
|
12091
12114
|
|
|
12092
12115
|
**id:** `String`
|
|
12093
12116
|
|
|
12117
|
+
</dd>
|
|
12118
|
+
</dl>
|
|
12119
|
+
|
|
12120
|
+
<dl>
|
|
12121
|
+
<dd>
|
|
12122
|
+
|
|
12123
|
+
**start:** `String`
|
|
12124
|
+
|
|
12125
|
+
</dd>
|
|
12126
|
+
</dl>
|
|
12127
|
+
|
|
12128
|
+
<dl>
|
|
12129
|
+
<dd>
|
|
12130
|
+
|
|
12131
|
+
**end_:** `String`
|
|
12132
|
+
|
|
12133
|
+
</dd>
|
|
12134
|
+
</dl>
|
|
12135
|
+
|
|
12136
|
+
<dl>
|
|
12137
|
+
<dd>
|
|
12138
|
+
|
|
12139
|
+
**non_auto_updated_coverages_only:** `Internal::Types::Boolean` — If true, only returns coverages that have NOT been auto-updated by the system.
|
|
12140
|
+
|
|
12141
|
+
</dd>
|
|
12142
|
+
</dl>
|
|
12143
|
+
|
|
12144
|
+
<dl>
|
|
12145
|
+
<dd>
|
|
12146
|
+
|
|
12147
|
+
**sort_direction:** `Candid::PreEncounter::Common::Types::SortDirection` — Defaults to ascending. Sorts by version.
|
|
12148
|
+
|
|
12149
|
+
</dd>
|
|
12150
|
+
</dl>
|
|
12151
|
+
|
|
12152
|
+
<dl>
|
|
12153
|
+
<dd>
|
|
12154
|
+
|
|
12155
|
+
**limit:** `Integer` — Must be between 0 and 1000. No default.
|
|
12156
|
+
|
|
12094
12157
|
</dd>
|
|
12095
12158
|
</dl>
|
|
12096
12159
|
</dd>
|
|
@@ -13179,6 +13242,14 @@ client.pre_encounter.lists.v_1.get_patient_list();
|
|
|
13179
13242
|
|
|
13180
13243
|
**filters:** `String`
|
|
13181
13244
|
|
|
13245
|
+
</dd>
|
|
13246
|
+
</dl>
|
|
13247
|
+
|
|
13248
|
+
<dl>
|
|
13249
|
+
<dd>
|
|
13250
|
+
|
|
13251
|
+
**include_deactivated:** `Internal::Types::Boolean` — If true, includes deactivated patients in the results. Defaults to false.
|
|
13252
|
+
|
|
13182
13253
|
</dd>
|
|
13183
13254
|
</dl>
|
|
13184
13255
|
</dd>
|
|
@@ -13265,6 +13336,14 @@ client.pre_encounter.lists.v_1.get_appointment_list();
|
|
|
13265
13336
|
|
|
13266
13337
|
**filters:** `String`
|
|
13267
13338
|
|
|
13339
|
+
</dd>
|
|
13340
|
+
</dl>
|
|
13341
|
+
|
|
13342
|
+
<dl>
|
|
13343
|
+
<dd>
|
|
13344
|
+
|
|
13345
|
+
**include_deactivated:** `Internal::Types::Boolean` — If true, includes deactivated appointments in the results. Defaults to false.
|
|
13346
|
+
|
|
13268
13347
|
</dd>
|
|
13269
13348
|
</dl>
|
|
13270
13349
|
</dd>
|
|
@@ -13943,6 +14022,68 @@ client.pre_encounter.patients.v_1.get_history();
|
|
|
13943
14022
|
</dl>
|
|
13944
14023
|
|
|
13945
14024
|
|
|
14025
|
+
</dd>
|
|
14026
|
+
</dl>
|
|
14027
|
+
</details>
|
|
14028
|
+
|
|
14029
|
+
<details><summary><code>client.pre_encounter.patients.v_1.get_coverage_snapshot(id) -> Candid::PreEncounter::Patients::V1::Types::PatientCoverageSnapshot</code></summary>
|
|
14030
|
+
<dl>
|
|
14031
|
+
<dd>
|
|
14032
|
+
|
|
14033
|
+
#### 📝 Description
|
|
14034
|
+
|
|
14035
|
+
<dl>
|
|
14036
|
+
<dd>
|
|
14037
|
+
|
|
14038
|
+
<dl>
|
|
14039
|
+
<dd>
|
|
14040
|
+
|
|
14041
|
+
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.
|
|
14042
|
+
</dd>
|
|
14043
|
+
</dl>
|
|
14044
|
+
</dd>
|
|
14045
|
+
</dl>
|
|
14046
|
+
|
|
14047
|
+
#### 🔌 Usage
|
|
14048
|
+
|
|
14049
|
+
<dl>
|
|
14050
|
+
<dd>
|
|
14051
|
+
|
|
14052
|
+
<dl>
|
|
14053
|
+
<dd>
|
|
14054
|
+
|
|
14055
|
+
```ruby
|
|
14056
|
+
client.pre_encounter.patients.v_1.get_coverage_snapshot(id: 'id');
|
|
14057
|
+
```
|
|
14058
|
+
</dd>
|
|
14059
|
+
</dl>
|
|
14060
|
+
</dd>
|
|
14061
|
+
</dl>
|
|
14062
|
+
|
|
14063
|
+
#### ⚙️ Parameters
|
|
14064
|
+
|
|
14065
|
+
<dl>
|
|
14066
|
+
<dd>
|
|
14067
|
+
|
|
14068
|
+
<dl>
|
|
14069
|
+
<dd>
|
|
14070
|
+
|
|
14071
|
+
**id:** `String`
|
|
14072
|
+
|
|
14073
|
+
</dd>
|
|
14074
|
+
</dl>
|
|
14075
|
+
|
|
14076
|
+
<dl>
|
|
14077
|
+
<dd>
|
|
14078
|
+
|
|
14079
|
+
**date:** `String`
|
|
14080
|
+
|
|
14081
|
+
</dd>
|
|
14082
|
+
</dl>
|
|
14083
|
+
</dd>
|
|
14084
|
+
</dl>
|
|
14085
|
+
|
|
14086
|
+
|
|
13946
14087
|
</dd>
|
|
13947
14088
|
</dl>
|
|
13948
14089
|
</details>
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: candidhealth
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.18.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Candid
|
|
@@ -365,6 +365,7 @@ files:
|
|
|
365
365
|
- lib/candid/financials/types/allocation_target_create.rb
|
|
366
366
|
- lib/candid/financials/types/appointment_allocation_target.rb
|
|
367
367
|
- lib/candid/financials/types/appointment_by_id_and_patient_external_id.rb
|
|
368
|
+
- lib/candid/financials/types/balance_earmark.rb
|
|
368
369
|
- lib/candid/financials/types/billing_provider_allocation_target.rb
|
|
369
370
|
- lib/candid/financials/types/claim_allocation_target.rb
|
|
370
371
|
- lib/candid/financials/types/invoice_update.rb
|
|
@@ -710,6 +711,7 @@ files:
|
|
|
710
711
|
- lib/candid/pre_encounter/coverages/v_1/types/coverage_status.rb
|
|
711
712
|
- lib/candid/pre_encounter/coverages/v_1/types/coverage_value.rb
|
|
712
713
|
- lib/candid/pre_encounter/coverages/v_1/types/coverage_value_unit.rb
|
|
714
|
+
- lib/candid/pre_encounter/coverages/v_1/types/coverages_get_history_request.rb
|
|
713
715
|
- lib/candid/pre_encounter/coverages/v_1/types/coverages_page.rb
|
|
714
716
|
- lib/candid/pre_encounter/coverages/v_1/types/expanded_member_info.rb
|
|
715
717
|
- lib/candid/pre_encounter/coverages/v_1/types/insurance_plan.rb
|
|
@@ -789,6 +791,7 @@ files:
|
|
|
789
791
|
- lib/candid/pre_encounter/patients/v_1/types/do_not_invoice_reason.rb
|
|
790
792
|
- lib/candid/pre_encounter/patients/v_1/types/external_provenance.rb
|
|
791
793
|
- lib/candid/pre_encounter/patients/v_1/types/filing_order.rb
|
|
794
|
+
- lib/candid/pre_encounter/patients/v_1/types/get_coverage_snapshot_request.rb
|
|
792
795
|
- lib/candid/pre_encounter/patients/v_1/types/guarantor.rb
|
|
793
796
|
- lib/candid/pre_encounter/patients/v_1/types/inferred_patient_metadata.rb
|
|
794
797
|
- lib/candid/pre_encounter/patients/v_1/types/marital_status.rb
|
|
@@ -796,6 +799,7 @@ files:
|
|
|
796
799
|
- lib/candid/pre_encounter/patients/v_1/types/mutable_patient_with_mrn.rb
|
|
797
800
|
- lib/candid/pre_encounter/patients/v_1/types/origination_detail.rb
|
|
798
801
|
- lib/candid/pre_encounter/patients/v_1/types/patient.rb
|
|
802
|
+
- lib/candid/pre_encounter/patients/v_1/types/patient_coverage_snapshot.rb
|
|
799
803
|
- lib/candid/pre_encounter/patients/v_1/types/patient_get_multi_request.rb
|
|
800
804
|
- lib/candid/pre_encounter/patients/v_1/types/patient_page.rb
|
|
801
805
|
- lib/candid/pre_encounter/patients/v_1/types/patient_scan_request.rb
|