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

Page standards status: Draft Maturity Level: 1

Definitions for the DrugExposure logical model.

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

0. DrugExposure
Definition

This table captures records about the exposure to a Drug ingested or otherwise introduced into the body. A Drug is a biochemical substance formulated in such a way that when administered to a Person it will exert a certain biochemical effect on the metabolism. Drugs include prescription and over-the-counter medicines, vaccines, and large-molecule biologic therapies. Radiological devices ingested or applied locally do not count as Drugs.

ShortDrug Exposure OMOP Table
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. DrugExposure.drug-exposure-id
Definition

The unique key given to records of drug dispensings or administrations for a person. Refer to the ETL for how duplicate drugs during the same visit were handled.

ShortDrug Exposure Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. DrugExposure.person-id
Definition

The PERSON_ID of the PERSON for whom the drug dispensing or administration is recorded. This may be a system generated code.

ShortPerson
Control1..1
TypeReference(Person OMOP Table)
6. DrugExposure.drug-concept-id
Definition

The DRUG_CONCEPT_ID field is recommended for primary use in analyses, and must be used for network studies. This is the standard concept mapped from the source concept id which represents a drug product or molecule otherwise introduced to the body. The drug concepts can have a varying degree of information about drug strength and dose. This information is relevant in the context of quantity and administration information in the subsequent fields plus strength information from the DRUG_STRENGTH table, provided as part of the standard vocabulary download.

ShortDrug
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. DrugExposure.drug-exposure-start-date
Definition

Use this date to determine the start date of the drug record.

ShortDrug Exposure Start Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. DrugExposure.drug-exposure-start-datetime
Definition

Drug Exposure Start Datetime

ShortDrug Exposure Start Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. DrugExposure.drug-exposure-end-date
Definition

The DRUG_EXPOSURE_END_DATE denotes the day the drug exposure ended for the patient.

ShortDrug Exposure End Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. DrugExposure.drug-exposure-end-datetime
Definition

Drug Exposure End Datetime

ShortDrug Exposure End Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. DrugExposure.verbatim-end-date
Definition

This is the end date of the drug exposure as it appears in the source data, if it is given

ShortVerbatim End Date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. DrugExposure.drug-type-concept-id
Definition

You can use the TYPE_CONCEPT_ID to delineate between prescriptions written vs. prescriptions dispensed vs. medication history vs. patient-reported exposure, etc.

ShortDrug Type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. DrugExposure.stop-reason
Definition

The reason a person stopped a medication as it is represented in the source. Reasons include regimen completed, changed, removed, etc. This field will be retired in v6.0.

ShortStop Reason
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. DrugExposure.refills
Definition

This is only filled in when the record is coming from a prescription written this field is meant to represent intended refills at time of the prescription.

ShortRefills
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. DrugExposure.quantity
Definition

Quantity

ShortQuantity
Control0..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. DrugExposure.days-supply
Definition

Days Supply

ShortDays Supply
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. DrugExposure.sig
Definition

This is the verbatim instruction for the drug as written by the provider.

ShortSig
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. DrugExposure.route-concept-id
Definition

Route

ShortRoute
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. DrugExposure.lot-number
Definition

Lot Number

ShortLot Number
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. DrugExposure.provider-id
Definition

The Provider associated with drug record, e.g. the provider who wrote the prescription or the provider who administered the drug.

ShortProvider
Control0..1
TypeReference(Provider OMOP Table)
36. DrugExposure.visit-occurrence-id
Definition

The Visit during which the drug was prescribed, administered or dispensed.

ShortVisit Occurrence
Control0..1
TypeReference(Visit Occurrence OMOP Table)
38. DrugExposure.visit-detail-id
Definition

The VISIT_DETAIL record during which the drug exposure occurred. For example, if the person was in the ICU at the time of the drug administration the VISIT_OCCURRENCE record would reflect the overall hospital stay and the VISIT_DETAIL record would reflect the ICU stay during the hospital visit.

ShortVisit Detail
Control0..1
TypeReference(Visit Detail OMOP Table)
40. DrugExposure.drug-source-value
Definition

This field houses the verbatim value from the source data representing the drug exposure that occurred. For example, this could be an NDC or Gemscript code.

ShortDrug Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. DrugExposure.drug-source-concept-id
Definition

This is the concept representing the drug source value and may not necessarily be standard. This field is discouraged from use in analysis because it is not required to contain Standard Concepts that are used across the OHDSI community, and should only be used when Standard Concepts do not adequately represent the source detail for the Drug necessary for a given analytic use case. Consider using DRUG_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network.

ShortDrug Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. DrugExposure.route-source-value
Definition

This field houses the verbatim value from the source data representing the drug route.

ShortRoute Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. DrugExposure.dose-unit-source-value
Definition

This field houses the verbatim value from the source data representing the dose unit of the drug given.

