candidhealth 1.8.0 → 1.9.0

data/lib/candidhealth/individual/types/patient.rb

@@ -23,6 +23,8 @@ module CandidApiClient
         attr_reader :email
         # @return [Boolean]
         attr_reader :email_consent
+        # @return [Boolean]
+        attr_reader :auto_charge_consent
         # @return [Array<CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayer>]
         attr_reader :non_insurance_payers
         # @return [Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfo>]
@@ -54,6 +56,7 @@ module CandidApiClient
         # @param phone_consent [Boolean]
         # @param email [String]
         # @param email_consent [Boolean]
+        # @param auto_charge_consent [Boolean]
         # @param non_insurance_payers [Array<CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayer>]
         # @param non_insurance_payers_info [Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfo>]
         # @param external_id [String] The ID used to identify this individual in your system. For example, your
@@ -66,13 +69,14 @@ module CandidApiClient
         # @param gender [CandidApiClient::Individual::Types::Gender]
         # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
         # @return [CandidApiClient::Individual::Types::Patient]
-        def initialize(individual_id:, phone_numbers:, phone_consent:, email_consent:, non_insurance_payers:,
-                       non_insurance_payers_info:, external_id:, date_of_birth:, address:, first_name:, last_name:, gender:, email: OMIT, additional_properties: nil)
+        def initialize(individual_id:, phone_numbers:, phone_consent:, email_consent:, auto_charge_consent:,
+                       non_insurance_payers:, non_insurance_payers_info:, external_id:, date_of_birth:, address:, first_name:, last_name:, gender:, email: OMIT, additional_properties: nil)
           @individual_id = individual_id
           @phone_numbers = phone_numbers
           @phone_consent = phone_consent
           @email = email if email != OMIT
           @email_consent = email_consent
+          @auto_charge_consent = auto_charge_consent
           @non_insurance_payers = non_insurance_payers
           @non_insurance_payers_info = non_insurance_payers_info
           @external_id = external_id
@@ -88,6 +92,7 @@ module CandidApiClient
             "phone_consent": phone_consent,
             "email": email,
             "email_consent": email_consent,
+            "auto_charge_consent": auto_charge_consent,
             "non_insurance_payers": non_insurance_payers,
             "non_insurance_payers_info": non_insurance_payers_info,
             "external_id": external_id,
@@ -116,6 +121,7 @@ module CandidApiClient
           phone_consent = struct["phone_consent"]
           email = struct["email"]
           email_consent = struct["email_consent"]
+          auto_charge_consent = struct["auto_charge_consent"]
           non_insurance_payers = parsed_json["non_insurance_payers"]&.map do |item|
             item = item.to_json
             CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayer.from_json(json_object: item)
@@ -141,6 +147,7 @@ module CandidApiClient
             phone_consent: phone_consent,
             email: email,
             email_consent: email_consent,
+            auto_charge_consent: auto_charge_consent,
             non_insurance_payers: non_insurance_payers,
             non_insurance_payers_info: non_insurance_payers_info,
             external_id: external_id,
@@ -172,6 +179,7 @@ module CandidApiClient
           obj.phone_consent.is_a?(Boolean) != false || raise("Passed value for field obj.phone_consent is not the expected type, validation failed.")
           obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
           obj.email_consent.is_a?(Boolean) != false || raise("Passed value for field obj.email_consent is not the expected type, validation failed.")
+          obj.auto_charge_consent.is_a?(Boolean) != false || raise("Passed value for field obj.auto_charge_consent is not the expected type, validation failed.")
           obj.non_insurance_payers.is_a?(Array) != false || raise("Passed value for field obj.non_insurance_payers is not the expected type, validation failed.")
           obj.non_insurance_payers_info.is_a?(Array) != false || raise("Passed value for field obj.non_insurance_payers_info is not the expected type, validation failed.")
           obj.external_id.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")

data/lib/candidhealth/individual/types/patient_create.rb

@@ -24,6 +24,8 @@ module CandidApiClient
         attr_reader :non_insurance_payers_info
         # @return [Boolean] Defaults to false
         attr_reader :email_consent
