candidhealth 0.45.0 → 0.46.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/candidhealth/billing_notes/v_2/client.rb +2 -2
- data/lib/candidhealth/charge_capture/v_1/client.rb +10 -94
- data/lib/candidhealth/charge_capture/v_1/types/charge_capture_data.rb +16 -16
- data/lib/candidhealth/charge_capture_bundles/v_1/client.rb +2 -44
- data/lib/candidhealth/contracts/v_2/client.rb +18 -34
- data/lib/candidhealth/contracts/v_2/types/contract_sort_field.rb +18 -0
- data/lib/candidhealth/credentialing/v_2/client.rb +6 -44
- data/lib/candidhealth/diagnoses/client.rb +4 -14
- data/lib/candidhealth/eligibility/v_2/client.rb +4 -4
- data/lib/candidhealth/encounter_attachments/v_1/client.rb +0 -6
- data/lib/candidhealth/encounter_providers/v_2/client.rb +16 -16
- data/lib/candidhealth/encounters/v_4/client.rb +38 -102
- data/lib/candidhealth/encounters/v_4/types/encounter.rb +12 -12
- data/lib/candidhealth/encounters/v_4/types/encounter_base.rb +10 -10
- data/lib/candidhealth/encounters/v_4/types/encounter_create_from_pre_encounter.rb +10 -10
- data/lib/candidhealth/encounters/v_4/types/encounter_optional.rb +14 -14
- data/lib/candidhealth/expected_network_status/v_1/client.rb +12 -18
- data/lib/candidhealth/expected_network_status/v_2/client.rb +4 -4
- data/lib/candidhealth/expected_network_status/v_2/types/empty_object.rb +53 -0
- data/lib/candidhealth/expected_network_status/v_2/types/insurance_type_codes.rb +13 -10
- data/lib/candidhealth/external_payment_account_config/v_1/client.rb +2 -2
- data/lib/candidhealth/fee_schedules/v_3/client.rb +12 -68
- data/lib/candidhealth/fee_schedules/v_3/types/payer_threshold.rb +3 -3
- data/lib/candidhealth/fee_schedules/v_3/types/rate_entry.rb +2 -2
- data/lib/candidhealth/guarantor/v_1/client.rb +4 -4
- data/lib/candidhealth/import_invoice/v_1/client.rb +6 -28
- data/lib/candidhealth/insurance_adjudications/v_1/client.rb +2 -2
- data/lib/candidhealth/insurance_payments/v_1/client.rb +2 -20
- data/lib/candidhealth/insurance_refunds/v_1/client.rb +6 -24
- data/lib/candidhealth/medication_dispense/v_1/client.rb +2 -2
- data/lib/candidhealth/non_insurance_payer_payments/v_1/client.rb +6 -22
- data/lib/candidhealth/non_insurance_payer_refunds/v_1/client.rb +6 -22
- data/lib/candidhealth/non_insurance_payers/v_1/client.rb +6 -22
- data/lib/candidhealth/organization_providers/v_3/client.rb +4 -4
- data/lib/candidhealth/organization_service_facilities/v_2/client.rb +2 -2
- data/lib/candidhealth/patient_payments/v_4/client.rb +8 -38
- data/lib/candidhealth/patient_refunds/v_1/client.rb +8 -40
- data/lib/candidhealth/payer_plan_groups/v_1/client.rb +6 -30
- data/lib/candidhealth/pre_encounter/appointments/v_1/client.rb +32 -44
- data/lib/candidhealth/pre_encounter/appointments/v_1/types/appointment.rb +4 -4
- data/lib/candidhealth/pre_encounter/common/types/base_model.rb +4 -4
- data/lib/candidhealth/pre_encounter/coverages/v_1/client.rb +24 -34
- data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage.rb +4 -4
- data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/client.rb +2 -2
- data/lib/candidhealth/pre_encounter/images/v_1/client.rb +20 -20
- data/lib/candidhealth/pre_encounter/images/v_1/types/image.rb +6 -6
- data/lib/candidhealth/pre_encounter/lists/v_1/client.rb +4 -28
- data/lib/candidhealth/pre_encounter/notes/v_1/client.rb +14 -14
- data/lib/candidhealth/pre_encounter/notes/v_1/types/note.rb +4 -4
- data/lib/candidhealth/pre_encounter/patients/v_1/client.rb +56 -68
- data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient.rb +8 -8
- data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient_with_mrn.rb +8 -8
- data/lib/candidhealth/pre_encounter/patients/v_1/types/patient.rb +16 -16
- data/lib/candidhealth/pre_encounter/tags/v_1/client.rb +16 -16
- data/lib/candidhealth/pre_encounter/tags/v_1/types/tag.rb +4 -4
- data/lib/candidhealth/service_facility/client.rb +2 -2
- data/lib/candidhealth/service_lines/v_2/client.rb +4 -4
- data/lib/candidhealth/superbills/v_1/client.rb +4 -6
- data/lib/candidhealth/tasks/v_3/client.rb +6 -34
- data/lib/candidhealth/write_offs/v_1/client.rb +2 -24
- data/lib/environment.rb +4 -0
- data/lib/requests.rb +2 -2
- data/lib/types_export.rb +2 -0
- metadata +4 -2
|
@@ -25,7 +25,7 @@ module CandidApiClient
|
|
|
25
25
|
@request_client = request_client
|
|
26
26
|
end
|
|
27
27
|
|
|
28
|
-
# Adds a patient.
|
|
28
|
+
# Adds a patient. VersionConflictError is returned when the patient's external ID
|
|
29
29
|
# is already in use.
|
|
30
30
|
#
|
|
31
31
|
# @param skip_duplicate_check [Boolean]
|
|
@@ -121,7 +121,7 @@ module CandidApiClient
|
|
|
121
121
|
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
|
|
122
122
|
# @example
|
|
123
123
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
124
|
-
# api.pre_encounter.patients.v_1.create(
|
|
124
|
+
# api.pre_encounter.patients.v_1.create(request: { name: { family: "family", given: ["given", "given"], use: USUAL }, other_names: [{ family: "family", given: ["given", "given"], use: USUAL }, { family: "family", given: ["given", "given"], use: USUAL }], birth_date: DateTime.parse(2023-01-15), biological_sex: FEMALE, primary_address: { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, other_addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }], primary_telecom: { value: "value", use: HOME }, other_telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], contacts: [{ relationship: [SELF, SELF], name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }] }, { relationship: [SELF, SELF], name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }] }], general_practitioners: [{ name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }] }, { name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }] }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] } })
|
|
125
125
|
def create(request:, skip_duplicate_check: nil, request_options: nil)
|
|
126
126
|
response = @request_client.conn.post do |req|
|
|
127
127
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
@@ -142,10 +142,10 @@ module CandidApiClient
|
|
|
142
142
|
CandidApiClient::PreEncounter::Patients::V1::Types::Patient.from_json(json_object: response.body)
|
|
143
143
|
end
|
|
144
144
|
|
|
145
|
-
# Adds a patient and hydrates their MRN with a pre-existing MRN.
|
|
146
|
-
# is created their MRN will not be editable. BadRequestError is returned
|
|
147
|
-
# MRN is greater than 20 characters. VersionConflictError is returned
|
|
148
|
-
# patient's external ID is already in use.
|
|
145
|
+
# Adds a patient and hydrates their MRN with a pre-existing MRN. Once this
|
|
146
|
+
# patient is created their MRN will not be editable. BadRequestError is returned
|
|
147
|
+
# when the MRN is greater than 20 characters. VersionConflictError is returned
|
|
148
|
+
# when the patient's external ID is already in use.
|
|
149
149
|
#
|
|
150
150
|
# @param skip_duplicate_check [Boolean]
|
|
151
151
|
# @param request [Hash] Request of type CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatientWithMrn, as a Hash
|
|
@@ -241,7 +241,7 @@ module CandidApiClient
|
|
|
241
241
|
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
|
|
242
242
|
# @example
|
|
243
243
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
244
|
-
# api.pre_encounter.patients.v_1.create_with_mrn(
|
|
244
|
+
# api.pre_encounter.patients.v_1.create_with_mrn(request: { name: { family: "family", given: ["given", "given"], use: USUAL }, other_names: [{ family: "family", given: ["given", "given"], use: USUAL }, { family: "family", given: ["given", "given"], use: USUAL }], birth_date: DateTime.parse(2023-01-15), biological_sex: FEMALE, primary_address: { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, other_addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }], primary_telecom: { value: "value", use: HOME }, other_telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], contacts: [{ relationship: [SELF, SELF], name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }] }, { relationship: [SELF, SELF], name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }] }], general_practitioners: [{ name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }] }, { name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }] }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] }, mrn: "mrn" })
|
|
245
245
|
def create_with_mrn(request:, skip_duplicate_check: nil, request_options: nil)
|
|
246
246
|
response = @request_client.conn.post do |req|
|
|
247
247
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
@@ -273,13 +273,7 @@ module CandidApiClient
|
|
|
273
273
|
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::PatientPage]
|
|
274
274
|
# @example
|
|
275
275
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
276
|
-
# api.pre_encounter.patients.v_1.get_multi
|
|
277
|
-
# limit: 1,
|
|
278
|
-
# mrn: "string",
|
|
279
|
-
# page_token: "string",
|
|
280
|
-
# sort_field: "string",
|
|
281
|
-
# sort_direction: ASC
|
|
282
|
-
# )
|
|
276
|
+
# api.pre_encounter.patients.v_1.get_multi
|
|
283
277
|
def get_multi(limit: nil, mrn: nil, page_token: nil, sort_field: nil, sort_direction: nil,
|
|
284
278
|
request_options: nil)
|
|
285
279
|
response = @request_client.conn.get do |req|
|
|
@@ -304,7 +298,7 @@ module CandidApiClient
|
|
|
304
298
|
CandidApiClient::PreEncounter::Patients::V1::Types::PatientPage.from_json(json_object: response.body)
|
|
305
299
|
end
|
|
306
300
|
|
|
307
|
-
# Searches for referring providers that match the query parameters.
|
|
301
|
+
# Searches for referring providers that match the query parameters. The search is
|
|
308
302
|
# case-insensitive, supports fuzzy matching, and matches against provider name and
|
|
309
303
|
# NPI. The search criteria must be an alphanumeric string, and the search is
|
|
310
304
|
# limited to the first 20 results.
|
|
@@ -314,7 +308,7 @@ module CandidApiClient
|
|
|
314
308
|
# @return [Array<CandidApiClient::PreEncounter::Common::Types::ExternalProvider>]
|
|
315
309
|
# @example
|
|
316
310
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
317
|
-
# api.pre_encounter.patients.v_1.search_providers(search_criteria: "
|
|
311
|
+
# api.pre_encounter.patients.v_1.search_providers(search_criteria: "search_criteria")
|
|
318
312
|
def search_providers(search_criteria:, request_options: nil)
|
|
319
313
|
response = @request_client.conn.get do |req|
|
|
320
314
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
@@ -345,7 +339,7 @@ module CandidApiClient
|
|
|
345
339
|
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
|
|
346
340
|
# @example
|
|
347
341
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
348
|
-
# api.pre_encounter.patients.v_1.get(id: "
|
|
342
|
+
# api.pre_encounter.patients.v_1.get(id: "id")
|
|
349
343
|
def get(id:, request_options: nil)
|
|
350
344
|
response = @request_client.conn.get do |req|
|
|
351
345
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
@@ -361,7 +355,7 @@ module CandidApiClient
|
|
|
361
355
|
CandidApiClient::PreEncounter::Patients::V1::Types::Patient.from_json(json_object: response.body)
|
|
362
356
|
end
|
|
363
357
|
|
|
364
|
-
# Gets a patient along with it's full history.
|
|
358
|
+
# Gets a patient along with it's full history. The return list is ordered by
|
|
365
359
|
# version ascending.
|
|
366
360
|
#
|
|
367
361
|
# @param id [String]
|
|
@@ -369,7 +363,7 @@ module CandidApiClient
|
|
|
369
363
|
# @return [Array<CandidApiClient::PreEncounter::Patients::V1::Types::Patient>]
|
|
370
364
|
# @example
|
|
371
365
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
372
|
-
# api.pre_encounter.patients.v_1.get_history(id: "
|
|
366
|
+
# api.pre_encounter.patients.v_1.get_history(id: "id")
|
|
373
367
|
def get_history(id:, request_options: nil)
|
|
374
368
|
response = @request_client.conn.get do |req|
|
|
375
369
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
@@ -389,8 +383,8 @@ module CandidApiClient
|
|
|
389
383
|
end
|
|
390
384
|
end
|
|
391
385
|
|
|
392
|
-
# Updates a patient.
|
|
393
|
-
# conditions.
|
|
386
|
+
# Updates a patient. The path must contain the most recent version to prevent
|
|
387
|
+
# race conditions. Updating historic versions is not supported.
|
|
394
388
|
#
|
|
395
389
|
# @param id [String]
|
|
396
390
|
# @param version [String]
|
|
@@ -487,9 +481,9 @@ module CandidApiClient
|
|
|
487
481
|
# @example
|
|
488
482
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
489
483
|
# api.pre_encounter.patients.v_1.update(
|
|
490
|
-
# id: "
|
|
491
|
-
# version: "
|
|
492
|
-
# request: { name: { family: "
|
|
484
|
+
# id: "id",
|
|
485
|
+
# version: "version",
|
|
486
|
+
# request: { name: { family: "family", given: ["given", "given"], use: USUAL }, other_names: [{ family: "family", given: ["given", "given"], use: USUAL }, { family: "family", given: ["given", "given"], use: USUAL }], birth_date: DateTime.parse(2023-01-15), biological_sex: FEMALE, primary_address: { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, other_addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }], primary_telecom: { value: "value", use: HOME }, other_telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], contacts: [{ relationship: [SELF, SELF], name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }] }, { relationship: [SELF, SELF], name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }] }], general_practitioners: [{ name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }] }, { name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }] }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] } }
|
|
493
487
|
# )
|
|
494
488
|
def update(id:, version:, request:, request_options: nil)
|
|
495
489
|
response = @request_client.conn.put do |req|
|
|
@@ -507,8 +501,8 @@ module CandidApiClient
|
|
|
507
501
|
CandidApiClient::PreEncounter::Patients::V1::Types::Patient.from_json(json_object: response.body)
|
|
508
502
|
end
|
|
509
503
|
|
|
510
|
-
# Sets a patient as deactivated.
|
|
511
|
-
# plus 1 to prevent race conditions.
|
|
504
|
+
# Sets a patient as deactivated. The path must contain the most recent version
|
|
505
|
+
# plus 1 to prevent race conditions. Deactivating historic versions is not
|
|
512
506
|
# supported.
|
|
513
507
|
#
|
|
514
508
|
# @param id [String]
|
|
@@ -517,7 +511,7 @@ module CandidApiClient
|
|
|
517
511
|
# @return [Void]
|
|
518
512
|
# @example
|
|
519
513
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
520
|
-
# api.pre_encounter.patients.v_1.deactivate(id: "
|
|
514
|
+
# api.pre_encounter.patients.v_1.deactivate(id: "id", version: "version")
|
|
521
515
|
def deactivate(id:, version:, request_options: nil)
|
|
522
516
|
@request_client.conn.delete do |req|
|
|
523
517
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
@@ -532,9 +526,9 @@ module CandidApiClient
|
|
|
532
526
|
end
|
|
533
527
|
end
|
|
534
528
|
|
|
535
|
-
# Removes the deactivated flag for a patient.
|
|
536
|
-
# recent version plus 1 to prevent race conditions.
|
|
537
|
-
# is not supported.
|
|
529
|
+
# Removes the deactivated flag for a patient. The path must contain the most
|
|
530
|
+
# recent version plus 1 to prevent race conditions. Reactivating historic
|
|
531
|
+
# versions is not supported.
|
|
538
532
|
#
|
|
539
533
|
# @param id [String]
|
|
540
534
|
# @param version [String]
|
|
@@ -542,7 +536,7 @@ module CandidApiClient
|
|
|
542
536
|
# @return [Void]
|
|
543
537
|
# @example
|
|
544
538
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
545
|
-
# api.pre_encounter.patients.v_1.reactivate(id: "
|
|
539
|
+
# api.pre_encounter.patients.v_1.reactivate(id: "id", version: "version")
|
|
546
540
|
def reactivate(id:, version:, request_options: nil)
|
|
547
541
|
@request_client.conn.patch do |req|
|
|
548
542
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
@@ -565,7 +559,7 @@ module CandidApiClient
|
|
|
565
559
|
# @return [Array<CandidApiClient::PreEncounter::Patients::V1::Types::Patient>]
|
|
566
560
|
# @example
|
|
567
561
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
568
|
-
# api.pre_encounter.patients.v_1.search
|
|
562
|
+
# api.pre_encounter.patients.v_1.search
|
|
569
563
|
def search(mrn: nil, similar_name_ordering: nil, request_options: nil)
|
|
570
564
|
response = @request_client.conn.get do |req|
|
|
571
565
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
@@ -590,8 +584,8 @@ module CandidApiClient
|
|
|
590
584
|
end
|
|
591
585
|
end
|
|
592
586
|
|
|
593
|
-
# Scans up to 100 patient updates.
|
|
594
|
-
# result list is ordered by updatedAt ascending.
|
|
587
|
+
# Scans up to 100 patient updates. The since query parameter is inclusive, and
|
|
588
|
+
# the result list is ordered by updatedAt ascending.
|
|
595
589
|
#
|
|
596
590
|
# @param since [DateTime]
|
|
597
591
|
# @param request_options [CandidApiClient::RequestOptions]
|
|
@@ -630,7 +624,7 @@ module CandidApiClient
|
|
|
630
624
|
@request_client = request_client
|
|
631
625
|
end
|
|
632
626
|
|
|
633
|
-
# Adds a patient.
|
|
627
|
+
# Adds a patient. VersionConflictError is returned when the patient's external ID
|
|
634
628
|
# is already in use.
|
|
635
629
|
#
|
|
636
630
|
# @param skip_duplicate_check [Boolean]
|
|
@@ -726,7 +720,7 @@ module CandidApiClient
|
|
|
726
720
|
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
|
|
727
721
|
# @example
|
|
728
722
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
729
|
-
# api.pre_encounter.patients.v_1.create(
|
|
723
|
+
# api.pre_encounter.patients.v_1.create(request: { name: { family: "family", given: ["given", "given"], use: USUAL }, other_names: [{ family: "family", given: ["given", "given"], use: USUAL }, { family: "family", given: ["given", "given"], use: USUAL }], birth_date: DateTime.parse(2023-01-15), biological_sex: FEMALE, primary_address: { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, other_addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }], primary_telecom: { value: "value", use: HOME }, other_telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], contacts: [{ relationship: [SELF, SELF], name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }] }, { relationship: [SELF, SELF], name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }] }], general_practitioners: [{ name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }] }, { name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }] }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] } })
|
|
730
724
|
def create(request:, skip_duplicate_check: nil, request_options: nil)
|
|
731
725
|
Async do
|
|
732
726
|
response = @request_client.conn.post do |req|
|
|
@@ -749,10 +743,10 @@ module CandidApiClient
|
|
|
749
743
|
end
|
|
750
744
|
end
|
|
751
745
|
|
|
752
|
-
# Adds a patient and hydrates their MRN with a pre-existing MRN.
|
|
753
|
-
# is created their MRN will not be editable. BadRequestError is returned
|
|
754
|
-
# MRN is greater than 20 characters. VersionConflictError is returned
|
|
755
|
-
# patient's external ID is already in use.
|
|
746
|
+
# Adds a patient and hydrates their MRN with a pre-existing MRN. Once this
|
|
747
|
+
# patient is created their MRN will not be editable. BadRequestError is returned
|
|
748
|
+
# when the MRN is greater than 20 characters. VersionConflictError is returned
|
|
749
|
+
# when the patient's external ID is already in use.
|
|
756
750
|
#
|
|
757
751
|
# @param skip_duplicate_check [Boolean]
|
|
758
752
|
# @param request [Hash] Request of type CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatientWithMrn, as a Hash
|
|
@@ -848,7 +842,7 @@ module CandidApiClient
|
|
|
848
842
|
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
|
|
849
843
|
# @example
|
|
850
844
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
851
|
-
# api.pre_encounter.patients.v_1.create_with_mrn(
|
|
845
|
+
# api.pre_encounter.patients.v_1.create_with_mrn(request: { name: { family: "family", given: ["given", "given"], use: USUAL }, other_names: [{ family: "family", given: ["given", "given"], use: USUAL }, { family: "family", given: ["given", "given"], use: USUAL }], birth_date: DateTime.parse(2023-01-15), biological_sex: FEMALE, primary_address: { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, other_addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }], primary_telecom: { value: "value", use: HOME }, other_telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], contacts: [{ relationship: [SELF, SELF], name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }] }, { relationship: [SELF, SELF], name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }] }], general_practitioners: [{ name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }] }, { name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }] }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] }, mrn: "mrn" })
|
|
852
846
|
def create_with_mrn(request:, skip_duplicate_check: nil, request_options: nil)
|
|
853
847
|
Async do
|
|
854
848
|
response = @request_client.conn.post do |req|
|
|
@@ -882,13 +876,7 @@ module CandidApiClient
|
|
|
882
876
|
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::PatientPage]
|
|
883
877
|
# @example
|
|
884
878
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
885
|
-
# api.pre_encounter.patients.v_1.get_multi
|
|
886
|
-
# limit: 1,
|
|
887
|
-
# mrn: "string",
|
|
888
|
-
# page_token: "string",
|
|
889
|
-
# sort_field: "string",
|
|
890
|
-
# sort_direction: ASC
|
|
891
|
-
# )
|
|
879
|
+
# api.pre_encounter.patients.v_1.get_multi
|
|
892
880
|
def get_multi(limit: nil, mrn: nil, page_token: nil, sort_field: nil, sort_direction: nil,
|
|
893
881
|
request_options: nil)
|
|
894
882
|
Async do
|
|
@@ -915,7 +903,7 @@ module CandidApiClient
|
|
|
915
903
|
end
|
|
916
904
|
end
|
|
917
905
|
|
|
918
|
-
# Searches for referring providers that match the query parameters.
|
|
906
|
+
# Searches for referring providers that match the query parameters. The search is
|
|
919
907
|
# case-insensitive, supports fuzzy matching, and matches against provider name and
|
|
920
908
|
# NPI. The search criteria must be an alphanumeric string, and the search is
|
|
921
909
|
# limited to the first 20 results.
|
|
@@ -925,7 +913,7 @@ module CandidApiClient
|
|
|
925
913
|
# @return [Array<CandidApiClient::PreEncounter::Common::Types::ExternalProvider>]
|
|
926
914
|
# @example
|
|
927
915
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
928
|
-
# api.pre_encounter.patients.v_1.search_providers(search_criteria: "
|
|
916
|
+
# api.pre_encounter.patients.v_1.search_providers(search_criteria: "search_criteria")
|
|
929
917
|
def search_providers(search_criteria:, request_options: nil)
|
|
930
918
|
Async do
|
|
931
919
|
response = @request_client.conn.get do |req|
|
|
@@ -958,7 +946,7 @@ module CandidApiClient
|
|
|
958
946
|
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
|
|
959
947
|
# @example
|
|
960
948
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
961
|
-
# api.pre_encounter.patients.v_1.get(id: "
|
|
949
|
+
# api.pre_encounter.patients.v_1.get(id: "id")
|
|
962
950
|
def get(id:, request_options: nil)
|
|
963
951
|
Async do
|
|
964
952
|
response = @request_client.conn.get do |req|
|
|
@@ -976,7 +964,7 @@ module CandidApiClient
|
|
|
976
964
|
end
|
|
977
965
|
end
|
|
978
966
|
|
|
979
|
-
# Gets a patient along with it's full history.
|
|
967
|
+
# Gets a patient along with it's full history. The return list is ordered by
|
|
980
968
|
# version ascending.
|
|
981
969
|
#
|
|
982
970
|
# @param id [String]
|
|
@@ -984,7 +972,7 @@ module CandidApiClient
|
|
|
984
972
|
# @return [Array<CandidApiClient::PreEncounter::Patients::V1::Types::Patient>]
|
|
985
973
|
# @example
|
|
986
974
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
987
|
-
# api.pre_encounter.patients.v_1.get_history(id: "
|
|
975
|
+
# api.pre_encounter.patients.v_1.get_history(id: "id")
|
|
988
976
|
def get_history(id:, request_options: nil)
|
|
989
977
|
Async do
|
|
990
978
|
response = @request_client.conn.get do |req|
|
|
@@ -1006,8 +994,8 @@ module CandidApiClient
|
|
|
1006
994
|
end
|
|
1007
995
|
end
|
|
1008
996
|
|
|
1009
|
-
# Updates a patient.
|
|
1010
|
-
# conditions.
|
|
997
|
+
# Updates a patient. The path must contain the most recent version to prevent
|
|
998
|
+
# race conditions. Updating historic versions is not supported.
|
|
1011
999
|
#
|
|
1012
1000
|
# @param id [String]
|
|
1013
1001
|
# @param version [String]
|
|
@@ -1104,9 +1092,9 @@ module CandidApiClient
|
|
|
1104
1092
|
# @example
|
|
1105
1093
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
1106
1094
|
# api.pre_encounter.patients.v_1.update(
|
|
1107
|
-
# id: "
|
|
1108
|
-
# version: "
|
|
1109
|
-
# request: { name: { family: "
|
|
1095
|
+
# id: "id",
|
|
1096
|
+
# version: "version",
|
|
1097
|
+
# request: { name: { family: "family", given: ["given", "given"], use: USUAL }, other_names: [{ family: "family", given: ["given", "given"], use: USUAL }, { family: "family", given: ["given", "given"], use: USUAL }], birth_date: DateTime.parse(2023-01-15), biological_sex: FEMALE, primary_address: { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, other_addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }], primary_telecom: { value: "value", use: HOME }, other_telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], contacts: [{ relationship: [SELF, SELF], name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }] }, { relationship: [SELF, SELF], name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }], addresses: [{ use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }, { use: HOME, line: ["line", "line"], city: "city", state: "state", postal_code: "postal_code", country: "country" }] }], general_practitioners: [{ name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }] }, { name: { family: "family", given: ["given", "given"], use: USUAL }, telecoms: [{ value: "value", use: HOME }, { value: "value", use: HOME }] }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] } }
|
|
1110
1098
|
# )
|
|
1111
1099
|
def update(id:, version:, request:, request_options: nil)
|
|
1112
1100
|
Async do
|
|
@@ -1126,8 +1114,8 @@ module CandidApiClient
|
|
|
1126
1114
|
end
|
|
1127
1115
|
end
|
|
1128
1116
|
|
|
1129
|
-
# Sets a patient as deactivated.
|
|
1130
|
-
# plus 1 to prevent race conditions.
|
|
1117
|
+
# Sets a patient as deactivated. The path must contain the most recent version
|
|
1118
|
+
# plus 1 to prevent race conditions. Deactivating historic versions is not
|
|
1131
1119
|
# supported.
|
|
1132
1120
|
#
|
|
1133
1121
|
# @param id [String]
|
|
@@ -1136,7 +1124,7 @@ module CandidApiClient
|
|
|
1136
1124
|
# @return [Void]
|
|
1137
1125
|
# @example
|
|
1138
1126
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
1139
|
-
# api.pre_encounter.patients.v_1.deactivate(id: "
|
|
1127
|
+
# api.pre_encounter.patients.v_1.deactivate(id: "id", version: "version")
|
|
1140
1128
|
def deactivate(id:, version:, request_options: nil)
|
|
1141
1129
|
Async do
|
|
1142
1130
|
@request_client.conn.delete do |req|
|
|
@@ -1153,9 +1141,9 @@ module CandidApiClient
|
|
|
1153
1141
|
end
|
|
1154
1142
|
end
|
|
1155
1143
|
|
|
1156
|
-
# Removes the deactivated flag for a patient.
|
|
1157
|
-
# recent version plus 1 to prevent race conditions.
|
|
1158
|
-
# is not supported.
|
|
1144
|
+
# Removes the deactivated flag for a patient. The path must contain the most
|
|
1145
|
+
# recent version plus 1 to prevent race conditions. Reactivating historic
|
|
1146
|
+
# versions is not supported.
|
|
1159
1147
|
#
|
|
1160
1148
|
# @param id [String]
|
|
1161
1149
|
# @param version [String]
|
|
@@ -1163,7 +1151,7 @@ module CandidApiClient
|
|
|
1163
1151
|
# @return [Void]
|
|
1164
1152
|
# @example
|
|
1165
1153
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
1166
|
-
# api.pre_encounter.patients.v_1.reactivate(id: "
|
|
1154
|
+
# api.pre_encounter.patients.v_1.reactivate(id: "id", version: "version")
|
|
1167
1155
|
def reactivate(id:, version:, request_options: nil)
|
|
1168
1156
|
Async do
|
|
1169
1157
|
@request_client.conn.patch do |req|
|
|
@@ -1188,7 +1176,7 @@ module CandidApiClient
|
|
|
1188
1176
|
# @return [Array<CandidApiClient::PreEncounter::Patients::V1::Types::Patient>]
|
|
1189
1177
|
# @example
|
|
1190
1178
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
1191
|
-
# api.pre_encounter.patients.v_1.search
|
|
1179
|
+
# api.pre_encounter.patients.v_1.search
|
|
1192
1180
|
def search(mrn: nil, similar_name_ordering: nil, request_options: nil)
|
|
1193
1181
|
Async do
|
|
1194
1182
|
response = @request_client.conn.get do |req|
|
|
@@ -1215,8 +1203,8 @@ module CandidApiClient
|
|
|
1215
1203
|
end
|
|
1216
1204
|
end
|
|
1217
1205
|
|
|
1218
|
-
# Scans up to 100 patient updates.
|
|
1219
|
-
# result list is ordered by updatedAt ascending.
|
|
1206
|
+
# Scans up to 100 patient updates. The since query parameter is inclusive, and
|
|
1207
|
+
# the result list is ordered by updatedAt ascending.
|
|
1220
1208
|
#
|
|
1221
1209
|
# @param since [DateTime]
|
|
1222
1210
|
# @param request_options [CandidApiClient::RequestOptions]
|
|
@@ -59,10 +59,10 @@ module CandidApiClient
|
|
|
59
59
|
attr_reader :disability_status
|
|
60
60
|
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::MaritalStatus]
|
|
61
61
|
attr_reader :marital_status
|
|
62
|
-
# @return [DateTime] Time of death for the patient.
|
|
62
|
+
# @return [DateTime] Time of death for the patient. Leave unset if the patient is not deceased.
|
|
63
63
|
attr_reader :deceased
|
|
64
|
-
# @return [Integer] The number of siblings the patient was born with.
|
|
65
|
-
# not part of a multiple birth.
|
|
64
|
+
# @return [Integer] The number of siblings the patient was born with. Leave unset if the patient
|
|
65
|
+
# was not part of a multiple birth.
|
|
66
66
|
attr_reader :multiple_birth
|
|
67
67
|
# @return [CandidApiClient::PreEncounter::Common::Types::Address] The primary address for the patient.
|
|
68
68
|
attr_reader :primary_address
|
|
@@ -80,7 +80,7 @@ module CandidApiClient
|
|
|
80
80
|
attr_reader :photo
|
|
81
81
|
# @return [String]
|
|
82
82
|
attr_reader :language
|
|
83
|
-
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::ExternalProvenance] Information about the upstream system that owns this patient data.
|
|
83
|
+
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::ExternalProvenance] Information about the upstream system that owns this patient data. Leave unset
|
|
84
84
|
# if Candid owns patient data.
|
|
85
85
|
attr_reader :external_provenance
|
|
86
86
|
# @return [Array<CandidApiClient::PreEncounter::Patients::V1::Types::Contact>] Contacts for the patient.
|
|
@@ -132,9 +132,9 @@ module CandidApiClient
|
|
|
132
132
|
# @param ethnicity [CandidApiClient::PreEncounter::Common::Types::Ethnicity]
|
|
133
133
|
# @param disability_status [CandidApiClient::PreEncounter::Common::Types::DisabilityStatus]
|
|
134
134
|
# @param marital_status [CandidApiClient::PreEncounter::Patients::V1::Types::MaritalStatus]
|
|
135
|
-
# @param deceased [DateTime] Time of death for the patient.
|
|
136
|
-
# @param multiple_birth [Integer] The number of siblings the patient was born with.
|
|
137
|
-
# not part of a multiple birth.
|
|
135
|
+
# @param deceased [DateTime] Time of death for the patient. Leave unset if the patient is not deceased.
|
|
136
|
+
# @param multiple_birth [Integer] The number of siblings the patient was born with. Leave unset if the patient
|
|
137
|
+
# was not part of a multiple birth.
|
|
138
138
|
# @param primary_address [CandidApiClient::PreEncounter::Common::Types::Address] The primary address for the patient.
|
|
139
139
|
# @param other_addresses [Array<CandidApiClient::PreEncounter::Common::Types::Address>] Other addresses for the patient.
|
|
140
140
|
# @param primary_telecom [CandidApiClient::PreEncounter::Common::Types::ContactPoint] The primary phone number for the patient.
|
|
@@ -143,7 +143,7 @@ module CandidApiClient
|
|
|
143
143
|
# @param electronic_communication_opt_in [Boolean]
|
|
144
144
|
# @param photo [String]
|
|
145
145
|
# @param language [String]
|
|
146
|
-
# @param external_provenance [CandidApiClient::PreEncounter::Patients::V1::Types::ExternalProvenance] Information about the upstream system that owns this patient data.
|
|
146
|
+
# @param external_provenance [CandidApiClient::PreEncounter::Patients::V1::Types::ExternalProvenance] Information about the upstream system that owns this patient data. Leave unset
|
|
147
147
|
# if Candid owns patient data.
|
|
148
148
|
# @param contacts [Array<CandidApiClient::PreEncounter::Patients::V1::Types::Contact>] Contacts for the patient.
|
|
149
149
|
# @param general_practitioners [Array<CandidApiClient::PreEncounter::Common::Types::ExternalProvider>]
|
|
@@ -60,10 +60,10 @@ module CandidApiClient
|
|
|
60
60
|
attr_reader :disability_status
|
|
61
61
|
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::MaritalStatus]
|
|
62
62
|
attr_reader :marital_status
|
|
63
|
-
# @return [DateTime] Time of death for the patient.
|
|
63
|
+
# @return [DateTime] Time of death for the patient. Leave unset if the patient is not deceased.
|
|
64
64
|
attr_reader :deceased
|
|
65
|
-
# @return [Integer] The number of siblings the patient was born with.
|
|
66
|
-
# not part of a multiple birth.
|
|
65
|
+
# @return [Integer] The number of siblings the patient was born with. Leave unset if the patient
|
|
66
|
+
# was not part of a multiple birth.
|
|
67
67
|
attr_reader :multiple_birth
|
|
68
68
|
# @return [CandidApiClient::PreEncounter::Common::Types::Address] The primary address for the patient.
|
|
69
69
|
attr_reader :primary_address
|
|
@@ -81,7 +81,7 @@ module CandidApiClient
|
|
|
81
81
|
attr_reader :photo
|
|
82
82
|
# @return [String]
|
|
83
83
|
attr_reader :language
|
|
84
|
-
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::ExternalProvenance] Information about the upstream system that owns this patient data.
|
|
84
|
+
# @return [CandidApiClient::PreEncounter::Patients::V1::Types::ExternalProvenance] Information about the upstream system that owns this patient data. Leave unset
|
|
85
85
|
# if Candid owns patient data.
|
|
86
86
|
attr_reader :external_provenance
|
|
87
87
|
# @return [Array<CandidApiClient::PreEncounter::Patients::V1::Types::Contact>] Contacts for the patient.
|
|
@@ -134,9 +134,9 @@ module CandidApiClient
|
|
|
134
134
|
# @param ethnicity [CandidApiClient::PreEncounter::Common::Types::Ethnicity]
|
|
135
135
|
# @param disability_status [CandidApiClient::PreEncounter::Common::Types::DisabilityStatus]
|
|
136
136
|
# @param marital_status [CandidApiClient::PreEncounter::Patients::V1::Types::MaritalStatus]
|
|
137
|
-
# @param deceased [DateTime] Time of death for the patient.
|
|
138
|
-
# @param multiple_birth [Integer] The number of siblings the patient was born with.
|
|
139
|
-
# not part of a multiple birth.
|
|
137
|
+
# @param deceased [DateTime] Time of death for the patient. Leave unset if the patient is not deceased.
|
|
138
|
+
# @param multiple_birth [Integer] The number of siblings the patient was born with. Leave unset if the patient
|
|
139
|
+
# was not part of a multiple birth.
|
|
140
140
|
# @param primary_address [CandidApiClient::PreEncounter::Common::Types::Address] The primary address for the patient.
|
|
141
141
|
# @param other_addresses [Array<CandidApiClient::PreEncounter::Common::Types::Address>] Other addresses for the patient.
|
|
142
142
|
# @param primary_telecom [CandidApiClient::PreEncounter::Common::Types::ContactPoint] The primary phone number for the patient.
|
|
@@ -145,7 +145,7 @@ module CandidApiClient
|
|
|
145
145
|
# @param electronic_communication_opt_in [Boolean]
|
|
146
146
|
# @param photo [String]
|
|
147
147
|
# @param language [String]
|
|
148
|
-
# @param external_provenance [CandidApiClient::PreEncounter::Patients::V1::Types::ExternalProvenance] Information about the upstream system that owns this patient data.
|
|
148
|
+
# @param external_provenance [CandidApiClient::PreEncounter::Patients::V1::Types::ExternalProvenance] Information about the upstream system that owns this patient data. Leave unset
|
|
149
149
|
# if Candid owns patient data.
|
|
150
150
|
# @param contacts [Array<CandidApiClient::PreEncounter::Patients::V1::Types::Contact>] Contacts for the patient.
|
|
151
151
|
# @param general_practitioners [Array<CandidApiClient::PreEncounter::Common::Types::ExternalProvider>]
|