candidhealth 0.27.0 → 0.28.0

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

@@ -3,6 +3,8 @@
 require_relative "../../../../requests"
 require_relative "types/mutable_patient"
 require_relative "types/patient"
+require_relative "../../common/types/sort_direction"
+require_relative "types/patient_page"
 require "json"
 require "date"
 require "async"
@@ -77,7 +79,7 @@ module CandidApiClient
           # @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(request: { name: {  }, other_names: [{  }], 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: {  }, other_addresses: [{  }], primary_telecom: {  }, other_telecoms: [{  }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: {  }, telecoms: [{  }], addresses: [{  }], period: {  } }], general_practitioners: [{  }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] } })
+          #  api.pre_encounter.patients.v_1.create(request: { name: {  }, other_names: [{  }], 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: {  }, other_addresses: [{  }], primary_telecom: {  }, other_telecoms: [{  }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: {  }, telecoms: [{  }], addresses: [{  }], period: {  }, hipaa_authorization: true }], general_practitioners: [{  }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] } })
           def create(request:, 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?
@@ -94,6 +96,44 @@ module CandidApiClient
             CandidApiClient::PreEncounter::Patients::V1::Types::Patient.from_json(json_object: response.body)
           end
 
+          # Searches for patients that match the query parameters.
+          #
+          # @param page_token [String]
+          # @param limit [Integer]
+          # @param sort_field [String]
+          # @param sort_direction [CandidApiClient::PreEncounter::Common::Types::SortDirection] Defaults to ascending.
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [CandidApiClient::PreEncounter::Patients::V1::Types::PatientPage]
+          # @example
+          #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+          #  api.pre_encounter.patients.v_1.get_multi(
+          #    page_token: "string",
+          #    limit: 1,
+          #    sort_field: "string",
+          #    sort_direction: ASC
+          #  )
+          def get_multi(page_token: nil, limit: nil, sort_field: nil, sort_direction: 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?
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
+              req.params = {
+                **(request_options&.additional_query_parameters || {}),
+                "page_token": page_token,
+                "limit": limit,
+                "sort_field": sort_field,
+                "sort_direction": sort_direction
+              }.compact
+              req.url "#{@request_client.get_url(environment: PreEncounter,
+                                                 request_options: request_options)}/patients/v1/get_multi"
+            end
+            CandidApiClient::PreEncounter::Patients::V1::Types::PatientPage.from_json(json_object: response.body)
+          end
+
           # Gets a patient.
           #
           # @param id [String]
@@ -145,8 +185,8 @@ module CandidApiClient
             end
           end
 
-          # Updates a patient. The path must contain the most recent version to prevent
-          #  races. Updating historic versions is not supported.
+          # Updates a patient. The path must contain the most recent version to prevent race
+          #  conditions. Updating historic versions is not supported.
           #
           # @param id [String]
           # @param version [String]
@@ -206,7 +246,7 @@ module CandidApiClient
           #  api.pre_encounter.patients.v_1.update(
           #    id: "string",
           #    version: "string",
-          #    request: { name: {  }, other_names: [{  }], 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: {  }, other_addresses: [{  }], primary_telecom: {  }, other_telecoms: [{  }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: {  }, telecoms: [{  }], addresses: [{  }], period: {  } }], general_practitioners: [{  }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] } }
+          #    request: { name: {  }, other_names: [{  }], 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: {  }, other_addresses: [{  }], primary_telecom: {  }, other_telecoms: [{  }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: {  }, telecoms: [{  }], addresses: [{  }], period: {  }, hipaa_authorization: true }], general_practitioners: [{  }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] } }
           #  )
           def update(id:, version:, request:, request_options: nil)
             response = @request_client.conn.put do |req|
@@ -225,9 +265,9 @@ module CandidApiClient
           end
 
           # Sets a patient as deactivated. The path must contain the most recent version to
