pharmaobservatory 0.1.3 → 0.1.4

data/docs/ConditionPrevalenceRow.md

@@ -0,0 +1,62 @@
+# PharmaObservatory::ConditionPrevalenceRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **disease_prevalence_id** | **String** | The figure's key. | [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 MeSH heading. | [optional] |
+| **condition_mapping_relation** | **String** | How the figure's disease maps to the condition: exact, narrower, broader, undetermined or unspecified. | [optional] |
+| **disease_id** | **String** | The rare disease key of the figure's disease (orpha:<code>). | [optional] |
+| **disease_name** | **String** | The disease's name in the source. | [optional] |
+| **orpha_code** | **String** | The Orphanet disease number. | [optional] |
+| **prevalence_type** | **String** | What the figure measures: point_prevalence, lifetime_prevalence, annual_incidence, prevalence_at_birth or cases_families. | [optional] |
+| **prevalence_class** | **String** | The source's prevalence band, as filed. | [optional] |
+| **prevalence_lower_bound** | **Float** | Lower bound of the prevalence band as a ratio of the population (0.0001 is 1 in 10,000). | [optional] |
+| **prevalence_upper_bound** | **Float** | Upper bound of the prevalence band as a ratio of the population (0.0005 is 5 in 10,000). | [optional] |
+| **population_denominator** | **Float** | The population size the source states the band against (for example 10000 for a band per 10,000 persons). | [optional] |
+| **population_unit** | **String** | The unit of the population denominator. | [optional] |
+| **qualification** | **String** | The source's qualification of the figure (class_only, value_and_class and so on). | [optional] |
+| **validation_status** | **String** | The source's validation status for the figure (validated or not_yet_validated). | [optional] |
+| **geography** | **String** | The geography the figure describes, as the source states it. | [optional] |
+| **jurisdiction_code** | **String** | US, EU or GB where the geography is that jurisdiction; null otherwise. | [optional] |
+| **observation_date** | **Date** | The date the source assigns to the observation. | [optional] |
+| **source_snapshot_date** | **Date** | The date of the source release the figure was read from. | [optional] |
+| **source** | **String** | The publication reference the source cites for the figure. | [optional] |
+| **source_url** | **String** | The source release URL. | [optional] |
+| **license_name** | **String** | The figure's licence. | [optional] |
+| **attribution** | **String** | The credit line the licence requires. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ConditionPrevalenceRow.new(
+  disease_prevalence_id: null,
+  condition_id: null,
+  condition_name: null,
+  condition_mapping_relation: null,
+  disease_id: null,
+  disease_name: null,
+  orpha_code: null,
+  prevalence_type: null,
+  prevalence_class: null,
+  prevalence_lower_bound: null,
+  prevalence_upper_bound: null,
+  population_denominator: null,
+  population_unit: null,
+  qualification: null,
+  validation_status: null,
+  geography: null,
+  jurisdiction_code: null,
+  observation_date: null,
+  source_snapshot_date: null,
+  source: null,
+  source_url: null,
+  license_name: null,
+  attribution: null
+)
+```
+

data/docs/ConditionPublicationsResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::ConditionPublicationsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) |  | [optional] |
+| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) |  |  |
+| **rows** | [**Array<ConditionPublicationsRow>**](ConditionPublicationsRow.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** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ConditionPublicationsResponse.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/ConditionPublicationsRow.md

@@ -0,0 +1,32 @@
+# PharmaObservatory::ConditionPublicationsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **condition_id** | **String** | The condition key, a MeSH (Medical Subject Headings) descriptor id (D followed by six to nine digits). | [optional] |
+| **pmid** | **String** | The PubMed id. | [optional] |
+| **title** | **String** | The article title. | [optional] |
+| **pub_year** | **Integer** | Publication year. | [optional] |
+| **journal_title** | **String** | The journal title. | [optional] |
+| **evidence_type** | **String** | The article's PubMed publication type, one per article, picked by study design (Randomized Controlled Trial, Journal Article and so on). | [optional] |
+| **is_major_topic** | **Boolean** | True when the condition is a major topic of the article. | [optional] |
+| **n_linked_trials** | **Integer** | Registry trials linked to the article. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ConditionPublicationsRow.new(
+  condition_id: null,
+  pmid: null,
+  title: null,
+  pub_year: null,
+  journal_title: null,
+  evidence_type: null,
+  is_major_topic: null,
+  n_linked_trials: null
+)
+```
+

data/docs/ConditionSitesResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::ConditionSitesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) |  | [optional] |
+| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) |  |  |
+| **rows** | [**Array<ConditionSitesRow>**](ConditionSitesRow.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** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ConditionSitesResponse.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/ConditionSitesRow.md

@@ -0,0 +1,28 @@
+# PharmaObservatory::ConditionSitesRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **condition_id** | **String** | The condition key, a MeSH (Medical Subject Headings) descriptor id (D followed by six to nine digits). | [optional] |
+| **site_id** | **String** | The site key (a normalized facility, city and country). | [optional] |
+| **site_name** | **String** | The facility name as the registry lists it. | [optional] |
+| **city** | **String** | City as listed. | [optional] |
+| **country** | **String** | Country as listed. | [optional] |
+| **n_trials** | **Integer** | Trials for this condition listed at the site. | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ConditionSitesRow.new(
+  condition_id: null,
+  site_id: null,
+  site_name: null,
+  city: null,
+  country: null,
+  n_trials: null
+)
+```
+

data/docs/ConditionTrialsResponse.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::ConditionTrialsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset** | **String** |  |  |
+| **grain** | **String** |  | [optional] |
+| **object_type** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **scope** | [**BiomarkerCdxAssertionsResponseScope**](BiomarkerCdxAssertionsResponseScope.md) |  | [optional] |
+| **columns** | [**Array<DatasetColumn>**](DatasetColumn.md) |  |  |
+| **rows** | [**Array<ConditionTrialsRow>**](ConditionTrialsRow.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** | [**BiomarkerCdxAssertionsResponseFreshness**](BiomarkerCdxAssertionsResponseFreshness.md) |  | [optional] |
+| **build** | [**BiomarkerCdxAssertionsResponseBuild**](BiomarkerCdxAssertionsResponseBuild.md) |  | [optional] |
+| **build_state** | [**DatasetBuildState**](DatasetBuildState.md) |  | [optional] |
+| **restriction** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ConditionTrialsResponse.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/ConditionTrialsRow.md

@@ -0,0 +1,58 @@
+# PharmaObservatory::ConditionTrialsRow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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 MeSH heading. | [optional] |
+| **trial_id** | **String** | The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number). | [optional] |
+| **is_direct** | **Boolean** | True when the trial is tagged with this condition itself; false when it is tagged with a condition beneath it in the MeSH tree. | [optional] |
+| **trial_title** | **String** | The trial's brief title. | [optional] |
+| **study_type** | **String** | The registry's study type (INTERVENTIONAL, OBSERVATIONAL or EXPANDED_ACCESS). | [optional] |
+| **phase** | **String** | The trial phase label (Phase 1, Phase 2, Phase 3, Phase 4, Not Applicable and so on). | [optional] |
+| **overall_status** | **String** | The registry's overall recruitment status (COMPLETED, RECRUITING, TERMINATED and so on). | [optional] |
+| **start_date** | **Date** | Trial start date as registered. | [optional] |
+| **start_year** | **Integer** | Calendar year of the start date. | [optional] |
+| **primary_completion_date** | **Date** | Primary completion date as registered. | [optional] |
+| **last_update_posted_date** | **Date** | The date the registry last posted an update to the trial record. | [optional] |
+| **enrollment** | **Integer** | Enrollment as registered. | [optional] |
+| **were_results_reported** | **Boolean** | Whether results are posted on the registry. | [optional] |
+| **sponsor_name** | **String** | The lead sponsor's name as filed. | [optional] |
+| **sponsor_org_id** | **String** | Legal-entity level: the lead sponsor's organization record. | [optional] |
+| **sponsor_company_id** | **String** | Company level: the lead sponsor's company (null when the sponsor did not resolve to a company). | [optional] |
+| **sponsor_company_name** | **String** | The lead sponsor's company name. | [optional] |
+| **sponsor_group_id** | **String** | Group level: the current ultimate parent of the lead sponsor's company; dated links are in company_members. | [optional] |
+| **sponsor_group_name** | **String** | Display name of the lead sponsor's group. | [optional] |
+| **sponsor_agency_class** | **String** | The registry's declared funder class of the lead sponsor (INDUSTRY, NIH for the US National Institutes of Health, OTHER and so on). | [optional] |
+
+## Example
+
+```ruby
+require 'pharmaobservatory'
+
+instance = PharmaObservatory::ConditionTrialsRow.new(
+  condition_id: null,
+  condition_name: null,
+  trial_id: null,
+  is_direct: null,
+  trial_title: null,
+  study_type: null,
+  phase: null,
+  overall_status: null,
+  start_date: null,
+  start_year: null,
+  primary_completion_date: null,
+  last_update_posted_date: null,
+  enrollment: null,
+  were_results_reported: null,
+  sponsor_name: null,
+  sponsor_org_id: null,
+  sponsor_company_id: null,
+  sponsor_company_name: null,
+  sponsor_group_id: null,
+  sponsor_group_name: null,
+  sponsor_agency_class: null
+)
+```
+