candidhealth 0.39.6 → 0.39.8

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.
Files changed (46) hide show
  1. checksums.yaml +4 -4
  2. data/lib/candidhealth/commons/types/procedure_modifier.rb +1 -0
  3. data/lib/candidhealth/eligibility/v_2/client.rb +48 -6
  4. data/lib/candidhealth/fee_schedules/v_3/client.rb +16 -4
  5. data/lib/candidhealth/fee_schedules/v_3/types/dimension_match.rb +16 -2
  6. data/lib/candidhealth/fee_schedules/v_3/types/dimensions.rb +16 -2
  7. data/lib/candidhealth/fee_schedules/v_3/types/match_payer_plan_groups.rb +85 -0
  8. data/lib/candidhealth/fee_schedules/v_3/types/optional_dimensions.rb +15 -2
  9. data/lib/candidhealth/fee_schedules/v_3/types/payer_plan_group_does_not_match_rate_payer_error.rb +75 -0
  10. data/lib/candidhealth/fee_schedules/v_3/types/validation_error.rb +39 -14
  11. data/lib/candidhealth/organization_providers/v_2/types/license_type.rb +4 -0
  12. data/lib/candidhealth/pre_encounter/appointments/v_1/client.rb +98 -4
  13. data/lib/candidhealth/pre_encounter/appointments/v_1/types/appointment.rb +2 -2
  14. data/lib/candidhealth/pre_encounter/appointments/v_1/types/mutable_appointment.rb +2 -2
  15. data/lib/candidhealth/pre_encounter/appointments/v_1/types/visit.rb +96 -0
  16. data/lib/candidhealth/pre_encounter/appointments/v_1/types/visits_page.rb +98 -0
  17. data/lib/candidhealth/pre_encounter/common/types/external_identifier.rb +87 -0
  18. data/lib/candidhealth/pre_encounter/common/types/external_provider.rb +10 -2
  19. data/lib/candidhealth/pre_encounter/coverages/v_1/client.rb +89 -4
  20. data/lib/candidhealth/pre_encounter/coverages/v_1/types/address.rb +118 -0
  21. data/lib/candidhealth/pre_encounter/coverages/v_1/types/benefits_related_entity.rb +11 -2
  22. data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverages_page.rb +98 -0
  23. data/lib/candidhealth/pre_encounter/coverages/v_1/types/expanded_member_info.rb +133 -0
  24. data/lib/candidhealth/pre_encounter/coverages/v_1/types/insurance_plan.rb +10 -2
  25. data/lib/candidhealth/pre_encounter/coverages/v_1/types/insurance_type_code.rb +1 -0
  26. data/lib/candidhealth/pre_encounter/coverages/v_1/types/member_info.rb +93 -0
  27. data/lib/candidhealth/pre_encounter/coverages/v_1/types/plan_metadata.rb +38 -3
  28. data/lib/candidhealth/pre_encounter/eligibility_checks/client.rb +32 -0
  29. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/client.rb +124 -0
  30. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_check.rb +119 -0
  31. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_request.rb +135 -0
  32. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_response.rb +15 -0
  33. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/encounter.rb +83 -0
  34. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/individual_provider.rb +81 -0
  35. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/organization_provider.rb +74 -0
  36. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/parsed_response.rb +99 -0
  37. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/provider.rb +66 -0
  38. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/request_correction.rb +79 -0
  39. data/lib/candidhealth/pre_encounter/lists/v_1/types/appointment_list_item.rb +5 -5
  40. data/lib/candidhealth/pre_encounter/patients/v_1/client.rb +70 -14
  41. data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient.rb +14 -2
  42. data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient_with_mrn.rb +14 -2
  43. data/lib/candidhealth/pre_encounter/patients/v_1/types/patient.rb +13 -1
  44. data/lib/requests.rb +2 -2
  45. data/lib/types_export.rb +18 -0
  46. metadata +22 -2
data/lib/candidhealth/pre_encounter/lists/v_1/types/appointment_list_item.rb CHANGED
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  require_relative "../../../appointments/v_1/types/appointment"
4
- require_relative "../../../patients/v_1/types/mutable_patient"
4
+ require_relative "../../../patients/v_1/types/mutable_patient_with_mrn"
5
5
  require_relative "../../../coverages/v_1/types/mutable_coverage"
6
6
  require_relative "../../../appointments/v_1/types/universal_service_identifier"
7
7
  require "ostruct"
@@ -15,7 +15,7 @@ module CandidApiClient
15
15
  class AppointmentListItem
16
16
  # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment]
17
17
  attr_reader :appointment
18
- # @return [CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatient]
18
+ # @return [CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatientWithMrn]
19
19
  attr_reader :patient
20
20
  # @return [CandidApiClient::PreEncounter::Coverages::V1::Types::MutableCoverage]
21
21
  attr_reader :primary_coverage
@@ -30,7 +30,7 @@ module CandidApiClient
30
30
  OMIT = Object.new
31
31
 
32
32
  # @param appointment [CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment]
33
- # @param patient [CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatient]
33
+ # @param patient [CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatientWithMrn]
34
34
  # @param primary_coverage [CandidApiClient::PreEncounter::Coverages::V1::Types::MutableCoverage]
35
35
  # @param primary_service_type [CandidApiClient::PreEncounter::Appointments::V1::Types::UniversalServiceIdentifier]
36
36
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
@@ -69,7 +69,7 @@ module CandidApiClient
69
69
  patient = nil
70
70
  else
71
71
  patient = parsed_json["patient"].to_json
72
- patient = CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatient.from_json(json_object: patient)
72
+ patient = CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatientWithMrn.from_json(json_object: patient)
73
73
  end
74
74
  if parsed_json["primary_coverage"].nil?
75
75
  primary_coverage = nil
@@ -102,7 +102,7 @@ module CandidApiClient
102
102
  # @return [Void]
103
103
  def self.validate_raw(obj:)
104
104
  CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment.validate_raw(obj: obj.appointment)
105
- CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatient.validate_raw(obj: obj.patient)
105
+ CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatientWithMrn.validate_raw(obj: obj.patient)
106
106
  obj.primary_coverage.nil? || CandidApiClient::PreEncounter::Coverages::V1::Types::MutableCoverage.validate_raw(obj: obj.primary_coverage)
107
107
  obj.primary_service_type&.is_a?(CandidApiClient::PreEncounter::Appointments::V1::Types::UniversalServiceIdentifier) != false || raise("Passed value for field obj.primary_service_type is not the expected type, validation failed.")
108
108
  end
data/lib/candidhealth/pre_encounter/patients/v_1/client.rb CHANGED
@@ -37,6 +37,7 @@ module CandidApiClient
37
37
  # * :start (Date)
38
38
  # * :end_ (Date)
39
39
  # * :other_names (Array<CandidApiClient::PreEncounter::Common::Types::HumanName>)
40
+ # * :other_identifiers (Array<CandidApiClient::PreEncounter::Common::Types::ExternalIdentifier>)
40
41
  # * :gender (CandidApiClient::PreEncounter::Common::Types::Gender)
41
42
  # * :birth_date (Date)
42
43
  # * :social_security_number (String)
@@ -116,7 +117,7 @@ module CandidApiClient
116
117
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
117
118
  # @example
118
119
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
119
- # api.pre_encounter.patients.v_1.create(skip_duplicate_check: true, request: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { } }], 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: { } }, 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: { } }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "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: { } }, 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", units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] })
120
+ # api.pre_encounter.patients.v_1.create(skip_duplicate_check: true, request: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { } }], 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: { } }, 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: { } }, 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: { } }, 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", units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, 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"] })
120
121
  def create(request:, skip_duplicate_check: nil, request_options: nil)
121
122
  response = @request_client.conn.post do |req|
122
123
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -153,6 +154,7 @@ module CandidApiClient
153
154
  # * :start (Date)
154
155
  # * :end_ (Date)
155
156
  # * :other_names (Array<CandidApiClient::PreEncounter::Common::Types::HumanName>)
157
+ # * :other_identifiers (Array<CandidApiClient::PreEncounter::Common::Types::ExternalIdentifier>)
156
158
  # * :gender (CandidApiClient::PreEncounter::Common::Types::Gender)
