addConceptEventDays: Add the first or last concept event and its relative days

In PatientProfiles: Identify Characteristics of Patients in the OMOP Common Data Model

Add the first or last concept event and its relative days

Description

addConceptEventDays() finds the first or last event from a set of concepts in each window. When no event is observed before the applicable boundary, the event is reported as "end_of_observation" if the observation period boundary is reached or "censor" if the window boundary or censorDate is reached. The days value represents that boundary.

Usage

addConceptEventDays(
  x,
  conceptSet,
  indexDate = "cohort_start_date",
  censorDate = NULL,
  targetDate = "event_start_date",
  order = "first",
  window = list(c(0, Inf)),
  multipleEvents = NULL,
  nameStyle = "{value}_{window_name}",
  name = NULL,
  type = "numeric"
)

Arguments

x	A table containing individuals in a CDM reference.
conceptSet	A named list of concept sets.
indexDate	Name of a date column in x, or a single date to use for all rows, used as the reference date.
censorDate	Date or name of a date column in x on which to censor follow-up. If NULL, no censoring is applied.
targetDate	Name or names of date columns in the target tables to use for the intersection.
order	Which record to use when multiple records occur in a window: "first" or "last".
window	Window or windows of time relative to indexDate to consider.
multipleEvents	How events occurring on the same date are handled. If NULL, the first event in the original event order is returned. If TRUE, all simultaneous event names are sorted alphabetically and joined with "; ". A character vector gives priority to the specified event names; the first matching name is returned, with unspecified names following in alphabetical order. Boundary labels ("censor" and "end_of_observation") are never combined with event names.
nameStyle	Naming pattern for the added columns. It must contain {value} and can also contain {window_name}.
name	Name of the new table. If NULL, a temporary table is returned.
type	Type of the created column(s). Counts, days, age, and observation durations can be "numeric" or "integer". Flag columns can also be "logical". Field columns can use "auto" to preserve the source type, or can be converted to "numeric", "integer", "logical", or "character".

Value

x with an event column and a days column of the requested type, relative to indexDate, for every window.

Examples

library(PatientProfiles)

cdm <- mockPatientProfiles(source = "duckdb")

cdm$cohort1 |>
  addConceptEventDays(conceptSet = list(acetaminophen = 1125315L))

PatientProfiles documentation built on Aug. 22, 2026, 1:07 a.m.