-          #  prevent races. Dactivating historic versions is not supported. Subsequent
-          #  updates via PUT to the patient will "reactivate" the patient and set the
-          #  deactivated flag to false.
+          #  prevent race conditions. Deactivating historic versions is not supported.
+          #  Subsequent updates via PUT to the patient will "reactivate" the patient and set
+          #  the deactivated flag to false.
           #
           # @param id [String]
           # @param version [String]
@@ -250,15 +290,16 @@ module CandidApiClient
             end
           end
 
-          # Searches for patients that match the query parameters.
+          # Returns a list of Patients based on the search criteria.
           #
-          # @param name_contains [String]
+          # @param mrn [String]
+          # @param similar_name_ordering [String] A string that is used to order similar names in search results.
           # @param request_options [CandidApiClient::RequestOptions]
           # @return [Array<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.search(name_contains: "string")
-          def search(name_contains: nil, request_options: nil)
+          #  api.pre_encounter.patients.v_1.search(mrn: "string", similar_name_ordering: "string")
+          def search(mrn: nil, similar_name_ordering: 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?
@@ -269,7 +310,8 @@ module CandidApiClient
               }.compact
               req.params = {
                 **(request_options&.additional_query_parameters || {}),
-                "name_contains": name_contains
+                "mrn": mrn,
+                "similar_name_ordering": similar_name_ordering
               }.compact
               req.url "#{@request_client.get_url(environment: PreEncounter,
                                                  request_options: request_options)}/patients/v1"
@@ -377,7 +419,7 @@ module CandidApiClient
           # @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(request: { name: {  }, other_names: [{  }], 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: {  }, other_addresses: [{  }], primary_telecom: {  }, other_telecoms: [{  }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: {  }, telecoms: [{  }], addresses: [{  }], period: {  } }], general_practitioners: [{  }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] } })
+          #  api.pre_encounter.patients.v_1.create(request: { name: {  }, other_names: [{  }], 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: {  }, other_addresses: [{  }], primary_telecom: {  }, other_telecoms: [{  }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: {  }, telecoms: [{  }], addresses: [{  }], period: {  }, hipaa_authorization: true }], general_practitioners: [{  }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] } })
           def create(request:, request_options: nil)
             Async do
               response = @request_client.conn.post do |req|
@@ -396,6 +438,46 @@ module CandidApiClient
             end
           end
 
+          # Searches for patients that match the query parameters.
+          #
+          # @param page_token [String]
+          # @param limit [Integer]
+          # @param sort_field [String]
+          # @param sort_direction [CandidApiClient::PreEncounter::Common::Types::SortDirection] Defaults to ascending.
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [CandidApiClient::PreEncounter::Patients::V1::Types::PatientPage]
+          # @example
+          #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+          #  api.pre_encounter.patients.v_1.get_multi(
+          #    page_token: "string",
+          #    limit: 1,
+          #    sort_field: "string",
+          #    sort_direction: ASC
+          #  )
+          def get_multi(page_token: nil, limit: nil, sort_field: nil, sort_direction: 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?
+                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 || {}),
+                  "page_token": page_token,
+                  "limit": limit,
+                  "sort_field": sort_field,
+                  "sort_direction": sort_direction
+                }.compact
+                req.url "#{@request_client.get_url(environment: PreEncounter,
+                                                   request_options: request_options)}/patients/v1/get_multi"
+              end
+              CandidApiClient::PreEncounter::Patients::V1::Types::PatientPage.from_json(json_object: response.body)
+            end
+          end
+
           # Gets a patient.
           #
           # @param id [String]
@@ -451,8 +533,8 @@ module CandidApiClient
             end
           end
 
-          # Updates a patient. The path must contain the most recent version to prevent
-          #  races. Updating historic versions is not supported.
+          # Updates a patient. The path must contain the most recent version to prevent race
+          #  conditions. Updating historic versions is not supported.
           #
           # @param id [String]
           # @param version [String]
