pharmaobservatory 0.1.6 → 0.1.7

data/docs/DrugsRecord.md

@@ -0,0 +1,38 @@
+# PharmaObservatory::DrugsRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object_type** | **String** |  |  |
+| **id** | **String** |  |  |
+| **record** | [**DrugsRow**](DrugsRow.md) |  |  |
+| **attributes** | [**DrugsRecordAttributes**](DrugsRecordAttributes.md) |  | [optional] |
+| **datasets** | [**Array<DatasetListing>**](DatasetListing.md) |  |  |
+| **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **freshness** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::DrugsRecord.new(
+  object_type: null,
+  id: null,
+  record: null,
+  attributes: null,
+  datasets: null,
+  attribution: null,
+  source_credit: null,
+  freshness: null,
+  build: null,
+  build_state: null,
+  restriction: null
+)
+```
+

data/docs/DrugsRecordAttributes.md

@@ -0,0 +1,20 @@
+# PharmaObservatory::DrugsRecordAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **drug_label_safety** | [**DrugLabelSafetyRow**](DrugLabelSafetyRow.md) |  | [optional] |
+| **drug_regulatory** | [**DrugRegulatoryRow**](DrugRegulatoryRow.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::DrugsRecordAttributes.new(
+  drug_label_safety: null,
+  drug_regulatory: null
+)
+```
+

data/docs/DrugsResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::DrugsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.md) |  | [optional] |
+| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) |  |  |
+| **rows** | [**Array<DrugsRow>**](DrugsRow.md) |  |  |
+| **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
+| **next_cursor** | **String** |  | [optional] |
+| **sort** | **Array<String>** |  | [optional] |
+| **filters** | **Array<Hash<String, Object>>** |  | [optional] |
+| **group_by** | **Array<String>** |  | [optional] |
+| **measures** | **Array<String>** |  | [optional] |
+| **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **withheld_tiers** | **Array<String>** |  | [optional] |
+| **withheld_columns** | **Array<String>** |  | [optional] |
+| **freshness** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::DrugsResponse.new(
+  dataset: null,
+  grain: null,
+  object_type: null,
+  id: null,
+  scope: null,
+  columns: null,
+  rows: null,
+  total: null,
+  next_cursor: null,
+  sort: null,
+  filters: null,
+  group_by: null,
+  measures: null,
+  attribution: null,
+  source_credit: null,
+  withheld_tiers: null,
+  withheld_columns: null,
+  freshness: null,
+  build: null,
+  build_state: null,
+  restriction: null
+)
+```
+

data/docs/DrugsRow.md

@@ -0,0 +1,82 @@
+# PharmaObservatory::DrugsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **molecule_id** | **String** | The molecule key: the resolved drug a brand, a salt form or an investigational arm resolves to, and the entry key for the drugs object type. A member id (a salt or a folded trial arm) is not a value here; it redirects to its molecule. | [optional] |
+| **molecule_name** | **String** | The drug's display name, from its lead record. | [optional] |
+| **substance_name** | **String** | The preferred substance name in the FDA substance registry. | [optional] |
+| **inn_name** | **String** | The International Nonproprietary Name (INN) where one is recorded. | [optional] |
+| **unii** | **String** | The FDA Unique Ingredient Identifier (UNII) of the lead record. | [optional] |
+| **cas** | **String** | The Chemical Abstracts Service (CAS) registry number of the lead record. | [optional] |
+| **chembl_id** | **String** | The ChEMBL compound id of the lead record. | [optional] |
+| **substance_type** | **String** | The registry's substance type (chemical, protein, mixture and so on). | [optional] |
+| **atc_code** | **String** | The Anatomical Therapeutic Chemical (ATC) code. | [optional] |
+| **atc_class** | **String** | The top-level ATC class. | [optional] |
+| **pharm_class** | **String** | The pharmacologic class the FDA registry gives the substance. | [optional] |
+| **is_biologic** | **Boolean** | True when the substance is a biologic, by the registry, Drugs@FDA or the Purple Book. | [optional] |
+| **is_marketed** | **Boolean** | True when the drug has a package in the US National Drug Code (NDC) directory. | [optional] |
+| **withdrawn** | **Boolean** | True when ChEMBL records the drug as withdrawn somewhere. | [optional] |
+| **approved_anywhere** | **Boolean** | True when the drug is approved in at least one jurisdiction. | [optional] |
+| **approved_in** | **Array<String>** | The regulators whose approval is recorded (FDA, EMA, Health Canada). | [optional] |
+| **first_approval_year** | **Integer** | The earliest approval year ChEMBL records. | [optional] |
+| **max_phase** | **Integer** | The highest development phase reached across the folded records (4 is approved). | [optional] |
+| **n_trials** | **Integer** | Registered trials that study the drug or a record folded under it. | [optional] |
+| **n_members** | **Integer** | Drug records folded into this drug, the lead included. | [optional] |
+| **member_ids** | **Array<String>** | The drug record ids folded into this drug, the lead included. The ids other datasets name drug_id. | [optional] |
+| **variant_count** | **Integer** | Variant records folded under the molecule; null when the drug is not a molecule. | [optional] |
+| **brands** | **Array<String>** | The brand keys that resolve to the drug. | [optional] |
+| **brand_count** | **Integer** | The number of brand keys. | [optional] |
+| **is_molecule** | **Boolean** | True when the drug has a chemical-entities page. | [optional] |
+| **is_combination** | **Boolean** | True when the drug is a combination product of two or more components. | [optional] |
+| **has_boxed_warning** | **Boolean** | True when the drug's current label carries a boxed warning; null when no label is on record. | [optional] |
+| **smiles** | **String** | The canonical SMILES string of the structure (ChEMBL). | [optional] |
+| **inchikey** | **String** | The InChIKey of the structure (ChEMBL). | [optional] |
+| **n_patent_mentions** | **Integer** | Patents that mention the drug in the SureChEMBL corpus. | [optional] |
+| **n_patent_families** | **Integer** | Distinct patent families among those mentions. | [optional] |
+| **first_patent_mention** | **Date** | Publication date of the earliest mentioning patent. | [optional] |
+| **last_patent_mention** | **Date** | Publication date of the latest mentioning patent. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::DrugsRow.new(
+  molecule_id: null,
+  molecule_name: null,
+  substance_name: null,
+  inn_name: null,
+  unii: null,
+  cas: null,
+  chembl_id: null,
+  substance_type: null,
+  atc_code: null,
+  atc_class: null,
+  pharm_class: null,
+  is_biologic: null,
+  is_marketed: null,
+  withdrawn: null,
+  approved_anywhere: null,
+  approved_in: null,
+  first_approval_year: null,
+  max_phase: null,
+  n_trials: null,
+  n_members: null,
+  member_ids: null,
+  variant_count: null,
+  brands: null,
+  brand_count: null,
+  is_molecule: null,
+  is_combination: null,
+  has_boxed_warning: null,
+  smiles: null,
+  inchikey: null,
+  n_patent_mentions: null,
+  n_patent_families: null,
+  first_patent_mention: null,
+  last_patent_mention: null
+)
+```
+

