candidhealth 0.35.2 → 0.35.3

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,149 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "date"
4
+ require "ostruct"
5
+ require "json"
6
+
7
+ module CandidApiClient
8
+ module PreEncounter
9
+ module Notes
10
+ module V1
11
+ module Types
12
+ # A Note object with immutable server-owned properties.
13
+ class Note
14
+ # @return [String]
15
+ attr_reader :id
16
+ # @return [DateTime]
17
+ attr_reader :created_at
18
+ # @return [String] The organization that owns this object.
19
+ attr_reader :organization_id
20
+ # @return [Boolean] True if the object is deactivated. Deactivated objects are not returned in
21
+ # search results but are returned in all other endpoints including scan.
22
+ attr_reader :deactivated
23
+ # @return [Integer] The version of the object. Any update to any property of an object object will
24
+ # create a new version.
25
+ attr_reader :version
26
+ # @return [DateTime]
27
+ attr_reader :updated_at
28
+ # @return [String] The user ID of the user who last updated the object.
29
+ attr_reader :updating_user_id
30
+ # @return [String]
31
+ attr_reader :value
32
+ # @return [String]
33
+ attr_reader :author_email
34
+ # @return [String]
35
+ attr_reader :author_name
36
+ # @return [OpenStruct] Additional properties unmapped to the current class definition
37
+ attr_reader :additional_properties
38
+ # @return [Object]
39
+ attr_reader :_field_set
40
+ protected :_field_set
41
+
42
+ OMIT = Object.new
43
+
44
+ # @param id [String]
45
+ # @param created_at [DateTime]
46
+ # @param organization_id [String] The organization that owns this object.
47
+ # @param deactivated [Boolean] True if the object is deactivated. Deactivated objects are not returned in
48
+ # search results but are returned in all other endpoints including scan.
49
+ # @param version [Integer] The version of the object. Any update to any property of an object object will
50
+ # create a new version.
51
+ # @param updated_at [DateTime]
52
+ # @param updating_user_id [String] The user ID of the user who last updated the object.
53
+ # @param value [String]
54
+ # @param author_email [String]
55
+ # @param author_name [String]
56
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
57
+ # @return [CandidApiClient::PreEncounter::Notes::V1::Types::Note]
58
+ def initialize(id:, created_at:, organization_id:, deactivated:, version:, updated_at:, updating_user_id:,
59
+ value:, author_email: OMIT, author_name: OMIT, additional_properties: nil)
60
+ @id = id
61
+ @created_at = created_at
62
+ @organization_id = organization_id
63
+ @deactivated = deactivated
64
+ @version = version
65
+ @updated_at = updated_at
66
+ @updating_user_id = updating_user_id
67
+ @value = value
68
+ @author_email = author_email if author_email != OMIT
69
+ @author_name = author_name if author_name != OMIT
70
+ @additional_properties = additional_properties
71
+ @_field_set = {
72
+ "id": id,
73
+ "created_at": created_at,
74
+ "organization_id": organization_id,
75
+ "deactivated": deactivated,
76
+ "version": version,
77
+ "updated_at": updated_at,
78
+ "updating_user_id": updating_user_id,
79
+ "value": value,
80
+ "author_email": author_email,
81
+ "author_name": author_name
82
+ }.reject do |_k, v|
83
+ v == OMIT
84
+ end
85
+ end
86
+
87
+ # Deserialize a JSON object to an instance of Note
88
+ #
89
+ # @param json_object [String]
90
+ # @return [CandidApiClient::PreEncounter::Notes::V1::Types::Note]
91
+ def self.from_json(json_object:)
92
+ struct = JSON.parse(json_object, object_class: OpenStruct)
93
+ parsed_json = JSON.parse(json_object)
94
+ id = struct["id"]
95
+ created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
96
+ organization_id = struct["organization_id"]
97
+ deactivated = struct["deactivated"]
98
+ version = struct["version"]
99
+ updated_at = (DateTime.parse(parsed_json["updated_at"]) unless parsed_json["updated_at"].nil?)
100
+ updating_user_id = struct["updating_user_id"]
101
+ value = struct["value"]
102
+ author_email = struct["author_email"]
103
+ author_name = struct["author_name"]
104
+ new(
105
+ id: id,
106
+ created_at: created_at,
107
+ organization_id: organization_id,
108
+ deactivated: deactivated,
109
+ version: version,
110
+ updated_at: updated_at,
111
+ updating_user_id: updating_user_id,
112
+ value: value,
113
+ author_email: author_email,
114
+ author_name: author_name,
115
+ additional_properties: struct
116
+ )
117
+ end
118
+
119
+ # Serialize an instance of Note to a JSON object
120
+ #
121
+ # @return [String]
122
+ def to_json(*_args)
123
+ @_field_set&.to_json
124
+ end
125
+
126
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given
127
+ # hash and check each fields type against the current object's property
128
+ # definitions.
129
+ #
130
+ # @param obj [Object]
131
+ # @return [Void]
132
+ def self.validate_raw(obj:)
133
+ obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
134
+ obj.created_at.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
135
+ obj.organization_id.is_a?(String) != false || raise("Passed value for field obj.organization_id is not the expected type, validation failed.")
136
+ obj.deactivated.is_a?(Boolean) != false || raise("Passed value for field obj.deactivated is not the expected type, validation failed.")
137
+ obj.version.is_a?(Integer) != false || raise("Passed value for field obj.version is not the expected type, validation failed.")
138
+ obj.updated_at.is_a?(DateTime) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")
139
+ obj.updating_user_id.is_a?(String) != false || raise("Passed value for field obj.updating_user_id is not the expected type, validation failed.")
140
+ obj.value.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
141
+ obj.author_email&.is_a?(String) != false || raise("Passed value for field obj.author_email is not the expected type, validation failed.")
142
+ obj.author_name&.is_a?(String) != false || raise("Passed value for field obj.author_name is not the expected type, validation failed.")
143
+ end
144
+ end
145
+ end
146
+ end
147
+ end
148
+ end
149
+ end
@@ -110,11 +110,13 @@ module CandidApiClient
110
110
  # * :referrals (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Referral>)