@@ -512,7 +594,7 @@ module CandidApiClient
           #  api.pre_encounter.patients.v_1.update(
           #    id: "string",
           #    version: "string",
-          #    request: { name: {  }, other_names: [{  }], 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: {  }, other_addresses: [{  }], primary_telecom: {  }, other_telecoms: [{  }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: {  }, telecoms: [{  }], addresses: [{  }], period: {  } }], general_practitioners: [{  }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] } }
+          #    request: { name: {  }, other_names: [{  }], 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: {  }, other_addresses: [{  }], primary_telecom: {  }, other_telecoms: [{  }], email: "string", electronic_communication_opt_in: true, photo: "string", language: "string", external_provenance: { external_id: "string", system_name: "string" }, contacts: [{ relationship: [SELF], name: {  }, telecoms: [{  }], addresses: [{  }], period: {  }, hipaa_authorization: true }], general_practitioners: [{  }], filing_order: { coverages: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] } }
           #  )
           def update(id:, version:, request:, request_options: nil)
             Async do
@@ -533,9 +615,9 @@ module CandidApiClient
           end
 
           # Sets a patient as deactivated. The path must contain the most recent version to
-          #  prevent races. Dactivating historic versions is not supported. Subsequent
-          #  updates via PUT to the patient will "reactivate" the patient and set the
-          #  deactivated flag to false.
+          #  prevent race conditions. Deactivating historic versions is not supported.
+          #  Subsequent updates via PUT to the patient will "reactivate" the patient and set
+          #  the deactivated flag to false.
           #
           # @param id [String]
           # @param version [String]
@@ -560,15 +642,16 @@ module CandidApiClient
             end
           end
 
-          # Searches for patients that match the query parameters.
+          # Returns a list of Patients based on the search criteria.
           #
-          # @param name_contains [String]
+          # @param mrn [String]
+          # @param similar_name_ordering [String] A string that is used to order similar names in search results.
           # @param request_options [CandidApiClient::RequestOptions]
           # @return [Array<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.search(name_contains: "string")
-          def search(name_contains: nil, request_options: nil)
+          #  api.pre_encounter.patients.v_1.search(mrn: "string", similar_name_ordering: "string")
+          def search(mrn: nil, similar_name_ordering: 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?
@@ -580,7 +663,8 @@ module CandidApiClient
                 }.compact
                 req.params = {
                   **(request_options&.additional_query_parameters || {}),
-                  "name_contains": name_contains
+                  "mrn": mrn,
+                  "similar_name_ordering": similar_name_ordering
                 }.compact
                 req.url "#{@request_client.get_url(environment: PreEncounter,
                                                    request_options: request_options)}/patients/v1"

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

@@ -24,6 +24,8 @@ module CandidApiClient
             attr_reader :addresses
             # @return [CandidApiClient::PreEncounter::Common::Types::Period]
             attr_reader :period
+            # @return [Boolean]
+            attr_reader :hipaa_authorization
             # @return [OpenStruct] Additional properties unmapped to the current class definition
             attr_reader :additional_properties
             # @return [Object]
@@ -37,21 +39,25 @@ module CandidApiClient
             # @param telecoms [Array<CandidApiClient::PreEncounter::Common::Types::ContactPoint>]
             # @param addresses [Array<CandidApiClient::PreEncounter::Common::Types::Address>]
             # @param period [CandidApiClient::PreEncounter::Common::Types::Period]
+            # @param hipaa_authorization [Boolean]
             # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
             # @return [CandidApiClient::PreEncounter::Patients::V1::Types::Contact]
-            def initialize(relationship:, name:, telecoms:, addresses:, period: OMIT, additional_properties: nil)
+            def initialize(relationship:, name:, telecoms:, addresses:, period: OMIT, hipaa_authorization: OMIT,
+                           additional_properties: nil)
               @relationship = relationship
               @name = name
               @telecoms = telecoms
               @addresses = addresses
               @period = period if period != OMIT
+              @hipaa_authorization = hipaa_authorization if hipaa_authorization != OMIT
               @additional_properties = additional_properties
               @_field_set = {
                 "relationship": relationship,
                 "name": name,
                 "telecoms": telecoms,
                 "addresses": addresses,
-                "period": period
+                "period": period,
+                "hipaa_authorization": hipaa_authorization
               }.reject do |_k, v|
                 v == OMIT
               end
@@ -85,12 +91,14 @@ module CandidApiClient
                 period = parsed_json["period"].to_json
                 period = CandidApiClient::PreEncounter::Common::Types::Period.from_json(json_object: period)
               end
+              hipaa_authorization = struct["hipaa_authorization"]
               new(
                 relationship: relationship,
                 name: name,
                 telecoms: telecoms,
                 addresses: addresses,
                 period: period,
+                hipaa_authorization: hipaa_authorization,
                 additional_properties: struct
               )
             end
@@ -114,6 +122,7 @@ module CandidApiClient
               obj.telecoms.is_a?(Array) != false || raise("Passed value for field obj.telecoms is not the expected type, validation failed.")
               obj.addresses.is_a?(Array) != false || raise("Passed value for field obj.addresses is not the expected type, validation failed.")
               obj.period.nil? || CandidApiClient::PreEncounter::Common::Types::Period.validate_raw(obj: obj.period)
+              obj.hipaa_authorization&.is_a?(Boolean) != false || raise("Passed value for field obj.hipaa_authorization is not the expected type, validation failed.")
             end
           end
         end

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

@@ -29,7 +29,8 @@ module CandidApiClient
             #  contexts.
             attr_reader :id
             # @return [String] The medical record number for the patient. Human-friendly Candid generated MRNs
-            #  are of the form JCH + 8 alphanumeric characters. MRNs are not case-sensitive.
+            #  are of the form "YYMMDDXXXX", where "YYYYMMDD" is the date of patient creation
+            #  and "XXXX" is a zero-padded incrementing integer.
             attr_reader :mrn
             # @return [String] The organization that owns this patient.
             attr_reader :organization_id
@@ -108,7 +109,8 @@ module CandidApiClient
             # @param id [String] The unique UUID identifier for a Patient. Patient ID is used in machine
             #  contexts.
             # @param mrn [String] The medical record number for the patient. Human-friendly Candid generated MRNs
