pharmaobservatory 0.1.7 → 0.1.8

data/docs/CompanyAssetsRow.md

@@ -12,7 +12,9 @@
 | **sponsor_group_name** | **String** | Display name of the sponsor's group. | [optional] |
 | **drug_id** | **String** | The drug key. | [optional] |
 | **drug_name** | **String** | The drug's name. | [optional] |
-| **max_phase** | **Integer** | Highest phase the sponsor reached on the drug: 0 early phase 1 through 6 for phase 4 (marketed); -1 when unstated. | [optional] |
+| **max_phase** | **Integer** | Highest phase the sponsor reached on the drug on the 0 to 4 scale: 0 not reported, 1 through 4 for phase 1 through phase 4 (4 is marketed); a split phase folds up to its higher phase. | [optional] |
+| **max_phase_label** | **String** | The furthest phase reached with the split phases kept: Early 1, Phase 1, Phase 1/2, Phase 2, Phase 2/3, Phase 3, Phase 4, or Not reported. max_phase is the same value folded onto 0 to 4 (a split phase counts as its higher phase). | [optional] |
+| **max_phase_fine_rank** | **Integer** | The finest phase rank behind max_phase_label: 6 Phase 4, 5 Phase 3, 4 Phase 2/3, 3 Phase 2, 2 Phase 1/2, 1 Phase 1, 0 Early 1, -1 not reported. Sort on it to order programs by furthest phase with the split phases kept; max_phase is the same value folded onto 0 to 4. | [optional] |
 | **n_trials** | **Integer** | Distinct trials this sponsor leads on the drug. Counted once per trial within the sponsor organization, so it is not additive across a company's organizations. | [optional] |
 | **n_active** | **Integer** | Of those trials, the number recruiting, not yet recruiting, active or enrolling by invitation. | [optional] |
 | **last_year** | **Integer** | Latest start year among those trials. | [optional] |
@@ -33,6 +35,8 @@ instance = PharmaObservatory::CompanyAssetsRow.new(
   drug_id: null,
   drug_name: null,
   max_phase: null,
+  max_phase_label: null,
+  max_phase_fine_rank: null,
   n_trials: null,
   n_active: null,
   last_year: null,

data/docs/CompanyBiomarkerCapabilityResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::CompanyBiomarkerCapabilityResponse
+
+## 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<CompanyBiomarkerCapabilityRow>**](CompanyBiomarkerCapabilityRow.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::CompanyBiomarkerCapabilityResponse.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/CompanyBiomarkerCapabilityRow.md

@@ -0,0 +1,68 @@
+# PharmaObservatory::CompanyBiomarkerCapabilityRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **biomarker_validation_id** | **String** | The evidence assertion id. | [optional] |
+| **organization_name** | **String** | The organization's name as filed on the evidence. | [optional] |
+| **organization_org_id** | **String** | Legal-entity level: the organization record of the organization. | [optional] |
+| **organization_company_id** | **String** | Company level: the company the organization belongs to (null when unresolved). | [optional] |
+| **organization_company_name** | **String** | Display name of the organization's company. | [optional] |
+| **organization_group_id** | **String** | Group level: the organization's current ultimate parent company; a root company's group is itself. | [optional] |
+| **organization_group_name** | **String** | Display name of the organization's group. | [optional] |
+| **gene_symbol** | **String** | The gene's HGNC (Human Genome Organisation Gene Nomenclature Committee) symbol; null for evidence that names no gene. | [optional] |
+| **biomarker_id** | **String** | The biomarker's id (a hash, not the route key). | [optional] |
+| **biomarker_display_name** | **String** | The biomarker's display name. | [optional] |
+| **biomarker_kind** | **String** | The kind of biomarker. | [optional] |
+| **biomarker_identity_status** | **String** | How firmly the biomarker's identity is resolved. | [optional] |
+| **organization_role** | **String** | The organization's role in the evidence (for example assay developer or testing laboratory). | [optional] |
+| **organization_match_tier** | **String** | How the organization was matched to its record. | [optional] |
+| **tier** | **Integer** | The evidence tier, higher for stronger kinds of evidence. A label of the kind of evidence, not a quality score. | [optional] |
+| **tier_label** | **String** | The evidence tier in words. | [optional] |
+| **evidence_type** | **String** | The kind of evidence (companion diagnostic authorization, trial endpoint, trial eligibility, trial specimen collection, trial text mention or ClinVar clinical testing). | [optional] |
+| **evidence_count** | **Integer** | Assertions that share this biomarker, organization and role. | [optional] |
+| **evidence_ref** | **String** | The reference of the evidence (a trial id, a device application number or a project id). | [optional] |
+| **evidence_ref_kind** | **String** | What evidence_ref is. | [optional] |
+| **trial_id** | **String** | The trial's registry id (NCT, National Clinical Trial, number) when the evidence is a trial. | [optional] |
+| **citation_url** | **String** | A link to the evidence. | [optional] |
+| **evidence_snippet** | **String** | A short excerpt of the evidence. | [optional] |
+| **biomarker_role** | **String** | The role the biomarker plays in the evidence. | [optional] |
+| **is_surrogate_endpoint_claim** | **Boolean** | Whether the evidence claims the biomarker as a surrogate endpoint. | [optional] |
+| **clinvar_scv_count** | **Integer** | ClinVar submissions behind a ClinVar row. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::CompanyBiomarkerCapabilityRow.new(
+  biomarker_validation_id: null,
+  organization_name: null,
+  organization_org_id: null,
+  organization_company_id: null,
+  organization_company_name: null,
+  organization_group_id: null,
+  organization_group_name: null,
+  gene_symbol: null,
+  biomarker_id: null,
+  biomarker_display_name: null,
+  biomarker_kind: null,
+  biomarker_identity_status: null,
+  organization_role: null,
+  organization_match_tier: null,
+  tier: null,
+  tier_label: null,
+  evidence_type: null,
+  evidence_count: null,
+  evidence_ref: null,
+  evidence_ref_kind: null,
+  trial_id: null,
+  citation_url: null,
+  evidence_snippet: null,
+  biomarker_role: null,
+  is_surrogate_endpoint_claim: null,
+  clinvar_scv_count: null
+)
+```
+

data/docs/CompanyProgramsRow.md

@@ -14,7 +14,9 @@
 | **drug_name** | **String** | The drug's name. | [optional] |
 | **condition_id** | **String** | The condition key, a MeSH (Medical Subject Headings) descriptor id (D followed by six to nine digits). | [optional] |
 | **condition_name** | **String** | The condition's name. | [optional] |
-| **max_phase** | **Integer** | Highest phase reached: 0 early phase 1 through 6 for phase 4 (marketed); -1 when unstated. | [optional] |
+| **max_phase** | **Integer** | Highest phase reached on the 0 to 4 scale: 0 not reported, 1 through 4 for phase 1 through phase 4 (4 is marketed); a split phase folds up to its higher phase. | [optional] |
+| **max_phase_label** | **String** | The furthest phase reached with the split phases kept: Early 1, Phase 1, Phase 1/2, Phase 2, Phase 2/3, Phase 3, Phase 4, or Not reported. max_phase is the same value folded onto 0 to 4 (a split phase counts as its higher phase). | [optional] |
+| **max_phase_fine_rank** | **Integer** | The finest phase rank behind max_phase_label: 6 Phase 4, 5 Phase 3, 4 Phase 2/3, 3 Phase 2, 2 Phase 1/2, 1 Phase 1, 0 Early 1, -1 not reported. Sort on it to order programs by furthest phase with the split phases kept; max_phase is the same value folded onto 0 to 4. | [optional] |
 | **n_trials** | **Integer** | Lead-sponsored trials in the program. | [optional] |
 | **n_active** | **Integer** | Of those, trials in an active status. | [optional] |
 | **last_year** | **Integer** | Latest trial start year. | [optional] |
@@ -39,6 +41,8 @@ instance = PharmaObservatory::CompanyProgramsRow.new(
   condition_id: null,
   condition_name: null,
   max_phase: null,
+  max_phase_label: null,
+  max_phase_fine_rank: null,
   n_trials: null,
   n_active: null,
   last_year: null,

data/docs/CompanyRareDiseaseDeclarationsResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::CompanyRareDiseaseDeclarationsResponse
+
+## 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<CompanyRareDiseaseDeclarationsRow>**](CompanyRareDiseaseDeclarationsRow.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::CompanyRareDiseaseDeclarationsResponse.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/CompanyRareDiseaseDeclarationsRow.md

@@ -0,0 +1,52 @@
+# PharmaObservatory::CompanyRareDiseaseDeclarationsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assertion_id** | **String** | The declaration assertion id. | [optional] |
+| **organization_name** | **String** | The organization's name as the source filed it. | [optional] |
+| **organization_org_id** | **String** | Legal-entity level: the organization record of the organization. | [optional] |
+| **organization_company_id** | **String** | Company level: the company the organization belongs to (null when unresolved). | [optional] |
+| **organization_company_name** | **String** | Display name of the organization's company. | [optional] |
+| **organization_group_id** | **String** | Group level: the organization's current ultimate parent company; a root company's group is itself. | [optional] |
+| **organization_group_name** | **String** | Display name of the organization's group. | [optional] |
+| **declared_function** | **String** | The function the source states for the organization. | [optional] |
+| **evidence_type** | **String** | The kind of evidence the source gives. | [optional] |
+| **authority_class** | **String** | How authoritative the source is for the claim. | [optional] |
+| **source_key** | **String** | The source the assertion comes from. | [optional] |
+| **source_record_id** | **String** | The source's own record id. | [optional] |
+| **source_url** | **String** | A link to the source record. | [optional] |
+| **observed_at** | **Time** | When the assertion was observed (UTC). | [optional] |
+| **last_verified_at** | **Time** | When the assertion was last verified (UTC). | [optional] |
+| **confidence** | **Float** | The source's or the extraction's own confidence; null when none is stated. | [optional] |
+| **license_name** | **String** | The licence of the source. | [optional] |
+| **attribution** | **String** | The credit line for the source. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::CompanyRareDiseaseDeclarationsRow.new(
+  assertion_id: null,
+  organization_name: null,
+  organization_org_id: null,
+  organization_company_id: null,
+  organization_company_name: null,
+  organization_group_id: null,
+  organization_group_name: null,
+  declared_function: null,
+  evidence_type: null,
+  authority_class: null,
+  source_key: null,
+  source_record_id: null,
+  source_url: null,
+  observed_at: null,
+  last_verified_at: null,
+  confidence: null,
+  license_name: null,
+  attribution: null
+)
+```
+

data/docs/GxpFacilitiesRow.md

@@ -5,6 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **facility_key** | **String** | The canonical facility id. | [optional] |
+| **registry** | **String** | The registry of the lead member record. Provenance and a facet, never a join key. | [optional] |
+| **registry_native_site_id** | **String** | The lead registry's own site id (FEI, EudraGMDP site key, Health Canada location 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] |
@@ -38,16 +40,25 @@
 | **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_scope** | **String** | site when a site-scope verdict set the severity rank, none when nothing did. Never org. | [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] |
+| **severity_source_url** | **String** | The source page of the signal that set 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] |
+| **worst_severity_raw_verdict** | **String** | The regulator's own verdict word behind the worst severity ever. | [optional] |
+| **worst_severity_signal_date** | **Date** | The date of the signal behind the worst severity ever. | [optional] |
 | **has_quality_signal** | **Boolean** | True when the facility has any quality signal. | [optional] |
+| **has_site_scope_signal** | **Boolean** | True when a signal is about this site itself. | [optional] |
+| **has_org_scope_signal** | **Boolean** | True when a signal is about the operating firm. | [optional] |
 | **latest_signal_date** | **Date** | The date of the latest signal of any scope. | [optional] |
+| **first_signal_date** | **Date** | The date of the earliest dated 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_signals_1095d** | **Integer** | Signals in the last 1,095 days of the build. | [optional] |
+| **n_signals_1825d** | **Integer** | Signals in the last 1,825 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] |
@@ -80,6 +91,8 @@ require 'pharmaobservatory'
 
 instance = PharmaObservatory::GxpFacilitiesRow.new(
   facility_key: null,
+  registry: null,
+  registry_native_site_id: null,
   registry_facility_keys: null,
   facility_name: null,
   member_count: null,
@@ -113,16 +126,25 @@ instance = PharmaObservatory::GxpFacilitiesRow.new(
   org_regulators: null,
   severity_rank: null,
   severity_level: null,
+  severity_scope: null,
   severity_source: null,
   severity_signal_type: null,
   severity_raw_verdict: null,
   severity_signal_date: null,
+  severity_source_url: null,
   worst_severity_rank_ever: null,
   worst_severity_level_ever: null,
+  worst_severity_raw_verdict: null,
+  worst_severity_signal_date: null,
   has_quality_signal: null,
+  has_site_scope_signal: null,
+  has_org_scope_signal: null,
   latest_signal_date: null,
+  first_signal_date: null,
   n_signals_total: null,
   n_signals_365d: null,
+  n_signals_1095d: null,
+  n_signals_1825d: null,
   n_inspections: null,
   latest_inspection_date: null,
   n_fda_inspections: null,