157
159
  # * :birth_date (Date)
158
160
  # * :social_security_number (String)
@@ -232,7 +234,7 @@ module CandidApiClient
232
234
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
233
235
  # @example
234
236
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
235
- # api.pre_encounter.patients.v_1.create_with_mrn(skip_duplicate_check: true, request: { mrn: "string", name: { family: "string", given: ["string"], use: USUAL, period: { } }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { } }], 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: { } }, 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: { } }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "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: { } }, 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", units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] })
237
+ # api.pre_encounter.patients.v_1.create_with_mrn(skip_duplicate_check: true, request: { mrn: "string", name: { family: "string", given: ["string"], use: USUAL, period: { } }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { } }], 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: { } }, 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: { } }, 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: { } }, 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", units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, 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"] })
236
238
  def create_with_mrn(request:, skip_duplicate_check: nil, request_options: nil)
237
239
  response = @request_client.conn.post do |req|
238
240
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -360,6 +362,7 @@ module CandidApiClient
360
362
  # * :start (Date)
361
363
  # * :end_ (Date)
362
364
  # * :other_names (Array<CandidApiClient::PreEncounter::Common::Types::HumanName>)
365
+ # * :other_identifiers (Array<CandidApiClient::PreEncounter::Common::Types::ExternalIdentifier>)
363
366
  # * :gender (CandidApiClient::PreEncounter::Common::Types::Gender)
364
367
  # * :birth_date (Date)
365
368
  # * :social_security_number (String)
@@ -442,7 +445,7 @@ module CandidApiClient
442
445
  # api.pre_encounter.patients.v_1.update(
443
446
  # id: "string",
444
447
  # version: "string",
445
- # request: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { } }], 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: { } }, 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: { } }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "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: { } }, 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", units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] }
448
+ # request: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { } }], 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: { } }, 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: { } }, 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: { } }, 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", units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, 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"] }
446
449
  # )
447
450
  def update(id:, version:, request:, request_options: nil)
448
451
  response = @request_client.conn.put do |req|
@@ -460,10 +463,9 @@ module CandidApiClient
460
463
  CandidApiClient::PreEncounter::Patients::V1::Types::Patient.from_json(json_object: response.body)
461
464
  end
462
465
 
463
- # Sets a patient as deactivated. The path must contain the most recent version to
464
- # prevent race conditions. Deactivating historic versions is not supported.
465
- # Subsequent updates via PUT to the patient will "reactivate" the patient and set
466
- # the deactivated flag to false.
466
+ # Sets a patient as deactivated. The path must contain the most recent version
467
+ # plus 1 to prevent race conditions. Deactivating historic versions is not
468
+ # supported.
467
469
  #
468
470
  # @param id [String]
469
471
  # @param version [String]
@@ -486,6 +488,31 @@ module CandidApiClient
486
488
  end
487
489
  end
488
490
 
491
+ # Removes the deactivated flag for a patient. The path must contain the most
492
+ # recent version plus 1 to prevent race conditions. Reactivating historic versions
493
+ # is not supported.
494
+ #
495
+ # @param id [String]
496
+ # @param version [String]
497
+ # @param request_options [CandidApiClient::RequestOptions]
498
+ # @return [Void]
499
+ # @example
500
+ # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
501
+ # api.pre_encounter.patients.v_1.reactivate(id: "string", version: "string")
502
+ def reactivate(id:, version:, request_options: nil)
503
+ @request_client.conn.patch do |req|
504
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
505
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
506
+ req.headers = {
507
+ **(req.headers || {}),
508
+ **@request_client.get_headers,
509
+ **(request_options&.additional_headers || {})
510
+ }.compact
511
+ req.url "#{@request_client.get_url(environment: PreEncounter,
512
+ request_options: request_options)}/patients/v1/#{id}/#{version}"
513
+ end
514
+ end
515
+
489
516
  # Returns a list of Patients based on the search criteria.
490
517
  #
491
518
  # @param mrn [String]
@@ -572,6 +599,7 @@ module CandidApiClient
572
599
  # * :start (Date)