ShortDose Unit 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. DrugExposure
Definition

This table captures records about the exposure to a Drug ingested or otherwise introduced into the body. A Drug is a biochemical substance formulated in such a way that when administered to a Person it will exert a certain biochemical effect on the metabolism. Drugs include prescription and over-the-counter medicines, vaccines, and large-molecule biologic therapies. Radiological devices ingested or applied locally do not count as Drugs.


Base definition for all types defined in FHIR type system.

ShortDrug Exposure 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. DrugExposure.drug-exposure-id
Definition

The unique key given to records of drug dispensings or administrations for a person. Refer to the ETL for how duplicate drugs during the same visit were handled.

ShortDrug Exposure Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. DrugExposure.person-id
Definition

The PERSON_ID of the PERSON for whom the drug dispensing or administration is recorded. This may be a system generated code.

ShortPerson
Control1..1
TypeReference(Person OMOP Table)
6. DrugExposure.drug-concept-id
Definition

The DRUG_CONCEPT_ID field is recommended for primary use in analyses, and must be used for network studies. This is the standard concept mapped from the source concept id which represents a drug product or molecule otherwise introduced to the body. The drug concepts can have a varying degree of information about drug strength and dose. This information is relevant in the context of quantity and administration information in the subsequent fields plus strength information from the DRUG_STRENGTH table, provided as part of the standard vocabulary download.

ShortDrug
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. DrugExposure.drug-exposure-start-date
Definition

Use this date to determine the start date of the drug record.

ShortDrug Exposure Start Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. DrugExposure.drug-exposure-start-datetime
Definition

Drug Exposure Start Datetime

ShortDrug Exposure Start Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. DrugExposure.drug-exposure-end-date
Definition

The DRUG_EXPOSURE_END_DATE denotes the day the drug exposure ended for the patient.

ShortDrug Exposure End Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. DrugExposure.drug-exposure-end-datetime
Definition

Drug Exposure End Datetime

ShortDrug Exposure End Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. DrugExposure.verbatim-end-date
Definition

This is the end date of the drug exposure as it appears in the source data, if it is given

ShortVerbatim End Date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. DrugExposure.drug-type-concept-id
Definition

You can use the TYPE_CONCEPT_ID to delineate between prescriptions written vs. prescriptions dispensed vs. medication history vs. patient-reported exposure, etc.

ShortDrug Type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. DrugExposure.stop-reason
Definition

The reason a person stopped a medication as it is represented in the source. Reasons include regimen completed, changed, removed, etc. This field will be retired in v6.0.

ShortStop Reason
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. DrugExposure.refills
Definition

This is only filled in when the record is coming from a prescription written this field is meant to represent intended refills at time of the prescription.

ShortRefills
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. DrugExposure.quantity
Definition

Quantity

ShortQuantity
Control0..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. DrugExposure.days-supply
Definition

Days Supply

ShortDays Supply
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. DrugExposure.sig
Definition

This is the verbatim instruction for the drug as written by the provider.

ShortSig
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. DrugExposure.route-concept-id
Definition

Route

ShortRoute
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. DrugExposure.lot-number
Definition

Lot Number

ShortLot Number
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. DrugExposure.provider-id
Definition

The Provider associated with drug record, e.g. the provider who wrote the prescription or the provider who administered the drug.

ShortProvider
Control0..1
TypeReference(Provider OMOP Table)
36. DrugExposure.visit-occurrence-id
Definition

The Visit during which the drug was prescribed, administered or dispensed.

ShortVisit Occurrence
Control0..1
TypeReference(Visit Occurrence OMOP Table)
38. DrugExposure.visit-detail-id
Definition

The VISIT_DETAIL record during which the drug exposure occurred. For example, if the person was in the ICU at the time of the drug administration the VISIT_OCCURRENCE record would reflect the overall hospital stay and the VISIT_DETAIL record would reflect the ICU stay during the hospital visit.

ShortVisit Detail
Control0..1
TypeReference(Visit Detail OMOP Table)
40. DrugExposure.drug-source-value
Definition

This field houses the verbatim value from the source data representing the drug exposure that occurred. For example, this could be an NDC or Gemscript code.

ShortDrug Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. DrugExposure.drug-source-concept-id
Definition

This is the concept representing the drug source value and may not necessarily be standard. This field is discouraged from use in analysis because it is not required to contain Standard Concepts that are used across the OHDSI community, and should only be used when Standard Concepts do not adequately represent the source detail for the Drug necessary for a given analytic use case. Consider using DRUG_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network.

ShortDrug Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. DrugExposure.route-source-value
Definition

This field houses the verbatim value from the source data representing the drug route.

ShortRoute Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. DrugExposure.dose-unit-source-value
Definition

This field houses the verbatim value from the source data representing the dose unit of the drug given.

ShortDose Unit 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. DrugExposure
Definition

This table captures records about the exposure to a Drug ingested or otherwise introduced into the body. A Drug is a biochemical substance formulated in such a way that when administered to a Person it will exert a certain biochemical effect on the metabolism. Drugs include prescription and over-the-counter medicines, vaccines, and large-molecule biologic therapies. Radiological devices ingested or applied locally do not count as Drugs.

ShortDrug Exposure OMOP Table
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. DrugExposure.drug-exposure-id
Definition

The unique key given to records of drug dispensings or administrations for a person. Refer to the ETL for how duplicate drugs during the same visit were handled.

ShortDrug Exposure Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. DrugExposure.person-id
Definition

The PERSON_ID of the PERSON for whom the drug dispensing or administration is recorded. This may be a system generated code.

ShortPerson
Control1..1
TypeReference(Person OMOP Table)
6. DrugExposure.drug-concept-id
Definition

The DRUG_CONCEPT_ID field is recommended for primary use in analyses, and must be used for network studies. This is the standard concept mapped from the source concept id which represents a drug product or molecule otherwise introduced to the body. The drug concepts can have a varying degree of information about drug strength and dose. This information is relevant in the context of quantity and administration information in the subsequent fields plus strength information from the DRUG_STRENGTH table, provided as part of the standard vocabulary download.

ShortDrug
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. DrugExposure.drug-exposure-start-date
Definition

Use this date to determine the start date of the drug record.

ShortDrug Exposure Start Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. DrugExposure.drug-exposure-start-datetime
Definition

Drug Exposure Start Datetime

ShortDrug Exposure Start Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. DrugExposure.drug-exposure-end-date
Definition

The DRUG_EXPOSURE_END_DATE denotes the day the drug exposure ended for the patient.

ShortDrug Exposure End Date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. DrugExposure.drug-exposure-end-datetime
Definition

Drug Exposure End Datetime

ShortDrug Exposure End Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. DrugExposure.verbatim-end-date
Definition

This is the end date of the drug exposure as it appears in the source data, if it is given

ShortVerbatim End Date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. DrugExposure.drug-type-concept-id
Definition

You can use the TYPE_CONCEPT_ID to delineate between prescriptions written vs. prescriptions dispensed vs. medication history vs. patient-reported exposure, etc.

ShortDrug Type
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. DrugExposure.stop-reason
Definition

The reason a person stopped a medication as it is represented in the source. Reasons include regimen completed, changed, removed, etc. This field will be retired in v6.0.

ShortStop Reason
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. DrugExposure.refills
Definition

This is only filled in when the record is coming from a prescription written this field is meant to represent intended refills at time of the prescription.

ShortRefills
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. DrugExposure.quantity
Definition

Quantity

ShortQuantity
Control0..1
Typedecimal
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. DrugExposure.days-supply
Definition

Days Supply

ShortDays Supply
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. DrugExposure.sig
Definition

This is the verbatim instruction for the drug as written by the provider.

ShortSig
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. DrugExposure.route-concept-id
Definition

Route

ShortRoute
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. DrugExposure.lot-number
Definition

Lot Number

ShortLot Number
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. DrugExposure.provider-id
Definition

The Provider associated with drug record, e.g. the provider who wrote the prescription or the provider who administered the drug.

ShortProvider
Control0..1
TypeReference(Provider OMOP Table)
36. DrugExposure.visit-occurrence-id
Definition

The Visit during which the drug was prescribed, administered or dispensed.

ShortVisit Occurrence
Control0..1
TypeReference(Visit Occurrence OMOP Table)
38. DrugExposure.visit-detail-id
Definition

The VISIT_DETAIL record during which the drug exposure occurred. For example, if the person was in the ICU at the time of the drug administration the VISIT_OCCURRENCE record would reflect the overall hospital stay and the VISIT_DETAIL record would reflect the ICU stay during the hospital visit.

ShortVisit Detail
Control0..1
TypeReference(Visit Detail OMOP Table)
40. DrugExposure.drug-source-value
Definition

This field houses the verbatim value from the source data representing the drug exposure that occurred. For example, this could be an NDC or Gemscript code.

ShortDrug Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. DrugExposure.drug-source-concept-id
Definition

This is the concept representing the drug source value and may not necessarily be standard. This field is discouraged from use in analysis because it is not required to contain Standard Concepts that are used across the OHDSI community, and should only be used when Standard Concepts do not adequately represent the source detail for the Drug necessary for a given analytic use case. Consider using DRUG_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network.

ShortDrug Source Concept
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. DrugExposure.route-source-value
Definition

This field houses the verbatim value from the source data representing the drug route.

ShortRoute Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. DrugExposure.dose-unit-source-value
Definition

This field houses the verbatim value from the source data representing the dose unit of the drug given.

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