API

CDM table name: ATTRIBUTE_DEFINITION

Julia struct name: AttributeDefinition

struct AttributeDefinition <: CDMType

• attribute_definition_id::Int64

• attribute_name::String

• attribute_description::Union{Missing, String}

• attribute_type_concept_id::Int64

• attribute_syntax::Union{Missing, String}

An OMOP Common Data Model (CDM) type.

CDM table name: CARE_SITE

Julia struct name: CareSite

struct CareSite <: CDMType

• care_site_id::Int64

• care_site_name::Union{Missing, String}

• place_of_service_concept_id::Union{Missing, Int64}

• location_id::Union{Missing, Int64}

• care_site_source_value::Union{Missing, String}

• place_of_service_source_value::Union{Missing, String}

CDM table name: CDM_SOURCE

Julia struct name: CdmSource

struct CdmSource <: CDMType

• cdm_source_name::String

• cdm_source_abbreviation::Union{Missing, String}

• cdm_holder::Union{Missing, String}

• source_description::Union{Missing, String}

• source_documentation_reference::Union{Missing, String}

• cdm_etl_reference::Union{Missing, String}

• source_release_date::Union{Missing, Dates.DateTime}

• cdm_release_date::Union{Missing, Dates.DateTime}

• cdm_version::Union{Missing, String}

• vocabulary_version::Union{Missing, String}

CDM table name: COHORT

Julia struct name: Cohort

struct Cohort <: CDMType

• cohort_definition_id::Int64

• subject_id::Int64

• cohort_start_date::Dates.DateTime

• cohort_end_date::Dates.DateTime

CDM table name: COHORT_ATTRIBUTE

Julia struct name: CohortAttribute

struct CohortAttribute <: CDMType

• cohort_definition_id::Int64

• subject_id::Int64

• cohort_start_date::Dates.DateTime

• cohort_end_date::Dates.DateTime

• attribute_definition_id::Int64

• value_as_number::Union{Missing, Float64}

• value_as_concept_id::Union{Missing, Int64}

CDM table name: COHORT_DEFINITION

Julia struct name: CohortDefinition

struct CohortDefinition <: CDMType

• cohort_definition_id::Int64

• cohort_definition_name::String

• cohort_definition_description::Union{Missing, String}

• definition_type_concept_id::Int64

• cohort_definition_syntax::Union{Missing, String}

• subject_concept_id::Int64

• cohort_initiation_date::Union{Missing, Dates.DateTime}

CDM table name: CONCEPT

Julia struct name: Concept

struct Concept <: CDMType

• concept_id::Int64

• concept_name::String

• domain_id::String

• vocabulary_id::String

• concept_class_id::String

• standard_concept::Union{Missing, String}

• concept_code::String

• valid_start_date::Dates.DateTime

• valid_end_date::Dates.DateTime

• invalid_reason::Union{Missing, String}

CDM table name: CONCEPT_ANCESTOR

Julia struct name: ConceptAncestor

struct ConceptAncestor <: CDMType

• ancestor_concept_id::Int64

• descendant_concept_id::Int64

• min_levels_of_separation::Int64

• max_levels_of_separation::Int64

CDM table name: CONCEPT_CLASS

Julia struct name: ConceptClass

struct ConceptClass <: CDMType

• concept_class_id::String

• concept_class_name::String

• concept_class_concept_id::Int64

CDM table name: CONCEPT_RELATIONSHIP

Julia struct name: ConceptRelationship

struct ConceptRelationship <: CDMType

• concept_id_1::Int64

• concept_id_2::Int64

• relationship_id::String

• valid_start_date::Dates.DateTime

• valid_end_date::Dates.DateTime

• invalid_reason::Union{Missing, String}

CDM table name: CONCEPT_SYNONYM

Julia struct name: ConceptSynonym

struct ConceptSynonym <: CDMType

• concept_id::Int64

• concept_synonym_name::String

• language_concept_id::Int64

CDM table name: CONDITION_ERA

Julia struct name: ConditionEra

struct ConditionEra <: CDMType

• condition_era_id::Int64

• person_id::Int64

• condition_concept_id::Int64

• condition_era_start_date::Dates.DateTime

• condition_era_end_date::Dates.DateTime

• condition_occurrence_count::Union{Missing, Int64}

CDM table name: CONDITION_OCCURRENCE

Julia struct name: ConditionOccurrence

struct ConditionOccurrence <: CDMType

• condition_occurrence_id::Int64

• person_id::Int64

• condition_concept_id::Int64