+        # @return [Boolean] Defaults to false
+        attr_reader :auto_charge_consent
         # @return [String] The ID used to identify this individual in your system. For example, your
         #  internal patient ID or an EHR patient ID.
         attr_reader :external_id
@@ -52,6 +54,7 @@ module CandidApiClient
         # @param non_insurance_payers [Array<String>]
         # @param non_insurance_payers_info [Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreate>]
         # @param email_consent [Boolean] Defaults to false
+        # @param auto_charge_consent [Boolean] Defaults to false
         # @param external_id [String] The ID used to identify this individual in your system. For example, your
         #  internal patient ID or an EHR patient ID.
         # @param date_of_birth [Date] Box 3 on the CMS-1500 claim form or Form Locator 10 on a UB-04 claim form. The
@@ -63,13 +66,14 @@ module CandidApiClient
         # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
         # @return [CandidApiClient::Individual::Types::PatientCreate]
         def initialize(external_id:, date_of_birth:, address:, first_name:, last_name:, gender:, phone_numbers: OMIT, phone_consent: OMIT, email: OMIT, non_insurance_payers: OMIT,
-                       non_insurance_payers_info: OMIT, email_consent: OMIT, additional_properties: nil)
+                       non_insurance_payers_info: OMIT, email_consent: OMIT, auto_charge_consent: OMIT, additional_properties: nil)
           @phone_numbers = phone_numbers if phone_numbers != OMIT
           @phone_consent = phone_consent if phone_consent != OMIT
           @email = email if email != OMIT
           @non_insurance_payers = non_insurance_payers if non_insurance_payers != OMIT
           @non_insurance_payers_info = non_insurance_payers_info if non_insurance_payers_info != OMIT
           @email_consent = email_consent if email_consent != OMIT
+          @auto_charge_consent = auto_charge_consent if auto_charge_consent != OMIT
           @external_id = external_id
           @date_of_birth = date_of_birth
           @address = address
@@ -84,6 +88,7 @@ module CandidApiClient
             "non_insurance_payers": non_insurance_payers,
             "non_insurance_payers_info": non_insurance_payers_info,
             "email_consent": email_consent,
+            "auto_charge_consent": auto_charge_consent,
             "external_id": external_id,
             "date_of_birth": date_of_birth,
             "address": address,
@@ -114,6 +119,7 @@ module CandidApiClient
             CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreate.from_json(json_object: item)
           end
           email_consent = struct["email_consent"]
+          auto_charge_consent = struct["auto_charge_consent"]
           external_id = struct["external_id"]
           date_of_birth = (Date.parse(parsed_json["date_of_birth"]) unless parsed_json["date_of_birth"].nil?)
           if parsed_json["address"].nil?
@@ -132,6 +138,7 @@ module CandidApiClient
             non_insurance_payers: non_insurance_payers,
             non_insurance_payers_info: non_insurance_payers_info,
             email_consent: email_consent,
+            auto_charge_consent: auto_charge_consent,
             external_id: external_id,
             date_of_birth: date_of_birth,
             address: address,
@@ -162,6 +169,7 @@ module CandidApiClient
           obj.non_insurance_payers&.is_a?(Array) != false || raise("Passed value for field obj.non_insurance_payers is not the expected type, validation failed.")
           obj.non_insurance_payers_info&.is_a?(Array) != false || raise("Passed value for field obj.non_insurance_payers_info is not the expected type, validation failed.")
           obj.email_consent&.is_a?(Boolean) != false || raise("Passed value for field obj.email_consent is not the expected type, validation failed.")
+          obj.auto_charge_consent&.is_a?(Boolean) != false || raise("Passed value for field obj.auto_charge_consent is not the expected type, validation failed.")
           obj.external_id.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")
           obj.date_of_birth.is_a?(Date) != false || raise("Passed value for field obj.date_of_birth is not the expected type, validation failed.")
           CandidApiClient::Commons::Types::StreetAddressShortZip.validate_raw(obj: obj.address)

data/lib/candidhealth/individual/types/patient_update.rb

@@ -34,6 +34,8 @@ module CandidApiClient
         attr_reader :email
         # @return [Boolean]
         attr_reader :email_consent
