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

Page standards status: Draft Maturity Level: 1

Definitions for the DeviceExposure logical model.

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

0. DeviceExposure
Definition

The Device domain captures information about a person's exposure to a foreign physical object or instrument which is used for diagnostic or therapeutic purposes through a mechanism beyond chemical action. Devices include implantable objects (e.g. pacemakers, stents, artificial joints), medical equipment and supplies (e.g. bandages, crutches, syringes), other instruments used in medical procedures (e.g. sutures, defibrillators) and material used in clinical care (e.g. adhesives, body material, dental material, surgical material).).

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

Device Exposure Identifier

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

The PERSON_ID of the PERSON for whom the condition is recorded.

ShortPerson
Control1..1
TypeReference(Person OMOP Table)
6. DeviceExposure.device-concept-id
Definition

The DEVICE_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 foreign object or instrument the person was exposed to.

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

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

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

Device Exposure Start Datetime

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

The DEVICE_EXPOSURE_END_DATE denotes the day the device exposure ended for the patient, if given.

ShortDevice Exposure End Date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. DeviceExposure.device-exposure-end-datetime
Definition

Device Exposure End Datetime

ShortDevice Exposure End Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. DeviceExposure.device-type-concept-id
Definition

You can use the TYPE_CONCEPT_ID to denote the provenance of the record, as in whether the record is from administrative claims or EHR.

ShortDevice Type Concept Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. DeviceExposure.unique-device-id
Definition

This is the Unique Device Identification (UDI-DI) number for devices regulated by the FDA, if given.

ShortUnique Device Identifier
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. DeviceExposure.production-id
Definition

This is the Production Identifier (UDI-PI) portion of the Unique Device Identification.

ShortProduction Identifier
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. DeviceExposure.quantity
Definition

Quantity

ShortQuantity
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. DeviceExposure.provider-id
Definition

The Provider associated with device record, e.g. the provider who wrote the prescription or the provider who implanted the device.

ShortProvider
Control0..1
TypeReference(Provider OMOP Table)
26. DeviceExposure.visit-occurrence-id
Definition

The Visit during which the device was prescribed or given.

ShortVisit Occurence Identifier
Control0..1
TypeReference(Visit Occurrence OMOP Table)
28. DeviceExposure.visit-detail-id
Definition

The Visit Detail during which the device was prescribed or given.

ShortVisit Detail Identifier
Control0..1
TypeReference(Visit Detail OMOP Table)
30. DeviceExposure.device-source-value
Definition

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

ShortDevice Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. DeviceExposure.device-source-concept-id
Definition

This is the concept representing the device 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 Device necessary for a given analytic use case. Consider using DEVICE_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network.

ShortDevice Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. DeviceExposure.unit-concept-id
Definition

UNIT_SOURCE_VALUES should be mapped to a Standard Concept in the Unit domain that best represents the unit as given in the source data.

ShortUnit
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. DeviceExposure.unit-source-value
Definition

This field houses the verbatim value from the source data representing the unit of the Device. For example, blood transfusions are considered devices and can be given in mL quantities.

ShortUnit Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. DeviceExposure.unit-source-concept-id
Definition

This is the concept representing the UNIT_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 Unit necessary for a given analytic use case. Consider using UNIT_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network.

ShortUnit Source
Control0..1
Typecode
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. DeviceExposure
Definition

The Device domain captures information about a person's exposure to a foreign physical object or instrument which is used for diagnostic or therapeutic purposes through a mechanism beyond chemical action. Devices include implantable objects (e.g. pacemakers, stents, artificial joints), medical equipment and supplies (e.g. bandages, crutches, syringes), other instruments used in medical procedures (e.g. sutures, defibrillators) and material used in clinical care (e.g. adhesives, body material, dental material, surgical material).).


Base definition for all types defined in FHIR type system.

ShortDevice 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. DeviceExposure.device-exposure-id
Definition

Device Exposure Identifier

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

The PERSON_ID of the PERSON for whom the condition is recorded.

ShortPerson
Control1..1
TypeReference(Person OMOP Table)
6. DeviceExposure.device-concept-id
Definition

The DEVICE_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 foreign object or instrument the person was exposed to.

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

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

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

Device Exposure Start Datetime

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

The DEVICE_EXPOSURE_END_DATE denotes the day the device exposure ended for the patient, if given.

ShortDevice Exposure End Date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. DeviceExposure.device-exposure-end-datetime
Definition

Device Exposure End Datetime

ShortDevice Exposure End Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. DeviceExposure.device-type-concept-id
Definition

You can use the TYPE_CONCEPT_ID to denote the provenance of the record, as in whether the record is from administrative claims or EHR.

ShortDevice Type Concept Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. DeviceExposure.unique-device-id
Definition

This is the Unique Device Identification (UDI-DI) number for devices regulated by the FDA, if given.

ShortUnique Device Identifier
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. DeviceExposure.production-id
Definition

This is the Production Identifier (UDI-PI) portion of the Unique Device Identification.

ShortProduction Identifier
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. DeviceExposure.quantity
Definition

Quantity

ShortQuantity
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. DeviceExposure.provider-id
Definition

The Provider associated with device record, e.g. the provider who wrote the prescription or the provider who implanted the device.

ShortProvider
Control0..1
TypeReference(Provider OMOP Table)
26. DeviceExposure.visit-occurrence-id
Definition

The Visit during which the device was prescribed or given.

ShortVisit Occurence Identifier
Control0..1
TypeReference(Visit Occurrence OMOP Table)
28. DeviceExposure.visit-detail-id
Definition

The Visit Detail during which the device was prescribed or given.

ShortVisit Detail Identifier
Control0..1
TypeReference(Visit Detail OMOP Table)
30. DeviceExposure.device-source-value
Definition

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

ShortDevice Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. DeviceExposure.device-source-concept-id
Definition

This is the concept representing the device 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 Device necessary for a given analytic use case. Consider using DEVICE_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network.

ShortDevice Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. DeviceExposure.unit-concept-id
Definition

UNIT_SOURCE_VALUES should be mapped to a Standard Concept in the Unit domain that best represents the unit as given in the source data.

ShortUnit
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. DeviceExposure.unit-source-value
Definition

This field houses the verbatim value from the source data representing the unit of the Device. For example, blood transfusions are considered devices and can be given in mL quantities.

ShortUnit Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. DeviceExposure.unit-source-concept-id
Definition

This is the concept representing the UNIT_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 Unit necessary for a given analytic use case. Consider using UNIT_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network.

ShortUnit Source
Control0..1
Typecode
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. DeviceExposure
Definition

The Device domain captures information about a person's exposure to a foreign physical object or instrument which is used for diagnostic or therapeutic purposes through a mechanism beyond chemical action. Devices include implantable objects (e.g. pacemakers, stents, artificial joints), medical equipment and supplies (e.g. bandages, crutches, syringes), other instruments used in medical procedures (e.g. sutures, defibrillators) and material used in clinical care (e.g. adhesives, body material, dental material, surgical material).).

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

Device Exposure Identifier

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

The PERSON_ID of the PERSON for whom the condition is recorded.

ShortPerson
Control1..1
TypeReference(Person OMOP Table)
6. DeviceExposure.device-concept-id
Definition

The DEVICE_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 foreign object or instrument the person was exposed to.

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

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

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

Device Exposure Start Datetime

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

The DEVICE_EXPOSURE_END_DATE denotes the day the device exposure ended for the patient, if given.

ShortDevice Exposure End Date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. DeviceExposure.device-exposure-end-datetime
Definition

Device Exposure End Datetime

ShortDevice Exposure End Datetime
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. DeviceExposure.device-type-concept-id
Definition

You can use the TYPE_CONCEPT_ID to denote the provenance of the record, as in whether the record is from administrative claims or EHR.

ShortDevice Type Concept Identifier
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. DeviceExposure.unique-device-id
Definition

This is the Unique Device Identification (UDI-DI) number for devices regulated by the FDA, if given.

ShortUnique Device Identifier
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. DeviceExposure.production-id
Definition

This is the Production Identifier (UDI-PI) portion of the Unique Device Identification.

ShortProduction Identifier
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. DeviceExposure.quantity
Definition

Quantity

ShortQuantity
Control0..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. DeviceExposure.provider-id
Definition

The Provider associated with device record, e.g. the provider who wrote the prescription or the provider who implanted the device.

ShortProvider
Control0..1
TypeReference(Provider OMOP Table)
26. DeviceExposure.visit-occurrence-id
Definition

The Visit during which the device was prescribed or given.

ShortVisit Occurence Identifier
Control0..1
TypeReference(Visit Occurrence OMOP Table)
28. DeviceExposure.visit-detail-id
Definition

The Visit Detail during which the device was prescribed or given.

ShortVisit Detail Identifier
Control0..1
TypeReference(Visit Detail OMOP Table)
30. DeviceExposure.device-source-value
Definition

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

ShortDevice Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. DeviceExposure.device-source-concept-id
Definition

This is the concept representing the device 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 Device necessary for a given analytic use case. Consider using DEVICE_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network.

ShortDevice Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. DeviceExposure.unit-concept-id
Definition

UNIT_SOURCE_VALUES should be mapped to a Standard Concept in the Unit domain that best represents the unit as given in the source data.

ShortUnit
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. DeviceExposure.unit-source-value
Definition

This field houses the verbatim value from the source data representing the unit of the Device. For example, blood transfusions are considered devices and can be given in mL quantities.

ShortUnit Source Value
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. DeviceExposure.unit-source-concept-id
Definition

This is the concept representing the UNIT_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 Unit necessary for a given analytic use case. Consider using UNIT_CONCEPT_ID instead to enable standardized analytics that can be consistent across the network.

ShortUnit Source
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension