pharmaobservatory 0.1.7 → 0.1.8

data/lib/pharmaobservatory/models/rwd_institutions_row.rb

@@ -0,0 +1,981 @@
+=begin
+#Pharma Observatory Public REST API
+
+#Read-only REST API over the Pharma Observatory biomedical data platform. Reference: https://pharmaobservatory.com/api-reference
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PharmaObservatory
+  # One row of the rwd_institutions dataset: one row per register institution entry (Institution ID). A grouped request returns the group columns and the measures instead, as additional properties.
+  class RwdInstitutionsRow
+    # The register's own Institution ID. The entry key of the rwd_institutions object type. The register can list one name under two ids; counts are per id and are not additive across rows.
+    attr_accessor :institution_id
+
+    # The institution's name as the register spells it; an institution here can be registered under a person's name.
+    attr_accessor :institution_name
+
+    # The legal entity (organization record id) the institution resolved to; null when it did not resolve. An unresolved institution keeps its row with null ids.
+    attr_accessor :institution_org_id
+
+    # The company the institution's legal entity belongs to; null when unresolved.
+    attr_accessor :institution_company_id
+
+    # The company's name.
+    attr_accessor :institution_company_name
+
+    # The current ultimate parent company of the institution's company.
+    attr_accessor :institution_group_id
+
+    # The group's name.
+    attr_accessor :institution_group_name
+
+    # How the institution name resolved to a legal entity (the resolution rung); null when unresolved.
+    attr_accessor :org_match_rung
+
+    # The confidence tier of that resolution; null when unresolved.
+    attr_accessor :org_match_tier
+
+    # The legal entity the register's parent institution claim resolved to. Most parent claims are claims between register entries, not between organizations: read it with is_org_to_org.
+    attr_accessor :parent_org_id
+
+    # True when the parent claim is a claim between two resolved legal entities, false when it only links register entries.
+    attr_accessor :is_org_to_org
+
+    # The normalised name key the study, membership and holder edges join on.
+    attr_accessor :institution_name_key
+
+    # The parent institution's name as the register spells it.
+    attr_accessor :parent_name
+
+    # The normalised key of the parent name.
+    attr_accessor :parent_name_key
+
+    # self_registered_profile when the entry carries at least one descriptive field, catalogue_name_entry when it is a name and an id only (a catalogue pick-list entry nobody registered a profile for). The declaration columns are null on a catalogue name entry.
+    attr_accessor :registration_state
+
+    # True when registration_state is self_registered_profile.
+    attr_accessor :is_self_registered_profile
+
+    # How many of the declarable profile fields the entry answered.
+    attr_accessor :declared_profile_fields
+
+    # How many profile fields the register offers; the denominator of declared_profile_fields.
+    attr_accessor :declarable_profile_fields
+
+    # The type of institution the entry declares, as typed.
+    attr_accessor :type_of_institution
+
+    # The role the entry declares for the institution, as typed.
+    attr_accessor :institution_role
+
+    # The country text the entry declares, as typed.
+    attr_accessor :institution_countries
+
+    # The declared countries split by the register's country list, one element per country.
+    attr_accessor :institution_country_names
+
+    # How many countries institution_country_names holds.
+    attr_accessor :institution_country_count
+
+    # Country text items the country vocabulary of this build does not hold.
+    attr_accessor :unmatched_country_fragments
+
+    # The ISO 3166-1 alpha-2 code when the entry declares exactly one country, null otherwise.
+    attr_accessor :single_declared_country_iso2
+
+    # The institution's website as the register holds it.
+    attr_accessor :institution_website
+
+    # The address of this entry on the HMA-EMA catalogue site (the register's URL LINK).
+    attr_accessor :catalogue_url
+
+    # Whether the institution declares it is open to industry-funded research; null on a catalogue name entry, where the export writes a default No that is not an answer.
+    attr_accessor :open_to_industry_funded_research
+
+    # Whether the institution declares it collects data directly from patients; null on a catalogue name entry.
+    attr_accessor :collects_data_directly_from_patients
+
+    # Whether the entry declares an ENCePP partnership; null on a catalogue name entry, where the export writes a default No that is not an answer.
+    attr_accessor :is_encepp_partner
+
+    # When the registrant last edited this catalogue entry. A different clock from last_refreshed_on: it dates the web form, not the database.
+    attr_accessor :record_updated_at
+
+    # True when the record's last update date is a mass-edit date: one shared by an outsized part of the register, so it dates a migration and not the registrant.
+    attr_accessor :record_updated_is_mass_edit
+
+    # record_updated_at with the mass-edit dates removed (null for a mass-edit date or no timestamp): the column to sort a freshness question on.
+    attr_accessor :record_updated_at_attested
+
+    # The share of the register whose last update carries the same date, on every row so a mass-edit date is visible.
+    attr_accessor :record_updated_date_share
+
+    # When the catalogue entry was first published.
+    attr_accessor :record_first_published_at
+
+    # EMA's own Outdated flag, carried through untouched; the register flags none of the data sources, so read false as EMA's answer and not as a currency finding.
+    attr_accessor :is_outdated
+
+    # Distinct registered studies the institution's name conducted. Four separate activity numbers; never added together.
+    attr_accessor :conducting_studies_lifetime
+
+    # Conducting studies that started within five years of the snapshot.
+    attr_accessor :conducting_studies_last_5_years
+
+    # Conducting studies whose status is Ongoing.
+    attr_accessor :conducting_studies_ongoing
+
+    # Conducting studies whose status is Planned.
+    attr_accessor :conducting_studies_planned
+
+    # Distinct registered studies the conductor is named on as an additional institution; a different claim from conducting, never added to it.
+    attr_accessor :additional_role_studies
+
+    # The latest actual start date among the studies it conducted (or delivered, for a network).
+    attr_accessor :most_recent_study_start_on
+
+    # How many registered data sources name this institution as their data holder; zero is no source naming it, not a finding about the institution.
+    attr_accessor :held_source_count
+
+    # The register Data source IDs of those sources.
+    attr_accessor :held_source_ids
+
+    # The sum of the active populations the held sources declare.
+    attr_accessor :held_active_population
+
+    # The largest active population any held source declares.
+    attr_accessor :held_max_active_population
+
+    # How many held sources declare an active population.
+    attr_accessor :held_sources_declaring_active_population
+
+    # How many held sources declare a data source qualification.
+    attr_accessor :held_qualified_source_count
+
+    # How many held sources are DARWIN EU data partners.
+    attr_accessor :held_darwin_partner_source_count
+
+    # How many networks' own member lists name this institution; zero is the network's silence, not a property of the institution.
+    attr_accessor :network_membership_count
+
+    # The register Network IDs of those networks.
+    attr_accessor :network_ids
+
+    # The names of those networks.
+    attr_accessor :network_names
+
+    # The number of institutions in the whole institution register at the snapshot.
+    attr_accessor :institution_register_total
+
+    # How many register entries are self-registered profiles.
+    attr_accessor :self_registered_profile_total
+
+    # How many register entries are catalogue name entries.
+    attr_accessor :catalogue_name_entry_total
+
+    # How many register institutions declare a country.
+    attr_accessor :institutions_declaring_a_country
+
+    # How many register institutions at least one network member list names.
+    attr_accessor :institutions_in_any_member_list
+
+    # How many distinct institution name keys the register holds.
+    attr_accessor :institution_name_key_total
+
+    # How many register institutions hold a registered data source.
+    attr_accessor :institutions_holding_a_source
+
+    # How many distinct data holder names the data source register declares.
+    attr_accessor :declared_holder_name_total
+
+    # How many of those holder names match a register institution.
+    attr_accessor :declared_holder_name_matched
+
+    # The number of data sources in the whole data source register at the snapshot: the denominator every source count is over. Not a count of real-world data sources in the world.
+    attr_accessor :register_source_count
+
+    # The number of studies in the whole study register at the snapshot.
+    attr_accessor :study_register_total
+
+    # How many registered studies name at least one data source that is itself registered; the denominator under study_count.
+    attr_accessor :studies_naming_a_registered_source
+
+    # How many registered studies name a conducting institution that is itself registered.
+    attr_accessor :studies_naming_a_registered_conductor
+
+    # The label of the catalogue snapshot the row was read from (a date).
+    attr_accessor :snapshot_label
+
+    # The month and year the catalogue was accessed (YYYY-MM), which EMA's site asks to be cited with its URL.
+    attr_accessor :accessed_month
+
+    # The license restriction tier of the row's source. Every row of this dataset is licensable (PROVISIONAL, legal read pending).
+    attr_accessor :restriction_tier
+
+    # The attribution line EMA requires, including the catalogue URL and the access month; quote it with any figure taken from the row.
+    attr_accessor :attribution
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'institution_id' => :'institution_id',
+        :'institution_name' => :'institution_name',
+        :'institution_org_id' => :'institution_org_id',
+        :'institution_company_id' => :'institution_company_id',
+        :'institution_company_name' => :'institution_company_name',
+        :'institution_group_id' => :'institution_group_id',
+        :'institution_group_name' => :'institution_group_name',
+        :'org_match_rung' => :'org_match_rung',
+        :'org_match_tier' => :'org_match_tier',
+        :'parent_org_id' => :'parent_org_id',
+        :'is_org_to_org' => :'is_org_to_org',
+        :'institution_name_key' => :'institution_name_key',
+        :'parent_name' => :'parent_name',
+        :'parent_name_key' => :'parent_name_key',
+        :'registration_state' => :'registration_state',
+        :'is_self_registered_profile' => :'is_self_registered_profile',
+        :'declared_profile_fields' => :'declared_profile_fields',
+        :'declarable_profile_fields' => :'declarable_profile_fields',
+        :'type_of_institution' => :'type_of_institution',
+        :'institution_role' => :'institution_role',
+        :'institution_countries' => :'institution_countries',
+        :'institution_country_names' => :'institution_country_names',
+        :'institution_country_count' => :'institution_country_count',
+        :'unmatched_country_fragments' => :'unmatched_country_fragments',
+        :'single_declared_country_iso2' => :'single_declared_country_iso2',
+        :'institution_website' => :'institution_website',
+        :'catalogue_url' => :'catalogue_url',
+        :'open_to_industry_funded_research' => :'open_to_industry_funded_research',
+        :'collects_data_directly_from_patients' => :'collects_data_directly_from_patients',
+        :'is_encepp_partner' => :'is_encepp_partner',
+        :'record_updated_at' => :'record_updated_at',
+        :'record_updated_is_mass_edit' => :'record_updated_is_mass_edit',
+        :'record_updated_at_attested' => :'record_updated_at_attested',
+        :'record_updated_date_share' => :'record_updated_date_share',
+        :'record_first_published_at' => :'record_first_published_at',
+        :'is_outdated' => :'is_outdated',
+        :'conducting_studies_lifetime' => :'conducting_studies_lifetime',
+        :'conducting_studies_last_5_years' => :'conducting_studies_last_5_years',
+        :'conducting_studies_ongoing' => :'conducting_studies_ongoing',
+        :'conducting_studies_planned' => :'conducting_studies_planned',
+        :'additional_role_studies' => :'additional_role_studies',
+        :'most_recent_study_start_on' => :'most_recent_study_start_on',
+        :'held_source_count' => :'held_source_count',
+        :'held_source_ids' => :'held_source_ids',
+        :'held_active_population' => :'held_active_population',
+        :'held_max_active_population' => :'held_max_active_population',
+        :'held_sources_declaring_active_population' => :'held_sources_declaring_active_population',
+        :'held_qualified_source_count' => :'held_qualified_source_count',
+        :'held_darwin_partner_source_count' => :'held_darwin_partner_source_count',
+        :'network_membership_count' => :'network_membership_count',
+        :'network_ids' => :'network_ids',
+        :'network_names' => :'network_names',
+        :'institution_register_total' => :'institution_register_total',
+        :'self_registered_profile_total' => :'self_registered_profile_total',
+        :'catalogue_name_entry_total' => :'catalogue_name_entry_total',
+        :'institutions_declaring_a_country' => :'institutions_declaring_a_country',
+        :'institutions_in_any_member_list' => :'institutions_in_any_member_list',
+        :'institution_name_key_total' => :'institution_name_key_total',
+        :'institutions_holding_a_source' => :'institutions_holding_a_source',
+        :'declared_holder_name_total' => :'declared_holder_name_total',
+        :'declared_holder_name_matched' => :'declared_holder_name_matched',
+        :'register_source_count' => :'register_source_count',
+        :'study_register_total' => :'study_register_total',
+        :'studies_naming_a_registered_source' => :'studies_naming_a_registered_source',
+        :'studies_naming_a_registered_conductor' => :'studies_naming_a_registered_conductor',
+        :'snapshot_label' => :'snapshot_label',
+        :'accessed_month' => :'accessed_month',
+        :'restriction_tier' => :'restriction_tier',
+        :'attribution' => :'attribution'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'institution_id' => :'String',
+        :'institution_name' => :'String',
+        :'institution_org_id' => :'String',
+        :'institution_company_id' => :'String',
+        :'institution_company_name' => :'String',
+        :'institution_group_id' => :'String',
+        :'institution_group_name' => :'String',
+        :'org_match_rung' => :'String',
+        :'org_match_tier' => :'String',
+        :'parent_org_id' => :'String',
+        :'is_org_to_org' => :'Boolean',
+        :'institution_name_key' => :'String',
+        :'parent_name' => :'String',
+        :'parent_name_key' => :'String',
+        :'registration_state' => :'String',
+        :'is_self_registered_profile' => :'Boolean',
+        :'declared_profile_fields' => :'Integer',
+        :'declarable_profile_fields' => :'Integer',
+        :'type_of_institution' => :'String',
+        :'institution_role' => :'String',
+        :'institution_countries' => :'String',
+        :'institution_country_names' => :'Array<String>',
+        :'institution_country_count' => :'Integer',
+        :'unmatched_country_fragments' => :'Array<String>',
+        :'single_declared_country_iso2' => :'String',
+        :'institution_website' => :'String',
+        :'catalogue_url' => :'String',
+        :'open_to_industry_funded_research' => :'Boolean',
+        :'collects_data_directly_from_patients' => :'Boolean',
+        :'is_encepp_partner' => :'Boolean',
+        :'record_updated_at' => :'Time',
+        :'record_updated_is_mass_edit' => :'Boolean',
+        :'record_updated_at_attested' => :'Time',
+        :'record_updated_date_share' => :'Float',
+        :'record_first_published_at' => :'Time',
+        :'is_outdated' => :'Boolean',
+        :'conducting_studies_lifetime' => :'Integer',
+        :'conducting_studies_last_5_years' => :'Integer',
+        :'conducting_studies_ongoing' => :'Integer',
+        :'conducting_studies_planned' => :'Integer',
+        :'additional_role_studies' => :'Integer',
+        :'most_recent_study_start_on' => :'Date',
+        :'held_source_count' => :'Integer',
+        :'held_source_ids' => :'Array<String>',
+        :'held_active_population' => :'Integer',
+        :'held_max_active_population' => :'Integer',
+        :'held_sources_declaring_active_population' => :'Integer',
+        :'held_qualified_source_count' => :'Integer',
+        :'held_darwin_partner_source_count' => :'Integer',
+        :'network_membership_count' => :'Integer',
+        :'network_ids' => :'Array<String>',
+        :'network_names' => :'Array<String>',
+        :'institution_register_total' => :'Integer',
+        :'self_registered_profile_total' => :'Integer',
+        :'catalogue_name_entry_total' => :'Integer',
+        :'institutions_declaring_a_country' => :'Integer',
+        :'institutions_in_any_member_list' => :'Integer',
+        :'institution_name_key_total' => :'Integer',
+        :'institutions_holding_a_source' => :'Integer',
+        :'declared_holder_name_total' => :'Integer',
+        :'declared_holder_name_matched' => :'Integer',
+        :'register_source_count' => :'Integer',
+        :'study_register_total' => :'Integer',
+        :'studies_naming_a_registered_source' => :'Integer',
+        :'studies_naming_a_registered_conductor' => :'Integer',
+        :'snapshot_label' => :'String',
+        :'accessed_month' => :'String',
+        :'restriction_tier' => :'String',
+        :'attribution' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'institution_id',
+        :'institution_name',
+        :'institution_org_id',
+        :'institution_company_id',
+        :'institution_company_name',
+        :'institution_group_id',
+        :'institution_group_name',
+        :'org_match_rung',
+        :'org_match_tier',
+        :'parent_org_id',
+        :'is_org_to_org',
+        :'institution_name_key',
+        :'parent_name',
+        :'parent_name_key',
+        :'registration_state',
+        :'is_self_registered_profile',
+        :'declared_profile_fields',
+        :'declarable_profile_fields',
+        :'type_of_institution',
+        :'institution_role',
+        :'institution_countries',
+        :'institution_country_names',
+        :'institution_country_count',
+        :'unmatched_country_fragments',
+        :'single_declared_country_iso2',
+        :'institution_website',
+        :'catalogue_url',
+        :'open_to_industry_funded_research',
+        :'collects_data_directly_from_patients',
+        :'is_encepp_partner',
+        :'record_updated_at',
+        :'record_updated_is_mass_edit',
+        :'record_updated_at_attested',
+        :'record_updated_date_share',
+        :'record_first_published_at',
+        :'is_outdated',
+        :'conducting_studies_lifetime',
+        :'conducting_studies_last_5_years',
+        :'conducting_studies_ongoing',
+        :'conducting_studies_planned',
+        :'additional_role_studies',
+        :'most_recent_study_start_on',
+        :'held_source_count',
+        :'held_source_ids',
+        :'held_active_population',
+        :'held_max_active_population',
+        :'held_sources_declaring_active_population',
+        :'held_qualified_source_count',
+        :'held_darwin_partner_source_count',
+        :'network_membership_count',
+        :'network_ids',
+        :'network_names',
+        :'institution_register_total',
+        :'self_registered_profile_total',
+        :'catalogue_name_entry_total',
+        :'institutions_declaring_a_country',
+        :'institutions_in_any_member_list',
+        :'institution_name_key_total',
+        :'institutions_holding_a_source',
+        :'declared_holder_name_total',
+        :'declared_holder_name_matched',
+        :'register_source_count',
+        :'study_register_total',
+        :'studies_naming_a_registered_source',
+        :'studies_naming_a_registered_conductor',
+        :'snapshot_label',
+        :'accessed_month',
+        :'restriction_tier',
+        :'attribution'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::RwdInstitutionsRow` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PharmaObservatory::RwdInstitutionsRow`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'institution_id')
+        self.institution_id = attributes[:'institution_id']
+      end
+
+      if attributes.key?(:'institution_name')
+        self.institution_name = attributes[:'institution_name']
+      end
+
+      if attributes.key?(:'institution_org_id')
+        self.institution_org_id = attributes[:'institution_org_id']
+      end
+
+      if attributes.key?(:'institution_company_id')
+        self.institution_company_id = attributes[:'institution_company_id']
+      end
+
+      if attributes.key?(:'institution_company_name')
+        self.institution_company_name = attributes[:'institution_company_name']
+      end
+
+      if attributes.key?(:'institution_group_id')
+        self.institution_group_id = attributes[:'institution_group_id']
+      end
+
+      if attributes.key?(:'institution_group_name')
+        self.institution_group_name = attributes[:'institution_group_name']
+      end
+
+      if attributes.key?(:'org_match_rung')
+        self.org_match_rung = attributes[:'org_match_rung']
+      end
+
+      if attributes.key?(:'org_match_tier')
+        self.org_match_tier = attributes[:'org_match_tier']
+      end
+
+      if attributes.key?(:'parent_org_id')
+        self.parent_org_id = attributes[:'parent_org_id']
+      end
+
+      if attributes.key?(:'is_org_to_org')
+        self.is_org_to_org = attributes[:'is_org_to_org']
+      end
+
+      if attributes.key?(:'institution_name_key')
+        self.institution_name_key = attributes[:'institution_name_key']
+      end
+
+      if attributes.key?(:'parent_name')
+        self.parent_name = attributes[:'parent_name']
+      end
+
+      if attributes.key?(:'parent_name_key')
+        self.parent_name_key = attributes[:'parent_name_key']
+      end
+
+      if attributes.key?(:'registration_state')
+        self.registration_state = attributes[:'registration_state']
+      end
+
+      if attributes.key?(:'is_self_registered_profile')
+        self.is_self_registered_profile = attributes[:'is_self_registered_profile']
+      end
+
+      if attributes.key?(:'declared_profile_fields')
+        self.declared_profile_fields = attributes[:'declared_profile_fields']
+      end
+
+      if attributes.key?(:'declarable_profile_fields')
+        self.declarable_profile_fields = attributes[:'declarable_profile_fields']
+      end
+
+      if attributes.key?(:'type_of_institution')
+        self.type_of_institution = attributes[:'type_of_institution']
+      end
+
+      if attributes.key?(:'institution_role')
+        self.institution_role = attributes[:'institution_role']
+      end
+
+      if attributes.key?(:'institution_countries')
+        self.institution_countries = attributes[:'institution_countries']
+      end
+
+      if attributes.key?(:'institution_country_names')
+        if (value = attributes[:'institution_country_names']).is_a?(Array)
+          self.institution_country_names = value
+        end
+      end
+
+      if attributes.key?(:'institution_country_count')
+        self.institution_country_count = attributes[:'institution_country_count']
+      end
+
+      if attributes.key?(:'unmatched_country_fragments')
+        if (value = attributes[:'unmatched_country_fragments']).is_a?(Array)
+          self.unmatched_country_fragments = value
+        end
+      end
+
+      if attributes.key?(:'single_declared_country_iso2')
+        self.single_declared_country_iso2 = attributes[:'single_declared_country_iso2']
+      end
+
+      if attributes.key?(:'institution_website')
+        self.institution_website = attributes[:'institution_website']
+      end
+
+      if attributes.key?(:'catalogue_url')
+        self.catalogue_url = attributes[:'catalogue_url']
+      end
+
+      if attributes.key?(:'open_to_industry_funded_research')
+        self.open_to_industry_funded_research = attributes[:'open_to_industry_funded_research']
+      end
+
+      if attributes.key?(:'collects_data_directly_from_patients')
+        self.collects_data_directly_from_patients = attributes[:'collects_data_directly_from_patients']
+      end
+
+      if attributes.key?(:'is_encepp_partner')
+        self.is_encepp_partner = attributes[:'is_encepp_partner']
+      end
+
+      if attributes.key?(:'record_updated_at')
+        self.record_updated_at = attributes[:'record_updated_at']
+      end
+
+      if attributes.key?(:'record_updated_is_mass_edit')
+        self.record_updated_is_mass_edit = attributes[:'record_updated_is_mass_edit']
+      end
+
+      if attributes.key?(:'record_updated_at_attested')
+        self.record_updated_at_attested = attributes[:'record_updated_at_attested']
+      end
+
+      if attributes.key?(:'record_updated_date_share')
+        self.record_updated_date_share = attributes[:'record_updated_date_share']
+      end
+
+      if attributes.key?(:'record_first_published_at')
+        self.record_first_published_at = attributes[:'record_first_published_at']
+      end
+
+      if attributes.key?(:'is_outdated')
+        self.is_outdated = attributes[:'is_outdated']
+      end
+
+      if attributes.key?(:'conducting_studies_lifetime')
+        self.conducting_studies_lifetime = attributes[:'conducting_studies_lifetime']
+      end
+
+      if attributes.key?(:'conducting_studies_last_5_years')
+        self.conducting_studies_last_5_years = attributes[:'conducting_studies_last_5_years']
+      end
+
+      if attributes.key?(:'conducting_studies_ongoing')
+        self.conducting_studies_ongoing = attributes[:'conducting_studies_ongoing']
+      end
+
+      if attributes.key?(:'conducting_studies_planned')
+        self.conducting_studies_planned = attributes[:'conducting_studies_planned']
+      end
+
+      if attributes.key?(:'additional_role_studies')
+        self.additional_role_studies = attributes[:'additional_role_studies']
+      end
+
+      if attributes.key?(:'most_recent_study_start_on')
+        self.most_recent_study_start_on = attributes[:'most_recent_study_start_on']
+      end
+
+      if attributes.key?(:'held_source_count')
+        self.held_source_count = attributes[:'held_source_count']
+      end
+
+      if attributes.key?(:'held_source_ids')
+        if (value = attributes[:'held_source_ids']).is_a?(Array)
+          self.held_source_ids = value
+        end
+      end
+
+      if attributes.key?(:'held_active_population')
+        self.held_active_population = attributes[:'held_active_population']
+      end
+
+      if attributes.key?(:'held_max_active_population')
+        self.held_max_active_population = attributes[:'held_max_active_population']
+      end
+
+      if attributes.key?(:'held_sources_declaring_active_population')
+        self.held_sources_declaring_active_population = attributes[:'held_sources_declaring_active_population']
+      end
+
+      if attributes.key?(:'held_qualified_source_count')
+        self.held_qualified_source_count = attributes[:'held_qualified_source_count']
+      end
+
+      if attributes.key?(:'held_darwin_partner_source_count')
+        self.held_darwin_partner_source_count = attributes[:'held_darwin_partner_source_count']
+      end
+
+      if attributes.key?(:'network_membership_count')
+        self.network_membership_count = attributes[:'network_membership_count']
+      end
+
+      if attributes.key?(:'network_ids')
+        if (value = attributes[:'network_ids']).is_a?(Array)
+          self.network_ids = value
+        end
+      end
+
+      if attributes.key?(:'network_names')
+        if (value = attributes[:'network_names']).is_a?(Array)
+          self.network_names = value
+        end
+      end
+
+      if attributes.key?(:'institution_register_total')
+        self.institution_register_total = attributes[:'institution_register_total']
+      end
+
+      if attributes.key?(:'self_registered_profile_total')
+        self.self_registered_profile_total = attributes[:'self_registered_profile_total']
+      end
+
+      if attributes.key?(:'catalogue_name_entry_total')
+        self.catalogue_name_entry_total = attributes[:'catalogue_name_entry_total']
+      end
+
+      if attributes.key?(:'institutions_declaring_a_country')
+        self.institutions_declaring_a_country = attributes[:'institutions_declaring_a_country']
+      end
+
+      if attributes.key?(:'institutions_in_any_member_list')
+        self.institutions_in_any_member_list = attributes[:'institutions_in_any_member_list']
+      end
+
+      if attributes.key?(:'institution_name_key_total')
+        self.institution_name_key_total = attributes[:'institution_name_key_total']
+      end
+
+      if attributes.key?(:'institutions_holding_a_source')
+        self.institutions_holding_a_source = attributes[:'institutions_holding_a_source']
+      end
+
+      if attributes.key?(:'declared_holder_name_total')
+        self.declared_holder_name_total = attributes[:'declared_holder_name_total']
+      end
+
+      if attributes.key?(:'declared_holder_name_matched')
+        self.declared_holder_name_matched = attributes[:'declared_holder_name_matched']
+      end
+
+      if attributes.key?(:'register_source_count')
+        self.register_source_count = attributes[:'register_source_count']
+      end
+
+      if attributes.key?(:'study_register_total')
+        self.study_register_total = attributes[:'study_register_total']
+      end
+
+      if attributes.key?(:'studies_naming_a_registered_source')
+        self.studies_naming_a_registered_source = attributes[:'studies_naming_a_registered_source']
+      end
+
+      if attributes.key?(:'studies_naming_a_registered_conductor')
+        self.studies_naming_a_registered_conductor = attributes[:'studies_naming_a_registered_conductor']
+      end
+
+      if attributes.key?(:'snapshot_label')
+        self.snapshot_label = attributes[:'snapshot_label']
+      end
+
+      if attributes.key?(:'accessed_month')
+        self.accessed_month = attributes[:'accessed_month']
+      end
+
+      if attributes.key?(:'restriction_tier')
+        self.restriction_tier = attributes[:'restriction_tier']
+      end
+
+      if attributes.key?(:'attribution')
+        self.attribution = attributes[:'attribution']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          institution_id == o.institution_id &&
+          institution_name == o.institution_name &&
+          institution_org_id == o.institution_org_id &&
+          institution_company_id == o.institution_company_id &&
+          institution_company_name == o.institution_company_name &&
+          institution_group_id == o.institution_group_id &&
+          institution_group_name == o.institution_group_name &&
+          org_match_rung == o.org_match_rung &&
+          org_match_tier == o.org_match_tier &&
+          parent_org_id == o.parent_org_id &&
+          is_org_to_org == o.is_org_to_org &&
+          institution_name_key == o.institution_name_key &&
+          parent_name == o.parent_name &&
+          parent_name_key == o.parent_name_key &&
+          registration_state == o.registration_state &&
+          is_self_registered_profile == o.is_self_registered_profile &&
+          declared_profile_fields == o.declared_profile_fields &&
+          declarable_profile_fields == o.declarable_profile_fields &&
+          type_of_institution == o.type_of_institution &&
+          institution_role == o.institution_role &&
+          institution_countries == o.institution_countries &&
+          institution_country_names == o.institution_country_names &&
+          institution_country_count == o.institution_country_count &&
+          unmatched_country_fragments == o.unmatched_country_fragments &&
+          single_declared_country_iso2 == o.single_declared_country_iso2 &&
+          institution_website == o.institution_website &&
+          catalogue_url == o.catalogue_url &&
+          open_to_industry_funded_research == o.open_to_industry_funded_research &&
+          collects_data_directly_from_patients == o.collects_data_directly_from_patients &&
+          is_encepp_partner == o.is_encepp_partner &&
+          record_updated_at == o.record_updated_at &&
+          record_updated_is_mass_edit == o.record_updated_is_mass_edit &&
+          record_updated_at_attested == o.record_updated_at_attested &&
+          record_updated_date_share == o.record_updated_date_share &&
+          record_first_published_at == o.record_first_published_at &&
+          is_outdated == o.is_outdated &&
+          conducting_studies_lifetime == o.conducting_studies_lifetime &&
+          conducting_studies_last_5_years == o.conducting_studies_last_5_years &&
+          conducting_studies_ongoing == o.conducting_studies_ongoing &&
+          conducting_studies_planned == o.conducting_studies_planned &&
+          additional_role_studies == o.additional_role_studies &&
+          most_recent_study_start_on == o.most_recent_study_start_on &&
+          held_source_count == o.held_source_count &&
+          held_source_ids == o.held_source_ids &&
+          held_active_population == o.held_active_population &&
+          held_max_active_population == o.held_max_active_population &&
+          held_sources_declaring_active_population == o.held_sources_declaring_active_population &&
+          held_qualified_source_count == o.held_qualified_source_count &&
+          held_darwin_partner_source_count == o.held_darwin_partner_source_count &&
+          network_membership_count == o.network_membership_count &&
+          network_ids == o.network_ids &&
+          network_names == o.network_names &&
+          institution_register_total == o.institution_register_total &&
+          self_registered_profile_total == o.self_registered_profile_total &&
+          catalogue_name_entry_total == o.catalogue_name_entry_total &&
+          institutions_declaring_a_country == o.institutions_declaring_a_country &&
+          institutions_in_any_member_list == o.institutions_in_any_member_list &&
+          institution_name_key_total == o.institution_name_key_total &&
+          institutions_holding_a_source == o.institutions_holding_a_source &&
+          declared_holder_name_total == o.declared_holder_name_total &&
+          declared_holder_name_matched == o.declared_holder_name_matched &&
+          register_source_count == o.register_source_count &&
+          study_register_total == o.study_register_total &&
+          studies_naming_a_registered_source == o.studies_naming_a_registered_source &&
+          studies_naming_a_registered_conductor == o.studies_naming_a_registered_conductor &&
+          snapshot_label == o.snapshot_label &&
+          accessed_month == o.accessed_month &&
+          restriction_tier == o.restriction_tier &&
+          attribution == o.attribution
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [institution_id, institution_name, institution_org_id, institution_company_id, institution_company_name, institution_group_id, institution_group_name, org_match_rung, org_match_tier, parent_org_id, is_org_to_org, institution_name_key, parent_name, parent_name_key, registration_state, is_self_registered_profile, declared_profile_fields, declarable_profile_fields, type_of_institution, institution_role, institution_countries, institution_country_names, institution_country_count, unmatched_country_fragments, single_declared_country_iso2, institution_website, catalogue_url, open_to_industry_funded_research, collects_data_directly_from_patients, is_encepp_partner, record_updated_at, record_updated_is_mass_edit, record_updated_at_attested, record_updated_date_share, record_first_published_at, is_outdated, conducting_studies_lifetime, conducting_studies_last_5_years, conducting_studies_ongoing, conducting_studies_planned, additional_role_studies, most_recent_study_start_on, held_source_count, held_source_ids, held_active_population, held_max_active_population, held_sources_declaring_active_population, held_qualified_source_count, held_darwin_partner_source_count, network_membership_count, network_ids, network_names, institution_register_total, self_registered_profile_total, catalogue_name_entry_total, institutions_declaring_a_country, institutions_in_any_member_list, institution_name_key_total, institutions_holding_a_source, declared_holder_name_total, declared_holder_name_matched, register_source_count, study_register_total, studies_naming_a_registered_source, studies_naming_a_registered_conductor, snapshot_label, accessed_month, restriction_tier, attribution].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = PharmaObservatory.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end