DiseaseOutbreak

Represents a disease outbreak monitored by the public health organization. This object is available in API version 64.0 and later.

Supported Calls

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

Fields

Field	Details
Description	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the disease outbreak.
DetectionDate	Type dateTime Properties Create, Filter, Sort, Update Description The date and time of the disease outbreak detection.
DiseaseDefinitionId	Type reference Properties Create, Filter, Group, Sort, Update Description The disease definition associated with the disease outbreak. This field is a relationship field. Relationship Name DiseaseDefinition Refers To DiseaseDefinition
EndDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The end date and time of the disease outbreak.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.
LocationReferenceRecordId	Type reference Properties Create, Filter, Group, Sort, Update Description The location, address, or healthcare facility associated with the disease outbreak. This field is a polymorphic relationship field. Relationship Name LocationReferenceRecord Refers To Address, HealthcareFacility, Location
ManuallyRecordedconfirmedCnt	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The manually recorded count of people affected by the disease outbreak, based on informal reports.
ManuallyRecordedsuspectedCnt	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The manually recorded count of people suspected to be affected by the disease outbreak, based on informal reports.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the disease outbreak.
OutbreakLevel	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the geographical scope of the outbreak, such as local, multi-jurisdictional, provincial, national, or facility-based. Possible values are: `Facility` `Local` `MultiJurisdictional` `National` `Provincial`
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who owns this record. This field is a polymorphic relationship field. Relationship Name Owner Refers To Group, User
RelatedDiseaseOutbreakId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description A related outbreak associated with the disease outbreak. This field is a relationship field. Relationship Name RelatedDiseaseOutbreak Refers To DiseaseOutbreak
ReportedById	Type reference Properties Create, Filter, Group, Sort, Update Description The user who reported the disease outbreak. This field is a polymorphic relationship field. Relationship Name ReportedBy Refers To User
StartDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The start date and time of the disease outbreak.
Status	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Specifies the status of the disease outbreak. Possible values are: `Completed` `InProgress` `New`
TotalConfirmedCount	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total confirmed count of people affected by the disease outbreak.
TotalSuspectedCount	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total suspected count of people affected by the disease outbreak.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

DiseaseOutbreakChangeEvent: Change events are available for the object.
DiseaseOutbreakHistory: History is available for tracked fields of the object.
DiseaseOutbreakOwnerSharingRule: Sharing rules are available for the object.
DiseaseOutbreakShare: Sharing is available for the object.

Salesforce Health Cloud Developer Guide

DiseaseOutbreak

Supported Calls

Fields

Associated Objects