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 - Detailed Descriptions

Page standards status: Draft Maturity Level: 1

Definitions for the Cost logical model.

Guidance on how to interpret the contents of this table can be found here

0. Cost
Definition

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.

ShortCost OMOP Table
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Cost.cost-id
Definition

Cost Identifier

ShortCost Identifier
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. Cost.cost-event-id
Definition

Cost Event Identifier

ShortCost Event Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. Cost.cost-domain-id
Definition

Cost Domain Identifier

ShortCost Domain Identifier
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. Cost.cost-type-concept-id
Definition

Cost Type

ShortCost Type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. Cost.currency-concept-id
Definition

Currency

ShortCurrency
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. Cost.total-charge
Definition

Total Charge

ShortTotal Charge
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. Cost.total-cost
Definition

Total Cost

ShortTotal Cost
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. Cost.total-paid
Definition

Total Paid

ShortTotal Paid
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. Cost.paid-by-payer
Definition

Paid by Payer

ShortPaid by Payer
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. Cost.paid-by-patient
Definition

Paid by Patient

ShortPaid by Patient
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. Cost.paid-patient-copay
Definition

Paid Patient Copay

ShortPaid Patient Copay
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. Cost.paid-patient-coinsurance
Definition

Paid Patient Coinsurance

ShortPaid Patient Coinsurance
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. Cost.paid-patient-deductible
Definition

Paid Patient Deductible

ShortPaid Patient Deductible
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. Cost.paid-by-primary
Definition

Paid by Primary

ShortPaid by Primary
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. Cost.paid-ingredient-cost
Definition

Paid Ingredent Cost

ShortPaid Ingredent Cost
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. Cost.paid-dispensing-fee
Definition

Paid Dispensing Fee

ShortPaid Dispensing Fee
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. Cost.payer-plan-period-id
Definition

Payer Plan Period

ShortPayer Plan Period
Control0..1
TypeReference(Payer Plan Period OMOP Table)
36. Cost.amount-allowed
Definition

Amount Allowed

ShortAmount Allowed
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. Cost.revenue-code-concept-id
Definition

Revenue Code

ShortRevenue Code
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. Cost.revenue-code-source-value
Definition

Revenue codes are a method to charge for a class of procedures and conditions in the U.S. hospital system.

ShortRevenue Code Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. Cost.drg-concept-id
Definition

Diagnosis Related Groups

ShortDiagnosis Related Groups
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. Cost.drg-source-value
Definition

Diagnosis Related Groups are US codes used to classify hospital cases into one of approximately 500 groups.

ShortDiagnosis Related Groups Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. Cost
Definition

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.


Base definition for all types defined in FHIR type system.

ShortCost OMOP TableBase for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Cost.cost-id
Definition

Cost Identifier

ShortCost Identifier
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. Cost.cost-event-id
Definition

Cost Event Identifier

ShortCost Event Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. Cost.cost-domain-id
Definition

Cost Domain Identifier

ShortCost Domain Identifier
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. Cost.cost-type-concept-id
Definition

Cost Type

ShortCost Type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. Cost.currency-concept-id
Definition

Currency

ShortCurrency
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. Cost.total-charge
Definition

Total Charge

ShortTotal Charge
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. Cost.total-cost
Definition

Total Cost

ShortTotal Cost
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. Cost.total-paid
Definition

Total Paid

ShortTotal Paid
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. Cost.paid-by-payer
Definition

Paid by Payer

ShortPaid by Payer
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. Cost.paid-by-patient
Definition

Paid by Patient

ShortPaid by Patient
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. Cost.paid-patient-copay
Definition

Paid Patient Copay

ShortPaid Patient Copay
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. Cost.paid-patient-coinsurance
Definition

Paid Patient Coinsurance

ShortPaid Patient Coinsurance
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. Cost.paid-patient-deductible
Definition

Paid Patient Deductible

ShortPaid Patient Deductible
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. Cost.paid-by-primary
Definition

Paid by Primary

ShortPaid by Primary
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. Cost.paid-ingredient-cost
Definition

Paid Ingredent Cost

ShortPaid Ingredent Cost
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. Cost.paid-dispensing-fee
Definition

Paid Dispensing Fee

ShortPaid Dispensing Fee
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. Cost.payer-plan-period-id
Definition

Payer Plan Period

ShortPayer Plan Period
Control0..1
TypeReference(Payer Plan Period OMOP Table)
36. Cost.amount-allowed
Definition

Amount Allowed

ShortAmount Allowed
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. Cost.revenue-code-concept-id
Definition

Revenue Code

ShortRevenue Code
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. Cost.revenue-code-source-value
Definition

Revenue codes are a method to charge for a class of procedures and conditions in the U.S. hospital system.

ShortRevenue Code Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. Cost.drg-concept-id
Definition

Diagnosis Related Groups

ShortDiagnosis Related Groups
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. Cost.drg-source-value
Definition

Diagnosis Related Groups are US codes used to classify hospital cases into one of approximately 500 groups.

ShortDiagnosis Related Groups Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. Cost
Definition

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.

ShortCost OMOP Table
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Cost.cost-id
Definition

Cost Identifier

ShortCost Identifier
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. Cost.cost-event-id
Definition

Cost Event Identifier

ShortCost Event Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. Cost.cost-domain-id
Definition

Cost Domain Identifier

ShortCost Domain Identifier
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. Cost.cost-type-concept-id
Definition

Cost Type

ShortCost Type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. Cost.currency-concept-id
Definition

Currency

ShortCurrency
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. Cost.total-charge
Definition

Total Charge

ShortTotal Charge
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. Cost.total-cost
Definition

Total Cost

ShortTotal Cost
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. Cost.total-paid
Definition

Total Paid

ShortTotal Paid
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. Cost.paid-by-payer
Definition

Paid by Payer

ShortPaid by Payer
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. Cost.paid-by-patient
Definition

Paid by Patient

ShortPaid by Patient
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. Cost.paid-patient-copay
Definition

Paid Patient Copay

ShortPaid Patient Copay
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. Cost.paid-patient-coinsurance
Definition

Paid Patient Coinsurance

ShortPaid Patient Coinsurance
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. Cost.paid-patient-deductible
Definition

Paid Patient Deductible

ShortPaid Patient Deductible
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. Cost.paid-by-primary
Definition

Paid by Primary

ShortPaid by Primary
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. Cost.paid-ingredient-cost
Definition

Paid Ingredent Cost

ShortPaid Ingredent Cost
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. Cost.paid-dispensing-fee
Definition

Paid Dispensing Fee

ShortPaid Dispensing Fee
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. Cost.payer-plan-period-id
Definition

Payer Plan Period

ShortPayer Plan Period
Control0..1
TypeReference(Payer Plan Period OMOP Table)
36. Cost.amount-allowed
Definition

Amount Allowed

ShortAmount Allowed
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. Cost.revenue-code-concept-id
Definition

Revenue Code

ShortRevenue Code
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. Cost.revenue-code-source-value
Definition

Revenue codes are a method to charge for a class of procedures and conditions in the U.S. hospital system.

ShortRevenue Code Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. Cost.drg-concept-id
Definition

Diagnosis Related Groups

ShortDiagnosis Related Groups
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. Cost.drg-source-value
Definition

Diagnosis Related Groups are US codes used to classify hospital cases into one of approximately 500 groups.

ShortDiagnosis Related Groups Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension