Salesforce Health Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Health Cloud Developer Guide
Health Cloud Data Model
Advanced Therapy Management
Adverse Events
Assessment Generation
Benefits Verification
Care Program Management
Claims
Clinical Data Model
Predecessors to Code Sets and Code Set Bundles in Health Cloud
Coverage Requirement Discovery
Crisis Support Center Management
Documentation Templates and Rules
Disease Surveillance
Electronic Signatures
Engagement Interaction
FHIR Subscription
Financial Assistance Program
Health Assessments
AssessmentEnvelope
AssessmentEnvelopeItem
Health Insurance
Home Health
Integrated Care Management
Intelligent Appointment Management
Intelligent Document Automation
Intelligent Sales
Medication Management
Patient Program Outcome Management
Participant Management
Patient Segmentation
Pharmacy Benefits Verification
Provider Network Management
Provider Relationship Management
Remote Monitoring and Device Registration
Social Determinants
Timeline
Unified Health Scoring
Utilization Management
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
Working With Electronic Health Records
Emergency Response Management
Apex Reference
Health Cloud Business APIs
Health Cloud Tooling API Objects
Health Cloud Standard Invocable Actions
Metadata Types
API End-of-Life Policy
PDF

AssessmentEnvelope

Represents information about an envelope that contains the assessments related to a user. For example, you can create an envelope that contains assessments for a patient or a caregiver related to depression or anxiety. This object is available in API version 58.0 and later.

Supported Calls

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

Fields

Field Details
AccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The recipient of the assessment envelope, such as a patient.
This field is a relationship field.
Relationship Name
Account
Relationship Type
Lookup
Refers To
Account
ContactId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The recipient of the assessment envelope, such as a caregiver.
This field is a relationship field.
Relationship Name
Contact
Relationship Type
Lookup
Refers To
Contact
ExpirationDateTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date and time of assessment envelope expiration.
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 assessment envelope.
NotificationStatus
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The sent status of the assessment envelope
Possible values are:
  • NotSent
  • Sent
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
Relationship Type
Lookup
Refers To
Group, User
RequestReferenceId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The reference to the context of the assessment envelope request.
This field is a polymorphic relationship field.
Relationship Name
RequestReference
Relationship Type
Lookup
Refers To
Case, ClinicalEncounter, ClinicalServiceRequest, ServiceAppointment
Status
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Specifies the status of the envelope that contains the assessments
Possible values are:
  • Completed
  • InProgress—In Progress
  • NotStarted—Not Started

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.

AssessmentEnvelopeChangeEvent (API version 60.0)
Change events are available for the object.
AssessmentEnvelopeFeed
Feed tracking is available for the object.
AssessmentEnvelopeHistory
History is available for tracked fields of the object.
AssessmentEnvelopeOwnerSharingRule
Sharing rules are available for the object.
AssessmentEnvelopeShare
Sharing is available for the object.