+        # @return [Boolean]
+        attr_reader :auto_charge_consent
         # @return [Array<String>] On update, we will replace the existing list of non-insurance payers with the
         #  new list if populated.
         attr_reader :non_insurance_payers
@@ -60,6 +62,7 @@ module CandidApiClient
         # @param phone_consent [Boolean]
         # @param email [String]
         # @param email_consent [Boolean]
+        # @param auto_charge_consent [Boolean]
         # @param non_insurance_payers [Array<String>] On update, we will replace the existing list of non-insurance payers with the
         #  new list if populated.
         # @param non_insurance_payers_info [Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreate>] On update, we will replace the existing list of non-insurance payers with the
@@ -67,7 +70,7 @@ module CandidApiClient
         # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
         # @return [CandidApiClient::Individual::Types::PatientUpdate]
         def initialize(first_name: OMIT, last_name: OMIT, gender: OMIT, external_id: OMIT, date_of_birth: OMIT,
-                       address: OMIT, phone_numbers: OMIT, phone_consent: OMIT, email: OMIT, email_consent: OMIT, non_insurance_payers: OMIT, non_insurance_payers_info: OMIT, additional_properties: nil)
+                       address: OMIT, phone_numbers: OMIT, phone_consent: OMIT, email: OMIT, email_consent: OMIT, auto_charge_consent: OMIT, non_insurance_payers: OMIT, non_insurance_payers_info: OMIT, additional_properties: nil)
           @first_name = first_name if first_name != OMIT
           @last_name = last_name if last_name != OMIT
           @gender = gender if gender != OMIT
@@ -78,6 +81,7 @@ module CandidApiClient
           @phone_consent = phone_consent if phone_consent != OMIT
           @email = email if email != OMIT
           @email_consent = email_consent if email_consent != OMIT
+          @auto_charge_consent = auto_charge_consent if auto_charge_consent != OMIT
           @non_insurance_payers = non_insurance_payers if non_insurance_payers != OMIT
           @non_insurance_payers_info = non_insurance_payers_info if non_insurance_payers_info != OMIT
           @additional_properties = additional_properties
@@ -92,6 +96,7 @@ module CandidApiClient
             "phone_consent": phone_consent,
             "email": email,
             "email_consent": email_consent,
+            "auto_charge_consent": auto_charge_consent,
             "non_insurance_payers": non_insurance_payers,
             "non_insurance_payers_info": non_insurance_payers_info
           }.reject do |_k, v|
@@ -124,6 +129,7 @@ module CandidApiClient
           phone_consent = struct["phone_consent"]
           email = struct["email"]
           email_consent = struct["email_consent"]
+          auto_charge_consent = struct["auto_charge_consent"]
           non_insurance_payers = struct["non_insurance_payers"]
           non_insurance_payers_info = parsed_json["non_insurance_payers_info"]&.map do |item|
             item = item.to_json
@@ -140,6 +146,7 @@ module CandidApiClient
             phone_consent: phone_consent,
             email: email,
             email_consent: email_consent,
+            auto_charge_consent: auto_charge_consent,
             non_insurance_payers: non_insurance_payers,
             non_insurance_payers_info: non_insurance_payers_info,
             additional_properties: struct
@@ -170,6 +177,7 @@ module CandidApiClient
           obj.phone_consent&.is_a?(Boolean) != false || raise("Passed value for field obj.phone_consent is not the expected type, validation failed.")
           obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
           obj.email_consent&.is_a?(Boolean) != false || raise("Passed value for field obj.email_consent is not the expected type, validation failed.")
+          obj.auto_charge_consent&.is_a?(Boolean) != false || raise("Passed value for field obj.auto_charge_consent is not the expected type, validation failed.")
           obj.non_insurance_payers&.is_a?(Array) != false || raise("Passed value for field obj.non_insurance_payers is not the expected type, validation failed.")
           obj.non_insurance_payers_info&.is_a?(Array) != false || raise("Passed value for field obj.non_insurance_payers_info is not the expected type, validation failed.")
         end

data/lib/candidhealth/individual/types/patient_update_with_optional_address.rb

@@ -34,6 +34,8 @@ module CandidApiClient
         attr_reader :email
         # @return [Boolean]
         attr_reader :email_consent
+        # @return [Boolean]
+        attr_reader :auto_charge_consent
         # @return [Array<String>] On update, we will replace the existing list of non-insurance payers with the
         #  new list if populated.
         attr_reader :non_insurance_payers
@@ -60,6 +62,7 @@ module CandidApiClient
         # @param phone_consent [Boolean]
         # @param email [String]
         # @param email_consent [Boolean]
+        # @param auto_charge_consent [Boolean]
         # @param non_insurance_payers [Array<String>] On update, we will replace the existing list of non-insurance payers with the
         #  new list if populated.
         # @param non_insurance_payers_info [Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>] On update, we will replace the existing list of non-insurance payers with the
@@ -67,7 +70,7 @@ module CandidApiClient
         # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
         # @return [CandidApiClient::Individual::Types::PatientUpdateWithOptionalAddress]
         def initialize(first_name: OMIT, last_name: OMIT, gender: OMIT, external_id: OMIT, date_of_birth: OMIT,
-                       address: OMIT, phone_numbers: OMIT, phone_consent: OMIT, email: OMIT, email_consent: OMIT, non_insurance_payers: OMIT, non_insurance_payers_info: OMIT, additional_properties: nil)
+                       address: OMIT, phone_numbers: OMIT, phone_consent: OMIT, email: OMIT, email_consent: OMIT, auto_charge_consent: OMIT, non_insurance_payers: OMIT, non_insurance_payers_info: OMIT, additional_properties: nil)
           @first_name = first_name if first_name != OMIT
           @last_name = last_name if last_name != OMIT
           @gender = gender if gender != OMIT
@@ -78,6 +81,7 @@ module CandidApiClient
           @phone_consent = phone_consent if phone_consent != OMIT
           @email = email if email != OMIT
           @email_consent = email_consent if email_consent != OMIT
+          @auto_charge_consent = auto_charge_consent if auto_charge_consent != OMIT
           @non_insurance_payers = non_insurance_payers if non_insurance_payers != OMIT
           @non_insurance_payers_info = non_insurance_payers_info if non_insurance_payers_info != OMIT
           @additional_properties = additional_properties
@@ -92,6 +96,7 @@ module CandidApiClient
             "phone_consent": phone_consent,
             "email": email,
             "email_consent": email_consent,
+            "auto_charge_consent": auto_charge_consent,
             "non_insurance_payers": non_insurance_payers,
             "non_insurance_payers_info": non_insurance_payers_info
           }.reject do |_k, v|
@@ -124,6 +129,7 @@ module CandidApiClient
           phone_consent = struct["phone_consent"]
           email = struct["email"]
           email_consent = struct["email_consent"]
+          auto_charge_consent = struct["auto_charge_consent"]
           non_insurance_payers = struct["non_insurance_payers"]
           non_insurance_payers_info = parsed_json["non_insurance_payers_info"]&.map do |item|
             item = item.to_json
@@ -140,6 +146,7 @@ module CandidApiClient
             phone_consent: phone_consent,
             email: email,
             email_consent: email_consent,
+            auto_charge_consent: auto_charge_consent,
             non_insurance_payers: non_insurance_payers,
             non_insurance_payers_info: non_insurance_payers_info,
             additional_properties: struct
@@ -170,6 +177,7 @@ module CandidApiClient
           obj.phone_consent&.is_a?(Boolean) != false || raise("Passed value for field obj.phone_consent is not the expected type, validation failed.")
           obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
           obj.email_consent&.is_a?(Boolean) != false || raise("Passed value for field obj.email_consent is not the expected type, validation failed.")
+          obj.auto_charge_consent&.is_a?(Boolean) != false || raise("Passed value for field obj.auto_charge_consent is not the expected type, validation failed.")
           obj.non_insurance_payers&.is_a?(Array) != false || raise("Passed value for field obj.non_insurance_payers is not the expected type, validation failed.")
           obj.non_insurance_payers_info&.is_a?(Array) != false || raise("Passed value for field obj.non_insurance_payers_info is not the expected type, validation failed.")
         end

data/lib/candidhealth/organization_providers/v_2/types/license_type.rb

@@ -106,6 +106,8 @@ module CandidApiClient
           AMFT = "AMFT"
           CDN = "CDN"
           CNS = "CNS"
+          MDPHD = "MDPHD"
+          AUD = "AuD"
         end
       end
     end

data/lib/candidhealth/organization_service_facilities/v_2/client.rb

@@ -2,6 +2,7 @@
 
 require_relative "../../../requests"
 require_relative "types/organization_service_facility"
+require_relative "../../commons/types/facility_type_code"
 require_relative "types/organization_service_facility_page"
 require_relative "types/organization_service_facility_create"
 require_relative "types/organization_service_facility_update"
@@ -44,6 +45,8 @@ module CandidApiClient
         # @param limit [Integer] Limit the number of results returned. Defaults to 100.
         # @param name [String] Filter to a name or a part of a name.
         # @param organization_service_facility_ids [String] Filter to the provided organization service facility IDs.
+        # @param external_ids [String] Filter by one or more external_ids.
+        # @param place_of_service_code [CandidApiClient::Commons::Types::FacilityTypeCode] Filter by Place of Service (POS) code.
         # @param page_token [String] The page token to continue paging through a previous request.
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacilityPage]
@@ -54,8 +57,8 @@ module CandidApiClient
         #    name: "Test Service Facility",
         #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
         #  )
-        def get_multi(limit: nil, name: nil, organization_service_facility_ids: nil, page_token: nil,
-                      request_options: nil)
+        def get_multi(limit: nil, name: nil, organization_service_facility_ids: nil, external_ids: nil,
+                      place_of_service_code: nil, page_token: nil, request_options: nil)
           response = @request_client.conn.get 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?
@@ -69,6 +72,8 @@ module CandidApiClient
               "limit": limit,
               "name": name,
               "organization_service_facility_ids": organization_service_facility_ids,
+              "external_ids": external_ids,
+              "place_of_service_code": place_of_service_code,
               "page_token": page_token
             }.compact
             req.url "#{@request_client.get_url(environment: CandidApi,
@@ -77,11 +82,40 @@ module CandidApiClient
           CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacilityPage.from_json(json_object: response.body)
         end
 
+        # Looks up a single organization service facility by its `external_id` field. This
+        #  can be useful
+        #  for finding service facilities within Candid which are associated with service
+        #  facilities in
+        #  an external system.
+        #
+        # @param external_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacility]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.organization_service_facilities.v_2.get_by_external_id(external_id: "external_id")
+        def get_by_external_id(external_id:, request_options: nil)
+          response = @request_client.conn.get 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.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/organization-service-facilities/v2/external-id/#{external_id}"
+          end
+          CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacility.from_json(json_object: response.body)
+        end
+
         # @param request [Hash] Request of type CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacilityCreate, as a Hash
         #   * :name (String)
         #   * :aliases (Array<String>)
         #   * :description (String)
+        #   * :external_id (String)
         #   * :npi (String)
+        #   * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
         #   * :status (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityStatus)
         #   * :operational_status (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityOperationalStatus)
         #   * :mode (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityMode)
@@ -121,7 +155,9 @@ module CandidApiClient
         #   * :name (String)
         #   * :aliases (Array<String>)
         #   * :description (String)
+        #   * :external_id (String)
         #   * :npi (String)
+        #   * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
         #   * :status (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityStatus)
         #   * :operational_status (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityOperationalStatus)
         #   * :mode (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityMode)
@@ -213,6 +249,8 @@ module CandidApiClient
         # @param limit [Integer] Limit the number of results returned. Defaults to 100.
         # @param name [String] Filter to a name or a part of a name.
         # @param organization_service_facility_ids [String] Filter to the provided organization service facility IDs.
+        # @param external_ids [String] Filter by one or more external_ids.
+        # @param place_of_service_code [CandidApiClient::Commons::Types::FacilityTypeCode] Filter by Place of Service (POS) code.
         # @param page_token [String] The page token to continue paging through a previous request.
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacilityPage]
@@ -223,8 +261,8 @@ module CandidApiClient
         #    name: "Test Service Facility",
         #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
         #  )
-        def get_multi(limit: nil, name: nil, organization_service_facility_ids: nil, page_token: nil,
-                      request_options: nil)
+        def get_multi(limit: nil, name: nil, organization_service_facility_ids: nil, external_ids: nil,
+                      place_of_service_code: nil, page_token: nil, request_options: nil)
           Async do
             response = @request_client.conn.get do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -239,6 +277,8 @@ module CandidApiClient
                 "limit": limit,
                 "name": name,
                 "organization_service_facility_ids": organization_service_facility_ids,
+                "external_ids": external_ids,
+                "place_of_service_code": place_of_service_code,
                 "page_token": page_token
               }.compact
               req.url "#{@request_client.get_url(environment: CandidApi,
@@ -248,11 +288,42 @@ module CandidApiClient
           end
         end
 
+        # Looks up a single organization service facility by its `external_id` field. This
+        #  can be useful
+        #  for finding service facilities within Candid which are associated with service
+        #  facilities in
+        #  an external system.
+        #
+        # @param external_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacility]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.organization_service_facilities.v_2.get_by_external_id(external_id: "external_id")
+        def get_by_external_id(external_id:, request_options: nil)
+          Async do
+            response = @request_client.conn.get 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.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/organization-service-facilities/v2/external-id/#{external_id}"
+            end
+            CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacility.from_json(json_object: response.body)
+          end
+        end
+
         # @param request [Hash] Request of type CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacilityCreate, as a Hash
         #   * :name (String)
         #   * :aliases (Array<String>)
         #   * :description (String)
+        #   * :external_id (String)
         #   * :npi (String)
+        #   * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
         #   * :status (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityStatus)
         #   * :operational_status (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityOperationalStatus)
         #   * :mode (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityMode)
@@ -294,7 +365,9 @@ module CandidApiClient
         #   * :name (String)
         #   * :aliases (Array<String>)
         #   * :description (String)
+        #   * :external_id (String)
         #   * :npi (String)
+        #   * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
         #   * :status (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityStatus)
         #   * :operational_status (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityOperationalStatus)
         #   * :mode (CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityMode)

data/lib/candidhealth/organization_service_facilities/v_2/types/organization_service_facility.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "../../../commons/types/facility_type_code"
 require_relative "service_facility_status"
 require_relative "service_facility_operational_status"
 require_relative "service_facility_mode"
@@ -22,10 +23,15 @@ module CandidApiClient
           attr_reader :aliases
           # @return [String] A description of the service facility.
           attr_reader :description
+          # @return [String] An ID for this service facility used in an external system (e.g. your EMR).
+          #  Service facilities can be queried by this field.
+          attr_reader :external_id
           # @return [String] An NPI specific to the service facility if applicable, i.e. if it has one and is
           #  not under the billing provider's NPI.
           #  Box 32 section (a) of the CMS-1500 claim form.
           attr_reader :npi
+          # @return [CandidApiClient::Commons::Types::FacilityTypeCode] The Place of Service (POS) code for this service facility.
+          attr_reader :place_of_service_code
           # @return [CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityStatus] The status of the service facility.
           attr_reader :status
           # @return [CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityOperationalStatus] The operational status of the service facility.
@@ -52,9 +58,12 @@ module CandidApiClient
           # @param name [String] The name of the service facility.
           # @param aliases [Array<String>] A list of alternate names for the service facility.
           # @param description [String] A description of the service facility.
+          # @param external_id [String] An ID for this service facility used in an external system (e.g. your EMR).
+          #  Service facilities can be queried by this field.
           # @param npi [String] An NPI specific to the service facility if applicable, i.e. if it has one and is
           #  not under the billing provider's NPI.
           #  Box 32 section (a) of the CMS-1500 claim form.
+          # @param place_of_service_code [CandidApiClient::Commons::Types::FacilityTypeCode] The Place of Service (POS) code for this service facility.
           # @param status [CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityStatus] The status of the service facility.
           # @param operational_status [CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityOperationalStatus] The operational status of the service facility.
           # @param mode [CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityMode] The mode of the service facility.
@@ -64,13 +73,15 @@ module CandidApiClient
           # @param address [CandidApiClient::Commons::Types::StreetAddressLongZip] The address of the service facility.
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacility]
-          def initialize(organization_service_facility_id:, name:, aliases:, telecoms:, address:, description: OMIT, npi: OMIT,
-                         status: OMIT, operational_status: OMIT, mode: OMIT, type: OMIT, physical_type: OMIT, additional_properties: nil)
+          def initialize(organization_service_facility_id:, name:, aliases:, telecoms:, address:, description: OMIT, external_id: OMIT,
+                         npi: OMIT, place_of_service_code: OMIT, status: OMIT, operational_status: OMIT, mode: OMIT, type: OMIT, physical_type: OMIT, additional_properties: nil)
             @organization_service_facility_id = organization_service_facility_id
             @name = name
             @aliases = aliases
             @description = description if description != OMIT
+            @external_id = external_id if external_id != OMIT
             @npi = npi if npi != OMIT
+            @place_of_service_code = place_of_service_code if place_of_service_code != OMIT
             @status = status if status != OMIT
             @operational_status = operational_status if operational_status != OMIT
             @mode = mode if mode != OMIT
@@ -84,7 +95,9 @@ module CandidApiClient
               "name": name,
               "aliases": aliases,
               "description": description,
+              "external_id": external_id,
               "npi": npi,
+              "place_of_service_code": place_of_service_code,
               "status": status,
               "operational_status": operational_status,
               "mode": mode,
@@ -108,7 +121,9 @@ module CandidApiClient
             name = struct["name"]
             aliases = struct["aliases"]
             description = struct["description"]
+            external_id = struct["external_id"]
             npi = struct["npi"]
+            place_of_service_code = struct["place_of_service_code"]
             status = struct["status"]
             operational_status = struct["operational_status"]
             mode = struct["mode"]
@@ -126,7 +141,9 @@ module CandidApiClient
               name: name,
               aliases: aliases,
               description: description,
+              external_id: external_id,
               npi: npi,
+              place_of_service_code: place_of_service_code,
               status: status,
               operational_status: operational_status,
               mode: mode,
@@ -156,7 +173,9 @@ module CandidApiClient
             obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
             obj.aliases.is_a?(Array) != false || raise("Passed value for field obj.aliases is not the expected type, validation failed.")
             obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+            obj.external_id&.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")
             obj.npi&.is_a?(String) != false || raise("Passed value for field obj.npi is not the expected type, validation failed.")
+            obj.place_of_service_code&.is_a?(CandidApiClient::Commons::Types::FacilityTypeCode) != false || raise("Passed value for field obj.place_of_service_code is not the expected type, validation failed.")
             obj.status&.is_a?(CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
             obj.operational_status&.is_a?(CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityOperationalStatus) != false || raise("Passed value for field obj.operational_status is not the expected type, validation failed.")
             obj.mode&.is_a?(CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityMode) != false || raise("Passed value for field obj.mode is not the expected type, validation failed.")

data/lib/candidhealth/organization_service_facilities/v_2/types/organization_service_facility_create.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "../../../commons/types/facility_type_code"
 require_relative "service_facility_status"
 require_relative "service_facility_operational_status"
 require_relative "service_facility_mode"
@@ -20,10 +21,15 @@ module CandidApiClient
           attr_reader :aliases
           # @return [String] A description of the service facility.
           attr_reader :description
+          # @return [String] An ID for this service facility used in an external system (e.g. your EMR).
+          #  Service facilities can be queried by this field.
+          attr_reader :external_id
           # @return [String] An NPI specific to the service facility if applicable, i.e. if it has one and is
           #  not under the billing provider's NPI.
           #  Box 32 section (a) of the CMS-1500 claim form.
           attr_reader :npi
+          # @return [CandidApiClient::Commons::Types::FacilityTypeCode] The Place of Service (POS) code for this service facility.
+          attr_reader :place_of_service_code
           # @return [CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityStatus] The status of the service facility.
           attr_reader :status
           # @return [CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityOperationalStatus] The operational status of the service facility.
@@ -49,9 +55,12 @@ module CandidApiClient
           # @param name [String] The name of the service facility.
           # @param aliases [Array<String>] A list of alternate names for the service facility.
           # @param description [String] A description of the service facility.
+          # @param external_id [String] An ID for this service facility used in an external system (e.g. your EMR).
+          #  Service facilities can be queried by this field.
           # @param npi [String] An NPI specific to the service facility if applicable, i.e. if it has one and is
           #  not under the billing provider's NPI.
           #  Box 32 section (a) of the CMS-1500 claim form.
+          # @param place_of_service_code [CandidApiClient::Commons::Types::FacilityTypeCode] The Place of Service (POS) code for this service facility.
           # @param status [CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityStatus] The status of the service facility.
           # @param operational_status [CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityOperationalStatus] The operational status of the service facility.
           # @param mode [CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityMode] The mode of the service facility.
@@ -61,12 +70,14 @@ module CandidApiClient
           # @param address [CandidApiClient::Commons::Types::StreetAddressLongZip] The address of the service facility.
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacilityCreate]
-          def initialize(name:, aliases:, telecoms:, address:, description: OMIT, npi: OMIT, status: OMIT, operational_status: OMIT,
-                         mode: OMIT, type: OMIT, physical_type: OMIT, additional_properties: nil)
+          def initialize(name:, aliases:, telecoms:, address:, description: OMIT, external_id: OMIT, npi: OMIT, place_of_service_code: OMIT,
+                         status: OMIT, operational_status: OMIT, mode: OMIT, type: OMIT, physical_type: OMIT, additional_properties: nil)
             @name = name
             @aliases = aliases
             @description = description if description != OMIT
+            @external_id = external_id if external_id != OMIT
             @npi = npi if npi != OMIT
+            @place_of_service_code = place_of_service_code if place_of_service_code != OMIT
             @status = status if status != OMIT
             @operational_status = operational_status if operational_status != OMIT
             @mode = mode if mode != OMIT
@@ -79,7 +90,9 @@ module CandidApiClient
               "name": name,
               "aliases": aliases,
               "description": description,
+              "external_id": external_id,
               "npi": npi,
+              "place_of_service_code": place_of_service_code,
               "status": status,
               "operational_status": operational_status,
               "mode": mode,
@@ -102,7 +115,9 @@ module CandidApiClient
             name = struct["name"]
             aliases = struct["aliases"]
             description = struct["description"]
+            external_id = struct["external_id"]
             npi = struct["npi"]
+            place_of_service_code = struct["place_of_service_code"]
             status = struct["status"]
             operational_status = struct["operational_status"]
             mode = struct["mode"]
@@ -119,7 +134,9 @@ module CandidApiClient
               name: name,
               aliases: aliases,
               description: description,
+              external_id: external_id,
               npi: npi,
+              place_of_service_code: place_of_service_code,
               status: status,
               operational_status: operational_status,
               mode: mode,
@@ -148,7 +165,9 @@ module CandidApiClient
             obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
             obj.aliases.is_a?(Array) != false || raise("Passed value for field obj.aliases is not the expected type, validation failed.")
             obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+            obj.external_id&.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")
             obj.npi&.is_a?(String) != false || raise("Passed value for field obj.npi is not the expected type, validation failed.")
+            obj.place_of_service_code&.is_a?(CandidApiClient::Commons::Types::FacilityTypeCode) != false || raise("Passed value for field obj.place_of_service_code is not the expected type, validation failed.")
             obj.status&.is_a?(CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
             obj.operational_status&.is_a?(CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityOperationalStatus) != false || raise("Passed value for field obj.operational_status is not the expected type, validation failed.")
             obj.mode&.is_a?(CandidApiClient::OrganizationServiceFacilities::V2::Types::ServiceFacilityMode) != false || raise("Passed value for field obj.mode is not the expected type, validation failed.")