• condition_start_date::Dates.DateTime

• condition_start_datetime::Union{Missing, Dates.DateTime}

• condition_end_date::Union{Missing, Dates.DateTime}

• condition_end_datetime::Union{Missing, Dates.DateTime}

• condition_type_concept_id::Int64

• stop_reason::Union{Missing, String}

• provider_id::Union{Missing, Int64}

• visit_occurrence_id::Union{Missing, Int64}

• visit_detail_id::Union{Missing, Int64}

• condition_source_value::Union{Missing, String}

• condition_source_concept_id::Union{Missing, Int64}

• condition_status_source_value::Union{Missing, String}

• condition_status_concept_id::Union{Missing, Int64}

CDM table name: COST

Julia struct name: Cost

struct Cost <: CDMType

• cost_id::Int64

• cost_event_id::Int64

• cost_domain_id::String

• cost_type_concept_id::Int64

• currency_concept_id::Union{Missing, Int64}

• total_charge::Union{Missing, Float64}

• total_cost::Union{Missing, Float64}

• total_paid::Union{Missing, Float64}

• paid_by_payer::Union{Missing, Float64}

• paid_by_patient::Union{Missing, Float64}

• paid_patient_copay::Union{Missing, Float64}

• paid_patient_coinsurance::Union{Missing, Float64}

• paid_patient_deductible::Union{Missing, Float64}

• paid_by_primary::Union{Missing, Float64}

• paid_ingredient_cost::Union{Missing, Float64}

• paid_dispensing_fee::Union{Missing, Float64}

• payer_plan_period_id::Union{Missing, Int64}

• amount_allowed::Union{Missing, Float64}

• revenue_code_concept_id::Union{Missing, Int64}

• reveue_code_source_value::Union{Missing, String}

• drg_concept_id::Union{Missing, Int64}

• drg_source_value::Union{Missing, String}

CDM table name: DEATH

Julia struct name: Death

struct Death <: CDMType

• person_id::Int64

• death_date::Dates.DateTime

• death_datetime::Union{Missing, Dates.DateTime}

• death_type_concept_id::Int64

• cause_concept_id::Union{Missing, Int64}

• cause_source_value::Union{Missing, String}

• cause_source_concept_id::Union{Missing, Int64}

CDM table name: DEVICE_EXPOSURE

Julia struct name: DeviceExposure

struct DeviceExposure <: CDMType

• device_exposure_id::Int64

• person_id::Int64

• device_concept_id::Int64

• device_exposure_start_date::Dates.DateTime

• device_exposure_start_datetime::Union{Missing, Dates.DateTime}

• device_exposure_end_date::Union{Missing, Dates.DateTime}

• device_exposure_end_datetime::Union{Missing, Dates.DateTime}

• device_type_concept_id::Int64

• unique_device_id::Union{Missing, String}

• quantity::Union{Missing, Int64}

• provider_id::Union{Missing, Int64}

• visit_occurrence_id::Union{Missing, Int64}

• visit_detail_id::Union{Missing, Int64}

• device_source_value::Union{Missing, String}

• device_source_concept_id::Union{Missing, Int64}

CDM table name: DOMAIN

Julia struct name: Domain

struct Domain <: CDMType

• domain_id::String

• domain_name::String

• domain_concept_id::Int64

CDM table name: DOSE_ERA

Julia struct name: DoseEra

struct DoseEra <: CDMType

• dose_era_id::Int64

• person_id::Int64

• drug_concept_id::Int64

• unit_concept_id::Int64

• dose_value::Float64

• dose_era_start_date::Dates.DateTime

• dose_era_end_date::Dates.DateTime

CDM table name: DRUG_ERA

Julia struct name: DrugEra

struct DrugEra <: CDMType

• drug_era_id::Int64

• person_id::Int64

• drug_concept_id::Int64

• drug_era_start_date::Dates.DateTime

• drug_era_end_date::Dates.DateTime

• drug_exposure_count::Union{Missing, Int64}

• gap_days::Union{Missing, Int64}

CDM table name: DRUG_EXPOSURE

Julia struct name: DrugExposure

struct DrugExposure <: CDMType

• drug_exposure_id::Int64

• person_id::Int64

• drug_concept_id::Int64

• drug_exposure_start_date::Dates.DateTime

• drug_exposure_start_datetime::Union{Missing, Dates.DateTime}

• drug_exposure_end_date::Dates.DateTime

• drug_exposure_end_datetime::Union{Missing, Dates.DateTime}

• verbatim_end_date::Union{Missing, Dates.DateTime}

• drug_type_concept_id::Int64

• stop_reason::Union{Missing, String}

• refills::Union{Missing, Int64}

• quantity::Union{Missing, Float64}

• days_supply::Union{Missing, Int64}

• sig::Union{Missing, String}

• route_concept_id::Union{Missing, Int64}

• lot_number::Union{Missing, String}

• provider_id::Union{Missing, Int64}

• visit_occurrence_id::Union{Missing, Int64}

• visit_detail_id::Union{Missing, Int64}

• drug_source_value::Union{Missing, String}

• drug_source_concept_id::Union{Missing, Int64}

• route_source_value::Union{Missing, String}

• dose_unit_source_value::Union{Missing, String}

CDM table name: DRUG_STRENGTH

Julia struct name: DrugStrength

struct DrugStrength <: CDMType

• drug_concept_id::Int64

• ingredient_concept_id::Int64

• amount_value::Union{Missing, Float64}

• amount_unit_concept_id::Union{Missing, Int64}

• numerator_value::Union{Missing, Float64}

• numerator_unit_concept_id::Union{Missing, Int64}

• denominator_value::Union{Missing, Float64}

• denominator_unit_concept_id::Union{Missing, Int64}

• box_size::Union{Missing, Int64}

• valid_start_date::Dates.DateTime

• valid_end_date::Dates.DateTime

• invalid_reason::Union{Missing, String}

CDM table name: FACT_RELATIONSHIP

Julia struct name: FactRelationship

struct FactRelationship <: CDMType

• domain_concept_id_1::Int64

• fact_id_1::Int64

• domain_concept_id_2::Int64

• fact_id_2::Int64

• relationship_concept_id::Int64

CDM table name: LOCATION

Julia struct name: Location

struct Location <: CDMType

• location_id::Int64

• address_1::Union{Missing, String}

• address_2::Union{Missing, String}

• city::Union{Missing, String}

• state::Union{Missing, String}

• zip::Union{Missing, String}

• county::Union{Missing, String}

• location_source_value::Union{Missing, String}

CDM table name: MEASUREMENT

Julia struct name: Measurement

struct Measurement <: CDMType

• measurement_id::Int64

• person_id::Int64

• measurement_concept_id::Int64

• measurement_date::Dates.DateTime

• measurement_datetime::Union{Missing, Dates.DateTime}

• measurement_time::Union{Missing, String}

• measurement_type_concept_id::Int64

• operator_concept_id::Union{Missing, Int64}

• value_as_number::Union{Missing, Float64}

• value_as_concept_id::Union{Missing, Int64}

• unit_concept_id::Union{Missing, Int64}

• range_low::Union{Missing, Float64}

• range_high::Union{Missing, Float64}

• provider_id::Union{Missing, Int64}

• visit_occurrence_id::Union{Missing, Int64}

• visit_detail_id::Union{Missing, Int64}

• measurement_source_value::Union{Missing, String}

• measurement_source_concept_id::Union{Missing, Int64}

• unit_source_value::Union{Missing, String}

• value_source_value::Union{Missing, String}

CDM table name: METADATA

Julia struct name: Metadata

struct Metadata <: CDMType

• metadata_concept_id::Int64

• metadata_type_concept_id::Int64

• name::String

• value_as_string::Union{Missing, String}

• value_as_concept_id::Union{Missing, Int64}

• metadata_date::Union{Missing, Dates.DateTime}

• metadata_datetime::Union{Missing, Dates.DateTime}

CDM table name: NOTE

Julia struct name: Note

struct Note <: CDMType

• note_id::Int64

• person_id::Int64

• note_date::Dates.DateTime

• note_datetime::Union{Missing, Dates.DateTime}

• note_type_concept_id::Int64

• note_class_concept_id::Int64

• note_title::Union{Missing, String}

• note_text::Union{Missing, String}

• encoding_concept_id::Int64

• language_concept_id::Int64

• provider_id::Union{Missing, Int64}

• visit_occurrence_id::Union{Missing, Int64}

• visit_detail_id::Union{Missing, Int64}

• note_source_value::Union{Missing, String}

CDM table name: NOTE_NLP

Julia struct name: NoteNlp

struct NoteNlp <: CDMType

• note_nlp_id::Int64

• note_id::Int64

• section_concept_id::Union{Missing, Int64}

• snippet::Union{Missing, String}

• offset::Union{Missing, String}

• lexical_variant::String

• note_nlp_concept_id::Union{Missing, Int64}