573
600
  # * :end_ (Date)
574
601
  # * :other_names (Array<CandidApiClient::PreEncounter::Common::Types::HumanName>)
602
+ # * :other_identifiers (Array<CandidApiClient::PreEncounter::Common::Types::ExternalIdentifier>)
575
603
  # * :gender (CandidApiClient::PreEncounter::Common::Types::Gender)
576
604
  # * :birth_date (Date)
577
605
  # * :social_security_number (String)
@@ -651,7 +679,7 @@ module CandidApiClient
651
679
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
652
680
  # @example
653
681
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
654
- # api.pre_encounter.patients.v_1.create(skip_duplicate_check: true, request: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { } }], 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: { } }, 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: { } }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "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: { } }, 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", units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] })
682
+ # api.pre_encounter.patients.v_1.create(skip_duplicate_check: true, request: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { } }], 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: { } }, 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: { } }, 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: { } }, 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", units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, 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"] })
655
683
  def create(request:, skip_duplicate_check: nil, request_options: nil)
656
684
  Async do
657
685
  response = @request_client.conn.post do |req|
@@ -690,6 +718,7 @@ module CandidApiClient
690
718
  # * :start (Date)
691
719
  # * :end_ (Date)
692
720
  # * :other_names (Array<CandidApiClient::PreEncounter::Common::Types::HumanName>)
721
+ # * :other_identifiers (Array<CandidApiClient::PreEncounter::Common::Types::ExternalIdentifier>)
693
722
  # * :gender (CandidApiClient::PreEncounter::Common::Types::Gender)
694
723
  # * :birth_date (Date)
695
724
  # * :social_security_number (String)
@@ -769,7 +798,7 @@ module CandidApiClient
769
798
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
770
799
  # @example
771
800
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
772
- # api.pre_encounter.patients.v_1.create_with_mrn(skip_duplicate_check: true, request: { mrn: "string", name: { family: "string", given: ["string"], use: USUAL, period: { } }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { } }], 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: { } }, 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: { } }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "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: { } }, 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", units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] })
801
+ # api.pre_encounter.patients.v_1.create_with_mrn(skip_duplicate_check: true, request: { mrn: "string", name: { family: "string", given: ["string"], use: USUAL, period: { } }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { } }], 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: { } }, 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: { } }, 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: { } }, 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", units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, 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"] })
773
802
  def create_with_mrn(request:, skip_duplicate_check: nil, request_options: nil)
774
803
  Async do
775
804
  response = @request_client.conn.post do |req|
@@ -905,6 +934,7 @@ module CandidApiClient
905
934
  # * :start (Date)
906
935
  # * :end_ (Date)
907
936
  # * :other_names (Array<CandidApiClient::PreEncounter::Common::Types::HumanName>)
937
+ # * :other_identifiers (Array<CandidApiClient::PreEncounter::Common::Types::ExternalIdentifier>)
908
938
  # * :gender (CandidApiClient::PreEncounter::Common::Types::Gender)
909
939
  # * :birth_date (Date)
910
940
  # * :social_security_number (String)
@@ -987,7 +1017,7 @@ module CandidApiClient
987
1017
  # api.pre_encounter.patients.v_1.update(
988
1018
  # id: "string",
989
1019
  # version: "string",
990
- # request: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { } }], 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: { } }, 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: { } }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "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: { } }, 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", units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: { }, canonical_id: "string" }, referral_number: "string" }], primary_service_facility_id: "string", do_not_invoice_reason: BANKRUPTCY, note_ids: ["string"], tag_ids: ["string"] }
1020
+ # request: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, other_names: [{ family: "string", given: ["string"], use: USUAL, period: { } }], 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: { } }, 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: { } }, 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: { } }, 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", units: VISIT, quantity: 1, period: { }, notes: "string" }], referrals: [{ provider: { name: { family: "string", given: ["string"], use: USUAL, period: { } }, 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"] }
991
1021
  # )
992
1022
  def update(id:, version:, request:, request_options: nil)
993
1023
  Async do
