---
schema_version: "1"
id: 01d0ed6fc4101e3062b999ba7d2a2e00f6a6100f9e23c08f856b935bd81c0eaa
title: ClinicalAlert
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/life_sciences_dev_guide/hc_r4_api_objects_ClinicalAlert.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_ClinicalAlert.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: a34fe9ebb19212ce8fc59a9d9e790b3c4bb6bb8716a78b26a757fbe858d41c95
description: Represents a warning or notification of significance related to different healthcare entities. The subject of the alert may be a patient, a location, a provider, a procedure, or even a medication. This object is available in API version 51.0 and later.
---
# ClinicalAlert

Represents a warning or notification of significance related to different healthcare entities. The subject of the alert may be a patient, a location, a provider, a procedure, or even a medication. This object is available in API version 51.0 and later.

## Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

## Additional Information for Clinical Alert in Other Objects

In addition to creating a record using these fields, you can add more details to your clinical alert record by creating records in certain other objects, and referencing your ClinicalAlert record as the parent record. Here’s the list of objects you can associate to ClinicalAlert in this way, the type of information they add, and the field they use to reference ClinicalAlert.

| Object | Type of Information | Reference Field |
| --- | --- | --- |
| Identifier | Associates an identifier value to the clinical alert. | ParentRecordId |

## Fields

### Categories

- **Type**: multipicklist
- **Properties**: Create, Filter, Nillable, Update
- **Description**: Specifies the category that the alert belongs to.
- **Possible values**:
    - Clinical
    - Diet
    - Drug
    - Lab
    - Subject Contact

### CodeDescription

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The description of the alert.

### CodeId

- **Type**: reference
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: The system-defined code that represents the alert.
- **Referenced Objects**:
    - CodeSetBundle

### EndDate

- **Type**: dateTime
- **Properties**: Create, Filter, Nillable, Sort, Update
- **Description**: The date and time when the alert was deactivated.

### LastReferencedDate

- **Type**: dateTime
- **Properties**: Filter, Nillable, Sort
- **Description**: The last date that the record was referenced.

### LastViewedDate

- **Type**: dateTime
- **Properties**: Filter, Nillable, Sort
- **Description**: The last date that the record was viewed.

### Name

- **Type**: string
- **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort
- **Description**: The system-generated name of the clinical alert record.

### OwnerId

- **Type**: reference
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: The user that this record belongs to.

### RaisedById

- **Type**: Polymorphic reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The person or facility that raised the alert.
- **Referenced Objects**:
    - HealthcareProvider
    - HealthcarePractitionerFacility
    - CareRegisteredDevice

### RelatedEncounterId

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The encounter that this alert is related to.
- **Referenced Objects**:
    - ClincialEncounter

### SourceSystem

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The source system from where the record was brought into Salesforce.

### SourceSystemIdentifier

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The identifier of the record in its source system.

### SourceSystemModified

- **Type**: dateTime
- **Properties**: Create, Filter, Nillable, Sort, Update
- **Description**: The date and time when the record was last modified in its source system.

### StartDate

- **Type**: dateTime
- **Properties**: Create, Filter, Nillable, Sort, Update
- **Description**: The date and time when the alert was activated.

### Status

- **Type**: picklist
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: The status of the clinical alert.
- **Possible values**:
    - Active
    - Entered-In-Error
    - Inactive

### SubjectId

- **Type**: polymorphic reference
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: The person or entity the alert is about.
- **Examples**:
    - A patient experiencing kidney failure.
    - A location with an avian flu outbreak.
    - A practitioner flagged from referrals.
    - A medication that’s flagged for special circumstances.
- **Referenced Objects**:
    - Location
    - HealthcareProvider
    - Medication
    - PatientMedicalProcedure
    - Account

## Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

[ClinicalAlertFeed](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.")

Feed tracking is available for the object.

[ClinicalAlertHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.")

History is available for tracked fields of the object.

[ClinicalAlertShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.")

Sharing is available for the object.

[ClinicalAlertChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0)

Change events are available for the object.