addDeathDate: Add date of death for individuals. Only death within the same...

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

Add date of death for individuals. Only death within the same observation period than indexDate will be observed.

Description

Add date of death for individuals. Only death within the same observation period than indexDate will be observed.

Usage

addDeathDate(
  x,
  indexDate = "cohort_start_date",
  censorDate = NULL,
  window = c(0, Inf),
  deathDateName = "date_of_death",
  name = NULL
)

Arguments

x	A table containing individuals in a CDM reference.
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.
window	Window or windows of time relative to indexDate to consider.
deathDateName	name of the new column to be added.
name	Name of the new table. If NULL, a temporary table is returned.

Value

table x with the added column with death information added.

Examples

library(PatientProfiles)

cdm <- mockPatientProfiles(source = "duckdb")

cdm$cohort1 |>
  addDeathDate()

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