@@ -1007,10 +1037,9 @@ module CandidApiClient
1007
1037
  end
1008
1038
  end
1009
1039
 
1010
- # Sets a patient as deactivated. The path must contain the most recent version to
1011
- # prevent race conditions. Deactivating historic versions is not supported.
1012
- # Subsequent updates via PUT to the patient will "reactivate" the patient and set
1013
- # the deactivated flag to false.
1040
+ # Sets a patient as deactivated. The path must contain the most recent version
1041
+ # plus 1 to prevent race conditions. Deactivating historic versions is not
1042
+ # supported.
1014
1043
  #
1015
1044
  # @param id [String]
1016
1045
  # @param version [String]
@@ -1035,6 +1064,33 @@ module CandidApiClient
1035
1064
  end
1036
1065
  end
1037
1066
 
1067
+ # Removes the deactivated flag for a patient. The path must contain the most
1068
+ # recent version plus 1 to prevent race conditions. Reactivating historic versions
1069
+ # is not supported.
1070
+ #
1071
+ # @param id [String]
1072
+ # @param version [String]
1073
+ # @param request_options [CandidApiClient::RequestOptions]
1074
+ # @return [Void]
1075
+ # @example
1076
+ # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
1077
+ # api.pre_encounter.patients.v_1.reactivate(id: "string", version: "string")
1078
+ def reactivate(id:, version:, request_options: nil)
1079
+ Async do
1080
+ @request_client.conn.patch do |req|
1081
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
1082
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
1083
+ req.headers = {
1084
+ **(req.headers || {}),
1085
+ **@request_client.get_headers,
1086
+ **(request_options&.additional_headers || {})
1087
+ }.compact
1088
+ req.url "#{@request_client.get_url(environment: PreEncounter,
1089
+ request_options: request_options)}/patients/v1/#{id}/#{version}"
1090
+ end
1091
+ end
1092
+ end
1093
+
1038
1094
  # Returns a list of Patients based on the search criteria.
1039
1095
  #
1040
1096
  # @param mrn [String]
data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient.rb CHANGED
@@ -1,6 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  require_relative "../../../common/types/human_name"
4
+ require_relative "../../../common/types/external_identifier"
4
5
  require_relative "../../../common/types/gender"
5
6
  require "date"
6
7
  require_relative "../../../common/types/sex"
@@ -34,6 +35,8 @@ module CandidApiClient
34
35
  attr_reader :name
35
36
  # @return [Array<CandidApiClient::PreEncounter::Common::Types::HumanName>] Other names for the patient.
36
37
  attr_reader :other_names
38
+ # @return [Array<CandidApiClient::PreEncounter::Common::Types::ExternalIdentifier>] Other identifiers for the patient.
39
+ attr_reader :other_identifiers
37
40
  # @return [CandidApiClient::PreEncounter::Common::Types::Gender]
38
41
  attr_reader :gender
39
42
  # @return [Date]
@@ -114,6 +117,7 @@ module CandidApiClient
114
117
 
115
118
  # @param name [CandidApiClient::PreEncounter::Common::Types::HumanName]
116
119
  # @param other_names [Array<CandidApiClient::PreEncounter::Common::Types::HumanName>] Other names for the patient.
120
+ # @param other_identifiers [Array<CandidApiClient::PreEncounter::Common::Types::ExternalIdentifier>] Other identifiers for the patient.
117
121
  # @param gender [CandidApiClient::PreEncounter::Common::Types::Gender]
118
122
  # @param birth_date [Date]
119
123
  # @param social_security_number [String]
@@ -153,10 +157,11 @@ module CandidApiClient
153
157
  # @param tag_ids [Array<String>]
154
158
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
155
159
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatient]
156
- def initialize(name:, other_names:, birth_date:, biological_sex:, primary_address:, other_addresses:,
157
- primary_telecom:, other_telecoms:, contacts:, general_practitioners:, filing_order:, 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)
160
+ 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)
158
162
  @name = name
159
163
  @other_names = other_names
164
+ @other_identifiers = other_identifiers if other_identifiers != OMIT
160
165
  @gender = gender if gender != OMIT
161
166
  @birth_date = birth_date