data/docs/EnforcementEventsResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::EnforcementEventsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.md) |  | [optional] |
+| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) |  |  |
+| **rows** | [**Array<EnforcementEventsRow>**](EnforcementEventsRow.md) |  |  |
+| **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
+| **next_cursor** | **String** |  | [optional] |
+| **sort** | **Array<String>** |  | [optional] |
+| **filters** | **Array<Hash<String, Object>>** |  | [optional] |
+| **group_by** | **Array<String>** |  | [optional] |
+| **measures** | **Array<String>** |  | [optional] |
+| **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **withheld_tiers** | **Array<String>** |  | [optional] |
+| **withheld_columns** | **Array<String>** |  | [optional] |
+| **freshness** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::EnforcementEventsResponse.new(
+  dataset: null,
+  grain: null,
+  object_type: null,
+  id: null,
+  scope: null,
+  columns: null,
+  rows: null,
+  total: null,
+  next_cursor: null,
+  sort: null,
+  filters: null,
+  group_by: null,
+  measures: null,
+  attribution: null,
+  source_credit: null,
+  withheld_tiers: null,
+  withheld_columns: null,
+  freshness: null,
+  build: null,
+  build_state: null,
+  restriction: null
+)
+```
+

data/docs/EnforcementEventsRow.md

@@ -0,0 +1,64 @@
+# PharmaObservatory::EnforcementEventsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** | The event id: a hash of the lane and the lane's own key, unique across lanes. | [optional] |
+| **source** | **String** | The lane the event came from: inspection_483 (an FDA inspection), import_refusal, warning_letter, untitled_letter, debarment or recall. | [optional] |
+| **event_date** | **Date** | The event date: the inspection date, refusal date, letter issue date (posted date when there is none), debarment effective date or recall initiation date. | [optional] |
+| **domain** | **String** | The regulatory domain of the event, derived from the lane's own classifier: drug, biologic, device, veterinary, food, cosmetic, tobacco or other. | [optional] |
+| **is_biomedical** | **Boolean** | True when domain is drug, biologic or device. | [optional] |
+| **headline** | **String** | A one-line description: the inspection product type, the refused product, the letter subject, the debarment type or the recalled product. | [optional] |
+| **detail** | **String** | The lane's supporting text: the cited regulations of an inspection, the refusal charges, the issuing office of a warning letter, the debarment term and citation, or the recall reason. | [optional] |
+| **classification** | **String** | The inspection outcome (NAI no action indicated, VAI voluntary action indicated, OAI official action indicated); null for every other lane. | [optional] |
+| **recall_class** | **String** | The recall severity class (Class I, II or III); null for every other lane. | [optional] |
+| **had_483** | **Boolean** | True when the inspection ended with a Form 483 of observations; null for every other lane. | [optional] |
+| **source_url** | **String** | The regulator's page for the event, where the lane has one. | [optional] |
+| **source_ref** | **String** | The lane's own reference, where it has one: the letter id, debarment id or recall number. | [optional] |
+| **device_class** | **String** | The FDA device class of an import-refusal product, from the device classification dimension; null for every other lane. | [optional] |
+| **device_specialty** | **String** | The medical specialty of an import-refusal device product; null for every other lane. | [optional] |
+| **is_low_signal_device** | **Boolean** | True for a device event the biomedical view hides by default (a low-signal commodity class). | [optional] |
+| **firm_name** | **String** | The firm's name as filed with the regulator (the party named on the record, an individual for an individual debarment). | [optional] |
+| **firm_org_id** | **String** | Legal-entity level: the organization record the firm resolved to (null when the firm did not resolve). | [optional] |
+| **firm_company_id** | **String** | Company level: the firm's company (null when unresolved); the entry key for the companies object type. | [optional] |
+| **firm_company_name** | **String** | Display name of the firm's company. | [optional] |
+| **firm_group_id** | **String** | Group level: the firm's current ultimate parent; a root's group is itself. | [optional] |
+| **firm_group_name** | **String** | Display name of the firm's group. | [optional] |
+| **match_tier** | **String** | How well the firm name was attached to an organization: high, medium or low name-and-geography matches, registry (the operating firm of a registered facility), ambiguous or unresolved. | [optional] |
+| **org_resolution_method** | **String** | The route that attached the firm: fei_bridge (the FDA establishment identifier bridge), fei_firm_mint or fei_firm_fold (the operating firm's registry record), firm_name_geo (name and geography), firm_name_only (name alone) or unresolved. | [optional] |
+| **is_org_resolved** | **Boolean** | True when the firm was attached to an organization. A false row is kept with null firm ids and the name as filed, so an empty read for a company is not proof of no enforcement history. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::EnforcementEventsRow.new(
+  event_id: null,
+  source: null,
+  event_date: null,
+  domain: null,
+  is_biomedical: null,
+  headline: null,
+  detail: null,
+  classification: null,
+  recall_class: null,
+  had_483: null,
+  source_url: null,
+  source_ref: null,
+  device_class: null,
+  device_specialty: null,
+  is_low_signal_device: null,
+  firm_name: null,
+  firm_org_id: null,
+  firm_company_id: null,
+  firm_company_name: null,
+  firm_group_id: null,
+  firm_group_name: null,
+  match_tier: null,
+  org_resolution_method: null,
+  is_org_resolved: null
+)
+```
+

data/docs/GxpFacilitiesResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::GxpFacilitiesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.md) |  | [optional] |
+| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) |  |  |
+| **rows** | [**Array<GxpFacilitiesRow>**](GxpFacilitiesRow.md) |  |  |
+| **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
+| **next_cursor** | **String** |  | [optional] |
+| **sort** | **Array<String>** |  | [optional] |
+| **filters** | **Array<Hash<String, Object>>** |  | [optional] |
+| **group_by** | **Array<String>** |  | [optional] |
+| **measures** | **Array<String>** |  | [optional] |
+| **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **withheld_tiers** | **Array<String>** |  | [optional] |
+| **withheld_columns** | **Array<String>** |  | [optional] |
+| **freshness** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::GxpFacilitiesResponse.new(
+  dataset: null,
+  grain: null,
+  object_type: null,
+  id: null,
+  scope: null,
+  columns: null,
+  rows: null,
+  total: null,
+  next_cursor: null,
+  sort: null,
+  filters: null,
+  group_by: null,
+  measures: null,
+  attribution: null,
+  source_credit: null,
+  withheld_tiers: null,
+  withheld_columns: null,
+  freshness: null,
+  build: null,
+  build_state: null,
+  restriction: null
+)
+```
+

data/docs/GxpFacilitiesRow.md

@@ -0,0 +1,152 @@
+# PharmaObservatory::GxpFacilitiesRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **facility_key** | **String** | The canonical facility id. | [optional] |
+| **registry_facility_keys** | **Array<String>** | The registry records the facility is made of, each as registry:native site id (for example fda_fei:3004123456), sorted. | [optional] |
+| **facility_name** | **String** | The facility's name. | [optional] |
+| **member_count** | **Integer** | How many registry records are clustered into the facility. | [optional] |
+| **address_line** | **String** | The street address. | [optional] |
+| **city** | **String** | The city. | [optional] |
+| **state_region** | **String** | The state or region. | [optional] |
+| **postal** | **String** | The postal code. | [optional] |
+| **country** | **String** | The two-letter country code. | [optional] |
+| **latitude** | **Float** | Latitude in degrees (WGS84), for the map tool. | [optional] |
+| **longitude** | **Float** | Longitude in degrees (WGS84), for the map tool. | [optional] |
+| **geocode_precision** | **String** | What a pin locates: for example a street address, a postal code or only a city. | [optional] |
+| **coord_source** | **String** | Where the coordinates came from: geonames (GeoNames) or als (Amazon Location Service); it names the attribution to show. | [optional] |
+| **firm_name** | **String** | The operating firm's name where the facility resolved to an organization; the facility name where it did not. | [optional] |
+| **firm_org_id** | **String** | Legal-entity level: the organization record the firm resolved to (null when the firm did not resolve). | [optional] |
+| **firm_company_id** | **String** | Company level: the firm's company (null when unresolved); the entry key for the companies object type. | [optional] |
+| **firm_company_name** | **String** | Display name of the firm's company. | [optional] |
+| **firm_group_id** | **String** | Group level: the firm's current ultimate parent; a root's group is itself. | [optional] |
+| **firm_group_name** | **String** | Display name of the firm's group. | [optional] |
+| **is_org_resolved** | **Boolean** | True when the facility was attached to an operating organization. A false row is kept with null firm ids. | [optional] |
+| **match_tier** | **String** | How the operating firm was attached: registry (the firm's own registry record), high, medium or low name-and-geography matches, or null. | [optional] |
+| **domains** | **Array<String>** | The regulatory domains of the facility's signals (drug, biologic, device, veterinary, food, cosmetic, tobacco). | [optional] |
+| **primary_domain** | **String** | The domain with the most signals. | [optional] |
+| **is_drug_facility** | **Boolean** | True when the registers say the site makes medicines (an FDA drug registration, or an EU or Canadian medicines register entry). | [optional] |
+| **is_device_facility** | **Boolean** | True when the registers say the site makes devices. | [optional] |
+| **register_domain** | **String** | The display bucket over the two flags: drug, device, drug_and_device or non_medicine. | [optional] |
+| **device_classification_status** | **String** | The registered-product rollup for a device facility: material, unresolved, low_signal or not_applicable. | [optional] |
+| **is_low_signal_device** | **Boolean** | True when the facility's device products are all low-signal commodity classes. | [optional] |
+| **regulators** | **Array<String>** | The regulators holding a registry record for the facility (fda, ema, health_canada), sorted. | [optional] |
+| **n_regulators** | **Integer** | How many regulators hold a registry record. | [optional] |
+| **is_multi_regulator** | **Boolean** | True when more than one regulator holds a record: the corroboration flag. | [optional] |
+| **org_regulators** | **Array<String>** | The regulators holding an organization-level record for the operating firm (this carries the UK MHRA leg). | [optional] |
+| **severity_rank** | **Integer** | The in-force site-scope severity, 0 (no signal) to 4 (non-compliant). | [optional] |
+| **severity_level** | **String** | The in-force site-scope severity: no_signal, clean, advisory, action or non_compliant. | [optional] |
+| **severity_source** | **String** | The regulator behind the severity: fda, ema, health_canada or mhra. | [optional] |
+| **severity_signal_type** | **String** | The kind of signal behind the severity (for example an inspection classification). | [optional] |
+| **severity_raw_verdict** | **String** | The regulator's own verdict behind the severity (for example OAI). | [optional] |
+| **severity_signal_date** | **Date** | The date of the signal behind the severity. | [optional] |
+| **worst_severity_rank_ever** | **Integer** | The highest site-scope severity the facility has ever had, 0 to 4. | [optional] |
+| **worst_severity_level_ever** | **String** | The worst severity ever: no_signal, clean, advisory, action or non_compliant. | [optional] |
+| **has_quality_signal** | **Boolean** | True when the facility has any quality signal. | [optional] |
+| **latest_signal_date** | **Date** | The date of the latest signal of any scope. | [optional] |
+| **n_signals_total** | **Integer** | Signals of any scope, all time. | [optional] |
+| **n_signals_365d** | **Integer** | Signals in the last 365 days of the build. | [optional] |
+| **n_inspections** | **Integer** | Inspections of the site by any regulator. | [optional] |
+| **latest_inspection_date** | **Date** | The date of the latest inspection by any regulator. | [optional] |
+| **n_fda_inspections** | **Integer** | FDA inspections of the site. | [optional] |
+| **latest_fda_inspection_date** | **Date** | The date of the latest FDA inspection. | [optional] |
+| **latest_inspection_classification** | **String** | The latest FDA inspection outcome (NAI, VAI or OAI). | [optional] |
+| **n_inspections_nai** | **Integer** | FDA inspections classified NAI. | [optional] |
+| **n_inspections_vai** | **Integer** | FDA inspections classified VAI. | [optional] |
+| **n_inspections_oai** | **Integer** | FDA inspections classified OAI. | [optional] |
+| **n_483** | **Integer** | FDA inspections that ended with a Form 483. | [optional] |
+| **n_hc_inspections** | **Integer** | Health Canada inspections of the site. | [optional] |
+| **latest_hc_inspection_date** | **Date** | The date of the latest Health Canada inspection. | [optional] |
+| **latest_hc_inspection_rating** | **String** | The latest Health Canada rating (for example compliant or non-compliant). | [optional] |
+| **n_hc_inspections_non_compliant** | **Integer** | Health Canada inspections rated non-compliant. | [optional] |
+| **n_import_refusals** | **Integer** | FDA import refusals at the site. | [optional] |
+| **latest_import_refusal_date** | **Date** | The date of the latest import refusal. | [optional] |
+| **n_gmp_certificates** | **Integer** | EU GMP certificates of the site. | [optional] |
+| **latest_gmp_certificate_date** | **Date** | The date of the latest EU GMP certificate. | [optional] |
+| **n_noncompliance_statements** | **Integer** | EU GMP non-compliance statements about the site. | [optional] |
+| **latest_noncompliance_statement_date** | **Date** | The date of the latest EU non-compliance statement. | [optional] |
+| **n_licences** | **Integer** | Health Canada establishment licences of the site. | [optional] |
+| **licence_status** | **String** | The licence status (the strictest licence of the site). | [optional] |
+| **org_n_licence_actions** | **Integer** | UK MHRA licence suspensions or revocations against the firm (repeated; does not add). | [optional] |
+| **org_latest_licence_action_date** | **Date** | The date of the firm's latest licence action. | [optional] |
+| **as_of** | **Date** | The build date the counts are as of. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::GxpFacilitiesRow.new(
+  facility_key: null,
+  registry_facility_keys: null,
+  facility_name: null,
+  member_count: null,
+  address_line: null,
+  city: null,
+  state_region: null,
+  postal: null,
+  country: null,
+  latitude: null,
+  longitude: null,
+  geocode_precision: null,
+  coord_source: null,
+  firm_name: null,
+  firm_org_id: null,
+  firm_company_id: null,
+  firm_company_name: null,
+  firm_group_id: null,
+  firm_group_name: null,
+  is_org_resolved: null,
+  match_tier: null,
+  domains: null,
+  primary_domain: null,
+  is_drug_facility: null,
+  is_device_facility: null,
+  register_domain: null,
+  device_classification_status: null,
+  is_low_signal_device: null,
+  regulators: null,
+  n_regulators: null,
+  is_multi_regulator: null,
+  org_regulators: null,
+  severity_rank: null,
+  severity_level: null,
+  severity_source: null,
+  severity_signal_type: null,
+  severity_raw_verdict: null,
+  severity_signal_date: null,
+  worst_severity_rank_ever: null,
+  worst_severity_level_ever: null,
+  has_quality_signal: null,
+  latest_signal_date: null,
+  n_signals_total: null,
+  n_signals_365d: null,
+  n_inspections: null,
+  latest_inspection_date: null,
+  n_fda_inspections: null,
+  latest_fda_inspection_date: null,
+  latest_inspection_classification: null,
+  n_inspections_nai: null,
+  n_inspections_vai: null,
+  n_inspections_oai: null,
+  n_483: null,
+  n_hc_inspections: null,
+  latest_hc_inspection_date: null,
+  latest_hc_inspection_rating: null,
+  n_hc_inspections_non_compliant: null,
+  n_import_refusals: null,
+  latest_import_refusal_date: null,
+  n_gmp_certificates: null,
+  latest_gmp_certificate_date: null,
+  n_noncompliance_statements: null,
+  latest_noncompliance_statement_date: null,
+  n_licences: null,
+  licence_status: null,
+  org_n_licence_actions: null,
+  org_latest_licence_action_date: null,
+  as_of: null
+)
+```
+

data/docs/HospitalBedsYearlyResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::HospitalBedsYearlyResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**BiomarkerAssayEvidenceResponseScope**](BiomarkerAssayEvidenceResponseScope.md) |  | [optional] |
+| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) |  |  |
+| **rows** | [**Array<HospitalBedsYearlyRow>**](HospitalBedsYearlyRow.md) |  |  |
+| **total** | **Integer** | The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped. | [optional] |
+| **next_cursor** | **String** |  | [optional] |
+| **sort** | **Array<String>** |  | [optional] |
+| **filters** | **Array<Hash<String, Object>>** |  | [optional] |
+| **group_by** | **Array<String>** |  | [optional] |
+| **measures** | **Array<String>** |  | [optional] |
+| **attribution** | [**Array<DatasetAttribution>**](DatasetAttribution.md) |  | [optional] |
+| **source_credit** | **String** |  | [optional] |
+| **withheld_tiers** | **Array<String>** |  | [optional] |
+| **withheld_columns** | **Array<String>** |  | [optional] |
+| **freshness** | [**BiomarkerAssayEvidenceResponseFreshness**](BiomarkerAssayEvidenceResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerAssayEvidenceResponseBuild**](BiomarkerAssayEvidenceResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::HospitalBedsYearlyResponse.new(
+  dataset: null,
+  grain: null,
+  object_type: null,
+  id: null,
+  scope: null,
+  columns: null,
+  rows: null,
+  total: null,
+  next_cursor: null,
+  sort: null,
+  filters: null,
+  group_by: null,
+  measures: null,
+  attribution: null,
+  source_credit: null,
+  withheld_tiers: null,
+  withheld_columns: null,
+  freshness: null,
+  build: null,
+  build_state: null,
+  restriction: null
+)
+```
+

data/docs/HospitalBedsYearlyRow.md

@@ -0,0 +1,28 @@
+# PharmaObservatory::HospitalBedsYearlyRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ccn** | **String** | CMS Certification Number of the hospital. | [optional] |
+| **year** | **Integer** | The calendar year. | [optional] |
+| **bed_count** | **Integer** | Certified bed count that year. | [optional] |
+| **is_teaching** | **Boolean** | Whether the hospital was a teaching hospital that year. | [optional] |
+| **pos_vintage** | **String** | The Provider of Services file vintage the row comes from. | [optional] |
+| **as_of** | **Date** | The as-of date of that file. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::HospitalBedsYearlyRow.new(
+  ccn: null,
+  year: null,
+  bed_count: null,
+  is_teaching: null,
+  pos_vintage: null,
+  as_of: null
+)
+```
+