111
111
  # * :primary_service_facility_id (String)
112
112
  # * :do_not_invoice_reason (CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason)
113
+ # * :note_ids (Array<String>)
114
+ # * :tag_ids (Array<String>)
113
115
  # @param request_options [CandidApiClient::RequestOptions]
114
116
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
115
117
  # @example
116
118
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
117
- # 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", authorization_number: "string", cpt_code: "string", units: VISIT }], 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 })
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", authorization_number: "string", cpt_code: "string", units: VISIT }], 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"] })
118
120
  def create(request:, skip_duplicate_check: nil, request_options: nil)
119
121
  response = @request_client.conn.post do |req|
120
122
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -224,11 +226,13 @@ module CandidApiClient
224
226
  # * :referrals (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Referral>)
225
227
  # * :primary_service_facility_id (String)
226
228
  # * :do_not_invoice_reason (CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason)
229
+ # * :note_ids (Array<String>)
230
+ # * :tag_ids (Array<String>)
227
231
  # @param request_options [CandidApiClient::RequestOptions]
228
232
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
229
233
  # @example
230
234
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
231
- # 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", authorization_number: "string", cpt_code: "string", units: VISIT }], 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 })
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", authorization_number: "string", cpt_code: "string", units: VISIT }], 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"] })
232
236
  def create_with_mrn(request:, skip_duplicate_check: nil, request_options: nil)
233
237
  response = @request_client.conn.post do |req|
234
238
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -429,6 +433,8 @@ module CandidApiClient
429
433
  # * :referrals (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Referral>)
430
434
  # * :primary_service_facility_id (String)
