candidhealth 0.41.1 → 0.41.3
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/candidhealth/charge_capture_bundles/v_1/types/charge_capture_bundle.rb +13 -1
- data/lib/candidhealth/charge_capture_bundles/v_1/types/charge_capture_bundle_status.rb +1 -0
- data/lib/candidhealth/charge_capture_bundles/v_1/types/charge_capture_bundle_summary.rb +16 -6
- data/lib/candidhealth/pre_encounter/common/types/gender.rb +2 -0
- data/lib/candidhealth/pre_encounter/coverages/v_1/client.rb +61 -0
- data/lib/candidhealth/pre_encounter/coverages/v_1/types/payer_plan_group_fields.rb +92 -0
- data/lib/candidhealth/pre_encounter/patients/v_1/client.rb +12 -6
- data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient.rb +9 -1
- data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient_with_mrn.rb +9 -1
- data/lib/candidhealth/pre_encounter/patients/v_1/types/patient.rb +9 -1
- data/lib/candidhealth/superbills/client.rb +30 -0
- data/lib/candidhealth/superbills/v_1/client.rb +125 -0
- data/lib/candidhealth/superbills/v_1/types/superbill.rb +108 -0
- data/lib/candidhealth/superbills/v_1/types/superbill_response.rb +65 -0
- data/lib/candidhealth.rb +7 -0
- data/lib/requests.rb +2 -2
- data/lib/types_export.rb +3 -0
- metadata +7 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5214d69f57a49a1660927a52af327025bbb13421a9b28b0bd444f02623c5fd28
|
4
|
+
data.tar.gz: da7f97e325824d1610009592c1d624e5306915418721c99c216b09349a8ab62e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e5dfed78cb1aa5a363b8d939d1f2274ab420d74d441f9948b054da488e4c66bead8bf0d2845cc5adf47a9d06e1fc07e89291fca3b3bb1aaaed3b4ea02b0addb2
|
7
|
+
data.tar.gz: d33e1a76f5a87a747e05c03558d7082e5985aafd564f66190ced046bea2b5f658342ab0cb746c2dab69843b1d6caa72b96fb2c1a3470b633897dd6fa7f5fec8e
|
@@ -18,6 +18,10 @@ module CandidApiClient
|
|
18
18
|
# @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleStatus] Status of the Bundle, Successful means that the Bundle created a corresponding
|
19
19
|
# Claim
|
20
20
|
attr_reader :status
|
21
|
+
# @return [Hash{String => String}] A dictionary of characteristics that are used to group charge captures together
|
22
|
+
# based on the bundling configuration.
|
23
|
+
# Example: {"service_facility.npi": "99999999", "date_of_service": "2023-01-01"}
|
24
|
+
attr_reader :characteristics
|
21
25
|
# @return [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCapture>] All the underlying ChargeCaptures that are present in a ChargeCaptureBundle.
|
22
26
|
attr_reader :charge_captures
|
23
27
|
# @return [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureError>] All errors that were found when the bundle was attempted to be created.
|
@@ -36,17 +40,21 @@ module CandidApiClient
|
|
36
40
|
# @param created_encounter_id [String]
|
37
41
|
# @param status [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleStatus] Status of the Bundle, Successful means that the Bundle created a corresponding
|
38
42
|
# Claim
|
43
|
+
# @param characteristics [Hash{String => String}] A dictionary of characteristics that are used to group charge captures together
|
44
|
+
# based on the bundling configuration.
|
45
|
+
# Example: {"service_facility.npi": "99999999", "date_of_service": "2023-01-01"}
|
39
46
|
# @param charge_captures [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCapture>] All the underlying ChargeCaptures that are present in a ChargeCaptureBundle.
|
40
47
|
# @param errors [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureError>] All errors that were found when the bundle was attempted to be created.
|
41
48
|
# Errors can correspond to the Bundle as a whole or specific underlying Charge
|
42
49
|
# Captures.
|
43
50
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
44
51
|
# @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundle]
|
45
|
-
def initialize(id:, status:, charge_captures:, errors:, created_encounter_id: OMIT,
|
52
|
+
def initialize(id:, status:, characteristics:, charge_captures:, errors:, created_encounter_id: OMIT,
|
46
53
|
additional_properties: nil)
|
47
54
|
@id = id
|
48
55
|
@created_encounter_id = created_encounter_id if created_encounter_id != OMIT
|
49
56
|
@status = status
|
57
|
+
@characteristics = characteristics
|
50
58
|
@charge_captures = charge_captures
|
51
59
|
@errors = errors
|
52
60
|
@additional_properties = additional_properties
|
@@ -54,6 +62,7 @@ module CandidApiClient
|
|
54
62
|
"id": id,
|
55
63
|
"created_encounter_id": created_encounter_id,
|
56
64
|
"status": status,
|
65
|
+
"characteristics": characteristics,
|
57
66
|
"charge_captures": charge_captures,
|
58
67
|
"errors": errors
|
59
68
|
}.reject do |_k, v|
|
@@ -71,6 +80,7 @@ module CandidApiClient
|
|
71
80
|
id = struct["id"]
|
72
81
|
created_encounter_id = struct["created_encounter_id"]
|
73
82
|
status = struct["status"]
|
83
|
+
characteristics = struct["characteristics"]
|
74
84
|
charge_captures = parsed_json["charge_captures"]&.map do |item|
|
75
85
|
item = item.to_json
|
76
86
|
CandidApiClient::ChargeCapture::V1::Types::ChargeCapture.from_json(json_object: item)
|
@@ -83,6 +93,7 @@ module CandidApiClient
|
|
83
93
|
id: id,
|
84
94
|
created_encounter_id: created_encounter_id,
|
85
95
|
status: status,
|
96
|
+
characteristics: characteristics,
|
86
97
|
charge_captures: charge_captures,
|
87
98
|
errors: errors,
|
88
99
|
additional_properties: struct
|
@@ -106,6 +117,7 @@ module CandidApiClient
|
|
106
117
|
obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
|
107
118
|
obj.created_encounter_id&.is_a?(String) != false || raise("Passed value for field obj.created_encounter_id is not the expected type, validation failed.")
|
108
119
|
obj.status.is_a?(CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
|
120
|
+
obj.characteristics.is_a?(Hash) != false || raise("Passed value for field obj.characteristics is not the expected type, validation failed.")
|
109
121
|
obj.charge_captures.is_a?(Array) != false || raise("Passed value for field obj.charge_captures is not the expected type, validation failed.")
|
110
122
|
obj.errors.is_a?(Array) != false || raise("Passed value for field obj.errors is not the expected type, validation failed.")
|
111
123
|
end
|
@@ -8,9 +8,12 @@ module CandidApiClient
|
|
8
8
|
module V1
|
9
9
|
module Types
|
10
10
|
class ChargeCaptureBundleSummary
|
11
|
-
# @return [Integer] The count of charge captures which are not
|
11
|
+
# @return [Integer] The count of charge captures which are not in a bundle or in a bundle with a
|
12
|
+
# status other than SUCCESSFUL.
|
12
13
|
attr_reader :charge_capture_unbundled_count
|
13
|
-
# @return [Integer] The count of charge capture bundles that
|
14
|
+
# @return [Integer] The count of charge capture bundles that have a bundle status of NOT_STARTED.
|
15
|
+
attr_reader :charge_capture_bundles_not_started_count
|
16
|
+
# @return [Integer] The count of charge capture bundles that have a bundle status of IN_ERROR.
|
14
17
|
attr_reader :charge_capture_bundles_in_error_count
|
15
18
|
# @return [Integer] The number of ChargeCapturePostBilledChange items that are unresolved.
|
16
19
|
attr_reader :charge_capture_unresolved_change_count
|
@@ -22,19 +25,23 @@ module CandidApiClient
|
|
22
25
|
|
23
26
|
OMIT = Object.new
|
24
27
|
|
25
|
-
# @param charge_capture_unbundled_count [Integer] The count of charge captures which are not
|
26
|
-
#
|
28
|
+
# @param charge_capture_unbundled_count [Integer] The count of charge captures which are not in a bundle or in a bundle with a
|
29
|
+
# status other than SUCCESSFUL.
|
30
|
+
# @param charge_capture_bundles_not_started_count [Integer] The count of charge capture bundles that have a bundle status of NOT_STARTED.
|
31
|
+
# @param charge_capture_bundles_in_error_count [Integer] The count of charge capture bundles that have a bundle status of IN_ERROR.
|
27
32
|
# @param charge_capture_unresolved_change_count [Integer] The number of ChargeCapturePostBilledChange items that are unresolved.
|
28
33
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
29
34
|
# @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleSummary]
|
30
|
-
def initialize(charge_capture_unbundled_count:,
|
31
|
-
charge_capture_unresolved_change_count:, additional_properties: nil)
|
35
|
+
def initialize(charge_capture_unbundled_count:, charge_capture_bundles_not_started_count:,
|
36
|
+
charge_capture_bundles_in_error_count:, charge_capture_unresolved_change_count:, additional_properties: nil)
|
32
37
|
@charge_capture_unbundled_count = charge_capture_unbundled_count
|
38
|
+
@charge_capture_bundles_not_started_count = charge_capture_bundles_not_started_count
|
33
39
|
@charge_capture_bundles_in_error_count = charge_capture_bundles_in_error_count
|
34
40
|
@charge_capture_unresolved_change_count = charge_capture_unresolved_change_count
|
35
41
|
@additional_properties = additional_properties
|
36
42
|
@_field_set = {
|
37
43
|
"charge_capture_unbundled_count": charge_capture_unbundled_count,
|
44
|
+
"charge_capture_bundles_not_started_count": charge_capture_bundles_not_started_count,
|
38
45
|
"charge_capture_bundles_in_error_count": charge_capture_bundles_in_error_count,
|
39
46
|
"charge_capture_unresolved_change_count": charge_capture_unresolved_change_count
|
40
47
|
}
|
@@ -47,10 +54,12 @@ module CandidApiClient
|
|
47
54
|
def self.from_json(json_object:)
|
48
55
|
struct = JSON.parse(json_object, object_class: OpenStruct)
|
49
56
|
charge_capture_unbundled_count = struct["charge_capture_unbundled_count"]
|
57
|
+
charge_capture_bundles_not_started_count = struct["charge_capture_bundles_not_started_count"]
|
50
58
|
charge_capture_bundles_in_error_count = struct["charge_capture_bundles_in_error_count"]
|
51
59
|
charge_capture_unresolved_change_count = struct["charge_capture_unresolved_change_count"]
|
52
60
|
new(
|
53
61
|
charge_capture_unbundled_count: charge_capture_unbundled_count,
|
62
|
+
charge_capture_bundles_not_started_count: charge_capture_bundles_not_started_count,
|
54
63
|
charge_capture_bundles_in_error_count: charge_capture_bundles_in_error_count,
|
55
64
|
charge_capture_unresolved_change_count: charge_capture_unresolved_change_count,
|
56
65
|
additional_properties: struct
|
@@ -72,6 +81,7 @@ module CandidApiClient
|
|
72
81
|
# @return [Void]
|
73
82
|
def self.validate_raw(obj:)
|
74
83
|
obj.charge_capture_unbundled_count.is_a?(Integer) != false || raise("Passed value for field obj.charge_capture_unbundled_count is not the expected type, validation failed.")
|
84
|
+
obj.charge_capture_bundles_not_started_count.is_a?(Integer) != false || raise("Passed value for field obj.charge_capture_bundles_not_started_count is not the expected type, validation failed.")
|
75
85
|
obj.charge_capture_bundles_in_error_count.is_a?(Integer) != false || raise("Passed value for field obj.charge_capture_bundles_in_error_count is not the expected type, validation failed.")
|
76
86
|
obj.charge_capture_unresolved_change_count.is_a?(Integer) != false || raise("Passed value for field obj.charge_capture_unresolved_change_count is not the expected type, validation failed.")
|
77
87
|
end
|
@@ -6,6 +6,7 @@ require_relative "types/coverage"
|
|
6
6
|
require_relative "types/coverages_page"
|
7
7
|
require "json"
|
8
8
|
require "date"
|
9
|
+
require_relative "types/payer_plan_group_fields"
|
9
10
|
require_relative "types/service_type_code"
|
10
11
|
require_relative "types/eligibility_check_metadata"
|
11
12
|
require_relative "types/coverage_eligibility_check_response"
|
@@ -509,6 +510,35 @@ module CandidApiClient
|
|
509
510
|
end
|
510
511
|
end
|
511
512
|
|
513
|
+
# Finds all coverages associated with the given ppg_id and updates the ppg_fields
|
514
|
+
# for each coverage.
|
515
|
+
#
|
516
|
+
# @param ppg_id [String]
|
517
|
+
# @param request [Hash] Request of type CandidApiClient::PreEncounter::Coverages::V1::Types::PayerPlanGroupFields, as a Hash
|
518
|
+
# * :payer_plan_group_id (String)
|
519
|
+
# * :payer_id (String)
|
520
|
+
# * :payer_name (String)
|
521
|
+
# * :plan_type (CandidApiClient::PreEncounter::Coverages::V1::Types::NetworkType)
|
522
|
+
# @param request_options [CandidApiClient::RequestOptions]
|
523
|
+
# @return [Void]
|
524
|
+
# @example
|
525
|
+
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
526
|
+
# api.pre_encounter.coverages.v_1.batch_update_ppg(ppg_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", payer_id: "string", payer_name: "string", plan_type: SELF_PAY })
|
527
|
+
def batch_update_ppg(ppg_id:, request:, request_options: nil)
|
528
|
+
@request_client.conn.post do |req|
|
529
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
530
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
531
|
+
req.headers = {
|
532
|
+
**(req.headers || {}),
|
533
|
+
**@request_client.get_headers,
|
534
|
+
**(request_options&.additional_headers || {})
|
535
|
+
}.compact
|
536
|
+
req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
|
537
|
+
req.url "#{@request_client.get_url(environment: PreEncounter,
|
538
|
+
request_options: request_options)}/coverages/v1/batch-update-ppg/#{ppg_id}"
|
539
|
+
end
|
540
|
+
end
|
541
|
+
|
512
542
|
# Initiates an eligibility check. Returns the metadata of the check if
|
513
543
|
# successfully initiated.
|
514
544
|
#
|
@@ -1083,6 +1113,37 @@ module CandidApiClient
|
|
1083
1113
|
end
|
1084
1114
|
end
|
1085
1115
|
|
1116
|
+
# Finds all coverages associated with the given ppg_id and updates the ppg_fields
|
1117
|
+
# for each coverage.
|
1118
|
+
#
|
1119
|
+
# @param ppg_id [String]
|
1120
|
+
# @param request [Hash] Request of type CandidApiClient::PreEncounter::Coverages::V1::Types::PayerPlanGroupFields, as a Hash
|
1121
|
+
# * :payer_plan_group_id (String)
|
1122
|
+
# * :payer_id (String)
|
1123
|
+
# * :payer_name (String)
|
1124
|
+
# * :plan_type (CandidApiClient::PreEncounter::Coverages::V1::Types::NetworkType)
|
1125
|
+
# @param request_options [CandidApiClient::RequestOptions]
|
1126
|
+
# @return [Void]
|
1127
|
+
# @example
|
1128
|
+
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
1129
|
+
# api.pre_encounter.coverages.v_1.batch_update_ppg(ppg_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", payer_id: "string", payer_name: "string", plan_type: SELF_PAY })
|
1130
|
+
def batch_update_ppg(ppg_id:, request:, request_options: nil)
|
1131
|
+
Async do
|
1132
|
+
@request_client.conn.post do |req|
|
1133
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
1134
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
1135
|
+
req.headers = {
|
1136
|
+
**(req.headers || {}),
|
1137
|
+
**@request_client.get_headers,
|
1138
|
+
**(request_options&.additional_headers || {})
|
1139
|
+
}.compact
|
1140
|
+
req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
|
1141
|
+
req.url "#{@request_client.get_url(environment: PreEncounter,
|
1142
|
+
request_options: request_options)}/coverages/v1/batch-update-ppg/#{ppg_id}"
|
1143
|
+
end
|
1144
|
+
end
|
1145
|
+
end
|
1146
|
+
|
1086
1147
|
# Initiates an eligibility check. Returns the metadata of the check if
|
1087
1148
|
# successfully initiated.
|
1088
1149
|
#
|
@@ -0,0 +1,92 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "network_type"
|
4
|
+
require "ostruct"
|
5
|
+
require "json"
|
6
|
+
|
7
|
+
module CandidApiClient
|
8
|
+
module PreEncounter
|
9
|
+
module Coverages
|
10
|
+
module V1
|
11
|
+
module Types
|
12
|
+
class PayerPlanGroupFields
|
13
|
+
# @return [String]
|
14
|
+
attr_reader :payer_plan_group_id
|
15
|
+
# @return [String]
|
16
|
+
attr_reader :payer_id
|
17
|
+
# @return [String]
|
18
|
+
attr_reader :payer_name
|
19
|
+
# @return [CandidApiClient::PreEncounter::Coverages::V1::Types::NetworkType]
|
20
|
+
attr_reader :plan_type
|
21
|
+
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
22
|
+
attr_reader :additional_properties
|
23
|
+
# @return [Object]
|
24
|
+
attr_reader :_field_set
|
25
|
+
protected :_field_set
|
26
|
+
|
27
|
+
OMIT = Object.new
|
28
|
+
|
29
|
+
# @param payer_plan_group_id [String]
|
30
|
+
# @param payer_id [String]
|
31
|
+
# @param payer_name [String]
|
32
|
+
# @param plan_type [CandidApiClient::PreEncounter::Coverages::V1::Types::NetworkType]
|
33
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
34
|
+
# @return [CandidApiClient::PreEncounter::Coverages::V1::Types::PayerPlanGroupFields]
|
35
|
+
def initialize(payer_plan_group_id:, payer_id:, payer_name:, plan_type:, additional_properties: nil)
|
36
|
+
@payer_plan_group_id = payer_plan_group_id
|
37
|
+
@payer_id = payer_id
|
38
|
+
@payer_name = payer_name
|
39
|
+
@plan_type = plan_type
|
40
|
+
@additional_properties = additional_properties
|
41
|
+
@_field_set = {
|
42
|
+
"payer_plan_group_id": payer_plan_group_id,
|
43
|
+
"payer_id": payer_id,
|
44
|
+
"payer_name": payer_name,
|
45
|
+
"plan_type": plan_type
|
46
|
+
}
|
47
|
+
end
|
48
|
+
|
49
|
+
# Deserialize a JSON object to an instance of PayerPlanGroupFields
|
50
|
+
#
|
51
|
+
# @param json_object [String]
|
52
|
+
# @return [CandidApiClient::PreEncounter::Coverages::V1::Types::PayerPlanGroupFields]
|
53
|
+
def self.from_json(json_object:)
|
54
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
55
|
+
payer_plan_group_id = struct["payer_plan_group_id"]
|
56
|
+
payer_id = struct["payer_id"]
|
57
|
+
payer_name = struct["payer_name"]
|
58
|
+
plan_type = struct["plan_type"]
|
59
|
+
new(
|
60
|
+
payer_plan_group_id: payer_plan_group_id,
|
61
|
+
payer_id: payer_id,
|
62
|
+
payer_name: payer_name,
|
63
|
+
plan_type: plan_type,
|
64
|
+
additional_properties: struct
|
65
|
+
)
|
66
|
+
end
|
67
|
+
|
68
|
+
# Serialize an instance of PayerPlanGroupFields to a JSON object
|
69
|
+
#
|
70
|
+
# @return [String]
|
71
|
+
def to_json(*_args)
|
72
|
+
@_field_set&.to_json
|
73
|
+
end
|
74
|
+
|
75
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
76
|
+
# hash and check each fields type against the current object's property
|
77
|
+
# definitions.
|
78
|
+
#
|
79
|
+
# @param obj [Object]
|
80
|
+
# @return [Void]
|
81
|
+
def self.validate_raw(obj:)
|
82
|
+
obj.payer_plan_group_id.is_a?(String) != false || raise("Passed value for field obj.payer_plan_group_id is not the expected type, validation failed.")
|
83
|
+
obj.payer_id.is_a?(String) != false || raise("Passed value for field obj.payer_id is not the expected type, validation failed.")
|
84
|
+
obj.payer_name.is_a?(String) != false || raise("Passed value for field obj.payer_name is not the expected type, validation failed.")
|
85
|
+
obj.plan_type.is_a?(CandidApiClient::PreEncounter::Coverages::V1::Types::NetworkType) != false || raise("Passed value for field obj.plan_type is not the expected type, validation failed.")
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
89
|
+
end
|
90
|
+
end
|
91
|
+
end
|
92
|
+
end
|
@@ -45,6 +45,7 @@ module CandidApiClient
|
|
45
45
|
# * :social_security_number (String)
|
46
46
|
# * :biological_sex (CandidApiClient::PreEncounter::Common::Types::Sex)
|
47
47
|
# * :sexual_orientation (CandidApiClient::PreEncounter::Common::Types::SexualOrientation)
|
48
|
+
# * :pronouns (Array<String>)
|
48
49
|
# * :race (CandidApiClient::PreEncounter::Common::Types::Race)
|
49
50
|
# * :ethnicity (CandidApiClient::PreEncounter::Common::Types::Ethnicity)
|
50
51
|
# * :disability_status (CandidApiClient::PreEncounter::Common::Types::DisabilityStatus)
|
@@ -120,7 +121,7 @@ module CandidApiClient
|
|
120
121
|
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
|
121
122
|
# @example
|
122
123
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
123
|
-
# api.pre_encounter.patients.v_1.create(skip_duplicate_check: true, request: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }], other_identifiers: [{ value: "string", system: "string" }], gender: MAN, birth_date: DateTime.parse(2023-01-15), social_security_number: "string", biological_sex: FEMALE, sexual_orientation: HETEROSEXUAL, race: AMERICAN_INDIAN_OR_ALASKA_NATIVE, ethnicity: HISPANIC_OR_LATINO, disability_status: DISABLED, marital_status: ANNULLED, deceased: DateTime.parse(2024-01-15T09:30:00.000Z), multiple_birth: 1, primary_address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }, other_addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], primary_telecom: { value: "string", use: HOME }, other_telecoms: [{ value: "string", use: HOME }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecoms: [{ value: "string", use: HOME }], addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], period: { }, hipaa_authorization: true }], general_practitioners: [{ name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] }, non_insurance_payers: ["string"], non_insurance_payer_associations: [{ id: "string" }], guarantor: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecom: { value: "string", use: HOME }, email: "string", birth_date: DateTime.parse(2023-01-15), address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } } }, self_pay: true, authorizations: [{ payer_id: "string", payer_name: "string", additional_payer_information: { }, authorization_number: "string", cpt_code: "string", apply_for_all_cpt_codes: true, units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] })
|
124
|
+
# api.pre_encounter.patients.v_1.create(skip_duplicate_check: true, request: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }], other_identifiers: [{ value: "string", system: "string" }], gender: MAN, birth_date: DateTime.parse(2023-01-15), social_security_number: "string", biological_sex: FEMALE, sexual_orientation: HETEROSEXUAL, pronouns: ["string"], race: AMERICAN_INDIAN_OR_ALASKA_NATIVE, ethnicity: HISPANIC_OR_LATINO, disability_status: DISABLED, marital_status: ANNULLED, deceased: DateTime.parse(2024-01-15T09:30:00.000Z), multiple_birth: 1, primary_address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }, other_addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], primary_telecom: { value: "string", use: HOME }, other_telecoms: [{ value: "string", use: HOME }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecoms: [{ value: "string", use: HOME }], addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], period: { }, hipaa_authorization: true }], general_practitioners: [{ name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] }, non_insurance_payers: ["string"], non_insurance_payer_associations: [{ id: "string" }], guarantor: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecom: { value: "string", use: HOME }, email: "string", birth_date: DateTime.parse(2023-01-15), address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } } }, self_pay: true, authorizations: [{ payer_id: "string", payer_name: "string", additional_payer_information: { }, authorization_number: "string", cpt_code: "string", apply_for_all_cpt_codes: true, units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] })
|
124
125
|
def create(request:, skip_duplicate_check: nil, request_options: nil)
|
125
126
|
response = @request_client.conn.post do |req|
|
126
127
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
@@ -164,6 +165,7 @@ module CandidApiClient
|
|
164
165
|
# * :social_security_number (String)
|
165
166
|
# * :biological_sex (CandidApiClient::PreEncounter::Common::Types::Sex)
|
166
167
|
# * :sexual_orientation (CandidApiClient::PreEncounter::Common::Types::SexualOrientation)
|
168
|
+
# * :pronouns (Array<String>)
|
167
169
|
# * :race (CandidApiClient::PreEncounter::Common::Types::Race)
|
168
170
|
# * :ethnicity (CandidApiClient::PreEncounter::Common::Types::Ethnicity)
|
169
171
|
# * :disability_status (CandidApiClient::PreEncounter::Common::Types::DisabilityStatus)
|
@@ -239,7 +241,7 @@ module CandidApiClient
|
|
239
241
|
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
|
240
242
|
# @example
|
241
243
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
242
|
-
# api.pre_encounter.patients.v_1.create_with_mrn(skip_duplicate_check: true, request: { mrn: "string", name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }], other_identifiers: [{ value: "string", system: "string" }], gender: MAN, birth_date: DateTime.parse(2023-01-15), social_security_number: "string", biological_sex: FEMALE, sexual_orientation: HETEROSEXUAL, race: AMERICAN_INDIAN_OR_ALASKA_NATIVE, ethnicity: HISPANIC_OR_LATINO, disability_status: DISABLED, marital_status: ANNULLED, deceased: DateTime.parse(2024-01-15T09:30:00.000Z), multiple_birth: 1, primary_address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }, other_addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], primary_telecom: { value: "string", use: HOME }, other_telecoms: [{ value: "string", use: HOME }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecoms: [{ value: "string", use: HOME }], addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], period: { }, hipaa_authorization: true }], general_practitioners: [{ name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] }, non_insurance_payers: ["string"], non_insurance_payer_associations: [{ id: "string" }], guarantor: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecom: { value: "string", use: HOME }, email: "string", birth_date: DateTime.parse(2023-01-15), address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } } }, self_pay: true, authorizations: [{ payer_id: "string", payer_name: "string", additional_payer_information: { }, authorization_number: "string", cpt_code: "string", apply_for_all_cpt_codes: true, units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] })
|
244
|
+
# api.pre_encounter.patients.v_1.create_with_mrn(skip_duplicate_check: true, request: { mrn: "string", name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }], other_identifiers: [{ value: "string", system: "string" }], gender: MAN, birth_date: DateTime.parse(2023-01-15), social_security_number: "string", biological_sex: FEMALE, sexual_orientation: HETEROSEXUAL, pronouns: ["string"], race: AMERICAN_INDIAN_OR_ALASKA_NATIVE, ethnicity: HISPANIC_OR_LATINO, disability_status: DISABLED, marital_status: ANNULLED, deceased: DateTime.parse(2024-01-15T09:30:00.000Z), multiple_birth: 1, primary_address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }, other_addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], primary_telecom: { value: "string", use: HOME }, other_telecoms: [{ value: "string", use: HOME }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecoms: [{ value: "string", use: HOME }], addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], period: { }, hipaa_authorization: true }], general_practitioners: [{ name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] }, non_insurance_payers: ["string"], non_insurance_payer_associations: [{ id: "string" }], guarantor: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecom: { value: "string", use: HOME }, email: "string", birth_date: DateTime.parse(2023-01-15), address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } } }, self_pay: true, authorizations: [{ payer_id: "string", payer_name: "string", additional_payer_information: { }, authorization_number: "string", cpt_code: "string", apply_for_all_cpt_codes: true, units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] })
|
243
245
|
def create_with_mrn(request:, skip_duplicate_check: nil, request_options: nil)
|
244
246
|
response = @request_client.conn.post do |req|
|
245
247
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
@@ -408,6 +410,7 @@ module CandidApiClient
|
|
408
410
|
# * :social_security_number (String)
|
409
411
|
# * :biological_sex (CandidApiClient::PreEncounter::Common::Types::Sex)
|
410
412
|
# * :sexual_orientation (CandidApiClient::PreEncounter::Common::Types::SexualOrientation)
|
413
|
+
# * :pronouns (Array<String>)
|
411
414
|
# * :race (CandidApiClient::PreEncounter::Common::Types::Race)
|
412
415
|
# * :ethnicity (CandidApiClient::PreEncounter::Common::Types::Ethnicity)
|
413
416
|
# * :disability_status (CandidApiClient::PreEncounter::Common::Types::DisabilityStatus)
|
@@ -486,7 +489,7 @@ module CandidApiClient
|
|
486
489
|
# api.pre_encounter.patients.v_1.update(
|
487
490
|
# id: "string",
|
488
491
|
# version: "string",
|
489
|
-
# request: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }], other_identifiers: [{ value: "string", system: "string" }], gender: MAN, birth_date: DateTime.parse(2023-01-15), social_security_number: "string", biological_sex: FEMALE, sexual_orientation: HETEROSEXUAL, race: AMERICAN_INDIAN_OR_ALASKA_NATIVE, ethnicity: HISPANIC_OR_LATINO, disability_status: DISABLED, marital_status: ANNULLED, deceased: DateTime.parse(2024-01-15T09:30:00.000Z), multiple_birth: 1, primary_address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }, other_addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], primary_telecom: { value: "string", use: HOME }, other_telecoms: [{ value: "string", use: HOME }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecoms: [{ value: "string", use: HOME }], addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], period: { }, hipaa_authorization: true }], general_practitioners: [{ name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] }, non_insurance_payers: ["string"], non_insurance_payer_associations: [{ id: "string" }], guarantor: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecom: { value: "string", use: HOME }, email: "string", birth_date: DateTime.parse(2023-01-15), address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } } }, self_pay: true, authorizations: [{ payer_id: "string", payer_name: "string", additional_payer_information: { }, authorization_number: "string", cpt_code: "string", apply_for_all_cpt_codes: true, units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] }
|
492
|
+
# request: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }], other_identifiers: [{ value: "string", system: "string" }], gender: MAN, birth_date: DateTime.parse(2023-01-15), social_security_number: "string", biological_sex: FEMALE, sexual_orientation: HETEROSEXUAL, pronouns: ["string"], race: AMERICAN_INDIAN_OR_ALASKA_NATIVE, ethnicity: HISPANIC_OR_LATINO, disability_status: DISABLED, marital_status: ANNULLED, deceased: DateTime.parse(2024-01-15T09:30:00.000Z), multiple_birth: 1, primary_address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }, other_addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], primary_telecom: { value: "string", use: HOME }, other_telecoms: [{ value: "string", use: HOME }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecoms: [{ value: "string", use: HOME }], addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], period: { }, hipaa_authorization: true }], general_practitioners: [{ name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] }, non_insurance_payers: ["string"], non_insurance_payer_associations: [{ id: "string" }], guarantor: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecom: { value: "string", use: HOME }, email: "string", birth_date: DateTime.parse(2023-01-15), address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } } }, self_pay: true, authorizations: [{ payer_id: "string", payer_name: "string", additional_payer_information: { }, authorization_number: "string", cpt_code: "string", apply_for_all_cpt_codes: true, units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] }
|
490
493
|
# )
|
491
494
|
def update(id:, version:, request:, request_options: nil)
|
492
495
|
response = @request_client.conn.put do |req|
|
@@ -647,6 +650,7 @@ module CandidApiClient
|
|
647
650
|
# * :social_security_number (String)
|
648
651
|
# * :biological_sex (CandidApiClient::PreEncounter::Common::Types::Sex)
|
649
652
|
# * :sexual_orientation (CandidApiClient::PreEncounter::Common::Types::SexualOrientation)
|
653
|
+
# * :pronouns (Array<String>)
|
650
654
|
# * :race (CandidApiClient::PreEncounter::Common::Types::Race)
|
651
655
|
# * :ethnicity (CandidApiClient::PreEncounter::Common::Types::Ethnicity)
|
652
656
|
# * :disability_status (CandidApiClient::PreEncounter::Common::Types::DisabilityStatus)
|
@@ -722,7 +726,7 @@ module CandidApiClient
|
|
722
726
|
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
|
723
727
|
# @example
|
724
728
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
725
|
-
# api.pre_encounter.patients.v_1.create(skip_duplicate_check: true, request: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }], other_identifiers: [{ value: "string", system: "string" }], gender: MAN, birth_date: DateTime.parse(2023-01-15), social_security_number: "string", biological_sex: FEMALE, sexual_orientation: HETEROSEXUAL, race: AMERICAN_INDIAN_OR_ALASKA_NATIVE, ethnicity: HISPANIC_OR_LATINO, disability_status: DISABLED, marital_status: ANNULLED, deceased: DateTime.parse(2024-01-15T09:30:00.000Z), multiple_birth: 1, primary_address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }, other_addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], primary_telecom: { value: "string", use: HOME }, other_telecoms: [{ value: "string", use: HOME }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecoms: [{ value: "string", use: HOME }], addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], period: { }, hipaa_authorization: true }], general_practitioners: [{ name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] }, non_insurance_payers: ["string"], non_insurance_payer_associations: [{ id: "string" }], guarantor: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecom: { value: "string", use: HOME }, email: "string", birth_date: DateTime.parse(2023-01-15), address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } } }, self_pay: true, authorizations: [{ payer_id: "string", payer_name: "string", additional_payer_information: { }, authorization_number: "string", cpt_code: "string", apply_for_all_cpt_codes: true, units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] })
|
729
|
+
# api.pre_encounter.patients.v_1.create(skip_duplicate_check: true, request: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }], other_identifiers: [{ value: "string", system: "string" }], gender: MAN, birth_date: DateTime.parse(2023-01-15), social_security_number: "string", biological_sex: FEMALE, sexual_orientation: HETEROSEXUAL, pronouns: ["string"], race: AMERICAN_INDIAN_OR_ALASKA_NATIVE, ethnicity: HISPANIC_OR_LATINO, disability_status: DISABLED, marital_status: ANNULLED, deceased: DateTime.parse(2024-01-15T09:30:00.000Z), multiple_birth: 1, primary_address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }, other_addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], primary_telecom: { value: "string", use: HOME }, other_telecoms: [{ value: "string", use: HOME }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecoms: [{ value: "string", use: HOME }], addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], period: { }, hipaa_authorization: true }], general_practitioners: [{ name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] }, non_insurance_payers: ["string"], non_insurance_payer_associations: [{ id: "string" }], guarantor: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecom: { value: "string", use: HOME }, email: "string", birth_date: DateTime.parse(2023-01-15), address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } } }, self_pay: true, authorizations: [{ payer_id: "string", payer_name: "string", additional_payer_information: { }, authorization_number: "string", cpt_code: "string", apply_for_all_cpt_codes: true, units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] })
|
726
730
|
def create(request:, skip_duplicate_check: nil, request_options: nil)
|
727
731
|
Async do
|
728
732
|
response = @request_client.conn.post do |req|
|
@@ -768,6 +772,7 @@ module CandidApiClient
|
|
768
772
|
# * :social_security_number (String)
|
769
773
|
# * :biological_sex (CandidApiClient::PreEncounter::Common::Types::Sex)
|
770
774
|
# * :sexual_orientation (CandidApiClient::PreEncounter::Common::Types::SexualOrientation)
|
775
|
+
# * :pronouns (Array<String>)
|
771
776
|
# * :race (CandidApiClient::PreEncounter::Common::Types::Race)
|
772
777
|
# * :ethnicity (CandidApiClient::PreEncounter::Common::Types::Ethnicity)
|
773
778
|
# * :disability_status (CandidApiClient::PreEncounter::Common::Types::DisabilityStatus)
|
@@ -843,7 +848,7 @@ module CandidApiClient
|
|
843
848
|
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
|
844
849
|
# @example
|
845
850
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
846
|
-
# api.pre_encounter.patients.v_1.create_with_mrn(skip_duplicate_check: true, request: { mrn: "string", name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }], other_identifiers: [{ value: "string", system: "string" }], gender: MAN, birth_date: DateTime.parse(2023-01-15), social_security_number: "string", biological_sex: FEMALE, sexual_orientation: HETEROSEXUAL, race: AMERICAN_INDIAN_OR_ALASKA_NATIVE, ethnicity: HISPANIC_OR_LATINO, disability_status: DISABLED, marital_status: ANNULLED, deceased: DateTime.parse(2024-01-15T09:30:00.000Z), multiple_birth: 1, primary_address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }, other_addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], primary_telecom: { value: "string", use: HOME }, other_telecoms: [{ value: "string", use: HOME }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecoms: [{ value: "string", use: HOME }], addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], period: { }, hipaa_authorization: true }], general_practitioners: [{ name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] }, non_insurance_payers: ["string"], non_insurance_payer_associations: [{ id: "string" }], guarantor: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecom: { value: "string", use: HOME }, email: "string", birth_date: DateTime.parse(2023-01-15), address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } } }, self_pay: true, authorizations: [{ payer_id: "string", payer_name: "string", additional_payer_information: { }, authorization_number: "string", cpt_code: "string", apply_for_all_cpt_codes: true, units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] })
|
851
|
+
# api.pre_encounter.patients.v_1.create_with_mrn(skip_duplicate_check: true, request: { mrn: "string", name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }], other_identifiers: [{ value: "string", system: "string" }], gender: MAN, birth_date: DateTime.parse(2023-01-15), social_security_number: "string", biological_sex: FEMALE, sexual_orientation: HETEROSEXUAL, pronouns: ["string"], race: AMERICAN_INDIAN_OR_ALASKA_NATIVE, ethnicity: HISPANIC_OR_LATINO, disability_status: DISABLED, marital_status: ANNULLED, deceased: DateTime.parse(2024-01-15T09:30:00.000Z), multiple_birth: 1, primary_address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }, other_addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], primary_telecom: { value: "string", use: HOME }, other_telecoms: [{ value: "string", use: HOME }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecoms: [{ value: "string", use: HOME }], addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], period: { }, hipaa_authorization: true }], general_practitioners: [{ name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] }, non_insurance_payers: ["string"], non_insurance_payer_associations: [{ id: "string" }], guarantor: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecom: { value: "string", use: HOME }, email: "string", birth_date: DateTime.parse(2023-01-15), address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } } }, self_pay: true, authorizations: [{ payer_id: "string", payer_name: "string", additional_payer_information: { }, authorization_number: "string", cpt_code: "string", apply_for_all_cpt_codes: true, units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] })
|
847
852
|
def create_with_mrn(request:, skip_duplicate_check: nil, request_options: nil)
|
848
853
|
Async do
|
849
854
|
response = @request_client.conn.post do |req|
|
@@ -1022,6 +1027,7 @@ module CandidApiClient
|
|
1022
1027
|
# * :social_security_number (String)
|
1023
1028
|
# * :biological_sex (CandidApiClient::PreEncounter::Common::Types::Sex)
|
1024
1029
|
# * :sexual_orientation (CandidApiClient::PreEncounter::Common::Types::SexualOrientation)
|
1030
|
+
# * :pronouns (Array<String>)
|
1025
1031
|
# * :race (CandidApiClient::PreEncounter::Common::Types::Race)
|
1026
1032
|
# * :ethnicity (CandidApiClient::PreEncounter::Common::Types::Ethnicity)
|
1027
1033
|
# * :disability_status (CandidApiClient::PreEncounter::Common::Types::DisabilityStatus)
|
@@ -1100,7 +1106,7 @@ module CandidApiClient
|
|
1100
1106
|
# api.pre_encounter.patients.v_1.update(
|
1101
1107
|
# id: "string",
|
1102
1108
|
# version: "string",
|
1103
|
-
# request: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }], other_identifiers: [{ value: "string", system: "string" }], gender: MAN, birth_date: DateTime.parse(2023-01-15), social_security_number: "string", biological_sex: FEMALE, sexual_orientation: HETEROSEXUAL, race: AMERICAN_INDIAN_OR_ALASKA_NATIVE, ethnicity: HISPANIC_OR_LATINO, disability_status: DISABLED, marital_status: ANNULLED, deceased: DateTime.parse(2024-01-15T09:30:00.000Z), multiple_birth: 1, primary_address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }, other_addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], primary_telecom: { value: "string", use: HOME }, other_telecoms: [{ value: "string", use: HOME }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecoms: [{ value: "string", use: HOME }], addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], period: { }, hipaa_authorization: true }], general_practitioners: [{ name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] }, non_insurance_payers: ["string"], non_insurance_payer_associations: [{ id: "string" }], guarantor: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecom: { value: "string", use: HOME }, email: "string", birth_date: DateTime.parse(2023-01-15), address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } } }, self_pay: true, authorizations: [{ payer_id: "string", payer_name: "string", additional_payer_information: { }, authorization_number: "string", cpt_code: "string", apply_for_all_cpt_codes: true, units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] }
|
1109
|
+
# request: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }], other_identifiers: [{ value: "string", system: "string" }], gender: MAN, birth_date: DateTime.parse(2023-01-15), social_security_number: "string", biological_sex: FEMALE, sexual_orientation: HETEROSEXUAL, pronouns: ["string"], race: AMERICAN_INDIAN_OR_ALASKA_NATIVE, ethnicity: HISPANIC_OR_LATINO, disability_status: DISABLED, marital_status: ANNULLED, deceased: DateTime.parse(2024-01-15T09:30:00.000Z), multiple_birth: 1, primary_address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }, other_addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], primary_telecom: { value: "string", use: HOME }, other_telecoms: [{ value: "string", use: HOME }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecoms: [{ value: "string", use: HOME }], addresses: [{ use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } }], period: { }, hipaa_authorization: true }], general_practitioners: [{ name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] }, non_insurance_payers: ["string"], non_insurance_payer_associations: [{ id: "string" }], guarantor: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, telecom: { value: "string", use: HOME }, email: "string", birth_date: DateTime.parse(2023-01-15), address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } } }, self_pay: true, authorizations: [{ payer_id: "string", payer_name: "string", additional_payer_information: { }, authorization_number: "string", cpt_code: "string", apply_for_all_cpt_codes: true, units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string", fax: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] }
|
1104
1110
|
# )
|
1105
1111
|
def update(id:, version:, request:, request_options: nil)
|
1106
1112
|
Async do
|
@@ -49,6 +49,8 @@ module CandidApiClient
|
|
49
49
|
attr_reader :biological_sex
|
50
50
|
# @return [CandidApiClient::PreEncounter::Common::Types::SexualOrientation] The sexual orientation of the patient.
|
51
51
|
attr_reader :sexual_orientation
|
52
|
+
# @return [Array<String>] The pronouns of the patient.
|
53
|
+
attr_reader :pronouns
|
52
54
|
# @return [CandidApiClient::PreEncounter::Common::Types::Race]
|
53
55
|
attr_reader :race
|
54
56
|
# @return [CandidApiClient::PreEncounter::Common::Types::Ethnicity]
|
@@ -125,6 +127,7 @@ module CandidApiClient
|
|
125
127
|
# AdministrativeGender
|
126
128
|
# https://www.hl7.org/fhir/valueset-administrative-gender.html
|
127
129
|
# @param sexual_orientation [CandidApiClient::PreEncounter::Common::Types::SexualOrientation] The sexual orientation of the patient.
|
130
|
+
# @param pronouns [Array<String>] The pronouns of the patient.
|
128
131
|
# @param race [CandidApiClient::PreEncounter::Common::Types::Race]
|
129
132
|
# @param ethnicity [CandidApiClient::PreEncounter::Common::Types::Ethnicity]
|
130
133
|
# @param disability_status [CandidApiClient::PreEncounter::Common::Types::DisabilityStatus]
|
@@ -158,7 +161,7 @@ module CandidApiClient
|
|
158
161
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
159
162
|
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatient]
|
160
163
|
def initialize(name:, other_names:, birth_date:, biological_sex:, primary_address:, other_addresses:, primary_telecom:, other_telecoms:, contacts:, general_practitioners:, filing_order:, other_identifiers: OMIT, gender: OMIT,
|
161
|
-
social_security_number: OMIT, sexual_orientation: OMIT, race: OMIT, ethnicity: OMIT, disability_status: OMIT, marital_status: OMIT, deceased: OMIT, multiple_birth: OMIT, email: OMIT, electronic_communication_opt_in: OMIT, photo: OMIT, language: OMIT, external_provenance: OMIT, non_insurance_payers: OMIT, non_insurance_payer_associations: OMIT, guarantor: OMIT, self_pay: OMIT, authorizations: OMIT, referrals: OMIT, primary_service_facility_id: OMIT, do_not_invoice_reason: OMIT, note_ids: OMIT, tag_ids: OMIT, additional_properties: nil)
|
164
|
+
social_security_number: OMIT, sexual_orientation: OMIT, pronouns: OMIT, race: OMIT, ethnicity: OMIT, disability_status: OMIT, marital_status: OMIT, deceased: OMIT, multiple_birth: OMIT, email: OMIT, electronic_communication_opt_in: OMIT, photo: OMIT, language: OMIT, external_provenance: OMIT, non_insurance_payers: OMIT, non_insurance_payer_associations: OMIT, guarantor: OMIT, self_pay: OMIT, authorizations: OMIT, referrals: OMIT, primary_service_facility_id: OMIT, do_not_invoice_reason: OMIT, note_ids: OMIT, tag_ids: OMIT, additional_properties: nil)
|
162
165
|
@name = name
|
163
166
|
@other_names = other_names
|
164
167
|
@other_identifiers = other_identifiers if other_identifiers != OMIT
|
@@ -167,6 +170,7 @@ module CandidApiClient
|
|
167
170
|
@social_security_number = social_security_number if social_security_number != OMIT
|
168
171
|
@biological_sex = biological_sex
|
169
172
|
@sexual_orientation = sexual_orientation if sexual_orientation != OMIT
|
173
|
+
@pronouns = pronouns if pronouns != OMIT
|
170
174
|
@race = race if race != OMIT
|
171
175
|
@ethnicity = ethnicity if ethnicity != OMIT
|
172
176
|
@disability_status = disability_status if disability_status != OMIT
|
@@ -209,6 +213,7 @@ module CandidApiClient
|
|
209
213
|
"social_security_number": social_security_number,
|
210
214
|
"biological_sex": biological_sex,
|
211
215
|
"sexual_orientation": sexual_orientation,
|
216
|
+
"pronouns": pronouns,
|
212
217
|
"race": race,
|
213
218
|
"ethnicity": ethnicity,
|
214
219
|
"disability_status": disability_status,
|
@@ -268,6 +273,7 @@ module CandidApiClient
|
|
268
273
|
social_security_number = struct["social_security_number"]
|
269
274
|
biological_sex = struct["biological_sex"]
|
270
275
|
sexual_orientation = struct["sexual_orientation"]
|
276
|
+
pronouns = struct["pronouns"]
|
271
277
|
race = struct["race"]
|
272
278
|
ethnicity = struct["ethnicity"]
|
273
279
|
disability_status = struct["disability_status"]
|
@@ -351,6 +357,7 @@ module CandidApiClient
|
|
351
357
|
social_security_number: social_security_number,
|
352
358
|
biological_sex: biological_sex,
|
353
359
|
sexual_orientation: sexual_orientation,
|
360
|
+
pronouns: pronouns,
|
354
361
|
race: race,
|
355
362
|
ethnicity: ethnicity,
|
356
363
|
disability_status: disability_status,
|
@@ -405,6 +412,7 @@ module CandidApiClient
|
|
405
412
|
obj.social_security_number&.is_a?(String) != false || raise("Passed value for field obj.social_security_number is not the expected type, validation failed.")
|
406
413
|
obj.biological_sex.is_a?(CandidApiClient::PreEncounter::Common::Types::Sex) != false || raise("Passed value for field obj.biological_sex is not the expected type, validation failed.")
|
407
414
|
obj.sexual_orientation&.is_a?(CandidApiClient::PreEncounter::Common::Types::SexualOrientation) != false || raise("Passed value for field obj.sexual_orientation is not the expected type, validation failed.")
|
415
|
+
obj.pronouns&.is_a?(Array) != false || raise("Passed value for field obj.pronouns is not the expected type, validation failed.")
|
408
416
|
obj.race&.is_a?(CandidApiClient::PreEncounter::Common::Types::Race) != false || raise("Passed value for field obj.race is not the expected type, validation failed.")
|
409
417
|
obj.ethnicity&.is_a?(CandidApiClient::PreEncounter::Common::Types::Ethnicity) != false || raise("Passed value for field obj.ethnicity is not the expected type, validation failed.")
|
410
418
|
obj.disability_status&.is_a?(CandidApiClient::PreEncounter::Common::Types::DisabilityStatus) != false || raise("Passed value for field obj.disability_status is not the expected type, validation failed.")
|
@@ -50,6 +50,8 @@ module CandidApiClient
|
|
50
50
|
attr_reader :biological_sex
|
51
51
|
# @return [CandidApiClient::PreEncounter::Common::Types::SexualOrientation] The sexual orientation of the patient.
|
52
52
|
attr_reader :sexual_orientation
|
53
|
+
# @return [Array<String>] The pronouns of the patient.
|
54
|
+
attr_reader :pronouns
|
53
55
|
# @return [CandidApiClient::PreEncounter::Common::Types::Race]
|
54
56
|
attr_reader :race
|
55
57
|
# @return [CandidApiClient::PreEncounter::Common::Types::Ethnicity]
|
@@ -127,6 +129,7 @@ module CandidApiClient
|
|
127
129
|
# AdministrativeGender
|
128
130
|
# https://www.hl7.org/fhir/valueset-administrative-gender.html
|
129
131
|
# @param sexual_orientation [CandidApiClient::PreEncounter::Common::Types::SexualOrientation] The sexual orientation of the patient.
|
132
|
+
# @param pronouns [Array<String>] The pronouns of the patient.
|
130
133
|
# @param race [CandidApiClient::PreEncounter::Common::Types::Race]
|
131
134
|
# @param ethnicity [CandidApiClient::PreEncounter::Common::Types::Ethnicity]
|
132
135
|
# @param disability_status [CandidApiClient::PreEncounter::Common::Types::DisabilityStatus]
|
@@ -160,7 +163,7 @@ module CandidApiClient
|
|
160
163
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
161
164
|
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatientWithMrn]
|
162
165
|
def initialize(mrn:, name:, other_names:, birth_date:, biological_sex:, primary_address:, other_addresses:, primary_telecom:, other_telecoms:, contacts:, general_practitioners:, filing_order:, other_identifiers: OMIT, gender: OMIT,
|
163
|
-
social_security_number: OMIT, sexual_orientation: OMIT, race: OMIT, ethnicity: OMIT, disability_status: OMIT, marital_status: OMIT, deceased: OMIT, multiple_birth: OMIT, email: OMIT, electronic_communication_opt_in: OMIT, photo: OMIT, language: OMIT, external_provenance: OMIT, non_insurance_payers: OMIT, non_insurance_payer_associations: OMIT, guarantor: OMIT, self_pay: OMIT, authorizations: OMIT, referrals: OMIT, primary_service_facility_id: OMIT, do_not_invoice_reason: OMIT, note_ids: OMIT, tag_ids: OMIT, additional_properties: nil)
|
166
|
+
social_security_number: OMIT, sexual_orientation: OMIT, pronouns: OMIT, race: OMIT, ethnicity: OMIT, disability_status: OMIT, marital_status: OMIT, deceased: OMIT, multiple_birth: OMIT, email: OMIT, electronic_communication_opt_in: OMIT, photo: OMIT, language: OMIT, external_provenance: OMIT, non_insurance_payers: OMIT, non_insurance_payer_associations: OMIT, guarantor: OMIT, self_pay: OMIT, authorizations: OMIT, referrals: OMIT, primary_service_facility_id: OMIT, do_not_invoice_reason: OMIT, note_ids: OMIT, tag_ids: OMIT, additional_properties: nil)
|
164
167
|
@mrn = mrn
|
165
168
|
@name = name
|
166
169
|
@other_names = other_names
|
@@ -170,6 +173,7 @@ module CandidApiClient
|
|
170
173
|
@social_security_number = social_security_number if social_security_number != OMIT
|
171
174
|
@biological_sex = biological_sex
|
172
175
|
@sexual_orientation = sexual_orientation if sexual_orientation != OMIT
|
176
|
+
@pronouns = pronouns if pronouns != OMIT
|
173
177
|
@race = race if race != OMIT
|
174
178
|
@ethnicity = ethnicity if ethnicity != OMIT
|
175
179
|
@disability_status = disability_status if disability_status != OMIT
|
@@ -213,6 +217,7 @@ module CandidApiClient
|
|
213
217
|
"social_security_number": social_security_number,
|
214
218
|
"biological_sex": biological_sex,
|
215
219
|
"sexual_orientation": sexual_orientation,
|
220
|
+
"pronouns": pronouns,
|
216
221
|
"race": race,
|
217
222
|
"ethnicity": ethnicity,
|
218
223
|
"disability_status": disability_status,
|
@@ -273,6 +278,7 @@ module CandidApiClient
|
|
273
278
|
social_security_number = struct["social_security_number"]
|
274
279
|
biological_sex = struct["biological_sex"]
|
275
280
|
sexual_orientation = struct["sexual_orientation"]
|
281
|
+
pronouns = struct["pronouns"]
|
276
282
|
race = struct["race"]
|
277
283
|
ethnicity = struct["ethnicity"]
|
278
284
|
disability_status = struct["disability_status"]
|
@@ -357,6 +363,7 @@ module CandidApiClient
|
|
357
363
|
social_security_number: social_security_number,
|
358
364
|
biological_sex: biological_sex,
|
359
365
|
sexual_orientation: sexual_orientation,
|
366
|
+
pronouns: pronouns,
|
360
367
|
race: race,
|
361
368
|
ethnicity: ethnicity,
|
362
369
|
disability_status: disability_status,
|
@@ -412,6 +419,7 @@ module CandidApiClient
|
|
412
419
|
obj.social_security_number&.is_a?(String) != false || raise("Passed value for field obj.social_security_number is not the expected type, validation failed.")
|
413
420
|
obj.biological_sex.is_a?(CandidApiClient::PreEncounter::Common::Types::Sex) != false || raise("Passed value for field obj.biological_sex is not the expected type, validation failed.")
|
414
421
|
obj.sexual_orientation&.is_a?(CandidApiClient::PreEncounter::Common::Types::SexualOrientation) != false || raise("Passed value for field obj.sexual_orientation is not the expected type, validation failed.")
|
422
|
+
obj.pronouns&.is_a?(Array) != false || raise("Passed value for field obj.pronouns is not the expected type, validation failed.")
|
415
423
|
obj.race&.is_a?(CandidApiClient::PreEncounter::Common::Types::Race) != false || raise("Passed value for field obj.race is not the expected type, validation failed.")
|
416
424
|
obj.ethnicity&.is_a?(CandidApiClient::PreEncounter::Common::Types::Ethnicity) != false || raise("Passed value for field obj.ethnicity is not the expected type, validation failed.")
|
417
425
|
obj.disability_status&.is_a?(CandidApiClient::PreEncounter::Common::Types::DisabilityStatus) != false || raise("Passed value for field obj.disability_status is not the expected type, validation failed.")
|
@@ -68,6 +68,8 @@ module CandidApiClient
|
|
68
68
|
attr_reader :biological_sex
|
69
69
|
# @return [CandidApiClient::PreEncounter::Common::Types::SexualOrientation] The sexual orientation of the patient.
|
70
70
|
attr_reader :sexual_orientation
|
71
|
+
# @return [Array<String>] The pronouns of the patient.
|
72
|
+
attr_reader :pronouns
|
71
73
|
# @return [CandidApiClient::PreEncounter::Common::Types::Race]
|
72
74
|
attr_reader :race
|
73
75
|
# @return [CandidApiClient::PreEncounter::Common::Types::Ethnicity]
|
@@ -156,6 +158,7 @@ module CandidApiClient
|
|
156
158
|
# AdministrativeGender
|
157
159
|
# https://www.hl7.org/fhir/valueset-administrative-gender.html
|
158
160
|
# @param sexual_orientation [CandidApiClient::PreEncounter::Common::Types::SexualOrientation] The sexual orientation of the patient.
|
161
|
+
# @param pronouns [Array<String>] The pronouns of the patient.
|
159
162
|
# @param race [CandidApiClient::PreEncounter::Common::Types::Race]
|
160
163
|
# @param ethnicity [CandidApiClient::PreEncounter::Common::Types::Ethnicity]
|
161
164
|
# @param disability_status [CandidApiClient::PreEncounter::Common::Types::DisabilityStatus]
|
@@ -189,7 +192,7 @@ module CandidApiClient
|
|
189
192
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
190
193
|
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
|
191
194
|
def initialize(id:, mrn:, organization_id:, deactivated:, version:, updated_at:, updating_user_id:, name:,
|
192
|
-
other_names:, birth_date:, biological_sex:, primary_address:, other_addresses:, primary_telecom:, other_telecoms:, contacts:, general_practitioners:, filing_order:, other_identifiers: OMIT, gender: OMIT, social_security_number: OMIT, sexual_orientation: OMIT, race: OMIT, ethnicity: OMIT, disability_status: OMIT, marital_status: OMIT, deceased: OMIT, multiple_birth: OMIT, email: OMIT, electronic_communication_opt_in: OMIT, photo: OMIT, language: OMIT, external_provenance: OMIT, non_insurance_payers: OMIT, non_insurance_payer_associations: OMIT, guarantor: OMIT, self_pay: OMIT, authorizations: OMIT, referrals: OMIT, primary_service_facility_id: OMIT, do_not_invoice_reason: OMIT, note_ids: OMIT, tag_ids: OMIT, additional_properties: nil)
|
195
|
+
other_names:, birth_date:, biological_sex:, primary_address:, other_addresses:, primary_telecom:, other_telecoms:, contacts:, general_practitioners:, filing_order:, other_identifiers: OMIT, gender: OMIT, social_security_number: OMIT, sexual_orientation: OMIT, pronouns: OMIT, race: OMIT, ethnicity: OMIT, disability_status: OMIT, marital_status: OMIT, deceased: OMIT, multiple_birth: OMIT, email: OMIT, electronic_communication_opt_in: OMIT, photo: OMIT, language: OMIT, external_provenance: OMIT, non_insurance_payers: OMIT, non_insurance_payer_associations: OMIT, guarantor: OMIT, self_pay: OMIT, authorizations: OMIT, referrals: OMIT, primary_service_facility_id: OMIT, do_not_invoice_reason: OMIT, note_ids: OMIT, tag_ids: OMIT, additional_properties: nil)
|
193
196
|
@id = id
|
194
197
|
@mrn = mrn
|
195
198
|
@organization_id = organization_id
|
@@ -205,6 +208,7 @@ module CandidApiClient
|
|
205
208
|
@social_security_number = social_security_number if social_security_number != OMIT
|
206
209
|
@biological_sex = biological_sex
|
207
210
|
@sexual_orientation = sexual_orientation if sexual_orientation != OMIT
|
211
|
+
@pronouns = pronouns if pronouns != OMIT
|
208
212
|
@race = race if race != OMIT
|
209
213
|
@ethnicity = ethnicity if ethnicity != OMIT
|
210
214
|
@disability_status = disability_status if disability_status != OMIT
|
@@ -254,6 +258,7 @@ module CandidApiClient
|
|
254
258
|
"social_security_number": social_security_number,
|
255
259
|
"biological_sex": biological_sex,
|
256
260
|
"sexual_orientation": sexual_orientation,
|
261
|
+
"pronouns": pronouns,
|
257
262
|
"race": race,
|
258
263
|
"ethnicity": ethnicity,
|
259
264
|
"disability_status": disability_status,
|
@@ -320,6 +325,7 @@ module CandidApiClient
|
|
320
325
|
social_security_number = struct["social_security_number"]
|
321
326
|
biological_sex = struct["biological_sex"]
|
322
327
|
sexual_orientation = struct["sexual_orientation"]
|
328
|
+
pronouns = struct["pronouns"]
|
323
329
|
race = struct["race"]
|
324
330
|
ethnicity = struct["ethnicity"]
|
325
331
|
disability_status = struct["disability_status"]
|
@@ -410,6 +416,7 @@ module CandidApiClient
|
|
410
416
|
social_security_number: social_security_number,
|
411
417
|
biological_sex: biological_sex,
|
412
418
|
sexual_orientation: sexual_orientation,
|
419
|
+
pronouns: pronouns,
|
413
420
|
race: race,
|
414
421
|
ethnicity: ethnicity,
|
415
422
|
disability_status: disability_status,
|
@@ -471,6 +478,7 @@ module CandidApiClient
|
|
471
478
|
obj.social_security_number&.is_a?(String) != false || raise("Passed value for field obj.social_security_number is not the expected type, validation failed.")
|
472
479
|
obj.biological_sex.is_a?(CandidApiClient::PreEncounter::Common::Types::Sex) != false || raise("Passed value for field obj.biological_sex is not the expected type, validation failed.")
|
473
480
|
obj.sexual_orientation&.is_a?(CandidApiClient::PreEncounter::Common::Types::SexualOrientation) != false || raise("Passed value for field obj.sexual_orientation is not the expected type, validation failed.")
|
481
|
+
obj.pronouns&.is_a?(Array) != false || raise("Passed value for field obj.pronouns is not the expected type, validation failed.")
|
474
482
|
obj.race&.is_a?(CandidApiClient::PreEncounter::Common::Types::Race) != false || raise("Passed value for field obj.race is not the expected type, validation failed.")
|
475
483
|
obj.ethnicity&.is_a?(CandidApiClient::PreEncounter::Common::Types::Ethnicity) != false || raise("Passed value for field obj.ethnicity is not the expected type, validation failed.")
|
476
484
|
obj.disability_status&.is_a?(CandidApiClient::PreEncounter::Common::Types::DisabilityStatus) != false || raise("Passed value for field obj.disability_status is not the expected type, validation failed.")
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "../../requests"
|
4
|
+
require_relative "v_1/client"
|
5
|
+
|
6
|
+
module CandidApiClient
|
7
|
+
module Superbills
|
8
|
+
class Client
|
9
|
+
# @return [CandidApiClient::Superbills::V1::V1Client]
|
10
|
+
attr_reader :v_1
|
11
|
+
|
12
|
+
# @param request_client [CandidApiClient::RequestClient]
|
13
|
+
# @return [CandidApiClient::Superbills::Client]
|
14
|
+
def initialize(request_client:)
|
15
|
+
@v_1 = CandidApiClient::Superbills::V1::V1Client.new(request_client: request_client)
|
16
|
+
end
|
17
|
+
end
|
18
|
+
|
19
|
+
class AsyncClient
|
20
|
+
# @return [CandidApiClient::Superbills::V1::AsyncV1Client]
|
21
|
+
attr_reader :v_1
|
22
|
+
|
23
|
+
# @param request_client [CandidApiClient::AsyncRequestClient]
|
24
|
+
# @return [CandidApiClient::Superbills::AsyncClient]
|
25
|
+
def initialize(request_client:)
|
26
|
+
@v_1 = CandidApiClient::Superbills::V1::AsyncV1Client.new(request_client: request_client)
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
@@ -0,0 +1,125 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "../../../requests"
|
4
|
+
require "date"
|
5
|
+
require_relative "../../commons/types/street_address_short_zip"
|
6
|
+
require_relative "types/superbill_response"
|
7
|
+
require "async"
|
8
|
+
|
9
|
+
module CandidApiClient
|
10
|
+
module Superbills
|
11
|
+
module V1
|
12
|
+
class V1Client
|
13
|
+
# @return [CandidApiClient::RequestClient]
|
14
|
+
attr_reader :request_client
|
15
|
+
|
16
|
+
# @param request_client [CandidApiClient::RequestClient]
|
17
|
+
# @return [CandidApiClient::Superbills::V1::V1Client]
|
18
|
+
def initialize(request_client:)
|
19
|
+
@request_client = request_client
|
20
|
+
end
|
21
|
+
|
22
|
+
# @param patient_external_id [String] Empty string not allowed
|
23
|
+
# @param date_range_min [Date] Minimum (inclusive) date selected for the superbill
|
24
|
+
# @param date_range_max [Date] Maximum (inclusive) date selected for the superbill
|
25
|
+
# @param pay_to_address [Hash] Address that will be displayed on the superbill as the 'Pay to' Address. If not
|
26
|
+
# provided this value will be set from available encounter data.Request of type CandidApiClient::Commons::Types::StreetAddressShortZip, as a Hash
|
27
|
+
# * :zip_plus_four_code (String)
|
28
|
+
# * :address_1 (String)
|
29
|
+
# * :address_2 (String)
|
30
|
+
# * :city (String)
|
31
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
32
|
+
# * :zip_code (String)
|
33
|
+
# @param request_options [CandidApiClient::RequestOptions]
|
34
|
+
# @return [CandidApiClient::Superbills::V1::Types::SuperbillResponse]
|
35
|
+
# @example
|
36
|
+
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
37
|
+
# api.superbills.v_1.create_superbill(
|
38
|
+
# patient_external_id: "string",
|
39
|
+
# date_range_min: DateTime.parse(2023-01-15),
|
40
|
+
# date_range_max: DateTime.parse(2023-01-15),
|
41
|
+
# pay_to_address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }
|
42
|
+
# )
|
43
|
+
def create_superbill(patient_external_id:, date_range_min:, date_range_max:, pay_to_address: nil,
|
44
|
+
request_options: nil)
|
45
|
+
response = @request_client.conn.post do |req|
|
46
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
47
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
48
|
+
req.headers = {
|
49
|
+
**(req.headers || {}),
|
50
|
+
**@request_client.get_headers,
|
51
|
+
**(request_options&.additional_headers || {})
|
52
|
+
}.compact
|
53
|
+
req.body = {
|
54
|
+
**(request_options&.additional_body_parameters || {}),
|
55
|
+
patient_external_id: patient_external_id,
|
56
|
+
date_range_min: date_range_min,
|
57
|
+
date_range_max: date_range_max,
|
58
|
+
pay_to_address: pay_to_address
|
59
|
+
}.compact
|
60
|
+
req.url "#{@request_client.get_url(environment: CandidApi,
|
61
|
+
request_options: request_options)}/api/superbill/v1"
|
62
|
+
end
|
63
|
+
CandidApiClient::Superbills::V1::Types::SuperbillResponse.from_json(json_object: response.body)
|
64
|
+
end
|
65
|
+
end
|
66
|
+
|
67
|
+
class AsyncV1Client
|
68
|
+
# @return [CandidApiClient::AsyncRequestClient]
|
69
|
+
attr_reader :request_client
|
70
|
+
|
71
|
+
# @param request_client [CandidApiClient::AsyncRequestClient]
|
72
|
+
# @return [CandidApiClient::Superbills::V1::AsyncV1Client]
|
73
|
+
def initialize(request_client:)
|
74
|
+
@request_client = request_client
|
75
|
+
end
|
76
|
+
|
77
|
+
# @param patient_external_id [String] Empty string not allowed
|
78
|
+
# @param date_range_min [Date] Minimum (inclusive) date selected for the superbill
|
79
|
+
# @param date_range_max [Date] Maximum (inclusive) date selected for the superbill
|
80
|
+
# @param pay_to_address [Hash] Address that will be displayed on the superbill as the 'Pay to' Address. If not
|
81
|
+
# provided this value will be set from available encounter data.Request of type CandidApiClient::Commons::Types::StreetAddressShortZip, as a Hash
|
82
|
+
# * :zip_plus_four_code (String)
|
83
|
+
# * :address_1 (String)
|
84
|
+
# * :address_2 (String)
|
85
|
+
# * :city (String)
|
86
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
87
|
+
# * :zip_code (String)
|
88
|
+
# @param request_options [CandidApiClient::RequestOptions]
|
89
|
+
# @return [CandidApiClient::Superbills::V1::Types::SuperbillResponse]
|
90
|
+
# @example
|
91
|
+
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
92
|
+
# api.superbills.v_1.create_superbill(
|
93
|
+
# patient_external_id: "string",
|
94
|
+
# date_range_min: DateTime.parse(2023-01-15),
|
95
|
+
# date_range_max: DateTime.parse(2023-01-15),
|
96
|
+
# pay_to_address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }
|
97
|
+
# )
|
98
|
+
def create_superbill(patient_external_id:, date_range_min:, date_range_max:, pay_to_address: nil,
|
99
|
+
request_options: nil)
|
100
|
+
Async do
|
101
|
+
response = @request_client.conn.post do |req|
|
102
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
103
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
104
|
+
req.headers = {
|
105
|
+
**(req.headers || {}),
|
106
|
+
**@request_client.get_headers,
|
107
|
+
**(request_options&.additional_headers || {})
|
108
|
+
}.compact
|
109
|
+
req.body = {
|
110
|
+
**(request_options&.additional_body_parameters || {}),
|
111
|
+
patient_external_id: patient_external_id,
|
112
|
+
date_range_min: date_range_min,
|
113
|
+
date_range_max: date_range_max,
|
114
|
+
pay_to_address: pay_to_address
|
115
|
+
}.compact
|
116
|
+
req.url "#{@request_client.get_url(environment: CandidApi,
|
117
|
+
request_options: request_options)}/api/superbill/v1"
|
118
|
+
end
|
119
|
+
CandidApiClient::Superbills::V1::Types::SuperbillResponse.from_json(json_object: response.body)
|
120
|
+
end
|
121
|
+
end
|
122
|
+
end
|
123
|
+
end
|
124
|
+
end
|
125
|
+
end
|
@@ -0,0 +1,108 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "date"
|
4
|
+
require "ostruct"
|
5
|
+
require "json"
|
6
|
+
|
7
|
+
module CandidApiClient
|
8
|
+
module Superbills
|
9
|
+
module V1
|
10
|
+
module Types
|
11
|
+
class Superbill
|
12
|
+
# @return [String] Primary id of the superbill.
|
13
|
+
attr_reader :superbill_id
|
14
|
+
# @return [String] external_id of the patient.
|
15
|
+
attr_reader :patient_external_id
|
16
|
+
# @return [String] Authenticated URL for downloading the generated superbill file.
|
17
|
+
attr_reader :authed_url
|
18
|
+
# @return [Date] Minimum (inclusive) date selected for this superbill.
|
19
|
+
attr_reader :date_range_min
|
20
|
+
# @return [Date] Maximum (inclusive) date selected for this superbill.
|
21
|
+
attr_reader :date_range_max
|
22
|
+
# @return [String] Original filename of the superbill.
|
23
|
+
attr_reader :file_name
|
24
|
+
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
25
|
+
attr_reader :additional_properties
|
26
|
+
# @return [Object]
|
27
|
+
attr_reader :_field_set
|
28
|
+
protected :_field_set
|
29
|
+
|
30
|
+
OMIT = Object.new
|
31
|
+
|
32
|
+
# @param superbill_id [String] Primary id of the superbill.
|
33
|
+
# @param patient_external_id [String] external_id of the patient.
|
34
|
+
# @param authed_url [String] Authenticated URL for downloading the generated superbill file.
|
35
|
+
# @param date_range_min [Date] Minimum (inclusive) date selected for this superbill.
|
36
|
+
# @param date_range_max [Date] Maximum (inclusive) date selected for this superbill.
|
37
|
+
# @param file_name [String] Original filename of the superbill.
|
38
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
39
|
+
# @return [CandidApiClient::Superbills::V1::Types::Superbill]
|
40
|
+
def initialize(superbill_id:, patient_external_id:, authed_url:, date_range_min:, date_range_max:,
|
41
|
+
file_name:, additional_properties: nil)
|
42
|
+
@superbill_id = superbill_id
|
43
|
+
@patient_external_id = patient_external_id
|
44
|
+
@authed_url = authed_url
|
45
|
+
@date_range_min = date_range_min
|
46
|
+
@date_range_max = date_range_max
|
47
|
+
@file_name = file_name
|
48
|
+
@additional_properties = additional_properties
|
49
|
+
@_field_set = {
|
50
|
+
"superbill_id": superbill_id,
|
51
|
+
"patient_external_id": patient_external_id,
|
52
|
+
"authed_url": authed_url,
|
53
|
+
"date_range_min": date_range_min,
|
54
|
+
"date_range_max": date_range_max,
|
55
|
+
"file_name": file_name
|
56
|
+
}
|
57
|
+
end
|
58
|
+
|
59
|
+
# Deserialize a JSON object to an instance of Superbill
|
60
|
+
#
|
61
|
+
# @param json_object [String]
|
62
|
+
# @return [CandidApiClient::Superbills::V1::Types::Superbill]
|
63
|
+
def self.from_json(json_object:)
|
64
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
65
|
+
parsed_json = JSON.parse(json_object)
|
66
|
+
superbill_id = struct["superbill_id"]
|
67
|
+
patient_external_id = struct["patient_external_id"]
|
68
|
+
authed_url = struct["authed_url"]
|
69
|
+
date_range_min = (Date.parse(parsed_json["date_range_min"]) unless parsed_json["date_range_min"].nil?)
|
70
|
+
date_range_max = (Date.parse(parsed_json["date_range_max"]) unless parsed_json["date_range_max"].nil?)
|
71
|
+
file_name = struct["file_name"]
|
72
|
+
new(
|
73
|
+
superbill_id: superbill_id,
|
74
|
+
patient_external_id: patient_external_id,
|
75
|
+
authed_url: authed_url,
|
76
|
+
date_range_min: date_range_min,
|
77
|
+
date_range_max: date_range_max,
|
78
|
+
file_name: file_name,
|
79
|
+
additional_properties: struct
|
80
|
+
)
|
81
|
+
end
|
82
|
+
|
83
|
+
# Serialize an instance of Superbill to a JSON object
|
84
|
+
#
|
85
|
+
# @return [String]
|
86
|
+
def to_json(*_args)
|
87
|
+
@_field_set&.to_json
|
88
|
+
end
|
89
|
+
|
90
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
91
|
+
# hash and check each fields type against the current object's property
|
92
|
+
# definitions.
|
93
|
+
#
|
94
|
+
# @param obj [Object]
|
95
|
+
# @return [Void]
|
96
|
+
def self.validate_raw(obj:)
|
97
|
+
obj.superbill_id.is_a?(String) != false || raise("Passed value for field obj.superbill_id is not the expected type, validation failed.")
|
98
|
+
obj.patient_external_id.is_a?(String) != false || raise("Passed value for field obj.patient_external_id is not the expected type, validation failed.")
|
99
|
+
obj.authed_url.is_a?(String) != false || raise("Passed value for field obj.authed_url is not the expected type, validation failed.")
|
100
|
+
obj.date_range_min.is_a?(Date) != false || raise("Passed value for field obj.date_range_min is not the expected type, validation failed.")
|
101
|
+
obj.date_range_max.is_a?(Date) != false || raise("Passed value for field obj.date_range_max is not the expected type, validation failed.")
|
102
|
+
obj.file_name.is_a?(String) != false || raise("Passed value for field obj.file_name is not the expected type, validation failed.")
|
103
|
+
end
|
104
|
+
end
|
105
|
+
end
|
106
|
+
end
|
107
|
+
end
|
108
|
+
end
|
@@ -0,0 +1,65 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "superbill"
|
4
|
+
require "ostruct"
|
5
|
+
require "json"
|
6
|
+
|
7
|
+
module CandidApiClient
|
8
|
+
module Superbills
|
9
|
+
module V1
|
10
|
+
module Types
|
11
|
+
class SuperbillResponse
|
12
|
+
# @return [Array<CandidApiClient::Superbills::V1::Types::Superbill>] Each object represents a single Superbill for a single billing provider.
|
13
|
+
attr_reader :superbills
|
14
|
+
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
15
|
+
attr_reader :additional_properties
|
16
|
+
# @return [Object]
|
17
|
+
attr_reader :_field_set
|
18
|
+
protected :_field_set
|
19
|
+
|
20
|
+
OMIT = Object.new
|
21
|
+
|
22
|
+
# @param superbills [Array<CandidApiClient::Superbills::V1::Types::Superbill>] Each object represents a single Superbill for a single billing provider.
|
23
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
24
|
+
# @return [CandidApiClient::Superbills::V1::Types::SuperbillResponse]
|
25
|
+
def initialize(superbills:, additional_properties: nil)
|
26
|
+
@superbills = superbills
|
27
|
+
@additional_properties = additional_properties
|
28
|
+
@_field_set = { "superbills": superbills }
|
29
|
+
end
|
30
|
+
|
31
|
+
# Deserialize a JSON object to an instance of SuperbillResponse
|
32
|
+
#
|
33
|
+
# @param json_object [String]
|
34
|
+
# @return [CandidApiClient::Superbills::V1::Types::SuperbillResponse]
|
35
|
+
def self.from_json(json_object:)
|
36
|
+
struct = JSON.parse(json_object, object_class: OpenStruct)
|
37
|
+
parsed_json = JSON.parse(json_object)
|
38
|
+
superbills = parsed_json["superbills"]&.map do |item|
|
39
|
+
item = item.to_json
|
40
|
+
CandidApiClient::Superbills::V1::Types::Superbill.from_json(json_object: item)
|
41
|
+
end
|
42
|
+
new(superbills: superbills, additional_properties: struct)
|
43
|
+
end
|
44
|
+
|
45
|
+
# Serialize an instance of SuperbillResponse to a JSON object
|
46
|
+
#
|
47
|
+
# @return [String]
|
48
|
+
def to_json(*_args)
|
49
|
+
@_field_set&.to_json
|
50
|
+
end
|
51
|
+
|
52
|
+
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
53
|
+
# hash and check each fields type against the current object's property
|
54
|
+
# definitions.
|
55
|
+
#
|
56
|
+
# @param obj [Object]
|
57
|
+
# @return [Void]
|
58
|
+
def self.validate_raw(obj:)
|
59
|
+
obj.superbills.is_a?(Array) != false || raise("Passed value for field obj.superbills is not the expected type, validation failed.")
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
data/lib/candidhealth.rb
CHANGED
@@ -34,6 +34,7 @@ require_relative "candidhealth/patient_refunds/client"
|
|
34
34
|
require_relative "candidhealth/payer_plan_groups/client"
|
35
35
|
require_relative "candidhealth/payers/client"
|
36
36
|
require_relative "candidhealth/service_lines/client"
|
37
|
+
require_relative "candidhealth/superbills/client"
|
37
38
|
require_relative "candidhealth/tasks/client"
|
38
39
|
require_relative "candidhealth/write_offs/client"
|
39
40
|
require_relative "candidhealth/pre_encounter/client"
|
@@ -102,6 +103,8 @@ module CandidApiClient
|
|
102
103
|
attr_reader :payers
|
103
104
|
# @return [CandidApiClient::ServiceLines::Client]
|
104
105
|
attr_reader :service_lines
|
106
|
+
# @return [CandidApiClient::Superbills::Client]
|
107
|
+
attr_reader :superbills
|
105
108
|
# @return [CandidApiClient::Tasks::Client]
|
106
109
|
attr_reader :tasks
|
107
110
|
# @return [CandidApiClient::WriteOffs::Client]
|
@@ -169,6 +172,7 @@ module CandidApiClient
|
|
169
172
|
@payer_plan_groups = CandidApiClient::PayerPlanGroups::Client.new(request_client: @request_client)
|
170
173
|
@payers = CandidApiClient::Payers::Client.new(request_client: @request_client)
|
171
174
|
@service_lines = CandidApiClient::ServiceLines::Client.new(request_client: @request_client)
|
175
|
+
@superbills = CandidApiClient::Superbills::Client.new(request_client: @request_client)
|
172
176
|
@tasks = CandidApiClient::Tasks::Client.new(request_client: @request_client)
|
173
177
|
@write_offs = CandidApiClient::WriteOffs::Client.new(request_client: @request_client)
|
174
178
|
@pre_encounter = CandidApiClient::PreEncounter::Client.new(request_client: @request_client)
|
@@ -238,6 +242,8 @@ module CandidApiClient
|
|
238
242
|
attr_reader :payers
|
239
243
|
# @return [CandidApiClient::ServiceLines::AsyncClient]
|
240
244
|
attr_reader :service_lines
|
245
|
+
# @return [CandidApiClient::Superbills::AsyncClient]
|
246
|
+
attr_reader :superbills
|
241
247
|
# @return [CandidApiClient::Tasks::AsyncClient]
|
242
248
|
attr_reader :tasks
|
243
249
|
# @return [CandidApiClient::WriteOffs::AsyncClient]
|
@@ -305,6 +311,7 @@ module CandidApiClient
|
|
305
311
|
@payer_plan_groups = CandidApiClient::PayerPlanGroups::AsyncClient.new(request_client: @async_request_client)
|
306
312
|
@payers = CandidApiClient::Payers::AsyncClient.new(request_client: @async_request_client)
|
307
313
|
@service_lines = CandidApiClient::ServiceLines::AsyncClient.new(request_client: @async_request_client)
|
314
|
+
@superbills = CandidApiClient::Superbills::AsyncClient.new(request_client: @async_request_client)
|
308
315
|
@tasks = CandidApiClient::Tasks::AsyncClient.new(request_client: @async_request_client)
|
309
316
|
@write_offs = CandidApiClient::WriteOffs::AsyncClient.new(request_client: @async_request_client)
|
310
317
|
@pre_encounter = CandidApiClient::PreEncounter::AsyncClient.new(request_client: @async_request_client)
|
data/lib/requests.rb
CHANGED
@@ -43,7 +43,7 @@ module CandidApiClient
|
|
43
43
|
|
44
44
|
# @return [Hash{String => String}]
|
45
45
|
def get_headers
|
46
|
-
headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "0.41.
|
46
|
+
headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "0.41.3" }
|
47
47
|
headers["Authorization"] = ((@token.is_a? Method) ? @token.call : @token) unless token.nil?
|
48
48
|
headers
|
49
49
|
end
|
@@ -87,7 +87,7 @@ module CandidApiClient
|
|
87
87
|
|
88
88
|
# @return [Hash{String => String}]
|
89
89
|
def get_headers
|
90
|
-
headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "0.41.
|
90
|
+
headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "0.41.3" }
|
91
91
|
headers["Authorization"] = ((@token.is_a? Method) ? @token.call : @token) unless token.nil?
|
92
92
|
headers
|
93
93
|
end
|
data/lib/types_export.rb
CHANGED
@@ -269,6 +269,8 @@ require_relative "candidhealth/service_lines/v_2/types/test_result_type"
|
|
269
269
|
require_relative "candidhealth/service_lines/v_2/types/test_result"
|
270
270
|
require_relative "candidhealth/service_lines/v_2/types/service_id_qualifier"
|
271
271
|
require_relative "candidhealth/service_lines/v_2/types/measurement_unit_code"
|
272
|
+
require_relative "candidhealth/superbills/v_1/types/superbill"
|
273
|
+
require_relative "candidhealth/superbills/v_1/types/superbill_response"
|
272
274
|
require_relative "candidhealth/tasks/v_3/types/task"
|
273
275
|
require_relative "candidhealth/tasks/v_3/types/task_note"
|
274
276
|
require_relative "candidhealth/tasks/v_3/types/task_assignment"
|
@@ -307,6 +309,7 @@ require_relative "candidhealth/pre_encounter/appointments/v_1/types/mutable_appo
|
|
307
309
|
require_relative "candidhealth/pre_encounter/appointments/v_1/types/appointment"
|
308
310
|
require_relative "candidhealth/pre_encounter/appointments/v_1/types/visit"
|
309
311
|
require_relative "candidhealth/pre_encounter/appointments/v_1/types/visits_page"
|
312
|
+
require_relative "candidhealth/pre_encounter/coverages/v_1/types/payer_plan_group_fields"
|
310
313
|
require_relative "candidhealth/pre_encounter/coverages/v_1/types/coverages_page"
|
311
314
|
require_relative "candidhealth/pre_encounter/coverages/v_1/types/latest_eligibility_check"
|
312
315
|
require_relative "candidhealth/pre_encounter/coverages/v_1/types/eligibility_check_metadata"
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: candidhealth
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.41.
|
4
|
+
version: 0.41.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- ''
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-04-
|
11
|
+
date: 2025-04-23 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: async-http-faraday
|
@@ -561,6 +561,7 @@ files:
|
|
561
561
|
- lib/candidhealth/pre_encounter/coverages/v_1/types/member_info.rb
|
562
562
|
- lib/candidhealth/pre_encounter/coverages/v_1/types/mutable_coverage.rb
|
563
563
|
- lib/candidhealth/pre_encounter/coverages/v_1/types/network_type.rb
|
564
|
+
- lib/candidhealth/pre_encounter/coverages/v_1/types/payer_plan_group_fields.rb
|
564
565
|
- lib/candidhealth/pre_encounter/coverages/v_1/types/plan_coverage.rb
|
565
566
|
- lib/candidhealth/pre_encounter/coverages/v_1/types/plan_coverage_details.rb
|
566
567
|
- lib/candidhealth/pre_encounter/coverages/v_1/types/plan_date.rb
|
@@ -640,6 +641,10 @@ files:
|
|
640
641
|
- lib/candidhealth/service_lines/v_2/types/service_line_update.rb
|
641
642
|
- lib/candidhealth/service_lines/v_2/types/test_result.rb
|
642
643
|
- lib/candidhealth/service_lines/v_2/types/test_result_type.rb
|
644
|
+
- lib/candidhealth/superbills/client.rb
|
645
|
+
- lib/candidhealth/superbills/v_1/client.rb
|
646
|
+
- lib/candidhealth/superbills/v_1/types/superbill.rb
|
647
|
+
- lib/candidhealth/superbills/v_1/types/superbill_response.rb
|
643
648
|
- lib/candidhealth/tags/types/tag.rb
|
644
649
|
- lib/candidhealth/tags/types/tag_color_enum.rb
|
645
650
|
- lib/candidhealth/tags/types/tag_create.rb
|