162
167
  @social_security_number = social_security_number if social_security_number != OMIT
@@ -198,6 +203,7 @@ module CandidApiClient
198
203
  @_field_set = {
199
204
  "name": name,
200
205
  "other_names": other_names,
206
+ "other_identifiers": other_identifiers,
201
207
  "gender": gender,
202
208
  "birth_date": birth_date,
203
209
  "social_security_number": social_security_number,
@@ -253,6 +259,10 @@ module CandidApiClient
253
259
  item = item.to_json
254
260
  CandidApiClient::PreEncounter::Common::Types::HumanName.from_json(json_object: item)
255
261
  end
262
+ other_identifiers = parsed_json["other_identifiers"]&.map do |item|
263
+ item = item.to_json
264
+ CandidApiClient::PreEncounter::Common::Types::ExternalIdentifier.from_json(json_object: item)
265
+ end
256
266
  gender = struct["gender"]
257
267
  birth_date = (Date.parse(parsed_json["birth_date"]) unless parsed_json["birth_date"].nil?)
258
268
  social_security_number = struct["social_security_number"]
@@ -335,6 +345,7 @@ module CandidApiClient
335
345
  new(
336
346
  name: name,
337
347
  other_names: other_names,
348
+ other_identifiers: other_identifiers,
338
349
  gender: gender,
339
350
  birth_date: birth_date,
340
351
  social_security_number: social_security_number,
@@ -388,6 +399,7 @@ module CandidApiClient
388
399
  def self.validate_raw(obj:)
389
400
  CandidApiClient::PreEncounter::Common::Types::HumanName.validate_raw(obj: obj.name)
390
401
  obj.other_names.is_a?(Array) != false || raise("Passed value for field obj.other_names is not the expected type, validation failed.")
402
+ obj.other_identifiers&.is_a?(Array) != false || raise("Passed value for field obj.other_identifiers is not the expected type, validation failed.")
391
403
  obj.gender&.is_a?(CandidApiClient::PreEncounter::Common::Types::Gender) != false || raise("Passed value for field obj.gender is not the expected type, validation failed.")
392
404
  obj.birth_date.is_a?(Date) != false || raise("Passed value for field obj.birth_date is not the expected type, validation failed.")
393
405
  obj.social_security_number&.is_a?(String) != false || raise("Passed value for field obj.social_security_number is not the expected type, validation failed.")
data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient_with_mrn.rb CHANGED
@@ -1,6 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  require_relative "../../../common/types/human_name"
4
+ require_relative "../../../common/types/external_identifier"
4
5
  require_relative "../../../common/types/gender"
5
6
  require "date"
6
7
  require_relative "../../../common/types/sex"
@@ -35,6 +36,8 @@ module CandidApiClient
35
36
  attr_reader :name
36
37
  # @return [Array<CandidApiClient::PreEncounter::Common::Types::HumanName>] Other names for the patient.
37
38
  attr_reader :other_names
39
+ # @return [Array<CandidApiClient::PreEncounter::Common::Types::ExternalIdentifier>] Other identifiers for the patient.
40
+ attr_reader :other_identifiers
38
41
  # @return [CandidApiClient::PreEncounter::Common::Types::Gender]
39
42
  attr_reader :gender
40
43
  # @return [Date]
@@ -116,6 +119,7 @@ module CandidApiClient
116
119
  # @param mrn [String] The medical record number for the patient.
117
120
  # @param name [CandidApiClient::PreEncounter::Common::Types::HumanName]
118
121
  # @param other_names [Array<CandidApiClient::PreEncounter::Common::Types::HumanName>] Other names for the patient.
122
+ # @param other_identifiers [Array<CandidApiClient::PreEncounter::Common::Types::ExternalIdentifier>] Other identifiers for the patient.
119
123
  # @param gender [CandidApiClient::PreEncounter::Common::Types::Gender]
120
124
  # @param birth_date [Date]
121
125
  # @param social_security_number [String]
@@ -155,11 +159,12 @@ module CandidApiClient
155
159
  # @param tag_ids [Array<String>]
156
160
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
157
161
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatientWithMrn]
158
- def initialize(mrn:, name:, other_names:, birth_date:, biological_sex:, primary_address:, other_addresses:,
159
- primary_telecom:, other_telecoms:, contacts:, general_practitioners:, filing_order:, 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)
162
+ 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)
160
164
  @mrn = mrn
