candidhealth 0.35.0 → 0.35.2

data/lib/candidhealth/pre_encounter/patients/v_1/client.rb

@@ -3,6 +3,7 @@
 require_relative "../../../../requests"
 require_relative "types/mutable_patient"
 require_relative "types/patient"
+require_relative "types/mutable_patient_with_mrn"
 require_relative "../../common/types/sort_direction"
 require_relative "types/patient_page"
 require "json"
@@ -108,11 +109,12 @@ module CandidApiClient
           #   * :authorizations (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Authorization>)
           #   * :referrals (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Referral>)
           #   * :primary_service_facility_id (String)
+          #   * :do_not_invoice_reason (CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason)
           # @param request_options [CandidApiClient::RequestOptions]
           # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  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" })
+          #  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 })
           def create(request:, skip_duplicate_check: nil, request_options: nil)
             response = @request_client.conn.post do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -133,6 +135,120 @@ module CandidApiClient
             CandidApiClient::PreEncounter::Patients::V1::Types::Patient.from_json(json_object: response.body)
           end
 
+          # Adds a patient and hydrates their MRN with a pre-existing MRN. Once this patient
+          #  is created their MRN will not be editable. BadRequestError is returned when the
+          #  MRN is greater than 20 characters. VersionConflictError is returned when the
+          #  patient's external ID is already in use.
+          #
+          # @param skip_duplicate_check [Boolean]
+          # @param request [Hash] Request of type CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatientWithMrn, as a Hash
+          #   * :mrn (String)
+          #   * :name (Hash)
+          #     * :family (String)
+          #     * :given (Array<String>)
+          #     * :use (CandidApiClient::PreEncounter::Common::Types::NameUse)
+          #     * :period (Hash)
+          #       * :start (Date)
+          #       * :end_ (Date)
+          #   * :other_names (Array<CandidApiClient::PreEncounter::Common::Types::HumanName>)
+          #   * :gender (CandidApiClient::PreEncounter::Common::Types::Gender)
+          #   * :birth_date (Date)
+          #   * :social_security_number (String)
+          #   * :biological_sex (CandidApiClient::PreEncounter::Common::Types::Sex)
+          #   * :sexual_orientation (CandidApiClient::PreEncounter::Common::Types::SexualOrientation)
+          #   * :race (CandidApiClient::PreEncounter::Common::Types::Race)
+          #   * :ethnicity (CandidApiClient::PreEncounter::Common::Types::Ethnicity)
+          #   * :disability_status (CandidApiClient::PreEncounter::Common::Types::DisabilityStatus)
+          #   * :marital_status (CandidApiClient::PreEncounter::Patients::V1::Types::MaritalStatus)
+          #   * :deceased (DateTime)
+          #   * :multiple_birth (Integer)
+          #   * :primary_address (Hash)
+          #     * :use (CandidApiClient::PreEncounter::Common::Types::AddressUse)
+          #     * :line (Array<String>)
+          #     * :city (String)
+          #     * :state (String)
+          #     * :postal_code (String)
+          #     * :country (String)
+          #     * :period (Hash)
+          #       * :start (Date)
+          #       * :end_ (Date)
+          #   * :other_addresses (Array<CandidApiClient::PreEncounter::Common::Types::Address>)
+          #   * :primary_telecom (Hash)
+          #     * :value (String)
+          #     * :use (CandidApiClient::PreEncounter::Common::Types::ContactPointUse)
+          #     * :period (Hash)
+          #       * :start (Date)
+          #       * :end_ (Date)
+          #   * :other_telecoms (Array<CandidApiClient::PreEncounter::Common::Types::ContactPoint>)
+          #   * :email (String)
+          #   * :electronic_communication_opt_in (Boolean)
+          #   * :photo (String)
+          #   * :language (String)
+          #   * :external_provenance (Hash)
+          #     * :external_id (String)
+          #     * :system_name (String)
+          #   * :contacts (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Contact>)
+          #   * :general_practitioners (Array<CandidApiClient::PreEncounter::Common::Types::ExternalProvider>)
+          #   * :filing_order (Hash)
+          #     * :coverages (Array<String>)
+          #   * :non_insurance_payers (Array<String>)
+          #   * :non_insurance_payer_associations (Array<CandidApiClient::PreEncounter::Common::Types::CanonicalNonInsurancePayerAssociation>)
+          #   * :guarantor (Hash)
+          #     * :name (Hash)
+          #       * :family (String)
+          #       * :given (Array<String>)
+          #       * :use (CandidApiClient::PreEncounter::Common::Types::NameUse)
+          #       * :period (Hash)
+          #         * :start (Date)
+          #         * :end_ (Date)
+          #     * :telecom (Hash)
+          #       * :value (String)
+          #       * :use (CandidApiClient::PreEncounter::Common::Types::ContactPointUse)
+          #       * :period (Hash)
+          #         * :start (Date)
+          #         * :end_ (Date)
+          #     * :email (String)
+          #     * :birth_date (Date)
+          #     * :address (Hash)
+          #       * :use (CandidApiClient::PreEncounter::Common::Types::AddressUse)
+          #       * :line (Array<String>)
+          #       * :city (String)
+          #       * :state (String)
+          #       * :postal_code (String)
+          #       * :country (String)
+          #       * :period (Hash)
+          #         * :start (Date)
+          #         * :end_ (Date)
+          #   * :self_pay (Boolean)
+          #   * :authorizations (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Authorization>)
+          #   * :referrals (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Referral>)
+          #   * :primary_service_facility_id (String)
+          #   * :do_not_invoice_reason (CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason)
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
+          # @example
+          #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+          #  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 })
+          def create_with_mrn(request:, skip_duplicate_check: nil, request_options: nil)
+            response = @request_client.conn.post do |req|
+              req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+              req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
+              req.params = {
+                **(request_options&.additional_query_parameters || {}),
+                "skip_duplicate_check": skip_duplicate_check
+              }.compact
+              req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+              req.url "#{@request_client.get_url(environment: PreEncounter,
+                                                 request_options: request_options)}/patients/v1/with_mrn"
+            end
+            CandidApiClient::PreEncounter::Patients::V1::Types::Patient.from_json(json_object: response.body)
+          end
+
           # Searches for patients that match the query parameters.
           #
           # @param limit [Integer]