431
435
  # * :do_not_invoice_reason (CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason)
436
+ # * :note_ids (Array<String>)
437
+ # * :tag_ids (Array<String>)
432
438
  # @param request_options [CandidApiClient::RequestOptions]
433
439
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
434
440
  # @example
@@ -436,7 +442,7 @@ module CandidApiClient
436
442
  # api.pre_encounter.patients.v_1.update(
437
443
  # id: "string",
438
444
  # version: "string",
439
- # 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", authorization_number: "string", cpt_code: "string", units: VISIT }], 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 }
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", authorization_number: "string", cpt_code: "string", units: VISIT }], 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"] }
440
446
  # )
441
447
  def update(id:, version:, request:, request_options: nil)
442
448
  response = @request_client.conn.put do |req|
@@ -639,11 +645,13 @@ module CandidApiClient
639
645
  # * :referrals (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Referral>)
640
646
  # * :primary_service_facility_id (String)
641
647
  # * :do_not_invoice_reason (CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason)
648
+ # * :note_ids (Array<String>)
649
+ # * :tag_ids (Array<String>)
642
650
  # @param request_options [CandidApiClient::RequestOptions]
643
651
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
644
652
  # @example
645
653
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
646
- # 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", authorization_number: "string", cpt_code: "string", units: VISIT }], 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 })
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", authorization_number: "string", cpt_code: "string", units: VISIT }], 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"] })
647
655
  def create(request:, skip_duplicate_check: nil, request_options: nil)
648
656
  Async do
649
657
  response = @request_client.conn.post do |req|
@@ -755,11 +763,13 @@ module CandidApiClient
755
763
  # * :referrals (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Referral>)
756
764
  # * :primary_service_facility_id (String)
757
765
  # * :do_not_invoice_reason (CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason)
766
+ # * :note_ids (Array<String>)
767
+ # * :tag_ids (Array<String>)
758
768
  # @param request_options [CandidApiClient::RequestOptions]
759
769
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
760
770
  # @example
761
771
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
762
- # 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", authorization_number: "string", cpt_code: "string", units: VISIT }], 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 })
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", authorization_number: "string", cpt_code: "string", units: VISIT }], 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"] })
763
773
  def create_with_mrn(request:, skip_duplicate_check: nil, request_options: nil)
764
774
  Async do
765
775
  response = @request_client.conn.post do |req|
@@ -968,6 +978,8 @@ module CandidApiClient
968
978
  # * :referrals (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Referral>)
969
979
  # * :primary_service_facility_id (String)
970
980
  # * :do_not_invoice_reason (CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason)
981
+ # * :note_ids (Array<String>)
982
+ # * :tag_ids (Array<String>)
971
983
  # @param request_options [CandidApiClient::RequestOptions]
972
984
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
973
985
  # @example
@@ -975,7 +987,7 @@ module CandidApiClient
975
987
  # api.pre_encounter.patients.v_1.update(
976
988
  # id: "string",
977
989
  # version: "string",
978
- # 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", authorization_number: "string", cpt_code: "string", units: VISIT }], 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 }
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", authorization_number: "string", cpt_code: "string", units: VISIT }], 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"] }
979
991
  # )
980
992
  def update(id:, version:, request:, request_options: nil)
981
993
  Async do
@@ -100,6 +100,10 @@ module CandidApiClient
100
100
  attr_reader :primary_service_facility_id
101
101
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason] If this value is defined, the customer will not be invoiced.
102
102
  attr_reader :do_not_invoice_reason
103
+ # @return [Array<String>]
104
+ attr_reader :note_ids
105
+ # @return [Array<String>]
106
+ attr_reader :tag_ids
103
107
  # @return [OpenStruct] Additional properties unmapped to the current class definition
104
108
  attr_reader :additional_properties
105
109
  # @return [Object]
@@ -145,10 +149,12 @@ module CandidApiClient
145
149
  # @param referrals [Array<CandidApiClient::PreEncounter::Patients::V1::Types::Referral>]
146
150
  # @param primary_service_facility_id [String]
147
151
  # @param do_not_invoice_reason [CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason] If this value is defined, the customer will not be invoiced.
152
+ # @param note_ids [Array<String>]
153
+ # @param tag_ids [Array<String>]
148
154
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
149
155
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatient]
150
156
  def initialize(name:, other_names:, birth_date:, biological_sex:, primary_address:, other_addresses:,
151
- 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, additional_properties: nil)
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)
152
158
  @name = name
153
159
  @other_names = other_names
154
160
  @gender = gender if gender != OMIT
@@ -186,6 +192,8 @@ module CandidApiClient
186
192
  @referrals = referrals if referrals != OMIT
187
193
  @primary_service_facility_id = primary_service_facility_id if primary_service_facility_id != OMIT
188
194
  @do_not_invoice_reason = do_not_invoice_reason if do_not_invoice_reason != OMIT
195
+ @note_ids = note_ids if note_ids != OMIT
196
+ @tag_ids = tag_ids if tag_ids != OMIT
189
197
  @additional_properties = additional_properties
190
198
  @_field_set = {
191
199
  "name": name,
@@ -220,7 +228,9 @@ module CandidApiClient
220
228
  "authorizations": authorizations,
221
229
  "referrals": referrals,
222
230
  "primary_service_facility_id": primary_service_facility_id,
223
- "do_not_invoice_reason": do_not_invoice_reason
231
+ "do_not_invoice_reason": do_not_invoice_reason,
232
+ "note_ids": note_ids,
233
+ "tag_ids": tag_ids
224
234
  }.reject do |_k, v|
225
235
  v == OMIT
226
236
  end
@@ -320,6 +330,8 @@ module CandidApiClient
320
330
  end
321
331
  primary_service_facility_id = struct["primary_service_facility_id"]
322
332
  do_not_invoice_reason = struct["do_not_invoice_reason"]
333
+ note_ids = struct["note_ids"]
334
+ tag_ids = struct["tag_ids"]
323
335
  new(
324
336
  name: name,
325
337
  other_names: other_names,
@@ -354,6 +366,8 @@ module CandidApiClient
354
366
  referrals: referrals,
355
367
  primary_service_facility_id: primary_service_facility_id,
356
368
  do_not_invoice_reason: do_not_invoice_reason,
369
+ note_ids: note_ids,
370
+ tag_ids: tag_ids,
357
371
  additional_properties: struct
358
372
  )
359
373
  end
@@ -405,6 +419,8 @@ module CandidApiClient
405
419
  obj.referrals&.is_a?(Array) != false || raise("Passed value for field obj.referrals is not the expected type, validation failed.")
406
420
  obj.primary_service_facility_id&.is_a?(String) != false || raise("Passed value for field obj.primary_service_facility_id is not the expected type, validation failed.")
407
421
  obj.do_not_invoice_reason&.is_a?(CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason) != false || raise("Passed value for field obj.do_not_invoice_reason is not the expected type, validation failed.")
422
+ obj.note_ids&.is_a?(Array) != false || raise("Passed value for field obj.note_ids is not the expected type, validation failed.")
423
+ obj.tag_ids&.is_a?(Array) != false || raise("Passed value for field obj.tag_ids is not the expected type, validation failed.")
408
424
  end
409
425
  end
410
426
  end
@@ -101,6 +101,10 @@ module CandidApiClient
101
101
  attr_reader :primary_service_facility_id
102
102
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason] If this value is defined, the customer will not be invoiced.
103
103
  attr_reader :do_not_invoice_reason
104
+ # @return [Array<String>]
105
+ attr_reader :note_ids
106
+ # @return [Array<String>]
107
+ attr_reader :tag_ids
104
108
  # @return [OpenStruct] Additional properties unmapped to the current class definition
105
109
  attr_reader :additional_properties
106
110
  # @return [Object]
@@ -147,10 +151,12 @@ module CandidApiClient
147
151
  # @param referrals [Array<CandidApiClient::PreEncounter::Patients::V1::Types::Referral>]
148
152
  # @param primary_service_facility_id [String]
149
153
  # @param do_not_invoice_reason [CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason] If this value is defined, the customer will not be invoiced.
154
+ # @param note_ids [Array<String>]
155
+ # @param tag_ids [Array<String>]
150
156
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
151
157
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatientWithMrn]
152
158
  def initialize(mrn:, name:, other_names:, birth_date:, biological_sex:, primary_address:, other_addresses:,
153
- 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, additional_properties: nil)
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)
154
160
  @mrn = mrn
155
161
  @name = name
156
162
  @other_names = other_names
@@ -189,6 +195,8 @@ module CandidApiClient
189
195
  @referrals = referrals if referrals != OMIT
190
196
  @primary_service_facility_id = primary_service_facility_id if primary_service_facility_id != OMIT
191
197
  @do_not_invoice_reason = do_not_invoice_reason if do_not_invoice_reason != OMIT
198
+ @note_ids = note_ids if note_ids != OMIT
199
+ @tag_ids = tag_ids if tag_ids != OMIT
192
200
  @additional_properties = additional_properties
193
201
  @_field_set = {
194
202
  "mrn": mrn,
@@ -224,7 +232,9 @@ module CandidApiClient
224
232
  "authorizations": authorizations,
225
233
  "referrals": referrals,
226
234
  "primary_service_facility_id": primary_service_facility_id,
227
- "do_not_invoice_reason": do_not_invoice_reason
235
+ "do_not_invoice_reason": do_not_invoice_reason,
236
+ "note_ids": note_ids,
237
+ "tag_ids": tag_ids
228
238
  }.reject do |_k, v|
229
239
  v == OMIT
230
240
  end
@@ -325,6 +335,8 @@ module CandidApiClient
325
335
  end
326
336
  primary_service_facility_id = struct["primary_service_facility_id"]
327
337
  do_not_invoice_reason = struct["do_not_invoice_reason"]
338
+ note_ids = struct["note_ids"]
339
+ tag_ids = struct["tag_ids"]
328
340
  new(
329
341
  mrn: mrn,
330
342
  name: name,
@@ -360,6 +372,8 @@ module CandidApiClient
360
372
  referrals: referrals,
361
373
  primary_service_facility_id: primary_service_facility_id,
362
374
  do_not_invoice_reason: do_not_invoice_reason,
375
+ note_ids: note_ids,
376
+ tag_ids: tag_ids,
363
377
  additional_properties: struct
364
378
  )
365
379
  end
@@ -412,6 +426,8 @@ module CandidApiClient
412
426
  obj.referrals&.is_a?(Array) != false || raise("Passed value for field obj.referrals is not the expected type, validation failed.")
413
427
  obj.primary_service_facility_id&.is_a?(String) != false || raise("Passed value for field obj.primary_service_facility_id is not the expected type, validation failed.")
414
428
  obj.do_not_invoice_reason&.is_a?(CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason) != false || raise("Passed value for field obj.do_not_invoice_reason is not the expected type, validation failed.")
429
+ obj.note_ids&.is_a?(Array) != false || raise("Passed value for field obj.note_ids is not the expected type, validation failed.")
430
+ obj.tag_ids&.is_a?(Array) != false || raise("Passed value for field obj.tag_ids is not the expected type, validation failed.")
415
431
  end
416
432
  end
417
433
  end
@@ -37,17 +37,17 @@ module CandidApiClient
37
37
  # are of the form "YYMMDDXXXX", where "YYYYMMDD" is the date of patient creation
38
38
  # and "XXXX" is a zero-padded incrementing integer.
39
39
  attr_reader :mrn
40
- # @return [String] The organization that owns this patient.
40
+ # @return [String] The organization that owns this object.
41
41
  attr_reader :organization_id
42
- # @return [Boolean] True if the patient is deactivated. Deactivated patients are not returned in
42
+ # @return [Boolean] True if the object is deactivated. Deactivated objects are not returned in
43
43
  # search results but are returned in all other endpoints including scan.
44
44
  attr_reader :deactivated
45
- # @return [Integer] The version of the patient. Any update to any property of a patient object will
45
+ # @return [Integer] The version of the object. Any update to any property of an object object will
46
46
  # create a new version.
47
47
  attr_reader :version
48
48
  # @return [DateTime]
49
49
  attr_reader :updated_at
50
- # @return [String] The user ID of the user who last updated the patient.
50
+ # @return [String] The user ID of the user who last updated the object.
51
51
  attr_reader :updating_user_id
52
52
  # @return [CandidApiClient::PreEncounter::Common::Types::HumanName]
53
53
  attr_reader :name
@@ -119,6 +119,10 @@ module CandidApiClient
119
119
  attr_reader :primary_service_facility_id
120
120
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason] If this value is defined, the customer will not be invoiced.
121
121
  attr_reader :do_not_invoice_reason
122
+ # @return [Array<String>]
123
+ attr_reader :note_ids
124
+ # @return [Array<String>]
125
+ attr_reader :tag_ids
122
126
  # @return [OpenStruct] Additional properties unmapped to the current class definition
123
127
  attr_reader :additional_properties
124
128
  # @return [Object]
@@ -132,13 +136,13 @@ module CandidApiClient
132
136
  # @param mrn [String] The medical record number for the patient. Human-friendly Candid generated MRNs
133
137
  # are of the form "YYMMDDXXXX", where "YYYYMMDD" is the date of patient creation
134
138
  # and "XXXX" is a zero-padded incrementing integer.
135
- # @param organization_id [String] The organization that owns this patient.
136
- # @param deactivated [Boolean] True if the patient is deactivated. Deactivated patients are not returned in
139
+ # @param organization_id [String] The organization that owns this object.
140
+ # @param deactivated [Boolean] True if the object is deactivated. Deactivated objects are not returned in
137
141
  # search results but are returned in all other endpoints including scan.
138
- # @param version [Integer] The version of the patient. Any update to any property of a patient object will
142
+ # @param version [Integer] The version of the object. Any update to any property of an object object will
139
143
  # create a new version.
140
144
  # @param updated_at [DateTime]
141
- # @param updating_user_id [String] The user ID of the user who last updated the patient.
145
+ # @param updating_user_id [String] The user ID of the user who last updated the object.
142
146
  # @param name [CandidApiClient::PreEncounter::Common::Types::HumanName]
143
147
  # @param other_names [Array<CandidApiClient::PreEncounter::Common::Types::HumanName>] Other names for the patient.
144
148
  # @param gender [CandidApiClient::PreEncounter::Common::Types::Gender]
@@ -176,10 +180,12 @@ module CandidApiClient
176
180
  # @param referrals [Array<CandidApiClient::PreEncounter::Patients::V1::Types::Referral>]
177
181
  # @param primary_service_facility_id [String]
178
182
  # @param do_not_invoice_reason [CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason] If this value is defined, the customer will not be invoiced.
183
+ # @param note_ids [Array<String>]
184
+ # @param tag_ids [Array<String>]
179
185
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
180
186
  # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
181
187
  def initialize(id:, mrn:, organization_id:, deactivated:, version:, updated_at:, updating_user_id:, name:,
182
- 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, additional_properties: nil)
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)
183
189
  @id = id
184
190
  @mrn = mrn
185
191
  @organization_id = organization_id
@@ -224,6 +230,8 @@ module CandidApiClient
224
230
  @referrals = referrals if referrals != OMIT
225
231
  @primary_service_facility_id = primary_service_facility_id if primary_service_facility_id != OMIT
226
232
  @do_not_invoice_reason = do_not_invoice_reason if do_not_invoice_reason != OMIT
233
+ @note_ids = note_ids if note_ids != OMIT
234
+ @tag_ids = tag_ids if tag_ids != OMIT
227
235
  @additional_properties = additional_properties
228
236
  @_field_set = {
229
237
  "id": id,
@@ -265,7 +273,9 @@ module CandidApiClient
265
273
  "authorizations": authorizations,
266
274
  "referrals": referrals,
267
275
  "primary_service_facility_id": primary_service_facility_id,
268
- "do_not_invoice_reason": do_not_invoice_reason
276
+ "do_not_invoice_reason": do_not_invoice_reason,
277
+ "note_ids": note_ids,
278
+ "tag_ids": tag_ids
269
279
  }.reject do |_k, v|
270
280
  v == OMIT
271
281
  end
@@ -372,6 +382,8 @@ module CandidApiClient
372
382
  end
373
383
  primary_service_facility_id = struct["primary_service_facility_id"]
374
384
  do_not_invoice_reason = struct["do_not_invoice_reason"]
385
+ note_ids = struct["note_ids"]
386
+ tag_ids = struct["tag_ids"]
375
387
  new(
376
388
  id: id,
377
389
  mrn: mrn,
@@ -413,6 +425,8 @@ module CandidApiClient
413
425
  referrals: referrals,
414
426
  primary_service_facility_id: primary_service_facility_id,
415
427
  do_not_invoice_reason: do_not_invoice_reason,
428
+ note_ids: note_ids,
429
+ tag_ids: tag_ids,
416
430
  additional_properties: struct
417
431
  )
418
432
  end
@@ -471,6 +485,8 @@ module CandidApiClient
471
485
  obj.referrals&.is_a?(Array) != false || raise("Passed value for field obj.referrals is not the expected type, validation failed.")
472
486
  obj.primary_service_facility_id&.is_a?(String) != false || raise("Passed value for field obj.primary_service_facility_id is not the expected type, validation failed.")
473
487
  obj.do_not_invoice_reason&.is_a?(CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason) != false || raise("Passed value for field obj.do_not_invoice_reason is not the expected type, validation failed.")
488
+ obj.note_ids&.is_a?(Array) != false || raise("Passed value for field obj.note_ids is not the expected type, validation failed.")
489
+ obj.tag_ids&.is_a?(Array) != false || raise("Passed value for field obj.tag_ids is not the expected type, validation failed.")
474
490
  end
475
491
  end
476
492
  end
@@ -0,0 +1,32 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "../../../requests"
4
+ require_relative "v_1/client"
5
+
6
+ module CandidApiClient
7
+ module PreEncounter
8
+ module Tags
9
+ class Client
10
+ # @return [CandidApiClient::PreEncounter::Tags::V1::V1Client]
11
+ attr_reader :v_1
12
+
13
+ # @param request_client [CandidApiClient::RequestClient]
14
+ # @return [CandidApiClient::PreEncounter::Tags::Client]
15
+ def initialize(request_client:)
16
+ @v_1 = CandidApiClient::PreEncounter::Tags::V1::V1Client.new(request_client: request_client)
17
+ end
18
+ end
19
+
20
+ class AsyncClient
21
+ # @return [CandidApiClient::PreEncounter::Tags::V1::AsyncV1Client]
22
+ attr_reader :v_1
23
+
24
+ # @param request_client [CandidApiClient::AsyncRequestClient]
25
+ # @return [CandidApiClient::PreEncounter::Tags::AsyncClient]
26
+ def initialize(request_client:)
27
+ @v_1 = CandidApiClient::PreEncounter::Tags::V1::AsyncV1Client.new(request_client: request_client)
28
+ end
29
+ end
30
+ end
31
+ end
32
+ end