FHIR to OMOP FHIR IG
0.1.0 - ci-build International flag

FHIR to OMOP FHIR IG, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-omop-ig/ and changes regularly. See the Directory of published versions

Logical Model: Cost OMOP Table

Official URL: http://hl7.org/fhir/uv/omop/StructureDefinition/Cost Version: 0.1.0
Standards status: Draft Maturity Level: 1 Computable Name: Cost

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.

Each record in the cost table account for the amount of money transacted for the clinical event. So, the COST table may be used to represent both receivables (charges) and payments (paid), each transaction type represented by its COST_CONCEPT_ID. The COST_TYPE_CONCEPT_ID field will use concepts in the Standardized Vocabularies to designate the source (provenance) of the cost data. A reference to the health plan information in the PAYER_PLAN_PERIOD table is stored in the record for information used for the adjudication system to determine the persons benefit for the clinical event.

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. Cost 0..* Base Cost OMOP Table
Instances of this logical model are not marked to be the target of a Reference
... cost_id 1..1 code Cost Identifier
... cost_event_id 1..1 integer Cost Event Identifier
... cost_domain_id 1..1 string Cost Domain Identifier
... currency_concept_id 0..1 code Currency
... total_charge 0..1 integer Total Charge
... total_cost 0..1 integer Total Cost
... total_paid 0..1 integer Total Paid
... paid_by_payer 0..1 integer Paid by Payer
... paid_by_patient 0..1 integer Paid by Patient
... paid_patient_copay 0..1 integer Paid Patient Copay
... paid_patient_coinsurance 0..1 integer Paid Patient Coinsurance
... paid_patient_deductible 0..1 integer Paid Patient Deductible
... paid_by_primary 0..1 integer Paid by Primary
... paid_ingredient_cost 0..1 integer Paid Ingredent Cost
... paid_dispensing_fee 0..1 integer Paid Dispensing Fee
... payer_plan_period_id 0..1 Reference(Payer Plan Period OMOP Table) Payer Plan Period
... amount_allowed 0..1 integer Amount Allowed
... revenue_code_concept_id 0..1 code Revenue Code
... revenue_code_source_value 0..1 string Revenue Code Source Value
... drg_concept_id 0..1 integer Diagnosis Related Groups
... drg_source_value 0..1 string Diagnosis Related Groups Source Value

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Cost 0..* Base Cost OMOP Table
Instances of this logical model are not marked to be the target of a Reference
... cost_id 1..1 code Cost Identifier
... cost_event_id 1..1 integer Cost Event Identifier
... cost_domain_id 1..1 string Cost Domain Identifier
... currency_concept_id 0..1 code Currency
... total_charge 0..1 integer Total Charge
... total_cost 0..1 integer Total Cost
... total_paid 0..1 integer Total Paid
... paid_by_payer 0..1 integer Paid by Payer
... paid_by_patient 0..1 integer Paid by Patient
... paid_patient_copay 0..1 integer Paid Patient Copay
... paid_patient_coinsurance 0..1 integer Paid Patient Coinsurance
... paid_patient_deductible 0..1 integer Paid Patient Deductible
... paid_by_primary 0..1 integer Paid by Primary
... paid_ingredient_cost 0..1 integer Paid Ingredent Cost
... paid_dispensing_fee 0..1 integer Paid Dispensing Fee
... payer_plan_period_id 0..1 Reference(Payer Plan Period OMOP Table) Payer Plan Period
... amount_allowed 0..1 integer Amount Allowed
... revenue_code_concept_id 0..1 code Revenue Code
... revenue_code_source_value 0..1 string Revenue Code Source Value
... drg_concept_id 0..1 integer Diagnosis Related Groups
... drg_source_value 0..1 string Diagnosis Related Groups Source Value

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Cost 0..* Base Cost OMOP Table
Instances of this logical model are not marked to be the target of a Reference
... cost_id 1..1 code Cost Identifier
... cost_event_id 1..1 integer Cost Event Identifier
... cost_domain_id 1..1 string Cost Domain Identifier
... currency_concept_id 0..1 code Currency
... total_charge 0..1 integer Total Charge
... total_cost 0..1 integer Total Cost
... total_paid 0..1 integer Total Paid
... paid_by_payer 0..1 integer Paid by Payer
... paid_by_patient 0..1 integer Paid by Patient
... paid_patient_copay 0..1 integer Paid Patient Copay
... paid_patient_coinsurance 0..1 integer Paid Patient Coinsurance
... paid_patient_deductible 0..1 integer Paid Patient Deductible
... paid_by_primary 0..1 integer Paid by Primary
... paid_ingredient_cost 0..1 integer Paid Ingredent Cost
... paid_dispensing_fee 0..1 integer Paid Dispensing Fee
... payer_plan_period_id 0..1 Reference(Payer Plan Period OMOP Table) Payer Plan Period
... amount_allowed 0..1 integer Amount Allowed
... revenue_code_concept_id 0..1 code Revenue Code
... revenue_code_source_value 0..1 string Revenue Code Source Value
... drg_concept_id 0..1 integer Diagnosis Related Groups
... drg_source_value 0..1 string Diagnosis Related Groups Source Value

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(4 nested mandatory elements)

Structures

This structure refers to these other structures:

Maturity: 1

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. Cost 0..* Base Cost OMOP Table
Instances of this logical model are not marked to be the target of a Reference
... cost_id 1..1 code Cost Identifier
... cost_event_id 1..1 integer Cost Event Identifier
... cost_domain_id 1..1 string Cost Domain Identifier
... currency_concept_id 0..1 code Currency
... total_charge 0..1 integer Total Charge
... total_cost 0..1 integer Total Cost
... total_paid 0..1 integer Total Paid
... paid_by_payer 0..1 integer Paid by Payer
... paid_by_patient 0..1 integer Paid by Patient
... paid_patient_copay 0..1 integer Paid Patient Copay
... paid_patient_coinsurance 0..1 integer Paid Patient Coinsurance
... paid_patient_deductible 0..1 integer Paid Patient Deductible
... paid_by_primary 0..1 integer Paid by Primary
... paid_ingredient_cost 0..1 integer Paid Ingredent Cost
... paid_dispensing_fee 0..1 integer Paid Dispensing Fee
... payer_plan_period_id 0..1 Reference(Payer Plan Period OMOP Table) Payer Plan Period
... amount_allowed 0..1 integer Amount Allowed
... revenue_code_concept_id 0..1 code Revenue Code
... revenue_code_source_value 0..1 string Revenue Code Source Value
... drg_concept_id 0..1 integer Diagnosis Related Groups
... drg_source_value 0..1 string Diagnosis Related Groups Source Value

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Cost 0..* Base Cost OMOP Table
Instances of this logical model are not marked to be the target of a Reference
... cost_id 1..1 code Cost Identifier
... cost_event_id 1..1 integer Cost Event Identifier
... cost_domain_id 1..1 string Cost Domain Identifier
... currency_concept_id 0..1 code Currency
... total_charge 0..1 integer Total Charge
... total_cost 0..1 integer Total Cost
... total_paid 0..1 integer Total Paid
... paid_by_payer 0..1 integer Paid by Payer
... paid_by_patient 0..1 integer Paid by Patient
... paid_patient_copay 0..1 integer Paid Patient Copay
... paid_patient_coinsurance 0..1 integer Paid Patient Coinsurance
... paid_patient_deductible 0..1 integer Paid Patient Deductible
... paid_by_primary 0..1 integer Paid by Primary
... paid_ingredient_cost 0..1 integer Paid Ingredent Cost
... paid_dispensing_fee 0..1 integer Paid Dispensing Fee
... payer_plan_period_id 0..1 Reference(Payer Plan Period OMOP Table) Payer Plan Period
... amount_allowed 0..1 integer Amount Allowed
... revenue_code_concept_id 0..1 code Revenue Code
... revenue_code_source_value 0..1 string Revenue Code Source Value
... drg_concept_id 0..1 integer Diagnosis Related Groups
... drg_source_value 0..1 string Diagnosis Related Groups Source Value

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Cost 0..* Base Cost OMOP Table
Instances of this logical model are not marked to be the target of a Reference
... cost_id 1..1 code Cost Identifier
... cost_event_id 1..1 integer Cost Event Identifier
... cost_domain_id 1..1 string Cost Domain Identifier
... currency_concept_id 0..1 code Currency
... total_charge 0..1 integer Total Charge
... total_cost 0..1 integer Total Cost
... total_paid 0..1 integer Total Paid
... paid_by_payer 0..1 integer Paid by Payer
... paid_by_patient 0..1 integer Paid by Patient
... paid_patient_copay 0..1 integer Paid Patient Copay
... paid_patient_coinsurance 0..1 integer Paid Patient Coinsurance
... paid_patient_deductible 0..1 integer Paid Patient Deductible
... paid_by_primary 0..1 integer Paid by Primary
... paid_ingredient_cost 0..1 integer Paid Ingredent Cost
... paid_dispensing_fee 0..1 integer Paid Dispensing Fee
... payer_plan_period_id 0..1 Reference(Payer Plan Period OMOP Table) Payer Plan Period
... amount_allowed 0..1 integer Amount Allowed
... revenue_code_concept_id 0..1 code Revenue Code
... revenue_code_source_value 0..1 string Revenue Code Source Value
... drg_concept_id 0..1 integer Diagnosis Related Groups
... drg_source_value 0..1 string Diagnosis Related Groups Source Value

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(4 nested mandatory elements)

Structures

This structure refers to these other structures:

Maturity: 1

 

Other representations of profile: CSV, Excel