161
165
  @name = name
162
166
  @other_names = other_names
167
+ @other_identifiers = other_identifiers if other_identifiers != OMIT
163
168
  @gender = gender if gender != OMIT
164
169
  @birth_date = birth_date
165
170
  @social_security_number = social_security_number if social_security_number != OMIT
@@ -202,6 +207,7 @@ module CandidApiClient
202
207
  "mrn": mrn,
203
208
  "name": name,
204
209
  "other_names": other_names,
210
+ "other_identifiers": other_identifiers,
205
211
  "gender": gender,
206
212
  "birth_date": birth_date,
207
213
  "social_security_number": social_security_number,
@@ -258,6 +264,10 @@ module CandidApiClient
258
264
  item = item.to_json
259
265
  CandidApiClient::PreEncounter::Common::Types::HumanName.from_json(json_object: item)
260
266
  end
267
+ other_identifiers = parsed_json["other_identifiers"]&.map do |item|
268
+ item = item.to_json
269
+ CandidApiClient::PreEncounter::Common::Types::ExternalIdentifier.from_json(json_object: item)
270
+ end
261
271
  gender = struct["gender"]
262
272
  birth_date = (Date.parse(parsed_json["birth_date"]) unless parsed_json["birth_date"].nil?)
263
273
  social_security_number = struct["social_security_number"]
@@ -341,6 +351,7 @@ module CandidApiClient
341
351
  mrn: mrn,
342
352
  name: name,
343
353
  other_names: other_names,
354
+ other_identifiers: other_identifiers,
344
355
  gender: gender,
345
356
  birth_date: birth_date,
346
357
  social_security_number: social_security_number,
@@ -395,6 +406,7 @@ module CandidApiClient
395
406
  obj.mrn.is_a?(String) != false || raise("Passed value for field obj.mrn is not the expected type, validation failed.")
396
407
  CandidApiClient::PreEncounter::Common::Types::HumanName.validate_raw(obj: obj.name)
397
408
  obj.other_names.is_a?(Array) != false || raise("Passed value for field obj.other_names is not the expected type, validation failed.")
409
+ obj.other_identifiers&.is_a?(Array) != false || raise("Passed value for field obj.other_identifiers is not the expected type, validation failed.")
398
410
  obj.gender&.is_a?(CandidApiClient::PreEncounter::Common::Types::Gender) != false || raise("Passed value for field obj.gender is not the expected type, validation failed.")
399
411
  obj.birth_date.is_a?(Date) != false || raise("Passed value for field obj.birth_date is not the expected type, validation failed.")
400
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.")
data/lib/candidhealth/pre_encounter/patients/v_1/types/patient.rb CHANGED
@@ -2,6 +2,7 @@
2
2
 
3
3
  require "date"
4
4
  require_relative "../../../common/types/human_name"
5
+ require_relative "../../../common/types/external_identifier"
5
6
  require_relative "../../../common/types/gender"
6
7
  require_relative "../../../common/types/sex"
7
8
  require_relative "../../../common/types/sexual_orientation"
@@ -53,6 +54,8 @@ module CandidApiClient
53
54
  attr_reader :name
54
55
  # @return [Array<CandidApiClient::PreEncounter::Common::Types::HumanName>] Other names for the patient.
55
56
  attr_reader :other_names
57
+ # @return [Array<CandidApiClient::PreEncounter::Common::Types::ExternalIdentifier>] Other identifiers for the patient.
58
+ attr_reader :other_identifiers
56
59
  # @return [CandidApiClient::PreEncounter::Common::Types::Gender]
57
60
  attr_reader :gender
58
61
  # @return [Date]
@@ -145,6 +148,7 @@ module CandidApiClient
145
148
  # @param updating_user_id [String] The user ID of the user who last updated the object.
146
149
  # @param name [CandidApiClient::PreEncounter::Common::Types::HumanName]
