addCohortEventDate: Add the first or last cohort event and its date

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

Add the first or last cohort event and its date

Description

addCohortEventDate() finds the first or last event 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 date value represents that boundary.

Usage

addCohortEventDate(
  x,
  targetCohortTable,
  targetCohortId = NULL,
  indexDate = "cohort_start_date",
  censorDate = NULL,
  targetDate = "cohort_start_date",
  order = "first",
  window = c(0, Inf),
  multipleEvents = NULL,
  nameStyle = "{value}_{window_name}",
  name = NULL
)

Arguments

x	A table containing individuals in a CDM reference.
targetCohortTable	Name of the cohort table to intersect with.
targetCohortId	Cohort definition IDs to include from targetCohortTable. If NULL, all cohorts are included.
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.

Value

x with an event column and a date column for every window.

Examples

library(PatientProfiles)

cdm <- mockPatientProfiles(source = "duckdb")

cdm$cohort1 |>
  addCohortEventDate(targetCohortTable = "cohort2")

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