-            #  are of the form JCH + 8 alphanumeric characters. MRNs are not case-sensitive.
+            #  are of the form "YYMMDDXXXX", where "YYYYMMDD" is the date of patient creation
+            #  and "XXXX" is a zero-padded incrementing integer.
             # @param organization_id [String] The organization that owns this patient.
             # @param deactivated [Boolean] True if the patient is deactivated. Deactivated patients are not returned in
             #  search results but are returned in all other endpoints including scan.

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

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative "patient"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module PreEncounter
+    module Patients
+      module V1
+        module Types
+          class PatientPage
+            # @return [Array<CandidApiClient::PreEncounter::Patients::V1::Types::Patient>]
+            attr_reader :items
+            # @return [String]
+            attr_reader :next_page_token
+            # @return [String]
+            attr_reader :prev_page_token
+            # @return [OpenStruct] Additional properties unmapped to the current class definition
+            attr_reader :additional_properties
+            # @return [Object]
+            attr_reader :_field_set
+            protected :_field_set
+
+            OMIT = Object.new
+
+            # @param items [Array<CandidApiClient::PreEncounter::Patients::V1::Types::Patient>]
+            # @param next_page_token [String]
+            # @param prev_page_token [String]
+            # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+            # @return [CandidApiClient::PreEncounter::Patients::V1::Types::PatientPage]
+            def initialize(items:, next_page_token: OMIT, prev_page_token: OMIT, additional_properties: nil)
+              @items = items
+              @next_page_token = next_page_token if next_page_token != OMIT
+              @prev_page_token = prev_page_token if prev_page_token != OMIT
+              @additional_properties = additional_properties
+              @_field_set = {
+                "items": items,
+                "next_page_token": next_page_token,
+                "prev_page_token": prev_page_token
+              }.reject do |_k, v|
+                v == OMIT
+              end
+            end
+
+            # Deserialize a JSON object to an instance of PatientPage
+            #
+            # @param json_object [String]
+            # @return [CandidApiClient::PreEncounter::Patients::V1::Types::PatientPage]
+            def self.from_json(json_object:)
+              struct = JSON.parse(json_object, object_class: OpenStruct)
+              parsed_json = JSON.parse(json_object)
+              items = parsed_json["items"]&.map do |item|
+                item = item.to_json
+                CandidApiClient::PreEncounter::Patients::V1::Types::Patient.from_json(json_object: item)
+              end
+              next_page_token = struct["next_page_token"]
+              prev_page_token = struct["prev_page_token"]
+              new(
+                items: items,
+                next_page_token: next_page_token,
+                prev_page_token: prev_page_token,
+                additional_properties: struct
+              )
+            end
+
+            # Serialize an instance of PatientPage to a JSON object
+            #
+            # @return [String]
+            def to_json(*_args)
+              @_field_set&.to_json
+            end
+
+            # Leveraged for Union-type generation, validate_raw attempts to parse the given
+            #  hash and check each fields type against the current object's property
+            #  definitions.
+            #
+            # @param obj [Object]
+            # @return [Void]
+            def self.validate_raw(obj:)
+              obj.items.is_a?(Array) != false || raise("Passed value for field obj.items is not the expected type, validation failed.")
+              obj.next_page_token&.is_a?(String) != false || raise("Passed value for field obj.next_page_token is not the expected type, validation failed.")
+              obj.prev_page_token&.is_a?(String) != false || raise("Passed value for field obj.prev_page_token is not the expected type, validation failed.")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/requests.rb

@@ -43,7 +43,7 @@ module CandidApiClient
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "0.27.0" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "0.28.0" }
       headers["Authorization"] = ((@token.is_a? Method) ? @token.call : @token) unless token.nil?
       headers
     end
@@ -87,7 +87,7 @@ module CandidApiClient
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "0.27.0" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "0.28.0" }
       headers["Authorization"] = ((@token.is_a? Method) ? @token.call : @token) unless token.nil?
       headers
     end

data/lib/types_export.rb

@@ -252,6 +252,24 @@ require_relative "candidhealth/x_12/v_1/types/claim_adjustment_reason_code"
 require_relative "candidhealth/x_12/v_1/types/remittance_advice_remark_code"
 require_relative "candidhealth/x_12/v_1/types/carc"
 require_relative "candidhealth/x_12/v_1/types/rarc"
+require_relative "candidhealth/pre_encounter/appointments/v_1/types/appointment_work_queue"
+require_relative "candidhealth/pre_encounter/appointments/v_1/types/appointment_sort_field"
+require_relative "candidhealth/pre_encounter/appointments/v_1/types/universal_service_identifier"
+require_relative "candidhealth/pre_encounter/appointments/v_1/types/appointment_reason"
+require_relative "candidhealth/pre_encounter/appointments/v_1/types/appointment_type"
+require_relative "candidhealth/pre_encounter/appointments/v_1/types/service"
+require_relative "candidhealth/pre_encounter/appointments/v_1/types/mutable_appointment"
+require_relative "candidhealth/pre_encounter/appointments/v_1/types/appointment"
+require_relative "candidhealth/pre_encounter/coverages/v_1/types/eligibility_check_metadata"
+require_relative "candidhealth/pre_encounter/coverages/v_1/types/coverage_eligibility_check_response"
+require_relative "candidhealth/pre_encounter/coverages/v_1/types/eligibility_check"
+require_relative "candidhealth/pre_encounter/coverages/v_1/types/eligibility_check_status"
+require_relative "candidhealth/pre_encounter/coverages/v_1/types/coverage_value"
+require_relative "candidhealth/pre_encounter/coverages/v_1/types/coverage_benefits"
+require_relative "candidhealth/pre_encounter/coverages/v_1/types/plan_coverage"
+require_relative "candidhealth/pre_encounter/coverages/v_1/types/plan_coverage_details"
+require_relative "candidhealth/pre_encounter/coverages/v_1/types/service_coverage"
+require_relative "candidhealth/pre_encounter/coverages/v_1/types/service_coverage_details"
 require_relative "candidhealth/pre_encounter/coverages/v_1/types/subscriber"
 require_relative "candidhealth/pre_encounter/coverages/v_1/types/coverage_status"
 require_relative "candidhealth/pre_encounter/coverages/v_1/types/network_type"
