documentation:software:heracles
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
documentation:software:heracles [2015/04/09 19:48] jduke |
documentation:software:heracles [2015/04/23 16:36] (current) jduke |
||
|---|---|---|---|
| Line 5: | Line 5: | ||
| **Requirements** | **Requirements** | ||
| * Data in OMOP CDM v4/v5 | * Data in OMOP CDM v4/v5 | ||
| - | * [[https://github.com/OHDSI/WebAPI|WebAPI]] installed and running | + | * COHORT and COHORT_DEFINITION tables (or other tables following the OMOP V5 cohort table format) |
| - | * Cohort and Cohort Definition Tables populated | + | |
| + | **Installation** | ||
| + | * Install [[documentation:software:olympus|OLYMPUS]] | ||
| + | * Advanced users may reference [[https://github.com/OHDSI/Heracles/|Heracles on Github]] for custom installation instructions | ||
| + | |||
| + | **Use** | ||
| + | |||
| + | * Select a Cohort from the Heracles dropdown. This will include all cohorts in your cohort definition table. | ||
| + | |||
| + | {{ :documentation:software:screen_shot_2015-04-09_at_4.04.07_pm.png |}} | ||
| + | |||
| + | * Select analyses individually (as listed below) or as part of a report package (bundle of analyses that will enable Heracles to build a particular visual report of a particular area of interest (e.g., drug exposure)). | ||
| + | |||
| + | {{ :documentation:software:screen_shot_2015-04-09_at_3.59.19_pm.png |}} | ||
| + | |||
| + | Optional parameters include | ||
| + | |||
| + | * Specific concept ID's to run for conditions, drugs, procedures, observations, and measurements | ||
| + | * Small Cell Count (minimum number of patients to return for any category) | ||
| + | * Run Heracles Heel for data quality analyses | ||
| + | * Limit the analyses to only events occurring within the Cohort Period (as opposed to all events for patients in the cohort) | ||
| + | |||
| + | * Your analysis will be sent to the Job Manager. If running Olympus, check there for completion status. Or if not in Olympus, use the link provided by Heracles to check it manually. | ||
| + | |||
| + | |||
| + | **Heracles Viewer** | ||
| + | |||
| **Heracles Analysis List** | **Heracles Analysis List** | ||
| Line 70: | Line 97: | ||
| * Number of condition occurrence records with invalid visit_id | * Number of condition occurrence records with invalid visit_id | ||
| * Number of condition occurrence records by condition occurrence start month | * Number of condition occurrence records by condition occurrence start month | ||
| + | |||
| + | Death | ||
| + | |||
| * Number of persons with death, by cause_of_death_concept_id | * Number of persons with death, by cause_of_death_concept_id | ||
| * Number of records of death, by cause_of_death_concept_id | * Number of records of death, by cause_of_death_concept_id | ||
| Line 83: | Line 113: | ||
| * Distribution of time from death to last procedure | * Distribution of time from death to last procedure | ||
| * Distribution of time from death to last observation | * Distribution of time from death to last observation | ||
| + | |||
| + | Procedure Occurrence | ||
| + | |||
| * Number of persons with at least one procedure occurrence, by procedure_concept_id | * Number of persons with at least one procedure occurrence, by procedure_concept_id | ||
| * Number of procedure occurrence records, by procedure_concept_id | * Number of procedure occurrence records, by procedure_concept_id | ||
| Line 95: | Line 128: | ||
| * Number of procedure occurrence records with invalid visit_id | * Number of procedure occurrence records with invalid visit_id | ||
| * Number of procedure occurrence records by procedure occurrence start month | * Number of procedure occurrence records by procedure occurrence start month | ||
| + | |||
| + | Drug Exposure | ||
| + | |||
| * Number of persons with at least one drug exposure, by drug_concept_id | * Number of persons with at least one drug exposure, by drug_concept_id | ||
| * Number of drug exposure records, by drug_concept_id | * Number of drug exposure records, by drug_concept_id | ||
| Line 111: | Line 147: | ||
| * Distribution of quantity by drug_concept_id | * Distribution of quantity by drug_concept_id | ||
| * Number of drug exposure records by drug exposure start month | * Number of drug exposure records by drug exposure start month | ||
| + | |||
| + | Observation | ||
| + | |||
| * Number of persons with at least one observation occurrence, by observation_concept_id | * Number of persons with at least one observation occurrence, by observation_concept_id | ||
| * Number of observation occurrence records, by observation_concept_id | * Number of observation occurrence records, by observation_concept_id | ||
| Line 129: | Line 168: | ||
| * Number of observation records below/within/above normal range, by observation_concept_id and unit_concept_id | * Number of observation records below/within/above normal range, by observation_concept_id and unit_concept_id | ||
| * Number of observation records by observation start month | * Number of observation records by observation start month | ||
| + | |||
| + | Measurement | ||
| + | |||
| + | * Number of persons with at least one measurement occurrence, by measurement_concept_id | ||
| + | * Number of measurement occurrence records, by measurement_concept_id | ||
| + | * Number of persons by measurement occurrence start month, by measurement_concept_id | ||
| + | * Number of distinct measurement occurrence concepts per person | ||
| + | * Number of persons with at least one measurement occurrence, by measurement_concept_id by calendar year by gender by age decile | ||
| + | * Number of measurement occurrence records, by measurement_concept_id by measurement_type_concept_id | ||
| + | * Distribution of age by measurement_concept_id | ||
| + | * Number of measurement occurrence records, by measurement_concept_id and unit_concept_id | ||
| + | * Number of measurement records with invalid person_id | ||
| + | * Number of measurement records outside valid measurement period | ||
| + | * Number of measurement records with invalid provider_id | ||
| + | * Number of measurement records with invalid visit_id | ||
| + | * Number of measurement records with no value (numeric, string, or concept) | ||
| + | * Distribution of numeric values, by measurement_concept_id and unit_concept_id | ||
| + | * Distribution of low range, by measurement_concept_id and unit_concept_id | ||
| + | * Distribution of high range, by measurement_concept_id and unit_concept_id | ||
| + | * Number of measurement records below/within/above normal range, by measurement_concept_id and unit_concept_id | ||
| + | * Number of measurement records by measurement start month | ||
| + | |||
| + | Drug Era | ||
| + | |||
| * Number of persons with at least one drug era, by drug_concept_id | * Number of persons with at least one drug era, by drug_concept_id | ||
| * Number of drug era records, by drug_concept_id | * Number of drug era records, by drug_concept_id | ||
| Line 140: | Line 203: | ||
| * Number of drug eras with end date < start date | * Number of drug eras with end date < start date | ||
| * Number of drug era records by drug era start month | * Number of drug era records by drug era start month | ||
| + | |||
| + | Condition Era | ||
| + | |||
| * Number of persons with at least one condition era, by condition_concept_id | * Number of persons with at least one condition era, by condition_concept_id | ||
| * Number of condition era records, by condition_concept_id | * Number of condition era records, by condition_concept_id | ||
| Line 151: | Line 217: | ||
| * Number of condition eras with end date < start date | * Number of condition eras with end date < start date | ||
| * Number of condition era records by condition era start month | * Number of condition era records by condition era start month | ||
| + | |||
| + | Location | ||
| + | |||
| * Number of persons by location 3-digit zip | * Number of persons by location 3-digit zip | ||
| * Number of persons by location state | * Number of persons by location state | ||
| + | |||
| + | Care Site | ||
| + | |||
| * Number of persons by place of service | * Number of persons by place of service | ||
| * Number of visits by place of service | * Number of visits by place of service | ||
| + | |||
| + | Cohort Analyses | ||
| + | |||
| * Number of records by cohort_concept_id | * Number of records by cohort_concept_id | ||
| * Number of records with cohort end date < cohort start date | * Number of records with cohort end date < cohort start date | ||
documentation/software/heracles.1428608908.txt.gz · Last modified: 2015/04/09 19:48 by jduke
Page Tools