• note_nlp_source_concept_id::Union{Missing, Int64}

• nlp_system::Union{Missing, String}

• nlp_date::Dates.DateTime

• nlp_datetime::Union{Missing, Dates.DateTime}

• term_exists::Union{Missing, String}

• term_temporal::Union{Missing, String}

• term_modifiers::Union{Missing, String}

CDM table name: OBSERVATION

Julia struct name: Observation

struct Observation <: CDMType

• observation_id::Int64

• person_id::Int64

• observation_concept_id::Int64

• observation_date::Dates.DateTime

• observation_datetime::Union{Missing, Dates.DateTime}

• observation_type_concept_id::Int64

• value_as_number::Union{Missing, Float64}

• value_as_string::Union{Missing, String}

• value_as_concept_id::Union{Missing, Int64}

• qualifier_concept_id::Union{Missing, Int64}

• unit_concept_id::Union{Missing, Int64}

• provider_id::Union{Missing, Int64}

• visit_occurrence_id::Union{Missing, Int64}

• visit_detail_id::Union{Missing, Int64}

• observation_source_value::Union{Missing, String}

• observation_source_concept_id::Union{Missing, Int64}

• unit_source_value::Union{Missing, String}

• qualifier_source_value::Union{Missing, String}

CDM table name: OBSERVATION_PERIOD

Julia struct name: ObservationPeriod

struct ObservationPeriod <: CDMType

• observation_period_id::Int64

• person_id::Int64

• observation_period_start_date::Dates.DateTime

• observation_period_end_date::Dates.DateTime

• period_type_concept_id::Int64

CDM table name: PAYERPLANPERIOD

Julia struct name: PayerPlanPeriod

struct PayerPlanPeriod <: CDMType

• payer_plan_period_id::Int64

• person_id::Int64

• payer_plan_period_start_date::Dates.DateTime

• payer_plan_period_end_date::Dates.DateTime

• payer_concept_id::Union{Missing, Int64}

• payer_source_value::Union{Missing, String}

• payer_source_concept_id::Union{Missing, Int64}

• plan_concept_id::Union{Missing, Int64}

• plan_source_value::Union{Missing, String}

• plan_source_concept_id::Union{Missing, Int64}

• sponsor_concept_id::Union{Missing, Int64}

• sponsor_source_value::Union{Missing, String}

• sponsor_source_concept_id::Union{Missing, Int64}

• family_source_value::Union{Missing, String}

• stop_reason_concept_id::Union{Missing, Int64}

• stop_reason_source_value::Union{Missing, String}

• stop_reason_source_concept_id::Union{Missing, Int64}

CDM table name: PERSON

Julia struct name: Person

struct Person <: CDMType

• person_id::Int64

• gender_concept_id::Int64

• year_of_birth::Int64

• month_of_birth::Union{Missing, Int64}

• day_of_birth::Union{Missing, Int64}

• birth_datetime::Union{Missing, Dates.DateTime}

• race_concept_id::Int64

• ethnicity_concept_id::Int64

• location_id::Union{Missing, Int64}

• provider_id::Union{Missing, Int64}

• care_site_id::Union{Missing, Int64}

• person_source_value::Union{Missing, String}

• gender_source_value::Union{Missing, String}

• gender_source_concept_id::Union{Missing, Int64}

• race_source_value::Union{Missing, String}

• race_source_concept_id::Union{Missing, Int64}

• ethnicity_source_value::Union{Missing, String}

• ethnicity_source_concept_id::Union{Missing, Int64}

CDM table name: PROCEDURE_OCCURRENCE

Julia struct name: ProcedureOccurrence

struct ProcedureOccurrence <: CDMType

• procedure_occurrence_id::Int64

• person_id::Int64

• procedure_concept_id::Int64

• procedure_date::Dates.DateTime

• procedure_datetime::Union{Missing, Dates.DateTime}

• procedure_type_concept_id::Int64

• modifier_concept_id::Union{Missing, Int64}

• quantity::Union{Missing, Int64}

• provider_id::Union{Missing, Int64}

• visit_occurrence_id::Union{Missing, Int64}

• visit_detail_id::Union{Missing, Int64}

• procedure_source_value::Union{Missing, String}

• procedure_source_concept_id::Union{Missing, Int64}

• modifier_source_value::Union{Missing, String}

CDM table name: PROVIDER

Julia struct name: Provider

struct Provider <: CDMType

• provider_id::Int64

• provider_name::Union{Missing, String}

• NPI::Union{Missing, String}

