Class: CandidApiClient::EncounterProviders::V2::Types::EncounterProvider

Inherits:
Object
  • Object
show all
Defined in:
lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(provider_id:, address:, npi:, tax_id: OMIT, taxonomy_code: OMIT, qualifier: OMIT, first_name: OMIT, last_name: OMIT, organization_name: OMIT, additional_properties: nil) ⇒ CandidApiClient::EncounterProviders::V2::Types::EncounterProvider

Parameters:

  • provider_id (String)
  • address (CandidApiClient::Commons::Types::StreetAddressLongZip)
  • tax_id (String) (defaults to: OMIT)
  • npi (String)
  • taxonomy_code (String) (defaults to: OMIT)
  • qualifier (CandidApiClient::Commons::Types::QualifierCode) (defaults to: OMIT)
  • first_name (String) (defaults to: OMIT) —

    If the provider is an individual, this should be set instead of organization name

  • last_name (String) (defaults to: OMIT) —

    If the provider is an individual, this should be set instead of organization name

  • organization_name (String) (defaults to: OMIT) —

    If the provider is an organization, this should be set instead of first + last name

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb', line 56

def initialize(provider_id:, address:, npi:, tax_id: OMIT, taxonomy_code: OMIT, qualifier: OMIT,
               first_name: OMIT, last_name: OMIT, organization_name: OMIT, additional_properties: nil)
  @provider_id = provider_id
  @address = address
  @tax_id = tax_id if tax_id != OMIT
  @npi = npi
  @taxonomy_code = taxonomy_code if taxonomy_code != OMIT
  @qualifier = qualifier if qualifier != OMIT
  @first_name = first_name if first_name != OMIT
  @last_name = last_name if last_name != OMIT
  @organization_name = organization_name if organization_name != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "provider_id": provider_id,
    "address": address,
    "tax_id": tax_id,
    "npi": npi,
    "taxonomy_code": taxonomy_code,
    "qualifier": qualifier,
    "first_name": first_name,
    "last_name": last_name,
    "organization_name": organization_name
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



35
36
37
 
# File 'lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb', line 35

def additional_properties
  @additional_properties
end

#address ⇒ CandidApiClient::Commons::Types::StreetAddressLongZip (readonly)

Returns:



16
17
18
 
# File 'lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb', line 16

def address
  @address
end

#first_name ⇒ String (readonly)

Returns If the provider is an individual, this should be set instead of organization name.

Returns:

  • (String) —

    If the provider is an individual, this should be set instead of organization name



27
28
29
 
# File 'lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb', line 27

def first_name
  @first_name
end

#last_name ⇒ String (readonly)

Returns If the provider is an individual, this should be set instead of organization name.

Returns:

  • (String) —

    If the provider is an individual, this should be set instead of organization name



30
31
32
 
# File 'lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb', line 30

def last_name
  @last_name
end

#npi ⇒ String (readonly)

Returns:

  • (String) 


20
21
22
 
# File 'lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb', line 20

def npi
  @npi
end

#organization_name ⇒ String (readonly)

Returns If the provider is an organization, this should be set instead of first + last name.

Returns:

  • (String) —

    If the provider is an organization, this should be set instead of first + last name



33
34
35
 
# File 'lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb', line 33

def organization_name
  @organization_name
end

#provider_id ⇒ String (readonly)

Returns:

  • (String) 


14
15
16
 
# File 'lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb', line 14

def provider_id
  @provider_id
end

#qualifier ⇒ CandidApiClient::Commons::Types::QualifierCode (readonly)

Returns:



24
25
26
 
# File 'lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb', line 24

def qualifier
  @qualifier
end

#tax_id ⇒ String (readonly)

Returns:

  • (String) 


18
19
20
 
# File 'lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb', line 18

def tax_id
  @tax_id
end

#taxonomy_code ⇒ String (readonly)

Returns:

  • (String) 


22
23
24
 
# File 'lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb', line 22

def taxonomy_code
  @taxonomy_code
end

Class Method Details

.from_json(json_object:) ⇒ CandidApiClient::EncounterProviders::V2::Types::EncounterProvider

Deserialize a JSON object to an instance of EncounterProvider

Parameters:

  • json_object (String)

Returns:



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb', line 87

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  provider_id = struct["provider_id"]
  if parsed_json["address"].nil?
    address = nil
  else
    address = parsed_json["address"].to_json
    address = CandidApiClient::Commons::Types::StreetAddressLongZip.from_json(json_object: address)
  end
  tax_id = struct["tax_id"]
  npi = struct["npi"]
  taxonomy_code = struct["taxonomy_code"]
  qualifier = struct["qualifier"]
  first_name = struct["first_name"]
  last_name = struct["last_name"]
  organization_name = struct["organization_name"]
  new(
    provider_id: provider_id,
    address: address,
    tax_id: tax_id,
    npi: npi,
    taxonomy_code: taxonomy_code,
    qualifier: qualifier,
    first_name: first_name,
    last_name: last_name,
    organization_name: organization_name,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

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.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb', line 131

def self.validate_raw(obj:)
  obj.provider_id.is_a?(String) != false || raise("Passed value for field obj.provider_id is not the expected type, validation failed.")
  CandidApiClient::Commons::Types::StreetAddressLongZip.validate_raw(obj: obj.address)
  obj.tax_id&.is_a?(String) != false || raise("Passed value for field obj.tax_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.taxonomy_code&.is_a?(String) != false || raise("Passed value for field obj.taxonomy_code is not the expected type, validation failed.")
  obj.qualifier&.is_a?(CandidApiClient::Commons::Types::QualifierCode) != false || raise("Passed value for field obj.qualifier is not the expected type, validation failed.")
  obj.first_name&.is_a?(String) != false || raise("Passed value for field obj.first_name is not the expected type, validation failed.")
  obj.last_name&.is_a?(String) != false || raise("Passed value for field obj.last_name is not the expected type, validation failed.")
  obj.organization_name&.is_a?(String) != false || raise("Passed value for field obj.organization_name is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of EncounterProvider to a JSON object

Returns:

  • (String) 


121
122
123
 
# File 'lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb', line 121

def to_json(*_args)
  @_field_set&.to_json
end