@@ -259,12 +277,14 @@ require_relative "candidhealth/pre_encounter/coverages/v_1/types/insurance_plan"
 require_relative "candidhealth/pre_encounter/coverages/v_1/types/mutable_coverage"
 require_relative "candidhealth/pre_encounter/coverages/v_1/types/coverage"
 require_relative "candidhealth/pre_encounter/coverages/v_1/types/insurance_type_code"
+require_relative "candidhealth/pre_encounter/coverages/v_1/types/service_type_code"
 require_relative "candidhealth/pre_encounter/patients/v_1/types/marital_status"
 require_relative "candidhealth/pre_encounter/patients/v_1/types/external_provenance"
 require_relative "candidhealth/pre_encounter/patients/v_1/types/contact"
 require_relative "candidhealth/pre_encounter/patients/v_1/types/filing_order"
 require_relative "candidhealth/pre_encounter/patients/v_1/types/mutable_patient"
 require_relative "candidhealth/pre_encounter/patients/v_1/types/patient"
+require_relative "candidhealth/pre_encounter/patients/v_1/types/patient_page"
 require_relative "candidhealth/claims/types/claim"
 require_relative "candidhealth/claims/types/claim_status"
 require_relative "candidhealth/commons/types/primitive"
@@ -366,8 +386,10 @@ require_relative "candidhealth/pre_encounter/common/types/address"
 require_relative "candidhealth/pre_encounter/common/types/period"
 require_relative "candidhealth/pre_encounter/common/types/contact_point_use"
 require_relative "candidhealth/pre_encounter/common/types/contact_point"
+require_relative "candidhealth/pre_encounter/common/types/resource_page"
 require_relative "candidhealth/pre_encounter/common/types/error_base"
 require_relative "candidhealth/pre_encounter/common/types/not_found_error_body"
 require_relative "candidhealth/pre_encounter/common/types/version_conflict_error_body"
 require_relative "candidhealth/pre_encounter/common/types/external_provider_type"
 require_relative "candidhealth/pre_encounter/common/types/external_provider"
+require_relative "candidhealth/pre_encounter/common/types/sort_direction"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: candidhealth
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.28.0
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-16 00:00:00.000000000 Z
+date: 2024-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -412,6 +412,16 @@ files:
 - lib/candidhealth/payers/v_3/types/payer_identifier.rb
 - lib/candidhealth/payers/v_3/types/payer_info.rb
 - lib/candidhealth/payers/v_3/types/payer_page.rb
+- lib/candidhealth/pre_encounter/appointments/client.rb
+- lib/candidhealth/pre_encounter/appointments/v_1/client.rb
+- lib/candidhealth/pre_encounter/appointments/v_1/types/appointment.rb
+- lib/candidhealth/pre_encounter/appointments/v_1/types/appointment_reason.rb
+- lib/candidhealth/pre_encounter/appointments/v_1/types/appointment_sort_field.rb
+- lib/candidhealth/pre_encounter/appointments/v_1/types/appointment_type.rb
+- lib/candidhealth/pre_encounter/appointments/v_1/types/appointment_work_queue.rb
+- lib/candidhealth/pre_encounter/appointments/v_1/types/mutable_appointment.rb
+- lib/candidhealth/pre_encounter/appointments/v_1/types/service.rb
+- lib/candidhealth/pre_encounter/appointments/v_1/types/universal_service_identifier.rb
 - lib/candidhealth/pre_encounter/client.rb
 - lib/candidhealth/pre_encounter/common/types/address.rb
 - lib/candidhealth/pre_encounter/common/types/address_use.rb
@@ -429,17 +439,30 @@ files:
 - lib/candidhealth/pre_encounter/common/types/period.rb
 - lib/candidhealth/pre_encounter/common/types/race.rb
 - lib/candidhealth/pre_encounter/common/types/relationship.rb
+- lib/candidhealth/pre_encounter/common/types/resource_page.rb
 - lib/candidhealth/pre_encounter/common/types/sex.rb
 - lib/candidhealth/pre_encounter/common/types/sexual_orientation.rb
+- lib/candidhealth/pre_encounter/common/types/sort_direction.rb
 - lib/candidhealth/pre_encounter/common/types/version_conflict_error_body.rb
 - lib/candidhealth/pre_encounter/coverages/client.rb
 - lib/candidhealth/pre_encounter/coverages/v_1/client.rb
 - lib/candidhealth/pre_encounter/coverages/v_1/types/coverage.rb
+- lib/candidhealth/pre_encounter/coverages/v_1/types/coverage_benefits.rb
+- lib/candidhealth/pre_encounter/coverages/v_1/types/coverage_eligibility_check_response.rb
 - lib/candidhealth/pre_encounter/coverages/v_1/types/coverage_status.rb
+- lib/candidhealth/pre_encounter/coverages/v_1/types/coverage_value.rb
+- lib/candidhealth/pre_encounter/coverages/v_1/types/eligibility_check.rb
+- lib/candidhealth/pre_encounter/coverages/v_1/types/eligibility_check_metadata.rb
+- lib/candidhealth/pre_encounter/coverages/v_1/types/eligibility_check_status.rb
 - lib/candidhealth/pre_encounter/coverages/v_1/types/insurance_plan.rb
 - lib/candidhealth/pre_encounter/coverages/v_1/types/insurance_type_code.rb
 - lib/candidhealth/pre_encounter/coverages/v_1/types/mutable_coverage.rb
 - lib/candidhealth/pre_encounter/coverages/v_1/types/network_type.rb
+- lib/candidhealth/pre_encounter/coverages/v_1/types/plan_coverage.rb
+- lib/candidhealth/pre_encounter/coverages/v_1/types/plan_coverage_details.rb
+- lib/candidhealth/pre_encounter/coverages/v_1/types/service_coverage.rb
+- lib/candidhealth/pre_encounter/coverages/v_1/types/service_coverage_details.rb
+- lib/candidhealth/pre_encounter/coverages/v_1/types/service_type_code.rb
 - lib/candidhealth/pre_encounter/coverages/v_1/types/subscriber.rb
 - lib/candidhealth/pre_encounter/patients/client.rb
 - lib/candidhealth/pre_encounter/patients/v_1/client.rb
@@ -449,6 +472,7 @@ files:
 - lib/candidhealth/pre_encounter/patients/v_1/types/marital_status.rb
 - lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient.rb
 - lib/candidhealth/pre_encounter/patients/v_1/types/patient.rb
+- lib/candidhealth/pre_encounter/patients/v_1/types/patient_page.rb
 - lib/candidhealth/remits/v_1/types/payee.rb
 - lib/candidhealth/remits/v_1/types/payee_identifier.rb
 - lib/candidhealth/service_facility/client.rb