• DEA::Union{Missing, String}

• specialty_concept_id::Union{Missing, Int64}

• care_site_id::Union{Missing, Int64}

• year_of_birth::Union{Missing, Int64}

• gender_concept_id::Union{Missing, Int64}

• provider_source_value::Union{Missing, String}

• specialty_source_value::Union{Missing, String}

• specialty_source_concept_id::Union{Missing, Int64}

• gender_source_value::Union{Missing, String}

• gender_source_concept_id::Union{Missing, Int64}

CDM table name: RELATIONSHIP

Julia struct name: Relationship

struct Relationship <: CDMType

• relationship_id::String

• relationship_name::String

• is_hierarchical::String

• defines_ancestry::String

• reverse_relationship_id::String

• relationship_concept_id::Int64

CDM table name: SOURCETOCONCEPT_MAP

Julia struct name: SourceToConceptMap

struct SourceToConceptMap <: CDMType

• source_code::String

• source_concept_id::Int64

• source_vocabulary_id::String

• source_code_description::Union{Missing, String}

• target_concept_id::Int64

• target_vocabulary_id::String

• valid_start_date::Dates.DateTime

• valid_end_date::Dates.DateTime

• invalid_reason::Union{Missing, String}

CDM table name: SPECIMEN

Julia struct name: Specimen

struct Specimen <: CDMType

• specimen_id::Int64

• person_id::Int64

• specimen_concept_id::Int64

• specimen_type_concept_id::Int64

• specimen_date::Dates.DateTime

• specimen_datetime::Union{Missing, Dates.DateTime}

• quantity::Union{Missing, Float64}

• unit_concept_id::Union{Missing, Int64}

• anatomic_site_concept_id::Union{Missing, Int64}

• disease_status_concept_id::Union{Missing, Int64}

• specimen_source_id::Union{Missing, String}

• specimen_source_value::Union{Missing, String}

• unit_source_value::Union{Missing, String}

• anatomic_site_source_value::Union{Missing, String}

• disease_status_source_value::Union{Missing, String}

CDM table name: VISIT_DETAIL

Julia struct name: VisitDetail

struct VisitDetail <: CDMType

• visit_detail_id::Int64

• person_id::Int64

• visit_detail_concept_id::Int64

• visit_detail_start_date::Dates.DateTime

• visit_detail_start_datetime::Union{Missing, Dates.DateTime}

• visit_detail_end_date::Dates.DateTime

• visit_detail_end_datetime::Union{Missing, Dates.DateTime}

• visit_detail_type_concept_id::Int64

• provider_id::Union{Missing, Int64}

• care_site_id::Union{Missing, Int64}

• admitting_source_concept_id::Union{Missing, Int64}

• discharge_to_concept_id::Union{Missing, Int64}

• preceding_visit_detail_id::Union{Missing, Int64}

• visit_detail_source_value::Union{Missing, String}

• visit_detail_source_concept_id::Union{Missing, Int64}

• admitting_source_value::Union{Missing, String}

• discharge_to_source_value::Union{Missing, String}

• visit_detail_parent_id::Union{Missing, Int64}

• visit_occurrence_id::Int64

CDM table name: VISIT_OCCURRENCE

Julia struct name: VisitOccurrence

struct VisitOccurrence <: CDMType

• visit_occurrence_id::Int64

• person_id::Int64

• visit_concept_id::Int64

• visit_start_date::Dates.DateTime

• visit_start_datetime::Union{Missing, Dates.DateTime}

• visit_end_date::Dates.DateTime

• visit_end_datetime::Union{Missing, Dates.DateTime}

• visit_type_concept_id::Int64

• provider_id::Union{Missing, Int64}

• care_site_id::Union{Missing, Int64}

• visit_source_value::Union{Missing, String}

• visit_source_concept_id::Union{Missing, Int64}

• admitting_source_concept_id::Union{Missing, Int64}

• admitting_source_value::Union{Missing, String}

• discharge_to_concept_id::Union{Missing, Int64}

• discharge_to_source_value::Union{Missing, String}

• preceding_visit_occurrence_id::Union{Missing, Int64}

CDM table name: VOCABULARY

Julia struct name: Vocabulary

struct Vocabulary <: CDMType

• vocabulary_id::String

• vocabulary_name::String

• vocabulary_reference::String

• vocabulary_version::String

• vocabulary_concept_id::Int64

The version of the OMOP Common Data Model (CDM) being implemented.

The version of the OMOPCommonDataModel.jl Julia package.