147
150
  # @param other_names [Array<CandidApiClient::PreEncounter::Common::Types::HumanName>] Other names for the patient.
151
+ # @param other_identifiers [Array<CandidApiClient::PreEncounter::Common::Types::ExternalIdentifier>] Other identifiers for the patient.
148
152
  # @param gender [CandidApiClient::PreEncounter::Common::Types::Gender]
149
153
  # @param birth_date [Date]
150
154
  # @param social_security_number [String]
@@ -185,7 +189,7 @@ module CandidApiClient
185
189
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
186
190
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
187
191
  def initialize(id:, mrn:, organization_id:, deactivated:, version:, updated_at:, updating_user_id:, name:,
188
- other_names:, birth_date:, biological_sex:, primary_address:, other_addresses:, primary_telecom:, other_telecoms:, contacts:, general_practitioners:, filing_order:, 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)
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)
189
193
  @id = id
190
194
  @mrn = mrn
191
195
  @organization_id = organization_id
@@ -195,6 +199,7 @@ module CandidApiClient
195
199
  @updating_user_id = updating_user_id
196
200
  @name = name
197
201
  @other_names = other_names
202
+ @other_identifiers = other_identifiers if other_identifiers != OMIT
198
203
  @gender = gender if gender != OMIT
199
204
  @birth_date = birth_date
200
205
  @social_security_number = social_security_number if social_security_number != OMIT
@@ -243,6 +248,7 @@ module CandidApiClient
243
248
  "updating_user_id": updating_user_id,
244
249
  "name": name,
245
250
  "other_names": other_names,
251
+ "other_identifiers": other_identifiers,
246
252
  "gender": gender,
247
253
  "birth_date": birth_date,
248
254
  "social_security_number": social_security_number,
@@ -305,6 +311,10 @@ module CandidApiClient
305
311
  item = item.to_json
306
312
  CandidApiClient::PreEncounter::Common::Types::HumanName.from_json(json_object: item)
307
313
  end
314
+ other_identifiers = parsed_json["other_identifiers"]&.map do |item|
315
+ item = item.to_json
316
+ CandidApiClient::PreEncounter::Common::Types::ExternalIdentifier.from_json(json_object: item)
317
+ end
308
318
  gender = struct["gender"]
309
319
  birth_date = (Date.parse(parsed_json["birth_date"]) unless parsed_json["birth_date"].nil?)
310
320
  social_security_number = struct["social_security_number"]
@@ -394,6 +404,7 @@ module CandidApiClient
394
404
  updating_user_id: updating_user_id,
395
405
  name: name,
396
406
  other_names: other_names,
407
+ other_identifiers: other_identifiers,
397
408
  gender: gender,
398
409
  birth_date: birth_date,
399
410
  social_security_number: social_security_number,
@@ -454,6 +465,7 @@ module CandidApiClient
454
465
  obj.updating_user_id.is_a?(String) != false || raise("Passed value for field obj.updating_user_id is not the expected type, validation failed.")
455
466
  CandidApiClient::PreEncounter::Common::Types::HumanName.validate_raw(obj: obj.name)
456
467
  obj.other_names.is_a?(Array) != false || raise("Passed value for field obj.other_names is not the expected type, validation failed.")
468
+ obj.other_identifiers&.is_a?(Array) != false || raise("Passed value for field obj.other_identifiers is not the expected type, validation failed.")
457
469
  obj.gender&.is_a?(CandidApiClient::PreEncounter::Common::Types::Gender) != false || raise("Passed value for field obj.gender is not the expected type, validation failed.")
458
470
  obj.birth_date.is_a?(Date) != false || raise("Passed value for field obj.birth_date is not the expected type, validation failed.")
459
471
  obj.social_security_number&.is_a?(String) != false || raise("Passed value for field obj.social_security_number is not the expected type, validation failed.")
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.39.6" }
46
+ headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "0.39.8" }
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.39.6" }
90
+ headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "0.39.8" }
91
91
  headers["Authorization"] = ((@token.is_a? Method) ? @token.call : @token) unless token.nil?
92
92
  headers
93
93
  end