DiseaseDefinition

Represents a disease definition that public health organizations regularly monitor to identify and prevent outbreaks. 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
ActivationDate
Type
date
Properties
Create, Filter, Group, Sort, Update
Description
The date the disease definition becomes active.
AuthorityReportingLevel
Type
multipicklist
Properties
Create, Filter, Nillable, Restricted picklist, Update
Description
Specifies the scope for reporting the disease.
Possible values are:
  • Global
  • Local
  • National
  • State
ClinicalDescription
Type
textarea
Properties
Create, Nillable, Update
Description
A clinical description of the disease definition that details the initial symptoms or physical and clinical findings.
Comment
Type
textarea
Properties
Create, Nillable, Update
Description
Additional details related to the disease definition.
DocumentVersionId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The document version used for data extraction.
This field is a relationship field.
Relationship Name
DocumentVersion
Refers To
ContentVersion
ExpirationDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The expiration date of disease definition.
IcdCodeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The International Classification of Diseases (ICD) code set bundle associated with the disease definition.
This field is a relationship field.
Relationship Name
IcdCode
Refers To
CodeSetBundle
IsHighRisk
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the disease is high risk (true) or not (false).
The default value is false.
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.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the disease.
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
ProblemDefinitionId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The parent problem definition associated with the disease definiton.
This field is a relationship field.
Relationship Name
ProblemDefinition
Relationship Type
Master-detail
Refers To
ProblemDefinition (the master object)
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Specifies the status of the disease definition.
Possible values are:
  • Active
  • Draft
  • Inactive
The default value is Draft.
Summary
Type
textarea
Properties
Create, Nillable, Update
Description
The summary of the disease definition.
Type
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the type of disease definition.
Possible values are:
  • Animal Borne
  • Blood Borne
  • Food or Water Borne
  • None
  • Respiratory Disease
  • Sexually_Transmitted_Infection
  • Vaccine Preventable

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.

DiseaseDefinitionChangeEvent
Change events are available for the object.
DiseaseDefinitionHistory
History is available for tracked fields of the object.
DiseaseDefinitionOwnerSharingRule
Sharing rules are available for the object.
DiseaseDefinitionShare
Sharing is available for the object.