Class: DrugExposure

name: DrugExposure
description: DrugExposures are records of a Person suggesting exposure to a medication.
  The source could be prescription, dispensing, medication administration records
  (MARs), or patient medication list.
from_schema: https://w3id.org/nhlbidatastage/bdchm
is_a: Exposure
attributes:
  drug_concept:
    name: drug_concept
    description: The coded value for a drug. From RxNorm. The syntax for the enum
      may need work.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    domain_of:
    - DrugExposure
    range: DrugExposureConceptEnum
  exposure_provenance:
    name: exposure_provenance
    description: A value representing the provenance of the DrugExposure record. From
      OMOP Drug Types.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    domain_of:
    - DrugExposure
    - DeviceExposure
    range: DrugExposureProvenanceEnum
  refills:
    name: refills
    description: Intended refills at time of the prescription.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    domain_of:
    - DrugExposure
    range: integer
    required: false
  quantity:
    name: quantity
    description: To find the dose form of a drug the RELATIONSHIP table can be used
      where the relationship_id is ‘Has dose form’. If liquid, quantity stands for
      the total amount dispensed or ordered of ingredient in the units given by the
      drug_strength table. If the unit from the source data does not align with the
      unit in the DRUG_STRENGTH table the quantity should be converted to the correct
      unit given in DRUG_STRENGTH. For clinical drugs with fixed dose forms (tablets
      etc.) the quantity is the number of units/tablets/capsules prescribed or dispensed
      (can be partial, but then only 1/2 or 1/3, not 0.01). Clinical drugs with divisible
      dose forms (injections) the quantity is the amount of ingredient the patient
      got. For example, if the injection is 2mg/mL but the patient got 80mL then quantity
      is reported as 160. Quantified clinical drugs with divisible dose forms (prefilled
      syringes), the quantity is the amount of ingredient similar to clinical drugs.
      Please see [how to calculate drug dose](https://ohdsi.github.io/CommonDataModel/drug_dose.html)
      for more information.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    domain_of:
    - Procedure
    - DrugExposure
    - DeviceExposure
    range: float
    required: false
  days_supply:
    name: days_supply
    description: The number of days of supply of the medication as recorded in the
      original prescription or dispensing record. Days supply can differ from actual
      drug duration (i.e. prescribed days supply vs actual exposure).
    comments:
    - The field should be left empty if the source data does not contain a verbatim
      days_supply, and should not be calculated from other fields.  Negative values
      are not allowed. If the source has negative days supply the record should be
      dropped as it is unknown if the patient actually took the drug. Several actions
      are possible -- record is not trustworthy and we remove the record entirely;
      we trust the record and leave days_supply empty; or record needs to be combined
      with other record (e.g. reversal of prescription). High values (>365 days) should
      be investigated. If considered an error in the source data (e.g. typo), the
      value needs to be excluded to prevent creation of unrealistic long eras.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    domain_of:
    - DrugExposure
    range: integer
    required: false
  sig:
    name: sig
    description: This is the verbatim instruction for the drug as written by the provider.
    comments:
    - Put the written out instructions for the drug as it is verbatim in the source,
      if available.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    domain_of:
    - DrugExposure
    range: string
    required: false
  route_concept:
    name: route_concept
    description: Route of drug administration.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    domain_of:
    - DrugExposure
    range: DrugRouteEnum

name: DrugExposure
description: DrugExposures are records of a Person suggesting exposure to a medication.
  The source could be prescription, dispensing, medication administration records
  (MARs), or patient medication list.
from_schema: https://w3id.org/nhlbidatastage/bdchm
is_a: Exposure
attributes:
  drug_concept:
    name: drug_concept
    description: The coded value for a drug. From RxNorm. The syntax for the enum
      may need work.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    alias: drug_concept
    owner: DrugExposure
    domain_of:
    - DrugExposure
    range: DrugExposureConceptEnum
  exposure_provenance:
    name: exposure_provenance
    description: A value representing the provenance of the DrugExposure record. From
      OMOP Drug Types.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    alias: exposure_provenance
    owner: DrugExposure
    domain_of:
    - DrugExposure
    - DeviceExposure
    range: DrugExposureProvenanceEnum
  refills:
    name: refills
    description: Intended refills at time of the prescription.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    alias: refills
    owner: DrugExposure
    domain_of:
    - DrugExposure
    range: integer
    required: false
  quantity:
    name: quantity
    description: To find the dose form of a drug the RELATIONSHIP table can be used
      where the relationship_id is ‘Has dose form’. If liquid, quantity stands for
      the total amount dispensed or ordered of ingredient in the units given by the
      drug_strength table. If the unit from the source data does not align with the
      unit in the DRUG_STRENGTH table the quantity should be converted to the correct
      unit given in DRUG_STRENGTH. For clinical drugs with fixed dose forms (tablets
      etc.) the quantity is the number of units/tablets/capsules prescribed or dispensed
      (can be partial, but then only 1/2 or 1/3, not 0.01). Clinical drugs with divisible
      dose forms (injections) the quantity is the amount of ingredient the patient
      got. For example, if the injection is 2mg/mL but the patient got 80mL then quantity
      is reported as 160. Quantified clinical drugs with divisible dose forms (prefilled
      syringes), the quantity is the amount of ingredient similar to clinical drugs.
      Please see [how to calculate drug dose](https://ohdsi.github.io/CommonDataModel/drug_dose.html)
      for more information.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    alias: quantity
    owner: DrugExposure
    domain_of:
    - Procedure
    - DrugExposure
    - DeviceExposure
    range: float
    required: false
  days_supply:
    name: days_supply
    description: The number of days of supply of the medication as recorded in the
      original prescription or dispensing record. Days supply can differ from actual
      drug duration (i.e. prescribed days supply vs actual exposure).
    comments:
    - The field should be left empty if the source data does not contain a verbatim
      days_supply, and should not be calculated from other fields.  Negative values
      are not allowed. If the source has negative days supply the record should be
      dropped as it is unknown if the patient actually took the drug. Several actions
      are possible -- record is not trustworthy and we remove the record entirely;
      we trust the record and leave days_supply empty; or record needs to be combined
      with other record (e.g. reversal of prescription). High values (>365 days) should
      be investigated. If considered an error in the source data (e.g. typo), the
      value needs to be excluded to prevent creation of unrealistic long eras.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    alias: days_supply
    owner: DrugExposure
    domain_of:
    - DrugExposure
    range: integer
    required: false
  sig:
    name: sig
    description: This is the verbatim instruction for the drug as written by the provider.
    comments:
    - Put the written out instructions for the drug as it is verbatim in the source,
      if available.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    alias: sig
    owner: DrugExposure
    domain_of:
    - DrugExposure
    range: string
    required: false
  route_concept:
    name: route_concept
    description: Route of drug administration.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    alias: route_concept
    owner: DrugExposure
    domain_of:
    - DrugExposure
    range: DrugRouteEnum
  identity:
    name: identity
    description: A 'business' identifier or accession number for the entity, typically
      as provided by an external system or authority, that are globally unique and
      persist across implementing systems. Also, since these identifiers are created
      outside the information system through a specific business process, the Identifier
      type has additional attributes to capture this additional metadata so the actual
      identifier values are qualified by the context that created those values. This
      additional context allows "identifier" instances to be transmitted as business
      data across systems while still being able to trace them back to the system
      of origin.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    slot_uri: schema:identifier
    alias: identity
    owner: DrugExposure
    domain_of:
    - Person
    - Demography
    - Participant
    - ResearchStudy
    - Organization
    - Questionnaire
    - QuestionnaireItem
    - Condition
    - Procedure
    - Exposure
    - File
    - Document
    - Specimen
    - BiologicProduct
    range: uriorcurie
    multivalued: true
  associated_visit:
    name: associated_visit
    description: A reference to the Visit that is associated with this record.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    alias: associated_visit
    owner: DrugExposure
    domain_of:
    - Demography
    - QuestionnaireResponse
    - Condition
    - Procedure
    - ImagingStudy
    - Exposure
    - ObservationSet
    - Observation
    range: Visit
  associated_participant:
    name: associated_participant
    description: A reference to the Participant that is associated with this record.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    alias: associated_participant
    owner: DrugExposure
    domain_of:
    - Demography
    - Visit
    - Condition
    - Procedure
    - ImagingStudy
    - Exposure
    - File
    - ObservationSet
    - Observation
    range: Participant
  age_at_exposure_start:
    name: age_at_exposure_start
    description: The Participant's age (expressed in days) at the exposure start date.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    alias: age_at_exposure_start
    owner: DrugExposure
    domain_of:
    - Exposure
    range: integer
    unit:
      ucum_code: d
  age_at_exposure_end:
    name: age_at_exposure_end
    description: The Participant's age (expressed in days) at the exposure end date,
      if available. Otherwise equal to age_at_exposure_start.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    alias: age_at_exposure_end
    owner: DrugExposure
    domain_of:
    - Exposure
    range: integer
    unit:
      ucum_code: d
  exposure_status:
    name: exposure_status
    description: A value indicating whether the exposure described in this record
      is present, absent, historically present, or unknown for this individual patient.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    alias: exposure_status
    owner: DrugExposure
    domain_of:
    - Exposure
    range: HistoricalStatusEnum
  id:
    name: id
    description: The 'logical' identifier of the entity within the system of record.  The
      simple value of this attribute stands for an identifier of this data object
      within the system, it can be used as a reference from other objects within the
      same system (i.e. primary and foreign keys), and it should be unique per type
      of object. The same data object copied to a different system will likely have
      a different "id" in the new system since "id" values are system specific and
      do not represent persistent business identifiers. Business identifiers are assigned
      outside the information system and are captured in the "identifier" field. The
      "id" field is more likely to be a serially or randomly generated value that
      is assigned to the data object as it is created in a system.
    from_schema: https://w3id.org/nhlbidatastage/bdchm
    rank: 1000
    slot_uri: schema:identifier
    identifier: true
    alias: id
    owner: DrugExposure
    domain_of:
    - Entity
    range: uriorcurie
    required: true