Skip to main content

Patient deceased and dateOfDeath on the public API

Summary​

The Public API Patient type now exposes a read-only deceased boolean and an optional dateOfDeath. Partners can use these on patient and patients queries (and on nested patient fields elsewhere in the schema) to determine whether a patient is marked as deceased in Semble and when, if a date was recorded.

What changed​

  • Added Patient.deceased: Boolean — true when the patient is marked as deceased in Semble.
  • Added Patient.dateOfDeath: Date — the recorded date of death, or null when none is set.
  • These are additive; existing queries continue to work without requesting the new fields.

Integration guidance​

  • Reading death status: Request deceased on patient(id:) or patients results when you need to skip billing or other workflows for deceased patients.
  • Date of death: Request dateOfDeath when you also need the recorded date. It can be null even when deceased is true.
  • Not the same as archived: archived and archivedInfo.archivedReason (for example DECEASED_PATIENT) reflect archiving, not the clinical deceased checkbox. Use deceased / dateOfDeath when you need the death fields themselves.

Example​

query PatientDeceasedStatus {
  patient(id: "PATIENT_ID") {
    id
    firstName
    lastName
    deceased
    dateOfDeath
  }
}

Migration​

No breaking changes. Opt in by adding deceased and dateOfDeath to your patient selections when needed.