Reference

OMOP Common Data Model.

Import the package:

import omop

This is the complete API reference:

CareSite(*args, **kwargs)

The CARE_SITE table contains a list of uniquely identified institutional (physical or organizational) units where healthcare delivery is practiced (offices, wards, hospitals, clinics, etc.).

CdmSource(*args, **kwargs)

The CDM_SOURCE table contains detail about the source database and the process used to transform the data into the OMOP Common Data Model.

Cohort(*args, **kwargs)

The COHORT table contains records of subjects that satisfy a given set of criteria for a duration of time.

CohortDefinition(*args, **kwargs)

The COHORT_DEFINITION table contains records defining a Cohort derived from the data through the associated description and syntax and upon instantiation (execution of the algorithm) placed into the COHORT table.

Concept(*args, **kwargs)

The Standardized Vocabularies contains records, or Concepts, that uniquely identify each fundamental unit of meaning used to express clinical information in all domain tables of the CDM.

ConceptAncestor(*args, **kwargs)

The CONCEPT_ANCESTOR table is designed to simplify observational analysis by providing the complete hierarchical relationships between Concepts.

ConceptRelationship(*args, **kwargs)

The CONCEPT_RELATIONSHIP table contains records that define direct relationships between any two Concepts and the nature or type of the relationship.

ConceptSynonym(*args, **kwargs)

The CONCEPT_SYNONYM table is used to store alternate names and descriptions for Concepts.

ConditionEra(*args, **kwargs)

A Condition Era is defined as a span of time when the Person is assumed to have a given condition.

ConditionOccurrence(*args, **kwargs)

This table contains records of Events of a Person suggesting the presence of a disease or medical condition stated as a diagnosis, a sign, or a symptom, which is either observed by a Provider or reported by the patient.

Cost(*args, **kwargs)

The COST table captures records containing the cost of any medical event recorded in one of the OMOP clinical event tables such as DRUG_EXPOSURE, PROCEDURE_OCCURRENCE, VISIT_OCCURRENCE, VISIT_DETAIL, DEVICE_OCCURRENCE, OBSERVATION or MEASUREMENT.

Death(*args, **kwargs)

The death domain contains the clinical event for how and when a Person dies.

DeviceExposure(*args, **kwargs)

The Device domain captures information about a person�s exposure to a foreign physical object or instrument which is used for diagnostic or therapeutic purposes through a mechanism beyond chemical action.

Domain(*args, **kwargs)

The DOMAIN table includes a list of OMOP-defined Domains the Concepts of the Standardized Vocabularies can belong to.

DoseEra(*args, **kwargs)

A Dose Era is defined as a span of time when the Person is assumed to be exposed to a constant dose of a specific active ingredient.

DrugEra(*args, **kwargs)

A Drug Era is defined as a span of time when the Person is assumed to be exposed to a particular active ingredient.

DrugExposure(*args, **kwargs)

This table captures records about the exposure to a Drug ingested or otherwise introduced into the body.

DrugStrength(*args, **kwargs)

The DRUG_STRENGTH table contains structured content about the amount or concentration and associated units of a specific ingredient contained within a particular drug product.

Episode(*args, **kwargs)

The EPISODE table aggregates lower-level clinical events (VISIT_OCCURRENCE, DRUG_EXPOSURE, PROCEDURE_OCCURRENCE, DEVICE_EXPOSURE) into a higher-level abstraction representing clinically and analytically relevant disease phases,outcomes and treatments.

EpisodeEvent(*args, **kwargs)

The EPISODE_EVENT table connects qualifying clinical events (such as CONDITION_OCCURRENCE, DRUG_EXPOSURE, PROCEDURE_OCCURRENCE, MEASUREMENT) to the appropriate EPISODE entry.

FactRelationship(*args, **kwargs)

The FACT_RELATIONSHIP table contains records about the relationships between facts stored as records in any table of the CDM.

Location(*args, **kwargs)

The LOCATION table represents a generic way to capture physical location or address information of Persons and Care Sites.

Measurement(*args, **kwargs)

The MEASUREMENT table contains records of Measurements, i.e. structured values (numerical or categorical) obtained through systematic and standardized examination or testing of a Person or Person�s sample.

Metadata(*args, **kwargs)

The METADATA table contains metadata information about a dataset that has been transformed to the OMOP Common Data Model.

Note(*args, **kwargs)

The NOTE table captures unstructured information that was recorded by a provider about a patient in free text (in ASCII, or preferably in UTF8 format) notes on a given date.

NoteNlp(*args, **kwargs)

The NOTE_NLP table encodes all output of NLP on clinical notes.

Observation(*args, **kwargs)

The OBSERVATION table captures clinical facts about a Person obtained in the context of examination, questioning or a procedure.

ObservationPeriod(*args, **kwargs)

This table contains records which define spans of time during which two conditions are expected to hold: (i) Clinical Events that happened to the Person are recorded in the Event tables, and (ii) absense of records indicate such Events did not occur during this span of time.

PayerPlanPeriod(*args, **kwargs)

The PAYER_PLAN_PERIOD table captures details of the period of time that a Person is continuously enrolled under a specific health Plan benefit structure from a given Payer.

Person(*args, **kwargs)

This table serves as the central identity management for all Persons in the database.

ProcedureOccurrence(*args, **kwargs)

This table contains records of activities or processes ordered by, or carried out by, a healthcare provider on the patient with a diagnostic or therapeutic purpose.

Provider(*args, **kwargs)

The PROVIDER table contains a list of uniquely identified healthcare providers.

Relationship(*args, **kwargs)

The RELATIONSHIP table provides a reference list of all types of relationships that can be used to associate any two concepts in the CONCEPT_RELATIONSHP table.

SourceToConceptMap(*args, **kwargs)

The source to concept map table is a legacy data structure within the OMOP Common Data Model, recommended for use in ETL processes to maintain local source codes which are not available as Concepts in the Standardized Vocabularies, and to establish mappings for each source code into a Standard Concept as target_concept_ids that can be used to populate the Common Data Model tables.

Specimen(*args, **kwargs)

The specimen domain contains the records identifying biological samples from a person.

VisitDetail(*args, **kwargs)

The VISIT_DETAIL table is an optional table used to represents details of each record in the parent VISIT_OCCURRENCE table.

VisitOccurrence(*args, **kwargs)

This table contains Events where Persons engage with the healthcare system for a duration of time.

Vocabulary(*args, **kwargs)

The VOCABULARY table includes a list of the Vocabularies collected from various sources or created de novo by the OMOP community.