# Cost OMOP Table - Data Management with FHIR v0.1.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **Cost OMOP Table**

## Logical Model: Cost OMOP Table 

| | |
| :--- | :--- |
| *Official URL*:https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPCost | *Version*:0.1.0 |
| Draft as of 2025-10-23 | *Computable Name*:OMOPCost |

 
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. 

**Usages:**

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

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/aphp.fhir.fr.dm|current/StructureDefinition/OMOPCost)

### Formal Views of Profile Content

 [Description of Profiles, Differentials, Snapshots and how the different presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-OMOPCost.csv), [Excel](StructureDefinition-OMOPCost.xlsx) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "OMOPCost",
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode" : "can-be-target"
    }
  ],
  "url" : "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPCost",
  "version" : "0.1.0",
  "name" : "OMOPCost",
  "title" : "Cost OMOP Table",
  "status" : "draft",
  "date" : "2025-10-23T20:49:03+00:00",
  "publisher" : "AP-HP",
  "contact" : [
    {
      "name" : "AP-HP",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://aphp.fr"
        }
      ]
    }
  ],
  "description" : "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.\n\nEach 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.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "FR",
          "display" : "France"
        }
      ]
    }
  ],
  "fhirVersion" : "4.0.1",
  "kind" : "logical",
  "abstract" : false,
  "type" : "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPCost",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation" : "specialization",
  "differential" : {
    "element" : [
      {
        "id" : "OMOPCost",
        "path" : "OMOPCost",
        "short" : "Cost OMOP Table",
        "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.\n\nEach 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."
      },
      {
        "id" : "OMOPCost.cost-id",
        "path" : "OMOPCost.cost_id",
        "short" : "Cost Identifier",
        "definition" : "Cost Identifier",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPCost.cost-event-id",
        "path" : "OMOPCost.cost_event_id",
        "short" : "Cost Event Identifier",
        "definition" : "Cost Event Identifier",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPCost.cost-domain-id",
        "path" : "OMOPCost.cost_domain_id",
        "short" : "Cost Domain Identifier",
        "definition" : "Cost Domain Identifier",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "OMOPCost.cost-type-concept-id",
        "path" : "OMOPCost.cost_type_concept_id",
        "short" : "Cost Type",
        "definition" : "Cost Type",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPConcept"
            ]
          }
        ]
      },
      {
        "id" : "OMOPCost.currency-concept-id",
        "path" : "OMOPCost.currency_concept_id",
        "short" : "Currency",
        "definition" : "Currency",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPConcept"
            ]
          }
        ]
      },
      {
        "id" : "OMOPCost.total-charge",
        "path" : "OMOPCost.total_charge",
        "short" : "Total Charge",
        "definition" : "Total Charge",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPCost.total-cost",
        "path" : "OMOPCost.total_cost",
        "short" : "Total Cost",
        "definition" : "Total Cost",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPCost.total-paid",
        "path" : "OMOPCost.total_paid",
        "short" : "Total Paid",
        "definition" : "Total Paid",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPCost.paid-by-payer",
        "path" : "OMOPCost.paid_by_payer",
        "short" : "Paid by Payer",
        "definition" : "Paid by Payer",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPCost.paid-by-patient",
        "path" : "OMOPCost.paid_by_patient",
        "short" : "Paid by Patient",
        "definition" : "Paid by Patient",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPCost.paid-patient-copay",
        "path" : "OMOPCost.paid_patient_copay",
        "short" : "Paid Patient Copay",
        "definition" : "Paid Patient Copay",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPCost.paid-patient-coinsurance",
        "path" : "OMOPCost.paid_patient_coinsurance",
        "short" : "Paid Patient Coinsurance",
        "definition" : "Paid Patient Coinsurance",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPCost.paid-patient-deductible",
        "path" : "OMOPCost.paid_patient_deductible",
        "short" : "Paid Patient Deductible",
        "definition" : "Paid Patient Deductible",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPCost.paid-by-primary",
        "path" : "OMOPCost.paid_by_primary",
        "short" : "Paid by Primary",
        "definition" : "Paid by Primary",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPCost.paid-ingredient-cost",
        "path" : "OMOPCost.paid_ingredient_cost",
        "short" : "Paid Ingredent Cost",
        "definition" : "Paid Ingredent Cost",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPCost.paid-dispensing-fee",
        "path" : "OMOPCost.paid_dispensing_fee",
        "short" : "Paid Dispensing Fee",
        "definition" : "Paid Dispensing Fee",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPCost.payer-plan-period-id",
        "path" : "OMOPCost.payer_plan_period_id",
        "short" : "Payer Plan Period",
        "definition" : "Payer Plan Period",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPPayerPlanPeriod"
            ]
          }
        ]
      },
      {
        "id" : "OMOPCost.amount-allowed",
        "path" : "OMOPCost.amount_allowed",
        "short" : "Amount Allowed",
        "definition" : "Amount Allowed",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPCost.revenue-code-concept-id",
        "path" : "OMOPCost.revenue_code_concept_id",
        "short" : "Revenue Code",
        "definition" : "Revenue Code",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Reference",
            "targetProfile" : [
              "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPConcept"
            ]
          }
        ]
      },
      {
        "id" : "OMOPCost.revenue-code-source-value",
        "path" : "OMOPCost.revenue_code_source_value",
        "short" : "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.",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "OMOPCost.drg-concept-id",
        "path" : "OMOPCost.drg_concept_id",
        "short" : "Diagnosis Related Groups",
        "definition" : "Diagnosis Related Groups",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "integer"
          }
        ]
      },
      {
        "id" : "OMOPCost.drg-source-value",
        "path" : "OMOPCost.drg_source_value",
        "short" : "Diagnosis Related Groups Source Value",
        "definition" : "Diagnosis Related Groups are US codes used to classify hospital cases into one of approximately 500 groups.",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "string"
          }
        ]
      }
    ]
  }
}

```