@@ -312,6 +428,7 @@ module CandidApiClient
           #   * :authorizations (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Authorization>)
           #   * :referrals (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Referral>)
           #   * :primary_service_facility_id (String)
+          #   * :do_not_invoice_reason (CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason)
           # @param request_options [CandidApiClient::RequestOptions]
           # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
           # @example
@@ -319,7 +436,7 @@ module CandidApiClient
           #  api.pre_encounter.patients.v_1.update(
           #    id: "string",
           #    version: "string",
-          #    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" }
+          #    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 }
           #  )
           def update(id:, version:, request:, request_options: nil)
             response = @request_client.conn.put do |req|
@@ -521,11 +638,12 @@ module CandidApiClient
           #   * :authorizations (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Authorization>)
           #   * :referrals (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Referral>)
           #   * :primary_service_facility_id (String)
+          #   * :do_not_invoice_reason (CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason)
           # @param request_options [CandidApiClient::RequestOptions]
           # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  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" })
+          #  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 })
           def create(request:, skip_duplicate_check: nil, request_options: nil)
             Async do
               response = @request_client.conn.post do |req|
@@ -548,6 +666,122 @@ module CandidApiClient
             end
           end
 
+          # Adds a patient and hydrates their MRN with a pre-existing MRN. Once this patient
+          #  is created their MRN will not be editable. BadRequestError is returned when the
+          #  MRN is greater than 20 characters. VersionConflictError is returned when the
+          #  patient's external ID is already in use.
+          #
+          # @param skip_duplicate_check [Boolean]
+          # @param request [Hash] Request of type CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatientWithMrn, as a Hash
+          #   * :mrn (String)
+          #   * :name (Hash)
+          #     * :family (String)
+          #     * :given (Array<String>)
+          #     * :use (CandidApiClient::PreEncounter::Common::Types::NameUse)
+          #     * :period (Hash)
+          #       * :start (Date)
+          #       * :end_ (Date)
+          #   * :other_names (Array<CandidApiClient::PreEncounter::Common::Types::HumanName>)
+          #   * :gender (CandidApiClient::PreEncounter::Common::Types::Gender)
+          #   * :birth_date (Date)
+          #   * :social_security_number (String)
+          #   * :biological_sex (CandidApiClient::PreEncounter::Common::Types::Sex)
+          #   * :sexual_orientation (CandidApiClient::PreEncounter::Common::Types::SexualOrientation)
+          #   * :race (CandidApiClient::PreEncounter::Common::Types::Race)
+          #   * :ethnicity (CandidApiClient::PreEncounter::Common::Types::Ethnicity)
+          #   * :disability_status (CandidApiClient::PreEncounter::Common::Types::DisabilityStatus)
+          #   * :marital_status (CandidApiClient::PreEncounter::Patients::V1::Types::MaritalStatus)
+          #   * :deceased (DateTime)
+          #   * :multiple_birth (Integer)
+          #   * :primary_address (Hash)
+          #     * :use (CandidApiClient::PreEncounter::Common::Types::AddressUse)
+          #     * :line (Array<String>)
+          #     * :city (String)
+          #     * :state (String)
+          #     * :postal_code (String)
+          #     * :country (String)
+          #     * :period (Hash)
+          #       * :start (Date)
+          #       * :end_ (Date)
+          #   * :other_addresses (Array<CandidApiClient::PreEncounter::Common::Types::Address>)
+          #   * :primary_telecom (Hash)
+          #     * :value (String)
+          #     * :use (CandidApiClient::PreEncounter::Common::Types::ContactPointUse)
+          #     * :period (Hash)
+          #       * :start (Date)
+          #       * :end_ (Date)
+          #   * :other_telecoms (Array<CandidApiClient::PreEncounter::Common::Types::ContactPoint>)
+          #   * :email (String)
+          #   * :electronic_communication_opt_in (Boolean)
+          #   * :photo (String)
+          #   * :language (String)
+          #   * :external_provenance (Hash)
+          #     * :external_id (String)
+          #     * :system_name (String)
+          #   * :contacts (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Contact>)
+          #   * :general_practitioners (Array<CandidApiClient::PreEncounter::Common::Types::ExternalProvider>)
+          #   * :filing_order (Hash)
+          #     * :coverages (Array<String>)
+          #   * :non_insurance_payers (Array<String>)
+          #   * :non_insurance_payer_associations (Array<CandidApiClient::PreEncounter::Common::Types::CanonicalNonInsurancePayerAssociation>)
+          #   * :guarantor (Hash)
+          #     * :name (Hash)
+          #       * :family (String)
+          #       * :given (Array<String>)
+          #       * :use (CandidApiClient::PreEncounter::Common::Types::NameUse)
+          #       * :period (Hash)
+          #         * :start (Date)
+          #         * :end_ (Date)
+          #     * :telecom (Hash)
+          #       * :value (String)
+          #       * :use (CandidApiClient::PreEncounter::Common::Types::ContactPointUse)
+          #       * :period (Hash)
+          #         * :start (Date)
+          #         * :end_ (Date)
+          #     * :email (String)
+          #     * :birth_date (Date)
+          #     * :address (Hash)
+          #       * :use (CandidApiClient::PreEncounter::Common::Types::AddressUse)
+          #       * :line (Array<String>)
+          #       * :city (String)
+          #       * :state (String)
+          #       * :postal_code (String)
+          #       * :country (String)
+          #       * :period (Hash)
+          #         * :start (Date)
+          #         * :end_ (Date)
+          #   * :self_pay (Boolean)
+          #   * :authorizations (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Authorization>)
+          #   * :referrals (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Referral>)
+          #   * :primary_service_facility_id (String)
+          #   * :do_not_invoice_reason (CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason)
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
+          # @example
+          #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+          #  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 })
+          def create_with_mrn(request:, skip_duplicate_check: nil, request_options: nil)
+            Async do
+              response = @request_client.conn.post do |req|
+                req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+                req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+                req.headers = {
+              **(req.headers || {}),
+              **@request_client.get_headers,
+              **(request_options&.additional_headers || {})
+                }.compact
+                req.params = {
+                  **(request_options&.additional_query_parameters || {}),
+                  "skip_duplicate_check": skip_duplicate_check
+                }.compact
+                req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+                req.url "#{@request_client.get_url(environment: PreEncounter,
+                                                   request_options: request_options)}/patients/v1/with_mrn"
+              end
+              CandidApiClient::PreEncounter::Patients::V1::Types::Patient.from_json(json_object: response.body)
+            end
+          end
+
           # Searches for patients that match the query parameters.
           #
           # @param limit [Integer]
@@ -733,6 +967,7 @@ module CandidApiClient
           #   * :authorizations (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Authorization>)
           #   * :referrals (Array<CandidApiClient::PreEncounter::Patients::V1::Types::Referral>)
           #   * :primary_service_facility_id (String)
+          #   * :do_not_invoice_reason (CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason)
           # @param request_options [CandidApiClient::RequestOptions]
           # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Patient]
           # @example
@@ -740,7 +975,7 @@ module CandidApiClient
           #  api.pre_encounter.patients.v_1.update(
           #    id: "string",
           #    version: "string",
-          #    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" }
+          #    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 }
           #  )
           def update(id:, version:, request:, request_options: nil)
             Async do

data/lib/candidhealth/pre_encounter/patients/v_1/types/do_not_invoice_reason.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CandidApiClient
+  module PreEncounter
+    module Patients
+      module V1
+        module Types
+          class DoNotInvoiceReason
+            BANKRUPTCY = "BANKRUPTCY"
+            DECEASED = "DECEASED"
+            HARDSHIP = "HARDSHIP"
+            OTHER = "OTHER"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient.rb

@@ -19,6 +19,7 @@ require_relative "../../../common/types/canonical_non_insurance_payer_associatio
 require_relative "guarantor"
 require_relative "authorization"
 require_relative "referral"
+require_relative "do_not_invoice_reason"
 require "ostruct"
 require "json"
 
@@ -97,6 +98,8 @@ module CandidApiClient
             attr_reader :referrals
             # @return [String]
             attr_reader :primary_service_facility_id
+            # @return [CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason] If this value is defined, the customer will not be invoiced.
+            attr_reader :do_not_invoice_reason
             # @return [OpenStruct] Additional properties unmapped to the current class definition
             attr_reader :additional_properties
             # @return [Object]
@@ -141,10 +144,11 @@ module CandidApiClient
             # @param authorizations [Array<CandidApiClient::PreEncounter::Patients::V1::Types::Authorization>]
             # @param referrals [Array<CandidApiClient::PreEncounter::Patients::V1::Types::Referral>]
             # @param primary_service_facility_id [String]
+            # @param do_not_invoice_reason [CandidApiClient::PreEncounter::Patients::V1::Types::DoNotInvoiceReason] If this value is defined, the customer will not be invoiced.
             # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
             # @return [CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatient]
             def initialize(name:, 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, additional_properties: nil)
+                           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)
               @name = name
               @other_names = other_names
               @gender = gender if gender != OMIT
@@ -181,6 +185,7 @@ module CandidApiClient
               @authorizations = authorizations if authorizations != OMIT
               @referrals = referrals if referrals != OMIT
               @primary_service_facility_id = primary_service_facility_id if primary_service_facility_id != OMIT
+              @do_not_invoice_reason = do_not_invoice_reason if do_not_invoice_reason != OMIT
               @additional_properties = additional_properties
               @_field_set = {
                 "name": name,
@@ -214,7 +219,8 @@ module CandidApiClient
                 "self_pay": self_pay,
                 "authorizations": authorizations,
                 "referrals": referrals,
-                "primary_service_facility_id": primary_service_facility_id
+                "primary_service_facility_id": primary_service_facility_id,
+                "do_not_invoice_reason": do_not_invoice_reason
               }.reject do |_k, v|
                 v == OMIT
               end
@@ -313,6 +319,7 @@ module CandidApiClient
                 CandidApiClient::PreEncounter::Patients::V1::Types::Referral.from_json(json_object: item)
               end
               primary_service_facility_id = struct["primary_service_facility_id"]
+              do_not_invoice_reason = struct["do_not_invoice_reason"]
               new(
                 name: name,
                 other_names: other_names,
@@ -346,6 +353,7 @@ module CandidApiClient
                 authorizations: authorizations,
                 referrals: referrals,
                 primary_service_facility_id: primary_service_facility_id,
+                do_not_invoice_reason: do_not_invoice_reason,
                 additional_properties: struct
               )
             end
@@ -396,6 +404,7 @@ module CandidApiClient
               obj.authorizations&.is_a?(Array) != false || raise("Passed value for field obj.authorizations is not the expected type, validation failed.")
               obj.referrals&.is_a?(Array) != false || raise("Passed value for field obj.referrals is not the expected type, validation failed.")
               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.")
+              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.")
             end
           end
         end