Salesforce Docs Portal

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
Feed tracking is available for the object.
ClinicalAlertHistory
History is available for tracked fields of the object.
ClinicalAlertShare
Sharing is available for the object.
ClinicalAlertChangeEvent (API version 61.0)
Change events are available for the object.