Package | hl7.fhir.uv.omop |
Type | StructureDefinition |
Id | DrugExposure |
FHIR Version | R5 |
Source | http://hl7.org/fhir/uv/omop/https://build.fhir.org/ig/HL7/fhir-omop-ig/StructureDefinition-DrugExposure.html |
URL | http://hl7.org/fhir/uv/omop/StructureDefinition/DrugExposure |
Version | 1.0.0-ballot |
Status | active |
Date | 2025-07-22T19:48:02+00:00 |
Name | DrugExposure |
Title | Drug Exposure OMOP Table |
Realm | uv |
Authority | hl7 |
Description | 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. |
Type | http://hl7.org/fhir/uv/omop/StructureDefinition/DrugExposure |
Kind | logical |
No resources found
StructureDefinition | |
Person | Person OMOP Table |
Provider | Provider OMOP Table |
VisitDetail | Visit Detail OMOP Table |
VisitOccurrence | Visit Occurrence OMOP Table |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition DrugExposure
{ "resourceType": "StructureDefinition", "id": "DrugExposure", "text": { "status": "extensions", "div": "<!-- snip (see above) -->" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics", "valueCode": "can-be-target" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "brr" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1, "_valueInteger": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop" } ] } }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "informative", "_valueCode": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop" } ] } } ], "url": "http://hl7.org/fhir/uv/omop/StructureDefinition/DrugExposure", "version": "1.0.0-ballot", "name": "DrugExposure", "title": "Drug Exposure OMOP Table", "status": "active", "date": "2025-07-22T19:48:02+00:00", "publisher": "HL7 International / Biomedical Research and Regulation", "contact": [ { "name": "HL7 International / Biomedical Research and Regulation", "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/rcrim" } ] } ], "description": "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.", "jurisdiction": [ { "coding": [ { "system": "http://unstats.un.org/unsd/methods/m49/m49.htm", "code": "001", "display": "World" } ] } ], "fhirVersion": "5.0.0", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "logical", "abstract": false, "type": "http://hl7.org/fhir/uv/omop/StructureDefinition/DrugExposure", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base", "derivation": "specialization", "snapshot": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString": "5.0.0" } ], "element": [ { "id": "DrugExposure", "path": "DrugExposure", "short": "Drug Exposure OMOP Table", "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.", "min": 0, "max": "*", "base": { "path": "Base", "min": 0, "max": "*" }, "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "DrugExposure.drug-exposure-id", "path": "DrugExposure.drug_exposure_id", "short": "Drug Exposure Identifier", "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.", "min": 1, "max": "1", "base": { "path": "DrugExposure.drug_exposure_id", "min": 1, "max": "1" }, "type": [ { "code": "integer" } ] }, { "id": "DrugExposure.person-id", "path": "DrugExposure.person_id", "short": "Person", "definition": "The PERSON_ID of the PERSON for whom the drug dispensing or administration is recorded. This may be a system generated code.", "min": 1, "max": "1", "base": { "path": "DrugExposure.person_id", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Person" ] } ] }, { "id": "DrugExposure.drug-concept-id", "path": "DrugExposure.drug_concept_id", "short": "Drug", "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.", "min": 1, "max": "1", "base": { "path": "DrugExposure.drug_concept_id", "min": 1, "max": "1" }, "type": [ { "code": "code" } ] }, { "id": "DrugExposure.drug-exposure-start-date", "path": "DrugExposure.drug_exposure_start_date", "short": "Drug Exposure Start Date", "definition": "Use this date to determine the start date of the drug record.", "min": 1, "max": "1", "base": { "path": "DrugExposure.drug_exposure_start_date", "min": 1, "max": "1" }, "type": [ { "code": "date" } ] }, { "id": "DrugExposure.drug-exposure-start-datetime", "path": "DrugExposure.drug_exposure_start_datetime", "short": "Drug Exposure Start Datetime", "definition": "Drug Exposure Start Datetime", "min": 0, "max": "1", "base": { "path": "DrugExposure.drug_exposure_start_datetime", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ] }, { "id": "DrugExposure.drug-exposure-end-date", "path": "DrugExposure.drug_exposure_end_date", "short": "Drug Exposure End Date", "definition": "The DRUG_EXPOSURE_END_DATE denotes the day the drug exposure ended for the patient.", "min": 1, "max": "1", "base": { "path": "DrugExposure.drug_exposure_end_date", "min": 1, "max": "1" }, "type": [ { "code": "date" } ] }, { "id": "DrugExposure.drug-exposure-end-datetime", "path": "DrugExposure.drug_exposure_end_datetime", "short": "Drug Exposure End Datetime", "definition": "Drug Exposure End Datetime", "min": 0, "max": "1", "base": { "path": "DrugExposure.drug_exposure_end_datetime", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ] }, { "id": "DrugExposure.verbatim-end-date", "path": "DrugExposure.verbatim_end_date", "short": "Verbatim End Date", "definition": "This is the end date of the drug exposure as it appears in the source data, if it is given", "min": 0, "max": "1", "base": { "path": "DrugExposure.verbatim_end_date", "min": 0, "max": "1" }, "type": [ { "code": "date" } ] }, { "id": "DrugExposure.drug-type-concept-id", "path": "DrugExposure.drug_type_concept_id", "short": "Drug Type", "definition": "You can use the TYPE_CONCEPT_ID to delineate between prescriptions written vs. prescriptions dispensed vs. medication history vs. patient-reported exposure, etc.", "min": 1, "max": "1", "base": { "path": "DrugExposure.drug_type_concept_id", "min": 1, "max": "1" }, "type": [ { "code": "code" } ] }, { "id": "DrugExposure.stop-reason", "path": "DrugExposure.stop_reason", "short": "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.", "min": 0, "max": "1", "base": { "path": "DrugExposure.stop_reason", "min": 0, "max": "1" }, "type": [ { "code": "string" } ] }, { "id": "DrugExposure.refills", "path": "DrugExposure.refills", "short": "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.", "min": 0, "max": "1", "base": { "path": "DrugExposure.refills", "min": 0, "max": "1" }, "type": [ { "code": "integer" } ] }, { "id": "DrugExposure.quantity", "path": "DrugExposure.quantity", "short": "Quantity", "definition": "Quantity", "min": 0, "max": "1", "base": { "path": "DrugExposure.quantity", "min": 0, "max": "1" }, "type": [ { "code": "decimal" } ] }, { "id": "DrugExposure.days-supply", "path": "DrugExposure.days_supply", "short": "Days Supply", "definition": "Days Supply", "min": 0, "max": "1", "base": { "path": "DrugExposure.days_supply", "min": 0, "max": "1" }, "type": [ { "code": "integer" } ] }, { "id": "DrugExposure.sig", "path": "DrugExposure.sig", "short": "Sig", "definition": "This is the verbatim instruction for the drug as written by the provider.", "min": 0, "max": "1", "base": { "path": "DrugExposure.sig", "min": 0, "max": "1" }, "type": [ { "code": "string" } ] }, { "id": "DrugExposure.route-concept-id", "path": "DrugExposure.route_concept_id", "short": "Route", "definition": "Route", "min": 0, "max": "1", "base": { "path": "DrugExposure.route_concept_id", "min": 0, "max": "1" }, "type": [ { "code": "code" } ] }, { "id": "DrugExposure.lot-number", "path": "DrugExposure.lot_number", "short": "Lot Number", "definition": "Lot Number", "min": 0, "max": "1", "base": { "path": "DrugExposure.lot_number", "min": 0, "max": "1" }, "type": [ { "code": "string" } ] }, { "id": "DrugExposure.provider-id", "path": "DrugExposure.provider_id", "short": "Provider", "definition": "The Provider associated with drug record, e.g. the provider who wrote the prescription or the provider who administered the drug.", "min": 0, "max": "1", "base": { "path": "DrugExposure.provider_id", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Provider" ] } ] }, { "id": "DrugExposure.visit-occurrence-id", "path": "DrugExposure.visit_occurrence_id", "short": "Visit Occurrence", "definition": "The Visit during which the drug was prescribed, administered or dispensed.", "min": 0, "max": "1", "base": { "path": "DrugExposure.visit_occurrence_id", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitOccurrence" ] } ] }, { "id": "DrugExposure.visit-detail-id", "path": "DrugExposure.visit_detail_id", "short": "Visit Detail", "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.", "min": 0, "max": "1", "base": { "path": "DrugExposure.visit_detail_id", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitDetail" ] } ] }, { "id": "DrugExposure.drug-source-value", "path": "DrugExposure.drug_source_value", "short": "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.", "min": 0, "max": "1", "base": { "path": "DrugExposure.drug_source_value", "min": 0, "max": "1" }, "type": [ { "code": "string" } ] }, { "id": "DrugExposure.drug-source-concept-id", "path": "DrugExposure.drug_source_concept_id", "short": "Drug Source Concept", "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.", "min": 0, "max": "1", "base": { "path": "DrugExposure.drug_source_concept_id", "min": 0, "max": "1" }, "type": [ { "code": "code" } ] }, { "id": "DrugExposure.route-source-value", "path": "DrugExposure.route_source_value", "short": "Route Source Value", "definition": "This field houses the verbatim value from the source data representing the drug route.", "min": 0, "max": "1", "base": { "path": "DrugExposure.route_source_value", "min": 0, "max": "1" }, "type": [ { "code": "string" } ] }, { "id": "DrugExposure.dose-unit-source-value", "path": "DrugExposure.dose_unit_source_value", "short": "Dose Unit Source Value", "definition": "This field houses the verbatim value from the source data representing the dose unit of the drug given.", "min": 0, "max": "1", "base": { "path": "DrugExposure.dose_unit_source_value", "min": 0, "max": "1" }, "type": [ { "code": "string" } ] } ] }, "differential": { "element": [ { "id": "DrugExposure", "path": "DrugExposure", "short": "Drug Exposure OMOP Table", "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." }, { "id": "DrugExposure.drug-exposure-id", "path": "DrugExposure.drug_exposure_id", "short": "Drug Exposure Identifier", "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.", "min": 1, "max": "1", "type": [ { "code": "integer" } ] }, { "id": "DrugExposure.person-id", "path": "DrugExposure.person_id", "short": "Person", "definition": "The PERSON_ID of the PERSON for whom the drug dispensing or administration is recorded. This may be a system generated code.", "min": 1, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Person" ] } ] }, { "id": "DrugExposure.drug-concept-id", "path": "DrugExposure.drug_concept_id", "short": "Drug", "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.", "min": 1, "max": "1", "type": [ { "code": "code" } ] }, { "id": "DrugExposure.drug-exposure-start-date", "path": "DrugExposure.drug_exposure_start_date", "short": "Drug Exposure Start Date", "definition": "Use this date to determine the start date of the drug record.", "min": 1, "max": "1", "type": [ { "code": "date" } ] }, { "id": "DrugExposure.drug-exposure-start-datetime", "path": "DrugExposure.drug_exposure_start_datetime", "short": "Drug Exposure Start Datetime", "definition": "Drug Exposure Start Datetime", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ] }, { "id": "DrugExposure.drug-exposure-end-date", "path": "DrugExposure.drug_exposure_end_date", "short": "Drug Exposure End Date", "definition": "The DRUG_EXPOSURE_END_DATE denotes the day the drug exposure ended for the patient.", "min": 1, "max": "1", "type": [ { "code": "date" } ] }, { "id": "DrugExposure.drug-exposure-end-datetime", "path": "DrugExposure.drug_exposure_end_datetime", "short": "Drug Exposure End Datetime", "definition": "Drug Exposure End Datetime", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ] }, { "id": "DrugExposure.verbatim-end-date", "path": "DrugExposure.verbatim_end_date", "short": "Verbatim End Date", "definition": "This is the end date of the drug exposure as it appears in the source data, if it is given", "min": 0, "max": "1", "type": [ { "code": "date" } ] }, { "id": "DrugExposure.drug-type-concept-id", "path": "DrugExposure.drug_type_concept_id", "short": "Drug Type", "definition": "You can use the TYPE_CONCEPT_ID to delineate between prescriptions written vs. prescriptions dispensed vs. medication history vs. patient-reported exposure, etc.", "min": 1, "max": "1", "type": [ { "code": "code" } ] }, { "id": "DrugExposure.stop-reason", "path": "DrugExposure.stop_reason", "short": "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.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "DrugExposure.refills", "path": "DrugExposure.refills", "short": "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.", "min": 0, "max": "1", "type": [ { "code": "integer" } ] }, { "id": "DrugExposure.quantity", "path": "DrugExposure.quantity", "short": "Quantity", "definition": "Quantity", "min": 0, "max": "1", "type": [ { "code": "decimal" } ] }, { "id": "DrugExposure.days-supply", "path": "DrugExposure.days_supply", "short": "Days Supply", "definition": "Days Supply", "min": 0, "max": "1", "type": [ { "code": "integer" } ] }, { "id": "DrugExposure.sig", "path": "DrugExposure.sig", "short": "Sig", "definition": "This is the verbatim instruction for the drug as written by the provider.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "DrugExposure.route-concept-id", "path": "DrugExposure.route_concept_id", "short": "Route", "definition": "Route", "min": 0, "max": "1", "type": [ { "code": "code" } ] }, { "id": "DrugExposure.lot-number", "path": "DrugExposure.lot_number", "short": "Lot Number", "definition": "Lot Number", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "DrugExposure.provider-id", "path": "DrugExposure.provider_id", "short": "Provider", "definition": "The Provider associated with drug record, e.g. the provider who wrote the prescription or the provider who administered the drug.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/Provider" ] } ] }, { "id": "DrugExposure.visit-occurrence-id", "path": "DrugExposure.visit_occurrence_id", "short": "Visit Occurrence", "definition": "The Visit during which the drug was prescribed, administered or dispensed.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitOccurrence" ] } ] }, { "id": "DrugExposure.visit-detail-id", "path": "DrugExposure.visit_detail_id", "short": "Visit Detail", "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.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/uv/omop/StructureDefinition/VisitDetail" ] } ] }, { "id": "DrugExposure.drug-source-value", "path": "DrugExposure.drug_source_value", "short": "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.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "DrugExposure.drug-source-concept-id", "path": "DrugExposure.drug_source_concept_id", "short": "Drug Source Concept", "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.", "min": 0, "max": "1", "type": [ { "code": "code" } ] }, { "id": "DrugExposure.route-source-value", "path": "DrugExposure.route_source_value", "short": "Route Source Value", "definition": "This field houses the verbatim value from the source data representing the drug route.", "min": 0, "max": "1", "type": [ { "code": "string" } ] }, { "id": "DrugExposure.dose-unit-source-value", "path": "DrugExposure.dose_unit_source_value", "short": "Dose Unit Source Value", "definition": "This field houses the verbatim value from the source data representing the dose unit of the drug given.", "min": 0, "max": "1", "type": [ { "code": "string" } ] } ] } }